Majora\Bundle\OAuthServerBundle\Security\AccessTokenAuthenticator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	2
Bugs	1	Features	2

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	getCredentials()	0	29	5
A	getUser()	0	4	1
A	checkCredentials()	0	9	1
A	onAuthenticationSuccess()	0	6	1
A	onAuthenticationFailure()	0	7	1
A	start()	0	7	2
A	supportsRememberMe()	0	4	1

<?php

namespace Majora\Bundle\OAuthServerBundle\Security;

use Majora\Component\OAuth\Exception\InvalidAccessTokenException;
use Majora\Component\OAuth\Server\Server as OAuthServer;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
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 Symfony\Component\Security\Guard\AbstractGuardAuthenticator;

/**
 * AccessToken authenticator class using Guard Symfony component and OAuth server.
 *
 * @link https://knpuniversity.com/screencast/guard/api-token
 */
class AccessTokenAuthenticator extends AbstractGuardAuthenticator
{
    /**
     * @var OAuthServer
     */
    protected $oauthServer;

    /**
     * @var AccessTokenInterface
     */
    protected $currentAccessToken;

    /**
     * Construct.
     *
     * @param OAuthServer $oauthServer
     */
    public function __construct(OAuthServer $oauthServer)
    {
        $this->oauthServer = $oauthServer;
    }

    /**
     * @see GuardAuthenticatorInterface::getCredentials()
     */
    public function getCredentials(Request $request)
    {
        switch (true) {

            // token through query params
            case $request->query->has('access_token') :

There must be no space before the colon in a CASE statement

                $hash = $request->query->get('access_token');
            break;

            // token through headers
            case $request->headers->has('Authorization') :

There must be no space before the colon in a CASE statement

                if (!preg_match('#^Bearer ([\w]+)$#', $request->headers->get('Authorization'), $matches)) {
                    break; // bad Authorization format
                }

                $hash = $matches[1];
            break;

            // otherwise auth failed
            default:
                return;
        }

        try {
            return $this->currentAccessToken = $this->oauthServer->check($hash);

The variable $hash does not seem to be defined for all execution paths leading up to this point.

It seems like $this->oauthServer->check($hash) of type object<Majora\Component\OAuth\Loader\TokenInterface> is incompatible with the declared type object<Majora\Bundle\OAuthServerBundle\Security\AccessTokenInterface> of property $currentAccessToken.

        } catch (InvalidAccessTokenException $e) {
            // log there
        }
    }

    /**
     * @see GuardAuthenticatorInterface::getUser()
     */
    public function getUser($accessToken, UserProviderInterface $userProvider)
    {
        return $accessToken->getAccount();
    }

    /**
     * @see GuardAuthenticatorInterface::checkCredentials()
     */
    public function checkCredentials($accessToken, UserInterface $user)
    {
        // test here if access token is valid (expiration date etc...)
        // or api limit isnt crossed
        // or anonymous allowed
        // etc...

        return true;
    }

    /**
     * @see GuardAuthenticatorInterface::onAuthenticationSuccess()
     */
    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
    {
        $request->query->remove('access_token');
        $request->headers->remove('Authorization');
        $request->attributes->set('access_token', $this->currentAccessToken);
    }

    /**
     * @see GuardAuthenticatorInterface::onAuthenticationFailure()
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        return new JsonResponse(
            array('message' => 'OAuth authentication required.'),
            403
        );
    }

    /**
     * @see GuardAuthenticatorInterface::onAuthenticationFailure()
     */
    public function start(Request $request, AuthenticationException $authException = null)
    {
        return !$authException ? null : new JsonResponse(
            array('message' => 'Invalid OAuth credentials.'),
            401
        );
    }

    /**
     * @see GuardAuthenticatorInterface::supportsRememberMe()
     */
    public function supportsRememberMe()
    {
        return false;
    }
}