MediaWiki  REL1_31
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, 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, $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, array $options = [] ) {
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, LoginForm::ABORTED, $abortError, 'AbortAutoAccount'
107  );
108  }
109  }
110 
111  return StatusValue::newGood();
112  }
113 
122  private function makeFailResponse( User $user, $constant, $msg, $hook ) {
123  switch ( $constant ) {
124  case LoginForm::SUCCESS:
125  // WTF?
126  $this->logger->debug( "$hook is SUCCESS?!" );
127  return StatusValue::newGood();
128 
130  return StatusValue::newFatal( $msg ?: 'nocookiesforlogin' );
131 
133  return StatusValue::newFatal( $msg ?: 'sessionfailure' );
134 
135  case LoginForm::NO_NAME:
136  case LoginForm::ILLEGAL:
137  return StatusValue::newFatal( $msg ?: 'noname' );
138 
141  return StatusValue::newFatal( $msg ?: 'wrongpassword' );
142 
144  return StatusValue::newFatal( $msg ?: 'nosuchusershort', wfEscapeWikiText( $user->getName() ) );
145 
147  return StatusValue::newFatal( $msg ?: 'wrongpasswordempty' );
148 
150  return StatusValue::newFatal( $msg ?: 'resetpass_announce' );
151 
153  $throttle = $this->config->get( 'PasswordAttemptThrottle' );
154  return StatusValue::newFatal(
155  $msg ?: 'login-throttled',
156  \Message::durationParam( $throttle['seconds'] )
157  );
158 
160  return StatusValue::newFatal(
161  $msg ?: 'login-userblocked', wfEscapeWikiText( $user->getName() )
162  );
163 
164  case LoginForm::ABORTED:
165  return StatusValue::newFatal(
166  $msg ?: 'login-abort-generic', wfEscapeWikiText( $user->getName() )
167  );
168 
170  $error = $msg ?: 'login-migrated-generic';
171  return call_user_func_array( 'StatusValue::newFatal', (array)$error );
172 
173  // @codeCoverageIgnoreStart
174  case LoginForm::CREATE_BLOCKED: // Can never happen
175  default:
176  throw new \DomainException( __METHOD__ . ": Unhandled case value from $hook" );
177  }
178  // @codeCoverageIgnoreEnd
179  }
180 }
$user
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
MediaWiki\Auth\LegacyHookPreAuthenticationProvider\testUserForCreation
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
Definition: LegacyHookPreAuthenticationProvider.php:99
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
MediaWiki\Auth\LegacyHookPreAuthenticationProvider\testForAuthentication
testForAuthentication(array $reqs)
Determine whether an authentication may begin.
Definition: LegacyHookPreAuthenticationProvider.php:36
LoginForm\USER_BLOCKED
const USER_BLOCKED
Definition: LoginSignupSpecialPage.php:1472
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
LoginForm\WRONG_PASS
const WRONG_PASS
Definition: LoginSignupSpecialPage.php:1466
LoginForm\CREATE_BLOCKED
const CREATE_BLOCKED
Definition: LoginSignupSpecialPage.php:1470
wfMessage
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 unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MediaWiki\Auth\LegacyHookPreAuthenticationProvider\makeFailResponse
makeFailResponse(User $user, $constant, $msg, $hook)
Construct an appropriate failure response.
Definition: LegacyHookPreAuthenticationProvider.php:122
LoginForm\ILLEGAL
const ILLEGAL
Definition: LoginSignupSpecialPage.php:1463
LoginForm\SUCCESS
const SUCCESS
Definition: LoginSignupSpecialPage.php:1461
$ret
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:2005
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
LoginForm\RESET_PASS
const RESET_PASS
Definition: LoginSignupSpecialPage.php:1468
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
LoginForm\THROTTLED
const THROTTLED
Definition: LoginSignupSpecialPage.php:1471
User
User
Definition: All_system_messages.txt:425
LoginForm\USER_MIGRATED
const USER_MIGRATED
Definition: LoginSignupSpecialPage.php:1475
MediaWiki\Auth\AuthenticationRequest\getRequestByClass
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
Definition: AuthenticationRequest.php:253
php
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
LoginForm\EMPTY_PASS
const EMPTY_PASS
Definition: LoginSignupSpecialPage.php:1467
LoginForm\ABORTED
const ABORTED
Definition: LoginSignupSpecialPage.php:1469
LoginForm\NOT_EXISTS
const NOT_EXISTS
Definition: LoginSignupSpecialPage.php:1465
LoginForm
LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount,...
Definition: LoginSignupSpecialPage.php:1460
$options
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 & $options
Definition: hooks.txt:2001
LoginForm\WRONG_TOKEN
const WRONG_TOKEN
Definition: LoginSignupSpecialPage.php:1474
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
MediaWiki\Auth\LegacyHookPreAuthenticationProvider\testForAccountCreation
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
Definition: LegacyHookPreAuthenticationProvider.php:74
$req
this hook is for auditing only $req
Definition: hooks.txt:990
as
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
LoginForm\NEED_TOKEN
const NEED_TOKEN
Definition: LoginSignupSpecialPage.php:1473
MediaWiki\Auth\AbstractPreAuthenticationProvider
A base class that implements some of the boilerplate for a PreAuthenticationProvider.
Definition: AbstractPreAuthenticationProvider.php:31
LoginForm\NO_NAME
const NO_NAME
Definition: LoginSignupSpecialPage.php:1462
MediaWiki\Auth\LegacyHookPreAuthenticationProvider
A pre-authentication provider to call some legacy hooks.
Definition: LegacyHookPreAuthenticationProvider.php:34
class
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:56
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
Message\durationParam
static durationParam( $duration)
Definition: Message.php:1039
LoginForm\WRONG_PLUGIN_PASS
const WRONG_PLUGIN_PASS
Definition: LoginSignupSpecialPage.php:1464
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:305