MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
26 use Status;
35 {
37  protected $authoritative;
39  private $passwordFactory = null;
46  public function __construct( array $params = [] ) {
47  $this->authoritative = !isset( $params['authoritative'] ) || (bool)$params['authoritative'];
48  }
54  protected function getPasswordFactory() {
55  if ( $this->passwordFactory === null ) {
56  $this->passwordFactory = new PasswordFactory();
57  $this->passwordFactory->init( $this->config );
58  }
60  }
67  protected function getPassword( $hash ) {
69  try {
70  return $passwordFactory->newFromCiphertext( $hash );
71  } catch ( \PasswordError $e ) {
72  $class = static::class;
73  $this->logger->debug( "Invalid password hash in {$class}::getPassword()" );
74  return $passwordFactory->newFromCiphertext( null );
75  }
76  }
84  if ( $this->authoritative ) {
86  wfMessage( $req->password === '' ? 'wrongpasswordempty' : 'wrongpassword' )
87  );
88  } else {
90  }
91  }
103  protected function checkPasswordValidity( $username, $password ) {
104  return \User::newFromName( $username )->checkPasswordValidity( $password );
105  }
118  protected function setPasswordResetFlag( $username, Status $status, $data = null ) {
119  $reset = $this->getPasswordResetData( $username, $data );
121  if ( !$reset && $this->config->get( 'InvalidPasswordReset' ) && !$status->isGood() ) {
122  $reset = (object)[
123  'msg' => $status->getMessage( 'resetpass-validity-soft' ),
124  'hard' => false,
125  ];
126  }
128  if ( $reset ) {
129  $this->manager->setAuthenticationSessionData( 'reset-pass', $reset );
130  }
131  }
140  protected function getPasswordResetData( $username, $data ) {
141  return null;
142  }
150  protected function getNewPasswordExpiry( $username ) {
151  $days = $this->config->get( 'PasswordExpirationDays' );
152  $expires = $days ? wfTimestamp( TS_MW, time() + $days * 86400 ) : null;
154  // Give extensions a chance to force an expiration
155  \Hooks::run( 'ResetPasswordExpiration', [ \User::newFromName( $username ), &$expires ] );
157  return $expires;
158  }
161  switch ( $action ) {
166  return [ new PasswordAuthenticationRequest() ];
167  default:
168  return [];
169  }
170  }
171 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
the array() calling protocol came about after MediaWiki 1.4rc1.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
setPasswordResetFlag($username, Status $status, $data=null)
Check if the password should be reset.
Returns whether the operation completed and didn't have any error or warnings.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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
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 and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
Change a user's credentials.
Definition: AuthManager.php:98
getAuthenticationRequests($action, array $options)
{{Return the applicable list of AuthenticationRequests.Possible values for $action depend on whether ...
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
Basic framework for a primary authentication provider that uses passwords.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
bool $authoritative
Whether this provider should ABSTAIN (false) or FAIL (true) on password failure.
This is a value object for authentication requests with a username and password.
getMessage($shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
Definition: Status.php:233
String $action
Cache what action this request is.
Definition: MediaWiki.php:43
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
A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider.
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:802
Show an error when any operation involving passwords fails to run.
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
Remove a user's credentials.
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
Create a new user.
Definition: AuthManager.php:88
Get expiration date for a new password, if any.
failResponse(PasswordAuthenticationRequest $req)
Return the appropriate response for failure.
Log in with an existing (not necessarily local) user.
Definition: AuthManager.php:83