From 897ea9216f20e236e502ce45c175ae2f6d26c7b8 Mon Sep 17 00:00:00 2001 From: Ralf Becker Date: Wed, 4 May 2011 07:56:09 +0000 Subject: [PATCH] * Setup: making SSHA (salted sha1) hashes the default password hash for SQL and LDAP - fixing not working ssha hashes if mb_string.func_overload > 0 set --- phpgwapi/inc/class.auth.inc.php | 519 ++++++++++++++++++++++++++ phpgwapi/inc/common_functions.inc.php | 21 ++ setup/inc/class.setup_process.inc.php | 4 + 3 files changed, 544 insertions(+) create mode 100644 phpgwapi/inc/class.auth.inc.php diff --git a/phpgwapi/inc/class.auth.inc.php b/phpgwapi/inc/class.auth.inc.php new file mode 100644 index 0000000000..63ddff4d87 --- /dev/null +++ b/phpgwapi/inc/class.auth.inc.php @@ -0,0 +1,519 @@ + + * @author Miles Lott + * @copyright 2004 by Miles Lott + * @license http://opensource.org/licenses/lgpl-license.php LGPL - GNU Lesser General Public License + * @package api + * @subpackage authentication + * @version $Id$ + */ + +// allow to set an application depending authentication type (eg. for syncml, groupdav, ...) +if (isset($GLOBALS['egw_info']['server']['auth_type_'.$GLOBALS['egw_info']['flags']['currentapp']]) && + $GLOBALS['egw_info']['server']['auth_type_'.$GLOBALS['egw_info']['flags']['currentapp']]) +{ + $GLOBALS['egw_info']['server']['auth_type'] = $GLOBALS['egw_info']['server']['auth_type_'.$GLOBALS['egw_info']['flags']['currentapp']]; +} +if(empty($GLOBALS['egw_info']['server']['auth_type'])) +{ + $GLOBALS['egw_info']['server']['auth_type'] = 'sql'; +} +//error_log('using auth_type='.$GLOBALS['egw_info']['server']['auth_type'].', currentapp='.$GLOBALS['egw_info']['flags']['currentapp']); + +/** + * eGroupWare API - Authentication baseclass, password auth and crypt functions + * + * Many functions based on code from Frank Thomas + * which can be seen at http://www.thomas-alfeld.de/frank/ + * + * Other functions from class.common.inc.php originally from phpGroupWare + */ +class auth +{ + static $error; + + /** + * Holds instance of backend + * + * @var auth_backend + */ + private $backend; + + function __construct() + { + $backend_class = 'auth_'.$GLOBALS['egw_info']['server']['auth_type']; + + $this->backend = new $backend_class; + + if (!is_a($this->backend,'auth_backend')) + { + throw new egw_exception_assertion_failed("Auth backend class $backend_class is NO auth_backend!"); + } + } + + /** + * password authentication against password stored in sql datababse + * + * @param string $username username of account to authenticate + * @param string $passwd corresponding password + * @param string $passwd_type='text' 'text' for cleartext passwords (default) + * @return boolean true if successful authenticated, false otherwise + */ + function authenticate($username, $passwd, $passwd_type='text') + { + return $this->backend->authenticate($username, $passwd, $passwd_type); + } + + /** + * changes password in sql datababse + * + * @param string $old_passwd must be cleartext + * @param string $new_passwd must be cleartext + * @param int $account_id account id of user whose passwd should be changed + * @return boolean true if password successful changed, false otherwise + */ + function change_password($old_passwd, $new_passwd, $account_id=0) + { + return $this->backend->change_password($old_passwd, $new_passwd, $account_id); + } + + /** + * return a random string of size $size + * + * @param $size int-size of random string to return + */ + static function randomstring($size) + { + $s = ''; + $random_char = array( + '0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f', + 'g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v', + 'w','x','y','z','A','B','C','D','E','F','G','H','I','J','K','L', + 'M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z' + ); + + for ($i=0; $i<$size; $i++) + { + $s .= $random_char[mt_rand(1,61)]; + } + return $s; + } + + /** + * encrypt password + * + * uses the encryption type set in setup and calls the appropriate encryption functions + * + * @param $password password to encrypt + */ + static function encrypt_password($password,$sql=False) + { + if($sql) + { + return self::encrypt_sql($password); + } + return self::encrypt_ldap($password); + } + + /** + * compares an encrypted password + * + * encryption type set in setup and calls the appropriate encryption functions + * + * @param $cleartext cleartext password + * @param $encrypted encrypted password, can have a {hash} prefix, which overrides $type + * @param $type type of encryption + * @param $username used as optional key of encryption for md5_hmac + */ + static function compare_password($cleartext,$encrypted,$type,$username='') + { + // allow to specify the hash type to prefix the hash, to easy migrate passwords from ldap + $saved_enc = $encrypted; + if (preg_match('/^\\{([a-z_5]+)\\}(.+)$/i',$encrypted,$matches)) + { + $type = strtolower($matches[1]); + $encrypted = $matches[2]; + + switch($type) // some hashs are specially "packed" in ldap + { + case 'md5': + $encrypted = implode('',unpack('H*',base64_decode($encrypted))); + break; + case 'plain': + case 'crypt': + // nothing to do + break; + default: + $encrypted = $saved_enc; + // ToDo: the others ... + } + } + switch($type) + { + case 'plain': + if(strcmp($cleartext,$encrypted) == 0) + { + return True; + } + return False; + case 'smd5': + return self::smd5_compare($cleartext,$encrypted); + case 'sha': + return self::sha_compare($cleartext,$encrypted); + case 'ssha': + return self::ssha_compare($cleartext,$encrypted); + case 'crypt': + case 'md5_crypt': + case 'blowfish_crypt': + case 'ext_crypt': + return self::crypt_compare($cleartext,$encrypted,$type); + case 'md5_hmac': + return self::md5_hmac_compare($cleartext,$encrypted,$username); + case 'md5': + default: + return strcmp(md5($cleartext),$encrypted) == 0 ? true : false; + } + } + + /** + * encrypt password for ldap + * + * uses the encryption type set in setup and calls the appropriate encryption functions + * + * @param $password password to encrypt + */ + static function encrypt_ldap($password) + { + $type = strtolower($GLOBALS['egw_info']['server']['ldap_encryption_type']); + $salt = ''; + switch($type) + { + default: // eg. setup >> config never saved + case 'des': + $salt = self::randomstring(2); + $_password = crypt($password, $salt); + $e_password = '{crypt}'.$_password; + break; + case 'blowfish_crypt': + if(@defined('CRYPT_BLOWFISH') && CRYPT_BLOWFISH == 1) + { + $salt = '$2$' . self::randomstring(13); + $e_password = '{crypt}'.crypt($password,$salt); + break; + } + self::$error = 'no blowfish crypt'; + break; + case 'md5_crypt': + if(@defined('CRYPT_MD5') && CRYPT_MD5 == 1) + { + $salt = '$1$' . self::randomstring(9); + $e_password = '{crypt}'.crypt($password,$salt); + break; + } + self::$error = 'no md5 crypt'; + break; + case 'ext_crypt': + if(@defined('CRYPT_EXT_DES') && CRYPT_EXT_DES == 1) + { + $salt = self::randomstring(9); + $e_password = '{crypt}'.crypt($password,$salt); + break; + } + self::$error = 'no ext crypt'; + break; + case 'md5': + /* New method taken from the openldap-software list as recommended by + * Kervin L. Pierre" + */ + $e_password = '{md5}' . base64_encode(pack("H*",md5($password))); + break; + case 'smd5': + $salt = self::randomstring(8); + $hash = md5($password . $salt,true); + $e_password = '{SMD5}' . base64_encode($hash . $salt); + break; + case 'sha': + $e_password = '{SHA}' . base64_encode(sha1($password,true)); + break; + case 'ssha': + $salt = self::randomstring(8); + $hash = sha1($password . $salt,true); + $e_password = '{SSHA}' . base64_encode($hash . $salt); + break; + case 'plain': + // if plain no type is prepended + $e_password =$password; + break; + } + return $e_password; + } + + /** + * Create an ldap hash from an sql hash + * + * @param string $hash + */ + static function hash_sql2ldap($hash) + { + switch(strtolower($GLOBALS['egw_info']['server']['sql_encryption_type'])) + { + case '': // not set sql_encryption_type + case 'md5': + $hash = '{md5}' . base64_encode(pack("H*",$hash)); + break; + case 'crypt': + $hash = '{crypt}' . $hash; + break; + case 'plain': + $saved_h = $hash; + if (preg_match('/^\\{([a-z_5]+)\\}(.+)$/i',$hash,$matches)) + { + $hash= $matches[2]; + } else { + $hash = $saved_h; + } + break; + } + return $hash; + } + + /** + * Create a password for storage in the accounts table + * + * @param string $password + * @return string hash + */ + static function encrypt_sql($password) + { + /* Grab configured type, or default to md5() (old method) */ + $type = @$GLOBALS['egw_info']['server']['sql_encryption_type'] + ? strtolower($GLOBALS['egw_info']['server']['sql_encryption_type']) + : 'md5'; + + switch($type) + { + case 'plain': + // since md5 is the default, type plain must be prepended, for eGroupware to understand + return '{PLAIN}'.$password; + case 'crypt': + if(@defined('CRYPT_STD_DES') && CRYPT_STD_DES == 1) + { + $salt = self::randomstring(2); + return crypt($password,$salt); + } + self::$error = 'no std crypt'; + break; + case 'blowfish_crypt': + if(@defined('CRYPT_BLOWFISH') && CRYPT_BLOWFISH == 1) + { + $salt = '$2$' . self::randomstring(13); + return crypt($password,$salt); + } + self::$error = 'no blowfish crypt'; + break; + case 'md5_crypt': + if(@defined('CRYPT_MD5') && CRYPT_MD5 == 1) + { + $salt = '$1$' . self::randomstring(9); + return crypt($password,$salt); + } + self::$error = 'no md5 crypt'; + break; + case 'ext_crypt': + if(@defined('CRYPT_EXT_DES') && CRYPT_EXT_DES == 1) + { + $salt = self::randomstring(9); + return crypt($password,$salt); + } + self::$error = 'no ext crypt'; + break; + case 'smd5': + $salt = self::randomstring(8); + $hash = md5($password . $salt,true); + return '{SMD5}' . base64_encode($hash . $salt); + case 'sha': + return '{SHA}' . base64_encode(sha1($password,true)); + case 'ssha': + $salt = self::randomstring(8); + $hash = sha1($password . $salt,true); + return '{SSHA}' . base64_encode($hash . $salt); + case 'md5': + default: + /* This is the old standard for password storage in SQL */ + return md5($password); + } + if (!self::$error) + { + self::$error = 'no valid encryption available'; + } + return False; + } + + /** + * Checks if a given password is "safe" + * + * @param string $login + * @abstract atm a simple check in length, #digits, #uppercase and #lowercase + * could be made more safe using e.g. pecl library cracklib + * but as pecl dosn't run on any platform and isn't GPL'd + * i haven't implemented it yet + * Windows compatible check is: 7 char lenth, 1 Up, 1 Low, 1 Num and 1 Special + * @author cornelius weiss + * @return mixed false if password is considered "safe" or a string $message if "unsafe" + */ + static function crackcheck($passwd) + { + if (!preg_match('/.{'. ($noc=7). ',}/',$passwd)) + { + $message = lang('Password must have at least %1 characters',$noc). '
'; + } + if(!preg_match('/(.*\d.*){'. ($non=1). ',}/',$passwd)) + { + $message .= lang('Password must contain at least %1 numbers',$non). '
'; + } + if(!preg_match('/(.*[[:upper:]].*){'. ($nou=1). ',}/',$passwd)) + { + $message .= lang('Password must contain at least %1 uppercase letters',$nou). '
'; + } + if(!preg_match('/(.*[[:lower:]].*){'. ($nol=1). ',}/',$passwd)) + { + $message .= lang('Password must contain at least %1 lowercase letters',$nol). '
'; + } + if(!preg_match('/(.*[\\!"#$%&\'()*+,-.\/:;<=>?@\[\]\^_ {|}~`].*){'. ($nol=1). ',}/',$passwd)) + { + $message .= lang('Password must contain at least %1 special characters',$nol). '
'; + } + return $message ? $message : false; + } + + /** + * compare SMD5-encrypted passwords for authentication + * + * @param string $form_val user input value for comparison + * @param string $db_val stored value (from database) + * @return boolean True on successful comparison + */ + static function smd5_compare($form_val,$db_val) + { + /* Start with the first char after {SMD5} */ + $hash = base64_decode(substr($db_val,6)); + + /* SMD5 hashes are 16 bytes long */ + $orig_hash = cut_bytes($hash, 0, 16); // binary string need to use cut_bytes, not mb_substr(,,'utf-8')! + $salt = cut_bytes($hash, 16); + + $new_hash = md5($form_val . $salt,true); + //echo '
DB: ' . base64_encode($orig_hash) . '
FORM: ' . base64_encode($new_hash); + + return strcmp($orig_hash,$new_hash) == 0; + } + + /** + * compare SHA-encrypted passwords for authentication + * + * @param string $form_val user input value for comparison + * @param string $db_val stored value (from database) + * @return boolean True on successful comparison + */ + static function sha_compare($form_val,$db_val) + { + /* Start with the first char after {SHA} */ + $hash = base64_decode(substr($db_val,5)); + $new_hash = sha1($form_val,true); + //echo '
DB: ' . base64_encode($orig_hash) . '
FORM: ' . base64_encode($new_hash); + + return strcmp($hash,$new_hash) == 0; + } + + /** + * compare SSHA-encrypted passwords for authentication + * + * @param string $form_val user input value for comparison + * @param string $db_val stored value (from database) + * @return boolean True on successful comparison + */ + static function ssha_compare($form_val,$db_val) + { + /* Start with the first char after {SSHA} */ + $hash = base64_decode(substr($db_val, 6)); + + // SHA-1 hashes are 160 bits long + $orig_hash = cut_bytes($hash, 0, 20); // binary string need to use cut_bytes, not mb_substr(,,'utf-8')! + $salt = cut_bytes($hash, 20); + $new_hash = sha1($form_val . $salt,true); + + //error_log(__METHOD__."('$form_val', '$db_val') hash='$hash', orig_hash='$orig_hash', salt='$salt', new_hash='$new_hash' returning ".array2string(strcmp($orig_hash,$new_hash) == 0)); + return strcmp($orig_hash,$new_hash) == 0; + } + + /** + * compare crypted passwords for authentication whether des,ext_des,md5, or blowfish crypt + * + * @param string $form_val user input value for comparison + * @param string $db_val stored value (from database) + * @param string $type crypt() type + * @return boolean True on successful comparison + */ + static function crypt_compare($form_val,$db_val,$type) + { + $saltlen = array( + 'blowfish_crypt' => 16, + 'md5_crypt' => 12, + 'ext_crypt' => 9, + 'crypt' => 2 + ); + + // PHP's crypt(): salt + hash + // notice: "The encryption type is triggered by the salt argument." + $salt = substr($db_val, 0, (int)$saltlen[$type]); + $new_hash = crypt($form_val, $salt); + + return strcmp($db_val,$new_hash) == 0; + } + + /** + * compare md5_hmac-encrypted passwords for authentication (see RFC2104) + * + * @param string $form_val user input value for comparison + * @param string $db_val stored value (from database) + * @param string $key key for md5_hmac-encryption (username for imported smf users) + * @return boolean True on successful comparison + */ + static function md5_hmac_compare($form_val,$db_val,$key) + { + $key = str_pad(strlen($key) <= 64 ? $key : pack('H*', md5($key)), 64, chr(0x00)); + $md5_hmac = md5(($key ^ str_repeat(chr(0x5c), 64)) . pack('H*', md5(($key ^ str_repeat(chr(0x36), 64)). $form_val))); + + return strcmp($md5_hmac,$db_val) == 0; + } +} + +/** + * Interface for authentication backend + */ +interface auth_backend +{ + /** + * password authentication against password stored in sql datababse + * + * @param string $username username of account to authenticate + * @param string $passwd corresponding password + * @param string $passwd_type='text' 'text' for cleartext passwords (default) + * @return boolean true if successful authenticated, false otherwise + */ + function authenticate($username, $passwd, $passwd_type='text'); + + /** + * changes password in sql datababse + * + * @param string $old_passwd must be cleartext + * @param string $new_passwd must be cleartext + * @param int $account_id account id of user whose passwd should be changed + * @return boolean true if password successful changed, false otherwise + */ + function change_password($old_passwd, $new_passwd, $account_id=0); +} diff --git a/phpgwapi/inc/common_functions.inc.php b/phpgwapi/inc/common_functions.inc.php index eb621fa0f7..34a36c6e39 100755 --- a/phpgwapi/inc/common_functions.inc.php +++ b/phpgwapi/inc/common_functions.inc.php @@ -49,6 +49,27 @@ function bytes($str) return $func_overload & 2 ? mb_strlen($str,'ascii') : strlen($str); } +/** + * mbstring.func_overload safe substr + * + * @param string $data + * @param int $offset + * @param int $len + * @return string + */ +function cut_bytes(&$data,$offset,$len=null) +{ + static $func_overload; + + if (is_null($func_overload)) $func_overload = extension_loaded('mbstring') ? ini_get('mbstring.func_overload') : 0; + + if (is_null($len)) + { + return $func_overload ? mb_substr($data,$offset,bytes($data),'ascii') : substr($data,$offset); + } + return $func_overload ? mb_substr($data,$offset,$len,'ascii') : substr($data,$offset,$len); +} + /** * Format array or other types as (one-line) string, eg. for error_log statements * diff --git a/setup/inc/class.setup_process.inc.php b/setup/inc/class.setup_process.inc.php index 340e797f10..ec1b75b355 100755 --- a/setup/inc/class.setup_process.inc.php +++ b/setup/inc/class.setup_process.inc.php @@ -257,6 +257,7 @@ class setup_process { unset($current_config['aspell_path']); } + // RalfBecker: php.net recommend this for security reasons, it should be our default too $current_config['usecookies'] = 'True'; @@ -279,6 +280,9 @@ class setup_process $current_config['postpone_statistics_submit'] = time() + 2 * 30 * 3600; // ask user in 2 month from now, when he has something to report + // use ssha (salted sha1) password hashes by default + $current_config['sql_encryption_type'] = $current_config['ldap_encryption_type'] = 'ssha'; + if ($preset_config) { $current_config = array_merge($current_config,$preset_config);