MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Auth;
23 use Psr\Log\LoggerInterface;
24 use User;
33  protected $domain = null;
36  protected $logger = null;
38  public function __construct() {
39  $this->logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' );
40  }
42  public function userExists( $name ) {
43  return AuthManager::singleton()->userExists( $name );
44  }
46  public function authenticate( $username, $password ) {
47  $data = [
48  'username' => $username,
49  'password' => $password,
50  ];
51  if ( $this->domain !== null && $this->domain !== '' ) {
52  $data['domain'] = $this->domain;
53  }
54  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_LOGIN );
57  $res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
58  switch ( $res->status ) {
60  return true;
62  // Hope it's not a PreAuthenticationProvider that failed...
63  $msg = $res->message instanceof \Message ? $res->message : new \Message( $res->message );
64  $this->logger->info( __METHOD__ . ': Authentication failed: ' . $msg->plain() );
65  return false;
66  default:
67  throw new \BadMethodCallException(
68  'AuthManager does not support such simplified authentication'
69  );
70  }
71  }
73  public function modifyUITemplate( &$template, &$type ) {
74  // AuthManager does not support direct UI screwing-around-with
75  }
77  public function setDomain( $domain ) {
78  $this->domain = $domain;
79  }
81  public function getDomain() {
82  if ( isset( $this->domain ) ) {
83  return $this->domain;
84  } else {
85  return 'invaliddomain';
86  }
87  }
89  public function validDomain( $domain ) {
90  $domainList = $this->domainList();
91  return $domainList ? in_array( $domain, $domainList, true ) : $domain === '';
92  }
94  public function updateUser( &$user ) {
95  \Hooks::run( 'UserLoggedIn', [ $user ] );
96  return true;
97  }
99  public function autoCreate() {
100  return true;
101  }
103  public function allowPropChange( $prop = '' ) {
104  return AuthManager::singleton()->allowsPropertyChange( $prop );
105  }
107  public function allowPasswordChange() {
108  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_CHANGE );
109  foreach ( $reqs as $req ) {
110  if ( $req instanceof PasswordAuthenticationRequest ) {
111  return true;
112  }
113  }
115  return false;
116  }
118  public function allowSetLocalPassword() {
119  // There should be a PrimaryAuthenticationProvider that does this, if necessary
120  return false;
121  }
123  public function setPassword( $user, $password ) {
124  $data = [
125  'username' => $user->getName(),
126  'password' => $password,
127  ];
128  if ( $this->domain !== null && $this->domain !== '' ) {
129  $data['domain'] = $this->domain;
130  }
131  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_CHANGE );
133  foreach ( $reqs as $req ) {
134  $status = AuthManager::singleton()->allowsAuthenticationDataChange( $req );
135  if ( !$status->isGood() ) {
136  $this->logger->info( __METHOD__ . ': Password change rejected: {reason}', [
137  'username' => $data['username'],
138  'reason' => $status->getWikiText( null, null, 'en' ),
139  ] );
140  return false;
141  }
142  }
143  foreach ( $reqs as $req ) {
144  AuthManager::singleton()->changeAuthenticationData( $req );
145  }
146  return true;
147  }
149  public function updateExternalDB( $user ) {
150  // This fires the necessary hook
151  $user->saveSettings();
152  return true;
153  }
155  public function updateExternalDBGroups( $user, $addgroups, $delgroups = [] ) {
156  throw new \BadMethodCallException(
157  'Update of user groups via AuthPlugin is not supported with AuthManager.'
158  );
159  }
161  public function canCreateAccounts() {
162  return AuthManager::singleton()->canCreateAccounts();
163  }
165  public function addUser( $user, $password, $email = '', $realname = '' ) {
166  throw new \BadMethodCallException(
167  'Creation of users via AuthPlugin is not supported with '
168  . 'AuthManager. Generally, user creation should be left to either '
169  . 'Special:CreateAccount, auto-creation when triggered by a '
170  . 'SessionProvider or PrimaryAuthenticationProvider, or '
171  . 'User::newSystemUser().'
172  );
173  }
175  public function strict() {
176  // There should be a PrimaryAuthenticationProvider that does this, if necessary
177  return true;
178  }
180  public function strictUserAuth( $username ) {
181  // There should be a PrimaryAuthenticationProvider that does this, if necessary
182  return true;
183  }
185  public function initUser( &$user, $autocreate = false ) {
186  \Hooks::run( 'LocalUserCreated', [ $user, $autocreate ] );
187  }
189  public function getCanonicalName( $username ) {
190  // AuthManager doesn't support restrictions beyond MediaWiki's
191  return $username;
192  }
194  public function getUserInstance( User &$user ) {
195  return new AuthManagerAuthPluginUser( $user );
196  }
198  public function domainList() {
199  return [];
200  }
201 }
209  private $user;
211  function __construct( $user ) {
212  $this->user = $user;
213  }
215  public function getId() {
216  return $this->user->getId();
217  }
219  public function isLocked() {
220  return $this->user->isLocked();
221  }
223  public function isHidden() {
224  return $this->user->isHidden();
225  }
227  public function resetAuthToken() {
228  \MediaWiki\Session\SessionManager::singleton()->invalidateSessionsForUser( $this->user );
229  return true;
230  }
231 }
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
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
updateExternalDB( $user)
Update user information in the external authentication database.
Definition: AuthManagerAuthPlugin.php:149
getCanonicalName( $username)
If you want to munge the case of an account name before the final check, now is your chance.
Definition: AuthManagerAuthPlugin.php:189
Definition: AuthManagerAuthPlugin.php:215
Definition: AuthManagerAuthPlugin.php:38
getUserInstance(User &$user)
Get an instance of a User object.
Definition: AuthManagerAuthPlugin.php:194
static loadRequestsFromSubmission(array $reqs, array $data)
Update a set of requests with form submit data, discarding ones that fail.
Definition: AuthenticationRequest.php:238
updateExternalDBGroups( $user, $addgroups, $delgroups=[])
Update user groups in the external authentication database.
Definition: AuthManagerAuthPlugin.php:155
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
Definition: LoggerFactory.php:92
Indicate whether the user is hidden.
Definition: AuthManagerAuthPlugin.php:223
Return true if the wiki should create a new local account automatically when asked to login a user wh...
Definition: AuthManagerAuthPlugin.php:99
modifyUITemplate(&$template, &$type)
Modify options in the login template.
Definition: AuthManagerAuthPlugin.php:73
Backwards-compatibility wrapper for AuthManager via $wgAuth.
Definition: AuthManagerAuthPlugin.php:31
initUser(&$user, $autocreate=false)
When creating a user account, optionally fill in preferences and such.
Definition: AuthManagerAuthPlugin.php:185
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template
Definition: hooks.txt:831
addUser( $user, $password, $email='', $realname='')
Add a user to the external authentication database.
Definition: AuthManagerAuthPlugin.php:165
Get a list of domains (in HTMLForm options format) used.
Definition: AuthManagerAuthPlugin.php:198
Definition: database.txt:21
Definition: All_system_messages.txt:425
string null $domain
Definition: AuthManagerAuthPlugin.php:33
Definition: AuthManagerAuthPlugin.php:227
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
This is a value object for authentication requests with a username and password.
Definition: PasswordAuthenticationRequest.php:29
authenticate( $username, $password)
Check if a username+password pair is a valid login.
Definition: AuthManagerAuthPlugin.php:46
Definition: AuthManagerAuthPlugin.php:207
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 and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:25
userExists( $name)
Check whether there exists a user account with the given name.
Definition: AuthManagerAuthPlugin.php:42
strictUserAuth( $username)
Check if a user should authenticate locally if the global authentication fails.
Definition: AuthManagerAuthPlugin.php:180
static singleton()
Get the global SessionManager.
Definition: SessionManager.php:92
Get the user's domain.
Definition: AuthManagerAuthPlugin.php:81
const FAIL
Indicates that the authentication failed.
Definition: AuthenticationResponse.php:42
LoggerInterface $logger
Definition: AuthManagerAuthPlugin.php:36
setDomain( $domain)
Set the domain this plugin is supposed to use when authenticating.
Definition: AuthManagerAuthPlugin.php:77
setPassword( $user, $password)
Set the given password in the authentication database.
Definition: AuthManagerAuthPlugin.php:123
validDomain( $domain)
Check to see if the specific domain is a valid domain.
Definition: AuthManagerAuthPlugin.php:89
Change a user's credentials.
Definition: AuthManager.php:100
Return true to prevent logins that don't authenticate here from being checked against the local datab...
Definition: AuthManagerAuthPlugin.php:175
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
Definition: AuthPlugin.php:330
this hook is for auditing only $req
Definition: hooks.txt:990
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
static singleton()
Get the global AuthManager.
Definition: AuthManager.php:147
User $user
Definition: AuthManagerAuthPlugin.php:209
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:22
Can users change their passwords?
Definition: AuthManagerAuthPlugin.php:107
Log in with an existing (not necessarily local) user.
Definition: AuthManager.php:85
When a user logs in, optionally fill in preferences and such.
Definition: AuthManagerAuthPlugin.php:94
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
const PASS
Indicates that the authentication succeeded.
Definition: AuthenticationResponse.php:39
Check to see if external accounts can be created.
Definition: AuthManagerAuthPlugin.php:161
Indicate whether the user is locked.
Definition: AuthManagerAuthPlugin.php:219
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
__construct( $user)
Definition: AuthManagerAuthPlugin.php:211
Definition: AbstractAuthenticationProvider.php:22
allowPropChange( $prop='')
Allow a property change? Properties are the same as preferences and use the same keys.
Definition: AuthManagerAuthPlugin.php:103
Should MediaWiki store passwords in its local database?
Definition: AuthManagerAuthPlugin.php:118
Authentication plugin interface.
Definition: AuthPlugin.php:38
Definition: testCompression.php:48