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
Only allow super users to modify and/or create groovy rules (#725)
Rich Turner34b091bb7a0b
diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesResourceImpl.java b/manager/src/main/java/org/openremote/manager/rules/RulesResourceImpl.javaindex 3c500109c..a4a404e6f 100644--- a/manager/src/main/java/org/openremote/manager/rules/RulesResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/rules/RulesResourceImpl.java@@ -35,6 +35,7 @@ import org.openremote.model.security.ClientRole;import org.openremote.model.security.Realm;import javax.ws.rs.BeanParam;+import javax.ws.rs.ForbiddenException;import javax.ws.rs.WebApplicationException;import javax.ws.rs.core.Response;import java.util.List;@@ -255,6 +256,12 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourLOG.info("Forbidden access for user '" + getUsername() + "': " + realm);throw new WebApplicationException(Response.Status.FORBIDDEN);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }ruleset = rulesetStorageService.merge(ruleset);return ruleset.getId();}@@ -296,6 +303,12 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourif (!existingRuleset.getRealm().equals(ruleset.getRealm())) {throw new WebApplicationException("Requested realm and existing ruleset realm must match", BAD_REQUEST);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }rulesetStorageService.merge(ruleset);}@@ -312,6 +325,13 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourif (!isRealmActiveAndAccessible(realm) || isRestrictedUser()) {throw new WebApplicationException(Response.Status.FORBIDDEN);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }+rulesetStorageService.delete(RealmRuleset.class, id);}@@ -333,6 +353,13 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourif (isRestrictedUser() && !assetStorageService.isUserAsset(getUserId(), asset.getId())) {throw new WebApplicationException(Response.Status.FORBIDDEN);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }+ruleset = rulesetStorageService.merge(ruleset);return ruleset.getId();}@@ -379,6 +406,12 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourthrow new WebApplicationException("Can't update asset ID, delete and create the ruleset to reassign",BAD_REQUEST);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }rulesetStorageService.merge(ruleset);}@@ -398,6 +431,13 @@ public class RulesResourceImpl extends ManagerWebResource implements RulesResourif (isRestrictedUser() && !assetStorageService.isUserAsset(getUserId(), asset.getId())) {throw new WebApplicationException(Response.Status.FORBIDDEN);}++ // Only super users can create/modify groovy rules+ // TODO: Implement robust groovy sandbox+ if (ruleset.getLang() == Ruleset.Lang.GROOVY && !isSuperUser()) {+ throw new ForbiddenException("Only super users can create/modify groovy rules for security reasons");+ }+rulesetStorageService.delete(AssetRuleset.class, id);}diff --git a/profile/dev-ui.yml b/profile/dev-ui.ymlindex 4f4a475b0..9d5214d7b 100644--- a/profile/dev-ui.yml+++ b/profile/dev-ui.yml@@ -43,6 +43,7 @@ services:extends:file: deploy.ymlservice: manager+ image: openremote/manager:${MANAGER_VERSION:-develop}depends_on:postgresql:condition: service_healthydiff --git a/test/src/test/groovy/org/openremote/test/rules/BasicRulesetResourceTest.groovy b/test/src/test/groovy/org/openremote/test/rules/BasicRulesetResourceTest.groovyindex 8d131f9f1..5a859e1a0 100644--- a/test/src/test/groovy/org/openremote/test/rules/BasicRulesetResourceTest.groovy+++ b/test/src/test/groovy/org/openremote/test/rules/BasicRulesetResourceTest.groovy@@ -11,7 +11,6 @@ import org.openremote.model.value.MetaItemTypeimport org.openremote.test.ManagerContainerTraitimport spock.lang.Specificationimport spock.util.concurrent.PollingConditions-import javax.ws.rs.WebApplicationExceptionimport static org.openremote.container.util.MapAccess.getString@@ -19,6 +18,8 @@ import static org.openremote.manager.security.ManagerIdentityProvider.OR_ADMIN_Pimport static org.openremote.manager.security.ManagerIdentityProvider.OR_ADMIN_PASSWORD_DEFAULTimport static org.openremote.model.Constants.*import static org.openremote.model.rules.Ruleset.Lang.GROOVY+import static org.openremote.model.rules.Ruleset.Lang.JAVASCRIPT+import static org.openremote.model.rules.Ruleset.Lang.JSONimport static org.openremote.model.rules.Ruleset.SHOW_ON_LISTclass BasicRulesetResourceTest extends Specification implements ManagerContainerTrait {@@ -459,7 +460,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerex.response.status == 403when: "a realm ruleset is created in the authenticated realm"- def realmRuleset = new RealmRuleset(MASTER_REALM, "Test realm definition", GROOVY, "SomeRulesCode")+ def realmRuleset = new RealmRuleset(MASTER_REALM, "Test realm definition", Ruleset.Lang.JSON, "SomeRulesCode")rulesetResource.createRealmRuleset(null, realmRuleset)def rulesetId = rulesetResource.getRealmRulesets(null, MASTER_REALM, null, false)[1].idrealmRuleset = rulesetResource.getRealmRuleset(null, rulesetId)@@ -541,8 +542,16 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerassert deployment == null}+ when: "a groovy realm ruleset is created"+ realmRuleset = new RealmRuleset(MASTER_REALM, "Test realm definition", GROOVY, "SomeRulesCode")+ rulesetResource.createRealmRuleset(null, realmRuleset)++ then: "access should be forbidden"+ ex = thrown()+ ex.response.status == 403+when: "a realm ruleset is created in a non-authenticated realm"- realmRuleset = new RealmRuleset(keycloakTestSetup.realmBuilding.name, "Test realm definition", GROOVY, "SomeRulesCode")+ realmRuleset = new RealmRuleset(keycloakTestSetup.realmBuilding.name, "Test realm definition", JAVASCRIPT, "SomeRulesCode")rulesetResource.createRealmRuleset(null, realmRuleset)then: "access should be forbidden"@@ -550,7 +559,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerex.response.status == 403when: "an asset ruleset is created in the authenticated realm"- def assetRuleset = new AssetRuleset(managerTestSetup.smartOfficeId, "Test asset definition", GROOVY, "SomeRulesCode")+ def assetRuleset = new AssetRuleset(managerTestSetup.smartOfficeId, "Test asset definition", JAVASCRIPT, "SomeRulesCode")rulesetResource.createAssetRuleset(null, assetRuleset)rulesetId = rulesetResource.getAssetRulesets(null, managerTestSetup.smartOfficeId, null, false)[0].idassetRuleset = rulesetResource.getAssetRuleset(null, rulesetId)@@ -632,7 +641,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainer}when: "an asset ruleset is created in a non-authenticated realm"- assetRuleset = new AssetRuleset(managerTestSetup.apartment2Id, "Test asset definition", GROOVY, "SomeRulesCode")+ assetRuleset = new AssetRuleset(managerTestSetup.apartment2Id, "Test asset definition", JSON, "SomeRulesCode")rulesetResource.createAssetRuleset(null, assetRuleset)then: "access should be forbidden"@@ -906,7 +915,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerex.response.status == 404when: "a realm ruleset is created in a non-authenticated realm"- realmRuleset = new RealmRuleset(keycloakTestSetup.realmCity.name, "Test realm definition", GROOVY, "SomeRulesCode")+ realmRuleset = new RealmRuleset(keycloakTestSetup.realmCity.name, "Test realm definition", JAVASCRIPT, "SomeRulesCode")rulesetResource.createRealmRuleset(null, realmRuleset)then: "access should be forbidden"@@ -917,7 +926,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerdef assetRuleset = new AssetRuleset(managerTestSetup.apartment1Id,"Test asset definition",- GROOVY, "SomeRulesCode")+ JAVASCRIPT, "SomeRulesCode")assetRuleset.getMeta().add(new MetaItem<>(MetaItemType.SHOW_ON_DASHBOARD, true))rulesetResource.createAssetRuleset(null, assetRuleset)def rulesetId = rulesetResource.getAssetRulesets(null, managerTestSetup.apartment1Id, null, false)[1].id@@ -1009,7 +1018,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainer}when: "an asset ruleset is created in the authenticated realm but on a forbidden asset"- assetRuleset = new AssetRuleset(managerTestSetup.apartment3Id, "Test asset definition", GROOVY, "SomeRulesCode")+ assetRuleset = new AssetRuleset(managerTestSetup.apartment3Id, "Test asset definition", JAVASCRIPT, "SomeRulesCode")rulesetResource.createAssetRuleset(null, assetRuleset)then: "access should be forbidden"@@ -1017,7 +1026,7 @@ class BasicRulesetResourceTest extends Specification implements ManagerContainerex.response.status == 403when: "an asset ruleset is created in a non-authenticated realm"- assetRuleset = new AssetRuleset(managerTestSetup.smartOfficeId, "Test asset definition", GROOVY, "SomeRulesCode")+ assetRuleset = new AssetRuleset(managerTestSetup.smartOfficeId, "Test asset definition", JAVASCRIPT, "SomeRulesCode")rulesetResource.createAssetRuleset(null, assetRuleset)then: "access should be forbidden"