• Home
• Neos
• Flow
• Security
• Context

PHP Class Neos\Flow\Security\Context

Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$activeTokens	Neos\Flow\Security\Authentication\TokenInterface[]	Array of tokens currently active
$authenticationManager	Neos\Flow\Security\Authentication\AuthenticationManagerInterface
$authenticationStrategy	integer	One of the AUTHENTICATE_* constants to set the authentication strategy.
$authorizationChecksDisabled	boolean	Whether authorization is disabled @see areAuthorizationChecksDisabled()
$contextHash	string	@see getContextHash()
$csrfProtectionStrategy	integer	One of the CSRF_* constants to set the csrf protection strategy
$csrfProtectionTokens	array
$hashService	Neos\Flow\Security\Cryptography\HashService
$inactiveTokens	array	Array of tokens currently inactive
$initialized	boolean	TRUE if the context is initialized in the current request, FALSE or NULL otherwise.
$interceptedRequest	Neos\Flow\Mvc\RequestInterface
$policyService	Neos\Flow\Security\Policy\PolicyService
$request	Neos\Flow\Mvc\ActionRequest
$roles	Neos\Flow\Security\Policy\Role[]
$securityLogger	Neos\Flow\Log\SecurityLoggerInterface
$sessionManager	Neos\Flow\Session\SessionManagerInterface
$tokenStatusLabels	array
$tokens	array	Array of configured tokens (might have request patterns)

Public Methods

Method	Description
areAuthorizationChecksDisabled ( ) : boolean	Returns TRUE if authorization should be ignored, otherwise FALSE This is mainly useful to fetch records without Content Security to kick in (e.g. for AuthenticationProviders)
canBeInitialized ( ) : boolean	Check if the securityContext is ready to be initialized. Only after that security will be active.
clearContext ( ) : void	Clears the security context.
getAccount ( ) : Account	Returns the account of the first authenticated authentication token.
getAccountByAuthenticationProviderName ( string $authenticationProviderName ) : Account	Returns an authenticated account for the given provider or NULL if no account was authenticated or no token was registered for the given authentication provider name.
getAuthenticationStrategy ( ) : integer	Get the token authentication strategy
getAuthenticationTokens ( ) : Neos\Flow\Security\Authentication\TokenInterface[]	Returns all Authentication\Tokens of the security context which are active for the current request. If a token has a request pattern that cannot match against the current request it is determined as not active.
getAuthenticationTokensOfType ( string $className ) : Neos\Flow\Security\Authentication\TokenInterface[]	Returns all Authentication\Tokens of the security context which are active for the current request and of the given type. If a token has a request pattern that cannot match against the current request it is determined as not active.
getContextHash ( ) : string	Returns a hash that is unique for the current context, depending on hash components, @see setContextHashComponent()
getCsrfProtectionToken ( ) : string	Returns the current CSRF protection token. A new one is created when needed, depending on the configured CSRF protection strategy.
getInterceptedRequest ( ) : ActionRequest	Returns the request, that has been stored for later resuming after it has been intercepted by a security exception, NULL if there is none.
getRoles ( ) : Role[]	Returns the roles of all authenticated accounts, including inherited roles.
hasCsrfProtectionTokens ( ) : boolean	Returns TRUE if the context has CSRF protection tokens.
hasRole ( string $roleIdentifier ) : boolean	Returns TRUE, if at least one of the currently authenticated accounts holds a role with the given identifier, also recursively.
initialize ( ) : void	Initializes the security context for the given request.
injectAuthenticationManager ( Neos\Flow\Security\Authentication\AuthenticationManagerInterface $authenticationManager ) : void	Inject the authentication manager
injectSettings ( array $settings ) : void	Injects the configuration settings
isCsrfProtectionTokenValid ( string $csrfToken ) : boolean	Returns TRUE if the given string is a valid CSRF protection token. The token will be removed if the configured csrf strategy is 'onePerUri'.
isInitialized ( ) : boolean
refreshRoles ( ) : void	Refreshes the currently effective roles. In fact the roles first level cache is reset and the effective roles get recalculated by calling getRoles().
refreshTokens ( ) : void	Refreshes all active tokens by updating the credentials.
setInterceptedRequest ( ActionRequest $interceptedRequest = null ) : void	Sets an action request, to be stored for later resuming after it has been intercepted by a security exception.
setRequest ( ActionRequest $request ) : void	Set the current action request
shutdownObject ( ) : void	Shut the object down
withoutAuthorizationChecks ( Closure $callback ) : void	Lets you switch off authorization checks (CSRF token, policies, content security, .

Protected Methods

Method	Description
isTokenActive ( Neos\Flow\Security\Authentication\TokenInterface $token ) : boolean	Evaluates any RequestPatterns of the given token to determine whether it is active for the current request - If no RequestPattern is configured for this token, it is active - Otherwise it is active only if at least one configured RequestPattern per type matches the request
mergeTokens ( array $managerTokens, array $sessionTokens ) : array	Merges the session and manager tokens. All manager tokens types will be in the result array If a specific type is found in the session this token replaces the one (of the same type) given by the manager.
separateActiveAndInactiveTokens ( ) : void	Stores all active tokens in $this->activeTokens, all others in $this->inactiveTokens
updateTokens ( array $tokens ) : void	Updates the token credentials for all tokens in the given array.

Method Details

Property Details