JWX\JWE\KeyAlgorithm\RSAESKeyAlgorithm

Complexity

Total Complexity

19

Size/Duplication

Total Lines	180
Duplicated Lines	25 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	0	Features	5

12 Methods

Rating	Name	Duplication	Size	Complexity
	_paddingScheme()	0	1	?
A	__construct()	0	5	1
A	fromJWK()	0	11	3
A	fromPublicKey()	0	3	1
A	fromPrivateKey()	0	3	1
A	publicKey()	0	3	1
A	hasPrivateKey()	0	3	1
A	privateKey()	0	6	2
A	_encryptKey()	19	19	3
A	_decryptKey()	19	19	3
A	_getLastOpenSSLError()	7	7	2
A	headerParameters()	0	3	1

<?php

namespace JWX\JWE\KeyAlgorithm;

use JWX\JWA\JWA;
use JWX\JWE\KeyAlgorithm\Feature\RandomCEK;
use JWX\JWE\KeyManagementAlgorithm;
use JWX\JWK\JWK;
use JWX\JWK\RSA\RSAPrivateKeyJWK;
use JWX\JWK\RSA\RSAPublicKeyJWK;
use JWX\JWT\Header\Header;
use JWX\JWT\Parameter\AlgorithmParameter;


/**
 * Base class for algorithms implementing RSA based key encryption.
 *
 * @link https://tools.ietf.org/html/rfc7518#section-4.2
 * @link https://tools.ietf.org/html/rfc7518#section-4.3
 */
abstract class RSAESKeyAlgorithm extends KeyManagementAlgorithm
{
	use RandomCEK;
	
	/**
	 * Public key.
	 *
	 * @var RSAPublicKeyJWK $_publicKey
	 */
	protected $_publicKey;
	
	/**
	 * Private key.
	 *
	 * @var RSAPrivateKeyJWK|null $_privateKey
	 */
	protected $_privateKey;
	
	/**
	 * Mapping from algorithm name to class name.
	 *
	 * @internal
	 *
	 * @var array
	 */
	const MAP_ALGO_TO_CLASS = array(
		/* @formatter:off */
		JWA::ALGO_RSA1_5 => RSAESPKCS1Algorithm::class,
		JWA::ALGO_RSA_OAEP => RSAESOAEPAlgorithm::class
		/* @formatter:on */
	);
	
	/**
	 * Get the padding scheme.
	 *
	 * @return int
	 */
	abstract protected function _paddingScheme();
	
	/**
	 * Constructor.
	 *
	 * Use <code>fromPublicKey</code> or <code>fromPrivateKey</code> 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;
	}
	
	/**
	 *
	 * @param JWK $jwk
	 * @param Header $header
	 * @throws \UnexpectedValueException
	 * @return RSAESKeyAlgorithm
	 */
	public static function fromJWK(JWK $jwk, Header $header) {
		$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.
	 *
	 * @param RSAPublicKeyJWK $jwk
	 * @return self
	 */
	public static function fromPublicKey(RSAPublicKeyJWK $jwk) {
		return new static($jwk);
	}
	
	/**
	 * Initialize from a private key.
	 *
	 * @param RSAPrivateKeyJWK $jwk
	 * @return self
	 */
	public static function fromPrivateKey(RSAPrivateKeyJWK $jwk) {
		return new static($jwk->publicKey(), $jwk);
	}
	
	/**
	 * Get the public key.
	 *
	 * @return RSAPublicKeyJWK
	 */
	public function publicKey() {
		return $this->_publicKey;
	}
	
	/**
	 * Check whether the private key is present.
	 *
	 * @return bool
	 */
	public function hasPrivateKey() {
		return isset($this->_privateKey);
	}
	
	/**
	 * Get the private key.
	 *
	 * @throws \LogicException
	 * @return RSAPrivateKeyJWK
	 */
	public function privateKey() {
		if (!$this->hasPrivateKey()) {
			throw new \LogicException("Private key not set.");
		}
		return $this->_privateKey;
	}
	
	protected function _encryptKey($key, Header &$header) {

This method seems to be duplicated in your project.

		$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;
	}
	
	protected function _decryptKey($ciphertext, Header $header) {

This method seems to be duplicated in your project.

		$privkey = openssl_pkey_get_private(
			$this->privateKey()
				->toPEM()
				->string());
		if (!$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.
	 *
	 * @return string|null
	 */
	protected function _getLastOpenSSLError() {

This method seems to be duplicated in your project.

		$msg = null;
		while (false !== ($err = openssl_error_string())) {
			$msg = $err;
		}
		return $msg;
	}
	
	public function headerParameters() {
		return array(AlgorithmParameter::fromAlgorithm($this));
	}
}