basyx.submodelrepository-feature-authorization

Submodel Repository - Authorization

This feature enables authorized access to the Submodel Repository.

To enable this feature, the following properties should be configured:

basyx.feature.authorization.enabled = true
basyx.feature.authorization.type = <The type of authorization to enable>
basyx.feature.authorization.jwtBearerTokenProvider = <The Jwt token provider>
basyx.feature.authorization.rbac.file = <Class path of the Rbac rules file if authorization type is rbac>
spring.security.oauth2.resourceserver.jwt.issuer-uri= <URI of the resource server>

Note: Only Role Based Access Control (RBAC) is supported as authorization type as of now, also Keycloak is the only Jwt token provider supported now and it is also a default provider.

To know more about the RBAC, please refer Authorization Services Guide To know more about the Keycloak server administration, please refer Server Administration Guide

An example valid configuration:

basyx.feature.authorization.enabled = true
basyx.feature.authorization.type = rbac
basyx.feature.authorization.jwtBearerTokenProvider = keycloak
basyx.feature.authorization.rbac.file = classpath:rbac_rules.json
spring.security.oauth2.resourceserver.jwt.issuer-uri= http://localhost:9096/realms/BaSyx

RBAC rule configuration

For configuring RBAC rules, all the rbac rules should be configured inside a json file, the rules are defined as below:

[
  {
    "role": "basyx-reader",
    "action": "READ",
    "targetInformation": {
      "@type": "submodel",
      "submodelIds": "*",
      "submodelElementIdShortPaths": "*"
    }
  },
  {
    "role": "admin",
    "action": ["CREATE", "READ", "UPDATE", "DELETE", "EXECUTE"],
    "targetInformation": {
      "@type": "submodel",
      "submodelIds": "*",
      "submodelElementIdShortPaths": "*"
    }
  },
  {
    "role": "basyx-reader-two",
    "action": "READ",
    "targetInformation": {
      "@type": "submodel",
      "submodelIds": "specificSubmodelId",
      "submodelElementIdShortPaths": "*"
    }
  },
  {
    "role": "basyx-sme-reader",
    "action": "READ",
    "targetInformation": {
      "@type": "submodel",
      "submodelIds": ["specificSubmodelId", "testSMId1", "testSMId2"],
      "submodelElementIdShortPaths": ["testSMEIdShortPath1","smc2.specificSubmodelElementIdShort","testSMEIdShortPath2"]
    }
  }
 ]

The role defines which role is allowed to perform the defined actions. The role is as per the configuration of identity providers or based on the organization. Action could be CREATE, READ, UPDATE, DELETE, and EXECUTE, there could be a single action or multiple actions as a list (cf. admin configuration above).

The targetInformation defines coarse-grained control over the resource, you may define the submodelIds and submodelElementIdShortPaths with a wildcard (*), it means the defined role x with action y can access any Submodel and any SubmodelElement on the repository. You can also define a specific Submodel Identifier in place of the wildcard (*), then the role x with action y could be performed only on that particular Submodel. Similarly, you can define a specific SubmodelElement IdShort path, then you can only access the SubmodelElement corresponding to that IdShort path. It means that the whole Submodel GET request would not be possible if the IdShort path for a specific SubmodelElement is provided, because the requestor only has access for a specific SubmodelElement. There could be a single submodelId/submodelElementIdShortPath or multiple submodelIds/submodelElementIdShortPaths as a list (cf. basyx-sme-reader).

Note:

• The Action are fixed as of now and limited to (CREATE, READ, UPDATE, DELETE and EXECUTE) but later user configurable mapping of these actions would be provided.
• Each rule should be unique in combination of role + action + target information

Action table for RBAC

Below is a reference table that shows which actions are used in what endpoints of the Submodel Repository:

Action	Endpoint
READ	GET /submodels GET /submodels/{submodelIdentifier} GET /submodels/{submodelIdentifier}/$value GET /submodels/{submodelIdentifier}/$metadata GET /submodels/{submodelIdentifier}/submodel-elements GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath} GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
CREATE	POST /submodels
UPDATE	PUT /submodels/{submodelIdentifier} PUT /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath} POST /submodels/{submodelIdentifier}/submodel-elements PATCH /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value PATCH /submodels/{submodelIdentifier}/$value DELETE /submodels/{submodelIdentifier}/submodel-elements/{idShortPath} DELETE /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
DELETE	DELETE /submodels/{submodelIdentifier}
EXECUTE	POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke

Note: The invoke operation is not supported currently for off-the-shelf component