MediaWiki  1.27.1
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Auth;
25 
27 use User;
28 
54  const TYPE_CREATE = 'create';
56  const TYPE_LINK = 'link';
58  const TYPE_NONE = 'none';
59 
73  public function beginPrimaryAuthentication( array $reqs );
74 
84  public function continuePrimaryAuthentication( array $reqs );
85 
94 
101  public function testUserExists( $username, $flags = User::READ_NORMAL );
102 
108  public function testUserCanAuthenticate( $username );
109 
130  public function providerNormalizeUsername( $username );
131 
143  public function providerRevokeAccessForUser( $username );
144 
151  public function providerAllowsPropertyChange( $property );
152 
167  AuthenticationRequest $req, $checkData = true
168  );
169 
182 
187  public function accountCreationType();
188 
203  public function testForAccountCreation( $user, $creator, array $reqs );
204 
222  public function beginPrimaryAccountCreation( $user, $creator, array $reqs );
223 
238  public function continuePrimaryAccountCreation( $user, $creator, array $reqs );
239 
256  public function finishAccountCreation( $user, $creator, AuthenticationResponse $response );
257 
270  public function postAccountCreation( $user, $creator, AuthenticationResponse $response );
271 
282  public function testUserForCreation( $user, $autocreate );
283 
292  public function autoCreatedAccount( $user, $source );
293 
309  public function beginPrimaryAccountLink( $user, array $reqs );
310 
323  public function continuePrimaryAccountLink( $user, array $reqs );
324 
333 
334 }
beginPrimaryAccountCreation($user, $creator, array $reqs)
Start an account creation flow.
the array() calling protocol came about after MediaWiki 1.4rc1.
$property
An AuthenticationProvider is used by AuthManager when authenticating users.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
$source
testUserExists($username, $flags=User::READ_NORMAL)
Test whether the named user exists.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2548
This is a value object to hold authentication response data.
providerNormalizeUsername($username)
Normalize the username for authentication.
testUserCanAuthenticate($username)
Test whether the named user can authenticate with this provider.
this hook is for auditing only $response
Definition: hooks.txt:762
A primary authentication provider determines which user is trying to log in.
finishAccountCreation($user, $creator, AuthenticationResponse $response)
Post-creation callback.
const TYPE_LINK
Provider can link to existing accounts elsewhere.
beginPrimaryAccountLink($user, array $reqs)
Start linking an account to an existing user.
testUserForCreation($user, $autocreate)
Determine whether an account may be created.
providerRevokeAccessForUser($username)
Revoke the user's credentials.
autoCreatedAccount($user, $source)
Post-auto-creation callback.
postAccountCreation($user, $creator, AuthenticationResponse $response)
Post-creation callback.
postAuthentication($user, AuthenticationResponse $response)
Post-login callback.
postAccountLink($user, AuthenticationResponse $response)
Post-link callback.
providerAllowsPropertyChange($property)
Determine whether a property can change.
const TYPE_NONE
Provider cannot create or link to accounts.
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
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:762
continuePrimaryAccountLink($user, array $reqs)
Continue linking an account to an existing user.
testForAccountCreation($user, $creator, array $reqs)
Determine whether an account creation may begin.
continuePrimaryAccountCreation($user, $creator, array $reqs)
Continue an account creation flow.
accountCreationType()
Fetch the account-creation type.
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
This is a value object for authentication requests.