From 51760fde170e2cd35d2fbad4b07474f4a8e0c887 Mon Sep 17 00:00:00 2001 From: Steve Hawkins Date: Mon, 4 Aug 2025 14:28:55 -0400 Subject: [PATCH] enhance: adding the ability to get the root config from a Scope closes: #36268 Signed-off-by: Steve Hawkins --- core/src/main/java/org/keycloak/Config.java | 13 +++++++++++++ .../DefaultCacheEmbeddedConfigProviderFactory.java | 4 +--- .../java/org/keycloak/config/MetricsOptions.java | 13 ------------- .../configuration/MicroProfileConfigProvider.java | 9 +++++++++ .../mappers/MetricsPropertyMappers.java | 9 --------- .../runtime/configuration/ConfigurationTest.java | 12 ++++++++++-- .../org/keycloak/component/ComponentModelScope.java | 11 ++++++++--- .../java/org/keycloak/provider/ProviderFactory.java | 2 +- .../PasswordCredentialProviderFactory.java | 3 ++- .../java/org/keycloak/utils/JsonConfigProvider.java | 8 ++++++++ .../vault/PlainTextVaultProviderFactoryTest.java | 6 ++++++ 11 files changed, 58 insertions(+), 32 deletions(-) diff --git a/core/src/main/java/org/keycloak/Config.java b/core/src/main/java/org/keycloak/Config.java index 538f571a85cb..e48b7fa975ed 100755 --- a/core/src/main/java/org/keycloak/Config.java +++ b/core/src/main/java/org/keycloak/Config.java @@ -208,6 +208,11 @@ public Set getPropertyNames() { throw new UnsupportedOperationException("Not implemented"); } + @Override + public Scope root() { + return new SystemPropertiesScope("keycloak."); + } + } /** @@ -243,5 +248,13 @@ public static interface Scope { */ @Deprecated Set getPropertyNames(); + + /** + * Root {@link Scope} for global options. The key format should match exactly what + * is expected to appear in the main configuration file - e.g. metrics-enabled, db, etc. + * + * @return a {@link Scope} with access to global configuration properties. + */ + Scope root(); } } diff --git a/model/infinispan/src/main/java/org/keycloak/spi/infinispan/impl/embedded/DefaultCacheEmbeddedConfigProviderFactory.java b/model/infinispan/src/main/java/org/keycloak/spi/infinispan/impl/embedded/DefaultCacheEmbeddedConfigProviderFactory.java index 3cb833cb1811..9c6f8e5d1bf0 100644 --- a/model/infinispan/src/main/java/org/keycloak/spi/infinispan/impl/embedded/DefaultCacheEmbeddedConfigProviderFactory.java +++ b/model/infinispan/src/main/java/org/keycloak/spi/infinispan/impl/embedded/DefaultCacheEmbeddedConfigProviderFactory.java @@ -73,7 +73,6 @@ public class DefaultCacheEmbeddedConfigProviderFactory implements CacheEmbeddedC // Configuration public static final String CONFIG = "configFile"; - private static final String METRICS = "metricsEnabled"; public static final String TRACING = "tracingEnabled"; private static final String HISTOGRAMS = "metricsHistogramsEnabled"; public static final String STACK = "stack"; @@ -119,7 +118,6 @@ public List getConfigMetadata() { var builder = ProviderConfigurationBuilder.create(); Util.copyFromOption(builder, CONFIG, "file", ProviderConfigProperty.STRING_TYPE, CachingOptions.CACHE_CONFIG_FILE, false); Util.copyFromOption(builder, HISTOGRAMS, "enabled", ProviderConfigProperty.BOOLEAN_TYPE, CachingOptions.CACHE_METRICS_HISTOGRAMS_ENABLED, false); - Util.copyFromOption(builder, METRICS, "enabled", ProviderConfigProperty.BOOLEAN_TYPE, MetricsOptions.INFINISPAN_METRICS_ENABLED, false); Stream.concat(Arrays.stream(LOCAL_CACHE_NAMES), Arrays.stream(CLUSTERED_MAX_COUNT_CACHES)) .forEach(name -> Util.copyFromOption(builder, CacheConfigurator.maxCountConfigKey(name), "max-count", ProviderConfigProperty.INTEGER_TYPE, CachingOptions.maxCountOption(name), false)); createTopologyProperties(builder); @@ -219,7 +217,7 @@ private static void singleSiteConfiguration(Config.Scope config, ConfigurationBu private static void configureMetrics(Config.Scope keycloakConfig, ConfigurationBuilderHolder holder) { //metrics are disabled by default (check MetricsOptions class) - if (keycloakConfig.getBoolean(METRICS, Boolean.FALSE)) { + if (keycloakConfig.root().getBoolean(MetricsOptions.METRICS_ENABLED.getKey(), Boolean.FALSE)) { logger.debug("Enabling Infinispan metrics"); var builder = holder.getGlobalConfigurationBuilder(); builder.addModule(MicrometerMeterRegisterConfigurationBuilder.class) diff --git a/quarkus/config-api/src/main/java/org/keycloak/config/MetricsOptions.java b/quarkus/config-api/src/main/java/org/keycloak/config/MetricsOptions.java index 72f748540281..3161150c3a9a 100644 --- a/quarkus/config-api/src/main/java/org/keycloak/config/MetricsOptions.java +++ b/quarkus/config-api/src/main/java/org/keycloak/config/MetricsOptions.java @@ -9,17 +9,4 @@ public class MetricsOptions { .defaultValue(Boolean.FALSE) .build(); - public static final Option PASSWORD_VALIDATION_COUNTER_ENABLED = new OptionBuilder<>("metrics-password-validation-counter-enabled", Boolean.class) - .category(OptionCategory.METRICS) - .description("If the server should publish counter metric for number of password validations performed.") - .defaultValue(Boolean.TRUE) - .hidden() // This is intended to be enabled all the time when global metrics are enabled, therefore this option is hidden - .build(); - - public static final Option INFINISPAN_METRICS_ENABLED = new OptionBuilder<>("infinispan-metrics-enabled", Boolean.class) - .category(OptionCategory.METRICS) - .description("If Infinispan metrics should be collected and exposed.") - .defaultValue(Boolean.FALSE) - .hidden() // Intentional, Infinispan metrics are enabled when '--metrics-enabled' are enabled. - .build(); } diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/MicroProfileConfigProvider.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/MicroProfileConfigProvider.java index 8e516dda3120..20c7bc1b92bb 100644 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/MicroProfileConfigProvider.java +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/MicroProfileConfigProvider.java @@ -26,6 +26,7 @@ import org.eclipse.microprofile.config.ConfigProvider; import org.keycloak.Config; +import org.keycloak.Config.Scope; public class MicroProfileConfigProvider implements Config.ConfigProvider { @@ -132,11 +133,19 @@ public Set getPropertyNames() { } private T getValue(String key, Class clazz, T defaultValue) { + if (NS_KEYCLOAK_PREFIX.equals(separatorPrefix)) { + return config.getOptionalValue(separatorPrefix.concat(key), clazz).orElse(defaultValue); + } String dashCase = toDashCase(key); return config.getOptionalValue(separatorPrefix.concat(dashCase), clazz) .or(() -> config.getOptionalValue(prefix.concat(dashCase), clazz)).orElse(defaultValue); } + @Override + public Scope root() { + return new MicroProfileScope(NS_KEYCLOAK_PREFIX); + } + } } diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java index 3dfce14864f9..65689a639b22 100644 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java @@ -16,15 +16,6 @@ public static PropertyMapper[] getMetricsPropertyMappers() { return new PropertyMapper[] { fromOption(MetricsOptions.METRICS_ENABLED) .to("quarkus.micrometer.enabled") - .build(), - fromOption(MetricsOptions.PASSWORD_VALIDATION_COUNTER_ENABLED) - .to("kc.spi-credential--keycloak-password--metrics-enabled") - .isEnabled(MetricsPropertyMappers::metricsEnabled, "metrics are enabled") - .build(), - fromOption(MetricsOptions.INFINISPAN_METRICS_ENABLED) - .mapFrom(MetricsOptions.METRICS_ENABLED) - .to("kc.spi-cache-embedded--default--metrics-enabled") - .isEnabled(MetricsPropertyMappers::metricsEnabled, "metrics are enabled") .build() }; } diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/ConfigurationTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/ConfigurationTest.java index f9c25c4fb63b..d4ee4dd54f0f 100644 --- a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/ConfigurationTest.java +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/ConfigurationTest.java @@ -61,7 +61,11 @@ public void testCamelCase() { putEnvVar("KC_SPI_CAMEL_CASE_SCOPE_CAMEL_CASE_PROP", "foobar"); initConfig(); String value = Config.scope("camelCaseScope").get("camelCaseProp"); - assertEquals(value, "foobar"); + assertEquals("foobar", value); + + // root should be at kc - users are not expected to obtain spi options this way + value = Config.scope().root().get("spi-camel-case-scope-camel-case-prop"); + assertEquals("foobar", value); } @Test @@ -69,7 +73,11 @@ public void testCamelCaseNewFormat() { putEnvVar("KC_SPI_CAMEL_CASE_SCOPE__CAMEL_CASE_PROP", "foobar"); initConfig(); String value = Config.scope("camelCaseScope").get("camelCaseProp"); - assertEquals(value, "foobar"); + assertEquals("foobar", value); + + // root should be at kc - users are not expected to obtain spi options this way + value = Config.scope().root().get("spi-camel-case-scope--camel-case-prop"); + assertEquals("foobar", value); } @Test diff --git a/server-spi-private/src/main/java/org/keycloak/component/ComponentModelScope.java b/server-spi-private/src/main/java/org/keycloak/component/ComponentModelScope.java index 43a0945dcf16..666527882fec 100644 --- a/server-spi-private/src/main/java/org/keycloak/component/ComponentModelScope.java +++ b/server-spi-private/src/main/java/org/keycloak/component/ComponentModelScope.java @@ -1,13 +1,13 @@ /* * Copyright 2021 Red Hat, Inc. and/or its affiliates * and other contributors as indicated by the @author tags. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -123,4 +123,9 @@ public ComponentModel getComponentModel() { return componentConfig; } + @Override + public Scope root() { + return this.origScope.root(); + } + } diff --git a/server-spi/src/main/java/org/keycloak/provider/ProviderFactory.java b/server-spi/src/main/java/org/keycloak/provider/ProviderFactory.java index 59e5ddf82f86..55bf1452fc2c 100755 --- a/server-spi/src/main/java/org/keycloak/provider/ProviderFactory.java +++ b/server-spi/src/main/java/org/keycloak/provider/ProviderFactory.java @@ -38,7 +38,7 @@ public interface ProviderFactory { T create(KeycloakSession session); /** - * Only called once when the factory is first created. This config is pulled from keycloak_server.json + * Only called once when the factory is first created. * * @param config */ diff --git a/services/src/main/java/org/keycloak/credential/PasswordCredentialProviderFactory.java b/services/src/main/java/org/keycloak/credential/PasswordCredentialProviderFactory.java index 95e30c1eb2cd..12fdbed301e1 100644 --- a/services/src/main/java/org/keycloak/credential/PasswordCredentialProviderFactory.java +++ b/services/src/main/java/org/keycloak/credential/PasswordCredentialProviderFactory.java @@ -20,6 +20,7 @@ import io.micrometer.core.instrument.Meter; import io.micrometer.core.instrument.Metrics; import org.keycloak.Config; +import org.keycloak.config.MetricsOptions; import org.keycloak.models.KeycloakSession; import org.keycloak.provider.ProviderConfigProperty; import org.keycloak.provider.ProviderConfigurationBuilder; @@ -61,7 +62,7 @@ public PasswordCredentialProvider create(KeycloakSession session) { @Override public void init(Config.Scope config) { - metricsEnabled = config.getBoolean("metrics-enabled", false); + metricsEnabled = config.root().getBoolean(MetricsOptions.METRICS_ENABLED.getKey(), false); if (metricsEnabled) { meterProvider = Counter.builder(LOGIN_PASSWORD_VERIFY_METER_NAME) .description(LOGIN_PASSWORD_VERIFY_METER_DESCRIPTION) diff --git a/services/src/test/java/org/keycloak/utils/JsonConfigProvider.java b/services/src/test/java/org/keycloak/utils/JsonConfigProvider.java index b8934b928c21..6a6d253cd423 100755 --- a/services/src/test/java/org/keycloak/utils/JsonConfigProvider.java +++ b/services/src/test/java/org/keycloak/utils/JsonConfigProvider.java @@ -20,7 +20,10 @@ import java.util.Set; import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.NullNode; + import org.keycloak.Config; +import org.keycloak.Config.Scope; import org.keycloak.common.util.StringPropertyReplacer; import org.keycloak.common.util.SystemEnvProperties; @@ -192,6 +195,11 @@ public Set getPropertyNames() { throw new UnsupportedOperationException("Not implemented"); } + @Override + public Scope root() { + return new JsonScope(NullNode.getInstance()); + } + } } diff --git a/services/src/test/java/org/keycloak/vault/PlainTextVaultProviderFactoryTest.java b/services/src/test/java/org/keycloak/vault/PlainTextVaultProviderFactoryTest.java index 7230e1f09755..e3e9360532d4 100644 --- a/services/src/test/java/org/keycloak/vault/PlainTextVaultProviderFactoryTest.java +++ b/services/src/test/java/org/keycloak/vault/PlainTextVaultProviderFactoryTest.java @@ -4,6 +4,7 @@ import org.junit.Test; import org.junit.rules.ExpectedException; import org.keycloak.Config; +import org.keycloak.Config.Scope; import org.keycloak.models.KeycloakSession; import org.keycloak.services.resteasy.ResteasyKeycloakSession; import org.keycloak.services.resteasy.ResteasyKeycloakSessionFactory; @@ -136,6 +137,11 @@ public Config.Scope scope(String... scope) { public Set getPropertyNames() { throw new UnsupportedOperationException("not implemented"); } + + @Override + public Scope root() { + throw new UnsupportedOperationException("not implemented"); + } } } \ No newline at end of file