MediaWiki  REL1_31
Password.php
Go to the documentation of this file.
1 <?php
66 abstract class Password {
70  protected $factory;
71 
76  protected $hash;
77 
82  protected $config;
83 
87  const MAX_HASH_SIZE = 255;
88 
101  final public function __construct( PasswordFactory $factory, array $config, $hash = null ) {
102  if ( !isset( $config['type'] ) ) {
103  throw new MWException( 'Password configuration must contain a type name.' );
104  }
105  $this->config = $config;
106  $this->factory = $factory;
107 
108  if ( $hash !== null && strlen( $hash ) >= 3 ) {
109  // Strip the type from the hash for parsing
110  $hash = substr( $hash, strpos( $hash, ':', 1 ) + 1 );
111  }
112 
113  $this->hash = $hash;
114  $this->parseHash( $hash );
115  }
116 
122  final public function getType() {
123  return $this->config['type'];
124  }
125 
133  protected function parseHash( $hash ) {
134  }
135 
141  abstract public function needsUpdate();
142 
153  public function equals( $other ) {
154  if ( !$other instanceof self ) {
155  // No need to use the factory because we're definitely making
156  // an object of the same type.
157  $obj = clone $this;
158  $obj->crypt( $other );
159  $other = $obj;
160  }
161 
162  return hash_equals( $this->toString(), $other->toString() );
163  }
164 
177  public function toString() {
178  $result = ':' . $this->config['type'] . ':' . $this->hash;
179  $this->assertIsSafeSize( $result );
180  return $result;
181  }
182 
193  final protected function assertIsSafeSize( $hash ) {
194  if ( strlen( $hash ) > self::MAX_HASH_SIZE ) {
195  throw new PasswordError( "Password hash is too big" );
196  }
197  }
198 
208  abstract public function crypt( $password );
209 }
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Password\equals
equals( $other)
Compare one Password object to this object.
Definition: Password.php:153
PasswordError
Show an error when any operation involving passwords fails to run.
Definition: PasswordError.php:26
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
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\$config
array $config
Array of configuration variables injected from the constructor.
Definition: Password.php:82
MWException
MediaWiki exception.
Definition: MWException.php:26
Password\assertIsSafeSize
assertIsSafeSize( $hash)
Assert that hash will fit in a tinyblob field.
Definition: Password.php:193
Password\crypt
crypt( $password)
Hash a password and store the result in this object.
Password\MAX_HASH_SIZE
const MAX_HASH_SIZE
Hash must fit in user_password, which is a tinyblob.
Definition: Password.php:87
Password\getType
getType()
Get the type name of the password.
Definition: Password.php:122
Password\toString
toString()
Convert this hash to a string that can be stored in the database.
Definition: Password.php:177
Password\__construct
__construct(PasswordFactory $factory, array $config, $hash=null)
Construct the Password object using a string hash.
Definition: Password.php:101
Password\$hash
string $hash
String representation of the hash without the type.
Definition: Password.php:76
Password\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: Password.php:133
Password\needsUpdate
needsUpdate()
Determine if the hash needs to be updated.
Password\$factory
PasswordFactory $factory
Factory that created the object.
Definition: Password.php:70
PasswordFactory
Factory class for creating and checking Password objects.
Definition: PasswordFactory.php:28
Password
Represents a password hash for use in authentication.
Definition: Password.php:66