Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Refactor identity provider role management (#1806)

Rich Turner851cd4ab0b09
diff --git a/container/src/main/java/org/openremote/container/security/AuthContext.java b/container/src/main/java/org/openremote/container/security/AuthContext.java
index d703da857..99ffe83ef 100644
--- a/container/src/main/java/org/openremote/container/security/AuthContext.java
+++ b/container/src/main/java/org/openremote/container/security/AuthContext.java
@@ -39,7 +39,7 @@ public interface AuthContext {
* @return <code>true</code> if the user is authenticated in the "master" realm and has the realm role "admin".
*/
default boolean isSuperUser() {
- return Constants.MASTER_REALM.equals(getAuthenticatedRealmName()) && hasRealmRole(Constants.REALM_ADMIN_ROLE);
+ return Constants.MASTER_REALM.equals(getAuthenticatedRealmName()) && hasRealmRole(Constants.SUPER_USER_REALM_ROLE);
}
boolean hasRealmRole(String role);
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.java
index 0dba1efcb..673882965 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
@@ -495,6 +495,6 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {
}
public static boolean isSuperUser(KeycloakSecurityContext securityContext) {
- return securityContext != null && Constants.MASTER_REALM.equals(securityContext.getRealm()) && securityContext.getToken().getRealmAccess().isUserInRole(Constants.REALM_ADMIN_ROLE);
+ return securityContext != null && Constants.MASTER_REALM.equals(securityContext.getRealm()) && securityContext.getToken().getRealmAccess().isUserInRole(Constants.SUPER_USER_REALM_ROLE);
}
}
diff --git a/manager/src/main/java/org/openremote/manager/alarm/AlarmService.java b/manager/src/main/java/org/openremote/manager/alarm/AlarmService.java
index ba77f314c..f147a9322 100644
--- a/manager/src/main/java/org/openremote/manager/alarm/AlarmService.java
+++ b/manager/src/main/java/org/openremote/manager/alarm/AlarmService.java
@@ -301,7 +301,7 @@ public class AlarmService extends RouteBuilder implements ContainerService {
UserQuery userQuery = new UserQuery()
.realm(new RealmPredicate(alarm.getRealm()))
.clientRoles(new StringPredicate(Constants.WRITE_ALARMS_ROLE))
- .realmRoles(new StringPredicate(Constants.REALM_ADMIN_ROLE))
+ .realmRoles(new StringPredicate(Constants.SUPER_USER_REALM_ROLE))
.serviceUsers(false);
users.addAll(Arrays.asList(identityProvider.queryUsers(userQuery)));
} else {
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
index 8145584ac..7d522afd4 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
@@ -816,7 +816,7 @@ public class GatewayService extends RouteBuilder implements ContainerService {
gateway.getRealm(),
gatewayUser.getId(),
identityProvider
- .addRealmRoles(gateway.getRealm(), gatewayUser.getId(), RESTRICTED_USER_REALM_ROLE));
+ .addUserRealmRoles(gateway.getRealm(), gatewayUser.getId(), RESTRICTED_USER_REALM_ROLE));
}
if (!clientId.equals(gateway.getClientId().orElse(null)) || !secret.equals(gateway.getClientSecret().orElse(null))) {
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/UserAssetProvisioningMQTTHandler.java b/manager/src/main/java/org/openremote/manager/mqtt/UserAssetProvisioningMQTTHandler.java
index 1dd905f4b..ab6ce501d 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/UserAssetProvisioningMQTTHandler.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/UserAssetProvisioningMQTTHandler.java
@@ -60,7 +60,6 @@ import java.util.logging.Logger;
import static org.openremote.container.persistence.PersistenceService.PERSISTENCE_TOPIC;
import static org.openremote.container.persistence.PersistenceService.isPersistenceEventForEntityType;
-import static org.openremote.manager.mqtt.MQTTBrokerService.connectionToString;
import static org.openremote.model.Constants.RESTRICTED_USER_REALM_ROLE;
import static org.openremote.model.syslog.SyslogCategory.API;
@@ -482,7 +481,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
if (provisioningConfig.getUserRoles() != null && provisioningConfig.getUserRoles().length > 0) {
LOG.finest("Setting user roles: realm=" + realm + ", username=" + username + ", roles=" + Arrays.toString(provisioningConfig.getUserRoles()));
- identityProvider.updateUserRoles(
+ identityProvider.updateUserClientRoles(
realm,
serviceUser.getId(),
Constants.KEYCLOAK_CLIENT_ID,
@@ -494,7 +493,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
if (provisioningConfig.isRestrictedUser()) {
LOG.finest("User will be made restricted: realm=" + realm + ", username=" + username);
- identityProvider.updateUserRealmRoles(realm, serviceUser.getId(), identityProvider.addRealmRoles(realm, serviceUser.getId(),RESTRICTED_USER_REALM_ROLE));
+ identityProvider.updateUserRealmRoles(realm, serviceUser.getId(), identityProvider.addUserRealmRoles(realm, serviceUser.getId(),RESTRICTED_USER_REALM_ROLE));
}
// Inject secret
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
index 03efa98e2..19b503d6e 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java
@@ -33,8 +33,7 @@ import java.sql.PreparedStatement;
import java.util.*;
import java.util.logging.Logger;
-import static org.openremote.model.Constants.MASTER_REALM;
-import static org.openremote.model.Constants.MASTER_REALM_ADMIN_USER;
+import static org.openremote.model.Constants.*;
public class ManagerBasicIdentityProvider extends BasicIdentityProvider implements ManagerIdentityProvider {
@@ -153,7 +152,7 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen
}
@Override
- public Role[] getRoles(String realm, String client) {
+ public Role[] getClientRoles(String realm, String client) {
if (client != null && !MASTER_REALM.equals(client)) {
throw new IllegalStateException("This provider only has a single master realm");
}
@@ -168,19 +167,20 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen
}
@Override
- public Role[] getUserRoles(String realm, String userId, String client) {
- return ClientRole.ALL_ROLES.stream()
- .map(role -> new Role(UUID.randomUUID().toString(), role, false, true, null))
- .toArray(Role[]::new);
+ public String[] getUserClientRoles(String realm, String userId, String client) {
+ if (KEYCLOAK_CLIENT_ID .equals(client)) {
+ return ClientRole.ALL_ROLES.toArray(new String[0]);
+ }
+ return new String[0];
}
@Override
- public Role[] getUserRealmRoles(String realm, String userId) {
+ public String[] getUserRealmRoles(String realm, String userId) {
throw new UnsupportedOperationException("This provider does not support user realm roles");
}
@Override
- public void updateUserRoles(String realm, String userId, String client, String... roles) {
+ public void updateUserClientRoles(String realm, String userId, String client, String... roles) {
throw new UnsupportedOperationException("This provider does not support updating user roles");
}
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
index a0adddaff..98f3ddaca 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java
@@ -62,15 +62,15 @@ public interface ManagerIdentityProvider extends IdentityProvider {
String resetSecret(String realm, String userId, String secret);
- Role[] getRoles(String realm, String client);
+ Role[] getClientRoles(String realm, String client);
void updateClientRoles(String realm, String client, Role[] roles);
- Role[] getUserRoles(String realm, String userId, String client);
+ String[] getUserClientRoles(String realm, String userId, String client);
- Role[] getUserRealmRoles(String realm, String userId);
+ String[] getUserRealmRoles(String realm, String userId);
- void updateUserRoles(String realm, String userId, String client, String... roles);
+ void updateUserClientRoles(String realm, String userId, String client, String... roles);
void updateUserRealmRoles(String realm, String userId, String... roles);
@@ -113,10 +113,10 @@ public interface ManagerIdentityProvider extends IdentityProvider {
* BELOW ARE STATIC HELPER METHODS
*/
- default String[] addRealmRoles(String realm, String userId, String... roles) {
- Set<String> realmRoles = Arrays.stream(getUserRealmRoles(realm, userId)).filter(role -> role.isAssigned() || Arrays.stream(roles).anyMatch(r -> role.getName().equals(r))).map(Role::getName).collect(Collectors.toCollection(LinkedHashSet::new));
- realmRoles.addAll(Arrays.asList(roles));
- return realmRoles.toArray(new String[0]);
+ default String[] addUserRealmRoles(String realm, String userId, String... roles) {
+ List<String> existingRoles = new ArrayList<>(Arrays.asList(getUserRealmRoles(realm, userId)));
+ existingRoles.addAll(Arrays.asList(roles));
+ return existingRoles.toArray(new String[0]);
}
@SuppressWarnings("unchecked")
@@ -358,23 +358,15 @@ public interface ManagerIdentityProvider extends IdentityProvider {
return o1.getName().compareTo(o2.getName());
});
- // TODO: Remove this once migrated to hibernate 6.2.x+
- realms.forEach(r -> r.getRealmRoles().size());
-
- return realms.toArray(new Realm[realms.size()]);
+ return realms.toArray(new Realm[0]);
});
}
- static Realm getRealmFromDb(PersistenceService persistenceService, String realm) {
- return persistenceService.doReturningTransaction(em -> {
- List<Realm> realms = em.createQuery("select r from Realm r where r.name = :realm", Realm.class)
- .setParameter("realm", realm).getResultList();
-
- // TODO: Remove this once migrated to hibernate 6.2.x+
- realms.forEach(r -> r.getRealmRoles().size());
-
- return realms.size() == 1 ? realms.get(0) : null;
- }
+ static Realm getRealmFromDb(PersistenceService persistenceService, String name) {
+ return persistenceService.doReturningTransaction(em -> em
+ .createQuery("select r from Realm r where r.name = :realm", Realm.class)
+ .setParameter("realm", name)
+ .getSingleResult()
);
}
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
index 76b445cef..ea9e2cdcd 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
@@ -93,7 +93,12 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
public static final String OR_KEYCLOAK_PUBLIC_URI = "OR_KEYCLOAK_PUBLIC_URI";
public static final String OR_KEYCLOAK_PUBLIC_URI_DEFAULT = "/auth";
public static final String OR_KEYCLOAK_ENABLE_DIRECT_ACCESS_GRANT = "OR_KEYCLOAK_ENABLE_DIRECT_ACCESS_GRANT";
-
+ public static final List<String> BUILT_IN_REALM_ROLES = List.of(
+ "admin",
+ "create-realm",
+ "offline_access",
+ "uma_authorization"
+ );
protected PersistenceService persistenceService;
protected AssetStorageService assetStorageService;
protected TimerService timerService;
@@ -188,7 +193,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
keycloakProxyUser = createUpdateUser(MASTER_REALM, keycloakProxyUser, password, true);
// Make this proxy user a super user by giving them admin realm role
- updateUserRealmRoles(MASTER_REALM, keycloakProxyUser.getId(), addRealmRoles(MASTER_REALM, keycloakProxyUser.getId(), REALM_ADMIN_ROLE));
+ updateUserRealmRoles(MASTER_REALM, keycloakProxyUser.getId(), addUserRealmRoles(MASTER_REALM, keycloakProxyUser.getId(), SUPER_USER_REALM_ROLE));
// Use same details as default keycloak grant but change the username and password to our new user
OAuthPasswordGrant grant = getDefaultKeycloakGrant(container);
@@ -491,7 +496,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
@Override
- public Role[] getRoles(String realm, String client) {
+ public Role[] getClientRoles(String realm, String client) {
return getRealms(realmsResource -> {
RealmResource realmResource = realmsResource.realm(realm);
ClientsResource clientsResource = realmResource.clients();
@@ -618,73 +623,33 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
@Override
- public Role[] getUserRoles(String realm, String userId, String client) {
+ public String[] getUserClientRoles(String realm, String userId, String client) {
return getRealms(realmsResource -> {
RealmResource realmResource = realmsResource.realm(realm);
RoleMappingResource roleMappingResource = realmResource.users().get(userId).roles();
- return withClientResource(realm, client, realmsResource, (clientRepresentation, clientResource) -> {
- RolesResource rolesResource = clientResource.roles();
- List<RoleRepresentation> allRoles = rolesResource.list();
- List<RoleRepresentation> effectiveRoles = roleMappingResource.clientLevel(clientRepresentation.getId()).listEffective();
-
- List<Role> roles = new ArrayList<>();
- for (RoleRepresentation roleRepresentation : allRoles) {
- boolean isAssigned = false;
-
- for (RoleRepresentation effectiveRole : effectiveRoles) {
- if (effectiveRole.getId().equals(roleRepresentation.getId()))
- isAssigned = true;
- }
-
- roles.add(new Role(
- roleRepresentation.getId(),
- roleRepresentation.getName(),
- roleRepresentation.isComposite(),
- isAssigned,
- null)
- .setDescription(roleRepresentation.getDescription()));
- }
-
- return roles.toArray(new Role[0]);
- }, () -> new Role[0]);
+ return withClientResource(realm, client, realmsResource, (clientRepresentation, clientResource) ->
+ roleMappingResource.clientLevel(clientRepresentation.getId()).listEffective()
+ .stream()
+ .map(RoleRepresentation::getName)
+ .toArray(String[]::new), () -> new String[0]);
});
}
@Override
- public Role[] getUserRealmRoles(String realm, String userId) {
+ public String[] getUserRealmRoles(String realm, String userId) {
return getRealms(realmsResource -> {
RealmResource realmResource = realmsResource.realm(realm);
RoleMappingResource roleMappingResource = realmResource.users().get(userId).roles();
-
- RolesResource rolesResource = realmResource.roles();
- List<RoleRepresentation> allRoles = rolesResource.list();
- List<RoleRepresentation> effectiveRoles = roleMappingResource.realmLevel().listEffective();
-
- List<Role> roles = new ArrayList<>();
- for (RoleRepresentation roleRepresentation : allRoles) {
- boolean isAssigned = false;
-
- for (RoleRepresentation effectiveRole : effectiveRoles) {
- if (effectiveRole.getId().equals(roleRepresentation.getId()))
- isAssigned = true;
- }
-
- roles.add(new Role(
- roleRepresentation.getId(),
- roleRepresentation.getName(),
- roleRepresentation.isComposite(),
- isAssigned,
- null)
- .setDescription(roleRepresentation.getDescription()));
- }
-
- return roles.toArray(new Role[0]);
+ return roleMappingResource.realmLevel().listEffective()
+ .stream()
+ .filter(rr -> (MASTER_REALM.equals(realm) && SUPER_USER_REALM_ROLE.equals(rr.getName())) || !isBuiltInRealmRole(rr.getName()))
+ .map(RoleRepresentation::getName).toArray(String[]::new);
});
}
@Override
- public void updateUserRoles(@NotNull String realm, @NotNull String userId, @NotNull String client, String...roles) {
+ public void updateUserClientRoles(@NotNull String realm, @NotNull String userId, @NotNull String client, String...roles) {
getRealms(realmsResource -> {
RealmResource realmResource = realmsResource.realm(realm);
UserRepresentation user = realmResource.users().get(userId).toRepresentation();
@@ -701,42 +666,36 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
ClientResource clientResource = realmResource.clients().get(clientRepresentation.getId());
-
- // Get all roles
- List<RoleRepresentation> existingRoles = roleMappingResource.clientLevel(clientRepresentation.getId()).listAll();
+ List<String> assignedRoles = roles != null ? Arrays.asList(roles) : Collections.emptyList();
+ // Get all configurable client roles
List<RoleRepresentation> availableRoles = clientResource.roles().list();
- List<RoleRepresentation> requestedRoles = availableRoles.stream().filter(role -> Arrays.stream(roles).anyMatch(name -> role.getName().equals(name))).collect(Collectors.toList());
-
- // Strip out requested roles that are already in a requested composite role
- List<String> removeRequestedRoles = requestedRoles.stream()
- .filter(RoleRepresentation::isComposite)
- .flatMap(role ->
- realmResource.rolesById().getRoleComposites(role.getId()).stream().map(RoleRepresentation::getId)
- ).collect(Collectors.toList());
-
- requestedRoles = requestedRoles.stream()
- .filter(role -> removeRequestedRoles.stream().noneMatch(id -> id.equals(role.getId())))
- .collect(Collectors.toList());
-
-
- // Get newly defined roles
- List<RoleRepresentation> addRoles = requestedRoles.isEmpty() ? Collections.emptyList() : requestedRoles.stream()
- .filter(requestedRole -> existingRoles.stream().noneMatch(r -> r.getId().equals(requestedRole.getId())))
- .collect(Collectors.toList());
-
- // Remove obsolete roles
- List<RoleRepresentation> finalRequestedRoles = requestedRoles;
- List<RoleRepresentation> removeRoles = requestedRoles.isEmpty() ? existingRoles : existingRoles.stream()
- .filter(r -> finalRequestedRoles.stream().noneMatch(requestedRole -> requestedRole.getId().equals(r.getId())))
- .collect(Collectors.toList());
-
- if (!removeRoles.isEmpty()) {
- roleMappingResource.clientLevel(clientRepresentation.getId()).remove(removeRoles);
- }
- if (!addRoles.isEmpty()) {
- roleMappingResource.clientLevel(clientRepresentation.getId()).add(addRoles);
- }
+ // Delete any that are not assigned and add all that are assigned
+ availableRoles.stream()
+ .collect(Collectors.partitioningBy(rr -> assignedRoles.contains(rr.getName())))
+ .forEach((isAssigned, realmRoles) -> {
+ if (isAssigned) {
+ // Assigned roles
+ if (!realmRoles.isEmpty()) {
+ roleMappingResource.clientLevel(clientRepresentation.getId()).add(realmRoles.stream().map(v -> {
+ RoleRepresentation rr = new RoleRepresentation();
+ rr.setId(v.getId());
+ rr.setName(v.getName());
+ return rr;
+ }).toList());
+ }
+ } else {
+ // Unassigned roles
+ if (!realmRoles.isEmpty()) {
+ roleMappingResource.clientLevel(clientRepresentation.getId()).remove(realmRoles.stream().map(v -> {
+ RoleRepresentation rr = new RoleRepresentation();
+ rr.setId(v.getId());
+ rr.setName(v.getName());
+ return rr;
+ }).toList());
+ }
+ }
+ });
return null;
});
}
@@ -752,42 +711,37 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
RoleMappingResource roleMappingResource = realmResource.users().get(user.getId()).roles();
-
- // Get all roles
- List<RoleRepresentation> existingRoles = roleMappingResource.realmLevel().listAll();
- List<RoleRepresentation> availableRoles = realmResource.roles().list();
- List<RoleRepresentation> requestedRoles = availableRoles.stream().filter(role -> Arrays.stream(roles).anyMatch(name -> role.getName().equals(name))).collect(Collectors.toList());
-
- // Strip out requested roles that are already in a requested composite role
- List<String> removeRequestedRoles = requestedRoles.stream()
- .filter(RoleRepresentation::isComposite)
- .flatMap(role ->
- realmResource.rolesById().getRoleComposites(role.getId()).stream().map(RoleRepresentation::getId)
- ).collect(Collectors.toList());
-
- requestedRoles = requestedRoles.stream()
- .filter(role -> removeRequestedRoles.stream().noneMatch(id -> id.equals(role.getId())))
- .collect(Collectors.toList());
-
-
- // Get newly defined roles
- List<RoleRepresentation> addRoles = requestedRoles.isEmpty() ? Collections.emptyList() : requestedRoles.stream()
- .filter(requestedRole -> existingRoles.stream().noneMatch(r -> r.getId().equals(requestedRole.getId())))
- .collect(Collectors.toList());
-
- // Remove obsolete roles
- List<RoleRepresentation> finalRequestedRoles = requestedRoles;
- List<RoleRepresentation> removeRoles = requestedRoles.isEmpty() ? existingRoles : existingRoles.stream()
- .filter(r -> finalRequestedRoles.stream().noneMatch(requestedRole -> requestedRole.getId().equals(r.getId())))
- .collect(Collectors.toList());
-
- if (!removeRoles.isEmpty()) {
- roleMappingResource.realmLevel().remove(removeRoles);
- }
- if (!addRoles.isEmpty()) {
- roleMappingResource.realmLevel().add(addRoles);
- }
-
+ List<String> assignedRoles = roles != null ? Arrays.asList(roles) : Collections.emptyList();
+
+ // Get all configurable realm roles from the realm cache
+ Set<RealmRole> availableRealmRoles = getRealm(realm).getRealmRoles();
+
+ // Delete any that are not assigned and add any that are assigned
+ availableRealmRoles.stream()
+ .collect(Collectors.partitioningBy(rr -> assignedRoles.contains(rr.getName())))
+ .forEach((isAssigned, realmRoles) -> {
+ if (isAssigned) {
+ // Assigned roles
+ if (!realmRoles.isEmpty()) {
+ roleMappingResource.realmLevel().add(realmRoles.stream().map(v -> {
+ RoleRepresentation rr = new RoleRepresentation();
+ rr.setId(v.getId());
+ rr.setName(v.getName());
+ return rr;
+ }).toList());
+ }
+ } else {
+ // Unassigned roles
+ if (!realmRoles.isEmpty()) {
+ roleMappingResource.realmLevel().remove(realmRoles.stream().map(v -> {
+ RoleRepresentation rr = new RoleRepresentation();
+ rr.setId(v.getId());
+ rr.setName(v.getName());
+ return rr;
+ }).toList());
+ }
+ }
+ });
return null;
});
}
@@ -802,7 +756,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
.filter(user -> user.getUsername().equals(MASTER_REALM_ADMIN_USER))
.findFirst();
- if (!adminUser.isPresent()) {
+ if (adminUser.isEmpty()) {
throw new IllegalStateException("Can't load master realm admin user");
}
return adminUser.map(UserRepresentation::getId).map(id -> id.equals(userId)).orElse(false);
@@ -814,13 +768,21 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
}
@Override
- public Realm getRealm(String realm) {
+ public Realm getRealm(String name) {
// This gets hit a lot for event authorisation so caching added
- return realmCache.computeIfAbsent(realm, (name) -> {
+ return realmCache.computeIfAbsent(name, k -> {
try {
- return ManagerIdentityProvider.getRealmFromDb(persistenceService, realm);
+ Realm realm = ManagerIdentityProvider.getRealmFromDb(persistenceService, name);
+ // Filter out built in roles
+ realm.setRealmRoles(
+ realm.getRealmRoles()
+ .stream()
+ .filter(rr -> (MASTER_REALM.equals(name) && SUPER_USER_REALM_ROLE.equals(rr.getName())) || !isBuiltInRealmRole(rr.getName()))
+ .collect(Collectors.toSet())
+ );
+ return realm;
} catch (Exception ex) {
- LOG.log(Level.INFO, "Failed to get realm by name: " + realm, ex);
+ LOG.log(Level.INFO, "Failed to get realm by name: " + name, ex);
}
return null;
});
@@ -836,19 +798,24 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
throw new IllegalStateException("Realm must already exist, ID does not match an existing realm");
}
- // Force realm to lowercase
- realm.setName(realm.getName().toLowerCase(Locale.ROOT));
-
- // Find existing realm by ID as realm name could have been changed
- RealmRepresentation realmRepresentation = realmsResource.findAll().stream().filter(r -> r.getId().equals(realm.getId())).findFirst().orElse(null);
+ RealmResource realmResource = realmsResource.realm(realm.getName());
+ RealmRepresentation realmRepresentation = realmResource.toRepresentation();
+ Set<RoleRepresentation> existingRealmRoles = realmResource.roles().list()
+ .stream()
+ .filter(rr -> !isBuiltInRealmRole(rr.getName()))
+ .collect(Collectors.toSet());
if (realmRepresentation == null) {
- throw new IllegalStateException("Realm must already exist, ID does not match an existing realm");
+ throw new IllegalStateException("Realm does not exist: " + realm.getName());
}
- String realmName = realmRepresentation.getRealm();
- RealmResource realmResource = realmsResource.realm(realmName);
- Realm existingRealm = getRealm(realmName);
+ Realm existingRealm = convert(realmRepresentation, Realm.class);
+ // Inject name as it is called realm in the realmRepresentation
+ existingRealm.setName(realmRepresentation.getRealm());
+ // Inject roles as don't exist in realmRepresentation
+ existingRealm.setRealmRoles(existingRealmRoles.stream()
+ .map(err -> new RealmRole(err.getId(), err.getName(), err.getDescription()))
+ .collect(Collectors.toSet()));
// Realm only has a subset of realm representation so overlay on actual realm representation
realmRepresentation.setDisplayName(realm.getDisplayName());
@@ -869,30 +836,35 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
configureRealm(realmRepresentation);
realmResource.update(realmRepresentation);
- Set<RealmRole> existingRealmRoles = existingRealm.getRealmRoles();
- existingRealm.setRealmRoles(existingRealmRoles);
-
- // Update realm roles if required
- if (realm.getRealmRoles() != null) {
-
- Set<RealmRole> realmRoles = realm.getNormalisedRealmRoles();
- RolesResource rolesResource = realmResource.roles();
+ Set<RealmRole> realmRoles = (realm.getRealmRoles() != null ? realm.getRealmRoles() : new HashSet<RealmRole>())
+ .stream()
+ .filter(rr -> !isBuiltInRealmRole(rr.getName()))
+ .collect(Collectors.toSet());
+ realmRoles = new HashSet<>(realmRoles);
+ realmRoles.addAll(Realm.DEFAULT_REALM_ROLES);
+
+ // Remove any obsolete roles
+ Set<RealmRole> finalRealmRoles = realmRoles;
+ existingRealmRoles.forEach(existingRealmRole -> {
+ if (finalRealmRoles.stream()
+ .noneMatch(realmRole -> realmRole.getName().equals(existingRealmRole.getName()))) {
+ realmResource.roles().deleteRole(existingRealmRole.getName());
+ }
+ });
- // Handle removed roles
- existingRealmRoles.stream().filter(realmRole -> !realmRoles.contains(realmRole)).forEach(realmRole -> {
- LOG.finest("Removing realm role + " + realmRole);
- rolesResource.deleteRole(realmRole.getName());
- });
- // Handle added roles
- realmRoles.stream().filter(realmRole -> !existingRealmRoles.contains(realmRole)).forEach(realmRole -> {
- LOG.finest("Adding realm role + " + realmRole);
- rolesResource.create(new RoleRepresentation(realmRole.getName(), realmRole.getDescription(), false));
- });
- }
+ // Create new roles
+ realmRoles.forEach(realmRole -> {
+ if (existingRealmRoles.stream()
+ .noneMatch(existingRealmRole -> existingRealmRole.getName().equals(realmRole.getName()))) {
+ realmResource.roles().create(new RoleRepresentation(realmRole.getName(), realmRole.getDescription(), false));
+ }
+ });
Realm updatedRealm = convert(realmRepresentation, Realm.class);
+ // Inject name as it is called realm in the realmRepresentation
updatedRealm.setName(realmRepresentation.getRealm());
- updatedRealm.setRealmRoles((realm.getRealmRoles() == null) ? existingRealmRoles : realm.getNormalisedRealmRoles());
+ // Inject roles as don't exist in realmRepresentation
+ updatedRealm.setRealmRoles(realmRoles);
persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.UPDATE, updatedRealm, existingRealm, Realm.class, null, null);
return null;
});
@@ -903,9 +875,6 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
LOG.fine("Create realm: " + realm);
return getRealms(realmsResource -> {
- // Force realm to lowercase
- realm.setName(realm.getName().toLowerCase(Locale.ROOT));
-
RealmRepresentation realmRepresentation = convert(realm, RealmRepresentation.class);
// Inject name as it is called realm in the realmRepresentation
realmRepresentation.setRealm(realm.getName());
@@ -919,13 +888,16 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
configureRealm(realmRepresentation);
realmResource.update(realmRepresentation);
- // Set realm roles
- RolesResource rolesResource = realmResource.roles();
- List<RoleRepresentation> existingRealmRoles = rolesResource.list();
- realm.getNormalisedRealmRoles().stream().filter(realmRole -> existingRealmRoles.stream().noneMatch(roleRepresentation -> roleRepresentation.getName().equals(realmRole.getName())))
- .forEach(realmRole -> {
+ // Create realm roles inserting
+ Set<RealmRole> realmRoles = (realm.getRealmRoles() != null ? realm.getRealmRoles() : new HashSet<RealmRole>())
+ .stream()
+ .filter(rr -> !isBuiltInRealmRole(rr.getName()))
+ .collect(Collectors.toSet());
+ realmRoles = new HashSet<>(realmRoles);
+ realmRoles.addAll(Realm.DEFAULT_REALM_ROLES);
+ realmRoles.forEach(realmRole -> {
LOG.finest("Adding realm role + " + realmRole);
- rolesResource.create(new RoleRepresentation(realmRole.getName(), realmRole.getDescription(), false));
+ realmResource.roles().create(new RoleRepresentation(realmRole.getName(), realmRole.getDescription(), false));
});
// Auto create the standard openremote client
@@ -933,7 +905,9 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
createUpdateClient(realm.getName(), clientRepresentation);
Realm createdRealm = convert(realmRepresentation, Realm.class);
+ // Inject name as it is called realm in the realmRepresentation
createdRealm.setName(realmRepresentation.getRealm());
+ // Inject roles as don't exist in realmRepresentation
createdRealm.setRealmRoles(realm.getRealmRoles());
persistenceService.publishPersistenceEvent(PersistenceEvent.Cause.CREATE, realm, null, Realm.class, null, null);
return createdRealm;
@@ -1277,6 +1251,10 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
});
}
+ public static boolean isBuiltInRealmRole(String realmRole) {
+ return realmRole.startsWith("default-roles-") || BUILT_IN_REALM_ROLES.contains(realmRole);
+ }
+
@Override
public String toString() {
return getClass().getSimpleName() + "{}";
diff --git a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java
index f1c93de9f..b49a508e5 100644
--- a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java
+++ b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java
@@ -19,7 +19,6 @@
*/
package org.openremote.manager.security;
-import com.fasterxml.jackson.databind.JsonNode;
import org.openremote.container.security.AuthContext;
import org.openremote.container.security.keycloak.KeycloakIdentityProvider;
import org.openremote.container.timer.TimerService;
@@ -34,7 +33,6 @@ import org.openremote.model.security.*;
import jakarta.ws.rs.*;
import org.openremote.model.util.TextUtil;
-import org.openremote.model.util.ValueUtil;
import java.util.*;
@@ -191,12 +189,7 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public Role[] getCurrentUserRoles(RequestParams requestParams) {
- return getCurrentUserClientRoles(requestParams, KEYCLOAK_CLIENT_ID);
- }
-
- @Override
- public Role[] getCurrentUserClientRoles(RequestParams requestParams, String clientId) {
+ public String[] getCurrentUserClientRoles(RequestParams requestParams, String clientId) {
if (!isAuthenticated()) {
throw new ForbiddenException("Must be authenticated");
}
@@ -205,7 +198,7 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public Role[] getCurrentUserRealmRoles(RequestParams requestParams) {
+ public String[] getCurrentUserRealmRoles(RequestParams requestParams) {
if (!isAuthenticated()) {
throw new ForbiddenException("Must be authenticated");
}
@@ -214,12 +207,7 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public Role[] getUserRoles(RequestParams requestParams, String realm, String userId) {
- return getUserClientRoles(requestParams, realm, userId, KEYCLOAK_CLIENT_ID);
- }
-
- @Override
- public Role[] getUserClientRoles(@BeanParam RequestParams requestParams, String realm, String userId, String clientId) {
+ public String[] getUserClientRoles(@BeanParam RequestParams requestParams, String realm, String userId, String clientId) {
boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);
if (!hasAdminReadRole && !Objects.equals(getUserId(), userId)) {
@@ -227,7 +215,7 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
try {
- return identityService.getIdentityProvider().getUserRoles(
+ return identityService.getIdentityProvider().getUserClientRoles(
realm, userId, clientId
);
} catch (ClientErrorException ex) {
@@ -238,7 +226,7 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public Role[] getUserRealmRoles(RequestParams requestParams, String realm, String userId) {
+ public String[] getUserRealmRoles(RequestParams requestParams, String realm, String userId) {
boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);
if (!hasAdminReadRole && !Objects.equals(getUserId(), userId)) {
@@ -257,21 +245,13 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public void updateUserRoles(RequestParams requestParams, String realm, String userId, Role[] roles) {
- updateUserClientRoles(requestParams, realm, userId, roles, KEYCLOAK_CLIENT_ID);
- }
-
- @Override
- public void updateUserClientRoles(@BeanParam RequestParams requestParams, String realm, String userId, Role[] roles, String clientId) {
+ public void updateUserClientRoles(@BeanParam RequestParams requestParams, String realm, String userId, String[] roles, String clientId) {
try {
- identityService.getIdentityProvider().updateUserRoles(
+ identityService.getIdentityProvider().updateUserClientRoles(
realm,
userId,
clientId,
- Arrays.stream(roles)
- .filter(Role::isAssigned)
- .map(Role::getName)
- .toArray(String[]::new));
+ roles);
} catch (ClientErrorException ex) {
ex.printStackTrace(System.out);
throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());
@@ -281,15 +261,12 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
@Override
- public void updateUserRealmRoles(RequestParams requestParams, String realm, String userId, Role[] roles) {
+ public void updateUserRealmRoles(RequestParams requestParams, String realm, String userId, String[] roles) {
try {
identityService.getIdentityProvider().updateUserRealmRoles(
realm,
userId,
- Arrays.stream(roles)
- .filter(Role::isAssigned)
- .map(Role::getName)
- .toArray(String[]::new));
+ roles);
} catch (ClientErrorException ex) {
ex.printStackTrace(System.out);
throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());
@@ -298,15 +275,10 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
}
}
- @Override
- public Role[] getRoles(RequestParams requestParams, String realm) {
- return getClientRoles(requestParams, realm, KEYCLOAK_CLIENT_ID);
- }
-
@Override
public Role[] getClientRoles(RequestParams requestParams, String realm, String clientId) {
try {
- return identityService.getIdentityProvider().getRoles(
+ return identityService.getIdentityProvider().getClientRoles(
realm,
clientId);
} catch (ClientErrorException ex) {
diff --git a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java
index 84aaed08b..99cd8db08 100644
--- a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java
+++ b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java
@@ -108,7 +108,7 @@ public abstract class AbstractKeycloakSetup implements Setup {
return null;
}
if (roles != null && roles.length > 0) {
- keycloakProvider.updateUserRoles(realm, user.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(roles).map(ClientRole::getValue).toArray(String[]::new));
+ keycloakProvider.updateUserClientRoles(realm, user.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(roles).map(ClientRole::getValue).toArray(String[]::new));
}
return user;
}
diff --git a/manager/src/main/java/org/openremote/manager/setup/KeycloakInitSetup.java b/manager/src/main/java/org/openremote/manager/setup/KeycloakInitSetup.java
index fd7ecf249..a4f70bce9 100644
--- a/manager/src/main/java/org/openremote/manager/setup/KeycloakInitSetup.java
+++ b/manager/src/main/java/org/openremote/manager/setup/KeycloakInitSetup.java
@@ -45,7 +45,7 @@ public class KeycloakInitSetup extends AbstractKeycloakSetup {
// e.g. Set SMTP server, theme, timeouts, etc.
Realm masterRealm = keycloakProvider.getRealm(MASTER_REALM);
masterRealm.setDisplayName("Master");
- masterRealm.setRealmRoles(masterRealm.getNormalisedRealmRoles());
+ masterRealm.setRealmRoles(null); // Clear out any existing custom realm roles
keycloakProvider.updateRealm(masterRealm);
// Create our client application with its default roles in the master realm
@@ -58,6 +58,6 @@ public class KeycloakInitSetup extends AbstractKeycloakSetup {
keycloakProvider.createUpdateUser(MASTER_REALM, adminUser, null, true);
// Give admin all roles on application client level
- keycloakProvider.updateUserRoles(MASTER_REALM, adminUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ.getValue(), ClientRole.WRITE.getValue());
+ keycloakProvider.updateUserClientRoles(MASTER_REALM, adminUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ.getValue(), ClientRole.WRITE.getValue());
}
}
diff --git a/model/src/main/java/org/openremote/model/Constants.java b/model/src/main/java/org/openremote/model/Constants.java
index 224ee4f03..152ffb1c2 100644
--- a/model/src/main/java/org/openremote/model/Constants.java
+++ b/model/src/main/java/org/openremote/model/Constants.java
@@ -28,7 +28,7 @@ public interface Constants {
String MANAGER_CLIENT_ID = "manager-keycloak";
String MASTER_REALM = "master";
String MASTER_REALM_ADMIN_USER = "admin";
- String REALM_ADMIN_ROLE = "admin";
+ String SUPER_USER_REALM_ROLE = "admin";
String READ_LOGS_ROLE = "read:logs";
String READ_USERS_ROLE = "read:users";
String READ_ADMIN_ROLE = "read:admin";
diff --git a/model/src/main/java/org/openremote/model/security/Realm.java b/model/src/main/java/org/openremote/model/security/Realm.java
index 2bb1c67f0..d8aba8db8 100644
--- a/model/src/main/java/org/openremote/model/security/Realm.java
+++ b/model/src/main/java/org/openremote/model/security/Realm.java
@@ -46,8 +46,9 @@ import static org.openremote.model.Constants.RESTRICTED_USER_REALM_ROLE;
@Subselect("select * from PUBLIC.REALM") // Map this immutable to an SQL view, don't use/create table
public class Realm {
- protected static Field[] propertyFields;
-
+ public static final List<RealmRole> DEFAULT_REALM_ROLES = List.of(
+ new RealmRole(null, RESTRICTED_USER_REALM_ROLE, "Restricted access to assets")
+ );
private static final PasswordPolicyConverter PASSWORD_POLICY_CONVERTER = new PasswordPolicyConverter();
public static class PasswordPolicyDeserializer extends JsonDeserializer<List<String>> {
@@ -148,7 +149,7 @@ public class Realm {
@Size(min = 3, max = 255, message = "{Realm.realm.Size}")
@Pattern(regexp = "[a-zA-Z0-9\\-_]+", message = "{Realm.realm.Pattern}")
public String getName() {
- return name;
+ return name != null ? name.toLowerCase() : null;
}
public Realm setName(String name) {
@@ -321,40 +322,11 @@ public class Realm {
return realmRoles;
}
- @JsonIgnore
- public Set<RealmRole> getNormalisedRealmRoles() {
- Set<RealmRole> tempSet = new HashSet<>(getDefaultRealmRoles(getName()));
- if (realmRoles != null) {
- tempSet.addAll(realmRoles);
- }
- return tempSet;
- }
-
public Realm setRealmRoles(Set<RealmRole> realmRoles) {
this.realmRoles = realmRoles;
return this;
}
- protected static List<RealmRole> getDefaultRealmRoles(String realm) {
- if (MASTER_REALM.equals(realm)) {
- return Arrays.asList(
- new RealmRole("default-roles-master"),
- new RealmRole("admin"),
- new RealmRole("create-realm"),
- new RealmRole("offline_access"),
- new RealmRole("uma_authorization"),
- new RealmRole(RESTRICTED_USER_REALM_ROLE, "Restricted access to assets")
- );
- }
-
- return Arrays.asList(
- new RealmRole("default-roles-" + realm),
- new RealmRole("offline_access"),
- new RealmRole("uma_authorization"),
- new RealmRole(RESTRICTED_USER_REALM_ROLE, "Restricted access to assets")
- );
- }
-
@Override
public int hashCode() {
return Objects.hashCode(name);
diff --git a/model/src/main/java/org/openremote/model/security/RealmRole.java b/model/src/main/java/org/openremote/model/security/RealmRole.java
index e175d233c..62378d105 100644
--- a/model/src/main/java/org/openremote/model/security/RealmRole.java
+++ b/model/src/main/java/org/openremote/model/security/RealmRole.java
@@ -21,7 +21,6 @@ package org.openremote.model.security;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonProperty;
import org.hibernate.annotations.Subselect;
import jakarta.persistence.Column;
@@ -46,13 +45,19 @@ public class RealmRole {
protected RealmRole() {}
@JsonCreator
- public RealmRole(@JsonProperty("name") String name, @JsonProperty("description") String description) {
+ public RealmRole(String id, String name, String description) {
+ this.id = id;
this.name = name;
this.description = description;
}
- public RealmRole(String name) {
+ public RealmRole(String name, String description) {
this.name = name;
+ this.description = description;
+ }
+
+ public String getId() {
+ return id;
}
public String getName() {
diff --git a/model/src/main/java/org/openremote/model/security/UserResource.java b/model/src/main/java/org/openremote/model/security/UserResource.java
index 312843a5e..0851fba6e 100644
--- a/model/src/main/java/org/openremote/model/security/UserResource.java
+++ b/model/src/main/java/org/openremote/model/security/UserResource.java
@@ -19,16 +19,14 @@
*/
package org.openremote.model.security;
-import com.fasterxml.jackson.databind.JsonNode;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
-import org.openremote.model.Constants;
-import org.openremote.model.http.RequestParams;
-import org.openremote.model.query.UserQuery;
-
import jakarta.annotation.security.RolesAllowed;
import jakarta.validation.Valid;
import jakarta.ws.rs.*;
+import org.openremote.model.Constants;
+import org.openremote.model.http.RequestParams;
+import org.openremote.model.query.UserQuery;
import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
@@ -40,14 +38,6 @@ import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
@Path("user")
public interface UserResource {
- @GET
- @Path("{realm}/roles")
- @Produces(APPLICATION_JSON)
- @SuppressWarnings("unusable-by-js")
- @RolesAllowed(Constants.READ_ADMIN_ROLE)
- @Operation(operationId = "getRoles", summary = "Retrieve roles for a realm")
- Role[] getRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);
-
@GET
@Path("{realm}/{clientId}/roles")
@Produces(APPLICATION_JSON)
@@ -126,62 +116,43 @@ public interface UserResource {
@Operation(operationId = "resetSecret", summary = "Reset the secret for a user in a realm")
String resetSecret(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);
- @GET
- @Path("{realm}/userRoles/{userId}")
- @Produces(APPLICATION_JSON)
- @Operation(operationId = "getUserRoles", summary = "Retrieve client roles for a user in a realm")
- Role[] getUserRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);
-
@GET
@Path("{realm}/userRoles/{userId}/{clientId}")
@Produces(APPLICATION_JSON)
@Operation(operationId = "getUserClientRoles", summary = "Retrieve client roles for a user using a client ID in a realm")
- Role[] getUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, @PathParam("clientId") String clientId);
+ String[] getUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, @PathParam("clientId") String clientId);
@GET
@Path("{realm}/userRealmRoles/{userId}")
@Produces(APPLICATION_JSON)
@Operation(operationId = "getUserRealmRoles", summary = "Retrieve realm roles for a user in a realm")
- Role[] getUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);
-
- @GET
- @Path("userRoles")
- @Produces(APPLICATION_JSON)
- @Operation(operationId = "getCurrentUserRoles", summary = "Retrieve client roles for the currently authenticated user")
- Role[] getCurrentUserRoles(@BeanParam RequestParams requestParams);
+ String[] getUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);
@GET
@Path("userRoles/{clientId}")
@Produces(APPLICATION_JSON)
@Operation(operationId = "getCurrentUserClientRoles", summary = "Retrieve client roles for the currently authenticated user using a client ID")
- Role[] getCurrentUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("clientId") String clientId);
+ String[] getCurrentUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("clientId") String clientId);
@GET
@Path("userRealmRoles")
@Produces(APPLICATION_JSON)
@Operation(operationId = "getCurrentUserRealmRoles", summary = "Retrieve realm roles for the currently authenticated user")
- Role[] getCurrentUserRealmRoles(@BeanParam RequestParams requestParams);
-
- @PUT
- @Path("{realm}/userRoles/{userId}")
- @Consumes(APPLICATION_JSON)
- @RolesAllowed(Constants.WRITE_ADMIN_ROLE)
- @Operation(operationId = "updateUserRoles", summary = "Update client roles for a user in a realm")
- void updateUserRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles);
+ String[] getCurrentUserRealmRoles(@BeanParam RequestParams requestParams);
@PUT
@Path("{realm}/userRoles/{userId}/{clientId}")
@Consumes(APPLICATION_JSON)
@RolesAllowed(Constants.WRITE_ADMIN_ROLE)
@Operation(operationId = "updateUserClientRoles", summary = "Update client roles for a user in a realm using a client ID")
- void updateUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles, @PathParam("clientId") String clientId);
+ void updateUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, String[] roles, @PathParam("clientId") String clientId);
@PUT
@Path("{realm}/userRealmRoles/{userId}")
@Consumes(APPLICATION_JSON)
@RolesAllowed(Constants.WRITE_ADMIN_ROLE)
@Operation(operationId = "updateUserRealmRoles", summary = "Update realm roles for a user in a realm")
- void updateUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles);
+ void updateUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, String[] roles);
@PUT
@Path("locale")
diff --git a/setup/src/demo/java/org/openremote/setup/demo/KeycloakDemoSetup.java b/setup/src/demo/java/org/openremote/setup/demo/KeycloakDemoSetup.java
index eea0bc9e7..01568a63c 100644
--- a/setup/src/demo/java/org/openremote/setup/demo/KeycloakDemoSetup.java
+++ b/setup/src/demo/java/org/openremote/setup/demo/KeycloakDemoSetup.java
@@ -73,12 +73,12 @@ public class KeycloakDemoSetup extends AbstractKeycloakSetup {
// Users
User smartCityUser = createUser(realmCity.getName(), "smartcity", "smartcity", "Smart", "City", null, true, demoUserRoles);
this.smartCityUserId = smartCityUser.getId();
- keycloakProvider.updateUserRoles(realmCity.getName(), smartCityUserId, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmCity.getName(), smartCityUserId, "account"); // Remove all roles for account client
User manufacturerUser = createUser(realmManufacturer.getName(), "manufacturer", "manufacturer", "Agri", "Tech", null, true, demoUserRoles);
manufacturerUserId = manufacturerUser.getId();
- keycloakProvider.updateUserRoles(realmManufacturer.getName(), manufacturerUserId, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmManufacturer.getName(), manufacturerUserId, "account"); // Remove all roles for account client
User customerUser = createUser(realmManufacturer.getName(), "customer", "customer", "Bert", "Frederiks", null, true, demoUserRoles);
customerUserId = customerUser.getId();
- keycloakProvider.updateUserRoles(realmManufacturer.getName(), customerUserId, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmManufacturer.getName(), customerUserId, "account"); // Remove all roles for account client
}
}
diff --git a/setup/src/demo/java/org/openremote/setup/demo/ManagerDemoSetup.java b/setup/src/demo/java/org/openremote/setup/demo/ManagerDemoSetup.java
index 5989d536a..75f8decc3 100644
--- a/setup/src/demo/java/org/openremote/setup/demo/ManagerDemoSetup.java
+++ b/setup/src/demo/java/org/openremote/setup/demo/ManagerDemoSetup.java
@@ -2284,7 +2284,7 @@ public class ManagerDemoSetup extends ManagerSetup {
// ################################ Make user restricted ###################################
ManagerIdentityProvider identityProvider = identityService.getIdentityProvider();
identityProvider.updateUserRealmRoles(realmManufacturer.getName(), KeycloakDemoSetup.customerUserId, identityProvider
- .addRealmRoles(realmManufacturer.getName(),
+ .addUserRealmRoles(realmManufacturer.getName(),
KeycloakDemoSetup.customerUserId, RESTRICTED_USER_REALM_ROLE));
}
diff --git a/setup/src/integration/java/org/openremote/setup/integration/KeycloakTestSetup.java b/setup/src/integration/java/org/openremote/setup/integration/KeycloakTestSetup.java
index bf85bedb9..56a8e8927 100644
--- a/setup/src/integration/java/org/openremote/setup/integration/KeycloakTestSetup.java
+++ b/setup/src/integration/java/org/openremote/setup/integration/KeycloakTestSetup.java
@@ -102,27 +102,27 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {
// Users
testuser1 = createUser(MASTER_REALM, "testuser1", "testuser1", "DemoMaster", "DemoLast", null, true, REGULAR_USER_ROLES);
this.testuser1Id = testuser1.getId();
- keycloakProvider.updateUserRoles(MASTER_REALM, testuser1Id, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(MASTER_REALM, testuser1Id, "account"); // Remove all roles for account client
testuser2 = createUser(realmBuilding.getName(), "testuser2", "testuser2", "DemoA2", "DemoLast", "[email protected]", true, false, true, new ClientRole[] {
ClientRole.WRITE_USER,
ClientRole.READ_MAP,
ClientRole.READ_ASSETS
});
this.testuser2Id = testuser2.getId();
- keycloakProvider.updateUserRoles(realmBuilding.getName(), testuser2Id, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmBuilding.getName(), testuser2Id, "account"); // Remove all roles for account client
testuser3 = createUser(realmBuilding.getName(), "testuser3", "testuser3", "DemoA3", "DemoLast", "[email protected]", true, true, false, REGULAR_USER_ROLES);
this.testuser3Id = testuser3.getId();
- keycloakProvider.updateUserRoles(realmBuilding.getName(), testuser3Id, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmBuilding.getName(), testuser3Id, "account"); // Remove all roles for account client
// Add realm role
- keycloakProvider.updateUserRealmRoles(realmBuilding.getName(), testuser3Id, keycloakProvider.addRealmRoles(realmBuilding.getName(), testuser3Id, REALM_ROLE_TEST));
+ keycloakProvider.updateUserRealmRoles(realmBuilding.getName(), testuser3Id, keycloakProvider.addUserRealmRoles(realmBuilding.getName(), testuser3Id, REALM_ROLE_TEST));
buildingUser = createUser(realmBuilding.getName(), "building", "building", "Building", "User", "[email protected]", true, noWriteAccess);
this.buildingUserId = buildingUser.getId();
- keycloakProvider.updateUserRoles(realmBuilding.getName(), buildingUserId, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmBuilding.getName(), buildingUserId, "account"); // Remove all roles for account client
// Add realm role
- keycloakProvider.updateUserRealmRoles(realmBuilding.getName(), buildingUserId, keycloakProvider.addRealmRoles(realmBuilding.getName(), buildingUserId, REALM_ROLE_TEST2));
+ keycloakProvider.updateUserRealmRoles(realmBuilding.getName(), buildingUserId, keycloakProvider.addUserRealmRoles(realmBuilding.getName(), buildingUserId, REALM_ROLE_TEST2));
smartCityUser = createUser(realmCity.getName(), "smartcity", "smartcity", "Smart", "City", null, true, noWriteAccess);
this.smartCityUserId = smartCityUser.getId();
- keycloakProvider.updateUserRoles(realmCity.getName(), smartCityUserId, "account"); // Remove all roles for account client
+ keycloakProvider.updateUserClientRoles(realmCity.getName(), smartCityUserId, "account"); // Remove all roles for account client
/*
* Service user clients
@@ -132,7 +132,7 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {
.setEnabled(true)
.setUsername("serviceuser");
serviceUser = keycloakProvider.createUpdateUser(realmBuilding.getName(), serviceUser, UniqueIdentifierGenerator.generateId("serviceusertest"), true);
- keycloakProvider.updateUserRoles(
+ keycloakProvider.updateUserClientRoles(
realmBuilding.getName(),
serviceUser.getId(),
Constants.KEYCLOAK_CLIENT_ID,
@@ -143,7 +143,7 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {
.setEnabled(true)
.setUsername("serviceuser2");
serviceUser2 = keycloakProvider.createUpdateUser(realmBuilding.getName(), serviceUser2, UniqueIdentifierGenerator.generateId("serviceuser2test"), true);
- keycloakProvider.updateUserRoles(
+ keycloakProvider.updateUserClientRoles(
realmBuilding.getName(),
serviceUser2.getId(),
Constants.KEYCLOAK_CLIENT_ID,
@@ -152,8 +152,8 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {
// ################################ Make users restricted ###################################
ManagerIdentityProvider identityProvider = identityService.getIdentityProvider();
- identityProvider.updateUserRealmRoles(realmBuilding.getName(), testuser3Id, identityProvider.addRealmRoles(realmBuilding.getName(), testuser3Id, RESTRICTED_USER_REALM_ROLE));
- identityProvider.updateUserRealmRoles(realmBuilding.getName(), buildingUserId, identityProvider.addRealmRoles(realmBuilding.getName(), buildingUserId, RESTRICTED_USER_REALM_ROLE));
- identityProvider.updateUserRealmRoles(realmBuilding.getName(), serviceUser2.getId(), identityProvider.addRealmRoles(realmBuilding.getName(), serviceUser2.getId(), RESTRICTED_USER_REALM_ROLE));
+ identityProvider.updateUserRealmRoles(realmBuilding.getName(), testuser3Id, identityProvider.addUserRealmRoles(realmBuilding.getName(), testuser3Id, RESTRICTED_USER_REALM_ROLE));
+ identityProvider.updateUserRealmRoles(realmBuilding.getName(), buildingUserId, identityProvider.addUserRealmRoles(realmBuilding.getName(), buildingUserId, RESTRICTED_USER_REALM_ROLE));
+ identityProvider.updateUserRealmRoles(realmBuilding.getName(), serviceUser2.getId(), identityProvider.addUserRealmRoles(realmBuilding.getName(), serviceUser2.getId(), RESTRICTED_USER_REALM_ROLE));
}
}
diff --git a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
index 62108685a..1621a5375 100644
--- a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
@@ -214,7 +214,7 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {
def "Get and update roles"() {
when: "a request is made for the roles in the building realm by the admin user"
- def roles = adminUserResource.getRoles(null, keycloakTestSetup.realmBuilding.name)
+ def roles = adminUserResource.getClientRoles(null, keycloakTestSetup.realmBuilding.name, KEYCLOAK_CLIENT_ID)
then: "the standard client roles should have been returned"
roles.size() == ClientRole.values().length
@@ -233,7 +233,7 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {
readAssets.compositeRoleIds == null
when: "a request is made for the roles in the smart building realm by a regular user"
- regularUserBuildingResource.getRoles(null, keycloakTestSetup.realmBuilding.name)
+ regularUserBuildingResource.getClientRoles(null, keycloakTestSetup.realmBuilding.name, KEYCLOAK_CLIENT_ID)
then: "a not allowed exception should be thrown"
thrown(ForbiddenException.class)
@@ -251,7 +251,7 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {
] as String[]
).setDescription("This is a test"))
adminUserResource.updateRoles(null, keycloakTestSetup.realmBuilding.name, updatedRoles as Role[])
- roles = adminUserResource.getRoles(null, keycloakTestSetup.realmBuilding.name)
+ roles = adminUserResource.getClientRoles(null, keycloakTestSetup.realmBuilding.name, KEYCLOAK_CLIENT_ID)
def testRole = roles.find {it.name == "test"}
then: "the new composite role should have been saved"
@@ -267,7 +267,7 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {
roles.find {it.name == ClientRole.READ_ASSETS.value}.id
]
adminUserResource.updateRoles(null, keycloakTestSetup.realmBuilding.name, roles)
- roles = adminUserResource.getRoles(null, keycloakTestSetup.realmBuilding.name)
+ roles = adminUserResource.getClientRoles(null, keycloakTestSetup.realmBuilding.name, KEYCLOAK_CLIENT_ID)
writeRole = roles.find {it.name == ClientRole.WRITE.value}
then: "the write role should have been updated"
diff --git a/ui/app/manager/src/headers.ts b/ui/app/manager/src/headers.ts
index b58849e20..13c665a6d 100644
--- a/ui/app/manager/src/headers.ts
+++ b/ui/app/manager/src/headers.ts
@@ -25,7 +25,7 @@ export function headerItemRules<S extends AppStateKeyed, A extends AnyAction>(or
href: "rules",
text: "rule_plural",
hideMobile: true,
- roles: () => !manager.hasRealmRole("restricted_user")
+ roles: () => !manager.isRestrictedUser()
};
}
diff --git a/ui/app/manager/src/pages/page-provisioning.ts b/ui/app/manager/src/pages/page-provisioning.ts
index 3f72dcee8..17f29dcbd 100644
--- a/ui/app/manager/src/pages/page-provisioning.ts
+++ b/ui/app/manager/src/pages/page-provisioning.ts
@@ -1,6 +1,6 @@
import {css, html, TemplateResult, unsafeCSS} from "lit";
import {customElement, state} from "lit/decorators.js";
-import manager, {DefaultColor3} from "@openremote/core";
+import manager, {DefaultColor3, OPENREMOTE_CLIENT_ID} from "@openremote/core";
import "@openremote/or-components/or-panel";
import "@openremote/or-translate";
import {Store} from "@reduxjs/toolkit";
@@ -301,7 +301,7 @@ export class PageProvisioning extends Page<AppStateKeyed> {
return;
}
- const rolesResponse = await manager.rest.api.UserResource.getRoles(manager.displayRealm);
+ const rolesResponse = await manager.rest.api.UserResource.getClientRoles(manager.displayRealm, OPENREMOTE_CLIENT_ID);
if (!responseAndStateOK(rolesResponse, i18next.t("loadFailedRoles"))) {
return;
diff --git a/ui/app/manager/src/pages/page-roles.ts b/ui/app/manager/src/pages/page-roles.ts
index a7a4ad46b..a78bacfaf 100644
--- a/ui/app/manager/src/pages/page-roles.ts
+++ b/ui/app/manager/src/pages/page-roles.ts
@@ -6,7 +6,7 @@ import {
unsafeCSS,
} from "lit";
import {customElement, property, state} from "lit/decorators.js";
-import manager, { OREvent, DefaultColor3 } from "@openremote/core";
+import manager, {OREvent, DefaultColor3, OPENREMOTE_CLIENT_ID} from "@openremote/core";
import "@openremote/or-components/or-panel";
import "@openremote/or-translate";
import { Store } from "@reduxjs/toolkit";
@@ -253,7 +253,7 @@ export class PageRoles extends Page<AppStateKeyed> {
}
protected async getRoles() {
- const roleResponse = await manager.rest.api.UserResource.getRoles(this.realm);
+ const roleResponse = await manager.rest.api.UserResource.getClientRoles(this.realm, OPENREMOTE_CLIENT_ID);
this._compositeRoles = [...roleResponse.data.filter(role => role.composite)];
this._roles = [...roleResponse.data.filter(role => !role.composite)];
this._roles.map(role => {
diff --git a/ui/app/manager/src/pages/page-users.ts b/ui/app/manager/src/pages/page-users.ts
index df8c39527..cc86d89fa 100644
--- a/ui/app/manager/src/pages/page-users.ts
+++ b/ui/app/manager/src/pages/page-users.ts
@@ -1,6 +1,6 @@
import {css, html, PropertyValues, TemplateResult, unsafeCSS} from "lit";
import {customElement, property, state} from "lit/decorators.js";
-import manager, {DefaultColor3, DefaultColor4, Util} from "@openremote/core";
+import manager, {DefaultColor3, DefaultColor4, OPENREMOTE_CLIENT_ID, Util} from "@openremote/core";
import "@openremote/or-components/or-panel";
import "@openremote/or-translate";
import {Store} from "@reduxjs/toolkit";
@@ -38,16 +38,14 @@ interface UserModel extends User {
password?: string;
loaded?: boolean;
loading?: boolean;
- previousRoles?: Role[];
- roles?: Role[];
- previousRealmRoles?: Role[];
- realmRoles?: Role[];
+ previousRoles?: string[];
+ roles?: string[];
+ previousRealmRoles?: string[];
+ realmRoles?: string[];
previousAssetLinks?: UserAssetLink[];
userAssetLinks?: UserAssetLink[];
}
-const RESTRICTED_USER_REALM_ROLE = "restricted_user";
-
@customElement("page-users")
export class PageUsers extends Page<AppStateKeyed> {
static get styles() {
@@ -213,7 +211,7 @@ export class PageUsers extends Page<AppStateKeyed> {
@state()
protected _roles: Role[] = [];
@state()
- protected _realmRoles: Role[] = [];
+ protected _realmRoles: string[] = [];
@state()
protected _registrationEmailAsUsername: boolean = false;
@@ -302,7 +300,7 @@ export class PageUsers extends Page<AppStateKeyed> {
return this.getState().app.realm === this.realm && this.isConnected;
}
- const roleResponse = await manager.rest.api.UserResource.getRoles(manager.displayRealm);
+ const roleResponse = await manager.rest.api.UserResource.getClientRoles(manager.displayRealm, OPENREMOTE_CLIENT_ID);
if (!this.responseAndStateOK(stateChecker, roleResponse, "loadFailedRoles")) {
return;
@@ -323,7 +321,7 @@ export class PageUsers extends Page<AppStateKeyed> {
this._compositeRoles = roleResponse.data.filter(role => role.composite).sort(Util.sortByString(role => role.name));
this._roles = roleResponse.data.filter(role => !role.composite).sort(Util.sortByString(role => role.name));
this._registrationEmailAsUsername = realmResponse.data.registrationEmailAsUsername;
- this._realmRoles = (realmResponse.data.realmRoles || []).sort(Util.sortByString(role => role.name));
+ this._realmRoles = (realmResponse.data.realmRoles || []).map(role => role.name).sort();
this._passwordPolicy = realmResponse.data.passwordPolicy;
this._users = usersResponse.data.filter(user => !user.serviceAccount).sort(Util.sortByString(u => u.username));
this._serviceUsers = usersResponse.data.filter(user => user.serviceAccount).sort(Util.sortByString(u => u.username));
@@ -332,8 +330,11 @@ export class PageUsers extends Page<AppStateKeyed> {
private async _createUpdateUser(user: UserModel, action: 'update' | 'create'): Promise<boolean> {
let result = false;
- if ((this._registrationEmailAsUsername && !user.serviceAccount) ? !user.email : !user.username) {
- showSnackbar(undefined, ((this._registrationEmailAsUsername && !user.serviceAccount) ? "noEmailSet" : "noUsernameSet"), "dismiss");
+ if (this._registrationEmailAsUsername && !user.serviceAccount && !user.email) {
+ showSnackbar(undefined, "noEmailSet", "dismiss");
+ return false;
+ } else if ((!this._registrationEmailAsUsername || user.serviceAccount) && !user.username) {
+ showSnackbar(undefined, "noUsernameSet", "dismiss");
return false;
}
@@ -345,7 +346,7 @@ export class PageUsers extends Page<AppStateKeyed> {
const isUpdate = !!user.id;
try {
- const response = action == 'update'
+ const response = action === 'update'
? await manager.rest.api.UserResource.update(manager.displayRealm, user)
: await manager.rest.api.UserResource.create(manager.displayRealm, user);
@@ -391,19 +392,20 @@ export class PageUsers extends Page<AppStateKeyed> {
* the names will match so that's ok
*/
private async _updateRoles(user: UserModel, realmRoles: boolean) {
- const roles = realmRoles ? user.realmRoles.filter(role => role.assigned) : user.roles.filter(role => role.assigned);
- const previousRoles = realmRoles ? user.previousRealmRoles : user.previousRoles;
- const removedRoles = previousRoles.filter(previousRole => !roles.some(role => role.name === previousRole.name));
- const addedRoles = roles.filter(role => !previousRoles.some(previousRole => previousRole.name === role.name));
-
- if (removedRoles.length === 0 && addedRoles.length === 0) {
- return;
- }
-
if (realmRoles) {
- await manager.rest.api.UserResource.updateUserRealmRoles(manager.displayRealm, user.id, roles);
+ if (!Util.objectsEqual(user.realmRoles, user.previousRealmRoles)) {
+ await manager.rest.api.UserResource.updateUserRealmRoles(manager.displayRealm, user.id, user.realmRoles);
+ }
} else {
- await manager.rest.api.UserResource.updateUserRoles(manager.displayRealm, user.id, roles);
+ const roles = user.roles;
+ const previousRoles = user.previousRoles;
+ const removedRoles = previousRoles.filter(previousRole => !roles.some(role => role === previousRole));
+ const addedRoles = roles.filter(role => !previousRoles.some(previousRole => previousRole === role));
+
+ if (removedRoles.length === 0 && addedRoles.length === 0) {
+ return;
+ }
+ await manager.rest.api.UserResource.updateUserClientRoles(manager.displayRealm, user.id, OPENREMOTE_CLIENT_ID, roles);
}
}
@@ -459,7 +461,7 @@ export class PageUsers extends Page<AppStateKeyed> {
const serviceUsers = this._serviceUserFilter(this._serviceUsers);
const compositeRoleOptions: string[] = this._compositeRoles.map(cr => cr.name);
- const realmRoleOptions: [string, string][] = this._realmRoles ? this._realmRoles.filter(r => Util.realmRoleFilter(r)).map(r => [r.name, i18next.t("realmRole." + r.name, Util.camelCaseToSentenceCase(r.name.replace("_", " ").replace("-", " ")))]) : [];
+ const realmRoleOptions: [string, string][] = this._realmRoles.map(r => [r, i18next.t("realmRole." + r, Util.camelCaseToSentenceCase(r.replace("_", " ").replace("-", " ")))]);
const readonly = !manager.hasRole(ClientRole.WRITE_ADMIN);
// Content of User Table
@@ -499,30 +501,30 @@ export class PageUsers extends Page<AppStateKeyed> {
}
const mergedUserList: UserModel[] = [...users, ...serviceUsers];
- const index: number | undefined = (this.userId ? mergedUserList.findIndex((user) => user.id == this.userId) : undefined);
+ const index: number | undefined = (this.userId ? mergedUserList.findIndex((user) => user.id === this.userId) : undefined);
return html`
<div id="wrapper">
<!-- Breadcrumb on top of the page-->
- ${when((this.userId && index != undefined) || this.creationState, () => html`
+ ${when((this.userId && index !== undefined) || this.creationState, () => html`
<div class="breadcrumb-container">
<span class="breadcrumb-clickable"
@click="${() => this.reset()}">${i18next.t("user_plural")}</span>
<or-icon class="breadcrumb-arrow" icon="chevron-right"></or-icon>
- <span style="margin-left: 2px;">${index != undefined ? mergedUserList[index]?.username : (this.creationState.userModel.serviceAccount ? i18next.t('creating_serviceUser') : i18next.t('creating_regularUser'))}</span>
+ <span style="margin-left: 2px;">${index !== undefined ? mergedUserList[index]?.username : (this.creationState.userModel.serviceAccount ? i18next.t('creating_serviceUser') : i18next.t('creating_regularUser'))}</span>
</div>
`)}
<div id="title">
<or-icon icon="account-group"></or-icon>
- <span>${this.userId && index != undefined ? mergedUserList[index]?.username : i18next.t('user_plural')}</span>
+ <span>${this.userId && index !== undefined ? mergedUserList[index]?.username : i18next.t('user_plural')}</span>
</div>
<!-- User Specific page -->
- ${when((this.userId && index != undefined) || this.creationState, () => html`
- ${when(mergedUserList[index] != undefined || this.creationState, () => {
- const user: UserModel = (index != undefined ? mergedUserList[index] : this.creationState.userModel);
+ ${when((this.userId && index !== undefined) || this.creationState, () => html`
+ ${when(mergedUserList[index] !== undefined || this.creationState, () => {
+ const user: UserModel = (index !== undefined ? mergedUserList[index] : this.creationState.userModel);
return html`
<div id="content" class="panel">
<p class="panel-title">
@@ -644,7 +646,7 @@ export class PageUsers extends Page<AppStateKeyed> {
}
// Load users assigned roles
- const userRolesResponse = await (manager.rest.api.UserResource.getUserRoles(manager.displayRealm, user.id));
+ const userRolesResponse = await (manager.rest.api.UserResource.getUserClientRoles(manager.displayRealm, user.id, OPENREMOTE_CLIENT_ID));
if (!this.responseAndStateOK(() => true, userRolesResponse, "loadFailedUserInfo")) {
return;
}
@@ -662,9 +664,8 @@ export class PageUsers extends Page<AppStateKeyed> {
return;
}
- user.roles = userRolesResponse.data.filter(r => r.assigned);
- user.realmRoles = userRealmRolesResponse.data.filter(r => r.assigned);
- this._realmRoles = [...userRealmRolesResponse.data];
+ user.roles = userRolesResponse.data;
+ user.realmRoles = userRealmRolesResponse.data;
user.previousRealmRoles = [...user.realmRoles];
user.previousRoles = [...user.roles];
user.userAssetLinks = userAssetLinksResponse.data;
@@ -786,12 +787,12 @@ export class PageUsers extends Page<AppStateKeyed> {
const roleName = checkbox.label;
const r = this._roles.find(role => roleName === role.name);
checkbox.disabled = !!implicitRoleNames.find(name => r.name === name);
- checkbox.value = !!user.roles.find(userRole => userRole.name === r.name) || implicitRoleNames.some(implicitRoleName => implicitRoleName === r.name);
+ checkbox.value = !!user.roles.find(userRole => userRole === r.name) || implicitRoleNames.some(implicitRoleName => implicitRoleName === r.name);
});
}
protected getImplicitUserRoles(user: UserModel) {
- return this._compositeRoles.filter((role) => user.roles.some(ur => ur.name === role.name)).flatMap((role) => role.compositeRoleIds).map(id => this._roles.find(r => r.id === id).name);
+ return this._compositeRoles.filter((role) => user.roles.some(ur => ur === role.name)).flatMap((role) => role.compositeRoleIds).map(id => this._roles.find(r => r.id === id).name);
}
protected getSingleUserView(user: UserModel, compositeRoleOptions: string[], realmRoleOptions: [string, string][], suffix: string, readonly: boolean = true): TemplateResult {
@@ -965,18 +966,13 @@ export class PageUsers extends Page<AppStateKeyed> {
?readonly="${readonly}"
?disabled="${isSameUser}"
class = "validate"
- .value="${user.realmRoles && user.realmRoles.length > 0 ? user.realmRoles.filter(r => Util.realmRoleFilter(r)).map(r => r.name) : undefined}"
+ .value="${user.realmRoles}"
.type="${InputType.SELECT}" multiple
.options="${realmRoleOptions}"
.label="${i18next.t("realm_role_plural")}"
@or-mwc-input-changed="${(e: OrInputChangedEvent) => {
this.onUserChanged(suffix);
- const roleNames = e.detail.value as string[];
- const excludedAndCompositeRoles = user.realmRoles.filter(r => !Util.realmRoleFilter(r));
- const selectedRoles = this._realmRoles.filter(cr => roleNames.some(name => cr.name === name)).map(r => {
- return {...r, assigned: true} as Role;
- });
- user.realmRoles = [...excludedAndCompositeRoles, ...selectedRoles];
+ user.realmRoles = e.detail.value as string[];
}}"></or-mwc-input>
<!-- composite client roles -->
@@ -984,15 +980,12 @@ export class PageUsers extends Page<AppStateKeyed> {
?readonly="${readonly}"
?disabled="${isSameUser}"
class = "validate"
- .value="${user.roles && user.roles.length > 0 ? user.roles.filter(r => r.composite).map(r => r.name) : undefined}"
+ .value="${user.roles && user.roles.length > 0 ? user.roles.filter(r => this._compositeRoles.some(cr => cr.name === r)) : undefined}"
.type="${InputType.SELECT}" multiple
.options="${compositeRoleOptions}"
.label="${i18next.t("manager_role_plural")}"
@or-mwc-input-changed="${(e: OrInputChangedEvent) => {
- const roleNames = e.detail.value as string[];
- user.roles = this._compositeRoles.filter(cr => roleNames.some(name => cr.name === name)).map(r => {
- return {...r, assigned: true};
- });
+ user.roles = e.detail.value as string[];
this._updateUserSelectedRoles(user, suffix);
this.onUserChanged(suffix);
}}"></or-mwc-input>
@@ -1006,16 +999,16 @@ export class PageUsers extends Page<AppStateKeyed> {
?readonly="${readonly}"
?disabled="${implicitRoleNames.find(name => r.name === name)}"
class = "validate"
- .value="${!!user.roles.find(userRole => userRole.name === r.name) || implicitRoleNames.some(implicitRoleName => implicitRoleName === r.name)}"
+ .value="${!!user.roles.find(userRole => userRole === r.name) || implicitRoleNames.some(implicitRoleName => implicitRoleName === r.name)}"
.type="${InputType.CHECKBOX}"
.label="${r.name}"
title="${r.description}"
style="flex: 0 1 160px; margin: 0; overflow: hidden;"
@or-mwc-input-changed="${(e: OrInputChangedEvent) => {
if (!!e.detail.value) {
- user.roles.push({...r, assigned: true});
+ user.roles.push(r.name);
} else {
- user.roles = user.roles.filter(e => e.name !== r.name);
+ user.roles = user.roles.filter(ur => ur !== r.name);
}
this.onUserChanged(suffix);
}}"></or-mwc-input>
diff --git a/ui/component/core/src/index.ts b/ui/component/core/src/index.ts
index aa47ef9f0..4f69f6022 100644
--- a/ui/component/core/src/index.ts
+++ b/ui/component/core/src/index.ts
@@ -28,7 +28,9 @@ export * from "./console";
export * from "./event";
export * from "./defaults";
-export const DEFAULT_ICONSET: string = "mdi";
+export const DEFAULT_ICONSET = "mdi";
+export const OPENREMOTE_CLIENT_ID = "openremote";
+export const RESTRICTED_USER_REALM_ROLE = "restricted_user";
export declare type KeycloakPromise<T> = {
success<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | KeycloakPromise<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | KeycloakPromise<TResult2>) | undefined | null): KeycloakPromise<TResult1 | TResult2>;
@@ -144,7 +146,7 @@ export function normaliseConfig(config: ManagerConfig): ManagerConfig {
}
if (normalisedConfig.clientId === undefined) {
- normalisedConfig.clientId = "openremote";
+ normalisedConfig.clientId = OPENREMOTE_CLIENT_ID;
}
return normalisedConfig;
@@ -192,7 +194,7 @@ export class Manager implements EventProviderFactory {
}
}
} else if (this._basicIdentity && this._basicIdentity.roles) {
- roleMap.set(this._config.clientId!, this._basicIdentity.roles.map((r) => r.name!));
+ roleMap.set(this._config.clientId!, this._basicIdentity.roles!);
}
return roleMap;
@@ -263,6 +265,10 @@ export class Manager implements EventProviderFactory {
this._emitEvent(OREvent.DISPLAY_REALM_CHANGED);
}
+ get clientId() {
+ return this._config.clientId || OPENREMOTE_CLIENT_ID;
+ }
+
getEventProvider(): EventProvider | undefined {
return this.events;
}
@@ -283,7 +289,7 @@ export class Manager implements EventProviderFactory {
private _basicIdentity?: {
token: string | undefined,
user: User | undefined,
- roles: Role[] | undefined
+ roles: string[] | undefined
};
private _keycloakUpdateTokenInterval?: number = undefined;
private _managerVersion: string = "";
@@ -835,7 +841,7 @@ export class Manager implements EventProviderFactory {
authenticated = true;
// Get user roles
- const rolesResponse = await rest.api.UserResource.getCurrentUserRoles();
+ const rolesResponse = await rest.api.UserResource.getCurrentUserClientRoles(this.clientId);
this._basicIdentity!.roles = rolesResponse.data;
} else {
console.debug("Unknown response so aborting");
@@ -854,7 +860,7 @@ export class Manager implements EventProviderFactory {
}
public isRestrictedUser(): boolean {
- return !!this.hasRealmRole("restricted_user");
+ return !!this.hasRealmRole(RESTRICTED_USER_REALM_ROLE);
}
public getApiBaseUrl(): string {
@@ -1061,7 +1067,7 @@ export class Manager implements EventProviderFactory {
if (!this._disconnected) {
return;
}
-
+
if (this._reconnectTimer) {
window.clearTimeout(this._reconnectTimer);
this._reconnectTimer = undefined;
@@ -1076,7 +1082,7 @@ export class Manager implements EventProviderFactory {
return false;
}
console.debug("Keycloak is reachable");
-
+
// Check if access token can be refreshed
console.debug("Checking keycloak access token");
try {
diff --git a/ui/component/core/src/util.ts b/ui/component/core/src/util.ts
index ba716f39a..342a20174 100644
--- a/ui/component/core/src/util.ts
+++ b/ui/component/core/src/util.ts
@@ -1104,7 +1104,3 @@ export function blobToBase64(blob:Blob) {
};
});
}
-
-export function realmRoleFilter(role: Role) {
- return role.name === "admin" || (!role.composite && !["uma_authorization", "offline_access", "create-realm"].includes(role.name!) && !role.name!.startsWith("default-roles"));
-}
diff --git a/ui/component/or-asset-viewer/src/index.ts b/ui/component/or-asset-viewer/src/index.ts
index 51b0d57cc..fc7d5e496 100644
--- a/ui/component/or-asset-viewer/src/index.ts
+++ b/ui/component/or-asset-viewer/src/index.ts
@@ -15,7 +15,7 @@ import {showOkCancelDialog, showOkDialog} from "@openremote/or-mwc-components/or
import "@openremote/or-mwc-components/or-mwc-list";
import {translate} from "@openremote/or-translate";
import {InputType, OrInputChangedEvent, OrMwcInput} from "@openremote/or-mwc-components/or-mwc-input";
-import manager, {subscribe, Util, DefaultColor5} from "@openremote/core";
+import manager, {OPENREMOTE_CLIENT_ID, RESTRICTED_USER_REALM_ROLE, subscribe, Util} from "@openremote/core";
import {OrMwcTable, OrMwcTableRowClickEvent} from "@openremote/or-mwc-components/or-mwc-table";
import {OrChartConfig} from "@openremote/or-chart";
import {HistoryConfig, OrAttributeHistory} from "@openremote/or-attribute-history";
@@ -44,8 +44,7 @@ import "./or-edit-asset-panel";
import {OrEditAssetModifiedEvent, OrEditAssetPanel, ValidatorResult} from "./or-edit-asset-panel";
import "@openremote/or-mwc-components/or-mwc-snackbar";
import {showSnackbar} from "@openremote/or-mwc-components/or-mwc-snackbar";
-import { progressCircular } from "@openremote/or-mwc-components/style";
-import { OrAssetTree } from "@openremote/or-asset-tree";
+import {progressCircular} from "@openremote/or-mwc-components/style";
export interface PanelConfig {
type: "info" | "setup" | "history" | "group" | "survey" | "survey-results" | "linkedUsers" | "alarm.linkedAlarms";
@@ -973,9 +972,9 @@ async function getLinkedUserInfo(userAssetLink: UserAssetLink): Promise<UserAsse
const userId = userAssetLink.id!.userId!;
const username = userAssetLink.userFullName!;
- const roleNames = await manager.rest.api.UserResource.getUserRoles(manager.displayRealm, userId)
+ const roleNames = await manager.rest.api.UserResource.getUserClientRoles(manager.displayRealm, userId, manager.clientId)
.then((response) => {
- return response.data.filter(role => role.composite && role.assigned).map(r => r.name!);
+ return response.data;
})
.catch((err) => {
console.info('User not allowed to get roles', err);
@@ -984,7 +983,7 @@ async function getLinkedUserInfo(userAssetLink: UserAssetLink): Promise<UserAsse
const isRestrictedUser = await manager.rest.api.UserResource.getUserRealmRoles(manager.displayRealm, userId)
.then((rolesRes) => {
- return rolesRes.data ? !!rolesRes.data.find(r => r.assigned && r.name === "restricted_user") : false;
+ return rolesRes.data ? !!rolesRes.data.find(r => r === RESTRICTED_USER_REALM_ROLE) : false;
});
return {
diff --git a/ui/component/or-rules/src/json-viewer/or-rule-action-notification.ts b/ui/component/or-rules/src/json-viewer/or-rule-action-notification.ts
index 073f840c2..acb91bfa9 100644
--- a/ui/component/or-rules/src/json-viewer/or-rule-action-notification.ts
+++ b/ui/component/or-rules/src/json-viewer/or-rule-action-notification.ts
@@ -184,7 +184,7 @@ export class OrRuleActionNotification extends LitElement {
// Get realm roles and add as options
const realm = await manager.rest.api.RealmResource.get(manager.displayRealm);
- let realmRoleOpts: [string, string][] = realm.data.realmRoles!.filter(r => Util.realmRoleFilter(r)).map(r => ["linked-" + r.name!, linkedLabel + ": " + i18next.t("realmRole." + r.name, Util.camelCaseToSentenceCase(r.name!.replace("_", " ").replace("-", " ")))]);
+ let realmRoleOpts: [string, string][] = realm.data.realmRoles!.map(r => ["linked-" + r.name!, linkedLabel + ": " + i18next.t("realmRole." + r.name, Util.camelCaseToSentenceCase(r.name!.replace("_", " ").replace("-", " ")))]);
let values: [string, string][] = usersResponse.data.map((user) => [user.id!, user.username!]);
return [["linkedUsers", linkedLabel], ...realmRoleOpts, ...values.sort(Util.sortByString(user => user[1]))];
}