

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

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

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

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

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

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

***<PAYLOAD\$1APPROVALR>***  
ペイロードキーのオペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。ペイロードキーのキー管理サービスのクォーラム値が 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] すべてのユーザーには、リストされているすべてのロールとログインしていないユーザーが含まれます。

# CloudHSM CLI のクラスターカテゴリ
<a name="cloudhsm_cli-cluster"></a>

CloudHSM CLI では、**cluster** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせるとクラスター固有のコマンドを作成します。現在、クラスターカテゴリは以下のコマンドで構成されています。

**Topics**
+ [アクティブ化](cloudhsm_cli-cluster-activate.md)
+ [hsm-info](cloudhsm_cli-cluster-hsm-info.md)
+ [mtls](cloudhsm_cli-cluster-mtls.md)

# CloudHSM CLI でクラスターをアクティブ化する
<a name="cloudhsm_cli-cluster-activate"></a>

CloudHSM CLI の **cluster activate** コマンドを使用して AWS CloudHSMで[新しいクラスターをアクティブ化](activate-cluster.md)します。クラスターを使用して暗号化オペレーションを実行するには、まずこのコマンドを実行する必要があります。

## ユーザーのタイプ
<a name="cluster-activate-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 非アクティブ管理者

## 構文
<a name="chsm-cli-cluster-activate-syntax"></a>

このコマンドにはパラメータはありません。

```
aws-cloudhsm > help cluster activate
Activate a cluster

This command will set the initial Admin password. This process will cause your CloudHSM cluster to
move into the ACTIVE state.

USAGE:
    cloudhsm-cli cluster activate [OPTIONS] [--password <PASSWORD>]

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

      --password <PASSWORD>
          Optional: Plaintext activation password If you do not include this argument you will be prompted for it

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="chsm-cli-cluster-activate-examples"></a>

このコマンドは、管理者ユーザーの初期パスワードを設定してクラスターをアクティブ化します。

```
aws-cloudhsm > cluster activate
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": "Cluster activation successful"
}
```

## 関連トピック
<a name="chsm-cluster-activate-seealso"></a>
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)

# CloudHSM CLI で HSM を一覧表示する
<a name="cloudhsm_cli-cluster-hsm-info"></a>

CloudHSM CLI の **cluster hsm-info** コマンドを使用して、 AWS CloudHSM クラスター内のハードウェアセキュリティモジュール (HSMsを一覧表示します。このコマンドは、CloudHSM CLI にログインしていなくても実行できます。

**注記**  
HSMs を追加または削除する場合は、 AWS CloudHSM クライアントとコマンドラインツールが使用する設定ファイルを更新します。そうしないと、クラスター内のすべての HSM で変更が有効にならない場合があります。

## ユーザーのタイプ
<a name="chsm-cluster-hsm-info-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ すべてのユーザー。このコマンドは、ログインしていなくても実行できます。

## Syntax
<a name="chsm-cluster-hsm-info-syntax"></a>

```
aws-cloudhsm > help cluster hsm-info
List info about each HSM in the cluster

Usage: cloudhsm-cli cluster hsm-info [OPTIONS]

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
  -h, --help                     Print help
```

## 例
<a name="chsm-cluster-hsm-info-examples"></a>

このコマンドは、 AWS CloudHSM クラスターに存在する HSMsを一覧表示します。

```
aws-cloudhsm > cluster hsm-info
{
  "error_code": 0,
  "data": {
    "hsms": [
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000590",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      },
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000625",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      },
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000663",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      }
    ]
  }
}
```

出力には以下の属性があります。
+ **Vendor**: HSM のベンダー名。
+ **Model**: HSM のモデル番号。
+ **Serial-number**: デバイスのシリアル番号。置換により変更される場合があります。
+ **Hardware-version-major**: ハードウェアのメジャーバージョン。
+ **Hardware-version-minor**: ハードウェアのマイナーバージョン。
+ **Firmware-version-major**: メジャーファームウェアバージョン。
+ **Firmware-version-minor**: マイナーファームウェアバージョン。
+ **Firmware-build-number**: ファームウェアビルド番号。
+ **Firmware-id**: ファームウェア ID。ビルドに加えてメジャーバージョンとマイナーバージョンが含まれます。
+ **FIPS-state**: クラスターとその中の HSM の FIPS モード。FIPS モードの場合、出力は「2 [単一要素認証の FIPS モード]」です。非 FIPS モードの場合、出力は「0 [単一要素認証の非 FIPS モード]」です。

## 関連トピック
<a name="chsm-cluster-hsm-info-seealso"></a>
+ [CloudHSM CLI でクラスターをアクティブ化する](cloudhsm_cli-cluster-activate.md)

# CloudHSM CLI のクラスター mtls カテゴリ
<a name="cloudhsm_cli-cluster-mtls"></a>

CloudHSM CLI では、 **cluster mtls**はコマンドグループの親カテゴリであり、親カテゴリと組み合わせると、 AWS CloudHSM クラスターに固有のコマンドが作成されます。現在、このカテゴリは次のコマンドで構成されています。

**Topics**
+ [deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md)
+ [get-enforcement](cloudhsm_cli-cluster-mtls-get-enforcement.md)
+ [list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md)
+ [register-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md)
+ [set-enforcement](cloudhsm_cli-cluster-mtls-set-enforcement.md)

# CloudHSM CLI でトラストアンカーの登録を解除する
<a name="cloudhsm_cli-cluster-mtls-deregister-trust-anchor"></a>

CloudHSM CLI の **cluster mtls deregister-trust-anchor** コマンドを使用して、クライアントと AWS CloudHSMの間の相互 TLS のトラストアンカーを登録解除します。

## ユーザーのタイプ
<a name="cluster-mtls-deregister-trust-anchor-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者

## 要件
<a name="cluster-mtls-deregister-trust-anchor-requirements"></a>
+ このコマンドを実行するには、管理者ユーザーとしてログインする必要があります。

## Syntax
<a name="cluster-mtls-deregister-trust-anchor-syntax"></a>

```
aws-cloudhsm > help cluster mtls deregister-trust-anchor
            
Deregister a trust anchor for mtls

Usage: cluster mtls deregister-trust-anchor [OPTIONS] --certificate-reference [<CERTIFICATE_REFERENCE>...]

Options:
      --certificate-reference <CERTIFICATE_REFERENCE>  A hexadecimal or decimal certificate reference
      --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
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## 例
<a name="cluster-mtls-deregister-trust-anchor-examples"></a>

**Example**  
次の例では、このコマンドは HSM からトラストアンカーを削除します。  

```
aws-cloudhsm > cluster mtls deregister-trust-anchor --certificate-reference 0x01
                
{
  "error_code": 0,
  "data": {
    "message": "Trust anchor with reference 0x01 deregistered successfully"
  }
}
```
その後、次のように **list-trust-anchors** コマンドを実行して、トラストアンカーが AWS CloudHSMから登録解除されたことを確認できます。  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": []
  }
}
```

## 引数
<a name="cluster-mtls-deregister-trust-anchor-arguments"></a>

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

** *<CERTIFICATE\$1REFERENCE>* **  
16 進数または 10 進数の証明書リファレンス。  
 **必須:** はい  
クラスター内のトラストアンカーの登録を解除すると、そのトラストアンカーによって署名されたクライアント証明書を使用した既存の mTLS 接続はすべて削除されます。

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

## 関連トピック
<a name="cluster-mtls-deregister-trust-anchor-seealso"></a>
+  [cluster mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [cluster mtls list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md) 
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI で mTLS 適用レベルを取得する
<a name="cloudhsm_cli-cluster-mtls-get-enforcement"></a>

CloudHSM CLI の **cluster mtls get-enforcement** コマンドを使用して、クライアントと AWS CloudHSMの間の相互 TLS の使用の適用レベルを取得します。

## ユーザーのタイプ
<a name="cluster-mtls-get-enforcement-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## 要件
<a name="cluster-mtls-get-enforcement-requirements"></a>
+ このコマンドを実行するには、管理者ユーザーまたは Crypto User (CU) としてログインする必要があります。

## Syntax
<a name="cluster-mtls-get-enforcement-syntax"></a>

```
aws-cloudhsm > help cluster mtls get-enforcement
            
Get the status of mtls enforcement in the cluster

Usage: cluster mtls get-enforcement [OPTIONS]

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
  -h, --help                     Print help
```

## 例
<a name="cluster-mtls-get-enforcement-examples"></a>

**Example**  
次の例では、このコマンドは AWS CloudHSMの mtls 適用レベルを一覧表示します。  

```
aws-cloudhsm > cluster mtls get-enforcement
                
{
  "error_code": 0,
  "data": {
    "mtls-enforcement-level": "none"
  }
}
```

## 引数
<a name="cluster-mtls-get-enforcement-arguments"></a>

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

## 関連トピック
<a name="cluster-mtls-get-enforcement-seealso"></a>
+  [cluster mtls set-enforcement](cloudhsm_cli-cluster-mtls-set-enforcement.md) 
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI でトラストアンカーを一覧表示する
<a name="cloudhsm_cli-cluster-mtls-list-trust-anchors"></a>

CloudHSM CLI の **cluster mtls list-trust-anchors** コマンドを使用して、クライアントと AWS CloudHSMの間の相互 TLS に使用できるすべてのトラストアンカーを一覧表示します。

## ユーザーのタイプ
<a name="cluster-mtls-list-trust-anchors-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ すべてのユーザー。このコマンドは、ログインしていなくても実行できます。

## Syntax
<a name="cluster-mtls-list-trust-anchors-syntax"></a>

```
aws-cloudhsm > help cluster mtls list-trust-anchors
            
List all trust anchors for mtls

Usage: cluster mtls list-trust-anchors [OPTIONS]

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
  -h, --help                     Print help
```

## 例
<a name="cluster-mtls-list-trust-anchors-examples"></a>

**Example**  
次の例では、このコマンドは AWS CloudHSMから登録されたすべてのトラストアンカーを一覧表示します。  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": [
      {
        "certificate-reference": "0x01",
        "certificate": "<PEM Encoded Certificate 1>",
        "cluster-coverage": "full"
      },
      {
        "certificate-reference": "0x02",
        "certificate": "<PEM Encoded Certificate 2>",
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## 引数
<a name="cluster-mtls-list-trust-anchors-arguments"></a>

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

## 関連トピック
<a name="cluster-mtls-register-trust-anchor-seealso"></a>
+  [cluster mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [cluster mtls deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md) 
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI でトラストアンカーを登録する
<a name="cloudhsm_cli-cluster-mtls-register-trust-anchor"></a>

CloudHSM CLI の **cluster mtls register-trust-anchor** コマンドを使用して、クライアントと AWS CloudHSMの間の相互 TLS のトラストアンカーを登録します。

## ユーザーのタイプ
<a name="cluster-mtls-register-trust-anchor-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者

## 要件
<a name="cluster-mtls-register-trust-anchor-requirements"></a>

は、次のキータイプのトラストアンカー AWS CloudHSM を受け入れます。


****  

| キータイプ | 説明 | 
| --- | --- | 
| EC |  secp256r1 (P-256)、secp384r1 (P-384)、および secp521r1 (P-521) 曲線。 | 
| RSA |  2048 ビット、3072 ビット、および 4096 ビットの RSA キー。 | 

## Syntax
<a name="cluster-mtls-register-trust-anchor-syntax"></a>

```
aws-cloudhsm > help cluster mtls register-trust-anchor
            
Register a trust anchor for mtls

Usage: cluster mtls register-trust-anchor [OPTIONS] --path [<PATH>...]

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
      --path <PATH>  Filepath of the trust anchor to register
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## 例
<a name="cluster-mtls-register-trust-anchor-examples"></a>

**Example**  
次の例では、このコマンドはトラストアンカーを HSM に登録します。登録できるトラストアンカーの最大数は 2 個です。  

```
aws-cloudhsm > cluster mtls register-trust-anchor --path /home/rootCA
                
{
  "error_code": 0,
  "data": {
    "trust_anchor": {
      "certificate-reference": "0x01",
      "certificate": "<PEM Encoded Certificate>",
      "cluster-coverage": "full"
    }
  }
}
```
その後、次のように **list-trust-anchors** コマンドを実行して、トラストアンカーが AWS CloudHSMに登録されたことを確認できます。  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": [
      {
        "certificate-reference": "0x01",
        "certificate": "<PEM Encoded Certificate>",
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## 引数
<a name="cluster-mtls-register-trust-anchor-arguments"></a>

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

** *<PATH>* **  
登録するトラストアンカーのファイルパス。  
 **必須:** はい  
AWS CloudHSM では、中間証明書をトラストアンカーとして登録できます。このような場合は、PEM でエンコードされた証明書チェーンファイル全体を、証明書を階層順にして、HSM に登録する必要があります。  
 AWS CloudHSM は、6980 バイトの証明書チェーンをサポートします。

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

## 関連トピック
<a name="cluster-mtls-register-trust-anchor-seealso"></a>
+  [cluster mtls deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md) 
+  [cluster mtls list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md) 
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI で mTLS 適用レベルを設定する
<a name="cloudhsm_cli-cluster-mtls-set-enforcement"></a>

CloudHSM CLI の **cluster mtls set-enforcement** コマンドを使用して、クライアントと AWS CloudHSMの間の相互 TLS の使用の適用レベルを設定します。

## ユーザーのタイプ
<a name="cluster-mtls-set-enforcement-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ ユーザー名 admin を使用する管理者

## 要件
<a name="cluster-mtls-set-enforcement-requirements"></a>

このコマンドを実行するには:
+ 少なくとも 1 つのトラストアンカーが AWS CloudHSMに正常に登録されました。
+ 適切なプライベートキーとクライアント証明書を使用して CloudHSM CLI を設定し、相互 TLS 接続で CloudHSM CLI を起動します。
+ デフォルトの管理者として「admin」というユーザー名でログインする必要があります。他の管理者ユーザーは、このコマンドを実行できません。

## Syntax
<a name="cluster-mtls-set-enforcement-syntax"></a>

```
aws-cloudhsm > help cluster mtls set-enforcement
            
Set mtls enforcement policy in the cluster

Usage: cluster mtls set-enforcement [OPTIONS] --level [<LEVEL>...]

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
      --level <LEVEL>  Level to be set for mtls in the cluster [possible values: none, cluster]
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## 例
<a name="cluster-mtls-set-enforcement-examples"></a>

**Example**  
次の例では、このコマンドは の mtls 適用レベル AWS CloudHSM をクラスターに設定します。set-enforcement コマンドは、相互 TLS 接続で、かつ、ユーザー名を admin とする管理者ユーザーとしてログインした場合のみ実行できます。「[AWS CloudHSMに対して mTLS 適用を設定する](getting-started-setup-mtls.md#getting-start-setup-mtls-enforcement)」を参照してください。  

```
aws-cloudhsm > cluster mtls set-enforcement --level cluster
                
{
  "error_code": 0,
  "data": {
    "message": "Mtls enforcement level set to Cluster successfully"
  }
}
```
その後、**get-enforcement** コマンドを実行して、適用レベルがクラスターに設定されたことを確認できます。  

```
aws-cloudhsm > cluster mtls get-enforcement
                
{
  "error_code": 0,
  "data": {
    "mtls-enforcement-level": "cluster"
  }
}
```

## 引数
<a name="cluster-mtls-set-enforcement-arguments"></a>

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

** *<LEVEL>* **  
クラスター内の mtls に設定するレベル。  
 **有効な値**   
+  cluster****: クライアントとクラスター AWS CloudHSM 間の相互 TLS の使用を強制します。
+  **none**: クライアントとクラスター AWS CloudHSM 間の相互 TLS の使用を強制しないでください。
 **必須:** はい  
クラスターで mTLS の使用を適用すると、既存の非 mTLS 接続はすべて削除され、mTLS 証明書を持つクラスターにのみ接続できます。

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

## 関連トピック
<a name="cluster-mtls-set-enforcement-seealso"></a>
+  [cluster mtls get-enforcement](cloudhsm_cli-cluster-mtls-get-enforcement.md) 
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI の暗号化カテゴリ
<a name="cloudhsm_cli-crypto"></a>

CloudHSM CLI では、**crypto** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせると暗号オペレーション固有のコマンドを作成します。現在、このカテゴリは次のコマンドで構成されています。
+ [サイン](cloudhsm_cli-crypto-sign.md)
  + [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md)
  + [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md)
  + [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md)
  + [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md)
+ [検証](cloudhsm_cli-crypto-verify.md)
  + [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md)
  + [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md)
  + [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md)
  + [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md)

# CloudHSM CLI の暗号化署名カテゴリ
<a name="cloudhsm_cli-crypto-sign"></a>

CloudHSM CLI では、**crypto sign** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせると、 AWS CloudHSM クラスター内で選択したプライベートキーを使用して署名を生成します。**crypto sign** には、次のサブコマンドがあります。
+ [CloudHSM CLI で ECDSA メカニズムを使用して署名を生成する](cloudhsm_cli-crypto-sign-ecdsa.md)
+ [CloudHSM CLI で HashEdDSA メカニズムを使用して署名を生成する](cloudhsm_cli-crypto-sign-ed25519ph.md)
+ [CloudHSM CLI で RSA-PKCS メカニズムを使用して署名を生成する](cloudhsm_cli-crypto-sign-rsa-pkcs.md)
+ [CloudHSM CLI で RSA-PKCS-PSS メカニズムを使用して署名を生成する](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md)

**crypto sign** を使用するには、HSM 内にプライベートキーが必要です。プライベートキーは、次のコマンドで生成できます。
+ [key generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [key generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# CloudHSM CLI で ECDSA メカニズムを使用して署名を生成する
<a name="cloudhsm_cli-crypto-sign-ecdsa"></a>

CloudHSM CLI の **crypto sign ecdsa** コマンドを使用して、EC プライベートキーと ECDSA 署名メカニズムを使用して署名を生成します。

**crypto sign ecdsa** コマンドを使用するには、まず AWS CloudHSM クラスターに EC プライベートキーが必要です。`sign` 属性を `true` に設定して、[CloudHSM CLI を使用して非対称 EC キーペアを生成する](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) コマンドを使用して EC プライベートキーを生成できます。

生成される ECDSA 署名は、r と のコンポーネントが raw バイナリデータとして連結され`r||s`、base64 でエンコードされた形式で返される 形式で生成されます。

**注記**  
署名は、 [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md) サブコマンド AWS CloudHSM を使用して で検証できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-sign-ecdsa-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-sign-ecdsa-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-sign-ecdsa-syntax"></a>

```
aws-cloudhsm > help crypto sign ecdsa
Sign with the ECDSA mechanism

Usage: crypto sign ecdsa --key-filter [<KEY_FILTER>>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-sign-ecdsa-examples"></a>

これらの例は、**crypto sign ecdsa** を使用して、ECDSA 署名メカニズムと `SHA256` ハッシュ関数を使用して署名を生成する方法を示しています。このコマンドは HSM でプライベートキーを使用します。

**Example 例: ベース 64 でエンコードされたデータの署名を生成する**  

```
aws-cloudhsm > crypto sign ecdsa --key-filter attr.label=ec-private --hash-function sha256 --data YWJjMTIz
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007808dd",
    "signature": "4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw=="
  }
}
```

**Example 例: データファイルの署名を生成する**  

```
aws-cloudhsm > crypto sign ecdsa --key-filter attr.label=ec-private --hash-function sha256 --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007808dd",
    "signature": "4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw=="
  }
}
```

## 引数
<a name="cloudhsm_cli-crypto-sign-ecdsa-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データパスを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キー参照 (例: `key-reference=0xabc`) または attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。プライベートキーのキー使用サービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-sign-ecdsa-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI で HashEdDSA メカニズムを使用して署名を生成する
<a name="cloudhsm_cli-crypto-sign-ed25519ph"></a>

**重要**  
HashEdDSA 署名オペレーションは、非 FIPS モードの hsm2m.medium インスタンスでのみサポートされています。

CloudHSM CLI の **crypto sign ed25519ph** コマンドを使用して、Ed25519 プライベートキーと HashEdDSA 署名メカニズムを使用して署名を生成します。HashEdDSA の詳細については、[NIST SP 186-5、セクション 7.8 ](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf)を参照してください。

**crypto sign ed25519ph** コマンドを使用するには、まず AWS CloudHSM クラスターに Ed25519 プライベートキーが必要です。`curve` パラメータを に設定`ed25519`し、`sign`属性を に設定して、 [CloudHSM CLI を使用して非対称 EC キーペアを生成する](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) コマンドを使用して Ed25519 プライベートキーを生成できます`true`。

**注記**  
署名は、 [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md) サブコマンド AWS CloudHSM を使用して で検証できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-sign-ed25519ph-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-sign-ed25519ph-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。
+ HashEdDSA 署名オペレーションは、非 FIPS モードの hsm2m.medium インスタンスでのみサポートされています。

## Syntax
<a name="cloudhsm_cli-crypto-sign-ed25519ph-syntax"></a>

```
aws-cloudhsm > help crypto sign ed25519ph
Sign with the Ed25519ph mechanism

Usage: crypto sign ed25519ph [OPTIONS] --key-filter [<KEY_FILTER>...] --data-type <DATA_TYPE> --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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 matching key
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --hash-function <HASH_FUNCTION>
          Hash function [possible values: sha512]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-sign-ed25519ph-examples"></a>

これらの例は、 **crypto sign ed25519ph**を使用して Ed25519ph 署名メカニズムと`sha512`ハッシュ関数を使用して署名を生成する方法を示しています。このコマンドは HSM でプライベートキーを使用します。

**Example 例: ベース 64 でエンコードされたデータの署名を生成する**  

```
aws-cloudhsm > crypto sign ed25519ph \
    --key-filter attr.label=ed25519-private \
    --data-type raw \
    --hash-function sha512 \
    --data YWJj
{
  "error_code": 0,
  "data": {
    "key-reference": "0x0000000000401cdf",
    "signature": "mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg=="
  }
}
```

**Example 例: データファイルの署名を生成する**  

```
aws-cloudhsm > crypto sign ed25519ph \
    --key-filter attr.label=ed25519-private \
    --data-type raw \
    --hash-function sha512 \
    --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x0000000000401cdf",
    "signature": "mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg=="
  }
}
```

## 引数
<a name="cloudhsm_cli-crypto-sign-ed25519ph-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データパラメータで指定されない限り)

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。Ed25519ph は SHA512 のみをサポートします。  
有効な値:  
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キー参照 (例: `key-reference=0xabc`) または attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「」を参照してください[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)。  
必須: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。プライベートキーのキー使用サービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト
必須: はい

## 関連トピック
<a name="cloudhsm_cli-crypto-sign-ed25519ph-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI で RSA-PKCS メカニズムを使用して署名を生成する
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs"></a>

CloudHSM CLI の **crypto sign rsa-pkcs** コマンドを使用して、RSA プライベートキーと RSA-PKCS 署名メカニズムを使用して署名を生成します。

**crypto sign rsa-pkcs** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA プライベートキーが必要です。`sign` 属性を `true` に設定して、[CloudHSM CLI で非対称 RSA キーペアを生成する](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) コマンドを使用して RSA プライベートキーを生成できます。

**注記**  
署名は、 [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md) サブコマンド AWS CloudHSM を使用して で検証できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto sign rsa-pkcs
Sign with the RSA-PKCS mechanism

Usage: crypto sign rsa-pkcs --key-filter [<KEY_FILTER>>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-examples"></a>

これらの例は、**crypto sign rsa-pkcs** を使用して、RSA-PKCS 署名メカニズムと `SHA256` ハッシュ関数を使用して署名を生成する方法を示しています。このコマンドは HSM でプライベートキーを使用します。

**Example 例: ベース 64 でエンコードされたデータの署名を生成する**  

```
aws-cloudhsm > crypto sign rsa-pkcs --key-filter attr.label=rsa-private --hash-function sha256 --data YWJjMTIz
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ=="
  }
}
```

**Example 例: データファイルの署名を生成する**  

```
aws-cloudhsm > crypto sign rsa-pkcs --key-filter attr.label=rsa-private --hash-function sha256 --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ=="
  }
}
```

## 引数
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。プライベートキーのキー使用サービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
RSA-PKCS の場合、データは [RFC 8017、セクション 9.2](https://www.rfc-editor.org/rfc/rfc8017#section-9.2) で規定されている DER エンコード形式で渡す必要があります。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI で RSA-PKCS-PSS メカニズムを使用して署名を生成する
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-pss"></a>

CloudHSM CLI の **crypto sign rsa-pkcs-pss** コマンドを使用して、RSA プライベートキーと `RSA-PKCS-PSS` 署名メカニズムを使用して署名を生成します。

**crypto sign rsa-pkcs-pss** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA プライベートキーが必要です。`sign` 属性を `true` に設定して、[CloudHSM CLI で非対称 RSA キーペアを生成する](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) コマンドを使用して RSA プライベートキーを生成できます。

**注記**  
署名は、 [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md) サブコマンド AWS CloudHSM を使用して で検証できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto sign rsa-pkcs-pss
Sign with the RSA-PKCS-PSS mechanism

Usage: crypto sign rsa-pkcs-pss [OPTIONS] --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --salt-length <SALT_LENGTH> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>  [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>          The path to the file containing the data to be signed
      --data <DATA>                    Base64 Encoded data to be signed
      --mgf <MGF>                      The mask generation function [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --salt-length <SALT_LENGTH>      The salt length
      --approval <APPROVAL>            Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help                           Print help
```

## 例
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-examples"></a>

これらの例は、**crypto sign rsa-pkcs-pss** を使用して、`RSA-PKCS-PSS` 署名メカニズムと `SHA256` ハッシュ関数を使用して署名を生成する方法を示しています。このコマンドは HSM でプライベートキーを使用します。

**Example 例: ベース 64 でエンコードされたデータの署名を生成する**  

```
aws-cloudhsm > crypto sign rsa-pkcs-pss --key-filter attr.label=rsa-private --hash-function sha256 --data YWJjMTIz --salt-length 10 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg=="
  }
}
```

**Example 例: データファイルの署名を生成する**  

```
aws-cloudhsm > crypto sign rsa-pkcs-pss --key-filter attr.label=rsa-private --hash-function sha256 --data-path data.txt --salt-length 10 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg=="
  }
}
```

## 引数
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<MGF>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効な値:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

***<SALT\$1LENGTH>***  
ソルトの長さを指定します。  
必須: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。プライベートキーのキー使用サービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

## 関連トピック
<a name="cloudhsm_cli-crypto-sign-seealso"></a>
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI の暗号化検証カテゴリ
<a name="cloudhsm_cli-crypto-verify"></a>

CloudHSM CLI では、**crypto verify** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせるとファイルが指定されたキーによって署名されているかどうかを確認します。**crypto verify** には次のサブコマンドがあります。
+ [crypto verify ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md)
+ [暗号化検証 ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md)
+ [crypto verify rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md)
+ [crypto verify rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md)

**crypto verify** コマンドは、署名されたファイルをソースファイルと比較し、両者が指定されたパブリックキーと署名メカニズムに基づいて暗号的に関連するかどうかを分析します。

**注記**  
ファイルは [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)オペレーション AWS CloudHSM でサインインできます。

# CloudHSM CLI で ECDSA メカニズムを使用して署名された署名を検証する
<a name="cloudhsm_cli-crypto-verify-ecdsa"></a>

CloudHSM CLI の **crypto verify ecdsa** コマンドを使用して、次のオペレーションを完了します。
+ 指定されたパブリックキーによって HSM でファイルが署名されていることを確認します。
+ ECDSA 署名メカニズムを使用して署名が生成されたことを検証します。
+ 署名されたファイルをソースファイルと比較し、両者が指定された ecdsa パブリックキーと署名メカニズムに基づいて暗号的に関連するかどうかを判断します。
+  ECDSA 検証関数は、r と のコンポーネントが raw バイナリデータとして連結される `r||s`形式の署名を想定しています。

**crypto verify ecdsa** コマンドを使用するには、まず AWS CloudHSM クラスターに EC パブリックキーが必要です。`verify` 属性を `true` に設定して [CloudHSM CLI で PEM 形式キーをインポートする](cloudhsm_cli-key-import-pem.md) コマンドを使用して、EC パブリックキーをインポートできます。

**注記**  
CloudHSM CLI の [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md) サブコマンドを使用して署名を生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-verify-ecdsa-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-verify-ecdsa-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-verify-ecdsa-syntax"></a>

```
aws-cloudhsm > help crypto verify ecdsa
Verify with the ECDSA mechanism

Usage: crypto verify ecdsa --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-verify-ecdsa-examples"></a>

これらの例は、**crypto verify ecdsa** を使用して、ECDSA 署名メカニズムと `SHA256` ハッシュ関数を使用して生成された署名を検証する方法を示しています。このコマンドは HSM でパブリックキーを使用します。

**Example 例: Base64 でエンコードされた署名を Base64 でエンコードされたデータで検証する**  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data YWJjMTIz --signature 4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: データファイルを使用して署名ファイルを検証する**  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data-path data.txt --signature-path signature-file
{
   "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: 偽の署名関係を証明する**  
このコマンドは、`/home/data` にあるデータが、ラベル `ecdsa-public` 付きのパブリックキーによって、`/home/signature` にある署名を生成する ECDSA 署名メカニズムを使用して署名されたかどうかを検証します。指定の引数が真の署名関係を構成していないため、コマンドは、エラーメッセージを返します。  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data aW52YWxpZA== --signature +ogk7M7S3iTqFg3SndJfd91dZFr5Qo6YixJl8JwcvqqVgsVuO6o+VKvTRjz0/V05kf3JJbBLr87Q+wLWcMAJfA==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## 引数
<a name="cloudhsm_cli-crypto-verify-ecdsa-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データパスを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<SIGNATURE>***  
Base64 でエンコードされた署名。  
必須: はい (署名パスを通じて提供される場合を除く）

***<SIGNATURE\$1PATH>***  
署名の場所を指定します。  
必須: はい (署名パスを通じて提供される場合を除く）

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-verify-ecdsa-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI で HashEdDSA メカニズムで署名された署名を検証する
<a name="cloudhsm_cli-crypto-verify-ed25519ph"></a>

**重要**  
HashEdDSA 署名検証オペレーションは、非 FIPS モードの hsm2m.medium インスタンスでのみサポートされます。

CloudHSM CLI の **crypto verify ed25519ph** コマンドを使用して、次のオペレーションを完了します。
+ 特定の Ed25519 パブリックキーを使用して、データまたはファイルの署名を検証します。
+ HashEdDSA 署名メカニズムを使用して署名が生成されたことを確認します。HashEdDSA の詳細については、[NIST SP 186-5、セクション 7.8 ](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf)を参照してください。

**crypto verify ed25519ph** コマンドを使用するには、まず AWS CloudHSM クラスターに Ed25519 パブリックキーが必要です。`curve` パラメータを に設定`ed25519`し、 `verify` 属性を に設定して [CloudHSM CLI を使用して非対称 EC キーペアを生成する](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) コマンドを使用して Ed25519 キーペアを生成するか`true`、 `verify` 属性を に設定して [CloudHSM CLI で PEM 形式キーをインポートする](cloudhsm_cli-key-import-pem.md) コマンドを使用して Ed25519 パブリックキーをインポートできます`true`。

**注記**  
CloudHSM CLI の [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md) サブコマンドを使用して署名を生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-verify-ed25519ph-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-verify-ed25519ph-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。
+ HashEdDSA 署名検証オペレーションは、非 FIPS モードの hsm2m.medium インスタンスでのみサポートされます。

## Syntax
<a name="cloudhsm_cli-crypto-verify-ed25519ph-syntax"></a>

```
aws-cloudhsm > help crypto verify ed25519ph
Verify with the Ed25519ph mechanism

Usage: crypto verify ed25519ph [OPTIONS] --key-filter [<KEY_FILTER>...] --data-type <DATA_TYPE> --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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 matching key
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --hash-function <HASH_FUNCTION>
          Hash function [possible values: sha512]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-verify-ed25519ph-examples"></a>

これらの例は、 **crypto verify ed25519ph**を使用して Ed25519ph 署名メカニズムと`sha512`ハッシュ関数を使用して生成された署名を検証する方法を示しています。このコマンドは HSM で Ed25519 パブリックキーを使用します。

**Example 例: Base64 でエンコードされた署名を Base64 でエンコードされたデータで検証する**  

```
aws-cloudhsm > crypto verify ed25519ph \
    --hash-function sha512 \
    --key-filter attr.label=ed25519-public \
    --data-type raw \
    --data YWJj \
    --signature mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: データファイルを使用して署名ファイルを検証する**  

```
aws-cloudhsm > crypto verify ed25519ph \
    --hash-function sha512 \
    --key-filter attr.label=ed25519-public \
    --data-type raw \
    --data-path data.txt \
    --signature-path signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

## 引数
<a name="cloudhsm_cli-crypto-verify-ed25519ph-arguments"></a>

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

***<DATA>***  
検証する Base64 エンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
検証するデータの場所を指定します。  
必須: はい (データパラメータで指定されない限り)

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。Ed25519ph は SHA512 のみをサポートします。  
有効な値:  
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「」を参照してください[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)。  
必須: はい

***<SIGNATURE>***  
Base64 でエンコードされた署名。  
必須: はい (署名パスを通じて提供される場合を除く）

***<SIGNATURE\$1PATH>***  
署名の場所を指定します。  
必須: はい (署名パラメータで指定されない限り)

***<DATA\$1TYPE>***  
 データパラメータの値を検証アルゴリズムの一部としてハッシュするかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト
必須: はい

## 関連トピック
<a name="cloudhsm_cli-crypto-verify-ed25519ph-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)
+ [CloudHSM CLI で HashEdDSA メカニズムを使用して署名を生成する](cloudhsm_cli-crypto-sign-ed25519ph.md)

# CloudHSM CLI で RSA-PKCS メカニズムを使用して署名された署名を検証する
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs"></a>

CloudHSM CLI の **crypto verify rsa-pkcs** コマンドを使用して、次のオペレーションを完了します。
+ 指定されたパブリックキーによって HSM でファイルが署名されていることを確認します。
+ `RSA-PKCS` 署名メカニズムを使用して署名が生成されたことを検証します。
+ 署名されたファイルをソースファイルと比較し、両者が指定された rsa パブリックキーと署名メカニズムに基づいて暗号的に関連するかどうかを判断します。

**crypto verify rsa-pkcs** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA パブリックキーが必要です。

**注記**  
CloudHSM CLI の [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md) サブコマンドを使用して署名を生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto verify rsa-pkcs
Verify with the RSA-PKCS mechanism

Usage: crypto verify rsa-pkcs --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-examples"></a>

これらの例は、**crypto verify rsa-pkcs** を使用して RSA-PKCS 署名メカニズムと `SHA256` ハッシュ関数を使用して生成された署名を検証する方法を示しています。このコマンドは HSM でパブリックキーを使用します。

**Example 例: Base64 でエンコードされた署名を Base64 でエンコードされたデータで検証する**  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data YWJjMTIz --signature XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: データファイルを使用して署名ファイルを検証する**  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data-path data.txt --signature-path signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: 偽の署名関係を証明する**  
このコマンドは、無効なデータが、ラベル `rsa-public` 付きのパブリックキーによって、`/home/signature` にある署名を生成する RSAPKCS 署名メカニズムを使用して署名されたかどうかを検証します。指定の引数が真の署名関係を構成していないため、コマンドは、エラーメッセージを返します。  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data aW52YWxpZA== --signature XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## 引数
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データパスを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<SIGNATURE>***  
Base64 でエンコードされた署名。  
必須: はい (署名パスを通じて提供される場合を除く）

***<SIGNATURE\$1PATH>***  
署名の場所を指定します。  
必須: はい (署名パスを通じて提供される場合を除く）

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
RSA-PKCS の場合、データは [RFC 8017、セクション 9.2](https://www.rfc-editor.org/rfc/rfc8017#section-9.2) で規定されている DER エンコード形式で渡す必要があります。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI で RSA-PKCS-PSS メカニズムを使用して署名された署名を検証する
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss"></a>

CloudHSM CLI の **crypto sign rsa-pkcs-pss** コマンドを使用して、次のオペレーションを完了します。
+ 指定されたパブリックキーによって HSM でファイルが署名されていることを確認します。
+ RSA-PKCS-PSS 署名メカニズムを使用して署名が生成されたことを検証します。
+ 署名されたファイルをソースファイルと比較し、両者が指定された rsa パブリックキーと署名メカニズムに基づいて暗号的に関連するかどうかを判断します。

**crypto verify rsa-pkcs-pss** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA パブリックキーが必要です。`verify` 属性を `true` に設定して、キーインポート pem コマンド (ADD UNWRAP LINK HERE) を使用して RSA パブリックキーをインポートできます。

**注記**  
CloudHSM CLI の [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md) サブコマンドを使用して署名を生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-syntax"></a>

```
aws-cloudhsm > help crypto verify rsa-pkcs-pss
Verify with the RSA-PKCS-PSS mechanism

Usage: crypto verify rsa-pkcs-pss --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --salt-length >SALT_LENGTH< <--data-path <DATA_PATH>|--data <DATA> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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 matching key
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --mgf <MGF>
          The mask generation function [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --salt-length <SALT_LENGTH>
          The salt length
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-examples"></a>

これらの例は、**crypto verify rsa-pkcs-pss** を使用して、RSA-PKCS-PSS 署名メカニズムと `SHA256` ハッシュ関数を使用して生成された署名を検証する方法を示しています。このコマンドは HSM でパブリックキーを使用します。

**Example 例: Base64 でエンコードされた署名を Base64 でエンコードされたデータで検証する**  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data YWJjMTIz --salt-length 10 --mgf mgf1-sha256 --signature H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: データファイルを使用して署名ファイルを検証する**  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data-path data.txt --salt-length 10 --mgf mgf1-sha256 --signature signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example 例: 偽の署名関係を証明する**  
このコマンドは、無効なデータが、ラベル `rsa-public` 付きのパブリックキーによって、`/home/signature` にある署名を生成する RSAPKCSPSS 署名メカニズムを使用して署名されたかどうかを検証します。指定の引数が真の署名関係を構成していないため、コマンドは、エラーメッセージを返します。  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data aW52YWxpZA== --salt-length 10 --mgf mgf1-sha256 --signature H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## 引数
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-arguments"></a>

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

***<DATA>***  
署名対象の Base64 でエンコードされたデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<DATA\$1PATH>***  
署名するデータの場所を指定します。  
必須: はい (データパスを通じて提供される場合を除く）

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<KEY\$1FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください  
必須: はい

***<MFG>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効な値:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

***<SIGNATURE>***  
Base64 でエンコードされた署名。  
必須: はい (署名パスを通じて提供される場合を除く）

***<SIGNATURE\$1PATH>***  
署名の場所を指定します。  
必須: はい (署名パスを通じて提供される場合を除く）

***<DATA\$1TYPE>***  
 データパラメータの値を、署名アルゴリズムの一部としてハッシュ化するかどうかを指定します。ハッシュされていないデータには `raw` を使用し、すでにハッシュされているダイジェストには `digest` を使用します。  
有効な値:  
+ raw
+ ダイジェスト

## 関連トピック
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI のキーカテゴリ
<a name="cloudhsm_cli-key"></a>

CloudHSM CLI では、**key** はコマンドのグループの親カテゴリであり、親カテゴリと組み合わせると、キーに固有のコマンドが作成されます。現在、このカテゴリは次のコマンドで構成されています。
+ [削除](cloudhsm_cli-key-delete.md)
+ [generate-file](cloudhsm_cli-key-generate-file.md)
+ [key generate-asymmetric-pair](cloudhsm_cli-key-generate-asymmetric-pair.md)
  + [key generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)
  + [key generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [key generate-symmetric](cloudhsm_cli-key-generate-symmetric.md)
  + [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md)
  + [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)
+ [import pem](cloudhsm_cli-key-import-pem.md)
+ [リスト](cloudhsm_cli-key-list.md)
+ [レプリケーション](cloudhsm_cli-key-replicate.md)
+ [セットの属性](cloudhsm_cli-key-set-attribute.md)
+ [使用](cloudhsm_cli-key-share.md)
+ [unshare](cloudhsm_cli-key-unshare.md)
+ [unwrap](cloudhsm_cli-key-unwrap.md)
+ [wrap](cloudhsm_cli-key-wrap.md)

# CloudHSM CLI でキーを削除する
<a name="cloudhsm_cli-key-delete"></a>

CloudHSM CLI の **key delete** コマンドを使用して、 AWS CloudHSM クラスターからキーを削除します。一度に削除できるキーは 1 つだけです。キーペアの一方のキーを削除しても、ペアの他方のキーには影響がありません。

キーを作成し、そのキーを所有している CU のみがキーを削除できます。キーを共有しているが所有者ではないユーザーは、暗号化オペレーションでキーを使用できますが、削除することはできません。

## ユーザーのタイプ
<a name="key-delete-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-delete-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="key-delete-syntax"></a>

```
aws-cloudhsm > help key delete
Delete a key in the HSM cluster

Usage: key delete [OPTIONS] --filter [<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
      --filter [<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 matching key for deletion
  -h, --help                     Print help
```

## 例
<a name="key-delete-examples"></a>

```
aws-cloudhsm > key delete --filter attr.label="ec-test-public-key"
{
  "error_code": 0,
  "data": {
    "message": "Key deleted successfully"
  }
}
```

## 引数
<a name="key-delete-arguments"></a>

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

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください  
必須: はい

## 関連トピック
<a name="key-delete-seealso"></a>
+ [CloudHSM CLI でユーザーのキーを一覧表示する](cloudhsm_cli-key-list.md)
+ [CloudHSM CLI で非対称キーをエクスポートする](cloudhsm_cli-key-generate-file.md)
+ [CloudHSM CLI を使用してキーの共有を解除する](cloudhsm_cli-key-unshare.md)
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI で非対称キーをエクスポートする
<a name="cloudhsm_cli-key-generate-file"></a>

CloudHSM CLI の **key generate-file** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) から非対称キーをエクスポートします。ターゲットがプライベートキーの場合、プライベートキーへの参照はフェイク PEM 形式でエクスポートされます。ターゲットがパブリックキーの場合、パブリックキーバイトは PEM 形式でエクスポートされます。

フェイク PEM ファイルは、実際のプライベートキーマテリアルを含むわけではなく、HSM のプライベートキーを参照するため、ウェブサーバーから AWS CloudHSMへの SSL/TLS オフロードを確立するために使用できます。詳細については、「[SSL/TLS オフロード](ssl-offload.md)」を参照してください。

## ユーザーのタイプ
<a name="key-generate-file-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-generate-file-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="key-generate-file-syntax"></a>

```
aws-cloudhsm > help key generate-file
Generate a key file from a key in the HSM cluster. This command does not export any private key data from the HSM

Usage: key generate-file --encoding <ENCODING> --path <PATH> --filter [<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
      --encoding <ENCODING>
          Encoding format for the key file

          Possible values:
          - reference-pem: PEM formatted key reference (supports private keys)
          - pem:           PEM format (supports public keys)

      --path <PATH>
          Filepath where the key file will be written

      --filter [<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 matching key for file generation

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="key-generate-file-examples"></a>

この例では、 **key generate-file** を使用して AWS CloudHSM クラスターにキーファイルを生成する方法を示します。

**Example**  

```
aws-cloudhsm > key generate-file --encoding reference-pem --path /tmp/ec-private-key.pem --filter attr.label="ec-test-private-key"
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

## 引数
<a name="key-generate-file-arguments"></a>

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

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください  
必須: いいえ

***<ENCODING>***  
キーファイルのエンコード形式を指定します  
必須: はい

***<PATH>***  
キーファイルが書き込まれるファイルパスを指定します  
必須: はい

## KSP キー参照を生成します (Windows)
<a name="key-generate-ksp-key-reference"></a>

**注記**  
この機能は、SDK バージョン 5.16.0 以降でのみ使用できます。

### 前提条件
<a name="key-generate-ksp-key-reference-requirements"></a>
+ KSP キー参照は Windows プラットフォームでのみ生成できます。
+ Crypto User (CU) としてサインインする必要があります。

### ファイルの場所
<a name="key-generate-ksp-key-reference-options"></a>

デフォルトでは、AWS CloudHSM は生成されたファイルを `C:\Users\Default\AppData\Roaming\Microsoft\Crypto\CaviumKSP\GlobalPartition` に保存します。

別の場所を指定するには、`--path` パラメータを使用します。

### 構文
<a name="key-generate-ksp-key-reference-syntax"></a>

```
aws-cloudhsm > help key generate-file --encoding ksp-key-reference 
Generate a key file from a key in the HSM cluster. This command does not export any private key data from the HSM

Usage: key generate-file --encoding <ENCODING> --path <PATH> --filter [<FILTER>...]

Options:
      --encoding <ENCODING>
        Encoding format for the key file

        Possible values:
        - reference-pem:     PEM formatted key reference (supports private keys)
        - pem:               PEM format (supports public keys)
        - ksp-key-reference: KSP key reference format

      --cluster-id <CLUSTER_ID>
        Unique Id to choose which of the clusters in the config file to run the operation against. If not provided with multiple clusters configured, will error

      --path <PATH>
        Directory path where the key file will be written

      --filter [<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 matching key for file generation

      --all
        Generate ksp key reference for all available key pairs in HSM

  -h, --help
        Print help (see a summary with '-h')
```

### 例 – プライベートキーの属性フィルターを使用して KSP キー参照を生成する
<a name="key-generate-ksp-key-reference-example1"></a>

次の例では、特定のラベルを持つプライベートキーの KSP キー参照を生成します。

**Example**  

```
aws-cloudhsm > key generate-file --encoding ksp-key-reference --path  --filter attr.label="ec-test-private-key"
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

### 例 – すべてのキーペアの KSP キー参照を生成する
<a name="key-generate-ksp-key-reference-example2"></a>

次の例では、クラスター内のすべてのキーペアの KSP キー参照を生成します。

**Example**  

```
aws-cloudhsm > key generate-file --encoding ksp-key-reference --all
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

## 関連トピック
<a name="key-generate-file-seealso"></a>
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)
+ [CloudHSM CLI の generate-asymmetric-pair カテゴリ](cloudhsm_cli-key-generate-asymmetric-pair.md)
+ [CloudHSM CLI の generate-symmetric カテゴリ](cloudhsm_cli-key-generate-symmetric.md)

# CloudHSM CLI の generate-asymmetric-pair カテゴリ
<a name="cloudhsm_cli-key-generate-asymmetric-pair"></a>

CloudHSM CLI では、**key generate-asymmetric-pair** はコマンドグループの親カテゴリで、親カテゴリと組み合わせると非対称キーペアを生成するコマンドを作成します。現在、このカテゴリは次のコマンドで構成されています。
+ [key generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [key generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# CloudHSM CLI を使用して非対称 EC キーペアを生成する
<a name="cloudhsm_cli-key-generate-asymmetric-pair-ec"></a>

CloudHSM CLI の **key asymmetric-pair ec** コマンドを使用して、 AWS CloudHSM クラスターに非対称楕円曲線 (EC) キーペアを生成します。

## ユーザーのタイプ
<a name="key-generate-asymmetric-pair-ec-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-generate-asymmetric-pair-ec-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="key-generate-asymmetric-pair-ec-syntax"></a>

```
aws-cloudhsm > help key generate-asymmetric-pair ec
Generate an Elliptic-Curve Cryptography (ECC) key pair

Usage: key generate-asymmetric-pair ec [OPTIONS] --public-label <PUBLIC_LABEL> --private-label <PRIVATE_LABEL> --curve <CURVE>

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
      --public-label <PUBLIC_LABEL>
          Label for the public key
      --private-label <PRIVATE_LABEL>
          Label for the private key
      --session
          Creates a session key pair that exists only in the current session. The key cannot be recovered after the session ends
      --curve <CURVE>
          Elliptic curve used to generate the key pair [possible values: prime256v1, secp256r1, secp224r1, secp384r1, secp256k1, secp521r1, ed25519]
      --public-attributes [<PUBLIC_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated EC public key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --private-attributes [<PRIVATE_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated EC private key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --share-crypto-users [<SHARE_CRYPTO_USERS>...]
          Space separated list of Crypto User usernames to share the EC private key with
      --manage-private-key-quorum-value <MANAGE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key management operations for the private key
      --use-private-key-quorum-value <USE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations for the private key
  -h, --help
          Print help
```

## 例
<a name="key-generate-asymmetric-pair-ec-examples"></a>

以下の例では、**key generate-asymmetric-pair ec** コマンドを使用して EC キーペアを作成する方法を示します。

**Example 例: EC キーペアの作成**  

```
aws-cloudhsm > key generate-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x000000000012000b",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xd7c1a7",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x047096513df542250a6b228fd9cb67fd0c903abc93488467681974d6f371083fce1d79da8ad1e9ede745fb9f38ac8622a1b3ebe9270556000c",
        "curve": "secp224r1"
      }
    },
"private_key": {
      "key-reference": "0x000000000012000c",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xd7c1a7",
        "class": "private-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x047096513df542250a6b228fd9cb67fd0c903abc93488467681974d6f371083fce1d79da8ad1e9ede745fb9f38ac8622a1b3ebe9270556000c",
        "curve": "secp224r1"
      }
    }
  }
}
```

**Example 例: オプションの属性を持つ EC キーペア作成**  

```
aws-cloudhsm > key generate-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example \
    --public-attributes encrypt=true \
    --private-attributes decrypt=true
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x00000000002806eb",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "public-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280c82",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "private-key",
        "encrypt": false,
        "decrypt": true,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    }
  }
}
```

**Example 例: クォーラム値を持つ EC キーペア作成**  
クォーラム制御を使用してキーを生成する場合、キーには、キーの最大クォーラム値と同じ数以上のユーザーを関連付ける必要があります。関連付けられるユーザーには、キー所有者と、そのキーが共有されている Crypto User が含まれます。キーを共有すべき最小ユーザー数を決定するには、キー使用クォーラム値とキー管理クォーラム値のうち大きい方のクォーラム値を取得し、デフォルトでキーに関連付けられているキー所有者を考慮して 1 を差し引きます。キーをさらに多くのユーザーと共有するには、**[CloudHSM CLI を使用してキーを共有する](cloudhsm_cli-key-share.md)** コマンドを使用します。  

```
aws-cloudhsm > key generate-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example \
    --public-attributes verify=true \
    --private-attributes sign=true
    --share-crypto-users cu2 cu3 cu4 \
    --manage-private-key-quorum-value 4 \
    --use-private-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x00000000002806eb",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280c82",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [
          {
            "username": "cu2",
            "key-coverage": "full"
          },
          {
            "username": "cu3",
            "key-coverage": "full"
          },
          {
            "username": "cu4",
            "key-coverage": "full"
          },
        ],
        "key-quorum-values": {
          "manage-key-quorum-value": 4,
          "use-key-quorum-value": 2
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "private-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    }
  }
}
```

## 引数
<a name="key-generate-asymmetric-pair-ec-arguments"></a>

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

***<CURVE>***  
楕円曲線の識別子を指定します。  
+ prime256v1
+ secp256r1
+ secp224r1
+ secp384r1
+ secp256k1
+ secp521r1
+ ed25519 (非 FIPS モードの hsm2m.medium インスタンスでのみサポート)
必須: はい

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された EC パブリックキーに設定するキー属性のスペース区切りリストを指定します (例: `verify=true`)。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<PUBLIC\$1LABEL>***  
パブリックキーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された EC プライベートキーに設定するキー属性のスペース区切りリストを指定します (例: `sign=true`)。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<PRIVATE\$1LABEL>***  
プライベートキーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するキーを作成します。セッション終了後、キーをリカバリすることはできません。  
このパラメータは、別のキーを暗号化してからすばやく復号化するラッピングキーなど、キーが短時間だけ必要な場合に使用します。セッション終了後に復号する必要がある可能性のあるデータを暗号化するためにセッションキーを使用しないでください。  
デフォルトでは、生成されるキーは永続 (トークン) キーです。<SESSION> で渡すことでこれが変わり、この引数で生成されたキーがセッション (エフェメラル) キーであることが保証されます。  
必須: いいえ

***<SHARE\$1CRYPTO\$1USERS>***  
EC プライベートキーを共有する Crypto User ユーザー名のスペース区切りリストを指定します。  
必須: いいえ

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
プライベートキーのキー管理オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

***<USE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
プライベートキーのキー使用オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

## 関連トピック
<a name="key-generate-asymmetric-pair-ec-seealso"></a>
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI で非対称 RSA キーペアを生成する
<a name="cloudhsm_cli-key-generate-asymmetric-pair-rsa"></a>

CloudHSM CLI の **key generate-asymmetric-pair rsa** コマンドを使用して、 AWS CloudHSM クラスターに非対称 RSA キーペアを生成します。

## ユーザーのタイプ
<a name="key-generate-asymmetric-pair-rsa-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-generate-asymmetric-pair-rsa-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="key-generate-asymmetric-pair-rsa-syntax"></a>

```
aws-cloudhsm > help key generate-asymmetric-pair rsa
Generate an RSA key pair

Usage: key generate-asymmetric-pair rsa [OPTIONS] --public-label <PUBLIC_LABEL> --private-label <PRIVATE_LABEL> --modulus-size-bits <MODULUS_SIZE_BITS> --public-exponent <PUBLIC_EXPONENT>

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
      --public-label <PUBLIC_LABEL>
          Label for the public key
      --private-label <PRIVATE_LABEL>
          Label for the private key
      --session
          Creates a session key pair that exists only in the current session. The key cannot be recovered after the session ends
      --modulus-size-bits <MODULUS_SIZE_BITS>
          Modulus size in bits used to generate the RSA key pair
      --public-exponent <PUBLIC_EXPONENT>
          Public exponent used to generate the RSA key pair
      --public-attributes [<PUBLIC_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated RSA public key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --private-attributes [<PRIVATE_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated RSA private key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --share-crypto-users [<SHARE_CRYPTO_USERS>...]
          Space separated list of Crypto User usernames to share the RSA key with
      --manage-private-key-quorum-value <MANAGE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key management operations for the private key
      --use-private-key-quorum-value <USE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations for the private key
  -h, --help
          Print help
```

## 例
<a name="key-generate-asymmetric-pair-rsa-examples"></a>

以下の例では、`key generate-asymmetric-pair rsa` を使用して RSA キーペアを作成する方法を示します。

**Example 例: RSA キーペアの作成**  

```
aws-cloudhsm > key generate-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000160010",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x498e1f",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xdfca0669dc8288ed3bad99509bd21c7e6192661407021b3f4cdf4a593d939dd24f4d641af8e4e73b04c847731c6dbdff3385818e08dd6efcbedd6e5b130344968c
e89a065e7d1a46ced96b46b909db2ab6be871ee700fd0a448b6e975bb64cae77c49008749212463e37a577baa57ce3e574cb057e9db131e119badf50c938f26e8a5975c61a8ba7ffe7a1115a
bcebb7d20bd6df1948ae336ae23b52d73b7f3b6acc2543edb6358e08d326d280ce489571f4d34e316a2ea1904d513ca12fa04075fc09ad005c81b7345d7804ff24c45117f0a1020dca7794df037a10aadec8653473b2088711f7b7d8b58431654e14e31af0e00511da641058fb7475ffdbe60f",
        "modulus-size-bits": 2048
      }
    },
"private_key": {
      "key-reference": "0x0000000000160011",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x498e1f",
        "class": "private-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xdfca0669dc8288ed3bad99509bd21c7e6192661407021b3f4cdf4a593d939dd24f4d641af8e4e73b04c847731c6dbdff3385818e08dd6efcbedd6e5b130344968ce89a065e7d1a46ced96b46b909db2ab6be871ee700fd0a448b6e975bb64cae77c49008749212463e37a577baa57ce3e574cb057e9db131e119badf50c938f26e8a5975c61a8ba7ffe7a1115abcebb7d20bd6df1948ae336ae23b52d73b7f3b6acc2543edb6358e08d326d280ce489571f4d34e316a2ea1904d513ca12fa04075fc09ad005c81b7345d7804ff24c45117f0a1020dca7794df037a10aadec8653473b2088711f7b7d8b58431654e14e31af0e00511da641058fb7475ffdbe60f",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

**Example 例: オプションの属性を含む RSA キーペアの作成**  

```
aws-cloudhsm > key generate-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example \
--public-attributes encrypt=true \
--private-attributes decrypt=true
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000280cc8",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "public-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c
73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634d
f6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc
133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0ac
ac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280cc7",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "private-key",
        "encrypt": false,
        "decrypt": true,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634df6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0acac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

**Example 例: クォーラム値を持つ RSA キーペア作成**  
クォーラム制御を使用してキーを生成する場合、キーには、キーの最大クォーラム値と同じ数以上のユーザーを関連付ける必要があります。関連付けられるユーザーには、キー所有者と、そのキーが共有されている Crypto User が含まれます。キーを共有すべき最小ユーザー数を決定するには、キー使用クォーラム値とキー管理クォーラム値のうち大きい方のクォーラム値を取得し、デフォルトでキーに関連付けられているキー所有者を考慮して 1 を差し引きます。キーをさらに多くのユーザーと共有するには、**[CloudHSM CLI を使用してキーを共有する](cloudhsm_cli-key-share.md)** コマンドを使用します。  

```
aws-cloudhsm > key generate-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example \
--public-attributes verify=true \
--private-attributes sign=true
--share-crypto-users cu2 cu3 cu4 \
--manage-private-key-quorum-value 4 \
--use-private-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000280cc8",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c
73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634d
f6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc
133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0ac
ac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280cc7",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [
          {
            "username": "cu2",
            "key-coverage": "full"
          },
          {
            "username": "cu3",
            "key-coverage": "full"
          },
          {
            "username": "cu4",
            "key-coverage": "full"
          },
        ],
        "key-quorum-values": {
          "manage-key-quorum-value": 4,
          "use-key-quorum-value": 2
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "private-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634df6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0acac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

## 引数
<a name="key-generate-asymmetric-pair-rsa-arguments"></a>

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

***<MODULUS\$1SIZE\$1BITS>***  
 モジュラスの長さをビット単位で指定します。最小値は 2,048 です。  
必須: はい

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された RSA プライベートキーに設定するキー属性のスペース区切りリストを指定します (例: `sign=true`)。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<PRIVATE\$1LABEL>***  
 プライベートキーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<PUBLIC\$1EXPONENT>***  
パブリック指数を指定します。値は、65537 以上の奇数にする必要があります  
必須: はい

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された RSA パブリックキーに設定するキー属性のスペース区切りリストを指定します (例: `verify=true`)  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<PUBLIC\$1LABEL>***  
 パブリックキーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するキーを作成します。セッション終了後、キーをリカバリすることはできません。  
このパラメータは、別のキーを暗号化してからすばやく復号化するラッピングキーなど、キーが短時間だけ必要な場合に使用します。セッション終了後に復号する必要がある可能性のあるデータを暗号化するためにセッションキーを使用しないでください。  
デフォルトでは、生成されるキーは永続 (トークン) キーです。<SESSION> で渡すことでこれが変わり、この引数で生成されたキーがセッション (エフェメラル) キーであることが保証されます。  
必須: いいえ

***<SHARE\$1CRYPTO\$1USERS>***  
RSAEC プライベートキーを共有する Crypto User ユーザー名のスペース区切りリストを指定します。  
必須: いいえ

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
プライベートキーのキー管理オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

***<USE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
プライベートキーのキー使用オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

## 関連トピック
<a name="key-generate-asymmetric-pair-rsa-seealso"></a>
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI の generate-symmetric カテゴリ
<a name="cloudhsm_cli-key-generate-symmetric"></a>

CloudHSM CLI では、**key generate-symmetric** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせると対称キーを生成するコマンドを作成します。現在、このカテゴリは次のコマンドで構成されています。
+ [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md)
+ [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)

# CloudHSM CLI で対称 AES キーを生成する
<a name="cloudhsm_cli-key-generate-symmetric-aes"></a>

CloudHSM CLI の **key generate-symmetric aes** コマンドを使用して、 AWS CloudHSM クラスターに対称 AES キーを生成します。

## ユーザーのタイプ
<a name="key-generate-symmetric-aes-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-generate-symmetric-aes-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="key-generate-symmetric-aes-syntax"></a>

```
aws-cloudhsm > help key generate-symmetric aes
Generate an AES key

Usage: key generate-symmetric aes [OPTIONS] --label <LABEL> --key-length-bytes <KEY_LENGTH_BYTES>

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
      --label <LABEL>
          Label for the key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --key-length-bytes <KEY_LENGTH_BYTES>
          Key length in bytes
      --attributes [<KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated AES key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --share-crypto-users [<SHARE_CRYPTO_USERS>...]
          Space separated list of Crypto User usernames to share the AES key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE>
          The quorum value for key management operations
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations
  -h, --help
          Print help
```

## 例
<a name="key-generate-symmetric-aes-examples"></a>

以下の例では、**key generate-symmetric aes** コマンドを使って AES キーを作成する方法を示します。

**Example 例: AES キーの作成**  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 24
      }
    }
  }
}
```

**Example 例: オプションの属性を含む AES キーペアの作成**  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24 \
--attributes decrypt=true encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": true,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 24
      }
    }
  }
}
```

**Example 例: クォーラム値を含む AES キーの作成**  
クォーラム制御を使用してキーを生成する場合、キーには、キーの最大クォーラム値と同じ数以上のユーザーを関連付ける必要があります。関連付けられるユーザーには、キー所有者と、そのキーが共有されている Crypto User が含まれます。キーを共有すべき最小ユーザー数を決定するには、キー使用クォーラム値とキー管理クォーラム値のうち大きい方のクォーラム値を取得し、デフォルトでキーに関連付けられているキー所有者を考慮して 1 を差し引きます。キーをさらに多くのユーザーと共有するには、**[CloudHSM CLI を使用してキーを共有する](cloudhsm_cli-key-share.md)** コマンドを使用します。  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24 \
--attributes decrypt=true encrypt=true
--share-crypto-users cu2 cu3 cu4 \
--manage-key-quorum-value 4 \
--use-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [
          {
            "username": "cu2",
            "key-coverage": "full"
          },
          {
            "username": "cu3",
            "key-coverage": "full"
          },
          {
            "username": "cu4",
            "key-coverage": "full"
          },
        ],
        "key-quorum-values": {
          "manage-key-quorum-value": 4,
          "use-key-quorum-value": 2
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": true,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 24
      }
    }
  }
}
```

## 引数
<a name="key-generate-symmetric-aes-arguments"></a>

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

***<KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された AES キーに設定するキー属性のスペース区切りリストを指定します (例: `sign=true`)。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<KEY-LENGTH-BYTES>***  
キーの長さをバイト単位で指定します。  

有効な値:
+ 16、24、32
必須: はい

***<LABEL>***  
AES キーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するキーを作成します。セッション終了後、キーをリカバリすることはできません。  
このパラメータは、別のキーを暗号化してからすばやく復号化するラッピングキーなど、キーが短時間だけ必要な場合に使用します。セッション終了後に復号する必要がある可能性のあるデータを暗号化するためにセッションキーを使用しないでください。  
デフォルトでは、生成されるキーは永続 (トークン) キーです。<SESSION> で渡すことでこれが変わり、この引数で生成されたキーがセッション (エフェメラル) キーであることが保証されます。  
必須: いいえ

***<SHARE\$1CRYPTO\$1USERS>***  
AES キーを共有する Crypto User ユーザー名のスペース区切りリストを指定します。  
必須: いいえ

***<MANAGE\$1KEY\$1QUORUM\$1VALUE>***  
キー管理オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

***<USE\$1KEY\$1QUORUM\$1VALUE>***  
キー使用オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

## 関連トピック
<a name="key-generate-symmetric-aes-seealso"></a>
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI で対称汎用シークレットキーを生成する
<a name="cloudhsm_cli-key-generate-symmetric-generic-secret"></a>

CloudHSM CLI の **key generate-symmetric generic-secret** コマンドを使用して、 AWS CloudHSM クラスターに対称汎用シークレットキーを生成します。

## ユーザーのタイプ
<a name="key-generate-symmetric-generic-secret-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="key-generate-symmetric-generic-secret-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="key-generate-symmetric-generic-secret-syntax"></a>

```
aws-cloudhsm > key help generate-symmetric generic-secret
Generate a generic secret key

Usage: key generate-symmetric generic-secret [OPTIONS] --label <LABEL> --key-length-bytes <KEY_LENGTH_BYTES>

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
      --label <LABEL>
          Label for the key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --key-length-bytes <KEY_LENGTH_BYTES>
          Key length in bytes
      --attributes [<KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated generic secret key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --share-crypto-users [<SHARE_CRYPTO_USERS>...]
          Space separated list of Crypto User usernames to share the generic secret key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE>
          The quorum value for key management operations
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations
  -h, --help
          Print help
```

## 例
<a name="key-generate-symmetric-generic-secret-examples"></a>

次の例は、**key generate-symmetric generic-secret** コマンドを使って汎用シークレットキーを作成する方法を示しています。

**Example 例: 汎用シークレットキー作成**  

```
aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 256
      }
    }
  }
}
```

**Example 例: オプションの属性を持つ汎用シークレットキー作成**  

```
aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 256
      }
    }
  }
}
```

**Example 例: クォーラム値を持つ汎用シークレットキー作成**  
クォーラム制御を使用してキーを生成する場合、キーには、キーの最大クォーラム値と同じ数以上のユーザーを関連付ける必要があります。関連付けられるユーザーには、キー所有者と、そのキーが共有されている Crypto User が含まれます。キーを共有すべき最小ユーザー数を決定するには、キー使用クォーラム値とキー管理クォーラム値のうち大きい方のクォーラム値を取得し、デフォルトでキーに関連付けられているキー所有者を考慮して 1 を差し引きます。キーをさらに多くのユーザーと共有するには、**[CloudHSM CLI を使用してキーを共有する](cloudhsm_cli-key-share.md)** コマンドを使用します。  

```
aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes encrypt=true
--share-crypto-users cu2 cu3 cu4 \
--manage-key-quorum-value 4 \
--use-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [
          {
            "username": "cu2",
            "key-coverage": "full"
          },
          {
            "username": "cu3",
            "key-coverage": "full"
          },
          {
            "username": "cu4",
            "key-coverage": "full"
          },
        ],
        "key-quorum-values": {
          "manage-key-quorum-value": 4,
          "use-key-quorum-value": 2
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 256
      }
    }
  }
}
```

## 引数
<a name="key-generate-symmetric-generic-secret-arguments"></a>

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

***<KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式で生成された AES キーに設定するキー属性のスペース区切りリストを指定します (例: `sign=true`)。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

***<KEY-LENGTH-BYTES>***  
キーの長さをバイト単位で指定します。  

有効な値:
+ 1～800
必須: はい

***<LABEL>***  
汎用シークレットキーのユーザー定義ラベルを指定します。`label` に許可される最大サイズは、クライアント SDK 5.11 以降では 127 文字です。クライアント SDK 5.10 以前では、制限は 126 文字です。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するキーを作成します。セッション終了後、キーをリカバリすることはできません。  
このパラメータは、別のキーを暗号化してからすばやく復号化するラッピングキーなど、キーが短時間だけ必要な場合に使用します。セッション終了後に復号する必要がある可能性のあるデータを暗号化するためにセッションキーを使用しないでください。  
デフォルトでは、生成されるキーは永続 (トークン) キーです。<SESSION> で渡すことでこれが変わり、この引数で生成されたキーがセッション (エフェメラル) キーであることが保証されます。  
必須: いいえ

***<SHARE\$1CRYPTO\$1USERS>***  
汎用シークレットキーを共有する Crypto User ユーザー名のスペース区切りリスト。  
必須: いいえ

***<MANAGE\$1KEY\$1QUORUM\$1VALUE>***  
キー管理オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

***<USE\$1KEY\$1QUORUM\$1VALUE>***  
キー使用オペレーションのクォーラム値。この値は、キーが関連付けられているユーザーの数以下である必要があります。これには、そのキーが共有されているユーザーと、キー所有者が含まれます。最大値は 8 です。  
必須: いいえ

## 関連トピック
<a name="key-generate-symmetric-generic-secret-seealso"></a>
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI で PEM 形式キーをインポートする
<a name="cloudhsm_cli-key-import-pem"></a>

の **key import pem** コマンドを使用して AWS CloudHSM 、PEM 形式キーをハードウェアセキュリティモジュール (HSM) にインポートします。このコマンドを使用すると、HSM の外部で生成されたパブリックキーをインポートできます。

**注記**  
[CloudHSM CLI で非対称キーをエクスポートする](cloudhsm_cli-key-generate-file.md) コマンドを使用して、パブリックキーから標準 PEM ファイルを作成するか、プライベートキーから参照 PEM ファイルを作成します。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-import-pem-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-import-pem-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-import-pem-syntax"></a>

```
aws-cloudhsm > help key import pem
Import key from a PEM file

Usage: key import pem [OPTIONS] --path <PATH> --label <LABEL> --key-type-class <KEY_TYPE_CLASS>
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
      --path <PATH>
          Path where the key is located in PEM format
      --label <LABEL>
          Label for the imported key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of the imported key [possible values: ec-public, rsa-public]
      --attributes [<IMPORT_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the imported key
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-import-pem-examples"></a>

この例では、**key import pem** コマンドを使用して、PEM 形式のファイルから RSA パブリックキーをインポートする方法を示しています。

**Example 例: RSA パブリックキーをインポートする**  

```
aws-cloudhsm > key import pem --path /home/example --label example-imported-key --key-type-class rsa-public
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001e08e3",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",                                   
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "example-imported-key",
        "id": "0x",
        "check-value": "0x99fe93",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0x8e9c172c37aa22ed1ce25f7c3a7c936dadc532201400128b044ebb4b96│··3e4930ab910df5a2896eaeb8853cfea0e341227654a8337a7864cc8a87d136f006cfba9e68d0b329│··746c1ad60941668b18699fc8169ff1ec363d0d18292845b2454d6a0b8c5d111b79c047619d460cdf│··be59debbacb66b7abeaf3f3d35dd2b9cfa6b6b7b1258b6866cb4085ac749e9d8552b3a4509e1b86c│··828cc794e22767b4f6b5bc6ff5c96f4b7e60eab305d669cfa2197e85379cb35c659bb58fcd246d48│··d9f6a7f36063b42da025459275aa8e3abedad775387086bd6c198ded868403f4b87ffda5a2d455ac│··aa6cbd00003c31d8d2f51d10cd272b31cf0c4037791f48ad51fb35",
        "modulus-size-bits": 2048
      }
    },
    "message": "Successfully imported key"
  }
}
```

**Example 例: オプションの属性を含む RSA パブリックキーをインポートする**  

```
aws-cloudhsm > key import pem --path /home/example --label example-imported-key-with-attributes --key-type-class rsa-public --attributes verify=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001e08e3",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",                                      
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "rsa",
        "label": "example-imported-key-with-attributes",
        "id": "0x",
        "check-value": "0x99fe93",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0x8e9c172c37aa22ed1ce25f7c3a7c936dadc532201400128b044ebb4b96│··3e4930ab910df5a2896eaeb8853cfea0e341227654a8337a7864cc8a87d136f006cfba9e68d0b329│··746c1ad60941668b18699fc8169ff1ec363d0d18292845b2454d6a0b8c5d111b79c047619d460cdf│··be59debbacb66b7abeaf3f3d35dd2b9cfa6b6b7b1258b6866cb4085ac749e9d8552b3a4509e1b86c│··828cc794e22767b4f6b5bc6ff5c96f4b7e60eab305d669cfa2197e85379cb35c659bb58fcd246d48│··d9f6a7f36063b42da025459275aa8e3abedad775387086bd6c198ded868403f4b87ffda5a2d455ac│··aa6cbd00003c31d8d2f51d10cd272b31cf0c4037791f48ad51fb35",
        "modulus-size-bits": 2048
      }
    },
    "message": "Successfully imported key"
  }
}
```

## 引数
<a name="cloudhsm_cli-key-import-pem-arguments"></a>

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

***<PATH>***  
キーファイルがあるファイルパスを指定します。  
必須: はい

***<LABEL>***  
インポートされたキーのユーザー定義ラベルを指定します。`label` の最大長は 126 文字です。  
必須: はい

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス。  
使用できる値:  
+ ec-public
+ rsa-public
必須: はい

***<IMPORT\$1KEY\$1ATTRIBUTES>***  
`KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式 (例: `sign=true`) でインポートされたキーに設定するキー属性のスペース区切りリストを指定します。サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: いいえ

## 関連トピック
<a name="cloudhsm_cli-key-import-pem-seealso"></a>
+ [CloudHSM CLI の暗号化署名カテゴリ](cloudhsm_cli-crypto-sign.md)
+ [CloudHSM CLI の暗号化検証カテゴリ](cloudhsm_cli-crypto-verify.md)

# CloudHSM CLI でユーザーのキーを一覧表示する
<a name="cloudhsm_cli-key-list"></a>

CloudHSM CLI の **key list** コマンドを使用して、 AWS CloudHSM クラスターに存在する現在のユーザーのすべてのキーを検索します。出力には、そのユーザーが所有および共有しているキーと、CloudHSM クラスターのすべてのパブリックキーが含まれます。

## ユーザーのタイプ
<a name="chsm-cli-key-list-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 管理者 (CO)
+ Crypto User (CU)

## 構文
<a name="chsm-cli-key-list-syntax"></a>

```
aws-cloudhsm > help key list
List the keys the current user owns, shares, and all public keys in the HSM cluster

Usage: key list [OPTIONS]

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
      --filter [<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 matching key(s) to list
      --max-items <MAX_ITEMS>
          The total number of items to return in the command's output. If the total number of items available is more than the value specified, a next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command [default: 10]
      --starting-token <STARTING_TOKEN>
          A token to specify where to start paginating. This is the next-token from a previously truncated response
  -v, --verbose
          If included, prints all attributes and key information for each matched key. By default each matched key only displays its key-reference and label attribute. This flag when used by Admins has no effect
  -h, --help
          Print help
```

## 例
<a name="chsm-cli-key-list-examples"></a>

次の例は、**key list** コマンドを実行するためのさまざまな方法を示しています。次の例は、Crypto User としての出力を示しています。

**Example 例: すべてのキーを検索 - デフォルト**  
このコマンドは、 AWS CloudHSM クラスターに存在するログインしているユーザーのキーを一覧表示します。  
デフォルトでは、現在ログインしているユーザーのキーは 10 個だけ表示され、出力には `key-reference` と `label` のみ表示されます。適切なページ分割オプションを使用して、出力として表示するキーの数を増やしたり減らしたりします。

```
aws-cloudhsm > key list
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x00000000000003d5",
        "attributes": {
          "label": "test_label_1"
        }
      },
      {
        "key-reference": "0x0000000000000626",
        "attributes": {
          "label": "test_label_2"
        }
      },.
      ...8 keys later...
    ],
    "total_key_count": 56,
    "returned_key_count": 10,
    "next_token": "10"
  }
}
```

**Example 例: すべてのキーを検索 - 詳細度**  
出力には、そのユーザーが所有および共有しているキーと、HSM のすべてのパブリックキーが含まれます。  
注: デフォルトでは、現在ログインしているユーザーのキーは 10 個だけ表示されます。適切なページ分割オプションを使用して、出力として表示するキーの数を増やしたり減らしたりします。

```
aws-cloudhsm > key list --verbose
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x000000000012000c",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "ec",
          "label": "ec-test-private-key",
          "id": "",
          "check-value": "0x2a737d",
          "class": "private-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": true,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": true,
          "sign": false,
          "trusted": false,
          "unwrap": false,
          "verify": false,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 122,
          "ec-point": "0x0442d53274a6c0ec1a23c165dcb9ccdd72c64e98ae1a9594bb5284e752c746280667e11f1e983493c1c605e0a8071ede47ca280f94c6b2aa33",
          "curve": "secp224r1"
        }
      },
      {
        "key-reference": "0x000000000012000d",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "ec",
          "label": "ec-test-public-key",
          "id": "",
          "check-value": "0x2a737d",
          "class": "public-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": false,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": false,
          "sign": false,
          "trusted": false,
          "unwrap": false,
          "verify": false,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 57,
          "ec-point": "0x0442d53274a6c0ec1a23c165dcb9ccdd72c64e98ae1a9594bb5284e752c746280667e11f1e983493c1c605e0a8071ede47ca280f94c6b2aa33",
          "curve": "secp224r1"
        }
      }
    ],
      ...8 keys later...
    "total_key_count": 1580,
    "returned_key_count": 10
  }
}
```

**Example 例: ページ分割されたリターン**  
次の例では、2 つのキーのみを表示するページ分割されたキーのサブセットを表示しています。次に、この例では次の 2 つのキーを表示する後続の呼び出しを行います。  

```
aws-cloudhsm > key list --verbose --max-items 2
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x0000000000000030",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "aes",
          "label": "98a6688d1d964ed7b45b9cec5c4b1909",
          "id": "",
          "check-value": "0xb28a46",
          "class": "secret-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": true,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": true,
          "sign": true,
          "trusted": false,
          "unwrap": false,
          "verify": true,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 32
        }
      },
      {
        "key-reference": "0x0000000000000042",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "aes",
          "label": "4ad6cdcbc02044e09fa954143efde233",
          "id": "",
          "check-value": "0xc98104",
          "class": "secret-key",
          "encrypt": true,
          "decrypt": true,
          "token": true,
          "always-sensitive": true,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": true,
          "sign": true,
          "trusted": false,
          "unwrap": true,
          "verify": true,
          "wrap": true,
          "wrap-with-trusted": false,
          "key-length-bytes": 16
        }
      }
    ],
    "total_key_count": 1580,
    "returned_key_count": 2,
    "next_token": "2"
  }
}
```
次の 2 つのキーを表示するには、後続の呼び出しを行います。  

```
aws-cloudhsm > key list --verbose --max-items 2 --starting-token 2
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x0000000000000081",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "aes",
          "label": "6793b8439d044046982e5b895791e47f",
          "id": "",
          "check-value": "0x3f986f",
          "class": "secret-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": true,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": true,
          "sign": true,
          "trusted": false,
          "unwrap": false,
          "verify": true,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 32
        }
      },
      {
        "key-reference": "0x0000000000000089",
        "key-info": {
          "key-owners": [
            {
              "username": "cu1",
              "key-coverage": "full"
            }
          ],
          "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
          "cluster-coverage": "full"
        },
        "attributes": {
          "key-type": "aes",
          "label": "56b30fa05c6741faab8f606d3b7fe105",
          "id": "",
          "check-value": "0xe9201a",
          "class": "secret-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": true,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": true,
          "sign": true,
          "trusted": false,
          "unwrap": false,
          "verify": true,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 32
        }
      }
    ],
    "total_key_count": 1580,
    "returned_key_count": 2,
    "next_token": "4"
  }
}
```
CloudHSM CLI でキーフィルタリングメカニズムがどのように機能するかを示すその他の例については、[CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md) を参照してください。

## 引数
<a name="key-list-arguments"></a>

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

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキー (複数可) を一覧表示対象として選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください  
必須: いいえ

***<MAX\$1ITEMS>***  
コマンドの出力で返される項目の総数。使用可能な項目の総数が指定された値を上回る場合、コマンドの出力で next-token が提供されます。ページ分割を再開するには、後続コマンドの starting-token 引数で next-token 値を指定します。  
必須: いいえ

***<STARTING\$1TOKEN>***  
ページ分割を始める場所を指定するトークン。これは、以前に切り詰められたレスポンスからの next-token です。  
必須: いいえ

***<VERBOSE>***  
含まれている場合は、一致した各キーのすべての属性とキー情報を出力します。デフォルトでは、一致した各キーには key-reference とラベル属性のみが表示されます。管理者が使用する場合、このフラグは効果がありません。  
必須: いいえ

## 関連トピック
<a name="chsm-key-list-seealso"></a>
+ [CloudHSM CLI でキーを削除する](cloudhsm_cli-key-delete.md)
+ [CloudHSM CLI で非対称キーをエクスポートする](cloudhsm_cli-key-generate-file.md)
+ [CloudHSM CLI を使用してキーの共有を解除する](cloudhsm_cli-key-unshare.md)
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)

# CloudHSM CLI でキーをレプリケートする
<a name="cloudhsm_cli-key-replicate"></a>

CloudHSM CLI の **key replicate** コマンドを使用して、ソース AWS CloudHSM クラスターから宛先 AWS CloudHSM クラスターにキーをレプリケートします。

## ユーザーのタイプ
<a name="chsm-cli-key-replicate-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 管理者 (CO)
+ Crypto User (CU)
**注記**  
Crypto User は、このコマンドを使用するにはキーを所有している必要があります。

## 要件
<a name="cloudhsm_cli-key-replicate-requirements"></a>
+ 送信元クラスターと送信先クラスターはクローンである必要があります。つまり、一方が他方のバックアップから作成されたか、どちらも共通のバックアップから作成されたということです。詳細については「[バックアップからクラスターを作成する](create-cluster-from-backup.md)」を参照してください。
+ キーのオーナーは、送信先クラスターに存在する必要があります。さらに、キーを共有しているユーザーがいる場合、それらのユーザーも送信先クラスターに存在する必要があります。
+ このコマンドを実行するには、送信元クラスターと送信先クラスターの両方で、Crypto User または管理者としてログインしている必要があります。
  +  単一コマンドモードでは、コマンドは CLOUDHSM\$1PIN および CLOUDHSM\$1ROLE 環境変数を使用してソースクラスターで認証します。詳細については「[シングルコマンドモード](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command)」を参照してください。送信先クラスターの認証情報を提供するには、DESTINATION\$1CLOUDHSM\$1PIN と DESTINATION\$1CLOUDHSM\$1ROLE の 2 つの追加の環境変数を設定する必要があります。

    ```
    $ export DESTINATION_CLOUDHSM_ROLE=<role>
    ```

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  インタラクティブモードでは、ユーザーは送信元クラスターと送信先クラスターの両方に明示的にログインする必要があります。

## 構文
<a name="chsm-cli-key-replicate-syntax"></a>

```
aws-cloudhsm > help key replicate
Replicate a key from a source to a destination cluster

Usage: key replicate --filter [<FILTER>...] --source-cluster-id <SOURCE_CLUSTER_ID> --destination-cluster-id <DESTINATION_CLUSTER_ID>

Options:
      --filter [<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 matching key on the source cluster
      --source-cluster-id <SOURCE_CLUSTER_ID>
          Source cluster ID
      --destination-cluster-id <DESTINATION_CLUSTER_ID>
          Destination cluster ID
  -h, --help
          Print help
```

## 例
<a name="chsm-cli-key-replicate-examples"></a>

**Example 例: キーをレプリケートする**  
このコマンドは、送信元のクラスターから送信先クラスター (クローン) にキーをレプリケートします。以下の例は、両方のクラスターに Crypto User としてログインしたときの出力を示しています。  

```
crypto-user-1@cluster-1234abcdefg > key replicate \
      --filter attr.label=example-key \
      --source-cluster-id cluster-1234abcdefg \
      --destination-cluster-id cluster-2345bcdefgh
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x0000000000300006",
      "key-info": {
        "key-owners": [
          {
            "username": "crypto-user-1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-key",
        "id": "0x",
        "check-value": "0x5e118e",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": true,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    },
    "message": "Successfully replicated key"
  }
}
```

## 引数
<a name="key-replicate-arguments"></a>

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを送信元クラスターで選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください  
必須: はい

***<SOURCE\$1CLUSTER\$1ID>***  
送信元クラスターの ID。  
必須: はい

***<DESTINATION\$1CLUSTER\$1ID>***  
送信先クラスターの ID。  
必須: はい

## 関連トピック
<a name="chsm-key-replicate-seealso"></a>
+ [CloudHSM CLI を使用した複数のクラスターへの接続](cloudhsm_cli-configs-multi-cluster.md)

# CloudHSM CLI でキーの属性を設定する
<a name="cloudhsm_cli-key-set-attribute"></a>

CloudHSM CLI の **key set-attribute** コマンドを使用して、 AWS CloudHSM クラスター内のキーの属性を設定します。キーの属性を変更できるのは、キーを作成し、その結果キーを所有する CU のみです。

CloudHSM CLI で使用できる主な属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。

## ユーザーのタイプ
<a name="chsm-cli-key-set-attribute-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ このコマンドを実行できるのは Crypto User (CU) です。
+ 管理者は信頼できる属性を設定できます。

## 要件
<a name="chsm-cli-key-set-attribute-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。信頼できる属性を設定するには、管理者ユーザーとしてログインする必要があります。

## Syntax
<a name="chsm-cli-key-set-attribute-syntax"></a>

```
aws-cloudhsm > help key set-attribute
Set an attribute for a key in the HSM cluster

Usage: cloudhsm-cli key set-attribute [OPTIONS] --filter [<FILTER>...] --name <KEY_ATTRIBUTE> --value <KEY_ATTRIBUTE_VALUE>

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
      --filter [<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 matching key to modify
      --name <KEY_ATTRIBUTE>            Name of attribute to be set
      --value <KEY_ATTRIBUTE_VALUE>...  Attribute value to be set
      --approval <APPROVAL>            Filepath of signed quorum token file to approve operation
  -h, --help                            Print help
```

## 例: キー属性の設定
<a name="chsm-cli-key-set-attribute-examples"></a>

次の例は、**key set-attribute** コマンドを使用してラベルを設定する方法を示しています。

**Example**  

1. 次に示すように、ラベル `my_key` の付いたキーを使用してください。

   ```
   aws-cloudhsm > key set-attribute --filter attr.label=my_key --name encrypt --value false
   {
     "error_code": 0,
     "data": {
       "message": "Attribute set successfully"
     }
   }
   ```

1. **key list** コマンドを使用して、`encrypt` 属性が変更されたことを確認します。

   ```
   aws-cloudhsm > key list --filter attr.label=my_key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000006400ec",
           "key-info": {
             "key-owners": [
               {
                 "username": "bob",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [],
           "key-quorum-values": {
             "manage-key-quorum-value": 0,
             "use-key-quorum-value": 0
           },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "aes",
             "label": "my_key",
             "id": "",
             "check-value": "0x6bd9f7",
             "class": "secret-key",
             "encrypt": false,
             "decrypt": true,
             "token": true,
             "always-sensitive": true,
             "derive": true,
             "destroyable": true,
             "extractable": true,
             "local": true,
             "modifiable": true,
             "never-extractable": false,
             "private": true,
             "sensitive": true,
             "sign": true,
             "trusted": true,
             "unwrap": true,
             "verify": true,
             "wrap": true,
             "wrap-with-trusted": false,
             "key-length-bytes": 32
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

## 引数
<a name="chsm-cli-key-set-attribute-arguments"></a>

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

***<KEY\$1ATTRIBUTE>***  
キーの属性の名前を指定します。  
必須: はい

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。  
サポートされている CloudHSM CLI キー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください  
必須: いいえ

***<KEY\$1ATTRIBUTE\$1VALUE>***  
キーの属性の値を指定します。  
必須: はい

***<KEY\$1REFERENCE>***  
キーの 16 進数または 10 進数表現。 (キーハンドルなど)。  
必須: いいえ

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

## 関連トピック
<a name="chsm-cli-key-set-attribute-see-also"></a>
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)

# CloudHSM CLI を使用してキーを共有する
<a name="cloudhsm_cli-key-share"></a>

CloudHSM CLI の **key share** コマンドを使用して、 AWS CloudHSM クラスター内の他の CUs とキーを共有します。

キーを共有できるのは、キーを作成し、その結果キーを所有する CU のみです。キーを共有しているユーザーは、暗号化オペレーションでキーを使用できますが、キーを削除、エクスポート、共有、または共有解除することはできません。さらに、これらのユーザーは [キー属性](cloudhsm_cli-key-attributes.md) を変更できません。

## ユーザーのタイプ
<a name="chsm-cli-key-share-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="chsm-cli-key-share-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="chsm-cli-key-share-syntax"></a>

```
aws-cloudhsm > help key share
Share a key in the HSM cluster with another user

Usage: key share --filter [<FILTER>...] --username <USERNAME> --role <ROLE>

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

      --filter [<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 matching key for sharing

      --username <USERNAME>
          A username with which the key will be shared

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## 例: キーを別の CU と共有する
<a name="chsm-cli-key-share-examples"></a>

以下の例は、**key share** コマンドを使用して CU `alice` とキーを共有する方法を示します。

**Example**  

1. **key share** コマンドを実行して `alice` とキーを共有します。

   ```
   aws-cloudhsm > key share --filter attr.label="rsa_key_to_share" attr.class=private-key --username alice --role crypto-user
   {
     "error_code": 0,
     "data": {
       "message": "Key shared successfully"
     }
   }
   ```

1. **key list** コマンドを実行します。

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
               {
                 "username": "alice",
                 "key-coverage": "full"
               }
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "decrypt": true,
             "token": true,
             "always-sensitive": true,
             "derive": false,
             "destroyable": true,
             "extractable": true,
             "local": true,
             "modifiable": true,
             "never-extractable": false,
             "private": true,
             "sensitive": true,
             "sign": true,
             "trusted": false,
             "unwrap": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

1. 上記のリストで、`alice` が `shared-users` のリストに含まれている事を検証します

## 引数
<a name="chsm-cli-key-share-arguments"></a>

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

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: はい

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。  
必須: はい

***<ROLE>***  
このユーザーに割り当てられるロールを指定します。このパラメータは必須です。ユーザーのロールを取得するには、ユーザーリストコマンドを使用します。HSM のユーザータイプの詳細については、「[CloudHSM CLI の HSM ユーザータイプ](understanding-users.md)」を参照してください。  
必須: はい

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

## 関連トピック
<a name="chsm-cli-key-share-see-also"></a>
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)

# CloudHSM CLI を使用してキーの共有を解除する
<a name="cloudhsm_cli-key-unshare"></a>

CloudHSM CLI の **key unshare** コマンドを使用して、 AWS CloudHSM クラスター内の他の CUs とキーの共有を解除します。

キーを共有解除できるのは、キーを作成し、その結果キーを所有する CU のみです。キーを共有しているユーザーは、暗号化オペレーションでキーを使用できますが、キーを削除、エクスポート、共有、または共有解除することはできません。さらに、これらのユーザーは [キー属性](cloudhsm_cli-key-attributes.md) を変更できません。

## ユーザーのタイプ
<a name="chsm-cli-key-unshare-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="chsm-cli-key-unshare-requirements"></a>

このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="chsm-cli-key-unshare-syntax"></a>

```
aws-cloudhsm > help key unshare
Unshare a key in the HSM cluster with another user

Usage: key unshare --filter [<FILTER>...] --username <USERNAME> --role <ROLE>

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

      --filter [<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 matching key for unsharing

      --username <USERNAME>
          A username with which the key will be unshared

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## 例: 別の CU とのキーの共有を解除する
<a name="chsm-cli-key-share-examples"></a>

以下の例は、**key unshare** コマンドを使用して CU `alice` とのキーの共有を解除する方法を示しています。

**Example**  

1. **key list** コマンドを実行し、`alice` と共有を解除したい特定のキーでフィルタリングします。

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
               {
                 "username": "alice",
                 "key-coverage": "full"
               }
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "decrypt": true,
             "token": true,
             "always-sensitive": true,
             "derive": false,
             "destroyable": true,
             "extractable": true,
             "local": true,
             "modifiable": true,
             "never-extractable": false,
             "private": true,
             "sensitive": true,
             "sign": true,
             "trusted": false,
             "unwrap": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

1. `shared-users` 出力に `alice` が含まれていることを確認し、次の **key unshare** コマンドを実行して `alice` とのキーの共有を解除します。

   ```
   aws-cloudhsm > key unshare --filter attr.label="rsa_key_to_share" attr.class=private-key --username alice --role crypto-user
   {
     "error_code": 0,
     "data": {
       "message": "Key unshared successfully"
     }
   }
   ```

1. `key list` コマンドをもう一度実行して、`alice` とキーが共有解除されたことを確認します。

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "decrypt": true,
             "token": true,
             "always-sensitive": true,
             "derive": false,
             "destroyable": true,
             "extractable": true,
             "local": true,
             "modifiable": true,
             "never-extractable": false,
             "private": true,
             "sensitive": true,
             "sign": true,
             "trusted": false,
             "unwrap": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

## 引数
<a name="chsm-cli-key-unshare-arguments"></a>

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

***<FILTER>***  
キーリファレンス (例: `key-reference=0xabc`) または `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。  
サポートされているキー属性のリストについては、「[CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)」を参照してください。  
必須: はい

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。  
必須: はい

***<ROLE>***  
このユーザーに割り当てられるロールを指定します。このパラメータは必須です。ユーザーのロールを取得するには、ユーザーリストコマンドを使用します。HSM のユーザータイプの詳細については、「[CloudHSM CLI の HSM ユーザータイプ](understanding-users.md)」を参照してください。  
必須: はい

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

## 関連トピック
<a name="chsm-cli-key-unshare-see-also"></a>
+ [CloudHSM CLI を使用してキーをフィルタリングする](manage-keys-cloudhsm-cli-filtering.md)
+ [CloudHSM CLI のキー属性](cloudhsm_cli-key-attributes.md)

# CloudHSM CLI のキーアンラップコマンド
<a name="cloudhsm_cli-key-unwrap"></a>

CloudHSM CLI の **key unwrap** 親コマンドは、暗号化された (ラップされた) 対称または非対称プライベートキーをファイルから HSM 内にインポートします。このコマンドは、[CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md) コマンドでラップされた暗号化されたキーをインポートするように設計されていますが、他のツールでラップされたキーをアンラップするためにも使用できます。ただし、このような場合は、PKCS\$111 または JCE ソフトウェアライブラリを使用して、キーをラップ解除することをお勧めします。
+ [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md)
+ [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md)
+ [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md)
+ [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md)
+ [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md)
+ [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md)
+ [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md)
+ [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md)

# CloudHSM CLI を使用して AES-GCM でキーのラッピングを解除する
<a name="cloudhsm_cli-key-unwrap-aes-gcm"></a>

CloudHSM CLI の **key unwrap aes-gcm** コマンドを使用して、AES ラッピングキーと `AES-GCM` ラップ解除メカニズムを使用してペイロードキーのラップを解除してクラスターに入れます。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap aes-gcm** コマンドを使用するには、 AWS CloudHSM クラスターに AES ラッピングキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-aes-gcm-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-aes-gcm-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-gcm
Usage: key unwrap aes-gcm [OPTIONS] --filter [<FILTER>...] --tag-length-bits <TAG_LENGTH_BITS> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> --iv <IV> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --iv <IV>
          Initial value used to wrap the key, in hex
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-aes-gcm-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap aes-gcm** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --iv 0xf90613bb8e337ec0339aad21 --data xvslgrtg8kHzrvekny97tLSIeokpPwV8
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e4",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --iv 0xf90613bb8e337ec0339aad21 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e4",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-aes-gcm-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<AAD>***  
AES GCM 追加認証データ (AAD) 値 (16 進数)。  
必須: いいえ

***<TAG\$1LENGTH\$1BITS>***  
AES GCM タグの長さ (ビット単位)。  
必須: はい

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

***<IV>***  
キーを 16 進数でラッピングするために使用される初期値。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-aes-gcm-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して AES-NO-PAD でキーのラッピングを解除する
<a name="cloudhsm_cli-key-unwrap-aes-no-pad"></a>

CloudHSM CLI の **key unwrap aes-no-pad** コマンドを使用して、AES ラップキーとラップ解除メカニズムを使用してペイロードキーを AWS CloudHSM クラスターにラップ`AES-NO-PAD`解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap aes-no-pad** コマンドを使用するには、 AWS CloudHSM クラスターに AES ラッピングキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-no-pad
Usage: key unwrap aes-no-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap aes-no-pad** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-no-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data eXK3PMAOnKM9y3YX6brbhtMoC060EOH9
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ec",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-no-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ec",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して AES-PKCS5-PAD でキーのラッピングを解除する
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad"></a>

CloudHSM CLI の **key unwrap aes-pkcs5-pad** コマンドを使用して、AES ラッピングキーと `AES-PKCS5-PAD` ラップ解除メカニズムを使用してペイロードキーのラップを解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap aes-pkcs5-pad** コマンドを使用するには、 AWS CloudHSM クラスターに AES ラッピングキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-pkcs5-pad
Usage: key unwrap aes-pkcs5-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap aes-pkcs5-pad** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-pkcs5-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data MbuYNresfOKyGNnxKWen88nSfX+uUE/0qmGofSisicY=
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e3",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-pkcs5-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e3",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して AES-ZERO-PAD でキーのラッピングを解除する
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad"></a>

CloudHSM CLI の **key unwrap aes-zero-pad** コマンドを使用して、AES ラップキーとラップ解除メカニズムを使用してペイロードキーを AWS CloudHSM クラスターにラップ`AES-ZERO-PAD`解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap aes-no-pad** コマンドを使用するには、 AWS CloudHSM クラスターに AES ラッピングキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-zero-pad
Usage: key unwrap aes-zero-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap aes-zero-pad** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-zero-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data L1wVlL/YeBNVAw6Mpk3owFJZXBzDLONt
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e7",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap aes-zero-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e7",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して CLOUDHSM-AES-GCM でキーのラッピングを解除する
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm"></a>

CloudHSM CLI の **key unwrap cloudhsm-aes-gcm** コマンドを使用して、AES ラップキーとラップ解除メカニズムを使用してペイロードキーを AWS CloudHSM クラスターにラップ`CLOUDHSM-AES-GCM`解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap cloudhsm-aes-gcm** コマンドを使用するには、 AWS CloudHSM クラスターに AES ラッピングキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key unwrap cloudhsm-aes-gcm
Usage: key unwrap cloudhsm-aes-gcm [OPTIONS] --filter [<FILTER>...] --tag-length-bits <TAG_LENGTH_BITS> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap cloudhsm-aes-gcm** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap cloudhsm-aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --data 6Rn8nkjEriDYlnP3P8nPkYQ8hplOEJ899zsrF+aTB0i/fIlZ
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001408e8",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap cloudhsm-aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001408e8",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<AAD>***  
AES GCM 追加認証データ (AAD) 値 (16 進数)。  
必須: いいえ

***<TAG\$1LENGTH\$1BITS>***  
AES GCM タグの長さ (ビット単位)。  
必須: はい

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して RSA-AES でキーをアンラップする
<a name="cloudhsm_cli-key-unwrap-rsa-aes"></a>

CloudHSM CLI の **key unwrap rsa-aes** コマンドを使用して、RSA プライベートキーと `RSA-AES` ラップ解除メカニズムを使用してペイロードキーをラップ解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

を使用するには**key unwrap rsa-aes**、 AWS CloudHSM クラスターに RSA パブリックラッピングキーの RSA プライベートキーがあり、その`unwrap`属性を に設定する必要があります`true`。

**注記**  
このコマンドは、CloudHSM CLI 5.11 以降でのみ使用できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-unwrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-aes
Usage: key unwrap rsa-aes [OPTIONS] --filter [<FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

これらの例は、`unwrap` 属性値が `true` に設定された RSA プライベートキーを使用して **key unwrap rsa-aes** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-aes --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --hash-function sha256 --mgf mgf1-sha256 --data HrSE1DEyLjIeyGdPa9R+ebiqB5TIJGyamPker31ZebPwRA+NcerbAJO8DJ1lXPygZcI21vIFSZJuWMEiWpe1R9D/5WSYgxLVKex30xCFqebtEzxbKuv4DOmU4meSofqREYvtb3EoIKwjyxCMRQFgoyUCuP4y0f0eSv0k6rSJh4NuCsHptXZbtgNeRcR4botN7LlzkEIUcq4fVHaatCwd0J1QGKHKyRhkol+RL5WGXKe4nAboAkC5GO7veI5yHL1SaKlssSJtTL/CFpbSLsAFuYbv/NUCWwMY5mwyVTCSlw+HlgKK+5TH1MzBaSi8fpfyepLT8sHy2Q/VRl6ifb49p6m0KQFbRVvz/OWUd6l4d97BdgtaEz6ueg==
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e2",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-aes --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --hash-function sha256 --mgf mgf1-sha256 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e2",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<MGF>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効な値:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI で RSA-OAEP でキーをアンラップする
<a name="cloudhsm_cli-key-unwrap-rsa-oaep"></a>

CloudHSM CLI の **key unwrap rsa-oaep** コマンドを使用して、RSA プライベートキーと `RSA-OAEP` ラップ解除メカニズムを使用してペイロードキーをラップ解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

**key unwrap rsa-oaep** コマンドを使用するには、 AWS CloudHSM クラスターに RSA パブリックラッピングキーの RSA プライベートキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-oaep
Usage: key unwrap rsa-oaep [OPTIONS] --filter [<FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-examples"></a>

これらの例は、`unwrap` 属性値が `true` に設定された RSA プライベートキーを使用して **key unwrap rsa-oaep** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-oaep --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-example-key --hash-function sha256 --mgf mgf1-sha256 --data OjJe4msobPLz9TuSAdULEu17T5rMDWtSlLyBSkLbaZnYzzpdrhsbGLbwZJCtB/jGkDNdB4qyTAOQwEpggGf6v+Yx6JcesNeKKNU8XZal/YBoHC8noTGUSDI2qr+u2tDc84NPv6d+F2KOONXsSxMhmxzzNG/gzTVIJhOuy/B1yHjGP4mOXoDZf5+7f5M1CjxBmz4Vva/wrWHGCSG0yOaWblEvOiHAIt3UBdyKmU+/My4xjfJv7WGGu3DFUUIZ06TihRtKQhUYU1M9u6NPf9riJJfHsk6QCuSZ9yWThDT9as6i7e3htnyDhIhGWaoK8JU855cN/YNKAUqkNpC4FPL3iw==
{
  "data": {
    "key": {
      "key-reference": "0x00000000001808e9",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-oaep --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-example-key --hash-function sha256 --mgf mgf1-sha256 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e9",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<HASH\$1FUNCTION>***  
ハッシュ関数を指定します。  
有効な値:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
必須: はい

***<MGF>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効な値:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して RSA-PKCS でキーをアンラップする
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs"></a>

CloudHSM CLI の **key unwrap rsa-pkcs** コマンドを使用して、RSA プライベートキーと `RSA-PKCS` ラップ解除メカニズムを使用してペイロードキーをラップ解除します。

ラップされていないキーは、 によって生成されたキーと同じ方法で使用できます AWS CloudHSM。ローカルで生成されなかったことを示すために、`local` 属性は `false` に設定されます。

key **unwrap rsa-pkcs** コマンドを使用するには、 AWS CloudHSM クラスターに RSA パブリックラッピングキーの RSA プライベートキーがあり、その`unwrap`属性を に設定する必要があります`true`。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## 構文
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-pkcs
Usage: key unwrap rsa-pkcs [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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
      --filter [<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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-examples"></a>

これらの例は、`unwrap` 属性値を `true` に設定した AES キーを使用して **key unwrap rsa-oaep** コマンドを使用する方法を示しています。

**Example 例: Base64 でエンコードされたラッピングされたキーデータからペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-pkcs --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --data am0Nc7+YE8FWs+5HvU7sIBcXVb24QA0l65nbNAD+1bK+e18BpSfnaI3P+r8Dp+pLu1ofoUy/vtzRjZoCiDofcz4EqCFnGl4GdcJ1/3W/5WRvMatCa2d7cx02swaeZcjKsermPXYRO1lGlfq6NskwMeeTkV8R7Rx9artFrs1y0DdIgIKVaiFHwnBIUMnlQrR2zRmMkfwU1jxMYmOYyD031F5VbnjSrhfMwkww2la7uf/c3XdFJ2+0Bo94c6og/yfPcpOOobJlITCoXhtMRepSdO4OggYq/6nUDuHCtJ86pPGnNahyr7+sAaSI3a5ECQLUjwaIARUCyoRh7EFK3qPXcg==
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ef",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

**Example 例: データパスを介して提供されたペイロードキーのラッピングを解除する**  

```
aws-cloudhsm > key unwrap rsa-pkcs --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ef",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    }
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-arguments"></a>

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

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

***<DATA\$1PATH>***  
ラッピングされたキーデータを含むバイナリファイルへのパス。  
必須: はい (Base64 でエンコードされたデータを通じて提供される場合を除く）

***<DATA>***  
Base64 でエンコードされたラッピングされたキーデータ。  
必須: はい (データパスを通じて提供される場合を除く）

***<ATTRIBUTES>***  
ラッピングされたキーの `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` 形式のキー属性のスペース区切りリスト。  
必須: いいえ

***<KEY\$1TYPE\$1CLASS>***  
ラッピングされたキーのキータイプとクラス [可能な値: `aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`]。  
必須: はい

***<LABEL>***  
ラッピングされていないキーのラベル。  
必須: はい

***<SESSION>***  
現在のセッションにのみ存在するセッションキーを作成します。セッション終了後、キーをリカバリすることはできません。  
必須: いいえ

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI のキーラップコマンド
<a name="cloudhsm_cli-key-wrap"></a>

CloudHSM CLI の **key wrap** コマンドでは、対称または非対称プライベートキーの暗号化されたコピーをハードウェアセキュリティモジュール (HSM) からファイルにエクスポートします。**key wrap** を実行するときは、エクスポートするキーと出力ファイルの 2 つを指定します。エクスポートするキーは、エクスポートするキーを暗号化 (ラップ) する HSM 上のキーです。

**key wrap** コマンドは、HSM からキーを削除したり、暗号化操作での使用を妨げたりしません。同じキーを複数回エクスポートできます。暗号化されたキーを HSM に再度インポートするには、[CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md) を使用します。キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、暗号化オペレーションでのみキーを使用できます

**key wrap** コマンドは次のサブコマンドで構成されます。
+ [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md)
+ [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md)
+ [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md)
+ [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md)
+ [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md)
+ [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md)
+ [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md)
+ [rsa-pkcs](cloudhsm_cli-key-wrap-rsa-pkcs.md)

# CloudHSM CLI を使用して AES-GCM でキーをラップする
<a name="cloudhsm_cli-key-wrap-aes-gcm"></a>

CloudHSM CLI の **key wrap aes-gcm** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の AES キーと `AES-GCM` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap aes-gcm** コマンドを使用するには、まず AWS CloudHSM クラスターに AES キーが必要です。[CloudHSM CLI で対称 AES キーを生成する](cloudhsm_cli-key-generate-symmetric-aes.md) コマンドと `true` に設定された `wrap` 属性でラップするための AES キーを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-aes-gcm-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-aes-gcm-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key wrap aes-gcm
Usage: key wrap aes-gcm [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --tag-length-bits <TAG_LENGTH_BITS>

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
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-wrap-aes-gcm-examples"></a>

この例では、AES キーを使用して **key wrap aes-gcm** コマンドを使用する方法を示しています。

**Example**  

```
aws-cloudhsm > key wrap aes-gcm --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example --tag-length-bits 64  --aad 0x10
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "iv": "0xf90613bb8e337ec0339aad21",
    "wrapped_key_data": "xvslgrtg8kHzrvekny97tLSIeokpPwV8"
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-aes-gcm-arguments"></a>

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

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

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

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

***<AAD>***  
AES GCM 追加認証データ (AAD) 値 (16 進数)。  
必須: いいえ

***<TAG\$1LENGTH\$1BITS>***  
AES GCM タグの長さ (ビット単位)。  
必須: はい

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-aes-gcm-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI でキーを AES-NO-PAD でラップする
<a name="cloudhsm_cli-key-wrap-aes-no-pad"></a>

CloudHSM CLI の **key wrap aes-no-pad** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の AES キーと `AES-NO-PAD` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap aes-no-pad** コマンドを使用するには、まず AWS CloudHSM クラスターに AES キーが必要です。[CloudHSM CLI で対称 AES キーを生成する](cloudhsm_cli-key-generate-symmetric-aes.md) コマンドと `true` に設定された `wrap` 属性を使用して、ラッピング用の AES キーを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-aes-no-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-aes-no-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-aes-no-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-no-pad
Usage: key wrap aes-no-pad [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
```

## 例
<a name="cloudhsm_cli-key-wrap-aes-no-pad-examples"></a>

この例では、`wrap` 属性値が `true` に設定された AES キーを使用して **key wrap aes-no-pad** コマンドを使用する方法を示します。

**Example**  

```
aws-cloudhsm > key wrap aes-no-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "eXK3PMAOnKM9y3YX6brbhtMoC060EOH9"
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-aes-no-pad-arguments"></a>

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

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

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

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

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-aes-no-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して AES-PKCS5-PAD でキーをラップする
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad"></a>

CloudHSM CLI の **key wrap aes-pkcs5-pad** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の AES キーと `AES-PKCS5-PAD` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap aes-pkcs5-pad** コマンドを使用するには、まず AWS CloudHSM クラスターに AES キーが必要です。[CloudHSM CLI で対称 AES キーを生成する](cloudhsm_cli-key-generate-symmetric-aes.md) コマンドと `true` に設定された `wrap` 属性を使用して、ラッピング用の AES キーを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-pkcs5-pad
Usage: key wrap aes-pkcs5-pad [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
```

## 例
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-examples"></a>

この例では、`wrap` 属性値が `true` に設定された AES キーを使用して **key wrap aes-pkcs5-pad** コマンドを使用する方法を示します。

**Example**  

```
aws-cloudhsm > key wrap aes-pkcs5-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "MbuYNresfOKyGNnxKWen88nSfX+uUE/0qmGofSisicY="
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-arguments"></a>

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

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

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

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

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI でキーを AES-ZERO-PAD でラップする
<a name="cloudhsm_cli-key-wrap-aes-zero-pad"></a>

CloudHSM CLI の **key wrap aes-zero-pad** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の AES キーと `AES-ZERO-PAD` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap aes-zero-pad** コマンドを使用するには、まず AWS CloudHSM クラスターに AES キーが必要です。[CloudHSM CLI で対称 AES キーを生成する](cloudhsm_cli-key-generate-symmetric-aes.md) コマンドで `wrap` 属性を `true` に設定して、ラッピング用の AES キーを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-zero-pad
Usage: key wrap aes-zero-pad [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
```

## 例
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-examples"></a>

この例では、`wrap` 属性値が `true` に設定された AES キーを使用して **key wrap aes-zero-pad ** コマンドを使用する方法を示します。

**Example**  

```
aws-cloudhsm > key wrap aes-zero-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "L1wVlL/YeBNVAw6Mpk3owFJZXBzDLONt"
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-arguments"></a>

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

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

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

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

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して CLOUDHSM-AES-GCM でキーをラップする
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm"></a>

CloudHSM CLI の **key wrap cloudhsm-aes-gcm** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の AES キーと `CLOUDHSM-AES-GCM` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap cloudhsm-aes-gcm** コマンドを使用するには、まず AWS CloudHSM クラスターに AES キーが必要です。[CloudHSM CLI で対称 AES キーを生成する](cloudhsm_cli-key-generate-symmetric-aes.md) コマンドと `true` に設定された `wrap` 属性でラップするための AES キーを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key wrap cloudhsm-aes-gcm
Usage: key wrap cloudhsm-aes-gcm [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --tag-length-bits <TAG_LENGTH_BITS>

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
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-examples"></a>

この例では、AES キーを使用して **key wrap cloudhsm-aes-gcm** コマンドを使用する方法を示しています。

**Example**  

```
aws-cloudhsm > key wrap cloudhsm-aes-gcm --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example --tag-length-bits 64 --aad 0x10
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "6Rn8nkjEriDYlnP3P8nPkYQ8hplOEJ899zsrF+aTB0i/fIlZ"
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-arguments"></a>

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

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

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

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

***<AAD>***  
AES GCM 追加認証データ (AAD) 値 (16 進数)。  
必須: いいえ

***<TAG\$1LENGTH\$1BITS>***  
AES GCM タグの長さ (ビット単位)。  
必須: はい

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI で RSA-AES を使用してキーをラップする
<a name="cloudhsm_cli-key-wrap-rsa-aes"></a>

CloudHSM CLI の **key wrap rsa-aes** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の RSA パブリックキーと RSA-AES ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap rsa-aes** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA キーが必要です。[CloudHSM CLI の generate-asymmetric-pair カテゴリ](cloudhsm_cli-key-generate-asymmetric-pair.md) コマンドと `true` に設定された `wrap` 属性を使用して、RSA キーペアを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-rsa-aes-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-rsa-aes-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key wrap rsa-aes
Usage: key wrap rsa-aes [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF>

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
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-wrap-rsa-aes-examples"></a>

この例では、`wrap` 属性値を `true` に設定した RSA 公開キーを使用して **key wrap rsa-ae** コマンドを使用する方法を示します。

**Example**  

```
aws-cloudhsm > key wrap rsa-aes --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example --hash-function sha256 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "payload-key-reference": "0x00000000001c08f1",
    "wrapping-key-reference": "0x00000000007008da",
    "wrapped-key-data": "HrSE1DEyLjIeyGdPa9R+ebiqB5TIJGyamPker31ZebPwRA+NcerbAJO8DJ1lXPygZcI21vIFSZJuWMEiWpe1R9D/5WSYgxLVKex30xCFqebtEzxbKuv4DOmU4meSofqREYvtb3EoIKwjyxCMRQFgoyUCuP4y0f0eSv0k6rSJh4NuCsHptXZbtgNeRcR4botN7LlzkEIUcq4fVHaatCwd0J1QGKHKyRhkol+RL5WGXKe4nAboAkC5GO7veI5yHL1SaKlssSJtTL/CFpbSLsAFuYbv/NUCWwMY5mwyVTCSlw+HlgKK+5TH1MzBaSi8fpfyepLT8sHy2Q/VRl6ifb49p6m0KQFbRVvz/OWUd6l4d97BdgtaEz6ueg=="
  }
}
```

## 引数
<a name="cloudhsm_cli-key-wrap-rsa-aes-arguments"></a>

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

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

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

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

***<MGF>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効値  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-rsa-aes-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して RSA-OAEP でキーをラップする
<a name="cloudhsm_cli-key-wrap-rsa-oaep"></a>

CloudHSM CLI の **key wrap rsa-oaep** コマンドを使用して、ハードウェアセキュリティモジュール (HSM) の RSA パブリックキーと `RSA-OAEP` ラップメカニズムを使用してペイロードキーをラップします。ペイロードキーの `extractable` 属性を `true` に設定する必要があります。

キーの所有者、つまりキーを作成した Crypto User (CU) のみがキーをラップできます。キーを共有するユーザーは、キーを暗号化オペレーションで使用できます。

**key wrap rsa-oaep** コマンドを使用するには、まず AWS CloudHSM クラスターに RSA キーが必要です。[CloudHSM CLI の generate-asymmetric-pair カテゴリ](cloudhsm_cli-key-generate-asymmetric-pair.md) コマンドと `true` に設定された `wrap` 属性を使用して、RSA キーペアを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-unwrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key wrap rsa-oaep
Usage: key wrap rsa-oaep [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF>

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
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
  -h, --help
          Print help
```

## 例
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

この例では、`wrap` 属性値を `true` に設定した RSA 公開キーを使用して **key wrap rsa-oaep** コマンドを使用する方法を示します。

**Example**  

```
aws-cloudhsm > key wrap rsa-oaep --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example --hash-function sha256 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "payload-key-reference": "0x00000000001c08f1",
    "wrapping-key-reference": "0x00000000007008da",
    "wrapped-key-data": "OjJe4msobPLz9TuSAdULEu17T5rMDWtSlLyBSkLbaZnYzzpdrhsbGLbwZJCtB/jGkDNdB4qyTAOQwEpggGf6v+Yx6JcesNeKKNU8XZal/YBoHC8noTGUSDI2qr+u2tDc84NPv6d+F2KOONXsSxMhmxzzNG/gzTVIJhOuy/B1yHjGP4mOXoDZf5+7f5M1CjxBmz4Vva/wrWHGCSG0yOaWblEvOiHAIt3UBdyKmU+/My4xjfJv7WGGu3DFUUIZ06TihRtKQhUYU1M9u6NPf9riJJfHsk6QCuSZ9yWThDT9as6i7e3htnyDhIhGWaoK8JU855cN/YNKAUqkNpC4FPL3iw=="
  }
}
```

## 引数
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

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

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

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

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

***<MGF>***  
マスク生成関数を指定します。  
マスク生成関数のハッシュ関数は、署名メカニズムのハッシュ関数と一致する必要があります。
有効値  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
必須: はい

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

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

## 関連トピック
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI で RSA-PKCS でキーをラップする
<a name="cloudhsm_cli-key-wrap-rsa-pkcs"></a>

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 キーペアを生成できます。

## ユーザーのタイプ
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ Crypto User (CU)

## 要件
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-requirements"></a>
+ このコマンドを実行するには、CU としてログインする必要があります。

## Syntax
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-syntax"></a>

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

## 例
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-examples"></a>

この例では、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=="
  }
```

## 引数
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-arguments"></a>

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

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

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

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

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

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

## 関連トピック
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-seealso"></a>
+ [CloudHSM CLI のキーラップコマンド](cloudhsm_cli-key-wrap.md)
+ [CloudHSM CLI のキーアンラップコマンド](cloudhsm_cli-key-unwrap.md)

# CloudHSM CLI を使用して HSM にログインする
<a name="cloudhsm_cli-login"></a>

CloudHSM CLI の **login** コマンドを使用して、 AWS CloudHSM クラスター内の各ハードウェアセキュリティ (HSM) にログインおよびログアウトできます。このコマンドは、次のサブコマンドで構成されます。
+ [mfa-token-sign](cloudhsm_cli-login-mfa-token-sign.md)

**注記**  
ログイン試行回数が 5 回を超えると、アカウントがロックアウトされます。アカウントのロックを解除するには、管理者は、cloudhsm\$1cli の [user change-password](cloudhsm_cli-user-change-password.md) コマンドを使用してパスワードをリセットする必要があります。

## ログインとログアウトのトラブルシューティングを行うには
<a name="troubleshoot-login-logout"></a>

クラスター内に複数の HSM がある場合は、アカウントがロックアウトされるまでのログイン試行回数の上限が増える可能性があります。これは、CloudHSM クライアントがさまざまな HSM 間で負荷を分散するためです。したがって、ログイン試行は毎回同じ HSM で開始されない場合があります。この機能をテストしている場合は、アクティブな HSM が1つだけのクラスターでテストすることをお勧めします。

2018 年 2 月より前にクラスターを作成した場合、ロックアウトされるまでのログイン試行回数は 20 回です。

## ユーザーのタイプ
<a name="chsm-cli-login-logout-userType"></a>

これらのコマンドは、次のユーザーが実行できます。
+ 非アクティブ管理者
+ 管理者
+ Crypto User (CU)

## Syntax
<a name="chsm-cli-login-syntax"></a>

```
aws-cloudhsm > help login
Login to your cluster  
        
USAGE:
    cloudhsm-cli login [OPTIONS] --username <USERNAME> --role <ROLE> [COMMAND]
    
Commands:
  mfa-token-sign  Login with token-sign mfa
  help            Print this message or the help of the given subcommand(s)

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

        --username <USERNAME>
            Username to access the Cluster
        
        --role <ROLE>
            Role the user has in the Cluster
            
           Possible values:
           - crypto-user: A CryptoUser has the ability to manage and use keys
           - admin:       An Admin has the ability to manage user accounts

        --password <PASSWORD>
           Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="chsm-cli-login-example"></a>

**Example**  
このコマンドは、`admin1` という名前の管理者ユーザーの認証情報を使用して、クラスター内のすべての HSM にログインします。  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```

## 引数
<a name="login-arguments"></a>

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

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。  
必須: はい

***<ROLE>***  
このユーザーに割り当てられるロールを指定します。有効な値は **admin**、**crypto-user** です。  
ユーザーのロールを取得するには、 **user list** コマンドを使用します。HSM のユーザータイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。  
必須: はい

***<PASSWORD>***  
HSM にログインしているユーザーのパスワードを指定します。  
必須: お客様は、`--password`コマンドライン引数を介してパスワードを指定するか、インタラクティブにプロンプトが表示されるように省略する必要があります。  
コマンドラインで `--password`引数を使用すると、シェル履歴に認証情報が公開される可能性があります。パスワードをインタラクティブにプロンプトするか、使用後にシェル履歴をクリアすることを検討してください。

## 関連トピック
<a name="login-seeAlso"></a>
+ [CloudHSM CLI の使用開始](cloudhsm_cli-getting-started.md)
+ [クラスターのアクティブ化](activate-cluster.md)

# CloudHSM CLI を使用して MFA で HSM にログインする
<a name="cloudhsm_cli-login-mfa-token-sign"></a>

 AWS CloudHSM CloudHSM CLI の **login mfa-token-sign** コマンドを使用して、多要素認証 (MFA) を使用してハードウェアセキュリティモジュール (HSM) にログインします。このコマンドを使用するには、まず [CloudHSM CLI の MFA](login-mfa-token-sign.md) を設定する必要があります。

## ユーザーのタイプ
<a name="cloudhsm_cli-login-mfa-token-userType"></a>

これらのコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## Syntax
<a name="cloudhsm_cli-login-mfa-token-syntax"></a>

```
aws-cloudhsm > help login mfa-token-sign
Login with token-sign mfa

USAGE:
    login --username <username> --role <role> mfa-token-sign --token <token>

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
      --token <TOKEN>            Filepath where the unsigned token file will be written
  -h, --help                     Print help
```

## 例
<a name="cloudhsm_cli-login-mfa-token-example"></a>

**Example**  

```
aws-cloudhsm > login --username test_user --role admin mfa-token-sign --token /home/valid.token
Enter password:
Enter signed token file path (press enter if same as the unsigned token file):
{
  "error_code": 0,
  "data": {
    "username": "test_user",
    "role": "admin"
  }
}
```

## 引数
<a name="cloudhsm_cli-login-mfa-token-arguments"></a>

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

***<TOKEN>***  
署名されていないトークンファイルが書き込まれるファイルパス。  
必須: はい

## 関連トピック
<a name="cloudhsm_cli-login-mfa-token-seeAlso"></a>
+ [CloudHSM CLI の使用開始](cloudhsm_cli-getting-started.md)
+ [クラスターのアクティブ化](activate-cluster.md)
+ [CloudHSM CLI を使用して MFA を管理する](login-mfa-token-sign.md)

# CloudHSM CLI で HSM からのログアウトする
<a name="cloudhsm_cli-logout"></a>

CloudHSM CLI の **logout** コマンドを使用して、 AWS CloudHSM クラスター内の各ハードウェアセキュリティモジュール (HSM) からログアウトします。

## ユーザーのタイプ
<a name="chsm-cli-logout-userType"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## Syntax
<a name="chsm-cli-logout-syntax"></a>

```
aws-cloudhsm > help logout
Logout of your cluster

USAGE:
    logout

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
    -h, --help                    Print help information
    -V, --version                 Print version information
```

## 例
<a name="chsm-cli-logout-example"></a>

**Example**  
このコマンドはクラスターの HSM からログアウトします。  

```
aws-cloudhsm > logout
{
  "error_code": 0,
  "data": "Logout successful"
}
```

## 関連トピック
<a name="logout-seeAlso"></a>
+ [CloudHSM CLI の使用開始](cloudhsm_cli-getting-started.md)
+ [クラスターのアクティブ化](activate-cluster.md)

# CloudHSM CLI のユーザーカテゴリ
<a name="cloudhsm_cli-user"></a>

CloudHSM CLI では、**user** はコマンドグループの親カテゴリであり、親カテゴリと組み合わせるとユーザー固有のコマンドが作成されます。現在、このユーザーカテゴリは次のコマンドで構成されています。
+ [user change-mfa](cloudhsm_cli-user-change-mfa.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [user list](cloudhsm_cli-user-list.md)
+ [user replicate](cloudhsm_cli-user-replicate.md)

# CloudHSM CLI のユーザー change-mfa カテゴリ
<a name="cloudhsm_cli-user-change-mfa"></a>

CloudHSM CLI において、**user change-mfa** は、多要素認証 (MFA) の変更に特化したコマンドを作成するために、親カテゴリと組み合わせて使用されるコマンド群の親カテゴリです。

現在、このカテゴリは次のサブコマンドで構成されています。
+ [token-sign](cloudhsm_cli-user-change-mfa-token-sign.md)

# CloudHSM CLI を使用してユーザーの MFA 設定を変更する
<a name="cloudhsm_cli-user-change-mfa-token-sign"></a>

CloudHSM CLI で **user change-mfa token-sign** コマンドを使用して、ユーザーアカウントの多要素認証 (MFA) 設定を更新します。このコマンドは、どのユーザーアカウントでも実行できます。Admin ロールを持つアカウントは、他のユーザーに対してこのコマンドを実行できます。

## ユーザーのタイプ
<a name="user-change-mfa-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User

## 構文
<a name="user-change-mfa-syntax"></a>

現在、ユーザーが利用できる多要素戦略は「トークン署名」だけです。

```
aws-cloudhsm > help user change-mfa
Change a user's Mfa Strategy

Usage:
    user change-mfa <COMMAND>
  
Commands:
  token-sign  Register or Deregister a public key using token-sign mfa strategy
  help        Print this message or the help of the given subcommand(s)
```

トークン署名戦略では、署名されていないトークンを書き込むためのトークンファイルを要求します。

```
aws-cloudhsm > help user change-mfa token-sign
Register or Deregister a public key using token-sign mfa strategy

Usage: user change-mfa token-sign [OPTIONS] --username <USERNAME> --role <ROLE> <--token <TOKEN>|--deregister>

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

      --username <USERNAME>
          Username of the user that will be modified

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --change-password <CHANGE_PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --token <TOKEN>
          Filepath where the unsigned token file will be written. Required for enabling MFA for a user

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

      --deregister
          Deregister the MFA public key, if present

      --change-quorum
          Change the Quorum public key along with the MFA key

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="user-change-mfa-examples"></a>

このコマンドは、クラスター内の HSM ごとに 1 つの未署名トークンを `token` で指定されたファイルに書き込みます。プロンプトが表示されたら、ファイル内のトークンに署名します。

**Example : クラスターの HSM ごとに 1 つの署名なしトークンを書き込みます**  

```
aws-cloudhsm > user change-mfa token-sign --username cu1 --change-password password --role crypto-user --token /path/myfile
Enter signed token file path (press enter if same as the unsigned token file):
Enter public key PEM file path:/path/mypemfile
{
  "error_code": 0,
  "data": {
    "username": "test_user",
    "role": "admin"
  }
}
```

### 引数
<a name="user-change-mfa-arguments"></a>

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

***<ROLE>***  
ユーザーアカウントに付与されるロールを指定します。このパラメータは必須です。HSM のユーザータイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。  
**有効な値**  
+ **Admin**:管理者はユーザーを管理できますが、キーを管理することはできません。
+ **Crypto user**: Crypto User は、管理キーを作成し、暗号化オペレーションでキーを使用できます。

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。  
ユーザーの作成後にユーザー名を変更することはできません。CloudHSM CLI コマンドでは、ロールとパスワードでは大文字と小文字が区別されますが、ユーザー名では区別されません。  
**必須**: はい

***<CHANGE\$1PASSWORD>***  
MFA を登録/登録解除するユーザーのプレーンテキストの新しいパスワードを指定します。  
**必須**: はい

***<TOKEN>***  
署名なしトークンファイルが書き込まれるファイルパス。  
**必須**: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。クォーラムユーザーサービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DEREGISTER>***  
MFA パブリックキーが存在する場合、登録を解除します。

***<CHANGE-QUORUM>***  
クォーラムパブリックキーを MFA キーと一緒に変更します。

## 関連トピック
<a name="user-change-mfa-seealso"></a>
+ [HSM ユーザー用 2FA について](login-mfa-token-sign.md)

# CloudHSM CLI でユーザーのパスワードを変更する
<a name="cloudhsm_cli-user-change-password"></a>

CloudHSM CLI の **user change-password** コマンドを使用して、 AWS CloudHSM クラスター内の既存のユーザーのパスワードを変更します。ユーザーの MFA を有効にするには、`user change-mfa` コマンドを使用します。

どのユーザーも自分のパスワードを変更できます。さらに、管理者ロールを持つユーザーは、クラスター内の別のユーザーのパスワードを変更できます。変更するために現在のパスワードを入力する必要はありません。

**注記**  
現在クラスターにログインしているユーザーのパスワードは変更できません。

## ユーザーのタイプ
<a name="change-password-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## 構文
<a name="change-password-syntax"></a>

**注記**  
 ユーザーの多要素認証 (MFA) を有効にするには、**user change-mfa** コマンドを使用します。

```
aws-cloudhsm > help user change-password
Change a user's password

    Usage:
        cloudhsm-cli user change-password [OPTIONS] --username <USERNAME> --role <ROLE> [--password <PASSWORD>]
    
    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

      --username <USERNAME>
          Username of the user that will be modified

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --password <PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
          
      --deregister-mfa <DEREGISTER-MFA>
          Deregister the user's mfa public key, if present
          
      --deregister-quorum <DEREGISTER-QUORUM>
          Deregister the user's quorum public key, if present
 -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="change-password-examples"></a>

次の例は、**user change-password** を使用して、現在のユーザーまたはクラスター内の他のユーザーのパスワードをリセットする方法を示しています。

**Example : パスワードの変更**  
クラスター内のすべてのユーザーは、**user change-password** を使用して自分のパスワードを変更できます。  
次の出力は、Bob が現在 Crypto User (CU) としてログインしていることを示しています。  

```
aws-cloudhsm > user change-password --username bob --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "bob",
    "role": "crypto-user"
  }
}
```

## 引数
<a name="change-password-arguments"></a>

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

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。クォーラムユーザーサービスのクォーラム値が 1 より大きい場合にのみ必要です。

***<DEREGISTER-MFA>***  
MFA パブリックキーが存在する場合、登録を解除します。

***<DEREGISTER-QUORUM>***  
Quorum パブリックキーがある場合は、登録を解除します。

***<PASSWORD>***  
ユーザーのプレーンテキストの新しいパスワードを指定します。「:」の文字は使用できません。  
**必須**: はい

***<ROLE>***  
ユーザーアカウントに付与されるロールを指定します。このパラメータは必須です。HSM のユーザータイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。  
**有効な値**  
+ **Admin**:管理者はユーザーを管理できますが、キーを管理することはできません。
+ **Crypto user**: Crypto User は、管理キーを作成し、暗号化オペレーションでキーを使用できます。

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。  
ユーザーの作成後にユーザー名を変更することはできません。CloudHSM CLI コマンドでは、ロールとパスワードでは大文字と小文字が区別されますが、ユーザー名では区別されません。  
**必須**: はい

## 関連トピック
<a name="change-password-seealso"></a>
+ [user list](cloudhsm_cli-user-list.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)

# CloudHSM CLI のユーザークォーラム変更カテゴリ
<a name="cloudhsm_cli-user-chqm"></a>

CloudHSM CLI では、**user change-quorum** はコマンドグループの親カテゴリであり、これを親カテゴリと組み合わせると、ユーザーのクォーラム変更専用のコマンドが作成されます。

**user change-quorum** は指定されたクォーラム戦略を使用してユーザークォーラム認証を登録するために使用されます。SDK 5.8.0 では、次に示すように、ユーザーが利用できるクォーラム戦略は 1 つだけです。

現在、このカテゴリは次のカテゴリとサブコマンドで構成されています。
+ [token-sign](cloudhsm_cli-user-chqm-token.md)
  + [登録](cloudhsm_cli-user-chqm-token-reg.md)

# CloudHSM CLI の change-quorum token-sign カテゴリ
<a name="cloudhsm_cli-user-chqm-token"></a>

CloudHSM CLI では、**user change-quorum token-sign** はコマンドの親カテゴリで、この親カテゴリと組み合わせるとトークン署名クォーラムオペレーション専用のコマンドが作成されます。

現在、このカテゴリは以下のコマンドで構成されています。
+ [登録](cloudhsm_cli-user-chqm-token-reg.md)

# CloudHSM CLI を使用してユーザーのトークン署名クォーラム戦略を登録する
<a name="cloudhsm_cli-user-chqm-token-reg"></a>

CloudHSM CLI の **user change-quorum token-sign register** コマンドを使用して、管理者ユーザーのトークン署名クォーラム戦略を登録します。

## ユーザーのタイプ
<a name="token-register-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者

## Syntax
<a name="token-register-syntax"></a>

```
aws-cloudhsm > help user change-quorum token-sign register
Register a user for quorum authentication with a public key

Usage: user change-quorum token-sign register --public-key <PUBLIC_KEY> --signed-token <SIGNED_TOKEN>

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
      --public-key <PUBLIC_KEY>      Filepath to public key PEM file
      --signed-token <SIGNED_TOKEN>  Filepath with token signed by user private key
  -h, --help Print help (see a summary with '-h')
```

## 例
<a name="token-register-examples"></a>

**Example**  
このコマンドを実行するには、**register quorum token-sign** を実行するユーザーとしてログインする必要があります。  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
**user change-quorum token-sign register** コマンドは HSM にパブリックキーを登録します。その結果、必要なクォーラム値のしきい値を満たすためにユーザーがクォーラム署名を取得する必要があるクォーラム必須オペレーションのクォーラム承認者としての資格が得られます。  

```
aws-cloudhsm > user change-quorum token-sign register \
    --public-key /home/mypemfile \
    --signed-token /home/mysignedtoken
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
これで、**user list** コマンドを実行して、このユーザーにクォーラムトークン署名が登録されていることを確認できます。  

```
aws-cloudhsm > user list
{
  "error_code": 0,
  "data": {
    "users": [
      {
        "username": "admin",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "quorum": [],
        "cluster-coverage": "full"
      },
      {
        "username": "admin1",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "quorum": [
          {        
            "strategy": "token-sign",
            "status": "enabled"
          }
        ],
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## 引数
<a name="token-register-arguments"></a>

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

***<PUBLIC-KEY>***  
パブリックキー PEM ファイルへのファイルパス。  
**必須**: はい

***<SIGNED-TOKEN>***  
ユーザーのプライベートキーで署名されたトークンを含むファイルパス。  
**必須**: はい

## 関連トピック
<a name="token-register-seealso"></a>
+ [CloudHSM CLI を使用してクォーラム認証を管理する](quorum-auth-chsm-cli.md)
+ [管理者用クォーラム認証を使用する: 初回セットアップ](quorum-auth-chsm-cli-first-time.md)
+ [管理者のクォーラム最小値を変更する](quorum-auth-chsm-cli-min-value.md)
+ [クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)

# CloudHSM CLI を使用して AWS CloudHSM ユーザーを作成する
<a name="cloudhsm_cli-user-create"></a>

CloudHSM CLI の **user create** コマンドは、 AWS CloudHSM クラスターにユーザーを作成します。このコマンドを実行できるのは、管理者ロールを持つユーザーアカウントのみです。

## ユーザーのタイプ
<a name="user-create-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 管理者

## 要件
<a name="user-create-requirements"></a>

このコマンドを実行するには、管理者ユーザーとしてログインする必要があります

## Syntax
<a name="user-create-syntax"></a>

```
aws-cloudhsm > help user create
Create a new user

Usage: cloudhsm-cli user create [OPTIONS] --username <USERNAME> --role <ROLE> [--password <PASSWORD>]

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

      --username <USERNAME>
          Username to access the HSM cluster

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --password <PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="user-create-examples"></a>

以下の例では、**user create** を使用して HSM に新しいユーザーを作成する方法を示します。

**Example : Crypto User を作成する**  
この例では、 暗号化ユーザーロールを使用して AWS CloudHSM クラスターに アカウントを作成します。  

```
aws-cloudhsm > user create --username alice --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## 引数
<a name="user-create-arguments"></a>

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

*<USERNAME>*  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。  
必須: はい

*<ROLE>*  
このユーザーに割り当てられるロールを指定します。このパラメータは必須です。有効な値は **admin**、**crypto-user** です。  
ユーザーのロールを取得するには、**user list** コマンドを使用します。HSM のユーザー タイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。

*<PASSWORD>*  
HSM にログインしているユーザーのパスワードを指定します。「:」の文字は使用できません。  
必須: はい

*<APPROVAL>*  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。クォーラムユーザーサービスのクォーラム値が 1 より大きい場合にのみ必要です。

## 関連トピック
<a name="user-create-seealso"></a>
+ [user list](cloudhsm_cli-user-list.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)

# CloudHSM CLI で AWS CloudHSM ユーザーを削除する
<a name="cloudhsm_cli-user-delete"></a>

CloudHSM CLI の **user delete** コマンドは、 AWS CloudHSM クラスターからユーザーを削除します。このコマンドを実行できるのは、管理者ロールを持つユーザーアカウントのみです。現在 HSM にログインしているユーザーを削除することはできません。

## ユーザーのタイプ
<a name="user-delete-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 管理者

## 要件
<a name="user-delete-requirements"></a>
+ キーを所有しているユーザーアカウントを削除することはできません。
+ このコマンドを実行するには、ユーザーアカウントに管理者ロールが必要です。

## 構文
<a name="user-delete-syntax"></a>

このコマンドには名前付きパラメータがないため、引数は図表で指定された順序で入力する必要があります。

```
aws-cloudhsm > help user delete
Delete a user

Usage: user delete [OPTIONS] --username <USERNAME> --role <ROLE>

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

      --username <USERNAME>
          Username to access the HSM cluster

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
```

## 例
<a name="user-delete-examples"></a>

```
aws-cloudhsm > user delete --username alice --role crypto-user
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## 引数
<a name="user-delete-arguments"></a>

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

***<USERNAME>***  
ユーザーのわかりやすい名前を指定します。最大長は 31 文字です。許可されている唯一の特殊文字はアンダースコア (\$1) です。このコマンドではユーザー名の大文字と小文字は区別されません。ユーザー名は常に小文字で表示されます。  
必須: はい

***<ROLE>***  
このユーザーに割り当てられるロールを指定します。このパラメータは必須です。有効な値は **admin**、**crypto-user** です。  
ユーザーのロールを取得するには、**user list** コマンドを使用します。HSM のユーザータイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。  
必須: はい

***<APPROVAL>***  
オペレーションを承認する署名付きクォーラムトークンファイルへのファイルパスを指定します。クォーラムユーザーサービスのクォーラム値が 1 より大きい場合にのみ必要です。  
必須: はい

## 関連トピック
<a name="user-delete-seealso"></a>
+ [user list](cloudhsm_cli-user-list.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)

# CloudHSM CLI を使用するすべての AWS CloudHSM ユーザーを一覧表示する
<a name="cloudhsm_cli-user-list"></a>

CloudHSM CLI の **user list** コマンドは、 AWS CloudHSM クラスターに存在するユーザーアカウントを一覧表示します。このコマンドは、CloudHSM CLI にログインしていなくても実行できます。

**注記**  
HSMs を追加または削除する場合は、 AWS CloudHSM クライアントとコマンドラインツールが使用する設定ファイルを更新します。そうしないと、クラスター内のすべての HSM で変更が有効にならない場合があります。

## ユーザーのタイプ
<a name="user-list-userType"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ すべてのユーザー。このコマンドは、ログインしていなくても実行できます。

## Syntax
<a name="chsm-cli-user-list-syntax"></a>

```
aws-cloudhsm > help user list
List the users in your cluster

USAGE:
    user list

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
  -h, --help                     Print help
```

## 例
<a name="chsm-cli-user-list-examples"></a>

このコマンドは、CloudHSM クラスターに存在するユーザーを一覧表示します。

```
aws-cloudhsm > user list
{
  "error_code": 0,
  "data": {
    "users": [
      {
        "username": "admin",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "cluster-coverage": "full"
      },
      {
        "username": "test_user",
        "role": "admin",
        "locked": "false",
        "mfa": [
          {
            "strategy": "token-sign",
            "status": "enabled"
          }
        ],
        "cluster-coverage": "full"
      },
      {
        "username": "app_user",
        "role": "internal(APPLIANCE_USER)",
        "locked": "false",
        "mfa": [],
        "cluster-coverage": "full"
      }
    ]
  }
}
```

この出力が示すユーザー属性は以下のとおりです。
+ **Username**: ユーザー定義のわかりやすいユーザー名を表示します。ユーザー名は常に小文字で表示されます。
+ **Role**: HSM でユーザーが実行できるオペレーションを決定します。
+ **Locked**: このユーザーアカウントがロックアウトされているかどうかを示します。
+ **MFA**: このユーザーアカウントでサポートされている多要素認証メカニズムを示します。
+ **Cluster coverage**: このユーザーアカウントのクラスター全体での可用性を示します。

## 関連トピック
<a name="chsm-user-list-seealso"></a>
+ key\$1mgmt\$1util で [listUsers](key_mgmt_util-listUsers.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)

# CloudHSM CLI でユーザーをレプリケートする
<a name="cloudhsm_cli-user-replicate"></a>

CloudHSM CLI の **user replicate** コマンドを使用して、ユーザーをソース AWS CloudHSM クラスターから宛先 AWS CloudHSM クラスターにレプリケートします。

## ユーザーのタイプ
<a name="chsm-cli-user-replicate-user-type"></a>

このコマンドは、次のタイプのユーザーが実行できます。
+ 管理者 (CO)

## 要件
<a name="cloudhsm_cli-user-replicate-requirements"></a>
+ 送信元クラスターと送信先クラスターはクローンである必要があります。つまり、一方が他方のバックアップから作成されたか、どちらも共通のバックアップから作成されたということです。詳細については「[バックアップからクラスターを作成する](create-cluster-from-backup.md)」を参照してください。
+ このコマンドを実行するには、送信元クラスターと送信先クラスターの両方で、管理者としてログインしている必要があります。
  +  単一コマンドモードでは、コマンドは CLOUDHSM\$1PIN および CLOUDHSM\$1ROLE 環境変数を使用してソースクラスターで認証します。詳細については「[シングルコマンドモード](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command)」を参照してください。送信先クラスターの認証情報を提供するには、DESTINATION\$1CLOUDHSM\$1PIN と DESTINATION\$1CLOUDHSM\$1ROLE の 2 つの追加の環境変数を設定する必要があります。

    ```
    $ export DESTINATION_CLOUDHSM_ROLE=<role>
    ```

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  インタラクティブモードでは、ユーザーは送信元クラスターと送信先クラスターの両方に明示的にログインする必要があります。

## 構文
<a name="chsm-cli-user-replicate-syntax"></a>

```
aws-cloudhsm > help user replicate
Replicate a user from a source to a destination cluster

Usage: user replicate --username <USERNAME> --role <ROLE> --source-cluster-id <SOURCE_CLUSTER_ID> --destination-cluster-id <DESTINATION_CLUSTER_ID>

Options:
      --username <USERNAME>
          Username of the user to replicate

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --source-cluster-id <SOURCE_CLUSTER_ID>
          Source cluster ID

      --destination-cluster-id <DESTINATION_CLUSTER_ID>
          Destination cluster ID

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="chsm-cli-user-replicate-examples"></a>

**Example 例: ユーザーをレプリケートする**  
このコマンドは、送信元のクラスターから送信先クラスター (クローン) にユーザーをレプリケートします。以下の例は、両方のクラスターに管理者としてログインしたときの出力を示しています。  

```
admin-user@cluster-1234abcdefg > user replicate \
      --username example-admin \
      --role admin \
      --source-cluster-id cluster-1234abcdefg \
      --destination-cluster-id cluster-2345bcdefgh
{
  "error_code": 0,
  "data": {
    "user": {
      "username": "example-admin",
      "role": "admin",
      "locked": "false",
      "mfa": [],
      "quorum": [],
      "cluster-coverage": "full"
    },
    "message": "Successfully replicated user"
  }
}
```

## 引数
<a name="user-replicate-arguments"></a>

***<USERNAME>***  
ソースクラスターでレプリケートするユーザーのユーザー名を指定します。  
必須: はい

***<ROLE>***  
このユーザーに割り当てられるロールを指定します。このパラメータは必須です。有効な値は **admin**、**crypto-user** です。  
ユーザーのロールを取得するには、**user list** コマンドを使用します。HSM のユーザータイプの詳細については、「[HSM ユーザーについて](manage-hsm-users.md)」を参照してください。  
必須: はい

***<SOURCE\$1CLUSTER\$1ID>***  
送信元クラスターの ID。  
必須: はい

***<DESTINATION\$1CLUSTER\$1ID>***  
送信先クラスターの ID。  
必須: はい

## 関連トピック
<a name="chsm-user-replicate-seealso"></a>
+ [CloudHSM CLI を使用した複数のクラスターへの接続](cloudhsm_cli-configs-multi-cluster.md)

# CloudHSM CLI のクォーラムカテゴリ
<a name="cloudhsm_cli-qm"></a>

CloudHSM CLIにおいて、**quorum** は、コマンドのグループの親カテゴリであり、これらと **quorum** を組み合わせることで、クォラム認証や、M of N オペレーションに固有のコマンドを作成できます。現在、このカテゴリは独自のコマンドで構成される **token-sign** サブカテゴリで構成されています。詳細については、以下のリンクをクリックしてください。
+ [token-sign](cloudhsm_cli-qm-token.md)

**管理サービス**: クォーラム認証は、ユーザーの作成、ユーザーの削除、ユーザーパスワードの変更、クォーラム値の設定、クォーラム機能と MFA 機能の無効化などの管理者権限を持つサービスに使用されます。

**Crypto User サービス**: クォーラム認証は、特定のキーに関連する Crypt User の特権サービス (キーによる署名、キーの共有/共有解除)、キーのラッピング/ラップ解除、キー属性の設定など) に使用されます。関連付けられたキーのクォーラム値は、そのキーを生成、インポート、またはラップ解除する際に設定されます。クォーラム値は、そのキーが関連付けられているユーザー数 (キーが共有されているユーザーおよびキー所有者を含む) 以下である必要があります。

各サービスタイプはさらに適格なサービス名に分類されます。このサービス名には、実行可能なクォーラムがサポートする特定のサービスオペレーションのセットが含まれます。


****  

| サービス名 | サービスタイプ | サービスオペレーション | 
| --- | --- | --- | 
| ユーザー | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| quorum | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| cluster1 | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| キーの管理 | Crypto User |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| キーの用途 | Crypto User |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 

[1] クラスターサービスは hsm2m.medium でのみ利用できます

## 関連トピック
<a name="cloudhsm_cli-qm-seealso"></a>
+ [CloudHSM CLI を使用して AWS CloudHSM 管理者のクォーラム認証を設定する](quorum-auth-chsm-cli-first-time.md)
+ [CloudHSM CLI を使用したクォーラム認証の管理 (M of N アクセスコントロール)](quorum-auth-chsm-cli.md)

# CloudHSM CLI の quorum token-sign カテゴリ
<a name="cloudhsm_cli-qm-token"></a>

CloudHSM CLI において、**quorum token-sign** はコマンド グループのカテゴリであり、**quorum token-sign** と組み合わせると、クォーラム認証や M of N オペレーションに固有のコマンドを作成できます。

現在、このカテゴリは次のコマンドで構成されています。
+ [削除](cloudhsm_cli-qm-token-del.md)
+ [生成](cloudhsm_cli-qm-token-gen.md)
+ [リスト](cloudhsm_cli-qm-token-list.md)
+ [list-quorum-values](cloudhsm_cli-qm-token-list-qm.md)
+ [set-quorum-value](cloudhsm_cli-qm-token-set-qm.md)

# CloudHSM CLI を使用してクォーラムトークンを削除する
<a name="cloudhsm_cli-qm-token-del"></a>

CloudHSM CLI の **quorum token-sign delete** のコマンドを使用して、クォーラム承認サービスの 1 つ以上のトークンを削除します。

## ユーザーのタイプ
<a name="quorum-token-delete-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者

## Syntax
<a name="quorum-token-delete-syntax"></a>

```
aws-cloudhsm > help quorum token-sign delete 
Delete one or more Quorum Tokens

Usage: quorum token-sign delete --scope <SCOPE>

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

      --scope <SCOPE>
          Scope of which token(s) will be deleted

          Possible values:
          - user: Deletes all token(s) of currently logged in user
          - all:  Deletes all token(s) on the HSM
  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="quorum-token-delete-examples"></a>

次の例は、CloudHSM CLI の **quorum token-sign delete** コマンドを使用して、クォーラム認定サービスの 1 つ以上のトークンを削除する方法を示しています。

**Example : クォーラム認定サービスの 1 つ以上のトークンを削除します**  

```
aws-cloudhsm > quorum token-sign delete --scope all
{
  "error_code": 0,
  "data": "Deletion of quorum token(s) successful"
}
```

## 引数
<a name="quorum-token-delete-arguments"></a>

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

***<SCOPE>***  
 AWS CloudHSM クラスター内でトークン (複数可) が削除されるスコープ。  
**有効な値**  
+ **ユーザー**: ログインしているユーザーが所有するトークンのみを削除する場合に使用します。
+ **すべて**: AWS CloudHSM クラスター内のすべてのトークンを削除するために使用します。

## 関連トピック
<a name="quorum-token-delete-seealso"></a>
+ [user list](cloudhsm_cli-user-list.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)

# CloudHSM CLI を使用してクォーラムトークンを生成する
<a name="cloudhsm_cli-qm-token-gen"></a>

CloudHSM CLI の **quorum token-sign generate** コマンドを使用して、クォーラム承認サービスのトークンを生成します。

サービスユーザーとクォーラムの HSM クラスターでは、サービスごとに 1 ユーザーにつき 1 つのアクティブトークンを取得することには制限があります。この制限は、キーサービスに関連するトークンには適用されません。

**注記**  
管理者と Crypto User のみが、特定のサービストークンを生成できます。サービスのタイプと名前について詳しくは、[クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)を参照してください。

**管理サービス**: クォーラム認証は、ユーザーの作成、ユーザーの削除、ユーザーパスワードの変更、クォーラム値の設定、クォーラム機能と MFA 機能の無効化などの管理者権限を持つサービスに使用されます。

**Crypto User サービス**: クォーラム認証は、特定のキーに関連する Crypt User の特権サービス (キーによる署名、キーの共有/共有解除)、キーのラッピング/ラップ解除、キー属性の設定など) に使用されます。関連付けられたキーのクォーラム値は、そのキーを生成、インポート、またはラップ解除する際に設定されます。クォーラム値は、そのキーが関連付けられているユーザー数 (キーが共有されているユーザーおよびキー所有者を含む) 以下である必要があります。

各サービスタイプはさらに適格なサービス名に分類されます。このサービス名には、実行可能なクォーラムがサポートする特定のサービスオペレーションのセットが含まれます。


****  

| サービス名 | サービスタイプ | サービスオペレーション | 
| --- | --- | --- | 
| ユーザー | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| quorum | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| cluster1 | 管理者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| キーの管理 | Crypto User |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| キーの用途 | Crypto User |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 

[1] クラスターサービスは hsm2m.medium でのみ利用できます

## ユーザーのタイプ
<a name="quorum-token-generate-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## Syntax
<a name="quorum-token-generate-syntax"></a>

```
aws-cloudhsm > help quorum token-sign generate
Generate a token

Usage: quorum token-sign generate --service <SERVICE> --token <TOKEN>

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

      --service <SERVICE>
          Service the token will be used for

          Possible values:
          - user:
            User management service is used for executing quorum authenticated user management operations
          - quorum:
            Quorum management service is used for setting quorum values for any quorum service
          - cluster: 
            Cluster management service is used for executing quorum for cluster wide configuration managements like mtls enforcement, mtls registration and mtls deregistration
          - registration:
            Registration service is used for registering a public key for quorum authentication
          - key-usage:
            Key usage service is used for executing quorum authenticated key usage operations
          - key-management:
            Key management service is used for executing quorum authenticated key management operations

      --token <TOKEN>
          Filepath where the unsigned token file will be written
  -h, --help                     Print help
```

## 例
<a name="quorum-token-generate-examples"></a>

このコマンドは、クラスター内の HSM ごとに 1 つの未署名トークンを `token` で指定されたファイルに書き込みます。

**Example : クラスターの HSM ごとに 1 つの署名なしトークンを書き込みます**  

```
aws-cloudhsm > quorum token-sign generate --service user --token /home/tfile
{
  "error_code": 0,
  "data": {
    "filepath": "/home/tfile"
  }
}
```

## 引数
<a name="quorum-token-generate-arguments"></a>

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

***<SERVICE>***  
トークンを生成するには、クォーラム承認サービスを指定します。このパラメータは必須です。  
**有効な値**  
+ **ユーザー**:クォーラム承認ユーザー管理オペレーションの実行に使用されるユーザー管理サービス。
+ **クォーラム**: すべてのクォーラム承認サービスのクォーラム承認クォーラム値を設定するために使用されるクォーラム管理サービス。
+ **クラスター**: mtls 適用、mtls 登録、mtls 登録解除などのクラスター全体の構成管理のクォーラムを実行するために使用されるクラスター管理サービス。
+ **登録**:クォーラム認可用のパブリックキーの登録に使用する署名なしトークンを生成します。
+ **キーの用途**: クォーラム認証されたキー使用オペレーションを実行するために使用される、署名なしトークンを生成します。
+ **キー管理**: クォーラム認可されたキー管理オペレーションを実行するために使用される、署名なしトークンを生成します。
**必須**: はい

***<TOKEN>***  
署名されていないトークンファイルが書き込まれるファイルパス。  
**必須**: はい

## 関連トピック
<a name="quorum-token-generate-seealso"></a>
+ [クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)

# CloudHSM CLI でクォーラムトークンを一覧表示する
<a name="cloudhsm_cli-qm-token-list"></a>

CloudHSM CLI の **quorum token-sign list** コマンドを使用して、 AWS CloudHSM クラスターに存在するすべてのトークン署名クォーラムトークンを一覧表示します。これには、他のユーザーによって生成されたトークンが含まれます。ただし、トークンはユーザーに紐づけられているため、他のユーザーのトークンが表示されることはありますが、使用できるのは現在ログインしているユーザーに関連付けられているトークンのみです。

サービスのタイプと名前について詳しくは、「[クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)」を参照してください。一覧表示されたトークンに関して表示される内容の詳細については、`key-management` および `key-usage` サービスに関連付けられたトークンについては「[CloudHSM CLI AWS CloudHSM を使用するためのクォーラム認証を有効にしたキー管理と使用状況](key-quorum-auth-chsm-cli-crypto-user.md)」を、`user`、`quorum` または `cluster` サービスに関連付けられたトークンについては「[CloudHSM CLI AWS CloudHSM の使用に対してクォーラム認証を有効にしたユーザー管理](quorum-auth-chsm-cli-admin.md)」をそれぞれ参照してください。

## ユーザーのタイプ
<a name="quorum-token-list-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者
+ Crypto User (CU)

## Syntax
<a name="quorum-token-list-syntax"></a>

```
aws-cloudhsm > help quorum token-sign list
List the token-sign tokens in your cluster

Usage: quorum token-sign list

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
  -h, --help                     Print help
```

## 例
<a name="quorum-token-list-examples"></a>

このコマンドは、 AWS CloudHSM クラスターに存在するすべてのトークン署名トークンを一覧表示します。これには、他のユーザーによって生成されたトークンが含まれます。ただし、トークンはユーザーに紐づけられているため、他のユーザーのトークンが表示されることはありますが、使用できるのは現在ログインしているユーザーに関連付けられているトークンのみです。

**Example**  

```
aws-cloudhsm > quorum token-sign list
{
  "error_code": 0,
  "data": {
    "tokens": [
      {
        "username": "admin",
        "service": "quorum",
        "approvals-required": 2,
        "number-of-approvals": 0,
        "token-timeout-seconds": 397,
        "cluster-coverage": "full"
      },
      {
        "username": "admin",
        "service": "user",
        "approvals-required": 2,
        "number-of-approvals": 0,
        "token-timeout-seconds": 588,
        "cluster-coverage": "full"
      },
      {
        "username": "crypto_user1",
        "service": "key-management",
        "key-reference": "0x00000000002c33f7",
        "minimum-token-count": 1
      },
      {
        "username": "crypto_user1",
        "service": "key-usage",
        "key-reference": "0x00000000002c33f7",
        "minimum-token-count": 1
      }
    ]
  }
}
```

## 関連トピック
<a name="quorum-token-list-seealso"></a>
+ [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md)

# CloudHSM CLI でクォーラム値を表示する
<a name="cloudhsm_cli-qm-token-list-qm"></a>

CloudHSM CLI の **quorum token-sign list-quorum-values** コマンドを使用して、 AWS CloudHSM クラスターに設定されたクォーラム値を一覧表示します。

## ユーザーのタイプ
<a name="quorum-token-list-qm-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ すべてのユーザー。このコマンドは、ログインしていなくても実行できます。

## Syntax
<a name="quorum-token-list-qm-syntax"></a>

```
aws-cloudhsm > help quorum token-sign list-quorum-values
List current quorum values

Usage: quorum token-sign list-quorum-values

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
  -h, --help                     Print help
```

## 例
<a name="quorum-token-list-qm-examples"></a>

このコマンドは、各サービスの AWS CloudHSM クラスターに設定されたクォーラム値を一覧表示します。

**Example**  
**hsm1.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 1
  }
}
```
**hsm2m.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 1,
    "cluster": 1
  }
}
```

## 関連トピック
<a name="quorum-token-list-qm-seealso"></a>
+ [クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)
+  [mTLS の設定 (推奨）](getting-started-setup-mtls.md) 

# CloudHSM CLI でクォーラム値を更新する
<a name="cloudhsm_cli-qm-token-set-qm"></a>

CloudHSM CLI の **quorum token-sign set-quorum-value** コマンドを使用して、クォーラム承認サービス用の新しいクォーラム値のトークンを設定します。

## ユーザーのタイプ
<a name="quorum-token-set-qm-user-type"></a>

このコマンドは、次のユーザーが実行できます。
+ 管理者

## Syntax
<a name="quorum-token-set-qm-syntax"></a>

```
aws-cloudhsm > help quorum token-sign set-quorum-value
Set a quorum value

Usage: quorum token-sign set-quorum-value [OPTIONS] --service <SERVICE> --value <VALUE>

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

      --service <SERVICE>
          Service the token will be used for

          Possible values:
          - user:
            User management service is used for executing quorum authenticated user management operations
          - quorum:
            Quorum management service is used for setting quorum values for any quorum service
          - cluster: 
            Cluster management service is used for executing quorum for cluster wide configuration managements like mtls enforcement, mtls registration and mtls deregistration

      --value <VALUE>
          Value to set for service

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## 例
<a name="quorum-token-set-qm-examples"></a>

**Example**  
次の例では、このコマンドは、クラスター内の HSM ごとに 1 つの署名なしトークンを、トークンで指定されたファイルに書き込みます。プロンプトが表示されたら、ファイル内のトークンに署名します。  

```
aws-cloudhsm > quorum token-sign set-quorum-value --service quorum --value 2
{
  "error_code": 0,
  "data": "Set Quorum Value successful"
}
```
その後、**list-quorum-values** コマンドを実行して、クォーラム管理サービスのクォーラム値が設定されていることを確認できます。  
**hsm1.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 2
  }
}
```
**hsm2m.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 2,
    "cluster": 1
  }
}
```

## 引数
<a name="quorum-token-set-qm-arguments"></a>

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

***<APPROVAL>***  
HSM で承認される署名済みトークンファイルのファイルパス。

***<SERVICE>***  
トークンを生成するには、クォーラム承認サービスを指定します。このパラメータは必須です。サービスのタイプと名前について詳しくは、「[クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)」を参照してください。  
**有効な値**  
+ **ユーザー**: ユーザー管理サービス。クォーラム承認ユーザー管理オペレーションの実行に使用されるサービス。
+ **クォーラム**: クォーラム管理サービス。あらゆるクォーラム承認サービスのクォーラム承認クォーラム値を設定するために使用されるサービス。
+ **クラスター**: mtls 適用、mtls 登録、mtls 登録解除などのクラスター全体の構成管理のクォーラムを実行するために使用されるクラスター管理サービス。
+ **登録**: クォーラム認可用のパブリックキーの登録に使用する署名なしトークンを生成します。
**必須**: はい

***<VALUE>***  
設定するクォーラム値を指定します。最大クォーラム値は 8 です。  
**必須**: はい

## 関連トピック
<a name="quorum-token-set-qm-seealso"></a>
+ [quorum token-sign list-quorum-values](cloudhsm_cli-qm-token-list-qm.md)
+ [クォーラム認証をサポートするサービス名とタイプ](quorum-auth-chsm-cli-service-names.md)
+ [mTLS の設定 (推奨）](getting-started-setup-mtls.md)