3 * Portable PHP password hashing framework.
6 * @version 0.3 / WordPress
7 * @link http://www.openwall.com/phpass/
11 # Written by Solar Designer <solar at openwall.com> in 2004-2006 and placed in
12 # the public domain. Revised in subsequent years, still public domain.
14 # There's absolutely no warranty.
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 * Portable PHP password hashing framework.
32 * @version 0.3 / WordPress
33 * @link http://www.openwall.com/phpass/
38 var $iteration_count_log2;
45 function __construct( $iteration_count_log2, $portable_hashes )
47 $this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
49 if ($iteration_count_log2 < 4 || $iteration_count_log2 > 31)
50 $iteration_count_log2 = 8;
51 $this->iteration_count_log2 = $iteration_count_log2;
53 $this->portable_hashes = $portable_hashes;
55 $this->random_state = microtime() . uniqid(rand(), TRUE); // removed getmypid() for compatibility reasons
61 public function PasswordHash( $iteration_count_log2, $portable_hashes ) {
62 self::__construct( $iteration_count_log2, $portable_hashes );
65 function get_random_bytes($count)
68 if ( @is_readable('/dev/urandom') &&
69 ($fh = @fopen('/dev/urandom', 'rb'))) {
70 $output = fread($fh, $count);
74 if (strlen($output) < $count) {
76 for ($i = 0; $i < $count; $i += 16) {
78 md5(microtime() . $this->random_state);
80 pack('H*', md5($this->random_state));
82 $output = substr($output, 0, $count);
88 function encode64($input, $count)
93 $value = ord($input[$i++]);
94 $output .= $this->itoa64[$value & 0x3f];
96 $value |= ord($input[$i]) << 8;
97 $output .= $this->itoa64[($value >> 6) & 0x3f];
101 $value |= ord($input[$i]) << 16;
102 $output .= $this->itoa64[($value >> 12) & 0x3f];
105 $output .= $this->itoa64[($value >> 18) & 0x3f];
106 } while ($i < $count);
111 function gensalt_private($input)
114 $output .= $this->itoa64[min($this->iteration_count_log2 +
115 ((PHP_VERSION >= '5') ? 5 : 3), 30)];
116 $output .= $this->encode64($input, 6);
121 function crypt_private($password, $setting)
124 if (substr($setting, 0, 2) == $output)
127 $id = substr($setting, 0, 3);
128 # We use "$P$", phpBB3 uses "$H$" for the same thing
129 if ($id != '$P$' && $id != '$H$')
132 $count_log2 = strpos($this->itoa64, $setting[3]);
133 if ($count_log2 < 7 || $count_log2 > 30)
136 $count = 1 << $count_log2;
138 $salt = substr($setting, 4, 8);
139 if (strlen($salt) != 8)
142 # We're kind of forced to use MD5 here since it's the only
143 # cryptographic primitive available in all versions of PHP
144 # currently in use. To implement our own low-level crypto
145 # in PHP would result in much worse performance and
146 # consequently in lower iteration counts and hashes that are
147 # quicker to crack (by non-PHP code).
148 if (PHP_VERSION >= '5') {
149 $hash = md5($salt . $password, TRUE);
151 $hash = md5($hash . $password, TRUE);
154 $hash = pack('H*', md5($salt . $password));
156 $hash = pack('H*', md5($hash . $password));
160 $output = substr($setting, 0, 12);
161 $output .= $this->encode64($hash, 16);
166 function gensalt_extended($input)
168 $count_log2 = min($this->iteration_count_log2 + 8, 24);
169 # This should be odd to not reveal weak DES keys, and the
170 # maximum valid value is (2**24 - 1) which is odd anyway.
171 $count = (1 << $count_log2) - 1;
174 $output .= $this->itoa64[$count & 0x3f];
175 $output .= $this->itoa64[($count >> 6) & 0x3f];
176 $output .= $this->itoa64[($count >> 12) & 0x3f];
177 $output .= $this->itoa64[($count >> 18) & 0x3f];
179 $output .= $this->encode64($input, 3);
184 function gensalt_blowfish($input)
186 # This one needs to use a different order of characters and a
187 # different encoding scheme from the one in encode64() above.
188 # We care because the last character in our encoded string will
189 # only represent 2 bits. While two known implementations of
190 # bcrypt will happily accept and correct a salt string which
191 # has the 4 unused bits set to non-zero, we do not want to take
192 # chances and we also do not want to waste an additional byte
194 $itoa64 = './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
197 $output .= chr(ord('0') + $this->iteration_count_log2 / 10);
198 $output .= chr(ord('0') + $this->iteration_count_log2 % 10);
203 $c1 = ord($input[$i++]);
204 $output .= $itoa64[$c1 >> 2];
205 $c1 = ($c1 & 0x03) << 4;
207 $output .= $itoa64[$c1];
211 $c2 = ord($input[$i++]);
213 $output .= $itoa64[$c1];
214 $c1 = ($c2 & 0x0f) << 2;
216 $c2 = ord($input[$i++]);
218 $output .= $itoa64[$c1];
219 $output .= $itoa64[$c2 & 0x3f];
225 function HashPassword($password)
227 if ( strlen( $password ) > 4096 ) {
233 if (CRYPT_BLOWFISH == 1 && !$this->portable_hashes) {
234 $random = $this->get_random_bytes(16);
236 crypt($password, $this->gensalt_blowfish($random));
237 if (strlen($hash) == 60)
241 if (CRYPT_EXT_DES == 1 && !$this->portable_hashes) {
242 if (strlen($random) < 3)
243 $random = $this->get_random_bytes(3);
245 crypt($password, $this->gensalt_extended($random));
246 if (strlen($hash) == 20)
250 if (strlen($random) < 6)
251 $random = $this->get_random_bytes(6);
253 $this->crypt_private($password,
254 $this->gensalt_private($random));
255 if (strlen($hash) == 34)
258 # Returning '*' on error is safe here, but would _not_ be safe
259 # in a crypt(3)-like function used _both_ for generating new
260 # hashes and for validating passwords against existing hashes.
264 function CheckPassword($password, $stored_hash)
266 if ( strlen( $password ) > 4096 ) {
270 $hash = $this->crypt_private($password, $stored_hash);
272 $hash = crypt($password, $stored_hash);
274 return $hash === $stored_hash;