primo commit

This commit is contained in:
2024-12-17 17:34:10 +01:00
commit e650f8df99
16435 changed files with 2451012 additions and 0 deletions

View File

@ -0,0 +1,120 @@
<?php
declare(strict_types=1);
namespace Jose\Component\KeyManagement\KeyConverter;
use InvalidArgumentException;
use Jose\Component\Core\Util\Base64UrlSafe;
use SpomkyLabs\Pki\CryptoEncoding\PEM;
use SpomkyLabs\Pki\CryptoTypes\Asymmetric\EC\ECPrivateKey;
use SpomkyLabs\Pki\CryptoTypes\Asymmetric\EC\ECPublicKey;
use Throwable;
use function array_key_exists;
use function is_string;
/**
* @internal
*/
final class ECKey
{
private array $values = [];
private function __construct(array $data)
{
$this->loadJWK($data);
}
public static function createFromPEM(string $pem): self
{
$data = self::loadPEM($pem);
return new self($data);
}
public static function toPublic(self $private): self
{
$data = $private->toArray();
if (array_key_exists('d', $data)) {
unset($data['d']);
}
return new self($data);
}
/**
* @return array
*/
public function toArray()
{
return $this->values;
}
private static function loadPEM(string $data): array
{
$pem = PEM::fromString($data);
try {
$key = ECPrivateKey::fromPEM($pem);
return [
'kty' => 'EC',
'crv' => self::getCurve($key->namedCurve()),
'd' => Base64UrlSafe::encodeUnpadded($key->privateKeyOctets()),
'x' => Base64UrlSafe::encodeUnpadded($key->publicKey()->curvePointOctets()[0]),
'y' => Base64UrlSafe::encodeUnpadded($key->publicKey()->curvePointOctets()[1]),
];
} catch (Throwable) {
}
try {
$key = ECPublicKey::fromPEM($pem);
return [
'kty' => 'EC',
'crv' => self::getCurve($key->namedCurve()),
'x' => Base64UrlSafe::encodeUnpadded($key->curvePointOctets()[0]),
'y' => Base64UrlSafe::encodeUnpadded($key->curvePointOctets()[1]),
];
} catch (Throwable) {
}
throw new InvalidArgumentException('Unable to load the key.');
}
private static function getCurve(string $oid): string
{
$curves = self::getSupportedCurves();
$curve = array_search($oid, $curves, true);
if (! is_string($curve)) {
throw new InvalidArgumentException('Unsupported OID.');
}
return $curve;
}
private static function getSupportedCurves(): array
{
return [
'P-256' => '1.2.840.10045.3.1.7',
'P-384' => '1.3.132.0.34',
'P-521' => '1.3.132.0.35',
];
}
private function loadJWK(array $jwk): void
{
$keys = [
'kty' => 'The key parameter "kty" is missing.',
'crv' => 'Curve parameter is missing',
'x' => 'Point parameters are missing.',
'y' => 'Point parameters are missing.',
];
foreach ($keys as $k => $v) {
if (! array_key_exists($k, $jwk)) {
throw new InvalidArgumentException($v);
}
}
if ($jwk['kty'] !== 'EC') {
throw new InvalidArgumentException('JWK is not an Elliptic Curve key.');
}
$this->values = $jwk;
}
}

View File

@ -0,0 +1,419 @@
<?php
declare(strict_types=1);
namespace Jose\Component\KeyManagement\KeyConverter;
use Brick\Math\BigInteger;
use InvalidArgumentException;
use Jose\Component\Core\Util\Base64UrlSafe;
use OpenSSLCertificate;
use ParagonIE\Sodium\Core\Ed25519;
use RuntimeException;
use SpomkyLabs\Pki\CryptoEncoding\PEM;
use SpomkyLabs\Pki\CryptoTypes\AlgorithmIdentifier\AlgorithmIdentifier;
use SpomkyLabs\Pki\CryptoTypes\Asymmetric\PrivateKey;
use SpomkyLabs\Pki\CryptoTypes\Asymmetric\PublicKey;
use SpomkyLabs\Pki\CryptoTypes\Asymmetric\RSA\RSASSAPSSPrivateKey;
use Throwable;
use function array_key_exists;
use function assert;
use function count;
use function extension_loaded;
use function in_array;
use function is_array;
use function is_string;
use const E_ERROR;
use const E_PARSE;
use const OPENSSL_KEYTYPE_EC;
use const OPENSSL_KEYTYPE_RSA;
use const OPENSSL_RAW_DATA;
use const PREG_PATTERN_ORDER;
/**
* @internal
*/
final class KeyConverter
{
public static function loadKeyFromCertificateFile(string $file): array
{
if (! file_exists($file)) {
throw new InvalidArgumentException(sprintf('File "%s" does not exist.', $file));
}
$content = file_get_contents($file);
if (! is_string($content)) {
throw new InvalidArgumentException(sprintf('File "%s" cannot be read.', $file));
}
return self::loadKeyFromCertificate($content);
}
public static function loadKeyFromCertificate(string $certificate): array
{
if (! extension_loaded('openssl')) {
throw new RuntimeException('Please install the OpenSSL extension');
}
$errorReporting = error_reporting(E_ERROR | E_PARSE);
try {
$res = openssl_x509_read($certificate);
if ($res === false) {
throw new InvalidArgumentException('Unable to load the certificate.');
}
} catch (Throwable) {
$certificate = self::convertDerToPem($certificate);
$res = openssl_x509_read($certificate);
} finally {
error_reporting($errorReporting);
}
if ($res === false) {
throw new InvalidArgumentException('Unable to load the certificate.');
}
return self::loadKeyFromX509Resource($res);
}
public static function loadKeyFromX509Resource(OpenSSLCertificate $res): array
{
if (! extension_loaded('openssl')) {
throw new RuntimeException('Please install the OpenSSL extension');
}
$key = openssl_pkey_get_public($res);
if ($key === false) {
throw new InvalidArgumentException('Unable to load the certificate.');
}
$details = openssl_pkey_get_details($key);
if (! is_array($details)) {
throw new InvalidArgumentException('Unable to load the certificate');
}
if (isset($details['key'])) {
$values = self::loadKeyFromPEM($details['key']);
openssl_x509_export($res, $out);
$x5c = preg_replace('#-.*-#', '', (string) $out);
$x5c = preg_replace('~\R~', '', (string) $x5c);
if (! is_string($x5c)) {
throw new InvalidArgumentException('Unable to load the certificate');
}
$x5c = trim($x5c);
$x5tsha1 = openssl_x509_fingerprint($res, 'sha1', true);
$x5tsha256 = openssl_x509_fingerprint($res, 'sha256', true);
if (! is_string($x5tsha1) || ! is_string($x5tsha256)) {
throw new InvalidArgumentException('Unable to compute the certificate fingerprint');
}
$values['x5c'] = [$x5c];
$values['x5t'] = Base64UrlSafe::encodeUnpadded($x5tsha1);
$values['x5t#256'] = Base64UrlSafe::encodeUnpadded($x5tsha256);
return $values;
}
throw new InvalidArgumentException('Unable to load the certificate');
}
public static function loadFromKeyFile(string $file, ?string $password = null): array
{
$content = file_get_contents($file);
if (! is_string($content)) {
throw new InvalidArgumentException('Unable to load the key from the file.');
}
return self::loadFromKey($content, $password);
}
public static function loadFromKey(string $key, ?string $password = null): array
{
try {
return self::loadKeyFromDER($key, $password);
} catch (Throwable) {
return self::loadKeyFromPEM($key, $password);
}
}
/**
* Be careful! The certificate chain is loaded, but it is NOT VERIFIED by any mean! It is mandatory to verify the
* root CA or intermediate CA are trusted. If not done, it may lead to potential security issues.
*/
public static function loadFromX5C(array $x5c): array
{
if (! extension_loaded('openssl')) {
throw new RuntimeException('Please install the OpenSSL extension');
}
if (count($x5c) === 0) {
throw new InvalidArgumentException('The certificate chain is empty');
}
foreach ($x5c as $id => $cert) {
$x5c[$id] = '-----BEGIN CERTIFICATE-----' . "\n" . chunk_split(
(string) $cert,
64,
"\n"
) . '-----END CERTIFICATE-----';
$x509 = openssl_x509_read($x5c[$id]);
if ($x509 === false) {
throw new InvalidArgumentException('Unable to load the certificate chain');
}
$parsed = openssl_x509_parse($x509);
if ($parsed === false) {
throw new InvalidArgumentException('Unable to load the certificate chain');
}
}
return self::loadKeyFromCertificate(reset($x5c));
}
private static function loadKeyFromDER(string $der, ?string $password = null): array
{
$pem = self::convertDerToPem($der);
return self::loadKeyFromPEM($pem, $password);
}
private static function loadKeyFromPEM(string $pem, ?string $password = null): array
{
if (! extension_loaded('openssl')) {
throw new RuntimeException('Please install the OpenSSL extension');
}
if (preg_match('#DEK-Info: (.+),(.+)#', $pem, $matches) === 1) {
$pem = self::decodePem($pem, $matches, $password);
}
if (preg_match('#BEGIN ENCRYPTED PRIVATE KEY(.+)(.+)#', $pem) === 1) {
$decrypted = openssl_pkey_get_private($pem, $password);
if ($decrypted === false) {
throw new InvalidArgumentException('Unable to decrypt the key.');
}
openssl_pkey_export($decrypted, $pem);
}
self::sanitizePEM($pem);
$res = openssl_pkey_get_private($pem);
if ($res === false) {
$res = openssl_pkey_get_public($pem);
}
if ($res === false) {
throw new InvalidArgumentException('Unable to load the key.');
}
$details = openssl_pkey_get_details($res);
if (! is_array($details) || ! array_key_exists('type', $details)) {
throw new InvalidArgumentException('Unable to get details of the key');
}
return match ($details['type']) {
OPENSSL_KEYTYPE_EC => self::tryToLoadECKey($pem),
OPENSSL_KEYTYPE_RSA => RSAKey::createFromPEM($pem)->toArray(),
-1 => self::tryToLoadOtherKeyTypes($pem),
default => throw new InvalidArgumentException('Unsupported key type'),
};
}
/**
* This method tries to load Ed448, X488, Ed25519 and X25519 keys.
*/
private static function tryToLoadECKey(string $input): array
{
try {
return ECKey::createFromPEM($input)->toArray();
} catch (Throwable) {
}
try {
return self::tryToLoadOtherKeyTypes($input);
} catch (Throwable) {
}
throw new InvalidArgumentException('Unable to load the key.');
}
/**
* This method tries to load Ed448, X488, Ed25519 and X25519 keys.
*/
private static function tryToLoadOtherKeyTypes(string $input): array
{
$pem = PEM::fromString($input);
return match ($pem->type()) {
PEM::TYPE_PUBLIC_KEY => self::loadPublicKey($pem),
PEM::TYPE_PRIVATE_KEY => self::loadPrivateKey($pem),
default => throw new InvalidArgumentException('Unsupported key type'),
};
}
/**
* @return array<string, mixed>
*/
private static function loadPrivateKey(PEM $pem): array
{
try {
$key = PrivateKey::fromPEM($pem);
switch ($key->algorithmIdentifier()->oid()) {
case AlgorithmIdentifier::OID_RSASSA_PSS_ENCRYPTION:
assert($key instanceof RSASSAPSSPrivateKey);
return [
'kty' => 'RSA',
'n' => self::convertDecimalToBas64Url($key->modulus()),
'e' => self::convertDecimalToBas64Url($key->publicExponent()),
'd' => self::convertDecimalToBas64Url($key->privateExponent()),
'dp' => self::convertDecimalToBas64Url($key->exponent1()),
'dq' => self::convertDecimalToBas64Url($key->exponent2()),
'p' => self::convertDecimalToBas64Url($key->prime1()),
'q' => self::convertDecimalToBas64Url($key->prime2()),
'qi' => self::convertDecimalToBas64Url($key->coefficient()),
];
case AlgorithmIdentifier::OID_ED25519:
case AlgorithmIdentifier::OID_ED448:
case AlgorithmIdentifier::OID_X25519:
case AlgorithmIdentifier::OID_X448:
$curve = self::getCurve($key->algorithmIdentifier()->oid());
$values = [
'kty' => 'OKP',
'crv' => $curve,
'd' => Base64UrlSafe::encodeUnpadded($key->privateKeyData()),
];
return self::populatePoints($key, $values);
default:
throw new InvalidArgumentException('Unsupported key type');
}
} catch (Throwable $e) {
throw new InvalidArgumentException('Unable to load the key.', 0, $e);
}
}
/**
* @return array<string, mixed>
*/
private static function loadPublicKey(PEM $pem): array
{
$key = PublicKey::fromPEM($pem);
switch ($key->algorithmIdentifier()->oid()) {
case AlgorithmIdentifier::OID_ED25519:
case AlgorithmIdentifier::OID_ED448:
case AlgorithmIdentifier::OID_X25519:
case AlgorithmIdentifier::OID_X448:
$curve = self::getCurve($key->algorithmIdentifier()->oid());
self::checkType($curve);
return [
'kty' => 'OKP',
'crv' => $curve,
'x' => Base64UrlSafe::encodeUnpadded((string) $key->subjectPublicKey()),
];
default:
throw new InvalidArgumentException('Unsupported key type');
}
}
private static function convertDecimalToBas64Url(string $decimal): string
{
return Base64UrlSafe::encodeUnpadded(BigInteger::fromBase($decimal, 10)->toBytes());
}
/**
* @param array<string, mixed> $values
* @return array<string, mixed>
*/
private static function populatePoints(PrivateKey $key, array $values): array
{
$crv = $values['crv'] ?? null;
assert(is_string($crv), 'Unsupported key type.');
$x = self::getPublicKey($key, $crv);
if ($x !== null) {
$values['x'] = Base64UrlSafe::encodeUnpadded($x);
}
return $values;
}
private static function getPublicKey(PrivateKey $key, string $crv): ?string
{
switch ($crv) {
case 'Ed25519':
return Ed25519::publickey_from_secretkey($key->privateKeyData());
case 'X25519':
if (extension_loaded('sodium')) {
return sodium_crypto_scalarmult_base($key->privateKeyData());
}
// no break
default:
return null;
}
}
private static function checkType(string $curve): void
{
$curves = ['Ed448ph', 'Ed25519ph', 'Ed448', 'Ed25519', 'X448', 'X25519'];
in_array($curve, $curves, true) || throw new InvalidArgumentException('Unsupported key type.');
}
/**
* This method modifies the PEM to get 64 char lines and fix bug with old OpenSSL versions.
*/
private static function getCurve(string $oid): string
{
return match ($oid) {
'1.3.101.115' => 'Ed448ph',
'1.3.101.114' => 'Ed25519ph',
'1.3.101.113' => 'Ed448',
'1.3.101.112' => 'Ed25519',
'1.3.101.111' => 'X448',
'1.3.101.110' => 'X25519',
default => throw new InvalidArgumentException('Unsupported key type.'),
};
}
/**
* This method modifies the PEM to get 64 char lines and fix bug with old OpenSSL versions.
*/
private static function sanitizePEM(string &$pem): void
{
$number = preg_match_all('#(-.*-)#', $pem, $matches, PREG_PATTERN_ORDER);
if ($number !== 2) {
throw new InvalidArgumentException('Unable to load the key');
}
$ciphertext = preg_replace('#-.*-|\r|\n| #', '', $pem);
$pem = $matches[0][0] . "\n";
$pem .= chunk_split($ciphertext ?? '', 64, "\n");
$pem .= $matches[0][1] . "\n";
}
/**
* @param string[] $matches
*/
private static function decodePem(string $pem, array $matches, ?string $password = null): string
{
if ($password === null) {
throw new InvalidArgumentException('Password required for encrypted keys.');
}
$iv = pack('H*', trim($matches[2]));
$iv_sub = mb_substr($iv, 0, 8, '8bit');
$symkey = pack('H*', md5($password . $iv_sub));
$symkey .= pack('H*', md5($symkey . $password . $iv_sub));
$key = preg_replace('#^(?:Proc-Type|DEK-Info): .*#m', '', $pem);
$ciphertext = base64_decode(preg_replace('#-.*-|\r|\n#', '', $key ?? '') ?? '', true);
if (! is_string($ciphertext)) {
throw new InvalidArgumentException('Unable to encode the data.');
}
$decoded = openssl_decrypt($ciphertext, mb_strtolower($matches[1]), $symkey, OPENSSL_RAW_DATA, $iv);
if ($decoded === false) {
throw new RuntimeException('Unable to decrypt the key');
}
$number = preg_match_all('#-{5}.*-{5}#', $pem, $result);
if ($number !== 2) {
throw new InvalidArgumentException('Unable to load the key');
}
$pem = $result[0][0] . "\n";
$pem .= chunk_split(base64_encode($decoded), 64);
return $pem . ($result[0][1] . "\n");
}
private static function convertDerToPem(string $der_data): string
{
$pem = chunk_split(base64_encode($der_data), 64, "\n");
return '-----BEGIN CERTIFICATE-----' . "\n" . $pem . '-----END CERTIFICATE-----' . "\n";
}
}

View File

@ -0,0 +1,233 @@
<?php
declare(strict_types=1);
namespace Jose\Component\KeyManagement\KeyConverter;
use InvalidArgumentException;
use Jose\Component\Core\JWK;
use Jose\Component\Core\Util\Base64UrlSafe;
use Jose\Component\Core\Util\BigInteger;
use RuntimeException;
use function array_key_exists;
use function extension_loaded;
use function in_array;
use function is_array;
/**
* @internal
*/
final class RSAKey
{
private array $values = [];
private function __construct(array $data)
{
$this->loadJWK($data);
}
public static function createFromKeyDetails(array $details): self
{
$values = [
'kty' => 'RSA',
];
$keys = [
'n' => 'n',
'e' => 'e',
'd' => 'd',
'p' => 'p',
'q' => 'q',
'dp' => 'dmp1',
'dq' => 'dmq1',
'qi' => 'iqmp',
];
foreach ($details as $key => $value) {
if (in_array($key, $keys, true)) {
$value = Base64UrlSafe::encodeUnpadded($value);
$values[array_search($key, $keys, true)] = $value;
}
}
return new self($values);
}
public static function createFromPEM(string $pem): self
{
if (! extension_loaded('openssl')) {
throw new RuntimeException('Please install the OpenSSL extension');
}
$res = openssl_pkey_get_private($pem);
if ($res === false) {
$res = openssl_pkey_get_public($pem);
}
if ($res === false) {
throw new InvalidArgumentException('Unable to load the key.');
}
$details = openssl_pkey_get_details($res);
if (! is_array($details) || ! isset($details['rsa'])) {
throw new InvalidArgumentException('Unable to load the key.');
}
return self::createFromKeyDetails($details['rsa']);
}
public static function createFromJWK(JWK $jwk): self
{
return new self($jwk->all());
}
public function isPublic(): bool
{
return ! array_key_exists('d', $this->values);
}
public static function toPublic(self $private): self
{
$data = $private->toArray();
$keys = ['p', 'd', 'q', 'dp', 'dq', 'qi'];
foreach ($keys as $key) {
if (array_key_exists($key, $data)) {
unset($data[$key]);
}
}
return new self($data);
}
public function toArray(): array
{
return $this->values;
}
public function toJwk(): JWK
{
return new JWK($this->values);
}
/**
* This method will try to add Chinese Remainder Theorem (CRT) parameters. With those primes, the decryption process
* is really fast.
*/
public function optimize(): void
{
if (array_key_exists('d', $this->values)) {
$this->populateCRT();
}
}
private function loadJWK(array $jwk): void
{
if (! array_key_exists('kty', $jwk)) {
throw new InvalidArgumentException('The key parameter "kty" is missing.');
}
if ($jwk['kty'] !== 'RSA') {
throw new InvalidArgumentException('The JWK is not a RSA key.');
}
$this->values = $jwk;
}
/**
* This method adds Chinese Remainder Theorem (CRT) parameters if primes 'p' and 'q' are available. If 'p' and 'q'
* are missing, they are computed and added to the key data.
*/
private function populateCRT(): void
{
if (! array_key_exists('p', $this->values) && ! array_key_exists('q', $this->values)) {
$d = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['d']));
$e = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['e']));
$n = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['n']));
[$p, $q] = $this->findPrimeFactors($d, $e, $n);
$this->values['p'] = Base64UrlSafe::encodeUnpadded($p->toBytes());
$this->values['q'] = Base64UrlSafe::encodeUnpadded($q->toBytes());
}
if (array_key_exists('dp', $this->values) && array_key_exists('dq', $this->values) && array_key_exists(
'qi',
$this->values
)) {
return;
}
$one = BigInteger::createFromDecimal(1);
$d = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['d']));
$p = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['p']));
$q = BigInteger::createFromBinaryString(Base64UrlSafe::decodeNoPadding($this->values['q']));
$this->values['dp'] = Base64UrlSafe::encodeUnpadded($d->mod($p->subtract($one))->toBytes());
$this->values['dq'] = Base64UrlSafe::encodeUnpadded($d->mod($q->subtract($one))->toBytes());
$this->values['qi'] = Base64UrlSafe::encodeUnpadded($q->modInverse($p)->toBytes());
}
/**
* @return BigInteger[]
*/
private function findPrimeFactors(BigInteger $d, BigInteger $e, BigInteger $n): array
{
$zero = BigInteger::createFromDecimal(0);
$one = BigInteger::createFromDecimal(1);
$two = BigInteger::createFromDecimal(2);
$k = $d->multiply($e)
->subtract($one);
if ($k->isEven()) {
$r = $k;
$t = $zero;
do {
$r = $r->divide($two);
$t = $t->add($one);
} while ($r->isEven());
$found = false;
$y = null;
for ($i = 1; $i <= 100; ++$i) {
$g = BigInteger::random($n->subtract($one));
$y = $g->modPow($r, $n);
if ($y->equals($one) || $y->equals($n->subtract($one))) {
continue;
}
for ($j = $one; $j->lowerThan($t->subtract($one)); $j = $j->add($one)) {
$x = $y->modPow($two, $n);
if ($x->equals($one)) {
$found = true;
break;
}
if ($x->equals($n->subtract($one))) {
continue;
}
$y = $x;
}
$x = $y->modPow($two, $n);
if ($x->equals($one)) {
$found = true;
break;
}
}
if ($y === null) {
throw new InvalidArgumentException('Unable to find prime factors.');
}
if ($found === true) {
$p = $y->subtract($one)
->gcd($n);
$q = $n->divide($p);
return [$p, $q];
}
}
throw new InvalidArgumentException('Unable to find prime factors.');
}
}