getAttribute - AWS CloudHSM
ユーザーのタイプSyntax例引数 関連トピック

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

getAttribute

cloudhsm_mgmt_util の getAttribute コマンドは、クラスター内のすべての HSM からキーの属性値を 1 つ取得し、stdout (標準出力) またはファイルに書き込みます。このコマンドを実行できるのは Crypto User (CU) のみです。

キー属性はキーのプロパティです。キー属性には、キータイプ、クラス、ラベル、ID などの特性と、キーに対して実行できるアクション (暗号化、復号、ラップ、署名、検証など) を表す値が含まれています。

getAttribute は、所有しているキーと共有しているキーに対してのみ使用できます。このコマンド、または、key_mgmt_util の getAttribute コマンドを実行し、キーの属性値の 1 つまたはすべてをファイルに書き込むことができます。

属性とそれを表す定数のリストを取得するには、listAttributes コマンドを使用します。既存のキーの属性値を変更するには、key_mgmt_util の setAttribute および cloudhsm_mgmt_util の setAttribute を使用します。キー属性の解釈については、「キー属性リファレンス」を参照してください。

CMU コマンドを実行する前に CMU を起動し、HSM にログインする必要があります。ログインに使用するユーザータイプで、使用するコマンドを実行できることを確認してください。

HSM を追加または削除する場合は、CMU の設定ファイルを更新します。さもないと、クラスター内のすべての HSM で変更が有効にならない場合があります。

ユーザーのタイプ

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

  • Crypto User (CU)

Syntax

このコマンドには名前付きパラメータがないため、引数は図表で指定された順序で入力する必要があります。

getAttribute <key handle> <attribute id> [<filename>]

例

次の例では、HSM でキーの抽出可能な属性の値を取得します。次のようなコマンドを使用して HSM からキーをエクスポートできるかどうかを判断できます。

最初のコマンドでは、listAttributes を使用して抽出可能な属性を表す定数を見つけます。出力は、OBJ_ATTR_EXTRACTABLE の定数が 354 であることを示しています。この情報は、「キー属性リファレンス」の属性と値の説明を使用して検索することもできます。

aws-cloudhsm> listAttributes

Following are the possible attribute values for getAttribute:

      OBJ_ATTR_CLASS                  = 0
      OBJ_ATTR_TOKEN                  = 1
      OBJ_ATTR_PRIVATE                = 2
      OBJ_ATTR_LABEL                  = 3
      OBJ_ATTR_TRUSTED                = 134
      OBJ_ATTR_KEY_TYPE               = 256
      OBJ_ATTR_ID                     = 258
      OBJ_ATTR_SENSITIVE              = 259
      OBJ_ATTR_ENCRYPT                = 260
      OBJ_ATTR_DECRYPT                = 261
      OBJ_ATTR_WRAP                   = 262
      OBJ_ATTR_UNWRAP                 = 263
      OBJ_ATTR_SIGN                   = 264
      OBJ_ATTR_VERIFY                 = 266
      OBJ_ATTR_DERIVE                 = 268
      OBJ_ATTR_LOCAL                  = 355
      OBJ_ATTR_MODULUS                = 288
      OBJ_ATTR_MODULUS_BITS           = 289
      OBJ_ATTR_PUBLIC_EXPONENT        = 290
      OBJ_ATTR_VALUE_LEN              = 353
      OBJ_ATTR_EXTRACTABLE            = 354
      OBJ_ATTR_NEVER_EXTRACTABLE      = 356
      OBJ_ATTR_ALWAYS_SENSITIVE       = 357
      OBJ_ATTR_DESTROYABLE            = 370
      OBJ_ATTR_KCV                    = 371
      OBJ_ATTR_WRAP_WITH_TRUSTED      = 528      
      OBJ_ATTR_WRAP_TEMPLATE          = 1073742353
      OBJ_ATTR_UNWRAP_TEMPLATE        = 1073742354
      OBJ_ATTR_ALL                    = 512

2 番目のコマンドは、getAttribute を使用して HSM でキーハンドルが 262170 であるキーの抽出可能な属性の値を取得します。抽出可能な属性を指定するために、コマンドは 354 (属性を表す定数) を使用します。このコマンドではファイル名が指定されないため、getAttribute は出力を stdout に書き込みます。

出力は、HSM のすべてにおいて抽出可能な属性の値が 1 であることを示しています。この値は、キーの所有者がキーをエクスポートできることを示します。値が 0 (0x0) であれば、HSM からキーをエクスポートすることはできません。抽出可能な属性の値は、キーの作成時に設定できますが、変更することはできません。

aws-cloudhsm> getAttribute 262170 354

Attribute Value on server 0(10.0.1.10):
OBJ_ATTR_EXTRACTABLE
0x00000001

Attribute Value on server 1(10.0.1.12):
OBJ_ATTR_EXTRACTABLE
0x00000001

Attribute Value on server 2(10.0.1.7):
OBJ_ATTR_EXTRACTABLE
0x00000001

引数

このコマンドには名前付きパラメータがないため、引数は図表で指定された順序で入力する必要があります。

getAttribute <key handle> <attribute id> [<filename>]
<key-handle>

ターゲットキーのキーハンドルを指定します。各コマンドに指定できるキーは 1 つのみです。キーのキーハンドルを取得するには、key_mgmt_util の findKey を使用します。

指定するキーは所有しているか、共有している必要があります。キーのユーザーを検索するには、key_mgmt_util getKeyInfoで を使用します。

必須: はい

<attribute id>

属性を識別します。属性を表す定数を入力するか、すべての属性を表す 512 を入力します。たとえば、キーの種類を取得するには「256」と入力します。これは OBJ_ATTR_KEY_TYPE 属性を表す定数です。

属性とその定数のリストアップするには、listAttributes を使用します。キー属性の解釈については、キー属性リファレンス を参照してください。

必須: はい

<filename>

指定したファイルに出力を書き込みます。ファイルパスを入力します。

指定したファイルが既に存在する場合、getAttribute は警告なしにそのファイルを上書きします。

必須: いいえ

デフォルト: Stdout

関連トピック