Skip to content

Add customizable hash algorithm for generating certificate ID #32

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

Merged
merged 1 commit into from
Mar 19, 2025
Merged

Add customizable hash algorithm for generating certificate ID #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions src/ocsp/Ocsp.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
use phpseclib3\File\X509;
use web_eid\web_eid_authtoken_validation_php\ocsp\exceptions\OcspCertificateException;
use web_eid\web_eid_authtoken_validation_php\util\AsnUtil;
use web_eid\web_eid_authtoken_validation_php\util\HashAlgorithm;

class Ocsp
{
Expand Down Expand Up @@ -65,7 +66,8 @@ class Ocsp
*/
public function generateCertificateId(
X509 $certificate,
X509 $issuerCertificate
X509 $issuerCertificate,
HashAlgorithm $hashAlgorithm = HashAlgorithm::SHA1
): array {
AsnUtil::loadOIDs();

Expand All @@ -87,9 +89,7 @@ public function generateCertificateId(
);
}

$certificateId["serialNumber"] = clone $certificate->getCurrentCert()[
"tbsCertificate"
]["serialNumber"];
$certificateId["serialNumber"] = clone $certificate->getCurrentCert()["tbsCertificate"]["serialNumber"];

// issuer name
if (
Expand All @@ -109,7 +109,7 @@ public function generateCertificateId(
"subject"
];
$issuerEncoded = ASN1::encodeDER($issuer, Name::MAP);
$certificateId["issuerNameHash"] = hash("sha1", $issuerEncoded, true);
$certificateId["issuerNameHash"] = hash($hashAlgorithm->value, $issuerEncoded, true);

// issuer public key
if (
Expand All @@ -129,12 +129,12 @@ public function generateCertificateId(
"subjectPublicKeyInfo"
]["subjectPublicKey"];
$certificateId["issuerKeyHash"] = hash(
"sha1",
$hashAlgorithm->value,
AsnUtil::extractKeyData($publicKey),
true
);

$certificateId["hashAlgorithm"]["algorithm"] = Asn1::getOID("id-sha1");
$certificateId["hashAlgorithm"]["algorithm"] = Asn1::getOID("id-" . $hashAlgorithm->value);

return $certificateId;
}
Expand Down
19 changes: 15 additions & 4 deletions src/util/AsnUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,20 @@ public static function isSignatureInAsn1Format(string $signature): bool

// ASN.1 format: 0x30 b1 0x02 b2 r 0x02 b3 s.
// Note: unpack() returns an array indexed from 1, not 0.
if(!isset($sigByteArray[1]) ||
if (
!isset($sigByteArray[1]) ||
!isset($sigByteArray[2]) ||
!isset($sigByteArray[3]) ||
!isset($sigByteArray[4])) {
!isset($sigByteArray[4])
) {
return false;
}
$b1 = $sigByteArray[2];
$b2 = $sigByteArray[4];
if(!isset($sigByteArray[5 + $b2]) ||
!isset($sigByteArray[6 + $b2])) {
if (
!isset($sigByteArray[5 + $b2]) ||
!isset($sigByteArray[6 + $b2])
) {
return false;
}
$b3 = $sigByteArray[6 + $b2];
Expand Down Expand Up @@ -108,6 +112,13 @@ public static function loadOIDs(): void
ASN1::loadOIDs([
"id-pkix-ocsp-nonce" => self::ID_PKIX_OCSP_NONCE,
"id-sha1" => "1.3.14.3.2.26",
'id-sha256' => '2.16.840.1.101.3.4.2.1',
'id-sha384' => '2.16.840.1.101.3.4.2.2',
'id-sha512' => '2.16.840.1.101.3.4.2.3',
'id-sha224' => '2.16.840.1.101.3.4.2.4',
'id-sha512/224' => '2.16.840.1.101.3.4.2.5',
'id-sha512/256' => '2.16.840.1.101.3.4.2.6',
'id-mgf1' => '1.2.840.113549.1.1.8',
"sha256WithRSAEncryption" => "1.2.840.113549.1.1.11",
"qcStatements(3)" => "1.3.6.1.5.5.7.1.3",
"street" => "2.5.4.9",
Expand Down
15 changes: 15 additions & 0 deletions src/util/HashAlgorithm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

namespace web_eid\web_eid_authtoken_validation_php\util;

enum HashAlgorithm: string
{
case SHA1 = "sha1";
case SHA256 = "sha256";
case SHA384 = "sha384";
case SHA512 = "sha512";
case SHA224 = "sha224";
case SHA512_224 = "sha512/224";
case SHA512_256 = "sha512/256";
case MGF1 = "mgf1";
}
14 changes: 14 additions & 0 deletions tests/ocsp/OcspTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
use PHPUnit\Framework\TestCase;
use web_eid\web_eid_authtoken_validation_php\ocsp\certificate\CertificateLoader;
use web_eid\web_eid_authtoken_validation_php\ocsp\exceptions\OcspCertificateException;
use web_eid\web_eid_authtoken_validation_php\util\HashAlgorithm;

class OcspTest extends TestCase
{
Expand All @@ -43,6 +44,19 @@ public function testWhenGenerateCertificateIdIsSuccess(): void
$this->assertEquals([168, 74, 106, 99, 4, 125, 221, 186, 230, 209, 57, 183, 166, 69, 101, 239, 243, 168, 236, 161], array_values(unpack('C*', $result['issuerKeyHash'])));
}

public function testWhenGenerateCertificateIdWithSha256IsSuccess(): void
{
$result = (new Ocsp)->generateCertificateId(
(new CertificateLoader)->fromFile(__DIR__ . '/../_resources/revoked.crt')->getCert(),
(new CertificateLoader)->fromFile(__DIR__ . '/../_resources/revoked.issuer.crt')->getCert(),
HashAlgorithm::SHA256
);

$this->assertEquals("2.16.840.1.101.3.4.2.1", $result['hashAlgorithm']['algorithm']);
$this->assertEquals([95, 66, 108, 14, 230, 221, 220, 19, 204, 150, 46, 50, 249, 230, 243, 173, 85, 145, 220, 162, 11, 98, 80, 34, 131, 168, 252, 178, 130, 128, 58, 168], array_values(unpack('C*', $result['issuerNameHash'])));
$this->assertEquals([171, 181, 182, 119, 64, 116, 118, 100, 255, 11, 197, 252, 216, 32, 39, 48, 158, 67, 174, 62, 32, 137, 104, 62, 240, 236, 220, 228, 44, 99, 167, 49], array_values(unpack('C*', $result['issuerKeyHash'])));
}

public function testWhenMissingSerialNumberInSubjectCertificateThrow(): void
{

Expand Down