MediaWiki REL1_37
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MediaWiki\Auth\AuthenticationRequest Class Reference

This is a value object for authentication requests. More...

Inheritance diagram for MediaWiki\Auth\AuthenticationRequest:
Inheritance graph
[legend]

Public Member Functions

 describeCredentials ()
 Describe the credentials represented by this request.
 
 getFieldInfo ()
 Fetch input field info.
 
 getMetadata ()
 Returns metadata about this request.
 
 getUniqueId ()
 Supply a unique key for deduplication.
 
 loadFromSubmission (array $data)
 Initialize form submitted form data.
 

Static Public Member Functions

static __set_state ( $data)
 Implementing this mainly for use from the unit tests.
 
static getRequestByClass (array $reqs, $class, $allowSubclasses=false)
 Select a request by class name.
 
static getUsernameFromRequests (array $reqs)
 Get the username from the set of requests.
 
static loadRequestsFromSubmission (array $reqs, array $data)
 Update a set of requests with form submit data, discarding ones that fail.
 
static mergeFieldInfo (array $reqs)
 Merge the output of multiple AuthenticationRequest::getFieldInfo() calls.
 

Public Attributes

string null $action = null
 The AuthManager::ACTION_* constant this request was created to be used for.
 
int $required = self::REQUIRED
 For login, continue, and link actions, one of self::OPTIONAL, self::REQUIRED, or self::PRIMARY_REQUIRED.
 
string null $returnToUrl = null
 Return-to URL, in case of redirect.
 
string null $username = null
 Username.
 
const OPTIONAL = 0
 Indicates that the request is not required for authentication to proceed.
 
const PRIMARY_REQUIRED = 2
 Indicates that the request is required by a primary authentication provider.
 
const REQUIRED = 1
 Indicates that the request is required for authentication to proceed.
 

Detailed Description

This is a value object for authentication requests.

An AuthenticationRequest represents a set of form fields that are needed on and provided from a login, account creation, password change or similar form.

Stability: stable
to extend
Since
1.27

Definition at line 38 of file AuthenticationRequest.php.

Member Function Documentation

◆ __set_state()

static MediaWiki\Auth\AuthenticationRequest::__set_state (   $data)
static

Implementing this mainly for use from the unit tests.

Parameters
array$data
Returns
AuthenticationRequest

Reimplemented in MediaWiki\Auth\ButtonAuthenticationRequest, MediaWiki\Auth\ConfirmLinkAuthenticationRequest, and MediaWiki\Auth\PasswordDomainAuthenticationRequest.

Definition at line 396 of file AuthenticationRequest.php.

◆ describeCredentials()

MediaWiki\Auth\AuthenticationRequest::describeCredentials ( )

Describe the credentials represented by this request.

This is used on requests returned by AuthenticationProvider::getAuthenticationRequests() for ACTION_LINK and ACTION_REMOVE and for requests returned in AuthenticationResponse::$linkRequest to create useful user interfaces.

Stability: stable
to override
Returns
Message[] with the following keys:
  • provider: A Message identifying the service that provides the credentials, e.g. the name of the third party authentication service.
  • account: A Message identifying the credentials themselves, e.g. the email address used with the third party authentication service.

Reimplemented in MediaWiki\Auth\PasswordAuthenticationRequest, MediaWiki\Auth\PasswordDomainAuthenticationRequest, and MediaWiki\Auth\TemporaryPasswordAuthenticationRequest.

Definition at line 235 of file AuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\getUniqueId().

Referenced by SpecialChangeCredentials\showSubpageList().

◆ getFieldInfo()

MediaWiki\Auth\AuthenticationRequest::getFieldInfo ( )
abstract

Fetch input field info.

The field info is an associative array mapping field names to info arrays. The info arrays have the following keys:

  • type: (string) Type of input. Types and equivalent HTML widgets are:
    • string: <input type="text">
    • password: <input type="password">
    • select: <select>
    • checkbox: <input type="checkbox">
    • multiselect: More a grid of checkboxes than <select multi>
    • button: <input type="submit"> (uses 'label' as button text)
    • hidden: Not visible to the user, but needs to be preserved for the next request
    • null: No widget, just display the 'label' message.
  • options: (array) Maps option values to Messages for the 'select' and 'multiselect' types.
  • value: (string) Value (for 'null' and 'hidden') or default value (for other types).
  • label: (Message) Text suitable for a label in an HTML form
  • help: (Message) Text suitable as a description of what the field is
  • optional: (bool) If set and truthy, the field may be left empty
  • sensitive: (bool) If set and truthy, the field is considered sensitive. Code using the request should avoid exposing the value of the field.
  • skippable: (bool) If set and truthy, the client is free to hide this field from the user to streamline the workflow. If all fields are skippable (except possibly a single button), no user interaction is required at all.

All AuthenticationRequests are populated from the same data, so most of the time you'll want to prefix fields names with something unique to the extension/provider (although in some cases sharing the field with other requests is the right thing to do, e.g. for a 'password' field).

Returns
array As above

Reimplemented in MediaWiki\Auth\ButtonAuthenticationRequest, MediaWiki\Auth\ConfirmLinkAuthenticationRequest, MediaWiki\Auth\CreatedAccountAuthenticationRequest, MediaWiki\Auth\CreateFromLoginAuthenticationRequest, MediaWiki\Auth\CreationReasonAuthenticationRequest, MediaWiki\Auth\PasswordAuthenticationRequest, MediaWiki\Auth\PasswordDomainAuthenticationRequest, MediaWiki\Auth\RememberMeAuthenticationRequest, MediaWiki\Auth\TemporaryPasswordAuthenticationRequest, MediaWiki\Auth\UserDataAuthenticationRequest, and MediaWiki\Auth\UsernameAuthenticationRequest.

Referenced by AuthManagerSpecialPage\hasOwnSubmitButton(), and MediaWiki\Auth\AuthenticationRequest\loadFromSubmission().

◆ getMetadata()

MediaWiki\Auth\AuthenticationRequest::getMetadata ( )

Returns metadata about this request.

This is mainly for the benefit of API clients which need more detailed render hints than what's available through getFieldInfo(). Semantics are unspecified and left to the individual subclasses, but the contents of the array should be primitive types so that they can be transformed into JSON or similar formats.

Stability: stable
to override
Returns
array A (possibly nested) array with primitive types

Definition at line 142 of file AuthenticationRequest.php.

◆ getRequestByClass()

static MediaWiki\Auth\AuthenticationRequest::getRequestByClass ( array  $reqs,
  $class,
  $allowSubclasses = false 
)
static

Select a request by class name.

Parameters
AuthenticationRequest[]$reqs
string$classClass name
bool$allowSubclassesIf true, also returns any request that's a subclass of the given class.
Returns
AuthenticationRequest|null Returns null if there is not exactly one matching request.

Definition at line 272 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation(), MediaWiki\Auth\AuthManager\beginAuthentication(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAccountCreation(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAccountCreation(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAuthentication(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testForAccountCreation(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testForAccountCreation(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().

◆ getUniqueId()

MediaWiki\Auth\AuthenticationRequest::getUniqueId ( )

Supply a unique key for deduplication.

When the AuthenticationRequests instances returned by the providers are merged, the value returned here is used for keeping only one copy of duplicate requests.

Subclasses should override this if multiple distinct instances would make sense, i.e. the request class has internal state of some sort.

This value might be exposed to the user in web forms so it should not contain private information.

Stability: stable
to override
Returns
string

Reimplemented in MediaWiki\Auth\ButtonAuthenticationRequest, and MediaWiki\Auth\ConfirmLinkAuthenticationRequest.

Definition at line 90 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\AuthenticationRequest\describeCredentials(), ApiRemoveAuthenticationData\execute(), and ApiAuthManagerHelper\loadAuthenticationRequests().

◆ getUsernameFromRequests()

static MediaWiki\Auth\AuthenticationRequest::getUsernameFromRequests ( array  $reqs)
static

Get the username from the set of requests.

Only considers requests that have a "username" field.

Parameters
AuthenticationRequest[]$reqs
Returns
string|null
Exceptions

\UnexpectedValueException If multiple different usernames are present.

Definition at line 292 of file AuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\$username.

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation(), and MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAuthentication().

◆ loadFromSubmission()

MediaWiki\Auth\AuthenticationRequest::loadFromSubmission ( array  $data)

Initialize form submitted form data.

The default behavior is to check for each key of self::getFieldInfo() in the submitted data, and copy the value - after type-appropriate transformations - to $this->$key. Most subclasses won't need to override this; if you do override it, make sure to always return false if self::getFieldInfo() returns an empty array.

Stability: stable
to override
Parameters
array$dataSubmitted data as an associative array (keys will correspond to getFieldInfo())
Returns
bool Whether the request data was successfully loaded

Reimplemented in MediaWiki\Auth\CreateFromLoginAuthenticationRequest.

Definition at line 159 of file AuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\getFieldInfo().

◆ loadRequestsFromSubmission()

static MediaWiki\Auth\AuthenticationRequest::loadRequestsFromSubmission ( array  $reqs,
array  $data 
)
static

Update a set of requests with form submit data, discarding ones that fail.

Parameters
AuthenticationRequest[]$reqs
array$data
Returns
AuthenticationRequest[]

Definition at line 249 of file AuthenticationRequest.php.

◆ mergeFieldInfo()

static MediaWiki\Auth\AuthenticationRequest::mergeFieldInfo ( array  $reqs)
static

Merge the output of multiple AuthenticationRequest::getFieldInfo() calls.

Parameters
AuthenticationRequest[]$reqs
Returns
array
Exceptions

\UnexpectedValueException If fields cannot be merged

Definition at line 317 of file AuthenticationRequest.php.

References MediaWiki\Auth\AuthenticationRequest\$required, and $type.

Member Data Documentation

◆ $action

string null MediaWiki\Auth\AuthenticationRequest::$action = null

The AuthManager::ACTION_* constant this request was created to be used for.

The *_CONTINUE constants are not used here, the corresponding "begin" constant is used instead.

Definition at line 59 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasPrimaryStateForAction(), and MediaWiki\Auth\CreateFromLoginAuthenticationRequest\hasStateForAction().

◆ $required

int MediaWiki\Auth\AuthenticationRequest::$required = self::REQUIRED

For login, continue, and link actions, one of self::OPTIONAL, self::REQUIRED, or self::PRIMARY_REQUIRED.

Definition at line 64 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), and MediaWiki\Auth\AuthenticationRequest\mergeFieldInfo().

◆ $returnToUrl

string null MediaWiki\Auth\AuthenticationRequest::$returnToUrl = null

Return-to URL, in case of redirect.

Definition at line 67 of file AuthenticationRequest.php.

◆ $username

string null MediaWiki\Auth\AuthenticationRequest::$username = null

Username.

See AuthenticationProvider::getAuthenticationRequests() for details of what this means and how it behaves.

Definition at line 72 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\AuthenticationRequest\getUsernameFromRequests().

◆ OPTIONAL

const MediaWiki\Auth\AuthenticationRequest::OPTIONAL = 0

Indicates that the request is not required for authentication to proceed.

Definition at line 41 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().

◆ PRIMARY_REQUIRED

const MediaWiki\Auth\AuthenticationRequest::PRIMARY_REQUIRED = 2

Indicates that the request is required by a primary authentication provider.

Since the user can choose which primary to authenticate with, the request might or might not end up being actually required.

Definition at line 53 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal().

◆ REQUIRED

const MediaWiki\Auth\AuthenticationRequest::REQUIRED = 1

Indicates that the request is required for authentication to proceed.

This will only be used for UI purposes; it is the authentication providers' responsibility to verify that all required requests are present.

Definition at line 47 of file AuthenticationRequest.php.

Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__construct(), MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().

The documentation for this class was generated from the following file: