MediaWiki  1.29.2
ResetPasswordSecondaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
38 
40  return [];
41  }
42 
43  public function beginSecondaryAuthentication( $user, array $reqs ) {
44  return $this->tryReset( $user, $reqs );
45  }
46 
47  public function continueSecondaryAuthentication( $user, array $reqs ) {
48  return $this->tryReset( $user, $reqs );
49  }
50 
51  public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
52  return $this->tryReset( $user, $reqs );
53  }
54 
55  public function continueSecondaryAccountCreation( $user, $creator, array $reqs ) {
56  return $this->tryReset( $user, $reqs );
57  }
58 
65  protected function tryReset( \User $user, array $reqs ) {
66  $data = $this->manager->getAuthenticationSessionData( 'reset-pass' );
67  if ( !$data ) {
69  }
70 
71  if ( is_array( $data ) ) {
72  $data = (object)$data;
73  }
74  if ( !is_object( $data ) ) {
75  throw new \UnexpectedValueException( 'reset-pass is not valid' );
76  }
77 
78  if ( !isset( $data->msg ) ) {
79  throw new \UnexpectedValueException( 'reset-pass msg is missing' );
80  } elseif ( !$data->msg instanceof \Message ) {
81  throw new \UnexpectedValueException( 'reset-pass msg is not valid' );
82  } elseif ( !isset( $data->hard ) ) {
83  throw new \UnexpectedValueException( 'reset-pass hard is missing' );
84  } elseif ( isset( $data->req ) && (
85  !$data->req instanceof PasswordAuthenticationRequest ||
86  !array_key_exists( 'retype', $data->req->getFieldInfo() )
87  ) ) {
88  throw new \UnexpectedValueException( 'reset-pass req is not valid' );
89  }
90 
91  if ( !$data->hard ) {
93  if ( $req ) {
94  $this->manager->removeAuthenticationSessionData( 'reset-pass' );
96  }
97  }
98 
99  $needReq = isset( $data->req ) ? $data->req : new PasswordAuthenticationRequest();
100  if ( !$needReq->action ) {
101  $needReq->action = AuthManager::ACTION_CHANGE;
102  }
103  $needReq->required = $data->hard ? AuthenticationRequest::REQUIRED
105  $needReqs = [ $needReq ];
106  if ( !$data->hard ) {
107  $needReqs[] = new ButtonAuthenticationRequest(
108  'skipReset',
109  wfMessage( 'authprovider-resetpass-skip-label' ),
110  wfMessage( 'authprovider-resetpass-skip-help' )
111  );
112  }
113 
114  $req = AuthenticationRequest::getRequestByClass( $reqs, get_class( $needReq ) );
115  if ( !$req || !array_key_exists( 'retype', $req->getFieldInfo() ) ) {
116  return AuthenticationResponse::newUI( $needReqs, $data->msg, 'warning' );
117  }
118 
119  if ( $req->password !== $req->retype ) {
120  return AuthenticationResponse::newUI( $needReqs, new \Message( 'badretype' ), 'error' );
121  }
122 
123  $req->username = $user->getName();
124  $status = $this->manager->allowsAuthenticationDataChange( $req );
125  if ( !$status->isGood() ) {
126  return AuthenticationResponse::newUI( $needReqs, $status->getMessage(), 'error' );
127  }
128  $this->manager->changeAuthenticationData( $req );
129 
130  $this->manager->removeAuthenticationSessionData( 'reset-pass' );
132  }
133 }
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset
tryReset(\User $user, array $reqs)
Try to reset the password.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:65
MediaWiki\Auth\AuthenticationRequest\OPTIONAL
const OPTIONAL
Indicates that the request is not required for authentication to proceed.
Definition: AuthenticationRequest.php:40
object
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
MediaWiki\$action
String $action
Cache what action this request is.
Definition: MediaWiki.php:47
MediaWiki\Auth\AbstractSecondaryAuthenticationProvider
A base class that implements some of the boilerplate for a SecondaryAuthenticationProvider.
Definition: AbstractSecondaryAuthenticationProvider.php:30
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\beginSecondaryAccountCreation
beginSecondaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:51
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
$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:246
$req
this hook is for auditing only $req
Definition: hooks.txt:990
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider
Reset the local password, if signalled via $this->manager->setAuthenticationSessionData()
Definition: ResetPasswordSecondaryAuthenticationProvider.php:37
MediaWiki\Auth\AuthenticationRequest\getRequestByClass
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
Definition: AuthenticationRequest.php:253
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\continueSecondaryAuthentication
continueSecondaryAuthentication( $user, array $reqs)
Continue an authentication flow.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:47
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:35
MediaWiki\Auth\AuthenticationResponse\newAbstain
static newAbstain()
Definition: AuthenticationResponse.php:170
MediaWiki\Auth\PasswordAuthenticationRequest
This is a value object for authentication requests with a username and password.
Definition: PasswordAuthenticationRequest.php:29
MediaWiki\Auth\ButtonAuthenticationRequest\getRequestByName
static getRequestByName(array $reqs, $name)
Fetch a ButtonAuthenticationRequest or subclass by name.
Definition: ButtonAuthenticationRequest.php:75
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\beginSecondaryAuthentication
beginSecondaryAuthentication( $user, array $reqs)
Start an authentication flow.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:43
MediaWiki\Auth\AuthManager\ACTION_CHANGE
const ACTION_CHANGE
Change a user's credentials.
Definition: AuthManager.php:99
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\continueSecondaryAccountCreation
continueSecondaryAccountCreation( $user, $creator, array $reqs)
Continue an authentication flow.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:55
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\getAuthenticationRequests
getAuthenticationRequests( $action, array $options)
Return the applicable list of AuthenticationRequests.
Definition: ResetPasswordSecondaryAuthenticationProvider.php:39
MediaWiki\Auth\ButtonAuthenticationRequest
This is an authentication request that just implements a simple button.
Definition: ButtonAuthenticationRequest.php:31
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
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
MediaWiki\Auth\AuthenticationResponse\newPass
static newPass( $username=null)
Definition: AuthenticationResponse.php:134
MediaWiki\Auth\AuthenticationResponse\newUI
static newUI(array $reqs, Message $msg, $msgtype='warning')
Definition: AuthenticationResponse.php:183
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
MediaWiki\Auth\AuthenticationRequest\REQUIRED
const REQUIRED
Indicates that the request is required for authentication to proceed.
Definition: AuthenticationRequest.php:46
array
the array() calling protocol came about after MediaWiki 1.4rc1.