Vault
Volant 如何读取 Ansible Vault 数据,从哪里获取密码,以及为什么密码永远不会离开控制节点进程。
Volant 读取和写入 ansible-core 2.19.12 的 vault 1.1 和 1.2 格式。结果、错误消息和退出码都与 ansible-core 一致。
密码从哪里来
Section titled “密码从哪里来”| 来源 | 说明 |
|---|---|
-J、--ask-vault-pass |
在终端中询问,不回显。 |
--vault-password-file、--vault-pass-file |
一个文件,或一个会打印密码的可执行文件。可重复使用。 |
--vault-id LABEL@SOURCE |
来源是文件、可执行文件或 prompt。可重复使用。 |
[defaults] vault_password_file、vault_identity_list |
同上,来自 ansible.cfg。 |
ANSIBLE_VAULT_PASSWORD_FILE、ANSIBLE_VAULT_IDENTITY_LIST |
同上,来自环境变量。 |
每个密码都会对每个 vault 加密的值逐一尝试,不论其标签是什么。
- playbook 或变量文件中的内联
!vault值。它们作为密文加载,在模板读取时解密。解密后的值保留 ansible-core 赋予它的信任级别。 - 整个 vault 加密的文件:
vars_files、include_vars、group_vars和host_vars文件。无法读取的 vault 文件会失败,消息与 ansible-core 一致。 vault和unvault过滤器、vault_encrypted和vaulted_file测试器,以及unvaultlookup。copy、template和script的 vault 加密src,以及unarchive的 vault 加密归档。运行会在插件读取之前,把它解密到一个私有的临时目录中。copy或unarchive上的decrypt: false会保留密文。
任何机密都打不开的 !vault 值,会让读取它的 task 失败,并附上 ansible-core 打印的三个块。debug: var=x 以退出码 2 结束,原因指向写下该值的那一行。is vault_encrypted 针对当前主机的变量应答。
机密留在控制节点
Section titled “机密留在控制节点”vault 密码以内存形式存在于控制节点进程中。它永远不会被写入命令行、子进程的环境变量、日志、结果或 agent 链路。连接密码和提权密码遵循同样的规则,SSH 密码如何到达 ssh,见连接。
在 Python 中运行的过滤器、测试器和 lookup 永远看不到 vault 密码。vault 相关的那些正是出于这个原因在控制节点进程中运行。见需要 Python 的过滤器、测试器和 lookup。
从受管主机返回的值永远不会用这次运行的机密解密,也永远不会再次作为模板渲染。见来自主机的值绝不会被当作模板。
加密和查看文件
Section titled “加密和查看文件”volant vault encrypt、decrypt 和 view 处理的文件与 ansible-vault 相同:一方加密的文件,另一方可以读取,无论是默认 id 还是带标签的 id。
encrypt把每个文件替换为它的 vault 文本,decrypt则替换为明文。两者都把结果留成0600权限,且不打印任何内容;在终端上,它们会在标准错误输出写出Encryption successful或Decryption successful。没有结尾换行的文件,还原后同样没有。- 默认 id 的头部是
$ANSIBLE_VAULT;1.1;AES256,其他 id 是$ANSIBLE_VAULT;1.2;AES256;LABEL。--vault-id LABEL@SOURCE设置标签。给出多个--vault-id时,由--encrypt-vault-id(或vault_encrypt_identity、ANSIBLE_VAULT_ENCRYPT_IDENTITY)选出用于加密的那个;不给的话,命令以退出码 5 结束。 --output FILE写到该处并保持源文件不变,--output -写到标准输出,不给文件名或给-则读取标准输入。view打印每个文件的明文。在终端上它经过分页器:先看PAGER,再看ANSIBLE_PAGER,再看[defaults] pager,最后是less。- 没有任何密码来源时,命令会询问密码。
encrypt会问两次,分别是New Vault password:和Confirm New Vault password:。 -v打印正在使用的配置文件,-vv打印版本。-vvvv的额外几行不会打印。
创建、编辑和更换文件密钥
Section titled “创建、编辑和更换文件密钥”volant vault create、edit 和 rekey 处理的文件与 ansible-vault 相同。
create接受一个文件名。除非标准输出是终端或给出了--skip-tty-check,否则它以退出码 5 拒绝;文件已存在时以退出码 1 拒绝。缺失的目录会被创建,并给出警告。编辑器可以把文件留空:结果是一个有效的 vault 文件,内容是空文本。edit解密每个文件,打开编辑器,并用打开该文件的密钥和它原有的标签加密结果。文本没有变化时,不会重写文件。被修改的文件保持原有权限。- 编辑器取自
EDITOR,否则ANSIBLE_EDITOR,否则[defaults] editor,否则vi,按 shell 的方式拆分成词,再加上文件名。与 ansible-vault 一样,不检查它的退出状态。 - 编辑器操作的是
ANSIBLE_LOCAL_TEMP([defaults] local_tmp,否则~/.ansible/tmp)下私有目录中权限为0600的副本。无论以何种方式退出,包括编辑器失败以及 SIGTERM 或 SIGHUP,副本都会被覆盖并删除。Ctrl-C 会交给编辑器。 rekey用旧密钥解密每个文件,再用新密钥写回,保持其权限。新密钥来自--new-vault-password-file、--new-vault-id LABEL@SOURCE,或提示New Vault password:和Confirm New Vault password:。无论标准输出是什么,它都在标准错误输出打印Rekey successful。
volant vault encrypt_string 把一个值变成可放入变量文件的 !vault | 块。密文的每一行缩进十个空格,每个块以换行结束:
mykey: !vault | $ANSIBLE_VAULT;1.1;AES256 66313561363937653234366564623639...-n NAME为位于同一位置的字符串命名,--stdin-name NAME为标准输入命名。没有名称时,块以!vault |开头。--vault-id LABEL@SOURCE会给出带标签的1.2头部。- 没有字符串,或给出
-时,从标准输入读取文本直到结尾。空输入以退出码 5 结束。 - 字符串多于一个时,标准错误输出为每个字符串打印一行注释,名称少于字符串时还会有一条提示。标准输出只包含这些块。
-p先询问变量名,再询问字符串;除非给出--show-input,否则不会回显字符串。它不能与读取标准输入同时使用。- 在终端上,
Encryption successful会在这些块之前输出到标准错误输出。 --output FILE把这些块写入文件,权限为0600。
vault过滤器的wrap_object参数会被拒绝,提示尚不支持。它的salt参数与 Ansible 一致:相同的 salt 总是得到相同的文本。- 在
-vvvvv下,vault view、decrypt和rekey不会输出 ansible-core 对每个所试 secret 的跟踪信息(Trying secret FileVaultSecret(...) for vault_id=...)。尝试 secret 的顺序相同。
命令行页面列出了这些选项。