JWX\JWE\KeyManagementAlgorithm

Complexity

Total Complexity

8

Size/Duplication

Total Lines	115
Duplicated Lines	6.09 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	11
Bugs	1	Features	6

8 Methods

Rating	Name	Duplication	Size	Complexity
	_encryptKey()	0	1	?
	_decryptKey()	0	1	?
A	encrypt()	0	6	2
A	decrypt()	0	6	2
	cekForEncryption()	0	1	?
A	fromJWK()	0	4	1
A	withKeyID()	0	5	1
A	headerParameters()	7	7	2

<?php

namespace JWX\JWE;

use JWX\JWE\KeyAlgorithm\KeyAlgorithmFactory;
use JWX\JWK\JWK;
use JWX\JWT\Header\Header;
use JWX\JWT\Header\HeaderParameters;
use JWX\JWT\Parameter\AlgorithmParameterValue;
use JWX\JWT\Parameter\JWTParameter;
use JWX\JWT\Parameter\KeyIDParameter;


/**
 * Base class for algorithms used for CEK management for the content encryption
 * algorithms.
 */
abstract class KeyManagementAlgorithm implements 
	AlgorithmParameterValue, 

Expected 4 spaces before interface name; 1 found

	HeaderParameters

Expected 4 spaces before interface name; 1 found

{
	/**
	 * ID of the key used by the algorithm.
	 *
	 * If set, KeyID parameter shall be automatically inserted into JWE's
	 * header.
	 *
	 * @var string|null $_keyID
	 */
	protected $_keyID;
	
	/**
	 * Encrypt a key.
	 *
	 * @param string $key Key to be encrypted
	 * @param Header $header Reference to the Header variable, that shall
	 *        be updated to contain parameters specific to the encryption
	 * @return string Ciphertext
	 */
	abstract protected function _encryptKey($key, Header &$header);
	
	/**
	 * Decrypt a key.
	 *
	 * @param string $ciphertext Ciphertext of the encrypted key
	 * @param Header $header Header possibly containing encoding specific
	 *        parameters
	 * @return string Plaintext key
	 */
	abstract protected function _decryptKey($ciphertext, Header $header);
	
	/**
	 * Encrypt a key to be inserted into JWE header.
	 *
	 * @param string $cek Content encryption key
	 * @param Header|null $header Optional reference to the Header variable,
	 *        which may be updated to contain parameters specific to this
	 *        encrypt invocation. If the variable is referenced, but is a null,
	 *        it shall be initialized to an empty Header.
	 * @throws \RuntimeException For generic errors
	 * @return string Encrypted key
	 */
	final public function encrypt($cek, Header &$header = null) {
		if (!isset($header)) {
			$header = new Header();
		}
		return $this->_encryptKey($cek, $header);
	}
	
	/**
	 * Decrypt a CEK from the encrypted data.
	 *
	 * @param string $data Encrypted key
	 * @param Header|null Optional header containing parameters required to
	 *        decrypt the key.
	 * @throws \RuntimeException For generic errors
	 * @return string Content encryption key
	 */
	final public function decrypt($data, Header $header = null) {
		if (!isset($header)) {
			$header = new Header();
		}
		return $this->_decryptKey($data, $header);
	}
	
	/**
	 * Get content encryption key for the encryption.
	 *
	 * Returned key may be random depending on the key management algorithm.
	 *
	 * @param int $length Required key size in bytes
	 * @return string
	 */
	abstract public function cekForEncryption($length);
	
	/**
	 * Initialize key management algorithm from a JWK and a header.
	 *
	 * @param JWK $jwk
	 * @param Header $header
	 * @return KeyManagementAlgorithm
	 */
	public static function fromJWK(JWK $jwk, Header $header) {
		$factory = new KeyAlgorithmFactory($header);
		return $factory->algoByKey($jwk);
	}
	
	/**
	 * Get self with key ID.
	 *
	 * @param string|null $id Key ID or null to remove
	 * @return self
	 */
	public function withKeyID($id) {
		$obj = clone $this;
		$obj->_keyID = $id;
		return $obj;
	}
	
	/**
	 *
	 * @see \JWX\JWT\Header\HeaderParameters::headerParameters()
	 * @return JWTParameter[]
	 */
	public function headerParameters() {

This method seems to be duplicated in your project.

		$params = array();
		if (isset($this->_keyID)) {
			$params[] = new KeyIDParameter($this->_keyID);
		}
		return $params;
	}
}