TYPO3 12.4 API: AbstractUserAuthentication

AbstractUserAuthentication implements LoggerAwareInterface uses LoggerAwareTrait, CookieHeaderTrait, PublicPropertyDeprecationTrait, PublicMethodDeprecationTrait

AbstractYes

Authentication of users in TYPO3

This class is used to authenticate a login user. The class is used by both the frontend and backend. In both cases this class is a parent class to BackendUserAuthentication and FrontendUserAuthentication

Interfaces

LoggerAwareInterface

Properties

$checkPid : bool: If set, the user-record must be stored at the page defined by $checkPid_value
$checkPid_value : int|string|null: The page id the user record must be stored at, can also hold a comma separated list of pids
$enablecolumns : array<string|int, mixed>: Enable field columns of user table
$loginType : string: Login type, used for services.
$name : string: Session/Cookie name
$uc : array<string|int, mixed>: User Settings (= preferences)
$user : array<string|int, mixed>|null
$user_table : string: Table in database with user data
$usergroup_column : string: Column for user group information
$usergroup_table : string: Table in database with user groups
$userGroups : array<string|int, mixed>: This array will hold the groups that the user is a member of
$userid_column : string: Column for user-id
$userident_column : string: Column for password
$username_column : string: Column for login-name
$writeAttemptLog : bool: Log failed login attempts
$writeStdLog : bool: Decides if the writelog() function is called at login and logout
$dontSetCookie : bool: Will prevent the setting of the session cookie
$formfield_status : string: Form field with status: *'login', 'logout'. If empty login is not verified.
$formfield_uident : string: Form field with password
$formfield_uname : string: Form field with login-name
$lastLogin_column : string: Column name for last login timestamp
$loginSessionStarted : bool: Will be set to TRUE if the login session is actually written during auth-check.
$setCookie : SetCookieBehavior: If set, this cookie will be set to the response.
$userSession : UserSession|null
$userSessionManager : UserSessionManager

Methods

__call() : mixed: Checks if the method of the given name is available, calls it but throws a deprecation.
__construct() : mixed: Initialize some important variables
__get() : mixed: Gets the value of the property of the given name if tagged.
__isset() : bool: Checks if the property of the given name is set.
__set() : mixed: Sets the property of the given name if tagged.
__unset() : mixed: Unsets the property of the given name if tagged.
appendCookieToResponse() : ResponseInterface: Used to apply a cookie to a PSR-7 Response.
checkAuthentication() : mixed: Checks if a submission of username and password is present or use other authentication by auth services
createUserSession() : UserSession: Creates a user session record and returns its values.
enforceNewSessionId() : mixed: Regenerates the session ID and sets the cookie again.
getAuthInfoArray() : array<string|int, mixed>: Returns an info array which provides additional information for auth services
getLoginFormData() : array<string|int, mixed>: Returns an info array with Login/Logout data submitted by a form or params
getModuleData() : mixed: Gets module data for a module (from a loaded ->uc array)
getRawUserByName() : array<string|int, mixed>: Fetching raw user record with username=$name
getRawUserByUid() : array<string|int, mixed>: Fetching raw user record with uid=$uid
getSession() : UserSession
getSessionData() : mixed: Returns the session data stored for $key.
getUserId() : int|null
getUserName() : string|null
initializeUserSessionManager() : void: Currently needed for various unit tests, until start() and checkAuthentication() methods are smaller and extracted from this class.
isActiveLogin() : bool
isMfaSetupRequired() : bool: Whether the user is required to set up MFA
logoff() : mixed: Log out current user! Removes the current session record, sets the internal ->user array to a blank string; Thereby the current user (if any) is effectively logged out!
processLoginData() : array<string|int, mixed>: Processes Login data submitted by a form or params
pushModuleData() : void: Stores data for a module.
removeCookie() : mixed: Empty / unset the cookie
setAndSaveSessionData() : mixed: Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
setBeUserByName() : mixed: Raw initialization of the be_user with username=$name
setBeUserByUid() : mixed: Raw initialization of the be_user with uid=$uid This will circumvent all login procedures and select a be_users record from the database and set the content of ->user to the record selected.
setSessionData() : mixed: Set session data by key.
start() : mixed: 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.
writelog() : mixed: DUMMY: Writes to log database table (in some extension classes)
writeUC() : mixed: This writes $this->>uc to the user-record. This is a way of providing session-data.
evaluateMfaRequirements() : void: This method checks if the user is authenticated but has not succeeded in passing his MFA challenge. This method can therefore only be used if a user has been authenticated against his first authentication method (username+password or any other authentication token).
fetchPossibleUsers() : array<string|int, mixed>: Loads users from various sources (= authentication services) as an array of arrays.
fetchValidUserFromSessionOrDestroySession() : array<string|int, mixed>|null: If the session is bound to a user, this method fetches the user record, and returns it.
getAuthServiceConfiguration() : array<string|int, mixed>: "auth" services configuration array from $GLOBALS['TYPO3_CONF_VARS']['SVCONF']['auth']
getAuthServices() : Traversable: Initializes authentication services to be used in a foreach loop
handleLoginFailure() : void: Implement functionality when there was a failed login
isCookieSet() : bool: Returns whether this request is going to set a cookie or a cookie was already found in the system
isRefreshTimeBasedCookie() : bool: Determine whether a non-session cookie needs to be set (lifetime>0)
isSetSessionCookie() : bool: Determine whether a session cookie needs to be set (lifetime=0)
performLogoff() : mixed: Perform the logoff action. Called from logoff() as a way to allow subclasses to override what happens when a user logs off, without needing to reproduce the hook calls and logging that happens in the public logoff() API method.
regenerateSessionId() : mixed: Regenerate the session ID and transfer the session to new ID Call this method whenever a user proceeds to a higher authorization level e.g. when an anonymous session is now authenticated.
removeSensitiveLoginDataForLoggingInfo() : mixed: Removes any sensitive data from the incoming data (either from loginData, processedLogin data or the user record from the DB).
setSessionCookie() : mixed: Sets the setCookie directive to "Send", which will then result in appending a new cookie to the PSR-7 response, see appendCookieToResponse().
shallSetSessionCookie() : bool: Determines whether setting the session cookie is generally enabled, or the current session is a non-session cookie (FE permalogin).
unpack_uc() : mixed: Unserializes the user configuration from the user record into $this->>uc
updateLoginTimestamp() : mixed: Updates the last login column in the user with the given id
userConstraints() : QueryRestrictionContainerInterface: This returns the restrictions needed to select the user respecting enable columns and flags like deleted, hidden, starttime, endtime and rootLevel

$checkPid

If set, the user-record must be stored at the page defined by $checkPid_value


        public
            bool
    $checkPid
     = true

$checkPid_value

The page id the user record must be stored at, can also hold a comma separated list of pids


        public
            int|string|null
    $checkPid_value
     = 0

$enablecolumns

Enable field columns of user table


        public
            array<string|int, mixed>
    $enablecolumns
     = [
    'rootLevel' => '',
    // Boolean: If TRUE, 'AND pid=0' will be a part of the query...
    'disabled' => '',
    'starttime' => '',
    'endtime' => '',
    'deleted' => '',
]

$loginType


        public
            string
    $loginType
     = ''

$name

Session/Cookie name


        public
            string
    $name
     = ''

$uc

User Settings (= preferences)


        public
            array<string|int, mixed>
    $uc
     = []

$user


        public
            array<string|int, mixed>|null
    $user

contains user- AND session-data from database (joined tables)

Internal

$user_table

Table in database with user data


        public
            string
    $user_table
     = ''

$usergroup_column

Column for user group information


        public
            string
    $usergroup_column
     = ''

$usergroup_table

Table in database with user groups


        public
            string
    $usergroup_table
     = ''

$userGroups

This array will hold the groups that the user is a member of


        public
            array<string|int, mixed>
    $userGroups
     = []

$userid_column

Column for user-id


        public
            string
    $userid_column
     = ''

$userident_column

Column for password


        public
            string
    $userident_column
     = ''

$username_column

Column for login-name


        public
            string
    $username_column
     = ''

$writeAttemptLog

Log failed login attempts


        public
            bool
    $writeAttemptLog
     = false

$writeStdLog

Decides if the writelog() function is called at login and logout


        public
            bool
    $writeStdLog
     = false