-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19969 from sberyozkin/oidc_dev_console
Support for provider-neutral OIDC Dev UI
- Loading branch information
Showing
13 changed files
with
317 additions
and
92 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
...loyment/src/main/java/io/quarkus/oidc/deployment/devservices/OidcDevConsoleProcessor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| package io.quarkus.oidc.deployment.devservices; | ||
|
|
||
| import java.time.Duration; | ||
|
|
||
| import org.eclipse.microprofile.config.ConfigProvider; | ||
| import org.jboss.logging.Logger; | ||
|
|
||
| import io.quarkus.bootstrap.classloading.QuarkusClassLoader; | ||
| import io.quarkus.deployment.IsDevelopment; | ||
| import io.quarkus.deployment.annotations.BuildProducer; | ||
| import io.quarkus.deployment.annotations.BuildStep; | ||
| import io.quarkus.deployment.annotations.Consume; | ||
| import io.quarkus.deployment.builditem.RuntimeConfigSetupCompleteBuildItem; | ||
| import io.quarkus.devconsole.spi.DevConsoleRouteBuildItem; | ||
| import io.quarkus.devconsole.spi.DevConsoleTemplateInfoBuildItem; | ||
| import io.quarkus.oidc.common.runtime.OidcConstants; | ||
| import io.quarkus.runtime.configuration.ConfigUtils; | ||
| import io.vertx.core.Vertx; | ||
| import io.vertx.core.http.HttpHeaders; | ||
| import io.vertx.core.json.JsonObject; | ||
| import io.vertx.mutiny.core.buffer.Buffer; | ||
| import io.vertx.mutiny.ext.web.client.HttpResponse; | ||
| import io.vertx.mutiny.ext.web.client.WebClient; | ||
|
|
||
| public class OidcDevConsoleProcessor { | ||
| static volatile Vertx vertxInstance; | ||
| private static final Logger LOG = Logger.getLogger(OidcDevConsoleProcessor.class); | ||
|
|
||
| private static final String CONFIG_PREFIX = "quarkus.oidc."; | ||
| private static final String TENANT_ENABLED_CONFIG_KEY = CONFIG_PREFIX + "tenant-enabled"; | ||
| private static final String AUTH_SERVER_URL_CONFIG_KEY = CONFIG_PREFIX + "auth-server-url"; | ||
| private static final String APP_TYPE_CONFIG_KEY = CONFIG_PREFIX + "application-type"; | ||
| private static final String SERVICE_APP_TYPE = "service"; | ||
| private static final String CLIENT_ID_CONFIG_KEY = CONFIG_PREFIX + "client-id"; | ||
| private static final String CLIENT_SECRET_CONFIG_KEY = CONFIG_PREFIX + "credentials.secret"; | ||
|
|
||
| @BuildStep(onlyIf = IsDevelopment.class) | ||
| @Consume(RuntimeConfigSetupCompleteBuildItem.class) | ||
| void prepareOidcDevConsole(BuildProducer<DevConsoleTemplateInfoBuildItem> console, | ||
| BuildProducer<DevConsoleRouteBuildItem> devConsoleRoute) { | ||
| if (isOidcTenantEnabled() && isAuthServerUrlSet() && isClientIdSet() && isServiceAuthType()) { | ||
|
|
||
| if (vertxInstance == null) { | ||
| vertxInstance = Vertx.vertx(); | ||
|
|
||
| Runnable closeTask = new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| if (vertxInstance != null) { | ||
| try { | ||
| vertxInstance.close(); | ||
| } catch (Throwable t) { | ||
| LOG.error("Failed to close Vertx instance", t); | ||
| } | ||
| } | ||
| vertxInstance = null; | ||
| } | ||
| }; | ||
| QuarkusClassLoader cl = (QuarkusClassLoader) Thread.currentThread().getContextClassLoader(); | ||
| ((QuarkusClassLoader) cl.parent()).addCloseTask(closeTask); | ||
| Thread closeHookThread = new Thread(closeTask, "OIDC DevConsole Vertx close thread"); | ||
| Runtime.getRuntime().addShutdownHook(closeHookThread); | ||
| ((QuarkusClassLoader) cl.parent()).addCloseTask(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| Runtime.getRuntime().removeShutdownHook(closeHookThread); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| String authServerUrl = getConfigProperty(AUTH_SERVER_URL_CONFIG_KEY); | ||
| JsonObject metadata = discoverMetadata(authServerUrl); | ||
| if (metadata == null) { | ||
| return; | ||
| } | ||
| if (authServerUrl.contains("/realms/")) { | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("keycloakAdminUrl", | ||
| authServerUrl.substring(0, authServerUrl.indexOf("/realms/")))); | ||
| } | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("oidcApplicationType", SERVICE_APP_TYPE)); | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("clientId", getConfigProperty(CLIENT_ID_CONFIG_KEY))); | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("clientSecret", getClientSecret())); | ||
|
|
||
| console.produce(new DevConsoleTemplateInfoBuildItem("tokenUrl", metadata.getString("token_endpoint"))); | ||
| console.produce( | ||
| new DevConsoleTemplateInfoBuildItem("authorizationUrl", metadata.getString("authorization_endpoint"))); | ||
| if (metadata.containsKey("end_session_endpoint")) { | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("logoutUrl", metadata.getString("end_session_endpoint"))); | ||
| } | ||
| console.produce(new DevConsoleTemplateInfoBuildItem("oidcGrantType", "code")); | ||
|
|
||
| devConsoleRoute.produce(new DevConsoleRouteBuildItem("testServiceWithToken", "POST", | ||
| new OidcTestServiceHandler(vertxInstance, Duration.ofSeconds(3)))); | ||
| devConsoleRoute.produce(new DevConsoleRouteBuildItem("exchangeCodeForTokens", "POST", | ||
| new OidcAuthorizationCodePostHandler(vertxInstance, Duration.ofSeconds(3)))); | ||
| } | ||
| } | ||
|
|
||
| private JsonObject discoverMetadata(String authServerUrl) { | ||
| WebClient client = OidcDevServicesUtils.createWebClient(vertxInstance); | ||
| try { | ||
| String metadataUrl = authServerUrl + OidcConstants.WELL_KNOWN_CONFIGURATION; | ||
| LOG.infof("OIDC Dev Console: discovering the provider metadata at %s", metadataUrl); | ||
|
|
||
| HttpResponse<Buffer> resp = client.getAbs(metadataUrl) | ||
| .putHeader(HttpHeaders.ACCEPT.toString(), "application/json").send().await().indefinitely(); | ||
| if (resp.statusCode() == 200) { | ||
| return resp.bodyAsJsonObject(); | ||
| } else { | ||
| LOG.errorf("OIDC metadata discovery failed: %s", resp.bodyAsString()); | ||
| return null; | ||
| } | ||
| } catch (Throwable t) { | ||
| LOG.errorf("OIDC metadata discovery failed: %s", t.toString()); | ||
| return null; | ||
| } finally { | ||
| client.close(); | ||
| } | ||
| } | ||
|
|
||
| private String getConfigProperty(String name) { | ||
| return ConfigProvider.getConfig().getValue(name, String.class); | ||
| } | ||
|
|
||
| private static boolean isOidcTenantEnabled() { | ||
| return ConfigProvider.getConfig().getOptionalValue(TENANT_ENABLED_CONFIG_KEY, Boolean.class).orElse(true); | ||
| } | ||
|
|
||
| private static boolean isClientIdSet() { | ||
| return ConfigUtils.isPropertyPresent(CLIENT_ID_CONFIG_KEY); | ||
| } | ||
|
|
||
| private static String getClientSecret() { | ||
| return ConfigProvider.getConfig().getOptionalValue(CLIENT_SECRET_CONFIG_KEY, String.class).orElse(""); | ||
| } | ||
|
|
||
| private static boolean isAuthServerUrlSet() { | ||
| return ConfigUtils.isPropertyPresent(AUTH_SERVER_URL_CONFIG_KEY); | ||
| } | ||
|
|
||
| private boolean isServiceAuthType() { | ||
| return SERVICE_APP_TYPE.equals( | ||
| ConfigProvider.getConfig().getOptionalValue(APP_TYPE_CONFIG_KEY, String.class).orElse(SERVICE_APP_TYPE)); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.