AdminTask 对象的 AuditSigningCommands 命令组
可以使用 Jython 脚本语言,通过 wsadmin 工具来配置审计记录的签名。使用 AuditSigningCommands 组中的命令和参数来启用、禁用安全性审计系统以及对其进行配置以签署审计记录。
createAuditSigningConfig
createAuditSigningConfig 命令会创建系统用来签署审计记录的签名模型。首次配置审计签名配置时,请使用此命令。如果已经配置审计签名,请使用 enableAuditSigning 和 disableAuditSigning 命令来开启和关闭签名。
您可以从包含证书的现有密钥文件名导入该证书,自动生成该证书,或使用与应用程序服务器所使用的同一证书对审计记录进行加密。要使用现有密钥库中的现有证书,请针对 -enableAuditEncryption、-certAlias 以及 -signingKeyStoreRef 参数指定输入值。另外,在此方案中,请将 -useEncryptionCert、-autogenCert 以及 -importCert 参数的值设为 false。
用户必须具有管理员和审计员管理角色才能运行此命令。
目标对象
无。
必需参数
- -enableAuditSigning
- 指定是否要签署审计记录。此参数会修改审计策略配置。(布尔值,必需)
- -certAlias
- 指定用于标识所生成或导入证书的别名。(字符串,必需)
- -signingKeyStoreRef
- 指定系统要将证书导入到其中的密钥库的引用标识。签名密钥库必须已在 security.xml 文件中存在。系统会使用用来签署审计记录的证书来更新此密钥库。(字符串,必需)
可选参数
- -useEncryptionCert
- 指定是否要使用同一证书进行加密和签署。(布尔值,可选)
- -autogenCert
- 指定是否要自动生成用于签署审计记录的证书。(布尔值,可选)
- -importCert
- 指定是否要导入现有证书以签署审计记录。(布尔值,可选)
- -certKeyFileName
- 指定要导入的证书的密钥文件唯一名称。(字符串,可选)
- -certKeyFilePath
- 指定要导入的证书的密钥文件位置。(字符串,可选)
- -certKeyFileType
- 指定要导入的证书的密钥文件类型。(字符串,可选)
- -certKeyFilePassword
- 指定要导入的证书的密钥文件密码。(字符串,可选)
- -certAliasToImport
- 指定要导入的证书的别名。(字符串,可选)
返回值
如果成功,那么返回缩短格式的密钥库(已在该密钥库中添加签名证书)。请记住,此密钥库位于 security.xml 文件中,而不是位于 audit.xml 文件中。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.createAuditSigningConfig('-enableAuditSigning true -certAlias auditSigningCert -autogenCert true -signingKeyStoreRef Ref_Id_of_KeyStoreInSecurityXML')
- 使用 Jython 列表:
AdminTask.createAuditSigningConfig(['-enableAuditSigning', 'true', '-certAlias', 'auditSigningCert', '-autogenCert', 'true -signingKeyStoreRef', 'Ref_Id_of_KeyStoreInSecurityXML'])
交互方式示例用法
- 使用 Jython:
AdminTask.createAuditSigningConfig('-interactive')
deleteAuditSigningConfig
deleteAuditSigningConfig 命令会删除系统用来签署审计记录的签名模型。当系统删除审计签名配置时,不会删除 security.xml 中的密钥库文件,也不会删除密钥库的签署者证书。
用户必须具有审计员管理角色才能运行此命令。
目标对象
无。
返回值
如果系统成功除去审计签名配置,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.deleteAuditSigningConfig()
- 使用 Jython 列表:
AdminTask.deleteAuditSigningConfig()
交互方式示例用法
- 使用 Jython:
AdminTask.deleteAuditSigningConfig('-interactive')
disableAuditSigning
disableAuditSigning 命令会禁用安全性审计系统的审计记录签名。
用户必须具有审计员管理角色才能运行此命令。
目标对象
无。
返回值
如果系统成功禁用审计签名,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.disableAuditSigning()
- 使用 Jython 列表:
AdminTask.disableAuditSigning()
交互方式示例用法
- 使用 Jython:
AdminTask.disableAuditSigning('-interactive')
enableAuditSigning
enableAuditSigning 命令会在安全性审计系统中启用审计记录签名。
用户必须具有审计员管理角色才能运行此命令。
目标对象
无。
返回值
如果系统成功在安全性审计系统中启用审计签名,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.enableAuditSigning()
- 使用 Jython 列表:
AdminTask.enableAuditSigning()
交互方式示例用法
- 使用 Jython:
AdminTask.enableAuditSigning()
getAuditSigningConfig
getAuditSigningConfig 命令会检索系统用来签署审计记录的签名模型。
用户必须具有监视员管理角色才能运行此命令。
目标对象
无。
返回值
{{securityXmlSignerScopeName (cell):Node04Cell:(node):Node04}
{securityXmlSignerCertAlias mysigningcert}
{securityXmlSignerKeyStoreName NodeDefaultRootStore}
{signerKeyStoreRef KeyStore_Node04_4}
{enabled true}}
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.getAuditSigningConfig()
- 使用 Jython 列表:
AdminTask.getAuditSigningConfig()
交互方式示例用法
- 使用 Jython 字符串:
AdminTask.getAuditSigningConfig('-interactive')
importEncryptionCertificate
importEncryptionCertificate 命令会将用于对审计数据进行加密的自签名证书,从加密密钥库导入到另一个密钥库。在内部使用此命令来自动生成用于加密或签名的证书。您也可以使用此命令,通过指定 keyStoreName 和 keyStoreScope 参数将证书导入到密钥库。
目标对象
无。
必需参数
- -keyStoreName
- 指定用于标识密钥库的唯一名称。(字符串,必需)
- -keyFilePath
- 指定包含所要导入证书的密钥库的路径名。(字符串,必需)
- -keyFilePassword
- 指定包含所要导入证书的密钥库的密码。(字符串,必需)
- -keyFileType
- 指定密钥库的类型。(字符串,必需)
- -certificateAliasFromKeyFile
- 指定要从密钥库文件中导入的证书的别名。(字符串,必需)
可选参数
- -keyStoreScope
- 指定密钥库的作用域名称。(字符串,可选)
- -certificateAlias
- 指定用来标识已导入证书的唯一名称。(字符串,可选)
返回值
如果系统成功导入加密证书,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.importEncryptionCertificate('{-keyStoreName AuditDefaultKeyStore -keyStoreScope (cell):Node04Cell -keyFilePath c:/install_root/appserver/profiles/AppSrv01/config/cells/Node04Cell/nodes/Node04/trust.p12 -keyFilePassword WebAS -keyFileType PKCS12 -certificateAliasFromKeyFile root -certificateAlias myimportcert')
- 使用 Jython 列表:
AdminTask.importEncryptionCertificate(['{-keyStoreName', 'AuditDefaultKeyStore', '-keyStoreScope', '(cell):Node04Cell', '-keyFilePath', 'c:/install_root/appserver/profiles/AppSrv01/config/cells/Node04Cell/nodes/Node04/trust.p12', '-keyFilePassword', 'WebAS', '-keyFileType', 'PKCS12', '-certificateAliasFromKeyFile', 'root', '-certificateAlias', 'myimportcert'])
交互方式示例用法
- 使用 Jython:
AdminTask.importEncryptionCertificate('-interactive')
isAuditSigningEnabled
isAuditSigningEnabled 命令指示审计签名在安全性审计系统中是处于已启用还是已禁用状态。
用户必须具有监视员管理角色才能运行此命令。
目标对象
无。
返回值
如果在安全性审计系统中配置了签名,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.isAuditSigningEnabled()
- 使用 Jython 列表:
AdminTask.isAuditSigningEnabled()
交互方式示例用法
- 使用 Jython:
AdminTask.isAuditSigningEnabled('-interactive')
modifyAuditSigningConfig
modifyAuditSigningConfig 命令会修改系统用来签署审计记录的签名模型。
证书可从包含该证书的现有密钥文件名导入,可自动生成,或者是用于对审计记录进行加密的同一证书。要使用现有密钥库中的现有证书,请针对 -enableAuditEncryption、-certAlias 以及 -signingKeyStoreRef 参数指定输入值。另外,在此方案中,请将 -useEncryptionCert、-autogenCert 以及 -importCert 参数的值设为 false。
用户必须具有管理员和审计员管理角色才能运行此命令。
目标对象
无。
必需参数
- -enableAuditSigning
- 指定是否要签署审计记录。此参数会修改审计策略配置。(布尔值,必需)
- -certAlias
- 指定用于标识所生成或导入证书的别名。(字符串,必需)
- -signingKeyStoreRef
- 指定系统要将证书导入到其中的密钥库的引用标识。签名密钥库必须已在 security.xml 文件中存在。系统会使用用来签署审计记录的证书来更新此密钥库。(字符串,必需)
可选参数
- -useEncryptionCert
- 指定是否要使用同一证书进行加密和签署。(布尔值,可选)
- -autogenCert
- 指定是否要自动生成用于签署审计记录的证书。(布尔值,可选)
- -importCert
- 指定是否要导入现有证书以签署审计记录。(布尔值,可选)
- -certKeyFileName
- 指定要导入的证书的密钥文件唯一名称。(字符串,可选)
- -certKeyFilePath
- 指定要导入的证书的密钥文件位置。(字符串,可选)
- -certKeyFileType
- 指定要导入的证书的密钥文件类型。(字符串,可选)
- -certKeyFilePassword
- 指定要导入的证书的密钥文件密码。(字符串,可选)
- -certAliasToImport
- 指定要导入的证书的别名。(字符串,可选)
返回值
如果系统成功修改安全性审计系统配置,那么此命令会返回值 true。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.modifyAuditSigningConfig('-enableAuditSigning true -certAlias auditSigningCert -autogenCert true -signingKeyStoreRef Ref_Id_of_KeyStoreInSecurityXML')
- 使用 Jython 列表:
AdminTask.modifyAuditSigningConfig(['-enableAuditSigning', 'true', '-certAlias', 'auditSigningCert', '-autogenCert', 'true', '-signingKeyStoreRef', 'Ref_Id_of_KeyStoreInSecurityXML'])
交互方式示例用法
- 使用 Jython:
AdminTask.modifyAuditSigningConfig('-interactive')