AdminTask 物件的 PasswordUtilCommands 群組

請利用 PasswordUtilCommands 群組，利用 wsadmin 工具中的 Jython 或 Jacl Scripting 語言來配置密碼加密。 您可以啟用、停用或修改密碼加密，以及管理用於密碼加密的金鑰儲存庫。

AdminTask 物件的 PasswordUtilCommands 指令群組包含下列指令:

enablePasswordEncryption

產生並配置金鑰檔和 passwordUtil.properties 檔，這兩者都是「進階加密標準 (AES)」密碼加密所需要的。

目標物件

無。

必要參數

無

選用參數

-clientPropsLocation
針對用戶端環境，提供要建立之內容檔的路徑名稱。 對於伺服器環境，請勿設定此值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cell_name 且無法變更。 （字串，選用）
-defaultAlgorithm
設定預設密碼編碼演算法。 當啟用自訂加密時，可用的值為 custom 、 xor或 aes。 預設值為 aes。 （字串，選用）
-aesKeystore
設定完整的金鑰儲存庫檔名稱。 預設檔案是 AESKey.jceks ，位於 clientPropsLocation 參數指定的目錄中。 （字串，選用）
-aesKeystorePassword
提供 AES 金鑰儲存庫檔的密碼。 （字串，選用）
-aesCurrentAlias
提供 AES 加密之金鑰的別名。 預設值是 Cell 中產生的最新金鑰。 可接受的別名字元是英數字元。 英文字母必須是小寫。 任何大寫英文字母都會轉換成小寫。 （字串，選用）
-aesAlias
提供要產生之金鑰的別名。 預設別名是含有時間戳記的 Cell 名稱。 可接受的別名字元是英數字元。 英文字母必須是小寫。 任何大寫英文字母都會轉換成小寫。 （字串，選用）
-aesGenerateKeystore
指定是否產生 AES 金鑰儲存庫。 預設值為 true。 （Boolean，選用）
-aesCustomKeyManager
提供自訂「AES 金鑰管理程式」類別名稱。 （字串，選用）
-updatePws
指定預設編碼演算法是否加密配置目錄中的所有密碼。 預設值為 true (布林，選用)
-forceGeneration
指定是否改寫現有的金鑰儲存庫檔和內容檔。 預設值為 false，表示不會改寫檔案。 （Boolean，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask enablePasswordEncryption {-aesKeystorePassword WebAS}
  • 使用 Jython 字串：
    AdminTask.enablePasswordEncryption('[-aesKeystorePassword WebAS]')
  • 使用 Jython 清單：
    AdminTask.enablePasswordEncryption(['-aesKeystorePassword',  'WebAS'])

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask enablePasswordEncryption {-interactive}
  • 使用 Jython：
    AdminTask.enablePasswordEncryption('-interactive')

modifyPasswordEncryption

修改密碼加密的配置。 除非由參數設定值，否則原始值不會變更。 若要將值變更為預設值，請使用空白字串 ('')。

目標物件

無。

必要參數

無

選用參數

-clientPropsLocation
提供要修改之用戶端環境的 passwordUtil.properties 檔案路徑名稱。 內容檔必須存在於指定的位置中。 請勿設定伺服器環境的值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cellName ，且無法變更。 （字串，選用）
-defaultAlgorithm
設定預設密碼編碼演算法。 當啟用自訂加密時，可用的值為 custom 、 xor或 aes。 預設值為 aes。 （字串，選用）
-aesKeystore
設定完整的金鑰儲存庫檔名稱。 此檔案必須存在。 預設金鑰儲存庫檔名位於 passwordUtil.properties 檔案中。 （字串，選用）
-aesNewKeystorePassword
提供 AES 金鑰儲存庫檔的新密碼。 （字串，選用）
-aesCurrentAlias
提供 AES 加密之金鑰的別名。 預設值是 Cell 中產生的最新金鑰。 可接受的別名字元是英數字元。 英文字母必須是小寫。 任何大寫英文字母都會轉換成小寫。 （字串，選用）
-aesCustomKeyManager
提供自訂「AES 金鑰管理程式」類別名稱。 （字串，選用）
-updatePws
指定預設編碼演算法是否加密配置目錄中的所有密碼。 預設值為 true。 （Boolean，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask modifyPasswordEncryption {-aesNewKeystorePassword newPassword}
  • 使用 Jython 字串：
    AdminTask.modifyPasswordEncryption('[-aesNewKeystorePassword newPassword]')
  • 使用 Jython 清單：
    AdminTask.modifyPasswordEncryption(['-aesNewKeystorePassword', ' newPassword'])

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask modifyPasswordEncryption {-interactive}
  • 使用 Jython：
    AdminTask.modifyPasswordEncryption('-interactive')

disablePasswordEncryption

停用密碼加密的配置。 因此， xor 或 custom 的值會用於加密演算法。

目標物件

無。

必要參數

無。

選用參數

-clientPropsLocation
提供要停用之用戶端環境的 passwordUtil.properties 檔路徑名稱。 內容檔必須存在於指定的位置中。 請勿設定伺服器環境的值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cellName ，且無法變更。 （字串，選用）
-defaultAlgorithm
設定預設密碼編碼演算法。 啟用自訂加密時，可用的值為 xor 或自訂。 預設值為 xor。 當 deleteAesFiles 參數未設定或設為 true 時，會忽略此值。 （字串，選用）
-deleteAesFiles
刪除 passwordUtil.properties 檔及相關聯的 AES 金鑰儲存庫檔。 預設值為 true。 （Boolean，選用）
-updatePws
指定預設編碼演算法是否加密配置目錄中的所有密碼。 預設值為 true。 （Boolean，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask disablePasswordEncryption {-deleteAesFiles false}
  • 使用 Jython 字串：
    AdminTask.disablePasswordEncryption('[-deleteAesFiles false]')
  • 使用 Jython 清單：
    AdminTask.disablePasswordEncryption(['-deleteAesFiles', 'false'])

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask disablePasswordEncryption {-interactive}
  • 使用 Jython：
    AdminTask.disablePasswordEncryption('-interactive')

deletePasswordEncryptionKey

從金鑰儲存庫檔中刪除 AES 加密金鑰。 使用自訂 KeyManager 類別時會停用此指令。

儲存在金鑰儲存庫檔中的金鑰名稱是 AES 別名。 AES 別名可唯一識別用於加密或解密的金鑰。 您可以執行 listPasswordEncryptionKeys 指令，以取得金鑰儲存庫中 AES 別名的清單。

目標物件

無。

必要參數

-aesAlias
提供要刪除之金鑰的別名。（字串，必要）

選用參數

-clientPropsLocation
提供用戶端環境之 passwordUtil.properties 檔的路徑名稱，指定金鑰儲存庫檔的位置。 內容檔必須存在於指定的位置中。 請勿設定伺服器環境的值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cellName ，且無法變更。（字串，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask deletePasswordEncryptionKey {-aesAlias key1}
  • 使用 Jython 字串：
    AdminTask.deletePasswordEncryptionKey('[-aesAlias key1]')
  • 使用 Jython 清單：
    AdminTask.deletePasswordEncryptionKey(['-aesAlias',  'key1'])

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask deletePasswordEncryptionKey {-interactive}
  • 使用 Jython：
    AdminTask.deletePasswordEncryptionKey('-interactive')

listPasswordEncryptionKeys

顯示指定之金鑰儲存庫檔中的金鑰別名和現行加密金鑰的清單。 清單中第一個項目是現行加密金鑰。

現行加密金鑰是用於加密密碼的 AES 別名。 無法刪除此 AES 別名。

目標物件

無。

必要參數

無。

選用參數

-clientPropsLocation
提供用戶端環境之 passwordUtil.properties 檔的路徑名稱，指定金鑰儲存庫檔的位置。 內容檔必須存在於指定的位置中。 請勿設定伺服器環境的值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cellName ，且無法變更。 （字串，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask listPasswordEncryptionKeys
  • 使用 Jython 字串：
    AdminTask.listPasswordEncryptionKeys()

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask listPasswordEncryptionKeys {-interactive}
  • 使用 Jython：
    AdminTask.listPasswordEncryptionKeys('-interactive')

regenPasswordEncryptionKey

產生新的 AES 密碼加密金鑰，將它設為要加密的現行金鑰，然後以新金鑰更新密碼。 使用自訂 KeyManager 類別時會停用此指令。

目標物件

無。

必要參數

無。

選用參數

-clientPropsLocation
提供用戶端環境之 passwordUtil.properties 檔的路徑名稱，指定金鑰儲存庫檔的位置。 內容檔必須存在於指定的位置中。 請勿設定伺服器環境的值，因為內容檔的位置預先定義為 CONFIG_ROOT/cells/cellName ，且無法變更。 （字串，選用）
-aesAlias
提供要產生之金鑰的別名。 預設別名是含有時間戳記的 Cell 名稱。 可接受的別名字元是英數字元。 英文字母必須是小寫。 任何大寫英文字母都會轉換成小寫。 （字串，選用）
-deleteOldKey
此參數設為 true 時會刪除前一個加密金鑰。 預設值為 false。 （Boolean，選用）
-updatePws
指定預設編碼演算法是否加密配置目錄中 .xml 檔內的所有密碼。 預設值為 true。 （Boolean，選用）

範例

批次模式下的用法範例：

  • 使用 Jacl：
    $AdminTask regenPasswordEncryptionKey {-deleteOldKey true}
  • 使用 Jython 字串：
    AdminTask.regenPasswordEncryptionKey('[-deleteOldKey true]')
  • 使用 Jython 清單：
    AdminTask.regenPasswordEncryptionKey(['-deleteOldKey', 'true'])

互動模式下的用法範例：

  • 使用 Jacl：
    $AdminTask regenPasswordEncryptionKey {-interactive}
  • 使用 Jython：
    AdminTask.regenPasswordEncryptionKey('-interactive')