RSAESKeyAlgorithm::__construct() - Code Metrics - sop/jwx - Measure and Improve Code Quality continuously with Scrutinizer

RSAESKeyAlgorithm::__construct() A
last analyzed 2022-09-07 10:08 UTC

↳ Parent: RSAESKeyAlgorithm

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?php

declare(strict_types = 1);

namespace Sop\JWX\JWE\KeyAlgorithm;

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\RSA\RSAPrivateKeyJWK;
use Sop\JWX\JWK\RSA\RSAPublicKeyJWK;
use Sop\JWX\JWT\Header\Header;
use Sop\JWX\JWT\Parameter\AlgorithmParameter;

/**
 * Base class for algorithms implementing RSA based key encryption.
 *
 * @see https://tools.ietf.org/html/rfc7518#section-4.2
 * @see https://tools.ietf.org/html/rfc7518#section-4.3
 */
abstract class RSAESKeyAlgorithm extends KeyManagementAlgorithm
{
    use RandomCEK;

    /**
     * Mapping from algorithm name to class name.
     *
     * @internal
     *
     * @var array
     */
    public const MAP_ALGO_TO_CLASS = [
        JWA::ALGO_RSA1_5 => RSAESPKCS1Algorithm::class,
        JWA::ALGO_RSA_OAEP => RSAESOAEPAlgorithm::class,
    ];

    /**
     * Public key.
     *
     * @var RSAPublicKeyJWK
     */
    protected $_publicKey;

    /**
     * Private key.
     *
     * @var null|RSAPrivateKeyJWK
     */
    protected $_privateKey;

    /**
     * Constructor.
     *
     * Use `fromPublicKey` or `fromPrivateKey` instead!
     *
     * @param RSAPublicKeyJWK  $pub_key  RSA public key
     * @param RSAPrivateKeyJWK $priv_key Optional RSA private key
     */
    protected function __construct(RSAPublicKeyJWK $pub_key,
        ?RSAPrivateKeyJWK $priv_key = null)
    {
        $this->_publicKey = $pub_key;
        $this->_privateKey = $priv_key;
    }

    /**
     * Initialize from JWK.
     *
     * @throws \UnexpectedValueException
     *
     * @return self
     */
    public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm
    {
        $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];
        if ($jwk->has(...RSAPrivateKeyJWK::MANAGED_PARAMS)) {
            return $cls::fromPrivateKey(RSAPrivateKeyJWK::fromJWK($jwk));
        }
        return $cls::fromPublicKey(RSAPublicKeyJWK::fromJWK($jwk));
    }

    /**
     * Initialize from a public key.
     */
    public static function fromPublicKey(RSAPublicKeyJWK $jwk): self
    {
        return new static($jwk);
    }

    /**
     * Initialize from a private key.
     */
    public static function fromPrivateKey(RSAPrivateKeyJWK $jwk): self
    {
        return new static($jwk->publicKey(), $jwk);
    }

    /**
     * Get the public key.
     */
    public function publicKey(): RSAPublicKeyJWK
    {
        return $this->_publicKey;
    }

    /**
     * Check whether the private key is present.
     */
    public function hasPrivateKey(): bool
    {
        return isset($this->_privateKey);
    }

    /**
     * Get the private key.
     *
     * @throws \LogicException
     */
    public function privateKey(): RSAPrivateKeyJWK
    {
        if (!$this->hasPrivateKey()) {
            throw new \LogicException('Private key not set.');
        }
        return $this->_privateKey;
    }

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

    /**
     * Get the padding scheme.
     */
    abstract protected function _paddingScheme(): int;

    /**
     * {@inheritdoc}
     */
    protected function _encryptKey(string $key, Header &$header): string
    {
        $pubkey = openssl_pkey_get_public(
            $this->publicKey()->toPEM()->string());
        if (false === $pubkey) {
            throw new \RuntimeException(
                'openssl_pkey_get_public() failed: ' .
                     $this->_getLastOpenSSLError());
        }
        $result = openssl_public_encrypt($key, $crypted, $pubkey,
            $this->_paddingScheme());
        if (!$result) {
            throw new \RuntimeException(
                'openssl_public_encrypt() failed: ' .
                     $this->_getLastOpenSSLError());
        }
        return $crypted;
    }

    /**
     * {@inheritdoc}
     */
    protected function _decryptKey(string $ciphertext, Header $header): string
    {
        $privkey = openssl_pkey_get_private(
            $this->privateKey()->toPEM()->string());
        if (false === $privkey) {
            throw new \RuntimeException(
                'openssl_pkey_get_private() failed: ' .
                     $this->_getLastOpenSSLError());
        }
        $result = openssl_private_decrypt($ciphertext, $cek, $privkey,
            $this->_paddingScheme());
        if (!$result) {
            throw new \RuntimeException(
                'openssl_private_decrypt() failed: ' .
                     $this->_getLastOpenSSLError());
        }
        return $cek;
    }

    /**
     * Get last OpenSSL error message.
     */
    protected function _getLastOpenSSLError(): ?string
    {
        $msg = null;
        while (false !== ($err = openssl_error_string())) {
            $msg = $err;
        }
        return $msg;
    }
}


1		<?php
2
3		declare(strict_types = 1);
4
5		namespace Sop\JWX\JWE\KeyAlgorithm;
6
7		use Sop\JWX\JWA\JWA;
8		use Sop\JWX\JWE\KeyAlgorithm\Feature\RandomCEK;
9		use Sop\JWX\JWE\KeyManagementAlgorithm;
10		use Sop\JWX\JWK\JWK;
11		use Sop\JWX\JWK\RSA\RSAPrivateKeyJWK;
12		use Sop\JWX\JWK\RSA\RSAPublicKeyJWK;
13		use Sop\JWX\JWT\Header\Header;
14		use Sop\JWX\JWT\Parameter\AlgorithmParameter;
15
16		/**
17		* Base class for algorithms implementing RSA based key encryption.
18		*
19		* @see https://tools.ietf.org/html/rfc7518#section-4.2
20		* @see https://tools.ietf.org/html/rfc7518#section-4.3
21		*/
22		abstract class RSAESKeyAlgorithm extends KeyManagementAlgorithm
23		{
24		use RandomCEK;
25
26		/**
27		* Mapping from algorithm name to class name.
28		*
29		* @internal
30		*
31		* @var array
32		*/
33		public const MAP_ALGO_TO_CLASS = [
34		JWA::ALGO_RSA1_5 => RSAESPKCS1Algorithm::class,
35		JWA::ALGO_RSA_OAEP => RSAESOAEPAlgorithm::class,
36		];
37
38		/**
39		* Public key.
40		*
41		* @var RSAPublicKeyJWK
42		*/
43		protected $_publicKey;
44
45		/**
46		* Private key.
47		*
48		* @var null\|RSAPrivateKeyJWK
49		*/
50		protected $_privateKey;
51
52		/**
53		* Constructor.
54		*
55		* Use `fromPublicKey` or `fromPrivateKey` instead!
56		*
57		* @param RSAPublicKeyJWK $pub_key RSA public key
58		* @param RSAPrivateKeyJWK $priv_key Optional RSA private key
59		*/
60	18	protected function __construct(RSAPublicKeyJWK $pub_key,
61		?RSAPrivateKeyJWK $priv_key = null)
62		{
63	18	$this->_publicKey = $pub_key;
64	18	$this->_privateKey = $priv_key;
65	18	}
66
67		/**
68		* Initialize from JWK.
69		*
70		* @throws \UnexpectedValueException
71		*
72		* @return self
73		*/
74	3	public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm
75		{
76	3	$alg = JWA::deriveAlgorithmName($header, $jwk);
77	3	if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) {
78	1	throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'.");
79		}
80	2	$cls = self::MAP_ALGO_TO_CLASS[$alg];
81	2	if ($jwk->has(...RSAPrivateKeyJWK::MANAGED_PARAMS)) {
82	1	return $cls::fromPrivateKey(RSAPrivateKeyJWK::fromJWK($jwk));
83		}
84	1	return $cls::fromPublicKey(RSAPublicKeyJWK::fromJWK($jwk));
85		}
86
87		/**
88		* Initialize from a public key.
89		*/
90	3	public static function fromPublicKey(RSAPublicKeyJWK $jwk): self
91		{
92	3	return new static($jwk);
93		}
94
95		/**
96		* Initialize from a private key.
97		*/
98	15	public static function fromPrivateKey(RSAPrivateKeyJWK $jwk): self
99		{
100	15	return new static($jwk->publicKey(), $jwk);
101		}
102
103		/**
104		* Get the public key.
105		*/
106	11	public function publicKey(): RSAPublicKeyJWK
107		{
108	11	return $this->_publicKey;
109		}
110
111		/**
112		* Check whether the private key is present.
113		*/
114	13	public function hasPrivateKey(): bool
115		{
116	13	return isset($this->_privateKey);
117		}
118
119		/**
120		* Get the private key.
121		*
122		* @throws \LogicException
123		*/
124	12	public function privateKey(): RSAPrivateKeyJWK
125		{
126	12	if (!$this->hasPrivateKey()) {
127	1	throw new \LogicException('Private key not set.');
128		}
129	11	return $this->_privateKey;
130		}
131
132		/**
133		* {@inheritdoc}
134		*/
135	3	public function headerParameters(): array
136		{
137	3	return array_merge(parent::headerParameters(),
138	3	[AlgorithmParameter::fromAlgorithm($this)]);
139		}
140
141		/**
142		* Get the padding scheme.
143		*/
144		abstract protected function _paddingScheme(): int;
145
146		/**
147		* {@inheritdoc}
148		*/
149	10	protected function _encryptKey(string $key, Header &$header): string
150		{
151	10	$pubkey = openssl_pkey_get_public(
152	10	$this->publicKey()->toPEM()->string());
153	10	if (false === $pubkey) {
154	1	throw new \RuntimeException(
155		'openssl_pkey_get_public() failed: ' .
156	1	$this->_getLastOpenSSLError());
157		}
158	9	$result = openssl_public_encrypt($key, $crypted, $pubkey,
159	9	$this->_paddingScheme());
160	9	if (!$result) {
161	1	throw new \RuntimeException(
162		'openssl_public_encrypt() failed: ' .
163	1	$this->_getLastOpenSSLError());
164		}
165	8	return $crypted;
166		}
167
168		/**
169		* {@inheritdoc}
170		*/
171	10	protected function _decryptKey(string $ciphertext, Header $header): string
172		{
173	10	$privkey = openssl_pkey_get_private(
174	10	$this->privateKey()->toPEM()->string());
175	10	if (false === $privkey) {
176	1	throw new \RuntimeException(
177		'openssl_pkey_get_private() failed: ' .
178	1	$this->_getLastOpenSSLError());
179		}
180	9	$result = openssl_private_decrypt($ciphertext, $cek, $privkey,
181	9	$this->_paddingScheme());
182	9	if (!$result) {
183	1	throw new \RuntimeException(
184		'openssl_private_decrypt() failed: ' .
185	1	$this->_getLastOpenSSLError());
186		}
187	8	return $cek;
188		}
189
190		/**
191		* Get last OpenSSL error message.
192		*/
193	4	protected function _getLastOpenSSLError(): ?string
194		{
195	4	$msg = null;
196	4	while (false !== ($err = openssl_error_string())) {
197	4	$msg = $err;
198		}
199	4	return $msg;
200		}
201		}
202

sop / jwx

GitHub Access Token became invalid

RSAESKeyAlgorithm::__construct() A last analyzed 2022-09-07 10:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RSAESKeyAlgorithm::__construct() A
last analyzed 2022-09-07 10:08 UTC