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
Added endpoints for realm roles. Test is WIP
Michael Rademakerfeec8574af6e
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.javaindex 874a84871..05cfba5d6 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java@@ -175,7 +175,6 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen.map(role -> new Role(UUID.randomUUID().toString(), role, false, true, null)).toArray(Role[]::new);}-public void updateUserAttributes(String realm, String userId, Map<String, List<String>> attributes) {throw new UnsupportedOperationException("This provider does not support updating attributes");}@@ -185,6 +184,11 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implementhrow new UnsupportedOperationException("This provider does not support updating roles");}+ @Override+ public void updateRealmRoles(String realm, Role[] roles) {+ throw new UnsupportedOperationException("This provider does not support updating realm roles");+ }+@Overridepublic Role[] getUserRoles(String realm, String userId, String client) {return ClientRole.ALL_ROLES.stream()@@ -192,11 +196,21 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen.toArray(Role[]::new);}+ @Override+ public Role[] getUserRealmRoles(String realm, String userId) {+ throw new UnsupportedOperationException("This provider does not support user realm roles");+ }+@Overridepublic void updateUserRoles(String realm, String userId, String client, String... roles) {throw new UnsupportedOperationException("This provider does not support updating user roles");}+ @Override+ public void updateUserRealmRoles(String realm, String userId, String... roles) {+ throw new UnsupportedOperationException("This provider does not support updating user realm roles");+ }+@Overridepublic boolean isMasterRealmAdmin(String userId) {return true;diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.javaindex f6ab520ad..4d394bdd7 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java@@ -71,10 +71,16 @@ public interface ManagerIdentityProvider extends IdentityProvider {void updateClientRoles(String realm, String client, Role[] roles);+ void updateRealmRoles(String realm, Role[] roles);+Role[] getUserRoles(String realm, String userId, String client);+ Role[] getUserRealmRoles(String realm, String userId);+void updateUserRoles(String realm, String userId, String client, String...roles);+ void updateUserRealmRoles(String realm, String userId, String...roles);+boolean isMasterRealmAdmin(String userId);boolean isRestrictedUser(AuthContext authContext);diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.javaindex 6cb5e4102..eed2a7f8c 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java@@ -563,6 +563,83 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im});}+ @Override+ public void updateRealmRoles(String realm, Role[] roles) {++ getRealms(realmsResource -> {+ RealmResource realmResource = realmsResource.realm(realm);+ List<RoleRepresentation> existingRoles = new ArrayList<>(realmResource.roles().list());++ List<RoleRepresentation> removedRoles = existingRoles.stream()+ .filter(existingRole -> Arrays.stream(roles).noneMatch(r -> existingRole.getId().equals(r.getId())))+ .collect(Collectors.toList());++ removedRoles.forEach(removedRole -> {+ realmResource.rolesById().deleteRole(removedRole.getId());+ existingRoles.remove(removedRole);+ });++ Arrays.stream(roles).forEach(role -> {++ RoleRepresentation existingRole;+ boolean compositesModified = false;+ Set<RoleRepresentation> existingComposites = new HashSet<>();+ Set<RoleRepresentation> requestedComposites = new HashSet<>();++ if (role.getId() == null) {+ existingRole = saveRealmRole(realmResource, role, null);+ existingRoles.add(existingRole);+ compositesModified = role.getCompositeRoleIds() != null && role.getCompositeRoleIds().length > 0;+ if (compositesModified) {+ requestedComposites.addAll(Arrays.stream(role.getCompositeRoleIds())+ .map(id -> existingRoles.stream().filter(er -> er.getId().equals(id)).findFirst().orElse(null))+ .filter(Objects::nonNull)+ .collect(Collectors.toSet()));+ }+ } else {+ existingRole = existingRoles.stream().filter(r -> r.getId().equals(role.getId())).findFirst().orElseThrow(() -> new IllegalStateException("One or more supplied roles have an ID that doesn't exist"));++ boolean isComposite = role.isComposite() && role.getCompositeRoleIds() != null && role.getCompositeRoleIds().length > 0;++ boolean rolePropertiesModified = !Objects.equals(existingRole.getName(), role.getName())+ || !Objects.equals(existingRole.getDescription(), role.getDescription());++ if (isComposite || existingRole.isComposite()) {+ existingComposites.addAll(Optional.ofNullable(realmResource.rolesById().getRoleComposites(existingRole.getId())).orElse(new HashSet<>()));+ requestedComposites.addAll(Arrays.stream(role.getCompositeRoleIds())+ .map(id -> existingRoles.stream().filter(er -> er.getId().equals(id)).findFirst().orElse(null))+ .filter(Objects::nonNull)+ .collect(Collectors.toSet()));++ if (requestedComposites.size() != role.getCompositeRoleIds().length) {+ throw new IllegalStateException("One or more composite roles contain an invalid role ID");+ }++ compositesModified = !Objects.equals(existingComposites, requestedComposites);+ }++ if (rolePropertiesModified) {+ // Merge the role property changes+ saveRealmRole(realmResource, role, existingRole);+ }+ }++ if (compositesModified) {+ List<RoleRepresentation> removed = existingComposites.stream().filter(existing -> !requestedComposites.contains(existing)).collect(Collectors.toList());+ List<RoleRepresentation> added = requestedComposites.stream().filter(existing -> !existingComposites.contains(existing)).collect(Collectors.toList());+ if (!removed.isEmpty()) {+ realmResource.rolesById().deleteComposites(existingRole.getId(), removed);+ }+ if (!added.isEmpty()) {+ realmResource.rolesById().addComposites(existingRole.getId(), added);+ }+ }+ });++ return null;+ });+ }+protected RoleRepresentation saveClientRole(RealmResource realmResource, ClientResource clientResource, Role role, RoleRepresentation representation) {if (representation == null) {representation = new RoleRepresentation();@@ -579,6 +656,22 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider imreturn clientResource.roles().get(representation.getName()).toRepresentation();}+ protected RoleRepresentation saveRealmRole(RealmResource realmResource, Role role, RoleRepresentation representation) {+ if (representation == null) {+ representation = new RoleRepresentation();+ }+ representation.setName(role.getName());+ representation.setDescription(role.getDescription());+ representation.setClientRole(true);+ if (representation.getId() == null) {+ realmResource.roles().create(representation);+ } else {+ realmResource.rolesById().updateRole(representation.getId(), representation);+ }++ return realmResource.roles().get(representation.getName()).toRepresentation();+ }+@Overridepublic Role[] getUserRoles(String realm, String userId, String client) {return getRealms(realmsResource -> {@@ -613,6 +706,38 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im});}+ @Override+ public Role[] 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]);+ });+ }+@Overridepublic void updateUserRoles(String realm, String userId, String client, String...roles) {getRealms(realmsResource -> {@@ -683,6 +808,57 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im});}+ @Override+ public void updateUserRealmRoles(String realm, String userId, String... roles) {+ getRealms(realmsResource -> {+ RealmResource realmResource = realmsResource.realm(realm);+ UserRepresentation user = realmResource.users().get(userId).toRepresentation();++ if (user == null) {+ throw new IllegalStateException("Multiple users with the same username found");+ }++ 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);+ }++ return null;+ });+ }+@Overridepublic boolean isMasterRealmAdmin(String userId) {Optional<UserRepresentation> adminUser = getRealms(realmsResource ->diff --git a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.javaindex 15698ba90..2054bdc9b 100644--- a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java@@ -169,6 +169,15 @@ public class UserResourceImpl extends ManagerWebResource implements UserResourcereturn getUserClientRoles(requestParams, getRequestRealm(), getUserId(), clientId);}+ @Override+ public Role[] getCurrentUserRealmRoles(RequestParams requestParams) {+ if (!isAuthenticated()) {+ throw new ForbiddenException("Must be authenticated");+ }++ return getUserRealmRoles(requestParams, getRequestRealm(), getUserId());+ }+@Overridepublic Role[] getUserRoles(RequestParams requestParams, String realm, String userId) {return getUserClientRoles(requestParams, realm, userId, KEYCLOAK_CLIENT_ID);@@ -191,6 +200,23 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}}+ @Override+ public Role[] getUserRealmRoles(RequestParams requestParams, String realm, String userId) {+ if (!isSuperUser() && !Objects.equals(getUserId(), userId)) {+ throw new ForbiddenException("Regular users can only retrieve their own roles");+ }++ try {+ return identityService.getIdentityProvider().getUserRealmRoles(+ realm, userId+ );+ } catch (ClientErrorException ex) {+ throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());+ } catch (Exception ex) {+ throw new WebApplicationException(ex);+ }+ }+@Overridepublic void updateUserRoles(RequestParams requestParams, String realm, String userId, Role[] roles) {updateUserClientRoles(requestParams, realm, userId, roles, KEYCLOAK_CLIENT_ID);@@ -215,6 +241,24 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}}+ @Override+ public void updateUserRealmRoles(RequestParams requestParams, String realm, String userId, Role[] roles) {+ try {+ identityService.getIdentityProvider().updateUserRealmRoles(+ realm,+ userId,+ Arrays.stream(roles)+ .filter(Role::isAssigned)+ .map(Role::getName)+ .toArray(String[]::new));+ } catch (ClientErrorException ex) {+ ex.printStackTrace(System.out);+ throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());+ } catch (Exception ex) {+ throw new WebApplicationException(ex);+ }+ }+@Overridepublic Role[] getRoles(RequestParams requestParams, String realm) {return getClientRoles(requestParams, realm, KEYCLOAK_CLIENT_ID);@@ -233,6 +277,19 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}}+ @Override+ public Role[] getRealmRoles(RequestParams requestParams, String realm) {+ try {+ return identityService.getIdentityProvider().getRoles(+ realm,+ null);+ } catch (ClientErrorException ex) {+ throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());+ } catch (Exception ex) {+ throw new WebApplicationException(ex);+ }+ }+@Overridepublic void updateRoles(RequestParams requestParams, String realm, Role[] roles) {updateClientRoles(requestParams, realm, roles, KEYCLOAK_CLIENT_ID);@@ -253,6 +310,20 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}}+ @Override+ public void updateRealmRoles(RequestParams requestParams, String realm, Role[] roles) {+ try {+ identityService.getIdentityProvider().updateRealmRoles(+ realm,+ roles);+ } catch (ClientErrorException ex) {+ ex.printStackTrace(System.out);+ throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());+ } catch (Exception ex) {+ throw new NotFoundException(ex);+ }+ }+protected void throwIfIllegalMasterAdminUserDeletion(RequestParams requestParams, String realm, String userId) throws WebApplicationException {if (!realm.equals(MASTER_REALM)) {return;diff --git a/model/src/main/java/org/openremote/model/security/UserResource.java b/model/src/main/java/org/openremote/model/security/UserResource.javaindex 2c57c1e3c..86eb907ef 100644--- a/model/src/main/java/org/openremote/model/security/UserResource.java+++ b/model/src/main/java/org/openremote/model/security/UserResource.java@@ -52,6 +52,12 @@ public interface UserResource {@RolesAllowed(Constants.WRITE_ADMIN_ROLE)Role[] getClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("clientId") String clientId);+ @GET+ @Path("{realm}/realm-roles")+ @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ @Produces(APPLICATION_JSON)+ Role[] getRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);+@PUT@Path("{realm}/roles")@Consumes(APPLICATION_JSON)@@ -64,6 +70,12 @@ public interface UserResource {@RolesAllowed(Constants.WRITE_ADMIN_ROLE)void updateClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, Role[] roles, @PathParam("clientId") String clientId);+ @PUT+ @Path("{realm}/realm-roles")+ @Consumes(APPLICATION_JSON)+ @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ void updateRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, Role[] roles);+@GET@Produces(APPLICATION_JSON)@Path("{realm}/users")@@ -122,6 +134,11 @@ public interface UserResource {@Produces(APPLICATION_JSON)Role[] getUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, @PathParam("clientId") String clientId);+ @GET+ @Path("{realm}/userRealmRoles/{userId}")+ @Produces(APPLICATION_JSON)+ Role[] getUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);+@GET@Path("userRoles")@Produces(APPLICATION_JSON)@@ -132,6 +149,11 @@ public interface UserResource {@Produces(APPLICATION_JSON)Role[] getCurrentUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("clientId") String clientId);+ @GET+ @Path("userRealmRoles")+ @Produces(APPLICATION_JSON)+ Role[] getCurrentUserRealmRoles(@BeanParam RequestParams requestParams);+@PUT@Path("{realm}/userRoles/{userId}")@Consumes(APPLICATION_JSON)@@ -143,4 +165,10 @@ public interface UserResource {@Consumes(APPLICATION_JSON)@RolesAllowed(Constants.WRITE_ADMIN_ROLE)void updateUserClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles, @PathParam("clientId") String clientId);++ @PUT+ @Path("{realm}/userRealmRoles/{userId}")+ @Consumes(APPLICATION_JSON)+ @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ void updateUserRealmRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles);}diff --git a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovyindex 482dedd6e..5749f54dc 100644--- a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy+++ b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy@@ -32,10 +32,12 @@ import javax.ws.rs.ForbiddenExceptionimport static org.openremote.container.security.IdentityProvider.SETUP_ADMIN_PASSWORDimport static org.openremote.container.security.IdentityProvider.SETUP_ADMIN_PASSWORD_DEFAULT+import static org.openremote.manager.security.ManagerKeycloakIdentityProvider.KEYCLOAK_DEFAULT_ROLES_PREFIXimport static org.openremote.container.util.MapAccess.getStringimport static org.openremote.model.Constants.KEYCLOAK_CLIENT_IDimport static org.openremote.model.Constants.MASTER_REALMimport static org.openremote.model.Constants.MASTER_REALM_ADMIN_USER+import static org.openremote.model.Constants.RESTRICTED_USER_REALM_ROLEclass UserResourceTest extends Specification implements ManagerContainerTrait {@@ -73,7 +75,7 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {def "Get and update roles"() {- when: "a request is made for the roles in the smart city realm by the admin user"+ when: "a request is made for the roles in the building realm by the admin user"def roles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)then: "the standard client roles should have been returned"@@ -135,4 +137,56 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {writeRole.compositeRoleIds.length == 1writeRole.compositeRoleIds.contains(roles.find {it.name == ClientRole.READ_ASSETS.value}.id)}++ def "Get and update realm roles"() {++ when: "a request is made for the realm roles in the building realm by the admin user"+ def roles = adminUserResource.getRealmRoles(null, keycloakTestSetup.tenantBuilding.realm)++ then: "the standard realm roles should have been returned"+ roles.size() == 4+ def restrictedUser = roles.find {it.name == RESTRICTED_USER_REALM_ROLE}+ restrictedUser != null++ when: "a request is made for the realm roles in the building realm by a regular user"+ regularUserResource.getRealmRoles(null, keycloakTestSetup.tenantBuilding.realm)++ then: "a not allowed exception should be thrown"+ thrown(ForbiddenException.class)++ when: "a new realm role is created by the admin user"+ List<Role> updatedRoles = new ArrayList<>(Arrays.asList(roles))+ updatedRoles.add(new Role(+ null,+ "realmTest",+ false, // Value is ignored on update+ false, // Value is ignored on update+ null+ ).setDescription("This is a realm role"))+ adminUserResource.updateRealmRoles(null, keycloakTestSetup.tenantBuilding.realm, updatedRoles as Role[])+ roles = adminUserResource.getRealmRoles(null, keycloakTestSetup.tenantBuilding.realm)+ def realmRole = roles.find {it.name == "realmTest"}++ then: "the new realm role should have been saved"+ realmRole != null+ realmRole.description == "This is a realm role"+//TODO: finish this test+//+// when: "an existing realm role is updated by the admin user"+// def defaultRole = roles.find {it.name == KEYCLOAK_DEFAULT_ROLES_PREFIX + keycloakTestSetup.tenantBuilding.realm}+// def clientRoles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)+// defaultRole.compositeRoleIds = [+// roles.find {it.name == RESTRICTED_USER_REALM_ROLE}.id,+// clientRoles.find { it.name == ClientRole.READ_ASSETS.value}+// ]+// adminUserResource.updateRoles(null, keycloakTestSetup.tenantBuilding.realm, roles)+// roles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)+// defaultRole = roles.find {it.name == KEYCLOAK_DEFAULT_ROLES_PREFIX + keycloakTestSetup.tenantBuilding.realm}+//+// then: "the write role should have been updated"+// defaultRole != null+// defaultRole.compositeRoleIds.length == 2+// defaultRole.compositeRoleIds.contains(roles.find {it.name == RESTRICTED_USER_REALM_ROLE}.id)+// defaultRole.compositeRoleIds.contains(clientRoles.find {it.name == ClientRole.READ_ASSETS.value}.id)+ }}