Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for PHP 8.1 compatibility #59

Merged
merged 3 commits into from
Feb 14, 2022
Merged

Fix for PHP 8.1 compatibility #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc46e19
Fix for PHP 8.1 compatibility
kelvinmo Feb 14, 2022
3ea247f
Throw exception if PEM format not supported
kelvinmo Feb 14, 2022
d7ad1f6
Update Changelog
kelvinmo Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to this project will be documented in this file.

## Unreleased

- Fixed: Compatibility with PHP 8.1 when using ECDH (#58)

## 0.6.1

- Changed: JWT::deserialise() no longer takes a `$format` parameter (which
Expand Down
62 changes: 56 additions & 6 deletions src/SimpleJWT/Keys/ECKey.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ class ECKey extends Key {

const KTY = 'EC';

const PEM_PRIVATE = '/-----BEGIN EC PRIVATE KEY-----([^-:]+)-----END EC PRIVATE KEY-----/';
const PEM_RFC5915_PRIVATE = '/-----BEGIN EC PRIVATE KEY-----([^-:]+)-----END EC PRIVATE KEY-----/';
const PEM_PKCS8_PRIVATE = '/-----BEGIN PRIVATE KEY-----([^-:]+)-----END PRIVATE KEY-----/'; // used by PHP 8.1

const EC_OID = '1.2.840.10045.2.1';
const P256_OID = '1.2.840.10045.3.1.7';
Expand Down Expand Up @@ -149,23 +150,22 @@ public function __construct($data, $format, $password = null, $alg = 'PBES2-HS25
$jwk['crv'] = $curve;
$jwk['x'] = Util::base64url_encode($x);
$jwk['y'] = Util::base64url_encode($y);
} elseif (preg_match(self::PEM_PRIVATE, $data, $matches)) {
} elseif (preg_match(self::PEM_RFC5915_PRIVATE, $data, $matches)) {
/** @var string|bool $der */
$der = base64_decode($matches[1]);

if ($der === FALSE) throw new KeyException('Cannot read PEM key');

$offset += ASN1::readDER($der, $offset, $data); // SEQUENCE
$offset += ASN1::readDER($der, $offset, $version); // INTEGER

if (ord($version) != 1) throw new KeyException('Invalid private key version');
if (ord($version) != 1) throw new KeyException('Invalid private key version: ' . ord($version));

$offset += ASN1::readDER($der, $offset, $d); // OCTET STRING [d]

$offset += ASN1::readDER($der, $offset, $data); // SEQUENCE[0]
$offset += ASN1::readDER($der, $offset, $curve_oid); // OBJECT IDENTIFIER - parameters
$curve_oid = ASN1::decodeOID($curve_oid);
$curve = $this->getCurveNameFromOID($curve_oid);
$curve = self::getCurveNameFromOID($curve_oid);
if ($curve == null) throw new KeyException('Unrecognised EC parameter: ' . $curve_oid);

$len = self::$curves[$curve]['len'];
Expand All @@ -184,6 +184,56 @@ public function __construct($data, $format, $password = null, $alg = 'PBES2-HS25
$jwk['d'] = Util::base64url_encode($d);
$jwk['x'] = Util::base64url_encode($x);
$jwk['y'] = Util::base64url_encode($y);
} elseif (preg_match(self::PEM_PKCS8_PRIVATE, $data, $matches)) {
/** @var string|bool $der */
$der = base64_decode($matches[1]);
if ($der === FALSE) throw new KeyException('Cannot read PEM key');

$offset += ASN1::readDER($der, $offset, $data); // SEQUENCE
$offset += ASN1::readDER($der, $offset, $version); // INTEGER

if (ord($version) != 0) throw new KeyException('Invalid private key version: ' . ord($version));

$offset += ASN1::readDER($der, $offset, $data); // SEQUENCE
$offset += ASN1::readDER($der, $offset, $key_oid); // OBJECT IDENTIFIER - id-ecPublicKey

if (ASN1::decodeOID($key_oid) != self::EC_OID) throw new KeyException('Invalid key type: ' . ASN1::decodeOID($key_oid));

$offset += ASN1::readDER($der, $offset, $curve_oid); // OBJECT IDENTIFIER - parameters
$curve_oid = ASN1::decodeOID($curve_oid);
$curve = self::getCurveNameFromOID($curve_oid);
if ($curve == null) throw new KeyException('Unrecognised EC parameter: ' . $curve_oid);

$len = self::$curves[$curve]['len'];

$offset += ASN1::readDER($der, $offset, $private_key); // OCTET STRING [privateKey]

// Parse the octet string
$offset = 0;
$offset += ASN1::readDER($private_key, $offset, $data); // SEQUENCE
$offset += ASN1::readDER($private_key, $offset, $version); // INTEGER

if (ord($version) != 1) throw new KeyException('Invalid private key version: ' . ord($version));

$offset += ASN1::readDER($private_key, $offset, $d); // OCTET STRING [d]

$offset += ASN1::readDER($private_key, $offset, $data); // SEQUENCE[0]
$offset += ASN1::readDER($private_key, $offset, $point); // BIT STRING - ECPoint

if (strlen($point) != $len + 1) throw new KeyException('Incorrect private key length: ' . strlen($point));

if (ord($point[0]) != 0x04) throw new KeyException('Invalid private key'); // W

$x = substr($point, 1, $len / 2);
$y = substr($point, 1 + $len / 2);

$jwk['kty'] = self::KTY;
$jwk['crv'] = $curve;
$jwk['d'] = Util::base64url_encode($d);
$jwk['x'] = Util::base64url_encode($x);
$jwk['y'] = Util::base64url_encode($y);
} else {
throw new KeyException('Unrecognised key format');
}

parent::__construct($jwk);
Expand Down Expand Up @@ -296,7 +346,7 @@ protected function getThumbnailMembers() {
return ['crv', 'kty', 'x', 'y'];
}

private function getCurveNameFromOID(string $curve_oid): ?string {
private static function getCurveNameFromOID(string $curve_oid): ?string {
foreach (self::$curves as $crv => $params) {
if ($params['oid'] == $curve_oid) return $crv;
}
Expand Down
5 changes: 4 additions & 1 deletion src/SimpleJWT/Keys/KeyFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class KeyFactory {
/** @var array<string, string> $pem_map */
static $pem_map = [
RSAKey::PEM_PRIVATE => 'SimpleJWT\Keys\RSAKey',
ECKey::PEM_PRIVATE => 'SimpleJWT\Keys\ECKey'
ECKey::PEM_RFC5915_PRIVATE => 'SimpleJWT\Keys\ECKey'
];

/** @var array<string, string> $oid_map */
Expand Down Expand Up @@ -166,6 +166,9 @@ static public function create($data, $format = null, $password = null, $alg = 'P
return new $cls($data, 'pem');
}
}

// TODO - it's probably PKCS#8, which uses BEGIN PRIVATE KEY
throw new KeyException('PEM key format not supported');
}
}

Expand Down