\Cake\AuthDigestAuthenticate

Digest Authentication adapter for AuthComponent.

Provides Digest HTTP authentication support for AuthComponent.

Using Digest auth

Load AuthComponent in your controller's initialize() and add 'Digest' in 'authenticate' key

 $this->loadComponent('Auth', [
     'authenticate' => ['Digest'],
     'storage' => 'Memory',
     'unauthorizedRedirect' => false,
 ]);

You should set storage to Memory to prevent CakePHP from sending a session cookie to the client.

You should set unauthorizedRedirect to false. This causes AuthComponent to throw a ForbiddenException exception instead of redirecting to another page.

Since HTTP Digest Authentication is stateless you don't need call setUser() in your controller. The user credentials will be checked on each request. If valid credentials are not provided, required authentication headers will be sent by this authentication provider which triggers the login dialog in the browser/client.

Generating passwords compatible with Digest authentication.

DigestAuthenticate requires a special password hash that conforms to RFC2617. You can generate this password using DigestAuthenticate::password()

$digestPass = DigestAuthenticate::password($username, $password, env('SERVER_NAME'));

If you wish to use digest authentication alongside other authentication methods, it's recommended that you store the digest authentication separately. For example User.digest_pass could be used for a digest password, while User.password would store the password hash for use with other methods like Basic or Form.

Summary

Methods
Properties
Constants
authenticate()
getUser()
unauthenticated()
loginHeaders()
__construct()
passwordHasher()
needsPasswordRehash()
implementedEvents()
setConfig()
getConfig()
config()
configShallow()
tableLocator()
setTableLocator()
getTableLocator()
parseAuthData()
generateResponseHash()
password()
No public properties found
No constants found
_findUser()
_query()
_configRead()
_configWrite()
_configDelete()
_getDigest()
generateNonce()
validNonce()
$_defaultConfig
$_registry
$_passwordHasher
$_needsPasswordRehash
$_config
$_configInitialized
$_tableLocator
N/A
No private methods found
No private properties found
N/A

Properties

$_defaultConfig

$_defaultConfig : array

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'.
  • Options scope and contain have been deprecated since 3.1. Use custom finder instead to modify the query to fetch user record.

Type

array

$_needsPasswordRehash

$_needsPasswordRehash : boolean

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

Type

boolean

$_config

$_config : array

Runtime config

Type

array

$_configInitialized

$_configInitialized : boolean

Whether the config property has already been configured with defaults

Type

boolean

Methods

authenticate()

authenticate(\Cake\Http\ServerRequest  $request, \Cake\Http\Response  $response) : mixed

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

mixed —

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

getUser()

getUser(\Cake\Http\ServerRequest  $request) : mixed

Get a user based on information in the request. Used by cookie-less auth for stateless clients.

Parameters

\Cake\Http\ServerRequest $request

Request object.

Returns

mixed —

Either false or an array of user information

unauthenticated()

unauthenticated(\Cake\Http\ServerRequest  $request, \Cake\Http\Response  $response) : 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.

loginHeaders()

loginHeaders(\Cake\Http\ServerRequest  $request) : array

Generate the login headers

Parameters

\Cake\Http\ServerRequest $request

Request object.

Returns

array —

Headers for logging in.

__construct()

__construct(\Cake\Controller\ComponentRegistry  $registry, array  $config = array()) 

Constructor

Besides the keys specified in BaseAuthenticate::$_defaultConfig, DigestAuthenticate uses the following extra keys:

  • secret The secret to use for nonce validation. Defaults to Security::getSalt().
  • realm The realm authentication is for, Defaults to the servername.
  • qop Defaults to 'auth', no other values are supported at this time.
  • opaque A string that must be returned unchanged by clients. Defaults to md5($config['realm'])
  • nonceLifetime The number of seconds that nonces are valid for. Defaults to 300.

Parameters

\Cake\Controller\ComponentRegistry $registry

The Component registry used on this request.

array $config

Array of config to use.

passwordHasher()

passwordHasher() : \Cake\Auth\AbstractPasswordHasher

Return password hasher object

Throws

\RuntimeException

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

Returns

\Cake\Auth\AbstractPasswordHasher

Password hasher instance

needsPasswordRehash()

needsPasswordRehash() : boolean

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

Returns

boolean

implementedEvents()

implementedEvents() : array

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(Event $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(Event $event, array $user) where $user is the user about to be logged out.

Returns

array —

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

setConfig()

setConfig(string|array  $key, mixed|null  $value = null, boolean  $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

string|array $key

The key to set, or a complete array of configs.

mixed|null $value

The value to set.

boolean $merge

Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception

When trying to set a key that is invalid.

Returns

$this

getConfig()

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

The key to get or null for the whole config.

mixed $default

The return value when the key does not exist.

Returns

mixed —

Config value being read.

config()

config(string|array|null  $key = null, mixed|null  $value = null, boolean  $merge = true) : mixed

Gets/Sets the config.

Usage

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

The key to get/set, or a complete array of configs.

mixed|null $value

The value to set.

boolean $merge

Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception

When trying to set a key that is invalid.

Returns

mixed —

Config value being read, or the object itself on write operations.

configShallow()

configShallow(string|array  $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

string|array $key

The key to set, or a complete array of configs.

mixed|null $value

The value to set.

Returns

$this

tableLocator()

tableLocator(\Cake\ORM\Locator\LocatorInterface|null  $tableLocator = null) : \Cake\ORM\Locator\LocatorInterface

Sets the table locator.

If no parameters are passed, it will return the currently used locator.

Parameters

\Cake\ORM\Locator\LocatorInterface|null $tableLocator

LocatorInterface instance.

Returns

\Cake\ORM\Locator\LocatorInterface

setTableLocator()

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

Sets the table locator.

Parameters

\Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

parseAuthData()

parseAuthData(string  $digest) : array|null

Parse the digest authentication headers and split them up.

Parameters

string $digest

The raw digest authentication headers.

Returns

array|null —

An array of digest authentication headers

generateResponseHash()

generateResponseHash(array  $digest, string  $password, string  $method) : string

Generate the response hash for a given digest array.

Parameters

array $digest

Digest information containing data from DigestAuthenticate::parseAuthData().

string $password

The digest hash password generated with DigestAuthenticate::password()

string $method

Request method

Returns

string —

Response hash

password()

password(string  $username, string  $password, string  $realm) : string

Creates an auth digest password hash to store

Parameters

string $username

The username to use in the digest hash.

string $password

The unhashed password to make a digest hash for.

string $realm

The realm the password is for.

Returns

string —

the hashed password that can later be used with Digest authentication.

_findUser()

_findUser(string  $username, string|null  $password = null) : boolean|array

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

The password, if not provided password checking is skipped and result of find is returned.

Returns

boolean|array —

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

_query()

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

Get query object for fetching user from database.

Parameters

string $username

The username/identifier.

Returns

\Cake\ORM\Query

_configRead()

_configRead(string|null  $key) : mixed

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()

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

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

\Cake\Core\Exception\Exception

if attempting to clobber existing config

_configDelete()

_configDelete(string  $key) : void

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

\Cake\Core\Exception\Exception

if attempting to clobber existing config

_getDigest()

_getDigest(\Cake\Http\ServerRequest  $request) : array|boolean

Gets the digest headers from the request/environment.

Parameters

\Cake\Http\ServerRequest $request

Request object.

Returns

array|boolean —

Array of digest information.

generateNonce()

generateNonce() : string

Generate a nonce value that is validated in future requests.

Returns

string

validNonce()

validNonce(string  $nonce) : boolean

Check the nonce to ensure it is valid and not expired.

Parameters

string $nonce

The nonce value to check.

Returns

boolean