鍵ペアを管理する
このセクションでは、SMCTL で鍵ペアを管理するために使用するコマンドについてカバーします。これらのコマンドは、記述・説明、生成、一覧表示、インポート、一時停止、一時停止解除、更新、アクセスの更新、鍵ペアプロファイルの管理、および鍵ペアを使用した証明書の生成です。フラグを使用してコマンドのパラメータを指定します。
コマンド
鍵ペアを表示するには、以下を実行します。
smctl keypair --help
or
smctl kp -h
サブコマンド
鍵ペアコマンドは、以下のように始まります。
smctl keypair <subcommand>
鍵ペアコマンドは、これらのフラグをサポートしています。
ショートカット | サブコマンド | 説明 |
---|---|---|
desc | 鍵ペアを説明します。 | |
gen | 鍵ペアを生成します。 | |
gen-cert | 既存の鍵ペア用の証明書を作成します。 | |
ls | 鍵ペアを一覧表示します。 | |
鍵ペアをインポートします。 | ||
鍵ペアプロファイルを一覧表示または説明します。 | ||
Refresh a dynamic keypair and the default certificate (if one exists). | ||
Rotate the keypair for the provided key rotation. | ||
鍵ペアの状態をオフラインにする。 | ||
鍵ペアの状態をオンラインにします。 | ||
鍵ペアを更新します。 | ||
鍵ペアのアクセス権を更新します。 | ||
-h | --help | 鍵ペアの管理に関するヘルプ。 |
鍵ペアを説明する
鍵ペアを説明のコマンドは、以下のように始まります。
Keypair ID
Keypair alias
Key algorithm
Key size
Key curve
Keypair status
Keypair type
Keypair category
Key storage
Public key
Access
Users who have access to keypair
Associated team
Dynamic key ID
Command
Describe keypair commands begin with:
smctl keypair describe
or
smctl kp desc
フラグ
鍵ペアを説明のコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--account-id string | ユーザーのアカウントID。 形式: --account-id="<account ID>" | |
-h | --help | 鍵ペアの説明に関するヘルプ。 |
例
説明: 指定された鍵ペアIDの鍵ペアを記述・説明します。
コマンド:
smctl keypair describe <keypair id>
コマンドの例:
smctl kp desc 54868080-c4fb-4ea8-99cc-490329a1953e
Command output
Keypair ID: 54868080-c4fb-4ea8-99cc-490329a1953e Keypair alias: kp-1 Key algorithm: RSA - 4096 Key size: 4096 Key curve: Keypair status: ONLINE Keypair type: STATIC Keypair category: PRODUCTION Key storage: DISK Public key: MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAzXNVPI+mg7EIs81FGRtbV3fJNA8r0u9VBuxejGV3bux/bQVa/Wo98RoEC99Q1M/gTINkmCNA+vj3XhknOV5RdxmWYVEuhOyD80NRzzd57/W/p8jnfy1BQ+SR9pyRv69m7UmvfHi7iEPHVmwK2rs86MEdqLIRMwySKFJu3hS2Zx4gvhNASEmSAC2iRVneqM1ef+3N8ZR/8aAxgwGtE1c+ozpiZHEfqpe7Nt0rz40DYnQtmXUPC1PGHETixyIZS27m1rPzKd6AJvGs30akMO6ea3X5lYtM7Mg/B+PCT+HmxiVU+CH5NmwQqvjWyBSMgc9E1klShdXsKnOzcHFeWKnu0OdV0x21ernbejb37c/7YGzlNWOiVovx0jDJhzca9wfw0ZT/4hJ75DPe5eet9SeFf3y1hPxIVFicyg0FXMD2LuEXOGg5I3qRD6nhfZMqXzgsCUd/Ia0YxG/2WDo66n6dtkrOyTu6L4CEc61AwWuUXxpS2G8Ermow8Md5uHPQjAOszGvII+ExDLsg7oqOtgxHox7fkpNCLEfO9FziKw2Z80rc4boxQ6Ga4oMWjWasG/X+oPQoWJma2+M/cvYGGLqD373mxE9rx76pfsXs7SQiSI4I/ydQSxOqUuHie/DeGO4H+ta+fwK3Im3YSv3r4d45VIRkeHCiRjaa9icd1hdD2lUCAwEAAQ== Default certificate: MIIGxzCCBS+gAwIBAgIUCIPHJ2oTkxQm5dwLIVwPce60a54wDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNVBAYTAklFMQ8wDQYDVQQIEwZEdWJsaW4xDzANBgNVBAcTBkR1YmxpbjEQMA4GA1UECRMHTWFpbiBTdDEOMAwGA1UEERMFOTAyMTAxGTAXBgNVBAoTEFJvY2hlIEluZHVzdHJpZXMxJDAiBgNVBAMTG1JvY2hlIEluZHVzdHJpZXMgSXNzdWluZyBDQTAeFw0yMDA5MDkxMTM1MDVaFw0yMDA5MTAxMTM1MDVaMIG/MQswCQYDVQQGEwJJRTEPMA0GA1UECBMGRHVibGluMQ8wDQYDVQQHEwZEdWJsaW4xEDAOBgNVBAkTB01haW4gU3QxDjAMBgNVBBETBTkwMjEwMRkwFwYDVQQKExBSb2NoZSBJbmR1c3RyaWVzMRUwEwYDVQQLEwxUZXN0IHNpZ25pbmcxHzAdBgNVBAsTFkZvciB0ZXN0IHB1cnBvc2VzIG9ubHkxGTAXBgNVBAMTEFJvY2hlIEluZHVzdHJpZXMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDNc1U8j6aDsQittUUZG1tXd8k0DyvS71UG7F6MZXdu7H9tBVr9aj3xGgQL31DUz+BMg2SYI0D6+PdeGSc5XlF3GZZhUS6E7IPzQ1HPN3nv9b+nyOd/LUFD5JH2nJG/r2btSa98eLuIQ8dWbArauzzowR2oshEzDJIoUm7eFLZnHiC+E0BISZIALaJFWd6ozV5/7c3xlH/xoDGDAa0TVz6jOmJkcR+ql7s23SvPjQNidC2ZdQ8LU8YcROLHIhlLbubWs/Mp3oAm8azfRqQw7p5rdfmVi0zsyD8H48JP4ebGJVT4Ifk2bBCq+NbIFIyBz0TWSVKF1ewqc7NwcV5Yqe7Q51XTHbV6udt6Nvftz/tgbOU1Y6JWi/HSMMmHNxr3B/DRlP/iEnvkM97l5631J4V/fLWE/EhUWJzKDQVcwPYu4Rc4aDkjepEPqeF9kypfOCwJR38hrRjEb/ZYOjrqfp22Ss7JO7ovgIRzrUDBa5RfGlLYbwSuajDwx3m4c9CMA6zMa8gj4TEMuyDuio62DEejHt+Sk0IsR870XOIrDZnzStzhujFDoZrigxaNZqwb9f6g9ChYmZrb4z9y9gYYuoPfvebET2vHvql+xeztJCJIjgj/J1BLE6pS4eJ78N4Y7gf61r5/ArcibdhK/evh3jlUhGR4cKJGNpr2Jx3WF0PaVQIDAQABo4IBZDCCAWAwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQU+jdQEZ956wIzcnNR5l9rpwC+OEswHwYDVR0jBBgwFoAUHyS+ZZ+7p0fqnMO9HsLZn8JzDYgwDgYDVR0PAQH/BAQDAgXgMCAGA1UdJQEB/wQWMBQGCCsGAQUFBwMDBggrBgEFBQcDAjCBjQYIKwYBBQUHAQEEgYAwfjAtBggrBgEFBQcwAYYhaHR0cDovL29jc3AuZGVtby5vbmUuZGlnaWNlcnQuY29tME0GCCsGAQUFBzAChkFodHRwOi8vY2FjZXJ0cy5kZW1vLm9uZS5kaWdpY2VydC5jb20vUm9jaGVJbmR1c3RyaWVzSXNzdWluZ0NBLmNydDBOBgNVHR8ERzBFMEOgQaA/hj1odHRwOi8vY3JsLmRlbW8ub25lLmRpZ2ljZXJ0LmNvbS9Sb2NoZUluZHVzdHJpZXNJc3N1aW5nQ0EuY3JsMA0GCSqGSIb3DQEBCwUAA4IBgQCs/pwki7DtuMIotK0GKkB44WFtXbQ45JRZOnTTnGRuPx5Mth7Nl+3TK0G4sAjEuMRxIzCI4gXHu8se7SOpSrwlTr/r36hL72NN4OdNNOVEo4myfrRkBNaSuwfnpTdXtWCqe6VFi/TRWaXJpyjpsXdd1g6Sfj09GQ1sCLswvH7/xoGDMAPdF1P8h7WCQ/CmH2lSgHvHkbEIwR7vbJ6SmrnVOJIRkZz1rjt8SYzjhs5DISYaIyaNSnb5yJXzeyfb3c8veJIRqEE6CnYWDd7+qeCD6k5hxWZ73G5svrzbJOExdpPrn/l6S7Na6wwVul6NQDTTMDs/NLWp84BRoVFRSC6XBnqlAGlsLCqrtUgUzQVQOUhbvtJlIKt+LW4Y0D3oEpYAc9QbT0ldo6tdfpEiZ44F7ORxr7LhXOq+/dBIS8jWCIM4oEMGW3d1gsuKmiRBVBfGuvT2TsGk+WD5g3bjFbi1N2fZ1q4RuhY9zvELvv87zUkOttO3U/P5OgTbymK3to8= Access: Open Users: [] Groups: [] Restricted to team: - Dynamic key ID:
鍵ペアを生成する
鍵ペアの生成コマンドは、以下のように始まります。
smctl keypair generate
or
smctl kp gen
サブコマンド
鍵ペアコマンドは、これらのサブコマンドを生成します。
サブコマンド | 説明 |
---|---|
profile | 鍵ペアプロファイルを使用して鍵を生成する |
ecdsa | ECDSA のアルゴリズムで鍵ペアを生成する。 |
eddsa | EdDSA のアルゴリズムで鍵ペアを生成する。 |
rsa | RSA のアルゴリズムで鍵ペアを生成する。 |
フラグ
鍵ペアコマンドは、これらのフラグを生成します。
ショートカット | フラグ | 説明 |
---|---|---|
--auto-renew string | Auto-renew this certificate. | |
--cert-alias string | Specify an alias for the default certificate you want to create. | |
--generate-cert | Generate a certificate (default false). | |
--groups string | 鍵ペアのグループID。 形式: --groups="<value>" | |
-hsm-partition-id string | Provide the HSM partition ID to specify which HSM you want the keypair to be stored on. | |
--restricted | [制限] (鍵ペアにマップされているユーザーとグループのみが使用可能) または [オープン] (アカウント内のすべてのユーザーが使用可能)。デフォルトは [制限]。 | |
--users string | 鍵ペアのユーザーID。 形式: --users="<value>" | |
--team-id string | Assign the keypair to a team by specifying the team ID. | |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 鍵ペアの生成に関するヘルプ。 |
例
Generate a keypair
Generate a keypair when keypair profiles are not enabled on the account.
Command:
smctl keypair generate <algorithm> <keypair alias>
Command sample:
smctl keypair generate rsa keypair-alias-kp1
Generate a keypair on a specific HSM
Generate a keypair on a specific HSM.
Command:
smctl kp gen <algorithm> <keypair alias> --key-storage HSM --hsm-partition-id=<HSM ID>
Command sample:
smctl kp gen rsa keypair1 --key-storage HSM --hsm-partition-id=386425F3GD207A379FAE38426
Generate key with keypair profile ID
Generate a keypair with the specified keypair profile ID. This command is used when keypair profiles are enabled on the account.
Command:
smctl keypair generate profile <keypair alias> <keypair profile id>
Command sample:
smctl keypair generate profile kp1 6109c7ab-c47f-4a3e-a6ea-57203016d725
Generate a key and certificate with different aliases
Generate a keypair and certificate with different aliases by referencing the an alias for the certificate, keypair, and providing the certificate profile. This command is used when certificate profiles are enabled on the account.
Command:
smctl keypair generate <algorithm> <key alias> --generate-cert --cert-alias <cert alias> --cert-profile-id <cert_profile_ID>
Command sample:
smctl keypair generate rsa RSA-KP-1 --generate-cert --cert-alias CERT-1 --cert-profile-id 022df79f-e684-4788-be16-b490cbfbc46c
既存の鍵ペア用の証明書を作成します。
証明書の生成のコマンドは、以下のように始まります。
smctl keypair generate-cert
or
smctl kp gen-cert
フラグ
証明書の生成のコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--cert-alias string | 証明書のエイリアス 形式: --cert-alias="<value>" | |
--cert-profile-id string | 証明書プロファイルID。 形式: --cert-profile-id="<value>" | |
--custom-fields stringToString | CertCentral プロファイルの場合、カスタムフィールドを指定します。デフォルトは[]です。 形式: --custom-fields="<value>" | |
--set-as-default-cert | 鍵ペアIDのデフォルトの証明書として設定します。設定しない場合は、生成された証明書がデフォルトの証明書となります。 | |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
--help | 既存の鍵ペアでの証明書の生成に関するヘルプ。 |
Examples
例
説明: 提供されている鍵ペア用の証明書を作成します。
コマンド:
smctl keypair generate-cert <keypair id>
コマンドの例:
smctl keypair generate-cert 7747527b-6cc0-4ccf-8099-a6df1bf90bc14
Generate a key and certificate with different aliases
Generate a keypair and certificate with different aliases by referencing the an alias for the certificate, keypair, and providing the certificate profile. This command is used when certificate profiles are enabled on the account.
Command:
smctl keypair generate rsa <key alias> --generate-cert --cert-alias <cert alias> --cert-profile-id <cert_profile_ID>
Command sample:
smctl keypair generate rsa RSA-KP-1 --generate-cert --cert-alias CERT-1 --cert-profile-id 022df79f-e684-4788-be16-b490cbfbc46c
鍵ペアをインポートする
鍵ペアのインポートコマンドは、以下のように始まります。
smctl keypair import
フラグ
鍵ペアのインポートコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--der | .Der 形式 (デフォルトは .pem) | |
-o | --offline | オフラインモードで鍵ペアをインポートする |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 鍵ペアのインポートに関するヘルプ。 |
例
説明: 指定されたエイリアスを持つ鍵ペアを .pem 形式でインポートします。
コマンド:
smctl keypair import <keypair alias> <path to private key file>
コマンドの例:
smctl keypair import keypair-dynamic-alias C:\Users\Name\Desktop\keypair.pem
鍵ペアを一覧表示する
鍵ペアを一覧表示するコマンドは、以下のように始まります。
smctl keypair list
or
smctl kp ls
フラグ
鍵ペアを一覧表示するコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
-f | --filter stringToString | エイリアス、key_alg, key_size, curve, key_statusでフィルタリングできます。デフォルトは[]です。 形式: --filter="<value>" |
--page int | ページ番号。デフォルトは -1 で、すべてのページが表示されます。 | |
--size int | ページサイズ。デフォルトは 100 です。 | |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<account ID>" | |
-h | --help | キーリングの一覧表示に関するヘルプ。 |
Examples
List all keypairs
List all keypairs in your account. This command is useful to identify keypair aliases and IDs.
Command
smctl keypair ls
Command sample
smctl keypair ls
Command sample
ID Key Modal TYPE ALIAS ALGORITHM & SIZE/CURVE STATUS TYPE STORAGE CERTIFICATE aab2e7b8-eb69-4a6b-b02f STATIC kp-1 RSA - 3072 ONLINE PRODUCTION HSM ea84d89e-8c8a-4f20 455768c5-5e4a-47b3-8fe0 DYNAMIC kp-2 ECDSA - P384 OFFLINE TEST DISK b9f65b65-ef63-4b61
例
説明: 指定されたエイリアスを持つすべての鍵ペアを一覧表示します。
コマンド:
smctl keypair ls -–filter=<keypair alias>
コマンドの例:
smctl keypair ls --filter alias=kp-1
Command output
ID Key Modal TYPE ALIAS ALGORITHM & SIZE/CURVE STATUS TYPE STORAGE CERTIFICATE aab2e7b8-eb69-4a6b-b02f STATIC kp-1 RSA - 3072 ONLINE PRODUCTION HSM ea84d89e-8c8a-4f20
鍵ペアプロファイルを一覧表示または説明します。
要件
鍵ペアプロファイルの使用は、アカウントレベルでのコントロールです。
アカウント管理者は、他のユーザーが鍵ペアプロファイルを使用することを許可または禁止することができます。
このフローは、鍵ペア生成の要件として鍵ペアプロファイルを有効にしている場合にのみ使用できます。
鍵ペアプロファイルを有効にしていない場合は、生成時にエイリアスとアルゴリズムを指定する必要があります。
コマンド
鍵ペアプロファイルのコマンドは、以下のように始まります。
smctl keypair profile
or
smctl kp profile
or
smctl keypair profiles
or
smctl keypair keypairprofile
or
smctl keypair keyprofiles
サブコマンド
鍵ペアプロファイルコマンドは、これらのサブコマンドをサポートしています。
ショートカット | サブコマンド | 説明 |
---|---|---|
desc | describe | 鍵ペアプロファイルIDの詳細を取得します。 |
ls | list | 鍵ペアプロファイルを一覧を表示します。 |
鍵ペアプロファイルを説明する
鍵ペアプロファイルの説明のコマンドは、以下のように始まります。
smctl keypair profile describe
or
smctl kp profile desc
フラグ
鍵ペアプロファイルの説明コマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 鍵ペアプロファイルに関するヘルプ。 |
例
説明: 指定された鍵ペアIDの鍵ペアプロファイルを記述・説明します。
コマンド:
smctl keypair profiles describe <keypair profile id> <account id string>
コマンドの例:
smctl keypair profiles describe a609c6e6-fc89-48ff-a071-1d7001580452
鍵ペアプロファイルを一覧表示する
鍵ペアプロファイルの一覧表示のコマンドは、以下のように始まります。
smctl keypair profile list
or
smctl kp profile ls
フラグ
鍵ペアプロファイルの一覧表示のコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 鍵ペアプロファイルに関するヘルプ。 |
例
説明:
コマンド:
smctl keypair profiles list -–filter name=<keypair profile alias>
コマンドの例:
smctl keypair profiles list -–filter name=keypair-profile-name
鍵ペアを一時停止する
鍵ペアをオフラインモードに切り替えるには、以下を実行します。
注記
鍵ペアを一時停止して、オフラインモードにします。オフラインモードの鍵ペアは、オフラインリリースによってオンラインにするか、使用するようにスケジュールしない限り、署名に使用することはできません。
鍵ペアを一時停止するコマンドは、以下のように始まります。
smctl keypair suspend
or
smctl kp suspend
フラグ
鍵ペアを一時停止するコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 鍵ペアの一時停止に関するヘルプ。 |
例
説明: 鍵ペアIDを参照し、鍵ペアをオフラインモードに切り替えます。
コマンド
smctl keypair suspend <keypair id>
コマンドの例
smctl keypair suspend a609c6e6-fc89-48ff-a071-1d7001580452
鍵ペアの一時停止を解除する
鍵ペアの一時停止を解除するコマンドは、鍵ペアをオンラインモードに切り替えます。
注記
オフラインモードの鍵ペアは、オフラインリリースによってオンラインにするか、使用するようにスケジュールしない限り、署名に使用することはできません。
鍵ペアの一時停止を解除するコマンドは、以下のように始まります。
smctl keypair unsuspend
or
smctl kp unsuspend
フラグ
鍵ペアの一時停止を解除するコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 一時停止解除に関するヘルプ。 |
例
説明する: 鍵ペアIDを参照して、鍵ペアをオンラインモードに切り替えます。
コマンド:
smctl keypair unsuspend <keypair id>
コマンドの例:
smctl keypair unsuspend a609c6e6-fc89-48ff-a071-1d7001580452
鍵ペアを更新する
鍵ペアを更新するコマンドは、次のように始まります。
smctl keypair update
or
smctl kp update
フラグ
鍵ペアを更新するコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--alias string | 鍵ペアのエイリアス 形式: --alias="<value>" | |
--default-cert-id string | デフォルトの証明書ID。 形式: --default-cert-id="<value>" | |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | 更新に関するヘルプ。 |
例
説明する: 指定された鍵ペアIDの鍵ペアのエイリアスを変更します。
コマンド:
smctl keypair update <keypair id> --alias=<new keypair alias>
コマンドの例:
smctl keypair update a609c6e6-fc89-48ff-a071-1d7001580452 -–alias=new-keypair-alias
鍵ペアのアクセス権を更新する
鍵ペアのアクセス権を更新するコマンドは、次のように始まります。
smctl keypair update-access
or
smctl kp update-access
フラグ
鍵ペアのアクセス権を更新するコマンドは、これらのフラグをサポートしています。
ショートカット | フラグ | 説明 |
---|---|---|
--groups string | 鍵ペアのグループID。 形式: --groups="<value>" | |
--operation string | 鍵ペアのアクセス権を、与えられた入力で上書きします。 形式: --operation="<value>" | |
--operation add | 既存のユーザーまたはグループに追加するために使用されます。 | |
--operation remove | ユーザーまたはグループから指定された入力を削除するために使用されます。 | |
--restricted | 制限またはオープン。デフォルトは [制限] です。 | |
--users string | 鍵ペアのユーザーID。 形式: --users="<value>" | |
--account-id string | ユーザーのアカウントID。 形式: --account-id="<value>" | |
-h | --help | アクセス権の更新に関するヘルプ。 |
例
説明: 指定された鍵ペアIDの鍵ペアアクセスを、指定されたグループで更新します。
コマンド:
smctl keypair update-access <keypair ID> --groups <user group ID>
コマンドの例:
smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 15cd4b2a-699c-4466-8c58-ceaee3e63583
説明: 指定された鍵ペアIDの鍵ペアアクセス権を更新し、既存のグループを追加します。
コマンド:
smctl keypair update-access <keypair ID> --groups <user group ID> --operation <overwrite, add or remove>
コマンドの例:
smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 7dcf0e76-362c-4410-b521-fef05b10c661 --operation add
説明: 指定された鍵ペアIDの鍵ペアアクセス権を更新し、既存のグループを削除します。
コマンド:
smctl keypair update-access <keypair ID> --groups <user group ID> --operation <overwrite, add or remove>
コマンドの例:
smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 7dcf0e76-362c-4410-b521-fef05b10c661 --operation remove