3 # Portable PHP password hashing framework.
5 # Version 0.3 / genuine.
7 # Written by Solar Designer <solar at openwall.com> in 2004-2006 and placed in
8 # the public domain. Revised in subsequent years, still public domain.
10 # There's absolutely no warranty.
12 # The homepage URL for this framework is:
14 # http://www.openwall.com/phpass/
16 # Please be sure to update the Version line if you edit this file in any way.
17 # It is suggested that you leave the main version number intact, but indicate
18 # your project name (after the slash) and add your own revision information.
20 # Please do not change the "private" password hashing method implemented in
21 # here, thereby making your hashes incompatible. However, if you must, please
22 # change the hash type identifier (the "$P$") to something different.
24 # Obviously, since this code is in the public domain, the above are not
25 # requirements (there can be none), but merely suggestions.
29 var $iteration_count_log2;
33 function __construct($iteration_count_log2, $portable_hashes)
35 $this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
37 if ($iteration_count_log2 < 4 || $iteration_count_log2 > 31)
38 $iteration_count_log2 = 8;
39 $this->iteration_count_log2 = $iteration_count_log2;
41 $this->portable_hashes = $portable_hashes;
43 $this->random_state = microtime();
44 if (function_exists('getmypid'))
45 $this->random_state .= getmypid();
48 function get_random_bytes($count)
51 if (is_readable('/dev/urandom') &&
52 ($fh = @fopen('/dev/urandom', 'rb'))) {
53 $output = fread($fh, $count);
57 if (strlen($output) < $count) {
59 for ($i = 0; $i < $count; $i += 16) {
61 md5(microtime() . $this->random_state);
63 pack('H*', md5($this->random_state));
65 $output = substr($output, 0, $count);
71 function encode64($input, $count)
76 $value = ord($input[$i++]);
77 $output .= $this->itoa64[$value & 0x3f];
79 $value |= ord($input[$i]) << 8;
80 $output .= $this->itoa64[($value >> 6) & 0x3f];
84 $value |= ord($input[$i]) << 16;
85 $output .= $this->itoa64[($value >> 12) & 0x3f];
88 $output .= $this->itoa64[($value >> 18) & 0x3f];
89 } while ($i < $count);
94 function gensalt_private($input)
97 $output .= $this->itoa64[min($this->iteration_count_log2 +
98 ((PHP_VERSION >= '5') ? 5 : 3), 30)];
99 $output .= $this->encode64($input, 6);
104 function crypt_private($password, $setting)
107 if (substr($setting, 0, 2) == $output)
110 $id = substr($setting, 0, 3);
111 # We use "$P$", phpBB3 uses "$H$" for the same thing
112 if ($id != '$P$' && $id != '$H$')
115 $count_log2 = strpos($this->itoa64, $setting[3]);
116 if ($count_log2 < 7 || $count_log2 > 30)
119 $count = 1 << $count_log2;
121 $salt = substr($setting, 4, 8);
122 if (strlen($salt) != 8)
125 # We're kind of forced to use MD5 here since it's the only
126 # cryptographic primitive available in all versions of PHP
127 # currently in use. To implement our own low-level crypto
128 # in PHP would result in much worse performance and
129 # consequently in lower iteration counts and hashes that are
130 # quicker to crack (by non-PHP code).
131 if (PHP_VERSION >= '5') {
132 $hash = md5($salt . $password, TRUE);
134 $hash = md5($hash . $password, TRUE);
137 $hash = pack('H*', md5($salt . $password));
139 $hash = pack('H*', md5($hash . $password));
143 $output = substr($setting, 0, 12);
144 $output .= $this->encode64($hash, 16);
149 function gensalt_extended($input)
151 $count_log2 = min($this->iteration_count_log2 + 8, 24);
152 # This should be odd to not reveal weak DES keys, and the
153 # maximum valid value is (2**24 - 1) which is odd anyway.
154 $count = (1 << $count_log2) - 1;
157 $output .= $this->itoa64[$count & 0x3f];
158 $output .= $this->itoa64[($count >> 6) & 0x3f];
159 $output .= $this->itoa64[($count >> 12) & 0x3f];
160 $output .= $this->itoa64[($count >> 18) & 0x3f];
162 $output .= $this->encode64($input, 3);
167 function gensalt_blowfish($input)
169 # This one needs to use a different order of characters and a
170 # different encoding scheme from the one in encode64() above.
171 # We care because the last character in our encoded string will
172 # only represent 2 bits. While two known implementations of
173 # bcrypt will happily accept and correct a salt string which
174 # has the 4 unused bits set to non-zero, we do not want to take
175 # chances and we also do not want to waste an additional byte
177 $itoa64 = './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
180 $output .= chr(ord('0') + $this->iteration_count_log2 / 10);
181 $output .= chr(ord('0') + $this->iteration_count_log2 % 10);
186 $c1 = ord($input[$i++]);
187 $output .= $itoa64[$c1 >> 2];
188 $c1 = ($c1 & 0x03) << 4;
190 $output .= $itoa64[$c1];
194 $c2 = ord($input[$i++]);
196 $output .= $itoa64[$c1];
197 $c1 = ($c2 & 0x0f) << 2;
199 $c2 = ord($input[$i++]);
201 $output .= $itoa64[$c1];
202 $output .= $itoa64[$c2 & 0x3f];
208 function HashPassword($password)
212 if (CRYPT_BLOWFISH == 1 && !$this->portable_hashes) {
213 $random = $this->get_random_bytes(16);
215 crypt($password, $this->gensalt_blowfish($random));
216 if (strlen($hash) == 60)
220 if (CRYPT_EXT_DES == 1 && !$this->portable_hashes) {
221 if (strlen($random) < 3)
222 $random = $this->get_random_bytes(3);
224 crypt($password, $this->gensalt_extended($random));
225 if (strlen($hash) == 20)
229 if (strlen($random) < 6)
230 $random = $this->get_random_bytes(6);
232 $this->crypt_private($password,
233 $this->gensalt_private($random));
234 if (strlen($hash) == 34)
237 # Returning '*' on error is safe here, but would _not_ be safe
238 # in a crypt(3)-like function used _both_ for generating new
239 # hashes and for validating passwords against existing hashes.
243 function CheckPassword($password, $stored_hash)
245 $hash = $this->crypt_private($password, $stored_hash);
247 $hash = crypt($password, $stored_hash);
249 return $hash == $stored_hash;