Inheritance diagram for TYPO3\CMS\Core\Authentication\AbstractUserAuthentication:

Public Member Functions
	__construct ()

	start ()

	isSetSessionCookie ()

	isRefreshTimeBasedCookie ()

	createSessionId ()

	createUserSession ($tempuser)

	getNewSessionRecord ($tempuser)

	fetchUserSession ($skipSessionUpdate=false)

	enforceNewSessionId ()

	logoff ()

	removeCookie ($cookieName)

	isExistingSessionRecord ($id)

	isCookieSet ()

	veriCode ()

	writeUC ($variable='')

	unpack_uc ($theUC='')

	pushModuleData ($module, $data, $noSave=0)

	getModuleData ($module, $type='')

	getSessionData ($key)

	setSessionData ($key, $data)

	setAndSaveSessionData ($key, $data)

	getLoginFormData ()

	processLoginData ($loginData, $passwordTransmissionStrategy='')

	getAuthInfoArray ()

	compareUident ($user, $loginData, $passwordCompareStrategy='')

	gc ()

	writelog ($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)

	checkLogFailures ($email, $secondsBack, $maxFailures)

	setBeUserByUid ($uid)

	setBeUserByName ($name)

	getRawUserByUid ($uid)

	getRawUserByName ($name)

	fetchUserRecord ($dbUser, $username, $extraWhere='')

	getSessionId ()

	getLoginType ()

Public Attributes
	$name = ''

	$get_name = ''

	$user_table = ''

	$usergroup_table = ''

	$username_column = ''

	$userident_column = ''

	$userid_column = ''

	$usergroup_column = ''

	$lastLogin_column = ''

	$enablecolumns

	$showHiddenRecords = false

	$formfield_uname = ''

	$formfield_uident = ''

	$formfield_status = ''

	$sessionTimeout = 0

	$auth_timeout_field = ''

	$lifetime = 0

	$gc_time = 0

	$gc_probability = 1

	$writeStdLog = false

	$writeAttemptLog = false

	$sendNoCacheHeaders = true

	$getFallBack = false

	$hash_length = 32

	$getMethodEnabled = false

	$lockIP = 4

	$warningEmail = ''

	$warningPeriod = 3600

	$warningMax = 3

	$checkPid = true

	$checkPid_value = 0

	$id

	$loginFailure = false

	$loginSessionStarted = false

	$user = null

	$get_URL_ID = ''

	$newSessionID = false

	$forceSetCookie = false

	$dontSetCookie = false

	$loginType = ''

	$svConfig = []

	$writeDevLog = false

	$uc

Protected Member Functions
	setSessionCookie ()

	getCookieDomain ()

	getCookie ($cookieName)

	getAuthServices (string $subType, array $loginData, array $authInfo)

	regenerateSessionId (array $existingSessionRecord=[], bool $anonymous=false)

	updateLoginTimestamp (int $userId)

	performLogoff ()

	userConstraints ()

	user_where_clause ()

	ipLockClause_remoteIPNumber ($parts)

	getSessionBackend ()

Protected Attributes
	$cookieWasSetOnCurrentRequest = false

	$sessionBackend

	$sessionData = []

Detailed Description

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 FrontenUserAuthentication

See Inside TYPO3 for more information about the API of the class and internal variables.

Definition at line 45 of file AbstractUserAuthentication.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::__construct ( )

Initialize some important variables

Definition at line 354 of file AbstractUserAuthentication.php.

Member Function Documentation

◆ checkLogFailures()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::checkLogFailures	(	$email,
		$secondsBack,
		$maxFailures
	)

DUMMY: Check login failures (in some extension classes)

Parameters

string	$email	Email address
int	$secondsBack	Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance
int	$maxFailures	Max allowed failures before a warning mail is sent

Definition at line 1504 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\simplelog().

◆ compareUident()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::compareUident	(	$user,
		$loginData,
		$passwordCompareStrategy = `''`
	)

Check the login data with the user record data for builtin login methods

Parameters

array	$user	User data array
array	$loginData	Login data array
string	$passwordCompareStrategy	Alternative passwordCompareStrategy. Used when authentication services wants to override the default.

Returns: bool TRUE if login data matched

Definition at line 1464 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$user, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$userident_column.

◆ createSessionId()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::createSessionId ( )

Creates a new session ID.

Returns: string The new session ID

Definition at line 827 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\regenerateSessionId(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start().

◆ createUserSession()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::createUserSession ( $tempuser )

Creates a user session record and returns its values.

Parameters

array $tempuser User data array

Returns: array The session data for the newly created session.

Definition at line 891 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getNewSessionRecord(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\updateLoginTimestamp().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ enforceNewSessionId()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::enforceNewSessionId ( )

Regenerates the session ID and sets the cookie again.

Definition at line 1006 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\regenerateSessionId(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setSessionCookie().

◆ fetchUserRecord()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::fetchUserRecord	(	$dbUser,
		$username,
		$extraWhere = `''`
	)

Get a user from DB by username provided for usage from services

Parameters

array	$dbUser	User db table definition: $this->db_user
string	$username	user name
string	$extraWhere	Additional WHERE clause: " AND ...

Returns: mixed User array or FALSE

Definition at line 1583 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$user, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

◆ fetchUserSession()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::fetchUserSession ( $skipSessionUpdate = false )

Read the user session from db.

Parameters

bool $skipSessionUpdate

Returns: array|bool User session data, false if $this->id does not represent valid session

Definition at line 952 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$sessionTimeout, TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByUid(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\logoff().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ gc()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::gc ( )

Garbage collector, removing old expired sessions.

Definition at line 1474 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start().

◆ getAuthInfoArray()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getAuthInfoArray ( )

Returns an info array which provides additional information for auth services

Returns: array

Definition at line 1421 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData().

◆ getAuthServices()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getAuthServices	(	string	$subType,
		array	$loginData,
		array	$authInfo
	)

protected

Initializes authentication services to be used in a foreach loop

Parameters

string	$subType	e.g. getUserFE
array	$loginData
array	$authInfo

Returns: A generator of service objects

Definition at line 840 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstanceService().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ getCookie()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getCookie ( $cookieName )

protected

Get the value of a specified cookie.

Parameters

string $cookieName The cookie ID

Returns: string The value stored in the cookie

Definition at line 537 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isCookieSet(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start().

◆ getCookieDomain()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getCookieDomain ( )

protected

Gets the domain to be used on setting cookies. The information is taken from the value in $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'].

Returns: string The domain to be used on setting cookies

Definition at line 506 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$loginType, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\removeCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setSessionCookie().

◆ getLoginFormData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getLoginFormData ( )

Returns an info array with Login/Logout data submitted by a form or params

Returns: array

Definition at line 1352 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ getLoginType()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getLoginType ( )

Definition at line 1630 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$loginType.

◆ getModuleData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getModuleData	(	$module,
		$type = `''`
	)

Gets module data for a module (from a loaded ->uc array)

Parameters

string	$module	Is the name of the module ($MCONF['name'])
string	$type	If $type = 'ses' then module data is returned only if it was stored in the current session, otherwise data from a previous session will be returned (if available).

Returns: mixed The module data if available: $this->uc['moduleData'][$module];

Definition at line 1285 of file AbstractUserAuthentication.php.

◆ getNewSessionRecord()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getNewSessionRecord ( $tempuser )

Returns a new session record for the current user for insertion into the DB. This function is mainly there as a wrapper for inheriting classes to override it.

Parameters

array $tempuser

Returns: array User session record

Definition at line 930 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$userid_column, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\ipLockClause_remoteIPNumber().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createUserSession().

◆ getRawUserByName()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getRawUserByName ( $name )

Fetching raw user record with username=$name

Parameters

string $name The username to look up.

Returns: array user record or FALSE

See also: ::getUserByUid()

Definition at line 1563 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$name, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\userConstraints().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setBeUserByName().

◆ getRawUserByUid()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getRawUserByUid ( $uid )

Fetching raw user record with uid=$uid

Parameters

int $uid The UID of the backend user to set in ->user

Returns: array user record or FALSE

Definition at line 1544 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\userConstraints().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserSession(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setBeUserByUid().

◆ getSessionBackend()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getSessionBackend ( )

protected

Returns initialized session backend. Returns same session backend if called multiple times

Returns: SessionBackendInterface

Definition at line 1640 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$sessionBackend, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ getSessionData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getSessionData ( $key )

Returns the session data stored for $key. The data will last only for this login session since it is stored in the user session.

Parameters

string $key The key associated with the session data

Returns: mixed

Definition at line 1300 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\getKey().

◆ getSessionId()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getSessionId ( )

Definition at line 1621 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id.

◆ ipLockClause_remoteIPNumber()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::ipLockClause_remoteIPNumber ( $parts )

protected

Returns the IP address to lock to. The IP address may be partial based on $parts.

Parameters

int $parts 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.

Returns: string (Partial) IP address for REMOTE_ADDR

Definition at line 1183 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getNewSessionRecord(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isExistingSessionRecord().

◆ isCookieSet()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::isCookieSet ( )

Returns whether this request is going to set a cookie or a cookie was already found in the system

Returns: bool Returns TRUE if a cookie is set

Definition at line 1099 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookie().

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\performLogoff(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\record_registration(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

◆ isExistingSessionRecord()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::isExistingSessionRecord ( $id )

Determine whether there's an according session record to a given session_id. Don't care if session record is still valid or not.

Parameters

string $id Claimed Session ID

Returns: bool Returns TRUE if a corresponding session was found in the database

Definition at line 1075 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\ipLockClause_remoteIPNumber().

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\removeSessionData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

◆ isRefreshTimeBasedCookie()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::isRefreshTimeBasedCookie ( )

Determine whether a non-session cookie needs to be set (lifetime>0)

Returns: bool

Definition at line 559 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setSessionCookie().

◆ isSetSessionCookie()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::isSetSessionCookie ( )

Determine whether a session cookie needs to be set (lifetime=0)

Returns: bool

Definition at line 548 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setSessionCookie().

◆ logoff()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::logoff ( )

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!

Definition at line 1017 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\performLogoff().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserSession(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ performLogoff()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::performLogoff ( )

protected

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.

Definition at line 1046 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\logoff().

◆ processLoginData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::processLoginData	(	$loginData,
		$passwordTransmissionStrategy = `''`
	)

Processes Login data submitted by a form or params depending on the passwordTransmissionStrategy

Parameters

array	$loginData	Login data array
string	$passwordTransmissionStrategy	Alternative passwordTransmissionStrategy. Used when authentication services wants to override the default.

Returns: array

Definition at line 1380 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$loginType, TYPO3\CMS\Core\Utility\GeneralUtility\arrayToLogString(), TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstanceService().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getLoginFormData().

◆ pushModuleData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::pushModuleData	(	$module,
		$data,
		$noSave = `0`
	)

Stores data for a module. The data is stored with the session id so you can even check upon retrieval if the module data is from a previous session or from the current session.

Parameters

string	$module	Is the name of the module ($MCONF['name'])
mixed	$data	Is the data you want to store for that module (array, string, ...)
bool \| int	$noSave	If $noSave is set, then the ->uc array (which carries all kinds of user data) is NOT written immediately, but must be written by some subsequent call.

Definition at line 1269 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

◆ regenerateSessionId()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::regenerateSessionId	(	array	$existingSessionRecord = `[]`,
		bool	$anonymous = `false`
	)

protected

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.

Parameters

array	$existingSessionRecord	If given, this session record will be used instead of fetching again
bool	$anonymous	If true session will be regenerated as anonymous session

Definition at line 861 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createSessionId(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\enforceNewSessionId(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ removeCookie()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::removeCookie ( $cookieName )

Empty / unset the cookie

Parameters

string $cookieName usually, this is $this->name

Definition at line 1060 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookieDomain(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\performLogoff(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

◆ setAndSaveSessionData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setAndSaveSessionData	(	$key,
		$data
	)

Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database. The data will last only for this login session since it is stored in the session table.

Parameters

string	$key	Pointer to an associative key in the session data array which is stored serialized in the field "ses_data" of the session table.
mixed	$data	The data to store in index $key

Definition at line 1327 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend().

◆ setBeUserByName()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setBeUserByName ( $name )

Raw initialization of the be_user with username=$name

Parameters

string $name The username to look up.

See also: ::setBeUserByUid()

Definition at line 1532 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$name, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByName().

Referenced by TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication\authenticate().

◆ setBeUserByUid()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setBeUserByUid ( $uid )

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. Thus the BE_USER object will appear like if a user was authenticated - however without a session id and the fields from the session table of course. Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())

Parameters

int $uid The UID of the backend user to set in ->user

Definition at line 1520 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByUid().

◆ setSessionCookie()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setSessionCookie ( )

protected

Sets the session cookie for the current disposal.

Exceptions

Exception

Definition at line 472 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookieDomain(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isSetSessionCookie().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\enforceNewSessionId(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

◆ setSessionData()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setSessionData	(	$key,
		$data
	)

Set session data by key. The data will last only for this login session since it is stored in the user session.

Parameters

string	$key	A non empty string to store the data under
mixed	$data	Data store store in session

Definition at line 1312 of file AbstractUserAuthentication.php.

◆ start()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::start ( )

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.

Exceptions

Exception

Definition at line 371 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$sessionTimeout, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\clientInfo(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createSessionId(), TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\gc(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookie(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isExistingSessionRecord(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setSessionCookie().

◆ unpack_uc()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::unpack_uc ( $theUC = '' )

Sets $theUC as the internal variable ->uc IF $theUC is an array. If $theUC is FALSE, the 'uc' content from the ->user array will be unserialized and restored in ->uc

Parameters

mixed $theUC If an array, then set as ->uc, otherwise load from user record

Definition at line 1250 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\BackendUserAuthentication\backendSetUC().

◆ updateLoginTimestamp()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::updateLoginTimestamp ( int $userId )

protected

Updates the last login column in the user with the given id

Parameters

int $userId

Definition at line 911 of file AbstractUserAuthentication.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createUserSession().

◆ user_where_clause()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::user_where_clause ( )

protected

This returns the where-clause needed to select the user with respect flags like deleted, hidden, starttime, endtime

Returns: string private

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1152 of file AbstractUserAuthentication.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ userConstraints()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::userConstraints ( )

protected

This returns the restrictions needed to select the user respecting enable columns and flags like deleted, hidden, starttime, endtime and rootLevel

Returns: QueryRestrictionContainerInterface

Definition at line 1117 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByName(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByUid().

◆ veriCode()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::veriCode ( )

VeriCode returns 10 first chars of a md5 hash of the session cookie AND the encryptionKey from TYPO3_CONF_VARS. This code is used as an alternative verification when the JavaScript interface executes cmd's to tce_db.php from eg. MSIE 5.0 because the proper referer is not passed with this browser...

Returns: string

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1205 of file AbstractUserAuthentication.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ writelog()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::writelog	(	$type,
		$action,
		$error,
		$details_nr,
		$details,
		$data,
		$tablename,
		$recuid,
		$recpid
	)

DUMMY: Writes to log database table (in some extension classes)

Parameters

int	$type	denotes which module that has submitted the entry. This is the current list: 1=tce_db; 2=tce_file; 3=system (eg. sys_history save); 4=modules; 254=Personal settings changed; 255=login / out action: 1=login, 2=logout, 3=failed login (+ errorcode 3), 4=failure_warning_email sent
int	$action	denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each $type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!)
int	$error	flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
int	$details_nr	The message number. Specific for each $type and $action. in the future this will make it possible to translate errormessages to other languages
string	$details	Default text that follows the message
array	$data	Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed the details-text...
string	$tablename	Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
int	$recuid	Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
int	$recpid	Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)

Definition at line 1492 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie().

◆ writeUC()

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::writeUC ( $variable = '' )

This writes $variable to the user-record. This is a way of providing session-data. You can fetch the data again through $this->uc in this class! If $variable is not an array, $this->uc is saved!

Parameters

array | string $variable An array you want to store for the user as session data. If $variable is not supplied (is null), the internal variable, ->uc, is stored by default

Definition at line 1223 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$uc, TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Database\Connection\PARAM_LOB.

Referenced by TYPO3\CMS\Core\Authentication\BackendUserAuthentication\backendSetUC(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

Member Data Documentation

◆ $auth_timeout_field

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$auth_timeout_field = ''

Definition at line 152 of file AbstractUserAuthentication.php.

◆ $checkPid

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$checkPid = true

Definition at line 250 of file AbstractUserAuthentication.php.

◆ $checkPid_value

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$checkPid_value = 0

Definition at line 256 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $cookieWasSetOnCurrentRequest

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$cookieWasSetOnCurrentRequest = false

protected

Definition at line 312 of file AbstractUserAuthentication.php.

◆ $dontSetCookie

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$dontSetCookie = false

Definition at line 307 of file AbstractUserAuthentication.php.

◆ $enablecolumns

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$enablecolumns

Initial value:

= [

'rootLevel' => ''

Definition at line 105 of file AbstractUserAuthentication.php.

◆ $forceSetCookie

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$forceSetCookie = false

Definition at line 301 of file AbstractUserAuthentication.php.

◆ $formfield_status

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$formfield_status = ''

Definition at line 135 of file AbstractUserAuthentication.php.

◆ $formfield_uident

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$formfield_uident = ''

Definition at line 129 of file AbstractUserAuthentication.php.

◆ $formfield_uname

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$formfield_uname = ''

Definition at line 123 of file AbstractUserAuthentication.php.

◆ $gc_probability

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$gc_probability = 1

Definition at line 177 of file AbstractUserAuthentication.php.

◆ $gc_time

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$gc_time = 0

Definition at line 171 of file AbstractUserAuthentication.php.

◆ $get_name

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$get_name = ''

Definition at line 57 of file AbstractUserAuthentication.php.

◆ $get_URL_ID

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$get_URL_ID = ''

Definition at line 289 of file AbstractUserAuthentication.php.

◆ $getFallBack

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$getFallBack = false

Definition at line 203 of file AbstractUserAuthentication.php.

◆ $getMethodEnabled

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$getMethodEnabled = false

Definition at line 220 of file AbstractUserAuthentication.php.

◆ $hash_length

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$hash_length = 32

Definition at line 213 of file AbstractUserAuthentication.php.

◆ $id

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$id

Definition at line 263 of file AbstractUserAuthentication.php.

◆ $lastLogin_column

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$lastLogin_column = ''

Definition at line 99 of file AbstractUserAuthentication.php.

◆ $lifetime

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$lifetime = 0

Definition at line 163 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\start().

◆ $lockIP

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$lockIP = 4

Definition at line 227 of file AbstractUserAuthentication.php.

◆ $loginFailure

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$loginFailure = false

Definition at line 269 of file AbstractUserAuthentication.php.

◆ $loginSessionStarted

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$loginSessionStarted = false

Definition at line 275 of file AbstractUserAuthentication.php.

◆ $loginType

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$loginType = ''

Definition at line 318 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookieDomain(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getLoginType(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData().

◆ $name

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$name = ''

Definition at line 51 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByName(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setBeUserByName().

◆ $newSessionID

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$newSessionID = false

Definition at line 295 of file AbstractUserAuthentication.php.

◆ $sendNoCacheHeaders

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$sendNoCacheHeaders = true

Definition at line 195 of file AbstractUserAuthentication.php.

◆ $sessionBackend

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$sessionBackend

protected

Definition at line 340 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getSessionBackend().

◆ $sessionData

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$sessionData = []

protected

Definition at line 349 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\performLogoff().

◆ $sessionTimeout

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$sessionTimeout = 0

Definition at line 145 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserSession(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start().

◆ $showHiddenRecords

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$showHiddenRecords = false

Definition at line 117 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $svConfig

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$svConfig = []

Definition at line 324 of file AbstractUserAuthentication.php.

◆ $uc

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$uc

Definition at line 335 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

◆ $user

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$user = null

Definition at line 281 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\compareUident(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserRecord().

◆ $user_table

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$user_table = ''

Definition at line 63 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $usergroup_column

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$usergroup_column = ''

Definition at line 93 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $usergroup_table

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$usergroup_table = ''

Definition at line 69 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $userid_column

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$userid_column = ''

Definition at line 87 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getNewSessionRecord().

◆ $userident_column

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$userident_column = ''

Definition at line 81 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\compareUident(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $username_column

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$username_column = ''

Definition at line 75 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getAuthInfoArray().

◆ $warningEmail

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$warningEmail = ''

Definition at line 232 of file AbstractUserAuthentication.php.

◆ $warningMax

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$warningMax = 3

Definition at line 244 of file AbstractUserAuthentication.php.

◆ $warningPeriod

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$warningPeriod = 3600

Definition at line 238 of file AbstractUserAuthentication.php.

◆ $writeAttemptLog

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$writeAttemptLog = false

Definition at line 189 of file AbstractUserAuthentication.php.

◆ $writeDevLog

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$writeDevLog = false

Definition at line 330 of file AbstractUserAuthentication.php.

◆ $writeStdLog

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$writeStdLog = false

Definition at line 183 of file AbstractUserAuthentication.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkLogFailures()

◆ compareUident()

◆ createSessionId()

◆ createUserSession()

◆ enforceNewSessionId()

◆ fetchUserRecord()

◆ fetchUserSession()

◆ gc()

◆ getAuthInfoArray()

◆ getAuthServices()

◆ getCookie()

◆ getCookieDomain()

◆ getLoginFormData()

◆ getLoginType()

◆ getModuleData()

◆ getNewSessionRecord()

◆ getRawUserByName()

◆ getRawUserByUid()

◆ getSessionBackend()

◆ getSessionData()

◆ getSessionId()

◆ ipLockClause_remoteIPNumber()

◆ isCookieSet()

◆ isExistingSessionRecord()

◆ isRefreshTimeBasedCookie()

◆ isSetSessionCookie()

◆ logoff()

◆ performLogoff()

◆ processLoginData()

◆ pushModuleData()

◆ regenerateSessionId()

◆ removeCookie()

◆ setAndSaveSessionData()

◆ setBeUserByName()

◆ setBeUserByUid()

◆ setSessionCookie()

◆ setSessionData()

◆ start()

◆ unpack_uc()

◆ updateLoginTimestamp()

◆ user_where_clause()

◆ userConstraints()

◆ veriCode()

◆ writelog()

◆ writeUC()

Member Data Documentation

◆ $auth_timeout_field

◆ $checkPid

◆ $checkPid_value

◆ $cookieWasSetOnCurrentRequest

◆ $dontSetCookie

◆ $enablecolumns

◆ $forceSetCookie

◆ $formfield_status

◆ $formfield_uident

◆ $formfield_uname

◆ $gc_probability

◆ $gc_time

◆ $get_name

◆ $get_URL_ID

◆ $getFallBack

◆ $getMethodEnabled

◆ $hash_length

◆ $id

◆ $lastLogin_column

◆ $lifetime

◆ $lockIP

◆ $loginFailure

◆ $loginSessionStarted

◆ $loginType

◆ $name

◆ $newSessionID