wiki.techinc.nl/includes/password/EncryptedPassword.php
Tim Starling 6dbb8f2d78 Fix multiple bugs in EncryptedPassword
* openssl_decrypt() expects the encrypted string you give it to be the
  exact one that came out of openssl_encrypt(), it doesn't expect you to
  pre-decode the base64 encoding. So don't do that.
* Use the same IV when re-encrypting the underlying hash for comparison.
* Check the return value of OpenSSL functions, and report meaningful
  error messages, for sysadmin convenience and to avoid e.g. giving all
  users the same hash if an invalid cipher method was chosen (which was
  the previous behaviour).
* Fix EncryptedPassword::update(). Tested it with eval.php since there
  doesn't seem to be any callers.

Change-Id: I3a39de152d0329f93d16aa4ed43faf08f665b8e2
2016-11-15 15:15:24 +11:00

121 lines
3.6 KiB
PHP

<?php
/**
* Implements the EncryptedPassword class for the MediaWiki software.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Helper class for passwords that use another password hash underneath it
* and encrypts that hash with a configured secret.
*
* @since 1.24
*/
class EncryptedPassword extends ParameterizedPassword {
protected function getDelimiter() {
return ':';
}
protected function getDefaultParams() {
return [
'cipher' => $this->config['cipher'],
'secret' => count( $this->config['secrets'] ) - 1
];
}
public function crypt( $password ) {
$secret = $this->config['secrets'][$this->params['secret']];
// Clear error string
while ( openssl_error_string() !== false );
if ( $this->hash ) {
$decrypted = openssl_decrypt(
$this->hash, $this->params['cipher'],
$secret, 0, base64_decode( $this->args[0] ) );
if ( $decrypted === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
$underlyingPassword = $this->factory->newFromCiphertext( $decrypted );
} else {
$underlyingPassword = $this->factory->newFromType( $this->config['underlying'] );
}
$underlyingPassword->crypt( $password );
if ( count( $this->args ) ) {
$iv = base64_decode( $this->args[0] );
} else {
$iv = MWCryptRand::generate( openssl_cipher_iv_length( $this->params['cipher'] ), true );
}
$this->hash = openssl_encrypt(
$underlyingPassword->toString(), $this->params['cipher'], $secret, 0, $iv );
if ( $this->hash === false ) {
throw new PasswordError( 'Error encrypting password: ' . openssl_error_string() );
}
$this->args = [ base64_encode( $iv ) ];
}
/**
* Updates the underlying hash by encrypting it with the newest secret.
*
* @throws MWException If the configuration is not valid
* @return bool True if the password was updated
*/
public function update() {
if ( count( $this->args ) != 1 || $this->params == $this->getDefaultParams() ) {
// Hash does not need updating
return false;
}
// Clear error string
while ( openssl_error_string() !== false );
// Decrypt the underlying hash
$underlyingHash = openssl_decrypt(
$this->hash,
$this->params['cipher'],
$this->config['secrets'][$this->params['secret']],
0,
base64_decode( $this->args[0] )
);
if ( $underlyingHash === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
// Reset the params
$this->params = $this->getDefaultParams();
// Check the key size with the new params
$iv = MWCryptRand::generate( openssl_cipher_iv_length( $this->params['cipher'] ), true );
$this->hash = openssl_encrypt(
$underlyingHash,
$this->params['cipher'],
$this->config['secrets'][$this->params['secret']],
0,
$iv
);
if ( $this->hash === false ) {
throw new PasswordError( 'Error encrypting password: ' . openssl_error_string() );
}
$this->args = [ base64_encode( $iv ) ];
return true;
}
}