‪TYPO3CMS  ‪main
TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication Class Reference
Inheritance diagram for TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication:
TYPO3\CMS\Core\Authentication\BackendUserAuthentication TYPO3\CMS\Core\Authentication\AbstractUserAuthentication

Public Member Functions

 setReactionInstruction (ReactionInstruction $reactionInstruction)
 
 start (ServerRequestInterface $request)
 
 checkAuthentication (ServerRequestInterface $request)
 
 getOriginalUserIdWhenInSwitchUserMode ()
 
 backendCheckLogin (ServerRequestInterface $request=null)
 
 isUserAllowedToLogin ()
 
 initializeBackendLogin (ServerRequestInterface $request=null)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 __construct ()
 
bool isAdmin ()
 
bool doesUserHaveAccess ($row, $perms)
 
int null isInWebMount ($idOrRow, $readPerms='')
 
 isSystemMaintainer ()
 
string getPagePermsClause ($perms)
 
int calcPerms ($row)
 
bool check ($type, $value)
 
bool checkAuthMode ($table, $field, $value)
 
bool checkLanguageAccess ($langValue)
 
bool checkFullLanguagesAccess ($table, $record)
 
bool recordEditAccessInternals ($table, $idOrRow, $newRecord=false, $deletedRecord=false, $checkFullLanguageAccess=false)
 
bool mayMakeShortcut ()
 
 workspaceAllowsLiveEditingInTable (string $table)
 
 workspaceCanCreateNewRecord (string $table)
 
bool workspaceCheckStageForCurrent ($stage)
 
array getTSConfig ()
 
 getUserTsConfig ()
 
array returnWebmounts ()
 
 setWebmounts (array $mountPointUids, $append=false)
 
 initializeWebmountsForElementBrowser ()
 
bool jsConfirmation (int $bitmask)
 
 fetchGroupData ()
 
array getCategoryMountPoints ()
 
array getFileMountRecords ()
 
TYPO3 CMS Core Resource ResourceStorage[] getFileStorages ()
 
 evaluateUserSpecificFileFilterSettings ()
 
 getFilePermissions ()
 
array false checkWorkspace (int|array $wsRec)
 
 setWorkspace ($workspaceId)
 
bool setTemporaryWorkspace ($workspaceId)
 
int writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='', $event_pid=-1, $NEWid='', $userId=0)
 
 handleUserLoggedIn (ServerRequestInterface $request=null)
 
 backendSetUC ()
 
 overrideUC ()
 
 resetUC ()
 
 logoff ()
 
 isMfaSetupRequired ()
 
 isImportEnabled ()
 
 isExportEnabled ()
 
 shallDisplayDebugInformation ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 initializeUserSessionManager (?UserSessionManager $userSessionManager=null)
 
 appendCookieToResponse (ResponseInterface $response, ?NormalizedParams $normalizedParams=null)
 
UserSession createUserSession (array $userRecordCandidate)
 
 enforceNewSessionId ()
 
 removeCookie ($cookieName=null)
 
 writeUC ()
 
 pushModuleData (string $module, mixed $data, bool $dontPersistImmediately=false)
 
mixed getModuleData (string $module, string $type='')
 
mixed getSessionData ($key)
 
 setSessionData ($key, $data)
 
 setAndSaveSessionData ($key, $data)
 
array getLoginFormData (ServerRequestInterface $request)
 
 isActiveLogin (ServerRequestInterface $request)
 
array processLoginData (array $loginData, ServerRequestInterface $request)
 
array getAuthInfoArray (ServerRequestInterface $request)
 
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
 
 setBeUserByUid ($uid)
 
 setBeUserByName ($name)
 
array getRawUserByUid ($uid)
 
array getRawUserByName ($name)
 
 getSession ()
 

Public Attributes

 $dontSetCookie = true
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
const ROLE_SYSTEMMAINTAINER = 'systemMaintainer'
 
string $usergroup_column = 'usergroup'
 
string $usergroup_table = 'be_groups'
 
array $groupData
 
array $userGroupsUID = array( )
 
int $workspace = -99
 
array $workspaceRec = array( )
 
string $errorMsg = ''
 
string $user_table = 'be_users'
 
string $username_column = 'username'
 
string $userident_column = 'password'
 
string $userid_column = 'uid'
 
string $lastLogin_column = 'lastlogin'
 
array $enablecolumns
 
bool $writeStdLog = true
 
bool $writeAttemptLog = true
 
int $firstMainGroup = 0
 
array $uc_default
 
string $loginType = 'BE'
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
string $name = ''
 
string $user_table = ''
 
string $usergroup_table = ''
 
string $username_column = ''
 
string $userident_column = ''
 
string $userid_column = ''
 
string $usergroup_column = ''
 
array $enablecolumns
 
bool $writeStdLog = false
 
bool $writeAttemptLog = false
 
bool $checkPid = true
 
int string null $checkPid_value = 0
 
array null $user
 
array $userGroups = []
 
string $loginType = ''
 
array $uc = []
 

Protected Attributes

ReactionInstruction $reactionInstruction = null
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
UserTsConfig $userTsConfig = null
 
bool $userTSUpdated = false
 
array null $checkWorkspaceCurrent_cache
 
TYPO3 CMS Core Resource ResourceStorage[] $fileStorages
 
array null $filePermissions
 
string $formfield_uname = 'username'
 
string $formfield_uident = 'userident'
 
string $formfield_status = 'login_status'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
string $lastLogin_column = ''
 
string $formfield_uname = ''
 
string $formfield_uident = ''
 
string $formfield_status = ''
 
bool $loginSessionStarted = false
 
bool $dontSetCookie = false
 
UserSession $userSession = null
 
UserSessionManager $userSessionManager
 
SetCookieBehavior $setCookie = SetCookieBehavior::None
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
static getCookieName ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 isMemberOfGroup (int $groupId)
 
array filterValidWebMounts (string $listOfWebMounts)
 
 prepareUserTsConfig ()
 
 initializeFileStorages ()
 
 workspaceInit ()
 
 initializeDbMountpointsInWorkspace ()
 
 hasEditAccessToLiveWorkspace ()
 
 checkWorkspaceCurrent ()
 
 setDefaultWorkspace ()
 
int getDefaultWorkspace ()
 
 releaseLockedRecords (int $userId)
 
 evaluateMfaRequirements ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 setSessionCookie ()
 
 shallSetSessionCookie ()
 
bool isSetSessionCookie ()
 
bool isRefreshTimeBasedCookie ()
 
 getAuthServiceConfiguration ()
 
 fetchPossibleUsers (array $loginData, bool $activeLogin, bool $isExistingSession, ?array $authenticatedUserFromSession, ServerRequestInterface $request)
 
Traversable getAuthServices (string $subType, array $loginData, ?array $authenticatedUserFromSession, ServerRequestInterface $request)
 
 regenerateSessionId ()
 
 updateLoginTimestamp (int $userId)
 
 fetchValidUserFromSessionOrDestroySession (bool $skipSessionUpdate=false)
 
 performLogoff ()
 
bool isCookieSet ()
 
 userConstraints ()
 
 unpack_uc ()
 
mixed removeSensitiveLoginDataForLoggingInfo ($data, bool $isUserRecord=false)
 

Detailed Description

TYPO3 backend user authentication for webhooks Auto-logs in, only allowed in webhooks context

not part of TYPO3 Core API as this part is experimental

Definition at line 30 of file ReactionUserAuthentication.php.

Member Function Documentation

◆ backendCheckLogin()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::backendCheckLogin ( ServerRequestInterface  $request = null)

Check if user is logged in and if so, call ->fetchGroupData() to load group information and access lists of all kind, further check IP, set the ->uc array. If no user is logged in the default behaviour is to exit with an error message. This function is called right after ->start() in fx. the TYPO3 Bootstrap.

Exceptions

Reimplemented from TYPO3\CMS\Core\Authentication\BackendUserAuthentication.

Definition at line 69 of file ReactionUserAuthentication.php.

◆ checkAuthentication()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::checkAuthentication ( ServerRequestInterface  $request)

Replacement for AbstractUserAuthentication::checkAuthentication()

Not required in WebHook mode if no user is impersonated, therefore empty.

Reimplemented from TYPO3\CMS\Core\Authentication\AbstractUserAuthentication.

Definition at line 59 of file ReactionUserAuthentication.php.

◆ getOriginalUserIdWhenInSwitchUserMode()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::getOriginalUserIdWhenInSwitchUserMode ( )

Returns the uid of the backend user to return to. This is set when the current session is a "switch-user" session.

Returns
‪int|null The user id

should only be used from within TYPO3 Core

Reimplemented from TYPO3\CMS\Core\Authentication\BackendUserAuthentication.

Definition at line 64 of file ReactionUserAuthentication.php.

◆ initializeBackendLogin()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::initializeBackendLogin ( ServerRequestInterface  $request = null)

◆ isUserAllowedToLogin()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::isUserAllowedToLogin ( )

Determines whether a webhook backend user is allowed to access TYPO3. Only when adminOnly is off (=0)

Reimplemented from TYPO3\CMS\Core\Authentication\BackendUserAuthentication.

Definition at line 80 of file ReactionUserAuthentication.php.

References $GLOBALS.

◆ setReactionInstruction()

◆ start()

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::start ( ServerRequestInterface  $request)

Starts a user session Typical configurations will: a) check if session cookie was set and if not, set one, b) check if a password/username was sent and if so, try to authenticate the user c) Lookup a session attached to a user and check timeout etc. d) Garbage collection, setting of no-cache headers. If a user is authenticated the database record of the user (array) will be set in the ->user internal variable.

Reimplemented from TYPO3\CMS\Core\Authentication\AbstractUserAuthentication.

Definition at line 43 of file ReactionUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\BackendUserAuthentication\backendSetUC(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\fetchGroupData(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\unpack_uc().

Member Data Documentation

◆ $dontSetCookie

TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::$dontSetCookie = true

Definition at line 32 of file ReactionUserAuthentication.php.

◆ $reactionInstruction

ReactionInstruction TYPO3\CMS\Reactions\Authentication\ReactionUserAuthentication::$reactionInstruction = null
protected