App\Services\Auth\OidConnectGuard

Complexity

Total Complexity

23

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	guest()	0	2	1
A	setUser()	0	3	1
A	id()	0	4	2
A	__construct()	0	12	1
A	check()	0	2	1
A	getProvider()	0	3	1
A	validate()	0	10	4
A	setProvider()	0	3	1
A	authenticate()	0	7	2
B	user()	0	51	9

<?php

Missing file doc comment

namespace App\Services\Auth;

use Illuminate\Http\Request;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Auth\AuthenticationException;
use App\Services\Auth\JwtValidator;
use App\Services\Auth\RequestTokenParser;
use App\Services\Auth\Contracts\TokenRefresher;
use App\Exceptions\Auth\TokenStorageException;
use App\Exceptions\Auth\TokenRequestException;

class OidConnectGuard implements Guard {

Missing doc comment for class OidConnectGuard

Opening brace of a class must be on the line after the definition

    protected $request;
    protected $provider;
    protected $requestTokenParser;
    protected $jwtValidator;
    protected $tokenRefresher;

    protected $user;

    /**
     * Set to true when user() has already ran once.
     * @var bool

There must be exactly one blank line before the tags in a doc comment

     */
    protected $userAlreadyAttempted;

    /**
     * Create a new authentication guard.
     *
     *
     * @param UserProvider $provider

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

There must be exactly one blank line before the tags in a doc comment

     * @param RequestTokenParser $requestTokenParser

Missing parameter comment

     * @param JwtValidator $jwtValidator

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param TokenRefresher $tokenRefresher

Expected 5 spaces after parameter type; 1 found

Missing parameter comment

     * @param Request $request

Expected 12 spaces after parameter type; 1 found

Missing parameter comment

     */
    public function __construct(UserProvider $provider,
            RequestTokenParser $requestTokenParser,

Multi-line function declaration not indented correctly; expected 8 spaces but found 12

            JwtValidator $jwtValidator,

Multi-line function declaration not indented correctly; expected 8 spaces but found 12

            TokenRefresher $tokenRefresher,

Multi-line function declaration not indented correctly; expected 8 spaces but found 12

            Request $request) {

Multi-line function declaration not indented correctly; expected 8 spaces but found 12

The closing parenthesis of a multi-line function declaration must be on a new line

        $this->request = $request;
        $this->provider = $provider;
        $this->requestTokenParser = $requestTokenParser;
        $this->jwtValidator = $jwtValidator;
        $this->tokenRefresher = $tokenRefresher;
        $this->user = NULL;

TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.

        $this->userAlreadyAttempted = false;
    }

    /**
     * Determine if the current user is authenticated.
     *
     * @return bool
     */
    public function check() {
        return !is_null($this->user());
    }

    /**
     * Determine if the current user is a guest.
     *
     * @return bool
     */
    public function guest() {
        return !$this->check();
    }

    /**
     * Get the ID for the currently authenticated user.
     *
     * @return int|null
     */
    public function id()
    {
        if ($this->user()) {
            return $this->user()->getAuthIdentifier();
        }
    }

    /**
     * Set the current user.
     *
     * @param  \Illuminate\Contracts\Auth\Authenticatable  $user

Expected 1 spaces after parameter type; 2 found

Missing parameter comment

     * @return void

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setUser(Authenticatable $user)
    {
        $this->user = $user;
    }

    public function user() {

Missing doc comment for function user()

        // If we've already retrieved the user for the current request we can just
        // return it back immediately. We do not want to fetch the user data on
        // every call to this method because that would be tremendously slow.
        if (! is_null($this->user) || $this->userAlreadyAttempted) {
            return $this->user;
        }

        $this->userAlreadyAttempted = true;
        $user = null;

        try {
            $idToken = $this->requestTokenParser->parse($this->request);
        } catch (AuthenticationException $exception) {
            //Return a null user is enough, swallow the exception here
            debugbar()->warning($exception->getMessage());
            return $user;
        }

        if (!$this->jwtValidator->claimsAreValid($idToken) ||
                !$this->jwtValidator->signatureIsValid($idToken)) {

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

Multi-line IF statement not indented correctly; expected 12 spaces but found 16

            debugbar()->warning("Bearer token exists but is not valid");
            return $user;
        }

        //At this point, token is definitely valid
        if ($this->jwtValidator->isExpired($idToken)) {
            debugbar()->info("Id token expired");

            $iss = $idToken->getClaim("iss");
            $sub = $idToken->getClaim("sub");
            try {
                $idToken = $this->tokenRefresher->refreshIDToken($iss, $sub);
                debugbar()->info("Refreshed id token");

            } catch (TokenStorageException $storageException) {
                debugbar()->warning($storageException->getMessage());
                return $user;
            } catch (TokenRequestException $requestException) {
                debugBar()->warning($requestException->getMessage());
                return $user;
            }
            $this->requestTokenParser->save($idToken);
        }

        $credentials = $idToken->getClaims();

        $user = $this->provider->retrieveByCredentials($credentials);

        $this->user = $user;
        return $user;
    }

    public function validate(array $credentials = array()): bool {

Missing doc comment for function validate()

        debugbar()->info("in Guard.validate()");
        if (empty($credentials['id_token'])) {
            return false;
        }
        $token = $this->requestTokenParser->parseFromString($credentials['id_token']);

The assignment to $token is dead and can be removed.

        return $this->jwtValidator->claimsAreValid($idToken) &&

The variable $idToken seems to be never defined.

            !$this->jwtValidator->isExpired($idToken) &&
            $this->jwtValidator->signatureIsValid($idToken);
    }

    /**
     * Get the user provider used by the guard.
     *
     * @return \Illuminate\Contracts\Auth\UserProvider
     */
    public function getProvider()
    {
        return $this->provider;
    }

    /**
     * Set the user provider used by the guard.
     *
     * @param  \Illuminate\Contracts\Auth\UserProvider  $provider

Expected 1 spaces after parameter type; 2 found

Missing parameter comment

     * @return void

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setProvider(UserProvider $provider)
    {
        $this->provider = $provider;
    }

    /**
     * Determine if the current user is authenticated.
     *
     * @return \Illuminate\Contracts\Auth\Authenticatable
     *
     * @throws \Illuminate\Auth\AuthenticationException
     */
    public function authenticate()
    {
        if (! is_null($user = $this->user())) {
            return $user;
        }

        throw new AuthenticationException;
    }
}