Improve the way OIDC tenants are grouped and their properties are gen…

…erated
quarkusio · Nov 8, 2024 · 48d61f7 · 48d61f7
1 parent d1c3ae8
commit 48d61f7
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 27 deletions.
diff --git a/.../runtime/src/main/java/io/quarkus/keycloak/pep/runtime/DefaultPolicyEnforcerResolver.java b/.../runtime/src/main/java/io/quarkus/keycloak/pep/runtime/DefaultPolicyEnforcerResolver.java
@@ -49,7 +49,7 @@ public class DefaultPolicyEnforcerResolver implements PolicyEnforcerResolver {
             this.tlsSupport = OidcTlsSupport.empty();
         }
 
-        var defaultTenantConfig = new OidcTenantConfig(oidcConfig.defaultTenant(), OidcUtils.DEFAULT_TENANT_ID);
+        var defaultTenantConfig = new OidcTenantConfig(OidcConfig.getDefaultTenant(oidcConfig), OidcUtils.DEFAULT_TENANT_ID);
         var defaultTenantTlsSupport = tlsSupport.forConfig(defaultTenantConfig.tls);
         this.defaultPolicyEnforcer = createPolicyEnforcer(defaultTenantConfig, config.defaultTenant(),
                 defaultTenantTlsSupport);

diff --git a/...ion/runtime/src/main/java/io/quarkus/keycloak/pep/runtime/KeycloakPolicyEnforcerUtil.java b/...ion/runtime/src/main/java/io/quarkus/keycloak/pep/runtime/KeycloakPolicyEnforcerUtil.java
@@ -226,7 +226,7 @@ private static boolean isNotComplexConfigKey(String key) {
 
     static OidcTenantConfig getOidcTenantConfig(OidcConfig oidcConfig, String tenant) {
         if (tenant == null || DEFAULT_TENANT_ID.equals(tenant)) {
-            return new OidcTenantConfig(oidcConfig.defaultTenant(), DEFAULT_TENANT_ID);
+            return new OidcTenantConfig(OidcConfig.getDefaultTenant(oidcConfig), DEFAULT_TENANT_ID);
         }
 
         var oidcTenantConfig = oidcConfig.namedTenants().get(tenant);

diff --git a/...n/runtime/src/main/java/io/quarkus/oidc/common/runtime/config/OidcClientCommonConfig.java b/...n/runtime/src/main/java/io/quarkus/oidc/common/runtime/config/OidcClientCommonConfig.java
@@ -4,6 +4,7 @@
 import java.util.Optional;
 
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
+import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigGroup;
 import io.smallrye.config.WithDefault;
 
@@ -38,8 +39,12 @@ public interface OidcClientCommonConfig extends OidcCommonConfig {
     /**
      * Credentials the OIDC adapter uses to authenticate to the OIDC server.
      */
+    @ConfigDocSection
     Credentials credentials();
 
+    /**
+     * Credentials the OIDC adapter uses to authenticate to the OIDC server.
+     */
     interface Credentials {
 
         /**

diff --git a/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/OidcBuildTimeConfig.java b/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/OidcBuildTimeConfig.java
@@ -1,6 +1,7 @@
 package io.quarkus.oidc.deployment;
 
 import io.quarkus.oidc.runtime.OidcConfig;
+import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
@@ -18,8 +19,9 @@ public interface OidcBuildTimeConfig {
     boolean enabled();
 
     /**
-     * Dev UI configuration.
+     * OIDC Dev UI configuration which is effective in dev mode only.
      */
+    @ConfigDocSection
     DevUiConfig devui();
 
     /**

diff --git a/extensions/oidc/deployment/src/test/java/io/quarkus/oidc/test/ProtectedResource.java b/extensions/oidc/deployment/src/test/java/io/quarkus/oidc/test/ProtectedResource.java
@@ -45,7 +45,7 @@ public void logout() {
     @Path("access-token-name")
     @GET
     public String accessTokenName() {
-        if (!config.defaultTenant().authentication().verifyAccessToken()) {
+        if (!OidcConfig.getDefaultTenant(config).authentication().verifyAccessToken()) {
             throw new IllegalStateException("Access token verification should be enabled");
         }
         return accessToken.getName();

diff --git a/...dc/deployment/src/test/java/io/quarkus/oidc/test/ProtectedResourceWithJwtAccessToken.java b/...dc/deployment/src/test/java/io/quarkus/oidc/test/ProtectedResourceWithJwtAccessToken.java
@@ -26,6 +26,6 @@ public class ProtectedResourceWithJwtAccessToken {
 
     @GET
     public String getName() {
-        return idToken.getName() + ":" + config.defaultTenant().authentication().verifyAccessToken();
+        return idToken.getName() + ":" + OidcConfig.getDefaultTenant(config).authentication().verifyAccessToken();
     }
 }
diff --git a/...deployment/src/test/java/io/quarkus/oidc/test/ProtectedResourceWithoutJwtAccessToken.java b/...deployment/src/test/java/io/quarkus/oidc/test/ProtectedResourceWithoutJwtAccessToken.java
@@ -23,6 +23,6 @@ public class ProtectedResourceWithoutJwtAccessToken {
 
     @GET
     public String getName() {
-        return idToken.getName() + ":" + config.defaultTenant().authentication().verifyAccessToken();
+        return idToken.getName() + ":" + OidcConfig.getDefaultTenant(config).authentication().verifyAccessToken();
     }
 }
diff --git a/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/BackChannelLogoutHandler.java b/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/BackChannelLogoutHandler.java
@@ -37,7 +37,7 @@ public BackChannelLogoutHandler(OidcConfig oidcConfig) {
     }
 
     public void setup(@Observes Router router) {
-        addRoute(router, new OidcTenantConfig(oidcConfig.defaultTenant(), OidcUtils.DEFAULT_TENANT_ID));
+        addRoute(router, new OidcTenantConfig(OidcConfig.getDefaultTenant(oidcConfig), OidcUtils.DEFAULT_TENANT_ID));
 
         for (var nameToOidcTenantConfig : oidcConfig.namedTenants().entrySet()) {
             addRoute(router, new OidcTenantConfig(nameToOidcTenantConfig.getValue(), nameToOidcTenantConfig.getKey()));

diff --git a/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcConfig.java b/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcConfig.java
@@ -10,31 +10,31 @@
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
 import io.smallrye.config.WithDefault;
+import io.smallrye.config.WithDefaults;
 import io.smallrye.config.WithParentName;
+import io.smallrye.config.WithUnnamedKey;
 
 @ConfigMapping(prefix = "quarkus.oidc")
 @ConfigRoot(phase = ConfigPhase.RUN_TIME)
 public interface OidcConfig {
 
-    /**
-     * The default tenant.
-     */
-    @WithParentName
-    OidcTenantConfig defaultTenant();
+    String DEFAULT_TENANT_KEY = "<default>";
 
     /**
      * Additional named tenants.
      */
-    @ConfigDocSection
     @ConfigDocMapKey("tenant")
     @WithParentName
+    @WithUnnamedKey(DEFAULT_TENANT_KEY)
+    @WithDefaults
     Map<String, OidcTenantConfig> namedTenants();
 
     /**
-     * Default TokenIntrospection and UserInfo Cache configuration which is used for all the tenants if it is enabled
-     * with the build-time 'quarkus.oidc.default-token-cache-enabled' property ('true' by default) and also activated,
-     * see its `max-size` property.
+     * Default TokenIntrospection and UserInfo Cache configuration.
+     * It is used for all the tenants if it is enabled with the build-time 'quarkus.oidc.default-token-cache-enabled' property
+     * ('true' by default) and also activated, see its `max-size` property.
      */
+    @ConfigDocSection
     TokenCache tokenCache();
 
     /**
@@ -66,4 +66,13 @@ interface TokenCache {
          */
         Optional<Duration> cleanUpTimerInterval();
     }
+
+    static io.quarkus.oidc.runtime.OidcTenantConfig getDefaultTenant(OidcConfig config) {
+        for (var tenant : config.namedTenants().entrySet()) {
+            if (OidcConfig.DEFAULT_TENANT_KEY.equals(tenant.getKey())) {
+                return tenant.getValue();
+            }
+        }
+        return null;
+    }
 }
diff --git a/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcRecorder.java b/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcRecorder.java
@@ -111,7 +111,7 @@ public TenantConfigBean setup(OidcConfig config, Vertx vertxValue, OidcTlsSuppor
             boolean userInfoInjectionPointDetected) {
         OidcRecorder.userInfoInjectionPointDetected = userInfoInjectionPointDetected;
 
-        var defaultTenant = new OidcTenantConfig(config.defaultTenant(), DEFAULT_TENANT_ID);
+        var defaultTenant = new OidcTenantConfig(OidcConfig.getDefaultTenant(config), DEFAULT_TENANT_ID);
         String defaultTenantId = defaultTenant.getTenantId().get();
         var defaultTenantInitializer = createStaticTenantContextCreator(vertxValue, defaultTenant,
                 !config.namedTenants().isEmpty(), defaultTenantId, tlsSupport);
@@ -120,6 +120,9 @@ public TenantConfigBean setup(OidcConfig config, Vertx vertxValue, OidcTlsSuppor
 
         Map<String, TenantConfigContext> staticTenantsConfig = new HashMap<>();
         for (var tenant : config.namedTenants().entrySet()) {
+            if (OidcConfig.DEFAULT_TENANT_KEY.equals(tenant.getKey())) {
+                continue;
+            }
             var namedTenantConfig = new OidcTenantConfig(tenant.getValue(), tenant.getKey());
             OidcCommonUtils.verifyConfigurationId(defaultTenantId, tenant.getKey(), namedTenantConfig.getTenantId());
             var staticTenantInitializer = createStaticTenantContextCreator(vertxValue, namedTenantConfig, false,
@@ -709,7 +712,7 @@ private TenantSpecificOidcIdentityProvider(String tenantId) {
             this.blockingExecutor = Arc.container().instance(BlockingSecurityExecutor.class).get();
             if (tenantId.equals(DEFAULT_TENANT_ID)) {
                 OidcConfig config = Arc.container().instance(OidcConfig.class).get();
-                this.tenantId = config.defaultTenant().tenantId().orElse(OidcUtils.DEFAULT_TENANT_ID);
+                this.tenantId = OidcConfig.getDefaultTenant(config).tenantId().orElse(OidcUtils.DEFAULT_TENANT_ID);
             } else {
                 this.tenantId = tenantId;
             }

diff --git a/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcTenantConfig.java b/extensions/oidc/runtime/src/main/java/io/quarkus/oidc/runtime/OidcTenantConfig.java
@@ -16,6 +16,7 @@
 import io.quarkus.oidc.common.runtime.config.OidcCommonConfig;
 import io.quarkus.runtime.annotations.ConfigDocDefault;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
+import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.configuration.TrimmedStringConverter;
 import io.quarkus.security.identity.SecurityIdentityAugmentor;
 import io.smallrye.config.WithConverter;
@@ -103,14 +104,16 @@ public interface OidcTenantConfig extends OidcClientCommonConfig {
     Optional<String> publicKey();
 
     /**
-     * Introspection Basic Authentication which must be configured only if the introspection is required
-     * and OpenId Connect Provider does not support the OIDC client authentication configured with
+     * Optional introspection endpoint-specific authentication configuration.
+     * It must be configured only if the introspection is required
+     * but OpenId Connect Provider does not support the OIDC client authentication configured with
      * {@link OidcCommonConfig#credentials} for its introspection endpoint.
      */
+    @ConfigDocSection
     IntrospectionCredentials introspectionCredentials();
 
     /**
-     * Introspection Basic Authentication configuration
+     * Optional introspection endpoint-specific authentication configuration.
      */
     interface IntrospectionCredentials {
         /**
@@ -132,18 +135,21 @@ interface IntrospectionCredentials {
     }
 
     /**
-     * Configuration to find and parse a custom claim containing the roles information.
+     * Configuration to find and parse custom claims which contain roles.
      */
+    @ConfigDocSection
     Roles roles();
 
     /**
-     * Configuration how to validate the token claims.
+     * Configuration to customize validation of token claims.
      */
+    @ConfigDocSection
     Token token();
 
     /**
-     * RP Initiated, BackChannel and FrontChannel Logout configuration
+     * RP-initiated, back-channel and front-channel logout configuration.
      */
+    @ConfigDocSection
     Logout logout();
 
     /**
@@ -161,8 +167,12 @@ interface IntrospectionCredentials {
      * If the truststore does not have the leaf certificate imported, then the leaf certificate must be identified by its Common
      * Name.
      */
+    @ConfigDocSection
     CertificateChain certificateChain();
 
+    /**
+     * Configuration of the certificate chain which can be used to verify tokens.
+     */
     interface CertificateChain {
         /**
          * Common name of the leaf certificate. It must be set if the {@link #trustStoreFile} does not have
@@ -196,18 +206,21 @@ interface CertificateChain {
     }
 
     /**
-     * Different options to configure authorization requests
+     * Configuration for managing an authorization code flow.
      */
+    @ConfigDocSection
     Authentication authentication();
 
     /**
-     * Authorization code grant configuration
+     * Configuration to complete an authorization code flow grant.
      */
+    @ConfigDocSection
     CodeGrant codeGrant();
 
     /**
      * Default token state manager configuration
      */
+    @ConfigDocSection
     TokenStateManager tokenStateManager();
 
     /**

diff --git a/integration-tests/oidc-wiremock/src/main/java/io/quarkus/it/keycloak/OidcEventResource.java b/integration-tests/oidc-wiremock/src/main/java/io/quarkus/it/keycloak/OidcEventResource.java
@@ -16,7 +16,7 @@ public class OidcEventResource {
     private final String expectedAuthServerUrl;
 
     public OidcEventResource(OidcEventObserver oidcEventObserver, OidcConfig oidcConfig) {
-        this.expectedAuthServerUrl = dropTrailingSlash(oidcConfig.defaultTenant().authServerUrl().get());
+        this.expectedAuthServerUrl = dropTrailingSlash(OidcConfig.getDefaultTenant(oidcConfig).authServerUrl().get());
         this.oidcEventObserver = oidcEventObserver;
     }