管理库密码
如果您为管理库密码制定策略,则管理加密内容会更容易。库密码可以是您选择的任何字符串。没有创建库密码的特殊命令。但是,您需要跟踪您的库密码。每次使用 Ansible Vault 加密变量或文件时,您都必须提供密码。当您在命令或剧本中使用加密的变量或文件时,您必须提供与用于加密它的密码相同的密码。要制定管理库密码的策略,请从两个问题开始
您是否希望使用相同的密码加密所有内容,或者使用不同的密码满足不同的需求?
您希望将密码存储在哪里?
在单个密码和多个密码之间进行选择
如果您有一个小型团队或很少的敏感值,您可以使用单个密码加密所有使用 Ansible Vault 加密的内容。按照下面介绍的方式将库密码安全地存储在文件或秘密管理器中。
如果您有一个较大的团队或许多敏感值,您可以使用多个密码。例如,您可以为不同的用户或不同的访问级别使用不同的密码。根据您的需要,您可能希望为每个加密文件、每个目录或每个环境使用不同的密码。您的剧本可能包含两个 vars 文件,一个用于开发环境,另一个用于生产环境,它们使用两个不同的密码进行加密。运行剧本时,您可以使用库 ID 选择目标环境的正确库密码。
使用库 ID 管理多个密码
如果您使用多个库密码,您可以使用库 ID 区分一个密码与另一个密码。您可以通过三种方式使用库 ID
在创建加密内容时,将其与
--vault-id
传递给 ansible-vault 命令将其包含在您存储该库 ID 密码的任何位置(参见 存储和访问库密码)
在运行使用使用该库 ID 加密的内容的剧本时,将其与
--vault-id
传递给 ansible-playbook 命令
将库 ID 作为选项传递给 ansible-vault 命令时,您会向加密内容添加一个标签(提示或昵称)。此标签记录您使用哪个密码对其进行加密。加密的变量或文件在标头中以纯文本形式包含库 ID 标签。库 ID 是加密内容之前的最后一个元素。例如
my_encrypted_var: !vault | $ANSIBLE_VAULT;1.2;AES256;dev 30613233633461343837653833666333643061636561303338373661313838333565653635353162 3263363434623733343538653462613064333634333464660a663633623939393439316636633863 61636237636537333938306331383339353265363239643939666639386530626330633337633833 6664656334373166630a363736393262666465663432613932613036303963343263623137386239 6330
除了标签之外,您还必须提供相关密码的来源。来源可以是提示、文件或脚本,具体取决于您如何存储库密码。模式如下
--vault-id label@source
如果您的剧本使用多个加密的变量或文件,这些文件使用不同的密码进行加密,则必须在运行该剧本时传递库 ID。您可以单独使用 --vault-id
,也可以与 --vault-password-file
或 --ask-vault-pass
一起使用。模式与创建加密内容时相同:包含标签和匹配密码的来源。
请参见以下使用库 ID 加密内容和使用使用库 ID 加密的示例。 --vault-id
选项适用于与库交互的任何 Ansible 命令,包括 ansible-vault、ansible-playbook 等等。
库 ID 的限制
Ansible 不会强制在每次使用特定库 ID 标签时都使用相同的密码。您可以使用相同的库 ID 标签但不同的密码加密不同的变量或文件。当您在提示符处键入密码并犯错时,通常会发生这种情况。可以使用不同的密码和相同的库 ID 标签来实现特定目的。例如,您可以将每个标签用作对密码类别而不是单个密码的引用。在这种情况下,您必须始终了解在上下文中使用哪个特定密码或文件。但是,您更有可能意外地使用相同的库 ID 标签和不同的密码加密两个文件。如果意外地使用相同的标签但不同的密码加密了两个文件,您可以 重新加锁 一个文件以解决此问题。
强制执行库 ID 匹配
默认情况下,库 ID 标签只是一个提示,用于提醒您使用哪个密码加密变量或文件。Ansible 不会检查加密内容标头中的库 ID 是否与您使用 --vault-id
提供的库 ID 相匹配。Ansible 会解密由您的命令或剧本调用的所有文件和变量,这些文件和变量使用您提供的密码进行加密。要检查加密内容并仅在其中包含的库 ID 与您使用 --vault-id
提供的库 ID 相匹配时才解密它,请设置配置选项 DEFAULT_VAULT_ID_MATCH。当您设置 DEFAULT_VAULT_ID_MATCH 时,每个密码仅用于解密使用相同标签加密的数据。这既高效又可预测,并且可以减少使用不同的密码对不同的值进行加密时发生的错误。
注意
即使启用了 DEFAULT_VAULT_ID_MATCH 设置,Ansible 也不会强制在每次使用特定库 ID 标签时都使用相同的密码。
存储和访问库密码
您可以记住库密码,也可以手动从任何来源复制库密码并将其粘贴到命令行提示符处,但大多数用户会将其安全地存储并在需要时从 Ansible 内部访问它们。您有两种在 Ansible 内部使用的存储库密码的选项:存储在文件或第三方工具(如系统密钥环或秘密管理器)中。如果将密码存储在第三方工具中,则需要库密码客户端脚本从 Ansible 内部检索它们。
将密码存储在文件中
要将库密码存储在文件中,请在文件中将密码作为字符串输入到单行上。确保文件上的权限适当。不要将密码文件添加到源代码控制中。
运行使用存储在文件中的库密码的剧本时,请在 --vault-password-file
标志中指定该文件。例如
ansible-playbook --extra-vars @secrets.enc --vault-password-file secrets.pass
使用库密码客户端脚本将密码存储在第三方工具中
您可以将库密码存储在系统密钥环、数据库或秘密管理器中,并使用库密码客户端脚本从 Ansible 内部检索它们。将密码作为字符串输入到单行上。如果您的密码有库 ID,请以适合您的密码存储工具的方式存储它。
要创建库密码客户端脚本
创建一个文件名以
-client
或-client.EXTENSION
结尾的文件。使文件可执行。
- 在脚本本身内部
将密码打印到标准输出。
接受
--vault-id
选项。如果脚本提示输入数据(例如,数据库密码),则将提示显示在 TTY 上。
当你运行一个使用存储在第三方工具中的保管库密码的剧本时,请在 --vault-id
标志中指定脚本作为源。例如
ansible-playbook --vault-id dev@contrib-scripts/vault/vault-keyring-client.py
Ansible 使用 --vault-id
选项执行客户端脚本,以便脚本知道你指定的保管库 ID 标签。例如,从秘密管理器加载密码的脚本可以使用保管库 ID 标签来选择“dev”或“prod”密码。上面的示例命令导致以下客户端脚本执行
contrib-scripts/vault/vault-keyring-client.py --vault-id dev
有关从系统密钥环加载密码的客户端脚本示例,请参阅 vault-keyring-client 脚本。