Page MenuHomeWickedGov Phorge
Files F4193763

EncryptedPassword.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

EncryptedPassword.php
View Options

<?php
/**
* Implements the EncryptedPassword class for the MediaWiki software.
*
* @license GPL-2.0-or-later
* @file
*/
declare( strict_types = 1 );
namespace MediaWiki\Password;
/**
* 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(): string {
return ':';
}
protected function getDefaultParams(): array {
return [
'cipher' => $this->config['cipher'],
'secret' => (string)( count( $this->config['secrets'] ) - 1 )
];
}
public function crypt( string $password ): void {
$secret = $this->config['secrets'][(int)$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 = random_bytes( openssl_cipher_iv_length( $this->params['cipher'] ) );
}
$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 PasswordError If the configuration is not valid
* @return bool True if the password was updated
*/
public function update(): bool {
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'][(int)$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 = random_bytes( openssl_cipher_iv_length( $this->params['cipher'] ) );
$this->hash = openssl_encrypt(
$underlyingHash,
$this->params['cipher'],
$this->config['secrets'][(int)$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;
}
/**
* @inheritDoc
*/
public function verify( string $password ): bool {
// Clear error string
while ( openssl_error_string() !== false );
// Decrypt the underlying hash
$underlyingHash = openssl_decrypt(
$this->hash,
$this->params['cipher'],
$this->config['secrets'][(int)$this->params['secret']],
0,
base64_decode( $this->args[0] )
);
if ( $underlyingHash === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
$storedPassword = $this->factory->newFromCiphertext( $underlyingHash );
return $storedPassword->verify( $password );
}
}
/** @deprecated since 1.43 use MediaWiki\\Password\\EncryptedPassword */
class_alias( EncryptedPassword::class, 'EncryptedPassword' );

File Metadata

Mime Type
text/x-php
Expires
Aug 20 2026, 19:23 (11 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
54/bc/1dfea728c255ca056c479347db5b
Default Alt Text
EncryptedPassword.php (3 KB)

Event Timeline