Skip to content

adds support for brainpoolP256r1 #646

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

Open
robertboeser wants to merge 2 commits into
base: 4.2.x
Choose a base branch
from
Open

adds support for brainpoolP256r1 #646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bc4c64
add support for brainpoolP256r1
robertboeser Nov 19, 2025
5552240
fixed some styling
robertboeser Nov 20, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ infection.txt
.castor.stub.php
/tmp*
/.ci-tools/coverage
/var/cache
7 changes: 6 additions & 1 deletion src/Library/Core/Util/ECKey.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@
use InvalidArgumentException;
use Jose\Component\Core\JWK;
use RuntimeException;

use function extension_loaded;
use function is_array;
use function is_string;
use function sprintf;

use const OPENSSL_KEYTYPE_EC;
use const STR_PAD_LEFT;

Expand All @@ -32,6 +34,7 @@ public static function convertPublicKeyToPEM(JWK $jwk): string
{
$der = match ($jwk->get('crv')) {
'P-256' => self::p256PublicKey(),
'BP-256' => self::p256PublicKey(),
Copy link
Member

@Spomky Spomky Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct as the OID is different for BP public keys

Copy link
Member

@Spomky Spomky Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be as follows:

  private static function bp256PublicKey(): string
  {
      return pack(
          'H*',
          '305a' // SEQUENCE, length 90
          . '3014' // SEQUENCE, length 20
          . '0607' // OID, length 7
          . '2a8648ce3d0201' // 1.2.840.10045.2.1 = EC Public Key
          . '0609' // OID, length 9
          . '2b2403030208010107' // 1.3.36.3.3.2.8.1.1.7 = brainpoolP256r1
          . '0342' // BIT STRING, length 66
          . '00' // prepend with NUL
      );
  }

'secp256k1' => self::p256KPublicKey(),
'P-384' => self::p384PublicKey(),
'P-521' => self::p521PublicKey(),
Expand All @@ -48,6 +51,7 @@ public static function convertPrivateKeyToPEM(JWK $jwk): string
{
$der = match ($jwk->get('crv')) {
'P-256' => self::p256PrivateKey($jwk),
'BP-256' => self::p256PrivateKey($jwk),
Copy link
Member

@Spomky Spomky Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. The OID is different for BP private keys

Copy link
Member

@Spomky Spomky Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be as follows:

  private static function bp256PrivateKey(JWK $jwk): string
  {
      $d = $jwk->get('d');
      if (!is_string($d)) {
          throw new InvalidArgumentException('Unable to get the private key');
      }
      $d = unpack('H*', str_pad(Base64UrlSafe::decodeNoPadding($d), 32, "\0", STR_PAD_LEFT));
      if (!is_array($d) || !isset($d[1])) {
          throw new InvalidArgumentException('Unable to get the private key');
      }

      return pack(
          'H*',
          '3078' // SEQUENCE, length 120
          . '020101' // INTEGER, 1
          . '0420' // OCTET STRING, length 32
          . $d[1]
          . 'a00b' // TAGGED OBJECT #0, length 11
          . '0609' // OID, length 9
          . '2b2403030208010107' // 1.3.36.3.3.2.8.1.1.7
          . 'a144' // TAGGED OBJECT #1, length 68
          . '0342' // BIT STRING, length 66
          . '00'
      );
  }

'secp256k1' => self::p256KPrivateKey($jwk),
'P-384' => self::p384PrivateKey($jwk),
'P-521' => self::p521PrivateKey($jwk),
Expand Down Expand Up @@ -77,7 +81,7 @@ public static function createECKey(string $curve, array $values = []): JWK
private static function getNistCurveSize(string $curve): int
{
return match ($curve) {
'P-256', 'secp256k1' => 256,
'P-256', 'BP-256', 'secp256k1' => 256,
'P-384' => 384,
'P-521' => 521,
default => throw new InvalidArgumentException(sprintf('The curve "%s" is not supported.', $curve)),
Expand Down Expand Up @@ -130,6 +134,7 @@ private static function getOpensslCurveName(string $curve): string
{
return match ($curve) {
'P-256' => 'prime256v1',
'BP-256' => 'brainpoolP256r1',
'secp256k1' => 'secp256k1',
'P-384' => 'secp384r1',
'P-521' => 'secp521r1',
Expand Down
48 changes: 48 additions & 0 deletions src/Library/Core/Util/Ecc/BrainpoolCurve.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

declare(strict_types=1);

namespace Jose\Component\Core\Util\Ecc;

use Brick\Math\BigInteger;

/**
* Copyright (C) 2024 Robert Böser.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

/**
* @internal
*/
final class BrainpoolCurve
{
/**
* Returns an Brainpool BP-256 curve.
* RFC 5639 - brainpoolP256r1
*/
public static function curve256(): Curve
{
$p = BigInteger::fromBase('A9FB57DBA1EEA9BC3E660A909D838D726E3BF623D52620282013481D1F6E5377', 16);
$a = BigInteger::fromBase('7D5A0975FC2C3057EEF67530417AFFE7FB8055C126DC5C6CE94A4B44F330B5D9', 16);
$b = BigInteger::fromBase('26DC5C6CE94A4B44F330B5D9BBD77CBF958416295CF7E1CE6BCCDC18FF8C07B6', 16);
$x = BigInteger::fromBase('8BD2AEB9CB7E57CB2C4B482FFC81B7AFB9DE27E1E3BD23C23A4453BD9ACE3262', 16);
$y = BigInteger::fromBase('547EF835C3DAC4FD97F8461A14611DC9C27745132DED8E545C1D54C72F046997', 16);
$n = BigInteger::fromBase('A9FB57DBA1EEA9BC3E660A909D838D718C397AA3B561A6F7901E0E82974856A7', 16);
$generator = Point::create($x, $y, $n);

return new Curve(256, $p, $a, $b, $generator);
}

}
7 changes: 6 additions & 1 deletion src/Library/Encryption/Algorithm/KeyEncryption/AbstractECDH.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use InvalidArgumentException;
use Jose\Component\Core\JWK;
use Jose\Component\Core\Util\Base64UrlSafe;
use Jose\Component\Core\Util\Ecc\BrainpoolCurve;
use Jose\Component\Core\Util\Ecc\Curve;
use Jose\Component\Core\Util\Ecc\EcDH;
use Jose\Component\Core\Util\Ecc\NistCurve;
Expand All @@ -17,6 +18,7 @@
use Override;
use RuntimeException;
use Throwable;

use function array_key_exists;
use function extension_loaded;
use function function_exists;
Expand Down Expand Up @@ -83,6 +85,7 @@ protected function calculateAgreementKey(JWK $private_key, JWK $public_key): str
case 'P-256':
case 'P-384':
case 'P-521':
case 'BP-256':
$curve = $this->getCurve($crv);
if (function_exists('openssl_pkey_derive')) {
try {
Expand Down Expand Up @@ -158,7 +161,7 @@ protected function getKeysFromPublicKey(
throw new InvalidArgumentException('Invalid key parameter "crv"');
}
$private_key = match ($crv) {
'P-256', 'P-384', 'P-521' => $senderKey ?? ECKey::createECKey($crv),
'P-256', 'P-384', 'P-521', 'BP-256' => $senderKey ?? ECKey::createECKey($crv),
'X25519' => $senderKey ?? $this->createOKPKey('X25519'),
default => throw new InvalidArgumentException(sprintf('The curve "%s" is not supported', $crv)),
};
Expand Down Expand Up @@ -221,6 +224,7 @@ private function checkKey(JWK $key, bool $is_private): void
case 'P-256':
case 'P-384':
case 'P-521':
case 'BP-256':
if (! $key->has('y')) {
throw new InvalidArgumentException('The key parameter "y" is missing.');
}
Expand All @@ -244,6 +248,7 @@ private function getCurve(string $crv): Curve
'P-256' => NistCurve::curve256(),
'P-384' => NistCurve::curve384(),
'P-521' => NistCurve::curve521(),
'BP-256' => BrainpoolCurve::curve256(),
default => throw new InvalidArgumentException(sprintf('The curve "%s" is not supported', $crv)),
};
}
Expand Down
Loading