MediaWiki  1.28.0
AuthManagerAuthPlugin.php
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Auth;
22 
23 use User;
24 
32  protected $domain = null;
33 
35  protected $logger = null;
36 
37  public function __construct() {
38  $this->logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' );
39  }
40 
41  public function userExists( $name ) {
42  return AuthManager::singleton()->userExists( $name );
43  }
44 
45  public function authenticate( $username, $password ) {
46  $data = [
47  'username' => $username,
48  'password' => $password,
49  ];
50  if ( $this->domain !== null && $this->domain !== '' ) {
51  $data['domain'] = $this->domain;
52  }
53  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_LOGIN );
55 
56  $res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
57  switch ( $res->status ) {
59  return true;
61  // Hope it's not a PreAuthenticationProvider that failed...
62  $msg = $res->message instanceof \Message ? $res->message : new \Message( $res->message );
63  $this->logger->info( __METHOD__ . ': Authentication failed: ' . $msg->plain() );
64  return false;
65  default:
66  throw new \BadMethodCallException(
67  'AuthManager does not support such simplified authentication'
68  );
69  }
70  }
71 
72  public function modifyUITemplate( &$template, &$type ) {
73  // AuthManager does not support direct UI screwing-around-with
74  }
75 
76  public function setDomain( $domain ) {
77  $this->domain = $domain;
78  }
79 
80  public function getDomain() {
81  if ( isset( $this->domain ) ) {
82  return $this->domain;
83  } else {
84  return 'invaliddomain';
85  }
86  }
87 
88  public function validDomain( $domain ) {
89  $domainList = $this->domainList();
90  return $domainList ? in_array( $domain, $domainList, true ) : $domain === '';
91  }
92 
93  public function updateUser( &$user ) {
94  \Hooks::run( 'UserLoggedIn', [ $user ] );
95  return true;
96  }
97 
98  public function autoCreate() {
99  return true;
100  }
101 
102  public function allowPropChange( $prop = '' ) {
103  return AuthManager::singleton()->allowsPropertyChange( $prop );
104  }
105 
106  public function allowPasswordChange() {
107  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_CHANGE );
108  foreach ( $reqs as $req ) {
109  if ( $req instanceof PasswordAuthenticationRequest ) {
110  return true;
111  }
112  }
113 
114  return false;
115  }
116 
117  public function allowSetLocalPassword() {
118  // There should be a PrimaryAuthenticationProvider that does this, if necessary
119  return false;
120  }
121 
122  public function setPassword( $user, $password ) {
123  $data = [
124  'username' => $user->getName(),
125  'password' => $password,
126  ];
127  if ( $this->domain !== null && $this->domain !== '' ) {
128  $data['domain'] = $this->domain;
129  }
130  $reqs = AuthManager::singleton()->getAuthenticationRequests( AuthManager::ACTION_CHANGE );
132  foreach ( $reqs as $req ) {
133  $status = AuthManager::singleton()->allowsAuthenticationDataChange( $req );
134  if ( !$status->isGood() ) {
135  $this->logger->info( __METHOD__ . ': Password change rejected: {reason}', [
136  'username' => $data['username'],
137  'reason' => $status->getWikiText( null, null, 'en' ),
138  ] );
139  return false;
140  }
141  }
142  foreach ( $reqs as $req ) {
143  AuthManager::singleton()->changeAuthenticationData( $req );
144  }
145  return true;
146  }
147 
148  public function updateExternalDB( $user ) {
149  // This fires the necessary hook
150  $user->saveSettings();
151  return true;
152  }
153 
154  public function updateExternalDBGroups( $user, $addgroups, $delgroups = [] ) {
155  \Hooks::run( 'UserGroupsChanged', [ $user, $addgroups, $delgroups ] );
156  return true;
157  }
158 
159  public function canCreateAccounts() {
160  return AuthManager::singleton()->canCreateAccounts();
161  }
162 
163  public function addUser( $user, $password, $email = '', $realname = '' ) {
164  throw new \BadMethodCallException(
165  'Creation of users via AuthPlugin is not supported with '
166  . 'AuthManager. Generally, user creation should be left to either '
167  . 'Special:CreateAccount, auto-creation when triggered by a '
168  . 'SessionProvider or PrimaryAuthenticationProvider, or '
169  . 'User::newSystemUser().'
170  );
171  }
172 
173  public function strict() {
174  // There should be a PrimaryAuthenticationProvider that does this, if necessary
175  return true;
176  }
177 
178  public function strictUserAuth( $username ) {
179  // There should be a PrimaryAuthenticationProvider that does this, if necessary
180  return true;
181  }
182 
183  public function initUser( &$user, $autocreate = false ) {
184  \Hooks::run( 'LocalUserCreated', [ $user, $autocreate ] );
185  }
186 
187  public function getCanonicalName( $username ) {
188  // AuthManager doesn't support restrictions beyond MediaWiki's
189  return $username;
190  }
191 
192  public function getUserInstance( User &$user ) {
193  return new AuthManagerAuthPluginUser( $user );
194  }
195 
196  public function domainList() {
197  return [];
198  }
199 }
200 
207  private $user;
208 
209  function __construct( $user ) {
210  $this->user = $user;
211  }
212 
213  public function getId() {
214  return $this->user->getId();
215  }
216 
217  public function isLocked() {
218  return $this->user->isLocked();
219  }
220 
221  public function isHidden() {
222  return $this->user->isHidden();
223  }
224 
225  public function resetAuthToken() {
226  \MediaWiki\Session\SessionManager::singleton()->invalidateSessionsForUser( $this->user );
227  return true;
228  }
229 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getInstance($channel)
Get a named logger instance from the currently configured logger factory.
static loadRequestsFromSubmission(array $reqs, array $data)
Update a set of requests with form submit data, discarding ones that fail.
Authentication plugin interface.
Definition: AuthPlugin.php:38
addUser($user, $password, $email= '', $realname= '')
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:802
Backwards-compatibility wrapper for AuthManager via $wgAuth.
const FAIL
Indicates that the authentication failed.
static singleton()
Get the global AuthManager.
$res
Definition: database.txt:21
const ACTION_CHANGE
Change a user's credentials.
Definition: AuthManager.php:98
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:9
const PASS
Indicates that the authentication succeeded.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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
static singleton()
Get the global SessionManager.
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
This is a value object for authentication requests with a username and password.
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
updateExternalDBGroups($user, $addgroups, $delgroups=[])
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
const ACTION_LOGIN
Log in with an existing (not necessarily local) user.
Definition: AuthManager.php:83
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300