xref: /php-src/ext/standard/password.c (revision 0ba5229a)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Anthony Ferrara <ircmaxell@php.net>                         |
14    |          Charles R. Portwood II <charlesportwoodii@erianna.com>      |
15    +----------------------------------------------------------------------+
16 */
17 
18 #include <stdlib.h>
19 
20 #include "php.h"
21 
22 #include "fcntl.h"
23 #include "php_password.h"
24 #include "php_crypt.h"
25 #include "base64.h"
26 #include "zend_interfaces.h"
27 #include "info.h"
28 #include "ext/random/php_random_csprng.h"
29 #include "password_arginfo.h"
30 #ifdef HAVE_ARGON2LIB
31 #include "argon2.h"
32 #endif
33 
34 #ifdef PHP_WIN32
35 #include "win32/winutil.h"
36 #endif
37 
38 static zend_array php_password_algos;
39 
php_password_algo_register(const char * ident,const php_password_algo * algo)40 int php_password_algo_register(const char *ident, const php_password_algo *algo) {
41 	zend_string *key = zend_string_init_interned(ident, strlen(ident), 1);
42 	return zend_hash_add_ptr(&php_password_algos, key, (void *) algo) ? SUCCESS : FAILURE;
43 }
44 
php_password_algo_unregister(const char * ident)45 void php_password_algo_unregister(const char *ident) {
46 	zend_hash_str_del(&php_password_algos, ident, strlen(ident));
47 }
48 
php_password_salt_to64(const char * str,const size_t str_len,const size_t out_len,char * ret)49 static int php_password_salt_to64(const char *str, const size_t str_len, const size_t out_len, char *ret) /* {{{ */
50 {
51 	size_t pos = 0;
52 	zend_string *buffer;
53 	if ((int) str_len < 0) {
54 		return FAILURE;
55 	}
56 	buffer = php_base64_encode((unsigned char*) str, str_len);
57 	if (ZSTR_LEN(buffer) < out_len) {
58 		/* Too short of an encoded string generated */
59 		zend_string_release_ex(buffer, 0);
60 		return FAILURE;
61 	}
62 	for (pos = 0; pos < out_len; pos++) {
63 		if (ZSTR_VAL(buffer)[pos] == '+') {
64 			ret[pos] = '.';
65 		} else if (ZSTR_VAL(buffer)[pos] == '=') {
66 			zend_string_free(buffer);
67 			return FAILURE;
68 		} else {
69 			ret[pos] = ZSTR_VAL(buffer)[pos];
70 		}
71 	}
72 	zend_string_free(buffer);
73 	return SUCCESS;
74 }
75 /* }}} */
76 
php_password_make_salt(size_t length)77 static zend_string* php_password_make_salt(size_t length) /* {{{ */
78 {
79 	zend_string *ret, *buffer;
80 
81 	if (length > (INT_MAX / 3)) {
82 		zend_value_error("Length is too large to safely generate");
83 		return NULL;
84 	}
85 
86 	buffer = zend_string_alloc(length * 3 / 4 + 1, 0);
87 	if (FAILURE == php_random_bytes_throw(ZSTR_VAL(buffer), ZSTR_LEN(buffer))) {
88 		zend_value_error("Unable to generate salt");
89 		zend_string_release_ex(buffer, 0);
90 		return NULL;
91 	}
92 
93 	ret = zend_string_alloc(length, 0);
94 	if (php_password_salt_to64(ZSTR_VAL(buffer), ZSTR_LEN(buffer), length, ZSTR_VAL(ret)) == FAILURE) {
95 		zend_value_error("Generated salt too short");
96 		zend_string_release_ex(buffer, 0);
97 		zend_string_release_ex(ret, 0);
98 		return NULL;
99 	}
100 	zend_string_release_ex(buffer, 0);
101 	ZSTR_VAL(ret)[length] = 0;
102 	return ret;
103 }
104 /* }}} */
105 
php_password_get_salt(zval * unused_,size_t required_salt_len,HashTable * options)106 static zend_string* php_password_get_salt(zval *unused_, size_t required_salt_len, HashTable *options) {
107 	if (options && zend_hash_str_exists(options, "salt", sizeof("salt") - 1)) {
108 		php_error_docref(NULL, E_WARNING, "The \"salt\" option has been ignored, since providing a custom salt is no longer supported");
109 	}
110 
111 	return php_password_make_salt(required_salt_len);
112 }
113 
114 /* bcrypt implementation */
115 
php_password_bcrypt_valid(const zend_string * hash)116 static bool php_password_bcrypt_valid(const zend_string *hash) {
117 	const char *h = ZSTR_VAL(hash);
118 	return (ZSTR_LEN(hash) == 60) &&
119 		(h[0] == '$') && (h[1] == '2') && (h[2] == 'y');
120 }
121 
php_password_bcrypt_get_info(zval * return_value,const zend_string * hash)122 static int php_password_bcrypt_get_info(zval *return_value, const zend_string *hash) {
123 	zend_long cost = PHP_PASSWORD_BCRYPT_COST;
124 
125 	if (!php_password_bcrypt_valid(hash)) {
126 		/* Should never get called this way. */
127 		return FAILURE;
128 	}
129 
130 	sscanf(ZSTR_VAL(hash), "$2y$" ZEND_LONG_FMT "$", &cost);
131 	add_assoc_long(return_value, "cost", cost);
132 
133 	return SUCCESS;
134 }
135 
php_password_bcrypt_needs_rehash(const zend_string * hash,zend_array * options)136 static bool php_password_bcrypt_needs_rehash(const zend_string *hash, zend_array *options) {
137 	zval *znew_cost;
138 	zend_long old_cost = PHP_PASSWORD_BCRYPT_COST;
139 	zend_long new_cost = PHP_PASSWORD_BCRYPT_COST;
140 
141 	if (!php_password_bcrypt_valid(hash)) {
142 		/* Should never get called this way. */
143 		return 1;
144 	}
145 
146 	sscanf(ZSTR_VAL(hash), "$2y$" ZEND_LONG_FMT "$", &old_cost);
147 	if (options && (znew_cost = zend_hash_str_find(options, "cost", sizeof("cost")-1)) != NULL) {
148 		new_cost = zval_get_long(znew_cost);
149 	}
150 
151 	return old_cost != new_cost;
152 }
153 
php_password_bcrypt_verify(const zend_string * password,const zend_string * hash)154 static bool php_password_bcrypt_verify(const zend_string *password, const zend_string *hash) {
155 	int status = 0;
156 	zend_string *ret = php_crypt(ZSTR_VAL(password), (int)ZSTR_LEN(password), ZSTR_VAL(hash), (int)ZSTR_LEN(hash), 1);
157 
158 	if (!ret) {
159 		return 0;
160 	}
161 
162 	if (ZSTR_LEN(hash) < 13) {
163 		zend_string_free(ret);
164 		return 0;
165 	}
166 
167 	/* We're using this method instead of == in order to provide
168 	 * resistance towards timing attacks. This is a constant time
169 	 * equality check that will always check every byte of both
170 	 * values. */
171 	status = php_safe_bcmp(ret, hash);
172 
173 	zend_string_free(ret);
174 	return status == 0;
175 }
176 
php_password_bcrypt_hash(const zend_string * password,zend_array * options)177 static zend_string* php_password_bcrypt_hash(const zend_string *password, zend_array *options) {
178 	char hash_format[10];
179 	size_t hash_format_len;
180 	zend_string *result, *hash, *salt;
181 	zval *zcost;
182 	zend_long cost = PHP_PASSWORD_BCRYPT_COST;
183 
184 	if (memchr(ZSTR_VAL(password), '\0', ZSTR_LEN(password))) {
185 		zend_value_error("Bcrypt password must not contain null character");
186 		return NULL;
187 	}
188 
189 	if (options && (zcost = zend_hash_str_find(options, "cost", sizeof("cost")-1)) != NULL) {
190 		cost = zval_get_long(zcost);
191 	}
192 
193 	if (cost < 4 || cost > 31) {
194 		zend_value_error("Invalid bcrypt cost parameter specified: " ZEND_LONG_FMT, cost);
195 		return NULL;
196 	}
197 
198 	hash_format_len = snprintf(hash_format, sizeof(hash_format), "$2y$%02" ZEND_LONG_FMT_SPEC "$", cost);
199 	if (!(salt = php_password_get_salt(NULL, Z_UL(22), options))) {
200 		return NULL;
201 	}
202 	ZSTR_VAL(salt)[ZSTR_LEN(salt)] = 0;
203 
204 	hash = zend_string_alloc(ZSTR_LEN(salt) + hash_format_len, 0);
205 	sprintf(ZSTR_VAL(hash), "%s%s", hash_format, ZSTR_VAL(salt));
206 	ZSTR_VAL(hash)[hash_format_len + ZSTR_LEN(salt)] = 0;
207 
208 	zend_string_release_ex(salt, 0);
209 
210 	/* This cast is safe, since both values are defined here in code and cannot overflow */
211 	result = php_crypt(ZSTR_VAL(password), (int)ZSTR_LEN(password), ZSTR_VAL(hash), (int)ZSTR_LEN(hash), 1);
212 	zend_string_release_ex(hash, 0);
213 
214 	if (!result) {
215 		return NULL;
216 	}
217 
218 	if (ZSTR_LEN(result) < 13) {
219 		zend_string_free(result);
220 		return NULL;
221 	}
222 
223 	return result;
224 }
225 
226 const php_password_algo php_password_algo_bcrypt = {
227 	"bcrypt",
228 	php_password_bcrypt_hash,
229 	php_password_bcrypt_verify,
230 	php_password_bcrypt_needs_rehash,
231 	php_password_bcrypt_get_info,
232 	php_password_bcrypt_valid,
233 };
234 
235 
236 #ifdef HAVE_ARGON2LIB
237 /* argon2i/argon2id shared implementation */
238 
extract_argon2_parameters(const zend_string * hash,zend_long * v,zend_long * memory_cost,zend_long * time_cost,zend_long * threads)239 static int extract_argon2_parameters(const zend_string *hash,
240 									  zend_long *v, zend_long *memory_cost,
241 									  zend_long *time_cost, zend_long *threads) /* {{{ */
242 {
243 	const char *p = ZSTR_VAL(hash);
244 	if (!hash || (ZSTR_LEN(hash) < sizeof("$argon2id$"))) {
245 		return FAILURE;
246 	}
247 	if (!memcmp(p, "$argon2i$", sizeof("$argon2i$") - 1)) {
248 		p += sizeof("$argon2i$") - 1;
249 	} else if (!memcmp(p, "$argon2id$", sizeof("$argon2id$") - 1)) {
250 		p += sizeof("$argon2id$") - 1;
251 	} else {
252 		return FAILURE;
253 	}
254 
255 	sscanf(p, "v=" ZEND_LONG_FMT "$m=" ZEND_LONG_FMT ",t=" ZEND_LONG_FMT ",p=" ZEND_LONG_FMT,
256 	       v, memory_cost, time_cost, threads);
257 
258 	return SUCCESS;
259 }
260 /* }}} */
261 
php_password_argon2_get_info(zval * return_value,const zend_string * hash)262 static int php_password_argon2_get_info(zval *return_value, const zend_string *hash) {
263 	zend_long v = 0;
264 	zend_long memory_cost = PHP_PASSWORD_ARGON2_MEMORY_COST;
265 	zend_long time_cost = PHP_PASSWORD_ARGON2_TIME_COST;
266 	zend_long threads = PHP_PASSWORD_ARGON2_THREADS;
267 
268 	extract_argon2_parameters(hash, &v, &memory_cost, &time_cost, &threads);
269 
270 	add_assoc_long(return_value, "memory_cost", memory_cost);
271 	add_assoc_long(return_value, "time_cost", time_cost);
272 	add_assoc_long(return_value, "threads", threads);
273 
274 	return SUCCESS;
275 }
276 
php_password_argon2_needs_rehash(const zend_string * hash,zend_array * options)277 static bool php_password_argon2_needs_rehash(const zend_string *hash, zend_array *options) {
278 	zend_long v = 0;
279 	zend_long new_memory_cost = PHP_PASSWORD_ARGON2_MEMORY_COST, memory_cost = 0;
280 	zend_long new_time_cost = PHP_PASSWORD_ARGON2_TIME_COST, time_cost = 0;
281 	zend_long new_threads = PHP_PASSWORD_ARGON2_THREADS, threads = 0;
282 	zval *option_buffer;
283 
284 	if (options && (option_buffer = zend_hash_str_find(options, "memory_cost", sizeof("memory_cost")-1)) != NULL) {
285 		new_memory_cost = zval_get_long(option_buffer);
286 	}
287 
288 	if (options && (option_buffer = zend_hash_str_find(options, "time_cost", sizeof("time_cost")-1)) != NULL) {
289 		new_time_cost = zval_get_long(option_buffer);
290 	}
291 
292 	if (options && (option_buffer = zend_hash_str_find(options, "threads", sizeof("threads")-1)) != NULL) {
293 		new_threads = zval_get_long(option_buffer);
294 	}
295 
296 	extract_argon2_parameters(hash, &v, &memory_cost, &time_cost, &threads);
297 
298 	return (new_time_cost != time_cost) ||
299 			(new_memory_cost != memory_cost) ||
300 			(new_threads != threads);
301 }
302 
php_password_argon2_hash(const zend_string * password,zend_array * options,argon2_type type)303 static zend_string *php_password_argon2_hash(const zend_string *password, zend_array *options, argon2_type type) {
304 	zval *option_buffer;
305 	zend_string *salt, *out, *encoded;
306 	size_t time_cost = PHP_PASSWORD_ARGON2_TIME_COST;
307 	size_t memory_cost = PHP_PASSWORD_ARGON2_MEMORY_COST;
308 	size_t threads = PHP_PASSWORD_ARGON2_THREADS;
309 	size_t encoded_len;
310 	int status = 0;
311 
312 	if (options && (option_buffer = zend_hash_str_find(options, "memory_cost", sizeof("memory_cost")-1)) != NULL) {
313 		memory_cost = zval_get_long(option_buffer);
314 	}
315 
316 	if (memory_cost > ARGON2_MAX_MEMORY || memory_cost < ARGON2_MIN_MEMORY) {
317 		zend_value_error("Memory cost is outside of allowed memory range");
318 		return NULL;
319 	}
320 
321 	if (options && (option_buffer = zend_hash_str_find(options, "time_cost", sizeof("time_cost")-1)) != NULL) {
322 		time_cost = zval_get_long(option_buffer);
323 	}
324 
325 	if (time_cost > ARGON2_MAX_TIME || time_cost < ARGON2_MIN_TIME) {
326 		zend_value_error("Time cost is outside of allowed time range");
327 		return NULL;
328 	}
329 
330 	if (options && (option_buffer = zend_hash_str_find(options, "threads", sizeof("threads")-1)) != NULL) {
331 		threads = zval_get_long(option_buffer);
332 	}
333 
334 	if (threads > ARGON2_MAX_LANES || threads == 0) {
335 		zend_value_error("Invalid number of threads");
336 		return NULL;
337 	}
338 
339 	if (!(salt = php_password_get_salt(NULL, Z_UL(16), options))) {
340 		return NULL;
341 	}
342 
343 	out = zend_string_alloc(32, 0);
344 	encoded_len = argon2_encodedlen(
345 		time_cost,
346 		memory_cost,
347 		threads,
348 		(uint32_t)ZSTR_LEN(salt),
349 		ZSTR_LEN(out),
350 		type
351 	);
352 
353 	encoded = zend_string_alloc(encoded_len - 1, 0);
354 	status = argon2_hash(
355 		time_cost,
356 		memory_cost,
357 		threads,
358 		ZSTR_VAL(password),
359 		ZSTR_LEN(password),
360 		ZSTR_VAL(salt),
361 		ZSTR_LEN(salt),
362 		ZSTR_VAL(out),
363 		ZSTR_LEN(out),
364 		ZSTR_VAL(encoded),
365 		encoded_len,
366 		type,
367 		ARGON2_VERSION_NUMBER
368 	);
369 
370 	zend_string_release_ex(out, 0);
371 	zend_string_release_ex(salt, 0);
372 
373 	if (status != ARGON2_OK) {
374 		zend_string_efree(encoded);
375 		zend_value_error("%s", argon2_error_message(status));
376 		return NULL;
377 	}
378 
379 	ZSTR_VAL(encoded)[ZSTR_LEN(encoded)] = 0;
380 	return encoded;
381 }
382 
383 /* argon2i specific methods */
384 
php_password_argon2i_verify(const zend_string * password,const zend_string * hash)385 static bool php_password_argon2i_verify(const zend_string *password, const zend_string *hash) {
386 	return ARGON2_OK == argon2_verify(ZSTR_VAL(hash), ZSTR_VAL(password), ZSTR_LEN(password), Argon2_i);
387 }
388 
php_password_argon2i_hash(const zend_string * password,zend_array * options)389 static zend_string *php_password_argon2i_hash(const zend_string *password, zend_array *options) {
390 	return php_password_argon2_hash(password, options, Argon2_i);
391 }
392 
393 const php_password_algo php_password_algo_argon2i = {
394 	"argon2i",
395 	php_password_argon2i_hash,
396 	php_password_argon2i_verify,
397 	php_password_argon2_needs_rehash,
398 	php_password_argon2_get_info,
399 	NULL,
400 };
401 
402 /* argon2id specific methods */
403 
php_password_argon2id_verify(const zend_string * password,const zend_string * hash)404 static bool php_password_argon2id_verify(const zend_string *password, const zend_string *hash) {
405 	return ARGON2_OK == argon2_verify(ZSTR_VAL(hash), ZSTR_VAL(password), ZSTR_LEN(password), Argon2_id);
406 }
407 
php_password_argon2id_hash(const zend_string * password,zend_array * options)408 static zend_string *php_password_argon2id_hash(const zend_string *password, zend_array *options) {
409 	return php_password_argon2_hash(password, options, Argon2_id);
410 }
411 
412 const php_password_algo php_password_algo_argon2id = {
413 	"argon2id",
414 	php_password_argon2id_hash,
415 	php_password_argon2id_verify,
416 	php_password_argon2_needs_rehash,
417 	php_password_argon2_get_info,
418 	NULL,
419 };
420 #endif
421 
PHP_MINIT_FUNCTION(password)422 PHP_MINIT_FUNCTION(password) /* {{{ */
423 {
424 	zend_hash_init(&php_password_algos, 4, NULL, ZVAL_PTR_DTOR, 1);
425 
426 	register_password_symbols(module_number);
427 
428 	if (FAILURE == php_password_algo_register("2y", &php_password_algo_bcrypt)) {
429 		return FAILURE;
430 	}
431 
432 #ifdef HAVE_ARGON2LIB
433 	if (FAILURE == php_password_algo_register("argon2i", &php_password_algo_argon2i)) {
434 		return FAILURE;
435 	}
436 	if (FAILURE == php_password_algo_register("argon2id", &php_password_algo_argon2id)) {
437 		return FAILURE;
438 	}
439 #endif
440 
441 	return SUCCESS;
442 }
443 /* }}} */
444 
PHP_MSHUTDOWN_FUNCTION(password)445 PHP_MSHUTDOWN_FUNCTION(password) /* {{{ */
446 {
447 #ifdef ZTS
448 	if (!tsrm_is_main_thread()) {
449 		return SUCCESS;
450 	}
451 #endif
452 	zend_hash_destroy(&php_password_algos);
453 	return SUCCESS;
454 }
455 /* }}} */
456 
php_password_algo_default(void)457 const php_password_algo* php_password_algo_default(void) {
458 	return &php_password_algo_bcrypt;
459 }
460 
php_password_algo_find(const zend_string * ident)461 const php_password_algo* php_password_algo_find(const zend_string *ident) {
462 	zval *tmp;
463 
464 	if (!ident) {
465 		return NULL;
466 	}
467 
468 	tmp = zend_hash_find(&php_password_algos, (zend_string*)ident);
469 	if (!tmp || (Z_TYPE_P(tmp) != IS_PTR)) {
470 		return NULL;
471 	}
472 
473 	return Z_PTR_P(tmp);
474 }
475 
php_password_algo_find_zval(zend_string * arg_str,zend_long arg_long,bool arg_is_null)476 static const php_password_algo* php_password_algo_find_zval(zend_string *arg_str, zend_long arg_long, bool arg_is_null) {
477 	if (arg_is_null) {
478 		return php_password_algo_default();
479 	}
480 
481 	if (arg_str) {
482 		return php_password_algo_find(arg_str);
483 	}
484 
485 	switch (arg_long) {
486 		case 0: return php_password_algo_default();
487 		case 1: return &php_password_algo_bcrypt;
488 #ifdef HAVE_ARGON2LIB
489 		case 2: return &php_password_algo_argon2i;
490 		case 3: return &php_password_algo_argon2id;
491 #else
492 		case 2:
493 			{
494 			zend_string *n = ZSTR_INIT_LITERAL("argon2i", 0);
495 			const php_password_algo* ret = php_password_algo_find(n);
496 			zend_string_release(n);
497 			return ret;
498 			}
499 		case 3:
500 			{
501 			zend_string *n = ZSTR_INIT_LITERAL("argon2id", 0);
502 			const php_password_algo* ret = php_password_algo_find(n);
503 			zend_string_release(n);
504 			return ret;
505 			}
506 #endif
507 	}
508 
509 	return NULL;
510 }
511 
php_password_algo_extract_ident(const zend_string * hash)512 zend_string *php_password_algo_extract_ident(const zend_string* hash) {
513 	const char *ident, *ident_end;
514 
515 	if (!hash || ZSTR_LEN(hash) < 3) {
516 		/* Minimum prefix: "$x$" */
517 		return NULL;
518 	}
519 
520 	ident = ZSTR_VAL(hash) + 1;
521 	ident_end = strchr(ident, '$');
522 	if (!ident_end) {
523 		/* No terminating '$' */
524 		return NULL;
525 	}
526 
527 	return zend_string_init(ident, ident_end - ident, 0);
528 }
529 
php_password_algo_identify_ex(const zend_string * hash,const php_password_algo * default_algo)530 const php_password_algo* php_password_algo_identify_ex(const zend_string* hash, const php_password_algo *default_algo) {
531 	const php_password_algo *algo;
532 	zend_string *ident = php_password_algo_extract_ident(hash);
533 
534 	if (!ident) {
535 		return default_algo;
536 	}
537 
538 	algo = php_password_algo_find(ident);
539 	zend_string_release(ident);
540 	return (!algo || (algo->valid && !algo->valid(hash))) ? default_algo : algo;
541 }
542 
543 /* {{{ Retrieves information about a given hash */
PHP_FUNCTION(password_get_info)544 PHP_FUNCTION(password_get_info)
545 {
546 	const php_password_algo *algo;
547 	zend_string *hash, *ident;
548 	zval options;
549 
550 	ZEND_PARSE_PARAMETERS_START(1, 1)
551 		Z_PARAM_STR(hash)
552 	ZEND_PARSE_PARAMETERS_END();
553 
554 	array_init(return_value);
555 	array_init(&options);
556 
557 	ident = php_password_algo_extract_ident(hash);
558 	algo = php_password_algo_find(ident);
559 	if (!algo || (algo->valid && !algo->valid(hash))) {
560 		if (ident) {
561 			zend_string_release(ident);
562 		}
563 		add_assoc_null(return_value, "algo");
564 		add_assoc_string(return_value, "algoName", "unknown");
565 		add_assoc_zval(return_value, "options", &options);
566 		return;
567 	}
568 
569 	add_assoc_str(return_value, "algo", php_password_algo_extract_ident(hash));
570 	zend_string_release(ident);
571 
572 	add_assoc_string(return_value, "algoName", algo->name);
573 	if (algo->get_info) {
574 		algo->get_info(&options, hash);
575 	}
576 	add_assoc_zval(return_value, "options", &options);
577 }
578 /** }}} */
579 
580 /* {{{ Determines if a given hash requires re-hashing based upon parameters */
PHP_FUNCTION(password_needs_rehash)581 PHP_FUNCTION(password_needs_rehash)
582 {
583 	const php_password_algo *old_algo, *new_algo;
584 	zend_string *hash;
585 	zend_string *new_algo_str;
586 	zend_long new_algo_long = 0;
587 	bool new_algo_is_null;
588 	zend_array *options = NULL;
589 
590 	ZEND_PARSE_PARAMETERS_START(2, 3)
591 		Z_PARAM_STR(hash)
592 		Z_PARAM_STR_OR_LONG_OR_NULL(new_algo_str, new_algo_long, new_algo_is_null)
593 		Z_PARAM_OPTIONAL
594 		Z_PARAM_ARRAY_HT(options)
595 	ZEND_PARSE_PARAMETERS_END();
596 
597 	new_algo = php_password_algo_find_zval(new_algo_str, new_algo_long, new_algo_is_null);
598 	if (!new_algo) {
599 		/* Unknown new algorithm, never prompt to rehash. */
600 		RETURN_FALSE;
601 	}
602 
603 	old_algo = php_password_algo_identify_ex(hash, NULL);
604 	if (old_algo != new_algo) {
605 		/* Different algorithm preferred, always rehash. */
606 		RETURN_TRUE;
607 	}
608 
609 	RETURN_BOOL(old_algo->needs_rehash(hash, options));
610 }
611 /* }}} */
612 
613 /* {{{ Verify a hash created using crypt() or password_hash() */
PHP_FUNCTION(password_verify)614 PHP_FUNCTION(password_verify)
615 {
616 	zend_string *password, *hash;
617 	const php_password_algo *algo;
618 
619 	ZEND_PARSE_PARAMETERS_START(2, 2)
620 		Z_PARAM_STR(password)
621 		Z_PARAM_STR(hash)
622 	ZEND_PARSE_PARAMETERS_END();
623 
624 	algo = php_password_algo_identify(hash);
625 	RETURN_BOOL(algo && (!algo->verify || algo->verify(password, hash)));
626 }
627 /* }}} */
628 
629 /* {{{ Hash a password */
PHP_FUNCTION(password_hash)630 PHP_FUNCTION(password_hash)
631 {
632 	zend_string *password, *digest = NULL;
633 	zend_string *algo_str;
634 	zend_long algo_long = 0;
635 	bool algo_is_null;
636 	const php_password_algo *algo;
637 	zend_array *options = NULL;
638 
639 	ZEND_PARSE_PARAMETERS_START(2, 3)
640 		Z_PARAM_STR(password)
641 		Z_PARAM_STR_OR_LONG_OR_NULL(algo_str, algo_long, algo_is_null)
642 		Z_PARAM_OPTIONAL
643 		Z_PARAM_ARRAY_HT(options)
644 	ZEND_PARSE_PARAMETERS_END();
645 
646 	algo = php_password_algo_find_zval(algo_str, algo_long, algo_is_null);
647 	if (!algo) {
648 		zend_argument_value_error(2, "must be a valid password hashing algorithm");
649 		RETURN_THROWS();
650 	}
651 
652 	digest = algo->hash(password, options);
653 	if (!digest) {
654 		if (!EG(exception)) {
655 			zend_throw_error(NULL, "Password hashing failed for unknown reason");
656 		}
657 		RETURN_THROWS();
658 	}
659 
660 	RETURN_NEW_STR(digest);
661 }
662 /* }}} */
663 
664 /* {{{ */
PHP_FUNCTION(password_algos)665 PHP_FUNCTION(password_algos) {
666 	zend_string *algo;
667 
668 	ZEND_PARSE_PARAMETERS_NONE();
669 
670 	array_init(return_value);
671 	ZEND_HASH_MAP_FOREACH_STR_KEY(&php_password_algos, algo) {
672 		add_next_index_str(return_value, zend_string_copy(algo));
673 	} ZEND_HASH_FOREACH_END();
674 }
675 /* }}} */
676