Charcoal\User\Service\JWTHandler

Complexity

Total Complexity

20

Size/Duplication

Total Lines	210
Duplicated Lines	14.76 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	generateTokenForUserId()	0	7	1
A	getTokenFromRequest()	0	17	3
A	isTokenValid()	0	12	3
A	getUserIdFromToken()	0	10	2
A	createBuilder()	0	12	1
A	createParser()	0	4	1
A	createSigner()	0	4	1
A	createValidationData()	0	8	1
A	loadPrivateKey()	15	15	3
A	loadPublicKey()	16	16	3

<?php

namespace Charcoal\User\Service;

use Exception;

// From psr/http-message (PSR-7)
use Psr\Http\Message\ServerRequestInterface as Request;

// From lcobucci/jwt
use Lcobucci\JWT\Builder;
use Lcobucci\JWT\Parser;
use Lcobucci\JWT\Signer\Rsa\Sha256;
use Lcobucci\JWT\Token;
use Lcobucci\JWT\ValidationData;

use Charcoal\User\Config\JWTConfig;

/**
 * Helper class to generate tokens for user and retrieve tokens from request.
 */
class JWTHandler
{
    /**
     * @var Builder
     */
    private $builder;

    /**
     * @var \Lcobucci\JWT\Signer
     */
    private $signer;

    /**
     * @var Parser
     */
    private $parser;

    /**
     * @var ValidationData
     */
    private $validationData;

    /**
     * @var string
     */
    private $privateKey;

    /**
     * @var string
     */
    private $publicKey;

    /**
     * @param JWTConfig $config The auth / JWT configuration.
     */
    public function __construct(JWTConfig $config)
    {
        $this->builder = $this->createBuilder($config);
        $this->signer = $this->createSigner();
        $this->parser = $this->createParser();
        $this->validationData = $this->createValidationData($config);
        $this->privateKey = $this->loadPrivateKey($config);
        $this->publicKey = $this->loadPublicKey($config);
    }

    /**
     * Builds and signs a token with a "uid" claim.
     *
     * @param string $userId The user to generate the token for.
     * @return Token
     */
    public function generateTokenForUserId($userId)
    {
        return $this->builder

The method Lcobucci\JWT\Builder::set() has been deprecated with message: This method will be removed on v4, use with() instead

The method Lcobucci\JWT\Builder::sign() has been deprecated with message: This method will be removed on v4, signature will be created on the getToken() method

            ->set('uid', $userId)
            ->sign($this->signer, $this->privateKey)
            ->getToken();
    }

    /**
     * Retrieves, parses and validates the token from request's HTTP_AUTHORIZATION header.
     *
     * @param Request $request A PSR-7 Request.
     * @throws Exception If there is no authorization headers in request or the token is invalid.
     * @return Token
     */
    public function getTokenFromRequest(Request $request)
    {
        $headers = $request->getHeaders();
        if (!isset($headers['HTTP_AUTHORIZATION'])) {
            throw new Exception(
                'No authorization (HTTP_AUTHORIZATION) in request headers.'
            );
        }
        $bearer = str_replace('Bearer ', '', $headers['HTTP_AUTHORIZATION'][0]);
        $token = $this->parser->parse($bearer);
        if ($this->isTokenValid($token) === false) {
            throw new Exception(
                'Invalid JWT token.'
            );
        }
        return $token;
    }

    /**
     * Validates and verifies a token.
     *
     * @param Token $token The token to validate and verify.
     * @return boolean
     */
    public function isTokenValid(Token $token)
    {
        if ($token->validate($this->validationData) !== true) {

The method Lcobucci\JWT\Token::validate() has been deprecated with message: This method will be removed on v4, new validation API should be used

            return false;
        }

        if ($token->verify($this->signer, $this->publicKey) !== true) {

The method Lcobucci\JWT\Token::verify() has been deprecated with message: This method will be removed on v4, new validation API should be used

            return false;
        }

        return true;
    }

    /**
     * Retrieves the uid claim (user id) from a token.
     *
     * @param Token $token The Token to load the user from.
     * @throws Exception If the token does not have a user (uid claim) or the user can not be loaded.
     * @return string
     */
    public function getUserIdFromToken(Token $token)
    {
        if ($token->getClaim('uid') === null) {

The method Lcobucci\JWT\Token::getClaim() has been deprecated with message: This method will be removed on v4

            throw new Exception(
                'Invalid Token. No user (uid claim).'
            );
        }

        return $token->getClaim('uid');

The method Lcobucci\JWT\Token::getClaim() has been deprecated with message: This method will be removed on v4

    }

    /**
     * @param JWTConfig $config The JWT / auth configuration.
     * @return Builder
     */
    private function createBuilder(JWTConfig $config)
    {
        $builder = new Builder();
        $builder

The method Lcobucci\JWT\Builder::setIssuer() has been deprecated with message: This method will be removed on v4, use issuedBy() instead

The method Lcobucci\JWT\Builder::setAudience() has been deprecated with message: This method will be removed on v4, use canOnlyBeUsedBy() instead

            ->setIssuer($config['issuer'])
            ->setAudience($config['audience'])
            ->setId($config['id'], true)
            ->setIssuedAt(time())
            ->setNotBefore(time())
            ->setExpiration((time() + $config['expiration']));
        return $builder;
    }

    /**
     * @return Parser
     */
    private function createParser()
    {
        return new Parser();
    }

    /**
     * @return \Lcobucci\JWT\Signer
     */
    private function createSigner()
    {
        return new Sha256();
    }

    /**
     * @param JWTConfig $config The JWT / auth configuration.
     * @return ValidationData
     */
    private function createValidationData(JWTConfig $config)
    {
        $validationData = new ValidationData();

The class Lcobucci\JWT\ValidationData has been deprecated with message: This class will be removed on v4, new validation API should be used

        $validationData->setIssuer($config['issuer']);
        $validationData->setAudience($config['audience']);
        $validationData->setId($config['id']);
        return $validationData;
    }

    /**
     * @param JWTConfig $config The JWT / auth configuration.
     * @throws Exception If the key is not set in config or not a string.
     * @return string
     */
    private function loadPrivateKey(JWTConfig $config)

This method seems to be duplicated in your project.

    {
        if (!isset($config['privateKey'])) {
            throw new Exception(
                'JWT authentication configuration requires a private key.'
            );
        }
        $keyFile = $config['privateKey'];
        if (!file_exists($keyFile)) {
            throw new Exception(
                sprintf('JWT private key file "%s" does not exist.', $keyFile)
            );
        }
        return file_get_contents($keyFile);
    }

    /**
     * @param JWTConfig $config The JWT / auth configuration.
     * @throws Exception If the key is not set in config or not a string.
     * @return string
     */
    private function loadPublicKey(JWTConfig $config)

This method seems to be duplicated in your project.

    {
        if (!isset($config['publicKey'])) {
            throw new Exception(
                'JWT authentication configuration requires a public key.'
            );
        }

        $keyFile = $config['publicKey'];
        if (!file_exists($keyFile)) {
            throw new Exception(
                sprintf('JWT public key file "%s" does not exist.', $keyFile)
            );
        }
        return file_get_contents($keyFile);
    }
}