fda131504b
Allows users to specify a key name in a given project’s `ansible.cfg` file and thus handle keyring integration with vaults with different passwords. If no key name is specified, the original default `ansible` key name will be used. Other improvements: * `username` is now optional; defaults to user that invokes the script * change string interpolation to new `.format()` style * clean up and expand upon documentation * enforce PEP 8 compliance
101 lines
3.3 KiB
Python
Executable file
101 lines
3.3 KiB
Python
Executable file
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
# (c) 2014, Matt Martz <matt@sivel.net>
|
|
# (c) 2016, Justin Mayer <https://justinmayer.com/>
|
|
#
|
|
# This file is part of Ansible.
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# =============================================================================
|
|
#
|
|
# This script is to be used with vault_password_file or --vault-password-file
|
|
# to retrieve the vault password via your OS's native keyring application.
|
|
#
|
|
# This file *MUST* be saved with executable permissions. Otherwise, Ansible
|
|
# will try to parse as a password file and display: "ERROR! Decryption failed"
|
|
#
|
|
# The `keyring` Python module is required: https://pypi.python.org/pypi/keyring
|
|
#
|
|
# By default, this script will store the specified password in the keyring of
|
|
# the user that invokes the script. To specify a user keyring, add a [vault]
|
|
# section to your ansible.cfg file with a 'username' option. Example:
|
|
#
|
|
# [vault]
|
|
# username = 'ansible-vault'
|
|
#
|
|
# Another optional setting is for the key name, which allows you to use this
|
|
# script to handle multiple project vaults with different passwords:
|
|
#
|
|
# [vault]
|
|
# keyname = 'ansible-vault-yourproject'
|
|
#
|
|
# You can configure the `vault_password_file` option in ansible.cfg:
|
|
#
|
|
# [defaults]
|
|
# ...
|
|
# vault_password_file = /path/to/vault-keyring.py
|
|
# ...
|
|
#
|
|
# To set your password, `cd` to your project directory and run:
|
|
#
|
|
# python /path/to/vault-keyring.py set
|
|
#
|
|
# If you choose not to configure the path to `vault_password_file` in
|
|
# ansible.cfg, your `ansible-playbook` command might look like:
|
|
#
|
|
# ansible-playbook --vault-password-file=/path/to/vault-keyring.py site.yml
|
|
|
|
ANSIBLE_METADATA = {'status': ['preview'],
|
|
'supported_by': 'community',
|
|
'version': '1.0'}
|
|
|
|
import sys
|
|
import getpass
|
|
import keyring
|
|
|
|
import ansible.constants as C
|
|
|
|
|
|
def main():
|
|
(parser, config_path) = C.load_config_file()
|
|
if parser.has_option('vault', 'username'):
|
|
username = parser.get('vault', 'username')
|
|
else:
|
|
username = getpass.getuser()
|
|
|
|
if parser.has_option('vault', 'keyname'):
|
|
keyname = parser.get('vault', 'keyname')
|
|
else:
|
|
keyname = 'ansible'
|
|
|
|
if len(sys.argv) == 2 and sys.argv[1] == 'set':
|
|
intro = 'Storing password in "{}" user keyring using key name: {}\n'
|
|
sys.stdout.write(intro.format(username, keyname))
|
|
password = getpass.getpass()
|
|
confirm = getpass.getpass('Confirm password: ')
|
|
if password == confirm:
|
|
keyring.set_password(keyname, username, password)
|
|
else:
|
|
sys.stderr.write('Passwords do not match\n')
|
|
sys.exit(1)
|
|
else:
|
|
sys.stdout.write('{}\n'.format(keyring.get_password(keyname,
|
|
username)))
|
|
|
|
sys.exit(0)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|