Beschrijving
Binnen Koppeltaal krijgt elke applicatie-instantie (een applicatie binnen een domein) een rol toegekend. Deze rol bepaalt welke acties uitgevoerd mogen worden op de FHIR resource service.
Overwegingen
Een domein bevat meerdere applicaties. Lang niet altijd zullen alle applicaties in een domein data van elkaar gebruiken. Vanwege het privacy-by-design principe mogen applicaties geen onnodige informatie opvragen. Dit moet zo min mogelijk impact hebben op de eindgebruikers. Zo is de FHIR resource service bijvoorbeeld verantwoordelijk voor het filteren van informatie op een “GET all”-request.
Helaas is er binnen FHIR geen gestandaardiseerde manier om dit op te lossen. Het staat dienstverleners vrij om een gepast autorisatiemodel toe te passen. Als oplossing hiervoor is een Role Based Access Control (verder: RBAC) autorisatiemodel ontwikkeld. Deze oplossing moet goed passen op de brede set aan functionaliteiten die de FHIR http en search specificaties bieden.
Toepassing en restricties
Autorisatiemodel
Kernpunten
Als oplossing is een RBAC autorisatiemodel tot stand gekomen middels deze vier uitgangspunten:
- Registreren: Bij het toetreden van een domein wordt voor elke applicatie-instantie een
Device
resource aangemaakt. - Authenticeren: Alle communicatie met de FHIR resource service vereist een
access_token
. Dit token bevat (indirect) informatie over welkeDevice
dit request uitvoert. - Eigenaarschap: Alle resources die aangemaakt worden op de FHIR resource service, krijgen automatisch een
resource-origin
extensie. Deze extensie refereert naar de gekoppeldeDevice
resource van de geauthenticeerde applicatie-instantie. - Autoriseren: Alle CRUD-acties die plaatsvinden op een resource, worden - aan de hand van de
resource-origin
extensie en de rol van de geauthenticeerde applicatie-instantie - geautoriseerd.
Rollen en permissies
Het autorisatiemodel is een op RBAC-gebaseerd model. Een applicatie-instantie krijgt maximaal één rol toegekend vanuit het domeinbeheer stelselcomponent. Deze rol is gekoppeld aan een set van permissies. Elke permissie bevat de volgende informatie:
Resource: Een permissie is altijd gekoppeld aan een enkele FHIR Domain Resource.
Actie: Is van toepassing op een Create (C), Read (R), Update (U) of Delete (D) actie.
Scope: Heeft één van de volgende scopes:
Scope Beschrijving OWN De permissie is enkel van toepassing op resources waarvan de resource-origin
overeenkomt met de geauthenticeerde applicatie.GRANTED De permissie is van toepassing op resources waarvan de resource-origin
overeenkomt met één van de geselecteerde applicatie(s).ALL De permissie is van toepassing op alle resources in het domein.
Registreren van Devices
Wanneer een applicatie een domein toetreedt, krijgt deze applicatie-instantie een client_id
toegekend. Het domeinbeheer stelselcomponent heeft de verantwoordelijkheid om een Device
resource aan te maken op de FHIR resource service. Deze Device
MOET de volgende identifier
bevatten:
{
"system": "<https://koppeltaal.nl/client_id>",
"value": "<CLIENT_ID>"
}
Mappen van access_token
naar Device
Wanneer een access_token
opgehaald wordt door een applicatie-instantie, MOET deze altijd het azp
veld bevatten. Dit veld wordt door de autorisatieserver gevuld met de client_id
van de applicatie die de access_token
opvraagt. Aangezien elke Device
resource een https://koppeltaal.nl/client_id
identifier moet hebben, kan de mapping plaatsvinden.
Rollen en permissies van Domeinbeheer naar authorizatie server
Het domeinbeheer stelselcomponent beheert de rollen en bijbehorende permissies. Deze permissies kunnen op twee manieren doorgegeven worden:
- Domeinbeheer biedt de mapping aan middels een API call.
- Domeinbeheer schrijft de records weg in een gedeelde cache/database met de auth server.
Deze laatste oplossing heeft de voorkeur aangezien deze over het algemeen beter te beveiligen is.
Permissies zetten op access_token.scope
Bij het uitgeven van een access_token
MOET de autorisatieserver de gekoppelde permissies omzetten naar het scope
veld. Raadpleeg [TODO: LINK TOEVOEGEN] voor de exacte uitwerking hiervan.
Toekennen resource-origin
aan resources
De FHIR resource service MOET voor elke Resource
die aangemaakt worden de resource-origin
extensie toevoegen. Op deze manier is per Resource
altijd te achterhalen wat het bronsysteem is van deze Resource
. Koppeltaal maakt expliciet gebruik van deze extensie aangezien er een Reference
naar een Device
dient te zijn. FHIR zelf heeft het Resource.meta.source
veld. Echter is deze van het type URI, en daarom te ambigu voor dit doeleinde.
De applicatie-instantie mag de resource-origin
extensie NIET zelf zetten op een POST
. De resource-origin
MAG wel meegegeven worden aan een PUT
. In dit geval MOET de FHIR resource server valideren dat deze ongewijzigd is. Indien de resource-origin
extensie NIET gezet is in een PUT
, MOET de FHIR resource service deze zetten.
Autoriseren
De FHIR resource service autoriseert elke binnenkomende CRUD request. Elke request MOET middels de volgende logica geautoriseerd worden:
- Zoek een permissie op in de
access_token.scope
bij de geauthoriseerde applicatie-instantie aan de hand van CRUD-actie enResource
type. Bijvoorbeeld voor eenUPDATE
op eenActivityDefinition
wordt gezocht naar de volgende reguliere expressie:(\*|(?:\d+|,*)+)\/ActivityDefinition\.(?:update|\*)
- Indien niet aanwezig: FHIR resource service respond met een
403 Forbidden
. - Indien ‘actie
CREATE
' OF ‘scopeALL
': Applicatie is geautoriseerd. Ga verder met aanmakenResource
. - Controleer de scope (let op dat de
access_token.scope
enkel de logical id van deDevice
bevat):OWN
: Verifieer dat deresource-origin
waarde van deResource
overeenkomt met deDevice
van de geauthenticeerde applicatie-instantie. Indien dit niet het geval is: respond met een403 Forbidden
.GRANTED
: Verifieer dat deresource-origin
waarde van deResource
voorkomt in de lijst van geselecteerdeDevices
op de permissie. Indien dit niet het geval is: respond met een403 Forbidden
.
Search Narrowing
Wanneer alle resources opgehaald worden voor een specifiek type, bijv. GET /Patient
, mogen enkel de resources teruggegeven worden waar de applicatie-instantie leesrechten op heeft. Dit wordt door de FHIR resource service opgelost met een interceptor
. De oplossing dient de huidige query-parameters te filteren en uit te breiden in het geval dat de permissie scope niet ALL
is.
De volgende flow wordt gehanteerd:
Subscription Narrowing
Het toevoegen van search narrowing kan als gevolg hebben dat de FHIR resource service een Subscription
afvuurt terwijl een applicatie-instantie daar geen toegang toe heeft. Bij het aanmaken van Subscriptions
dient dezelfde logica toegepast te worden als bij search narrowing, alleen dan op de Subscription.criteria
.
Eisen
Eis | Auth server | Domeinbeheer | Applicatie-instantie | FHIR Resource service |
---|---|---|---|---|
Elk access_token MOET een azp veld hebben waar de client_id van de applicatie-instantie in staat. | X | |||
De permissies gekoppeld aan de rol van een applicatie-instantie MOETEN meegegeven worden als scope waarde van de access_token. | X | |||
Er MOET een Device resource aangemaakt worden voor elke applicatie-instantie op het moment dat een domein wordt toegetreden. | X | |||
De client_id MOET uniek zijn over alle Devices. | X | |||
De aangemaakte Device MOET een identifier bevatten die refereert naar de toegekende client_id van de applicatie-instantie. Deze identifier MOET als system de volgende system hebben: https://koppeltaal.nl/client_id. | X | |||
Een applicatie-instantie MOET één rol bevatten. | X | |||
Rollen en permissies MOETEN beschikbaar gesteld worden op het niveau van applicatie-instanties. | X | |||
Een Create permissie MOET altijd de scope OWN zijn | X | |||
Elke CRUD request MOET een access_token bevatten. | X | |||
Er mag GEEN POST [base] (batch/transactie) uitgevoerd worden met Bundles. | X | X | ||
Er mag GEEN gebruik gemaakt worden van de _include , _revinclude, _contained of _containedType search parameters. | X | X | ||
De autorisatie-flow MOET uitgevoerd worden voor elke CRUD request | X | |||
De resource-origin extensie MOET toegevoegd worden bij het aanmaken van een Resource. | X | |||
De resource-origin extensie MOET gezet worden bij een PUT indien deze niet aangeleverd wordt. | X | |||
De resource-origin MAG meegegeven worden met een PUT, maar mag NIET veranderd zijn. | X | |||
Er MOET search narrowing toegepast worden. | X | |||
Er MOET subscription narrowing toegepast worden. | X |