Class HttpBasicAuthenticator
HttpBasic Authenticator
Provides Basic HTTP authentication support.
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this object.
fieldsThe fields to use to identify a user by.skipChallengeIf set totruethen challenge exception will not be generated in case of authentication failure. Defaults tofalse.
-
$_identifier protected
Authentication\Identifier\IdentifierInterfaceIdentifier or identifiers collection.
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
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. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getIdentifier() public
Gets the identifier.
-
loginHeaders() protected
Generate the login headers
-
setConfig() public
Sets the config.
-
setIdentifier() public
Sets the identifier.
-
unauthorizedChallenge() public
Create a challenge exception for basic auth challenge.
Method Detail
__construct() ¶ public
__construct(Authentication\Identifier\IdentifierInterface $identifier, array $config = [])Constructor
Parameters
-
Authentication\Identifier\IdentifierInterface$identifier Identifier or identifiers collection.
-
array$config optional Configuration settings.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif 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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites 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
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
authenticate() ¶ public
authenticate(Psr\Http\Message\ServerRequestInterface $request): Authentication\Authenticator\ResultInterfaceAuthenticate a user using HTTP auth. Will use the configured User model and attempt a login using HTTP auth.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request to authenticate with.
Returns
Authentication\Authenticator\ResultInterfaceconfigShallow() ¶ public
configShallow(array<string, mixed>|string $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
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() ¶ 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
InvalidArgumentExceptiongetIdentifier() ¶ public
getIdentifier(): Authentication\Identifier\IdentifierInterfaceGets the identifier.
Returns
Authentication\Identifier\IdentifierInterfaceloginHeaders() ¶ protected
loginHeaders(Psr\Http\Message\ServerRequestInterface $request): arrayGenerate the login headers
Parameters
-
Psr\Http\Message\ServerRequestInterface$request Request object.
Returns
arraysetConfig() ¶ public
setConfig(array<string, mixed>|string $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
-
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
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
setIdentifier() ¶ public
setIdentifier(Authentication\Identifier\IdentifierInterface $identifier): $thisSets the identifier.
Parameters
-
Authentication\Identifier\IdentifierInterface$identifier IdentifierInterface instance.
Returns
$thisunauthorizedChallenge() ¶ public
unauthorizedChallenge(Psr\Http\Message\ServerRequestInterface $request): voidCreate a challenge exception for basic auth challenge.
Create an exception with the appropriate headers and response body to challenge a request that has missing or invalid credentials.
This is primarily used by authentication methods that use the WWW-Authorization header.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request A request object.
Returns
voidThrows
Authentication\Authenticator\AuthenticationRequiredExceptionProperty 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.skipChallengeIf set totruethen challenge exception will not be generated in case of authentication failure. Defaults tofalse.
Type
array$_identifier ¶ protected
Identifier or identifiers collection.
Type
Authentication\Identifier\IdentifierInterface