Classes List

Symfony\Component\Security\Guard\GuardAuthenticatorHandler

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Guard;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
use Symfony\Component\Security\Http\SecurityEvents;

/** * A utility class that does much of the *work* during the guard authentication process. * * By having the logic here instead of the listener, more of the process * can be called directly (e.g. for manual authentication) or overridden. * * @author Ryan Weaver <ryan@knpuniversity.com> * * @final since version 3.4 */
class GuardAuthenticatorHandler
{
    private $tokenStorage;

    private $dispatcher;

    public function __construct(TokenStorageInterface $tokenStorageEventDispatcherInterface $eventDispatcher = null)
    {
        $this->tokenStorage = $tokenStorage;
        $this->dispatcher = $eventDispatcher;
    }

    /** * Authenticates the given token in the system. */
    public function authenticateWithToken(TokenInterface $tokenRequest $request)
    {
        $this->tokenStorage->setToken($token);

        if (null !== $this->dispatcher) {
            $loginEvent = new InteractiveLoginEvent($request$token);
            $this->dispatcher->dispatch(SecurityEvents::INTERACTIVE_LOGIN$loginEvent);
        }
    }

    /** * Returns the "on success" response for the given GuardAuthenticator. * * @param TokenInterface $token * @param Request $request * @param AuthenticatorInterface $guardAuthenticator * @param string $providerKey The provider (i.e. firewall) key * * @return null|Response */
    public function handleAuthenticationSuccess(TokenInterface $tokenRequest $requestGuardAuthenticatorInterface $guardAuthenticator$providerKey)
    {
        $response = $guardAuthenticator->onAuthenticationSuccess($request$token$providerKey);

        // check that it's a Response or null
        if ($response instanceof Response || null === $response) {
            return $response;
        }

        throw new \UnexpectedValueException(sprintf(
            'The %s::onAuthenticationSuccess method must return null or a Response object. You returned %s.',
            get_class($guardAuthenticator),
            is_object($response) ? get_class($response) : gettype($response)
        ));
    }

    /** * Convenience method for authenticating the user and returning the * Response *if any* for success. * * @param UserInterface $user * @param Request $request * @param AuthenticatorInterface $authenticator * @param string $providerKey The provider (i.e. firewall) key * * @return Response|null */
    public function authenticateUserAndHandleSuccess(UserInterface $userRequest $requestGuardAuthenticatorInterface $authenticator$providerKey)
    {
        // create an authenticated token for the User
        $token = $authenticator->createAuthenticatedToken($user$providerKey);
        // authenticate this in the system
        $this->authenticateWithToken($token$request);

        // return the success metric
        return $this->handleAuthenticationSuccess($token$request$authenticator$providerKey);
    }

    /** * Handles an authentication failure and returns the Response for the * GuardAuthenticator. * * @param AuthenticationException $authenticationException * @param Request $request * @param AuthenticatorInterface $guardAuthenticator * @param string $providerKey The key of the firewall * * @return null|Response */
    public function handleAuthenticationFailure(AuthenticationException $authenticationExceptionRequest $requestGuardAuthenticatorInterface $guardAuthenticator$providerKey)
    {
        $response = $guardAuthenticator->onAuthenticationFailure($request$authenticationException);
        if ($response instanceof Response || null === $response) {
            // returning null is ok, it means they want the request to continue
            return $response;
        }

        throw new \UnexpectedValueException(sprintf(
            'The %s::onAuthenticationFailure method must return null or a Response object. You returned %s.',
            get_class($guardAuthenticator),
            is_object($response) ? get_class($response) : gettype($response)
        ));
    }
}