Class BaseAuthenticate

Base Authentication class with common methods and properties.

Abstract
Namespace: Cake\Auth

Property Summary

$_config protected

array<string, mixed>

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array<string, mixed>

Default config for this object.
$_needsPasswordRehash protected

bool

Whether the user authenticated by this class requires their password to be rehashed with another algorithm.
$_passwordHasher protected

Cake\Auth\AbstractPasswordHasher|null

Password hasher instance.
$_registry protected

Cake\Controller\ComponentRegistry

A Component registry, used to get more components.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Table locator instance
$defaultTable protected

string|null

This object's default table alias.

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.
fetchTable() public

Convenience method to get a table instance.
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 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<string, mixed> $config = [])

Constructor

Parameters

Cake\Controller\ComponentRegistry $registry: The Component registry used on this request.
array<string, mixed> $config optional: Array of config to use.

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters

array<string, mixed>|string $key: Key to write to.
mixed $value: Value to write.
string|bool $merge optional: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_findUser() ¶ protected

_findUser(string $username, string|null $password = null): array<string, mixed>|false

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.

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<string, mixed>|false

Either false on failure, or an array of user data.

_query() ¶ protected

_query(string $username): Cake\ORM\Query

Get query object for fetching user from database.

Parameters

string $username: The username/identifier.

Returns

Cake\ORM\Query

authenticate() ¶ abstract public

authenticate(Cake\Http\ServerRequest $request, Cake\Http\Response $response): array<string, mixed>|false

Authenticate 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<string, mixed>|false

Either false on failure, or an array of user data on success.

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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']);

Parameters

array<string, mixed>|string $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.

Returns

$this

fetchTable() ¶ public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Convenience method to get a table instance.

Parameters

string|null $alias optional: The alias name you want to get. Should be in CamelCase format. If null then the value of $defaultTable property is used.
array<string, mixed> $options optional: The options you want to build the table with. If a table has already been loaded the registry options will be ignored.

Returns

Cake\ORM\Table

Throws

Cake\Core\Exception\CakeException
If `$alias` argument and `$defaultTable` property both are `null`.

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

Returns 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

mixed

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Returns 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

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

getUser() ¶ public

getUser(Cake\Http\ServerRequest $request): array<string, mixed>|false

Get 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<string, mixed>|false

Either false or an array of user information

implementedEvents() ¶ public

implementedEvents(): array<string, mixed>

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.

Returns

array<string, mixed>

List of events this class listens to. Defaults to [].

needsPasswordRehash() ¶ public

needsPasswordRehash(): bool

Returns whether the password stored in the repository for the logged in user requires to be rehashed with another algorithm

Returns

bool

passwordHasher() ¶ public

passwordHasher(): Cake\Auth\AbstractPasswordHasher

Return password hasher object

Returns

Cake\Auth\AbstractPasswordHasher

Password hasher instance

Throws

RuntimeException
If password hasher class not found or it does not extend AbstractPasswordHasher

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Sets 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

array<string, mixed>|string $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

$this

Throws

Cake\Core\Exception\CakeException
When trying to set a key that is invalid.

setTableLocator() ¶ public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

unauthenticated() ¶ public

unauthenticated(Cake\Http\ServerRequest $request, Cake\Http\Response $response): Cake\Http\Response|null|void

Handle 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|void

Property Detail

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

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'.

Type

array<string, mixed>

`$_needsPasswordRehash` ¶ protected

Whether the user authenticated by this class requires their password to be rehashed with another algorithm.

Type

bool

`$_passwordHasher` ¶ protected

Password hasher instance.

Type

Cake\Auth\AbstractPasswordHasher|null

`$_registry` ¶ protected

A Component registry, used to get more components.

Type

Cake\Controller\ComponentRegistry

`$_tableLocator` ¶ protected

Table locator instance

Type

Cake\ORM\Locator\LocatorInterface|null

`$defaultTable` ¶ protected

This object's default table alias.

Type

string|null

Namespaces

Class BaseAuthenticate

Property Summary

Method Summary

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_findUser() protected

_query() protected

authenticate() abstract public

configShallow() public

fetchTable() public

getConfig() public

getConfigOrFail() public

getTableLocator() public

getUser() public

implementedEvents() public

needsPasswordRehash() public

passwordHasher() public

setConfig() public

setTableLocator() public

unauthenticated() public

Method Detail

__construct() ¶ public

Parameters

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_findUser() ¶ protected

Parameters

Returns

_query() ¶ protected

Parameters

Returns

authenticate() ¶ abstract public

Parameters

Returns

configShallow() ¶ public

Parameters

Returns

fetchTable() ¶ public

Parameters

Returns

Throws

See Also

getConfig() ¶ public

Usage

Parameters

Returns

getConfigOrFail() ¶ public

Parameters

Returns

Throws

getTableLocator() ¶ public

Returns

getUser() ¶ public

Parameters

Returns

implementedEvents() ¶ public

Returns

needsPasswordRehash() ¶ public

Returns

passwordHasher() ¶ public

Returns

Throws

setConfig() ¶ public

Usage

Parameters

Returns

Throws

setTableLocator() ¶ public

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_needsPasswordRehash` ¶ protected

`$_passwordHasher` ¶ protected

`$_registry` ¶ protected

`$_tableLocator` ¶ protected

`$defaultTable` ¶ protected