TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator:

Public Member Functions
	__construct (Context $context, LanguageServiceFactory $languageServiceFactory, RateLimiterFactory $rateLimiterFactory)
	process (ServerRequestInterface $request, RequestHandlerInterface $handler)
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Middleware\BackendUserAuthenticator
	__construct (protected Context $context)

Protected Member Functions
	enrichResponseWithHeadersAndCookieInformation (ServerRequestInterface $request, ResponseInterface $response, ?BackendUserAuthentication $userAuthentication)
	sessionGarbageCollection ()
	redirectToMfaEndpoint (string $endpoint, BackendUserAuthentication $user, ServerRequestInterface $request, array $parameters=[])
bool	isLoggedInBackendUserRequired (Route $route)
	ensureLoginRateLimit (BackendUserAuthentication $user, ServerRequestInterface $request)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Middleware\BackendUserAuthenticator
ResponseInterface	applyHeadersToResponse (ResponseInterface $response)
	setBackendUserAspect (?BackendUserAuthentication $user, int $alternativeWorkspaceId=null)

Protected Attributes
array	$publicRoutes

Private Attributes
LanguageServiceFactory	$languageServiceFactory
RateLimiterFactory	$rateLimiterFactory

Detailed Description

Initializes the backend user authentication object (BE_USER) and the global LANG object.

Definition at line 47 of file BackendUserAuthenticator.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::__construct	(	Context	$context,
		LanguageServiceFactory	$languageServiceFactory,
		RateLimiterFactory	$rateLimiterFactory
	)

Definition at line 73 of file BackendUserAuthenticator.php.

References TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\$languageServiceFactory, and TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\$rateLimiterFactory.

Member Function Documentation

enrichResponseWithHeadersAndCookieInformation()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::enrichResponseWithHeadersAndCookieInformation ( ServerRequestInterface  $request, ResponseInterface  $response, ?BackendUserAuthentication  $userAuthentication  )

protected

Backend requests should always apply Set-Cookie information and never be cacheable. This is also needed if there is a redirect from somewhere in the code.

Exceptions

Definition at line 169 of file BackendUserAuthenticator.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\appendCookieToResponse(), TYPO3\CMS\Core\Middleware\BackendUserAuthenticator\applyHeadersToResponse(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\removeCookie().

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

ensureLoginRateLimit()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::ensureLoginRateLimit ( BackendUserAuthentication  $user, ServerRequestInterface  $request  )

protected

Definition at line 227 of file BackendUserAuthenticator.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\HttpUtility\HTTP_STATUS_403, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isActiveLogin().

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

isLoggedInBackendUserRequired()

bool TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::isLoggedInBackendUserRequired ( Route  $route )

protected

Check if the user is required for the request. If we're trying to do a login or an ajax login, don't require a user.

Parameters

Route

$route

‪the Route path to check against, something like '

Returns

‪bool true when the Route requires an authenticated backend user

Definition at line 222 of file BackendUserAuthenticator.php.

References TYPO3\CMS\Backend\Routing\Route\getPath().

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

process()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::process	(	ServerRequestInterface	$request,
		RequestHandlerInterface	$handler
	)

Calls the bootstrap process to set up $GLOBALS['BE_USER'] AND $GLOBALS['LANG']

Reimplemented from TYPO3\CMS\Core\Middleware\BackendUserAuthenticator.

Definition at line 86 of file BackendUserAuthenticator.php.

References $GLOBALS, TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRoute(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\enrichResponseWithHeadersAndCookieInformation(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\ensureLoginRateLimit(), TYPO3\CMS\Core\Authentication\Mfa\MfaRequiredException\getProvider(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\isLoggedInBackendUserRequired(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\redirectToMfaEndpoint(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\sessionGarbageCollection(), and TYPO3\CMS\Core\Middleware\BackendUserAuthenticator\setBackendUserAspect().

redirectToMfaEndpoint()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::redirectToMfaEndpoint ( string  $endpoint, BackendUserAuthentication  $user, ServerRequestInterface  $request, array  $parameters = []  )

protected

Initiate a redirect to the given MFA endpoint with necessary cookies and headers appended

Definition at line 199 of file BackendUserAuthenticator.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\appendCookieToResponse(), TYPO3\CMS\Core\Middleware\BackendUserAuthenticator\applyHeadersToResponse(), and TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest().

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

sessionGarbageCollection()

TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::sessionGarbageCollection ( )

protected

Garbage collection for be_sessions (with a probability)

Definition at line 191 of file BackendUserAuthenticator.php.

References TYPO3\CMS\Core\Session\UserSessionManager\create().

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

Member Data Documentation

$languageServiceFactory

LanguageServiceFactory TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::$languageServiceFactory

private

Definition at line 70 of file BackendUserAuthenticator.php.

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\__construct().

$publicRoutes

array TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::$publicRoutes

protected

Initial value:

= [
        '/login',
        '/login/frame',
        '/login/password-reset/forget',
        '/login/password-reset/initiate-reset',
        '/login/password-reset/validate',
        '/login/password-reset/finish',
        '/login/request-token',
        '/install/server-response-check/host',
        '/ajax/login',
        '/ajax/logout',
        '/ajax/login/preflight',
        '/ajax/login/refresh',
        '/ajax/login/timedout',
    ]

List of requests that don't need a valid BE user

Definition at line 54 of file BackendUserAuthenticator.php.

$rateLimiterFactory

RateLimiterFactory TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator::$rateLimiterFactory

private

Definition at line 71 of file BackendUserAuthenticator.php.

Referenced by TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\__construct().