MediaWiki  REL1_31
ParameterizedPassword.php
Go to the documentation of this file.
1 <?php
38 abstract class ParameterizedPassword extends Password {
43  protected $params = [];
44 
50  protected $args = [];
51 
52  protected function parseHash( $hash ) {
53  parent::parseHash( $hash );
54 
55  if ( $hash === null ) {
56  $this->params = $this->getDefaultParams();
57  return;
58  }
59 
60  $parts = explode( $this->getDelimiter(), $hash );
61  $paramKeys = array_keys( $this->getDefaultParams() );
62 
63  if ( count( $parts ) < count( $paramKeys ) ) {
64  throw new PasswordError( 'Hash is missing required parameters.' );
65  }
66 
67  if ( $paramKeys ) {
68  $this->args = array_splice( $parts, count( $paramKeys ) );
69  $this->params = array_combine( $paramKeys, $parts );
70  } else {
71  $this->args = $parts;
72  }
73 
74  if ( $this->args ) {
75  $this->hash = array_pop( $this->args );
76  } else {
77  $this->hash = null;
78  }
79  }
80 
81  public function needsUpdate() {
82  return $this->params !== $this->getDefaultParams();
83  }
84 
85  public function toString() {
86  $str = ':' . $this->config['type'] . ':';
87 
88  if ( count( $this->params ) || count( $this->args ) ) {
89  $str .= implode( $this->getDelimiter(), array_merge( $this->params, $this->args ) );
90  $str .= $this->getDelimiter();
91  }
92 
93  $res = $str . $this->hash;
94  $this->assertIsSafeSize( $res );
95  return $res;
96  }
97 
103  abstract protected function getDelimiter();
104 
120  abstract protected function getDefaultParams();
121 }
ParameterizedPassword\toString
toString()
Convert this hash to a string that can be stored in the database.
Definition: ParameterizedPassword.php:85
ParameterizedPassword\parseHash
parseHash( $hash)
Perform any parsing necessary on the hash to see if the hash is valid and/or to perform logic for see...
Definition: ParameterizedPassword.php:52
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ParameterizedPassword\getDelimiter
getDelimiter()
Returns the delimiter for the parameters inside the hash.
PasswordError
Show an error when any operation involving passwords fails to run.
Definition: PasswordError.php:26
$res
$res
Definition: database.txt:21
ParameterizedPassword\$params
array $params
Named parameters that have default values for this password type.
Definition: ParameterizedPassword.php:43
php
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:37
Password\assertIsSafeSize
assertIsSafeSize( $hash)
Assert that hash will fit in a tinyblob field.
Definition: Password.php:193
Password\$hash
string $hash
String representation of the hash without the type.
Definition: Password.php:76
ParameterizedPassword\getDefaultParams
getDefaultParams()
Return an ordered array of default parameters for this password hash.
ParameterizedPassword\needsUpdate
needsUpdate()
Determine if the hash needs to be updated.
Definition: ParameterizedPassword.php:81
ParameterizedPassword
Helper class for password hash types that have a delimited set of parameters inside of the hash.
Definition: ParameterizedPassword.php:38
Password
Represents a password hash for use in authentication.
Definition: Password.php:66
ParameterizedPassword\$args
array $args
Extra arguments that were found in the hash.
Definition: ParameterizedPassword.php:50