Class DigestAuthenticate
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.
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.
-
_getDigest() protected
Gets the digest headers from the request/environment.
-
_query() protected
Get query object for fetching user from database.
-
authenticate() public
Authenticate a user using HTTP auth. Will use the configured User model and attempt a login using HTTP auth.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
generateNonce() protected
Generate a nonce value that is validated in future requests.
-
generateResponseHash() public
Generate the response hash for a given digest array.
-
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. Used by cookie-less auth for stateless clients.
-
implementedEvents() public
Returns a list of all events that this authenticate class will listen to.
-
loginHeaders() public
Generate the login headers
-
needsPasswordRehash() public
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
-
parseAuthData() public
Parse the digest authentication headers and split them up.
-
password() public static
Creates an auth digest password hash to store
-
passwordHasher() public
Return password hasher object
-
setConfig() public
Sets the config.
-
setTableLocator() public
Sets the table locator.
-
unauthenticated() public
Handles an unauthenticated access attempt by sending appropriate login headers
-
validNonce() protected
Check the nonce to ensure it is valid and not expired.
Method Detail
__construct() ¶ public
__construct(Cake\Controller\ComponentRegistry $registry, array $config = [])Constructor
Besides the keys specified in BaseAuthenticate::$_defaultConfig, DigestAuthenticate uses the following extra keys:
secretThe secret to use for nonce validation. Defaults to Security::getSalt().realmThe realm authentication is for, Defaults to the servername.qopDefaults to 'auth', no other values are supported at this time.opaqueA string that must be returned unchanged by clients. Defaults tomd5($config['realm'])nonceLifetimeThe 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 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\Exceptionif 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\Exceptionif 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_getDigest() ¶ protected
_getDigest(Cake\Http\ServerRequest $request): array|nullGets the digest headers from the request/environment.
Parameters
-
Cake\Http\ServerRequest$request Request object.
Returns
array|null_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() ¶ public
authenticate(Cake\Http\ServerRequest $request, Cake\Http\Response $response): array|falseAuthenticate a user using HTTP auth. Will use the configured User model and attempt a login using HTTP auth.
Parameters
-
Cake\Http\ServerRequest$request The request to authenticate with.
-
Cake\Http\Response$response The response to add headers to.
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
$thisgenerateNonce() ¶ protected
generateNonce(): stringGenerate a nonce value that is validated in future requests.
Returns
stringgenerateResponseHash() ¶ public
generateResponseHash(array $digest, string $password, string $method): stringGenerate 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
stringgetConfig() ¶ 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. Used by cookie-less auth for stateless clients.
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
arrayloginHeaders() ¶ public
loginHeaders(Cake\Http\ServerRequest $request): string[]Generate the login headers
Parameters
-
Cake\Http\ServerRequest$request Request object.
Returns
string[]needsPasswordRehash() ¶ 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
boolparseAuthData() ¶ public
parseAuthData(string $digest): array|nullParse the digest authentication headers and split them up.
Parameters
-
string$digest The raw digest authentication headers.
Returns
array|nullpassword() ¶ public static
password(string $username, string $password, string $realm): stringCreates 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
stringpasswordHasher() ¶ 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\ExceptionWhen 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): voidHandles an unauthenticated access attempt by sending appropriate login headers
- 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
voidThrows
Cake\Http\Exception\UnauthorizedExceptionvalidNonce() ¶ protected
validNonce(string $nonce): boolCheck the nonce to ensure it is valid and not expired.
Parameters
-
string$nonce The nonce value to check.
Returns
boolProperty 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