Add TrustAnchorConfig abstraction value

Author: cicnavi

src/ValueAbstracts/TrustAnchorConfig.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\OpenID\ValueAbstracts;
+
+use SimpleSAML\OpenID\Codebooks\ClaimsEnum;
+use SimpleSAML\OpenID\Exceptions\JwksException;
+
+class TrustAnchorConfig
+{
+    /**
+     * @param non-empty-string $entityId Trust Anchor Entity ID
+     * @param string|null $jwks Trust Anchor's JWKS JSON object string value, or
+     * null. If JWKS is provided, it can be used to validate Trust Anchor
+     * Configuration Statement in addition to using JWKS acquired during Trust
+     * Chain resolution. If JWKS is not provided, the validity of Trust Anchor
+     * Configuration Statement will "only" be validated by the JWKS acquired
+     * during Trust Chain resolution. This means that security will rely "only"
+     * on protection implied from using TLS on endpoints used during
+     * Trust Chain resolution.
+     */
+    public function __construct(
+        protected readonly string $entityId,
+        protected readonly ?string $jwks = null,
+    ) {
+    }
+
+
+    /**
+     * @return non-empty-string
+     */
+    public function getEntityId(): string
+    {
+        return $this->entityId;
+    }
+
+
+    public function getJwks(): ?string
+    {
+        return $this->jwks;
+    }
+
+
+    /**
+     * @return array{keys:non-empty-array<mixed>}|null
+     * @throws \SimpleSAML\OpenID\Exceptions\JwksException
+     */
+    public function getJwksAsArray(): ?array
+    {
+        if (is_string($this->jwks)) {
+            $jwks = json_decode($this->jwks, true);
+
+            if (
+                is_array($jwks) &&
+                array_key_exists(ClaimsEnum::Keys->value, $jwks) &&
+                is_array($jwks[ClaimsEnum::Keys->value]) &&
+                $jwks[ClaimsEnum::Keys->value] !== []
+            ) {
+                return $jwks;
+            }
+
+            throw new JwksException('Invalid JWKS JSON object.');
+        }
+
+        return null;
+    }
+}

src/ValueAbstracts/TrustAnchorConfigBag.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\OpenID\ValueAbstracts;
+
+use Traversable;
+
+/**
+ * @implements \IteratorAggregate<non-empty-string,\SimpleSAML\OpenID\ValueAbstracts\TrustAnchorConfig>
+ */
+class TrustAnchorConfigBag implements \IteratorAggregate
+{
+    /**
+     * @var array<non-empty-string,\SimpleSAML\OpenID\ValueAbstracts\TrustAnchorConfig>
+     */
+    protected array $trustAnchorConfigs;
+
+
+    public function __construct(
+        TrustAnchorConfig ...$trustAnchorConfigs,
+    ) {
+        $this->add(...$trustAnchorConfigs);
+    }
+
+
+    public function add(TrustAnchorConfig ...$trustAnchorConfigs): void
+    {
+        foreach ($trustAnchorConfigs as $trustAnchorConfig) {
+            $this->trustAnchorConfigs[$trustAnchorConfig->getEntityId()] = $trustAnchorConfig;
+        }
+    }
+
+
+    public function getByEntityId(string $entityId): ?TrustAnchorConfig
+    {
+        return $this->trustAnchorConfigs[$entityId] ?? null;
+    }
+
+
+    /**
+     * @return array<non-empty-string,\SimpleSAML\OpenID\ValueAbstracts\TrustAnchorConfig>
+     */
+    public function getAll(): array
+    {
+        return $this->trustAnchorConfigs;
+    }
+
+
+    /**
+     * @return \ArrayIterator<string,\SimpleSAML\OpenID\ValueAbstracts\TrustAnchorConfig>
+     */
+    public function getIterator(): Traversable
+    {
+        return new \ArrayIterator($this->getAll());
+    }
+}

src/ValueAbstracts/UniqueStringBag.php

@@ -4,7 +4,10 @@
 
 namespace SimpleSAML\OpenID\ValueAbstracts;
 
-class UniqueStringBag implements \JsonSerializable
+/**
+ * @implements \IteratorAggregate<int, string>
+ */
+class UniqueStringBag implements \JsonSerializable, \IteratorAggregate
 {
     /**
      * @var string[]
@@ -15,7 +18,16 @@ class UniqueStringBag implements \JsonSerializable
     public function __construct(
         string ...$values,
     ) {
-        $this->values = $values;
+        $this->add(...$values);
+    }
+
+
+    /**
+     * @return \ArrayIterator<int, string>
+     */
+    public function getIterator(): \ArrayIterator
+    {
+        return new \ArrayIterator($this->values);
     }
 
 

tests/src/ValueAbstracts/UniqueStringBagTest.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\OpenID\ValueAbstracts;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\OpenID\ValueAbstracts\UniqueStringBag;
+
+#[CoversClass(UniqueStringBag::class)]
+final class UniqueStringBagTest extends TestCase
+{
+    protected array $sampleValues = ['foo', 'bar'];
+
+
+    protected function sut(
+        ?array $values = null,
+    ): UniqueStringBag {
+        $values ??= $this->sampleValues;
+
+        return new UniqueStringBag(...$values);
+    }
+
+
+    public function testIsIterable(): void
+    {
+        $bag = $this->sut();
+
+        $this->assertInstanceOf(\Traversable::class, $bag);
+
+        $result = [];
+        foreach ($bag as $item) {
+            $result[] = $item;
+        }
+
+        $this->assertSame(['foo', 'bar'], $result);
+    }
+}