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 support for reading and updating client roles
Rich Turneree673eaad950
diff --git a/client/src/main/java/org/openremote/app/client/admin/users/edit/AdminUserEditActivity.java b/client/src/main/java/org/openremote/app/client/admin/users/edit/AdminUserEditActivity.javaindex 1fee28e16..f3fa8eeb9 100644--- a/client/src/main/java/org/openremote/app/client/admin/users/edit/AdminUserEditActivity.java+++ b/client/src/main/java/org/openremote/app/client/admin/users/edit/AdminUserEditActivity.java@@ -259,7 +259,7 @@ public class AdminUserEditActivityprotected void updateRoles(Runnable onComplete) {environment.getApp().getRequests().sendWith(roleArrayMapper,- requestParams -> userResource.updateRoles(requestParams, realm, userId, roles),+ requestParams -> userResource.updateUserRoles(requestParams, realm, userId, roles),204,onComplete);@@ -313,7 +313,7 @@ public class AdminUserEditActivityprotected void loadRoles(Runnable onComplete) {environment.getApp().getRequests().sendAndReturn(roleArrayMapper,- requestParams -> userResource.getRoles(requestParams, realm, userId),+ requestParams -> userResource.getUserRoles(requestParams, realm, userId),200,roles -> {List<Role> roleList = new ArrayList<>();diff --git a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java b/manager/src/main/java/org/openremote/manager/event/ClientEventService.javaindex 43854c2d1..eddd7c727 100644--- a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java+++ b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java@@ -353,7 +353,7 @@ public class ClientEventService implements ProtocolClientEventService {User serviceUser = keycloakIdentityProvider.getClientServiceUser(clientCredentials.getRealm(), clientCredentials.getClientId());if (clientCredentials.getRoles() != null && clientCredentials.getRoles().length > 0) {- keycloakIdentityProvider.updateRoles(clientCredentials.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(clientCredentials.getRoles()).map(ClientRole::getValue).toArray(String[]::new));+ keycloakIdentityProvider.updateUserRoles(clientCredentials.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(clientCredentials.getRoles()).map(ClientRole::getValue).toArray(String[]::new));}}diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.javaindex 22c640128..3f0b93a05 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java@@ -164,17 +164,32 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen}@Override- public Role[] getRoles(String realm, String userId) {+ public Role[] getRoles(String realm, String client) {+ if (client != null && !MASTER_REALM.equals(client)) {+ throw new IllegalStateException("This provider only has a single master realm");+ }return ClientRole.ALL_ROLES.stream()- .map(role -> new Role(UUID.randomUUID().toString(), role, false, true))+ .map(role -> new Role(UUID.randomUUID().toString(), role, false, true, null)).toArray(Role[]::new);}@Override- public void updateRoles(String realm, String username, String client, String... roles) {+ public void updateRoles(String realm, String client, Role[] roles) {throw new UnsupportedOperationException("This provider does not support updating roles");}+ @Override+ public Role[] getUserRoles(String realm, String userId) {+ return ClientRole.ALL_ROLES.stream()+ .map(role -> new Role(UUID.randomUUID().toString(), role, false, true, null))+ .toArray(Role[]::new);+ }++ @Override+ public void updateUserRoles(String realm, String username, String client, String... roles) {+ throw new UnsupportedOperationException("This provider does not support updating user 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 fff272e90..2d18a907c 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java@@ -59,9 +59,13 @@ public interface ManagerIdentityProvider extends IdentityProvider {void resetPassword(String realm, String userId, Credential credential);- Role[] getRoles(String realm, String userId);+ Role[] getRoles(String realm, String client);- void updateRoles(String realm, String username, String client, String...roles);+ void updateRoles(String realm, String client, Role[] roles);++ Role[] getUserRoles(String realm, String userId);++ void updateUserRoles(String realm, String username, String client, String...roles);boolean isMasterRealmAdmin(String userId);diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.javaindex e7f1b6dc8..d6a2b6a7e 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java@@ -44,10 +44,14 @@ import org.openremote.model.query.filter.TenantPredicate;import org.openremote.model.security.*;import org.openremote.model.util.TextUtil;+import javax.ws.rs.BadRequestException;+import javax.ws.rs.NotFoundException;import javax.ws.rs.WebApplicationException;import javax.ws.rs.core.Response;import javax.ws.rs.core.UriBuilder;import java.util.*;+import java.util.function.BiConsumer;+import java.util.function.Function;import java.util.logging.Level;import java.util.logging.Logger;import java.util.stream.Collectors;@@ -208,7 +212,139 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im}@Override- public Role[] getRoles(String realm, String userId) {+ public Role[] getRoles(String realm, String client) {++ RealmResource realmResource = getRealms().realm(realm);+ ClientsResource clientsResource = realmResource.clients();+ String clientId;++ if (TextUtil.isNullOrEmpty(client)) {+ clientId = clientsResource.findByClientId(KEYCLOAK_CLIENT_ID).get(0).getId();+ } else {+ ClientRepresentation clientRepresentation = getClient(realm, client);+ if (clientRepresentation == null) {+ throw new NotFoundException("Cannot find specified client: " + client);+ }+ clientId = clientsResource.findByClientId(clientRepresentation.getClientId()).get(0).getId();+ }++ ClientResource clientResource = realmResource.clients().get(clientId);+ List<RoleRepresentation> clientRoles = clientResource.roles().list();+ List<Role> roles = new ArrayList<>();++ for (RoleRepresentation clientRole : clientRoles) {+ String[] composites = clientRole.isComposite() ? realmResource.rolesById().getClientRoleComposites(clientRole.getId(), clientId).stream().map(RoleRepresentation::getId).toArray(String[]::new) : null;+ roles.add(new Role(clientRole.getId(), clientRole.getName(), clientRole.isComposite(), null, composites).setDescription(clientRole.getDescription()));+ }++ return roles.toArray(new Role[0]);+ }++ @Override+ public void updateRoles(String realm, String client, Role[] roles) {++ RealmResource realmResource = getRealms().realm(realm);+ ClientsResource clientsResource = realmResource.clients();+ String clientId;++ if (TextUtil.isNullOrEmpty(client)) {+ clientId = clientsResource.findByClientId(KEYCLOAK_CLIENT_ID).get(0).getId();+ } else {+ ClientRepresentation clientRepresentation = getClient(realm, client);+ if (clientRepresentation == null) {+ throw new NotFoundException("Cannot find specified client: " + client);+ }+ clientId = clientsResource.findByClientId(clientRepresentation.getClientId()).get(0).getId();+ }++ ClientResource clientResource = realmResource.clients().get(clientId);+ List<RoleRepresentation> existingRoles = new ArrayList<>(clientResource.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 = saveRole(realmResource, clientResource, 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 BadRequestException("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().getClientRoleComposites(existingRole.getId(), clientId)).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 BadRequestException("One or more composite roles contain an invalid role ID");+ }++ compositesModified = !Objects.equals(existingComposites, requestedComposites);+ }++ if (rolePropertiesModified) {+ // Merge the role property changes+ saveRole(realmResource, clientResource, 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);+ }+ }+ });+ }++ protected RoleRepresentation saveRole(RealmResource realmResource, ClientResource clientResource, 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) {+ clientResource.roles().create(representation);+ } else {+ realmResource.rolesById().updateRole(representation.getId(), representation);+ }++ return clientResource.roles().get(representation.getName()).toRepresentation();+ }++ @Override+ public Role[] getUserRoles(String realm, String userId) {RealmResource realmResource = getRealms().realm(realm);RoleMappingResource roleMappingResource = realmResource.users().get(userId).roles();ClientsResource clientsResource = realmResource.clients();@@ -232,15 +368,16 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider imroleRepresentation.getId(),roleRepresentation.getName(),roleRepresentation.isComposite(),- isAssigned- ));+ isAssigned,+ null)+ .setDescription(roleRepresentation.getDescription()));}return roles.toArray(new Role[0]);}@Override- public void updateRoles(String realm, String userId, String client, String... roles) {+ public void updateUserRoles(String realm, String userId, String client, String... roles) {RealmResource realmResource = getRealms().realm(realm);UserRepresentation user = realmResource.users().get(userId).toRepresentation();diff --git a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.javaindex 17406b0cf..691cb42c1 100644--- a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java@@ -179,13 +179,21 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}@Override- public Role[] getRoles(@BeanParam RequestParams requestParams, String realm, String userId) {+ public Role[] getCurrentUserRoles(RequestParams requestParams) {+ if (!isAuthenticated()) {+ throw new ForbiddenException("Must be authenticated");+ }+ return getUserRoles(requestParams, getRequestRealm(), getUserId());+ }++ @Override+ public Role[] getUserRoles(@BeanParam 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().getRoles(+ return identityService.getIdentityProvider().getUserRoles(realm, userId);} catch (ClientErrorException ex) {@@ -196,17 +204,9 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}@Override- public Role[] getCurrentUserRoles(RequestParams requestParams) {- if (!isAuthenticated()) {- throw new ForbiddenException("Must be authenticated");- }- return getRoles(requestParams, getRequestRealm(), getUserId());- }-- @Override- public void updateRoles(@BeanParam RequestParams requestParams, String realm, String userId, Role[] roles) {+ public void updateUserRoles(@BeanParam RequestParams requestParams, String realm, String userId, Role[] roles) {try {- identityService.getIdentityProvider().updateRoles(+ identityService.getIdentityProvider().updateUserRoles(realm,userId,KEYCLOAK_CLIENT_ID,@@ -222,6 +222,34 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource}}+ @Override+ public Role[] getRoles(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);+ }+ }++ @Override+ public void updateRoles(RequestParams requestParams, String realm, Role[] roles) {+ try {+ identityService.getIdentityProvider().updateRoles(+ realm,+ KEYCLOAK_CLIENT_ID,+ roles);+ } catch (ClientErrorException ex) {+ ex.printStackTrace(System.out);+ throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());+ } catch (Exception ex) {+ throw new WebApplicationException(ex);+ }+ }+protected ConstraintViolationReport isIllegalMasterAdminUserDeletion(RequestParams requestParams, String realm, String userId) {if (!realm.equals(MASTER_REALM))return null;diff --git a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.javaindex a4b8d9381..26b9f778d 100644--- a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java@@ -96,7 +96,7 @@ public abstract class AbstractKeycloakSetup implements Setup {return null;}if (roles != null && roles.length > 0) {- keycloakProvider.updateRoles(realm, user.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(roles).map(ClientRole::getValue).toArray(String[]::new));+ keycloakProvider.updateUserRoles(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/builtin/KeycloakDemoSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.javaindex 89b16ef67..2bdd1fe41 100644--- a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.java@@ -65,6 +65,6 @@ public class KeycloakDemoSetup extends AbstractKeycloakSetup {// UsersUser smartCityUser = createUser(tenantCity.getRealm(), "smartcity", "smartcity", "Smart", "City", null, true, demoUserRoles);this.smartCityUserId = smartCityUser.getId();- keycloakProvider.updateRoles(tenantCity.getRealm(), smartCityUserId, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(tenantCity.getRealm(), smartCityUserId, "account"); // Remove all roles for account client}}diff --git a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.javaindex afefa908d..97ab346f4 100644--- a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java@@ -58,6 +58,6 @@ public class KeycloakInitSetup extends AbstractKeycloakSetup {keycloakProvider.updateUser(MASTER_REALM, adminUser);// Give admin all roles on application client level- keycloakProvider.updateRoles(MASTER_REALM, adminUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ.getValue(), ClientRole.WRITE.getValue());+ keycloakProvider.updateUserRoles(MASTER_REALM, adminUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ.getValue(), ClientRole.WRITE.getValue());}}diff --git a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakTestSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakTestSetup.javaindex 25a1a24f6..311ee4710 100644--- a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakTestSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakTestSetup.java@@ -82,23 +82,23 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {// UsersUser testuser1 = createUser(MASTER_REALM, "testuser1", "testuser1", "DemoMaster", "DemoLast", null, true, container.isDevMode() ? REGULAR_USER_ROLES : demoUserRoles);this.testuser1Id = testuser1.getId();- keycloakProvider.updateRoles(MASTER_REALM, testuser1Id, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(MASTER_REALM, testuser1Id, "account"); // Remove all roles for account clientUser testuser2 = createUser(tenantBuilding.getRealm(), "testuser2", "testuser2", "DemoA2", "DemoLast", "[email protected]", true, new ClientRole[] {ClientRole.WRITE_USER,ClientRole.READ_MAP,ClientRole.READ_ASSETS});this.testuser2Id = testuser2.getId();- keycloakProvider.updateRoles(tenantBuilding.getRealm(), testuser2Id, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(tenantBuilding.getRealm(), testuser2Id, "account"); // Remove all roles for account clientUser testuser3 = createUser(tenantBuilding.getRealm(), "testuser3", "testuser3", "DemoA3", "DemoLast", "[email protected]", true, container.isDevMode() ? REGULAR_USER_ROLES : demoUserRoles);this.testuser3Id = testuser3.getId();- keycloakProvider.updateRoles(tenantBuilding.getRealm(), testuser3Id, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(tenantBuilding.getRealm(), testuser3Id, "account"); // Remove all roles for account clientUser buildingUser = createUser(tenantBuilding.getRealm(), "building", "building", "Building", "User", "[email protected]", true, demoUserRoles);this.buildingUserId = buildingUser.getId();- keycloakProvider.updateRoles(tenantBuilding.getRealm(), buildingUserId, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(tenantBuilding.getRealm(), buildingUserId, "account"); // Remove all roles for account clientUser smartCityUser = createUser(tenantCity.getRealm(), "smartcity", "smartcity", "Smart", "City", null, true, demoUserRoles);this.smartCityUserId = smartCityUser.getId();- keycloakProvider.updateRoles(tenantCity.getRealm(), smartCityUserId, "account"); // Remove all roles for account client+ keycloakProvider.updateUserRoles(tenantCity.getRealm(), smartCityUserId, "account"); // Remove all roles for account clientif (container.isDevMode()) {/*@@ -117,7 +117,7 @@ public class KeycloakTestSetup extends AbstractKeycloakSetup {// Add asset RW roles to service userUser serviceUser = keycloakProvider.getClientServiceUser(tenantBuilding.getRealm(), mqttClient.getClientId());- keycloakProvider.updateRoles(tenantBuilding.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ_ASSETS.getValue(), ClientRole.WRITE_ASSETS.getValue(), ClientRole.WRITE_ATTRIBUTES.getValue());+ keycloakProvider.updateUserRoles(tenantBuilding.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ_ASSETS.getValue(), ClientRole.WRITE_ASSETS.getValue(), ClientRole.WRITE_ATTRIBUTES.getValue());}}}diff --git a/model/src/main/java/org/openremote/model/security/Role.java b/model/src/main/java/org/openremote/model/security/Role.javaindex 9383bd216..cfd55f59b 100644--- a/model/src/main/java/org/openremote/model/security/Role.java+++ b/model/src/main/java/org/openremote/model/security/Role.java@@ -19,21 +19,31 @@*/package org.openremote.model.security;+import java.util.Arrays;++/**+ * Represents a role; depending on the context then different values will be populated. If getting roles related to a user+ * then the {@link #isAssigned} will indicate whether the role is assigned to the user or not and {@link #isComposite}+ * will indicate if it is a composite role. If getting roles for a client then if {@link #isComposite} then the+ */public class Role {protected String id;protected String name;+ protected String description;protected boolean composite;- protected boolean assigned;+ protected Boolean assigned;+ protected String[] compositeRoleIds;public Role() {}- public Role(String id, String name, boolean composite, boolean assigned) {+ public Role(String id, String name, boolean composite, Boolean assigned, String[] compositeRoleIds) {this.id = id;this.name = name;this.composite = composite;this.assigned = assigned;+ this.compositeRoleIds = compositeRoleIds;}public String getId() {@@ -52,7 +62,20 @@ public class Role {this.name = name;}- public boolean isAssigned() {+ public String getDescription() {+ return description;+ }++ public Role setDescription(String description) {+ this.description = description;+ return this;+ }++ public void setAssigned(Boolean assigned) {+ this.assigned = assigned;+ }++ public Boolean isAssigned() {return assigned;}@@ -68,12 +91,21 @@ public class Role {this.composite = composite;}+ public String[] getCompositeRoleIds() {+ return compositeRoleIds;+ }++ public void setCompositeRoleIds(String[] compositeRoleIds) {+ this.compositeRoleIds = compositeRoleIds;+ }+@Overridepublic String toString() {return getClass().getName() + "{" +"id='" + id + '\'' +", name='" + name + '\'' +", composite=" + composite ++ ", compositeRoleNames=" + Arrays.toString(compositeRoleIds) +", assigned=" + assigned +'}';}diff --git a/model/src/main/java/org/openremote/model/security/UserResource.java b/model/src/main/java/org/openremote/model/security/UserResource.javaindex ebc3a3cb1..ffe401f3b 100644--- a/model/src/main/java/org/openremote/model/security/UserResource.java+++ b/model/src/main/java/org/openremote/model/security/UserResource.java@@ -39,8 +39,24 @@ import static javax.ws.rs.core.MediaType.APPLICATION_JSON;public interface UserResource {@GET+ @Path("{realm}/roles")@Produces(APPLICATION_JSON)- @Path("{realm}")+ @SuccessStatusCode(200)+ @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ @SuppressWarnings("unusable-by-js")+ Role[] getRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);++ @PUT+ @Path("{realm}/roles")+ @Consumes(APPLICATION_JSON)+ @SuccessStatusCode(204)+ @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ @SuppressWarnings("unusable-by-js")+ void updateRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, Role[] roles);++ @GET+ @Produces(APPLICATION_JSON)+ @Path("{realm}/users")@SuccessStatusCode(200)@SuppressWarnings("unusable-by-js")User[] getAll(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);@@ -53,13 +69,14 @@ public interface UserResource {User get(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);@GET+ @Path("user")@Produces(APPLICATION_JSON)@SuccessStatusCode(200)@SuppressWarnings("unusable-by-js")User getCurrent(@BeanParam RequestParams requestParams);@PUT- @Path("{realm}/{userId}")+ @Path("{realm}/users/{userId}")@Consumes(APPLICATION_JSON)@Produces(APPLICATION_JSON)@SuccessStatusCode(204)@@ -68,7 +85,7 @@ public interface UserResource {void update(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, @Valid User user);@POST- @Path("{realm}")+ @Path("{realm}/users")@Consumes(APPLICATION_JSON)@Produces(APPLICATION_JSON)@SuccessStatusCode(204)@@ -77,7 +94,7 @@ public interface UserResource {void create(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @Valid User user);@DELETE- @Path("{realm}/{userId}")+ @Path("{realm}/users/{userId}")@Produces(APPLICATION_JSON)@SuccessStatusCode(204)@RolesAllowed(Constants.WRITE_ADMIN_ROLE)@@ -85,7 +102,7 @@ public interface UserResource {void delete(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);@PUT- @Path("{realm}/{userId}/reset-password")+ @Path("{realm}/reset-password/{userId}")@SuccessStatusCode(204)@Consumes(APPLICATION_JSON)@Produces(APPLICATION_JSON)@@ -94,24 +111,24 @@ public interface UserResource {void resetPassword(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Credential credential);@GET- @Path("{realm}/{userId}/role")+ @Path("{realm}/userRoles/{userId}")@Produces(APPLICATION_JSON)@SuccessStatusCode(200)@SuppressWarnings("unusable-by-js")- Role[] getRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);+ Role[] getUserRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId);@GET- @Path("role")+ @Path("userRoles")@Produces(APPLICATION_JSON)@SuccessStatusCode(200)@SuppressWarnings("unusable-by-js")Role[] getCurrentUserRoles(@BeanParam RequestParams requestParams);@PUT- @Path("{realm}/role/{userId}")+ @Path("{realm}/userRoles/{userId}")@Consumes(APPLICATION_JSON)@SuccessStatusCode(204)@RolesAllowed(Constants.WRITE_ADMIN_ROLE)@SuppressWarnings("unusable-by-js")- void updateRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("userId") String userId, Role[] roles);+ void updateUserRoles(@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.groovynew file mode 100644index 000000000..e1cda1b2c--- /dev/null+++ b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy@@ -0,0 +1,140 @@+/*+ * Copyright 2017, OpenRemote Inc.+ *+ * See the CONTRIBUTORS.txt file in the distribution for a+ * full listing of individual contributors.+ *+ * This program is free software: you can redistribute it and/or modify+ * it under the terms of the GNU Affero General Public License as+ * published by the Free Software Foundation, either version 3 of the+ * License, or (at your option) any later version.+ *+ * This program is distributed in the hope that it will be useful,+ * but WITHOUT ANY WARRANTY; without even the implied warranty of+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ * GNU Affero General Public License for more details.+ *+ * You should have received a copy of the GNU Affero General Public License+ * along with this program. If not, see <http://www.gnu.org/licenses/>.+ */+package org.openremote.test.users++import org.openremote.manager.setup.SetupService+import org.openremote.manager.setup.builtin.KeycloakTestSetup+import org.openremote.model.security.ClientRole+import org.openremote.model.security.Role+import org.openremote.model.security.UserResource+import org.openremote.test.ManagerContainerTrait+import spock.lang.Shared+import spock.lang.Specification++import javax.ws.rs.ForbiddenException+import javax.ws.rs.NotAllowedException+import java.lang.reflect.Array++import static org.openremote.container.security.IdentityProvider.SETUP_ADMIN_PASSWORD+import static org.openremote.container.security.IdentityProvider.SETUP_ADMIN_PASSWORD_DEFAULT+import static org.openremote.container.util.MapAccess.getString+import static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID+import static org.openremote.model.Constants.MASTER_REALM+import static org.openremote.model.Constants.MASTER_REALM_ADMIN_USER++class UserResourceTest extends Specification implements ManagerContainerTrait {++ @Shared+ static UserResource adminUserResource+ @Shared+ static UserResource regularUserResource++ @Shared+ static KeycloakTestSetup keycloakTestSetup++ def setupSpec() {+ def container = startContainer(defaultConfig(), defaultServices())+ keycloakTestSetup = container.getService(SetupService.class).getTaskOfType(KeycloakTestSetup.class)++ def accessToken = authenticate(+ container,+ MASTER_REALM,+ KEYCLOAK_CLIENT_ID,+ MASTER_REALM_ADMIN_USER,+ getString(container.getConfig(), SETUP_ADMIN_PASSWORD, SETUP_ADMIN_PASSWORD_DEFAULT)+ ).token++ def regularAccessToken = authenticate(+ container,+ keycloakTestSetup.tenantBuilding.realm,+ KEYCLOAK_CLIENT_ID,+ "testuser3",+ "testuser3"+ ).token++ adminUserResource = getClientApiTarget(serverUri(serverPort), MASTER_REALM, accessToken).proxy(UserResource.class)+ regularUserResource = getClientApiTarget(serverUri(serverPort), keycloakTestSetup.tenantBuilding.realm, regularAccessToken).proxy(UserResource.class)+ }++ def "Get and update roles"() {++ when: "a request is made for the roles in the smart city realm by the admin user"+ def roles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)++ then: "the standard client roles should have been returned"+ roles.size() == ClientRole.values().length+ def readComposite = roles.find {it.name == ClientRole.READ.value}+ readComposite != null+ readComposite.description == ClientRole.READ.description+ readComposite.compositeRoleIds.length == ClientRole.READ.composites.length+ assert readComposite.compositeRoleIds.every {roleId ->+ String roleName = roles.find {it.id == roleId}.name+ return ClientRole.READ.composites.any {it.value == roleName}+ }++ def readAssets = roles.find{ it.name == ClientRole.READ_ASSETS.value}+ readAssets != null+ readAssets.description == ClientRole.READ_ASSETS.description+ readAssets.compositeRoleIds == null++ when: "a request is made for the roles in the smart building realm by a regular user"+ regularUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)++ then: "a not allowed exception should be thrown"+ thrown(ForbiddenException.class)++ when: "a new composite role is created by the admin user"+ List<Role> updatedRoles = new ArrayList<>(Arrays.asList(roles))+ updatedRoles.add(new Role(+ null,+ "test",+ true, // Value is ignored on update+ false, // Value is ignored on update+ [+ roles.find {it.name == ClientRole.READ_LOGS.value}.id,+ roles.find {it.name == ClientRole.READ_APPS.value}.id+ ] as String[]+ ).setDescription("This is a test"))+ adminUserResource.updateRoles(null, keycloakTestSetup.tenantBuilding.realm, updatedRoles as Role[])+ roles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)+ def testRole = roles.find {it.name == "test"}++ then: "the new composite role should have been saved"+ testRole != null+ testRole.description == "This is a test"+ testRole.compositeRoleIds.length == 2+ testRole.compositeRoleIds.contains(roles.find {it.name == ClientRole.READ_LOGS.value}.id)+ testRole.compositeRoleIds.contains(roles.find {it.name == ClientRole.READ_APPS.value}.id)++ when: "an existing composite role is updated by the admin user"+ def writeRole = roles.find {it.name == ClientRole.WRITE.value}+ writeRole.compositeRoleIds = [+ roles.find {it.name == ClientRole.READ_ASSETS.value}.id+ ]+ adminUserResource.updateRoles(null, keycloakTestSetup.tenantBuilding.realm, roles)+ roles = adminUserResource.getRoles(null, keycloakTestSetup.tenantBuilding.realm)+ writeRole = roles.find {it.name == ClientRole.WRITE.value}++ then: "the write role should have been updated"+ writeRole != null+ writeRole.compositeRoleIds.length == 1+ writeRole.compositeRoleIds.contains(roles.find {it.name == ClientRole.READ_ASSETS.value}.id)+ }+}