‪TYPO3CMS  10.4
TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication Class Reference
Inheritance diagram for TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication:
TYPO3\CMS\Core\Authentication\BackendUserAuthentication TYPO3\CMS\Core\Authentication\AbstractUserAuthentication

Public Member Functions

 __construct ()
 
 start ()
 
 checkAuthentication ()
 
 authenticate ()
 
 backendCheckLogin ($proceedIfNoUserIsLoggedIn=false)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
bool isAdmin ()
 
bool isMemberOfGroup ($groupId)
 
bool doesUserHaveAccess ($row, $perms)
 
int null isInWebMount ($idOrRow, $readPerms='', $exitOnError=0)
 
bool modAccess ($conf)
 
bool isSystemMaintainer ()
 
string getPagePermsClause ($perms)
 
int calcPerms ($row)
 
bool isRTE ()
 
bool check ($type, $value)
 
bool checkAuthMode ($table, $field, $value, $authMode)
 
bool checkLanguageAccess ($langValue)
 
bool checkFullLanguagesAccess ($table, $record)
 
bool recordEditAccessInternals ($table, $idOrRow, $newRecord=false, $deletedRecord=false, $checkFullLanguageAccess=false)
 
bool mayMakeShortcut ()
 
string workspaceCannotEditRecord ($table, $recData)
 
string workspaceCannotEditOfflineVersion ($table, $recData)
 
mixed workspaceAllowLiveRecordsInPID ($pid, $table)
 
bool workspaceAllowsLiveEditingInTable (string $table)
 
bool workspaceCreateNewRecord ($pid, $table)
 
bool workspaceCanCreateNewRecord (string $table)
 
bool workspaceAllowAutoCreation ($table, $id, $recpid)
 
bool workspaceCheckStageForCurrent ($stage)
 
bool workspacePublishAccess ($wsid)
 
bool workspaceSwapAccess ()
 
array getTSConfig ()
 
array returnWebmounts ()
 
 setWebmounts (array $mountPointUids, $append=false)
 
 initializeWebmountsForElementBrowser ()
 
bool jsConfirmation ($bitmask)
 
 fetchGroupData ()
 
 fetchGroups ($grList, $idList='')
 
 setCachedList ($cList)
 
array getCategoryMountPoints ()
 
array getFileMountRecords ()
 
TYPO3 CMS Core Resource ResourceStorage[] getFileStorages ()
 
 evaluateUserSpecificFileFilterSettings ()
 
array getFilePermissions ()
 
array getFilePermissionsForStorage (ResourceStorage $storageObject)
 
TYPO3 CMS Core Resource Folder bool getDefaultUploadFolder ($pid=null, $table=null, $field=null)
 
TYPO3 CMS Core Resource Folder null getDefaultUploadTemporaryFolder ()
 
 workspaceInit ()
 
array checkWorkspace ($wsRec, $fields=' *')
 
array checkWorkspaceCurrent ()
 
 setWorkspace ($workspaceId)
 
bool setTemporaryWorkspace ($workspaceId)
 
 setDefaultWorkspace ()
 
int getDefaultWorkspace ()
 
int writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='', $event_pid=-1, $NEWid='', $userId=0)
 
 checkLogFailures ($email, $secondsBack=3600, $max=3)
 
bool checkLockToIP ()
 
 backendSetUC ()
 
 overrideUC ()
 
 resetUC ()
 
 logoff ()
 
 isImportEnabled ()
 
 isExportEnabled ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
bool isSetSessionCookie ()
 
bool isRefreshTimeBasedCookie ()
 
string createSessionId ()
 
array createUserSession ($tempuser)
 
array getNewSessionRecord ($tempuser)
 
array bool fetchUserSession ($skipSessionUpdate=false)
 
 enforceNewSessionId ()
 
 removeCookie ($cookieName)
 
bool isExistingSessionRecord ($id)
 
bool isCookieSet ()
 
 writeUC ($variable='')
 
 unpack_uc ($theUC='')
 
 pushModuleData ($module, $data, $noSave=0)
 
mixed getModuleData ($module, $type='')
 
mixed getSessionData ($key)
 
 setSessionData ($key, $data)
 
 setAndSaveSessionData ($key, $data)
 
array getLoginFormData ()
 
array processLoginData ($loginData, $passwordTransmissionStrategy='')
 
array getAuthInfoArray ()
 
 gc ()
 
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
 
 setBeUserByUid ($uid)
 
 setBeUserByName ($name)
 
array getRawUserByUid ($uid)
 
array getRawUserByName ($name)
 
string getSessionId ()
 
string getLoginType ()
 

Protected Member Functions

bool isUserAllowedToLogin ()
 
bool checkIfCliUserExists ()
 
 createCliUser ()
 
string generateHashedPassword ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 prepareUserTsConfig ()
 
 initializeFileStorages ()
 
 initializeDbMountpointsInWorkspace ()
 
 sendLoginAttemptEmail (Statement $result, string $emailAddress)
 
 releaseLockedRecords (int $userId)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 sendHttpHeaders ()
 
array getHttpHeaders ()
 
 setSessionCookie ()
 
string getCookieDomain ()
 
string getCookie ($cookieName)
 
Traversable getAuthServices (string $subType, array $loginData, array $authInfo)
 
 regenerateSessionId (array $existingSessionRecord=[], bool $anonymous=false)
 
 updateLoginTimestamp (int $userId)
 
 performLogoff ()
 
QueryRestrictionContainerInterface userConstraints ()
 
mixed removeSensitiveLoginDataForLoggingInfo ($data, bool $isUserRecord=false)
 
SessionBackendInterface getSessionBackend ()
 

Protected Attributes

string $username = '_cli_'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
array $userTS = array( )
 
bool $userTSUpdated = false
 
array null $checkWorkspaceCurrent_cache
 
TYPO3 CMS Core Resource ResourceStorage[] $fileStorages
 
array $filePermissions
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
bool $cookieWasSetOnCurrentRequest = false
 
IpLocker $ipLocker
 
SessionBackendInterface $sessionBackend
 
array $sessionData = array( )
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
static string getCookieName ()
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
const ROLE_SYSTEMMAINTAINER = 'systemMaintainer'
 
string $usergroup_column = 'usergroup'
 
string $usergroup_table = 'be_groups'
 
array $groupData
 
array $userGroups = array( )
 
array $userGroupsUID = array( )
 
string $groupList = ''
 
int $workspace = -99
 
array $workspaceRec = array( )
 
array $dataLists
 
array $includeGroupArray = array( )
 
string $errorMsg = ''
 
string $user_table = 'be_users'
 
string $username_column = 'username'
 
string $userident_column = 'password'
 
string $userid_column = 'uid'
 
string $lastLogin_column = 'lastlogin'
 
array $enablecolumns
 
string $formfield_uname = 'username'
 
string $formfield_uident = 'userident'
 
string $formfield_status = 'login_status'
 
bool $writeStdLog = true
 
bool $writeAttemptLog = true
 
int $sessionTimeout = 28800
 
int $firstMainGroup = 0
 
array $uc
 
array $uc_default
 
string $loginType = 'BE'
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
string $name = ''
 
string $user_table = ''
 
string $usergroup_table = ''
 
string $username_column = ''
 
string $userident_column = ''
 
string $userid_column = ''
 
string $usergroup_column = ''
 
string $lastLogin_column = ''
 
array $enablecolumns
 
bool $showHiddenRecords = false
 
string $formfield_uname = ''
 
string $formfield_uident = ''
 
string $formfield_status = ''
 
int $sessionTimeout = 0
 
string $auth_timeout_field = ''
 
int $lifetime = 0
 
int $gc_time = 86400
 
int $gc_probability = 1
 
bool $writeStdLog = false
 
bool $writeAttemptLog = false
 
bool $sendNoCacheHeaders = true
 
int $hash_length = 32
 
string $warningEmail = ''
 
int $warningPeriod = 3600
 
int $warningMax = 3
 
bool $checkPid = true
 
int $checkPid_value = 0
 
string $id
 
bool $loginFailure = false
 
bool $loginSessionStarted = false
 
array null $user
 
bool $newSessionID = false
 
bool $forceSetCookie = false
 
bool $dontSetCookie = false
 
string $loginType = ''
 
array $svConfig = array( )
 
array $uc
 

Detailed Description

TYPO3 backend user authentication on a CLI level Auto-logs in, only allowed on CLI

Definition at line 29 of file CommandLineUserAuthentication.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ authenticate()

◆ backendCheckLogin()

TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::backendCheckLogin (   $proceedIfNoUserIsLoggedIn = false)

Logs in the TYPO3 Backend user "_cli_"

Parameters
bool$proceedIfNoUserIsLoggedIn‪if this option is set, then there won't be a redirect to the login screen of the Backend - used for areas in the backend which do not need user rights like the login page.

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

Definition at line 108 of file CommandLineUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication\authenticate().

◆ checkAuthentication()

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

Replacement for AbstractUserAuthentication::checkAuthentication()

Not required in CLI mode, therefore empty.

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

Definition at line 70 of file CommandLineUserAuthentication.php.

◆ checkIfCliUserExists()

bool TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::checkIfCliUserExists ( )
protected

Check if a user with username "_cli_" exists. Deleted users are left out but hidden and start / endtime restricted users are considered.

Returns
‪bool true if the user exists

Definition at line 130 of file CommandLineUserAuthentication.php.

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

◆ createCliUser()

TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::createCliUser ( )
protected

◆ generateHashedPassword()

string TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::generateHashedPassword ( )
protected

This function returns a salted hashed key.

Returns
‪string a random password

Definition at line 168 of file CommandLineUserAuthentication.php.

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

◆ isUserAllowedToLogin()

bool TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::isUserAllowedToLogin ( )
protected

Determines whether a CLI backend user is allowed to access TYPO3. Only when adminOnly is off (=0), and only allowed for admins and CLI users (=2)

Returns
‪bool Whether the CLI user is allowed to access TYPO3

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

Definition at line 119 of file CommandLineUserAuthentication.php.

References $GLOBALS.

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

◆ start()

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

Replacement for AbstractUserAuthentication::start()

We do not need support for sessions, cookies, $_GET-modes, the postUserLookup hook or a database connection during CLI Bootstrap

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

Definition at line 60 of file CommandLineUserAuthentication.php.

Member Data Documentation

◆ $username

string TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::$username = '_cli_'
protected

The username of the CLI user (there is only one)

Definition at line 35 of file CommandLineUserAuthentication.php.

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