com-pas / compas-cim-mapping

Service to Map CIM Data to SCL Data
Apache License 2.0
6 stars 5 forks source link
cim iec-cim iec61850

Maven Build Github Action Status REUSE status Quality Gate Status CII Best Practices Slack

CoMPAS CIM Mapping

Mapping between IEC CIM and IEC 61850

The Mapping between IEC CIM and IEC 61850 is described in Mapping.

Development

Information about how to run and develop for this project check Development.

Environment variables

Below environment variable(s) can be used to configure which claim is used to fill user information, for instance the Who Attribute in the History Record.

Environment variable Java Property Description Example
USERINFO_WHO_CLAIMNAME compas.userinfo.who.claimname The Name of the user used in the Who History. name

Security

To use most of the endpoints the users needs to be authenticated using JWT in the authorization header. There are 4 environment variables that can be set in the container to configure the validation/processing of the JWT.

Environment variable Java Property Description Example
JWT_VERIFY_KEY smallrye.jwt.verify.key.location Location of certificates to verify the JWT. http://localhost:8089/auth/realms/compas/protocol/openid-connect/certs
JWT_VERIFY_ISSUER mp.jwt.verify.issuer The issuer of the JWT. http://localhost:8089/auth/realms/compas
JWT_VERIFY_CLIENT_ID mp.jwt.verify.audiences The Client ID that should be in the "aud" claim. cim-mapping
JWT_GROUPS_PATH smallrye.jwt.path.groups The JSON Path where to find the roles of the user. resource_access/cim-mapping/roles

There are no roles defined in this service, only need to be authenticated.