Enable building JwksDecorator from JwkDecorators

Author: cicnavi

src/Jwk/Factories/JwkDecoratorFactory.php

@@ -32,6 +32,7 @@ public function fromPkcs1Or8KeyFile(
     ): JwkDecorator {
         return new JwkDecorator(
             JWKFactory::createFromKeyFile($path, $password, $additionalData),
+            $additionalData,
         );
     }
 
@@ -47,6 +48,7 @@ public function fromPkcs1Or8Key(
     ): JwkDecorator {
         return new JwkDecorator(
             JWKFactory::createFromKey($key, $password, $additionalData),
+            $additionalData,
         );
     }
 
@@ -62,6 +64,7 @@ public function fromPkcs12CertificateFile(
     ): JwkDecorator {
         return new JwkDecorator(
             JWKFactory::createFromPKCS12CertificateFile($path, $password, $additionalData),
+            $additionalData,
         );
     }
 
@@ -76,6 +79,7 @@ public function fromX509CertificateFile(
     ): JwkDecorator {
         return new JwkDecorator(
             JWKFactory::createFromCertificateFile($path, $additionalData),
+            $additionalData,
         );
     }
 
@@ -90,6 +94,7 @@ public function fromX509Certificate(
     ): JwkDecorator {
         return new JwkDecorator(
             JWKFactory::createFromCertificate($certificate, $additionalData),
+            $additionalData,
         );
     }
 }

src/Jwk/JwkDecorator.php

@@ -6,10 +6,14 @@
 
 use Jose\Component\Core\JWK;
 
-class JwkDecorator
+class JwkDecorator implements \JsonSerializable
 {
+    /**
+     * @param mixed[] $additionalData
+     */
     public function __construct(
         protected readonly JWK $jwk,
+        protected readonly array $additionalData = [],
     ) {
     }
 
@@ -18,4 +22,22 @@ public function jwk(): JWK
     {
         return $this->jwk;
     }
+
+
+    /**
+     * @return mixed[]
+     */
+    public function getAdditionalData(): array
+    {
+        return $this->additionalData;
+    }
+
+
+    /**
+     * @return mixed[]
+     */
+    public function jsonSerialize(): array
+    {
+        return array_merge($this->jwk->jsonSerialize(), $this->additionalData);
+    }
 }

src/Jwks/Factories/JwksDecoratorFactory.php

@@ -5,15 +5,29 @@
 namespace SimpleSAML\OpenID\Jwks\Factories;
 
 use Jose\Component\Core\JWKSet;
+use SimpleSAML\OpenID\Jwk\JwkDecorator;
 use SimpleSAML\OpenID\Jwks\JwksDecorator;
 
 class JwksDecoratorFactory
 {
     /**
-     * @phpstan-ignore missingType.iterableValue (JWKS array is validated later)
+     * @param mixed[] $jwks JWKS array (validated later)
      */
     public function fromKeySetData(array $jwks): JwksDecorator
     {
         return new JwksDecorator(JWKSet::createFromKeyData($jwks));
     }
+
+
+    public function fromJwkDecorators(JwkDecorator ...$jwkDecorators): JwksDecorator
+    {
+        $jwks = [
+            'keys' => array_map(
+                fn (JwkDecorator $jwkDecorator): array => $jwkDecorator->jsonSerialize(),
+                $jwkDecorators,
+            ),
+        ];
+
+        return $this->fromKeySetData($jwks);
+    }
 }

tests/src/CoreTest.php

@@ -13,6 +13,7 @@
 use SimpleSAML\OpenID\Algorithms\AlgorithmManagerDecorator;
 use SimpleSAML\OpenID\Core;
 use SimpleSAML\OpenID\Core\Factories\ClientAssertionFactory;
+use SimpleSAML\OpenID\Core\Factories\IdTokenFactory;
 use SimpleSAML\OpenID\Core\Factories\RequestObjectFactory;
 use SimpleSAML\OpenID\Decorators\DateIntervalDecorator;
 use SimpleSAML\OpenID\Factories\AlgorithmManagerDecoratorFactory;
@@ -43,6 +44,7 @@
 #[UsesClass(JwsVerifierDecorator::class)]
 #[UsesClass(JwsSerializerManagerDecorator::class)]
 #[UsesClass(ClaimFactory::class)]
+#[UsesClass(IdTokenFactory::class)]
 final class CoreTest extends TestCase
 {
     protected MockObject $supportedAlgorithmsMock;
@@ -105,5 +107,10 @@ public function testCanBuildTools(): void
             ClientAssertionFactory::class,
             $sut->clientAssertionFactory(),
         );
+
+        $this->assertInstanceOf(
+            IdTokenFactory::class,
+            $sut->idTokenFactory(),
+        );
     }
 }

tests/src/Jwk/JwkDecoratorTest.php

@@ -15,6 +15,8 @@ final class JwkDecoratorTest extends TestCase
 {
     protected MockObject $jwkMock;
 
+    protected array $additionalData = [];
+
 
     protected function setUp(): void
     {
@@ -24,10 +26,12 @@ protected function setUp(): void
 
     protected function sut(
         ?JWK $jwk = null,
+        ?array $additionalData = null,
     ): JwkDecorator {
         $jwk ??= $this->jwkMock;
+        $additionalData ??= $this->additionalData;
 
-        return new JwkDecorator($jwk);
+        return new JwkDecorator($jwk, $additionalData);
     }
 
 
@@ -47,4 +51,22 @@ public function testCanGetJwk(): void
             $this->sut()->jwk(),
         );
     }
+
+
+    public function testCanGetAdditionalData(): void
+    {
+        $this->additionalData = ['foo' => 'bar'];
+
+        $this->assertSame($this->additionalData, $this->sut()->getAdditionalData());
+    }
+
+
+    public function testCanJsonSerialize(): void
+    {
+        $this->jwkMock->expects($this->once())->method('jsonSerialize')
+            ->willReturn(['a' => 'b']);
+        $this->additionalData = ['foo' => 'bar'];
+
+        $this->assertSame(['a' => 'b', 'foo' => 'bar'], $this->sut()->jsonSerialize());
+    }
 }

tests/src/Jwks/Factories/JwksDecoratorFactoryTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
+use SimpleSAML\OpenID\Jwk\JwkDecorator;
 use SimpleSAML\OpenID\Jwks;
 use SimpleSAML\OpenID\Jwks\Factories\JwksDecoratorFactory;
 use SimpleSAML\OpenID\Jwks\JwksDecorator;
@@ -52,4 +53,20 @@ public function testCanBuildFromKeyData(): void
     {
         $this->assertInstanceOf(Jwks\JwksDecorator::class, $this->sut()->fromKeySetData($this->jwksArraySample));
     }
+
+
+    public function testCanBuildFromJwkDecorators(): void
+    {
+        $key1 = $this->createMock(JwkDecorator::class);
+        $key2 = $this->createMock(JwkDecorator::class);
+        $key1->expects($this->once())->method('jsonSerialize')->willReturn(['kty' => 'RSA']);
+        $key2->expects($this->once())->method('jsonSerialize')->willReturn(['kty' => 'EC']);
+
+        $jwksDecorator = $this->sut()->fromJwkDecorators($key1, $key2);
+
+        $this->assertSame(
+            ['keys' => [['kty' => 'RSA'], ['kty' => 'EC']]],
+            $jwksDecorator->jsonSerialize(),
+        );
+    }
 }