xref: /plugin/authwordpress/class-phpass.php (revision db8c34b521320517176c0fcb5c80f50a072ae9f6)
1*db8c34b5SDamien Regad<?php
2*db8c34b5SDamien Regad/**
3*db8c34b5SDamien Regad * Portable PHP password hashing framework.
4*db8c34b5SDamien Regad * @package phpass
5*db8c34b5SDamien Regad * @since 2.5.0
6*db8c34b5SDamien Regad * @version 0.3 / WordPress
7*db8c34b5SDamien Regad * @link http://www.openwall.com/phpass/
8*db8c34b5SDamien Regad */
9*db8c34b5SDamien Regad
10*db8c34b5SDamien Regad#
11*db8c34b5SDamien Regad# Written by Solar Designer <solar at openwall.com> in 2004-2006 and placed in
12*db8c34b5SDamien Regad# the public domain.  Revised in subsequent years, still public domain.
13*db8c34b5SDamien Regad#
14*db8c34b5SDamien Regad# There's absolutely no warranty.
15*db8c34b5SDamien Regad#
16*db8c34b5SDamien Regad# Please be sure to update the Version line if you edit this file in any way.
17*db8c34b5SDamien Regad# It is suggested that you leave the main version number intact, but indicate
18*db8c34b5SDamien Regad# your project name (after the slash) and add your own revision information.
19*db8c34b5SDamien Regad#
20*db8c34b5SDamien Regad# Please do not change the "private" password hashing method implemented in
21*db8c34b5SDamien Regad# here, thereby making your hashes incompatible.  However, if you must, please
22*db8c34b5SDamien Regad# change the hash type identifier (the "$P$") to something different.
23*db8c34b5SDamien Regad#
24*db8c34b5SDamien Regad# Obviously, since this code is in the public domain, the above are not
25*db8c34b5SDamien Regad# requirements (there can be none), but merely suggestions.
26*db8c34b5SDamien Regad#
27*db8c34b5SDamien Regad
28*db8c34b5SDamien Regad/**
29*db8c34b5SDamien Regad * Portable PHP password hashing framework.
30*db8c34b5SDamien Regad *
31*db8c34b5SDamien Regad * @package phpass
32*db8c34b5SDamien Regad * @version 0.3 / WordPress
33*db8c34b5SDamien Regad * @link http://www.openwall.com/phpass/
34*db8c34b5SDamien Regad * @since 2.5.0
35*db8c34b5SDamien Regad */
36*db8c34b5SDamien Regadclass PasswordHash {
37*db8c34b5SDamien Regad	var $itoa64;
38*db8c34b5SDamien Regad	var $iteration_count_log2;
39*db8c34b5SDamien Regad	var $portable_hashes;
40*db8c34b5SDamien Regad	var $random_state;
41*db8c34b5SDamien Regad
42*db8c34b5SDamien Regad	/**
43*db8c34b5SDamien Regad	 * PHP5 constructor.
44*db8c34b5SDamien Regad	 */
45*db8c34b5SDamien Regad	function __construct( $iteration_count_log2, $portable_hashes )
46*db8c34b5SDamien Regad	{
47*db8c34b5SDamien Regad		$this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
48*db8c34b5SDamien Regad
49*db8c34b5SDamien Regad		if ($iteration_count_log2 < 4 || $iteration_count_log2 > 31)
50*db8c34b5SDamien Regad			$iteration_count_log2 = 8;
51*db8c34b5SDamien Regad		$this->iteration_count_log2 = $iteration_count_log2;
52*db8c34b5SDamien Regad
53*db8c34b5SDamien Regad		$this->portable_hashes = $portable_hashes;
54*db8c34b5SDamien Regad
55*db8c34b5SDamien Regad		$this->random_state = microtime() . uniqid(rand(), TRUE); // removed getmypid() for compatibility reasons
56*db8c34b5SDamien Regad	}
57*db8c34b5SDamien Regad
58*db8c34b5SDamien Regad	/**
59*db8c34b5SDamien Regad	 * PHP4 constructor.
60*db8c34b5SDamien Regad	 */
61*db8c34b5SDamien Regad	public function PasswordHash( $iteration_count_log2, $portable_hashes ) {
62*db8c34b5SDamien Regad		self::__construct( $iteration_count_log2, $portable_hashes );
63*db8c34b5SDamien Regad	}
64*db8c34b5SDamien Regad
65*db8c34b5SDamien Regad	function get_random_bytes($count)
66*db8c34b5SDamien Regad	{
67*db8c34b5SDamien Regad		$output = '';
68*db8c34b5SDamien Regad		if ( @is_readable('/dev/urandom') &&
69*db8c34b5SDamien Regad		    ($fh = @fopen('/dev/urandom', 'rb'))) {
70*db8c34b5SDamien Regad			$output = fread($fh, $count);
71*db8c34b5SDamien Regad			fclose($fh);
72*db8c34b5SDamien Regad		}
73*db8c34b5SDamien Regad
74*db8c34b5SDamien Regad		if (strlen($output) < $count) {
75*db8c34b5SDamien Regad			$output = '';
76*db8c34b5SDamien Regad			for ($i = 0; $i < $count; $i += 16) {
77*db8c34b5SDamien Regad				$this->random_state =
78*db8c34b5SDamien Regad				    md5(microtime() . $this->random_state);
79*db8c34b5SDamien Regad				$output .=
80*db8c34b5SDamien Regad				    pack('H*', md5($this->random_state));
81*db8c34b5SDamien Regad			}
82*db8c34b5SDamien Regad			$output = substr($output, 0, $count);
83*db8c34b5SDamien Regad		}
84*db8c34b5SDamien Regad
85*db8c34b5SDamien Regad		return $output;
86*db8c34b5SDamien Regad	}
87*db8c34b5SDamien Regad
88*db8c34b5SDamien Regad	function encode64($input, $count)
89*db8c34b5SDamien Regad	{
90*db8c34b5SDamien Regad		$output = '';
91*db8c34b5SDamien Regad		$i = 0;
92*db8c34b5SDamien Regad		do {
93*db8c34b5SDamien Regad			$value = ord($input[$i++]);
94*db8c34b5SDamien Regad			$output .= $this->itoa64[$value & 0x3f];
95*db8c34b5SDamien Regad			if ($i < $count)
96*db8c34b5SDamien Regad				$value |= ord($input[$i]) << 8;
97*db8c34b5SDamien Regad			$output .= $this->itoa64[($value >> 6) & 0x3f];
98*db8c34b5SDamien Regad			if ($i++ >= $count)
99*db8c34b5SDamien Regad				break;
100*db8c34b5SDamien Regad			if ($i < $count)
101*db8c34b5SDamien Regad				$value |= ord($input[$i]) << 16;
102*db8c34b5SDamien Regad			$output .= $this->itoa64[($value >> 12) & 0x3f];
103*db8c34b5SDamien Regad			if ($i++ >= $count)
104*db8c34b5SDamien Regad				break;
105*db8c34b5SDamien Regad			$output .= $this->itoa64[($value >> 18) & 0x3f];
106*db8c34b5SDamien Regad		} while ($i < $count);
107*db8c34b5SDamien Regad
108*db8c34b5SDamien Regad		return $output;
109*db8c34b5SDamien Regad	}
110*db8c34b5SDamien Regad
111*db8c34b5SDamien Regad	function gensalt_private($input)
112*db8c34b5SDamien Regad	{
113*db8c34b5SDamien Regad		$output = '$P$';
114*db8c34b5SDamien Regad		$output .= $this->itoa64[min($this->iteration_count_log2 +
115*db8c34b5SDamien Regad			((PHP_VERSION >= '5') ? 5 : 3), 30)];
116*db8c34b5SDamien Regad		$output .= $this->encode64($input, 6);
117*db8c34b5SDamien Regad
118*db8c34b5SDamien Regad		return $output;
119*db8c34b5SDamien Regad	}
120*db8c34b5SDamien Regad
121*db8c34b5SDamien Regad	function crypt_private($password, $setting)
122*db8c34b5SDamien Regad	{
123*db8c34b5SDamien Regad		$output = '*0';
124*db8c34b5SDamien Regad		if (substr($setting, 0, 2) == $output)
125*db8c34b5SDamien Regad			$output = '*1';
126*db8c34b5SDamien Regad
127*db8c34b5SDamien Regad		$id = substr($setting, 0, 3);
128*db8c34b5SDamien Regad		# We use "$P$", phpBB3 uses "$H$" for the same thing
129*db8c34b5SDamien Regad		if ($id != '$P$' && $id != '$H$')
130*db8c34b5SDamien Regad			return $output;
131*db8c34b5SDamien Regad
132*db8c34b5SDamien Regad		$count_log2 = strpos($this->itoa64, $setting[3]);
133*db8c34b5SDamien Regad		if ($count_log2 < 7 || $count_log2 > 30)
134*db8c34b5SDamien Regad			return $output;
135*db8c34b5SDamien Regad
136*db8c34b5SDamien Regad		$count = 1 << $count_log2;
137*db8c34b5SDamien Regad
138*db8c34b5SDamien Regad		$salt = substr($setting, 4, 8);
139*db8c34b5SDamien Regad		if (strlen($salt) != 8)
140*db8c34b5SDamien Regad			return $output;
141*db8c34b5SDamien Regad
142*db8c34b5SDamien Regad		# We're kind of forced to use MD5 here since it's the only
143*db8c34b5SDamien Regad		# cryptographic primitive available in all versions of PHP
144*db8c34b5SDamien Regad		# currently in use.  To implement our own low-level crypto
145*db8c34b5SDamien Regad		# in PHP would result in much worse performance and
146*db8c34b5SDamien Regad		# consequently in lower iteration counts and hashes that are
147*db8c34b5SDamien Regad		# quicker to crack (by non-PHP code).
148*db8c34b5SDamien Regad		if (PHP_VERSION >= '5') {
149*db8c34b5SDamien Regad			$hash = md5($salt . $password, TRUE);
150*db8c34b5SDamien Regad			do {
151*db8c34b5SDamien Regad				$hash = md5($hash . $password, TRUE);
152*db8c34b5SDamien Regad			} while (--$count);
153*db8c34b5SDamien Regad		} else {
154*db8c34b5SDamien Regad			$hash = pack('H*', md5($salt . $password));
155*db8c34b5SDamien Regad			do {
156*db8c34b5SDamien Regad				$hash = pack('H*', md5($hash . $password));
157*db8c34b5SDamien Regad			} while (--$count);
158*db8c34b5SDamien Regad		}
159*db8c34b5SDamien Regad
160*db8c34b5SDamien Regad		$output = substr($setting, 0, 12);
161*db8c34b5SDamien Regad		$output .= $this->encode64($hash, 16);
162*db8c34b5SDamien Regad
163*db8c34b5SDamien Regad		return $output;
164*db8c34b5SDamien Regad	}
165*db8c34b5SDamien Regad
166*db8c34b5SDamien Regad	function gensalt_extended($input)
167*db8c34b5SDamien Regad	{
168*db8c34b5SDamien Regad		$count_log2 = min($this->iteration_count_log2 + 8, 24);
169*db8c34b5SDamien Regad		# This should be odd to not reveal weak DES keys, and the
170*db8c34b5SDamien Regad		# maximum valid value is (2**24 - 1) which is odd anyway.
171*db8c34b5SDamien Regad		$count = (1 << $count_log2) - 1;
172*db8c34b5SDamien Regad
173*db8c34b5SDamien Regad		$output = '_';
174*db8c34b5SDamien Regad		$output .= $this->itoa64[$count & 0x3f];
175*db8c34b5SDamien Regad		$output .= $this->itoa64[($count >> 6) & 0x3f];
176*db8c34b5SDamien Regad		$output .= $this->itoa64[($count >> 12) & 0x3f];
177*db8c34b5SDamien Regad		$output .= $this->itoa64[($count >> 18) & 0x3f];
178*db8c34b5SDamien Regad
179*db8c34b5SDamien Regad		$output .= $this->encode64($input, 3);
180*db8c34b5SDamien Regad
181*db8c34b5SDamien Regad		return $output;
182*db8c34b5SDamien Regad	}
183*db8c34b5SDamien Regad
184*db8c34b5SDamien Regad	function gensalt_blowfish($input)
185*db8c34b5SDamien Regad	{
186*db8c34b5SDamien Regad		# This one needs to use a different order of characters and a
187*db8c34b5SDamien Regad		# different encoding scheme from the one in encode64() above.
188*db8c34b5SDamien Regad		# We care because the last character in our encoded string will
189*db8c34b5SDamien Regad		# only represent 2 bits.  While two known implementations of
190*db8c34b5SDamien Regad		# bcrypt will happily accept and correct a salt string which
191*db8c34b5SDamien Regad		# has the 4 unused bits set to non-zero, we do not want to take
192*db8c34b5SDamien Regad		# chances and we also do not want to waste an additional byte
193*db8c34b5SDamien Regad		# of entropy.
194*db8c34b5SDamien Regad		$itoa64 = './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
195*db8c34b5SDamien Regad
196*db8c34b5SDamien Regad		$output = '$2a$';
197*db8c34b5SDamien Regad		$output .= chr(ord('0') + $this->iteration_count_log2 / 10);
198*db8c34b5SDamien Regad		$output .= chr(ord('0') + $this->iteration_count_log2 % 10);
199*db8c34b5SDamien Regad		$output .= '$';
200*db8c34b5SDamien Regad
201*db8c34b5SDamien Regad		$i = 0;
202*db8c34b5SDamien Regad		do {
203*db8c34b5SDamien Regad			$c1 = ord($input[$i++]);
204*db8c34b5SDamien Regad			$output .= $itoa64[$c1 >> 2];
205*db8c34b5SDamien Regad			$c1 = ($c1 & 0x03) << 4;
206*db8c34b5SDamien Regad			if ($i >= 16) {
207*db8c34b5SDamien Regad				$output .= $itoa64[$c1];
208*db8c34b5SDamien Regad				break;
209*db8c34b5SDamien Regad			}
210*db8c34b5SDamien Regad
211*db8c34b5SDamien Regad			$c2 = ord($input[$i++]);
212*db8c34b5SDamien Regad			$c1 |= $c2 >> 4;
213*db8c34b5SDamien Regad			$output .= $itoa64[$c1];
214*db8c34b5SDamien Regad			$c1 = ($c2 & 0x0f) << 2;
215*db8c34b5SDamien Regad
216*db8c34b5SDamien Regad			$c2 = ord($input[$i++]);
217*db8c34b5SDamien Regad			$c1 |= $c2 >> 6;
218*db8c34b5SDamien Regad			$output .= $itoa64[$c1];
219*db8c34b5SDamien Regad			$output .= $itoa64[$c2 & 0x3f];
220*db8c34b5SDamien Regad		} while (1);
221*db8c34b5SDamien Regad
222*db8c34b5SDamien Regad		return $output;
223*db8c34b5SDamien Regad	}
224*db8c34b5SDamien Regad
225*db8c34b5SDamien Regad	function HashPassword($password)
226*db8c34b5SDamien Regad	{
227*db8c34b5SDamien Regad		if ( strlen( $password ) > 4096 ) {
228*db8c34b5SDamien Regad			return '*';
229*db8c34b5SDamien Regad		}
230*db8c34b5SDamien Regad
231*db8c34b5SDamien Regad		$random = '';
232*db8c34b5SDamien Regad
233*db8c34b5SDamien Regad		if (CRYPT_BLOWFISH == 1 && !$this->portable_hashes) {
234*db8c34b5SDamien Regad			$random = $this->get_random_bytes(16);
235*db8c34b5SDamien Regad			$hash =
236*db8c34b5SDamien Regad			    crypt($password, $this->gensalt_blowfish($random));
237*db8c34b5SDamien Regad			if (strlen($hash) == 60)
238*db8c34b5SDamien Regad				return $hash;
239*db8c34b5SDamien Regad		}
240*db8c34b5SDamien Regad
241*db8c34b5SDamien Regad		if (CRYPT_EXT_DES == 1 && !$this->portable_hashes) {
242*db8c34b5SDamien Regad			if (strlen($random) < 3)
243*db8c34b5SDamien Regad				$random = $this->get_random_bytes(3);
244*db8c34b5SDamien Regad			$hash =
245*db8c34b5SDamien Regad			    crypt($password, $this->gensalt_extended($random));
246*db8c34b5SDamien Regad			if (strlen($hash) == 20)
247*db8c34b5SDamien Regad				return $hash;
248*db8c34b5SDamien Regad		}
249*db8c34b5SDamien Regad
250*db8c34b5SDamien Regad		if (strlen($random) < 6)
251*db8c34b5SDamien Regad			$random = $this->get_random_bytes(6);
252*db8c34b5SDamien Regad		$hash =
253*db8c34b5SDamien Regad		    $this->crypt_private($password,
254*db8c34b5SDamien Regad		    $this->gensalt_private($random));
255*db8c34b5SDamien Regad		if (strlen($hash) == 34)
256*db8c34b5SDamien Regad			return $hash;
257*db8c34b5SDamien Regad
258*db8c34b5SDamien Regad		# Returning '*' on error is safe here, but would _not_ be safe
259*db8c34b5SDamien Regad		# in a crypt(3)-like function used _both_ for generating new
260*db8c34b5SDamien Regad		# hashes and for validating passwords against existing hashes.
261*db8c34b5SDamien Regad		return '*';
262*db8c34b5SDamien Regad	}
263*db8c34b5SDamien Regad
264*db8c34b5SDamien Regad	function CheckPassword($password, $stored_hash)
265*db8c34b5SDamien Regad	{
266*db8c34b5SDamien Regad		if ( strlen( $password ) > 4096 ) {
267*db8c34b5SDamien Regad			return false;
268*db8c34b5SDamien Regad		}
269*db8c34b5SDamien Regad
270*db8c34b5SDamien Regad		$hash = $this->crypt_private($password, $stored_hash);
271*db8c34b5SDamien Regad		if ($hash[0] == '*')
272*db8c34b5SDamien Regad			$hash = crypt($password, $stored_hash);
273*db8c34b5SDamien Regad
274*db8c34b5SDamien Regad		return $hash === $stored_hash;
275*db8c34b5SDamien Regad	}
276*db8c34b5SDamien Regad}
277*db8c34b5SDamien Regad
278*db8c34b5SDamien Regad?>
279