Added release notes for 'ContentHandler::runLegacyHooks' removal
[mediawiki.git] / includes / password / Pbkdf2Password.php
blob6ffada36b4c66090d0ebb7456aaac6acd364168f
1 <?php
2 /**
3 * Implements the Pbkdf2Password class for the MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
23 /**
24 * A PBKDF2-hashed password
26 * This is a computationally complex password hash for use in modern applications.
27 * The number of rounds can be configured by $wgPasswordConfig['pbkdf2']['cost'].
29 * @since 1.24
31 class Pbkdf2Password extends ParameterizedPassword {
32 protected function getDefaultParams() {
33 return [
34 'algo' => $this->config['algo'],
35 'rounds' => $this->config['cost'],
36 'length' => $this->config['length']
40 protected function getDelimiter() {
41 return ':';
44 public function crypt( $password ) {
45 if ( count( $this->args ) == 0 ) {
46 $this->args[] = base64_encode( MWCryptRand::generate( 16, true ) );
49 if ( function_exists( 'hash_pbkdf2' ) ) {
50 $hash = hash_pbkdf2(
51 $this->params['algo'],
52 $password,
53 base64_decode( $this->args[0] ),
54 (int)$this->params['rounds'],
55 (int)$this->params['length'],
56 true
58 if ( !is_string( $hash ) ) {
59 throw new PasswordError( 'Error when hashing password.' );
61 } else {
62 $hashLenHash = hash( $this->params['algo'], '', true );
63 if ( !is_string( $hashLenHash ) ) {
64 throw new PasswordError( 'Error when hashing password.' );
66 $hashLen = strlen( $hashLenHash );
67 $blockCount = ceil( $this->params['length'] / $hashLen );
69 $hash = '';
70 $salt = base64_decode( $this->args[0] );
71 for ( $i = 1; $i <= $blockCount; ++$i ) {
72 $roundTotal = $lastRound = hash_hmac(
73 $this->params['algo'],
74 $salt . pack( 'N', $i ),
75 $password,
76 true
79 for ( $j = 1; $j < $this->params['rounds']; ++$j ) {
80 $lastRound = hash_hmac( $this->params['algo'], $lastRound, $password, true );
81 $roundTotal ^= $lastRound;
84 $hash .= $roundTotal;
87 $hash = substr( $hash, 0, $this->params['length'] );
90 $this->hash = base64_encode( $hash );