MediaWiki  master
LocalPasswordPrimaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
24 use User;
25 
33 {
34 
36  protected $loginOnly = false;
37 
44  public function __construct( $params = [] ) {
45  parent::__construct( $params );
46  $this->loginOnly = !empty( $params['loginOnly'] );
47  }
48 
56  protected function getPasswordResetData( $username, $row ) {
57  $now = wfTimestamp();
58  $expiration = wfTimestampOrNull( TS_UNIX, $row->user_password_expires );
59  if ( $expiration === null || $expiration >= $now ) {
60  return null;
61  }
62 
63  $grace = $this->config->get( 'PasswordExpireGrace' );
64  if ( $expiration + $grace < $now ) {
65  $data = [
66  'hard' => true,
67  'msg' => \Status::newFatal( 'resetpass-expired' )->getMessage(),
68  ];
69  } else {
70  $data = [
71  'hard' => false,
72  'msg' => \Status::newFatal( 'resetpass-expired-soft' )->getMessage(),
73  ];
74  }
75 
76  return (object)$data;
77  }
78 
79  public function beginPrimaryAuthentication( array $reqs ) {
81  if ( !$req ) {
83  }
84 
85  if ( $req->username === null || $req->password === null ) {
87  }
88 
89  $username = User::getCanonicalName( $req->username, 'usable' );
90  if ( $username === false ) {
92  }
93 
94  $fields = [
95  'user_id', 'user_password', 'user_password_expires',
96  ];
97 
98  $dbr = wfGetDB( DB_REPLICA );
99  $row = $dbr->selectRow(
100  'user',
101  $fields,
102  [ 'user_name' => $username ],
103  __METHOD__
104  );
105  if ( !$row ) {
106  // Do not reveal whether its bad username or
107  // bad password to prevent username enumeration
108  // on private wikis. (T134100)
109  return $this->failResponse( $req );
110  }
111 
112  $oldRow = clone $row;
113  // Check for *really* old password hashes that don't even have a type
114  // The old hash format was just an md5 hex hash, with no type information
115  if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password ) ) {
116  if ( $this->config->get( 'PasswordSalt' ) ) {
117  $row->user_password = ":B:{$row->user_id}:{$row->user_password}";
118  } else {
119  $row->user_password = ":A:{$row->user_password}";
120  }
121  }
122 
123  $status = $this->checkPasswordValidity( $username, $req->password );
124  if ( !$status->isOK() ) {
125  // Fatal, can't log in
126  return AuthenticationResponse::newFail( $status->getMessage() );
127  }
128 
129  $pwhash = $this->getPassword( $row->user_password );
130  if ( !$pwhash->verify( $req->password ) ) {
131  if ( $this->config->get( 'LegacyEncoding' ) ) {
132  // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
133  // Check for this with iconv
134  $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $req->password );
135  if ( $cp1252Password === $req->password || !$pwhash->verify( $cp1252Password ) ) {
136  return $this->failResponse( $req );
137  }
138  } else {
139  return $this->failResponse( $req );
140  }
141  }
142 
143  // @codeCoverageIgnoreStart
144  if ( $this->getPasswordFactory()->needsUpdate( $pwhash ) ) {
145  $newHash = $this->getPasswordFactory()->newFromPlaintext( $req->password );
146  $fname = __METHOD__;
147  \DeferredUpdates::addCallableUpdate( function () use ( $newHash, $oldRow, $fname ) {
148  $dbw = wfGetDB( DB_MASTER );
149  $dbw->update(
150  'user',
151  [ 'user_password' => $newHash->toString() ],
152  [
153  'user_id' => $oldRow->user_id,
154  'user_password' => $oldRow->user_password
155  ],
156  $fname
157  );
158  } );
159  }
160  // @codeCoverageIgnoreEnd
161 
162  $this->setPasswordResetFlag( $username, $status, $row );
163 
165  }
166 
167  public function testUserCanAuthenticate( $username ) {
169  if ( $username === false ) {
170  return false;
171  }
172 
173  $dbr = wfGetDB( DB_REPLICA );
174  $row = $dbr->selectRow(
175  'user',
176  [ 'user_password' ],
177  [ 'user_name' => $username ],
178  __METHOD__
179  );
180  if ( !$row ) {
181  return false;
182  }
183 
184  // Check for *really* old password hashes that don't even have a type
185  // The old hash format was just an md5 hex hash, with no type information
186  if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password ) ) {
187  return true;
188  }
189 
190  return !$this->getPassword( $row->user_password ) instanceof \InvalidPassword;
191  }
192 
193  public function testUserExists( $username, $flags = User::READ_NORMAL ) {
195  if ( $username === false ) {
196  return false;
197  }
198 
200  return (bool)wfGetDB( $db )->selectField(
201  [ 'user' ],
202  [ 'user_id' ],
203  [ 'user_name' => $username ],
204  __METHOD__,
205  $options
206  );
207  }
208 
210  AuthenticationRequest $req, $checkData = true
211  ) {
212  // We only want to blank the password if something else will accept the
213  // new authentication data, so return 'ignore' here.
214  if ( $this->loginOnly ) {
215  return \StatusValue::newGood( 'ignored' );
216  }
217 
218  if ( get_class( $req ) === PasswordAuthenticationRequest::class ) {
219  if ( !$checkData ) {
220  return \StatusValue::newGood();
221  }
222 
223  $username = User::getCanonicalName( $req->username, 'usable' );
224  if ( $username !== false ) {
225  $row = wfGetDB( DB_MASTER )->selectRow(
226  'user',
227  [ 'user_id' ],
228  [ 'user_name' => $username ],
229  __METHOD__
230  );
231  if ( $row ) {
232  $sv = \StatusValue::newGood();
233  if ( $req->password !== null ) {
234  if ( $req->password !== $req->retype ) {
235  $sv->fatal( 'badretype' );
236  } else {
237  $sv->merge( $this->checkPasswordValidity( $username, $req->password ) );
238  }
239  }
240  return $sv;
241  }
242  }
243  }
244 
245  return \StatusValue::newGood( 'ignored' );
246  }
247 
249  $username = $req->username !== null ? User::getCanonicalName( $req->username, 'usable' ) : false;
250  if ( $username === false ) {
251  return;
252  }
253 
254  $pwhash = null;
255 
256  if ( get_class( $req ) === PasswordAuthenticationRequest::class ) {
257  if ( $this->loginOnly ) {
258  $pwhash = $this->getPasswordFactory()->newFromCiphertext( null );
259  $expiry = null;
260  } else {
261  $pwhash = $this->getPasswordFactory()->newFromPlaintext( $req->password );
262  $expiry = $this->getNewPasswordExpiry( $username );
263  }
264  }
265 
266  if ( $pwhash ) {
267  $dbw = wfGetDB( DB_MASTER );
268  $dbw->update(
269  'user',
270  [
271  'user_password' => $pwhash->toString(),
272  'user_password_expires' => $dbw->timestampOrNull( $expiry ),
273  ],
274  [ 'user_name' => $username ],
275  __METHOD__
276  );
277  }
278  }
279 
280  public function accountCreationType() {
281  return $this->loginOnly ? self::TYPE_NONE : self::TYPE_CREATE;
282  }
283 
284  public function testForAccountCreation( $user, $creator, array $reqs ) {
286 
288  if ( !$this->loginOnly && $req && $req->username !== null && $req->password !== null ) {
289  if ( $req->password !== $req->retype ) {
290  $ret->fatal( 'badretype' );
291  } else {
292  $ret->merge(
293  $this->checkPasswordValidity( $user->getName(), $req->password )
294  );
295  }
296  }
297  return $ret;
298  }
299 
300  public function beginPrimaryAccountCreation( $user, $creator, array $reqs ) {
301  if ( $this->accountCreationType() === self::TYPE_NONE ) {
302  throw new \BadMethodCallException( 'Shouldn\'t call this when accountCreationType() is NONE' );
303  }
304 
306  if ( $req && $req->username !== null && $req->password !== null ) {
307  // Nothing we can do besides claim it, because the user isn't in
308  // the DB yet
309  if ( $req->username !== $user->getName() ) {
310  $req = clone $req;
311  $req->username = $user->getName();
312  }
314  $ret->createRequest = $req;
315  return $ret;
316  }
318  }
319 
320  public function finishAccountCreation( $user, $creator, AuthenticationResponse $res ) {
321  if ( $this->accountCreationType() === self::TYPE_NONE ) {
322  throw new \BadMethodCallException( 'Shouldn\'t call this when accountCreationType() is NONE' );
323  }
324 
325  // Now that the user is in the DB, set the password on it.
326  $this->providerChangeAuthenticationData( $res->createRequest );
327 
328  return null;
329  }
330 }
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
getPasswordResetData( $username, $row)
Check if the password has expired and needs a reset.
checkPasswordValidity( $username, $password)
Check that the password is valid.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
A primary authentication provider that uses the password field in the &#39;user&#39; table.
finishAccountCreation( $user, $creator, AuthenticationResponse $res)
Post-creation callback.
getNewPasswordExpiry( $username)
Get expiration date for a new password, if any.
This is a value object to hold authentication response data.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
const DB_MASTER
Definition: defines.php:26
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
setPasswordResetFlag( $username, Status $status, $data=null)
Check if the password should be reset.
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1233
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
$params
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
Basic framework for a primary authentication provider that uses passwords.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
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
this hook is for auditing only $req
Definition: hooks.txt:979
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:780
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
const DB_REPLICA
Definition: defines.php:25
failResponse(PasswordAuthenticationRequest $req)
Return the appropriate response for failure.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
This is a value object for authentication requests.