Form authentication adapter for AuthComponent.
Allows you to authenticate users based on form POST data. Usually, this is a login form that users enter information into.
Load AuthComponent
in your controller's initialize()
and add 'Form' in 'authenticate' key
$this->loadComponent('Auth', [ 'authenticate' => [ 'Form' => [ 'fields' => ['username' => 'email', 'password' => 'passwd'], 'finder' => 'auth', ] ] ]);
When configuring FormAuthenticate you can pass in config to which fields, model and finder are used. See BaseAuthenticate::$_defaultConfig
for more information.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this object.
bool
Whether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
\Cake\Auth\AbstractPasswordHasher|null
Password hasher instance.
\Cake\Controller\ComponentRegistry
A Component registry, used to get more components.
\Cake\ORM\Locator\LocatorInterface|null
Table locator instance
Authenticates the identity contained in a request. Will use the config.userModel
, and config.fields
to find POST data that is used to find a matching record in the config.userModel
. Will return false if there is no post data, either username or password is missing, or if the scope conditions have not been met.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Returns a list of all events that this authenticate class will listen to.
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
Handle unauthenticated access attempt. In implementation valid return values can be:
__construct(\Cake\Controller\ComponentRegistry $registry, array $config)
Constructor
\Cake\Controller\ComponentRegistry
$registry The Component registry used on this request.
array
$config optional Array of config to use.
_checkFields(\Cake\Http\ServerRequest $request, array $fields)
Checks the fields to ensure they are supplied.
\Cake\Http\ServerRequest
$request The request that contains login information.
array
$fields The fields to be checked.
bool
False if the fields have not been supplied. True if they exist.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception
_findUser(string $username, ?string $password)
Find 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.
string
$username The username/identifier.
string|null
$password optional The password, if not provided password checking is skipped and result of find is returned.
array|false
Either false on failure, or an array of user data.
_query(string $username)
Get query object for fetching user from database.
string
$username The username/identifier.
\Cake\ORM\Query
authenticate(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response)
Authenticates the identity contained in a request. Will use the config.userModel
, and config.fields
to find POST data that is used to find a matching record in the config.userModel
. Will return false if there is no post data, either username or password is missing, or if the scope conditions have not been met.
\Cake\Http\ServerRequest
$request The request that contains login information.
\Cake\Http\Response
$response Unused response object.
array|false
False on login failure. An array of User data on success.
configShallow(mixed $key, mixed $value)
Merge 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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(?string $key, mixed $default)
Returns the config.
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');
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.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getTableLocator()
Gets the table locator.
\Cake\ORM\Locator\LocatorInterface
getUser(\Cake\Http\ServerRequest $request)
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
\Cake\Http\ServerRequest
$request Request object.
array|false
Either false or an array of user information
implementedEvents()
Returns 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 like afterIdentify(EventInterface $event, array $user)
when $user
is the identified user record.
Auth.logout
- Fired when AuthComponent::logout() is called. The callback function should have signature like logout(EventInterface $event, array $user)
where $user
is the user about to be logged out.
array
List of events this class listens to. Defaults to []
.
needsPasswordRehash()
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
bool
passwordHasher()
Return password hasher object
\Cake\Auth\AbstractPasswordHasher
Password hasher instance
RuntimeException
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
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.
$this
Cake\Core\Exception\Exception
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)
Sets the table locator.
\Cake\ORM\Locator\LocatorInterface
$tableLocator LocatorInterface instance.
$this
unauthenticated(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response)
Handle unauthenticated access attempt. In implementation valid return values can be:
\Cake\Http\ServerRequest
$request A request object.
\Cake\Http\Response
$response A response object.
\Cake\Http\Response|null|void
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this object.
fields
The fields to use to identify a user by.userModel
The alias for users table, defaults to Users.finder
The 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 to Table::find()
options. E.g. ['finderName' => ['some_finder_option' => 'some_value']]passwordHasher
Password hasher class. Can be a string specifying class name or an array containing className
key, any other keys will be passed as config to the class. Defaults to 'Default'.array
Whether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
bool
Password hasher instance.
\Cake\Auth\AbstractPasswordHasher|null
A Component registry, used to get more components.
\Cake\Controller\ComponentRegistry
Table locator instance
\Cake\ORM\Locator\LocatorInterface|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Auth.FormAuthenticate.html