‪TYPO3CMS  ‪main
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 (?ServerRequestInterface $request=null)
 
 checkAuthentication (ServerRequestInterface $request)
 
 getOriginalUserIdWhenInSwitchUserMode ()
 
 authenticate ()
 
 backendCheckLogin (?ServerRequestInterface $request=null)
 
bool isUserAllowedToLogin ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
bool isAdmin ()
 
bool doesUserHaveAccess ($row, $perms)
 
int null isInWebMount ($idOrRow, $readPerms='')
 
 isSystemMaintainer (bool $pure=false)
 
string getPagePermsClause ($perms)
 
int calcPerms ($row)
 
bool check ($type, $value)
 
bool checkAuthMode ($table, $field, $value)
 
bool checkLanguageAccess ($langValue)
 
bool checkFullLanguagesAccess ($table, $record)
 
bool recordEditAccessInternals ($table, $idOrRow, $newRecord=false, $deletedRecord=false, $checkFullLanguageAccess=false)
 
bool mayMakeShortcut ()
 
 workspaceAllowsLiveEditingInTable (string $table)
 
 workspaceCanCreateNewRecord (string $table)
 
bool workspaceCheckStageForCurrent ($stage)
 
array getTSConfig ()
 
 getUserTsConfig ()
 
array returnWebmounts ()
 
 setWebmounts (array $mountPointUids, $append=false)
 
 initializeWebmountsForElementBrowser ()
 
bool jsConfirmation (int $bitmask)
 
 fetchGroupData ()
 
array getCategoryMountPoints ()
 
array getFileMountRecords ()
 
TYPO3 CMS Core Resource ResourceStorage[] getFileStorages ()
 
 evaluateUserSpecificFileFilterSettings ()
 
 getFilePermissions ()
 
array false checkWorkspace (int|array $wsRec)
 
 setWorkspace ($workspaceId)
 
bool setTemporaryWorkspace ($workspaceId)
 
int writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='', $event_pid=-1, $NEWid='', $userId=0)
 
 initializeBackendLogin (?ServerRequestInterface $request=null)
 
 handleUserLoggedIn (?ServerRequestInterface $request=null)
 
 backendSetUC ()
 
 overrideUC ()
 
 resetUC ()
 
 logoff ()
 
 isMfaSetupRequired ()
 
 isImportEnabled ()
 
 isExportEnabled ()
 
 shallDisplayDebugInformation ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 initializeUserSessionManager (?UserSessionManager $userSessionManager=null)
 
 start (ServerRequestInterface $request)
 
 appendCookieToResponse (ResponseInterface $response, ?NormalizedParams $normalizedParams=null)
 
UserSession createUserSession (array $userRecordCandidate)
 
 enforceNewSessionId ()
 
 removeCookie ($cookieName=null)
 
 writeUC ()
 
 pushModuleData (string $module, mixed $data, bool $dontPersistImmediately=false)
 
mixed getModuleData (string $module, string $type='')
 
mixed getSessionData ($key)
 
 setSessionData ($key, $data)
 
 setAndSaveSessionData ($key, $data)
 
array getLoginFormData (ServerRequestInterface $request)
 
 isActiveLogin (ServerRequestInterface $request)
 
array processLoginData (array $loginData, ServerRequestInterface $request)
 
array getAuthInfoArray (ServerRequestInterface $request)
 
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
 
 setBeUserByUid ($uid)
 
 setBeUserByName ($name)
 
array getRawUserByUid ($uid)
 
array getRawUserByName ($name)
 
 getUserId ()
 
 getUserName ()
 
 getSession ()
 

Protected Member Functions

bool checkIfCliUserExists ()
 
 createCliUser ()
 
string generateHashedPassword ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 isMemberOfGroup (int $groupId)
 
array filterValidWebMounts (string $listOfWebMounts)
 
 prepareUserTsConfig ()
 
 initializeFileStorages ()
 
 workspaceInit ()
 
 initializeDbMountpointsInWorkspace ()
 
 hasEditAccessToLiveWorkspace ()
 
 checkWorkspaceCurrent ()
 
 setDefaultWorkspace ()
 
int getDefaultWorkspace ()
 
 releaseLockedRecords (int $userId)
 
 evaluateMfaRequirements ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 setSessionCookie ()
 
 shallSetSessionCookie ()
 
bool isSetSessionCookie ()
 
bool isRefreshTimeBasedCookie ()
 
 getAuthServiceConfiguration ()
 
 fetchPossibleUsers (array $loginData, bool $activeLogin, bool $isExistingSession, ?array $authenticatedUserFromSession, ServerRequestInterface $request)
 
Traversable getAuthServices (string $subType, array $loginData, ?array $authenticatedUserFromSession, ServerRequestInterface $request)
 
 regenerateSessionId ()
 
 updateLoginTimestamp (int $userId)
 
 fetchValidUserFromSessionOrDestroySession (bool $skipSessionUpdate=false)
 
 performLogoff ()
 
bool isCookieSet ()
 
 userConstraints ()
 
 unpack_uc ()
 
mixed removeSensitiveLoginDataForLoggingInfo ($data, bool $isUserRecord=false)
 

Protected Attributes

string $username = '_cli_'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
UserTsConfig $userTsConfig = null
 
bool $userTSUpdated = false
 
array null $checkWorkspaceCurrent_cache
 
TYPO3 CMS Core Resource ResourceStorage[] $fileStorages
 
array null $filePermissions
 
string $formfield_uname = 'username'
 
string $formfield_uident = 'userident'
 
string $formfield_status = 'login_status'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
string $lastLogin_column = ''
 
string $formfield_uname = ''
 
string $formfield_uident = ''
 
string $formfield_status = ''
 
bool $loginSessionStarted = false
 
bool $dontSetCookie = false
 
UserSession $userSession = null
 
UserSessionManager $userSessionManager
 
SetCookieBehavior $setCookie = SetCookieBehavior::None
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
static 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 $userGroupsUID = array( )
 
int $workspace = -99
 
array $workspaceRec = 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
 
bool $writeStdLog = true
 
bool $writeAttemptLog = true
 
int $firstMainGroup = 0
 
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 = ''
 
array $enablecolumns
 
bool $writeStdLog = false
 
bool $writeAttemptLog = false
 
bool $checkPid = true
 
int string null $checkPid_value = 0
 
array null $user
 
array $userGroups = []
 
string $loginType = ''
 
array $uc = []
 

Detailed Description

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

Definition at line 30 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 ( ?ServerRequestInterface  $request = null)

◆ checkAuthentication()

TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::checkAuthentication ( ServerRequestInterface  $request)

Replacement for AbstractUserAuthentication::checkAuthentication()

Not required in CLI mode, therefore empty.

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

Definition at line 72 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 138 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 176 of file CommandLineUserAuthentication.php.

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

◆ getOriginalUserIdWhenInSwitchUserMode()

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

On CLI there is no session and no switched user

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

Definition at line 80 of file CommandLineUserAuthentication.php.

◆ isUserAllowedToLogin()

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

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 127 of file CommandLineUserAuthentication.php.

References $GLOBALS.

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

◆ start()

TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication::start ( ?ServerRequestInterface  $request = null)

Replacement for AbstractUserAuthentication::start()

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

Parameters
ServerRequestInterface | null$request

Definition at line 62 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().