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
Cake\Auth\AbstractPasswordHasher|nullPassword hasher instance.
-
$_registry protected
Cake\Controller\ComponentRegistryA Component registry, used to get more components.
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterface|nullTable locator instance
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_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.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getTableLocator() public
Gets the table locator.
-
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
-
setConfig() public
Sets the config.
-
setTableLocator() public
Sets the table locator.
-
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): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites a config key.
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\CakeExceptionif attempting to clobber existing config
_findUser() ¶ protected
_findUser(string $username, string|null $password = null): array|falseFind 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
array|false_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\Http\ServerRequest $request, Cake\Http\Response $response): array|falseAuthenticate a user based on the request information.
Parameters
-
Cake\Http\ServerRequest$request Request to get authentication information from.
-
Cake\Http\Response$response A response object that can have headers added.
Returns
array|falseconfigShallow() ¶ 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->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['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
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns the config.
Usage
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Reading with default value:
$this->getConfig('some-key', 'default-value');Parameters
-
string|null$key optional The key to get or null for the whole config.
-
mixed$default optional The return value when the key does not exist.
Returns
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptiongetTableLocator() ¶ public
getTableLocator(): Cake\ORM\Locator\LocatorInterfaceGets the table locator.
Returns
Cake\ORM\Locator\LocatorInterfacegetUser() ¶ public
getUser(Cake\Http\ServerRequest $request): array|falseGet a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Parameters
-
Cake\Http\ServerRequest$request Request object.
Returns
array|falseimplementedEvents() ¶ 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(EventInterface $event, array $user)when$useris the identified user record. -
Auth.logout- Fired when AuthComponent::logout() is called. The callback function should have signature likelogout(EventInterface $event, array $user)where$useris the user about to be logged out.
Returns
arrayneedsPasswordRehash() ¶ 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(): Cake\Auth\AbstractPasswordHasherReturn password hasher object
Returns
Cake\Auth\AbstractPasswordHasherThrows
RuntimeExceptionIf password hasher class not found or it does not extend AbstractPasswordHasher
setConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['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.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
setTableLocator() ¶ public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $thisSets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thisunauthenticated() ¶ public
unauthenticated(Cake\Http\ServerRequest $request, Cake\Http\Response $response): Cake\Http\Response|null|voidHandle unauthenticated access attempt. In implementation valid return values can be:
- Null - No action taken, AuthComponent should return appropriate response.
- Cake\Http\Response - A response object, which will cause AuthComponent to simply return that response.
Parameters
-
Cake\Http\ServerRequest$request A request object.
-
Cake\Http\Response$response A response object.
Returns
Cake\Http\Response|null|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.finderThe finder method to use to fetch user record. Defaults to 'all'. You can set finder name as string or an array where key is finder name and value is an array passed toTable::find()options. E.g. ['finderName' => ['some_finder_option' => 'some_value']]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$_registry ¶ protected
A Component registry, used to get more components.
Type
Cake\Controller\ComponentRegistry