نام (NAME)

nethsm-key-generate - تولید یک کلید جدید

خلاصه دستور (SYNOPSIS)

nethsm key generate [-L|--length] [-k|--key-id] [-t|--tags] [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user] [-h|--help] [KEY_TYPE] [KEY_MECHANISMS]

توضیحات (DESCRIPTION)

تولید یک کلید جدید

نوع کلید ارائه‌شده و فهرست سازوکارهای (mechanisms) کلید باید با یکدیگر مطابقت داشته باشند: * "Rsa" به یکی از موارد [RsaDecryptionRaw, RsaDecryptionPkcs1, RsaDecryptionOaepMd5, RsaDecryptionOaepSha1, RsaDecryptionOaepSha224, RsaDecryptionOaepSha256, RsaDecryptionOaepSha384, RsaDecryptionOaepSha512, RsaSignaturePkcs1, RsaSignaturePssMd5, RsaSignaturePssSha1, RsaSignaturePssSha224, RsaSignaturePssSha256, RsaSignaturePssSha384, RsaSignaturePssSha512] نیاز دارد. * "Curve25519" به یکی از موارد [EdDsaSignature] نیاز دارد. * "EcP256" ،"EcP384" و "EcP521" به یکی از موارد [EcdsaSignature] نیاز دارند. * "Generic" حداقل به یکی از موارد [AesDecryptionCbc, AesEncryptionCbc] نیاز دارد.

کاربران سراسری سیستم (System-wide) در نقش "Administrator" کلیدهای سراسری تولید می‌کنند. کاربران دارای فضای نام (Namespaced) در نقش "Administrator" کلیدها را در فضای نام اختصاصی خود تولید می‌کنند.

نکته: با این‌که اختصاص برچسب‌ها (tags) به کلید جدید اختیاری است، اما اکیداً توصیه می‌شود؛ زیرا عدم انجام این کار بدان معناست که همهٔ کاربران در همان حوزه (scope) به آن دسترسی خواهند داشت!

نیازمند احراز هویت یک کاربر در نقش "Administrator" است.

گزینه‌ها (OPTIONS)

-L, --length <LENGTH>

طول اختیاری کلید تولیدشده بر حسب بیت

در صورت مشخص نشدن، مقدار پیش‌فرض انتخاب می‌شود.

-k, --key-id <KEY_ID>

شناسهٔ یکتای اختیاری که به کلید تولیدشده اختصاص می‌یابد

اگر مقداری ارائه نشود، یک شناسهٔ عمومی برای کلید ایجاد خواهد شد.

-t, --tags <TAGS>

فهرست اختیاری از برچسب‌هایی که به کلید تولیدشده اختصاص می‌یابند

برچسب‌های روی کلیدها برای اعطای دسترسی به آن کلیدها به کاربرانی که برچسب‌های یکسانی دارند، به کار می‌روند.

-a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE>

مسیر یک فایل حاوی عبارت عبور برای احراز هویت

عبارت عبور ارائه‌شده در فایل باید متعلق به کاربری باشد که برای این دستور انتخاب شده است.

این گزینه می‌تواند چندین بار مشخص شود که برای دستوراتی که به‌طور همزمان به چند نقش نیاز دارند، الزامی است. در صورت وجود چندین فایل عبارت عبور، ترتیب آنها اهمیت دارد؛ چرا که فایل‌ها به کاربر متناظر ارائه‌شده توسط گزینهٔ «--user» تخصیص داده می‌شوند.

-c, --config <CONFIG>

مسیر یک فایل پیکربندی سفارشی

در صورت مشخص شدن، فایل پیکربندی سفارشی به جای مکان پیش‌فرض فایل پیکربندی استفاده می‌شود.

-l, --label <LABEL>

برچسبی که به طور یکتا یک دستگاه را در فایل پیکربندی مشخص می‌کند

اگر بیش از یک دستگاه در فایل پیکربندی تنظیم شده باشد، مشخص کردن این گزینه الزامی است.

-u, --user <USER>

نام کاربری که برای اجرای یک دستور استفاده می‌شود

اگر هیچ نام کاربری در فایل پیکربندی برای یک دستگاه تنظیم نشده باشد، می‌تواند ارائه شود. اگر چندین نام کاربر با نقش هدف یکسان در فایل پیکربندی برای یک دستگاه تنظیم شده باشند، تعیین آن الزامی است.

این گزینه می‌تواند چندین بار مشخص شود که برای دستوراتی که به‌طور همزمان به چند نقش نیاز دارند، الزامی است.

-h, --help

چاپ راهنما (مشاهدهٔ خلاصه با '-h')

[KEY_TYPE]

نوع اختیاری کلید برای تولید

نوع کلید باید با سازوکارهای کلید انتخابی مطابقت داشته باشد!

یکی از ["Curve25519", "EcP256", "EcP384", "EcP521", "Generic", "Rsa"] (پیش‌فرض: "Curve25519").

[KEY_MECHANISMS]

سازوکارهای ارائه‌شده توسط کلید تولیدشده

سازوکارهای کلید باید با نوع کلید انتخابی مطابقت داشته باشند!

حداقل یکی از ["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssMd5", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"] (پیش‌فرض: "EdDsaSignature").