Page MenuHomeWickedGov Phorge
Files F4152512

ParameterizedPassword.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ParameterizedPassword.php
View Options

<?php
/**
* Implements the ParameterizedPassword class for the MediaWiki software.
*
* @license GPL-2.0-or-later
* @file
*/
declare( strict_types = 1 );
namespace MediaWiki\Password;
/**
* Helper class for password hash types that have a delimited set of parameters
* inside the hash.
*
* All passwords are in the form of :<TYPE>:... as explained in the main Password
* class. This class is for hashes in the form of :<TYPE>:<PARAM1>:<PARAM2>:... where
* <PARAM1>, <PARAM2>, etc. are parameters that determine how the password was hashed.
* Of course, the internal delimiter (which is : by convention and default), can be
* changed by overriding the ParameterizedPassword::getDelimiter() function.
*
* This class requires overriding an additional function: ParameterizedPassword::getDefaultParams().
* See the function description for more details on the implementation.
*
* @since 1.24
*/
abstract class ParameterizedPassword extends Password {
/**
* Named parameters that have default values for this password type
* @var array
*/
protected $params = [];
/**
* Extra arguments that were found in the hash. This may or may not make
* the hash invalid.
* @var string[]
*/
protected $args = [];
/**
* @inheritDoc
*/
protected function parseHash( ?string $hash ): void {
parent::parseHash( $hash );
if ( $hash === null ) {
$this->params = $this->getDefaultParams();
return;
}
$parts = explode( $this->getDelimiter(), $hash );
$paramKeys = array_keys( $this->getDefaultParams() );
if ( count( $parts ) < count( $paramKeys ) ) {
throw new PasswordError( 'Hash is missing required parameters.' );
}
if ( $paramKeys ) {
$this->args = array_splice( $parts, count( $paramKeys ) );
$this->params = array_combine( $paramKeys, $parts );
} else {
$this->args = $parts;
}
if ( $this->args ) {
$this->hash = array_pop( $this->args );
} else {
$this->hash = null;
}
}
public function needsUpdate(): bool {
return $this->params !== $this->getDefaultParams();
}
public function toString(): string {
$str = ':' . $this->config['type'] . ':';
if ( count( $this->params ) || count( $this->args ) ) {
$str .= implode( $this->getDelimiter(), array_merge( $this->params, $this->args ) );
$str .= $this->getDelimiter();
}
$res = $str . $this->hash;
$this->assertIsSafeSize( $res );
return $res;
}
/**
* Returns the delimiter for the parameters inside the hash
*
* @return string
*/
abstract protected function getDelimiter(): string;
/**
* Return an ordered array of default parameters for this password hash
*
* The keys should be the parameter names and the values should be the default
* values. Additionally, the order of the array should be the order in which they
* appear in the hash.
*
* When parsing a password hash, the constructor will split the hash based on
* the delimiter, and consume as many parts as it can, matching each to a parameter
* in this list. Once all the parameters have been filled, all remaining parts will
* be considered extra arguments, except, of course, for the very last part, which
* is the hash itself.
*
* @return array
*/
abstract protected function getDefaultParams(): array;
}
/** @deprecated since 1.43 use MediaWiki\\Password\\ParameterizedPassword */
class_alias( ParameterizedPassword::class, 'ParameterizedPassword' );

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:23 (7 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7a/1a/8bcd1517366192cf850c26b2287d
Default Alt Text
ParameterizedPassword.php (3 KB)

Event Timeline