Ansible KeePass Lookup Plugin

Perhaps, from a security view point, this solution is the same as ansible-vault. Just if you are storing secrets data in KeePass, then why not use it, instead of duplicating to ansible-vault.

Installation

Dependency: pykeepass==3.2.1

pip install 'pykeepass==3.2.1' --user
mkdir -p ~/.ansible/plugins/lookup && cd "$_"
curl https://raw.githubusercontent.com/viczem/ansible-keepass/master/keepass.py -o ./keepass.py

More about ansible plugins installation

Variables

• keepass_dbx - path to KeePass file
• keepass_psw - password. [optional] if the socket is used
• keepass_key - [optional] path to keyfile

Usage

For global variables define them once in group_vars/all.

For security reasons, do not store KeePass password in plain text. Use ansible-vault encrypt_string to encrypt the password. I'm not sure, but I think that for simplicity, it is safe to use the same ansible-vault password as KeePass password. To decrypt the passwod use --ask-vault-pass e.g. ansible all -m ping --ask-vault-pass.

# file: group_vars/all

keepass_dbx: "~/.keepass/database.kdbx"
keepass_psw: !vault |
      $ANSIBLE_VAULT;1.1;AES256
      ...

Alternative usage with UNIX socket

This usage is more preferred for performance reason, because of KeePass file stay decrypted and not need to reopen after done each playbook task (see the issue for more info)

In this case, there is no need to enter a password for KeePass each time Ansible is called. Run socket by the command and after that enter a password to make to open KeePass file.

Supported only Python 3

python3 kpsock.py ~/.keepass/database.kdbx

The command will creates UNIX socket in a system temp directory. Only one socket

WARNING: The KeePass file and password are stay decrypted in memory while the socket is open.

The socket timeout is 1 minute since past access (will be closed automatically when not used). To change timeout use --ttl argument. For logging requests in a file use --log (default --log-level is INFO).

For help python kpsock.py --help

To send the running command in background press CTRL+Z and execute bg (fg to get the job into the foreground again).

Example

Define variables you need e.g. in any file in group_vars

ansible_user             : "{{ lookup('keepass', 'path/to/entry', 'username') }}"
ansible_become_pass      : "{{ lookup('keepass', 'path/to/entry', 'password') }}"
ansible_custom_field     : "{{ lookup('keepass', 'path/to/entry', 'custom_field_property', true) }}"
ansible_all_custom_fields: "{{ lookup('keepass', 'path/to/entry', '*', true) }}"

You can get another properties of an KeePass entry (not only username or password)

Specify a boolean value of true to use custom field properties

ansible-doc -t lookup keepass - to get description of the plugin