publiccodeYmlVersion: "0.5"
name: Generieke Functies Gateway Verifier
url: https://github.com/minvws/gfmodules-nationale-verwijsindex-gateway-verifier
platforms:
  - web
categories:
  - application-development
developmentStatus: development
softwareType: standalone/backend
intendedAudience:
  countries:
    - NL
  scope:
    - government
    - healthcare

description:
  nl:
    shortDescription: >-
      Gatewayverificatieservice voor de NVI en de PRS die bearer-JWT's
      valideert aan de hand van de door de gateway aangeleverde handelende
      identiteit.
    longDescription: |
      De Gateway Verifier voor de NVI en de PRS is onderdeel van het project
      'Generieke Functies, lokalisatie en addressering' van het Ministerie van
      Volksgezondheid, Welzijn en Sport. De FastAPI-service valideert inkomende
      gateway-verzoeken op basis van een bearer-JWT en de handelende identiteit
      die de gateway aanlevert via X-GF-Act-Sub en X-GF-Act-Cn. De
      service controleert de JWT-handtekening en vereiste claims en vergelijkt
      de `act.sub`- en `act.cn`-claims met de gatewaywaarden. Na succesvolle
      validatie retourneert de service genormaliseerde identiteitsgegevens in
      `x-gf-*`-velden.
    features:
      - Validatie van ondertekende bearer-JWT's en vereiste claims
      - Vergelijking van de handelende identiteit met de `act`-claims in het JWT
      - Genormaliseerde identiteitsgegevens voor achterliggende diensten
  en:
    shortDescription: >-
      Gateway verification service for the NVI and PRS that validates bearer
      JWTs against the acting identity supplied by the gateway.
    longDescription: |
      The Gateway Verifier for the NVI and PRS is part of the 'Generieke
      Functies, lokalisatie en addressering' project of the Ministry of Health,
      Welfare and Sport. The FastAPI service validates protected gateway
      requests using a bearer JWT and the acting identity supplied by the
      gateway through X-GF-Act-Sub and X-GF-Act-Cn. It verifies the JWT
      signature and required claims, then compares the `act.sub` and `act.cn`
      claims with the gateway-supplied values. After successful validation,
      the service returns normalized `x-gf-*` identity data.
    features:
      - Validation of signed bearer JWTs and required claims
      - Matching the acting identity against the JWT `act` claims
      - Normalized identity data for downstream services

legal:
  license: EUPL-1.2
  mainCopyrightOwner: Ministerie van Volksgezondheid, Welzijn en Sport

maintenance:
  type: internal
  contacts:
    - name: iRealisatie - Team Generieke Functies
      email: maintainer@irealisatie.nl
      affiliation: Ministerie van Volksgezondheid, Welzijn en Sport

organisation:
  uri: https://www.rijksoverheid.nl/ministeries/ministerie-van-volksgezondheid-welzijn-en-sport
  name: Ministerie van Volksgezondheid, Welzijn en Sport

localisation:
  localisationReady: false
  availableLanguages:
    - en