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
Fixed user read:admin permission to allow reading users and roles (Fixes #650) (#696)
Rich Turner539957fe6ae4
diff --git a/.ci_cd/aws/cloudformation-create-ec2.yml b/.ci_cd/aws/cloudformation-create-ec2.ymlindex 9a8633b7d..1846fcd33 100644--- a/.ci_cd/aws/cloudformation-create-ec2.yml+++ b/.ci_cd/aws/cloudformation-create-ec2.yml@@ -589,7 +589,7 @@ Resources:KeyName:"developers"ImageId:- "ami-032afb7a6d14ab941"+ "ami-0042fede24cb86d5c"SecurityGroups:- "ssh-access"- Ref: StandardSecurityGroupdiff --git a/.ci_cd/deploy.sh b/.ci_cd/deploy.shindex 29d36cbf3..97e3549a0 100644--- a/.ci_cd/deploy.sh+++ b/.ci_cd/deploy.sh@@ -195,7 +195,7 @@ if [ "$ROLLBACK_ON_ERROR" == 'true' ]; thenrm -fr temp_oldmv temp temp_old# Tag existing manager image with previous tag (current tag might not be available in docker hub anymore or it could have been overwritten)- docker tag `docker images openremote/manager -q | head -1` openremote/manager:previous+ docker tag '`docker images openremote/manager -q | head -1`' openremote/manager:previouselseecho "Removing old temp deployment dir"rm -fr tempdiff --git a/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java b/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.javaindex 25813d0ad..c5770eb65 100644--- a/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java@@ -32,12 +32,14 @@ import org.openremote.model.attribute.*;import org.openremote.model.http.RequestParams;import org.openremote.model.query.AssetQuery;import org.openremote.model.query.filter.TenantPredicate;+import org.openremote.model.security.ClientRole;import org.openremote.model.util.TextUtil;import org.openremote.model.util.ValueUtil;import javax.persistence.OptimisticLockException;import javax.validation.ConstraintViolationException;import javax.ws.rs.BadRequestException;+import javax.ws.rs.ForbiddenException;import javax.ws.rs.WebApplicationException;import javax.ws.rs.core.HttpHeaders;import javax.ws.rs.core.MediaType;@@ -100,6 +102,7 @@ public class AssetResourceImpl extends ManagerWebResource implements AssetResourpublic UserAssetLink[] getUserAssetLinks(RequestParams requestParams, String realm, String userId, String assetId) {try {realm = TextUtil.isNullOrEmpty(realm) ? getAuthenticatedRealm() : realm;+ boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);if (realm == null)throw new WebApplicationException(BAD_REQUEST);@@ -107,8 +110,8 @@ public class AssetResourceImpl extends ManagerWebResource implements AssetResourif (!(isSuperUser() || getAuthenticatedRealm().equals(realm)))throw new WebApplicationException(FORBIDDEN);- if (!isSuperUser() && userId != null && !userId.equals(getAuthContext().getUserId())) {- throw new WebApplicationException(FORBIDDEN);+ if (!hasAdminReadRole && userId != null && !Objects.equals(getUserId(), userId)) {+ throw new ForbiddenException("Can only retrieve own asset links unless you have role '" + ClientRole.READ_ADMIN + "'");}if (userId != null && !identityService.getIdentityProvider().isUserInTenant(userId, realm))diff --git a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.javaindex 83da42f9f..8e2ddff9e 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.security.AuthContext;import org.openremote.container.timer.TimerService;import org.openremote.manager.web.ManagerWebResource;+import org.openremote.model.Constants;import org.openremote.model.http.RequestParams;import org.openremote.model.query.UserQuery;import org.openremote.model.query.filter.TenantPredicate;@@ -83,8 +84,10 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource@Overridepublic User get(RequestParams requestParams, String realm, String userId) {- if (!isSuperUser() && !Objects.equals(getUserId(), userId)) {- throw new ForbiddenException("Regular users can only retrieve their own roles");+ boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);++ if (!hasAdminReadRole && !Objects.equals(getUserId(), userId)) {+ throw new ForbiddenException("Can only retrieve own user info unless you have role '" + ClientRole.READ_ADMIN + "'");}try {@@ -189,8 +192,10 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource@Overridepublic Role[] getUserClientRoles(@BeanParam RequestParams requestParams, String realm, String userId, String clientId) {- if (!isSuperUser() && !Objects.equals(getUserId(), userId)) {- throw new ForbiddenException("Regular users can only retrieve their own roles");+ boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);++ if (!hasAdminReadRole && !Objects.equals(getUserId(), userId)) {+ throw new ForbiddenException("Can only retrieve own user roles unless you have role '" + ClientRole.READ_ADMIN + "'");}try {@@ -206,8 +211,10 @@ public class UserResourceImpl extends ManagerWebResource implements UserResource@Overridepublic 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");+ boolean hasAdminReadRole = hasResourceRole(ClientRole.READ_ADMIN.getValue(), Constants.KEYCLOAK_CLIENT_ID);++ if (!hasAdminReadRole && !Objects.equals(getUserId(), userId)) {+ throw new ForbiddenException("Can only retrieve own user roles unless you have role '" + ClientRole.READ_ADMIN + "'");}try {diff --git a/model/src/main/java/org/openremote/model/security/UserResource.java b/model/src/main/java/org/openremote/model/security/UserResource.javaindex 6fc39234e..486ee0b43 100644--- a/model/src/main/java/org/openremote/model/security/UserResource.java+++ b/model/src/main/java/org/openremote/model/security/UserResource.java@@ -44,14 +44,14 @@ public interface UserResource {@Path("{realm}/roles")@Produces(APPLICATION_JSON)@SuppressWarnings("unusable-by-js")- @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ @RolesAllowed(Constants.READ_ADMIN_ROLE)Role[] getRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm);@GET@Path("{realm}/{clientId}/roles")@Produces(APPLICATION_JSON)@SuppressWarnings("unusable-by-js")- @RolesAllowed(Constants.WRITE_ADMIN_ROLE)+ @RolesAllowed(Constants.READ_ADMIN_ROLE)Role[] getClientRoles(@BeanParam RequestParams requestParams, @PathParam("realm") String realm, @PathParam("clientId") String clientId);@PUTdiff --git a/ui/app/manager/src/headers.ts b/ui/app/manager/src/headers.tsindex 45caf5810..b781201f2 100644--- a/ui/app/manager/src/headers.ts+++ b/ui/app/manager/src/headers.ts@@ -95,7 +95,7 @@ export function headerItemUsers<S extends AppStateKeyed, A extends AnyAction>(orvalue: "users",href: "users",text: "user_plural",- roles: ["write:admin"]+ roles: ["read:admin", "write:admin"]};}export function headerItemRoles<S extends AppStateKeyed, A extends AnyAction>(orApp: OrApp<S>): HeaderItem {@@ -104,7 +104,7 @@ export function headerItemRoles<S extends AppStateKeyed, A extends AnyAction>(orvalue: "roles",href: "roles",text: "role_plural",- roles: ["write:admin"]+ roles: ["read:admin", "write:admin"]};}export function headerItemRealms<S extends AppStateKeyed, A extends AnyAction>(orApp: OrApp<S>): HeaderItem {diff --git a/ui/app/manager/src/pages/page-gateway.ts b/ui/app/manager/src/pages/page-gateway.tsindex 4469d4e60..3a73889e8 100644--- a/ui/app/manager/src/pages/page-gateway.ts+++ b/ui/app/manager/src/pages/page-gateway.ts@@ -2,7 +2,7 @@ import {css, html, PropertyValues, TemplateResult, unsafeCSS} from "lit";import {customElement, property, state} from "lit/decorators.js";import i18next from "i18next";import "@openremote/or-components/or-panel";-import {ConnectionStatus, GatewayConnection, GatewayConnectionStatusEvent} from "@openremote/model";+import {ClientRole, ConnectionStatus, GatewayConnection, GatewayConnectionStatusEvent} from "@openremote/model";import manager, {DefaultColor1, OREvent} from "@openremote/core";import {InputType, OrInputChangedEvent} from "@openremote/or-mwc-components/or-mwc-input";import {Page, PageProvider} from "@openremote/or-app";@@ -139,7 +139,7 @@ export class PageGateway extends Page<AppStateKeyed> {connectedCallback() {super.connectedCallback();- this._readonly = !manager.hasRole("write:admin");+ this._readonly = !manager.hasRole(ClientRole.WRITE_ADMIN);this._subscribeEvents();}diff --git a/ui/app/manager/src/pages/page-roles.ts b/ui/app/manager/src/pages/page-roles.tsindex 9bdc31230..adce5b28d 100644--- a/ui/app/manager/src/pages/page-roles.ts+++ b/ui/app/manager/src/pages/page-roles.ts@@ -405,16 +405,18 @@ export class PageRoles extends Page<AppStateKeyed> {})}</div></div>-- <div class="row" style="margin-bottom: 0;">- ${role.id && !readonly ? html`- <or-mwc-input .label="${i18next.t("delete")}" .type="${InputType.BUTTON}" @click="${() => this._deleteRole(role, index)}"></or-mwc-input>- <or-mwc-input ?disabled="${this._compositeRoles.some(role => role.compositeRoleIds.length === 0)}" style="margin-left: auto;" .label="${i18next.t("save")}" .type="${InputType.BUTTON}" @click="${() => this._updateRoles()}"></or-mwc-input>- ` : html`- <or-mwc-input .label="${i18next.t("cancel")}" .type="${InputType.BUTTON}" @click="${() => {this._compositeRoles.splice(-1,1); this._compositeRoles = [...this._compositeRoles]}}"></or-mwc-input>- <or-mwc-input ?disabled="${this._compositeRoles.some(role => role.compositeRoleIds.length === 0)}" style="margin-left: auto;" .label="${i18next.t("create")}" .type="${InputType.BUTTON}" @click="${() => this._updateRoles()}"></or-mwc-input>- `}- </div>++ ${readonly ? html`` : html`+ <div class="row" style="margin-bottom: 0;">+ ${role.id ? html`+ <or-mwc-input .label="${i18next.t("delete")}" .type="${InputType.BUTTON}" @click="${() => this._deleteRole(role, index)}"></or-mwc-input>+ <or-mwc-input ?disabled="${this._compositeRoles.some(role => role.compositeRoleIds.length === 0)}" style="margin-left: auto;" .label="${i18next.t("save")}" .type="${InputType.BUTTON}" @click="${() => this._updateRoles()}"></or-mwc-input>+ ` : html`+ <or-mwc-input .label="${i18next.t("cancel")}" .type="${InputType.BUTTON}" @click="${() => {this._compositeRoles.splice(-1,1); this._compositeRoles = [...this._compositeRoles]}}"></or-mwc-input>+ <or-mwc-input ?disabled="${this._compositeRoles.some(role => role.compositeRoleIds.length === 0)}" style="margin-left: auto;" .label="${i18next.t("create")}" .type="${InputType.BUTTON}" @click="${() => this._updateRoles()}"></or-mwc-input>+ `}+ </div>+ `}</div></td></tr>diff --git a/ui/app/manager/src/pages/page-users.ts b/ui/app/manager/src/pages/page-users.tsindex 71b77a204..b04a2788a 100644--- a/ui/app/manager/src/pages/page-users.ts+++ b/ui/app/manager/src/pages/page-users.ts@@ -12,7 +12,7 @@ import {InputType, OrInputChangedEvent, OrMwcInput} from "@openremote/or-mwc-comimport {OrMwcDialog, showDialog, showOkCancelDialog} from "@openremote/or-mwc-components/or-mwc-dialog";import {showSnackbar} from "@openremote/or-mwc-components/or-mwc-snackbar";import {AxiosError, isAxiosError, GenericAxiosResponse} from "@openremote/rest";-import {OrAssetTreeSelectionEvent} from "@openremote/or-asset-tree";+import {OrAssetTreeRequestSelectionEvent, OrAssetTreeSelectionEvent} from "@openremote/or-asset-tree";const tableStyle = require("@material/data-table/dist/mdc.data-table.css");@@ -428,7 +428,7 @@ export class PageUsers extends Page<AppStateKeyed> {}const compositeRoleOptions: string[] = this._compositeRoles.map(cr => cr.name);- const readonly = !manager.hasRole(ClientRole.WRITE_USER);+ const readonly = !manager.hasRole(ClientRole.WRITE_ADMIN);return html`<div id="wrapper">@@ -588,7 +588,7 @@ export class PageUsers extends Page<AppStateKeyed> {}}- protected _openAssetSelector(ev: MouseEvent, user: UserModel) {+ protected _openAssetSelector(ev: MouseEvent, user: UserModel, readonly: boolean) {const openBtn = ev.target as OrMwcInput;openBtn.disabled = true;user.previousAssetLinks = [...user.userAssetLinks];@@ -612,7 +612,16 @@ export class PageUsers extends Page<AppStateKeyed> {<or-asset-treeid="chart-asset-tree" readonly .selectedIds="${user.userAssetLinks.map(ual => ual.id.assetId)}".showSortBtn="${false}" expandNodes checkboxes- @or-asset-tree-selection="${(e: OrAssetTreeSelectionEvent) => onAssetSelectionChanged(e)}"></or-asset-tree>+ @or-asset-tree-request-selection="${(e: OrAssetTreeRequestSelectionEvent) => {+ if (readonly) {+ e.detail.allow = false;+ }+ }}"+ @or-asset-tree-selection="${(e: OrAssetTreeSelectionEvent) => {+ if (!readonly) {+ onAssetSelectionChanged(e);+ }+ }}"></or-asset-tree>`).setActions([{@@ -840,6 +849,7 @@ export class PageUsers extends Page<AppStateKeyed> {<or-mwc-inputid="${user.id}-restricted".type="${InputType.CHECKBOX}"+ ?readonly="${readonly}".label="${i18next.t("restrictedAccessToAssets") + ':'}"@or-mwc-input-changed="${(ev: OrInputChangedEvent) => this._addRemoveRealmRole(user, RESTRICTED_USER_REALM_ROLE, ev.detail.value as boolean)}".value="${user.realmRoles ? !!user.realmRoles.find(r => r.name === RESTRICTED_USER_REALM_ROLE) : undefined}"></or-mwc-input>@@ -847,7 +857,7 @@ export class PageUsers extends Page<AppStateKeyed> {<or-mwc-input outlined.type="${InputType.BUTTON}".label="${i18next.t("selectRestrictedAssets", {number: user.userAssetLinks.length})}"- @click="${(ev: MouseEvent) => this._openAssetSelector(ev, user)}"></or-mwc-input>+ @click="${(ev: MouseEvent) => this._openAssetSelector(ev, user, readonly)}"></or-mwc-input></div></div></div>diff --git a/ui/component/or-asset-viewer/src/index.ts b/ui/component/or-asset-viewer/src/index.tsindex 10a5a6181..5c7fb7ec9 100644--- a/ui/component/or-asset-viewer/src/index.ts+++ b/ui/component/or-asset-viewer/src/index.ts@@ -29,6 +29,7 @@ import {ClientRole,FileInfo,SharedEvent,+ UserAssetLink,WellknownAssets,WellknownAttributes,WellknownMetaItems,@@ -777,22 +778,37 @@ export function getPanelContent(panelName: string, asset: Asset, attributes: { [if (panelConfig.type === "linkedUsers") {- const createUserTable = (rows: string[][]) => {- const userTable: OrMwcTable = hostElement.shadowRoot!.getElementById(panelName+"-user-table") as OrMwcTable;+ const hasReadAdminRole = manager.hasRole(ClientRole.READ_ADMIN);++ // Hide the panel if user doesn't have permission+ const panelElem = hostElement.shadowRoot!.getElementById('linkedUsers-panel');+ if (panelElem) {+ panelElem.hidden = !hasReadAdminRole;+ }++ if (!hasReadAdminRole) {+ return;+ }++ getLinkedUsers(asset).then((assetLinkInfos) => {+ const panelElem = hostElement.shadowRoot!.getElementById('linkedUsers-panel');+ const userTable: OrMwcTable = hostElement.shadowRoot!.getElementById(panelName + "-user-table") as OrMwcTable;userTable.options = {stickyFirstColumn:false};- userTable.headers = ['Username', 'Roles', 'Restricted user'];- userTable.rows = rows.sort(Util.sortByString(u => u[0]));- };+ userTable.headers = ["Username", "Roles", "Restricted user"];+ userTable.rows = assetLinkInfos.sort(Util.sortByString(u => u.usernameAndId)).map(assetLinkInfo => {+ return [+ assetLinkInfo.usernameAndId,+ assetLinkInfo.roles.join(", "),+ assetLinkInfo.restrictedUser ? i18next.t("yes") : i18next.t("no")+ ];+ });- // Load users and rights, then update the table- getLinkedUsers(asset, hostElement).then((linkedUsers) => {- Promise.all(linkedUsers).then(res => {- if (!res || res.length === 0) {- hostElement.shadowRoot!.getElementById('linkedUsers-panel')!.hidden = true;- return;- }- createUserTable(res);- })+ if (panelElem) {+ panelElem.hidden = assetLinkInfos.length === 0;+ onRenderComplete.startCallbacks().then(() => {+ OrAssetViewer.generateGrid(hostElement.shadowRoot);+ });+ }});return html`<or-mwc-table .id="${panelName}-user-table"></or-mwc-table>`;@@ -924,62 +940,55 @@ async function getAssetChildren(id: string, childAssetType: string): Promise<Assreturn response.data.filter((asset) => asset.type === childAssetType);}-async function getLinkedUsers(asset: Asset, hostElement: LitElement): Promise<Promise<string[]>[]> {- let response: Promise<string[]>[];-- try {- response = await manager.rest.api.AssetResource.getUserAssetLinks(- {realm: manager.displayRealm, assetId: asset.id}- ).then((userAssetLinksRes) => {- const userIds = userAssetLinksRes.data.map(e => e.id!.userId) as string[];- return userIds.map(async (userId) => {+interface UserAssetLinkInfo {+ usernameAndId: string;+ roles: string[];+ restrictedUser: boolean;+}- let row: string[] = [];+async function getLinkedUserInfo(userAssetLink: UserAssetLink): Promise<UserAssetLinkInfo> {+ const userId = userAssetLink.id!.userId!;+ const username = userAssetLink.userFullName!;- await manager.rest.api.UserResource.get(manager.displayRealm, userId!)- .then((usersRes) => {- row.push(usersRes.data.username!);- });+ const roleNames = await manager.rest.api.UserResource.getUserRoles(manager.displayRealm, userId)+ .then((response) => {+ return response.data.filter(role => role.composite).map(r => r.name!);+ })+ .catch((err) => {+ console.info('User not allowed to get roles', err);+ return [];+ });- await manager.rest.api.UserResource.getRoles(manager.displayRealm)- .then((rolesRes) => {- const roles = rolesRes.data.filter(role => !role.composite);- if (!manager.isSuperUser() && !roles.some(r => r.name === 'write:admin') && !roles.some(r => r.name === 'read:admin')) {- hostElement.shadowRoot!.getElementById('linkedUsers-panel')!.hidden = true;- return;- }- const compositeRoles = rolesRes.data.filter(role => role.composite).map(r => r.name);- const roleNames = compositeRoles.join(', ');- row.push(roleNames!);- })- .catch((err) => {- console.info('User not allowed to get roles', err);- hostElement.shadowRoot!.getElementById('linkedUsers-panel')!.hidden = true;- return;- });+ 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;+ });- await manager.rest.api.UserResource.getUserRealmRoles(manager.displayRealm, userId)- .then((rolesRes) => {- const hasRestrictedUser = rolesRes.data ? !!rolesRes.data.find(r => r.assigned && r.name === "restricted_user") : false;+ return {+ usernameAndId: username,+ roles: roleNames,+ restrictedUser: isRestrictedUser+ };+}- let restrictedUser = hasRestrictedUser ? i18next.t('yes') : i18next.t('no');- row.push(restrictedUser);- });+async function getLinkedUsers(asset: Asset): Promise<UserAssetLinkInfo[]> {- return row;+ try {+ return await manager.rest.api.AssetResource.getUserAssetLinks(+ {realm: manager.displayRealm, assetId: asset.id}+ ).then((response) => {+ const userAssetLinks = response.data;+ const infoPromises = userAssetLinks.map(userAssetLink => {+ return getLinkedUserInfo(userAssetLink)});++ return Promise.all(infoPromises);});} catch (e) {console.log("Failed to get child assets: " + e);return [];}-- if (!response) {- return [];- }-- return response;}export async function saveAsset(asset: Asset): Promise<SaveResult> {diff --git a/ui/component/or-attribute-input/src/index.ts b/ui/component/or-attribute-input/src/index.tsindex 955c7843d..3eb2850c8 100644--- a/ui/component/or-attribute-input/src/index.ts+++ b/ui/component/or-attribute-input/src/index.ts@@ -16,7 +16,8 @@ import {ValueDescriptor,WellknownMetaItems,WellknownValueTypes,- AssetModelUtil+ AssetModelUtil,+ ClientRole} from "@openremote/model";import manager, {DefaultColor4, subscribe, Util} from "@openremote/core";import "@openremote/or-mwc-components/or-mwc-input";@@ -718,8 +719,8 @@ export class OrAttributeInput extends subscribe(manager)(translate(i18next)(LitE}public isReadonly(): boolean {- if(!manager.hasRole("write:attributes")) {- this.readonly = !manager.hasRole("write:attributes");+ if(!manager.hasRole(ClientRole.WRITE_ATTRIBUTES)) {+ this.readonly = !manager.hasRole(ClientRole.WRITE_ATTRIBUTES);return this.readonly;}