使用 Cloud 產生對稱一般秘密金鑰HSM CLI - AWS CloudHSM
使用者類型要求語法範例引數相關主題

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

使用 Cloud 產生對稱一般秘密金鑰HSM CLI

使用 CloudHSM 中的 key generate-asymmetric-pair命令，在您的 AWS CloudHSM 叢集中CLI產生對稱的一般秘密金鑰。

使用者類型

下列類型的使用者可以執行此命令。

  • 加密使用者 （CUs）

要求

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

語法

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

範例

下列範例示範如何使用 key generate-symmetric generic-secret 命令來建立一組通用私密金鑰。

範例：建立一組通用私密金鑰
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": [],
        "cluster-coverage": "session"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": false,
        "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
      }
    }
  }
}
範例：建立一組無選用屬性的通用私密金鑰
aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes token=true encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "cluster-coverage": "session"
      },
      "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
      }
    }
  }
}

引數

<CLUSTER_ID>

執行此操作的叢集 ID。

必要：如果已設定多個叢集。

<KEY_ATTRIBUTES>

指定要為產生的金鑰設定之金鑰屬性的空格分隔清單，格式AES為 KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE（例如 token=true）。

如需支援的金鑰屬性清單，請參閱 Cloud 的關鍵屬性HSM CLI。

必要：否

<KEY-LENGTH-BYTES>

指金鑰長度 (以位元組為單位)。

有效值：

  • 1 到 800

必要：是

<LABEL>

指定使用者定義的通用私密金鑰標籤。對於 Client 5.11 label 和更新版本，允許的大小上限為 SDK 127 個字元。用戶端 SDK 5.10 和以前的 限制為 126 個字元。

必要：是

<SESSION>

建立只在目前工作階段中存在的金鑰。工作階段結束後，金鑰無法復原。

當您僅短暫需要金鑰 (例如，加密後快速解密另一個金鑰的包裝金鑰) 時，請使用此參數。請勿使用工作階段金鑰來加密工作階段結束後可能需要解密的資料。

根據預設，產生的金鑰是持久性 (權杖) 金鑰。傳入 <SESSION> 會變更此項目，確保使用此引數產生的金鑰是工作階段 （暫時） 金鑰。

必要：否

相關主題