Ansible Vault Tools
A simple CLI tool and Python library to encrypt and decrypt strings and files using Ansible Vault, and to inspect decrypted host variables from an Ansible inventory.
Requirements
- Python 3.11 or newer
ansibleandansible-vaultexecutables available inPATH(provided by theansibleandansible-vaultpackages)
Installation
Install with the optional Ansible dependencies included:
pip install "ansible-vault-tools[ansible-deps]"
Or, if you manage Ansible separately:
pip install ansible-vault-tools
Usage
CLI
ansible-vault-tools <command> [options]
encrypt — encrypt a string or file
# Encrypt a string (prompts for input if omitted)
ansible-vault-tools encrypt --string "my secret"
ansible-vault-tools encrypt -s
# Encrypt a file in place
ansible-vault-tools encrypt --file secrets.yml
ansible-vault-tools encrypt -f secrets.yml
decrypt — decrypt a variable or file
# Decrypt a specific variable for a host (prompts if omitted)
ansible-vault-tools decrypt --host webserver01 --var db_password
ansible-vault-tools decrypt -H webserver01 -v db_password
# Decrypt variables for all hosts
ansible-vault-tools decrypt --host all --var db_password
# Decrypt a vault-encrypted file (shows content, then asks to write it back)
ansible-vault-tools decrypt --file secrets.yml
ansible-vault-tools decrypt -f secrets.yml
allvars — print all variables for a host
# Print all resolved variables for a specific host
ansible-vault-tools allvars --host webserver01
ansible-vault-tools allvars -H webserver01
# Print hostvars for all hosts
ansible-vault-tools allvars --host all
Library
The individual functions can also be imported directly:
from ansible_vault_tools.main import (
encrypt_string,
encrypt_file,
decrypt_string,
decrypt_file,
allvars,
)
| Function | Description |
|---|---|
encrypt_string(password) |
Encrypt a string with ansible-vault encrypt_string |
encrypt_file(filename) |
Encrypt a file in place with ansible-vault encrypt |
decrypt_string(host, var) |
Decrypt a variable from Ansible inventory host(s) |
decrypt_file(filename) |
Decrypt a vault-encrypted file |
allvars(host) |
Return all variables for a host as JSON |
License
The project is mainly licensed under Apache-2.0. It may also contain files under different licenses and copyright holders. The project is REUSE compliant so it's fully transparent.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ansible_vault_tools-0.2.6.tar.gz.
File metadata
- Download URL: ansible_vault_tools-0.2.6.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
670a560d2946b8a2406dcfa866110b2d4fbffadc4fd9ce5e917d2aba45267e08
|
|
| MD5 |
aac06a359c6b9de59cce462374059571
|
|
| BLAKE2b-256 |
981d72fff4cfe806b1bdacbe3724cf0a2f6502c347e89b3431b19023389aade5
|
Provenance
The following attestation bundles were made for ansible_vault_tools-0.2.6.tar.gz:
Publisher:
publish.yaml on mxmehl/ansible-vault-tools
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansible_vault_tools-0.2.6.tar.gz -
Subject digest:
670a560d2946b8a2406dcfa866110b2d4fbffadc4fd9ce5e917d2aba45267e08 - Sigstore transparency entry: 2437289137
- Sigstore integration time:
-
Permalink:
mxmehl/ansible-vault-tools@33eef4f689dad41188c175b6ce05d787dc7b1851 -
Branch / Tag:
refs/tags/v0.2.6 - Owner: https://github.com/mxmehl
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@33eef4f689dad41188c175b6ce05d787dc7b1851 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ansible_vault_tools-0.2.6-py3-none-any.whl.
File metadata
- Download URL: ansible_vault_tools-0.2.6-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65a5835c8f769f76ba156df675b143b26f3333cf385b28fac337d1c0e2deb472
|
|
| MD5 |
418dfaf7caec92b44951db2a70e461ee
|
|
| BLAKE2b-256 |
4b62f76865c527eb9f4e764a871882fe77240720785ecc9b587b49c15fc6dcde
|
Provenance
The following attestation bundles were made for ansible_vault_tools-0.2.6-py3-none-any.whl:
Publisher:
publish.yaml on mxmehl/ansible-vault-tools
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansible_vault_tools-0.2.6-py3-none-any.whl -
Subject digest:
65a5835c8f769f76ba156df675b143b26f3333cf385b28fac337d1c0e2deb472 - Sigstore transparency entry: 2437289274
- Sigstore integration time:
-
Permalink:
mxmehl/ansible-vault-tools@33eef4f689dad41188c175b6ce05d787dc7b1851 -
Branch / Tag:
refs/tags/v0.2.6 - Owner: https://github.com/mxmehl
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@33eef4f689dad41188c175b6ce05d787dc7b1851 -
Trigger Event:
release
-
Statement type:
