Class BaseAuthenticate
Base Authentication class with common methods and properties.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this object.
-
$_needsPasswordRehash protected
boolWhether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
-
$_passwordHasher protected
AbstractPasswordHasherPassword hasher instance.
-
$_registry protected
ComponentRegistryA Component registry, used to get more components.
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_findUser() protected
Find a user record using the username and password provided.
-
_query() protected
Get query object for fetching user from database.
-
authenticate() abstract public
Authenticate a user based on the request information.
-
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getUser() public
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
-
implementedEvents() public
Returns a list of all events that this authenticate class will listen to.
-
needsPasswordRehash() public
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
-
passwordHasher() public
Return password hasher object
-
unauthenticated() public
Handle unauthenticated access attempt. In implementation valid return values can be:
Method Detail
__construct() ¶ public
__construct(Cake\Controller\ComponentRegistry $registry, array $config = [])Constructor
Parameters
-
Cake\Controller\ComponentRegistry$registry The Component registry used on this request.
-
array$config optional Array of config to use.
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_findUser() ¶ protected
_findUser(string $username, string|null $password = null): bool|arrayFind a user record using the username and password provided.
Input passwords will be hashed even when a user doesn't exist. This helps mitigate timing attacks that are attempting to find valid usernames.
Parameters
-
string$username The username/identifier.
-
string|null$password optional The password, if not provided password checking is skipped and result of find is returned.
Returns
bool|arrayEither false on failure, or an array of user data.
_query() ¶ protected
_query(string $username): Cake\ORM\QueryGet query object for fetching user from database.
Parameters
-
string$username The username/identifier.
Returns
Cake\ORM\Queryauthenticate() ¶ abstract public
authenticate(Cake\Network\Request $request, Cake\Network\Response $response): mixedAuthenticate a user based on the request information.
Parameters
-
Cake\Network\Request$request Request to get authentication information from.
-
Cake\Network\Response$response A response object that can have headers added.
Returns
mixedEither false on failure, or an array of user data on success.
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisThe object itself.
getUser() ¶ public
getUser(Cake\Network\Request $request): mixedGet a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Parameters
-
Cake\Network\Request$request Request object.
Returns
mixedEither false or an array of user information
implementedEvents() ¶ public
implementedEvents(): arrayReturns a list of all events that this authenticate class will listen to.
An authenticate class can listen to following events fired by AuthComponent:
-
Auth.afterIdentify- Fired after a user has been identified using one of configured authenticate class. The callback function should have signature likeafterIdentify(Event $event, array $user)when$useris the identified user record. -
Auth.logout- Fired when AuthComponent::logout() is called. The callback function should have signature likelogout(Event $event, array $user)where$useris the user about to be logged out.
Returns
arrayList of events this class listens to. Defaults to [].
needsPasswordRehash() ¶ public
needsPasswordRehash(): boolReturns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
Returns
boolpasswordHasher() ¶ public
passwordHasher(): AbstractPasswordHasherReturn password hasher object
Returns
AbstractPasswordHasherPassword hasher instance
Throws
RuntimeExceptionIf password hasher class not found or it does not extend AbstractPasswordHasher
unauthenticated() ¶ public
unauthenticated(Cake\Network\Request $request, Cake\Network\Response $response): voidHandle unauthenticated access attempt. In implementation valid return values can be:
- Null - No action taken, AuthComponent should return appropriate response.
- Cake\Network\Response - A response object, which will cause AuthComponent to simply return that response.
Parameters
-
Cake\Network\Request$request A request object.
-
Cake\Network\Response$response A response object.
Returns
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Default config for this object.
fieldsThe fields to use to identify a user by.userModelThe alias for users table, defaults to Users.scopeAdditional conditions to use when looking up and authenticating users, i.e.['Users.is_active' => 1].containExtra models to contain and store in session.passwordHasherPassword hasher class. Can be a string specifying class name or an array containingclassNamekey, any other keys will be passed as config to the class. Defaults to 'Default'.
Type
array$_needsPasswordRehash ¶ protected
Whether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
Type
bool