includes/password/Pbkdf2Password.php

   1 <?php
   2 /**
   3  * Implements the Pbkdf2Password class for the MediaWiki software.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * A PBKDF2-hashed password
  25  *
  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'].
  28  *
  29  * @since 1.24
  30  */
  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']
  37                 ];
  38         }
  39
  40         protected function getDelimiter() {
  41                 return ':';
  42         }
  43
  44         protected function shouldUseHashExtension() {
  45                 return $this->config['use-hash-extension'] ?? function_exists( 'hash_pbkdf2' );
  46         }
  47
  48         public function crypt( $password ) {
  49                 if ( count( $this->args ) == 0 ) {
  50                         $this->args[] = base64_encode( MWCryptRand::generate( 16, true ) );
  51                 }
  52
  53                 if ( $this->shouldUseHashExtension() ) {
  54                         $hash = hash_pbkdf2(
  55                                 $this->params['algo'],
  56                                 $password,
  57                                 base64_decode( $this->args[0] ),
  58                                 (int)$this->params['rounds'],
  59                                 (int)$this->params['length'],
  60                                 true
  61                         );
  62                         if ( !is_string( $hash ) ) {
  63                                 throw new PasswordError( 'Error when hashing password.' );
  64                         }
  65                 } else {
  66                         $hashLenHash = hash( $this->params['algo'], '', true );
  67                         if ( !is_string( $hashLenHash ) ) {
  68                                 throw new PasswordError( 'Error when hashing password.' );
  69                         }
  70                         $hashLen = strlen( $hashLenHash );
  71                         $blockCount = ceil( $this->params['length'] / $hashLen );
  72
  73                         $hash = '';
  74                         $salt = base64_decode( $this->args[0] );
  75                         for ( $i = 1; $i <= $blockCount; ++$i ) {
  76                                 $roundTotal = $lastRound = hash_hmac(
  77                                         $this->params['algo'],
  78                                         $salt . pack( 'N', $i ),
  79                                         $password,
  80                                         true
  81                                 );
  82
  83                                 for ( $j = 1; $j < $this->params['rounds']; ++$j ) {
  84                                         $lastRound = hash_hmac( $this->params['algo'], $lastRound, $password, true );
  85                                         $roundTotal ^= $lastRound;
  86                                 }
  87
  88                                 $hash .= $roundTotal;
  89                         }
  90
  91                         $hash = substr( $hash, 0, $this->params['length'] );
  92                 }
  93
  94                 $this->hash = base64_encode( $hash );
  95         }
  96 }