JWX\JWS\SignatureAlgorithm

Complexity

Total Complexity

4

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	headerParameters()	0	7	2
A	fromJWK()	0	4	1
A	withKeyID()	0	5	1

<?php

declare(strict_types = 1);

namespace Sop\JWX\JWS;

use Sop\JWX\JWK\JWK;
use Sop\JWX\JWS\Algorithm\SignatureAlgorithmFactory;
use Sop\JWX\JWT\Header\Header;
use Sop\JWX\JWT\Header\HeaderParameters;
use Sop\JWX\JWT\Parameter\AlgorithmParameterValue;
use Sop\JWX\JWT\Parameter\KeyIDParameter;

/**
 * Base class for algorithms usable for signing and validating JWS's.
 */
abstract class SignatureAlgorithm implements AlgorithmParameterValue, HeaderParameters
{
    /**
     * ID of the key used by the algorithm.
     *
     * If set, KeyID parameter shall be automatically inserted into JWS's
     * header.
     *
     * @var null|string
     */
    protected $_keyID;

    /**
     * Compute signature.
     *
     * @param string $data Data for which the signature is computed
     *
     * @return string
     */
    abstract public function computeSignature(string $data): string;

    /**
     * Validate signature.
     *
     * @param string $data      Data to validate
     * @param string $signature Signature to compare
     *
     * @return bool
     */
    abstract public function validateSignature(string $data, string $signature): bool;

    /**
     * Initialize signature algorithm from a JWK and a header.
     *
     * @param JWK    $jwk    JSON Web Key
     * @param Header $header Header
     *
     * @return SignatureAlgorithm
     */
    public static function fromJWK(JWK $jwk, Header $header): SignatureAlgorithm
    {
        $factory = new SignatureAlgorithmFactory($header);
        return $factory->algoByKey($jwk);
    }

    /**
     * Get self with key ID.
     *
     * @param null|string $id Key ID or null to remove
     *
     * @return self
     */
    public function withKeyID(?string $id): self
    {
        $obj = clone $this;
        $obj->_keyID = $id;
        return $obj;
    }

    /**
     * {@inheritdoc}
     */
    public function headerParameters(): array
    {
        $params = [];
        if (isset($this->_keyID)) {
            $params[] = new KeyIDParameter($this->_keyID);
        }
        return $params;
    }
}