CloudHSM CLI でキーの属性を設定する - AWS CloudHSM
ユーザーのタイプ要件Syntax例: キー属性の設定引数関連トピック

CloudHSM CLI でキーの属性を設定する

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

CloudHSM CLI で使用できる主な属性のリストについては、「CloudHSM CLI のキー属性」を参照してください。

ユーザーのタイプ

このコマンドは、次のタイプのユーザーが実行できます。

  • このコマンドを実行できるのは Crypto User (CU) です。

  • 管理者は信頼できる属性を設定できます。

要件

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

Syntax

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 コマンドを使用してラベルを設定する方法を示しています。

  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"
  }
}

  2. 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>

このオペレーションを実行するクラスターの ID。

必須: 複数のクラスターが設定されている場合。

<KEY_ATTRIBUTE>

キーの属性の名前を指定します。

必須: はい

<FILTER>

キーリファレンス (例: key-reference=0xabc) または attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE 形式のキー属性のスペース区切りリスト。これに一致するキーを削除対象として選択します。

サポートされている CloudHSM CLI キー属性のリストについては、「CloudHSM CLI のキー属性」を参照してください

必須：いいえ

<KEY_ATTRIBUTE_VALUE>

キーの属性の値を指定します。

必須: はい

<KEY_REFERENCE>

キーの 16 進数または 10 進数表現。 (キーハンドルなど)。

必須：いいえ

関連トピック