

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# CloudHSM CLI コマンドのリファレンス
<a name="cloudhsm_cli-reference"></a>

CloudHSM CLI は、管理者が AWS CloudHSM クラスター内のユーザーを管理するのに役立ちます。CloudHSM CLI は、インタラクティブモードとシングルコマンドモードの 2 つのモードで実行できます。クイックスタートについては、「[コマンドラインインターフェイス (CLI) AWS CloudHSM の開始方法](cloudhsm_cli-getting-started.md)」を参照してください。

多くの CloudHSM CLI コマンドを実行するには、CloudHSM CLI を起動し、HSM にログインする必要があります。HSM を追加または削除する場合は、CloudHSM CLI の構成ファイルを更新します。さもないと、クラスター内のすべての HSM で変更が有効にならない場合があります。

以下のトピックでは、CloudHSM CLI のコマンドについて説明します。


| コマンド | 説明 | ユーザータイプ | 
| --- | --- | --- | 
| [アクティブ化](cloudhsm_cli-cluster-activate.md) | CloudHSM クラスターをアクティブ化し、クラスターが新しいものであることを確認します。これは他のオペレーションを実行する前に行う必要があります。 | 非アクティブ管理者 | 
| [hsm-info](cloudhsm_cli-cluster-hsm-info.md) | クラスター内の HSM を一覧表示します。 | 認証されていないユーザーを含むすべての [1](#cli-ref-1)。ログインは必須ではありません。 | 
| [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md) | EC プライベートキーと ECDSA 署名機構を使用して署名を生成します。 | Crypto User (CU) | 
| [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md) | Ed25519 プライベートキーと HashEdDSA 署名メカニズムを使用して署名を生成します。 | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md) | RSA プライベートキーと RSA-PKCS 署名機構を使用して署名を生成します。 | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md) | RSA プライベートキーと RSA-PKCS-PSS 署名機構を使用して署名を生成します。 | CU | 
| [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md) | ファイルが特定のパブリックキーによって HSM で署名されていることを確認します。ECDSA 署名機構を使用して署名が生成されたことを確認します。署名されたファイルをソース ファイルと比較し、指定された ecdsa パブリックキーと署名機構に基づいて暗号的に関連するかどうかを分析します。 | CU | 
| [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md) | Ed25519 パブリックキーを使用して HashEdDSA 署名を検証します。 | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md) | ファイルが特定のパブリックキーによって HSM で署名されていることを確認します。RSA-PKCS 署名機構を使用して署名が生成されたことを確認します。署名されたファイルをソース ファイルと比較し、指定された rsa パブリックキーと署名機構に基づいて暗号的に関連するかどうかを分析します。 | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md) | ファイルが特定のパブリックキーによって HSM で署名されていることを確認します。RSA-PKCS-PSS 署名機構を使用して署名が生成されたことを確認します。署名されたファイルをソース ファイルと比較し、指定された rsa パブリックキーと署名機構に基づいて暗号的に関連するかどうかを分析します。 | CU | 
| [キー削除](cloudhsm_cli-key-delete.md) |  AWS CloudHSM クラスターからキーを削除します。 | CU | 
| [key generate-file](cloudhsm_cli-key-generate-file.md) |  AWS CloudHSM クラスターにキーファイルを生成します。 | CU | 
| [key generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) |  AWS CloudHSM クラスターに非対称 RSA キーペアを生成します。 | CU | 
| [key generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) |  AWS CloudHSM クラスターに非対称楕円曲線 (EC) キーペアを生成します。 | CU | 
| [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md) |  AWS CloudHSM クラスターに対称 AES キーを生成します。 | CU | 
| [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md) |  AWS CloudHSM クラスターに対称汎用シークレットキーを生成します。 | CU | 
| [key import pem](cloudhsm_cli-key-import-pem.md) | PEM 形式キーを HSM にインポートします。このコマンドを使用すると、HSM の外部で生成されたパブリックキーをインポートできます。 | CU | 
| [キーリスト](cloudhsm_cli-key-list.md) |  AWS CloudHSM クラスターに存在する現在のユーザーのすべてのキーを検索します。 | CU | 
| [key replicate](cloudhsm_cli-key-replicate.md) | ソースクラスターから複製先のクラスターにキーをレプリケートします。 | CU | 
| [key set-attribute](cloudhsm_cli-key-set-attribute.md) |  AWS CloudHSM クラスター内のキーの属性を設定します。 | CU はこのコマンドを実行でき、管理者は信頼できる属性を設定できます。 | 
| [キーシェア](cloudhsm_cli-key-share.md) |  AWS CloudHSM クラスター内の他の CUs とキーを共有します。 | CU | 
| [キー共有解除](cloudhsm_cli-key-unshare.md) |  AWS CloudHSM クラスター内の他の CUs とキーの共有を解除します。 | CU | 
| [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md) | AES ラッピングキーと AES-GCM ラップ解除メカニズムを使用して、ペイロードキーをクラスターにラップ解除します。 | CU | 
| [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md) | AES ラッピングキーと AES-NO-PAD ラップ解除メカニズムを使用して、ペイロードキーをクラスターにラップ解除します。 | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md) | AES ラッピングキーと AES-PKCS5-PAD ラップ解除メカニズムを使用してペイロードキーをラップ解除します。 | CU | 
| [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md) | AES ラッピングキーと AES-ZERO-PAD ラップ解除メカニズムを使用して、ペイロードキーをクラスターにラップ解除します。 | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md) | AES ラッピングキーと CLOUDHSM-AES-GCM ラップ解除メカニズムを使用して、ペイロードキーをクラスターにラップ解除します。 | CU | 
| [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md) | RSA プライベートキーと RSA-AES ラップ解除メカニズムを使用してペイロードキーをラップ解除します。 | CU | 
| [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md) | RSA プライベートキーと RSA-OAEP ラップ解除メカニズムを使用してペイロードキーをラップ解除します。 | CU | 
| [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md) | RSA プライベートキーと RSA-PKCS ラップ解除メカニズムを使用してペイロードキーをラップ解除します。 | CU | 
| [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md) | HSM の AES キーと AES-GCM ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md) | HSM の AES キーと AES-NO-PAD ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md) | HSM の AES キーと AES-PKCS5-PAD ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md) | HSM の AES キーと AES-ZERO-PAD ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md) | HSM の AES キーと CLOUDHSM-AES-GCM ラッピングメカニズムを使用してペイロードキーをラップします。 | CU | 
| [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md) | HSM の RSA パブリックキーと RSA-AES ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md) | HSM の RSA パブリックキーと RSA-OAEP ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [ CloudHSM CLI で RSA-PKCS でキーをラップするrsa-pkcs  **key wrap rsa-pkcs** コマンドは、HSM の RSA パブリックキーと `RSA-PKCS` ラップメカニズムを使用してペイロードキーをラップします。   CloudHSM CLI の **key wrap rsa-pkcs** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の RSA パブリックキーと `RSA-PKCS` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。 キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。 **key wrap rsa-pkcs** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA キーが必要です。[CloudHSM CLI の generate-asymmetric-pair カテゴリ](cloudhsm_cli-key-generate-asymmetric-pair.md) コマンドと `true` に設定された `wrap` 属性を使用して、RSA キーペアを生成できます。  ユーザーのタイプ  このコマンドは、次のタイプのユーザーが実行できます。   Crypto User (CU)     要件    このコマンドを実行するには、CU としてログインする必要があります。     Syntax  

```
aws-cloudhsm > help key wrap rsa-pkcs
Usage: key wrap rsa-pkcs [OPTIONS] --payload-filter [{{<PAYLOAD_FILTER>}}...] --wrapping-filter [{{<WRAPPING_FILTER>}}...]

Options:
      --cluster-id {{<CLUSTER_ID>}}
          Unique Id to choose which of the clusters in the config file to run the operation against. If not provided, will fall back to the value provided when interactive mode was started, or error
      --payload-filter [{{<PAYLOAD_FILTER>}}...]
          Key reference (e.g. key-reference=0xabc) or space separated list of key attributes in the form of attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE to select a payload key
      --wrapping-filter [{{<WRAPPING_FILTER>}}...]
          Key reference (e.g. key-reference=0xabc) or space separated list of key attributes in the form of attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE to select a wrapping key
      --path {{<PATH>}}
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval {{<WRAPPING_APPROVALR>}}
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval {{<PAYLOAD_APPROVALR>}}
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```   例  この例では、RSA パブリックキーを使用して **key wrap rsa-pkcs** コマンドを使用する方法を示しています。 

**Example**  

```
aws-cloudhsm > key wrap rsa-pkcs --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000007008da",
    "wrapped_key_data": "am0Nc7+YE8FWs+5HvU7sIBcXVb24QA0l65nbNAD+1bK+e18BpSfnaI3P+r8Dp+pLu1ofoUy/vtzRjZoCiDofcz4EqCFnGl4GdcJ1/3W/5WRvMatCa2d7cx02swaeZcjKsermPXYRO1lGlfq6NskwMeeTkV8R7Rx9artFrs1y0DdIgIKVaiFHwnBIUMnlQrR2zRmMkfwU1jxMYmOYyD031F5VbnjSrhfMwkww2la7uf/c3XdFJ2+0Bo94c6og/yfPcpOOobJlITCoXhtMRepSdO4OggYq/6nUDuHCtJ86pPGnNahyr7+sAaSI3a5ECQLUjwaIARUCyoRh7EFK3qPXcg=="
  }
```   引数   

**{{<CLUSTER\_ID>}}**  
このオペレーションを実行するクラスターの ID。  
必須: 複数のクラスターが[設定](cloudhsm_cli-configs-multi-cluster.md)されている場合。 

**{{<PAYLOAD\_FILTER>}}**  
ペイロードキーを選択する `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のキーリファレンス (例: `key-reference=0xabc`) またはスペース区切りリスト。  
必須: はい 

**{{<PATH>}}**  
ラップされたキーデータを保存するバイナリファイルへのパス。  
必須: いいえ 

**{{<WRAPPING\_FILTER>}}**  
ラッピングキーを選択する `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のキーリファレンス (例: `key-reference=0xabc`) またはスペース区切りリスト。  
必須: はい 

**{{<WRAPPING\_APPROVALR>}}**  
ラッピングキーのオペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。ラッピングキーのキー管理サービスのクォーラム値が 1 より大きい場合にのみ必要です。 

**{{<PAYLOAD\_APPROVALR>}}**  
ペイロードキーのオペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。ペイロードキーのキー管理サービスのクォーラム値が 1 より大きい場合にのみ必要です。    関連トピック    [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)   [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)    ](cloudhsm_cli-key-wrap-rsa-pkcs.md) | HSM の RSA パブリックキーと RSA-PKCS ラップメカニズムを使用してペイロードキーをラップします。 | CU | 
| [login](cloudhsm_cli-login.md) (ログイン) |  AWS CloudHSM クラスターにログインします。 | Admin、Crypto User (CU)、および Appliance User (AU) | 
| [logout](cloudhsm_cli-logout.md) (サインアウト) |  AWS CloudHSM クラスターからログアウトします。 | Admin、CU、および Appliance User (AU) | 
| [quorum token-sign delete](cloudhsm_cli-qm-token-del.md) | クォーラム承認サービスのトークンを 1 つ以上削除します。 | 管理者 | 
| [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md) | クォーラム承認サービスのトークンを生成します。 | 管理者 | 
| [quorum token-sign list](cloudhsm_cli-qm-token-list.md) | CloudHSM クラスターに存在するすべてのトークン署名のクォーラムトークンを一覧表示します。 | 認証されていないユーザーを含むすべての [1](#cli-ref-1)。ログインは必須ではありません。 | 
| [quorum token-sign list-quorum-values](cloudhsm_cli-qm-token-list-qm.md) | CloudHSM クラスターに設定されているクォーラム値を一覧表示します。 | 認証されていないユーザーを含むすべての [1](#cli-ref-1)。ログインは必須ではありません。 | 
| [quorum token-sign set-quorum-value](cloudhsm_cli-qm-token-set-qm.md) | クォーラム認定サービスの新しいクォーラム値を設定します。 | 管理者 | 
| [user change-mfa](cloudhsm_cli-user-change-mfa.md) | ユーザーの多要素認証 (MFA) 戦略を変更します。 | Admin、CU | 
| [user change-password](cloudhsm_cli-user-change-password.md) | HSM 上のユーザーのパスワードを変更します。どのユーザーも自分のパスワードを変更できます。管理者は誰でもパスワードを変更できます。 | Admin、CU | 
| [user create](cloudhsm_cli-user-create.md) |  AWS CloudHSM クラスターにユーザーを作成します。 | 管理者 | 
| [user delete](cloudhsm_cli-user-delete.md) |  AWS CloudHSM クラスター内のユーザーを削除します。 | 管理者 | 
| [user list](cloudhsm_cli-user-list.md) |  AWS CloudHSM クラスター内のユーザーを一覧表示します。 | 認証されていないユーザーを含むすべての [1](#cli-ref-1)。ログインは必須ではありません。 | 
| [ユーザー変更クォーラムトークン署名登録](cloudhsm_cli-user-chqm-token-reg.md) | ユーザーのクォーラムトークン署名クォーラム戦略を登録します。 | 管理者 | 

**注釈**
+ [1] すべてのユーザーには、リストされているすべてのロールとログインしていないユーザーが含まれます。