MediaWiki  1.28.0
PasswordReset.php
Go to the documentation of this file.
1 <?php
25 
35  protected $config;
36 
38  protected $authManager;
39 
46 
48  $this->config = $config;
49  $this->authManager = $authManager;
50  $this->permissionCache = new HashBagOStuff( [ 'maxKeys' => 1 ] );
51  }
52 
60  public function isAllowed( User $user, $displayPassword = false ) {
61  $statuses = $this->permissionCache->get( $user->getName() );
62  if ( $statuses ) {
63  list ( $status, $status2 ) = $statuses;
64  } else {
65  $resetRoutes = $this->config->get( 'PasswordResetRoutes' );
67 
68  if ( !is_array( $resetRoutes ) ||
69  !in_array( true, array_values( $resetRoutes ), true )
70  ) {
71  // Maybe password resets are disabled, or there are no allowable routes
72  $status = StatusValue::newFatal( 'passwordreset-disabled' );
73  } elseif (
74  ( $providerStatus = $this->authManager->allowsAuthenticationDataChange(
76  && !$providerStatus->isGood()
77  ) {
78  // Maybe the external auth plugin won't allow local password changes
79  $status = StatusValue::newFatal( 'resetpass_forbidden-reason',
80  $providerStatus->getMessage() );
81  } elseif ( !$this->config->get( 'EnableEmail' ) ) {
82  // Maybe email features have been disabled
83  $status = StatusValue::newFatal( 'passwordreset-emaildisabled' );
84  } elseif ( !$user->isAllowed( 'editmyprivateinfo' ) ) {
85  // Maybe not all users have permission to change private data
86  $status = StatusValue::newFatal( 'badaccess' );
87  } elseif ( $user->isBlocked() ) {
88  // Maybe the user is blocked (check this here rather than relying on the parent
89  // method as we have a more specific error message to use here
90  $status = StatusValue::newFatal( 'blocked-mailpassword' );
91  }
92 
93  $status2 = StatusValue::newGood();
94  if ( !$user->isAllowed( 'passwordreset' ) ) {
95  $status2 = StatusValue::newFatal( 'badaccess' );
96  }
97 
98  $this->permissionCache->set( $user->getName(), [ $status, $status2 ] );
99  }
100 
101  if ( !$displayPassword || !$status->isGood() ) {
102  return $status;
103  } else {
104  return $status2;
105  }
106  }
107 
123  public function execute(
124  User $performingUser, $username = null, $email = null, $displayPassword = false
125  ) {
126  if ( !$this->isAllowed( $performingUser, $displayPassword )->isGood() ) {
127  $action = $this->isAllowed( $performingUser )->isGood() ? 'display' : 'reset';
128  throw new LogicException( 'User ' . $performingUser->getName()
129  . ' is not allowed to ' . $action . ' passwords' );
130  }
131 
132  $resetRoutes = $this->config->get( 'PasswordResetRoutes' )
133  + [ 'username' => false, 'email' => false ];
134  if ( $resetRoutes['username'] && $username ) {
135  $method = 'username';
136  $users = [ User::newFromName( $username ) ];
137  } elseif ( $resetRoutes['email'] && $email ) {
138  if ( !Sanitizer::validateEmail( $email ) ) {
139  return StatusValue::newFatal( 'passwordreset-invalidemail' );
140  }
141  $method = 'email';
142  $users = $this->getUsersByEmail( $email );
143  } else {
144  // The user didn't supply any data
145  return StatusValue::newFatal( 'passwordreset-nodata' );
146  }
147 
148  // Check for hooks (captcha etc), and allow them to modify the users list
149  $error = [];
150  $data = [
151  'Username' => $username,
152  'Email' => $email,
153  'Capture' => $displayPassword ? '1' : null,
154  ];
155  if ( !Hooks::run( 'SpecialPasswordResetOnSubmit', [ &$users, $data, &$error ] ) ) {
157  }
158 
159  if ( !$users ) {
160  if ( $method === 'email' ) {
161  // Don't reveal whether or not an email address is in use
162  return StatusValue::newGood( [] );
163  } else {
164  return StatusValue::newFatal( 'noname' );
165  }
166  }
167 
168  $firstUser = $users[0];
169 
170  if ( !$firstUser instanceof User || !$firstUser->getId() ) {
171  // Don't parse username as wikitext (bug 65501)
172  return StatusValue::newFatal( wfMessage( 'nosuchuser', wfEscapeWikiText( $username ) ) );
173  }
174 
175  // Check against the rate limiter
176  if ( $performingUser->pingLimiter( 'mailpassword' ) ) {
177  return StatusValue::newFatal( 'actionthrottledtext' );
178  }
179 
180  // All the users will have the same email address
181  if ( !$firstUser->getEmail() ) {
182  // This won't be reachable from the email route, so safe to expose the username
183  return StatusValue::newFatal( wfMessage( 'noemail',
184  wfEscapeWikiText( $firstUser->getName() ) ) );
185  }
186 
187  // We need to have a valid IP address for the hook, but per bug 18347, we should
188  // send the user's name if they're logged in.
189  $ip = $performingUser->getRequest()->getIP();
190  if ( !$ip ) {
191  return StatusValue::newFatal( 'badipaddress' );
192  }
193 
194  Hooks::run( 'User::mailPasswordInternal', [ &$performingUser, &$ip, &$firstUser ] );
195 
197  $reqs = [];
198  foreach ( $users as $user ) {
199  $req = TemporaryPasswordAuthenticationRequest::newRandom();
200  $req->username = $user->getName();
201  $req->mailpassword = true;
202  $req->hasBackchannel = $displayPassword;
203  $req->caller = $performingUser->getName();
204  $status = $this->authManager->allowsAuthenticationDataChange( $req, true );
205  if ( $status->isGood() && $status->getValue() !== 'ignored' ) {
206  $reqs[] = $req;
207  } elseif ( $result->isGood() ) {
208  // only record the first error, to avoid exposing the number of users having the
209  // same email address
210  if ( $status->getValue() === 'ignored' ) {
211  $status = StatusValue::newFatal( 'passwordreset-ignored' );
212  }
213  $result->merge( $status );
214  }
215  }
216 
217  if ( !$result->isGood() ) {
218  return $result;
219  }
220 
221  $passwords = [];
222  foreach ( $reqs as $req ) {
223  $this->authManager->changeAuthenticationData( $req );
224  // TODO record mail sending errors
225  if ( $displayPassword ) {
226  $passwords[$req->username] = $req->password;
227  }
228  }
229 
230  return StatusValue::newGood( $passwords );
231  }
232 
238  protected function getUsersByEmail( $email ) {
239  $res = wfGetDB( DB_REPLICA )->select(
240  'user',
242  [ 'user_email' => $email ],
243  __METHOD__
244  );
245 
246  if ( !$res ) {
247  // Some sort of database error, probably unreachable
248  throw new MWException( 'Unknown database error in ' . __METHOD__ );
249  }
250 
251  $users = [];
252  foreach ( $res as $row ) {
253  $users[] = User::newFromRow( $row );
254  }
255  return $users;
256  }
257 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
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
static newFromRow($row, $data=null)
Create a new user object from a user row.
Definition: User.php:612
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
__construct(Config $config, AuthManager $authManager)
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
pingLimiter($action= 'edit', $incrBy=1)
Primitive rate limits: enforce maximum actions per time period to put a brake on flooding.
Definition: User.php:1794
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2108
static selectFields()
Return the list of user fields that should be selected to create a new user object.
Definition: User.php:5325
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. '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 '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
HashBagOStuff $permissionCache
In-process cache for isAllowed lookups, by username.
wfEscapeWikiText($text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
AuthManager $authManager
isAllowed($action= '')
Internal mechanics of testing a permission.
Definition: User.php:3443
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
$res
Definition: database.txt:21
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
This serves as the entry point to the authentication system.
Definition: AuthManager.php:81
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
This represents the intention to set a temporary password for the user.
Helper class for the password reset functionality shared by the web UI and the API.
getUsersByEmail($email)
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 local account $user
Definition: hooks.txt:242
isBlocked($bFromSlave=true)
Check if user is blocked.
Definition: User.php:1934
getRequest()
Get the WebRequest object to use with this object.
Definition: User.php:3490
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:1007
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:802
execute(User $performingUser, $username=null, $email=null, $displayPassword=false)
Do a password reset.
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 $status
Definition: hooks.txt:1046
isAllowed(User $user, $displayPassword=false)
Check if a given user has permission to use this functionality.
static validateEmail($addr)
Does a string look like an e-mail address?
Definition: Sanitizer.php:1942
const DB_REPLICA
Definition: defines.php:22
static newFromSpecifier($value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:398