1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
|
<?php
/**
* Implements the Password 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
*/
declare( strict_types = 1 );
namespace MediaWiki\Password;
use InvalidArgumentException;
use MediaWiki\Config\Config;
use MediaWiki\MainConfigNames;
use MWCryptRand;
use Wikimedia\ObjectFactory\ObjectFactory;
/**
* Factory class for creating and checking Password objects
*
* @since 1.24
*/
final class PasswordFactory {
/**
* The default PasswordHash type
*
* @var string
* @see PasswordFactory::setDefaultType
*/
private $default = '';
/**
* Mapping of password types to classes
*
* @var array[]
* @see PasswordFactory::register
* @see Setup.php
*/
private $types = [
'' => [ 'type' => '', 'class' => InvalidPassword::class ],
];
private const MIN_RANDOM_PASSWORD_LENGTH = 10;
/**
* Most of the time you'll want to use MediaWikiServices::getInstance()->getPasswordFactory
* instead.
* @param array $config Mapping of password type => config
* @param string $default Default password type
* @see PasswordFactory::register
* @see PasswordFactory::setDefaultType
*/
public function __construct( array $config = [], string $default = '' ) {
foreach ( $config as $type => $options ) {
$this->register( $type, $options );
}
if ( $default !== '' ) {
$this->setDefaultType( $default );
}
}
/**
* Register a new type of password hash
*
* @param string $type Unique type name for the hash. Will be prefixed to the password hashes
* to identify what hashing method was used.
* @param array $config Array of configuration options. 'class' is required (the Password
* subclass name), everything else is passed to the constructor of that class.
*/
public function register( string $type, array $config ): void {
$config['type'] = $type;
$this->types[$type] = $config;
}
/**
* Set the default password type
*
* This type will be used for creating new passwords when the type is not specified.
* Passwords of a different type will be considered outdated and in need of update.
*
* @param string $type Password hash type
* @throws InvalidArgumentException If the type is not registered
*/
public function setDefaultType( string $type ): void {
if ( !isset( $this->types[$type] ) ) {
throw new InvalidArgumentException( "Invalid password type $type." );
}
$this->default = $type;
}
/**
* Get the default password type
*
* @return string
*/
public function getDefaultType(): string {
return $this->default;
}
/**
* @deprecated since 1.32 Initialize settings using the constructor
* Emitting deprecation warnings since 1.41.
*
* Initialize the internal static variables using the global variables
*
* @param Config $config Configuration object to load data from
*/
public function init( Config $config ): void {
wfDeprecated( __METHOD__, '1.32' );
foreach ( $config->get( MainConfigNames::PasswordConfig ) as $type => $options ) {
$this->register( $type, $options );
}
$this->setDefaultType( $config->get( MainConfigNames::PasswordDefault ) );
}
/**
* Get the list of types of passwords
*
* @return array[]
*/
public function getTypes(): array {
return $this->types;
}
/**
* Create a new Password object from an existing string hash
*
* Parse the type of a hash and create a new hash object based on the parsed type.
* Pass the raw hash to the constructor of the new object. Use InvalidPassword type
* if a null hash is given.
*
* @param string|null $hash Existing hash or null for an invalid password
* @return Password
* @throws PasswordError If hash is invalid or type is not recognized
*/
public function newFromCiphertext( ?string $hash ): Password {
if ( $hash === null || $hash === '' ) {
return new InvalidPassword( $this, [ 'type' => '' ], null );
} elseif ( $hash[0] !== ':' ) {
throw new PasswordError( 'Invalid hash given' );
}
$type = substr( $hash, 1, strpos( $hash, ':', 1 ) - 1 );
return $this->newFromTypeAndHash( $type, $hash );
}
/**
* Create a new Password object of the given type.
*
* @param string $type Existing type
* @return Password
* @throws PasswordError If type is not recognized
*/
public function newFromType( string $type ): Password {
return $this->newFromTypeAndHash( $type, null );
}
/**
* Create a new Password object of the given type, optionally with an existing string hash.
*
* @param string $type Existing type
* @param string|null $hash Existing hash
* @return Password
* @throws PasswordError If hash is invalid or type is not recognized
*/
private function newFromTypeAndHash( string $type, ?string $hash ): Password {
if ( !isset( $this->types[$type] ) ) {
throw new PasswordError( "Unrecognized password hash type $type." );
}
$config = $this->types[$type];
// @phan-suppress-next-line PhanTypeInvalidCallableArrayKey
return ObjectFactory::getObjectFromSpec( $config, [
'extraArgs' => [ $this, $config, $hash ],
'assertClass' => Password::class,
] );
}
/**
* Create a new Password object from a plaintext password
*
* If no existing object is given, make a new default object. If one is given, clone that
* object. Then pass the plaintext to Password::crypt().
*
* @param string|null $password Plaintext password, or null for an invalid password
* @param Password|null $existing Optional existing hash to get options from
* @return Password
*/
public function newFromPlaintext( ?string $password, ?Password $existing = null ): Password {
if ( $password === null ) {
return new InvalidPassword( $this, [ 'type' => '' ], null );
}
if ( $existing === null ) {
$obj = $this->newFromType( $this->default );
} else {
$obj = clone $existing;
}
$obj->crypt( $password );
return $obj;
}
/**
* Determine whether a password object needs updating
*
* Check whether the given password is of the default type. If it is,
* pass off further needsUpdate checks to Password::needsUpdate.
*
* @param Password $password
*
* @return bool True if needs update, false otherwise
*/
public function needsUpdate( Password $password ): bool {
if ( $password->getType() !== $this->default ) {
return true;
} else {
return $password->needsUpdate();
}
}
/**
* Generate a random string suitable for a password
*
* @param int $minLength Minimum length of password to generate
* @return string
*/
public static function generateRandomPasswordString( int $minLength = 10 ): string {
// Decide the final password length based on our min password length,
// requiring at least a minimum of self::MIN_RANDOM_PASSWORD_LENGTH chars.
$length = max( self::MIN_RANDOM_PASSWORD_LENGTH, $minLength );
// Multiply by 1.25 to get the number of hex characters we need
$hex = MWCryptRand::generateHex( ceil( $length * 1.25 ) );
// Convert from base 16 to base 32 to get a proper password like string
return substr( \Wikimedia\base_convert( $hex, 16, 32, $length ), -$length );
}
/**
* Create an InvalidPassword
*
* @return InvalidPassword
*/
public static function newInvalidPassword(): InvalidPassword {
static $password = null;
if ( $password === null ) {
$factory = new self();
$password = new InvalidPassword( $factory, [ 'type' => '' ], null );
}
return $password;
}
}
/** @deprecated since 1.43 use MediaWiki\\Password\\PasswordFactory */
class_alias( PasswordFactory::class, 'PasswordFactory' );
|