Skip to main content

Pinned to release v0.5.9. For the current default branch, see VC Configuration Reference.

Configuration Reference

Generated: 2026-05-18

Complete reference for all configuration parameters in the VC system.

Table of Contents

Environment Variables

These environment variables control service behavior outside of the YAML configuration file.

VariableDescriptionExample
VC_CONFIG_YAMLPath to the YAML configuration file. Each service reads this on startup.config.yaml
SSL_CERT_FILEPath to a CA certificate file that Go's crypto/x509 trusts for TLS verification. Required when services use self-signed or private CA certificates for inter-service HTTPS./pki/rootCA.crt

common (Top-level)

Shared configuration used across all services.

common

Path: .common

FieldTypeDescriptionExampleDefaultRequired
productionboolProduction mode-trueNo
logobjectLogging configuration--No
mongoobjectMongoDB configuration--No
tracingobjectOpenTelemetry tracing configuration--No
kafkaobjectKafka message broker configuration--No
secret_file_pathstringPath to a separate YAML file containing secrets; when set, secret values in config.yaml are cleared and only non-empty fields from the secrets file are applied."/etc/vc/secrets.yaml"-No
haobjectHigh-availability mode. When Enable is true, caches use MongoDB (Common.Mongo.URI) instead of in-memory storage so state is shared across instances.--No
brandingobjectCustom branding configuration (logo and favicon paths)--No
credential_metadataobjectOAuth2 scope values to their credential configuration, required by apigw, issuer, and verifier Key: OAuth2 scope (e.g., "pid", "ehic", "diploma") - matches AuthorizationContext.Scope Each entry contains the VCTM reference, format, and other configuration for that credential type--No

log

Path: .common.log

FieldTypeDescriptionExampleDefaultRequired
folder_pathstringPath to the log folder"/var/log/vc"-No

mongo

Path: .common.mongo

FieldTypeDescriptionExampleDefaultRequired
uristringMongoDB connection URI"mongodb://user:password@mongo:27017/vc"-Yes
tlsboolTLS for the MongoDB connection. Can also be enabled via the connection URI parameter "tls=true".-falseNo
ca_file_pathstringPath to a PEM-encoded CA certificate used to verify the MongoDB server's certificate. When empty, the system root CAs are used.--No
cert_file_pathstringPath to a PEM-encoded client certificate for mutual TLS (mTLS). Must be set together with KeyFilePath.--No
key_file_pathstringPath to a PEM-encoded client private key for mutual TLS (mTLS). Must be set together with CertFilePath.--No

tracing

Path: .common.tracing

FieldTypeDescriptionExampleDefaultRequired
enableboolEnable activates OpenTelemetry tracing-falseNo
addrstringOTEL collector address"jaeger:4318"-Yes (if enabled)
timeoutint64Timeout in seconds-10No

kafka

Path: .common.kafka

FieldTypeDescriptionExampleDefaultRequired
enableboolKafka integration-falseNo
brokers[]stringList of Kafka broker addresses["kafka0:9092", "kafka1:9092"]-Yes

ha

Path: .common.ha

FieldTypeDescriptionExampleDefaultRequired
enableboolHA mode; when true caches are backed by MongoDB instead of in-memory storage.-falseNo
cache_database_namestringMongoDB database name used for caches.-vc_cacheNo

branding

Path: .common.branding

FieldTypeDescriptionExampleDefaultRequired
logo_pathstringFile path to a custom logo PNG image; when empty, the built-in SUNET logo is used--No
favicon_pathstringFile path to a custom favicon PNG image; when empty, the built-in SUNET favicon is used--No

credential_metadata entry

Path: .common.credential_metadata.<credential scope>

https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-issuer-metadata-p

FieldTypeDescriptionExampleDefaultRequired
displayarrayDisplay: OPTIONAL. A non-empty array of objects, where each object contains the display properties of the supported Credential for a certain language.--No
claimsarrayClaims: OPTIONAL. A non-empty array of claims description objects as defined in Appendix B.2.--No

display entry

Path: .common.credential_metadata.<credential scope>.display[]

FieldTypeDescriptionExampleDefaultRequired
namestringName: REQUIRED. String value of a display name for the Credential.--Yes
localestringLocale: OPTIONAL. String value that identifies the language of this object represented as a language tag taken from values defined in BCP47 [RFC5646]. Multiple display objects MAY be included for separate languages. There MUST be only one object for each language identifier.--No
logoobjectLogo: OPTIONAL. Object with information about the logo of the Credential--No
descriptionstringDescription: OPTIONAL. String value of a description of the Credential.--No
background_colorstringBackgroundColor: OPTIONAL. String value of a background color of the Credential represented as numerical color values defined in CSS Color Module Level 37 [CSS-Color].--No
background_imageobjectBackgroundImage: OPTIONAL. Object with information about the background image of the Credential. At least the following parameter MUST be included:--No
text_colorstringTextColor: OPTIONAL. String value of a text color of the Credential represented as numerical color values defined in CSS Color Module Level 37 [CSS-Color].--No

Path: .common.credential_metadata.<credential scope>.display[].logo, .apigw.issuer_metadata.display[].logo

FieldTypeDescriptionExampleDefaultRequired
uristringURI: REQUIRED. String value that contains a URI where the Wallet can obtain the logo of the Credential Issuer. The Wallet needs to determine the scheme, since the URI value could use the https: scheme, the data: scheme, etc.--Yes
alt_textstringAltText: OPTIONAL. String value of the alternative text for the logo image.--No

background_image

Path: .common.credential_metadata.<credential scope>.display[].background_image

FieldTypeDescriptionExampleDefaultRequired
uristringURI REQUIRED. String value that contains a URI where the Wallet can obtain the background image of the Credential from the Credential Issuer. The Wallet needs to determine the scheme, since the URI value could use the https: scheme, the data: scheme, etc.--Yes

claims entry

Path: .common.credential_metadata.<credential scope>.claims[]

https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-claims-description-for-issu

FieldTypeDescriptionExampleDefaultRequired
path[]stringPath: REQUIRED. A non-empty array representing a claims path pointer that specifies the path to a claim within the credential.--Yes
mandatoryboolMandatory: OPTIONAL. Boolean which, when set to true, indicates that the Credential Issuer will always include this claim.--No
displayarrayDisplay: OPTIONAL. A non-empty array of objects containing display properties for the claim.--No

display entry

Path: .common.credential_metadata.<credential scope>.claims[].display[]

FieldTypeDescriptionExampleDefaultRequired
namestringName: OPTIONAL. String value of a display name for the claim.--No
localestringLocale: OPTIONAL. String value that identifies the language of this object.--No

apigw (Top-level)

Configuration for the API Gateway service that handles credential issuance requests.

apigw

Path: .apigw

FieldTypeDescriptionExampleDefaultRequired
api_serverobjectHTTP API server configuration--Yes
admin_ui_enableboolThe admin web UI. When false (default), the /ui routes are not registered. This must be explicitly set to true to enable the admin interface.-falseNo
key_configobjectSigning key configuration--Yes
data_sourcesobjectCredential types to their data sources--Yes
auth_providersobjectHow users authenticate (SAML, OIDC)--No
remotesobjectNamed external API connections referenced by DataSources.ExternalAPI"ladok"-No
deliveryobjectDelivery groups credential delivery to wallets (OpenID4VCI, credential offers)--Yes
issuer_metadataobjectOpenID4VCI issuer metadata--No
public_urlstringPublic URL of this service (must be valid HTTP/HTTPS URL)"https://issuer.sunet.se"-Yes
issuer_clientobjectGRPC client config for issuer--Yes
registry_clientobjectGRPC client config for registry--Yes
identity_mapping_importobjectAutomatic import of identity mappings from JSON files at startup. When configured, APIGW reads JSON files and imports them into the identity mappings collection on first startup (skipped if data already exists).--No
trustobjectTrust evaluation configuration for OpenID4VP credential validation. When configured, credentials presented via VP are validated against a PDP.--No

api_server

Path: .apigw.api_server, .issuer.api_server, .verifier.api_server, .registry.api_server

FieldTypeDescriptionExampleDefaultRequired
addrstringListen address for the HTTP server-:8080No
served_by_headerstringThe X-Served-By response header value for HA troubleshooting. Empty (default): header is not set. "hostname": uses os.Hostname(). Any other value is used as-is.--No
tlsobjectTLS--No
api_authobjectAPI Auth--No
corsobjectCORS--No
trust_proxy_tlsboolThe Secure flag on session cookies even when TLS is not enabled on this server. Use this when running behind a TLS-terminating reverse proxy.-falseNo

tls

Path: .apigw.api_server.tls, .issuer.api_server.tls, .verifier.api_server.tls, .registry.api_server.tls

FieldTypeDescriptionExampleDefaultRequired
enableboolTLS-falseNo
cert_file_pathstringPath to the TLS certificate--Yes
key_file_pathstringPath to the TLS private key--Yes

api_auth

Path: .apigw.api_server.api_auth, .issuer.api_server.api_auth, .verifier.api_server.api_auth, .registry.api_server.api_auth

JWKS and OIDC are mutually exclusive If neither is enabled, no authentication is applied (open access)

When Rules (and/or RulesFile) are configured, each authenticated request is checked against a SPOCP engine. A query of the form

(vc (service <SERVICE>)(method <HTTP_METHOD>)(path <REQUEST_PATH>)(subject <JWT_SUBJECT>))

is evaluated; the request is allowed only if a matching rule exists. The <SERVICE> value is supplied by the calling service at middleware registration time. When two services share endpoints, rules for one service do not grant access to the other. When no rules are configured, any valid Bearer JWT grants access.

FieldTypeDescriptionExampleDefaultRequired
jwksobjectStatic JWKS Bearer token authentication configuration When enabled, requests are validated against a manually configured JWKS URL--No
oidcobjectOIDC Bearer token authentication configuration When enabled, the JWKS endpoint is auto-discovered from the issuer's .well-known/openid-configuration and Bearer JWTs are validated locally The RP fields (client_id, redirect_uri, etc.) also enable the admin UI login flow via OIDC redirect--No
rules[]stringSPOCP S-expression authorization rules loaded into an in-process engine When non-empty the middleware builds a query per request and checks it Rules apply regardless of whether JWKS or OIDC is the active auth method["(vc (service apigw)(method POST)(path /api/v1/upload)(subject alice))"]-No
rules_filestringOptional path to a file containing SPOCP rules (one per line) Rules from this file are loaded in addition to the inline Rules list--No

jwks

Path: .apigw.api_server.api_auth.jwks, .issuer.api_server.api_auth.jwks, .verifier.api_server.api_auth.jwks, .registry.api_server.api_auth.jwks

FieldTypeDescriptionExampleDefaultRequired
enableboolStatic JWKS Bearer token authentication-falseNo
jwks_urlstringURL of the JSON Web Key Set used to validate token signatures"https://auth.example.com/.well-known/jwks.json"-Yes (if enabled)
issuerstringExpected "iss" claim. Tokens with a different issuer are rejected--Yes (if enabled)
audiencestringExpected "aud" claim. Tokens that do not contain this audience are rejected--Yes (if enabled)

oidc

Path: .apigw.api_server.api_auth.oidc, .issuer.api_server.api_auth.oidc, .verifier.api_server.api_auth.oidc, .registry.api_server.api_auth.oidc

It serves two purposes:

  • API auth: Bearer JWTs in Authorization headers are validated locally against the provider's JWKS (auto-discovered from IssuerURL).
  • Admin UI login: the RP fields (ClientID, RedirectURI, Scopes) enable an authorization-code redirect flow so admins log in via the OIDC provider.
FieldTypeDescriptionExampleDefaultRequired
enableboolOIDC authentication-falseNo
issuer_urlstringOIDC provider's issuer URL used for discovery and "iss" claim validation."https://auth.example.com"-Yes (if enabled)
audiencestringExpected "aud" claim. Tokens that do not contain this audience are rejected.--Yes (if enabled)
client_idstringOAuth2 client identifier registered with the OIDC provider.--Yes (if enabled)
client_secretstringOAuth2 client secret. May be empty for public clients.--No
redirect_uristringCallback URL for the admin UI OIDC login flow (e.g. "https://apigw.example.com/ui/callback")."https://apigw.example.com/ui/callback"-Yes (if enabled)
scopes[]stringOAuth2/OIDC scopes to request (default: ["openid"]).--No

cors

Path: .apigw.api_server.cors, .issuer.api_server.cors, .verifier.api_server.cors, .registry.api_server.cors

FieldTypeDescriptionExampleDefaultRequired
allowed_origins[]stringList of allowed CORS origins["https://wallet.sunet.se", "https://app.sunet.se"][]No

key_config

Path: .apigw.key_config, .issuer.key_config, .verifier.key_config, .registry.token_status_lists.key_config

Supports both file-based and HSM-based keys with explicit control.

FieldTypeDescriptionExampleDefaultRequired
private_key_pathstringFile-based configuration--Yes (if pkcs11 not set)
chain_pathstringPath to certificate chain (optional)--No
pkcs11objectHSM-based configuration--Yes (if private_key_path not set)
sourceobjectSource selection (determines which config to use) If empty, tries in order: File (if FilePath set), then HSM (if HSM set)--No
enable_fileboolFile-based key loading (default: true if FilePath set)--No
enable_hsmboolHSM-based key loading (default: true if HSM set)--No
priorityarrayFallback order when both are enabled If nil, uses Source field or auto-detects based on what's configured["hsm", "file"]-No

pkcs11

Path: .apigw.key_config.pkcs11, .issuer.key_config.pkcs11, .verifier.key_config.pkcs11, .registry.token_status_lists.key_config.pkcs11

FieldTypeDescriptionExampleDefaultRequired
module_pathstringPath to the PKCS#11 library"/usr/lib/softhsm/libsofthsm2.so"-No
slot_iduintHSM slot ID0-No
pinstringUser PIN for the slot"1234"-No
key_labelstringLabel of the key to use"my-signing-key"-No
key_idstringIdentifier for the JWT kid header"key-1"-No

data_sources

Path: .apigw.data_sources

Each key under a data source is a credential type.

FieldTypeDescriptionExampleDefaultRequired
datastoreobjectCredential types backed by a pre-loaded datastore (e.g. MongoDB)--No
assertionobjectCredential types backed by authentication assertions (SAML attributes or OIDC claims)--No
external_apiobjectCredential types backed by an external API Each credential references a named remote defined in APIGW.Remotes--No

datastore

Path: .apigw.data_sources.datastore

FieldTypeDescriptionExampleDefaultRequired
scopesobjectCredential scope names to their datastore configuration--No
importobjectAutomatic data import from JSON files at startup. When configured, APIGW reads JSON files and imports them into the datastore on first startup (skipped if data already exists).--No

scopes entry

Path: .apigw.data_sources.datastore.scopes.<credential scope>

FieldTypeDescriptionExampleDefaultRequired
auth_providerstringAuth provider for this credential type (openid4vp, saml, or oidc)--Yes
auth_claims[]stringThe normalized claim names used for datastore identity lookup. These names must match the BSON field names under "identities." in the datastore. Use attribute_mappings (in auth_providers) to normalize provider-specific attribute names (e.g. SAML urn:oid:2.5.4.42, eIDAS date_of_birth) to these canonical names. Available identity fields: given_name, family_name, birth_date, birth_place, authentic_source_person_id, personal_administrative_number.[given_name, family_name, birth_date]-No
auth_scopes[]stringCredential keys whose VCTs are acceptable for wallet authentication (for OpenID4VP)[pid]-No

import

Path: .apigw.data_sources.datastore.import

FieldTypeDescriptionExampleDefaultRequired
file_paths[]stringJSON files to import into the datastore. Each JSON file should contain a map of person IDs to CompleteDocument objects. Import is skipped if the datastore already contains data.["./bootstrapping/pid.json", "./bootstrapping/ehic.json"]-Yes
users[]stringUsers limits which person IDs to import. If empty, all persons are imported.["100", "102"]-No

assertion

Path: .apigw.data_sources.assertion

FieldTypeDescriptionExampleDefaultRequired
scopesobjectCredential scope names to their assertion configuration--No

scopes entry

Path: .apigw.data_sources.assertion.scopes.<credential scope>

The data comes directly from the SAML attributes or OIDC claims.

FieldTypeDescriptionExampleDefaultRequired
auth_providerstringAuth provider for this credential type (saml or oidc)--Yes

external_api

Path: .apigw.data_sources.external_api

FieldTypeDescriptionExampleDefaultRequired
scopesobjectCredential scope names to their external API configuration--No

scopes entry

Path: .apigw.data_sources.external_api.scopes.<credential scope>

FieldTypeDescriptionExampleDefaultRequired
remotestringName of a remote defined in Remotes--Yes
auth_providerstringAuth provider to identify the user (saml or oidc)--Yes
attribute_mappingobjectHow to map API response data to credential claims--No

attribute_mapping entry

Path: .apigw.data_sources.external_api.scopes.<credential scope>.attribute_mapping.<attribute>, .apigw.auth_providers.saml.attribute_mapping.<attribute>, .apigw.auth_providers.oidc.attribute_mapping.<attribute>

Generic across protocols (SAML, OIDC, etc.) - uses protocol-specific identifiers as keys

FieldTypeDescriptionExampleDefaultRequired
claimstringTarget claim name (supports dot-notation for nesting)"identity.given_name"-Yes
requiredboolRequired indicates if this attribute must be present in the assertion/response-falseNo
transformstringOptional transformation to apply Supported: "lowercase", "uppercase", "trim"--No
defaultstringOptional default value if attribute is missing--No

auth_providers

Path: .apigw.auth_providers

FieldTypeDescriptionExampleDefaultRequired
samlobjectThe SAML SP auth provider--No
oidcobjectThe OIDC RP auth provider--No

saml

Path: .apigw.auth_providers.saml

FieldTypeDescriptionExampleDefaultRequired
enableboolSAML support (default: false)-falseNo
entity_idstringSAML SP entity identifier (typically the metadata URL)"https://issuer.sunet.se/saml/metadata"-Yes (if enabled)
metadata_urlstringPublic URL where SP metadata is served (optional, auto-generated if empty)--No
mdq_serverstringBase URL for MDQ (Metadata Query Protocol) server (must end with /) Mutually exclusive with StaticIDPMetadata"https://md.sunet.se/entities/"-No
static_idp_metadataobjectA single static IdP as alternative to MDQ Mutually exclusive with MDQServer--No
certificate_pathstringPath to X.509 certificate for SAML signing/encryption TODO(pki): Migrate to pki.KeyConfig for consistency with other services and to enable HSM-backed SAML signing keys in the future.--Yes (if enabled)
private_key_pathstringPath to private key for SAML signing/encryption TODO(pki): See CertificatePath TODO — both fields would be replaced by a single KeyConfig.--Yes (if enabled)
acs_endpointstringAssertion Consumer Service URL where IdP sends SAML responses"https://issuer.sunet.se/saml/acs"-Yes (if enabled)
session_durationintMaximum time in seconds an in-flight SAML authentication flow (AuthnRequest → Response) may remain active before it expires-300No
attribute_mappingobjectAttributeMapping normalizes provider-specific attribute names (e.g. SAML OIDs) to canonical claim names. Applied to ALL attributes in the assertion. Which normalized attributes are used depends on the data source: - assertion: VCTM determines which go into the credential - datastore: auth_claims determines which are used for DB identity lookup--Yes (if enabled)
metadata_signing_cert_pathstringPath to the X.509 certificate used to verify metadata signatures. When set, all fetched metadata (MDQ and static) must carry a valid XML signature from this certificate.--No
metadata_cache_ttlintMetadataCacheTTL in seconds (default: 3600) - how long to cache IdP metadata from MDQ--No

static_idp_metadata

Path: .apigw.auth_providers.saml.static_idp_metadata

FieldTypeDescriptionExampleDefaultRequired
entity_idstringIdP entity identifier--Yes
metadata_pathstringFile path to IdP metadata XML (mutually exclusive with MetadataURL)--Yes (if metadata_url not set)
metadata_urlstringHTTP(S) URL to fetch IdP metadata from (mutually exclusive with MetadataPath)--No

oidc

Path: .apigw.auth_providers.oidc

FieldTypeDescriptionExampleDefaultRequired
enableboolOIDC RP support (default: false)-falseNo
registrationobjectHow the client obtains credentials from the OIDC Provider. Exactly one of preconfigured or dynamic must be set: - preconfigured: pre-registered client_id and client_secret - dynamic: RFC 7591 dynamic client registration (credentials obtained at startup)--Yes (if enabled)
redirect_uristringCallback URL where the OIDC Provider sends the authorization response"https://issuer.sunet.se/oidcrp/callback"-Yes (if enabled)
issuer_urlstringOIDC Provider's issuer URL for discovery Used for .well-known/openid-configuration discovery"https://accounts.google.com"-Yes (if enabled)
scopes[]stringOAuth2/OIDC scopes to request (at least one scope is required, e.g. "openid")-["openid", "profile", "email"]No
session_durationintMaximum time in seconds an in-flight OIDC authorization flow (state, nonce, PKCE verifier) may remain active before it expires-300No
client_namestringHuman-readable name for the OIDC client, shown during dynamic registration or consent--No
client_uristringURL to the client's homepage, used for display during consent--No
logo_uristringURL to the client's logo image, shown during consent screens--No
contacts[]stringList of email addresses for responsible parties of this client--No
tos_uristringURL to the client's Terms of Service document--No
policy_uristringURL to the client's Privacy Policy document--No
attribute_mappingobjectAttributeMapping normalizes OIDC claim names to canonical claim names. Optional: when omitted, OIDC claims pass through as-is (standard names already match). Which normalized attributes are used depends on the data source: - assertion: VCTM determines which go into the credential - datastore: auth_claims determines which are used for DB identity lookup--No

registration

Path: .apigw.auth_providers.oidc.registration

Exactly one of Preconfigured or Dynamic must be set.

FieldTypeDescriptionExampleDefaultRequired
preconfiguredobjectPreconfigured uses pre-registered client credentials. Set this when the client is already registered with the OIDC Provider.--Yes (if dynamic not set)
dynamicobjectDynamic uses RFC 7591 dynamic client registration. Set this when the client should register itself at startup.--Yes (if preconfigured not set)

preconfigured

Path: .apigw.auth_providers.oidc.registration.preconfigured

FieldTypeDescriptionExampleDefaultRequired
enableboolEnable activates preconfigured client credentials--No
client_idstringOIDC client identifier--Yes (if enabled)
client_secretstringOIDC client secret--Yes (if enabled)

dynamic

Path: .apigw.auth_providers.oidc.registration.dynamic

When set, client credentials are obtained automatically at startup and persisted in the database.

FieldTypeDescriptionExampleDefaultRequired
enableboolEnable activates dynamic client registration--No
initial_access_tokenstringBearer token for registration Required by some OIDC Providers (e.g., Keycloak)--Yes (if enabled)

remotes entry

Path: .apigw.remotes.<remote name>

FieldTypeDescriptionExampleDefaultRequired
typeobjectAPI protocol type--Yes
base_urlstringBase URL of the API endpoint"https://api.ladok.se/eduapi"-Yes
token_urlstringOAuth 2.0 token endpoint for Client Credentials Grant"https://api.ladok.se/oauth2/token"-Yes
client_idstringOAuth 2.0 client identifier--Yes
client_secretstringOAuth 2.0 client secret--Yes
scopes[]stringOAuth 2.0 scopes to request--No
timeoutdurationHTTP client timeout-10sNo

delivery

Path: .apigw.delivery

FieldTypeDescriptionExampleDefaultRequired
openid4vciobjectThe OpenID4VCI Authorization Server for wallet credential issuance--Yes
credential_offersobjectCredential offer wallet configurations--Yes

openid4vci

Path: .apigw.delivery.openid4vci

FieldTypeDescriptionExampleDefaultRequired
token_endpointstringOAuth2 token endpoint URL"https://verifier.sunet.se/token"-Yes
clientsobjectOAuth2 client configurations--Yes

clients entry

Path: .apigw.delivery.openid4vci.clients.<client id>, .verifier.inbound.openid4vp.clients.<client id>

FieldTypeDescriptionExampleDefaultRequired
typestringClient type per RFC 6749 Section 2.1 ("public" or "confidential"). Defaults to "public" since registered clients are wallets (native/web apps) that cannot securely store credentials and rely on PKCE instead.-publicNo
redirect_uristringAllowed redirect URI for the client"https://example.com/callback"-Yes
scopes[]stringList of OAuth2 scopes allowed for the client--Yes

credential_offers

Path: .apigw.delivery.credential_offers

FieldTypeDescriptionExampleDefaultRequired
issuer_urlstringIssuer URL for credential offers--Yes
walletsobjectWallet redirect configurations--Yes

wallets entry

Path: .apigw.delivery.credential_offers.wallets.<wallet name>

FieldTypeDescriptionExampleDefaultRequired
labelstringDisplay label for the wallet--Yes
redirect_uristringWallet redirect URI"eudi-wallet://credential-offer"-Yes

issuer_metadata

Path: .apigw.issuer_metadata

FieldTypeDescriptionExampleDefaultRequired
authorization_servers[]stringThe authorization server URLs--No
deferred_credential_endpointstringDeferred credential endpoint--No
notification_endpointstringNotification endpoint--No
cryptographic_binding_methods_supported[]stringThe supported binding methods--No
credential_signing_alg_values_supported[]stringThe supported signing algorithms--No
proof_signing_alg_values_supported[]stringThe supported proof algorithms--No
credential_response_encryptionobjectResponse encryption configuration--No
batch_credential_issuanceobjectBatch issuance configuration--No
displayarrayDisplay metadata--No

credential_response_encryption

Path: .apigw.issuer_metadata.credential_response_encryption

FieldTypeDescriptionExampleDefaultRequired
alg_values_supported[]stringAlgValuesSupported: REQUIRED. Array containing a list of the JWE [RFC7516] encryption algorithms (alg values) [RFC7518] supported by the Credential and Batch Credential Endpoint to encode the Credential or Batch Credential Response in a JWT [RFC7519].--Yes
enc_values_supported[]stringEncValuesSupported: REQUIRED. Array containing a list of the JWE [RFC7516] encryption algorithms (enc values) [RFC7518] supported by the Credential and Batch Credential Endpoint to encode the Credential or Batch Credential Response in a JWT [RFC7519].--Yes
encryption_requiredboolEncryptionRequired: REQUIRED. Boolean value specifying whether the Credential Issuer requires the additional encryption on top of TLS for the Credential Response. If the value is true, the Credential Issuer requires encryption for every Credential Response and therefore the Wallet MUST provide encryption keys in the Credential Request. If the value is false, the Wallet MAY chose whether it provides encryption keys or not.--No

batch_credential_issuance

Path: .apigw.issuer_metadata.batch_credential_issuance

FieldTypeDescriptionExampleDefaultRequired
batch_sizeintBatchSize: REQUIRED. Integer value specifying the maximum array size for the proofs parameter in a Credential Request.--Yes

display entry

Path: .apigw.issuer_metadata.display[]

FieldTypeDescriptionExampleDefaultRequired
namestringName: OPTIONAL. String value of a display name for the Credential Issuer.--No
localestringLocale: OPTIONAL. String value that identifies the language of this object represented as a language tag taken from values defined in BCP47 [RFC5646]. There MUST be only one object for each language identifier.--No
logoobjectLogo: OPTIONAL. Object with information about the logo of the Credential Issuer. Below is a non-exhaustive list of parameters that MAY be included:--No

issuer_client

Path: .apigw.issuer_client, .apigw.registry_client, .issuer.registry_client

FieldTypeDescriptionExampleDefaultRequired
addrstringGRPC server address"issuer:8090"-Yes
tlsboolTLS-falseNo
cert_file_pathstringClient certificate for mTLS--No
key_file_pathstringClient private key for mTLS--No
ca_file_pathstringCA certificate to verify the server--No
server_namestringServer name for TLS verification (optional)--No

identity_mapping_import

Path: .apigw.identity_mapping_import

FieldTypeDescriptionExampleDefaultRequired
file_paths[]stringJSON files containing identity mappings to import. Each JSON file should contain a map of person IDs to arrays of IdentityMapping objects. Import is skipped if the identity mappings collection already contains data.["./bootstrapping/identity_mappings.json"]-Yes
users[]stringUsers limits which person IDs to import. If empty, all persons are imported.["100", "102"]-No

trust

Path: .apigw.trust, .verifier.trust

This is used for validating W3C VC Data Integrity proofs and other trust-related operations.

Trust evaluation operates in one of two modes:

  • When PDPURL is configured: "default deny" mode - all trust decisions go through the PDP
  • When PDPURL is empty: "allow all" mode - keys are resolved but always considered trusted
FieldTypeDescriptionExampleDefaultRequired
pdp_urlstringURL of the AuthZEN PDP (Policy Decision Point) service for trust evaluation. When set, operates in "default deny" mode - trust decisions require PDP approval. When empty, operates in "allow all" mode - resolved keys are always considered trusted."https://trust.sunet.se/pdp"-No
local_did_methods[]stringWhich DID methods can be resolved locally without go-trust. Self-contained methods like "did:key" and "did:jwk" are always resolved locally.-["did:key", "did:jwk"]No
trust_policiesobjectPer-role trust evaluation policies. The key is the role (e.g., "issuer", "verifier") and the value contains policy settings.--No
allowed_signature_algorithms[]stringAllowedSignatureAlgorithms restricts which JWT signature algorithms are accepted. If empty, defaults to a secure set: ES256, ES384, ES512, RS256, RS384, RS512, PS256, PS384, PS512, EdDSA. The "none" algorithm is NEVER allowed regardless of configuration.["ES256", "ES384", "ES512", "EdDSA"]-No

trust_policies entry

Path: .apigw.trust.trust_policies.<role>, .verifier.trust.trust_policies.<role>

FieldTypeDescriptionExampleDefaultRequired
trust_frameworks[]stringThe accepted trust frameworks for this role.["did:web", "did:ebsi", "etsi-tl", "openid-federation", "x509"]-No
trust_anchors[]stringTrusted root entities for this role. Format depends on the trust framework (e.g., DID for did:web, federation entity for OpenID Fed).--No
require_revocation_checkboolRequireRevocationCheck enforces revocation status checking for this role. Default: false-falseNo

issuer (Top-level)

Configuration for the Issuer service that signs and issues verifiable credentials.

issuer

Path: .issuer

FieldTypeDescriptionExampleDefaultRequired
api_serverobjectHTTP API server configuration--Yes
grpc_serverobjectGRPC server configuration--Yes
key_configobjectSigning key configuration--Yes
jwt_attributeobjectJWT credential attribute configuration--Yes
issuer_urlstringIssuer identifier URL"https://issuer.sunet.se"-Yes
registry_clientobjectRegistry gRPC client config--No
mdocobjectMDL/mdoc configuration--No
audit_logobjectAudit log configuration--No

grpc_server

Path: .issuer.grpc_server, .registry.grpc_server

FieldTypeDescriptionExampleDefaultRequired
addrstringGRPC server listen address-:8090No
tlsobjectMTLS configuration--No

tls

Path: .issuer.grpc_server.tls, .registry.grpc_server.tls

FieldTypeDescriptionExampleDefaultRequired
enableboolEnable-falseNo
cert_file_pathstringServer certificate-/pki/grpc_server.crtYes (if enabled)
key_file_pathstringServer private key-/pki/grpc_server.keyYes (if enabled)
client_ca_pathstringCA to verify client certificates (for mTLS)-/pki/client_ca.crtYes (if enabled)
allowed_client_fingerprintsobjectSHA256 fingerprint -> friendly namea1b2c3...: issuer-prod-No
allowed_client_dnsobjectFriendly name -> Certificate Subject DNapigw-prod: CN=apigw,O=SUNET-No

jwt_attribute

Path: .issuer.jwt_attribute

In a later state this should be placed under authentic source in order to issue credentials based on that configuration.

FieldTypeDescriptionExampleDefaultRequired
issuerstringIssuer of the tokenhttps://issuer.sunet.se-Yes
static_hoststringStatic host of the issuer, expose static files, like pictures.--No
enable_not_beforeboolThe time not before which the token is valid-falseNo
valid_durationint64Valid duration of the token in seconds-3600No
verifiable_credential_typestringVerifiableCredentialType URLhttps://credential.sunet.se/identity_credential-Yes
statusstringStatus status of the Verifiable Credential--No
kidstringKid key id of the signing key--No

mdoc

Path: .issuer.mdoc

FieldTypeDescriptionExampleDefaultRequired
certificate_chain_pathstringPath to the PEM certificate chain TODO(pki): Consider folding into pki.KeyConfig.ChainPath to unify certificate chain loading with the standard key material configuration pattern.--Yes
default_validitydurationDefault credential validity (default: 365 days)-8760hNo
digest_algorithmstringDigest algorithm: "SHA-256", "SHA-384", or "SHA-512"-SHA-256No

audit_log

Path: .issuer.audit_log

FieldTypeDescriptionExampleDefaultRequired
enableboolAudit logging-falseNo
destinations[]stringList of log destinations (console/stdout, file path, or HTTP URL)["stdout", "/var/log/audit.log", "https://audit.sunet.se/webhook"]-Yes (if enabled)
file_sync_intervaldurationFsync behavior for file destinations. 0 = fsync after every write (strict durability, lower throughput). >0 = periodic batched fsync at the given interval (better throughput, bounded data-loss window). Has no effect on console or webhook destinations.-5sNo

verifier (Top-level)

Configuration for the Verifier service that verifies credentials and acts as an OIDC Provider.

verifier

Path: .verifier

FieldTypeDescriptionExampleDefaultRequired
api_serverobjectHTTP API server configuration--Yes
public_urlstringPublic URL of this service (must be valid HTTP/HTTPS URL)"https://verifier.sunet.se"-Yes
key_configobjectSigning key configuration--Yes
preferred_vp_formatsobjectInformational VP formats and algorithms supported by wallets--No
supported_walletsobjectSupported wallet configurations--No
inboundobjectInbound groups inbound credential verification--No
outboundobjectOutbound groups outbound identity assertion--No
digital_credentialsobjectW3C Digital Credentials API configuration--No
authorization_page_cssobjectAuthorization page styling configuration--No
credential_displayobjectCredential display settings--No
trustobjectTrust evaluation configuration--No

preferred_vp_formats

Path: .verifier.preferred_vp_formats

Used in client_metadata and Wallet metadata to indicate supported formats and algorithms.

FieldTypeDescriptionExampleDefaultRequired
ldp_vcobjectConfiguration for W3C VC Data Integrity format (ldp_vc)--No
jwt_vc_jsonobjectConfiguration for JWT-based W3C VC format (jwt_vc_json)--No
dc+sd-jwtobjectConfiguration for SD-JWT VC format (dc+sd-jwt)--No
mso_mdocobjectConfiguration for ISO mdoc format (mso_mdoc)--No

ldp_vc

Path: .verifier.preferred_vp_formats.ldp_vc

FieldTypeDescriptionExampleDefaultRequired
proof_type_values[]stringNon-empty array containing identifiers of proof types supported. If present, the proof type of the presented VC/VP MUST match one of the array values.["DataIntegrityProof", "Ed25519Signature2020"]-No
cryptosuite_values[]stringNon-empty array containing identifiers of crypto suites supported. Used when one of the algorithms in ProofTypeValues supports multiple crypto suites.["ecdsa-rdfc-2019", "ecdsa-sd-2023", "eddsa-rdfc-2022", "bbs-2023"]-No

jwt_vc_json

Path: .verifier.preferred_vp_formats.jwt_vc_json

FieldTypeDescriptionExampleDefaultRequired
alg_values[]stringNon-empty array containing identifiers of cryptographic algorithms supported. If present, the alg JOSE header of the presented VC/VP MUST match one of the array values.--No

dc+sd-jwt

Path: .verifier.preferred_vp_formats.dc+sd-jwt

FieldTypeDescriptionExampleDefaultRequired
sd-jwt_alg_values[]stringNon-empty array containing cryptographic algorithm identifiers supported for the Issuer-signed JWT of an SD-JWT.--No
kb-jwt_alg_values[]stringNon-empty array containing cryptographic algorithm identifiers supported for a Key Binding JWT (KB-JWT).--No

mso_mdoc

Path: .verifier.preferred_vp_formats.mso_mdoc

FieldTypeDescriptionExampleDefaultRequired
issuerauth_alg_values[]intNon-empty array containing cryptographic algorithm identifiers supported for IssuerAuth COSE signatures.--No
deviceauth_alg_values[]intNon-empty array containing cryptographic algorithm identifiers supported for DeviceAuth COSE signatures or MACs.--No

inbound

Path: .verifier.inbound

FieldTypeDescriptionExampleDefaultRequired
openid4vpobjectOpenID4VP configuration for accepting wallet presentations--Yes

openid4vp

Path: .verifier.inbound.openid4vp

FieldTypeDescriptionExampleDefaultRequired
presentation_timeoutintPresentation timeout in seconds-300No
supported_credentialsarraySupported credential configurations--Yes
presentation_requests_dirstringOptional directory with presentation request templates--No
token_endpointstringOAuth2 token endpoint URL used for VP token exchange"https://verifier.sunet.se/token"-Yes
clientsobjectOAuth2 client configurations for RP interactions--Yes

supported_credentials entry

Path: .verifier.inbound.openid4vp.supported_credentials[]

FieldTypeDescriptionExampleDefaultRequired
vctstringVerifiable credential type"urn:eudi:pid:1"-Yes
scopes[]stringOIDC scopes that grant access to this credential--Yes

outbound

Path: .verifier.outbound

FieldTypeDescriptionExampleDefaultRequired
oidc_providerobjectOIDC Provider configuration for asserting verified identity to downstream RPs--No

oidc_provider

Path: .verifier.outbound.oidc_provider

This configures how the verifier issues ID tokens and access tokens to relying parties. Note: This is NOT related to verifiable credential issuance (see IssuerConfig for VC issuance). The signing key is shared from the parent Verifier.KeyConfig.

FieldTypeDescriptionExampleDefaultRequired
issuerstringOIDC Provider identifier that appears in ID tokens and discovery metadata. This identifies the verifier as an OpenID Provider. Must match the 'iss' claim in all issued ID tokens."https://verifier.sunet.se"-Yes
enable_userinfoboolWhen true, the OP advertises a userinfo_endpoint in discovery and issues JWT access tokens (RFC 9068). When false (default), only ID tokens are returned — no access_token, refresh_token, or userinfo endpoint.truefalseNo
session_durationintSession duration in seconds-3600No
code_durationintAuthorization code duration in seconds-300No
access_token_durationintAccess token duration in seconds (only used when enable_userinfo is true)-3600No
id_token_durationintID token duration in seconds-3600No
refresh_token_durationintRefresh token duration in seconds-86400No
subject_typestringSubject type: "public" or "pairwise"--Yes
subject_saltstringSalt for pairwise subject generation--Yes
static_clientsarrayList of pre-configured OIDC clients These clients are checked in addition to dynamically registered clients--No

static_clients entry

Path: .verifier.outbound.oidc_provider.static_clients[]

Static clients are configured in YAML and do not require dynamic registration. These clients are checked in addition to dynamically registered clients stored in the database.

FieldTypeDescriptionExampleDefaultRequired
client_idstringUnique identifier for the client--Yes
client_secretstringClient secret for authentication. Can be defined in the secrets file under verifier.oidc_op.static_clients as a map of client_id to client_secret. Required unless TokenEndpointAuthMethod is "none" (public client).--No
redirect_uris[]stringList of allowed redirect URIs for this client--Yes
allowed_scopes[]stringList of scopes this client is allowed to request. If empty, defaults to standard OIDC scopes (openid, profile, email, address, phone).--No
token_endpoint_auth_methodstringAuthentication method for the token endpoint. Supported values: client_secret_basic, client_secret_post, none (public client) Default: "client_secret_basic"-client_secret_basicNo
grant_types[]stringList of allowed grant types. Supported values: authorization_code, refresh_token Default: ["authorization_code"]-["authorization_code"]No
response_types[]stringList of allowed response types. Supported values: code Default: ["code"]-["code"]No
client_namestringOptional human-readable name for the client--No

digital_credentials

Path: .verifier.digital_credentials

FieldTypeDescriptionExampleDefaultRequired
enableboolW3C Digital Credentials API support in browser-falseNo
use_jarboolJWT Authorization Request (JAR) for wallet communication When true, request objects are signed JWTs instead of plain JSON-falseNo
preferred_formats[]stringThe order of preference for credential formats Supported values: "vc+sd-jwt", "dc+sd-jwt", "mso_mdoc" Default: ["vc+sd-jwt", "dc+sd-jwt", "mso_mdoc"]-["vc+sd-jwt", "dc+sd-jwt", "mso_mdoc"]No
response_modestringThe OpenID4VP response mode for DC API flows Supported values: "dc_api.jwt" (encrypted), "direct_post.jwt" (signed), "direct_post" Default: "dc_api.jwt"-dc_api.jwtNo
allow_qr_fallbackboolAutomatic fallback to QR code if DC API is unavailable Default: true-trueNo
deep_link_schemestringDeepLinkScheme for mobile wallet integration"eudi-wallet://"-No

authorization_page_css

Path: .verifier.authorization_page_css

FieldTypeDescriptionExampleDefaultRequired
custom_cssstringInline CSS that will be injected into the authorization page Allows deployers to override default styling without modifying templates--No
css_filestringPath to an external CSS file to include If both CustomCSS and CSSFile are provided, both are included--No
themestringPredefined color scheme: "light" (default), "dark", "blue", "purple"-lightNo
primary_colorstringPrimaryColor overrides the primary brand color"#667eea"-No
secondary_colorstringSecondaryColor overrides the secondary brand color"#764ba2"-No
logo_urlstringA URL to a custom logo image--No
titlestringTitle overrides the page title (default: "Wallet Authorization")--No
subtitlestringSubtitle overrides the page subtitle--No

credential_display

Path: .verifier.credential_display

FieldTypeDescriptionExampleDefaultRequired
enableboolUsers to optionally view credential details before completing authorization When enabled, a checkbox appears on the authorization page-falseNo
require_confirmationboolUsers to review credentials before proceeding When true, the credential display step is mandatory (checkbox is pre-checked and disabled)-falseNo
show_raw_credentialboolThe raw VP token/credential in the display page Useful for debugging and technical users-falseNo
show_claimsboolThe parsed claims that will be sent to the RP Recommended for transparency and user consent-trueNo
allow_editboolUsers to redact certain claims before sending to RP (future feature) Currently not implemented-falseNo

registry (Top-level)

Configuration for the Registry service that manages credential status.

registry

Path: .registry

FieldTypeDescriptionExampleDefaultRequired
api_serverobjectHTTP API server configuration--Yes
public_urlstringPublic URL of this service (must be valid HTTP/HTTPS URL)"https://registry.sunet.se"-Yes
grpc_serverobjectGRPC server configuration--Yes
token_status_listsobjectToken Status List configuration--Yes
admin_guiobjectAdmin GUI configuration--No

token_status_lists

Path: .registry.token_status_lists

FieldTypeDescriptionExampleDefaultRequired
key_configobjectKey configuration for signing Token Status List tokens.--Yes
token_refresh_intervalint64How often (in seconds) new Token Status List tokens are generated. Default: 43200 (12 hours). Min: 301 (>5 minutes), Max: 86400 (24 hours)-43200No
section_sizeint64Number of entries (decoys) per section. Default: 1000000 (1 million)-1000000No
rate_limit_requests_per_minuteintMaximum requests per minute per IP for token status list endpoints. Default: 60-60No

admin_gui

Path: .registry.admin_gui

FieldTypeDescriptionExampleDefaultRequired
enableboolThe admin GUI-falseNo
usernamestringAdmin username-adminYes (if enabled)
passwordstringAdmin password--Yes (if enabled)

Secrets File Reference

The structure of the separate secrets file.

Secrets file structure

Path: (root)

When Common.SecretFilePath is set, secret values in config.yaml are cleared; only non-empty fields from this file are applied. Fields omitted or left empty here remain at their zero value.

FieldTypeDescriptionExampleDefaultRequired
commonobjectCommon--No
apigwobjectAPIGW--No
registryobjectRegistry--No
verifierobjectVerifier--No

common

Path: .common

FieldTypeDescriptionExampleDefaultRequired
mongoobjectMongo--No

mongo

Path: .common.mongo

FieldTypeDescriptionExampleDefaultRequired
uristringMongoDB connection string, which may include authentication credentials--No

apigw

Path: .apigw

FieldTypeDescriptionExampleDefaultRequired
api_serverobjectAPI Server--No
auth_providersobjectAuth Providers--No

api_server

Path: .apigw.api_server

FieldTypeDescriptionExampleDefaultRequired
api_authobjectAPI Auth--No

api_auth

Path: .apigw.api_server.api_auth

FieldTypeDescriptionExampleDefaultRequired
oidcobjectOIDC--No

oidc

Path: .apigw.api_server.api_auth.oidc

FieldTypeDescriptionExampleDefaultRequired
client_secretstringOAuth2 client secret for the OIDC provider--No

auth_providers

Path: .apigw.auth_providers

FieldTypeDescriptionExampleDefaultRequired
oidcobjectOIDC--No

oidc

Path: .apigw.auth_providers.oidc

FieldTypeDescriptionExampleDefaultRequired
registrationobjectRegistration--No

registration

Path: .apigw.auth_providers.oidc.registration

FieldTypeDescriptionExampleDefaultRequired
preconfiguredobjectPreconfigured--No
dynamicobjectDynamic--No

preconfigured

Path: .apigw.auth_providers.oidc.registration.preconfigured

FieldTypeDescriptionExampleDefaultRequired
client_secretstringShared secret for the pre-configured OIDC RP client--No

dynamic

Path: .apigw.auth_providers.oidc.registration.dynamic

FieldTypeDescriptionExampleDefaultRequired
initial_access_tokenstringBearer token required by the OP for dynamic client registration--No

registry

Path: .registry

FieldTypeDescriptionExampleDefaultRequired
admin_guiobjectAdmin GUI--No

admin_gui

Path: .registry.admin_gui

FieldTypeDescriptionExampleDefaultRequired
passwordstringAdmin GUI login password--No

verifier

Path: .verifier

FieldTypeDescriptionExampleDefaultRequired
outboundobjectOutbound--No

outbound

Path: .verifier.outbound

FieldTypeDescriptionExampleDefaultRequired
oidc_providerobjectOIDC Provider--No

oidc_provider

Path: .verifier.outbound.oidc_provider

FieldTypeDescriptionExampleDefaultRequired
subject_saltstringSecret value used to derive pairwise subject identifiers for OIDC clients--No
static_clientsobjectClient_id to client_secret for static OIDC clients. Only clients listed here will have their secrets applied; clients not present in this map keep whatever value the main config provides (which will be empty after ClearSecrets).<client_id>: "<client_secret>"-No

Example secrets.yaml

Path: file referenced by .common.secret_file_path

common:
mongo:
uri: "mongodb://user:password@mongo:27017/vc"
apigw:
api_server:
api_auth:
oidc:
client_secret: "your-oidc-client-secret"
auth_providers:
oidc:
registration:
preconfigured:
client_secret: "your-oidc-client-secret"
dynamic:
initial_access_token: "<secret-value>"
registry:
admin_gui:
password: "change-me-in-production"
verifier:
outbound:
oidc_provider:
subject_salt: "random-salt-for-pairwise-subjects"
static_clients:
<client_id>: "<client_secret>"