MediaWiki REL1_32
LegacyHookPreAuthenticationProvider.php
Go to the documentation of this file.
1<?php
22namespace MediaWiki\Auth;
23
26use User;
27
35
36 public function testForAuthentication( array $reqs ) {
37 $req = AuthenticationRequest::getRequestByClass( $reqs, PasswordAuthenticationRequest::class );
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 ], '1.27' ) ) {
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 ], '1.27' ) ) {
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 ], '1.27' ) ) {
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.
90 $ret = StatusValue::newGood();
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 ], '1.27' ) ) {
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 ) {
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
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
165 return StatusValue::newFatal(
166 $msg ?: 'login-abort-generic', wfEscapeWikiText( $user->getName() )
167 );
168
170 $error = $msg ?: 'login-migrated-generic';
171 return 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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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,...
LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount,...
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.
A pre-authentication provider to call some legacy hooks.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
makeFailResponse(User $user, $constant, $msg, $hook)
Construct an appropriate failure response.
testForAuthentication(array $reqs)
Determine whether an authentication may begin.
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
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
this hook is for auditing only $req
Definition hooks.txt:1018
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:2050
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:2054
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 use $formDescriptor instead 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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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:247
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
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))