App\Services\Auth\JwtKeysFetcher

Complexity

Total Complexity

9

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	encodeLength()	0	7	2
A	fetch()	0	8	2
A	createPemFromModulusAndExponent()	0	28	1
A	getByKID()	0	13	3

<?php

namespace App\Services\Auth;

use Carbon\Carbon;
use App\Services\Auth\Contracts\JSONGetter;
use Illuminate\Contracts\Cache\Repository as CacheRepository;
use Lcobucci\JWT\Parsing\Decoder;
use Lcobucci\JWT\Signer\Key;

/**
 * Adapted from the OpenIDConnect Laravel package at
 * https://github.com/furdarius/oidconnect-laravel
 */
class JwtKeysFetcher
{
    /**
     * @var JSONGetter
     */
    private $fetcher;
    /**
     * @var string
     */
    private $jwksURI;
    /**
     * @var Decoder
     */
    private $decoder;
    /**
     * @var CacheRepository
     */
    private $cache;
    /**
     * @var int

Expected "integer" but found "int" for @var tag in member variable comment

     */
    private $cacheHourLimit;
    /**
     * JwtKeysFetcher constructor.
     *
     * @param JSONGetter     $fetcher

Missing parameter comment

Expected 6 spaces after parameter type; 5 found

     * @param CacheRepository $cache

Missing parameter comment

     * @param Decoder         $decoder

Missing parameter comment

     * @param string          $jwksURI

Missing parameter comment

     * @param int             $cacheHourLimit

Missing parameter comment

Expected "integer" but found "int" for parameter type

     */
    public function __construct(JSONGetter $fetcher, CacheRepository $cache, Decoder $decoder, string $jwksURI, int $cacheHourLimit)
    {
        $this->fetcher = $fetcher;
        $this->cache = $cache;
        $this->jwksURI = $jwksURI;
        $this->decoder = $decoder;
        $this->cacheHourLimit = $cacheHourLimit;
    }
    /**
     * Fetch JWK key from JWKs URI with defined kid
     *
     * @param string $kid

Missing parameter comment

     *
     * @return Key|null
     */
    public function getByKID(string $kid)

Method \App\Services\Auth\JwtKeysFetcher::getByKID() does not have return type hint for its return value but it should be possible to add it based on @return annotation "Key|null".

    {
        $cacheKey = 'keys.' . $kid;
        if ($this->cache->has($cacheKey)) {
            return $this->cache->get($cacheKey);
        }
        /** @var Key[] $keys */
        $keys = $this->fetch();
        if (!isset($keys[$kid])) {
            return null;
        }
        $this->cache->put($cacheKey, $keys[$kid], Carbon::now()->addHours($this->cacheHourLimit));
        return $keys[$kid];
    }
    /**
     * Fetch list of JWKs from JWKs URI
     *
     * @return array

@return annotation of method \App\Services\Auth\JwtKeysFetcher::fetch() does not specify type hint for items of its traversable return value.

     */
    public function fetch()

Method \App\Services\Auth\JwtKeysFetcher::fetch() does not have return type hint for its return value but it should be possible to add it based on @return annotation "array".

    {
        $result = [];
        $data = $this->fetcher->get($this->jwksURI);
        foreach ($data['keys'] as $key) {
            $result[$key['kid']] = new Key($this->createPemFromModulusAndExponent($key['n'], $key['e']));
        }
        return $result;
    }
    /**
     *
     * Create a public key represented in PEM format from RSA modulus and exponent information
     *
     * @param string $n the RSA modulus encoded in URL Safe Base64

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param string $e the RSA exponent encoded in URL Safe Base64

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     *
     * @return string the RSA public key represented in PEM format
     */
    protected function createPemFromModulusAndExponent(string $n, string $e)

Method \App\Services\Auth\JwtKeysFetcher::createPemFromModulusAndExponent() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string".

    {
        $modulus = $this->decoder->base64UrlDecode($n);
        $publicExponent = $this->decoder->base64UrlDecode($e);
        $components = [
            'modulus' => pack('Ca*a*', 2, $this->encodeLength(strlen($modulus)), $modulus),
            'publicExponent' => pack('Ca*a*', 2, $this->encodeLength(strlen($publicExponent)), $publicExponent),
        ];
        $RSAPublicKey = pack(
            'Ca*a*a*',
            48,
            $this->encodeLength(strlen($components['modulus']) + strlen($components['publicExponent'])),
            $components['modulus'],
            $components['publicExponent']
        );
        $rsaOID = pack('H*', '300d06092a864886f70d0101010500');
        $RSAPublicKey = chr(0) . $RSAPublicKey;
        $RSAPublicKey = chr(3) . $this->encodeLength(strlen($RSAPublicKey)) . $RSAPublicKey;
        $RSAPublicKey = pack(
            'Ca*a*',
            48,
            $this->encodeLength(strlen($rsaOID . $RSAPublicKey)),
            $rsaOID . $RSAPublicKey
        );
        $RSAPublicKey = "-----BEGIN PUBLIC KEY-----" . PHP_EOL
            . chunk_split(base64_encode($RSAPublicKey), 64, PHP_EOL)
            . '-----END PUBLIC KEY-----';
        return $RSAPublicKey;
    }
    /**
     * DER-encode the length
     *
     * DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4.  See
     * {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3}
     * for more information.
     *
     * @param int $length

Missing parameter comment

Expected "integer" but found "int" for parameter type

     *
     * @return string
     */
    protected function encodeLength(int $length)

Method \App\Services\Auth\JwtKeysFetcher::encodeLength() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string".

    {
        if ($length <= 0x7F) {
            return chr($length);
        }
        $temp = ltrim(pack('N', $length), chr(0));
        return pack('Ca*', 0x80 | strlen($temp), $temp);
    }
}