MediaWiki  1.28.0
PasswordFactory.php
Go to the documentation of this file.
1 <?php
28 final class PasswordFactory {
35  private $default = '';
36 
43  private $types = [
44  '' => [ 'type' => '', 'class' => 'InvalidPassword' ],
45  ];
46 
53  public function register( $type, array $config ) {
54  $config['type'] = $type;
55  $this->types[$type] = $config;
56  }
57 
64  public function setDefaultType( $type ) {
65  if ( !isset( $this->types[$type] ) ) {
66  throw new InvalidArgumentException( "Invalid password type $type." );
67  }
68  $this->default = $type;
69  }
70 
76  public function getDefaultType() {
77  return $this->default;
78  }
79 
85  public function init( Config $config ) {
86  foreach ( $config->get( 'PasswordConfig' ) as $type => $options ) {
87  $this->register( $type, $options );
88  }
89 
90  $this->setDefaultType( $config->get( 'PasswordDefault' ) );
91  }
92 
98  public function getTypes() {
99  return $this->types;
100  }
101 
113  public function newFromCiphertext( $hash ) {
114  if ( $hash === null || $hash === false || $hash === '' ) {
115  return new InvalidPassword( $this, [ 'type' => '' ], null );
116  } elseif ( $hash[0] !== ':' ) {
117  throw new PasswordError( 'Invalid hash given' );
118  }
119 
120  $type = substr( $hash, 1, strpos( $hash, ':', 1 ) - 1 );
121  if ( !isset( $this->types[$type] ) ) {
122  throw new PasswordError( "Unrecognized password hash type $type." );
123  }
124 
125  $config = $this->types[$type];
126 
127  return new $config['class']( $this, $config, $hash );
128  }
129 
137  public function newFromType( $type ) {
138  if ( !isset( $this->types[$type] ) ) {
139  throw new PasswordError( "Unrecognized password hash type $type." );
140  }
141 
142  $config = $this->types[$type];
143 
144  return new $config['class']( $this, $config );
145  }
146 
157  public function newFromPlaintext( $password, Password $existing = null ) {
158  if ( $password === null ) {
159  return new InvalidPassword( $this, [ 'type' => '' ], null );
160  }
161 
162  if ( $existing === null ) {
163  $config = $this->types[$this->default];
164  $obj = new $config['class']( $this, $config );
165  } else {
166  $obj = clone $existing;
167  }
168 
169  $obj->crypt( $password );
170 
171  return $obj;
172  }
173 
184  public function needsUpdate( Password $password ) {
185  if ( $password->getType() !== $this->default ) {
186  return true;
187  } else {
188  return $password->needsUpdate();
189  }
190  }
191 
198  public static function generateRandomPasswordString( $minLength = 10 ) {
199  // Decide the final password length based on our min password length,
200  // stopping at a minimum of 10 chars.
201  $length = max( 10, $minLength );
202  // Multiply by 1.25 to get the number of hex characters we need
203  // Generate random hex chars
204  $hex = MWCryptRand::generateHex( ceil( $length * 1.25 ) );
205  // Convert from base 16 to base 32 to get a proper password like string
206  return substr( Wikimedia\base_convert( $hex, 16, 32, $length ), -$length );
207  }
208 
214  public static function newInvalidPassword() {
215  static $password = null;
216 
217  if ( $password === null ) {
218  $factory = new self();
219  $password = new InvalidPassword( $factory, [ 'type' => '' ], null );
220  }
221 
222  return $password;
223  }
224 }
getDefaultType()
Get the default password type.
needsUpdate()
Determine if the hash needs to be updated.
Definition: Password.php:136
the array() calling protocol came about after MediaWiki 1.4rc1.
needsUpdate(Password $password)
Determine whether a password object needs updating.
static generateRandomPasswordString($minLength=10)
Generate a random string suitable for a password.
Represents an invalid password hash.
array $types
Mapping of password types to classes.
setDefaultType($type)
Set the default password type.
get($name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
newFromPlaintext($password, Password $existing=null)
Create a new Hash object from a plaintext password.
getType()
Get the type name of the password.
Definition: Password.php:117
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
init(Config $config)
Initialize the internal static variables using the global variables.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static newInvalidPassword()
Create an InvalidPassword.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Show an error when any operation involving passwords fails to run.
newFromType($type)
Make a new default password of the given type.
getTypes()
Get the list of types of passwords.
static generateHex($chars, $forceStrong=false)
Generate a run of (ideally) cryptographically random data and return it in hexadecimal string format...
Definition: MWCryptRand.php:76
string $default
The default PasswordHash type.
newFromCiphertext($hash)
Create a new Hash object from an existing string hash.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491