MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
24 use User;
33 {
36  protected $loginOnly = false;
44  public function __construct( $params = [] ) {
45  parent::__construct( $params );
46  $this->loginOnly = !empty( $params['loginOnly'] );
47  }
49  protected function getPasswordResetData( $username, $row ) {
50  $now = wfTimestamp();
51  $expiration = wfTimestampOrNull( TS_UNIX, $row->user_password_expires );
52  if ( $expiration === null || $expiration >= $now ) {
53  return null;
54  }
56  $grace = $this->config->get( 'PasswordExpireGrace' );
57  if ( $expiration + $grace < $now ) {
58  $data = [
59  'hard' => true,
60  'msg' => \Status::newFatal( 'resetpass-expired' )->getMessage(),
61  ];
62  } else {
63  $data = [
64  'hard' => false,
65  'msg' => \Status::newFatal( 'resetpass-expired-soft' )->getMessage(),
66  ];
67  }
69  return (object)$data;
70  }
72  public function beginPrimaryAuthentication( array $reqs ) {
74  if ( !$req ) {
76  }
78  if ( $req->username === null || $req->password === null ) {
80  }
82  $username = User::getCanonicalName( $req->username, 'usable' );
83  if ( $username === false ) {
85  }
87  $fields = [
88  'user_id', 'user_password', 'user_password_expires',
89  ];
91  $dbr = wfGetDB( DB_REPLICA );
92  $row = $dbr->selectRow(
93  'user',
94  $fields,
95  [ 'user_name' => $username ],
96  __METHOD__
97  );
98  if ( !$row ) {
99  // Do not reveal whether its bad username or
100  // bad password to prevent username enumeration
101  // on private wikis. (T134100)
102  return $this->failResponse( $req );
103  }
105  $oldRow = clone $row;
106  // Check for *really* old password hashes that don't even have a type
107  // The old hash format was just an md5 hex hash, with no type information
108  if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password ) ) {
109  if ( $this->config->get( 'PasswordSalt' ) ) {
110  $row->user_password = ":B:{$row->user_id}:{$row->user_password}";
111  } else {
112  $row->user_password = ":A:{$row->user_password}";
113  }
114  }
116  $status = $this->checkPasswordValidity( $username, $req->password );
117  if ( !$status->isOK() ) {
118  // Fatal, can't log in
119  return AuthenticationResponse::newFail( $status->getMessage() );
120  }
122  $pwhash = $this->getPassword( $row->user_password );
123  if ( !$pwhash->equals( $req->password ) ) {
124  if ( $this->config->get( 'LegacyEncoding' ) ) {
125  // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
126  // Check for this with iconv
127  $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $req->password );
128  if ( $cp1252Password === $req->password || !$pwhash->equals( $cp1252Password ) ) {
129  return $this->failResponse( $req );
130  }
131  } else {
132  return $this->failResponse( $req );
133  }
134  }
136  // @codeCoverageIgnoreStart
137  if ( $this->getPasswordFactory()->needsUpdate( $pwhash ) ) {
138  $newHash = $this->getPasswordFactory()->newFromPlaintext( $req->password );
139  \DeferredUpdates::addCallableUpdate( function () use ( $newHash, $oldRow ) {
140  $dbw = wfGetDB( DB_MASTER );
141  $dbw->update(
142  'user',
143  [ 'user_password' => $newHash->toString() ],
144  [
145  'user_id' => $oldRow->user_id,
146  'user_password' => $oldRow->user_password
147  ],
148  __METHOD__
149  );
150  } );
151  }
152  // @codeCoverageIgnoreEnd
154  $this->setPasswordResetFlag( $username, $status, $row );
157  }
159  public function testUserCanAuthenticate( $username ) {
161  if ( $username === false ) {
162  return false;
163  }
165  $dbr = wfGetDB( DB_REPLICA );
166  $row = $dbr->selectRow(
167  'user',
168  [ 'user_password' ],
169  [ 'user_name' => $username ],
170  __METHOD__
171  );
172  if ( !$row ) {
173  return false;
174  }
176  // Check for *really* old password hashes that don't even have a type
177  // The old hash format was just an md5 hex hash, with no type information
178  if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password ) ) {
179  return true;
180  }
182  return !$this->getPassword( $row->user_password ) instanceof \InvalidPassword;
183  }
185  public function testUserExists( $username, $flags = User::READ_NORMAL ) {
187  if ( $username === false ) {
188  return false;
189  }
192  return (bool)wfGetDB( $db )->selectField(
193  [ 'user' ],
194  [ 'user_id' ],
195  [ 'user_name' => $username ],
196  __METHOD__,
197  $options
198  );
199  }
202  AuthenticationRequest $req, $checkData = true
203  ) {
204  // We only want to blank the password if something else will accept the
205  // new authentication data, so return 'ignore' here.
206  if ( $this->loginOnly ) {
207  return \StatusValue::newGood( 'ignored' );
208  }
210  if ( get_class( $req ) === PasswordAuthenticationRequest::class ) {
211  if ( !$checkData ) {
212  return \StatusValue::newGood();
213  }
215  $username = User::getCanonicalName( $req->username, 'usable' );
216  if ( $username !== false ) {
217  $row = wfGetDB( DB_MASTER )->selectRow(
218  'user',
219  [ 'user_id' ],
220  [ 'user_name' => $username ],
221  __METHOD__
222  );
223  if ( $row ) {
224  $sv = \StatusValue::newGood();
225  if ( $req->password !== null ) {
226  if ( $req->password !== $req->retype ) {
227  $sv->fatal( 'badretype' );
228  } else {
229  $sv->merge( $this->checkPasswordValidity( $username, $req->password ) );
230  }
231  }
232  return $sv;
233  }
234  }
235  }
237  return \StatusValue::newGood( 'ignored' );
238  }
241  $username = $req->username !== null ? User::getCanonicalName( $req->username, 'usable' ) : false;
242  if ( $username === false ) {
243  return;
244  }
246  $pwhash = null;
248  if ( get_class( $req ) === PasswordAuthenticationRequest::class ) {
249  if ( $this->loginOnly ) {
250  $pwhash = $this->getPasswordFactory()->newFromCiphertext( null );
251  $expiry = null;
252  } else {
253  $pwhash = $this->getPasswordFactory()->newFromPlaintext( $req->password );
254  $expiry = $this->getNewPasswordExpiry( $username );
255  }
256  }
258  if ( $pwhash ) {
259  $dbw = wfGetDB( DB_MASTER );
260  $dbw->update(
261  'user',
262  [
263  'user_password' => $pwhash->toString(),
264  'user_password_expires' => $dbw->timestampOrNull( $expiry ),
265  ],
266  [ 'user_name' => $username ],
267  __METHOD__
268  );
269  }
270  }
272  public function accountCreationType() {
273  return $this->loginOnly ? self::TYPE_NONE : self::TYPE_CREATE;
274  }
276  public function testForAccountCreation( $user, $creator, array $reqs ) {
280  if ( !$this->loginOnly && $req && $req->username !== null && $req->password !== null ) {
281  if ( $req->password !== $req->retype ) {
282  $ret->fatal( 'badretype' );
283  } else {
284  $ret->merge(
285  $this->checkPasswordValidity( $user->getName(), $req->password )
286  );
287  }
288  }
289  return $ret;
290  }
292  public function beginPrimaryAccountCreation( $user, $creator, array $reqs ) {
293  if ( $this->accountCreationType() === self::TYPE_NONE ) {
294  throw new \BadMethodCallException( 'Shouldn\'t call this when accountCreationType() is NONE' );
295  }
298  if ( $req ) {
299  if ( $req->username !== null && $req->password !== null ) {
300  // Nothing we can do besides claim it, because the user isn't in
301  // the DB yet
302  if ( $req->username !== $user->getName() ) {
303  $req = clone $req;
304  $req->username = $user->getName();
305  }
307  $ret->createRequest = $req;
308  return $ret;
309  }
310  }
312  }
314  public function finishAccountCreation( $user, $creator, AuthenticationResponse $res ) {
315  if ( $this->accountCreationType() === self::TYPE_NONE ) {
316  throw new \BadMethodCallException( 'Shouldn\'t call this when accountCreationType() is NONE' );
317  }
319  // Now that the user is in the DB, set the password on it.
320  $this->providerChangeAuthenticationData( $res->createRequest );
322  return null;
323  }
324 }
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
bool $loginOnly
If true, this instance is for legacy logins only.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:36
Provider can create accounts.
Definition: PrimaryAuthenticationProvider.php:77
Fetch the account-creation type.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:272
Provider cannot create or link to accounts.
Definition: PrimaryAuthenticationProvider.php:81
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
getPassword( $hash)
Get a Password object from the hash.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:67
the array() calling protocol came about after MediaWiki 1.4rc1.
failResponse(PasswordAuthenticationRequest $req)
Return the appropriate response for failure.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:83
Basic framework for a primary authentication provider that uses passwords.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:35
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
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:2005
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Definition: styleTest.css.php:40
Definition: database.txt:21
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
Definition: DBAccessObjectUtils.php:52
Definition: All_system_messages.txt:425
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
Definition: AuthenticationRequest.php:253
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
Definition: testCompression.php:50
static newAbstain()
Definition: AuthenticationResponse.php:170
getNewPasswordExpiry( $username)
Get expiration date for a new password, if any.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:150
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:201
A primary authentication provider that uses the password field in the 'user' table.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:33
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:159
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:72
This is a value object to hold authentication response data.
Definition: AuthenticationResponse.php:37
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Definition: GlobalFunctions.php:1996
finishAccountCreation( $user, $creator, AuthenticationResponse $res)
Post-creation callback.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:314
Definition: defines.php:25
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:276
Definition: defines.php:29
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
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:240
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:2001
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:292
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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:1255
setPasswordResetFlag( $username, Status $status, $data=null)
Check if the password should be reset.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:118
getPasswordResetData( $username, $row)
Get password reset data, if any.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:49
checkPasswordValidity( $username, $password)
Check that the password is valid.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:103
this hook is for auditing only $req
Definition: hooks.txt:990
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
Definition: LocalPasswordPrimaryAuthenticationProvider.php:185
static newFail(Message $msg)
Definition: AuthenticationResponse.php:146
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition: User.php:1210
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
Get the PasswordFactory.
Definition: AbstractPasswordPrimaryAuthenticationProvider.php:54
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:56
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:111
Definition: AbstractAuthenticationProvider.php:22
__construct( $params=[])
Definition: LocalPasswordPrimaryAuthenticationProvider.php:44
static newPass( $username=null)
Definition: AuthenticationResponse.php:134
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37