密钥命名约定
- Updated: 2025/02/19
外部密钥库要求密钥名称遵循特定的命名约定,通常包括像 autologin_ 这样的前缀,并要求对某些特殊字符进行编码。 这些名称必须与系统的用户名一致。
坐席自动登录命名约定
Control Room 根据外部密钥库中的对象命名约定检索自动登录凭据。 Control Room 会搜索一个对象,其中对象名称(外部密钥库中的凭据名称)与其执行自动登录的 Control Room 用户名匹配。
前缀 autologin_ 是所有支持的外部密钥库自动登录凭证命名约定的一部分。 外部密钥库中自动登录凭据的名称必须包含 autologin_,后接 Control Room 用户名。 在某些工单中,某些密钥保管库对凭证对象名称中可使用的字符有限制。 此外,为了支持不同场景对凭据的编码方式,Automation 360 要求保留或编码某些字符。
以下表格列出了 Control Room 中预期的对象命名约定示例:
Control Room 用户名 | 预期对象名称格式 |
---|---|
ABCD\用户123 | 自动登录_ABCD--用户123 |
user123@rpa.abcd.com | 自动登录_用户123-40-rpa-2e-abcd-2e-com |
ABCD\用户123 | 自动登录_ABCD\用户123 |
user123@rpa.abcd.com | autologin_user123@rpa.abcd.com |
约翰 | 自动登录_约翰 |
对于自动登录凭据,请记住以下几点:
- 外部密钥库中的对象名称必须包含前缀 autologin_。
- 自动登录凭据名称必须映射到要检索的凭据的 Control Room 用户名(登录 ID)。
某些外部密钥库对某些字符的使用有限制,例如在密钥名称(对象名称)中限制使用反斜杠(\)和符号(@),以及限制在 API 调用中如何解释特殊字符。 如果用户 ID 包含特殊字符,则必须使用 ASCII 代码字符替换在外部密钥库中对秘密名称(对象名称)进行编码,如下表所示。
此字符 | 对该 ASCII 代码字符替换的更改 |
---|---|
\ (反斜杠) | -- |
- (破折号) | -2d- |
_ (下划线) | -5f- |
@(和号) | -40- |
. (句号) | -2e- |
坐席自动化命名约定
坐席自动化凭据是自动化在运行时检索的凭据,并由自动化 bot 用于与应用程序进行身份验证。 从外部密钥库检索的自动化凭据在配置存储柜和凭据时,使用外部密钥库选项映射到 Automation Anywhere Credential Vault 中。
Automation Anywhere locker 映射到以下任一项:
- 安全名称 (CyberArk)
- 密钥名称前缀(AWS、Azure 和 HashiCorp)
凭据映射到以下任一项:
- 对象名称 (CyberArk)
- 一个秘密名称主体(AWS、Azure 和 HashiCorp)
为了支持 Automation Anywhere 用户定义的凭据功能,您可以使用 Control Room_username 后缀创建凭据,因为这些凭据是根据正在运行的 bot 的用户上下文检索的。 如果您不创建用户定义的凭据,那么自动化 bot 凭据检索过程将检索系统凭据。
外部密钥库禁止在密钥名称中使用不同的特殊字符。 因此,您必须根据所使用的外部密钥库类型(CyberArk、AWS 和 Azure)及其特定要求,对外部密钥库中凭据(密钥)名称的某些字符进行编码。
HashiCorp 密钥命名约定
- 大写字符 (A–Z)
- 小写字符 (a–z)
- 数字 (0–9)
- 特殊字符 (+=)
对于其他特殊字符,密钥名称应使用特殊字符的 ASCII 编码值。 例如,下划线字符 (_) 必须用作 -5f-。
On-Premises 部署: 要覆盖由 Control Room 编码的默认字符,请在位于 配置目录中的 keyvault.propertiesAutomation Anywhere 文件中添加以下属性和正则表达式值。 例如,如果您不想对特殊字符进行编码,请使用以下表达式:name.encoding.characters.allowed.regex.hashicorp=^[A-Za-z0-9/_+=.@-]+$。