Dummy session provider. More...

Inheritance diagram for DummySessionProvider:

[legend]

Collaboration diagram for DummySessionProvider:

[legend]

Public Member Functions
	canChangeUser ()
	Indicate whether the user associated with the request can be changed.

	immutableSessionCouldExistForUser ( $user)

	newSessionInfo ( $id=null)
	Provide session info for a new, empty session.

	persistSession (SessionBackend $session, WebRequest $request)
	Persist a session into a request/response.

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

	preventImmutableSessionsForUser ( $user)

	provideSessionInfo (WebRequest $request)
	Provide session info for a request.

	suggestLoginUsername (WebRequest $request)
	Get a suggested username for the login form.

	unpersistSession (WebRequest $request)
	Remove any persisted session from a request/response.

Public Member Functions inherited from MediaWiki\Session\SessionProvider
	__construct ()

	__toString ()

	describe (Language $lang)
	Return an identifier for this session type.

	getAllowedUserRights (SessionBackend $backend)
	Fetch the rights allowed the user when the specified session is active.

	getManager ()
	Get the session manager.

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

	getVaryCookies ()
	Return the list of cookies that need varying on.

	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.

	preventSessionsForUser ( $username)
	Prevent future sessions for the user.

	refreshSessionInfo (SessionInfo $info, WebRequest $request, &$metadata)
	Validate a loaded SessionInfo and refresh 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.

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

Public Attributes
const	ID = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'

Additional Inherited Members
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\SessionProvider
Config	$config

LoggerInterface	$logger

SessionManager	$manager

int	$priority
	Session priority.

Detailed Description

Dummy session provider.

An implementation of a session provider that doesn't actually do anything.

Definition at line 12 of file DummySessionProvider.php.

Member Function Documentation

◆ canChangeUser()

DummySessionProvider::canChangeUser ( )

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

If false, any session passed to self::persistSession() will have a user that was originally provided by self::provideSessionInfo(). Further, self::provideSessionInfo() may only provide sessions that have a user already set.

If true, the provider may be passed sessions with arbitrary users, and will be expected to manipulate the request in such a way that future requests will cause self::provideSessionInfo() to provide a SessionInfo with that ID. This can be as simple as not passing any 'userInfo' into SessionInfo's constructor, in which case SessionInfo will load the user from the saved session's metadata.

For example, a session provider for OAuth or SSL client certificates would function by matching the OAuth headers or certificate to a particular user, and thus would return false here since it can't arbitrarily assign those OAuth credentials or that certificate to a different user. A session provider that shoves information into cookies, on the other hand, could easily do so.

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

Returns: bool

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 39 of file DummySessionProvider.php.

References persistsSessionId().

◆ immutableSessionCouldExistForUser()

DummySessionProvider::immutableSessionCouldExistForUser ( $user )

Definition at line 49 of file DummySessionProvider.php.

◆ newSessionInfo()

DummySessionProvider::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 25 of file DummySessionProvider.php.

◆ persistSession()

DummySessionProvider::persistSession	(	SessionBackend	$session,
		WebRequest	$request
	)

Persist a session into a request/response.

For example, you might set cookies for the session's ID, user ID, user name, and user token on the passed request.

To correctly persist a user independently of the session ID, the provider should persist both the user ID (or name, but preferably the ID) and the user token. When reading the data from the request, it should construct a User object from the ID/name and then verify that the User object's token matches the token included in the request. Should the tokens not match, an anonymous user must be passed to SessionInfo::__construct().

When persisting a user independently of the session ID, $session->shouldRememberUser() should be checked first. If this returns false, the user token must not be saved to cookies. The user name and/or ID may be persisted, and should be used to construct an unverified UserInfo to pass to SessionInfo::__construct().

A backend that cannot persist sesison ID or user info should implement this as a no-op.

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

Parameters

SessionBackend	$session	Session to persist
WebRequest	$request	Request into which to persist the session

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 43 of file DummySessionProvider.php.

◆ persistsSessionId()

DummySessionProvider::persistsSessionId ( )

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

If false, any session passed to self::persistSession() will have an ID that was originally provided by self::provideSessionInfo().

If true, the provider may be passed sessions with arbitrary session IDs, and will be expected to manipulate the request in such a way that future requests will cause self::provideSessionInfo() to provide a SessionInfo with that ID.

For example, a session provider for OAuth would function by matching the OAuth headers to a particular user, and then would use self::hashToSessionId() to turn the user and OAuth client ID (and maybe also the user token and client secret) into a session ID, and therefore can't easily assign that user+client a different ID. Similarly, a session provider for SSL client certificates would function by matching the certificate to a particular user, and then would use self::hashToSessionId() to turn the user and certificate fingerprint into a session ID, and therefore can't easily assign a different ID either. On the other hand, a provider that saves the session ID into a cookie can easily just set the cookie to a different value.

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

Returns: bool

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 35 of file DummySessionProvider.php.

Referenced by canChangeUser().

◆ preventImmutableSessionsForUser()

DummySessionProvider::preventImmutableSessionsForUser ( $user )

Definition at line 53 of file DummySessionProvider.php.

◆ provideSessionInfo()

DummySessionProvider::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, $wgParser, $wgTitle, 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 16 of file DummySessionProvider.php.

◆ suggestLoginUsername()

DummySessionProvider::suggestLoginUsername ( WebRequest $request )

Get a suggested username for the login form.

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

Parameters

WebRequest $request

Returns: string|null

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 56 of file DummySessionProvider.php.

References $request.

◆ unpersistSession()

DummySessionProvider::unpersistSession ( WebRequest $request )

Remove any persisted session from a request/response.

For example, blank and expire any cookies set by self::persistSession().

A backend that cannot persist sesison ID or user info should implement this as a no-op.

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

Parameters

WebRequest $request Request from which to remove any session data

Reimplemented from MediaWiki\Session\SessionProvider.

Definition at line 46 of file DummySessionProvider.php.

Member Data Documentation

◆ ID

const DummySessionProvider::ID = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'

Definition at line 14 of file DummySessionProvider.php.

Referenced by MediaWiki\Auth\AuthManagerTest\testSecuritySensitiveOperationStatus().

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

tests/phpunit/mocks/session/DummySessionProvider.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canChangeUser()

◆ immutableSessionCouldExistForUser()

◆ newSessionInfo()

◆ persistSession()

◆ persistsSessionId()

◆ preventImmutableSessionsForUser()

◆ provideSessionInfo()

◆ suggestLoginUsername()

◆ unpersistSession()

Member Data Documentation

◆ ID