使用加密变量和文件

运行使用加密变量或文件的任务或 playbook 时，必须提供用于解密变量或文件的密码。这可以通过命令行完成，也可以通过在配置选项或环境变量中设置默认密码来源来完成。

传递单个密码

如果任务或 playbook 中所有加密变量和文件都需要使用单个密码，则可以使用 --ask-vault-pass 或 --vault-password-file 命令行选项。

提示输入密码

ansible-playbook --ask-vault-pass site.yml

从 /path/to/my/vault-password-file 文件中检索密码

ansible-playbook --vault-password-file /path/to/my/vault-password-file site.yml

从 vault 密码客户端脚本 my-vault-password-client.py 获取密码

ansible-playbook --vault-password-file my-vault-password-client.py

传递 vault ID

也可以使用 --vault-id 选项来传递带有其 vault 标签的单个密码。当单个清单中使用多个 vault 时，这种方法更清晰。

提示输入 “dev” vault ID 的密码

ansible-playbook --vault-id dev@prompt site.yml

从 dev-password 文件中检索 “dev” vault ID 的密码

ansible-playbook --vault-id dev@dev-password site.yml

从 vault 密码客户端脚本 my-vault-password-client.py 获取 “dev” vault ID 的密码

ansible-playbook --vault-id [email protected]

传递多个 vault 密码

如果任务或 playbook 需要多个使用不同 vault ID 加密的加密变量或文件，则必须使用 --vault-id 选项，传递多个 --vault-id 选项来指定 vault ID（“dev”、“prod”、“cloud”、“db”）和密码来源（提示、文件、脚本）。例如，要使用从文件中读取的 “dev” 密码并提示输入 “prod” 密码

ansible-playbook --vault-id dev@dev-password --vault-id prod@prompt site.yml

默认情况下，vault ID 标签（dev、prod 等）只是提示。Ansible 会尝试使用每个密码解密 vault 内容。与加密数据标签相同的密码将首先尝试，之后，每个 vault 密钥将按它们在命令行中提供的顺序尝试。

如果加密数据没有标签，或者标签与任何提供的标签都不匹配，则将按指定的顺序尝试密码。在上面的示例中，将首先尝试 “dev” 密码，然后尝试 “prod” 密码，用于 Ansible 不知道使用哪个 vault ID 加密某些内容的情况。

使用 `--vault-id` 但不指定 vault ID

--vault-id 选项也可以不指定 vault-id 使用。此行为等效于 --ask-vault-pass 或 --vault-password-file，因此很少使用。

例如，使用密码文件 dev-password

ansible-playbook --vault-id dev-password site.yml

提示输入密码

ansible-playbook --vault-id @prompt site.yml

从可执行脚本 my-vault-password-client.py 获取密码

ansible-playbook --vault-id my-vault-password-client.py

配置使用加密内容的默认值

设置默认 vault ID

如果比其他任何 vault ID 更频繁地使用一个 vault ID，则可以将配置选项 DEFAULT_VAULT_IDENTITY_LIST 设置为指定默认 vault ID 和密码来源。在未指定 --vault-id 时，Ansible 将使用默认 vault ID 和来源。可以为此选项设置多个值。设置多个值等效于传递多个 --vault-id 命令行选项。

设置默认密码来源

如果不想在命令行上提供密码文件，或者比其他任何 vault 密码文件更频繁地使用一个 vault 密码文件，则可以设置 DEFAULT_VAULT_PASSWORD_FILE 配置选项或 ANSIBLE_VAULT_PASSWORD_FILE 环境变量来指定要使用的默认文件。例如，如果设置 ANSIBLE_VAULT_PASSWORD_FILE=~/.vault_pass.txt，Ansible 将自动在该文件中搜索密码。这在例如从 Jenkins 等持续集成系统使用 Ansible 时非常有用。

引用的文件可以是包含密码（纯文本）的文件，也可以是返回密码的脚本（已设置可执行权限）。

何时显示加密文件？

通常情况下，使用 Ansible Vault 加密的内容在执行后仍然保持加密状态。但是，有一个例外。如果将加密文件作为 src 参数传递给 copy、template、unarchive、script 或 assemble 模块，则该文件不会在目标主机上加密（假设在运行 play 时提供了正确的 vault 密码）。此行为是预期的且有用的。可以加密配置文件或模板以避免共享配置详细信息，但在将该配置复制到环境中的服务器时，需要对其进行解密，以便本地用户和进程可以访问它。

使用 Ansible Vault 加密的文件格式

Ansible Vault 创建 UTF-8 编码的 txt 文件。文件格式包括以换行符结尾的标题。例如

$ANSIBLE_VAULT;1.1;AES256

或

$ANSIBLE_VAULT;1.2;AES256;vault-id-label

标题包含最多四个元素，用分号 (;) 分隔。

格式 ID ($ANSIBLE_VAULT)。目前 $ANSIBLE_VAULT 是唯一有效的格式 ID。格式 ID 用于标识使用 Ansible Vault 加密的内容 (使用 vault.is_encrypted_file())。

保管库格式版本（1.X）。所有受支持的 Ansible 版本目前在提供标记的保管库 ID 时将默认为“1.1”或“1.2”。“1.0”格式仅支持读取（写入时会自动转换为“1.1”格式）。格式版本目前仅用作精确字符串比较（版本号目前不进行“比较”）。

用于加密数据的密码算法（AES256）。目前AES256是唯一支持的密码算法。保管库格式 1.0 使用“AES”，但当前代码始终使用“AES256”。

用于加密数据的保管库 ID 标签（可选，vault-id-label）例如，如果使用--vault-id dev@prompt加密文件，则保管库 ID 标签为dev。

注意：将来，标题可能会更改。格式 ID 和格式版本之后的字段取决于格式版本。未来的保管库格式版本可能会添加更多密码算法选项和/或其他字段。

文件的其余内容是“vaulttext”。vaulttext 是加密密文的文本装甲版本。每行 80 个字符宽，最后一行的长度可能较短。

Ansible 保管库有效负载格式 1.1 - 1.2

vaulttext 是密文和 SHA256 摘要的串联，结果“进行了十六进制转换”。

“十六进制转换”指的是 Python 标准库的binascii 模块的hexlify()方法。

经过十六进制转换的结果为：

盐的十六进制转换字符串，后跟换行符（0x0a）
加密 HMAC 的十六进制转换字符串，后跟换行符。HMAC 是
- 一个RFC2104 风格的 HMAC
  - 输入是：
    - AES256 加密的密文
    - PBKDF2 密钥。此密钥、密码密钥和密码 IV 由以下内容生成：
      - 盐（以字节为单位）
      - 10000 次迭代
      - SHA256() 算法
      - 前 32 个字节是密码密钥
      - 接下来的 32 个字节是 HMAC 密钥
      - 其余 16 个字节是密码 IV
密文的十六进制转换字符串。密文是

AES256 加密的数据。数据使用以下方式加密：

AES-CTR 流密码

密码密钥

IV

一个从整数 IV 播种的 128 位计数器块

明文

原始明文

填充到 AES256 块大小。（用于填充的数据基于RFC5652）