#!/usr/bin/python3

import PAM
import functools
from pathlib import Path
import subprocess
import sys

db = 'pam'
db_user = 'pam'
db_password = 'pampasswd'
db_table = 'users'
user_column = 'username'
password_column = 'password'
pam_service = 'pamtest'
config_file = Path('/etc/pam-mysql.conf')

# The hashes here aren't derived on-the-fly from the password, because
# they simulate database field values, which don't change with any
# environment (even OS level) change.
passwords = {
    'plain'    : { 'crypt':  0, 'hash': 'foopwd' },
    'Y'        : { 'crypt':  1, 'md5': 'false', 'hash': 'xycbw66FMoYGI' }, # mkpasswd -m descrypt foopwd xy
    'Y_MD5'    : { 'crypt':  1, 'md5': 'true' , 'hash': '$1$abcdefgh$cKmmXi05KpTgjDSOXaL4X/' }, # mkpasswd -m md5crypt foopwd abcdefgh
    'mysql'    : { 'crypt':  2, '323': 'false', 'hash': '*1A8A8D8A90F03E8A15D4FFB3FC91A4693F077A84' }, # select PASSWORD('foopwd')
    'mysql_old': { 'crypt':  2, '323': 'true' , 'hash': '2a7c7b955b2d807b' }, # select OLD_PASSWORD('foopwd') (original, pre-4.1 hash)
    'md5'      : { 'crypt':  3, 'hash': '1631f7e7ed3c261d02b309016087f8a9' }, # select MD5('foopwd')
    'sha1'     : { 'crypt':  4, 'hash': '794ed3d18464baff93f8ded1cfd00d9a2d9fe316' }, # select SHA1('foopwd')
    'drupal7'  : { 'crypt':  5, 'hash': '$S$5925NCiI4OFCbPvIIbhLVZagCu/GkASIhxqJHhuMfEP6WRqJLNwe' }, # https://www.useotools.com/drupal-password-hash-generator
    'joomla15' : { 'crypt':  6, 'hash': 'e6a39083bd9bbc7a4919942146230321:dksVPHnEP2MPyD4CgkSKxSAvTIIuAERa' }, # https://www.useotools.com/joomla-password-hash-generator
    'ssha'     : { 'crypt':  7, 'hash': '3TwCepGYd95hd7m7B8verbpYpksxMjM0' }, # salt=b'1234'; base64.b64encode(hashlib.sha1(b'foopwd'+salt).digest()+salt).decode('ascii')
    'sha512'   : { 'crypt':  8, 'hash': 'd9ea269f6b13bea79e6af9a34b2e9312f5897b689664b9ac7a57f8e50c0034188a69631613901303048e7ade717ebb7d58cdb43147e5d1c9c37b33950cf64d82' }, # printf foopwd | sha512sum
    'sha256'   : { 'crypt':  9, 'hash': 'df6555b9bdcb7fbe4fe0f8986a446e6c6f5dbacdca4a36ff288041cd59b4fb5f' }, # printf foopwd | sha256sum
}

with subprocess.Popen('mysql', stdin=subprocess.PIPE, text=True) as mysql_client:
    users = ','.join(f"('{k}','{v['hash']}')" for k,v in passwords.items())
    maxlen = max(len(rec['hash']) for rec in passwords.values())
    mysql_client.communicate(f'''\
DROP DATABASE IF EXISTS {db};
CREATE DATABASE {db};
USE {db};
CREATE TABLE {db_table} (
  {user_column} VARCHAR (10) NOT NULL,
  {password_column} VARCHAR ({maxlen})
);
INSERT INTO {db_table} ({user_column}, {password_column})
  VALUES ('null', NULL), ('empty', ''), {users};
DROP USER IF EXISTS {db_user}@localhost;
CREATE USER {db_user}@localhost IDENTIFIED BY '{db_password}';
GRANT SELECT ON {db}.{db_table} TO {db_user}@localhost;
''')
    assert mysql_client.returncode == 0

Path(f'/etc/pam.d/{pam_service}').write_text(f'auth required pam_mysql.so config_file={config_file}\n')

def write_config_file(conf, nullok):
    crypt = conf['crypt']
    with open(config_file, 'w') as pam_mysql_conf:
        pam_mysql_conf.write(f'''\
users.host 		= localhost
users.database 		= {db}
users.db_user 		= {db_user}
users.db_passwd		= {db_password}
users.table 		= {db_table}
users.user_column 	= {user_column}
users.password_column 	= {password_column}
users.password_crypt 	= {crypt}
''')
        if 'md5' in conf:
            pam_mysql_conf.write(f'users.use_md5 = {conf["md5"]}\n')
        elif '323' in conf:
            pam_mysql_conf.write(f'users.use_323_password = {conf["323"]}\n')
        if nullok:
            pam_mysql_conf.write('nullok = yes\n')
    print(f'Module configured for password_crypt = {crypt}, nullok = {nullok}', flush=True)

def pam_conv(auth, query_list, userData):
    if query_list != [('Password:', PAM.PAM_PROMPT_ECHO_OFF)]:
        print('Unexpected query_list', query_list)
        return None
    return [(userData,0)]

def authenticate(user, password, flags):
    p = PAM.pam()
    p.start(pam_service, user, pam_conv)
    p.setUserData(password)
    try:
        p.authenticate(flags)
    except PAM.error as err:
        if err.args == ('Authentication failure', 7):
            return False
        else:
            raise
    else:
        return True

def check_and_log(user, password, flags, qualifier, expectation):
    accepted = authenticate(user, password, flags)
    success = accepted == expectation
    print(
        f'{"OK" if success else "FAIL"}: {user}: {qualifier} password {"accepted" if accepted else "refused"} under flags {flags}',
        flush=True,
    )
    return success

def check_scenarios(crypt, nullok):
    for flags in (0, PAM.PAM_DISALLOW_NULL_AUTHTOK):
        yield check_and_log(crypt, 'foopwd', flags, 'correct', True)
        yield check_and_log(crypt, 'wrong_password', flags, 'invalid', False)
        yield check_and_log(crypt, '', flags, 'empty', False)
        yield check_and_log('empty', '', flags, 'empty', crypt == 'plain')
        yield check_and_log('empty', 'any_password', flags, 'nonempty', False)
        yield check_and_log('null', '', flags, 'empty', nullok and flags == 0)
        yield check_and_log('null', 'any_password', flags, 'nonempty', nullok and flags == 0)

def check_configs():
    for crypt, conf in passwords.items():
        for nullok in (False, True):
            write_config_file(conf, nullok)
            yield from check_scenarios(crypt, nullok)

checks, successes = functools.reduce(
    lambda c, result: (c[0] + 1, c[1] + int(result)),
    check_configs(),
    (0, 0)
)

print(f'SUMMARY: ran {checks} tests; {successes} succeeded, {checks - successes} failed')
sys.exit(0 if checks == successes else 1)
