ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 12:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Retain vault password as bytes in 2.2 (#22378)

Browse source 
* Retain vault password as bytes in 2.2

Prior to 2.2.1, the vault password was read in as byes and then remained
bytes all the way through the code.  A bug existed where bytes and text
were mixed, leading to a traceback with non-ascii passwords.  In devel,
this was fixed by changing the read in password to text type to match
with our overall strategy of converting at the borders.  This was
backported to stable-2.2 for the 2.2.1 release.

On reflection, this should not have been backported as it causes
passwords which were originally non-utf-8 to become utf-8.  People will
then have their working 2.2.x vault files become in-accessible.

this commit pipes bytes all the way through the system for vault
password.  That way if a password is read in as a non-utf-8 character
sequence, it will continue to work in 2.2.2+.  This change is only for
the 2.2 branch, not for 2.3 and beyond.

Why not everywhere?  The reason is that non-utf-8 passwords will cause
problems when vault files are shared between systems or users.  If the
password is read from the prompt and one user/machine has a latin1
encoded locale while a second one has utf-8, the non-ascii password
typed in won't match between machines.  Deal with this by making sure
that when we encrypt the data, we always use valid utf-8.

Fixes #20398

(cherry picked from commit 5dcce0666a81917c68b76286685642fd72d84327)
This commit is contained in:
Adrian Likins 2017-03-07 15:30:09 -05:00 • committed by GitHub
commit edcbef27ec
8 changed files with 47 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/ansible/cli/__init__.py
View file

@ -174,7 +174,7 @@ class CLI(with_metaclass(ABCMeta, object)):
# enforce no newline chars at the end of passwords
if vault_pass:
vault_pass = to_text(vault_pass, errors='surrogate_or_strict', nonstring='simplerepr').strip()
vault_pass = to_bytes(vault_pass, errors='surrogate_or_strict', nonstring='simplerepr').strip()
return vault_pass
@ -190,7 +190,7 @@ class CLI(with_metaclass(ABCMeta, object)):
pass
if new_vault_pass:
new_vault_pass = to_text(new_vault_pass, errors='surrogate_or_strict', nonstring='simplerepr').strip()
new_vault_pass = to_bytes(new_vault_pass, errors='surrogate_or_strict', nonstring='simplerepr').strip()
return new_vault_pass
@ -641,7 +641,7 @@ class CLI(with_metaclass(ABCMeta, object)):
except (OSError, IOError) as e:
raise AnsibleError("Could not read vault password file %s: %s" % (this_path, e))
return to_text(vault_pass, errors='surrogate_or_strict')
return vault_pass
def get_opt(self, k, defval=""):
"""