@@ -16,71 +16,71 @@ |
||
16 | 16 | */ |
17 | 17 | class DeflateAlgorithm implements CompressionAlgorithm |
18 | 18 | { |
19 | - /** |
|
20 | - * Compression level. |
|
21 | - * |
|
22 | - * @var int |
|
23 | - */ |
|
24 | - protected $_compressionLevel; |
|
19 | + /** |
|
20 | + * Compression level. |
|
21 | + * |
|
22 | + * @var int |
|
23 | + */ |
|
24 | + protected $_compressionLevel; |
|
25 | 25 | |
26 | - /** |
|
27 | - * Constructor. |
|
28 | - * |
|
29 | - * @param int $level Compression level 0..9 |
|
30 | - */ |
|
31 | - public function __construct(int $level = -1) |
|
32 | - { |
|
33 | - if ($level < -1 || $level > 9) { |
|
34 | - throw new \DomainException('Compression level must be -1..9.'); |
|
35 | - } |
|
36 | - $this->_compressionLevel = $level; |
|
37 | - } |
|
26 | + /** |
|
27 | + * Constructor. |
|
28 | + * |
|
29 | + * @param int $level Compression level 0..9 |
|
30 | + */ |
|
31 | + public function __construct(int $level = -1) |
|
32 | + { |
|
33 | + if ($level < -1 || $level > 9) { |
|
34 | + throw new \DomainException('Compression level must be -1..9.'); |
|
35 | + } |
|
36 | + $this->_compressionLevel = $level; |
|
37 | + } |
|
38 | 38 | |
39 | - /** |
|
40 | - * {@inheritdoc} |
|
41 | - * |
|
42 | - * @throws \RuntimeException |
|
43 | - */ |
|
44 | - public function compress(string $data): string |
|
45 | - { |
|
46 | - $ret = @gzdeflate($data, $this->_compressionLevel); |
|
47 | - if (false === $ret) { |
|
48 | - $err = error_get_last(); |
|
49 | - $msg = isset($err) && __FILE__ === $err['file'] ? $err['message'] : null; |
|
50 | - throw new \RuntimeException($msg ?? 'gzdeflate() failed.'); |
|
51 | - } |
|
52 | - return $ret; |
|
53 | - } |
|
39 | + /** |
|
40 | + * {@inheritdoc} |
|
41 | + * |
|
42 | + * @throws \RuntimeException |
|
43 | + */ |
|
44 | + public function compress(string $data): string |
|
45 | + { |
|
46 | + $ret = @gzdeflate($data, $this->_compressionLevel); |
|
47 | + if (false === $ret) { |
|
48 | + $err = error_get_last(); |
|
49 | + $msg = isset($err) && __FILE__ === $err['file'] ? $err['message'] : null; |
|
50 | + throw new \RuntimeException($msg ?? 'gzdeflate() failed.'); |
|
51 | + } |
|
52 | + return $ret; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * {@inheritdoc} |
|
57 | - * |
|
58 | - * @throws \RuntimeException |
|
59 | - */ |
|
60 | - public function decompress(string $data): string |
|
61 | - { |
|
62 | - $ret = @gzinflate($data); |
|
63 | - if (false === $ret) { |
|
64 | - $err = error_get_last(); |
|
65 | - $msg = isset($err) && __FILE__ === $err['file'] ? $err['message'] : null; |
|
66 | - throw new \RuntimeException($msg ?? 'gzinflate() failed.'); |
|
67 | - } |
|
68 | - return $ret; |
|
69 | - } |
|
55 | + /** |
|
56 | + * {@inheritdoc} |
|
57 | + * |
|
58 | + * @throws \RuntimeException |
|
59 | + */ |
|
60 | + public function decompress(string $data): string |
|
61 | + { |
|
62 | + $ret = @gzinflate($data); |
|
63 | + if (false === $ret) { |
|
64 | + $err = error_get_last(); |
|
65 | + $msg = isset($err) && __FILE__ === $err['file'] ? $err['message'] : null; |
|
66 | + throw new \RuntimeException($msg ?? 'gzinflate() failed.'); |
|
67 | + } |
|
68 | + return $ret; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * {@inheritdoc} |
|
73 | - */ |
|
74 | - public function compressionParamValue(): string |
|
75 | - { |
|
76 | - return JWA::ALGO_DEFLATE; |
|
77 | - } |
|
71 | + /** |
|
72 | + * {@inheritdoc} |
|
73 | + */ |
|
74 | + public function compressionParamValue(): string |
|
75 | + { |
|
76 | + return JWA::ALGO_DEFLATE; |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * {@inheritdoc} |
|
81 | - */ |
|
82 | - public function headerParameters(): array |
|
83 | - { |
|
84 | - return [CompressionAlgorithmParameter::fromAlgorithm($this)]; |
|
85 | - } |
|
79 | + /** |
|
80 | + * {@inheritdoc} |
|
81 | + */ |
|
82 | + public function headerParameters(): array |
|
83 | + { |
|
84 | + return [CompressionAlgorithmParameter::fromAlgorithm($this)]; |
|
85 | + } |
|
86 | 86 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\CompressionAlgorithm; |
6 | 6 |
@@ -13,52 +13,52 @@ |
||
13 | 13 | */ |
14 | 14 | abstract class CompressionFactory |
15 | 15 | { |
16 | - /** |
|
17 | - * Mapping from algorithm name to class name. |
|
18 | - * |
|
19 | - * @internal |
|
20 | - * |
|
21 | - * @var array |
|
22 | - */ |
|
23 | - const MAP_ALGO_TO_CLASS = [ |
|
24 | - JWA::ALGO_DEFLATE => DeflateAlgorithm::class, |
|
25 | - ]; |
|
16 | + /** |
|
17 | + * Mapping from algorithm name to class name. |
|
18 | + * |
|
19 | + * @internal |
|
20 | + * |
|
21 | + * @var array |
|
22 | + */ |
|
23 | + const MAP_ALGO_TO_CLASS = [ |
|
24 | + JWA::ALGO_DEFLATE => DeflateAlgorithm::class, |
|
25 | + ]; |
|
26 | 26 | |
27 | - /** |
|
28 | - * Get the compression algorithm by name. |
|
29 | - * |
|
30 | - * @param string $name |
|
31 | - * |
|
32 | - * @throws \UnexpectedValueException If algorithm is not supported |
|
33 | - * |
|
34 | - * @return CompressionAlgorithm |
|
35 | - */ |
|
36 | - public static function algoByName(string $name): CompressionAlgorithm |
|
37 | - { |
|
38 | - if (!array_key_exists($name, self::MAP_ALGO_TO_CLASS)) { |
|
39 | - throw new \UnexpectedValueException( |
|
40 | - "No compression algorithm '{$name}'."); |
|
41 | - } |
|
42 | - $cls = self::MAP_ALGO_TO_CLASS[$name]; |
|
43 | - return new $cls(); |
|
44 | - } |
|
27 | + /** |
|
28 | + * Get the compression algorithm by name. |
|
29 | + * |
|
30 | + * @param string $name |
|
31 | + * |
|
32 | + * @throws \UnexpectedValueException If algorithm is not supported |
|
33 | + * |
|
34 | + * @return CompressionAlgorithm |
|
35 | + */ |
|
36 | + public static function algoByName(string $name): CompressionAlgorithm |
|
37 | + { |
|
38 | + if (!array_key_exists($name, self::MAP_ALGO_TO_CLASS)) { |
|
39 | + throw new \UnexpectedValueException( |
|
40 | + "No compression algorithm '{$name}'."); |
|
41 | + } |
|
42 | + $cls = self::MAP_ALGO_TO_CLASS[$name]; |
|
43 | + return new $cls(); |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Get the compression algorithm as specified in the given header. |
|
48 | - * |
|
49 | - * @param Header $header Header |
|
50 | - * |
|
51 | - * @throws \UnexpectedValueException If compression algorithm parameter is |
|
52 | - * not present or algorithm is not supported |
|
53 | - * |
|
54 | - * @return CompressionAlgorithm |
|
55 | - */ |
|
56 | - public static function algoByHeader(Header $header): CompressionAlgorithm |
|
57 | - { |
|
58 | - if (!$header->hasCompressionAlgorithm()) { |
|
59 | - throw new \UnexpectedValueException( |
|
60 | - 'No compression algorithm parameter.'); |
|
61 | - } |
|
62 | - return self::algoByName($header->compressionAlgorithm()->value()); |
|
63 | - } |
|
46 | + /** |
|
47 | + * Get the compression algorithm as specified in the given header. |
|
48 | + * |
|
49 | + * @param Header $header Header |
|
50 | + * |
|
51 | + * @throws \UnexpectedValueException If compression algorithm parameter is |
|
52 | + * not present or algorithm is not supported |
|
53 | + * |
|
54 | + * @return CompressionAlgorithm |
|
55 | + */ |
|
56 | + public static function algoByHeader(Header $header): CompressionAlgorithm |
|
57 | + { |
|
58 | + if (!$header->hasCompressionAlgorithm()) { |
|
59 | + throw new \UnexpectedValueException( |
|
60 | + 'No compression algorithm parameter.'); |
|
61 | + } |
|
62 | + return self::algoByName($header->compressionAlgorithm()->value()); |
|
63 | + } |
|
64 | 64 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\CompressionAlgorithm; |
6 | 6 |
@@ -17,127 +17,127 @@ |
||
17 | 17 | */ |
18 | 18 | abstract class KeyManagementAlgorithm implements AlgorithmParameterValue, HeaderParameters |
19 | 19 | { |
20 | - /** |
|
21 | - * ID of the key used by the algorithm. |
|
22 | - * |
|
23 | - * If set, KeyID parameter shall be automatically inserted into JWE's |
|
24 | - * header. |
|
25 | - * |
|
26 | - * @var null|string |
|
27 | - */ |
|
28 | - protected $_keyID; |
|
20 | + /** |
|
21 | + * ID of the key used by the algorithm. |
|
22 | + * |
|
23 | + * If set, KeyID parameter shall be automatically inserted into JWE's |
|
24 | + * header. |
|
25 | + * |
|
26 | + * @var null|string |
|
27 | + */ |
|
28 | + protected $_keyID; |
|
29 | 29 | |
30 | - /** |
|
31 | - * Encrypt a key to be inserted into JWE header. |
|
32 | - * |
|
33 | - * @param string $cek Content encryption key |
|
34 | - * @param null|Header $header Optional reference to the Header variable, |
|
35 | - * which may be updated to contain parameters |
|
36 | - * specific to this encrypt invocation. |
|
37 | - * If the variable is referenced, but is a null, |
|
38 | - * it shall be initialized to an empty Header. |
|
39 | - * |
|
40 | - * @throws \RuntimeException For generic errors |
|
41 | - * |
|
42 | - * @return string Encrypted key |
|
43 | - */ |
|
44 | - final public function encrypt(string $cek, Header &$header = null): string |
|
45 | - { |
|
46 | - if (!isset($header)) { |
|
47 | - $header = new Header(); |
|
48 | - } |
|
49 | - return $this->_encryptKey($cek, $header); |
|
50 | - } |
|
30 | + /** |
|
31 | + * Encrypt a key to be inserted into JWE header. |
|
32 | + * |
|
33 | + * @param string $cek Content encryption key |
|
34 | + * @param null|Header $header Optional reference to the Header variable, |
|
35 | + * which may be updated to contain parameters |
|
36 | + * specific to this encrypt invocation. |
|
37 | + * If the variable is referenced, but is a null, |
|
38 | + * it shall be initialized to an empty Header. |
|
39 | + * |
|
40 | + * @throws \RuntimeException For generic errors |
|
41 | + * |
|
42 | + * @return string Encrypted key |
|
43 | + */ |
|
44 | + final public function encrypt(string $cek, Header &$header = null): string |
|
45 | + { |
|
46 | + if (!isset($header)) { |
|
47 | + $header = new Header(); |
|
48 | + } |
|
49 | + return $this->_encryptKey($cek, $header); |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * Decrypt a CEK from the encrypted data. |
|
54 | - * |
|
55 | - * @param string $data Encrypted key |
|
56 | - * @param null|Header $header Optional header containing parameters |
|
57 | - * required to decrypt the key |
|
58 | - * |
|
59 | - * @throws \RuntimeException For generic errors |
|
60 | - * |
|
61 | - * @return string Content encryption key |
|
62 | - */ |
|
63 | - final public function decrypt(string $data, ?Header $header = null): string |
|
64 | - { |
|
65 | - if (!isset($header)) { |
|
66 | - $header = new Header(); |
|
67 | - } |
|
68 | - return $this->_decryptKey($data, $header); |
|
69 | - } |
|
52 | + /** |
|
53 | + * Decrypt a CEK from the encrypted data. |
|
54 | + * |
|
55 | + * @param string $data Encrypted key |
|
56 | + * @param null|Header $header Optional header containing parameters |
|
57 | + * required to decrypt the key |
|
58 | + * |
|
59 | + * @throws \RuntimeException For generic errors |
|
60 | + * |
|
61 | + * @return string Content encryption key |
|
62 | + */ |
|
63 | + final public function decrypt(string $data, ?Header $header = null): string |
|
64 | + { |
|
65 | + if (!isset($header)) { |
|
66 | + $header = new Header(); |
|
67 | + } |
|
68 | + return $this->_decryptKey($data, $header); |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * Get content encryption key for the encryption. |
|
73 | - * |
|
74 | - * Returned key may be random depending on the key management algorithm. |
|
75 | - * |
|
76 | - * @param int $length Required key size in bytes |
|
77 | - * |
|
78 | - * @return string |
|
79 | - */ |
|
80 | - abstract public function cekForEncryption(int $length): string; |
|
71 | + /** |
|
72 | + * Get content encryption key for the encryption. |
|
73 | + * |
|
74 | + * Returned key may be random depending on the key management algorithm. |
|
75 | + * |
|
76 | + * @param int $length Required key size in bytes |
|
77 | + * |
|
78 | + * @return string |
|
79 | + */ |
|
80 | + abstract public function cekForEncryption(int $length): string; |
|
81 | 81 | |
82 | - /** |
|
83 | - * Initialize key management algorithm from a JWK and a header. |
|
84 | - * |
|
85 | - * @param JWK $jwk |
|
86 | - * @param Header $header |
|
87 | - * |
|
88 | - * @return KeyManagementAlgorithm |
|
89 | - */ |
|
90 | - public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
91 | - { |
|
92 | - $factory = new KeyAlgorithmFactory($header); |
|
93 | - return $factory->algoByKey($jwk); |
|
94 | - } |
|
82 | + /** |
|
83 | + * Initialize key management algorithm from a JWK and a header. |
|
84 | + * |
|
85 | + * @param JWK $jwk |
|
86 | + * @param Header $header |
|
87 | + * |
|
88 | + * @return KeyManagementAlgorithm |
|
89 | + */ |
|
90 | + public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
91 | + { |
|
92 | + $factory = new KeyAlgorithmFactory($header); |
|
93 | + return $factory->algoByKey($jwk); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Get self with key ID. |
|
98 | - * |
|
99 | - * @param null|string $id Key ID or null to remove |
|
100 | - * |
|
101 | - * @return self |
|
102 | - */ |
|
103 | - public function withKeyID(?string $id): self |
|
104 | - { |
|
105 | - $obj = clone $this; |
|
106 | - $obj->_keyID = $id; |
|
107 | - return $obj; |
|
108 | - } |
|
96 | + /** |
|
97 | + * Get self with key ID. |
|
98 | + * |
|
99 | + * @param null|string $id Key ID or null to remove |
|
100 | + * |
|
101 | + * @return self |
|
102 | + */ |
|
103 | + public function withKeyID(?string $id): self |
|
104 | + { |
|
105 | + $obj = clone $this; |
|
106 | + $obj->_keyID = $id; |
|
107 | + return $obj; |
|
108 | + } |
|
109 | 109 | |
110 | - /** |
|
111 | - * {@inheritdoc} |
|
112 | - */ |
|
113 | - public function headerParameters(): array |
|
114 | - { |
|
115 | - $params = []; |
|
116 | - if (isset($this->_keyID)) { |
|
117 | - $params[] = new KeyIDParameter($this->_keyID); |
|
118 | - } |
|
119 | - return $params; |
|
120 | - } |
|
110 | + /** |
|
111 | + * {@inheritdoc} |
|
112 | + */ |
|
113 | + public function headerParameters(): array |
|
114 | + { |
|
115 | + $params = []; |
|
116 | + if (isset($this->_keyID)) { |
|
117 | + $params[] = new KeyIDParameter($this->_keyID); |
|
118 | + } |
|
119 | + return $params; |
|
120 | + } |
|
121 | 121 | |
122 | - /** |
|
123 | - * Encrypt a key. |
|
124 | - * |
|
125 | - * @param string $key Key to be encrypted |
|
126 | - * @param Header $header Reference to the Header variable, that shall |
|
127 | - * be updated to contain parameters specific to the encryption |
|
128 | - * |
|
129 | - * @return string Ciphertext |
|
130 | - */ |
|
131 | - abstract protected function _encryptKey(string $key, Header &$header): string; |
|
122 | + /** |
|
123 | + * Encrypt a key. |
|
124 | + * |
|
125 | + * @param string $key Key to be encrypted |
|
126 | + * @param Header $header Reference to the Header variable, that shall |
|
127 | + * be updated to contain parameters specific to the encryption |
|
128 | + * |
|
129 | + * @return string Ciphertext |
|
130 | + */ |
|
131 | + abstract protected function _encryptKey(string $key, Header &$header): string; |
|
132 | 132 | |
133 | - /** |
|
134 | - * Decrypt a key. |
|
135 | - * |
|
136 | - * @param string $ciphertext Ciphertext of the encrypted key |
|
137 | - * @param Header $header Header possibly containing encoding specific |
|
138 | - * parameters |
|
139 | - * |
|
140 | - * @return string Plaintext key |
|
141 | - */ |
|
142 | - abstract protected function _decryptKey(string $ciphertext, Header $header): string; |
|
133 | + /** |
|
134 | + * Decrypt a key. |
|
135 | + * |
|
136 | + * @param string $ciphertext Ciphertext of the encrypted key |
|
137 | + * @param Header $header Header possibly containing encoding specific |
|
138 | + * parameters |
|
139 | + * |
|
140 | + * @return string Plaintext key |
|
141 | + */ |
|
142 | + abstract protected function _decryptKey(string $ciphertext, Header $header): string; |
|
143 | 143 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE; |
6 | 6 |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\Exception; |
6 | 6 |
@@ -12,44 +12,44 @@ |
||
12 | 12 | */ |
13 | 13 | interface ContentEncryptionAlgorithm extends EncryptionAlgorithmParameterValue, HeaderParameters |
14 | 14 | { |
15 | - /** |
|
16 | - * Encrypt plaintext. |
|
17 | - * |
|
18 | - * @param string $plaintext Data to encrypt |
|
19 | - * @param string $key Encryption key |
|
20 | - * @param string $iv Initialization vector |
|
21 | - * @param string $aad Additional authenticated data |
|
22 | - * |
|
23 | - * @return array Tuple of ciphertext and authentication tag |
|
24 | - */ |
|
25 | - public function encrypt(string $plaintext, string $key, string $iv, |
|
26 | - string $aad): array; |
|
15 | + /** |
|
16 | + * Encrypt plaintext. |
|
17 | + * |
|
18 | + * @param string $plaintext Data to encrypt |
|
19 | + * @param string $key Encryption key |
|
20 | + * @param string $iv Initialization vector |
|
21 | + * @param string $aad Additional authenticated data |
|
22 | + * |
|
23 | + * @return array Tuple of ciphertext and authentication tag |
|
24 | + */ |
|
25 | + public function encrypt(string $plaintext, string $key, string $iv, |
|
26 | + string $aad): array; |
|
27 | 27 | |
28 | - /** |
|
29 | - * Decrypt ciphertext. |
|
30 | - * |
|
31 | - * @param string $ciphertext Data to decrypt |
|
32 | - * @param string $key Encryption key |
|
33 | - * @param string $iv Initialization vector |
|
34 | - * @param string $aad Additional authenticated data |
|
35 | - * @param string $auth_tag Authentication tag to compare |
|
36 | - * |
|
37 | - * @return string Plaintext |
|
38 | - */ |
|
39 | - public function decrypt(string $ciphertext, string $key, string $iv, |
|
40 | - string $aad, string $auth_tag): string; |
|
28 | + /** |
|
29 | + * Decrypt ciphertext. |
|
30 | + * |
|
31 | + * @param string $ciphertext Data to decrypt |
|
32 | + * @param string $key Encryption key |
|
33 | + * @param string $iv Initialization vector |
|
34 | + * @param string $aad Additional authenticated data |
|
35 | + * @param string $auth_tag Authentication tag to compare |
|
36 | + * |
|
37 | + * @return string Plaintext |
|
38 | + */ |
|
39 | + public function decrypt(string $ciphertext, string $key, string $iv, |
|
40 | + string $aad, string $auth_tag): string; |
|
41 | 41 | |
42 | - /** |
|
43 | - * Get the required key size in bytes. |
|
44 | - * |
|
45 | - * @return int |
|
46 | - */ |
|
47 | - public function keySize(): int; |
|
42 | + /** |
|
43 | + * Get the required key size in bytes. |
|
44 | + * |
|
45 | + * @return int |
|
46 | + */ |
|
47 | + public function keySize(): int; |
|
48 | 48 | |
49 | - /** |
|
50 | - * Get the required IV size in bytes. |
|
51 | - * |
|
52 | - * @return int |
|
53 | - */ |
|
54 | - public function ivSize(): int; |
|
49 | + /** |
|
50 | + * Get the required IV size in bytes. |
|
51 | + * |
|
52 | + * @return int |
|
53 | + */ |
|
54 | + public function ivSize(): int; |
|
55 | 55 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE; |
6 | 6 |
@@ -22,199 +22,199 @@ |
||
22 | 22 | */ |
23 | 23 | abstract class PBES2Algorithm extends KeyManagementAlgorithm |
24 | 24 | { |
25 | - use RandomCEK; |
|
26 | - |
|
27 | - /** |
|
28 | - * Mapping from algorithm name to class name. |
|
29 | - * |
|
30 | - * @internal |
|
31 | - * |
|
32 | - * @var array |
|
33 | - */ |
|
34 | - const MAP_ALGO_TO_CLASS = [ |
|
35 | - JWA::ALGO_PBES2_HS256_A128KW => PBES2HS256A128KWAlgorithm::class, |
|
36 | - JWA::ALGO_PBES2_HS384_A192KW => PBES2HS384A192KWAlgorithm::class, |
|
37 | - JWA::ALGO_PBES2_HS512_A256KW => PBES2HS512A256KWAlgorithm::class, |
|
38 | - ]; |
|
39 | - |
|
40 | - /** |
|
41 | - * Password. |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - protected $_password; |
|
46 | - |
|
47 | - /** |
|
48 | - * Salt input. |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - protected $_saltInput; |
|
53 | - |
|
54 | - /** |
|
55 | - * Iteration count. |
|
56 | - * |
|
57 | - * @var int |
|
58 | - */ |
|
59 | - protected $_count; |
|
60 | - |
|
61 | - /** |
|
62 | - * Derived key. |
|
63 | - * |
|
64 | - * @var string |
|
65 | - */ |
|
66 | - private $_derivedKey; |
|
67 | - |
|
68 | - /** |
|
69 | - * Constructor. |
|
70 | - * |
|
71 | - * @param string $password Password |
|
72 | - * @param string $salt_input Salt input |
|
73 | - * @param int $count Iteration count |
|
74 | - */ |
|
75 | - public function __construct(string $password, string $salt_input, int $count) |
|
76 | - { |
|
77 | - $this->_password = $password; |
|
78 | - $this->_saltInput = $salt_input; |
|
79 | - $this->_count = $count; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Initialize from JWK. |
|
84 | - * |
|
85 | - * @param JWK $jwk |
|
86 | - * @param Header $header |
|
87 | - * |
|
88 | - * @throws \UnexpectedValueException |
|
89 | - * |
|
90 | - * @return self |
|
91 | - */ |
|
92 | - public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
93 | - { |
|
94 | - $jwk = SymmetricKeyJWK::fromJWK($jwk); |
|
95 | - if (!$header->hasPBES2SaltInput()) { |
|
96 | - throw new \UnexpectedValueException('No salt input.'); |
|
97 | - } |
|
98 | - $salt_input = $header->PBES2SaltInput()->saltInput(); |
|
99 | - if (!$header->hasPBES2Count()) { |
|
100 | - throw new \UnexpectedValueException('No iteration count.'); |
|
101 | - } |
|
102 | - $count = $header->PBES2Count()->value(); |
|
103 | - $alg = JWA::deriveAlgorithmName($header, $jwk); |
|
104 | - if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) { |
|
105 | - throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'."); |
|
106 | - } |
|
107 | - $cls = self::MAP_ALGO_TO_CLASS[$alg]; |
|
108 | - return new $cls($jwk->key(), $salt_input, $count); |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Initialize from a password with random salt and default iteration count. |
|
113 | - * |
|
114 | - * @param string $password Password |
|
115 | - * @param int $count Optional user defined iteration count |
|
116 | - * @param int $salt_bytes Optional user defined salt length |
|
117 | - * |
|
118 | - * @return self |
|
119 | - */ |
|
120 | - public static function fromPassword(string $password, int $count = 64000, |
|
121 | - int $salt_bytes = 8): self |
|
122 | - { |
|
123 | - $salt_input = openssl_random_pseudo_bytes($salt_bytes); |
|
124 | - return new static($password, $salt_input, $count); |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * Get salt input. |
|
129 | - * |
|
130 | - * @return string |
|
131 | - */ |
|
132 | - public function saltInput(): string |
|
133 | - { |
|
134 | - return $this->_saltInput; |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Get computed salt. |
|
139 | - * |
|
140 | - * @return string |
|
141 | - */ |
|
142 | - public function salt(): string |
|
143 | - { |
|
144 | - return PBES2SaltInputParameter::fromString($this->_saltInput)->salt( |
|
145 | - AlgorithmParameter::fromAlgorithm($this)); |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * Get iteration count. |
|
150 | - * |
|
151 | - * @return int |
|
152 | - */ |
|
153 | - public function iterationCount(): int |
|
154 | - { |
|
155 | - return $this->_count; |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * {@inheritdoc} |
|
160 | - */ |
|
161 | - public function headerParameters(): array |
|
162 | - { |
|
163 | - return array_merge(parent::headerParameters(), |
|
164 | - [AlgorithmParameter::fromAlgorithm($this), |
|
165 | - PBES2SaltInputParameter::fromString($this->_saltInput), |
|
166 | - new PBES2CountParameter($this->_count), ]); |
|
167 | - } |
|
168 | - |
|
169 | - /** |
|
170 | - * Get hash algorithm for hash_pbkdf2. |
|
171 | - * |
|
172 | - * @return string |
|
173 | - */ |
|
174 | - abstract protected function _hashAlgo(): string; |
|
175 | - |
|
176 | - /** |
|
177 | - * Get derived key length. |
|
178 | - * |
|
179 | - * @return int |
|
180 | - */ |
|
181 | - abstract protected function _keyLength(): int; |
|
182 | - |
|
183 | - /** |
|
184 | - * Get key wrapping algoritym. |
|
185 | - * |
|
186 | - * @return AESKeyWrapAlgorithm |
|
187 | - */ |
|
188 | - abstract protected function _kwAlgo(): AESKeyWrapAlgorithm; |
|
189 | - |
|
190 | - /** |
|
191 | - * Get derived key. |
|
192 | - * |
|
193 | - * @return string |
|
194 | - */ |
|
195 | - protected function _derivedKey(): string |
|
196 | - { |
|
197 | - if (!isset($this->_derivedKey)) { |
|
198 | - $this->_derivedKey = hash_pbkdf2($this->_hashAlgo(), |
|
199 | - $this->_password, $this->salt(), $this->_count, |
|
200 | - $this->_keyLength(), true); |
|
201 | - } |
|
202 | - return $this->_derivedKey; |
|
203 | - } |
|
204 | - |
|
205 | - /** |
|
206 | - * {@inheritdoc} |
|
207 | - */ |
|
208 | - protected function _encryptKey(string $key, Header &$header): string |
|
209 | - { |
|
210 | - return $this->_kwAlgo()->wrap($key, $this->_derivedKey()); |
|
211 | - } |
|
212 | - |
|
213 | - /** |
|
214 | - * {@inheritdoc} |
|
215 | - */ |
|
216 | - protected function _decryptKey(string $ciphertext, Header $header): string |
|
217 | - { |
|
218 | - return $this->_kwAlgo()->unwrap($ciphertext, $this->_derivedKey()); |
|
219 | - } |
|
25 | + use RandomCEK; |
|
26 | + |
|
27 | + /** |
|
28 | + * Mapping from algorithm name to class name. |
|
29 | + * |
|
30 | + * @internal |
|
31 | + * |
|
32 | + * @var array |
|
33 | + */ |
|
34 | + const MAP_ALGO_TO_CLASS = [ |
|
35 | + JWA::ALGO_PBES2_HS256_A128KW => PBES2HS256A128KWAlgorithm::class, |
|
36 | + JWA::ALGO_PBES2_HS384_A192KW => PBES2HS384A192KWAlgorithm::class, |
|
37 | + JWA::ALGO_PBES2_HS512_A256KW => PBES2HS512A256KWAlgorithm::class, |
|
38 | + ]; |
|
39 | + |
|
40 | + /** |
|
41 | + * Password. |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + protected $_password; |
|
46 | + |
|
47 | + /** |
|
48 | + * Salt input. |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + protected $_saltInput; |
|
53 | + |
|
54 | + /** |
|
55 | + * Iteration count. |
|
56 | + * |
|
57 | + * @var int |
|
58 | + */ |
|
59 | + protected $_count; |
|
60 | + |
|
61 | + /** |
|
62 | + * Derived key. |
|
63 | + * |
|
64 | + * @var string |
|
65 | + */ |
|
66 | + private $_derivedKey; |
|
67 | + |
|
68 | + /** |
|
69 | + * Constructor. |
|
70 | + * |
|
71 | + * @param string $password Password |
|
72 | + * @param string $salt_input Salt input |
|
73 | + * @param int $count Iteration count |
|
74 | + */ |
|
75 | + public function __construct(string $password, string $salt_input, int $count) |
|
76 | + { |
|
77 | + $this->_password = $password; |
|
78 | + $this->_saltInput = $salt_input; |
|
79 | + $this->_count = $count; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Initialize from JWK. |
|
84 | + * |
|
85 | + * @param JWK $jwk |
|
86 | + * @param Header $header |
|
87 | + * |
|
88 | + * @throws \UnexpectedValueException |
|
89 | + * |
|
90 | + * @return self |
|
91 | + */ |
|
92 | + public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
93 | + { |
|
94 | + $jwk = SymmetricKeyJWK::fromJWK($jwk); |
|
95 | + if (!$header->hasPBES2SaltInput()) { |
|
96 | + throw new \UnexpectedValueException('No salt input.'); |
|
97 | + } |
|
98 | + $salt_input = $header->PBES2SaltInput()->saltInput(); |
|
99 | + if (!$header->hasPBES2Count()) { |
|
100 | + throw new \UnexpectedValueException('No iteration count.'); |
|
101 | + } |
|
102 | + $count = $header->PBES2Count()->value(); |
|
103 | + $alg = JWA::deriveAlgorithmName($header, $jwk); |
|
104 | + if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) { |
|
105 | + throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'."); |
|
106 | + } |
|
107 | + $cls = self::MAP_ALGO_TO_CLASS[$alg]; |
|
108 | + return new $cls($jwk->key(), $salt_input, $count); |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Initialize from a password with random salt and default iteration count. |
|
113 | + * |
|
114 | + * @param string $password Password |
|
115 | + * @param int $count Optional user defined iteration count |
|
116 | + * @param int $salt_bytes Optional user defined salt length |
|
117 | + * |
|
118 | + * @return self |
|
119 | + */ |
|
120 | + public static function fromPassword(string $password, int $count = 64000, |
|
121 | + int $salt_bytes = 8): self |
|
122 | + { |
|
123 | + $salt_input = openssl_random_pseudo_bytes($salt_bytes); |
|
124 | + return new static($password, $salt_input, $count); |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * Get salt input. |
|
129 | + * |
|
130 | + * @return string |
|
131 | + */ |
|
132 | + public function saltInput(): string |
|
133 | + { |
|
134 | + return $this->_saltInput; |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Get computed salt. |
|
139 | + * |
|
140 | + * @return string |
|
141 | + */ |
|
142 | + public function salt(): string |
|
143 | + { |
|
144 | + return PBES2SaltInputParameter::fromString($this->_saltInput)->salt( |
|
145 | + AlgorithmParameter::fromAlgorithm($this)); |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * Get iteration count. |
|
150 | + * |
|
151 | + * @return int |
|
152 | + */ |
|
153 | + public function iterationCount(): int |
|
154 | + { |
|
155 | + return $this->_count; |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * {@inheritdoc} |
|
160 | + */ |
|
161 | + public function headerParameters(): array |
|
162 | + { |
|
163 | + return array_merge(parent::headerParameters(), |
|
164 | + [AlgorithmParameter::fromAlgorithm($this), |
|
165 | + PBES2SaltInputParameter::fromString($this->_saltInput), |
|
166 | + new PBES2CountParameter($this->_count), ]); |
|
167 | + } |
|
168 | + |
|
169 | + /** |
|
170 | + * Get hash algorithm for hash_pbkdf2. |
|
171 | + * |
|
172 | + * @return string |
|
173 | + */ |
|
174 | + abstract protected function _hashAlgo(): string; |
|
175 | + |
|
176 | + /** |
|
177 | + * Get derived key length. |
|
178 | + * |
|
179 | + * @return int |
|
180 | + */ |
|
181 | + abstract protected function _keyLength(): int; |
|
182 | + |
|
183 | + /** |
|
184 | + * Get key wrapping algoritym. |
|
185 | + * |
|
186 | + * @return AESKeyWrapAlgorithm |
|
187 | + */ |
|
188 | + abstract protected function _kwAlgo(): AESKeyWrapAlgorithm; |
|
189 | + |
|
190 | + /** |
|
191 | + * Get derived key. |
|
192 | + * |
|
193 | + * @return string |
|
194 | + */ |
|
195 | + protected function _derivedKey(): string |
|
196 | + { |
|
197 | + if (!isset($this->_derivedKey)) { |
|
198 | + $this->_derivedKey = hash_pbkdf2($this->_hashAlgo(), |
|
199 | + $this->_password, $this->salt(), $this->_count, |
|
200 | + $this->_keyLength(), true); |
|
201 | + } |
|
202 | + return $this->_derivedKey; |
|
203 | + } |
|
204 | + |
|
205 | + /** |
|
206 | + * {@inheritdoc} |
|
207 | + */ |
|
208 | + protected function _encryptKey(string $key, Header &$header): string |
|
209 | + { |
|
210 | + return $this->_kwAlgo()->wrap($key, $this->_derivedKey()); |
|
211 | + } |
|
212 | + |
|
213 | + /** |
|
214 | + * {@inheritdoc} |
|
215 | + */ |
|
216 | + protected function _decryptKey(string $ciphertext, Header $header): string |
|
217 | + { |
|
218 | + return $this->_kwAlgo()->unwrap($ciphertext, $this->_derivedKey()); |
|
219 | + } |
|
220 | 220 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\KeyAlgorithm; |
6 | 6 |
@@ -21,202 +21,202 @@ |
||
21 | 21 | */ |
22 | 22 | abstract class RSAESKeyAlgorithm extends KeyManagementAlgorithm |
23 | 23 | { |
24 | - use RandomCEK; |
|
25 | - |
|
26 | - /** |
|
27 | - * Mapping from algorithm name to class name. |
|
28 | - * |
|
29 | - * @internal |
|
30 | - * |
|
31 | - * @var array |
|
32 | - */ |
|
33 | - 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 <code>fromPublicKey</code> or <code>fromPrivateKey</code> instead! |
|
56 | - * |
|
57 | - * @param RSAPublicKeyJWK $pub_key RSA public key |
|
58 | - * @param RSAPrivateKeyJWK $priv_key Optional RSA private key |
|
59 | - */ |
|
60 | - protected function __construct(RSAPublicKeyJWK $pub_key, |
|
61 | - ?RSAPrivateKeyJWK $priv_key = null) |
|
62 | - { |
|
63 | - $this->_publicKey = $pub_key; |
|
64 | - $this->_privateKey = $priv_key; |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * Initialize from JWK. |
|
69 | - * |
|
70 | - * @param JWK $jwk |
|
71 | - * @param Header $header |
|
72 | - * |
|
73 | - * @throws \UnexpectedValueException |
|
74 | - * |
|
75 | - * @return self |
|
76 | - */ |
|
77 | - public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
78 | - { |
|
79 | - $alg = JWA::deriveAlgorithmName($header, $jwk); |
|
80 | - if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) { |
|
81 | - throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'."); |
|
82 | - } |
|
83 | - $cls = self::MAP_ALGO_TO_CLASS[$alg]; |
|
84 | - if ($jwk->has(...RSAPrivateKeyJWK::MANAGED_PARAMS)) { |
|
85 | - return $cls::fromPrivateKey(RSAPrivateKeyJWK::fromJWK($jwk)); |
|
86 | - } |
|
87 | - return $cls::fromPublicKey(RSAPublicKeyJWK::fromJWK($jwk)); |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Initialize from a public key. |
|
92 | - * |
|
93 | - * @param RSAPublicKeyJWK $jwk |
|
94 | - * |
|
95 | - * @return self |
|
96 | - */ |
|
97 | - public static function fromPublicKey(RSAPublicKeyJWK $jwk): self |
|
98 | - { |
|
99 | - return new static($jwk); |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * Initialize from a private key. |
|
104 | - * |
|
105 | - * @param RSAPrivateKeyJWK $jwk |
|
106 | - * |
|
107 | - * @return self |
|
108 | - */ |
|
109 | - public static function fromPrivateKey(RSAPrivateKeyJWK $jwk): self |
|
110 | - { |
|
111 | - return new static($jwk->publicKey(), $jwk); |
|
112 | - } |
|
113 | - |
|
114 | - /** |
|
115 | - * Get the public key. |
|
116 | - * |
|
117 | - * @return RSAPublicKeyJWK |
|
118 | - */ |
|
119 | - public function publicKey(): RSAPublicKeyJWK |
|
120 | - { |
|
121 | - return $this->_publicKey; |
|
122 | - } |
|
123 | - |
|
124 | - /** |
|
125 | - * Check whether the private key is present. |
|
126 | - * |
|
127 | - * @return bool |
|
128 | - */ |
|
129 | - public function hasPrivateKey(): bool |
|
130 | - { |
|
131 | - return isset($this->_privateKey); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Get the private key. |
|
136 | - * |
|
137 | - * @throws \LogicException |
|
138 | - * |
|
139 | - * @return RSAPrivateKeyJWK |
|
140 | - */ |
|
141 | - public function privateKey(): RSAPrivateKeyJWK |
|
142 | - { |
|
143 | - if (!$this->hasPrivateKey()) { |
|
144 | - throw new \LogicException('Private key not set.'); |
|
145 | - } |
|
146 | - return $this->_privateKey; |
|
147 | - } |
|
148 | - |
|
149 | - /** |
|
150 | - * {@inheritdoc} |
|
151 | - */ |
|
152 | - public function headerParameters(): array |
|
153 | - { |
|
154 | - return array_merge(parent::headerParameters(), |
|
155 | - [AlgorithmParameter::fromAlgorithm($this)]); |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * Get the padding scheme. |
|
160 | - * |
|
161 | - * @return int |
|
162 | - */ |
|
163 | - abstract protected function _paddingScheme(): int; |
|
164 | - |
|
165 | - /** |
|
166 | - * {@inheritdoc} |
|
167 | - */ |
|
168 | - protected function _encryptKey(string $key, Header &$header): string |
|
169 | - { |
|
170 | - $pubkey = openssl_pkey_get_public( |
|
171 | - $this->publicKey()->toPEM()->string()); |
|
172 | - if (false === $pubkey) { |
|
173 | - throw new \RuntimeException( |
|
174 | - 'openssl_pkey_get_public() failed: ' . |
|
175 | - $this->_getLastOpenSSLError()); |
|
176 | - } |
|
177 | - $result = openssl_public_encrypt($key, $crypted, $pubkey, |
|
178 | - $this->_paddingScheme()); |
|
179 | - if (!$result) { |
|
180 | - throw new \RuntimeException( |
|
181 | - 'openssl_public_encrypt() failed: ' . |
|
182 | - $this->_getLastOpenSSLError()); |
|
183 | - } |
|
184 | - return $crypted; |
|
185 | - } |
|
186 | - |
|
187 | - /** |
|
188 | - * {@inheritdoc} |
|
189 | - */ |
|
190 | - protected function _decryptKey(string $ciphertext, Header $header): string |
|
191 | - { |
|
192 | - $privkey = openssl_pkey_get_private( |
|
193 | - $this->privateKey()->toPEM()->string()); |
|
194 | - if (false === $privkey) { |
|
195 | - throw new \RuntimeException( |
|
196 | - 'openssl_pkey_get_private() failed: ' . |
|
197 | - $this->_getLastOpenSSLError()); |
|
198 | - } |
|
199 | - $result = openssl_private_decrypt($ciphertext, $cek, $privkey, |
|
200 | - $this->_paddingScheme()); |
|
201 | - if (!$result) { |
|
202 | - throw new \RuntimeException( |
|
203 | - 'openssl_private_decrypt() failed: ' . |
|
204 | - $this->_getLastOpenSSLError()); |
|
205 | - } |
|
206 | - return $cek; |
|
207 | - } |
|
208 | - |
|
209 | - /** |
|
210 | - * Get last OpenSSL error message. |
|
211 | - * |
|
212 | - * @return null|string |
|
213 | - */ |
|
214 | - protected function _getLastOpenSSLError(): ?string |
|
215 | - { |
|
216 | - $msg = null; |
|
217 | - while (false !== ($err = openssl_error_string())) { |
|
218 | - $msg = $err; |
|
219 | - } |
|
220 | - return $msg; |
|
221 | - } |
|
24 | + use RandomCEK; |
|
25 | + |
|
26 | + /** |
|
27 | + * Mapping from algorithm name to class name. |
|
28 | + * |
|
29 | + * @internal |
|
30 | + * |
|
31 | + * @var array |
|
32 | + */ |
|
33 | + 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 <code>fromPublicKey</code> or <code>fromPrivateKey</code> instead! |
|
56 | + * |
|
57 | + * @param RSAPublicKeyJWK $pub_key RSA public key |
|
58 | + * @param RSAPrivateKeyJWK $priv_key Optional RSA private key |
|
59 | + */ |
|
60 | + protected function __construct(RSAPublicKeyJWK $pub_key, |
|
61 | + ?RSAPrivateKeyJWK $priv_key = null) |
|
62 | + { |
|
63 | + $this->_publicKey = $pub_key; |
|
64 | + $this->_privateKey = $priv_key; |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * Initialize from JWK. |
|
69 | + * |
|
70 | + * @param JWK $jwk |
|
71 | + * @param Header $header |
|
72 | + * |
|
73 | + * @throws \UnexpectedValueException |
|
74 | + * |
|
75 | + * @return self |
|
76 | + */ |
|
77 | + public static function fromJWK(JWK $jwk, Header $header): KeyManagementAlgorithm |
|
78 | + { |
|
79 | + $alg = JWA::deriveAlgorithmName($header, $jwk); |
|
80 | + if (!array_key_exists($alg, self::MAP_ALGO_TO_CLASS)) { |
|
81 | + throw new \UnexpectedValueException("Unsupported algorithm '{$alg}'."); |
|
82 | + } |
|
83 | + $cls = self::MAP_ALGO_TO_CLASS[$alg]; |
|
84 | + if ($jwk->has(...RSAPrivateKeyJWK::MANAGED_PARAMS)) { |
|
85 | + return $cls::fromPrivateKey(RSAPrivateKeyJWK::fromJWK($jwk)); |
|
86 | + } |
|
87 | + return $cls::fromPublicKey(RSAPublicKeyJWK::fromJWK($jwk)); |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Initialize from a public key. |
|
92 | + * |
|
93 | + * @param RSAPublicKeyJWK $jwk |
|
94 | + * |
|
95 | + * @return self |
|
96 | + */ |
|
97 | + public static function fromPublicKey(RSAPublicKeyJWK $jwk): self |
|
98 | + { |
|
99 | + return new static($jwk); |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * Initialize from a private key. |
|
104 | + * |
|
105 | + * @param RSAPrivateKeyJWK $jwk |
|
106 | + * |
|
107 | + * @return self |
|
108 | + */ |
|
109 | + public static function fromPrivateKey(RSAPrivateKeyJWK $jwk): self |
|
110 | + { |
|
111 | + return new static($jwk->publicKey(), $jwk); |
|
112 | + } |
|
113 | + |
|
114 | + /** |
|
115 | + * Get the public key. |
|
116 | + * |
|
117 | + * @return RSAPublicKeyJWK |
|
118 | + */ |
|
119 | + public function publicKey(): RSAPublicKeyJWK |
|
120 | + { |
|
121 | + return $this->_publicKey; |
|
122 | + } |
|
123 | + |
|
124 | + /** |
|
125 | + * Check whether the private key is present. |
|
126 | + * |
|
127 | + * @return bool |
|
128 | + */ |
|
129 | + public function hasPrivateKey(): bool |
|
130 | + { |
|
131 | + return isset($this->_privateKey); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Get the private key. |
|
136 | + * |
|
137 | + * @throws \LogicException |
|
138 | + * |
|
139 | + * @return RSAPrivateKeyJWK |
|
140 | + */ |
|
141 | + public function privateKey(): RSAPrivateKeyJWK |
|
142 | + { |
|
143 | + if (!$this->hasPrivateKey()) { |
|
144 | + throw new \LogicException('Private key not set.'); |
|
145 | + } |
|
146 | + return $this->_privateKey; |
|
147 | + } |
|
148 | + |
|
149 | + /** |
|
150 | + * {@inheritdoc} |
|
151 | + */ |
|
152 | + public function headerParameters(): array |
|
153 | + { |
|
154 | + return array_merge(parent::headerParameters(), |
|
155 | + [AlgorithmParameter::fromAlgorithm($this)]); |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * Get the padding scheme. |
|
160 | + * |
|
161 | + * @return int |
|
162 | + */ |
|
163 | + abstract protected function _paddingScheme(): int; |
|
164 | + |
|
165 | + /** |
|
166 | + * {@inheritdoc} |
|
167 | + */ |
|
168 | + protected function _encryptKey(string $key, Header &$header): string |
|
169 | + { |
|
170 | + $pubkey = openssl_pkey_get_public( |
|
171 | + $this->publicKey()->toPEM()->string()); |
|
172 | + if (false === $pubkey) { |
|
173 | + throw new \RuntimeException( |
|
174 | + 'openssl_pkey_get_public() failed: ' . |
|
175 | + $this->_getLastOpenSSLError()); |
|
176 | + } |
|
177 | + $result = openssl_public_encrypt($key, $crypted, $pubkey, |
|
178 | + $this->_paddingScheme()); |
|
179 | + if (!$result) { |
|
180 | + throw new \RuntimeException( |
|
181 | + 'openssl_public_encrypt() failed: ' . |
|
182 | + $this->_getLastOpenSSLError()); |
|
183 | + } |
|
184 | + return $crypted; |
|
185 | + } |
|
186 | + |
|
187 | + /** |
|
188 | + * {@inheritdoc} |
|
189 | + */ |
|
190 | + protected function _decryptKey(string $ciphertext, Header $header): string |
|
191 | + { |
|
192 | + $privkey = openssl_pkey_get_private( |
|
193 | + $this->privateKey()->toPEM()->string()); |
|
194 | + if (false === $privkey) { |
|
195 | + throw new \RuntimeException( |
|
196 | + 'openssl_pkey_get_private() failed: ' . |
|
197 | + $this->_getLastOpenSSLError()); |
|
198 | + } |
|
199 | + $result = openssl_private_decrypt($ciphertext, $cek, $privkey, |
|
200 | + $this->_paddingScheme()); |
|
201 | + if (!$result) { |
|
202 | + throw new \RuntimeException( |
|
203 | + 'openssl_private_decrypt() failed: ' . |
|
204 | + $this->_getLastOpenSSLError()); |
|
205 | + } |
|
206 | + return $cek; |
|
207 | + } |
|
208 | + |
|
209 | + /** |
|
210 | + * Get last OpenSSL error message. |
|
211 | + * |
|
212 | + * @return null|string |
|
213 | + */ |
|
214 | + protected function _getLastOpenSSLError(): ?string |
|
215 | + { |
|
216 | + $msg = null; |
|
217 | + while (false !== ($err = openssl_error_string())) { |
|
218 | + $msg = $err; |
|
219 | + } |
|
220 | + return $msg; |
|
221 | + } |
|
222 | 222 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\KeyAlgorithm; |
6 | 6 |
@@ -15,27 +15,27 @@ |
||
15 | 15 | */ |
16 | 16 | class A192GCMKWAlgorithm extends AESGCMKWAlgorithm |
17 | 17 | { |
18 | - /** |
|
19 | - * {@inheritdoc} |
|
20 | - */ |
|
21 | - public function algorithmParamValue(): string |
|
22 | - { |
|
23 | - return JWA::ALGO_A192GCMKW; |
|
24 | - } |
|
18 | + /** |
|
19 | + * {@inheritdoc} |
|
20 | + */ |
|
21 | + public function algorithmParamValue(): string |
|
22 | + { |
|
23 | + return JWA::ALGO_A192GCMKW; |
|
24 | + } |
|
25 | 25 | |
26 | - /** |
|
27 | - * {@inheritdoc} |
|
28 | - */ |
|
29 | - protected function _getGCMCipher(): Cipher |
|
30 | - { |
|
31 | - return new AES192Cipher(); |
|
32 | - } |
|
26 | + /** |
|
27 | + * {@inheritdoc} |
|
28 | + */ |
|
29 | + protected function _getGCMCipher(): Cipher |
|
30 | + { |
|
31 | + return new AES192Cipher(); |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * {@inheritdoc} |
|
36 | - */ |
|
37 | - protected function _keySize(): int |
|
38 | - { |
|
39 | - return 24; |
|
40 | - } |
|
34 | + /** |
|
35 | + * {@inheritdoc} |
|
36 | + */ |
|
37 | + protected function _keySize(): int |
|
38 | + { |
|
39 | + return 24; |
|
40 | + } |
|
41 | 41 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\KeyAlgorithm; |
6 | 6 |
@@ -15,35 +15,35 @@ |
||
15 | 15 | */ |
16 | 16 | class PBES2HS256A128KWAlgorithm extends PBES2Algorithm |
17 | 17 | { |
18 | - /** |
|
19 | - * {@inheritdoc} |
|
20 | - */ |
|
21 | - public function algorithmParamValue(): string |
|
22 | - { |
|
23 | - return JWA::ALGO_PBES2_HS256_A128KW; |
|
24 | - } |
|
18 | + /** |
|
19 | + * {@inheritdoc} |
|
20 | + */ |
|
21 | + public function algorithmParamValue(): string |
|
22 | + { |
|
23 | + return JWA::ALGO_PBES2_HS256_A128KW; |
|
24 | + } |
|
25 | 25 | |
26 | - /** |
|
27 | - * {@inheritdoc} |
|
28 | - */ |
|
29 | - protected function _hashAlgo(): string |
|
30 | - { |
|
31 | - return 'sha256'; |
|
32 | - } |
|
26 | + /** |
|
27 | + * {@inheritdoc} |
|
28 | + */ |
|
29 | + protected function _hashAlgo(): string |
|
30 | + { |
|
31 | + return 'sha256'; |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * {@inheritdoc} |
|
36 | - */ |
|
37 | - protected function _keyLength(): int |
|
38 | - { |
|
39 | - return 16; |
|
40 | - } |
|
34 | + /** |
|
35 | + * {@inheritdoc} |
|
36 | + */ |
|
37 | + protected function _keyLength(): int |
|
38 | + { |
|
39 | + return 16; |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * {@inheritdoc} |
|
44 | - */ |
|
45 | - protected function _kwAlgo(): AESKeyWrapAlgorithm |
|
46 | - { |
|
47 | - return new AESKW128(); |
|
48 | - } |
|
42 | + /** |
|
43 | + * {@inheritdoc} |
|
44 | + */ |
|
45 | + protected function _kwAlgo(): AESKeyWrapAlgorithm |
|
46 | + { |
|
47 | + return new AESKW128(); |
|
48 | + } |
|
49 | 49 | } |
@@ -1,6 +1,6 @@ |
||
1 | 1 | <?php |
2 | 2 | |
3 | -declare(strict_types = 1); |
|
3 | +declare(strict_types=1); |
|
4 | 4 | |
5 | 5 | namespace Sop\JWX\JWE\KeyAlgorithm; |
6 | 6 |