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

Public Member Functions
	__construct ()

	start ()

	isSetSessionCookie ()

	isRefreshTimeBasedCookie ()

	checkAuthentication ()

	createSessionId ()

	createUserSession ($tempuser)

	getNewSessionRecord ($tempuser)

	fetchUserSession ($skipSessionUpdate=FALSE)

	logoff ()

	removeCookie ($cookieName)

	isExistingSessionRecord ($id)

	isCookieSet ()

	veriCode ()

	writeUC ($variable='')

	unpack_uc ($theUC='')

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

	getModuleData ($module, $type='')

	getSessionData ($key)

	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='')

Public Attributes
	$global_database = ''

	$session_table = ''

	$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_chalvalue = ''

	$formfield_status = ''

	$auth_timeout_field = 0

	$lifetime = 0

	$gc_time = 0

	$gc_probability = 1

	$writeStdLog = FALSE

	$writeAttemptLog = FALSE

	$sendNoCacheHeaders = TRUE

	$getFallBack = FALSE

	$hash_length = 32

	$getMethodEnabled = FALSE

	$lockIP = 4

	$lockHashKeyWords = 'useragent'

	$warningEmail = ''

	$warningPeriod = 3600

	$warningMax = 3

	$checkPid = TRUE

	$checkPid_value = 0

	$id

	$cookieId

	$loginFailure = FALSE

	$loginSessionStarted = FALSE

	$user = NULL

	$get_URL_ID = ''

	$newSessionID = FALSE

	$forceSetCookie = FALSE

	$dontSetCookie = FALSE

	$challengeStoredInCookie = FALSE

	$loginType = ''

	$svConfig = array()

	$writeDevLog = FALSE

	$uc

Protected Member Functions
	setSessionCookie ()

	getCookieDomain ()

	getCookie ($cookieName)

	regenerateSessionId ()

	fetchUserSessionFromDB ()

	user_where_clause ()

	ipLockClause ()

	ipLockClause_remoteIPNumber ($parts)

	hashLockClause ()

	hashLockClause_getHashInt ()

	getDatabaseConnection ()

Protected Attributes
	$cookieWasSetOnCurrentRequest = FALSE

	$db = NULL

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.

Author: Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om; René Fritz r.fri.nosp@m.tz@c.nosp@m.olorc.nosp@m.ube..nosp@m.de

Definition at line 32 of file AbstractUserAuthentication.php.

Constructor & Destructor Documentation

◆ __construct()

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

Initialize some important variables

Definition at line 408 of file AbstractUserAuthentication.php.

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

Member Function Documentation

◆ checkAuthentication()

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

Checks if a submission of username and password is present or use other authentication by auth services

Exceptions

Definition at line 627 of file AbstractUserAuthentication.php.

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

◆ checkLogFailures()

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

DUMMY: Check login failures (in some extension classes)

Parameters

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

Returns: void

Todo:: Define visibility

Definition at line 1554 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\checkAuthentication(), 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: boolean TRUE if login data matched

Todo:: Define visibility

Definition at line 1483 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$user, TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\logoff().

◆ createSessionId()

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

Creates a new session ID.

Returns: string The new session ID

Definition at line 884 of file AbstractUserAuthentication.php.

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

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.

Todo:: Define visibility

Definition at line 920 of file AbstractUserAuthentication.php.

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

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

◆ 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

Todo:: Define visibility

Definition at line 1641 of file AbstractUserAuthentication.php.

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

◆ fetchUserSession()

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

Read the user session from db.

Parameters

boolean $skipSessionUpdate

Returns: array User session data

Todo:: Define visibility

Definition at line 978 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$user, TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserSessionFromDB(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\logoff().

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

◆ fetchUserSessionFromDB()

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

protected

The session_id is used to find user in the database. Two tables are joined: The session-table with user_id of the session and the usertable with its primary key if the client is flash (e.g. from a flash application inside TYPO3 that does a server request) then don't evaluate with the hashLockClause, as the client/browser is included in this hash and thus, the flash request would be rejected

Returns: private

Definition at line 1111 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\hashLockClause(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\ipLockClause(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\user_where_clause(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\veriCode().

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

◆ gc()

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

Garbage collector, removing old expired sessions.

Returns: void

Definition at line 1521 of file AbstractUserAuthentication.php.

References $GLOBALS.

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 1447 of file AbstractUserAuthentication.php.

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

◆ 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 593 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 563 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$loginType, $result, 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().

◆ getDatabaseConnection()

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

protected

Get global database connection

Returns: DatabaseConnection

Definition at line 1659 of file AbstractUserAuthentication.php.

References $GLOBALS.

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

◆ 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 1374 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\checkAuthentication().

◆ 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];

Todo:: Define visibility

Definition at line 1323 of file AbstractUserAuthentication.php.

References $module.

◆ 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

Todo:: Define visibility

Definition at line 960 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\hashLockClause_getHashInt(), 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 1616 of file AbstractUserAuthentication.php.

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

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

◆ getRawUserByUid()

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

Fetching raw user record with uid=$uid

Parameters

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

Returns: array user record or FALSE

Definition at line 1597 of file AbstractUserAuthentication.php.

References $uid, TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$user, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\user_where_clause().

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

◆ 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 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.

Returns: mixed

Todo:: Define visibility

Definition at line 1338 of file AbstractUserAuthentication.php.

◆ hashLockClause()

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

protected

This returns the where-clause needed to lock a user to a hash integer

Returns: string private

Definition at line 1235 of file AbstractUserAuthentication.php.

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

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

◆ hashLockClause_getHashInt()

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

protected

Creates hash integer to lock user to. Depends on configured keywords

Returns: integer Hash integer private

Definition at line 1245 of file AbstractUserAuthentication.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\md5int().

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

◆ ipLockClause()

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

protected

This returns the where prepared statement-clause needed to lock a user to the IP address

Returns: array private

Definition at line 1179 of file AbstractUserAuthentication.php.

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

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

◆ 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

integer $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 private

Definition at line 1204 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\ipLockClause().

◆ 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 replaces the old functionality for "$this->cookieId"

Returns: boolean Returns TRUE if a cookie is set

Definition at line 1092 of file AbstractUserAuthentication.php.

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

Referenced by TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\logoff(), 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 in the database. Don't care if session record is still valid or not.

Parameters

integer $id Claimed Session ID

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

Todo:: Define visibility

Definition at line 1077 of file AbstractUserAuthentication.php.

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

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

◆ isRefreshTimeBasedCookie()

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

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

Returns: boolean

Definition at line 615 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: boolean

Definition at line 604 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!

Returns: void

Todo:: Define visibility

Definition at line 1027 of file AbstractUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), and TYPO3\CMS\Backend\Utility\BackendUtility\lockRecords().

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

◆ 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 1404 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.

Returns: void

Todo:: Define visibility

Definition at line 1307 of file AbstractUserAuthentication.php.

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

◆ regenerateSessionId()

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

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.

Definition at line 893 of file AbstractUserAuthentication.php.

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

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

◆ removeCookie()

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

Empty / unset the cookie

Parameters

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

Returns: void

Definition at line 1062 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\logoff(), 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 variable to store in index $key

Returns: void

Todo:: Define visibility

Definition at line 1352 of file AbstractUserAuthentication.php.

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

◆ 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.

Returns: void

See also: ::setBeUserByUid()

Definition at line 1585 of file AbstractUserAuthentication.php.

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

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

◆ 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

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

Returns: void

Definition at line 1572 of file AbstractUserAuthentication.php.

References $uid, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getRawUserByUid().

◆ setSessionCookie()

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

protected

Sets the session cookie for the current disposal.

Returns: void

Exceptions

Definition at line 528 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\start(), and TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\storeSessionData().

◆ 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

Definition at line 425 of file AbstractUserAuthentication.php.

◆ 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

Returns: void

Todo:: Define visibility

Definition at line 1287 of file AbstractUserAuthentication.php.

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

◆ 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

Definition at line 1152 of file AbstractUserAuthentication.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\fetchUserSessionFromDB(), 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

Definition at line 1225 of file AbstractUserAuthentication.php.

References $GLOBALS.

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

◆ 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

integer	$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
integer	$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 !!)
integer	$error	flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
integer	$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.)
integer	$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.)
integer	$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.)

Returns: void

Todo:: Define visibility

Definition at line 1540 of file AbstractUserAuthentication.php.

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

◆ 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 blank string), the internal variable, ->uc, is stored by default

Returns: void

Todo:: Define visibility

Definition at line 1267 of file AbstractUserAuthentication.php.

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

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 = 0

Definition at line 164 of file AbstractUserAuthentication.php.

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

◆ $challengeStoredInCookie

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$challengeStoredInCookie = FALSE

Definition at line 372 of file AbstractUserAuthentication.php.

◆ $checkPid

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

Definition at line 283 of file AbstractUserAuthentication.php.

◆ $checkPid_value

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

Definition at line 290 of file AbstractUserAuthentication.php.

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

◆ $cookieId

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

Definition at line 308 of file AbstractUserAuthentication.php.

◆ $cookieWasSetOnCurrentRequest

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

protected

Definition at line 364 of file AbstractUserAuthentication.php.

◆ $db

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$db = NULL

protected

Definition at line 403 of file AbstractUserAuthentication.php.

◆ $dontSetCookie

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

Definition at line 359 of file AbstractUserAuthentication.php.

◆ $enablecolumns

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

Initial value:

= array(
        'rootLevel' => '',
        
        'disabled' => '',
        'starttime' => '',
        'endtime' => '',
        'deleted' => ''
    )

Definition at line 114 of file AbstractUserAuthentication.php.

◆ $forceSetCookie

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

Definition at line 352 of file AbstractUserAuthentication.php.

◆ $formfield_chalvalue

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

Definition at line 147 of file AbstractUserAuthentication.php.

◆ $formfield_status

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

Definition at line 154 of file AbstractUserAuthentication.php.

◆ $formfield_uident

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

Definition at line 140 of file AbstractUserAuthentication.php.

◆ $formfield_uname

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

Definition at line 133 of file AbstractUserAuthentication.php.

◆ $gc_probability

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

Definition at line 190 of file AbstractUserAuthentication.php.

◆ $gc_time

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

Definition at line 183 of file AbstractUserAuthentication.php.

◆ $get_name

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

Definition at line 60 of file AbstractUserAuthentication.php.

◆ $get_URL_ID

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

Definition at line 338 of file AbstractUserAuthentication.php.

◆ $getFallBack

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

Definition at line 220 of file AbstractUserAuthentication.php.

◆ $getMethodEnabled

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

Definition at line 239 of file AbstractUserAuthentication.php.

◆ $global_database

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

Definition at line 39 of file AbstractUserAuthentication.php.

◆ $hash_length

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

Definition at line 231 of file AbstractUserAuthentication.php.

◆ $id

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

Definition at line 298 of file AbstractUserAuthentication.php.

Referenced by TYPO3\CMS\Backend\FrontendBackendUserAuthentication\extGetTreeList(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\isExistingSessionRecord(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isExistingSessionRecord(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isInWebMount(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\regenerateSessionId(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\regenerateSessionId(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\workspaceAllowAutoCreation().

◆ $lastLogin_column

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

Definition at line 107 of file AbstractUserAuthentication.php.

◆ $lifetime

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

Definition at line 174 of file AbstractUserAuthentication.php.

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

◆ $lockHashKeyWords

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$lockHashKeyWords = 'useragent'

Definition at line 256 of file AbstractUserAuthentication.php.

◆ $lockIP

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

Definition at line 247 of file AbstractUserAuthentication.php.

◆ $loginFailure

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

Definition at line 315 of file AbstractUserAuthentication.php.

◆ $loginSessionStarted

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

Definition at line 322 of file AbstractUserAuthentication.php.

◆ $loginType

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

Definition at line 379 of file AbstractUserAuthentication.php.

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

◆ $name

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

Definition at line 53 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 345 of file AbstractUserAuthentication.php.

◆ $sendNoCacheHeaders

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

Definition at line 211 of file AbstractUserAuthentication.php.

◆ $session_table

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

Definition at line 46 of file AbstractUserAuthentication.php.

◆ $showHiddenRecords

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

Definition at line 126 of file AbstractUserAuthentication.php.

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

◆ $svConfig

TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::$svConfig = array()

Definition at line 386 of file AbstractUserAuthentication.php.

◆ $uc

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

Definition at line 398 of file AbstractUserAuthentication.php.

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

◆ $user

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

Definition at line 329 of file AbstractUserAuthentication.php.

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

◆ $user_table

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

Definition at line 67 of file AbstractUserAuthentication.php.

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

◆ $usergroup_column

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

Definition at line 100 of file AbstractUserAuthentication.php.

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

◆ $usergroup_table

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

Definition at line 73 of file AbstractUserAuthentication.php.

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

◆ $userid_column

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

Definition at line 94 of file AbstractUserAuthentication.php.

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

◆ $userident_column

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

Definition at line 87 of file AbstractUserAuthentication.php.

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

◆ $username_column

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

Definition at line 80 of file AbstractUserAuthentication.php.

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

◆ $warningEmail

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

Definition at line 262 of file AbstractUserAuthentication.php.

◆ $warningMax

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

Definition at line 276 of file AbstractUserAuthentication.php.

◆ $warningPeriod

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

Definition at line 269 of file AbstractUserAuthentication.php.

◆ $writeAttemptLog

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

Definition at line 204 of file AbstractUserAuthentication.php.

◆ $writeDevLog

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

Definition at line 393 of file AbstractUserAuthentication.php.

◆ $writeStdLog

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

Definition at line 197 of file AbstractUserAuthentication.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAuthentication()

◆ checkLogFailures()

◆ compareUident()

◆ createSessionId()

◆ createUserSession()

◆ fetchUserRecord()

◆ fetchUserSession()

◆ fetchUserSessionFromDB()

◆ gc()

◆ getAuthInfoArray()

◆ getCookie()

◆ getCookieDomain()

◆ getDatabaseConnection()

◆ getLoginFormData()

◆ getModuleData()

◆ getNewSessionRecord()

◆ getRawUserByName()

◆ getRawUserByUid()

◆ getSessionData()

◆ hashLockClause()

◆ hashLockClause_getHashInt()

◆ ipLockClause()

◆ ipLockClause_remoteIPNumber()

◆ isCookieSet()

◆ isExistingSessionRecord()

◆ isRefreshTimeBasedCookie()

◆ isSetSessionCookie()

◆ logoff()

◆ processLoginData()

◆ pushModuleData()

◆ regenerateSessionId()

◆ removeCookie()

◆ setAndSaveSessionData()

◆ setBeUserByName()

◆ setBeUserByUid()

◆ setSessionCookie()

◆ start()

◆ unpack_uc()

◆ user_where_clause()

◆ veriCode()

◆ writelog()

◆ writeUC()

Member Data Documentation

◆ $auth_timeout_field

◆ $challengeStoredInCookie

◆ $checkPid

◆ $checkPid_value

◆ $cookieId

◆ $cookieWasSetOnCurrentRequest

◆ $db

◆ $dontSetCookie

◆ $enablecolumns

◆ $forceSetCookie

◆ $formfield_chalvalue

◆ $formfield_status

◆ $formfield_uident

◆ $formfield_uname

◆ $gc_probability

◆ $gc_time

◆ $get_name

◆ $get_URL_ID

◆ $getFallBack

◆ $getMethodEnabled

◆ $global_database

◆ $hash_length

◆ $id

◆ $lastLogin_column

◆ $lifetime

◆ $lockHashKeyWords

◆ $lockIP

◆ $loginFailure

◆ $loginSessionStarted