# vault2vault
Like
[`ansible-vault rekey`](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html#rekey)
but works recursively on encrypted files and in-line variables
[](https://github.com/enpaul/vault2vault/actions)
[](https://pypi.org/project/vault2vault/)
[](https://opensource.org/licenses/MIT)
[](https://www.python.org)
[](https://github.com/psf/black)
⚠️ **This project is beta software and is under active development** ⚠️
- [What is this?](#what-is-this)
- [Installing](#installing)
- [Usage](#usage)
- [Recovering from a failed migration](#recovering-from-a-failed-migration)
- [Roadmap](#roadmap)
- [Developing](#developer-documentation)
## What is this?
If you use [Ansible Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html)
then you may have encountered the problem of needing to roll your vault password. Maybe
you found it written down on a sticky note, maybe a coworker who knows it left the
company, maybe you accidentally typed it into Slack when you thought the focus was on your
terminal. Whatever, these things happen.
The built-in tool Ansible provides,
[`ansible-vault rekey`](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html#rekey),
suffers from two main drawbacks: first, it only works on vault encrypted files and not on
vault encrypted YAML data; and second, it only works on a single vault encrypted file at a
time. To rekey everything in a large project you'd need to write a script that recursively
goes through every file and rekeys every encrypted file and YAML variable all at once.
This is that script.
## Installing
If you're using [Poetry](https://python-poetry.org/) or
[Pipenv](https://pipenv.pypa.io/en/latest/) to manage your Ansible runtime environment,
you can just add `vault2vault` to that same environment:
```
# using poetry
poetry add vault2vault --dev
# using pipenv
pipenv install vault2vault
```
If you're using Ansible from your system package manager, it's probably easier to just
install `vault2vault` using [PipX](https://pypa.github.io/pipx/) and the `ansible` extra:
```
pipx install vault2vault[ansible]
```
> Note: vault2vault requires an Ansible installation to function. If you are installing to
> a standalone virtual environment (like with PipX) then you must install it with the
> `ansible` extra to ensure a version of Ansible is available to the application.\*\*
## Usage
> Note: the full command reference is available by running `vault2vault --help`
Vault2Vault works with files in any arbitrary directory structures, so there is no need to
have your Ansible project(s) structured in a specific way for the tool to work. The
simplest usage of Vault2Vault is by passing the path to your Ansible project directory to
the command:
```bash
vault2vault ./my-ansible-project/
```
The tool will prompt for the current vault password and the new vault password and then
process every file under the provided path. You can also specify multiple paths and
they'll all be processed together:
```bash
vault2vault \
./my-ansible-project/playbooks/ \
./my-ansible-project/host_vars/ \
./my-ansible-project/group_vars/
```
To skip the interactive password prompts you can put the password in a file and have the
tool read it in at runtime. The `--old-pass-file` and `--new-pass-file` parameters work
the same way as the `--vault-password-file` option from the `ansible` command:
```bash
vault2vault ./my-ansible-project/ \
--old-pass-file=./oldpass.txt \
--new-pass-file=./newpass.txt
```
If you use multiple vault passwords in your project and want to roll them you'll need to
run `vault2vault` once for each password you want to change. By default, `vault2vault`
will fail with an error if it encounters vaulted data that it cannot decrypt with the
provided current vault password. To change this behavior and instead just ignore any
vaulted data that can't be decrypted (like, for example, if you have data encrypted with
multiple vault passwords) you can pass the `--ignore-undecryptable` flag to turn the
errors into warnings.
> Please report any bugs or issues you encounter on
> [Github](https://github.com/enpaul/vault2vault/issues).
### Recovering from a failed migration
This tool is still pretty early in it's development, and to be honest it hooks into
Ansible's functionality in some fragile ways. I've tested as best I can to ensure it
covers as many edge cases as possible, but there is still the chance that you might get
partway through a password migration and then have the tool fail out, leaving half of your
data successfully rekeyed and the other half not.
In the spirit of the
[Unix philosophy](https://hackaday.com/2018/09/10/doing-one-thing-well-the-unix-philosophy/)
this tool does not include any built-in way to recover from this state. However, it can be
done very effectively using a version control tool.
If you are using Git to track your project files then you can use the command
`git reset --hard` to restore all files to the state of the currently checked out commit.
This does have the side effect of erasing any other un-committed work in the repository,
so it's recommended to always have a clean working tree when using Vault2Vault.
If you are not using a version control system to track your project files then you can
create a temporary Git repository to use in the event of a migration failure:
```bash
cd my-project/
# Initialize the new repository
git init
# Add and commit all your existing files to the git tree
git add .
git commit -m "initial commit"
# Run vault migrations
vault2vault ...
# If no recovery is necessary, delete the git repository data
rm -rf .git
```
## Roadmap
This project is considered feature complete as of the
[0.1.1](https://github.com/enpaul/vault2vault/releases/tag/0.1.1) release. As a result the
roadmap focuses on stability and user experience ahead of a 1.0 release.
- [ ] Reimplement core vaulted data processing function to enable multithreading
- [ ] Implement multithreading for performance in large environments
- [ ] Add unit tests
- [ ] Add integration tests
- [ ] Redesign logging messages to improve clarity and consistency
## Developer Documentation
All project contributors and participants are expected to adhere to the
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md)
([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
The `devel` branch has the latest (and potentially unstable) changes. The stable releases
are tracked on [Github](https://github.com/enpaul/vault2vault/releases),
[PyPi](https://pypi.org/project/vault2vault/#history), and in the
[Changelog](CHANGELOG.md).
- To report a bug, request a feature, or ask for assistance, please
[open an issue on the Github repository](https://github.com/enpaul/vault2vault/issues/new).
- To report a security concern or code of conduct violation, please contact the project
author directly at **me \[at\] enp dot one**.
- To submit an update, please
[fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo)
and [open a pull request](https://github.com/enpaul/vault2vault/compare).
Developing this project requires [Python 3.7+](https://www.python.org/downloads/) and
[Poetry 1.0](https://python-poetry.org/docs/#installation) or later. GNU Make can
optionally be used to quickly setup a local development environment, but this is not
required.
To setup a local development environment:
```bash
# Clone the repository...
# ...over HTTPS
git clone https://github.com/enpaul/vault2vault.git
# ...over SSH
git clone git@github.com:enpaul/vault2vault.git
cd vault2vault/
# Create and configure the local development environment...
make dev
# Run tests and CI locally...
make test
# See additional make targets
make help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/enpaul/vault2vault/",
"name": "vault2vault",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "ansible,vault,playbook,yaml,password",
"author": "Ethan Paul",
"author_email": "24588726+enpaul@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/2c/72/98cf9b6d58e184a0a83a63ae0cfb33b3ad729d82321d05d8661c81d9ed80/vault2vault-0.1.3.tar.gz",
"platform": null,
"description": "# vault2vault\n\nLike\n[`ansible-vault rekey`](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html#rekey)\nbut works recursively on encrypted files and in-line variables\n\n[](https://github.com/enpaul/vault2vault/actions)\n[](https://pypi.org/project/vault2vault/)\n[](https://opensource.org/licenses/MIT)\n[](https://www.python.org)\n[](https://github.com/psf/black)\n\n\u26a0\ufe0f **This project is beta software and is under active development** \u26a0\ufe0f\n\n- [What is this?](#what-is-this)\n- [Installing](#installing)\n- [Usage](#usage)\n - [Recovering from a failed migration](#recovering-from-a-failed-migration)\n- [Roadmap](#roadmap)\n- [Developing](#developer-documentation)\n\n## What is this?\n\nIf you use [Ansible Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html)\nthen you may have encountered the problem of needing to roll your vault password. Maybe\nyou found it written down on a sticky note, maybe a coworker who knows it left the\ncompany, maybe you accidentally typed it into Slack when you thought the focus was on your\nterminal. Whatever, these things happen.\n\nThe built-in tool Ansible provides,\n[`ansible-vault rekey`](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html#rekey),\nsuffers from two main drawbacks: first, it only works on vault encrypted files and not on\nvault encrypted YAML data; and second, it only works on a single vault encrypted file at a\ntime. To rekey everything in a large project you'd need to write a script that recursively\ngoes through every file and rekeys every encrypted file and YAML variable all at once.\n\nThis is that script.\n\n## Installing\n\nIf you're using [Poetry](https://python-poetry.org/) or\n[Pipenv](https://pipenv.pypa.io/en/latest/) to manage your Ansible runtime environment,\nyou can just add `vault2vault` to that same environment:\n\n```\n# using poetry\npoetry add vault2vault --dev\n\n# using pipenv\npipenv install vault2vault\n```\n\nIf you're using Ansible from your system package manager, it's probably easier to just\ninstall `vault2vault` using [PipX](https://pypa.github.io/pipx/) and the `ansible` extra:\n\n```\npipx install vault2vault[ansible]\n```\n\n> Note: vault2vault requires an Ansible installation to function. If you are installing to\n> a standalone virtual environment (like with PipX) then you must install it with the\n> `ansible` extra to ensure a version of Ansible is available to the application.\\*\\*\n\n## Usage\n\n> Note: the full command reference is available by running `vault2vault --help`\n\nVault2Vault works with files in any arbitrary directory structures, so there is no need to\nhave your Ansible project(s) structured in a specific way for the tool to work. The\nsimplest usage of Vault2Vault is by passing the path to your Ansible project directory to\nthe command:\n\n```bash\nvault2vault ./my-ansible-project/\n```\n\nThe tool will prompt for the current vault password and the new vault password and then\nprocess every file under the provided path. You can also specify multiple paths and\nthey'll all be processed together:\n\n```bash\nvault2vault \\\n ./my-ansible-project/playbooks/ \\\n ./my-ansible-project/host_vars/ \\\n ./my-ansible-project/group_vars/\n```\n\nTo skip the interactive password prompts you can put the password in a file and have the\ntool read it in at runtime. The `--old-pass-file` and `--new-pass-file` parameters work\nthe same way as the `--vault-password-file` option from the `ansible` command:\n\n```bash\nvault2vault ./my-ansible-project/ \\\n --old-pass-file=./oldpass.txt \\\n --new-pass-file=./newpass.txt\n```\n\nIf you use multiple vault passwords in your project and want to roll them you'll need to\nrun `vault2vault` once for each password you want to change. By default, `vault2vault`\nwill fail with an error if it encounters vaulted data that it cannot decrypt with the\nprovided current vault password. To change this behavior and instead just ignore any\nvaulted data that can't be decrypted (like, for example, if you have data encrypted with\nmultiple vault passwords) you can pass the `--ignore-undecryptable` flag to turn the\nerrors into warnings.\n\n> Please report any bugs or issues you encounter on\n> [Github](https://github.com/enpaul/vault2vault/issues).\n\n### Recovering from a failed migration\n\nThis tool is still pretty early in it's development, and to be honest it hooks into\nAnsible's functionality in some fragile ways. I've tested as best I can to ensure it\ncovers as many edge cases as possible, but there is still the chance that you might get\npartway through a password migration and then have the tool fail out, leaving half of your\ndata successfully rekeyed and the other half not.\n\nIn the spirit of the\n[Unix philosophy](https://hackaday.com/2018/09/10/doing-one-thing-well-the-unix-philosophy/)\nthis tool does not include any built-in way to recover from this state. However, it can be\ndone very effectively using a version control tool.\n\nIf you are using Git to track your project files then you can use the command\n`git reset --hard` to restore all files to the state of the currently checked out commit.\nThis does have the side effect of erasing any other un-committed work in the repository,\nso it's recommended to always have a clean working tree when using Vault2Vault.\n\nIf you are not using a version control system to track your project files then you can\ncreate a temporary Git repository to use in the event of a migration failure:\n\n```bash\ncd my-project/\n\n# Initialize the new repository\ngit init\n\n# Add and commit all your existing files to the git tree\ngit add .\ngit commit -m \"initial commit\"\n\n# Run vault migrations\nvault2vault ...\n\n# If no recovery is necessary, delete the git repository data\nrm -rf .git\n```\n\n## Roadmap\n\nThis project is considered feature complete as of the\n[0.1.1](https://github.com/enpaul/vault2vault/releases/tag/0.1.1) release. As a result the\nroadmap focuses on stability and user experience ahead of a 1.0 release.\n\n- [ ] Reimplement core vaulted data processing function to enable multithreading\n- [ ] Implement multithreading for performance in large environments\n- [ ] Add unit tests\n- [ ] Add integration tests\n- [ ] Redesign logging messages to improve clarity and consistency\n\n## Developer Documentation\n\nAll project contributors and participants are expected to adhere to the\n[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md)\n([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).\n\nThe `devel` branch has the latest (and potentially unstable) changes. The stable releases\nare tracked on [Github](https://github.com/enpaul/vault2vault/releases),\n[PyPi](https://pypi.org/project/vault2vault/#history), and in the\n[Changelog](CHANGELOG.md).\n\n- To report a bug, request a feature, or ask for assistance, please\n [open an issue on the Github repository](https://github.com/enpaul/vault2vault/issues/new).\n- To report a security concern or code of conduct violation, please contact the project\n author directly at **\u200cme \\[at\u200c\\] enp dot\u200e \u200cone**.\n- To submit an update, please\n [fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo)\n and [open a pull request](https://github.com/enpaul/vault2vault/compare).\n\nDeveloping this project requires [Python 3.7+](https://www.python.org/downloads/) and\n[Poetry 1.0](https://python-poetry.org/docs/#installation) or later. GNU Make can\noptionally be used to quickly setup a local development environment, but this is not\nrequired.\n\nTo setup a local development environment:\n\n```bash\n# Clone the repository...\n# ...over HTTPS\ngit clone https://github.com/enpaul/vault2vault.git\n# ...over SSH\ngit clone git@github.com:enpaul/vault2vault.git\n\ncd vault2vault/\n\n# Create and configure the local development environment...\nmake dev\n\n# Run tests and CI locally...\nmake test\n\n# See additional make targets\nmake help\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Recursively rekey ansible-vault encrypted files and in-line variables",
"version": "0.1.3",
"split_keywords": [
"ansible",
"vault",
"playbook",
"yaml",
"password"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05fb26c44192fc3fca01089b580a4754963174fc60bd0b0312131e672ca9f4ba",
"md5": "64d75a56f036a73dc9e2213d268e6804",
"sha256": "33016ce995cf2efca7229b010f4099177be1ccd9ffd0beba41ac8003c0906ac6"
},
"downloads": -1,
"filename": "vault2vault-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64d75a56f036a73dc9e2213d268e6804",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 11384,
"upload_time": "2023-04-03T16:02:03",
"upload_time_iso_8601": "2023-04-03T16:02:03.383876Z",
"url": "https://files.pythonhosted.org/packages/05/fb/26c44192fc3fca01089b580a4754963174fc60bd0b0312131e672ca9f4ba/vault2vault-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c7298cf9b6d58e184a0a83a63ae0cfb33b3ad729d82321d05d8661c81d9ed80",
"md5": "4e47635b4c6bce5d5da03299e7a10eef",
"sha256": "64a6946ed15a14fd5c9a3aa60b74bb1da23221097157e9ae87d3b0d293bf70df"
},
"downloads": -1,
"filename": "vault2vault-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "4e47635b4c6bce5d5da03299e7a10eef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 14507,
"upload_time": "2023-04-03T16:02:05",
"upload_time_iso_8601": "2023-04-03T16:02:05.071478Z",
"url": "https://files.pythonhosted.org/packages/2c/72/98cf9b6d58e184a0a83a63ae0cfb33b3ad729d82321d05d8661c81d9ed80/vault2vault-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-03 16:02:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "enpaul",
"github_project": "vault2vault",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "vault2vault"
}
JSON
