Quick Start

Load the plugin by adding the following statement in your project’s :

public function bootstrap()
{
    parent::bootstrap();
    $this->addPlugin('Authentication');
}

Prior to 3.6.0:

Plugin::load('Authentication');

Add the authentication to the middleware. See the CakePHP documentation on how to usemiddleware if you don’t know what it is or how to work with it.

Example of configuring the authentication middleware using authentication application hook:

use Authentication\AuthenticationService;
use Authentication\AuthenticationServiceProviderInterface;
use Authentication\Middleware\AuthenticationMiddleware;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
 
class Application extends BaseApplication implements AuthenticationServiceProviderInterface
{
 
    /**
     * Returns a service provider instance.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request Request
     * @param \Psr\Http\Message\ResponseInterface $response Response
     * @return \Authentication\AuthenticationServiceInterface
     */
    public function getAuthenticationService(ServerRequestInterface $request, ResponseInterface $response)
    {
        $service = new AuthenticationService();
 
        $fields = [
            'username' => 'email',
            'password' => 'password'
        ];
 
        // Load identifiers
        $service->loadIdentifier('Authentication.Password', compact('fields'));
 
        // Load the authenticators, you want session first
        $service->loadAuthenticator('Authentication.Form', [
            'fields' => $fields,
            'loginUrl' => '/users/login'
        ]);
 
        return $service;
    }
 
    public function middleware($middlewareQueue)
    {
        // Various other middlewares for error handling, routing etc. added here.
 
        // Add the authentication middleware
        $authentication = new AuthenticationMiddleware($this);
 
        // Add the middleware to the middleware queue
        $middlewareQueue->add($authentication);
 
        return $middlewareQueue;
    }
}

If one of the configured authenticators was able to validate the credentials,the middleware will add the authentication service to the request object as anattribute. If you’re not yet familiar with request attributes .

You can use the to access the result ofauthentication, get user identity and logout user. Load the component in yourAppController::initialize() like any other component:

$this->loadComponent('Authentication.Authentication', [
    'logoutRedirect' => '/users/login'  // Default is false
]);

Once loaded, the AuthenticationComponent will require that all actions have anauthenticated user present, but perform no other access control checks. You candisable this check for specific actions using allowUnauthenticated():

// In your controller's beforeFilter method.
$this->Authentication->allowUnauthenticated(['view']);

You can get the authenticated identity data using the authentication component:

$user = $this->Authentication->getIdentity();

You can also get the identity directly from the request instance:

You can check if the authentication process was successful by accessing the resultobject:

// Using Authentication component
$result = $this->Authentication->getResult();
 
// Using request object
$result = $request->getAttribute('authentication')->getResult();
 
if ($result->isValid()) {
    $user = $request->getAttribute('identity');
} else {
    $this->log($result->getStatus());
    $this->log($result->getErrors());
}

ResultInterface::SUCCESS, when successful.
, when identity could not be found.
ResultInterface::FAILURE_CREDENTIALS_INVALID, when credentials are invalid.
ResultInterface::FAILURE_OTHER, on any other kind of failure.
The error array returned by getErrors() contains additional informationcoming from the specific system against which the authentication attempt wasmade. For example LDAP or OAuth would put errors specific to theirimplementation in here for easier logging and debugging the cause. But most ofthe included authenticators don’t put anything in here.

To log an identity out just do:

$this->Authentication->logout();

If you have set the loginRedirect config, willreturn that value else will return false. It won’t perform any actual redirectionin either case.

Alternatively, instead of the component you can also use the request instance to log out:

$return = $request->getAttribute('authentication')->clearIdentity($request, $response);
debug($return);

The debug will show you an array like this:

Note