Class DigestAuthenticate

public $components = [
    'Auth' => [
        'authenticate' => ['Digest']
    ]
];

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

__constructsource public

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

Constructor

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

• realm The realm authentication is for, Defaults to the servername.
• nonce A nonce used for authentication. Defaults to uniqid().
• 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'])

Parameters

Cake\Controller\ComponentRegistry $registry

The Component registry used on this request.

array $config optional []

Array of config to use.

Overrides

Cake\Auth\BaseAuthenticate::__construct()

_getDigestsource protected

_getDigest( Cake\Network\Request $request )

Gets the digest headers from the request/environment.

Parameters

Cake\Network\Request $request

Request object.

Returns

array
Array of digest information.

generateResponseHashsource public

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

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

getUsersource public

getUser( Cake\Network\Request $request )

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

Parameters

Cake\Network\Request $request

Request object.

Returns

mixed
Either false or an array of user information

Overrides

Cake\Auth\BasicAuthenticate::getUser()

loginHeaderssource public

loginHeaders( Cake\Network\Request $request )

Generate the login headers

Parameters

Cake\Network\Request $request

Request object.

Returns

string
Headers for logging in.

Overrides

Cake\Auth\BasicAuthenticate::loginHeaders()

parseAuthDatasource public

parseAuthData( string $digest )

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

passwordsource public static

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

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.

authenticatesource public

authenticate( Cake\Network\Request $request , Cake\Network\Response $response )

Authenticate a user using HTTP auth. Will use the configured User model and attempt a login using HTTP auth.

Parameters

Cake\Network\Request $request

The request to authenticate with.

Cake\Network\Response $response

The response to add headers to.

Returns

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

unauthenticatedsource public

unauthenticated( Cake\Network\Request $request , Cake\Network\Response $response )

Handles an unauthenticated access attempt by sending appropriate login headers

Parameters

Cake\Network\Request $request

A request object.

Cake\Network\Response $response

A response object.

Throws

Cake\Network\Exception\UnauthorizedException
\Cake\Network\Exception\UnauthorizedException

Overrides

Cake\Auth\BaseAuthenticate::unauthenticated()

_findUsersource protected

_findUser( string $username , string|null $password null )

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 null

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.

_querysource protected

_query( string $username )

Get query object for fetching user from database.

Parameters

string $username

The username/identifier.

Returns

Cake\ORM\Query
\Cake\ORM\Query

implementedEventssource public

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(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 [].

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

needsPasswordRehashsource public

needsPasswordRehash( )

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

Returns

boolean
bool

passwordHashersource public

passwordHasher( )

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

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

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

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

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

Write a config variable

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

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

configsource public

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

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 optional null

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

mixed|null $value optional null

The value to set.

boolean $merge optional true

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

Returns

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

Throws

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

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

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->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 null

The value to set.

Returns

mixed
$this The object itself.

[
    'fields' => [
        'username' => 'username',
        'password' => 'password'
    ],
    'userModel' => 'Users',
    'scope' => [],
    'finder' => 'all',
    'contain' => null,
    'passwordHasher' => 'Default'
]

false

[]

false