MediaWiki  1.27.2
LegacyHookPreAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
26 use User;
27 
35 
36  public function testForAuthentication( array $reqs ) {
38  if ( $req ) {
39  $user = User::newFromName( $req->username );
40  $password = $req->password;
41  } else {
42  $user = null;
43  foreach ( $reqs as $req ) {
44  if ( $req->username !== null ) {
45  $user = User::newFromName( $req->username );
46  break;
47  }
48  }
49  if ( !$user ) {
50  $this->logger->debug( __METHOD__ . ': No username in $reqs, skipping hooks' );
51  return StatusValue::newGood();
52  }
53 
54  // Something random for the 'AbortLogin' hook.
55  $password = wfRandomString( 32 );
56  }
57 
58  $msg = null;
59  if ( !\Hooks::run( 'LoginUserMigrated', [ $user, &$msg ] ) ) {
60  return $this->makeFailResponse(
61  $user, null, LoginForm::USER_MIGRATED, $msg, 'LoginUserMigrated'
62  );
63  }
64 
65  $abort = LoginForm::ABORTED;
66  $msg = null;
67  if ( !\Hooks::run( 'AbortLogin', [ $user, $password, &$abort, &$msg ] ) ) {
68  return $this->makeFailResponse( $user, null, $abort, $msg, 'AbortLogin' );
69  }
70 
71  return StatusValue::newGood();
72  }
73 
74  public function testForAccountCreation( $user, $creator, array $reqs ) {
75  $abortError = '';
76  $abortStatus = null;
77  if ( !\Hooks::run( 'AbortNewAccount', [ $user, &$abortError, &$abortStatus ] ) ) {
78  // Hook point to add extra creation throttles and blocks
79  $this->logger->debug( __METHOD__ . ': a hook blocked creation' );
80  if ( $abortStatus === null ) {
81  // Report back the old string as a raw message status.
82  // This will report the error back as 'createaccount-hook-aborted'
83  // with the given string as the message.
84  // To return a different error code, return a StatusValue object.
85  $msg = wfMessage( 'createaccount-hook-aborted' )->rawParams( $abortError );
86  return StatusValue::newFatal( $msg );
87  } else {
88  // For MediaWiki 1.23+ and updated hooks, return the Status object
89  // returned from the hook.
91  $ret->merge( $abortStatus );
92  return $ret;
93  }
94  }
95 
96  return StatusValue::newGood();
97  }
98 
99  public function testUserForCreation( $user, $autocreate ) {
100  if ( $autocreate !== false ) {
101  $abortError = '';
102  if ( !\Hooks::run( 'AbortAutoAccount', [ $user, &$abortError ] ) ) {
103  // Hook point to add extra creation throttles and blocks
104  $this->logger->debug( __METHOD__ . ": a hook blocked auto-creation: $abortError\n" );
105  return $this->makeFailResponse(
106  $user, $user, LoginForm::ABORTED, $abortError, 'AbortAutoAccount'
107  );
108  }
109  } else {
110  $abortError = '';
111  $abortStatus = null;
112  if ( !\Hooks::run( 'AbortNewAccount', [ $user, &$abortError, &$abortStatus ] ) ) {
113  // Hook point to add extra creation throttles and blocks
114  $this->logger->debug( __METHOD__ . ': a hook blocked creation' );
115  if ( $abortStatus === null ) {
116  // Report back the old string as a raw message status.
117  // This will report the error back as 'createaccount-hook-aborted'
118  // with the given string as the message.
119  // To return a different error code, return a StatusValue object.
120  $msg = wfMessage( 'createaccount-hook-aborted' )->rawParams( $abortError );
121  return StatusValue::newFatal( $msg );
122  } else {
123  // For MediaWiki 1.23+ and updated hooks, return the Status object
124  // returned from the hook.
126  $ret->merge( $abortStatus );
127  return $ret;
128  }
129  }
130  }
131 
132  return StatusValue::newGood();
133  }
134 
144  protected function makeFailResponse( $user, $creator, $constant, $msg, $hook ) {
145  switch ( $constant ) {
146  case LoginForm::SUCCESS:
147  // WTF?
148  $this->logger->debug( "$hook is SUCCESS?!" );
149  return StatusValue::newGood();
150 
152  return StatusValue::newFatal( $msg ?: 'nocookiesforlogin' );
153 
155  return StatusValue::newFatal( $msg ?: 'sessionfailure' );
156 
157  case LoginForm::NO_NAME:
158  case LoginForm::ILLEGAL:
159  return StatusValue::newFatal( $msg ?: 'noname' );
160 
163  return StatusValue::newFatal( $msg ?: 'wrongpassword' );
164 
166  return StatusValue::newFatal( $msg ?: 'nosuchusershort', wfEscapeWikiText( $user->getName() ) );
167 
169  return StatusValue::newFatal( $msg ?: 'wrongpasswordempty' );
170 
172  return StatusValue::newFatal( $msg ?: 'resetpass_announce' );
173 
175  $throttle = $this->config->get( 'PasswordAttemptThrottle' );
176  return StatusValue::newFatal(
177  $msg ?: 'login-throttled',
178  \Message::durationParam( $throttle['seconds'] )
179  );
180 
182  return StatusValue::newFatal(
183  $msg ?: 'login-userblocked', wfEscapeWikiText( $user->getName() )
184  );
185 
186  case LoginForm::ABORTED:
187  return StatusValue::newFatal(
188  $msg ?: 'login-abort-generic', wfEscapeWikiText( $user->getName() )
189  );
190 
192  $error = $msg ?: 'login-migrated-generic';
193  return call_user_func_array( 'StatusValue::newFatal', (array)$error );
194 
195  // @codeCoverageIgnoreStart
196  case LoginForm::CREATE_BLOCKED: // Can never happen
197  default:
198  throw new \DomainException( __METHOD__ . ": Unhandled case value from $hook" );
199  }
200  // @codeCoverageIgnoreEnd
201  }
202 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:568
the array() calling protocol came about after MediaWiki 1.4rc1.
testForAccountCreation($user, $creator, array $reqs)
Determine whether an account creation may begin.
static durationParam($duration)
Definition: Message.php:997
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
A pre-authentication provider to call some legacy hooks.
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
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:1798
wfRandomString($length=32)
Get a random string containing a number of pseudo-random hex characters.
wfEscapeWikiText($text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing 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
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 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
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
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:965
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
A base class that implements some of the boilerplate for a PreAuthenticationProvider.
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
makeFailResponse($user, $creator, $constant, $msg, $hook)
Construct an appropriate failure response.
testUserForCreation($user, $autocreate)
Determine whether an account may be created.
testForAuthentication(array $reqs)
Determine whether an authentication may begin.