AWS CloudHSM キー管理ユーティリティコマンドのリファレンス

key_mgmt_util コマンドラインツールは、キーとその属性の作成、削除、検索など、 AWS CloudHSM クラスター内のハードウェアセキュリティモジュール (HSM) のキーを管理するのに役立ちます。このトピックでは、このツールに含まれている各コマンドについて詳しく説明します。

クイックスタートについては、「AWS CloudHSM key_mgmt_util の起動方法」を参照してください。キー属性の解釈については、AWS CloudHSM KMU のキー属性リファレンスを参照してください。クラスターの HSM とユーザーを管理するコマンドを含む cloudhsm_mgmt_util コマンドラインツールについては、AWS CloudHSM 管理ユーティリティ (CMU) を参照してください。

key_mgmt_util コマンドを実行する前に、key_mgmt_util を起動し、Crypto User (CU) として HSM にログインする必要があります。

すべての key_mgmt_util コマンドを一覧表示するには、次のように入力します。


Command: help

特定の key_mgmt_util コマンドのヘルプを表示するには、次のように入力します。


Command: <command-name> -h

key_mgmt_util セッションを終了するには、次のように入力します。


Command: exit

次のトピックでは、key_mgmt_util のコマンドについて説明します。

注記

key_mgmt_util と cloudhsm_mgmt_util のコマンドには、同じ名前のものがあります。ただし、コマンドは通常、構文が異なり、出力が異なり、機能がわずかに異なります。

コマンド	説明
aesWrapUnwrap	ファイルのキーの内容を暗号化および復号します。
deleteKey	HSM からキーを削除します。
Error2String	key_mgmt_util 16 進エラーコードに対応するエラーを取得します。
exit	key_mgmt_util を終了します。
exportPrivateKey	プライベートキーのコピーを HSM からディスク上のファイルにエクスポートします。
exportPubKey	パブリックキーのコピーを HSM からファイルにエクスポートします。
exSymKey	対称キーのプレーンテキストコピーを HSM からファイルにエクスポートします。
extractMaskedObject	HSM のキーをマスクされたオブジェクトとして抽出します。
findKey	キーの属性値に基づいてキーを検索します。
findSingleKey	クラスターのすべての HSM にキーが存在することを検証します。
genDSAKeyPair	デジタル署名アルゴリズム (DSA) キーペアを HSM に生成します。
genECCKeyPair	楕円曲線暗号 (ECC) キーペアを HSM に生成します。
genRSAKeyPair	RSA 非対称キーペアを HSM に生成します。
genSymKey	対称キーを HSM に生成します。
getAttribute	AWS CloudHSM キーの属性値を取得し、ファイルに書き込みます。
getCaviumPrivKey	プライベートキーのフェイク PEM 形式バージョンを作成し、ファイルにエクスポートします。
getCert	HSM のパーティション証明書を取得し、それをファイルに保存します。
getKeyInfo	キーを使用できるユーザーの HSM ユーザー ID を取得します。キーがクォーラム制御されている場合は、クォーラムのユーザー数を取得します。
help (ヘルプ)	key_mgmt_util で使用可能なコマンドに関するヘルプ情報を表示します。
importPrivateKey	プライベートキーを HSM にインポートします。
importPubKey	パブリックキーを HSM にインポートします。
imSymKey	対称キーのプレーンテキストコピーをファイルから HSM 内にインポートします。
insertMaskedObject	ディスク上のファイルにあるマスクされたオブジェクトを、そのオブジェクトの元のクラスターの関連クラスターに格納されている HSM に挿入します。関連クラスターとは、元のクラスターのバックアップから生成されたクラスターを指します。
AWS CloudHSM KMU を使用してキーファイルを検証する	特定のファイルに実際のプライベートキーまたは PEM キーの例が含まれているかどうかを決定します。
listAttributes	AWS CloudHSM キーの属性とそれを表す定数を一覧表示します。
listUsers	HSM のユーザー、そのユーザータイプと ID、およびその他の属性を取得します。
loginHSM および logoutHSM	クラスターの HSM でログインおよびログアウトを行います。
setAttribute	セッションキーを永続キーに変換します。
sign	選択されたプライベートキーを使ってファイルのための署名を生成します。
unWrapKey	ラップ (暗号化) されたキーをファイルから HSM 内にインポートします。
verify	特定のファイルへの署名に特定のキーが使用されたかどうかを検証します。
wrapKey	キーの暗号化されたコピーを HSM からファイルにエクスポートします。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

クライアントのインストール (Windows)

aesWrapUnwrap