Add new informational metadata claims

Author: cicnavi

UPGRADE.md

@@ -52,10 +52,15 @@ and optionally a port (as in all previous module versions).
   - signer algorithm
   - entity statement duration
   - organization name
+  - display name
+  - description
+  - keywords
   - contacts
   - logo URI
   - policy URI
-  - homepage URI
+  - information URI
+  - homepage URI (renamed to organization_uri in draft-43)
+  - organization URI
 
 ## Major impact changes
 

config/module_oidc.php.dist

@@ -471,10 +471,21 @@ $config = [
     // Common federation entity parameters:
     // https://openid.net/specs/openid-federation-1_0.html#name-common-metadata-parameters
     ModuleConfig::OPTION_ORGANIZATION_NAME => null,
+    ModuleConfig::OPTION_DISPLAY_NAME => null,
+    ModuleConfig::OPTION_DESCRIPTION => null,
+    ModuleConfig::OPTION_KEYWORDS => [
+        // 'some-keyword',
+    ],
     ModuleConfig::OPTION_CONTACTS => [
         // 'John Doe [email protected]',
     ],
     ModuleConfig::OPTION_LOGO_URI => null,
     ModuleConfig::OPTION_POLICY_URI => null,
+    ModuleConfig::OPTION_INFORMATION_URI => null,
+    ModuleConfig::OPTION_ORGANIZATION_URI => null,
+    /**
+     * @deprecated In Draft-43 of OIDFed specification, metadata claim 'homepage_uri' has been renamed to
+     * 'organization_uri'. Use 'organization_uri' instead.
+     */
     ModuleConfig::OPTION_HOMEPAGE_URI => null,
 ];

src/Controllers/Federation/EntityStatementController.php

@@ -88,10 +88,14 @@ public function configuration(): Response
                         ...(array_filter(
                             [
                                 ClaimsEnum::OrganizationName->value => $this->moduleConfig->getOrganizationName(),
+                                ClaimsEnum::DisplayName->value => $this->moduleConfig->getDisplayName(),
+                                ClaimsEnum::Description->value => $this->moduleConfig->getDescription(),
+                                ClaimsEnum::Keywords->value => $this->moduleConfig->getKeywords(),
                                 ClaimsEnum::Contacts->value => $this->moduleConfig->getContacts(),
                                 ClaimsEnum::LogoUri->value => $this->moduleConfig->getLogoUri(),
                                 ClaimsEnum::PolicyUri->value => $this->moduleConfig->getPolicyUri(),
-                                ClaimsEnum::HomepageUri->value => $this->moduleConfig->getHomepageUri(),
+                                ClaimsEnum::InformationUri->value => $this->moduleConfig->getInformationUri(),
+                                ClaimsEnum::OrganizationUri->value => $this->moduleConfig->getOrganizationUri(),
                             ],
                         )),
                         ClaimsEnum::FederationFetchEndpoint->value => $this->routes->urlFederationFetch(),

src/ModuleConfig.php

@@ -66,10 +66,15 @@ class ModuleConfig
     final public const OPTION_FEDERATION_ENTITY_STATEMENT_DURATION = 'federation_entity_statement_duration';
     final public const OPTION_FEDERATION_AUTHORITY_HINTS = 'federation_authority_hints';
     final public const OPTION_ORGANIZATION_NAME = 'organization_name';
+    final public const OPTION_DISPLAY_NAME = 'display_name';
+    final public const OPTION_DESCRIPTION = 'description';
+    final public const OPTION_KEYWORDS = 'keywords';
     final public const OPTION_CONTACTS = 'contacts';
     final public const OPTION_LOGO_URI = 'logo_uri';
     final public const OPTION_POLICY_URI = 'policy_uri';
+    final public const OPTION_INFORMATION_URI = 'information_uri';
     final public const OPTION_HOMEPAGE_URI = 'homepage_uri';
+    final public const OPTION_ORGANIZATION_URI = 'organization_uri';
     final public const OPTION_FEDERATION_ENABLED = 'federation_enabled';
     final public const OPTION_FEDERATION_CACHE_ADAPTER = 'federation_cache_adapter';
     final public const OPTION_FEDERATION_CACHE_ADAPTER_ARGUMENTS = 'federation_cache_adapter_arguments';
@@ -651,6 +656,42 @@ public function getOrganizationName(): ?string
         );
     }
 
+    public function getDisplayName(): ?string
+    {
+        return $this->config()->getOptionalString(
+            self::OPTION_DISPLAY_NAME,
+            null,
+        );
+    }
+
+    public function getDescription(): ?string
+    {
+        return $this->config()->getOptionalString(
+            self::OPTION_DESCRIPTION,
+            null,
+        );
+    }
+
+    /**
+     * JSON array with one or more strings representing search keywords, tags, categories, or labels that
+     * apply to this Entity.
+     *
+     * @return ?string[]
+     */
+    public function getKeywords(): ?array
+    {
+        $keywords = $this->config()->getOptionalArray(
+            self::OPTION_KEYWORDS,
+            null,
+        );
+
+        if (is_null($keywords)) {
+            return null;
+        }
+
+        return array_filter($keywords, fn($keyword) => is_string($keyword));
+    }
+
     public function getContacts(): ?array
     {
         return $this->config()->getOptionalArray(
@@ -675,6 +716,21 @@ public function getPolicyUri(): ?string
         );
     }
 
+    public function getInformationUri(): ?string
+    {
+        return $this->config()->getOptionalString(
+            self::OPTION_INFORMATION_URI,
+            null,
+        );
+    }
+
+    /**
+     * @return string|null
+     * TODO mivanci v7 Remove in next major release, as well as config constant.
+     * In Draft-43 of OIDFed specification, metadata claim 'homepage_uri' has been renamed to
+     *  'organization_uri'. Use 'organization_uri' instead.
+     * @see self::getOrganizationUri()
+     */
     public function getHomepageUri(): ?string
     {
         return $this->config()->getOptionalString(
@@ -683,6 +739,14 @@ public function getHomepageUri(): ?string
         );
     }
 
+    public function getOrganizationUri(): ?string
+    {
+        return $this->config()->getOptionalString(
+            self::OPTION_ORGANIZATION_URI,
+            null,
+        );
+    }
+
     public function getFederationCacheAdapterClass(): ?string
     {
         return $this->config()->getOptionalString(self::OPTION_FEDERATION_CACHE_ADAPTER, null);

tests/config/module_oidc.php

@@ -107,10 +107,15 @@
     ModuleConfig::OPTION_FEDERATION_TOKEN_SIGNER => Sha256::class,
 
     ModuleConfig::OPTION_ORGANIZATION_NAME => 'Foo corp',
+    ModuleConfig::OPTION_DISPLAY_NAME => 'Foo corp',
+    ModuleConfig::OPTION_DESCRIPTION => 'Foo provider',
+    ModuleConfig::OPTION_KEYWORDS => ['openid', 'oidc', 'op', 'federation'],
     ModuleConfig::OPTION_CONTACTS => [
         'John Doe [email protected]',
     ],
     ModuleConfig::OPTION_LOGO_URI => 'https://example.org/logo',
     ModuleConfig::OPTION_POLICY_URI => 'https://example.org/policy',
+    ModuleConfig::OPTION_INFORMATION_URI => 'https://example.org/info',
     ModuleConfig::OPTION_HOMEPAGE_URI => 'https://example.org',
+    ModuleConfig::OPTION_ORGANIZATION_URI => 'https://example.org',
 ];

tests/unit/src/ModuleConfigTest.php

@@ -239,17 +239,33 @@ public function testCanGetCommonFederationOptions(): void
         $this->assertNotEmpty($this->sut()->getFederationAuthorityHints());
         $this->assertNotEmpty($this->sut()->getFederationTrustMarkTokens());
         $this->assertNotEmpty($this->sut()->getOrganizationName());
+        $this->assertNotEmpty($this->sut()->getDisplayName());
+        $this->assertNotEmpty($this->sut()->getDescription());
+        $this->assertNotEmpty($this->sut()->getKeywords());
         $this->assertNotEmpty($this->sut()->getContacts());
         $this->assertNotEmpty($this->sut()->getLogoUri());
         $this->assertNotEmpty($this->sut()->getPolicyUri());
+        $this->assertNotEmpty($this->sut()->getInformationUri());
         $this->assertNotEmpty($this->sut()->getHomepageUri());
+        $this->assertNotEmpty($this->sut()->getOrganizationUri());
         $this->assertNotEmpty($this->sut()->getFederationCacheAdapterClass());
         $this->assertIsArray($this->sut()->getFederationCacheAdapterArguments());
         $this->assertNotEmpty($this->sut()->getFederationCacheMaxDurationForFetched());
         $this->assertNotEmpty($this->sut()->getFederationTrustAnchors());
         $this->assertNotEmpty($this->sut()->getFederationTrustAnchorIds());
     }
 
+    public function testKeywordsCanBeNull(): void
+    {
+        $this->assertNull(
+            $this->sut(
+                overrides: [
+                    ModuleConfig::OPTION_KEYWORDS => null,
+                ],
+            )->getKeywords(),
+        );
+    }
+
     public function testGetFederationTrustAnchorsThrowsOnEmptyIfFederationEnabled(): void
     {
         $this->expectException(ConfigurationError::class);