Skip to content

armgit / core

Public Imported from GitHub
0

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

Added READ_USERS role to allow regular users to read limited user information

Rich Turner7ddbe3b12747
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 954d4c39b..8263e4037 100644
--- a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java
+++ b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java
@@ -22,6 +22,7 @@ package org.openremote.manager.security;
import org.openremote.container.timer.TimerService;
import org.openremote.manager.i18n.I18NService;
import org.openremote.manager.web.ManagerWebResource;
+import org.openremote.model.Constants;
import org.openremote.model.http.ConstraintViolation;
import org.openremote.model.http.ConstraintViolationReport;
import org.openremote.model.http.RequestParams;
@@ -46,10 +47,30 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource
@Override
public User[] getAll(RequestParams requestParams, String realm) {
+ boolean isAdmin = getAuthContext().hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);
+ boolean isBasicRead = getAuthContext().hasResourceRole(ClientRole.READ_USERS.getValue(), Constants.KEYCLOAK_CLIENT_ID);
+
+ if (!isAdmin && !isBasicRead) {
+ throw new ForbiddenException("Insufficient permissions to read users");
+ }
+
try {
- return identityService.getIdentityProvider().getUsers(
+ User[] users = identityService.getIdentityProvider().getUsers(
realm
);
+
+ if (isAdmin) {
+ return users;
+ } else {
+ return Arrays.stream(users)
+ .map(user ->
+ new User()
+ .setUsername(user.getUsername())
+ .setId(user.getId())
+ .setFirstName(user.getFirstName())
+ .setLastName(user.getLastName()))
+ .toArray(User[]::new);
+ }
} catch (ClientErrorException ex) {
throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());
} catch (Exception 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 89c665aa6..d4a105fc6 100644
--- a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java
+++ b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java
@@ -38,6 +38,7 @@ public abstract class AbstractKeycloakSetup implements Setup {
ClientRole.WRITE_USER,
ClientRole.READ_MAP,
ClientRole.READ_ASSETS,
+ ClientRole.READ_USERS,
ClientRole.READ_RULES,
ClientRole.WRITE_ASSETS,
ClientRole.WRITE_RULES
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.java
index bcceb70ca..1ccb786d7 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
@@ -84,7 +84,7 @@ public class KeycloakDemoSetup extends AbstractKeycloakSetup {
this.testuser3Id = testuser3.getId();
User buildingUser = createUser(tenantBuilding.getRealm(), "building", "building", "Building", "User", "[email protected]", true, REGULAR_USER_ROLES);
this.buildingUserId = buildingUser.getId();
- User smartCityUser = createUser(tenantCity.getRealm(), "smartcity", "smartycity", "Smart", "City", null, true, REGULAR_USER_ROLES);
+ User smartCityUser = createUser(tenantCity.getRealm(), "smartcity", "smartcity", "Smart", "City", null, true, REGULAR_USER_ROLES);
this.smartCityUserId = smartCityUser.getId();
/*
diff --git a/model/src/main/java/org/openremote/model/Constants.java b/model/src/main/java/org/openremote/model/Constants.java
index 8624e1f61..88e808d0d 100644
--- a/model/src/main/java/org/openremote/model/Constants.java
+++ b/model/src/main/java/org/openremote/model/Constants.java
@@ -26,6 +26,7 @@ public interface Constants {
String MASTER_REALM_ADMIN_USER = "admin";
String REALM_ADMIN_ROLE = "admin";
String READ_LOGS_ROLE = "read:logs";
+ String READ_USERS_ROLE = "read:users";
String READ_ADMIN_ROLE = "read:admin";
String READ_MAP_ROLE = "read:map";
String READ_ASSETS_ROLE = "read:assets";
diff --git a/model/src/main/java/org/openremote/model/security/ClientRole.java b/model/src/main/java/org/openremote/model/security/ClientRole.java
index c2223bdd1..c989f82a5 100644
--- a/model/src/main/java/org/openremote/model/security/ClientRole.java
+++ b/model/src/main/java/org/openremote/model/security/ClientRole.java
@@ -35,6 +35,7 @@ public enum ClientRole {
READ_ADMIN(Constants.READ_ADMIN_ROLE, "Read system settings, tenants, and users"),
READ_LOGS(Constants.READ_LOGS_ROLE, "Read logs and log settings"),
+ READ_USERS(Constants.READ_USERS_ROLE, "Read limited set of user details for use in rules etc."),
READ_MAP(Constants.READ_MAP_ROLE, "View map"),
READ_ASSETS(Constants.READ_ASSETS_ROLE, "Read asset data"),
READ_RULES(Constants.READ_RULES_ROLE, "Read rulesets"),
@@ -49,6 +50,7 @@ public enum ClientRole {
READ("read", "Read all data", new ClientRole[]{
READ_ADMIN,
READ_LOGS,
+ READ_USERS,
READ_MAP,
READ_ASSETS,
READ_RULES,
diff --git a/model/src/main/java/org/openremote/model/security/User.java b/model/src/main/java/org/openremote/model/security/User.java
index c2dc28ada..9fad65bc2 100644
--- a/model/src/main/java/org/openremote/model/security/User.java
+++ b/model/src/main/java/org/openremote/model/security/User.java
@@ -68,24 +68,27 @@ public class User {
return realm;
}
- public void setRealm(String realm) {
+ public User setRealm(String realm) {
this.realm = realm;
+ return this;
}
public String getRealmId() {
return realmId;
}
- public void setRealmId(String realmId) {
+ public User setRealmId(String realmId) {
this.realmId = realmId;
+ return this;
}
public String getId() {
return id;
}
- public void setId(String id) {
+ public User setId(String id) {
this.id = id;
+ return this;
}
@NotNull(message = "{User.username.NotNull}")
@@ -95,8 +98,9 @@ public class User {
return username;
}
- public void setUsername(String username) {
+ public User setUsername(String username) {
this.username = username;
+ return this;
}
@Size(min = 0, max = 127, message = "{User.firstName.Size}")
@@ -104,8 +108,9 @@ public class User {
return firstName;
}
- public void setFirstName(String firstName) {
+ public User setFirstName(String firstName) {
this.firstName = firstName;
+ return this;
}
@Size(min = 0, max = 127, message = "{User.lastName.Size}")
@@ -113,8 +118,9 @@ public class User {
return lastName;
}
- public void setLastName(String lastName) {
+ public User setLastName(String lastName) {
this.lastName = lastName;
+ return this;
}
@Email(message = "{User.email.Email}")
@@ -122,16 +128,18 @@ public class User {
return email;
}
- public void setEmail(String email) {
+ public User setEmail(String email) {
this.email = email;
+ return this;
}
public Boolean getEnabled() {
return enabled;
}
- public void setEnabled(Boolean enabled) {
+ public User setEnabled(Boolean enabled) {
this.enabled = enabled;
+ return this;
}
public String getFullName() {
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 1092bdfd1..ebc3a3cb1 100644
--- a/model/src/main/java/org/openremote/model/security/UserResource.java
+++ b/model/src/main/java/org/openremote/model/security/UserResource.java
@@ -42,7 +42,6 @@ public interface UserResource {
@Produces(APPLICATION_JSON)
@Path("{realm}")
@SuccessStatusCode(200)
- @RolesAllowed(Constants.READ_ADMIN_ROLE)
@SuppressWarnings("unusable-by-js")
User[] getAll(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);