Skip to content

Commit

Permalink
chore: TRACEFOSS-XXX Updated roles / rights table
Browse files Browse the repository at this point in the history
  • Loading branch information
ds-mwesener committed Sep 26, 2023
1 parent 40270d2 commit 4ddb473
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Toggle for parts and other parts to switch views asPlanned/asBuilt
- LocalStorage to be used for saving view setting
- archunit tests as preparation for good quality architecture checks
- safety and security doc including roles matrix

### Changed
- added sorting for /api/investigations received and created endpoints
Expand Down
61 changes: 61 additions & 0 deletions docs/src/docs/arc42/cross-cutting/safety-security.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
= Safety and security concepts

== Authentication / Authorization

=== Trace-X API

The Trace-X is secured using OAuth2.0 / Open ID Connect.
Every request to the Trace-X API requires a valid bearer token.
JWT token should also contain two claims:

- 'bpn' which is equal to the configuration value from `API_ALLOWED_BPN` property
- 'resource_access' with the specific key for C-X environments.
The list of values will be converted to roles by Trace-X.
Currently, Trace-X API handles three roles: **'User'** and **'Supervisor'** and **'Admin'.**

The behavior is shown in the table below.

==== Rights and Roles Matrix of Trace-X

|===
| Category | Action | User | Supervisor | Admin
| View | View Dashboard | x | x | x
| | View Parts | x | x | x
| | View Other parts | x | x | x
| | View Quality investigations | x | x | x
| | View Quality alerts | x | x | x
| | View Administration | | | x

| Investigation | Create | x | x |
| | Send | | x |
| | Read | x | x | x
| | Update | x | x |
| | Delete All | | x |
| | Delete Own | (x) | x |

| Alert | Create | x | x |
| | Send | | x |
| | Read | x | x | x
| | Update | x | x |
| | Delete All | | x |
| | Delete Own | (x) | x |

| Administration Panel | Access "BPN EDC config panel" | | | x
| | Access "Registry lookup Panel" | | | x

|===

Legend: x = full access to all resources, (x) = access to the resources he owns

=== Trace-X as EDC client

The Trace-X accesses the Catena-X network via the EDC consumer connector.
This component requires authentication via a Verifiable Credential (VC), which is provided to the EDC via the Managed Identity Wallet.

The VC identifies and authenticates the EDC and is used to acquire access permissions for the data transferred via EDC.

== Credentials

Credentials must never be stored in Git!



0 comments on commit 4ddb473

Please sign in to comment.