PasswordUtilCommands AdminTask 对象的组

使用 PasswordUtilCommands 组，在 wsadmin 工具中使用 Jython 或 Jacl 脚本语言配置密码加密。您可以启用，禁用或修改密码加密，以及管理密码加密的密钥库。

AdminTask 对象的 PasswordUtilCommands 命令组包括以下命令：

enablePasswordEncryption
modifyPasswordEncryption
disablePasswordEncryption
deletePasswordEncryptionKey
listPasswordEncryptionKeys
regenPasswordEncryptionKey

enablePasswordEncryption

生成并配置密钥文件和 passwordUtil.properties 文件，这两个文件都是高级加密标准 (AES) 密码加密所必需的。

目标对象

无。

必需参数

无

可选参数

-clientPropsLocation: 提供要为客户机环境创建的属性文件的路径名。对于服务器环境，请勿设置该值，因为属性文件的位置预定义为 CONFIG_ROOT/cells/cell_name 并且无法更改。（字符串，可选）
-defaultAlgorithm: 设置缺省密码编码算法。当启用定制加密时，可用值为 custom ， xor或 aes。缺省值为 aes。（字符串，可选）; 新支持的有效值是 aes-128 和 aes-256. 可以指定这些值来代替 aes。目前， aes 默认为 aes-128 ，但计划将来将默认值改为 aes-256 默认值。
-aesKeystore: 设置标准密钥库文件名。默认文件为 AESKey.jceks ，位于 clientPropsLocation 参数指定的目录中。（字符串，可选）
-aesKeystorePassword: 提供 AES 密钥库文件的密码。如果未指定密码，则使用随机生成的密码。（字符串，可选）
-aesCurrentAlias: 提供用于 AES 加密的密钥的别名。缺省值为单元中最新生成的密钥。可接受的别名字符为字母数字字符字母字符必须小写。任何大写字母字符都将转换为小写。（字符串，可选）
-aesAlias: 提供要生成的密钥的别名。缺省别名是具有时间戳记的单元名称。可接受的别名字符为字母数字字符字母字符必须小写。任何大写字母字符都将转换为小写。（字符串，可选）
-aesGenerateKeystore: 指定是否生成 AES 密钥库。缺省值为 True。（布尔值，可选）
-aesCustomKeyManager: 提供定制 AES 密钥管理器类名。（字符串，可选）
-updatePws: 指定缺省编码算法是否对 config 目录中的所有密码都进行加密。缺省值为 true (布尔值，可选)
-forceGeneration: 指定是否已覆盖现有密钥库文件和属性文件。缺省值为 false，这意味着不会覆盖文件。（布尔值，可选）

示例

批处理方式示例用法：

使用 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。（字符串，可选）; 新支持的有效值是 aes-128 和 aes-256. 可以指定这些值来代替 aes。目前， aes 默认为 aes-128 ，但计划将来将默认值改为 aes-256 默认值。
-aesKeystore: 设置标准密钥库文件名。此文件必须存在。缺省密钥库文件名在 passwordUtil.properties 文件中。（字符串，可选）
-aesNewKeystorePassword: 提供 AES 密钥库文件的新密码。（字符串，可选）
-aesCurrentAlias: 提供用于 AES 加密的密钥的别名。缺省值为单元中最新生成的密钥。可接受的别名字符为字母数字字符字母字符必须小写。任何大写字母字符都将转换为小写。（字符串，可选）
-aesCustomKeyManager: 提供定制 AES 密钥管理器类名。（字符串，可选）
-updatePws: 指定缺省编码算法是否对 config 目录中的所有密码都进行加密。缺省值为 True。（布尔值，可选）

示例

批处理方式示例用法：

使用 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 或 custom。缺省值为 xor。当未设置 deleteAesFiles 参数或者此参数设置为 true 时，会忽略此值。（字符串，可选）
-deleteAesFiles: 删除 passwordUtil.properties 文件和关联的 AES 密钥库文件。缺省值为 True。（布尔值，可选）
-updatePws: 指定缺省编码算法是否加密配置目录中的所有密码。缺省值为 True。（布尔值，可选）

示例

批处理方式示例用法：

使用 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: 提供要生成的密钥的别名。缺省别名是具有时间戳记的单元名称。可接受的别名字符为字母数字字符字母字符必须小写。任何大写字母字符都将转换为小写。（字符串，可选）
-deleteOldKey: 当此参数设置为 true 时，将删除先前的加密密钥。缺省值为 FALSE。（布尔值，可选）
-updatePws: 指定缺省编码算法是否对配置目录中的 .xml 文件中的所有密码进行加密。缺省值为 True。（布尔值，可选）

示例

批处理方式示例用法：

使用 Jacl：

$AdminTask regenPasswordEncryptionKey {-deleteOldKey true}

使用 Jython 字符串：

AdminTask.regenPasswordEncryptionKey('[-deleteOldKey true]')

使用 Jython 列表：

AdminTask.regenPasswordEncryptionKey(['-deleteOldKey', 'true'])

交互方式示例用法：

使用 Jacl：

$AdminTask regenPasswordEncryptionKey {-interactive}

使用 Jython：

AdminTask.regenPasswordEncryptionKey('-interactive')