100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Cleanup of identity provider frontend URI (#1295)
Rich Turnere881c02b8bfa
diff --git a/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java b/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.javaindex 38586dfee..5b4defb44 100644--- a/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java+++ b/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java@@ -51,6 +51,7 @@ import org.openremote.model.Constants;import org.openremote.model.Container;import org.openremote.model.auth.OAuthGrant;import org.openremote.model.auth.OAuthPasswordGrant;+import org.openremote.model.util.TextUtil;import javax.security.auth.Subject;import java.net.URI;@@ -93,6 +94,8 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {public static final String OR_KEYCLOAK_HOST_DEFAULT = "127.0.0.1"; // Bug in keycloak default hostname provider means localhost causes problems with dev-proxy profilepublic static final String OR_KEYCLOAK_PORT = "OR_KEYCLOAK_PORT";public static final int OR_KEYCLOAK_PORT_DEFAULT = 8081;+ public static final String OR_KEYCLOAK_PATH = "OR_KEYCLOAK_PATH";+ public static final String OR_KEYCLOAK_PATH_DEFAULT = "auth";public static final String KEYCLOAK_CONNECT_TIMEOUT = "KEYCLOAK_CONNECT_TIMEOUT";public static final int KEYCLOAK_CONNECT_TIMEOUT_DEFAULT = 2000;public static final String KEYCLOAK_REQUEST_TIMEOUT = "KEYCLOAK_REQUEST_TIMEOUT";@@ -103,8 +106,6 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {public static final int OR_IDENTITY_SESSION_MAX_MINUTES_DEFAULT = 60 * 24; // 1 daypublic static final String OR_IDENTITY_SESSION_OFFLINE_TIMEOUT_MINUTES = "OR_IDENTITY_SESSION_OFFLINE_TIMEOUT_MINUTES";public static final int OR_IDENTITY_SESSION_OFFLINE_TIMEOUT_MINUTES_DEFAULT = 2628000; // 5 years-- public static final String KEYCLOAK_AUTH_PATH = "auth";private static final Logger LOG = Logger.getLogger(KeycloakIdentityProvider.class.getName());// The URI where Keycloak can be foundprotected UriBuilder keycloakServiceUri;@@ -168,8 +169,14 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {UriBuilder.fromPath("/").scheme("http").host(getString(container.getConfig(), OR_KEYCLOAK_HOST, OR_KEYCLOAK_HOST_DEFAULT))- .port(getInteger(container.getConfig(), OR_KEYCLOAK_PORT, OR_KEYCLOAK_PORT_DEFAULT))- .path(KEYCLOAK_AUTH_PATH);+ .port(getInteger(container.getConfig(), OR_KEYCLOAK_PORT, OR_KEYCLOAK_PORT_DEFAULT));++ String keycloakPath = getString(container.getConfig(), OR_KEYCLOAK_PATH, OR_KEYCLOAK_PATH_DEFAULT);++ if (!TextUtil.isNullOrEmpty(keycloakPath)) {+ keycloakServiceUri.path(keycloakPath);+ }+LOG.info("Keycloak service URL: " + keycloakServiceUri.build());@@ -457,14 +464,15 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {.build(loader);}- protected void enableAuthProxy(WebService webService) {+ protected void enableAuthProxy(WebService webService, String keycloakPath) {if (authProxyHandler == null)throw new IllegalStateException("Initialize this service first");- LOG.info("Enabling auth reverse proxy (passing requests through to Keycloak) on web context: /" + KEYCLOAK_AUTH_PATH);++ LOG.info("Enabling auth reverse proxy (passing requests through to Keycloak) on web context: /" + keycloakPath);webService.getRequestHandlers().add(0, pathStartsWithHandler("Keycloak auth proxy",- "/" + KEYCLOAK_AUTH_PATH,+ "/" + keycloakPath,authProxyHandler));}diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.javaindex 430274fa7..03efa98e2 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java@@ -251,7 +251,7 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen}@Override- public String getFrontendUrl() {+ public String getFrontendURI() {return null;}diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.javaindex e61827233..1078b3e1e 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java@@ -105,7 +105,7 @@ public interface ManagerIdentityProvider extends IdentityProvider {/*** Returns the frontend URL to be used for frontend apps to authenticate*/- String getFrontendUrl();+ String getFrontendURI();/** BELOW ARE STATIC HELPER METHODSdiff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.javaindex 8785483b2..804c126df 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java@@ -23,8 +23,6 @@ import io.undertow.util.Headers;import jakarta.persistence.Query;import jakarta.validation.constraints.NotNull;import jakarta.ws.rs.*;-import jakarta.ws.rs.core.MultivaluedHashMap;-import jakarta.ws.rs.core.MultivaluedMap;import jakarta.ws.rs.core.Response;import jakarta.ws.rs.core.UriBuilder;import org.apache.commons.io.IOUtils;@@ -91,10 +89,8 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider impublic static final String DEFAULT_REALM_KEYCLOAK_THEME_DEFAULT = "openremote";public static final String OR_KEYCLOAK_GRANT_FILE = "OR_KEYCLOAK_GRANT_FILE";public static final String OR_KEYCLOAK_GRANT_FILE_DEFAULT = "manager/build/keycloak.json";- public static final String KEYCLOAK_DEFAULT_ROLES_PREFIX = "default-roles-";- public static final String KC_HOSTNAME = "KC_HOSTNAME";- public static final String KC_HOSTNAME_PATH = "KC_HOSTNAME_PATH";- public static final String KC_HOSTNAME_PORT = "KC_HOSTNAME_PORT";+ public static final String OR_KEYCLOAK_PUBLIC_URI = "OR_KEYCLOAK_PUBLIC_URI";+ public static final String OR_KEYCLOAK_PUBLIC_URI_DEFAULT = "/auth";protected PersistenceService persistenceService;protected AssetStorageService assetStorageService;@@ -104,7 +100,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider improtected ConsoleAppService consoleAppService;protected String keycloakAdminPassword;protected Container container;- protected String frontendUrl;+ protected String frontendURI;protected List<String> validRedirectUris;@Override@@ -112,21 +108,12 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider imsuper.init(container);this.container = container;- String hostname = getString(container.getConfig(), Constants.OR_HOSTNAME, null);- int port = getInteger(container.getConfig(), Constants.OR_SSL_PORT, -1); // Should just be called port- String keycloakHostname = getString(container.getConfig(), KC_HOSTNAME, hostname);- int keycloakPort = getInteger(container.getConfig(), KC_HOSTNAME_PORT, port);- String keycloakHostnamePath = getString(container.getConfig(), KC_HOSTNAME_PATH, "auth");-- URIBuilder uriBuilder = new URIBuilder().setHost(keycloakHostname).setPath(keycloakHostnamePath);- if (keycloakPort > 0) {- uriBuilder.setPort(keycloakPort);- }-+ String keycloakPublicUri = getString(container.getConfig(), OR_KEYCLOAK_PUBLIC_URI, OR_KEYCLOAK_PUBLIC_URI_DEFAULT);try {- frontendUrl = uriBuilder.build().toString();+ URIBuilder uriBuilder = new URIBuilder(keycloakPublicUri);+ frontendURI = uriBuilder.build().toString();} catch (URISyntaxException e) {- LOG.log(Level.SEVERE, "Failed to build Keycloak host URI", e);+ LOG.log(Level.SEVERE, "Failed to build Keycloak public URI", e);throw new RuntimeException(e);}@@ -148,7 +135,8 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider impublic void start(Container container) {super.start(container);if (container.isDevMode()) {- enableAuthProxy(container.getService(WebService.class));+ String keycloakPath = getString(container.getConfig(), OR_KEYCLOAK_PATH, OR_KEYCLOAK_PATH_DEFAULT);+ enableAuthProxy(container.getService(WebService.class), keycloakPath);}}@@ -1136,8 +1124,8 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im}@Override- public String getFrontendUrl() {- return frontendUrl;+ public String getFrontendURI() {+ return frontendURI;}protected void configureRealm(RealmRepresentation realmRepresentation) {diff --git a/manager/src/main/java/org/openremote/manager/system/HealthService.java b/manager/src/main/java/org/openremote/manager/system/HealthService.javaindex 80c701070..7037238b4 100644--- a/manager/src/main/java/org/openremote/manager/system/HealthService.java+++ b/manager/src/main/java/org/openremote/manager/system/HealthService.java@@ -63,7 +63,7 @@ public class HealthService implements ContainerService {public static final System.Logger LOG = System.getLogger(HealthService.class.getName());public static final String OR_METRICS_PORT = "OR_METRICS_PORT";- public static final int OR_METRICS_PORT_DEFAULT = 8404;+ public static final int OR_METRICS_PORT_DEFAULT = 8405;public static final String OR_CAMEL_ROUTE_METRIC_PREFIX = "or_camel_route";protected List<HealthStatusProvider> healthStatusProviderList = new ArrayList<>();protected boolean metricsEnabled;diff --git a/manager/src/main/java/org/openremote/manager/system/StatusResourceImpl.java b/manager/src/main/java/org/openremote/manager/system/StatusResourceImpl.javaindex b057a28cc..d86bef5d4 100644--- a/manager/src/main/java/org/openremote/manager/system/StatusResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/system/StatusResourceImpl.java@@ -46,7 +46,7 @@ public class StatusResourceImpl implements StatusResource {ManagerIdentityService identityService = container.getService(ManagerIdentityService.class);if (identityService != null) {- authServerUrl = identityService.getIdentityProvider().getFrontendUrl();+ authServerUrl = identityService.getIdentityProvider().getFrontendURI();}try(InputStream resourceStream = StatusResourceImpl.class.getClassLoader().getResourceAsStream("version.properties")) {diff --git a/profile/deploy.yml b/profile/deploy.ymlindex 0d490a9a4..43b1ecfcc 100644--- a/profile/deploy.yml+++ b/profile/deploy.yml@@ -221,11 +221,10 @@ services:# The service-internal host name and port of the keycloak identity provider; defaults:OR_KEYCLOAK_HOST: ${OR_KEYCLOAK_HOST:-keycloak}OR_KEYCLOAK_PORT: ${OR_KEYCLOAK_PORT:-8080}+ OR_KEYCLOAK_PATH: ${OR_KEYCLOAK_PATH:-auth}- # Keycloak frontend host name, port and path (defaults: to OR_HOSTNAME:OR_SSL_PORT/auth)- KC_HOSTNAME:- KC_HOSTNAME_PORT:- KC_HOSTNAME_PATH:+ # Keycloak public URI (only set this if keycloak is not on the same base URI as the manager i.e. not accessible at /auth)+ OR_KEYCLOAK_PUBLIC_URI:# Location of built in web content.OR_APP_DOCROOT: ${OR_APP_DOCROOT:-/opt/web}@@ -289,9 +288,9 @@ services:OR_IDENTITY_SESSION_OFFLINE_TIMEOUT_MINUTES: ${OR_IDENTITY_SESSION_OFFLINE_TIMEOUT_MINUTES:-2628000}# Enable/disable Prometheus metrics collection- OR_METRICS_ENABLED: ${OR_METRICS_ENABLED:-true}+ #OR_METRICS_ENABLED: ${OR_METRICS_ENABLED:-true}# Web server port used to host metrics endpoint- OR_METRICS_PORT: ${OR_METRICS_PORT:-8404}+ #OR_METRICS_PORT: ${OR_METRICS_PORT:-8405}# Set the number of concurrent attribute event processors (defaults to number of CPU cores)OR_ATTRIBUTE_EVENT_THREADS:@@ -333,8 +332,8 @@ services:# - "8081:8080" # Web server portenvironment:- # It is important that all services have the same timezone and are time synchronized.- # Bearer tokens are only valid for minutes, and authentication fails if Keycloak drifts+ # It is important that all services are time synchronized. Bearer tokens are+ # only valid for minutes, and authentication fails if Keycloak driftsTZ: ${TZ:-Europe/Amsterdam}# Switch to debug to diagnose Keycloak problems; default:@@ -350,10 +349,11 @@ services:# Configure web serverKC_HOSTNAME: ${OR_HOSTNAME:-localhost}KC_HOSTNAME_PORT: ${OR_SSL_PORT:--1}- KC_HOSTNAME_PATH: ${KC_HOSTNAME_PATH:-auth}- KC_HOSTNAME_ADMIN: ${KC_HOSTNAME_ADMIN:-}- KC_PROXY: ${KC_PROXY:-edge}-+ #KC_HOSTNAME_PATH: ${KC_HOSTNAME_PATH:-auth}+ #KC_HOSTNAME_ADMIN: ${KC_HOSTNAME_ADMIN:-}+ #KC_HTTP_ENABLED: ${KC_HTTP_ENABLED:-true}+ #KC_PROXY_HEADERS: ${KC_PROXY_HEADERS:-xforwarded}+ #KC_PROXY: ${KC_PROXY:-edge}# Configure main user credentials (only on first startup)KEYCLOAK_ADMIN: ${KEYCLOAK_ADMIN:-admin}KEYCLOAK_ADMIN_PASSWORD: ${KEYCLOAK_ADMIN_PASSWORD:-secret}@@ -364,6 +364,10 @@ services:KEYCLOAK_DEFAULT_THEME: ${KEYCLOAK_DEFAULT_THEME:-openremote}KEYCLOAK_ACCOUNT_THEME: ${KEYCLOAK_ACCOUNT_THEME:-openremote}KEYCLOAK_WELCOME_THEME: ${KEYCLOAK_WELCOME_THEME:-keycloak}+ # Use the following to set the issuer to a fixed value (useful when accessing a private instance via a tunnel)+ # Should also set KC_HOSTNAME to blank, KC_HOSTNAME_STRICT to false and if the keycloak instance is publicly+ # exposed then the proxy should be configured to validate the host header to prevent abuse+ #KEYCLOAK_ISSUER_BASE_URI: 'https://192.168.1.2/auth'# Custom JVM options (increase heap size if required)JAVA_OPTS: ${KEYCLOAK_JAVA_OPTS:-}diff --git a/ui/demo/demo-core/src/index.ts b/ui/demo/demo-core/src/index.tsindex ed8ef1e35..2c99b8a07 100644--- a/ui/demo/demo-core/src/index.ts+++ b/ui/demo/demo-core/src/index.ts@@ -115,7 +115,6 @@ class OrDemo extends subscribe(manager)(LitElement) {manager.init({managerUrl: "http://localhost:8080",- keycloakUrl: "http://localhost:8080/auth",auth: Auth.KEYCLOAK,autoLogin: false,realm: "smartcity",diff --git a/ui/demo/demo-or-asset-tree/src/index.ts b/ui/demo/demo-or-asset-tree/src/index.tsindex 58c4e386e..f1649147b 100644--- a/ui/demo/demo-or-asset-tree/src/index.ts+++ b/ui/demo/demo-or-asset-tree/src/index.ts@@ -43,7 +43,6 @@ class App extends LitElement {manager.init({auth: Auth.KEYCLOAK,autoLogin: true,- keycloakUrl: "http://localhost:8080/auth",managerUrl: "http://localhost:8080",realm: "smartcity"}).then(() => {diff --git a/ui/demo/demo-or-map/src/index.ts b/ui/demo/demo-or-map/src/index.tsindex bbf75c9f0..63c772830 100644--- a/ui/demo/demo-or-map/src/index.ts+++ b/ui/demo/demo-or-map/src/index.ts@@ -8,7 +8,6 @@ import {getBuildingAsset} from "../../demo-core/src/util";manager.init({auth: Auth.KEYCLOAK,autoLogin: true,- keycloakUrl: "http://localhost:8080/auth",managerUrl: "http://localhost:8080",realm: "smartcity"})diff --git a/ui/demo/demo-or-thermostat/src/index.ts b/ui/demo/demo-or-thermostat/src/index.tsindex 4b7fa8bd6..84b998815 100644--- a/ui/demo/demo-or-thermostat/src/index.ts+++ b/ui/demo/demo-or-thermostat/src/index.ts@@ -63,7 +63,6 @@ manager.addListener((event: OREvent) => {manager.init({auth: Auth.KEYCLOAK,autoLogin: true,- keycloakUrl: "https://localhost/auth",managerUrl: "https://localhost",realm: "building"});diff --git a/ui/demo/demo-rest/src/index.ts b/ui/demo/demo-rest/src/index.tsindex e4e9d8969..b5e14b10e 100644--- a/ui/demo/demo-rest/src/index.ts+++ b/ui/demo/demo-rest/src/index.ts@@ -33,7 +33,6 @@ manager.addListener(event => {manager.init({managerUrl: "http://localhost:8080",- keycloakUrl: "http://localhost:8080/auth",auth: Auth.KEYCLOAK,autoLogin: true,realm: "smartcity"