設定金錀屬性

使用key set-attribute指令來設定 AWS CloudHSM 叢集中金鑰的屬性。只有建立金鑰並因此擁有金鑰的加密使用者才能變更金鑰的屬性。

如需可在 CloudHSM CLI 中使用的金鑰屬性清單，請參閱雲端的關鍵屬性 HSM CLI。

使用者類型

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

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

要求

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

語法


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

範例：設定金錀屬性

下列範例示範如何使用 key set-attribute 命令來設定標籤。

使用帶有標籤 my_key 的金錀，如下所示：


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

使用 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": [],
          "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
  }
}

引數

<CLUSTER_ID>

執行此作業的叢集識別碼。

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

<KEY_ATTRIBUTES>

指金錀屬性的名稱。

必要：是

<FILTER>

鍵引用（例如，key-reference=0xabc）或空格分隔的鍵屬性列表，attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE以的形式選擇要刪除的匹配鍵。

如需支援的 CloudHSM CLI 金鑰屬性清單，請參閱雲端的關鍵屬性 HSM CLI

必要：否

<KEY_ATTRIBUTE_VALUE>

指金錀屬性的名稱。

必要：是

<KEY_REFERENCE>

金鑰的十六進位或十進位表示法。(例如金錀控制代碼)。

必要：否

設定金錀屬性

使用者類型

要求

語法

範例：設定金錀屬性

引數

相關主題