Session provider for bot passwords. More...

Inheritance diagram for MediaWiki\Session\BotPasswordSessionProvider:

[legend]

Collaboration diagram for MediaWiki\Session\BotPasswordSessionProvider:

[legend]

Public Member Functions

__construct (array $params=[])

getAllowedUserRights (SessionBackend $backend)

Fetch the rights allowed the user when the specified session is active.

newSessionForRequest (User $user, BotPassword $bp, WebRequest $request)

Create a new session for a request.

newSessionInfo ( $id=null)

Provide session info for a new, empty session.

preventSessionsForUser ( $username)

Prevent future sessions for the user.If the provider is capable of returning a SessionInfo with a verified UserInfo for the named user in some manner other than by validating against $user->getToken(), steps must be taken to prevent that from occurring in the future. This might add the username to a blacklist, or it might just delete whatever authentication credentials would allow such a session in the first place (e.g. remove all OAuth grants or delete record of the SSL client certificate).The intention is that the named account will never again be usable for normal login (i.e. there is no way to undo the prevention of access).Note that the passed user name might not exist locally (i.e. User::idFromName( $username ) === 0); the name should still be prevented, if applicable.

Access:\n protected For use by \MediaWiki\Session\SessionManager only

Parameters

string $username

provideSessionInfo (WebRequest $request)

Provide session info for a request.

refreshSessionInfo (SessionInfo $info, WebRequest $request, &$metadata)

Validate a loaded SessionInfo and refresh provider metadata.

Public Member Functions inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie

__construct ( $params=[])

canChangeUser ()

Indicate whether the user associated with the request can be changed.

getVaryCookies ()

Return the list of cookies that need varying on.

persistSession (SessionBackend $session, WebRequest $request)

Persist a session into a request/response.

persistsSessionId ()

Indicate whether self::persistSession() can save arbitrary session IDs.

unpersistSession (WebRequest $request)

Remove any persisted session from a request/response.

whyNoSession ()

Return a Message for why sessions might not be being persisted.

Public Member Functions inherited from MediaWiki\Session\SessionProvider

__construct ()

__toString ()

describe (Language $lang)

Return an identifier for this session type.

getManager ()

Get the session manager.

getRememberUserDuration ()

Returns the duration (in seconds) for which users will be remembered when Session::setRememberUser() is set.

getVaryHeaders ()

Return the HTTP headers that need varying on.

invalidateSessionsForUser (User $user)

Invalidate existing sessions for a user.

mergeMetadata (array $savedMetadata, array $providedMetadata)

Merge saved session provider metadata.

sessionIdWasReset (SessionBackend $session, $oldId)

Notification that the session ID was reset.

setConfig (Config $config)

Set configuration.

setLogger (LoggerInterface $logger)

setManager (SessionManager $manager)

Set the session manager.

suggestLoginUsername (WebRequest $request)

Get a suggested username for the login form.

Additional Inherited Members
Protected Member Functions inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie
	getSessionIdFromCookie (WebRequest $request)
	Get the session ID from the cookie, if any.

Protected Member Functions inherited from MediaWiki\Session\SessionProvider
	describeMessage ()
	Return a Message identifying this session type.

	hashToSessionId ( $data, $key=null)
	Hash data as a session ID.

Protected Attributes inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie
string null	$sessionCookieName = null

mixed[]	$sessionCookieOptions = []

Protected Attributes inherited from MediaWiki\Session\SessionProvider
Config	$config

LoggerInterface	$logger

SessionManager	$manager

int	$priority
	Session priority.

Detailed Description

Session provider for bot passwords.

Since: 1.27

Definition at line 34 of file BotPasswordSessionProvider.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\BotPasswordSessionProvider::__construct ( array $params = [] )

Parameters

array

$params

Keys include:

priority: (required) Set the priority
sessionCookieName: Session cookie name. Default is '_BPsession'.
sessionCookieOptions: Options to pass to WebResponse::setCookie().

Definition at line 42 of file BotPasswordSessionProvider.php.

References MediaWiki\Session\SessionInfo\MAX_PRIORITY, and MediaWiki\Session\SessionInfo\MIN_PRIORITY.

Member Function Documentation

◆ getAllowedUserRights()

MediaWiki\Session\BotPasswordSessionProvider::getAllowedUserRights ( SessionBackend $backend )

Fetch the rights allowed the user when the specified session is active.

This is mainly meant for allowing the user to restrict access to the account by certain methods; you probably want to use this with MWGrants. The returned rights will be intersected with the user's actual rights.

Parameters

SessionBackend $backend

Returns: null|string[] Allowed user rights, or null to allow all.

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 176 of file BotPasswordSessionProvider.php.

References MediaWiki\Session\SessionBackend\getProvider(), and MediaWiki\Session\SessionBackend\getProviderMetadata().

◆ newSessionForRequest()

MediaWiki\Session\BotPasswordSessionProvider::newSessionForRequest	(	User	$user,
		BotPassword	$bp,
		WebRequest	$request
	)

Create a new session for a request.

Parameters

User	$user
BotPassword	$bp
WebRequest	$request

Returns: Session

Definition at line 96 of file BotPasswordSessionProvider.php.

References BotPassword\getAppId(), MWGrants\getGrantRights(), BotPassword\getGrants(), MediaWiki\Session\SessionProvider\getManager(), MediaWiki\Session\ImmutableSessionProviderWithCookie\getSessionIdFromCookie(), BotPassword\getToken(), BotPassword\getUserCentralId(), MediaWiki\Session\SessionInfo\MAX_PRIORITY, and MediaWiki\Session\UserInfo\newFromUser().

◆ newSessionInfo()

MediaWiki\Session\BotPasswordSessionProvider::newSessionInfo ( $id = null )

Provide session info for a new, empty session.

Return null if such a session cannot be created. This base implementation assumes that it only makes sense if a session ID can be persisted and changing users is allowed.

Access:\n protected For use by \MediaWiki\Session\SessionManager only

Parameters

string | null $id ID to force for the new session

Returns: SessionInfo|null If non-null, must return true for $info->isIdSafe(); pass true for $data['idIsSafe'] to ensure this.

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 84 of file BotPasswordSessionProvider.php.

◆ preventSessionsForUser()

MediaWiki\Session\BotPasswordSessionProvider::preventSessionsForUser ( $username )

Prevent future sessions for the user.If the provider is capable of returning a SessionInfo with a verified UserInfo for the named user in some manner other than by validating against $user->getToken(), steps must be taken to prevent that from occurring in the future. This might add the username to a blacklist, or it might just delete whatever authentication credentials would allow such a session in the first place (e.g. remove all OAuth grants or delete record of the SSL client certificate).The intention is that the named account will never again be usable for normal login (i.e. there is no way to undo the prevention of access).Note that the passed user name might not exist locally (i.e. User::idFromName( $username ) === 0); the name should still be prevented, if applicable.

Access:\n protected For use by \MediaWiki\Session\SessionManager only

Parameters

string $username

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 172 of file BotPasswordSessionProvider.php.

References BotPassword\removeAllPasswordsForUser().

◆ provideSessionInfo()

MediaWiki\Session\BotPasswordSessionProvider::provideSessionInfo ( WebRequest $request )

Provide session info for a request.

If no session exists for the request, return null. Otherwise return an SessionInfo object identifying the session.

If multiple SessionProviders provide sessions, the one with highest priority wins. In case of a tie, an exception is thrown. SessionProviders are encouraged to make priorities user-configurable unless only max-priority makes sense.

Warning: This will be called early in the MediaWiki setup process, before $wgUser, $wgLang, $wgOut, $wgTitle, the global parser, and corresponding pieces of the main RequestContext are set up! If you try to use these, things will break.

Note: The SessionProvider must not attempt to auto-create users. MediaWiki will do this later (when it's safe) if the chosen session has a user with a valid name but no ID.

Access:\n protected For use by \MediaWiki\Session\SessionManager only

Parameters

WebRequest $request

Returns: SessionInfo|null

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 60 of file BotPasswordSessionProvider.php.

References MediaWiki\Session\ImmutableSessionProviderWithCookie\getSessionIdFromCookie().

◆ refreshSessionInfo()

MediaWiki\Session\BotPasswordSessionProvider::refreshSessionInfo	(	SessionInfo	$info,
		WebRequest	$request,
		&	$metadata
	)

Validate a loaded SessionInfo and refresh provider metadata.

This is similar in purpose to the 'SessionCheckInfo' hook, and also allows for updating the provider metadata. On failure, the provider is expected to write an appropriate message to its logger.

Access:\n protected For use by \MediaWiki\Session\SessionManager only

Parameters

SessionInfo	$info	Any changes by mergeMetadata() will already be reflected here.
WebRequest	$request
array \| null	&$metadata	Provider metadata, may be altered.

Returns: bool Return false to reject the SessionInfo after all.

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 115 of file BotPasswordSessionProvider.php.

References BotPassword\newFromCentralId().

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

includes/session/BotPasswordSessionProvider.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAllowedUserRights()

◆ newSessionForRequest()

◆ newSessionInfo()

◆ preventSessionsForUser()

◆ provideSessionInfo()

◆ refreshSessionInfo()