نام (NAME)

nethsm-key-import - وارد کردن یک کلید

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

nethsm key import [--format] [-k|--key-id] [-t|--tags] [-a|--auth-passphrase-file] [-c|--config] [-l|--label] [-u|--user] [-h|--help] <KEY_TYPE> <KEY_DATA> [KEY_MECHANISMS]

توضیحات (DESCRIPTION)

وارد کردن یک کلید

داده‌های کلید ارائه‌شده باید به عنوان یک کلید خصوصی PKCS#8 با کدگذاری ASN.1 DER یا در قالب PEM (Privacy-Enhanced Mail) ارائه شوند. داده‌های کلید باید با نوع کلید ارائه‌شده مطابقت داشته باشند.

نوع کلید ارائه‌شده و فهرست سازوکارهای (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)

--format <FORMAT> [default: Der]

قالب کلید برای وارد کردن

کلیدها را می‌توان در قالب‌های Distinguished Encoding Rules (DER) یا Privacy-Enhanced Mail (PEM) وارد کرد.

یکی از مقادیر ["Pem", "Der"].

-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>

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

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

یکی از موارد ["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssMd5", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"].

<KEY_DATA>

مسیر یک کلید خصوصی PKCS#8 با قالب کدگذاری‌شده ASN.1 DER

داده‌های کلید خصوصی باید با نوع کلید انتخاب‌شده مطابقت داشته باشند.

[KEY_MECHANISMS]

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

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

حداقل یکی از موارد ["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssMd5", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"].