#!/usr/bin/env bash
set -euvx
MYTMPDIR = $( mktemp -d 2>/dev/null || mktemp -d -t 'mytmpdir' )
trap 'rm -rf "${MYTMPDIR}"' EXIT
# create a test file
TEST_FILE = " ${ MYTMPDIR } /test_file "
echo "This is a test file" > " ${ TEST_FILE } "
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
TEST_FILE_1_2 = " ${ MYTMPDIR } /test_file_1_2 "
echo "This is a test file for format 1.2" > " ${ TEST_FILE_1_2 } "
TEST_FILE_ENC_PASSWORD = " ${ MYTMPDIR } /test_file_enc_password "
echo "This is a test file for encrypted with a vault password that is itself vault encrypted" > " ${ TEST_FILE_ENC_PASSWORD } "
TEST_FILE_ENC_PASSWORD_DEFAULT = " ${ MYTMPDIR } /test_file_enc_password_default "
echo "This is a test file for encrypted with a vault password that is itself vault encrypted using --encrypted-vault-id default" > " ${ TEST_FILE_ENC_PASSWORD_DEFAULT } "
TEST_FILE_OUTPUT = " ${ MYTMPDIR } /test_file_output "
TEST_FILE_EDIT = " ${ MYTMPDIR } /test_file_edit "
echo "This is a test file for edit" > " ${ TEST_FILE_EDIT } "
TEST_FILE_EDIT2 = " ${ MYTMPDIR } /test_file_edit2 "
echo "This is a test file for edit2" > " ${ TEST_FILE_EDIT2 } "
# test case for https://github.com/ansible/ansible/issues/35834
# (being prompted for new password on vault-edit with no configured passwords)
TEST_FILE_EDIT3 = " ${ MYTMPDIR } /test_file_edit3 "
echo "This is a test file for edit3" > " ${ TEST_FILE_EDIT3 } "
# ansible-config view
ansible-config view
# ansisle-config
ansible-config dump --only-changed
ansible-vault encrypt " $@ " --vault-id vault-password " ${ TEST_FILE_EDIT3 } "
# EDITOR=./faux-editor.py ansible-vault edit "$@" "${TEST_FILE_EDIT3}"
EDITOR = ./faux-editor.py ansible-vault edit --vault-id vault-password -vvvvv " ${ TEST_FILE_EDIT3 } "
echo $?
# view the vault encrypted password file
ansible-vault view " $@ " --vault-id vault-password encrypted-vault-password
# encrypt with a password from a vault encrypted password file and multiple vault-ids
# should fail because we dont know which vault id to use to encrypt with
ansible-vault encrypt " $@ " --vault-id vault-password --vault-id encrypted-vault-password " ${ TEST_FILE_ENC_PASSWORD } " && :
WRONG_RC = $?
echo " rc was $WRONG_RC (5 is expected) "
[ $WRONG_RC -eq 5 ]
# try to view the file encrypted with the vault-password we didnt specify
# to verify we didnt choose the wrong vault-id
ansible-vault view " $@ " --vault-id vault-password encrypted-vault-password
FORMAT_1_1_HEADER = "\$ANSIBLE_VAULT;1.1;AES256"
FORMAT_1_2_HEADER = "\$ANSIBLE_VAULT;1.2;AES256"
Better handling of malformed vault data envelope (#32515)
* Better handling of malformed vault data envelope
If an embedded vaulted variable ('!vault' in yaml)
had an invalid format, it would eventually cause
an error for seemingly unrelated reasons.
"Invalid" meaning not valid hexlify (extra chars,
non-hex chars, etc).
For ex, if a host_vars file had invalid vault format
variables, on py2, it would cause an error like:
'ansible.vars.hostvars.HostVars object' has no
attribute u'broken.example.com'
Depending on where the invalid vault is, it could
also cause "VARIABLE IS NOT DEFINED!". The behavior
can also change if ansible-playbook is py2 or py3.
Root cause is errors from binascii.unhexlify() not
being handled consistently.
Fix is to add a AnsibleVaultFormatError exception and
raise it on any unhexlify() errors and to handle it
properly elsewhere.
Add a _unhexlify() that try/excepts around a binascii.unhexlify()
and raises an AnsibleVaultFormatError on invalid vault data.
This is so the same exception type is always raised for this
case. Previous it was different between py2 and py3.
binascii.unhexlify() raises a binascii.Error if the hexlified
blobs in a vault data blob are invalid.
On py2, binascii.Error is a subclass of Exception.
On py3, binascii.Error is a subclass of TypeError
When decrypting content of vault encrypted variables,
if a binascii.Error is raised it propagates up to
playbook.base.Base.post_validate(). post_validate()
handles exceptions for TypeErrors but not for
base Exception subclasses (like py2 binascii.Error).
* Add a display.warning on vault format errors
* Unit tests for _unhexlify, parse_vaulttext*
* Add intg test cases for invalid vault formats
Fixes #28038
7 years ago
VAULT_PASSWORD_FILE = vault-password
# new format, view, using password client script
ansible-vault view " $@ " --vault-id vault-password@test-vault-client.py format_1_1_AES256.yml
# view, using password client script, unknown vault/keyname
ansible-vault view " $@ " --vault-id some_unknown_vault_id@test-vault-client.py format_1_1_AES256.yml && :
# Use linux setsid to test without a tty. No setsid if osx/bsd though...
if [ -x " $( command -v setsid) " ] ; then
# tests related to https://github.com/ansible/ansible/issues/30993
CMD = 'ansible-playbook -vvvvv --ask-vault-pass test_vault.yml'
setsid sh -c " echo test-vault-password| ${ CMD } " < /dev/null > log 2>& 1 && :
WRONG_RC = $?
cat log
echo " rc was $WRONG_RC (0 is expected) "
[ $WRONG_RC -eq 0 ]
setsid sh -c 'tty; ansible-vault --ask-vault-pass -vvvvv view test_vault.yml' < /dev/null > log 2>& 1 && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
cat log
setsid sh -c 'tty; echo passbhkjhword|ansible-playbook -vvvvv --ask-vault-pass test_vault.yml' < /dev/null > log 2>& 1 && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
cat log
setsid sh -c 'tty; echo test-vault-password |ansible-playbook -vvvvv --ask-vault-pass test_vault.yml' < /dev/null > log 2>& 1
echo $?
cat log
setsid sh -c 'tty; echo test-vault-password|ansible-playbook -vvvvv --ask-vault-pass test_vault.yml' < /dev/null > log 2>& 1
echo $?
cat log
setsid sh -c 'tty; echo test-vault-password |ansible-playbook -vvvvv --ask-vault-pass test_vault.yml' < /dev/null > log 2>& 1
echo $?
cat log
setsid sh -c 'tty; echo test-vault-password|ansible-vault --ask-vault-pass -vvvvv view vaulted.inventory' < /dev/null > log 2>& 1
echo $?
cat log
fi
ansible-vault view " $@ " --vault-password-file vault-password-wrong format_1_1_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
set -eux
# new format, view
ansible-vault view " $@ " --vault-password-file vault-password format_1_1_AES256.yml
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# new format, view with vault-id
ansible-vault view " $@ " --vault-id= vault-password format_1_1_AES256.yml
# new format, view, using password script
ansible-vault view " $@ " --vault-password-file password-script.py format_1_1_AES256.yml
# new format, view, using password script with vault-id
ansible-vault view " $@ " --vault-id password-script.py format_1_1_AES256.yml
# new 1.2 format, view
ansible-vault view " $@ " --vault-password-file vault-password format_1_2_AES256.yml
# new 1.2 format, view with vault-id
ansible-vault view " $@ " --vault-id= test_vault_id@vault-password format_1_2_AES256.yml
# new 1,2 format, view, using password script
ansible-vault view " $@ " --vault-password-file password-script.py format_1_2_AES256.yml
# new 1.2 format, view, using password script with vault-id
ansible-vault view " $@ " --vault-id password-script.py format_1_2_AES256.yml
# newish 1.1 format, view, using a vault-id list from config env var
ANSIBLE_VAULT_IDENTITY_LIST = 'wrong-password@vault-password-wrong,default@vault-password' ansible-vault view " $@ " --vault-id password-script.py format_1_1_AES256.yml
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# new 1.2 format, view, ENFORCE_IDENTITY_MATCH=true, should fail, no 'test_vault_id' vault_id
ANSIBLE_VAULT_ID_MATCH = 1 ansible-vault view " $@ " --vault-password-file vault-password format_1_2_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# new 1.2 format, view with vault-id, ENFORCE_IDENTITY_MATCH=true, should work, 'test_vault_id' is provided
ANSIBLE_VAULT_ID_MATCH = 1 ansible-vault view " $@ " --vault-id= test_vault_id@vault-password format_1_2_AES256.yml
# new 1,2 format, view, using password script, ENFORCE_IDENTITY_MATCH=true, should fail, no 'test_vault_id'
ANSIBLE_VAULT_ID_MATCH = 1 ansible-vault view " $@ " --vault-password-file password-script.py format_1_2_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# new 1.2 format, view, using password script with vault-id, ENFORCE_IDENTITY_MATCH=true, should fail
ANSIBLE_VAULT_ID_MATCH = 1 ansible-vault view " $@ " --vault-id password-script.py format_1_2_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# new 1.2 format, view, using password script with vault-id, ENFORCE_IDENTITY_MATCH=true, 'test_vault_id' provided should work
ANSIBLE_VAULT_ID_MATCH = 1 ansible-vault view " $@ " --vault-id= test_vault_id@password-script.py format_1_2_AES256.yml
# test with a default vault password set via config/env, right password
ANSIBLE_VAULT_PASSWORD_FILE = vault-password ansible-vault view " $@ " format_1_1_AES256.yml
# test with a default vault password set via config/env, wrong password
ANSIBLE_VAULT_PASSWORD_FILE = vault-password-wrong ansible-vault view " $@ " format_1_1_AES.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# test with a default vault-id list set via config/env, right password
ANSIBLE_VAULT_PASSWORD_FILE = wrong@vault-password-wrong,correct@vault-password ansible-vault view " $@ " format_1_1_AES.yml && :
# test with a default vault-id list set via config/env,wrong passwords
ANSIBLE_VAULT_PASSWORD_FILE = wrong@vault-password-wrong,alsowrong@vault-password-wrong ansible-vault view " $@ " format_1_1_AES.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# try specifying a --encrypt-vault-id that doesnt exist, should exit with an error indicating
# that --encrypt-vault-id and the known vault-ids
ansible-vault encrypt " $@ " --vault-password-file vault-password --encrypt-vault-id doesnt_exist " ${ TEST_FILE } " && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# encrypt it
ansible-vault encrypt " $@ " --vault-password-file vault-password " ${ TEST_FILE } "
ansible-vault view " $@ " --vault-password-file vault-password " ${ TEST_FILE } "
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# view with multiple vault-password files, including a wrong one
ansible-vault view " $@ " --vault-password-file vault-password --vault-password-file vault-password-wrong " ${ TEST_FILE } "
# view with multiple vault-password files, including a wrong one, using vault-id
ansible-vault view " $@ " --vault-id vault-password --vault-id vault-password-wrong " ${ TEST_FILE } "
# And with the password files specified in a different order
ansible-vault view " $@ " --vault-password-file vault-password-wrong --vault-password-file vault-password " ${ TEST_FILE } "
# And with the password files specified in a different order, using vault-id
ansible-vault view " $@ " --vault-id vault-password-wrong --vault-id vault-password " ${ TEST_FILE } "
# And with the password files specified in a different order, using --vault-id and non default vault_ids
ansible-vault view " $@ " --vault-id test_vault_id@vault-password-wrong --vault-id test_vault_id@vault-password " ${ TEST_FILE } "
ansible-vault decrypt " $@ " --vault-password-file vault-password " ${ TEST_FILE } "
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# encrypt it, using a vault_id so we write a 1.2 format file
ansible-vault encrypt " $@ " --vault-id test_vault_1_2@vault-password " ${ TEST_FILE_1_2 } "
ansible-vault view " $@ " --vault-id vault-password " ${ TEST_FILE_1_2 } "
ansible-vault view " $@ " --vault-id test_vault_1_2@vault-password " ${ TEST_FILE_1_2 } "
# view with multiple vault-password files, including a wrong one
ansible-vault view " $@ " --vault-id vault-password --vault-id wrong_password@vault-password-wrong " ${ TEST_FILE_1_2 } "
# And with the password files specified in a different order, using vault-id
ansible-vault view " $@ " --vault-id vault-password-wrong --vault-id vault-password " ${ TEST_FILE_1_2 } "
# And with the password files specified in a different order, using --vault-id and non default vault_ids
ansible-vault view " $@ " --vault-id test_vault_id@vault-password-wrong --vault-id test_vault_id@vault-password " ${ TEST_FILE_1_2 } "
ansible-vault decrypt " $@ " --vault-id test_vault_1_2@vault-password " ${ TEST_FILE_1_2 } "
# multiple vault passwords
ansible-vault view " $@ " --vault-password-file vault-password --vault-password-file vault-password-wrong format_1_1_AES256.yml
# multiple vault passwords, --vault-id
ansible-vault view " $@ " --vault-id test_vault_id@vault-password --vault-id test_vault_id@vault-password-wrong format_1_1_AES256.yml
# encrypt it, with password from password script
ansible-vault encrypt " $@ " --vault-password-file password-script.py " ${ TEST_FILE } "
ansible-vault view " $@ " --vault-password-file password-script.py " ${ TEST_FILE } "
ansible-vault decrypt " $@ " --vault-password-file password-script.py " ${ TEST_FILE } "
# encrypt it, with password from password script
ansible-vault encrypt " $@ " --vault-id test_vault_id@password-script.py " ${ TEST_FILE } "
ansible-vault view " $@ " --vault-id test_vault_id@password-script.py " ${ TEST_FILE } "
ansible-vault decrypt " $@ " --vault-id test_vault_id@password-script.py " ${ TEST_FILE } "
# new password file for rekeyed file
NEW_VAULT_PASSWORD = " ${ MYTMPDIR } /new-vault-password "
echo "newpassword" > " ${ NEW_VAULT_PASSWORD } "
ansible-vault encrypt " $@ " --vault-password-file vault-password " ${ TEST_FILE } "
ansible-vault rekey " $@ " --vault-password-file vault-password --new-vault-password-file " ${ NEW_VAULT_PASSWORD } " " ${ TEST_FILE } "
# --new-vault-password-file and --new-vault-id should cause options error
ansible-vault rekey " $@ " --vault-password-file vault-password --new-vault-id= foobar --new-vault-password-file " ${ NEW_VAULT_PASSWORD } " " ${ TEST_FILE } " && :
WRONG_RC = $?
echo " rc was $WRONG_RC (2 is expected) "
[ $WRONG_RC -eq 2 ]
ansible-vault view " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " " ${ TEST_FILE } "
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# view with old password file and new password file
ansible-vault view " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " --vault-password-file vault-password " ${ TEST_FILE } "
# view with old password file and new password file, different order
ansible-vault view " $@ " --vault-password-file vault-password --vault-password-file " ${ NEW_VAULT_PASSWORD } " " ${ TEST_FILE } "
# view with old password file and new password file and another wrong
ansible-vault view " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " --vault-password-file vault-password-wrong --vault-password-file vault-password " ${ TEST_FILE } "
# view with old password file and new password file and another wrong, using --vault-id
ansible-vault view " $@ " --vault-id " tmp_new_password@ ${ NEW_VAULT_PASSWORD } " --vault-id wrong_password@vault-password-wrong --vault-id myorg@vault-password " ${ TEST_FILE } "
ansible-vault decrypt " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " " ${ TEST_FILE } "
# reading/writing to/from stdin/stdin (See https://github.com/ansible/ansible/issues/23567)
ansible-vault encrypt " $@ " --vault-password-file " ${ VAULT_PASSWORD_FILE } " --output= " ${ TEST_FILE_OUTPUT } " < " ${ TEST_FILE } "
OUTPUT = $( ansible-vault decrypt " $@ " --vault-password-file " ${ VAULT_PASSWORD_FILE } " --output= - < " ${ TEST_FILE_OUTPUT } " )
echo " ${ OUTPUT } " | grep 'This is a test file'
OUTPUT_DASH = $( ansible-vault decrypt " $@ " --vault-password-file " ${ VAULT_PASSWORD_FILE } " --output= - " ${ TEST_FILE_OUTPUT } " )
echo " ${ OUTPUT_DASH } " | grep 'This is a test file'
OUTPUT_DASH_SPACE = $( ansible-vault decrypt " $@ " --vault-password-file " ${ VAULT_PASSWORD_FILE } " --output - " ${ TEST_FILE_OUTPUT } " )
echo " ${ OUTPUT_DASH_SPACE } " | grep 'This is a test file'
# test using an empty vault password file
ansible-vault view " $@ " --vault-password-file empty-password format_1_1_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
ansible-vault view " $@ " --vault-id= empty@empty-password --vault-password-file empty-password format_1_1_AES256.yml && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
echo 'foo' > some_file.txt
ansible-vault encrypt " $@ " --vault-password-file empty-password some_file.txt && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
ansible-vault encrypt_string " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " "a test string"
ansible-vault encrypt_string " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " --name "blippy" "a test string names blippy"
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
ansible-vault encrypt_string " $@ " --vault-id " ${ NEW_VAULT_PASSWORD } " "a test string"
ansible-vault encrypt_string " $@ " --vault-id " ${ NEW_VAULT_PASSWORD } " --name "blippy" "a test string names blippy"
# from stdin
ansible-vault encrypt_string " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " < " ${ TEST_FILE } "
ansible-vault encrypt_string " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " --stdin-name "the_var_from_stdin" < " ${ TEST_FILE } "
# write to file
ansible-vault encrypt_string " $@ " --vault-password-file " ${ NEW_VAULT_PASSWORD } " --name "blippy" "a test string names blippy" --output " ${ MYTMPDIR } /enc_string_test_file "
# test ansible-vault edit with a faux editor
ansible-vault encrypt " $@ " --vault-password-file vault-password " ${ TEST_FILE_EDIT } "
# edit a 1.1 format with no vault-id, should stay 1.1
EDITOR = ./faux-editor.py ansible-vault edit " $@ " --vault-password-file vault-password " ${ TEST_FILE_EDIT } "
head -1 " ${ TEST_FILE_EDIT } " | grep " ${ FORMAT_1_1_HEADER } "
# edit a 1.1 format with vault-id, should stay 1.1
cat " ${ TEST_FILE_EDIT } "
EDITOR = ./faux-editor.py ansible-vault edit " $@ " --vault-id vault_password@vault-password " ${ TEST_FILE_EDIT } "
cat " ${ TEST_FILE_EDIT } "
head -1 " ${ TEST_FILE_EDIT } " | grep " ${ FORMAT_1_1_HEADER } "
ansible-vault encrypt " $@ " --vault-id vault_password@vault-password " ${ TEST_FILE_EDIT2 } "
# verify that we aren't prompted for a new vault password on edit if we are running interactively (ie, with prompts)
# have to use setsid nd --ask-vault-pass to force a prompt to simulate.
# See https://github.com/ansible/ansible/issues/35834
setsid sh -c 'tty; echo password |ansible-vault edit --ask-vault-pass vault_test.yml' < /dev/null > log 2>& 1 && :
grep 'New Vault password' log && :
WRONG_RC = $?
echo " The stdout log had 'New Vault password' in it and it is not supposed to. rc of grep was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# edit a 1.2 format with vault id, should keep vault id and 1.2 format
EDITOR = ./faux-editor.py ansible-vault edit " $@ " --vault-id vault_password@vault-password " ${ TEST_FILE_EDIT2 } "
head -1 " ${ TEST_FILE_EDIT2 } " | grep " ${ FORMAT_1_2_HEADER } ;vault_password "
# edit a 1.2 file with no vault-id, should keep vault id and 1.2 format
EDITOR = ./faux-editor.py ansible-vault edit " $@ " --vault-password-file vault-password " ${ TEST_FILE_EDIT2 } "
head -1 " ${ TEST_FILE_EDIT2 } " | grep " ${ FORMAT_1_2_HEADER } ;vault_password "
# encrypt with a password from a vault encrypted password file and multiple vault-ids
# should fail because we dont know which vault id to use to encrypt with
ansible-vault encrypt " $@ " --vault-id vault-password --vault-id encrypted-vault-password " ${ TEST_FILE_ENC_PASSWORD } " && :
WRONG_RC = $?
echo " rc was $WRONG_RC (5 is expected) "
[ $WRONG_RC -eq 5 ]
# encrypt with a password from a vault encrypted password file and multiple vault-ids
# but this time specify with --encrypt-vault-id, but specifying vault-id names (instead of default)
# ansible-vault encrypt "$@" --vault-id from_vault_password@vault-password --vault-id from_encrypted_vault_password@encrypted-vault-password --encrypt-vault-id from_encrypted_vault_password "${TEST_FILE(_ENC_PASSWORD}"
# try to view the file encrypted with the vault-password we didnt specify
# to verify we didnt choose the wrong vault-id
# ansible-vault view "$@" --vault-id vault-password "${TEST_FILE_ENC_PASSWORD}" && :
# WRONG_RC=$?
# echo "rc was $WRONG_RC (1 is expected)"
# [ $WRONG_RC -eq 1 ]
ansible-vault encrypt " $@ " --vault-id vault-password " ${ TEST_FILE_ENC_PASSWORD } "
# view the file encrypted with a password from a vault encrypted password file
ansible-vault view " $@ " --vault-id vault-password --vault-id encrypted-vault-password " ${ TEST_FILE_ENC_PASSWORD } "
# try to view the file encrypted with a password from a vault encrypted password file but without the password to the password file.
# This should fail with an
ansible-vault view " $@ " --vault-id encrypted-vault-password " ${ TEST_FILE_ENC_PASSWORD } " && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# test playbooks using vaulted files
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --list-tasks
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --list-hosts
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --syntax-check
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --syntax-check
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password
ansible-playbook test_vaulted_inventory.yml -i vaulted.inventory -v " $@ " --vault-password-file vault-password
ansible-playbook test_vaulted_template.yml -i ../../inventory -v " $@ " --vault-password-file vault-password
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# test a playbook with a host_var whose value is non-ascii utf8 (see https://github.com/ansible/ansible/issues/37258)
ansible-playbook -i ../../inventory -v " $@ " --vault-id vault-password test_vaulted_utf8_value.yml
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# test with password from password script
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file password-script.py
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file password-script.py
# with multiple password files
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --vault-password-file vault-password-wrong
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong --vault-password-file vault-password
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password --vault-password-file vault-password-wrong --syntax-check
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong --vault-password-file vault-password
# test with a default vault password file set in config
ANSIBLE_VAULT_PASSWORD_FILE = vault-password ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong
# test using vault_identity_list config
ANSIBLE_VAULT_IDENTITY_LIST = 'wrong-password@vault-password-wrong,default@vault-password' ansible-playbook test_vault.yml -i ../../inventory -v " $@ "
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
7 years ago
# test that we can have a vault encrypted yaml file that includes embedded vault vars
# that were encrypted with a different vault secret
ansible-playbook test_vault_file_encrypted_embedded.yml -i ../../inventory " $@ " --vault-id encrypted_file_encrypted_var_password --vault-id vault-password
# with multiple password files, --vault-id, ordering
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id vault-password --vault-id vault-password-wrong
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id vault-password-wrong --vault-id vault-password
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-id vault-password --vault-id vault-password-wrong --syntax-check
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-id vault-password-wrong --vault-id vault-password
# test with multiple password files, including a script, and a wrong password
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong --vault-password-file password-script.py --vault-password-file vault-password
# test with multiple password files, including a script, and a wrong password, and a mix of --vault-id and --vault-password-file
ansible-playbook test_vault_embedded.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong --vault-id password-script.py --vault-id vault-password
# test with multiple password files, including a script, and a wrong password, and a mix of --vault-id and --vault-password-file
ansible-playbook test_vault_embedded_ids.yml -i ../../inventory -v " $@ " \
--vault-password-file vault-password-wrong \
--vault-id password-script.py --vault-id example1@example1_password \
--vault-id example2@example2_password --vault-password-file example3_password \
--vault-id vault-password
# with wrong password
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# with multiple wrong passwords
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-password-file vault-password-wrong --vault-password-file vault-password-wrong && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# with wrong password, --vault-id
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id vault-password-wrong && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# with multiple wrong passwords with --vault-id
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id vault-password-wrong --vault-id vault-password-wrong && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# with multiple wrong passwords with --vault-id
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id wrong1@vault-password-wrong --vault-id wrong2@vault-password-wrong && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
# with empty password file
ansible-playbook test_vault.yml -i ../../inventory -v " $@ " --vault-id empty@empty-password && :
WRONG_RC = $?
echo " rc was $WRONG_RC (1 is expected) "
[ $WRONG_RC -eq 1 ]
Better handling of malformed vault data envelope (#32515)
* Better handling of malformed vault data envelope
If an embedded vaulted variable ('!vault' in yaml)
had an invalid format, it would eventually cause
an error for seemingly unrelated reasons.
"Invalid" meaning not valid hexlify (extra chars,
non-hex chars, etc).
For ex, if a host_vars file had invalid vault format
variables, on py2, it would cause an error like:
'ansible.vars.hostvars.HostVars object' has no
attribute u'broken.example.com'
Depending on where the invalid vault is, it could
also cause "VARIABLE IS NOT DEFINED!". The behavior
can also change if ansible-playbook is py2 or py3.
Root cause is errors from binascii.unhexlify() not
being handled consistently.
Fix is to add a AnsibleVaultFormatError exception and
raise it on any unhexlify() errors and to handle it
properly elsewhere.
Add a _unhexlify() that try/excepts around a binascii.unhexlify()
and raises an AnsibleVaultFormatError on invalid vault data.
This is so the same exception type is always raised for this
case. Previous it was different between py2 and py3.
binascii.unhexlify() raises a binascii.Error if the hexlified
blobs in a vault data blob are invalid.
On py2, binascii.Error is a subclass of Exception.
On py3, binascii.Error is a subclass of TypeError
When decrypting content of vault encrypted variables,
if a binascii.Error is raised it propagates up to
playbook.base.Base.post_validate(). post_validate()
handles exceptions for TypeErrors but not for
base Exception subclasses (like py2 binascii.Error).
* Add a display.warning on vault format errors
* Unit tests for _unhexlify, parse_vaulttext*
* Add intg test cases for invalid vault formats
Fixes #28038
7 years ago
# test invalid format ala https://github.com/ansible/ansible/issues/28038
EXPECTED_ERROR = 'Vault format unhexlify error: Non-hexadecimal digit found'
ansible-playbook " $@ " -i invalid_format/inventory --vault-id invalid_format/vault-secret invalid_format/broken-host-vars-tasks.yml 2>& 1 | grep " ${ EXPECTED_ERROR } "
EXPECTED_ERROR = 'Vault format unhexlify error: Odd-length string'
ansible-playbook " $@ " -i invalid_format/inventory --vault-id invalid_format/vault-secret invalid_format/broken-group-vars-tasks.yml 2>& 1 | grep " ${ EXPECTED_ERROR } "
# Ensure we don't leave unencrypted temp files dangling
ansible-playbook -v " $@ " --vault-password-file vault-password test_dangling_temp.yml
