OpenID Connect Relying Party for GesundheitsID (eHealthID)

The goal is to provide a simple standalone server exposing Germany's 'GesundheitsID' (eHealthID) as a good old OpenID Connect Relying Party (OIDC RP).

Identity Providers such as Keycloak can link accounts with OIDC out-of-the-box

State of Compatibility

Productive Environment (PU)

Sectoral IdP	End-to-End	Provider
Techniker Krankenkasse	✅	IBM
Gothaer	🚫	RISE

Note

Most providers can not be independently tested as there are no test accounts available.

Authentication Flow IDP / Relying Party

sequenceDiagram
    participant app as Mobile App
    participant idp as Your IDP
    participant rp as Relying Party
    app ->> idp: login
    idp -->> app: redirect to Relying Party (OIDC)
    app ->> rp: login
    note over app, rp: login via eHealthID handled by Relying Party (RP)
    rp -->> app: redirect to IDP with code
    app ->> idp: success, callback to IDP
    idp ->> rp: redeem code
    rp -->> idp: id_token
    idp -->> app: success! redirect

Loading

Contents

• ehealthid-rp - A standalone application to act as a OpenID Connect (OIDC) Relying Party. Bridges OIDC and Germany's GesundheitsID OpenID federation.
• ehealthid-cli - A script to generate keys and federation registration forms.
• ehealthid - A plain Java library to build RelyingParties for GesundheitsID.
  • API clients
  • Models for the EntityStatments, IDP list endpoints etc.
  • Narrow support for the 'Fachdienst' use-case.

Quickstart

#---- 1. generate keys
# the URI where your relying-party will run, 
# for the registration this _MUST_ be publicly reachable
export ISSUER_URI=https://mydiga.example.com

# generate keys for the application, keep those safe and secure
./cli.sh keygen --issuer-uri=$ISSUER_URI

#---- 2. deploy the relying party
docker run --rm \
    -v "$(pwd)"/sig_mydiga_example_com_jwks.json:/secrets/sig_jwks.json:ro \
    -e "EHEALTHID_RP_APP_NAME=Awesome DiGA" \
    -e "EHEALTHID_RP_BASE_URI=$ISSUER_URI" \
    -e 'EHEALTHID_RP_FEDERATION_ES_JWKS_PATH=/secrets/sig_jwks.json' \
    -e 'EHEALTHID_RP_FEDERATION_MASTER=https://app-test.federationmaster.de' \
    -e 'EHEALTHID_RP_REDIRECT_URIS=https://sso-mydiga.example.com/auth/callback' \
    -e 'EHEALTHID_RP_ES_TTL=PT5M' \
    -e 'EHEALTHID_RP_IDP_DISCOVERY_URI=https://sso-mydiga.example.com/.well-known/openid-configuration' \
    -p 1234:1234 \
    ghcr.io/oviva-ag/ehealthid-relying-party:latest

#---- 3. register with the federation master

# a string received from Gematik as part of the registration process
# see: https://wiki.gematik.de/pages/viewpage.action?pageId=544316583
export MEMBER_ID=FDmyDiGa0112TU

# generate the registration XML from an existing entity statement
./cli.sh fedreg \
    --environment=TU \
    [email protected] \
    --issuer-uri=$ISSUER_URI \
    --member-id="$MEMBER_ID"
    
# this prints the XML for registration in the federation, send it
# as an email attachment to Gematik 
# see: https://wiki.gematik.de/pages/viewpage.action?pageId=544316583

IMPORTANT:

• The relying party MUST be registered within the OpenID federation to work fully.
• In order to register for the federation, your entity statment MUST be publicly available.

Once the server is booted, it will:

1. Expose an OpenID Discovery document at $EHEALTHID_RP_BASE_URI/.well-known/openid-configuration

    curl $BASE_URI/.well-known/openid-configuration | jq .

2. Expose an OpenID Federation entity configuration at $EHEALTHID_RP_BASE_URI/.well-known/openid-federation

    curl $BASE_URI/.well-known/openid-federation | jwt decode -j - | jq .payload

3. Be ready to handle OpenID Connect flows and handle them via Germany's GesundheitsID federation.

Configure Identity Provider

Generic settings:

• the relying party OpenID configuration is at $ISSUER_URI/.well-known/openid-configuration
  • token_url: /auth/token
  • auth_url: /auth
  • jwks_url: /jwks.json
• the only supported client authentication is private_key_jwt, the public keys will be discovered

Example: Keycloak OpenID Connect Identity Provider Settings

As an example with https://t.oviva.io as the relying party issuer.

Configuration

Use environment variables to configure the relying party server.

(*) required configuration

Name	Description	Example
EHEALTHID_RP_FEDERATION_ES_JWKS_PATH*	Path to a JWKS with at least one keypair for signature of the entity statement. All these keys MUST be registered with the federation master.	./sig_jwks.json
EHEALTHID_RP_OPENID_RP_SIG_JWKS_PATH*	Path to a JWKS with signing keys of our relying party, i.e. for mTLS client certificates	./openid_rp_sig_jwks.json
EHEALTHID_RP_OPENID_RP_ENC_JWKS_PATH*	Path to a JWKS with the keys used for encryption between the federation and the relying party, i.e. to encrypt id_tokens	./openid_rp_enc_jwks.json
EHEALTHID_RP_REDIRECT_URIS*	Valid redirection URIs for OpenID connect.	https://sso-mydiga.example.com/auth/callback
EHEALTHID_RP_BASE_URI*	The external base URI of the relying party. This is also the issuer towards the OpenID federation. Additional paths are unsupported for now.	https://mydiga-rp.example.com
EHEALTHID_RP_IDP_DISCOVERY_URI*	The URI of the discovery document of your identity provider. Used to fetch public keys for client authentication.	https://sso-mydiga.example.com/.well-known/openid-configuration
EHEALTHID_RP_FEDERATION_MASTER*	The URI of the federation master.	https://app-test.federationmaster.de
EHEALTHID_RP_APP_NAME*	The application name within the federation.	Awesome DiGA
EHEALTHID_RP_HOST	Host to bind to.	0.0.0.0
EHEALTHID_RP_PORT	Port to bind to.	1234
EHEALTHID_RP_ES_TTL	The time to live for the entity statement. In ISO8601 format.	PT12H
EHEALTHID_RP_SCOPES	The comma separated list of scopes requested in the federation. This MUST match what was registered with the federation master.	openid,urn:telematik:versicherter
EHEALTHID_RP_SESSION_STORE_TTL	The time to live for sessions. In ISO8601 format.	PT20M
EHEALTHID_RP_SESSION_STORE_MAX_ENTRIES	The maximum number of sessions to store. Keeps memory bounded.	1000
EHEALTHID_RP_CODE_STORE_TTL	The time to live for codes, i.e. successful logins where the code is not redeemed yet. In ISO8601 format.	PT5M
EHEALTHID_RP_CODE_STORE_MAX_ENTRIES	The maximum number of codes to store. Keeps memory bounded.	1000
EHEALTHID_RP_LOG_LEVEL	The log level.	INFO
EHEALTHID_RP_OPENID_PROVIDER_SIG_JWKS_PATH	Path to a JWKS with signing keys for our openIdProvider, for example the id_token issued by the relying party will be signed with it. Will be generated if not configured.	./openid_provider_sig_jwks.json

Generate Keys & Register for Federation

In order to participate in the GesundheitsID one needs to register the entity statement of the IDP or in this case the relying party here.

To simplify matter, here a script to generate fresh keys as well as the XML necessary to register with Gematik.

See Gematik documentation for details on the registration process.

./cli.sh --help

Authentication flow between all involved parties

NOTE: There are some additional interactions within the federation, for a more complete flow see AppFlow in the Gematik documentation.

sequenceDiagram
    participant app as Mobile App
    participant idp as Your IDP
    participant rp as Relying Party
    participant secIdp as Sectoral IDP
    participant fedmaster as Federation Master
    app ->> idp: login
    idp -->> app: redirect to Relying Party (OIDC)
    app ->> rp: login
    alt relying party & eHealthID federation
        rp ->> fedmaster: fetch list of sectoral IDPs
        fedmaster -->> rp: list of sectoral IDPs
        rp -->> app: show list of IDPs to select from
        app ->> rp: select an IDP
        rp ->> secIdp: get redirect url (PAR)
        secIdp -->> rp: redirect_uri
        rp -->> app: redirect to sectoral authentication (e.g. ident app)
        alt proprietary flow
            app ->> secIdp: authenticate
            secIdp ->> app: success, redirect to relying party
        end
        app ->> rp: success, callback to relying party
        rp ->> secIdp: fetch id_token
        secIdp -->> rp: id_token
    end
    rp -->> app: redirect to IDP with code
    app ->> idp: success, callback to IDP
    idp ->> rp: redeem code
    alt client authentication
        note right of rp: client authenticated via 'private_key_jwt'
        rp ->> idp: fetch OpenID discovery document
        idp -->> rp: discovery document
        rp ->> idp: fetch JWKS
        idp -->> rp: JWKS
        note right of rp: verifies client JWT with discovered JWKS
    end
    rp -->> idp: id_token
    idp -->> app: success! redirect

Loading

Testing

See TESTING.

Limitations

• for now sessions are stored in-memory, this implies:
  • rebooting the server will force users currently logging-in to restart
  • if multiple instances run, sessions must be sticky (e.g. use session_id cookie)
  • though it would be relatively straight forward to use a database instead
• this is tested in the 'Testumgebung' (TU) against the Gematik IDP due to a lack of other options

Open Points

• end-to-end tests with Verimi, Gematik, RISE and IBM IDPs, most lack options to test currently

Wishlist

• Accept base URI's with paths.
• MySQL or Postgres backed session and code repos
• PKCE flow on OIDC side
• Integration with other IDPs such as FusionAuth

Helpful Links

• OpenID Federation Spec
• Gematik Fachdienst Specifications
• Gematik Fedmaster Specification
• Gematik Sectoral IDP Specifications
• AppFlow - Authentication flow to implement
• Sektoraler IDP - Examples & Reference Implementation