‪TYPO3CMS  9.5
TYPO3\CMS\Core\Authentication\AbstractAuthenticationService Class Reference
Inheritance diagram for TYPO3\CMS\Core\Authentication\AbstractAuthenticationService:
TYPO3\CMS\Core\Service\AbstractService TYPO3\CMS\Core\Authentication\AuthenticationService TYPO3\CMS\Core\Crypto\PasswordHashing\SaltedPasswordService TYPO3\CMS\Sv\AbstractAuthenticationService TYPO3\CMS\Rsaauth\RsaAuthService TYPO3\CMS\Sv\AuthenticationService TYPO3\CMS\Saltedpasswords\SaltedPasswordService

Public Member Functions

 initAuth ($mode, $loginData, $authInfo, $pObj)
 
bool compareUident (array $user, array $loginData, $passwordCompareStrategy='')
 
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='')
 
mixed fetchUserRecord ($username, $extraWhere='', $dbUserSetup='')
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Service\AbstractService
array getServiceInfo ()
 
string getServiceKey ()
 
string getServiceTitle ()
 
mixed getServiceOption ($optionName, $defaultValue='', $includeDefaultConfig=true)
 
 devLog ($msg, $severity=0, $dataVar=false)
 
 errorPush ($errNum=self::ERROR_GENERAL, $errMsg='Unspecified error occurred')
 
 errorPull ()
 
int bool getLastError ()
 
string getLastErrorMsg ()
 
array getErrorMsgArray ()
 
array getLastErrorArray ()
 
 resetErrors ()
 
bool checkExec ($progList)
 
 deactivateService ()
 
string bool checkInputFile ($absFile)
 
string bool readFile ($absFile, $length=0)
 
string bool writeFile ($content, $absFile='')
 
string bool tempFile ($filePrefix)
 
 registerTempFile ($absFile)
 
 unlinkTempFiles ()
 
 setInput ($content, $type='')
 
 setInputFile ($absFile, $type='')
 
mixed getInput ()
 
string getInputFile ($createFile='')
 
 setOutputFile ($absFile)
 
mixed getOutput ()
 
mixed getOutputFile ($absFile='')
 
bool init ()
 
 reset ()
 
 __destruct ()
 

Public Attributes

AbstractUserAuthentication $pObj
 
string $mode
 
array $login = array( )
 
array $authInfo = array( )
 
array $db_user = array( )
 
array $db_groups = array( )
 
bool $writeAttemptLog = false
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Service\AbstractService
const ERROR_GENERAL = -1
 
const ERROR_SERVICE_NOT_AVAILABLE = -2
 
const ERROR_WRONG_SUBTYPE = -3
 
const ERROR_NO_INPUT = -4
 
const ERROR_FILE_NOT_FOUND = -20
 
const ERROR_FILE_NOT_READABLE = -21
 
const ERROR_FILE_NOT_WRITEABLE = -22
 
const ERROR_PROGRAM_NOT_FOUND = -40
 
const ERROR_PROGRAM_FAILED = -41
 
array $info = array( )
 
array $error = array( )
 
string $out = ''
 
string $inputFile = ''
 
string $inputContent = ''
 
string $inputType = ''
 
string $outputFile = ''
 
array $tempFiles = array( )
 

Additional Inherited Members

- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Service\AbstractService
array $shutdownRegistry = array( )
 
string $prefixId = ''
 

Detailed Description

Authentication services class

Definition at line 26 of file AbstractAuthenticationService.php.

Member Function Documentation

◆ compareUident()

bool TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::compareUident ( array  $user,
array  $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‪Password compare strategy
Returns
‪bool TRUE if login data matched
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Reimplemented in TYPO3\CMS\Core\Crypto\PasswordHashing\SaltedPasswordService.

Definition at line 99 of file AbstractAuthenticationService.php.

◆ fetchUserRecord()

mixed TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::fetchUserRecord (   $username,
  $extraWhere = '',
  $dbUserSetup = '' 
)

Get a user from DB by username

Parameters
string$username‪User name
string$extraWhere‪Additional WHERE clause: " AND ...
array | string$dbUserSetup‪User db table definition, or empty string for $this->db_user
Returns
‪mixed User array or FALSE

Definition at line 133 of file AbstractAuthenticationService.php.

References TYPO3\CMS\Core\Authentication\AbstractAuthenticationService\$db_user, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Core\Authentication\AuthenticationService\getUser().

◆ initAuth()

TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::initAuth (   $mode,
  $loginData,
  $authInfo,
  $pObj 
)

Initialize authentication service

Parameters
string$mode‪Subtype of the service which is used to call the service.
array$loginData‪Submitted login form data
array$authInfoInformation array. Holds submitted form data etc.
AbstractUserAuthentication$pObj‪Parent object

Definition at line 78 of file AbstractAuthenticationService.php.

References TYPO3\CMS\Core\Authentication\AbstractAuthenticationService\$authInfo, TYPO3\CMS\Core\Authentication\AbstractAuthenticationService\$mode, TYPO3\CMS\Core\Authentication\AbstractAuthenticationService\$pObj, and TYPO3\CMS\Core\Service\AbstractService\getServiceOption().

◆ writelog()

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

Writes to log database table in pObj

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 error messages 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 | string$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 | string$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 118 of file AbstractAuthenticationService.php.

References TYPO3\CMS\Core\Service\AbstractService\$error.

Referenced by TYPO3\CMS\Core\Crypto\PasswordHashing\SaltedPasswordService\authUser(), and TYPO3\CMS\Core\Authentication\AuthenticationService\getUser().

Member Data Documentation

◆ $authInfo

array TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$authInfo = array( )

◆ $db_groups

array TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$db_groups = array( )

Usergroups db table definition

Definition at line 62 of file AbstractAuthenticationService.php.

◆ $db_user

array TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$db_user = array( )

◆ $login

array TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$login = array( )

Submitted login form data

Definition at line 44 of file AbstractAuthenticationService.php.

◆ $mode

string TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$mode

Subtype of the service which is used to call the service.

Definition at line 38 of file AbstractAuthenticationService.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractAuthenticationService\initAuth().

◆ $pObj

AbstractUserAuthentication TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$pObj

◆ $writeAttemptLog

bool TYPO3\CMS\Core\Authentication\AbstractAuthenticationService::$writeAttemptLog = false

If the writelog() functions is called if a login-attempt has be tried without success

Definition at line 68 of file AbstractAuthenticationService.php.