App\Security\Generation2Authenticator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	onAuthenticationFailure()	0	6	1
A	getClient()	0	3	1
A	onAuthenticationSuccess()	0	7	2
A	start()	0	7	1
A	getUser()	0	29	4
A	getCredentials()	0	4	1
A	supports()	0	4	1
A	__construct()	0	10	1

<?php

namespace App\Security;

use App\Entity\User;
use D3strukt0r\OAuth2\Client\Provider\Generation2ResourceOwner;

The type D3strukt0r\OAuth2\Client\Provider\Generation2ResourceOwner was not found. Maybe you did not declare it correctly or list all dependencies?

use Doctrine\ORM\EntityManagerInterface;
use KnpU\OAuth2ClientBundle\Client\ClientRegistry;
use KnpU\OAuth2ClientBundle\Client\OAuth2ClientInterface;
use KnpU\OAuth2ClientBundle\Security\Authenticator\SocialAuthenticator;
use KnpU\OAuth2ClientBundle\Security\User\OAuthUserProvider;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Routing\RouterInterface;
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\Core\User\UserProviderInterface;
use UnexpectedValueException;

class Generation2Authenticator extends SocialAuthenticator
{
    private $clientRegistry;
    private $em;
    private $router;
    private $kernel;

    public function __construct(
        ClientRegistry $clientRegistry,
        EntityManagerInterface $em,
        RouterInterface $router,
        KernelInterface $kernel
    ) {
        $this->clientRegistry = $clientRegistry;
        $this->em = $em;
        $this->router = $router;
        $this->kernel = $kernel;
    }

    /**
     * Returns a response that directs the user to authenticate.
     *
     * This is called when an anonymous request accesses a resource that
     * requires authentication. The job of this method is to return some
     * response that "helps" the user start into the authentication process.
     *
     * Examples:
     *  A) For a form login, you might redirect to the login page
     *      return new RedirectResponse('/login');
     *  B) For an API token authentication system, you return a 401 response
     *      return new Response('Auth header required', 401);
     *
     * @param Request                 $request       The request that resulted in an AuthenticationException
     * @param AuthenticationException $authException The exception that started the authentication process
     *
     * @return Response
     */
    public function start(Request $request, AuthenticationException $authException = null)
    {
        // not called in our app, but if it were, redirecting to the
        // login page makes sense
        $url = $this->router->generate('login');

        return new RedirectResponse($url);
    }

    /**
     * Does the authenticator support the given Request?
     *
     * If this returns false, the authenticator will be skipped.
     *
     * @param Request $request The request
     *
     * @return bool
     */
    public function supports(Request $request)
    {
        // continue ONLY if the URL matches the check URL
        return '/login-check' === $request->getPathInfo();
    }

    /**
     * Get the authentication credentials from the request and return them
     * as any type (e.g. an associate array).
     *
     * Whatever value you return here will be passed to getUser() and checkCredentials()
     *
     * For example, for a form login, you might:
     *
     *      return array(
     *          'username' => $request->request->get('_username'),
     *          'password' => $request->request->get('_password'),
     *      );
     *
     * Or for an API token that's on a header, you might use:
     *
     *      return array('api_key' => $request->headers->get('X-API-TOKEN'));
     *
     * @param Request $request The request
     *
     * @throws UnexpectedValueException If null is returned
     *
     * @return mixed Any non-null value
     */
    public function getCredentials(Request $request)
    {
        // this method is only called if supports() returns true
        return $this->fetchAccessToken($this->getClient());
    }

    /**
     * Return a UserInterface object based on the credentials.
     *
     * The *credentials* are the return value from getCredentials()
     *
     * You may throw an AuthenticationException if you wish. If you return
     * null, then a UsernameNotFoundException is thrown for you.
     *
     * @param mixed                 $credentials  The credentials
     * @param UserProviderInterface $userProvider The user provider
     *
     * @throws AuthenticationException
     *
     * @return UserInterface|null
     */
    public function getUser($credentials, UserProviderInterface $userProvider)
    {
        /** @var OAuthUserProvider $userProvider */

        /** @var Generation2ResourceOwner $originUser */
        $originUser = $this->getClient()->fetchUserFromToken($credentials);

        // 1) have they logged in with Facebook before? Easy!
        $existingUser = $this->em->getRepository('App:User')->findOneBy(['remote_id' => $originUser->getId()]);
        if ($existingUser) {
            if (empty($existingUser->getTokenData()) || unserialize($existingUser->getTokenData()) !== $credentials) {
                $existingUser->setTokenData(serialize($credentials));
                $this->em->flush();
            }

            return $existingUser;
        }

        // 2) Maybe you just want to "register" them by creating
        // a User object
        $user = (new User())
            ->setRemoteId($originUser->getId())
            ->setUsername($originUser->getUsername())
            ->setTokenData(serialize($credentials))
        ;
        $this->em->persist($user);
        $this->em->flush();

        return $user;
    }

    /**
     * Called when authentication executed, but failed (e.g. wrong username password).
     *
     * This should return the Response sent back to the user, like a
     * RedirectResponse to the login page or a 403 response.
     *
     * If you return null, the request will continue, but the user will
     * not be authenticated. This is probably not what you want to do.
     *
     * @param Request                 $request   The request
     * @param AuthenticationException $exception The exception
     *
     * @return Response|null
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        $this->saveAuthenticationErrorToSession($request, $exception);
        $loginUrl = $this->router->generate('login');

        return new RedirectResponse($loginUrl);
    }

    /**
     * Called when authentication executed and was successful!
     *
     * This should return the Response sent back to the user, like a
     * RedirectResponse to the last page they visited.
     *
     * If you return null, the current request will continue, and the user
     * will be authenticated. This makes sense, for example, with an API.
     *
     * @param Request        $request     The request
     * @param TokenInterface $token       The token
     * @param string         $providerKey The provider (i.e. firewall) key
     *
     * @return Response|null
     */
    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        if (!$url = $this->getPreviousUrl($request, $providerKey)) {
            $url = $this->router->generate('index');
        }

        return new RedirectResponse($url);
    }

    /**
     * @return OAuth2ClientInterface
     */
    private function getClient()
    {
        return $this->clientRegistry->getClient('generation2');
    }
}