AdminTask オブジェクトの KeyStoreCommands コマンド・グループ
Jython または Jacl スクリプト言語を使用すると、wsadmin ツールで鍵ストアを構成することができます。鍵ストアはインストール時にアプリケーション・サーバーによって作成され、暗号鍵または証明書を含むことができます。KeyStoreCommands グループのコマンドおよびパラメーターは、 鍵ストアの作成、削除、および管理に使用できます。
changeKeyStorePassword
changeKeyStorePassword コマンドは、鍵ストアのパスワードを変更します。このコマンドは、新規パスワードを構成に自動的に保存します。
必須パラメーター
- -keyStoreName
- パスワードの変更を必要とする鍵ストアの名前を指定します。(ストリング、必須)
- -keyStorePassword
- 変更するパスワードの名前を指定します。(ストリング、必須)
- -newKeyStorePassword
- 鍵ストアへのアクセスに使用する新規パスワードを指定します。 (ストリング、必須)
- -newKeyStorePasswordVerify
- 新しいパスワードを指定して、新規の鍵ストア・パスワードを確認します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 鍵ストアの管理有効範囲を指定します。(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask changeKeyStorePassword {-keystoreName myKeystore -keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd}
- Jython ストリングを使用:
AdminTask.changeKeyStorePassword('[-keystoreName myKeystore -keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd]')
- Jython リストを使用:
AdminTask.changeKeyStorePassword(['-keystoreName', 'myKeystore', '-keyStorePassword', 'WebAS', '-newKeyStorePassword', 'newpwd', '-newKeyStorePasswordVerify', 'newpwd'])
対話モードの使用例:
- Jacl を使用:
$AdminTask changeKeyStorePassword {-interactive}
- Jython の使用:
AdminTask.changeKeyStorePassword('-interactive')
changeMultipleKeyStorePasswords
changeMultipleKeyStorePasswords コマンドは、特定のパスワードを持つ構成内で、各鍵ストアのパスワードを更新します。システム上で 鍵ストア・ファイルを作成する場合、デフォルトではそのパスワードが WebAS に なるため、このコマンドを使用すると便利です。
必須パラメーター
- -keyStorePassword
- 変更するパスワードの名前を指定します。(ストリング、必須)
- -newKeyStorePassword
- 鍵ストアへのアクセスに使用する新規パスワードを指定します。 (ストリング、必須)
- -newKeyStorePasswordVerify
- 鍵ストアの新規パスワードを確認します。(ストリング、必須)
オプション・パラメーター
なし。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask changeMultipleKeyStorePasswords {-keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd}
- Jython ストリングを使用:
AdminTask.changeMultipleKeyStorePasswords('[-keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd]')
- Jython リストを使用:
AdminTask.changeMultipleKeyStorePasswords(['-keyStorePassword', 'WebAS', '-newKeyStorePassword', 'newpwd', '-newKeyStorePasswordVerify', 'newpwd'])
対話モードの使用例:
- Jacl を使用:
$AdminTask changeMultipleKeyStorePasswords {-interactive}
- Jython の使用:
AdminTask.changeMultipleKeyStorePasswords('-interactive')
createKeyStore
createKeyStore は、 構成および鍵ストア・データベースに鍵ストア設定を作成するコマンドです。
必須パラメーター
- -keyStoreName
- 鍵ストア構成オブジェクトを一意的に識別する名前。 (ストリング、必須)
- -keyStoreType
- 鍵ストア管理の実装。(ストリング、必須)
- -keyStoreLocation
- 鍵ストアのロケーション。ファイル・ベースの場合、このロケーションは鍵ストア・データベースへの
ファイル・システム・パスです。ハードウェア鍵ストアでは、このロケーションは
トークン・ライブラリーへのパスです。(ストリング、必須)
IBMi5OSKeyStore 鍵ストアを作成する場合、鍵ストア・ロケーションに .kdb ファイル拡張子を含む必要があります。
- -keyStorePassword
- 鍵ストアを保護するパスワード。(ストリング、必須)
- -keyStorePasswordVerify
- 鍵ストアを保護するパスワード。(ストリング、必須)
オプション・パラメーター
- -keyStoreProvider
- 鍵ストアの実装に使用されるプロバイダー。(ストリング、オプション)
- -keyStoreIsFileBased
- 鍵ストアがファイル・ベースである場合は、このパラメーターの値を true に 設定します。ハードウェア暗号鍵ストアの場合は、このパラメーターの値を false に 設定します。(ブール値、オプション)
- -keyStoreHostList
- リモート側で鍵ストアを管理する場所を示すホスト名のコンマ区切りの リスト。(ストリング、オプション)
- -keyStoreInitAtStartup
- 鍵ストアを始動時に初期化する場合は、このパラメーターの値を true に 設定します。それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
- -keyStoreReadOnly
- 鍵ストアに書き込めないようにする場合は、このパラメーターの値を true に 設定します。それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
- -keyStoreStashFile
- CMS タイプの鍵ストア用の stash ファイルを作成する場合は、 このパラメーターの値を true に設定します。それ以外の場合は、このパラメーターの値を false に設定 します。 (ブール値、オプション)
- -enableCryptoOperations
- ハードウェア暗号オペレーションで鍵ストア・オブジェクトを使用するかどうかを 指定します。デフォルト値は false です。(ブール値、オプション)
- -keyStoreDescription
- 対象とする鍵ストアを記述するユーザー定義テキストを指定します。(ストリング、オプション)
- -keyStoreUsage
- 対象の鍵ストアの使用法を指定します。SSLKeys、KeySetKeys、RootKeys、DeletedKeys、DefaultSigners、または RSATokenKeys を指定します。(ストリング、オプション)
- -scopeName
- 管理有効範囲を一意的に識別する名前。例: (cell):localhostNode01Cell(ストリング、オプション)
- -controlRegionUser
- 制御領域鍵リングの書き込み可能鍵ストア・オブジェクトを作成するには、制御領域ユーザーを指定します。SAF 書き込み可能鍵リングが使用可能なときに、SAF 鍵リングにこのオプションを指定します。(ストリング、オプション)
- -servantRegionUser
- サーバント領域鍵リングの書き込み可能鍵ストア・オブジェクトを作成するには、サーバント領域ユーザーを指定します。SAF 書き込み可能鍵リングが使用可能なときに、SAF 鍵リングにこのオプションを指定します。(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask createKeyStore {-keyStoreName testKS -keyStoreType JCEKS -keyStoreLocation c:/temp/testKeyFile.p12 -keyStorePassword testpwd -keyStorePasswordVerify testpwd -keyStoreIsFileBased true -keyStoreInitAtStartup true -keyStoreReadOnly false}
- Jython ストリングを使用:
AdminTask.createKeyStore ('[-keyStoreName testKS -keyStoreType JCEKS -keyStoreLocation c:/temp/testKeyFile.p12 -keyStorePassword testpwd -keyStorePasswordVerify testpwd -keyStoreIsFileBased true -keyStoreInitAtStartup true -keyStoreReadOnly false]')
- Jython リストを使用:
AdminTask.createKeyStore (['-keyStoreName', 'testKS', '-keyStoreLocation', '-keyStoreType', 'JCEKS', 'c:/temp/testKeyFile.p12', '-keyStorePassword', 'testpwd', '-keyStorePasswordVerify', 'testpwd', '-keyStoreIsFileBased', 'true', '-keyStoreInitAtStartup', 'true', '-keyStoreReadOnly', 'false'])
対話モードの使用例:
- Jacl を使用:
$AdminTask createKeyStore {-interactive}
- Jython の使用:
AdminTask.createKeyStore('-interactive')
createCMSKeyStore
createCMSKeyStore は、 構成に CMS 鍵ストア・データベースおよび鍵ストア設定を作成するコマンドです。
必須パラメーター
- -cmsKeyStoreURI
- CMS 鍵ストアの URI。(ストリング、必須)
- -pluginHostName
- プラグインのホスト名。(ストリング、必須)
オプション・パラメーター
なし。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask createCMSKeyStore {-cmsKeyStoreURI CMSKeystoreURI -pluginHostName myHostName}
- Jython ストリングを使用:
AdminTask.createCMSKeyStore('-cmsKeyStoreURI CMSKeystoreURI -pluginHostName myHostName')
- Jython リストを使用:
AdminTask.createCMSKeyStore(['-cmsKeyStoreURI', 'CMSKeystoreURI', '-pluginHostName', 'myHostName'])
対話モードの使用例:
- Jacl を使用:
$AdminTask createCMSKeyStore {-interactive}
- Jython の使用:
AdminTask.createCMSKeyStore('-interactive')
deleteKeyStore
deleteKeyStore は、 構成および鍵ストア・ファイルから鍵ストアの設定を削除するコマンドです。
必須パラメーター
- -keyStoreName
- 削除する鍵ストアを一意的に識別する名前。 (ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲を一意的に識別する名前。例: (cell):localhostNode01Cell(ストリング、オプション)
- -removeKeyStoreFile
- 鍵ストア・ファイルを削除するかどうかを指定します。鍵ストア・ファイルを削除するには true を指定し、 構成に残す場合は false を指定します。(ブール値、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask deleteKeyStore {-keyStoreName testKS}
- Jython ストリングを使用:
AdminTask.deleteKeyStore('[-keyStoreName testKS]')
- Jython リストを使用:
AdminTask.deleteKeyStore(['-keyStoreName', 'testKS'])
対話モードの使用例:
- Jacl を使用:
$AdminTask deleteKeyStore {-interactive}
- Jython の使用:
AdminTask.deleteKeyStore('-interactive')
exchangeSigners
exchangeSigners は、 鍵ストア間で署名者証明書を交換するコマンドです。
必須パラメーター
- -keyStoreName1
- 鍵ストアを一意的に識別する名前。2 番目の鍵ストアを指定する場合は、 keyStoreName2 パラメーターを使用する必要があります。(ストリング、必須)
- -keyStoreName2
- 鍵ストアを一意的に識別する名前。2 番目の鍵ストアを指定する場合は、 keyStoreName1 パラメーターを使用する必要があります。(ストリング、必須)
オプション・パラメーター
- -keyStoreScope1
- keyStoreName1 パラメーターで指定した鍵ストアの 有効範囲名。(ストリング、オプション)
- -keyStoreScope2
- keyStoreName2 パラメーターで指定した鍵ストアの 有効範囲名。(ストリング、オプション)
- -certificateAlaisList1
- コンマで区切った別名のリスト。(ストリング、オプション)
- -certificateAliasList2
- コンマで区切った別名のリスト。(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask exchangeSigners {-keyStoreName1 testKS -certificateAliasList1 testCert1 -keyStoreName2 secondKS -certificateAlaisList2 certAlis}
- Jython ストリングを使用:
AdminTask.exchangeSigners('[-keyStoreName1 testKS -certificateAliasList1 testCert1 -keyStoreName2 secondKS -certificateAlaisList2 certAlis]')
- Jython リストを使用:
AdminTask.exchangeSigners(['-keyStoreName1', 'testKS', '-certificateAliasList1', 'testCert1', '-keyStoreName2', 'secondKS', '-certificateAlaisList2', 'certAlis'])
対話モードの使用例:
- Jacl を使用:
$AdminTask exchangeSigners {-interactive}
- Jython の使用:
AdminTask.exchangeSigners('-interactive')
getKeyStoreInfo
getKeyStoreInfo は、 特定の鍵ストアの設定を表示するコマンドです。
必須パラメーター
- -keyStoreName
- 鍵ストアを一意的に識別する名前。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲を一意的に識別する名前。例: (cell):localhostNode01Cell(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask getKeyStoreInfo {-name testKS}
- Jython ストリングを使用:
AdminTask.getKeyStoreInfo('[-name testKS]')
- Jython リストを使用:
AdminTask.getKeyStoreInfo(['-name', 'testKS'])
対話モードの使用例:
- Jacl を使用:
$AdminTask getKeyStoreInfo {-interactive}
- Jython の使用:
AdminTask.getKeyStoreInfo('-interactive')
listKeyFileAliases
listKeyFileAliases は、 鍵ストア・ファイル内の証明書をリストするコマンドです。
必須パラメーター
- -keyFilePath
- 鍵ファイルのパス。(ストリング、必須)
- -keyFilePassword
- 鍵ファイルのパスワード。(ストリング、必須)
- -keyFileType
- 鍵ファイル・タイプ。(ストリング、必須)
オプション・パラメーター
なし。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listKeyFileAliases {-keyFilePath c:/temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12}
$AdminTask listKeyFileAliases {-keyFilePath /temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12}
- Jython ストリングを使用:
AdminTask.listKeyFileAliases('[-keyFilePaht c:/temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12]')
AdminTask.listKeyFileAliases('[-keyFilePaht /temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12]')
- Jython リストを使用:
AdminTask.listKeyFileAliases(['-keyFilePaht', 'c:/temp/testKeyFile.p12', '-keyFilePassword', 'testPwd', '-keyFileType', 'PKCS12'])
AdminTask.listKeyFileAliases(['-keyFilePaht', '/temp/testKeyFile.p12', '-keyFilePassword', 'testPwd', '-keyFileType', 'PKCS12'])
対話モードの使用例:
- Jacl を使用:
$AdminTask listKeyFileAliases {-interactive}
- Jython の使用:
AdminTask.listKeyFileAliases('-interactive')
listKeyStores
listKeyStores は、 特定の有効範囲内の鍵ストアをリストするコマンドです。
必須パラメーター
なし。オプション・パラメーター
- -scopeName
- 管理有効範囲を一意的に識別する名前を指定します。例: (cell):localhostNode01Cell (ストリング、オプション)
- -all
- すべての鍵ストアをリストするには、このパラメーターの値を true に指定します。 このパラメーターは、scopeName パラメーターをオーバーライドします。デフォルト値は false です。(ブール値、オプション)
- -keyStoreUsage
- 対象の鍵ストアの使用法を指定します。SSLKeys、KeySetKeys、RootKeys、DeletedKeys、DefaultSigners、または RSATokenKeys を指定します。(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listKeyStores
- Jython の使用:
AdminTask.listKeyStores()
対話モードの使用例:
- Jacl を使用:
$AdminTask listKeyStores {-interactive}
- Jython の使用:
AdminTask.listKeyStores('-interactive')
listKeyStoreTypes
listKeyStoreTypes は、 有効な鍵ストア・タイプをすべてリストするコマンドです。
必須パラメーター
なし。オプション・パラメーター
なし。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listKeyStoreTypes
- Jython の使用:
AdminTask.listKeyStoreTypes()
対話モードの使用例:
- Jacl を使用:
$AdminTask listKeyStoreTypes {-interactive}
- Jython ストリングを使用:
AdminTask.listKeyStoreTypes('-interactive')
listSignatureAlgorithms
listSignatureAlgorithms コマンド は、構成されている現在のセキュリティー・レベルで有効な署名アルゴリズム をリストします。セキュリティー標準が有効にされていない場合はすべての署名アルゴリズムが戻され、それ以外の場合は、構成されたセキュリティー・レベルで有効な署名アルゴリズムが戻されます。
必須パラメーター
なし。オプション・パラメーター
なし。セキュリティー・モード | 有効な署名アルゴリズム |
---|---|
FIPS が有効にされていない | SHA1withRSA |
FIPS140-2 | SHA1withRSA |
SP800-131 - Transition | SHA1withRSA |
SP800-131 - Strict | SHA256withRSA |
Suite B 128 | SHA256withECDSA |
Suite B 192 | SHA256withECDSA |
modifyKeyStore
- このコマンドを使用して、鍵ストア・オブジェクトが参照する鍵ストア・ファイルを変更するには、 keyStoreName、keyStoreLocation、keyStoreType、および keyStorePassword パラメーターを指定します。
必須パラメーター
- -keyStoreName
- 鍵ストアを識別する固有の名前を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 鍵ストアの管理有効範囲を指定します。(ストリング、オプション)
- -keyStoreProvider
- 鍵ストアのプロバイダーを指定します。(ストリング、オプション)
- -keyStoreType
- いずれかの事前定義された鍵ストア・タイプを指定します。有効な値は、JCEKS、CMSKS、PKCS12、PKCS11、および JKS です。(ストリング、オプション)
- -keyStoreLocation
- 鍵ストア・ファイルの完全修飾されたロケーションを指定します。鍵ストア・ファイルのロケーションを変更するには、keyStoreLocation、keyStoreType、keyStorePassword、および keyStoreName parameters を指定する必要があります。(ストリング、オプション)
- -keyStorePassword
- 鍵ストアを開くパスワードを指定します。changeKeystorePassword コマンドを使用して、鍵ストアのパスワードを変更します。(ストリング、オプション)
- -keyStoreIsFileBased
- 鍵ストアがファイル・ベースかどうかを指定します。鍵ストアがファイル・ベースであるかどうかを変更するには、keyStoreIsFileBased および keyStoreName パラメーターを指定します。 (ブール値、オプション)
- -keyStoreInitAtStartup
- 鍵ストアによりサーバー始動を開始するかどうかを指定します。鍵ストアが、サーバー始動時に開始するかどうかを変更するには、keyStoreInitAtStartup および keyStoreName パラメーターを指定します。(ブール値、オプション)
- -keyStoreReadOnly
- 鍵ストアを書き込み可能にするかどうかを指定します。鍵ストアが読み取り専用であるかどうかを変更するには、keyStoreReadOnly および keyStoreName パラメーターを指定します。(ブール値、オプション)
- -keyStoreDescription
- 鍵ストアを記述するステートメントを指定します。鍵ストアの記述を変更するには、keyStoreDescription および keyStoreName パラメーターを指定します。 (ストリング、オプション)
- -keyStoreUsage
- 対象の鍵ストアの使用法を指定します。SSLKeys、KeySetKeys、RootKeys、DeletedKeys、DefaultSigners、または RSATokenKeys を指定します。(ストリング、オプション)
例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask modifyKeyStore {-keyStoreName CellDefaultKeyStore -keyStoreLocation c:/temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password}
$AdminTask modifyKeyStore {-keyStoreName CellDefaultKeyStore -keyStoreLocation /temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password}
- Jython の使用:
AdminTask.modifyKeyStore('-keyStoreName CellDefaultKeyStore -keyStoreLocation c:/temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password')
AdminTask.modifyKeyStore('keyStoreName CellDefaultKeyStore -keyStoreLocation /temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password')
対話モードの使用例:
- Jacl を使用:
$AdminTask modifyKeyStore {-interactive}
- Jython の使用:
AdminTask.modifyKeyStore('-interactive')