

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# CloudHSM CLI 命令的參考資料
<a name="cloudhsm_cli-reference"></a>

CloudHSM CLI 可協助管理員管理其 AWS CloudHSM 叢集中的使用者。CloudHSM CLI 可以在兩種模式下執行：互動式模式和單一命令模式。如需快速入門，請參閱 [開始使用 AWS CloudHSM 命令列界面 (CLI)](cloudhsm_cli-getting-started.md)。

若要執行大多數 CloudHSM CLI 命令，您必須啟動 CloudHSM CLI 並登入 HSM。如果您新增或刪除 HSM，請更新 CloudHSM CLI 的組態檔案。否則，您所進行的變更可能無法在叢集中的所有 HSM 上生效。

下列各主題說明 CloudHSM CLI 中的命令。


| 命令 | Description | 使用者類型 | 
| --- | --- | --- | 
| [activate](cloudhsm_cli-cluster-activate.md) | 啟動 CloudHSM 叢集並確認叢集是新的叢集。完成此操作後，方可執行其他操作。 | 未激活的管理員 | 
| [hsm-info](cloudhsm_cli-cluster-hsm-info.md) | 列出叢集中的 HSMs。 | 所有 [1](#cli-ref-1)，包括未經身分驗證的使用者。無需登入。 | 
| [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md) | 使用 EC 私有金鑰和 ECDSA 簽署機制產生簽章。 | 加密使用者 (CU) | 
| [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md) | 使用 Ed25519 私有金鑰和 HashEdDSA 簽署機制產生簽章。 | 加密使用者 | 
| [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md) | 使用 RSA 私有金鑰和 RSA-PKCS 簽署機制產生簽章。 | 加密使用者 | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md) | 使用 RSA 私有金鑰和 RSA-PKCS-PSS 簽署機制產生簽章。 | 加密使用者 | 
| [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md) | 確認檔案已由指定的公有金鑰在 HSM 中簽署。驗證簽章是否使用 ECDSA 簽署機制產生。比較已簽章的檔案與來源檔案，並根據指定的 ecdsa 公有金鑰和簽署機制，判斷兩者是否在密碼編譯上相關。 | 加密使用者 | 
| [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md) | 使用 Ed25519 公有金鑰驗證 HashEdDSA 簽章。 | 加密使用者 | 
| [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md) | 確認檔案已由指定的公有金鑰在 HSM 中簽署。驗證簽章是否使用 RSA-PKCS 簽署機制產生。比較已簽章的檔案與來源檔案，並根據指定的 rsa 公有金鑰和簽署機制，判斷兩者是否在密碼編譯上相關。 | 加密使用者 | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md) | 確認檔案已由指定的公有金鑰在 HSM 中簽署。驗證簽章是否使用 RSA-PKCS-PSS 簽署機制產生。比較已簽章的檔案與來源檔案，並根據指定的 rsa 公有金鑰和簽署機制，判斷兩者是否在密碼編譯上相關。 | 加密使用者 | 
| [刪除金錀](cloudhsm_cli-key-delete.md) | 從 AWS CloudHSM 叢集刪除金鑰。 | 加密使用者 | 
| [產生金錀的檔案](cloudhsm_cli-key-generate-file.md) | 在 AWS CloudHSM 叢集中產生金鑰檔案。 | 加密使用者 | 
| [產生非對稱 RSA 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) | 在您的 AWS CloudHSM 叢集中產生非對稱 RSA 金鑰對。 | 加密使用者 | 
| [產生非對稱 EC 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) | 在 AWS CloudHSM 叢集中產生非對稱橢圓曲線 (EC) 金鑰對。 | 加密使用者 | 
| [產生對稱 AES 金錀](cloudhsm_cli-key-generate-symmetric-aes.md) | 在 AWS CloudHSM 叢集中產生對稱 AES 金鑰。 | 加密使用者 | 
| [產生對稱通用私密金錀](cloudhsm_cli-key-generate-symmetric-generic-secret.md) | 在 AWS CloudHSM 叢集中產生對稱的一般私密金鑰。 | 加密使用者 | 
| [金鑰匯入 pem](cloudhsm_cli-key-import-pem.md) | 將 PEM 格式金鑰匯入 HSM。您可以使用此命令匯入在 HSM 之外產生的公有金鑰。 | 加密使用者 | 
| [列出金錀](cloudhsm_cli-key-list.md) | 尋找 AWS CloudHSM 叢集中目前使用者的所有金鑰。 | 加密使用者 | 
| [金鑰複寫](cloudhsm_cli-key-replicate.md) | 將金鑰從來源叢集複寫到複製的目的地叢集。 | 加密使用者 | 
| [設定金錀屬性](cloudhsm_cli-key-set-attribute.md) | 設定 AWS CloudHSM 叢集中金鑰的屬性。 | 加密使用者可以執行此命令，管理員可以設定受信任的屬性。 | 
| [共用金錀](cloudhsm_cli-key-share.md) | 與 AWS CloudHSM 叢集中的其他 CUs共用金鑰。 | 加密使用者 | 
| [取消共用金鑰](cloudhsm_cli-key-unshare.md) | 取消與 AWS CloudHSM 叢集中其他 CUs共用金鑰。 | 加密使用者 | 
| [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md) | 使用 AES 包裝金鑰和 AES-GCM 取消包裝機制，將承載金鑰取消包裝到叢集中。 | 加密使用者 | 
| [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md) | 使用 AES 包裝金鑰和 AES-NO-PAD 取消包裝機制，將承載金鑰取消包裝到叢集中。 | 加密使用者 | 
| [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md) | 使用 AES 包裝金鑰和 AES-PKCS5-PAD 取消包裝機制來取消包裝承載金鑰。 | 加密使用者 | 
| [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md) | 使用 AES 包裝金鑰和 AES-ZERO-PAD 取消包裝機制，將承載金鑰取消包裝至叢集。 | 加密使用者 | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md) | 使用 AES 包裝金鑰和 CLOUDHSM-AES-GCM 取消包裝機制，將承載金鑰取消包裝至叢集。 | 加密使用者 | 
| [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md) | 使用 RSA 私有金鑰和 RSA-AES 取消包裝機制來取消包裝承載金鑰。 | 加密使用者 | 
| [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md) | 使用 RSA 私有金鑰和 RSA-OAEP 取消包裝機制來取消包裝承載金鑰。 | 加密使用者 | 
| [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md) | 使用 RSA 私有金鑰和 RSA-PKCS 取消包裝機制來取消包裝承載金鑰。 | 加密使用者 | 
| [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md) | 使用 HSM 上的 AES 金鑰和 AES-GCM 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md) | 使用 HSM 上的 AES 金鑰和 AES-NO-PAD 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md) | 使用 HSM 上的 AES 金鑰和 AES-PKCS5-PAD 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md) | 使用 HSM 上的 AES 金鑰和 AES-ZERO-PAD 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md) | 使用 HSM 上的 AES 金鑰和 CLOUDHSM-AES-GCM 包裝機制來包裝承載金鑰。 | CUs | 
| [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md) | 使用 HSM 上的 RSA 公有金鑰和 RSA-AES 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md) | 使用 HSM 上的 RSA 公有金鑰和 RSA-OAEP 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [ 使用 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`。 只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。 若要使用 **key wrap rsa-pkcs**命令，您必須先在 AWS CloudHSM 叢集中擁有 RSA 金鑰。您可以使用 [CloudHSM CLI 中的 generate-asymmetric-pair 類別](cloudhsm_cli-key-generate-asymmetric-pair.md)命令和設定為 的 `wrap` 屬性來產生 RSA 金鑰對`true`。  使用者類型  下列類型的使用者可以執行此命令。   加密使用者 (CU)     要求    若要執行此命令，必須以 CU 的身分登入。     語法  

```
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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是 

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否 

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是 

***<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 包裝機制來包裝承載金鑰。 | 加密使用者 | 
| [登入](cloudhsm_cli-login.md) | 登入您的 AWS CloudHSM 叢集。 | 管理員、加密使用者 (CU) 和設備使用者 (AU) | 
| [登出](cloudhsm_cli-logout.md) | 登出您的 AWS CloudHSM 叢集。 | 管理員、加密使用者和設備使用者 (AU) | 
| [刪除规定人數字符簽署](cloudhsm_cli-qm-token-del.md) | 刪除規定人數授權服務的一個或多個權杖。 | 管理員 | 
| [產生规定人數字符簽署](cloudhsm_cli-qm-token-gen.md) | 產生規定人數授權服務的權杖。 | 管理員 | 
| [列出規定人數字符簽署](cloudhsm_cli-qm-token-list.md) | 列出 CloudHSM 叢集中所有權杖簽署的規定人數權杖。 | 所有 [1](#cli-ref-1)，包括未經身分驗證的使用者。無需登入。 | 
| [規定人數字符簽署 列出規定人數值](cloudhsm_cli-qm-token-list-qm.md) | 列出 CloudHSM 叢集中規定人數值集。 | 所有 [1](#cli-ref-1)，包括未經身分驗證的使用者。無需登入。 | 
| [規定人數字符簽署 設定規定人數值](cloudhsm_cli-qm-token-set-qm.md) | 為規定人數授權服務設定新的規定人數值。 | 管理員 | 
| [變更使用者 MFA](cloudhsm_cli-user-change-mfa.md) | 變更使用者的多重要素驗證 (MFA) 策略。 | 管理員、加密使用者 | 
| [變更使用者密碼](cloudhsm_cli-user-change-password.md) | 變更 HSM 上使用者的密碼。任何使用者都可以變更自己的密碼。加密使用者可以變更任何人的密碼。 | 管理員、加密使用者 | 
| [建立使用者](cloudhsm_cli-user-create.md) | 在 AWS CloudHSM 叢集中建立使用者。 | 管理員 | 
| [刪除使用者](cloudhsm_cli-user-delete.md) | 刪除 AWS CloudHSM 叢集中的使用者。 | 管理員 | 
| [使用者清單](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**
+ [activate](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**命令來[啟用新的叢集](activate-cluster.md) AWS CloudHSM。必須先執行此命令，叢集才可以用於執行密碼編譯操作。

## 使用者類型
<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>
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [刪除使用者](cloudhsm_cli-user-delete.md)
+ [變更使用者密碼](cloudhsm_cli-user-change-password.md)

# 使用 HSMsCLI 列出 HSM CloudHSM
<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>

下列類型的使用者可以執行此命令。
+ 所有使用者。您無須登入即可執行此命令。

## 語法
<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]"
      }
    ]
  }
}
```

輸出具有下列屬性：
+ **廠商**：HSM 的廠商名稱。
+ **型號**：HSM 的型號。
+ **序號**：HSM 的序號。其可能會因更換而改變。
+ **Hardware-version-major**：主要硬體版本。
+ **Hardware-version-minor**：次要硬體版本。
+ **Firmware-version-major**：主要韌體版本。
+ **Firmware-version-minor**：次要韌體版本。
+ **Firmware-build-number**：韌體建置編號。
+ **Firmware-id**：韌體 ID，其中包括主要和次要版本以及建置編號。
+ **FIPS-state**：叢集和其中 HSMs 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-forcement](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-forcement](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**命令，取消註冊用戶端與 之間交互 TLS 的信任錨點 AWS CloudHSM。

## 使用者類型
<a name="cluster-mtls-deregister-trust-anchor-userType"></a>

下列使用者可以執行此命令。
+ 管理員

## 要求
<a name="cluster-mtls-deregister-trust-anchor-requirements"></a>
+ 若要執行此命令，您必須以管理員使用者身分登入。

## 語法
<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>* **  
十六進位或十進位憑證參考。  
 **必要**：是  
在叢集中取消註冊信任錨點後，使用該信任錨點簽署的用戶端憑證的所有現有 mTLS 連線都會遭到捨棄。

** *<APPROVAL>* **  
指要核准操作的已簽署規定人數權杖檔案的檔案路徑。只有在規定人數叢集服務規定人數值大於 1 時才需要。

## 相關主題
<a name="cluster-mtls-deregister-trust-anchor-seealso"></a>
+  [叢集 mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [叢集 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**命令，以取得用戶端與 之間交互 TLS 用量的強制執行層級 AWS CloudHSM。

## 使用者類型
<a name="cluster-mtls-get-enforcement-userType"></a>

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者 (CU)

## 要求
<a name="cluster-mtls-get-enforcement-requirements"></a>
+ 若要執行此命令，您必須以管理員使用者或加密使用者 (CUs身分登入。

## 語法
<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**  
在下列範例中，此命令會列出 的 mtls 強制執行層級 AWS CloudHSM。  

```
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>
+  [叢集 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**命令，列出可用於用戶端與 之間交互 TLS 的所有信任錨點 AWS CloudHSM。

## 使用者類型
<a name="cluster-mtls-list-trust-anchors-userType"></a>

下列使用者可以執行此命令。
+ 所有使用者。您無須登入即可執行此命令。

## 語法
<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>
+  [叢集 mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [叢集 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**命令，為用戶端和 之間的交互 TLS 註冊信任錨點 AWS CloudHSM。

## 使用者類型
<a name="cluster-mtls-register-trust-anchor-userType"></a>

下列使用者可以執行此命令。
+ 管理員

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

 AWS CloudHSM 接受具有下列金鑰類型的信任錨點：


****  

| 金鑰類型 | Description | 
| --- | --- | 
| EC |  secp256r1 (P-256)、secp384r1 (P-384) 和 secp521r1 (P-521) 曲線。 | 
| RSA |  2048 位元、3072 位元和 4096 位元 RSA 金鑰。 | 

## 語法
<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>
+  [叢集 mtls deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md) 
+  [叢集 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**命令，設定用戶端與 之間交互 TLS 用量的強制執行層級 AWS CloudHSM。

## 使用者類型
<a name="cluster-mtls-set-enforcement-userType"></a>

下列使用者可以執行此命令。
+ 使用者名稱為 admin 的管理員

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

若要執行此命令：
+ 至少有一個信任錨點已成功註冊到 AWS CloudHSM。
+ 使用正確的私有金鑰和用戶端憑證設定 CloudHSM CLI，並在交互 TLS 連線下啟動 CloudHSM CLI。
+ 您必須以使用者名稱為 "admin" 的預設管理員身分登入。任何其他管理員使用者將無法執行此命令。

## 語法
<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**  
在下列範例中，此命令會將 AWS CloudHSM 的 mtls 強制執行層級設定為叢集。set-enforcement 命令只能在交互 TLS 連線中執行，並以使用者名稱為 admin 的管理員使用者身分登入，請參閱[設定 mTLS 強制執行 AWS CloudHSM](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 設定的關卡。  
 **有效值**   
+  **叢集**：在用戶端和叢集 AWS CloudHSM 中強制使用交互 TLS。
+  **無**：請勿在用戶端和叢集 AWS CloudHSM 中強制使用交互 TLS。
 **必要**：是  
在叢集中強制執行 mTLS 用量之後，所有現有的非 mTLS 連線都會遭到捨棄，而且您只能使用 mTLS 憑證連線到叢集。

** *<APPROVAL>* **  
指要核准操作的已簽署規定人數權杖檔案的檔案路徑。只有在規定人數叢集服務規定人數值大於 1 時才需要。

## 相關主題
<a name="cluster-mtls-set-enforcement-seealso"></a>
+  [叢集 mtls get-forcement](cloudhsm_cli-cluster-mtls-get-enforcement.md) 
+  [設定 mTLS （建議）](getting-started-setup-mtls.md) 

# CloudHSM CLI 中的加密類別
<a name="cloudhsm_cli-crypto"></a>

在 CloudHSM CLI 中， **crypto** 是一組命令的父類別，當 與父類別結合時，會建立密碼編譯操作專用的命令。目前，此類別由以下命令組成：
+ [sign](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 中擁有私有金鑰。您可以使用下列命令產生私有金鑰：
+ [產生非對稱 EC 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [產生非對稱 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` 屬性設定為 的 [使用 CloudHSM CLI 產生非對稱 EC 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)命令來產生 EC 私有金鑰`true`。

產生的 ECDSA 簽章會以 格式產生`r||s`，其中 r 和 s 元件會串連為原始二進位資料，並以 base64 編碼格式傳回。

**注意**  
可以使用[CloudHSM CLI 中的加密驗證類別](cloudhsm_cli-crypto-verify.md)子命令 AWS CloudHSM 在 中驗證簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-sign-ecdsa-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-sign-ecdsa-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>

這些範例示範如何使用 ECDSA 簽署機制和`SHA256`雜湊函數**crypto sign ecdsa**產生簽章。此命令在 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>

**重要**  
僅在非 FIPS 模式下的 hsm2m.medium 執行個體上支援 HashEdDSA 簽署操作。

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

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-sign-ed25519ph-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。
+ 僅在非 FIPS 模式下的 hsm2m.medium 執行個體上支援 HashEdDSA 簽署操作。

## 語法
<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>

這些範例示範如何使用 Ed25519ph 簽署機制和`sha512`雜湊函數**crypto sign ed25519ph**來產生簽章。此命令在 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` 屬性設定為 的 [使用 CloudHSM CLI 產生非對稱 RSA 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)命令來產生 RSA 私有金鑰`true`。

**注意**  
可以使用[CloudHSM CLI 中的加密驗證類別](cloudhsm_cli-crypto-verify.md)子命令 AWS CloudHSM 在 中驗證簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>

這些範例示範如何使用 RSA-PKCS 簽署機制和`SHA256`雜湊函數**crypto sign rsa-pkcs**產生簽章。此命令在 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，資料必須以 DER 編碼格式傳遞[，如 RFC 8017 第 9.2](https://www.rfc-editor.org/rfc/rfc8017#section-9.2) 節所述  
有效值：  
+ 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` 屬性設定為 的 [使用 CloudHSM CLI 產生非對稱 RSA 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)命令來產生 RSA 私有金鑰`true`。

**注意**  
可以使用[CloudHSM CLI 中的加密驗證類別](cloudhsm_cli-crypto-verify.md)子命令 AWS CloudHSM 在 中驗證簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>

這些範例示範如何使用`RSA-PKCS-PSS`簽署機制和`SHA256`雜湊函數**crypto sign rsa-pkcs-pss**來產生簽章。此命令在 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>***  
指定 salt 長度。  
必要：是

***<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 驗證 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)

**crypto verify** 命令會比較已簽章的檔案與來源檔案，並根據指定的公有金鑰和簽署機制，分析它們在密碼編譯上是否相關。

**注意**  
檔案可以使用 AWS CloudHSM [CloudHSM CLI 中的加密簽署類別](cloudhsm_cli-crypto-sign.md)操作登入。

# 在 CloudHSM CLI 中驗證使用 ECDSA 機制簽署的簽章
<a name="cloudhsm_cli-crypto-verify-ecdsa"></a>

在 CloudHSM CLI 中使用 **crypto verify ecdsa**命令來完成下列操作：
+ 確認檔案已由指定的公有金鑰在 HSM 中簽署。
+ 驗證簽章是否使用 ECDSA 簽署機制產生。
+ 比較已簽章的檔案與來源檔案，並根據指定的 ecdsa 公有金鑰和簽署機制，判斷兩者是否在密碼編譯上相關。
+  ECDSA 驗證函數預期簽章的格式為 `r||s`，其中 r 和 s 元件會串連為原始二進位資料。

若要使用 **crypto verify ecdsa**命令，您必須先在 AWS CloudHSM 叢集中擁有 EC 公有金鑰。您可以使用 `verify` 屬性設定為 的 [使用 CloudHSM CLI 匯入 PEM 格式金鑰](cloudhsm_cli-key-import-pem.md)命令匯入 EC 公有金鑰`true`。

**注意**  
您可以使用[CloudHSM CLI 中的加密簽署類別](cloudhsm_cli-crypto-sign.md)子命令在 CloudHSM CLI 中產生簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-verify-ecdsa-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-verify-ecdsa-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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 範例：證明錯誤簽署關係**  
此命令會使用 ECDSA `/home/data`簽署機制產生位於 中的簽章，驗證位於 的資料是否由具有 標籤`ecdsa-public`的公有金鑰簽署`/home/signature`。由於指定的引數不會構成真正的簽署關係，因此 命令會傳回錯誤訊息。  

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

**重要**  
僅在非 FIPS 模式下的 hsm2m.medium 執行個體上支援 HashEdDSA 簽章驗證操作。

在 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-crypto-sign.md)子命令在 CloudHSM CLI 中產生簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-verify-ed25519ph-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-verify-ed25519ph-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。
+ 僅在非 FIPS 模式下的 hsm2m.medium 執行個體上支援 HashEdDSA 簽章驗證操作。

## 語法
<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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`會使用 RSAPKCS 簽署機制來產生位於 中的簽章，驗證無效資料是否由具有 標籤的公有金鑰簽署`/home/signature`。由於指定的引數不會構成真正的簽署關係，因此 命令會傳回錯誤訊息。  

```
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 公有金鑰。您可以使用金鑰匯入 pem 命令 ADD UNWRAP LINK HERE) 匯入 RSA 公有金鑰，並將 `verify` 屬性設定為 `true`。

**注意**  
您可以使用 CloudHSM CLI 搭配 [CloudHSM CLI 中的加密簽署類別](cloudhsm_cli-crypto-sign.md)子命令來產生簽章。

## 使用者類型
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`會使用 RSAPKCSPSS 簽署機制來產生位於 中的簽章，驗證無效資料是否由具有標籤的公有金鑰簽署`/home/signature`。由於指定的引數不會構成真正的簽署關係，因此命令會傳回錯誤訊息。  

```
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** 是一組命令的父類別，當 與父類別結合時，會建立專屬於 金鑰的命令。目前，此類別由以下命令組成：
+ [delete](cloudhsm_cli-key-delete.md)
+ [產生的檔案](cloudhsm_cli-key-generate-file.md)
+ [產生非對稱金鑰對](cloudhsm_cli-key-generate-asymmetric-pair.md)
  + [產生非對稱 RSA 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)
  + [產生非對稱 EC 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [產生對稱金錀](cloudhsm_cli-key-generate-symmetric.md)
  + [產生對稱 AES 金錀](cloudhsm_cli-key-generate-symmetric-aes.md)
  + [產生對稱通用私密金錀](cloudhsm_cli-key-generate-symmetric-generic-secret.md)
+ [匯入 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)
+ [取消共用](cloudhsm_cli-key-unshare.md)
+ [取消包裝](cloudhsm_cli-key-unwrap.md)
+ [包裝](cloudhsm_cli-key-wrap.md)

# 使用 CloudHSM CLI 刪除金鑰
<a name="cloudhsm_cli-key-delete"></a>

使用 CloudHSM CLI 中的 **key delete**命令，從 AWS CloudHSM 叢集刪除金鑰。您一次只能刪除一個金鑰。刪除金鑰對中的一個金鑰，對金鑰對中的另一個金鑰沒有影響。

只有建立金鑰並因此擁有金鑰的 CU 才能刪除金鑰。共用金鑰但卻未擁有金鑰的使用者可以在密碼編譯操作中使用金鑰，但不能刪除它。

## 使用者類型
<a name="key-delete-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="key-delete-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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)

***<篩選條件>***  
索引鍵參考 （例如 `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 中的私有金鑰，可用來從 Web 伺服器建立 SSL/TLS 卸載 AWS CloudHSM。如需詳細資訊，請參閱 [SSL/TLS 卸載](ssl-offload.md)。

## 使用者類型
<a name="key-generate-file-user-type"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

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

若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>

此範例示範如何使用 在 AWS CloudHSM 叢集中**key generate-file**產生金鑰檔案。

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

***<篩選條件>***  
索引鍵參考 （例如 `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>
+ 您只能在 Windows 平台上產生 KSP 金鑰參考。
+ 您必須以加密使用者 (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 中的產生對稱類別](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** 是一組命令的父類別，當 與父類別結合時，會建立產生非對稱金鑰對的命令。目前，此類別由以下命令組成：
+ [產生非對稱 EC 金鑰對](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [產生非對稱 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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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 金鑰對**  
使用規定人數控制產生金鑰時，該金鑰必須與等於最大金鑰規定人數值的最小使用者數目相關聯。關聯的使用者包括金鑰擁有者和與金鑰共用的加密使用者。若要判斷要共用金鑰的最小使用者數量，請取得金鑰使用量值與金鑰管理量值之間的最大規定人數值，並減去 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` (例如，`verify=true`) 的形式為產生的 EC 公有金鑰設定  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<PUBLIC\$1LABEL>***  
指使用者定義的公有金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
指一個空格分隔的金鑰屬性清單，以 `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (例如，`sign=true`) 的形式為產生的 EC 私有金鑰設定  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<PRIVATE\$1LABEL>***  
指使用者定義的私有金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<SESSION>***  
建立只在目前工作階段中存在的金鑰。工作階段結束後，金鑰無法復原。  
當您僅短暫需要金鑰 (例如，加密後快速解密另一個金鑰的包裝金鑰) 時，請使用此參數。請勿使用工作階段金鑰來加密工作階段結束後可能需要解密的資料。  
根據預設，產生的金鑰是持久性 (權杖) 金鑰。在 <SESSION> 傳遞會變更此情況，確保使用此參數生成的金鑰是工作階段 (臨時) 金鑰。  
必要：否

***<SHARE\$1CRYPTO\$1USERS>***  
指定要與 共用 EC 私有金鑰的加密使用者名稱的空格分隔清單  
必要：否

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

下列類型的使用者可以執行此命令。
+ 加密使用者 (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 金鑰對**  
使用規定人數控制產生金鑰時，該金鑰必須與等於最大金鑰規定人數值的最小使用者數目相關聯。關聯的使用者包括金鑰擁有者和與金鑰共用的加密使用者。若要判斷要共用金鑰的最小使用者數量，請取得金鑰使用量值與金鑰管理量值之間的最大規定人數值，並減去 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>***  
 指模數的長度 (以位元為單位)。最小值為 2048。  
必要：是

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
指一個空格分隔的金鑰屬性清單，以 `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (例如，`sign=true`) 的形式為產生的 RSA 私有金鑰設定  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<PRIVATE\$1LABEL>***  
 指使用者定義的私有金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<PUBLIC\$1EXPONENT>***  
指公有指數。值必須為大於或等於 65537 的奇數。  
必要：是

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
指一個空格分隔的金鑰屬性清單，以 `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (例如，`verify=true`) 的形式為產生的 RSA 公有金鑰設定  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<PUBLIC\$1LABEL>***  
 指使用者定義的公有金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<SESSION>***  
建立只在目前工作階段中存在的金鑰。工作階段結束後，金鑰無法復原。  
當您僅短暫需要金鑰 (例如，加密後快速解密另一個金鑰的包裝金鑰) 時，請使用此參數。請勿使用工作階段金鑰來加密工作階段結束後可能需要解密的資料。  
根據預設，產生的金鑰是持久性 (權杖) 金鑰。在 <SESSION> 傳遞會變更此情況，確保使用此參數生成的金鑰是工作階段 (臨時) 金鑰。  
必要：否

***<SHARE\$1CRYPTO\$1USERS>***  
指定要與 共用 RSA 私有金鑰的加密使用者名稱的空格分隔清單  
必要：否

***<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 中的產生對稱類別
<a name="cloudhsm_cli-key-generate-symmetric"></a>

在 CloudHSM CLI 中， **key generate-symmetric** 是一組命令的父類別，當 與父類別結合時，會建立產生對稱金鑰的命令。目前，此類別由以下命令組成：
+ [產生對稱 AES 金錀](cloudhsm_cli-key-generate-symmetric-aes.md)
+ [產生對稱通用私密金錀](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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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 金鑰**  
使用規定人數控制產生金鑰時，該金鑰必須與等於最大金鑰規定人數值的最小使用者數目相關聯。關聯的使用者包括金鑰擁有者和與金鑰共用的加密使用者。若要判斷要共用金鑰的最小使用者數量，請取得金鑰使用量值與金鑰管理量值之間的最大規定人數值，並減去 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>***  
指定一個空格分隔的金鑰屬性清單，對產生的 AES 金鑰進行設定，格式為 `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (例如，`sign=true`)。  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<KEY-LENGTH-BYTES>***  
指金鑰長度 (以位元組為單位)。  

有效值：
+ 16、24 和 32
必要：是

***<LABEL>***  
指定使用者定義的 AES 金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<SESSION>***  
建立只在目前工作階段中存在的金鑰。工作階段結束後，金鑰無法復原。  
當您僅短暫需要金鑰 (例如，加密後快速解密另一個金鑰的包裝金鑰) 時，請使用此參數。請勿使用工作階段金鑰來加密工作階段結束後可能需要解密的資料。  
根據預設，產生的金鑰是持久性 (權杖) 金鑰。在 <SESSION> 傳遞會變更此情況，確保使用此參數生成的金鑰是工作階段 (臨時) 金鑰。  
必要：否

***<SHARE\$1CRYPTO\$1USERS>***  
指定要與 共用 AES 金鑰的加密使用者名稱的空格分隔清單  
必要：否

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

下列類型的使用者可以執行此命令。
+ 加密使用者 (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 範例：建立具有規定人數值的一般私密金鑰**  
使用規定人數控制產生金鑰時，該金鑰必須與等於最大金鑰規定人數值的最小使用者數目相關聯。關聯的使用者包括金鑰擁有者和與金鑰共用的加密使用者。若要判斷要共用金鑰的最小使用者數量，請取得金鑰使用量值與金鑰管理量值之間的最大規定人數值，並減去 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>***  
指定一個空格分隔的金鑰屬性清單，對產生的 AES 金鑰進行設定，格式為 `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (例如，`sign=true`)。  
如需支援的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。  
必要：否

***<KEY-LENGTH-BYTES>***  
指金鑰長度 (以位元組為單位)。  

有效值：
+ 1 到 800
必要：是

***<LABEL>***  
指定使用者定義的通用私密金鑰標籤。用戶端 SDK `label` 5.11 和更新版本允許的大小上限為 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。  
必要：是

***<SESSION>***  
建立只在目前工作階段中存在的金鑰。工作階段結束後，金鑰無法復原。  
當您僅短暫需要金鑰 (例如，加密後快速解密另一個金鑰的包裝金鑰) 時，請使用此參數。請勿使用工作階段金鑰來加密工作階段結束後可能需要解密的資料。  
根據預設，產生的金鑰是持久性 (權杖) 金鑰。在 <SESSION> 傳遞會變更此情況，確保使用此參數生成的金鑰是工作階段 (臨時) 金鑰。  
必要：否

***<SHARE\$1CRYPTO\$1USERS>***  
以空格分隔的 Crypto 使用者名稱清單，以與 共用一般私密金鑰  
必要：否

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

下列類型的使用者可以執行此命令。
+ 加密使用者 (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>

下列類型的使用者可以執行此命令。
+ 管理員 (COs)
+ 加密使用者 (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** 命令的不同方式。下列範例以加密使用者身分顯示輸出。

**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 範例：尋找所有金鑰 – 詳細內容**  
輸出包含使用者擁有和共用的金鑰，以及 HSMs中的所有公有金鑰。  
注意：按照預設，僅顯示目前登入使用者的 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 範例：分頁傳回**  
下列範例將顯示僅顯示兩個金錀的金錀分頁子集。然後，此範例會提供後續呼叫，以顯示接下來的兩個金錀。  

```
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"
  }
}
```
若要顯示接下來的兩個金錀，可以進行後續呼叫：  

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

***<篩選條件>***  
索引鍵參考 （例如，`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>***  
如已包含，則會列印每個相符金錀的所有屬性和金鑰資訊。根據預設，每個相符金錀僅顯示其金錀參考和標籤屬性。管理員使用時，此旗標沒有作用。  
必要：否

## 相關主題
<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>

下列類型的使用者可以執行此命令。
+ 管理員 (COs)
+ 加密使用者 (CU)
**注意**  
加密 使用者必須擁有金鑰才能使用此命令。

## 要求
<a name="cloudhsm_cli-key-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：

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

***<篩選條件>***  
索引鍵參考 （例如 `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 叢集中金鑰的屬性。只有建立金鑰並因此擁有金鑰的加密使用者才能變更金鑰的屬性。

如需可在 CloudHSM CLI 中使用的金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)。

## 使用者類型
<a name="chsm-cli-key-set-attribute-user-type"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU) 可以執行此命令。
+ 管理員可設定受信任的屬性。

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

若要執行此命令，必須以 CU 的身分登入。若要設定受信任屬性，您必須以管理員使用者身分登入。

## 語法
<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\$1ATTRIBUTES>***  
指金錀屬性的名稱。  
必要：是

***<篩選條件>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以 形式分隔的索引鍵屬性清單`attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`，以選取要刪除的相符索引鍵。  
如需支援的 CloudHSM CLI 金鑰屬性清單，請參閱 [CloudHSM CLI 的金鑰屬性](cloudhsm_cli-key-attributes.md)  
必要：否

***<KEY\$1ATTRIBUTE\$1VALUE>***  
指金錀屬性的名稱。  
必要：是

***<KEY\$1REFERENCE>***  
金鑰的十六進位或十進位表示法。(例如金錀控制代碼)。  
必要：否

***<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共用金鑰。

只有建立金鑰並因此擁有金鑰的加密使用者才能共用金鑰。共用金鑰的使用者可以在密碼編譯操作中使用此金鑰，但無法刪除、匯出、共用金錀或取消共用金錀。此外，這些使用者無法變更[金錀屬性](cloudhsm_cli-key-attributes.md)。

## 使用者類型
<a name="chsm-cli-key-share-user-type"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

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

若要執行此命令，必須以 CU 的身分登入。

## 語法
<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')
```

## 範例：與另一個加密使用者共用金鑰
<a name="chsm-cli-key-share-examples"></a>

下列範例顯示如何使用 **key share** 命令與加密使用者 `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)

***<篩選條件>***  
索引鍵參考 （例如 `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共用金鑰。

只有建立金鑰並因此擁有金鑰的加密使用者才能取消共用金鑰。共用金鑰的使用者可以在密碼編譯操作中使用此金鑰，但無法刪除、匯出、共用金錀或取消共用金錀。此外，這些使用者無法變更[金錀屬性](cloudhsm_cli-key-attributes.md)。

## 使用者類型
<a name="chsm-cli-key-unshare-user-type"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

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

若要執行此命令，必須以 CU 的身分登入。

## 語法
<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')
```

## 範例：取消與另一個加密使用者共用金鑰
<a name="chsm-cli-key-share-examples"></a>

下列範例顯示如何使用 **key unshare** 命令取消與加密使用者 `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. 確認 `alice` 在 `shared-users` 輸出中，並運行下列 **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)

***<篩選條件>***  
索引鍵參考 （例如 `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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap aes-gcm**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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) 值，以十六進位為單位。  
必要：否

***<TAG\$1LENGTH\$1BITS>***  
Aes GCM 標籤長度，以位元為單位。  
必要：是

***<KEY\$1TYPE\$1CLASS>***  
金鑰類型和包裝金鑰類別 【可能值：`aes`、`des3`、`ec-private`、`generic-secret`、`rsa-private`】。  
必要：是

***<LABEL>***  
未包裝金鑰的標籤。  
必要：是

***<SESSION>***  
建立僅存在於目前工作階段的工作階段金鑰。工作階段結束後，金鑰無法復原。  
必要：否

***<IV>***  
用來以十六進位包裝金鑰的初始值。  
必要：否

***<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 包裝金鑰和取消包裝機制將承載金鑰`AES-NO-PAD`取消包裝到 AWS CloudHSM 叢集中。

未包裝金鑰的使用方式與 產生的金鑰相同 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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap aes-no-pad**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap aes-pkcs5-pad**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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 包裝金鑰和取消包裝機制將承載金鑰`AES-ZERO-PAD`取消包裝到 AWS CloudHSM 叢集中。

未包裝金鑰的使用方式與 產生的金鑰相同 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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap aes-zero-pad**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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 包裝金鑰和取消包裝機制將承載金鑰`CLOUDHSM-AES-GCM`取消包裝到 AWS CloudHSM 叢集中。

未包裝金鑰的使用方式與 產生的金鑰相同 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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap cloudhsm-aes-gcm**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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) 值，以十六進位為單位。  
必要：否

***<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\$1。

## 使用者類型
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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` 屬性值設定為 的 RSA 私有金鑰來使用 **key unwrap rsa-aes**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設定為 的 RSA 私有金鑰來使用 **key unwrap rsa-oaep**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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`。

若要使用金鑰**unwrap rsa-pkcs**命令，您必須在 AWS CloudHSM 叢集中擁有 RSA 公有包裝金鑰的 RSA 私有金鑰，且其`unwrap`屬性必須設定為 `true`。

## 使用者類型
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (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` 屬性值設為 的 AES 金鑰來使用 **key unwrap rsa-oaep**命令`true`。

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

***<篩選條件>***  
索引鍵參考 （例如 `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**，您可以指定兩件事：要匯出的 金鑰和輸出檔案。要匯出的金鑰是 HSM 上的金鑰，它會加密 （包裝） 您要匯出的金鑰。

**key wrap** 命令不會從 HSM 移除金鑰，也不會阻止您在密碼編譯操作中使用金鑰。您可以多次匯出相同的金鑰。若要將加密的金鑰匯入回 HSM，請使用 [CloudHSM CLI 中的金鑰取消包裝命令](cloudhsm_cli-key-unwrap.md)。只有建立金鑰的加密使用者 (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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap aes-gcm**命令，您必須先在 AWS CloudHSM 叢集中具有 AES 金鑰。您可以產生 AES 金鑰來包裝 [使用 CloudHSM CLI 產生對稱 AES 金鑰](cloudhsm_cli-key-generate-symmetric-aes.md)命令，並將 `wrap` 屬性設定為 `true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-aes-gcm-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-aes-gcm-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<AAD>***  
AES GCM 其他已驗證資料 (AAD) 值，以十六進位表示。  
必要：否

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap aes-no-pad**命令，您必須先在 AWS CloudHSM 叢集中具有 AES 金鑰。您可以使用 [使用 CloudHSM CLI 產生對稱 AES 金鑰](cloudhsm_cli-key-generate-symmetric-aes.md)命令和 `wrap` 屬性設定為 來產生 AES 金鑰以進行包裝`true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-aes-no-pad-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-aes-no-pad-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`屬性值設為 的 AES 金鑰來使用 **key wrap aes-no-pad**命令`true`。

**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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap aes-pkcs5-pad**命令，您必須先在 AWS CloudHSM 叢集中具有 AES 金鑰。您可以使用 [使用 CloudHSM CLI 產生對稱 AES 金鑰](cloudhsm_cli-key-generate-symmetric-aes.md)命令和 `wrap` 屬性設定為 來產生 AES 金鑰以進行包裝`true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`屬性值設為 的 AES 金鑰來使用 **key wrap aes-pkcs5-pad**命令`true`。

**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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap aes-zero-pad**命令，您必須先在 AWS CloudHSM 叢集中具有 AES 金鑰。您可以使用 `wrap` 屬性設為 的 [使用 CloudHSM CLI 產生對稱 AES 金鑰](cloudhsm_cli-key-generate-symmetric-aes.md)命令來產生 AES 金鑰以進行包裝`true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`屬性值設為 的 AES 金鑰來使用 **key wrap aes-zero-pad **命令`true`。

**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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap cloudhsm-aes-gcm**命令，您必須先在 AWS CloudHSM 叢集中具有 AES 金鑰。您可以產生 AES 金鑰來包裝 [使用 CloudHSM CLI 產生對稱 AES 金鑰](cloudhsm_cli-key-generate-symmetric-aes.md)命令，並將 `wrap` 屬性設定為 `true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<AAD>***  
AES GCM 其他已驗證資料 (AAD) 值，以十六進位表示。  
必要：否

***<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-AES 包裝機制上使用 RSA 公有金鑰來包裝承載金鑰。承載金鑰的`extractable`屬性必須設定為 `true`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap rsa-aes**命令，您必須先在 AWS CloudHSM 叢集中擁有 RSA 金鑰。您可以使用 [CloudHSM CLI 中的 generate-asymmetric-pair 類別](cloudhsm_cli-key-generate-asymmetric-pair.md)命令和設定為 的 `wrap` 屬性來產生 RSA 金鑰對`true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-rsa-aes-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-rsa-aes-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`屬性值設定為 的 RSA 公有金鑰來使用 **key wrap rsa-ae**命令`true`。

**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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap rsa-oaep**命令，您必須先在 AWS CloudHSM 叢集中擁有 RSA 金鑰。您可以使用 [CloudHSM CLI 中的 generate-asymmetric-pair 類別](cloudhsm_cli-key-generate-asymmetric-pair.md)命令和設定為 的 `wrap` 屬性來產生 RSA 金鑰對`true`。

## 使用者類型
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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`屬性值設定為 的 RSA 公有金鑰來使用 **key wrap rsa-oaep**命令`true`。

**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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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`。

只有建立金鑰的加密使用者 (CU) 金鑰擁有者才能包裝金鑰。共用金鑰的使用者可以在密碼編譯操作中使用金鑰。

若要使用 **key wrap rsa-pkcs**命令，您必須先在 AWS CloudHSM 叢集中擁有 RSA 金鑰。您可以使用 [CloudHSM CLI 中的 generate-asymmetric-pair 類別](cloudhsm_cli-key-generate-asymmetric-pair.md)命令和設定為 的 `wrap` 屬性來產生 RSA 金鑰對`true`。

## 使用者類型
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-userType"></a>

下列類型的使用者可以執行此命令。
+ 加密使用者 (CU)

## 要求
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-requirements"></a>
+ 若要執行此命令，必須以 CU 的身分登入。

## 語法
<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>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取承載索引鍵。  
必要：是

***<PATH>***  
二進位檔案的路徑，其中會儲存包裝的金鑰資料。  
必要：否

***<WRAPPING\$1FILTER>***  
索引鍵參考 （例如 `key-reference=0xabc`) 或以空格分隔的索引鍵屬性清單，格式為 `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE`以選取包裝索引鍵。  
必要：是

***<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 權杖](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 的叢集上執行此操作。

如果您在 2018 年 2 月前建立叢集，則系統將在您 20 次錯誤登入後鎖定您的賬戶。

## 使用者類型
<a name="chsm-cli-login-logout-userType"></a>

下列使用者可以執行這些命令。
+ 未激活的管理員
+ 管理員
+ 加密使用者 (CU)

## 語法
<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`引數可能會公開 shell 歷史記錄中的登入資料。請考慮以互動方式提示密碼，或在使用後清除您的 shell 歷史記錄。

## 相關主題
<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>

使用 in AWS CloudHSM CloudHSM CLI **login mfa-token-sign**命令，使用多重驗證 (MFA) 登入硬體安全模組 (HSM)。若要使用此命令，您必須先設定 [MFA 的 CloudHSM CLI](login-mfa-token-sign.md)。

## 使用者類型
<a name="cloudhsm_cli-login-mfa-token-userType"></a>

下列使用者可以執行這些命令。
+ 管理員
+ 加密使用者 (CU)

## 語法
<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>

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者 (CU)

## 語法
<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** 是一組命令的父類別，當 與父類別結合時，會建立使用者專屬的命令。目前，用戶類別由以下命令組成：
+ [變更使用者 MFA](cloudhsm_cli-user-change-mfa.md)
+ [變更使用者密碼](cloudhsm_cli-user-change-password.md)
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [刪除使用者](cloudhsm_cli-user-delete.md)
+ [使用者清單](cloudhsm_cli-user-list.md)
+ [使用者複寫](cloudhsm_cli-user-replicate.md)

# CloudHSM CLI 中的使用者 change-mfa 類別
<a name="cloudhsm_cli-user-change-mfa"></a>

在 CloudHSM CLI 中， **user change-mfa** 是一組命令的父類別，當與父類別結合時，為使用者建立特定於變更多重要素驗證 (MFA) 的命令。

目前，此類別由以下子命令組成：
+ [字符簽署](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) 設定。任何使用者帳戶均可執行此命令。具有管理員角色的帳戶可以為其他使用者執行此命令。

## 使用者類型
<a name="user-change-mfa-type"></a>

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者

## 語法
<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)
```

Token Sign 策略需要一個權杖檔案將未簽署的權杖寫入其中。

```
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 的未簽署權杖寫入 `token` 指定的檔案。當系統提示您時，請在檔案中簽署權杖。

**Example ：寫入叢集中每個 HSM 的未簽署權杖**  

```
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)。  
**有效值**  
+ **管理員**：管理員可以管理使用者，但無法管理金鑰。
+ **加密使用者**：加密使用者可以建立管理金鑰並在密碼編譯操作時使用該金鑰。

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

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者 (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 目前正以加密使用者 (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>***  
取消註冊規定人數公有鑰 (如有)。

***<PASSWORD>***  
指使用者的純文字新密碼。不允許使用下列字元 '：'  
**必要**：是

***<ROLE>***  
指賦予使用者帳戶的角色。此為必要參數。如需 HSM 上使用者類型的詳細資訊，請參閱[了解 HSM 使用者](manage-hsm-users.md)。  
**有效值**  
+ **管理員**：管理員可以管理使用者，但無法管理金鑰。
+ **加密使用者**：加密使用者可以建立管理金鑰並在密碼編譯操作時使用該金鑰。

***<USERNAME>***  
為使用者指定易記的名稱。長度上限為 31 個字元。允許的唯一特殊字元是底線 (\$1)。  
建立使用者之後，您就無法再變更使用者的名稱。在 CloudHSM CLI 命令中，角色和密碼需區分大小寫，但使用者名稱不區分大小寫。  
**必要**：是

## 相關主題
<a name="change-password-seealso"></a>
+ [使用者清單](cloudhsm_cli-user-list.md)
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [刪除使用者](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 開始，使用者只能使用一種規定人數策略。

目前，此類別由以下類別和子命令組成：
+ [字符簽署](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>

下列使用者可以執行此命令。
+ 管理員

## 語法
<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>

若要執行此命令，必須以管理員使用者的身分登入。

## 語法
<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 ：建立加密使用者**  
此範例會使用加密使用者角色在您的 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>
+ [使用者清單](cloudhsm_cli-user-list.md)
+ [刪除使用者](cloudhsm_cli-user-delete.md)
+ [變更使用者密碼](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>
+ [使用者清單](cloudhsm_cli-user-list.md)
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [變更使用者密碼](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>

下列類型的使用者可以執行此命令。
+ 所有使用者。您無須登入即可執行此命令。

## 語法
<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"
      }
    ]
  }
}
```

輸出包含下列使用者屬性：
+ **使用者名稱**：顯示使用者定義的使用者易記名稱。使用者名稱一律以小寫顯示。
+ **角色**：決定使用者在 HSM 上可執行的操作。
+ **已鎖定**：表示此使用者帳戶是否已鎖定。
+ **MFA**：表示此使用者帳戶支援的多重要素驗證機制。
+ **叢集涵蓋範圍**：表示此使用者帳戶在叢集範圍內的可用性。

## 相關主題
<a name="chsm-user-list-seealso"></a>
+ key\$1mgmt\$1util 中的 [listUsers](key_mgmt_util-listUsers.md)
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [刪除使用者](cloudhsm_cli-user-delete.md)
+ [變更使用者密碼](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>

下列類型的使用者可以執行此命令。
+ 管理員 (COs)

## 要求
<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：

    ```
    $ 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 的 N 操作的命令。目前，此類別由 **token-sign** 子類別組成，該子類別由其自己的命令組成。按一下以下連結了解詳細資訊。
+ [字符簽署](cloudhsm_cli-qm-token.md)

**管理員服務**：規定人數身分驗證用於管理員特殊權限服務，例如建立使用者、刪除使用者、變更使用者密碼、設定規定人數值，以及停用規定人數和 MFA 功能。

**加密使用者服務**：配額身分驗證用於與特定金鑰相關聯的加密使用者權限服務，例如使用金鑰簽署、共用/取消共用金鑰、包裝/取消包裝金鑰，以及設定金鑰的屬性。產生、匯入或取消包裝金鑰時，會設定關聯金鑰的仲裁值。規定人數值必須等於或小於與金鑰相關聯的使用者數量，其中包括與金鑰共用的使用者和金鑰擁有者。

每種服務類型都會進一步細分為合格的服務名稱，這包含一組特定的可執行法定人數支援的服務操作。


****  

| 服務名稱 | 服務類型 | 服務操作 | 
| --- | --- | --- | 
| user | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| 規定人數 | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| cluster1 | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| 金鑰管理 | 加密使用者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| key-usage | 加密使用者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/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 中的規定人數字符簽署類別
<a name="cloudhsm_cli-qm-token"></a>

在 CloudHSM CLI 中， **quorum token-sign** 是一組命令的類別，當與 結合時**quorum token-sign**，會建立規定人數身分驗證或 N 操作的 M 特定的命令。

目前，此類別由以下命令組成：
+ [delete](cloudhsm_cli-qm-token-del.md)
+ [產生](cloudhsm_cli-qm-token-gen.md)
+ [列出](cloudhsm_cli-qm-token-list.md)
+ [列出規定人數值](cloudhsm_cli-qm-token-list-qm.md)
+ [設定規定人數值](cloudhsm_cli-qm-token-set-qm.md)

# 使用 CloudHSM CLI 刪除規定人數字符
<a name="cloudhsm_cli-qm-token-del"></a>

使用 CloudHSM CLI 中的 **quorum token-sign delete** 命令刪除規定人數授權服務的一個或多個權杖。

## 使用者類型
<a name="quorum-token-delete-user-type"></a>

下列使用者可以執行此命令。
+ 管理員

## 語法
<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** 命令刪除規定人數授權服務的一個或多個權杖。

**Example ：刪除規定人數授權服務的一個或多個權杖**  

```
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 叢集中將刪除字符的範圍 (s)。  
**有效值**  
+ **使用者**：僅用於刪除登入使用者擁有的權杖。
+ **全部**：用於刪除 AWS CloudHSM 叢集中的所有字符。

## 相關主題
<a name="quorum-token-delete-seealso"></a>
+ [使用者清單](cloudhsm_cli-user-list.md)
+ [建立使用者](cloudhsm_cli-user-create.md)
+ [刪除使用者](cloudhsm_cli-user-delete.md)

# 使用 CloudHSM CLI 產生規定人數字符
<a name="cloudhsm_cli-qm-token-gen"></a>

使用 CloudHSM CLI 中的 **quorum token-sign generate** 命令為規定人數授權服務產生一個權杖。

對於服務使用者和規定人數而言，HSM 叢集上，每位使用者每種服務取得作用中權杖有一定限制。此限制不適用於與金鑰服務相關的字符。

**注意**  
只有管理員和加密使用者可以產生特定的服務字符。如需服務類型和名稱的詳細資訊，請參閱[支援規定人數身分驗證的服務名稱和類型](quorum-auth-chsm-cli-service-names.md)

**管理員服務**：規定人數身分驗證用於管理員特殊權限服務，例如建立使用者、刪除使用者、變更使用者密碼、設定規定人數值，以及停用規定人數和 MFA 功能。

**加密使用者服務**：配額身分驗證用於與特定金鑰相關聯的加密使用者權限服務，例如使用金鑰簽署、共用/取消共用金鑰、包裝/取消包裝金鑰，以及設定金鑰的屬性。產生、匯入或取消包裝金鑰時，會設定關聯金鑰的仲裁值。規定人數值必須等於或小於與金鑰相關聯的使用者數量，其中包括與金鑰共用的使用者和金鑰擁有者。

每種服務類型都會進一步細分為合格的服務名稱，這包含一組特定的可執行法定人數支援的服務操作。


****  

| 服務名稱 | 服務類型 | 服務操作 | 
| --- | --- | --- | 
| user | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| 規定人數 | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| cluster1 | 管理員 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| 金鑰管理 | 加密使用者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| key-usage | 加密使用者 |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 

【1】 叢集服務僅在 hsm2m.medium 上提供

## 使用者類型
<a name="quorum-token-generate-user-type"></a>

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者 (CU)

## 語法
<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 的未簽署權杖寫入 `token` 指定的檔案。

**Example ：寫入叢集中每個 HSM 的未簽署權杖**  

```
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 取消註冊等全叢集組態管理規定人數的叢集管理服務。
+ **登記**：產生一個未簽署權杖，用於登記規定人數授權的公有金錀。
+ **key-usage**：產生用於執行規定人數授權金鑰使用操作的未簽署權杖。
+ **金鑰管理**：產生用於執行規定人數授權金鑰管理操作的未簽署權杖。
**必要**：是

***<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)。如需從列出的字符顯示的內容詳細資訊，請參閱 [啟用規定人數身分驗證以 AWS CloudHSM 使用 CloudHSM CLI 的金鑰管理和用量](key-quorum-auth-chsm-cli-crypto-user.md) 以取得與 `key-management`和 `key-usage`服務相關聯的字符，請參閱 [AWS CloudHSM 使用 CloudHSM CLI 啟用規定人數身分驗證的使用者管理](quorum-auth-chsm-cli-admin.md) 以取得與 `user`、 `quorum`或 `cluster`服務相關聯的字符。

## 使用者類型
<a name="quorum-token-list-user-type"></a>

下列使用者可以執行此命令。
+ 管理員
+ 加密使用者 (CU)

## 語法
<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>
+ [產生规定人數字符簽署](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>

下列使用者可以執行此命令。
+ 所有使用者。您無須登入即可執行此命令。

## 語法
<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>

下列使用者可以執行此命令。
+ 管理員

## 語法
<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 的未簽署權杖寫入權杖指定的檔案。當系統提示您時，請在檔案中簽署權杖。  

```
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>
+ [規定人數字符簽署 列出規定人數值](cloudhsm_cli-qm-token-list-qm.md)
+ [支援規定人數身分驗證的服務名稱和類型](quorum-auth-chsm-cli-service-names.md)
+ [設定 mTLS （建議）](getting-started-setup-mtls.md)