Ansible 加密模块 Vault

ansible-vault 只要用于配置文件加密，可以加密或解密，具体使用方式如下：

Usage: ansible-vault [create|decrypt|edit|encrypt|encrypt_string|rekey|view] [options] [vaultfile.yml]

可以看到有很多子命令：

• create: 创建一个新文件，并直接对其进行加密
• decrypt: 解密文件
• edit: 用于编辑 ansible-vault 加密过的文件
• encrypy: 加密文件
• encrypt_strin: 加密字符串，字符串从命令行获取
• view: 查看经过加密的文件

加密文件

先自己创建一个文件，写入一些内容：

[root@Ansible ~]# echo "123456" > pass.txt
[root@Ansible ~]# cat pass.txt 
123456
[root@Ansible ~]# 

然后用 ansible-vault encrypt 加密文件：

[root@Ansible ~]# ansible-vault encrypt pass.txt
New Vault password: 
Confirm New Vault password: 
Encryption successful
[root@Ansible ~]# 

这里会要求输入密码。

现在再去打开文件看看：

[root@Ansible ~]# cat pass.txt 
$ANSIBLE_VAULT;1.1;AES256
62633762393035316438663662343964656465376634393131313466313536336361333163313238
6162356161653365623961353533356264386134653830640a353531623635653337636564383763
38316636383334323533363666383963666161633332663461316338333332623434376162326265
6565623130373539330a313737646431626131336637663033656664383932393934633337383666
6334
[root@Ansible ~]# 

查看文件内容，可以用 ansible-vault view 命令：

[root@Ansible ~]# ansible-vault view pass.txt
Vault password: 
123456
[root@Ansible ~]# 

把文件还原可以用 ansible-vault decrypt 命令：

[root@Ansible ~]# ansible-vault decrypt pass.txt
Vault password: 
Decryption successful
[root@Ansible ~]# cat pass.txt 
123456
[root@Ansible ~]# 

加密配置文件

上面的演示内容只是一个小工具的单独使用，这里看看结合ansible命令的使用。
在/etc/ansible/hosts文件中新加一台主机用于测试：

host1 ansible_host=127.0.0.1 ansible_connection=local

这里加的就是本机。

然后单独创建这台主机的变量文件 /etc/ansible/host_vars/host1 ，随便写入一些变量：

---
key1: vaule1
key2: VALUE2

先来验证一下：

[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}" 
host1 | CHANGED | rc=0 >>
key1=vaule1, key2=VALUE2
[root@Ansible ~]# 

现在把配置文件加密：

[root@Ansible ~]# ansible-vault encrypt /etc/ansible/host_vars/host1 
New Vault password: 
Confirm New Vault password: 
Encryption successful
[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}" 
ERROR! Attempting to decrypt but no vault secrets found
[root@Ansible ~]# 

加密后再运行就不管用了，这里需要加一个参数 --ask-vault-pass 来提供vault加密的密码：

[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}"  --ask-vault-pass
Vault password: 
host1 | CHANGED | rc=0 >>
key1=vaule1, key2=VALUE2
[root@Ansible ~]# 

使用文件加密

之前都是直接使用密码进行加密。对我们来说，其实只是把一个密码用另一个密码加密了。在使用的时候，我们不使用原来的密码，而是使用vault的密码。
为了方便不用每次都输入密码，可以把密码写在文件中。不过直接把密码明文写在文件中总是不安全的。利用 ansible-vault 就是让我们可以把密码直接写在配置中（也可以是一个单独的配置文件），然后把有敏感信息的文件加密。这样做的好处是，整个项目所有的配置信息都是全的，包括项目中使用的密码，并且是加密的。
如果每次使用时仍然不想输入密码，也可以把vault的密码写到文件中（明文的），这样每次使用时就不是手动输入，而是让ansible自动从文件中获取这个密码。

还是重复使用之前的配置文件，先把文件进行解密：

[root@Ansible ~]# ansible-vault decrypt /etc/ansible/host_vars/host1 
Vault password: 
Decryption successful
[root@Ansible ~]# 

然后再生成文件后用文件进行加密：

[root@Ansible ~]# echo "123456" > vault-pass-file
[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}"
ERROR! Attempting to decrypt but no vault secrets found
[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}" --vault-password-file vault-pass-file
host1 | CHANGED | rc=0 >>
key1=vaule1, key2=VALUE2
[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key2={{key2}}" --ask-vault-pass
Vault password: 
host1 | CHANGED | rc=0 >>
key1=vaule1, key2=VALUE2
[root@Ansible ~]#

这里最后还试了一下使用密码 --ask-vault-pass 效果其实和使用 --vault-password-file 是一样的。一个是手动输入密码，一个是从文件中读取密码字符串。

加密变量

上面的加密方式是加密整个文件。加密后，文件中敏感的内容不敏感的内容就都看不到了，这样也很不方便。一个解决办法是把敏感的和不敏感的内容分开，写在不同的文件中，只加密敏感文件。就像之前的示例中那样。
还有一个更灵活的方式，使用 ansible-vault encrypt_string 把值进行加密。

通过文件加密

准备好用作vault认证的文件：

[root@Ansible ~]# ansible-vault encrypt_string --vault-id vault-pass-file 'ssh_pass' --name 'key3'
key3: !vault |
          $ANSIBLE_VAULT;1.1;AES256
          66613666353739356536663965336234383363373563353231353939303839313430616161336365
          6662336162386231316132633365366232363936613561650a313637643339323861626364633864
          32653666626333623961643866656235653764646333613533343231303734313862376232393734
          6563343539393264650a653438326463646364646338656339356236383537663135633935313239
          3664
Encryption successful
[root@Ansible ~]# 

参数--name，可以不写。写上后最后生成的内容就是带key的，否则只是生成值的部分，key我们也可以手动加上。

手动输入密码

如果不使用文件，而是要手动输入，可以将指定的文件名替换为prompt，这样就会让我们输入2次密码确认了：

[root@Ansible ~]# ansible-vault encrypt_string --vault-id prompt 'ssh_pass' --name 'key3'
New vault password (default): 
Confirm new vault password (default): 
key3: !vault |
          $ANSIBLE_VAULT;1.1;AES256
          30666333366265346464383165373062613165666130373066613930316364363432376336613938
          3131663337633863373539666134643661623734613330350a616661613934633335303365366266
          36363433613334386664663839346435656534373732333632303532303939383466303662396438
          3433633535333130350a323934373162356139363762383739386139333937666237613564313939
          3137
Encryption successful
[root@Ansible ~]#

加上用户标识

官方的文档如下：
https://docs.ansible.com/ansible/latest/network/getting_started/first_inventory.html#protecting-sensitive-variables-with-ansible-vault

在官方文档的示例中 --vault-id 的参数值，都是加上了用户名称表示的，加在文件名或者prompt前，用@隔开：

$ ansible-vault encrypt_string --vault-id steed@vault-pass-file 'ssh_pass' --name 'key3'
$ ansible-vault encrypt_string --vault-id steed@prompt 'ssh_pass' --name 'key3'

貌似也没什么用，但是生成的内容中会有这个用户标识。还是尽量参考官方的建议来比较好。

生成一个新的变量，将加密的值写到配置文件中：

[root@Ansible ~]# ansible-vault encrypt_string --vault-id steed@vault-pass-file 'ssh_pass' --name 'key3' >> /etc/ansible/host_vars/host1
[root@Ansible ~]# cat /etc/ansible/host_vars/host1
---
key1: vaule1
key2: VALUE2
key3: !vault |
          $ANSIBLE_VAULT;1.2;AES256;steed
          30343264386638623133383632353762356632643531643735653131663662623164303533373163
          3032646663363765386135386362376433326131333262310a366636396233653038646133336334
          62376532343064396639623835646563643663613530383739666239663565386364303931316637
          6137343936636266340a306233633039323537346332336132313766383039653565646230393662
          6332
[root@Ansible ~]# 

这里可以看到密文上一行的内容的最后，有之前加上的用户标识信息。

使用的时候，使用密码还是指定文件都可以：

[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key3={{key3}}" --vault-id vault-pass-file 
host1 | CHANGED | rc=0 >>
key1=vaule1, key3=ssh_pass
[root@Ansible ~]# ansible host1 -a "echo key1={{key1}}, key3={{key3}}" --vault-password-file vault-pass-file 
host1 | CHANGED | rc=0 >>
key1=vaule1, key3=ssh_pass
[root@Ansible ~]# 

官方文档中是用 --vault-id 来指定解密用的文件的，不过试了下 --vault-password-file 也是可以的。

其他技巧

还有一些其他的相关内容。

使用debug模块进行调试

官方的建议是使用debug模块就行调试：

To see the original value, you can use the debug module.

之前的示例就不改了，要用debug模块，简单的可以这么使用：

[root@Ansible ~]# ansible host1 -m debug -a 'var="key1,key2,key3"' --vault-password-file vault-pass-file
host1 | SUCCESS => {
    "key1,key2,key3": "('vaule1', 'VALUE2', 'ssh_pass')"
}
[root@Ansible ~]# 

设置配置文件

每次都多打一个参数也是很麻烦，在配置文件中有对应的配置项，比如配置成下面这样：

# If set, configures the path to the Vault password file as an alternative to
# specifying --vault-password-file on the command line.
vault_password_file = ~/vault_password_file

注意：配置生效后，就不能再自己加参数指定了，否则会报错。并且这个情况不只是在解密的时候，加密的时候也一样。

自动生成随机密码

网上方法有很多，我觉得用 openssl 比较方便：

$ openssl rand -base64 10
VStCUWZZ1HfVtw==
$

可以直接生成一串长一点的到文件中：

$ openssl rand -base64 128 -out vault_password_file
$ cat vault_password_file 
MGt5jsPiFSLR3AUMxiOqcFmg3emStka72Zm6oqv8oB/uxY4QzYkWVYNLYVOF2Oiq
3smsUcJJ3yhmmjOSP0Lveb+qwtJhk2wZe+T0Er4cqa3ymrRvuGrLlmips566uFfO
doAYVPdrqYrKKb5IQ3VCQeX6tBBmJh972oiyVsg8XQg=
$

防止普通用户查看加密信息

虽然配置加密了，但是如果用户要执行任务，还是需要加密的密码或者文件的读权限。有了这些，用户就可以解密配置获取密码了。

通过sudo限制用户
如果限制用户的文件读权限，则用户在执行命令的时候，会警告文件不可读。所以这条行不通：

 [WARNING]: Error in vault password file loading (default): Could not read vault password file
/home/asb/vault-pass-file: [Errno 13] Permission denied: '/home/asb/vault-pass-file'
ERROR! Could not read vault password file /home/asb/vault-pass-file: [Errno 13] Permission denied: '/home/asb/vault-pass-file'

可行的方案是使用sudo。通过sudo提权后，用户就有了访问文件的权限。但是sudo可以限制使用的命令，这样用户拥有高权限时的行为就受到了控制。只让用户可以sudo提权执行有限的命令。
注意，如果让用户可以sudo执行ansible相关的命令，那么用户只要自己用ansible调用debug模块就可以提权后，把敏感的信息打印出来。或者自己构建playbook，提权执行ansible-playbook，一样可以获取加密信息。

需要创建一个专门存放脚本的目录，让普通用户有目录的执行权限，但是不可写。sudo则是设置用户可以提权操作该目录下的所有程序。需要用户执行的ansible或者playbook命令则是写成shell脚本，由管理员设置好属组和可执行权限，放到该目录下。

sudo 配置
下面是sudo文件的相关设置，修改sudo建议使用命令visudo：

[root@Ansible ~]# visudo

# 创建一个组，哪些命令或目录可以sudo执行。这里添加了一个目录
Cmnd_Alias ANSIBLE_SCRIPT = /home/ansible/script/
# 创建一个用户组
User_Alias ANSIBLE_USERS = adam, bob, clark
# ANSIBLE_USERS的用户 可以在任何主机上 以ansible用户的身份 免密码执行 ANSIBLE_SCRIPT指定的命令
ANSIBLE_USERS ALL=(ansible) NOPASSWD:ANSIBLE_SCRIPT

# 这个设置是不必要的，不过不加的话，命令需要使用完整的路径，加上path后，就只需要加上文件名就好了
# 这个就是sudo下的$PATH变量。使用了sudo，查找命令就不是全局的$PATH变量了，而是下面设置的值
Defaults    secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/home/ansible/script

修改完成后，也是 :wq 退出。程序在退出前会进行语法检查，如果配置文件写的不对是不能保存退出的。sudo的配置修改后立即生效。