JSON Web Tokens (JWT)
Het afsprakenstelsel maakt gebruik van JSON Web Tokens (JWT) voor de communicatie van informatie tussen partijen in de context van een datadienst. JWT (JSON Web Token) is een open standaard die een compacte en op zichzelf staande manier definieert om informatie veilig te verzenden tussen partijen door een JSON-object. In het afsprakenstelsel worden JWTs digitaal getekend (als JWS volgens RFC 7515), waardoor informatie in de JWTs kan worden vertrouwd (zie Ondertekening van JWTs).
Op deze pagina worden de generieke afspraken die gelden voor het gebruik van JWT vastgelegd, deze zijn in lijn met de API strategie voor de Nederlandse Overheid, het iSHARE (v2.0) en het Centre of Excellence for Data Sharing and Cloud (CoE-DSC) Use Case Implementation Guide, waarin deze standaard ook gebruikt wordt.
Het DSGO definieert twee soorten JWTs die voor verschillende doeleindes worden gebruikt. Een Authenticatie JWT om informatie over de identiteit van een partij te communiceren, en een Onweerlegbaarheid JWT die boven op de Authenticatie JWT additionele informatie bevat (zoals beschreven in ETSI TS 119 182-1) om de onweerlegbaarheid van content waar in de JWT naar wordt verwezen te garanderen. De Authenticatie JWT is gelijk aan de iSHARE JWT gedefinieerd in iSHARE (v2.0).
JWT Header
DSGO.Basis
: Partijen MOETEN in Authenticatie JWTs de parameters zoals opgesteld in de onderstaande tabel gebruiken als JWT headers
DSGO.Basis
: Partijen MOETEN in Onweerlegbaarheid JWTs de parameters zoals opgesteld in de onderstaande tabel gebruiken als JWT headers
DSGO.Basis
: Partijen MOGEN in alle JWTs andere parameters NIET als JWT headers gebruiken
JWT headers | Beschrijving | ||
---|---|---|---|
van toepassing voor: | Authenticatie JWT | Onweerlegbaarheid JWT | |
| Vereist | Vereist | Als beschreven in RFC 7515, MOET ingevuld worden als |
| Niet aanwezig | Vereist | Als beschreven in RFC 7797, MOET ingevuld worden als |
| Niet aanwezig | Vereist | Als beschreven in RFC 7515, MOET ingevuld worden als |
| Niet aanwezig | Vereist | Als beschreven in ETSI TS 119 182-1, MOET ingevuld worden volgens de tabel hieronder |
| Vereist | Vereist | Als beschreven in RFC 7515, MOET ingevuld worden als |
| Vereist | Vereist | Als beschreven in RFC 7515, MOET de public key van de QSeal gebruikt voor de ondertekening bevatten |
De sigD
header is toegevoegd in de Onweerlegbaarheid JWT om een handtekening over specifieke HTTP headers en de HTTP body te kunnen zetten om deze te beveiligen.
| Beschrijving | |
---|---|---|
| Als beschreven in ETSI TS 119 182-1, is een URI die het mechanisme voor refereren en verwerken van alle gerefereerde dataobjecten beschrijf, MOET gelijk zijn aan | |
| Als beschreven in ETSI TS 119 182-1, bevat een array van strings als parameters die met dit mechanisme getekend worden, MOET ingevuld worden met de hieronder beschreven velden. | |
HTTP Header fields | Beschrijving | |
| Enkel van toepassing voor HTTP requests | |
| Indien aanwezig | |
| Indien aanwezig | |
| Indien aanwezig | |
| Het tekenen hiervan borgt dat de inhoud van de datadienst wordt gebonden aan de executie van de datadienst. | |
| Indien aanwezig, het tekenen hiervan borgt dat de licentie waaronder de data wordt gegeven wordt vastgelegd. |
Een JWT header ziet er bijvoorbeeld uit zoals hieronder: