key generate-file

key generate-file コマンドは HSM から非対称キーをエクスポートします。ターゲットがプライベートキーの場合、プライベートキーへの参照はフェイク PEM 形式でエクスポートされます。ターゲットがパブリックキーの場合、パブリックキーのバイトは PEM 形式でエクスポートされます。

実際のプライベートキーマテリアルは含まず、HSM のプライベートキーを参照するフェイク PEM ファイルを使用して、ウェブサーバーから への SSL/TLS オフロードを確立できます AWS CloudHSM。詳細については、「SSL/TLS オフロード」を参照してください。

ユーザーのタイプ

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

• Crypto User (CU)

要件

このコマンドを実行するには、CU としてログインする必要があります。

Syntax

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

例

この例では、 key generate-fileを使用して AWS CloudHSM クラスターにキーファイルを生成する方法を示します。

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

引数

<CLUSTER_ID>

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

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

＜フィルター＞

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

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

必須: いいえ

<ENCODING>

キーファイルのエンコード形式を指定します

必須: はい

<PATH>

キーファイルが書き込まれるファイルパスを指定します

必須: はい

関連トピック

• CloudHSM CLI のキー属性

• CloudHSM CLI を使用してキーをフィルタリングする

• キー generate-asymmetric-pair

• key generate-symmetric