php-src/ext/standard/password.c

/*
   +----------------------------------------------------------------------+
   | PHP Version 5                                                        |
   +----------------------------------------------------------------------+
   | Copyright (c) 1997-2012 The PHP Group                                |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.php.net/license/3_01.txt                                  |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Authors: Anthony Ferrara <ircmaxell@php.net>                         |
   +----------------------------------------------------------------------+
*/

/* $Id$ */

#include <stdlib.h>

#include "php.h"
#if HAVE_CRYPT
#include "php_crypt.h"
#endif

#include "php_password.h"
#include "php_rand.h"
#include "base64.h"
#include "zend_interfaces.h"

PHP_MINIT_FUNCTION(password) /* {{{ */
{
	REGISTER_STRING_CONSTANT("PASSWORD_DEFAULT", PHP_PASSWORD_DEFAULT, CONST_CS | CONST_PERSISTENT);
	REGISTER_STRING_CONSTANT("PASSWORD_BCRYPT", PHP_PASSWORD_BCRYPT, CONST_CS | CONST_PERSISTENT);
	REGISTER_STRING_CONSTANT("PASSWORD_MD5", PHP_PASSWORD_MD5, CONST_CS | CONST_PERSISTENT);
	REGISTER_STRING_CONSTANT("PASSWORD_SHA256", PHP_PASSWORD_SHA256, CONST_CS | CONST_PERSISTENT);
	REGISTER_STRING_CONSTANT("PASSWORD_SHA512", PHP_PASSWORD_SHA512, CONST_CS | CONST_PERSISTENT);
	return SUCCESS;
}
/* }}} */


static int php_password_salt_is_alphabet(const char *str, const int len)
{
        int i = 0;

        for (i = 0; i < len; i++) {
                if (!((str[i] >= 'A' && str[i] <= 'Z') || (str[i] >= 'a' && str[i] <= 'z') || (str[i] >= '0' && str[i] <= '9') || str[i] == '.' || str[i] == '/')) {
                        return 0;
                }
        }
        return 1;
}

static int php_password_salt_to64(const char *str, const int str_len, const int out_len, char *ret)
{
        int pos = 0;
	unsigned char *buffer;
        buffer = php_base64_encode((unsigned char*) str, str_len, NULL);
        for (pos = 0; pos < out_len; pos++) {
                if (buffer[pos] == '+') {
                        ret[pos] = '.';
		} else if (buffer[pos] == '=') {
			efree(buffer);
			return FAILURE;
                } else {
			ret[pos] = buffer[pos];
		}
        }
	efree(buffer);
	return SUCCESS;
}

static int php_password_make_salt(int length, int raw, char *ret)
{
	int i, raw_length;
	char *buffer;
	if (raw) {
		raw_length = length;
	} else {
		raw_length = length * 3 / 4 + 1;
	}
	buffer = (char *) emalloc(raw_length + 1);
	
	/* Temp Placeholder */
	for (i = 0; i < raw_length; i++) {
		buffer[i] = i;
	}
	/* /Temp Placeholder */

	if (raw) {
		memcpy(ret, buffer, length);
	} else {
		char *result;
		result = emalloc(length + 1); 
		if (php_password_salt_to64(buffer, raw_length, length, result) == FAILURE) {
			php_error_docref(NULL, E_WARNING, "Generated salt too short");
			efree(buffer);
			efree(result);
			return FAILURE;
		} else {
			memcpy(ret, result, length);
			efree(result);
		}
	}
	efree(buffer);
	ret[length] = 0;
	return SUCCESS;
} 

PHP_FUNCTION(password_verify)
{
	zval *password, *hash, *ret;
	int status = 0, i;

	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zz", &password, &hash) == FAILURE) {
                RETURN_FALSE;
        }

	zend_call_method_with_2_params(NULL, NULL, NULL, "crypt", &ret, password, hash);
	
	if (Z_TYPE_P(ret) != IS_STRING) {
		zval_ptr_dtor(&ret);
		RETURN_FALSE;
	}

	if (Z_STRLEN_P(ret) != Z_STRLEN_P(hash)) {
		zval_ptr_dtor(&ret);
		RETURN_FALSE;
	}

	for (i = 0; i < Z_STRLEN_P(ret); i++) {
		status |= (Z_STRVAL_P(ret)[i] ^ Z_STRVAL_P(hash)[i]);
	}

	zval_ptr_dtor(&ret);

	RETURN_BOOL(status == 0);
	
}

PHP_FUNCTION(password_make_salt)
{
	char *salt;
	int length = 0;
	zend_bool raw_output = 0;
	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|b", &length, &raw_output) == FAILURE) {
                RETURN_FALSE;
        }
	if (length <= 0) {
		php_error_docref(NULL TSRMLS_CC, E_WARNING, "Length cannot be less than or equal zero: %d", length);
		RETURN_FALSE;
	}
	salt = emalloc(length + 1);
	if (php_password_make_salt(length, (int) raw_output, salt) == FAILURE) {
		efree(salt);
		RETURN_FALSE;
	}
	RETURN_STRINGL(salt, length, 0);
}


/* {{{ proto string password(string password, string algo = PASSWORD_DEFAULT, array options = array())
Hash a password */
PHP_FUNCTION(password_create)
{
        char *algo = 0, *hash_format, *hash, *salt;
        int algo_len = 0, salt_len = 0, required_salt_len = 0, hash_format_len;
        HashTable *options = 0;
        zval **option_buffer, *ret, *password, *hash_zval;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|sH", &password, &algo, &algo_len, &options) == FAILURE) {
                RETURN_FALSE;
        }

	if (Z_TYPE_P(password) != IS_STRING) {
		php_error_docref(NULL TSRMLS_CC, E_WARNING, "Password must be a string");
		RETURN_FALSE;
	}

        if (algo_len == 0) {
		algo = PHP_PASSWORD_DEFAULT;
                algo_len = strlen(PHP_PASSWORD_DEFAULT);
        }

        if (strcmp(algo, PHP_PASSWORD_BCRYPT) == 0) {
		int cost = PHP_PASSWORD_BCRYPT_DEFAULT_COST;
		if (options && zend_symtable_find(options, "cost", 5, (void **) &option_buffer) == SUCCESS) {
			convert_to_long_ex(option_buffer);
			cost = Z_LVAL_PP(option_buffer);
			zval_ptr_dtor(option_buffer);
			if (cost < 4 || cost > 31) {
				php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid bcrypt cost parameter specified: %d", cost);
        		        RETURN_FALSE;
			}
		}
                required_salt_len = 22;
		hash_format = emalloc(8);
		sprintf(hash_format, "$2y$%02d$", cost);
		hash_format_len = 7;
        } else if (strcmp(algo, PHP_PASSWORD_MD5) == 0) {
                required_salt_len = 12;
		hash_format = emalloc(4);
		memcpy(hash_format, "$1$", 3);
		hash_format_len = 3;
        } else if (strcmp(algo, PHP_PASSWORD_SHA256) == 0 || strcmp(algo, PHP_PASSWORD_SHA512) == 0) {
                int rounds = PHP_PASSWORD_SHA_DEFAULT_ROUNDS;
                if (options && zend_symtable_find(options, "rounds", 7, (void **) &option_buffer) == SUCCESS) {
                        convert_to_long_ex(option_buffer);
                        rounds = Z_LVAL_PP(option_buffer);
                        zval_ptr_dtor(option_buffer);
                        if (rounds < 1000 || rounds > 999999999) {
                                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid SHA rounds parameter specified: %d", rounds);
                                RETURN_FALSE;
                        }
                }
                required_salt_len = 16;
		hash_format = emalloc(21);
		sprintf(hash_format, "$%s$rounds=%d$", algo, rounds);
		hash_format_len = strlen(hash_format);
        } else {
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unknown password hashing algorithm: %s", algo);
                RETURN_FALSE;
        }

        if (options && zend_symtable_find(options, "salt", 5, (void**) &option_buffer) == SUCCESS) {
		char *buffer;
		int buffer_len;
                if (Z_TYPE_PP(option_buffer) == IS_STRING) {
                        buffer = Z_STRVAL_PP(option_buffer);
                        buffer_len = Z_STRLEN_PP(option_buffer);
                } else {
                        zval_ptr_dtor(option_buffer);
			efree(hash_format);
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Non-string salt parameter supplied");
                        RETURN_FALSE;
                }
                if (buffer_len < required_salt_len) {
			efree(hash_format);
		        zval_ptr_dtor(option_buffer);
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Provided salt is too short: %d expecting %d", buffer_len, required_salt_len);
                        RETURN_FALSE;
                } else if (0 == php_password_salt_is_alphabet(buffer, buffer_len)) {
			salt = emalloc(required_salt_len + 1);
                        if (php_password_salt_to64(buffer, buffer_len, required_salt_len, salt) == FAILURE) {
				efree(hash_format);
				efree(salt);
			        zval_ptr_dtor(option_buffer);
	                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Provided salt is too short: %d", salt_len);
				RETURN_FALSE;
			}
                        salt_len = required_salt_len;
                } else {
			salt = emalloc(required_salt_len + 1);
			memcpy(salt, buffer, required_salt_len);
                        salt_len = required_salt_len;
		}
		zval_ptr_dtor(option_buffer);
        } else {
		salt = emalloc(required_salt_len + 1);
		if (php_password_make_salt(required_salt_len, 0, salt) == FAILURE) {
			efree(hash_format);
			efree(salt);
			RETURN_FALSE;
		}
                salt_len = required_salt_len;
        }
	
	salt[salt_len] = 0;

	hash = emalloc(salt_len + hash_format_len + 1);
	sprintf(hash, "%s%s", hash_format, salt);
	hash[hash_format_len + salt_len] = 0;

	ALLOC_INIT_ZVAL(hash_zval);
	ZVAL_STRINGL(hash_zval, hash, hash_format_len + salt_len, 0);

	efree(hash_format);
	efree(salt);

	zend_call_method_with_2_params(NULL, NULL, NULL, "crypt", &ret, password, hash_zval);

	zval_ptr_dtor(&hash_zval);

	if (Z_TYPE_P(ret) != IS_STRING) {
		zval_ptr_dtor(&ret);
		RETURN_FALSE;
	} else if(Z_STRLEN_P(ret) < 13) {
		zval_ptr_dtor(&ret);
		RETURN_FALSE;
	}

	RETURN_ZVAL(ret, 0, 1);
}
/* }}} */

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: sw=4 ts=4 fdm=marker
 * vim<600: sw=4 ts=4
 */