JWX\JWE\KeyAlgorithm\AESKWAlgorithm

Complexity

Total Complexity

9

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	_decryptKey()	0	3	1
A	_encryptKey()	0	3	1
A	_kw()	0	6	2
A	headerParameters()	0	4	1
A	fromJWK()	0	9	2

<?php

declare(strict_types = 1);

namespace Sop\JWX\JWE\KeyAlgorithm;

use Sop\AESKW\AESKeyWrapAlgorithm;
use Sop\JWX\JWA\JWA;
use Sop\JWX\JWE\KeyAlgorithm\Feature\RandomCEK;
use Sop\JWX\JWE\KeyManagementAlgorithm;
use Sop\JWX\JWK\JWK;
use Sop\JWX\JWK\Symmetric\SymmetricKeyJWK;
use Sop\JWX\JWT\Header\Header;
use Sop\JWX\JWT\Parameter\AlgorithmParameter;

/**
 * Base class for algorithms implementing AES key wrap.
 *
 * @see https://tools.ietf.org/html/rfc7518#section-4.4
 */
abstract class AESKWAlgorithm extends KeyManagementAlgorithm
{
    use RandomCEK;

    /**
     * Mapping from algorithm name to class name.
     *
     * @internal
     *
     * @var array
     */
    const MAP_ALGO_TO_CLASS = [
        JWA::ALGO_A128KW => A128KWAlgorithm::class,
        JWA::ALGO_A192KW => A192KWAlgorithm::class,
        JWA::ALGO_A256KW => A256KWAlgorithm::class,
    ];

    /**
     * Key encryption key.
     *
     * @var string
     */
    protected $_kek;

    /**
     * Key wrapping algorithm.
     *
     * Lazily initialized.
     *
     * @var null|AESKeyWrapAlgorithm
     */
    protected $_kw;

    /**
     * Constructor.
     *
     * @param string $kek Key encryption key
     */
    public function __construct(string $kek)
    {
        if (strlen($kek) !== $this->_kekSize()) {
            throw new \LengthException(
                'Key encryption key must be ' . $this->_kekSize() . ' bytes.');
        }
        $this->_kek = $kek;
    }

    /**
     * Initialize from JWK.
     *
     * @param JWK    $jwk
     * @param Header $header
     *
     * @throws \UnexpectedValueException
     *
     * @return self
     */
    public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm
    {
        $jwk = SymmetricKeyJWK::fromJWK($jwk);
        $alg = JWA::deriveAlgorithmName($header, $jwk);
        if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) {
            throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'.");
        }
        $cls = self::MAP_ALGO_TO_CLASS[$alg];
        return new $cls($jwk->key());
    }

    /**
     * {@inheritdoc}
     */
    public function headerParameters(): array
    {
        return array_merge(parent::headerParameters(),
            [AlgorithmParameter::fromAlgorithm($this)]);
    }

    /**
     * Get the size of the key encryption key in bytes.
     *
     * @return int
     */
    abstract protected function _kekSize(): int;

    /**
     * Get key wrapping algorithm instance.
     *
     * @return AESKeyWrapAlgorithm
     */
    abstract protected function _AESKWAlgo(): AESKeyWrapAlgorithm;

    /**
     * Get key wrapping algorithm.
     *
     * @return AESKeyWrapAlgorithm
     */
    protected function _kw(): AESKeyWrapAlgorithm
    {
        if (!isset($this->_kw)) {
            $this->_kw = $this->_AESKWAlgo();
        }
        return $this->_kw;

The expression return $this->_kw could return the type null which is incompatible with the type-hinted return Sop\AESKW\AESKeyWrapAlgorithm. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    protected function _encryptKey(string $key, Header &$header): string
    {
        return $this->_kw()->wrap($key, $this->_kek);
    }

    /**
     * {@inheritdoc}
     */
    protected function _decryptKey(string $ciphertext, Header $header): string
    {
        return $this->_kw()->unwrap($ciphertext, $this->_kek);
    }
}