Sop\JWX\JWK\TypedJWK

Complexity

Total Complexity

48

Size/Duplication

Total Lines	493
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

47 Methods

Rating	Name	Duplication	Size	Complexity
A	otherPrimesInfoParameter()	0	4	1
A	curveParameter()	0	4	1
A	publicKeyUseParameter()	0	4	1
A	secondPrimeFactorParameter()	0	4	1
A	hasPrivateExponentParameter()	0	3	1
A	hasAlgorithmParameter()	0	3	1
A	modulusParameter()	0	4	1
A	hasFirstPrimeFactorParameter()	0	3	1
A	hasX509CertificateChainParameter()	0	3	1
A	hasExponentParameter()	0	3	1
A	keyIDParameter()	0	4	1
A	XCoordinateParameter()	0	4	1
A	hasX509URLParameter()	0	3	1
A	hasCurveParameter()	0	3	1
A	hasOtherPrimesInfoParameter()	0	3	1
A	privateExponentParameter()	0	4	1
A	hasSecondPrimeFactorParameter()	0	3	1
A	X509CertificateChainParameter()	0	4	1
A	X509CertificateSHA1ThumbprintParameter()	0	4	1
A	hasFirstCRTCoefficientParameter()	0	3	1
A	hasYCoordinateParameter()	0	3	1
A	hasKeyValueParameter()	0	3	1
A	algorithmParameter()	0	4	1
A	hasKeyIDParameter()	0	3	1
A	hasSecondFactorCRTExponentParameter()	0	3	1
A	ECCPrivateKeyParameter()	0	4	1
A	X509URLParameter()	0	4	1
A	hasFirstFactorCRTExponentParameter()	0	3	1
A	hasPublicKeyUseParameter()	0	3	1
A	exponentParameter()	0	4	1
A	firstPrimeFactorParameter()	0	4	1
A	hasKeyTypeParameter()	0	3	1
A	secondFactorCRTExponentParameter()	0	4	1
A	firstFactorCRTExponentParameter()	0	4	1
A	keyTypeParameter()	0	4	1
A	_checkType()	0	7	2
A	hasX509CertificateSHA1ThumbprintParameter()	0	3	1
A	keyOperationsParameter()	0	4	1
A	hasECCPrivateKeyParameter()	0	3	1
A	hasXCoordinateParameter()	0	3	1
A	YCoordinateParameter()	0	4	1
A	X509CertificateSHA256ThumbprintParameter()	0	4	1
A	hasModulusParameter()	0	3	1
A	keyValueParameter()	0	4	1
A	hasX509CertificateSHA256ThumbprintParameter()	0	3	1
A	firstCRTCoefficientParameter()	0	4	1
A	hasKeyOperationsParameter()	0	3	1

<?php

declare(strict_types = 1);

namespace Sop\JWX\JWK;

use Sop\JWX\JWK\Parameter\JWKParameter;

/**
 * Trait for JWK to provide parameter accessor methods for typed return values.
 */
trait TypedJWK
{
    /**
     * Whether parameters are present.
     *
     * @param string ...$names Parameter names
     */
    abstract public function has(string ...$names): bool;

    /**
     * Get a parameter.
     *
     * @param string $name Parameter name
     */
    abstract public function get(string $name): JWKParameter;

    /**
     * Check whether the algorithm parameter is present.
     */
    public function hasAlgorithmParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_ALG);
    }

    /**
     * Get the algorithm parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function algorithmParameter(): Parameter\AlgorithmParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_ALG),
            Parameter\AlgorithmParameter::class);
    }

    /**
     * Check whether the curve parameter is present.
     */
    public function hasCurveParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_CRV);
    }

    /**
     * Get the curve parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function curveParameter(): Parameter\CurveParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_CRV),
            Parameter\CurveParameter::class);
    }

    /**
     * Check whether the ECC private key parameter is present.
     */
    public function hasECCPrivateKeyParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_ECC_D);
    }

    /**
     * Get the ECC private key parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function ECCPrivateKeyParameter(): Parameter\ECCPrivateKeyParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_ECC_D),
            Parameter\ECCPrivateKeyParameter::class);
    }

    /**
     * Check whether the exponent parameter is present.
     */
    public function hasExponentParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_E);
    }

    /**
     * Get the exponent parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function exponentParameter(): Parameter\ExponentParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_E),
            Parameter\ExponentParameter::class);
    }

    /**
     * Check whether the first CRT coefficient parameter is present.
     */
    public function hasFirstCRTCoefficientParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_QI);
    }

    /**
     * Get the first CRT coefficient parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function firstCRTCoefficientParameter(): Parameter\FirstCRTCoefficientParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_QI),
            Parameter\FirstCRTCoefficientParameter::class);
    }

    /**
     * Check whether the first factor CRT exponent parameter is present.
     */
    public function hasFirstFactorCRTExponentParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_DP);
    }

    /**
     * Get the first factor CRT exponent parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function firstFactorCRTExponentParameter(): Parameter\FirstFactorCRTExponentParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_DP),
            Parameter\FirstFactorCRTExponentParameter::class);
    }

    /**
     * Check whether the first prime factor parameter is present.
     */
    public function hasFirstPrimeFactorParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_P);
    }

    /**
     * Get the first prime factor parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function firstPrimeFactorParameter(): Parameter\FirstPrimeFactorParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_P),
            Parameter\FirstPrimeFactorParameter::class);
    }

    /**
     * Check whether the key ID parameter is present.
     */
    public function hasKeyIDParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_KID);
    }

    /**
     * Get the key ID parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function keyIDParameter(): Parameter\KeyIDParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_KID),
            Parameter\KeyIDParameter::class);
    }

    /**
     * Check whether the key operations parameter is present.
     */
    public function hasKeyOperationsParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_KEY_OPS);
    }

    /**
     * Get the key operations parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function keyOperationsParameter(): Parameter\KeyOperationsParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_KEY_OPS),
            Parameter\KeyOperationsParameter::class);
    }

    /**
     * Check whether the key type parameter is present.
     */
    public function hasKeyTypeParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_KTY);
    }

    /**
     * Get the key type parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function keyTypeParameter(): Parameter\KeyTypeParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_KTY),
            Parameter\KeyTypeParameter::class);
    }

    /**
     * Check whether the key value parameter is present.
     */
    public function hasKeyValueParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_K);
    }

    /**
     * Get the key value parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function keyValueParameter(): Parameter\KeyValueParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_K),
            Parameter\KeyValueParameter::class);
    }

    /**
     * Check whether the modulus parameter is present.
     */
    public function hasModulusParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_N);
    }

    /**
     * Get the modulus parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function modulusParameter(): Parameter\ModulusParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_N),
            Parameter\ModulusParameter::class);
    }

    /**
     * Check whether the other primes info parameter is present.
     */
    public function hasOtherPrimesInfoParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_OTH);
    }

    /**
     * Get the other primes info parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function otherPrimesInfoParameter(): Parameter\OtherPrimesInfoParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_OTH),
            Parameter\OtherPrimesInfoParameter::class);
    }

    /**
     * Check whether the private exponent parameter is present.
     */
    public function hasPrivateExponentParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_RSA_D);
    }

    /**
     * Get the private exponent parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function privateExponentParameter(): Parameter\PrivateExponentParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_RSA_D),
            Parameter\PrivateExponentParameter::class);
    }

    /**
     * Check whether the public key use parameter is present.
     */
    public function hasPublicKeyUseParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_USE);
    }

    /**
     * Get the public key use parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function publicKeyUseParameter(): Parameter\PublicKeyUseParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_USE),
            Parameter\PublicKeyUseParameter::class);
    }

    /**
     * Check whether the second factor CRT exponent parameter is present.
     */
    public function hasSecondFactorCRTExponentParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_DQ);
    }

    /**
     * Get the second factor CRT exponent parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function secondFactorCRTExponentParameter(): Parameter\SecondFactorCRTExponentParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_DQ),
            Parameter\SecondFactorCRTExponentParameter::class);
    }

    /**
     * Check whether the second prime factor parameter is present.
     */
    public function hasSecondPrimeFactorParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_Q);
    }

    /**
     * Get the second prime factor parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function secondPrimeFactorParameter(): Parameter\SecondPrimeFactorParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_Q),
            Parameter\SecondPrimeFactorParameter::class);
    }

    /**
     * Check whether the X.509 certificate chain parameter is present.
     */
    public function hasX509CertificateChainParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_X5C);
    }

    /**
     * Get the X.509 certificate chain parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function X509CertificateChainParameter(): Parameter\X509CertificateChainParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_X5C),
            Parameter\X509CertificateChainParameter::class);
    }

    /**
     * Check whether the X.509 certificate SHA-1 thumbprint parameter is
     * present.
     */
    public function hasX509CertificateSHA1ThumbprintParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_X5T);
    }

    /**
     * Get the X.509 certificate SHA-1 thumbprint parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function X509CertificateSHA1ThumbprintParameter(): Parameter\X509CertificateSHA1ThumbprintParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_X5T),
            Parameter\X509CertificateSHA1ThumbprintParameter::class);
    }

    /**
     * Check whether the X.509 certificate SHA-256 thumbprint parameter is
     * present.
     */
    public function hasX509CertificateSHA256ThumbprintParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_X5TS256);
    }

    /**
     * Get the X.509 certificate SHA-256 thumbprint parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function X509CertificateSHA256ThumbprintParameter(): Parameter\X509CertificateSHA256ThumbprintParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_X5TS256),
            Parameter\X509CertificateSHA256ThumbprintParameter::class);
    }

    /**
     * Check whether the X.509 URL parameter is present.
     */
    public function hasX509URLParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_X5U);
    }

    /**
     * Get the X.509 URL parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function X509URLParameter(): Parameter\X509URLParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_X5U),
            Parameter\X509URLParameter::class);
    }

    /**
     * Check whether the X coordinate parameter is present.
     */
    public function hasXCoordinateParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_X);
    }

    /**
     * Get the X coordinate parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function XCoordinateParameter(): Parameter\XCoordinateParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_X),
            Parameter\XCoordinateParameter::class);
    }

    /**
     * Check whether the Y coordinate parameter is present.
     */
    public function hasYCoordinateParameter(): bool
    {
        return $this->has(Parameter\JWKParameter::P_Y);
    }

    /**
     * Get the Y coordinate parameter.
     *
     * @throws \UnexpectedValueException If the parameter has a wrong class
     * @throws \LogicException           If the parameter is not present
     */
    public function YCoordinateParameter(): Parameter\YCoordinateParameter
    {
        return self::_checkType($this->get(Parameter\JWKParameter::P_Y),
            Parameter\YCoordinateParameter::class);
    }

    /**
     * Check that the parameter is an instance of the given class.
     *
     * @param Parameter\JWKParameter $param Parameter
     * @param string                 $cls   Class name
     *
     * @throws \UnexpectedValueException
     */
    private static function _checkType(Parameter\JWKParameter $param, string $cls): Parameter\JWKParameter
    {
        if (!$param instanceof $cls) {
            throw new \UnexpectedValueException(
                "{$cls} expected, got " . get_class($param));
        }
        return $param;
    }
}