Basic Authentication adapter for AuthComponent.
Provides Basic HTTP authentication support for AuthComponent. Basic Auth will authenticate users against the configured userModel and verify the username and passwords match.
In your controller's components array, add auth + the required config
public $components = [ 'Auth' => [ 'authenticate' => ['Basic'] ] ];
You should also set AuthComponent::$sessionKey = false;
in your AppController's beforeFilter() to prevent CakePHP from sending a session cookie to the client.
Since HTTP Basic Authentication is stateless you don't need a login() action 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.
You may also want to use $this->Auth->unauthorizedRedirect = false;
. By default, unauthorized users are redirected to the referrer URL, AuthComponent::$loginAction
, or '/'. If unauthorizedRedirect is set to false, a ForbiddenException exception is thrown instead of redirecting.
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.
Cake\Network\Request
$request
Cake\Network\Response
$response
mixed
getUser( Cake\Network\Request $request )
Get a user based on information in the request. Used by cookie-less auth for stateless clients.
Cake\Network\Request
$request
mixed
Cake\Auth\BaseAuthenticate::getUser()
loginHeaders( Cake\Network\Request $request )
Generate the login headers
Cake\Network\Request
$request
string
unauthenticated( Cake\Network\Request $request , Cake\Network\Response $response )
Handles an unauthenticated access attempt by sending appropriate login headers
Cake\Network\Request
$request
Cake\Network\Response
$response
Cake\Network\Exception\UnauthorizedException
Cake\Auth\BaseAuthenticate::unauthenticated()
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )
Constructor
Cake\Controller\ComponentRegistry
$registry
$config
optional [] _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.
$username
$password
optional null boolean|array
_query( string $username )
Get query object for fetching user from database.
$username
Cake\ORM\Query
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.array
[]
.Cake\Event\EventListenerInterface::implementedEvents()
needsPasswordRehash( )
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
boolean
passwordHasher( )
Return password hasher object
Cake\Auth\AbstractPasswordHasher
RuntimeException
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
$key
optional null $value
optional null $merge
optional true mixed
Cake\Core\Exception\Exception
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']);
$key
$value
optional null mixed
protected 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'.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'.scope
and contain
have been deprecated since 3.1. Use custom finder instead to modify the query to fetch user record.[ 'fields' => [ 'username' => 'username', 'password' => 'password' ], 'userModel' => 'Users', 'scope' => [], 'finder' => 'all', 'contain' => null, 'passwordHasher' => 'Default' ]
protected boolean
Whether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
false
protected Cake\Controller\ComponentRegistry
A Component registry, used to get more components.
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Auth.BasicAuthenticate.html