mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-05 00:20:58 +02:00
201 lines
7.4 KiB
Python
201 lines
7.4 KiB
Python
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import crypt
|
|
import multiprocessing
|
|
import random
|
|
import string
|
|
import sys
|
|
|
|
from collections import namedtuple
|
|
|
|
from ansible import constants as C
|
|
from ansible.errors import AnsibleError, AnsibleAssertionError
|
|
from ansible.module_utils.six import text_type
|
|
from ansible.module_utils._text import to_text, to_bytes
|
|
|
|
PASSLIB_AVAILABLE = False
|
|
try:
|
|
import passlib
|
|
import passlib.hash
|
|
from passlib.utils.handlers import HasRawSalt
|
|
|
|
PASSLIB_AVAILABLE = True
|
|
except:
|
|
pass
|
|
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
__all__ = ['do_encrypt']
|
|
|
|
_LOCK = multiprocessing.Lock()
|
|
|
|
DEFAULT_PASSWORD_LENGTH = 20
|
|
|
|
|
|
def random_password(length=DEFAULT_PASSWORD_LENGTH, chars=C.DEFAULT_PASSWORD_CHARS):
|
|
'''Return a random password string of length containing only chars
|
|
|
|
:kwarg length: The number of characters in the new password. Defaults to 20.
|
|
:kwarg chars: The characters to choose from. The default is all ascii
|
|
letters, ascii digits, and these symbols ``.,:-_``
|
|
'''
|
|
if not isinstance(chars, text_type):
|
|
raise AnsibleAssertionError('%s (%s) is not a text_type' % (chars, type(chars)))
|
|
|
|
random_generator = random.SystemRandom()
|
|
return u''.join(random_generator.choice(chars) for dummy in range(length))
|
|
|
|
|
|
def random_salt(length=8):
|
|
"""Return a text string suitable for use as a salt for the hash functions we use to encrypt passwords.
|
|
"""
|
|
# Note passlib salt values must be pure ascii so we can't let the user
|
|
# configure this
|
|
salt_chars = string.ascii_letters + string.digits + u'./'
|
|
return random_password(length=length, chars=salt_chars)
|
|
|
|
|
|
class BaseHash(object):
|
|
algo = namedtuple('algo', ['crypt_id', 'salt_size', 'implicit_rounds'])
|
|
algorithms = {
|
|
'md5_crypt': algo(crypt_id='1', salt_size=8, implicit_rounds=None),
|
|
'bcrypt': algo(crypt_id='2a', salt_size=22, implicit_rounds=None),
|
|
'sha256_crypt': algo(crypt_id='5', salt_size=16, implicit_rounds=5000),
|
|
'sha512_crypt': algo(crypt_id='6', salt_size=16, implicit_rounds=5000),
|
|
}
|
|
|
|
def __init__(self, algorithm):
|
|
self.algorithm = algorithm
|
|
|
|
|
|
class CryptHash(BaseHash):
|
|
def __init__(self, algorithm):
|
|
super(CryptHash, self).__init__(algorithm)
|
|
|
|
if sys.platform.startswith('darwin'):
|
|
raise AnsibleError("crypt.crypt not supported on Mac OS X/Darwin, install passlib python module")
|
|
|
|
if algorithm not in self.algorithms:
|
|
raise AnsibleError("crypt.crypt does not support '%s' algorithm" % self.algorithm)
|
|
self.algo_data = self.algorithms[algorithm]
|
|
|
|
def hash(self, secret, salt=None, salt_size=None, rounds=None):
|
|
salt = self._salt(salt, salt_size)
|
|
rounds = self._rounds(rounds)
|
|
return self._hash(secret, salt, rounds)
|
|
|
|
def _salt(self, salt, salt_size):
|
|
salt_size = salt_size or self.algo_data.salt_size
|
|
return salt or random_salt(salt_size)
|
|
|
|
def _rounds(self, rounds):
|
|
if rounds == self.algo_data.implicit_rounds:
|
|
# Passlib does not include the rounds if it is the same as implict_rounds.
|
|
# Make crypt lib behave the same, by not explicitly specifying the rounds in that case.
|
|
return None
|
|
else:
|
|
return rounds
|
|
|
|
def _hash(self, secret, salt, rounds):
|
|
if rounds is None:
|
|
saltstring = "$%s$%s" % (self.algo_data.crypt_id, salt)
|
|
else:
|
|
saltstring = "$%s$rounds=%d$%s" % (self.algo_data.crypt_id, rounds, salt)
|
|
result = crypt.crypt(secret, saltstring)
|
|
|
|
# crypt.crypt returns None if it cannot parse saltstring
|
|
# None as result would be interpreted by the some modules (user module)
|
|
# as no password at all.
|
|
if not result:
|
|
raise AnsibleError("crypt.crypt does not support '%s' algorithm" % self.algorithm)
|
|
|
|
return result
|
|
|
|
|
|
class PasslibHash(BaseHash):
|
|
def __init__(self, algorithm):
|
|
super(PasslibHash, self).__init__(algorithm)
|
|
|
|
if not PASSLIB_AVAILABLE:
|
|
raise AnsibleError("passlib must be installed to hash with '%s'" % algorithm)
|
|
|
|
try:
|
|
self.crypt_algo = getattr(passlib.hash, algorithm)
|
|
except:
|
|
raise AnsibleError("passlib does not support '%s' algorithm" % algorithm)
|
|
|
|
def hash(self, secret, salt=None, salt_size=None, rounds=None):
|
|
salt = self._clean_salt(salt)
|
|
rounds = self._clean_rounds(rounds)
|
|
return self._hash(secret, salt=salt, salt_size=salt_size, rounds=rounds)
|
|
|
|
def _clean_salt(self, salt):
|
|
if not salt:
|
|
return None
|
|
elif issubclass(self.crypt_algo, HasRawSalt):
|
|
return to_bytes(salt, encoding='ascii', errors='strict')
|
|
else:
|
|
return to_text(salt, encoding='ascii', errors='strict')
|
|
|
|
def _clean_rounds(self, rounds):
|
|
algo_data = self.algorithms.get(self.algorithm)
|
|
if rounds:
|
|
return rounds
|
|
elif algo_data and algo_data.implicit_rounds:
|
|
# The default rounds used by passlib depend on the passlib version.
|
|
# For consistency ensure that passlib behaves the same as crypt in case no rounds were specified.
|
|
# Thus use the crypt defaults.
|
|
return algo_data.implicit_rounds
|
|
else:
|
|
return None
|
|
|
|
def _hash(self, secret, salt, salt_size, rounds):
|
|
# Not every hash algorithm supports every paramter.
|
|
# Thus create the settings dict only with set parameters.
|
|
settings = {}
|
|
if salt:
|
|
settings['salt'] = salt
|
|
if salt_size:
|
|
settings['salt_size'] = salt_size
|
|
if rounds:
|
|
settings['rounds'] = rounds
|
|
|
|
# starting with passlib 1.7 'using' and 'hash' should be used instead of 'encrypt'
|
|
if hasattr(self.crypt_algo, 'hash'):
|
|
result = self.crypt_algo.using(**settings).hash(secret)
|
|
elif hasattr(self.crypt_algo, 'encrypt'):
|
|
result = self.crypt_algo.encrypt(secret, **settings)
|
|
else:
|
|
raise AnsibleError("installed passlib version %s not supported" % passlib.__version__)
|
|
|
|
# passlib.hash should always return something or raise an exception.
|
|
# Still ensure that there is always a result.
|
|
# Otherwise an empty password might be assumed by some modules, like the user module.
|
|
if not result:
|
|
raise AnsibleError("failed to hash with algorithm '%s'" % self.algorithm)
|
|
|
|
# Hashes from passlib.hash should be represented as ascii strings of hex
|
|
# digits so this should not traceback. If it's not representable as such
|
|
# we need to traceback and then blacklist such algorithms because it may
|
|
# impact calling code.
|
|
return to_text(result, errors='strict')
|
|
|
|
|
|
def passlib_or_crypt(secret, algorithm, salt=None, salt_size=None, rounds=None):
|
|
if PASSLIB_AVAILABLE:
|
|
return PasslibHash(algorithm).hash(secret, salt=salt, salt_size=salt_size, rounds=rounds)
|
|
else:
|
|
return CryptHash(algorithm).hash(secret, salt=salt, salt_size=salt_size, rounds=rounds)
|
|
|
|
|
|
def do_encrypt(result, encrypt, salt_size=None, salt=None):
|
|
return passlib_or_crypt(result, encrypt, salt_size=salt_size, salt=salt)
|