Page Comparison

Authenticatie via Vlaams Toegangsbeheer

Vanuit Bij Mijn Burgerprofiel maken gebruiken we gebruik van het Vlaams Toegangsbeheer om authenticatie te faciliteren. Deze component voorziet automatisch single sign-on-functionaliteit (SS0-functionaliteit) zodat een burger zich niet telkens opnieuw moet aanmelden in verschillende applicaties. In het kader van de aanvraagmodule

Voor de Aanvraagmodule kan een formulier op twee manier geraadpleegd worden op 2 manieren:

• Embedded (verankerd) in Mijn Burgerprofiel

• Stand-alone (als aparte applicatie)

De SSO-functionaliteit is gebonden aan deze beperkingen:

• een beperkte levensduur - kies een duurtijd van < 5 minuten

• aanmelden moet in dezelfde browserinstantie

• geen garantie dat de gebruikerscontext bewaard blijft tussen de verschillende applicaties

• bij embed embedded gebruik kan de functionaliteit geïmpacteerd worden door de third-party cookie problematiekcookieproblematiek

Single Sign-on via token

Om een aantal beperkingen op te lossen bij de klassieke manier waarop werking van single sign-on werktop te lossen, gebruiken we Token Exchange om een OAuth Access Token te generen die door dat de aanvraagmodule gebruikt Aanvraagmodule kan wordengebruiken.

...

Voorwaarde

• De aanvraagmodule Aanvraagmodule moet een trust-relatie hebben met de Mijn Burgerprofiel Client-ID (- zie Bijlage: Mijn- Mijn Burgerprofiel-Client-ID)

Stroomdiagram

Implementatie

Standaard zal een aanvraagmodule gebruik maken van OpenId maakt de Aanvraagmodule gebruik van OpenID Connect (op basis van authorization code Authorization Code grant) in kader van voor geauthenticeerde formulieren. Hoewel dit geen probleem vormt voor een formulier dat Dit verloopt vlot voor formulieren die in stand-alone modus getoond wordt kan dit problemen veroorzaken in embedded modus getoond worden.

Gebruikerscontext doorgeven aan een

...

Aanvraagmodule

Hiervoor moet mijn Burgerprofiel het OAuth Access Token - verkregen via de voorgaande Token Exchange - worden doorgegeven vanuit Mijn Burgerprofiel. Gezien doorgeven. Door de gevoeligheid van het OAuth Access Token moet dit altijd via een server-to-server operatie verlopen .Om dit te bereiken dient de aanvraagmodule als volgt:

1. De Aanvraagmodule moet een API-endpoint

...

1. voorzien volgens de onderstaande API

...

1. -specificaties.

2. Mijn Burgerprofiel (server) roept

...

1. dat API-endpoint

...

1. aan om een OAuth Access token te registreren.

...

2. Het resultaat van die registratie moet

...

1. een tijdelijk, éénmalig te gebruiken token

...

1. zijn, dat

...

1. wordt doorgegeven

...

1. zodra de Aanvraagmodule wordt geopend in de browser

...

1. .

Aanvraagmodule - SSO Token (Swagger)

{
  "openapi": "3.0.2",
  "info": {
    "title": "Aanvraagmodule - SSO Token",
    "version": "1.0"
  },
  "components": {
    "schemas": {
      "RequestToken": {
        "type": "object",
        "required": [
          "token",
          "token_type"
        ],
        "properties": {
          "token": {
            "type": "string",
            "description": "Token ontvangen via IdP Token Exchange"
          },
          "token_type": {
            "type": "string",
            "description": "Type token ontvangen via IdP Token Exchange",
            "enum": [
              "urn:ietf:params:oauth:token-type:access_token"
            ]
          }
        }
      },
      "ResponseTempToken": {
        "type": "object",
        "required": [
          "token"
        ],
        "properties": {
          "token": {
            "type": "string",
            "description": "Tijdelijk SSO Token"
          }
        }
      },
      "ClientError": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Foutmelding"
          }
        }
      },
      "ServerError": {
        "type": "string"
      }
    }
  },
  "servers": [
    {
      "description": "Form provider",
      "url": "https://formulier.vlaanderen.be"
    }
  ],
  "paths": {
    "/auth/v1/token": {
      "post": {
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestToken"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/RequestToken"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Vraagstelling is geaccepteerd en een tijdelijk token werd gegenereerd",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseTempToken"
                }
              }
            }
          },
          "400": {
            "description": "Vraagstelling ontbreekt verplichte velden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientError"
                }
              }
            }
          },
          "401": {
            "description": "Ongeldig of vervallen token in de vraagstelling",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientError"
                }
              }
            }
          },
          "500": {
            "description": "Onverwacht probleem opgetreden in de applicatie bij het verwerken van het token",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/ServerError"
                }
              }
            }
          }
        }
      }
    }
  }
}

Het verkregen tijdelijk token zal door Mijn Burgerprofiel worden doorgegeven als query Mijn Burgerprofiel geeft het tijdelijke token door als query-parameter via de formulier URL. De exacte waarde die gebruikt zal worden wordt voor de query parameter naam dient door te stromen -parameternaam moet doorstroome via de Formulieren API-specificatie.

...

Voor een overzicht van relevante foutboodschappen, zie ook https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Standaard-foutberichten en https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Specifieke-foutberichten

Voorbeeld:

https://formulier.vlaanderen.be/f6d35977-f45d-4710-befc-21e2812d83ea?token=<TEMP-TOKEN>

...

Het token verwerken in de

...

Aanvraagmodule

Wanneer de aanvraagmodule een token ontvangt dient men volgende stappen uit te voerenDoorloop de volgende stappen nadat de Aanvraagmodule het token heeft ontvangen:

1. Controleer dat het

...

1. tijdelijke token niet vervallen is

...

1. .
   Bijvoorbeeld: een aanvraagmodule kan het geregistreerde access token samen met het tijdelijk token voor 2 minuten opslaan in een cache. Op het moment dat een tijdelijk token dan gebruikt wordt, kan de aanvraagmodule controleren of het nog in de cache aanwezig is (en het token dan ook uit de cache verwijderen, zodat het niet meermaals gebruikt kan worden).

2. Controleer dat het tijdelijk token nog niet gebruikt is.

3. Valideer het uitgewisselde OAuth Access Token

...

1. , zie ook https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/rest-namens-gebruiker/rest-token-exchange/valideer-access-token/

...

Indien aan alle voorgenoemde voorwaarden is voldaan, kan de aanvraagmodule Aanvraagmodule een nieuwe sessie opstarten op basis van de gebruikerscontext die beschikbaar gesteld is via het OAuth Access Token.

Anchor
bijlage-mbp-client-id bijlage-mbp-client-id

Bijlage - Mijn Burgerprofiel Client-ID