From 50496799f09ea92af61af70297bc98235f610605 Mon Sep 17 00:00:00 2001 From: Ronald Koster Date: Wed, 13 Dec 2023 09:28:15 +0100 Subject: [PATCH 1/8] verplicht het toepassen van de standaard Federated Service Connectivity --- .idea/.gitignore | 8 ++ ...koppeling-Koppelvlakstandaard-REST-API.iml | 9 +++ .idea/modules.xml | 8 ++ .idea/vcs.xml | 6 ++ ch03_Digikoppeling Restful API profiel.md | 76 ++++++++++++++++--- 5 files changed, 97 insertions(+), 10 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml b/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml new file mode 100644 index 0000000..5e764c4 --- /dev/null +++ b/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..986aadd --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/ch03_Digikoppeling Restful API profiel.md b/ch03_Digikoppeling Restful API profiel.md index eb0a6c2..0502339 100644 --- a/ch03_Digikoppeling Restful API profiel.md +++ b/ch03_Digikoppeling Restful API profiel.md @@ -1,10 +1,11 @@ -# Digikoppeling Restful API profiel +# Digikoppeling REST API profiel ## Inleiding ### Historie -Vanuit het TO Digikoppeling zijn al langere tijd de ontwikkelingen rond Restful API's gevolgd. Binnen het Kennisplatform API zijn de REST-API Design Rules (REST ADR) ontwikkeld en de REST ADR standaard is ook opgenomen op de Pas-toe-of-leg-uit lijst van het Forum Standaardisatie. De REST ADR standaard is dan ook als basis genomen voor dit Digikoppeling REST API Profiel dat zich specifiek richt op G2G (Government-to-Government) interactie en M2M (Machine-to-Machine verkeer). +Vanuit het TO Digikoppeling zijn al langere tijd de ontwikkelingen rond RESTful API's gevolgd. Binnen het Kennisplatform API zijn de REST-API Design Rules (REST ADR) ontwikkeld en de REST ADR standaard is ook opgenomen op de Pas-toe-of-leg-uit lijst van het Forum Standaardisatie. De REST ADR standaard is dan ook als basis genomen voor dit Digikoppeling REST API Profiel dat zich specifiek richt op G2G (Government-to-Government) interactie en M2M (Machine-to-Machine verkeer). +Daarnaast is de standaard Federated Service Connectivity (FSC) ontwikkelt die voorschrijft hoe organisaties REST API's kunnen ontdekken, aanbieden en consumeren. De FSC standaard is opgenomen in dit Digikoppeling REST API Profiel om de koppelingen met REST API's te standardiseren waardoor er een interoperabel API landschap ontstaat. ### Toepassingsgebied @@ -12,31 +13,86 @@ Het toepassingsgebied is voor Digikoppeling: > Digikoppeling moet worden toegepast bij digitale gegevensuitwisseling die plaatsvindt met voorzieningen die onderdeel zijn van de GDI, waaronder de basisregistraties, of die sectoroverstijgend is. De verplichting geldt voor gegevensuitwisseling tussen systemen waarbij er noodzaak is voor tweezijdige authenticatie. -Dit profiel is toe te passen bij het aanbieden van REST API's ten behoeve van het ontsluiten van overheidsinformatie en/of functionaliteit. +Dit profiel is toe te passen bij het aanbieden en/of consumeren van REST API's ten behoeve van het ontsluiten van overheidsinformatie en/of functionaliteit. -## Digikoppeling REST-API profiel +## Digikoppeling REST API profiel ### Algemeen -Het Digikoppeling REST-API profiel is gebaseerd op de REST-API Design Rules standaard zoals ontwikkeld door het Kennisplatform API's en in beheer gebracht bij Logius Stelsels & Standaarden: [[ADR]] +Het Digikoppeling REST API profiel verplicht het gebruik van de FSC standaard. -Het Digikoppeling REST-API profiel conformeert zich volledig aan het normatieve deel van de REST-API Design Rules. +Het Digikoppeling REST API profiel is o.a. gebaseerd op de REST-API Design Rules standaard zoals ontwikkeld door het Kennisplatform API's en in beheer gebracht bij Logius Stelsels & Standaarden: [[ADR]] + + +Het Digikoppeling REST API profiel conformeert zich volledig aan het normatieve deel van de REST-API Design Rules. + ### Koppelvlak Generiek +#### FSC + +De FSC standaard bestaat uit een Core component en een extensie genaamd Logging. Het Digikoppeling REST API profiel verplicht het gebruik van zowel Core, Logging. + +FSC beschrijft het volgende: + +1. Hoe de identiteit van een organisatie wordt bepaald en vertrouwd. +2. Hoe een autorisatie om te mogen koppelen met een API gegeven, geweigerd of ontnomen wordt. +3. Hoe organisaties van een netwerk de API's, en elkaar kunnen vinden. +4. Hoe een verbinding naar een API veilig kan worden opgezet. +5. Hoe logregels weggeschreven moet worden. +6. Hoe een intermediar namens een organisatie een API kan consumeren en/of publiceren. + +Het Digikoppeling REST API profiel geeft invulling aan keuzes die gemaakt moeten worden bij het gebruik van FSC. +In het Digikoppeling REST API profiel wordt er vanuit gegaan dat de lezer bekent is met de standaard FSC. Er worden namelijk termen gebruikt uit deze standaard. + +De bovengenoemde functionaliteit is vastgelegd in FSC Core en de extensies Logging en Delegation. Core beschrijft het koppelen met API's, Logging hoe logregels wgeggeschreven moeten worden en Delegation hoe een intermediar namens een organisatie een API kan consumeren en/of publiceren. + +1. [Core](https://commonground.gitlab.io/standards/fsc/core/draft-fsc-core-00.html) +2. [Logging](https://commonground.gitlab.io/standards/fsc/logging/draft-fsc-logging-00.html) + #### Vertrouwelijkheid -De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] en 2-zijdig TLS. +De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] . * Zie [[Digikoppeling-Beveiligingsdocument]] +FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid. + +De Trust Anchor voor de FSC Group moet daarom de PKIO Private Root zijn. #### Identificatie & Authenticatie -Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. -Binnen dit DK REST-API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. +Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Dit is het PeerID binnen de context van FSC. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject. +Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat. +Binnen dit Digikoppeling REST API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. * Zie [[Digikoppeling-Identificatie-Authenticatie]] +#### TLS + +De Digikoppeling Beveilingsstandaarden en voorschriften veplichten het gebruik van 2-zijdig TLS met minimaal TLS versie 1.2, FSC verscherpt deze eis door de ciphersuites die geen perfect forward secrecy ondersteunen niet toe te laten. +* Zie [[Digikoppeling-Beveiligingsdocument]] + +#### Netwerk-poorten + +De Digikoppeling Beveiligingsstandaarden en voorschriften verplichten het gebruik van de netwerkpoort 443 voor data verkeer. FSC voegt daar het gebruik van port 8443 voor managementverkeer aan toe. E.g. toegang aanvragen voor een API. +* Zie [[Digikoppeling-Beveiligingsdocument]] + +#### Contracten + +FSC gebruikt Contracten om afspraken tussen Peers vast te leggen. Een Contract kan één of meerdere Grants bevatten. Een Grant beschrijft welke interactie er mogelijk is tussen de Peers. +FSC plaatst geen beperking op het aantal Grants per Contract. Het Digikoppeling REST API profiel doet dit wel om te voorkomen dat er fragiele Contracten ontstaan met een hoge beheerslast. Het aantal Grants wordt beperkt tot maximaal 10. + +#### Retry-mechanisme tijdens synchronisatie + +FSC stelt elke implementatie zelf verantwoordlijk voor het synchroniseren van Contracten en de digitale handtekeningen onder deze Contracten. +Het Digikoppeling REST API profiel verplicht hiervoor het implementeren van een exponential backoff retry-mechanisme. +> Het retry mechanisme betreft niet de HTTP-requests voor het bevragen van een Service. + +#### Logging + +De FSC Logging extensie beschrijft een Transaction ID. Een unieke identifier in de vorm van een UUID voor elke transactie die gedaan wordt, i.e. een bevraging van een API. Deze transactie ID wordt weggeschreven bij elke log regel. +Het Digikoppeling REST API profiel verplicht het gebruik van een UUID V7 als Transaction ID. + ### API Design Rules #### Toelichting aanduidingen @@ -54,7 +110,7 @@ Binnen dit DK REST-API profielprofiel zijn er alleen voorschriften m.b.t. het ve #### Regels -Het Digikoppeling REST-API profiel conformeert zich volledig aan het normatieve deel van de [[ADR]]. +Het Digikoppeling REST API profiel conformeert zich volledig aan het normatieve deel van de [[ADR]]. |Categorie |Principe |Toelichting |Link | |--- | --- |---|---| From 03d3006a0c1b8e587d6152e3b6f3d8e84aa6d329 Mon Sep 17 00:00:00 2001 From: Ronald Koster Date: Tue, 4 Jun 2024 14:38:38 +0200 Subject: [PATCH 2/8] beschrijving retry-mechanisme herschreven en een voorbeeld toegevoegd --- ch03_Digikoppeling Restful API profiel.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/ch03_Digikoppeling Restful API profiel.md b/ch03_Digikoppeling Restful API profiel.md index 0502339..be43c51 100644 --- a/ch03_Digikoppeling Restful API profiel.md +++ b/ch03_Digikoppeling Restful API profiel.md @@ -5,7 +5,7 @@ ### Historie Vanuit het TO Digikoppeling zijn al langere tijd de ontwikkelingen rond RESTful API's gevolgd. Binnen het Kennisplatform API zijn de REST-API Design Rules (REST ADR) ontwikkeld en de REST ADR standaard is ook opgenomen op de Pas-toe-of-leg-uit lijst van het Forum Standaardisatie. De REST ADR standaard is dan ook als basis genomen voor dit Digikoppeling REST API Profiel dat zich specifiek richt op G2G (Government-to-Government) interactie en M2M (Machine-to-Machine verkeer). -Daarnaast is de standaard Federated Service Connectivity (FSC) ontwikkelt die voorschrijft hoe organisaties REST API's kunnen ontdekken, aanbieden en consumeren. De FSC standaard is opgenomen in dit Digikoppeling REST API Profiel om de koppelingen met REST API's te standardiseren waardoor er een interoperabel API landschap ontstaat. +Daarnaast is de standaard Federated Service Connectivity (FSC) ontwikkeld die voorschrijft hoe organisaties REST API's kunnen ontdekken, aanbieden en consumeren. De FSC standaard is opgenomen in dit Digikoppeling REST API Profiel om de koppelingen met REST API's te standardiseren waardoor er een interoperabel API landschap ontstaat. ### Toepassingsgebied @@ -19,7 +19,7 @@ Dit profiel is toe te passen bij het aanbieden en/of consumeren van REST API's t ### Algemeen -Het Digikoppeling REST API profiel verplicht het gebruik van de FSC standaard. +Het Digikoppeling REST API profiel maakt gebruikt van de FSC standaard. Het Digikoppeling REST API profiel is o.a. gebaseerd op de REST-API Design Rules standaard zoals ontwikkeld door het Kennisplatform API's en in beheer gebracht bij Logius Stelsels & Standaarden: [[ADR]] @@ -56,15 +56,15 @@ De bovengenoemde functionaliteit is vastgelegd in FSC Core en de extensies Loggi De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] . * Zie [[Digikoppeling-Beveiligingsdocument]] -FSC spreekt over een Thrust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid. +FSC spreekt over een Trust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid. De Trust Anchor voor de FSC Group moet daarom de PKIO Private Root zijn. #### Identificatie & Authenticatie Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Dit is het PeerID binnen de context van FSC. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject. -Het verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat. -Binnen dit Digikoppeling REST API profielprofiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. +Het is verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat. +Binnen dit Digikoppeling REST API profiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. * Zie [[Digikoppeling-Identificatie-Authenticatie]] #### TLS @@ -82,12 +82,17 @@ De Digikoppeling Beveiligingsstandaarden en voorschriften verplichten het gebrui FSC gebruikt Contracten om afspraken tussen Peers vast te leggen. Een Contract kan één of meerdere Grants bevatten. Een Grant beschrijft welke interactie er mogelijk is tussen de Peers. FSC plaatst geen beperking op het aantal Grants per Contract. Het Digikoppeling REST API profiel doet dit wel om te voorkomen dat er fragiele Contracten ontstaan met een hoge beheerslast. Het aantal Grants wordt beperkt tot maximaal 10. -#### Retry-mechanisme tijdens synchronisatie +#### Retry-mechanisme voor versturen van Contracten en hantekeningen -FSC stelt elke implementatie zelf verantwoordlijk voor het synchroniseren van Contracten en de digitale handtekeningen onder deze Contracten. -Het Digikoppeling REST API profiel verplicht hiervoor het implementeren van een exponential backoff retry-mechanisme. +De Peer die een Contract aanmaakt of een handtekening plaats op een Contract is zelf verantwoordelijk voor het distribureren van het Contract of handtekening naar de Peers op het Contract. +In het scenario dat het versturen van Contract of handtekening mislukt verplicht het Digikoppeling REST API profiel het toepassen van een exponential backoff retry-mechanisme. > Het retry mechanisme betreft niet de HTTP-requests voor het bevragen van een Service. +Een exponential backoff retry-mechanism is een mechanisme dat een mislukt verzoek opnieuw gaat uitvoeren op een interval die exponentieel groeit. +Deze exponentiële groei voorkomt dat een applicatie een veelvoud van verzoeken verstuurd naar een service die niet bereikbaar is. + +Voorbeeld: Peer A verstuurt een Contract naar Peer B. Het versturen mislukt. Peer A probeert het opnieuw na 1 seconde, het verzoek mislukt weer. De volgende poging wordt gedaan na 2 seconden, daarna 4 seconden, vervolgens 16 seconden, enzovoort. Om te voorkomen dat er langlopende processen worden gecreëerd hanteerd Peer A een maximale interval van 300 seconden. + #### Logging De FSC Logging extensie beschrijft een Transaction ID. Een unieke identifier in de vorm van een UUID voor elke transactie die gedaan wordt, i.e. een bevraging van een API. Deze transactie ID wordt weggeschreven bij elke log regel. From efeb56319f65b18d1cf2405a2caf18464ad65abe Mon Sep 17 00:00:00 2001 From: Alexander Green Date: Fri, 7 Jun 2024 18:11:12 +0200 Subject: [PATCH 3/8] Abstract toegevoegd --- abstract.md | 4 ++++ index.html | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 abstract.md diff --git a/abstract.md b/abstract.md new file mode 100644 index 0000000..6ad18fd --- /dev/null +++ b/abstract.md @@ -0,0 +1,4 @@ +Dit document beschrijft de functionele specificaties voor de Digikoppeling Koppelvlakstandaard REST-API. +Het document is bestemd voor architecten en ontwikkelaars die op basis van REST-API's gegevens willen uitwisselen via Digikoppeling. + +Het Digikoppeling REST-API profiel is gebaseerd op de [[[ADR]]] zoals ontwikkeld door het Kennisplatform API's en in beheer gebracht bij Logius. \ No newline at end of file diff --git a/index.html b/index.html index 821ae8c..64e35be 100644 --- a/index.html +++ b/index.html @@ -18,7 +18,7 @@ -
+

Status van het document - verplicht onderdeel. Een deel van de tekst wordt hierin gegenereerd door ReSpec op basis van de configuratieparameter specStatus. From 9f92f8d6257c0dd3f98d10dbb914a66dfe4c1711 Mon Sep 17 00:00:00 2001 From: Alexander Green Date: Wed, 12 Jun 2024 10:56:29 +0200 Subject: [PATCH 4/8] Delete `.idea` --- .idea/.gitignore | 8 -------- .idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml | 9 --------- .idea/modules.xml | 8 -------- .idea/vcs.xml | 6 ------ 4 files changed, 31 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml delete mode 100644 .idea/modules.xml delete mode 100644 .idea/vcs.xml diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 13566b8..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml b/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml deleted file mode 100644 index 5e764c4..0000000 --- a/.idea/Digikoppeling-Koppelvlakstandaard-REST-API.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 986aadd..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1dd..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file From dad7f1afca8ac645ab3f33fea79b545a54465027 Mon Sep 17 00:00:00 2001 From: Logius Standaardenbeheer <78218356+logius-standaardenbeheer@users.noreply.github.com> Date: Wed, 12 Jun 2024 15:05:27 +0200 Subject: [PATCH 5/8] update aanbevolen --- ch03_Digikoppeling Restful API profiel.md | 32 ++++++++++++++++------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/ch03_Digikoppeling Restful API profiel.md b/ch03_Digikoppeling Restful API profiel.md index ae42934..ffec0a9 100644 --- a/ch03_Digikoppeling Restful API profiel.md +++ b/ch03_Digikoppeling Restful API profiel.md @@ -19,20 +19,34 @@ Dit profiel is toe te passen bij het aanbieden en/of consumeren van REST API's t ### Algemeen -Het Digikoppeling REST API profiel maakt gebruikt van de FSC standaard. - - Het Digikoppeling REST API profiel is o.a. gebaseerd op de REST-API Design Rules standaard zoals ontwikkeld door het Kennisplatform API's en in beheer gebracht bij Logius Stelsels & Standaarden: [[ADR]] Het Digikoppeling REST API profiel conformeert zich volledig aan het normatieve deel van de REST-API Design Rules. +Het Digikoppeling REST API profiel maakt gebruikt van de FSC standaard. + ### Koppelvlak Generiek -#### FSC -De FSC standaard bestaat uit een Core component en een extensie genaamd Logging. Het Digikoppeling REST API profiel verplicht het gebruik van zowel Core, Logging. +#### Vertrouwelijkheid + +De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] . +* Zie [[[DK-beveiliging]]] + + +#### Identificatie & Authenticatie + +Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Binnen dit Digikoppeling REST API profiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. +* Zie [[[DK-IDAuth]]] + +### FSC + +Gebruik van de FSC standaard binnen het Digikoppeling REST API profiel is aanbevolen. + +De FSC standaard bestaat uit een Core component en een extensie genaamd Logging. +Wanneer FSC wordt gebruikt is het verplicht Core en Logging beide te gebruiken. FSC beschrijft het volgende: @@ -51,22 +65,20 @@ De bovengenoemde functionaliteit is vastgelegd in FSC Core en de extensies Loggi 1. [Core](https://commonground.gitlab.io/standards/fsc/core/draft-fsc-core-00.html) 2. [Logging](https://commonground.gitlab.io/standards/fsc/logging/draft-fsc-logging-00.html) -#### Vertrouwelijkheid -De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] . -* Zie [[[DK-beveiliging]]] +#### Vertrouwelijkheid FSC spreekt over een Trust Anchor die door een Group moet worden gekozen. De Trust Anchor is binnen de context van X.509 certificaten de certificate authority (CA) waaruit het vertrouwen wordt afgeleid. - De Trust Anchor voor de FSC Group moet daarom de PKIO Private Root zijn. #### Identificatie & Authenticatie -Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Dit is het PeerID binnen de context van FSC. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject. +Het PeerID binnen de context van FSC is OIN. Het OIN wordt bij PKIO certificaten geplaatst in het SerialNumber veld van het Subject. Het is verplicht vanuit FSC om te bepalen welk veld uit het certificaat de Peer name bepaald. Dit is het organization veld van het Subject van het PKIO certificaat. Binnen dit Digikoppeling REST API profiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. * Zie [[[DK-IDAuth]]] + #### TLS De Digikoppeling Beveilingsstandaarden en voorschriften veplichten het gebruik van 2-zijdig TLS met minimaal TLS versie 1.2, FSC verscherpt deze eis door de ciphersuites die geen perfect forward secrecy ondersteunen niet toe te laten. From ea8aab9adbe72fc1868d7d3f808b929c0470cb47 Mon Sep 17 00:00:00 2001 From: Alexander Green Date: Wed, 12 Jun 2024 15:35:55 +0200 Subject: [PATCH 6/8] ref fix --- ch03_Digikoppeling Restful API profiel.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ch03_Digikoppeling Restful API profiel.md b/ch03_Digikoppeling Restful API profiel.md index ffec0a9..7597905 100644 --- a/ch03_Digikoppeling Restful API profiel.md +++ b/ch03_Digikoppeling Restful API profiel.md @@ -32,7 +32,7 @@ Het Digikoppeling REST API profiel maakt gebruikt van de FSC standaard. #### Vertrouwelijkheid -De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKI-Policy]] . +De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op het verplichte gebruik van PKIO certificaten [[PKIO-PvE]]. * Zie [[[DK-beveiliging]]] @@ -82,12 +82,12 @@ Binnen dit Digikoppeling REST API profiel zijn er alleen voorschriften m.b.t. he #### TLS De Digikoppeling Beveilingsstandaarden en voorschriften veplichten het gebruik van 2-zijdig TLS met minimaal TLS versie 1.2, FSC verscherpt deze eis door de ciphersuites die geen perfect forward secrecy ondersteunen niet toe te laten. -* Zie [[Digikoppeling-Beveiligingsdocument]] +* Zie [[[DK-beveiliging]]] #### Netwerk-poorten De Digikoppeling Beveiligingsstandaarden en voorschriften verplichten het gebruik van de netwerkpoort 443 voor data verkeer. FSC voegt daar het gebruik van port 8443 voor managementverkeer aan toe. E.g. toegang aanvragen voor een API. -* Zie [[Digikoppeling-Beveiligingsdocument]] +* Zie [[[DK-beveiliging]]] #### Contracten From c91e434287ecb44145c818e761b63ac6202de973 Mon Sep 17 00:00:00 2001 From: Logius Standaardenbeheer <78218356+logius-standaardenbeheer@users.noreply.github.com> Date: Wed, 12 Jun 2024 15:57:56 +0200 Subject: [PATCH 7/8] update aanbevolen --- ch03_Digikoppeling Restful API profiel.md | 2 +- js/config.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ch03_Digikoppeling Restful API profiel.md b/ch03_Digikoppeling Restful API profiel.md index 7597905..d0c6c8c 100644 --- a/ch03_Digikoppeling Restful API profiel.md +++ b/ch03_Digikoppeling Restful API profiel.md @@ -41,7 +41,7 @@ De Digikoppeling Beveiligingsstandaarden en voorschriften gaan specifiek in op h Digikoppeling maakt gebruik van het OIN (Organisatie Identificatie Nummer) voor de identificatie van organisaties. Binnen dit Digikoppeling REST API profiel zijn er alleen voorschriften m.b.t. het verplicht gebruik van het OIN binnen PKIO certificaten en FSC. Voor OIN gebruik binnen payloads (bv JSON) of resource-pad gelden geen specifieke voorschriften. * Zie [[[DK-IDAuth]]] -### FSC +### Federated Service Connectivity Standaard (FSC) Gebruik van de FSC standaard binnen het Digikoppeling REST API profiel is aanbevolen. diff --git a/js/config.js b/js/config.js index c0adc6d..403dd1c 100644 --- a/js/config.js +++ b/js/config.js @@ -27,6 +27,6 @@ var respecConfig = { publishDate: "2022-11-14", publishVersion: "1.1.1", shortName: "restapi", - specStatus: "WV", + specStatus: "CV", specType: "ST" }; From dc25f8bdf3ed484bbf40bca5b327a07cd34ff8ea Mon Sep 17 00:00:00 2001 From: Logius Standaardenbeheer <78218356+logius-standaardenbeheer@users.noreply.github.com> Date: Wed, 12 Jun 2024 16:09:49 +0200 Subject: [PATCH 8/8] update --- js/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/js/config.js b/js/config.js index 403dd1c..eb8b86b 100644 --- a/js/config.js +++ b/js/config.js @@ -24,7 +24,7 @@ var respecConfig = { nl_emailcomments: "digikoppeling@logius.nl", previousPublishVersion: "1.1.0", pubDomain: "dk", - publishDate: "2022-11-14", + publishDate: "2024-06-12", publishVersion: "1.1.1", shortName: "restapi", specStatus: "CV",