Every configuration key
This page shows the shipped ferroehr.toml template, ferroehr.default.toml. It
holds every key FerroEHR reads, each under its description with its default.
tools/config-reference generates it from the configuration types, so it matches the server you
run.
- The file opens with What you must set: the keys a deployment that holds real data sets. Every other key is optional, and its note says so.
- Each key’s note ends with whether you must set it and why it is a key: infrastructure, trust, or neither for a tuning key with a built-in default.
- Only the keys of What you must set are live lines, so a copy of the file sets nothing else.
- Every other key is a
#?line, showing its default or, for a key with no default or a secret, a placeholder. Remove the#?marker and the space after it, then edit the value, to set it. - A
# [table.<name>]header shows a table you name yourself, with its keys commented out.
Every key can also be set as an environment variable: FERROEHR, then the TOML path with __
between the segments, such as FERROEHR__DATABASE__MAX_CONNECTIONS. The guides under
Configuration reference explain the sections.
# @generated by tools/config-reference from the configuration types. DO NOT EDIT.
# SPDX-FileCopyrightText: Cadasto B.V.
# SPDX-License-Identifier: BUSL-1.1
#
# ferroehr.toml: every key FerroEHR reads, each under its description. Copy
# this file to ferroehr.toml and set the keys the "What you must set" block
# names, which are its only live lines. Every other key is a `#?` line that
# shows its default, or a placeholder where it has none: remove `#? ` and edit
# the value to set it. A line marked `#` under a `# [table.<name>]` header
# shows a table you name yourself.
#
# A duration is a string with its unit ("500ms", "30s", "10min", "12h",
# "7d"), a size a string with an IEC binary unit ("64MiB"). Each key can
# also be set as FERROEHR__<TABLE>__<KEY>, such as
# FERROEHR__DATABASE__MAX_CONNECTIONS; `--set key=value` wins over it.
#
# What you must set
#
# This file lists 851 keys. A deployment that holds real data sets the 10
# below, the only live lines; every other key is optional and runs on the
# built-in default its `#?` line shows, or stays unset where its note says so.
#
# [deployment] profile
# [[auth.issuer]] issuer, kind, audience
# [authz.party_binding.provider] issuer, id
# [api] system_id
# [database] url
# [privacy] subject_namespaces
# [record] subject_index
#
# Each note ends with why the key is in the file: infrastructure (what the
# server needs before it reaches its store), trust (what it trusts, its floors
# and its secrets), or nothing more for a tuning key.
# The declared posture, the openEHR specification set and the licence token.
[deployment]
# The declared posture (`sandbox` | `production`; default `sandbox`).
# `production` refuses to start while a separation it asserts is missing and
# not accepted by name (#3226). Must set (infrastructure).
profile = "sandbox"
# The `DeploymentGap`s a `production` deployment runs without, each stated on
# every boot and on `/management/status`. Ignored under `sandbox`, which
# accepts everything. Optional (infrastructure).
#? accepts = []
# The openEHR specification generation set the server runs (`development` |
# `stable`; default `development`). Optional (infrastructure).
#? spec_profile = "development"
# The commercial licence token file the licensor issued. Optional in every
# respect: an unset, missing, malformed or expired token is logged once at boot
# and the server runs unlicensed, identically in every other way. Optional,
# unset by default (infrastructure).
#? licence_file = ""
# The HTTP listener: the family's section (the listen address, the timeouts,
# the body limit, the overload bound, the drain, TLS, the trusted proxies, the
# caller rate and compression) and the public base URL every public URL derives
# from.
#? [server]
# The socket address the listener binds. Optional (infrastructure).
#? listen = "0.0.0.0:8080"
# The path every route is served under: empty, or starting with `/` and not
# ending with one. Optional (infrastructure).
#? base_path = ""
# How long one request may take before the server answers `408`. Optional
# (infrastructure).
#? request_timeout = "30s"
# How long a client may take to send its first byte once it connected, and each
# HTTP/1.1 request head from that head's first byte; a client still sending its
# head then is disconnected, which bounds a connection that never finishes one.
# Never zero. Optional (infrastructure).
#? header_read_timeout = "30s"
# How long a kept-alive HTTP/1.1 connection may wait for its next request
# before the server closes it. Keep it longer than the idle timeout of the
# clients and proxies in front, so they close an idle connection first. Never
# zero. Optional (infrastructure).
#? idle_timeout = "2min"
# The largest request body the server reads before answering `413`. Optional
# (infrastructure).
#? body_limit = "64MiB"
# How long readiness stays withdrawn before the listener closes, so an
# orchestrator stops sending requests first. Optional (infrastructure).
#? drain_delay = "0s"
# How long the requests in flight may take once the listener closed. Optional
# (infrastructure).
#? shutdown_timeout = "10s"
# How many requests the server serves at once; past it a request waits for a
# slot in the queue `max_waiting_requests` bounds, and is answered `503` with
# `Retry-After` when the queue is full or the wait expires, so offered load
# beyond capacity cannot grow the server's memory. Always bounded, 256 by
# default (`DEFAULT_MAX_CONCURRENT_REQUESTS`); never zero. Optional
# (infrastructure).
#? max_concurrent_requests = 256
# How many requests past `max_concurrent_requests` may wait for a slot at once,
# first come first served; zero keeps no queue and refuses a request past the
# bound at once. 256 by default, the default of `max_concurrent_requests`, so
# the requests held never exceed twice the bound (no specification governs
# this: our own design). Optional (infrastructure).
#? max_waiting_requests = 256
# How long a request past `max_concurrent_requests` waits for a slot before it
# is answered `503`; zero keeps no queue. 100 ms by default: FerroEHR's
# server-side stalls of 110 to 150 ms at 2000 rps (a WAL flush) are mostly
# drained within it, and a client waits little longer for a refusal (no
# specification governs this: our own design). The wait counts in the request's
# latency. Optional (infrastructure).
#? admission_wait = "100ms"
# How long a refused request is told to wait (`Retry-After`), a whole number of
# seconds, since the header carries delay-seconds (RFC 9110 §10.2.3). Optional
# (infrastructure).
#? retry_after = "1s"
# The reverse proxies whose forwarded client address is believed, each an
# address or a CIDR block; empty, every request is named by its peer. Optional
# (infrastructure).
#? trusted_proxies = []
# The header a trusted proxy names the client in. Optional (infrastructure).
#? forwarded_header = "forwarded"
# Whether a response is compressed with gzip or Brotli when the client accepts
# one. Optional (infrastructure).
#? compression = true
# The smallest response body that is compressed. Optional (infrastructure).
#? compression_min_size = "1KiB"
# The URL clients reach this listener at, through any proxy in front of it:
# `https://cdr.example.com`, or with a path when a proxy serves the server
# under one. Every public URL derives from it, after `server.base_path`: the
# SMART discovery document's `baseUrl` (it, `base_path` and `api.base_path`),
# every SCIM `meta.location` (it, `base_path` and `/scim/v2`) and the URL a
# `DPoP` proof's `htu` is compared with (it, `base_path` and the request path,
# RFC 9449 §4.3). An absolute `http(s)` URL with no userinfo, query or
# fragment; required with `auth.smart.discovery`, `[auth.scim]` or
# `[auth.dpop]`. Optional, unset by default (infrastructure).
#? public_base_url = ""
# The listener's TLS; unset, the listener speaks plain HTTP behind a proxy that
# terminates TLS.
#? [server.tls]
# The certificate chain, the leaf first. Required in its table
# (infrastructure).
#? certificate_file = ""
# The private key of the leaf. Required in its table (infrastructure).
#? key_file = ""
# Whether the listener asks a client certificate. Optional (infrastructure).
#? client_auth = "none"
# The CA bundle a client certificate must chain to; required unless
# `client_auth` is `none`, and refused when it is. Optional, unset by default
# (infrastructure).
#? client_ca_file = ""
# How often the files are read again, never zero; unset, only `SIGHUP` reads
# them again. Optional, unset by default (infrastructure).
#? reload_interval = "500ms"
# The client certificate chain and key, in one PEM, the healthcheck presents to
# a listener that asks one. Optional, unset by default (infrastructure).
#? healthcheck_identity_file = ""
# The oldest TLS version the listener speaks: `"1.3"` unless lowered to
# `"1.2"`. Optional (infrastructure).
#? min_version = "1.3"
# The requests one caller may send; unset, a caller is not limited.
#? [server.caller_rate]
# The requests per second a caller may send once its burst is spent. Required
# in its table (infrastructure).
#? requests_per_second = 0
# The requests a caller may send at once. Required in its table
# (infrastructure).
#? burst = 0
# The console, the request log and the OpenTelemetry export, the family's
# shared section.
#? [telemetry]
# The console rendering. Optional (infrastructure).
#? format = "auto"
# The `tracing` filter directive of the console. Optional (infrastructure).
#? filter = "info,hyper=warn,tower=warn,h2=warn"
# The query parameters whose values the request log may carry; empty, it
# carries none. Optional (infrastructure).
#? logged_query_parameters = []
# The deployment environment, `deployment.environment.name` on the resource,
# such as `production`. Optional, unset by default (infrastructure).
#? environment = ""
# The OTLP collector, when spans and metrics are exported.
#? [telemetry.otlp]
# The collector's OTLP/gRPC endpoint; `https://` speaks TLS. It may carry a
# credential, so it renders masked. Optional (infrastructure).
#? endpoint = ""
# Whether the product's spans are exported. Optional (infrastructure).
#? traces = true
# Whether the metrics are pushed. Optional (infrastructure).
#? metrics = true
# The share of the server's traces that are sampled. Optional (infrastructure).
#? sample_ratio = 1.0
# The TLS to the collector: trust roots beside the platform's, the client
# identity for mutual TLS and the minimum version. The crate reads none of it:
# the product reads the table with `ferrohealth-server`'s `TlsClient` and hands
# the built configuration to `Telemetry::with_tls`. TLS material is refused
# beside an endpoint that is not `https://`.
#? [telemetry.otlp.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The installation report to `FerroPULSE` (on by default).
#? [usage_report]
# The off switch: `false` sends nothing. Optional (infrastructure).
#? enabled = true
# The collector. Optional (infrastructure).
#? endpoint = "https://report.ferropulse.eu/v1/report"
# The directory the instance id lives in; without one nothing is sent, since
# every restart would count as a new installation. Optional, unset by default
# (infrastructure).
#? state_dir = ""
# How the product is deployed. Optional (infrastructure).
#? deployment = "unknown"
# Authentication: the `ferrohealth-smart` section, whose serialization writes
# every secret as `***`, `[auth.idp]`, `[auth.smart]` and `[auth.scim]`.
#? [auth]
# Whether inbound authentication is on; a product may refuse `false`. Optional
# (trust).
#? enabled = true
# The realm the challenges name; empty for none, which a product replaces with
# its own default. Optional.
#? realm = ""
# The SMART capabilities the discovery document adds, each a capability SMART
# App Launch 2.2.0 or the SMART on openEHR draft defines, or a full URI.
# Optional.
#? capabilities = []
# The scopes the discovery document lists as `scopes_supported`: only scopes
# the product honours, because "the server SHALL support all scopes listed
# here". Optional.
#? scopes_supported = []
# The issuer the discovery document describes; absent for the one issuer the
# rule of `crate::resource::described` picks. It renders with any userinfo
# masked. Optional, unset by default (trust).
#? described_issuer = ""
# The product's own scope, a full URI or a string starting with `__`; empty for
# none. Optional (trust).
#? product_scope = ""
# The `[auth.issuer]` tables, each issuer with its own settings.
#? [[auth.issuer]]
# The issuer identifier. It renders with any userinfo masked, as `SecretUrl`
# renders itself. Must set (trust).
#? issuer = ""
# Whose tokens the issuer signs; required, with no default. Must set (trust).
#? kind = "persons"
# The preset the profile starts from. Optional (trust).
#? profile = "rfc9068"
# The audiences, of which a token's `aud` must contain one. Must set (trust).
#? audience = []
# The signature algorithms admitted. Optional (trust).
#? algorithms = ["RS256", "RS384", "PS256", "PS384", "ES256", "ES384"]
# The clock skew, at most `300s`. Optional (trust).
#? clock_skew = "1min"
# How long a held key set is used. Optional (trust).
#? jwks_max_age = "10min"
# The shortest time between two reads of the key set. Optional (trust).
#? jwks_refresh_interval = "1min"
# A key set file handed over out of band, in place of the issuer's `jwks_uri`;
# empty for none. Optional (trust).
#? jwks_file = ""
# How long one call to the authorization server may take. Optional (trust).
#? timeout = "10s"
# How the issuer's tokens are checked. Optional (trust).
#? mode = "jwt"
# Whether the issuer's tokens must be bound to a `DPoP` key or a client
# certificate: `none` (the default) or `required` (`crate::sender`). Optional
# (trust).
#? sender_constraint = "none"
# The claims the issuer's roles are read from, each a dotted path that
# `crate::roles` reads, a claim name with dots included; by default `roles`,
# `groups` and `entitlements` (RFC 9068 §2.2.3.1), and none, never settable,
# on a `federation` issuer. Optional, unset by default (trust).
#? role_claims = []
# `ProfileKeys::person_key`. Optional, unset by default (trust).
#? person_key = ""
# `ProfileKeys::tenant_claim`. Optional, unset by default (trust).
#? tenant_claim = ""
# `ProfileKeys::client_claims`. Optional, unset by default (trust).
#? client_claims = []
# `ProfileKeys::impersonation_marker`. Optional, unset by default (trust).
#? impersonation_marker = ""
# `ProfileKeys::expect`. Optional, unset by default (trust).
#? expect = {}
# `ProfileKeys::user_claims`. Optional, unset by default (trust).
#? user_claims = []
# `ProfileKeys::person_equality`. Optional, unset by default (trust).
#? person_equality = []
# `ProfileKeys::unstable_claims`. Optional, unset by default (trust).
#? unstable_claims = []
# `ProfileKeys::onward_preview`. Optional, unset by default (trust).
#? onward_preview = []
# `ProfileKeys::onward_subject_audience`. Optional, unset by default (trust).
#? onward_subject_audience = false
# `ProfileKeys::max_actor_chain`. Optional, unset by default (trust).
#? max_actor_chain = 0
# `ProfileKeys::act_represents_patient`. Optional, unset by default (trust).
#? act_represents_patient = false
# `ProfileKeys::token_types`. Optional, unset by default (trust).
#? token_types = []
# `ProfileKeys::required_claims`. Optional, unset by default (trust).
#? required_claims = []
# `ProfileKeys::adapter`. Optional, unset by default (trust).
#? adapter = ""
# `ProfileKeys::max_onward_lifetime`. Optional, unset by default (trust).
#? max_onward_lifetime = "500ms"
# `ProfileKeys::onward_grant`. Optional, unset by default (trust).
#? onward_grant = "token_exchange"
# `ProfileKeys::onward_indicator`. Optional, unset by default (trust).
#? onward_indicator = "resource"
# `ProfileKeys::onward_parameters`. Optional, unset by default (trust).
#? onward_parameters = {}
# `ProfileKeys::onward_client_id`. Optional, unset by default (trust).
#? onward_client_id = false
# The introspection check, under `mode = "introspection"`.
#? [auth.issuer.introspection]
# The introspection endpoint; empty for the one the issuer's metadata names. It
# renders with its userinfo and its query masked. Optional (trust).
#? endpoint = ""
# The longest an active response is used; `0s` caches nothing. Optional
# (trust).
#? cache_max_age = "1min"
# The most responses held at once. Optional (trust).
#? cache_capacity = 10000
# The client authentication of the introspection call.
#? [auth.issuer.introspection.client]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (trust).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (trust).
#? token_endpoint = ""
# The client identifier. Optional (trust).
#? client_id = ""
# How the client authenticates. Optional (trust).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default (trust).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default (trust).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (trust).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (trust).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (trust).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (trust).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (trust).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (trust).
#? audience = ""
# How long before the token expires a new one is fetched. Optional (trust).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional (trust).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (trust).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (trust).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional (trust).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (trust).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (trust).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (trust).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (trust).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (trust).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [auth.issuer.introspection.client.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (trust).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default (trust).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (trust).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (trust).
#? min_version = "1.3"
# The client credentials grant whose token authorizes the call.
#? [auth.issuer.introspection.bearer]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (trust).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (trust).
#? token_endpoint = ""
# The client identifier. Optional (trust).
#? client_id = ""
# How the client authenticates. Optional (trust).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default (trust).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default (trust).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (trust).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (trust).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (trust).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (trust).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (trust).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (trust).
#? audience = ""
# How long before the token expires a new one is fetched. Optional (trust).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional (trust).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (trust).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (trust).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional (trust).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (trust).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (trust).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (trust).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (trust).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (trust).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [auth.issuer.introspection.bearer.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (trust).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default (trust).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (trust).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (trust).
#? min_version = "1.3"
# The assurance level the issuer's tokens carry.
#? [auth.issuer.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (trust).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (trust).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (trust).
#? minimum = "low"
# `ProfileKeys::app_only`.
#? [[auth.issuer.app_only]]
# The claim of `{ claim, value }`. Optional, unset by default (trust).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (trust).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (trust).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (trust).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default (trust).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default (trust).
#? differs_from_iss = ""
# `ProfileKeys::guest`.
#? [[auth.issuer.guest]]
# The claim of `{ claim, value }`. Optional, unset by default (trust).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (trust).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (trust).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (trust).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default (trust).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default (trust).
#? differs_from_iss = ""
# `ProfileKeys::representation`.
#? [auth.issuer.representation]
# The claim naming the subject the person represents. Required in its table
# (trust).
#? claim = ""
# The claim carrying the ground of the representation, as asserted. Optional,
# unset by default (trust).
#? ground_claim = ""
# `ProfileKeys::scope_claim`.
#? [auth.issuer.scope_claim]
# The claim. Required in its table (trust).
#? claim = ""
# Its JSON form. Optional (trust).
#? form = "string"
# `ProfileKeys::app_only_scope_claim`.
#? [auth.issuer.app_only_scope_claim]
# The claim. Required in its table (trust).
#? claim = ""
# Its JSON form. Optional (trust).
#? form = "string"
# The `[auth.idp]` table: the vendor adapters a profile may name, each read in
# a build that compiles it in.
#? [auth.idp]
# The Microsoft Graph access of the `idp-entra` adapter (`[auth.idp.entra]`),
# which resolves an Entra ID groups overage.
#? [auth.idp.entra]
# The Microsoft Graph root every URL is built from, `https` without a query or
# a fragment. Optional (infrastructure).
#? base_url = "https://graph.microsoft.com/v1.0"
# The adapter's budget for one call, the token fetch and the Graph round trip
# together; never zero. Optional (infrastructure).
#? timeout = "2s"
# The largest Graph answer read; never zero. Optional (infrastructure).
#? max_response_size = "1MiB"
# The `securityEnabledOnly` parameter of `getMemberObjects`: `false` reads
# every group, administrative unit and directory role, `true` only the security
# groups. Optional (infrastructure).
#? security_enabled_only = false
# The client credentials grant the Graph token is obtained with, under the
# Graph permission the deployment grants.
#? [auth.idp.entra.credentials]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (infrastructure).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client identifier. Optional (infrastructure).
#? client_id = ""
# How the client authenticates. Optional (infrastructure).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default
# (infrastructure).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default
# (infrastructure).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (infrastructure).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (infrastructure).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (infrastructure).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (infrastructure).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (infrastructure).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (infrastructure).
#? audience = ""
# How long before the token expires a new one is fetched. Optional
# (infrastructure).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional
# (infrastructure).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (infrastructure).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (infrastructure).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional
# (infrastructure).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (infrastructure).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (infrastructure).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (infrastructure).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (infrastructure).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (infrastructure).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [auth.idp.entra.credentials.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The Basic users of the surface; absent for no Basic.
#? [auth.basic]
# How long a credential that verified is kept, so a repeat request skips the
# key derivation; `5min` by default, `0s` keeps none. Optional.
#? cache_ttl = "5min"
# The users.
#? [[auth.basic.users]]
# The user-id. Optional (trust).
#? user = ""
# The Argon2id PHC string of the password, rendered redacted. Optional, unset
# by default (trust).
#? password_hash = ""
# The file holding that PHC string. Optional, unset by default (trust).
#? password_hash_file = ""
# The `DPoP` proof check of the surface; absent for none, so a `DPoP` request
# is refused as carrying no admitted credential.
#? [auth.dpop]
# How long after its `iat` a proof is accepted, at most `300s`. Optional
# (trust).
#? max_age = "1min"
# How far a proof's `iat` may lie ahead, at most `300s`. Optional (trust).
#? clock_skew = "10s"
# The signature algorithms a proof may use; asymmetric only. Optional (trust).
#? algorithms = ["RS256", "RS384", "PS256", "PS384", "ES256", "ES384"]
# The TLS of the discovery document, the key set and the introspection calls of
# every issuer: trust roots beside the platform's, for an issuer behind a
# private certificate authority, a client identity and the minimum version. The
# crate reads none of it: the product's `TlsBuilder` builds it once at start.
#? [auth.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (trust).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default (trust).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (trust).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (trust).
#? min_version = "1.3"
# The `[auth.federation]` tables, one per `federation` issuer.
#? [[auth.federation]]
# The `[auth.issuer]` this table describes, of kind `federation`. It renders
# with any userinfo masked, as `SecretUrl` renders itself. Optional (trust).
#? issuer = ""
# Whether the issuer is a MyHealth@EU contact point; required, with no default.
# Optional, unset by default (trust).
#? contact_point = false
# The default sources the table starts from. Optional, unset by default
# (trust).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (trust).
#? fields = {}
# The country codes a professional may carry. Optional (trust).
#? countries = []
# The issuing authorities a professional or provider may name. Optional
# (trust).
#? issuing_authorities = []
# The prefixes a healthcare provider identifier must start with. Optional
# (trust).
#? provider_identifier_prefixes = []
# Whether the issuer attests the `authorization_details` it puts in a token,
# which RFC 9396 §12 has "sent through the user agent". Optional (trust).
#? attests_authorization_details = false
# The `authorization_details` type the attributes are read from. Optional,
# unset by default (trust).
#? authorization_details_type = ""
# The `authorization_details` types that state an organisation's access.
# Optional (trust).
#? organisation_types = []
# The claim holding the Verifiable Presentations of a Nuts RFC021 §6
# introspection response, `vps`. Optional, unset by default (trust).
#? presentations_claim = ""
# The credential types the deployment declares user-authenticated. Optional
# (trust).
#? user_credential_types = []
# The fields every token of the issuer must carry, each with a source. Optional
# (trust).
#? required_fields = []
# Whether the issuer's tokens must be sender-constrained, so the issuer fails
# to load without `sender_constraint = "required"`. Optional (trust).
#? requires_sender_constraint = false
# The subject-token issuers whose persons this issuer is trusted to map to its
# own, when it issues onward tokens (`client::onward`). Optional (trust).
#? exchanges_from = []
# The subject-token claim, a dotted path, whose value an onward token of this
# issuer must carry as `professional.hp_identifier`. Optional, unset by default
# (trust).
#? person_mapping = ""
# The `[auth.attributes]` tables, at most one per `persons` issuer: where it
# states its professionals' attributes.
#? [[auth.attributes]]
# The `[auth.issuer]` this table describes, of kind `persons`, `patients` or
# `machines`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (trust).
#? issuer = ""
# The default sources the table starts from. Optional, unset by default
# (trust).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (trust).
#? fields = {}
# Whether the `purpose_of_use` of each RFC 9396 `authorization_details` entry,
# written `system|code`, is read as a purpose of use. Optional (trust).
#? authorization_details_purposes = false
# The `[auth.party]` tables, one per `persons` issuer whose logins are bound to
# a party.
#? [[auth.party]]
# The `persons` issuer whose logins the table binds. It renders with any
# userinfo masked, as `SecretUrl` renders itself. Optional (trust).
#? issuer = ""
# The issuer of the identifiers the key is matched against; no two tables share
# one. Optional (trust).
#? identifier_issuer = ""
# The type of those identifiers, which declares the key's canonical form:
# `guid` or `uuid` is compared in lower case, any other type exactly. Optional
# (trust).
#? identifier_type = ""
# The claim naming the groups the token asserts, an array of strings; empty to
# read no group. Optional (trust).
#? group_claim = ""
# The issuer of the group identifiers the group claim names; set with
# `group_claim`. Optional (trust).
#? group_identifier_issuer = ""
# Whether a guest of the issuer is looked up; a guest is not by default.
# Optional (trust).
#? guests = false
# The SMART App Launch resource-server posture.
#? [auth.smart]
# Serve the `/.well-known/smart-configuration` discovery document (SMART App
# Launch 2.x §Conformance; default `false`). The document is built from the
# metadata of one `[auth]` issuer that serves a user launch: `[auth]
# described_issuer`, else the one issuer that is not of kind `machines` and
# whose metadata is available. Several such issuers and no `described_issuer`,
# or none, refuse the start. master04 §Services makes every
# `services.*.baseUrl` an "Absolute URL to the root of the API (required)", so
# the document needs `[server] public_base_url`. Optional (infrastructure).
#? discovery = false
# The RFC 8414 §2 authorization-server metadata of the `[auth]` issuer it
# names, whose key set is a `jwks_file` and carries none: a JSON document read
# at boot. SMART App Launch 2.2.0, Conformance, §Metadata requires the
# `token_endpoint` it names. Optional, unset by default (infrastructure).
#? issuer_metadata_file = ""
# The SMART platform base URL the discovery document hangs off (master04
# §Service Discovery: the document is served relative to the platform or
# gateway base, not the FHIR base). Unset, the REST root (`/ferroehr/rest`). A
# leading path segment is honoured, e.g. `/gateway/v1` →
# `/gateway/v1/.well-known/smart-configuration`. Optional, unset by default
# (infrastructure).
#? platform_base_url = ""
# Episode context (master09 §Experimental: Episode Context), advertised only:
# `episode_launch = true` adds `context-openehr-episode` to the document's
# capabilities and applies no episode filtering (openEHR has no first-class
# Episode resource; master09 calls the semantics "currently
# implementation-defined"). Optional (infrastructure).
#? episode_launch = false
# The issuers whose `patient/` grants count, each confined to the `ehrId` of
# the token's launch context (master07 §Context Selection: the `ehrId` names
# an EHR of the platform that issued it). Empty, a `patient/` grant grants
# nothing. Each renders with any userinfo masked. Optional (trust).
#? patient_issuers = []
# The SCIM 2.0 service provider and its provisioning clients; absent,
# `/scim/v2/` is not served.
#? [auth.scim]
# The most resources one list response returns (RFC 7643 §5, the
# `ServiceProviderConfig` `filter.maxResults`). Optional.
#? filter_max_results = 100
# The most Users one client deactivates or deletes in one window; past it, a
# deactivation or a deletion is refused with `429`. Optional.
#? max_deactivations = 100
# The length of that window. Optional.
#? deactivation_window = "1h"
# How long after a User's deletion the contacts of every version of its
# `PERSON` are erased (GDPR Art. 17), at most 30 days; `"0s"` erases them in
# the deletion itself. The name, the binding key and the identifiers stay.
# Optional.
#? contact_erasure_delay = "0s"
# The most members one Group holds; an add past it is refused with `400`. Each
# membership change stores every membership of the Group again (RM demographic
# master02 §Versioning Semantics), so the cap bounds a Group's version
# storage. Optional.
#? max_group_members = 5000
# RBAC, assurance, the party binding, the system clients and the grant ceiling.
#? [authz]
# Role-based access control.
#? [authz.rbac]
# Master switch of the coarse role gate, active only when auth is enabled
# (`FERROEHR__AUTHZ__RBAC__ENABLED`, default `true`). Optional (trust).
#? enabled = true
# The role required for Admin-class operations (default `ADMIN`). Optional
# (trust).
#? admin_role = "ADMIN"
# The role marking a principal as read-only (default `READONLY`): a caller
# carrying it is refused on every write operation even when it also holds
# granting roles (a restriction overrides a grant). Supports the conformance
# catalogue's authorization-separation cases. Optional (trust).
#? readonly_role = "READONLY"
# The role that may reach data under an EHDS Art. 8 access restriction in an
# emergency (`FERROEHR__AUTHZ__RBAC__EMERGENCY_ACCESS_ROLE`, default unset).
# Optional, unset by default (trust).
#? emergency_access_role = ""
# The issuers whose role claims may grant `admin_role` and
# `emergency_access_role`, each a `persons` issuer; empty, the default, lets no
# token grant them. Each renders with any userinfo masked. Optional (trust).
#? role_issuers = []
# The Basic user of `[auth.basic.users]` that holds `admin_role` and `[auth]
# product_scope` from this file (`FERROEHR__AUTHZ__RBAC__FIRST_ADMIN`, default
# unset). Optional, unset by default (trust).
#? first_admin = ""
# What an EHR carrying no `ACCESS_CONTROL_SETTINGS` admits (default `open`).
# Optional (trust).
#? ehr_access_default = "open"
# The authentication assurance a patient-data request must carry
# (`[authz.assurance]`, off by default).
#? [authz.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (trust).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (trust).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (trust).
#? minimum = "low"
# The party binding: the provider, the namespace and the Basic users' keys
# (`[authz.party_binding]`).
#? [authz.party_binding]
# The `PARTY_REF.namespace` a bound party is written under, held to the
# `OBJECT_REF.namespace` pattern. Optional.
#? namespace = "demographic"
# The age past which `ferroehr party-binding check` reports a provisional
# `PERSON`. Optional.
#? provisional_report_after = "30d"
# The healthcare provider this deployment acts for, which every access record
# of a bound person and every version a person commits name (EHDS Art. 13(4),
# Annex II 3.2(a)): one provider, or one table per tenant.
#? [authz.party_binding.provider]
# The issuer of the identifier. Must set (trust).
#? issuer = ""
# The identifier. Must set (trust).
#? id = ""
# The key each Basic user is bound by (`[authz.party_binding.basic_user]`).
#? [[authz.party_binding.basic_user]]
# The `[auth.basic.users]` user-id. Optional (trust).
#? user = ""
# The `identifier_issuer` of the `[auth.party]` table the key belongs to.
# Optional (trust).
#? key_issuer = ""
# The binding key the user's `PERSON` carries. Optional (trust).
#? key = ""
# The person templates and attributes of the shared party mapping. Each mapping
# section defaults to FerroEHR's default demographic definitions, which every
# boot stores when no definition of their id is stored (the book's "Default
# demographic definitions" page); a deployment with templates of its own sets
# the section, and stores its templates before boot.
#? [authz.party_binding.person]
# `[authz.party_binding.person.template]`, one per template a professional's
# `PERSON` may use.
#? [[authz.party_binding.person.template]]
# An operational template in the definition store rooted at `PERSON`. Optional.
#? template_id = ""
# Whether SCIM and just-in-time creation create new persons with this template;
# exactly one table sets it. Optional.
#? default = false
# The binding key.
#? [authz.party_binding.person.template.key]
# The openEHR path. Optional.
#? path = ""
# The `DV_IDENTIFIER.type`. Optional.
#? type = ""
# The SCIM `userName`.
#? [authz.party_binding.person.template.user_name]
# The openEHR path. Optional.
#? path = ""
# The `DV_IDENTIFIER.type`. Optional.
#? type = ""
# The SCIM `externalId`.
#? [authz.party_binding.person.template.external_id]
# The openEHR path. Optional.
#? path = ""
# The `DV_IDENTIFIER.type`. Optional.
#? type = ""
# `[authz.party_binding.person.attribute]`, one per mapped value.
#? [[authz.party_binding.person.attribute]]
# A SCIM attribute path, with the RFC 7644 §3.4.2.2 `valuePath` filter form
# (`emails[type eq "work"].value`). Optional, unset by default.
#? scim = ""
# An OpenID Connect Core 1.0 §5.1 claim. Optional, unset by default.
#? oidc = ""
# Whether just-in-time creation writes the value. Optional.
#? jit = false
# Whether this is the name the committer reads; at most one table sets it.
# Optional.
#? name = false
# The path the value goes to, per template id. Optional.
#? path = {}
# The professional `ROLE` template.
#? [authz.party_binding.professional_role]
# An operational template rooted at `ROLE`. Optional.
#? template_id = "openEHR-DEMOGRAPHIC-ROLE.healthcare_professional.v1.0.0"
# The provisioned `GROUP` template.
#? [authz.party_binding.group]
# An operational template rooted at `GROUP`. Optional.
#? template_id = "openEHR-DEMOGRAPHIC-GROUP.care_team.v1.0.0"
# The path of the group's `displayName`, a `DV_TEXT` in `identities`. Optional.
#? display_name = "/identities[id4]/details[id5]/items[id6]"
# The group's `externalId`.
#? [authz.party_binding.group.external_id]
# The openEHR path. Optional.
#? path = "/details[id2]/items[id3]"
# The `DV_IDENTIFIER.type`. Optional.
#? type = "scim_external_id"
# The membership `PARTY_RELATIONSHIP` archetype.
#? [authz.party_binding.membership]
# A `PARTY_RELATIONSHIP` archetype. Optional.
#? archetype_id = "openEHR-DEMOGRAPHIC-PARTY_RELATIONSHIP.membership.v1"
# The patient's `PERSON` template.
#? [authz.party_binding.patient]
# An operational template rooted at `PERSON`: the subject of an EHR and the
# target of a representation. Optional.
#? template_id = "openEHR-DEMOGRAPHIC-PERSON.patient.v1.0.0"
# The path of the `ELEMENT` holding the patient's identifiers, each a
# `DV_IDENTIFIER` in `details` of any type and issuer. Optional.
#? identifier = "/details[id2]/items[id3]"
# The path of the patient's name, a `DV_TEXT` in `identities`. Optional.
#? name = "/identities[id6]/details[id7]/items[id8]"
# How FerroEHR reads each `persons` issuer's tokens when it creates a
# provisional `PERSON` at a first login (`[authz.party_binding.issuer]`).
#? [[authz.party_binding.issuer]]
# The `persons` issuer the table holds for. It renders with any userinfo
# masked. Optional (trust).
#? issuer = ""
# The claim the `userName` is read from; the issuer profile's `person_key` when
# unset. Optional, unset by default (trust).
#? user_name_claim = ""
# The dotted claim path the identity provider an `admit_idp` admission
# condition matches is read from. Optional (trust).
#? idp_claim = "idp"
# The operations the policy grants may grant (`[authz.grants]`).
#? [authz.grants]
# The operations the party store may grant (`FERROEHR__AUTHZ__GRANTS__ALLOWED`,
# comma-separated). Optional (trust).
#? allowed = ["commit_composition"]
# The openEHR REST API: the base path, the system identifier, the `OPTIONS`
# identity, the `OpenAPI` UI, CORS, the clinical body tier and the ADMIN and
# terminology groups.
[api]
# The ITS-REST base path all API routes hang off, from the root of the
# listener. `management.base_path` is set the same way; the two never overlap.
# Optional (infrastructure).
#? base_path = "/ferroehr/rest/openehr/v1"
# Who may read the Swagger UI and the `OpenAPI` documents at the REST root:
# `off` (not mounted), `admin_only`, `private` (any authenticated principal;
# the default) or `public`. The documents list the whole enabled operation
# surface, admin and message groups included, so `public` discloses it to
# anyone who can reach the port. The same vocabulary the management endpoints
# use; the name is the `OpenAPI` Specification's, the document the UI renders.
# Optional (infrastructure).
#? openapi_ui = "private"
# This CDR's own openEHR **system identifier** — the identity the deployment
# stamps into the data it authors (`FERROEHR__API__SYSTEM_ID`). Must set
# (infrastructure).
system_id = "ferroehr.local"
# The largest body the ordinary clinical surface accepts, below the listener's
# `server.body_limit`. Optional, unset by default (infrastructure).
#? body_limit = "512KiB"
# Whether the ADMIN API group is served. Optional (infrastructure).
#? admin = false
# Whether the terminology extension API is mounted. Off by default — the
# routes answer `404` unless enabled. The terminology server the CDR asks is
# `[terminology]`. Optional (infrastructure).
#? terminology = false
# The CORS protocol answers of the API (Fetch Standard §3.2). Absent, no CORS
# header is sent, so a browser on another origin cannot read a response.
#? [api.cors]
# `Access-Control-Allow-Origin`: the origins a browser may read responses for,
# each a serialized origin such as `https://app.example`, or `["*"]` for any
# origin (dev only). Optional (infrastructure).
#? allow_origins = []
# `Access-Control-Allow-Methods`: the methods a preflight admits; empty admits
# the method the preflight asks for. Optional (infrastructure).
#? allow_methods = []
# `Access-Control-Allow-Headers`: the request headers a preflight admits; empty
# admits the headers the preflight asks for. Optional (infrastructure).
#? allow_headers = []
# `Access-Control-Expose-Headers`: the response headers a script may read
# beyond the CORS-safelisted ones. Optional (infrastructure).
#? expose_headers = []
# `Access-Control-Allow-Credentials`: whether a credentialed request's response
# may be read. Refused beside `allow_origins = ["*"]`, which the Fetch Standard
# forbids together. Optional (infrastructure).
#? allow_credentials = false
# `Access-Control-Max-Age`: how long a preflight answer may be cached; unset
# sends no header. Optional, unset by default (infrastructure).
#? max_age = "500ms"
# The `OPTIONS /` System-Options manifest identity (`[api.options]`). Sourced
# from config so the public identity is not a string literal in the handler;
# the live endpoint list is supplied separately by `ferroehr_rest::router`.
# This is the *display* identity of the manifest — the data-authoring
# identity is `Self::system_id`.
#? [api.options]
# `Options.solution` — the product name. Optional.
#? solution = "FerroEHR"
# `Options.vendor` — the organisation providing the solution (ITS-REST
# `specifications/schemas/others/Options.yaml`, a plain string); defaults to
# the manufacturer's name (`crate::manufacturer::MANUFACTURER`). Optional.
#? vendor = "Cadasto B.V."
# The shared `PostgreSQL` DSN, pool tuning, migrations and one table per
# storage domain.
#? [database]
# `PostgreSQL` connection DSN (`postgres://user:pass@host:port/db`).
# Credentials are redacted from every rendering (`SecretUrl`). Must set
# (infrastructure).
#? url = ""
# Path to a file holding the DSN, read at boot in place of `Self::url`.
# Optional, unset by default (infrastructure).
#? url_file = ""
# DSN that schema preparation (`prepare`) authenticates as; unset (the default)
# reuses `Self::url`. Optional, unset by default (infrastructure).
#? migrate_url = ""
# Path to a file holding `Self::migrate_url`, read at boot in place of it —
# the mounted-secret route, as `Self::url_file` is for the clinical DSN.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? migrate_url_file = ""
# DSN the policy listeners hold their `LISTEN` sessions on, for every domain on
# `Self::url`; unset reuses `Self::url`. Optional, unset by default
# (infrastructure).
#? listen_url = ""
# Path to a file holding `Self::listen_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? listen_url_file = ""
# The most connections this instance opens to `PostgreSQL` while it serves: its
# three pools, the audit runtime's `pool::AUDIT_RUNTIME_POOL` and its listener
# sessions together. Optional.
#? connection_budget = 40
# Upper bound of each domain's connection pool (clinical, party and audit each
# have one). Unset, it follows the instance: four per core the process may run
# on, at least 10 (`pool::POOL_PER_CORE`, `pool::POOL_FLOOR`), within the share
# of `Self::connection_budget` each pool gets, and the server bounds it by
# `server.max_concurrent_requests`, since a request holds at most one
# connection of a pool. Optional, unset by default.
#? max_connections = 0
# Connections each pool keeps open while idle. The server opens them before it
# answers ready, so an instance started under load serves its first requests
# without opening connections; unset, the server keeps one per core, at least 2
# and at most the pool size, and a one-shot command opens what it uses.
# Optional, unset by default.
#? min_connections = 0
# How long to wait for a free connection before failing. Optional.
#? acquire_timeout = "30s"
# `statement_timeout` applied to every pooled connection; `"0s"` leaves the
# server default (usually unlimited). Optional.
#? statement_timeout = "1min"
# Whether the server applies its embedded migrations at boot (`MigrationMode`).
# Optional (infrastructure).
#? migrations = "apply"
# The clinical record's own DSN and the credential that prepares its database.
#? [database.clinical]
# This domain's `PostgreSQL` DSN. Unset reuses `[database] url`. Optional,
# unset by default (infrastructure).
#? url = ""
# Path to a file holding `Self::url`, read at boot in place of it — the route
# for a deployment that mounts its database credential as a file rather than
# passing it as an environment value, which is readable through
# `/proc/<pid>/environ` and inherited by every child process. Setting both is a
# boot error. Optional, unset by default (infrastructure).
#? url_file = ""
# The credential that prepares the database this domain lives in when that is
# not the database `[database] migrate_url` reaches. Optional, unset by default
# (infrastructure).
#? migrate_url = ""
# Path to a file holding `Self::migrate_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? migrate_url_file = ""
# The DSN this domain's policy listeners hold their `LISTEN` sessions on when
# the domain connects on `Self::url`: a direct or session-mode connection to
# the database the domain lives in. Unset reuses the domain's DSN. The audit
# domain holds no listener, so its key is refused. No openEHR spec governs the
# process model: our own design (#5589). Optional, unset by default
# (infrastructure).
#? listen_url = ""
# Path to a file holding `Self::listen_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? listen_url_file = ""
# The identities' own DSN and the credential that prepares their database.
#? [database.party]
# This domain's `PostgreSQL` DSN. Unset reuses `[database] url`. Optional,
# unset by default (infrastructure).
#? url = ""
# Path to a file holding `Self::url`, read at boot in place of it — the route
# for a deployment that mounts its database credential as a file rather than
# passing it as an environment value, which is readable through
# `/proc/<pid>/environ` and inherited by every child process. Setting both is a
# boot error. Optional, unset by default (infrastructure).
#? url_file = ""
# The credential that prepares the database this domain lives in when that is
# not the database `[database] migrate_url` reaches. Optional, unset by default
# (infrastructure).
#? migrate_url = ""
# Path to a file holding `Self::migrate_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? migrate_url_file = ""
# The DSN this domain's policy listeners hold their `LISTEN` sessions on when
# the domain connects on `Self::url`: a direct or session-mode connection to
# the database the domain lives in. Unset reuses the domain's DSN. The audit
# domain holds no listener, so its key is refused. No openEHR spec governs the
# process model: our own design (#5589). Optional, unset by default
# (infrastructure).
#? listen_url = ""
# Path to a file holding `Self::listen_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? listen_url_file = ""
# The audit repository's own DSN and the credential that prepares its database.
#? [database.audit]
# This domain's `PostgreSQL` DSN. Unset reuses `[database] url`. Optional,
# unset by default (infrastructure).
#? url = ""
# Path to a file holding `Self::url`, read at boot in place of it — the route
# for a deployment that mounts its database credential as a file rather than
# passing it as an environment value, which is readable through
# `/proc/<pid>/environ` and inherited by every child process. Setting both is a
# boot error. Optional, unset by default (infrastructure).
#? url_file = ""
# The credential that prepares the database this domain lives in when that is
# not the database `[database] migrate_url` reaches. Optional, unset by default
# (infrastructure).
#? migrate_url = ""
# Path to a file holding `Self::migrate_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? migrate_url_file = ""
# The DSN this domain's policy listeners hold their `LISTEN` sessions on when
# the domain connects on `Self::url`: a direct or session-mode connection to
# the database the domain lives in. Unset reuses the domain's DSN. The audit
# domain holds no listener, so its key is refused. No openEHR spec governs the
# process model: our own design (#5589). Optional, unset by default
# (infrastructure).
#? listen_url = ""
# Path to a file holding `Self::listen_url`, read at boot in place of it.
# Setting both is a boot error. Optional, unset by default (infrastructure).
#? listen_url_file = ""
# The management/observability surface.
#? [management]
# Master switch. When `false`, no management routes are mounted at all.
# Optional (infrastructure).
#? enabled = false
# The base path the management endpoints hang off. Optional (infrastructure).
#? base_path = "/management"
# When set, the management surface is served from its **own** listener on this
# socket address (a separate axum server task in the binary) instead of the
# main API listener — so production can keep it off the public listener
# entirely. The same form as `server.listen`. Optional, unset by default
# (infrastructure).
#? listen = ""
# Span-timing capture: every span's folded stacks are written to this file, for
# `inferno-flamegraph` to render offline. Unset, nothing is captured. Optional,
# unset by default (infrastructure).
#? flame_file = ""
# Per-endpoint access levels — the SINGLE authority for this surface.
#? [management.endpoints]
# `/management/info`. Optional (infrastructure).
#? info = "off"
# `/management/metrics` (+ `/{name}`) — the JSON registry view. Optional
# (infrastructure).
#? metrics = "off"
# `/management/prometheus` — the text exposition scraped by Prometheus.
# Optional (infrastructure).
#? prometheus = "off"
# `/management/env` — the redacted effective configuration. Optional
# (infrastructure).
#? env = "off"
# `/management/loggers` — the runtime `EnvFilter` control. Optional
# (infrastructure).
#? loggers = "off"
# `/management/flamegraph` — the on-demand CPU flamegraph (pprof sampling).
# Optional (infrastructure).
#? flamegraph = "off"
# `/management/health` — every readiness indicator with its detail. Optional
# (infrastructure).
#? health = "off"
# `/management/status` — the status document with the licence, the deployment
# posture and the support period. Optional (infrastructure).
#? status = "off"
# Limits for the on-demand CPU profiler (`endpoints.flamegraph`).
#? [management.profiling]
# The longest sample window a single request may ask for, in whole seconds.
# Optional.
#? max_duration = "30s"
# The highest sampling frequency a request may ask for, in Hz. Optional.
#? max_frequency = 999
# The IHE ATNA audit trail / System Log (local Audit Record Repository + the
# syslog and FHIR-feed forwarding sinks).
#? [audit]
# Master switch (`FERROEHR__AUDIT__ENABLED`). **On by default** — every
# deployment gets a queryable audit trail with zero external dependencies (the
# sinks decide where records go). Optional (infrastructure).
#? enabled = true
# Enterprise/site id → `AuditEnterpriseSiteID`
# (`FERROEHR__AUDIT__ENTERPRISE_SITE_ID`). Optional, unset by default
# (infrastructure).
#? enterprise_site_id = ""
# Audit source id → `AuditSourceID` and the destination participant
# (`FERROEHR__AUDIT__SOURCE_ID`). Optional (infrastructure).
#? source_id = "ferroehr"
# Fill value for empty mandatory fields (`FERROEHR__AUDIT__VALUE_IF_MISSING`).
# Optional.
#? value_if_missing = "UNKNOWN"
# Skip successful-login records (`FERROEHR__AUDIT__SUPPRESS_LOGIN_EVENTS`).
# Rejected accesses (401/403) are always recorded. Optional.
#? suppress_login_events = true
# Enrich the patient participant through an indexed lookup of `ehr.subject_id`
# (`FERROEHR__AUDIT__RESOLVE_SUBJECT`), memoized per EHR. On by default: the
# IHE BALP `Patient*` patterns and the patient-centric audit search need the
# subject. Optional.
#? resolve_subject = true
# This node's advertised network address → the destination
# network-access-point (`FERROEHR__AUDIT__SERVER_HOST`); the `value_if_missing`
# fill when unset. Optional, unset by default (infrastructure).
#? server_host = ""
# The request header carrying the caller's declared purpose of use
# (`FERROEHR__AUDIT__PURPOSE_HEADER`), recorded on every access record.
# Optional.
#? purpose_header = "x-purpose-of-use"
# The request header carrying the data permit the caller acts under
# (`FERROEHR__AUDIT__PERMIT_HEADER`), recorded on every access record.
# Optional.
#? permit_header = "x-data-permit"
# The purpose codes this deployment accepts (`FERROEHR__AUDIT__PURPOSE_CODES`).
# Optional.
#? purpose_codes = []
# The declared purpose codes that mark an access as an emergency access
# (`FERROEHR__AUDIT__EMERGENCY_PURPOSE_CODES`). Empty (the default) marks
# nothing. Optional (trust).
#? emergency_purpose_codes = []
# The legal basis this deployment processes under
# (`FERROEHR__AUDIT__LEGAL_BASIS`), recorded on every access record. Optional,
# unset by default (infrastructure).
#? legal_basis = ""
# The local Audit Record Repository.
#? [audit.store]
# The time between two scheduled verifications of the store's hash chain
# (`FERROEHR__AUDIT__STORE__VERIFY_INTERVAL`); `"0s"` turns the schedule off.
# Default one hour. Optional.
#? verify_interval = "1h"
# The time between two scheduled full passes over the hash chain
# (`FERROEHR__AUDIT__STORE__FULL_VERIFY_INTERVAL`), which also recompute the
# records before the checkpoint; `"0s"` leaves the full pass to `SELECT * FROM
# audit.verify_audit_chain()` on demand. Default one week. A run that found
# damage is always followed by a full pass. Optional.
#? full_verify_interval = "7d"
# How long a record may wait past its chain's verification cursor before the
# `audit_chain` health indicator reads `DEGRADED`
# (`FERROEHR__AUDIT__STORE__MAX_VERIFY_LAG`); `"0s"` reports the lag only as
# the `audit_chain_verification_lag` and `audit_chain_unverified_age` metrics.
# Default four hours. Set it above `verify_interval`, since the cursor stays
# where a run left it until the next run. Optional.
#? max_verify_lag = "4h"
# The classic DICOM-over-syslog feed; absent, off.
#? [audit.syslog]
# The Audit Record Repository, `tls://host:port`
# (`FERROEHR__AUDIT__SYSLOG__URL`): RFC 5425 TLS, on the §4.1 port 6514 by
# default. Optional (infrastructure).
#? url = "tls://localhost:6514"
# The TLS material of the connection to the ARR (`[audit.syslog.tls]`): the
# family's outbound TLS keys, the client identity for mutual TLS and the trust
# roots beside the platform's.
#? [audit.syslog.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The wait between two delivery attempts.
#? [audit.syslog.retry]
# The longest wait between two delivery attempts after a failure. Optional.
#? max_backoff = "1min"
# The RESTful-ATNA FHIR `AuditEvent` feed; absent, off.
#? [audit.fhir_feed]
# How long the forwarder waits for a new record before it reads the store again
# (`FERROEHR__AUDIT__FHIR_FEED__POLL_INTERVAL`); at least 100 ms is waited.
# Optional.
#? poll_interval = "2s"
# `[audit.fhir_feed.endpoint]`, the family's outbound endpoint: the ARR's FHIR
# base URL (`url`; the `AuditEvent` endpoint is `{url}/AuditEvent`), the
# timeout of one `POST`, the `retry` of a delivery, the TLS and the credential,
# such as the OAuth 2.0 client credentials grant of the IHE IUA authorized
# client. Credentials in the URL are masked in every rendering.
#? [audit.fhir_feed.endpoint]
# The service's URL (RFC 3986); required. It renders with its userinfo and its
# query masked, in `Debug` and when serialized. Optional (infrastructure).
#? url = ""
# How long one whole call may take; never zero. Optional (infrastructure).
#? timeout = "10s"
# How long opening the connection may take; unset, only `timeout` bounds it.
# Optional, unset by default (infrastructure).
#? connect_timeout = "500ms"
# How a failed call is tried again.
#? [audit.fhir_feed.endpoint.retry]
# How many times one call is tried in all; 1 tries once. Optional
# (infrastructure).
#? max_attempts = 3
# The wait before the second try. Optional (infrastructure).
#? initial_backoff = "200ms"
# The longest wait between two tries. Optional (infrastructure).
#? max_backoff = "1min"
# The TLS of the connection, built by the product's reader of TLS material.
#? [audit.fhir_feed.endpoint.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The credential the calls carry: HTTP Basic or the client credentials grant.
#? [audit.fhir_feed.endpoint.credentials]
# The Basic user-id. Optional (infrastructure).
#? user = ""
# The Basic password, rendered redacted. Optional, unset by default
# (infrastructure).
#? password = ""
# The file holding the Basic password. Optional, unset by default
# (infrastructure).
#? password_file = ""
# The client credentials grant.
#? [audit.fhir_feed.endpoint.credentials.oauth]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (infrastructure).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client identifier. Optional (infrastructure).
#? client_id = ""
# How the client authenticates. Optional (infrastructure).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default
# (infrastructure).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default
# (infrastructure).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (infrastructure).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (infrastructure).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (infrastructure).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (infrastructure).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (infrastructure).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (infrastructure).
#? audience = ""
# How long before the token expires a new one is fetched. Optional
# (infrastructure).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional
# (infrastructure).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (infrastructure).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (infrastructure).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional
# (infrastructure).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (infrastructure).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (infrastructure).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (infrastructure).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (infrastructure).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (infrastructure).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [audit.fhir_feed.endpoint.credentials.oauth.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The onward target the lane reaches on a caller's behalf, authenticating with
# `oauth`.
#? [audit.fhir_feed.endpoint.credentials.onward]
# The identifier of the issuer of the onward tokens, whose metadata names its
# token endpoint unless `token_endpoint` is set. It renders with any userinfo
# masked, as `SecretUrl` renders itself. Optional (infrastructure).
#? issuer = ""
# Whose tokens the issuer signs: `persons` (a delegated exchange), `patients`
# (a patient's own token) or `federation`; required, with no default. Optional,
# unset by default (infrastructure).
#? kind = "persons"
# The preset the issuer's profile starts from. Optional (infrastructure).
#? profile = "rfc9068"
# The token endpoint itself; empty to discover it from `issuer`. It renders
# with its userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client id at this issuer; empty for the lane's own. Optional
# (infrastructure).
#? client_id = ""
# The audiences an onward token may name, at least one. Optional
# (infrastructure).
#? audiences = []
# The `resource` or `audience` values the request names, as the profile's
# `onward_indicator` says. Optional (infrastructure).
#? indicators = []
# The `scope` the request names; empty for none. Optional (infrastructure).
#? scope = ""
# The claim a chained federation route carries from the subject token to the
# onward token; empty for none. Optional (infrastructure).
#? correlation_claim = ""
# Whether the lane holds the tokens it obtains until they near their `exp`.
# `false` exchanges a token at the issuer on every call, a setting for a
# performance measurement's self-test, never for production. `true` by default.
# Optional (infrastructure).
#? cache = true
# Whether every token exchange sent without an actor token names the lane's
# client as its actor with an assertion signed by the current key of its
# `oauth` table's key ring (RFC 8693 §2.1; `Onward::with_actor_assertion`).
# `false` by default. Optional (infrastructure).
#? actor_assertion = false
# The profile keys set over the preset; `max_onward_lifetime` is required, here
# or in the preset.
#? [audit.fhir_feed.endpoint.credentials.onward.keys]
# `Profile::person_key`. Optional, unset by default (infrastructure).
#? person_key = ""
# `Profile::tenant_claim`. Optional, unset by default (infrastructure).
#? tenant_claim = ""
# `Profile::client_claims`. Optional, unset by default (infrastructure).
#? client_claims = []
# `Profile::impersonation_marker`. Optional, unset by default (infrastructure).
#? impersonation_marker = ""
# `Profile::expect`. Optional, unset by default (infrastructure).
#? expect = {}
# `Profile::user_claims`. Optional, unset by default (infrastructure).
#? user_claims = []
# `Profile::person_equality`. Optional, unset by default (infrastructure).
#? person_equality = []
# `Profile::unstable_claims`. Optional, unset by default (infrastructure).
#? unstable_claims = []
# `Profile::first_party_clients`. Optional, unset by default (infrastructure).
#? first_party_clients = []
# `Profile::max_actor_chain`. Optional, unset by default (infrastructure).
#? max_actor_chain = 0
# `Profile::act_represents_patient`. Optional, unset by default
# (infrastructure).
#? act_represents_patient = false
# `Profile::token_types`. Optional, unset by default (infrastructure).
#? token_types = []
# `Profile::required_claims`. Optional, unset by default (infrastructure).
#? required_claims = []
# `Profile::adapter`. Optional, unset by default (infrastructure).
#? adapter = ""
# `Profile::max_onward_lifetime`, a duration such as `"10min"`. Optional, unset
# by default (infrastructure).
#? max_onward_lifetime = "500ms"
# `Profile::onward_grant`. Optional, unset by default (infrastructure).
#? onward_grant = "token_exchange"
# `Profile::onward_indicator`. Optional, unset by default (infrastructure).
#? onward_indicator = "resource"
# `Profile::onward_parameters`. Optional, unset by default (infrastructure).
#? onward_parameters = {}
# `Profile::onward_client_id`. Optional, unset by default (infrastructure).
#? onward_client_id = false
# `Profile::onward_subject_audience`. Optional, unset by default
# (infrastructure).
#? onward_subject_audience = false
# `Profile::onward_preview`. Optional, unset by default (infrastructure).
#? onward_preview = []
# `Profile::app_only`.
#? [[audit.fhir_feed.endpoint.credentials.onward.keys.app_only]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::guest`.
#? [[audit.fhir_feed.endpoint.credentials.onward.keys.guest]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::delegates`.
#? [[audit.fhir_feed.endpoint.credentials.onward.keys.delegates]]
# The actor's issuer. Optional, unset by default (infrastructure).
#? issuer = ""
# The actor's `sub`. Optional, unset by default (infrastructure).
#? sub = ""
# The client. Optional, unset by default (infrastructure).
#? client = ""
# `Profile::representation`.
#? [audit.fhir_feed.endpoint.credentials.onward.keys.representation]
# The claim naming the subject the person represents. Required in its table
# (infrastructure).
#? claim = ""
# The claim carrying the ground of the representation, as asserted. Optional,
# unset by default (infrastructure).
#? ground_claim = ""
# `Profile::scope_claim`.
#? [audit.fhir_feed.endpoint.credentials.onward.keys.scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# `Profile::app_only_scope_claim`.
#? [audit.fhir_feed.endpoint.credentials.onward.keys.app_only_scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# What a `federation` issuer asserts, over its preset's defaults;
# `exchanges_from` and `person_mapping` are required.
#? [audit.fhir_feed.endpoint.credentials.onward.federation]
# The `[auth.issuer]` this table describes, of kind `federation`. It renders
# with any userinfo masked, as `SecretUrl` renders itself. Optional
# (infrastructure).
#? issuer = ""
# Whether the issuer is a MyHealth@EU contact point; required, with no default.
# Optional, unset by default (infrastructure).
#? contact_point = false
# The default sources the table starts from. Optional, unset by default
# (infrastructure).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (infrastructure).
#? fields = {}
# The country codes a professional may carry. Optional (infrastructure).
#? countries = []
# The issuing authorities a professional or provider may name. Optional
# (infrastructure).
#? issuing_authorities = []
# The prefixes a healthcare provider identifier must start with. Optional
# (infrastructure).
#? provider_identifier_prefixes = []
# Whether the issuer attests the `authorization_details` it puts in a token,
# which RFC 9396 §12 has "sent through the user agent". Optional
# (infrastructure).
#? attests_authorization_details = false
# The `authorization_details` type the attributes are read from. Optional,
# unset by default (infrastructure).
#? authorization_details_type = ""
# The `authorization_details` types that state an organisation's access.
# Optional (infrastructure).
#? organisation_types = []
# The claim holding the Verifiable Presentations of a Nuts RFC021 §6
# introspection response, `vps`. Optional, unset by default (infrastructure).
#? presentations_claim = ""
# The credential types the deployment declares user-authenticated. Optional
# (infrastructure).
#? user_credential_types = []
# The fields every token of the issuer must carry, each with a source. Optional
# (infrastructure).
#? required_fields = []
# Whether the issuer's tokens must be sender-constrained, so the issuer fails
# to load without `sender_constraint = "required"`. Optional (infrastructure).
#? requires_sender_constraint = false
# The subject-token issuers whose persons this issuer is trusted to map to its
# own, when it issues onward tokens (`client::onward`). Optional
# (infrastructure).
#? exchanges_from = []
# The subject-token claim, a dotted path, whose value an onward token of this
# issuer must carry as `professional.hp_identifier`. Optional, unset by default
# (infrastructure).
#? person_mapping = ""
# The assurance level the issuer's tokens carry.
#? [audit.fhir_feed.endpoint.credentials.onward.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (infrastructure).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (infrastructure).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (infrastructure).
#? minimum = "low"
# Where the access log's checkpoints are published and the systems whose
# exported access logs are imported.
#? [audit.access_log]
# A directory outside the database, ideally on write-once storage, where the
# server publishes the newest checkpoint as its own file every 30 seconds
# (`FERROEHR__AUDIT__ACCESS_LOG__PUBLISH_DIRECTORY`). Only a published
# checkpoint shows that the newest entries were removed together with the
# checkpoints that seal them; unset, the `access_log_checkpoints` indicator
# reads `DEGRADED`. Optional, unset by default (infrastructure).
#? publish_directory = ""
# Armored `OpenPGP` public certificates of the systems whose exported logs this
# deployment imports (`FERROEHR__AUDIT__ACCESS_LOG__TRUSTED_KEY_FILES`). An
# import verifies the checkpoint against these and the keyring's own key, and
# is refused when none signed it. Optional (trust).
#? trusted_key_files = []
# The data-minimisation policy: the subject namespaces, the identified parties,
# the cohort query and the access delay.
[privacy]
# The namespaces an `EHR_STATUS.subject.external_ref` may name
# (`FERROEHR__PRIVACY__SUBJECT_NAMESPACES`, comma-separated in the environment)
# — the pseudonymisation domains this deployment issues subject pseudonyms
# in. Must set (trust).
subject_namespaces = []
# Accept `PARTY_IDENTIFIED` / `PARTY_RELATED` carrying `name` or `identifiers`
# in clinical content (`FERROEHR__PRIVACY__ALLOW_IDENTIFIED_PARTIES_IN_EHR`).
# Optional (trust).
#? allow_identified_parties_in_ehr = false
# The cross-domain cohort-query allow-list and limits.
#? [privacy.cohort]
# The distinct-EHR floor a result set must reach to be served
# (`FERROEHR__PRIVACY__COHORT__SMALL_CELL_THRESHOLD`); `0` disables
# suppression. Optional (trust).
#? small_cell_threshold = 5
# The largest cohort a predicate may select
# (`FERROEHR__PRIVACY__COHORT__MAX_COHORT_SIZE`). Optional (trust).
#? max_cohort_size = 100000
# Whether a cohort may name its subjects by identifier
# (`FERROEHR__PRIVACY__COHORT__SUBJECTS`), each resolved through the installed
# EHR index provider. The one cohort form an IHE patient identity source
# serves, so it turns the surface on without a bound predicate. Optional
# (trust).
#? subjects = false
# The bound predicates, keyed by the name a caller uses
# (`[privacy.cohort.predicates]`). Empty — the default — leaves the
# predicate half of the surface off.
# [privacy.cohort.predicates.<name>]
# The archetype HRID of the nearest archetyped ancestor of the ELEMENT
# (`openEHR-DEMOGRAPHIC-ADDRESS.address.v1`), matched case-insensitively
# against the stored, case-folded column (BASE `base_types`
# `master05-identification_package.adoc` §"Composite Identifiers and Case").
# Required in its table (trust).
# archetype = ""
# The ELEMENT's `archetype_node_id` at-code (`at0012`). Required in its table
# (trust).
# node = ""
# How the caller's value is matched against the leaf. Required in its table
# (trust).
# kind = "text"
# The record itself: the subject index, versioning, signing, the query engine,
# the change feed and multimedia.
#? [record]
# Who holds the subject-to-EHR cross-reference, the IHE patient identity source
# of `[pixm]` (`pixm`) or the in-instance map (`local`). No default: an unset
# index refuses the start. Must set (infrastructure).
#? subject_index = "pixm"
# The answer to an identical re-send.
#? [record.versioning]
# `idempotent_resend` (default `false`): when `true`, an update whose content
# equals the current version's commits nothing and answers with the existing
# version's `ETag` and `Location`, leaving one `resend` record on the access
# log. No `commit_audit` and no CONTRIBUTION then record the act (RM common
# master06 §Committal and Audits), which is why the default records every
# commit. The name is RFC 9110 §9.2.2's: a re-send then has the effect of one
# request. Optional (infrastructure).
#? idempotent_resend = false
# VERSION signing.
#? [record.signing]
# Server-side signing of committed versions. Defaults **on** so the STANDARD
# "Signing" capability is demonstrably met. Optional (infrastructure).
#? enabled = true
# Signing mode: `digest` | `pgp`. Optional (infrastructure).
#? mode = "digest"
# Armored RFC 4880 secret key; **required for `pgp` mode** (validated at boot,
# fail-closed). Optional, unset by default (infrastructure).
#? key_file = ""
# Key passphrase, kept in `ferrohealth_secret::secret::Secret` and redacted
# from any config snapshot. Optional, unset by default (infrastructure).
#? key_passphrase = ""
# File-based indirection for `Self::key_passphrase` (K8s/Docker secrets).
# Exactly one of the pair may be set; the loader reads and trims the file.
# Optional, unset by default (infrastructure).
#? key_passphrase_file = ""
# Armored RFC 4880 **public** keys retired from signing but retained for
# verification, so versions signed before a key rotation keep verifying.
# Optional (infrastructure).
#? retired_key_files = []
# Read-time verification policy: `off` | `warn` | `strict`. **Unset** (the
# default) resolves via `Self::effective_verify_on_read` to `strict` when
# signing is enabled — the explicit "sign but never check" state is reachable
# only by deliberately setting `off`. Optional, unset by default
# (infrastructure).
#? verify_on_read = "off"
# AQL execution knobs.
#? [record.query]
# Max distinct cached query plans; `0` disables the plan cache (every lookup
# misses and the full parse→lower path runs). Optional.
#? plan_cache_capacity = 256
# Per-query DB execution budget; `"0s"` disables it. Overrun reports `408`
# (ITS-REST `Requests_and_responses` §HTTP status codes). Optional
# (infrastructure).
#? timeout = "30s"
# The largest page of rows one query execution serves; `0` means unbounded.
# Optional (infrastructure).
#? max_result_rows = 10000
# The commit-event outbox retention; its readers are the change-feed grants.
#? [record.change_feed]
# How long a row is kept once every active reader has acknowledged it, counted
# from its commit instant. Optional.
#? retention = "7d"
# How often the retention prune runs. Optional.
#? prune_interval = "1h"
# `DV_MULTIMEDIA` externalization to a blob store. It keeps `enabled`, because
# its store applies while it is off: blobs already offloaded are read back from
# the backend `backend` names.
#? [record.multimedia]
# Master switch. `false` (default) = today's inline behaviour, byte for byte;
# no blob store is built or contacted. Optional (infrastructure).
#? enabled = false
# A decoded `DV_MULTIMEDIA.data` strictly larger than this is offloaded to the
# blob store; at or below it stays inline. Default `"256KiB"`. Optional
# (infrastructure).
#? threshold = "256KiB"
# The storage service the blobs live in. Default `"s3"`, the one service this
# build offers. Optional (infrastructure).
#? backend = "s3"
# The most requests to the blob store in flight at once, across every request
# this server serves. Default `64`. Optional (infrastructure).
#? max_concurrent_requests = 64
# How long one request to the blob store, or one chunk of its body, may take
# before it is retried or fails. Default `"30s"`. Optional (infrastructure).
#? request_timeout = "30s"
# The part size of a multipart upload and of a ranged read: a blob larger than
# this is uploaded in parts. Default `"8MiB"`. Optional (infrastructure).
#? part_size = "8MiB"
# How many parts of one blob move at once. Default `4`. Optional
# (infrastructure).
#? part_concurrency = 4
# How old an unreferenced blob must be before `ferroehr db sweep-blobs` deletes
# it. A write of bytes already stored rewrites a blob older than half of this,
# so a blob a commit is about to reference is never that old. Keep it well
# above the longest commit; zero is refused. Default `"1h"`. Optional
# (infrastructure).
#? orphan_grace = "1h"
# The S3 backend's settings (`[record.multimedia.s3]`).
#? [record.multimedia.s3]
# S3-compatible endpoint URL (e.g. a SeaweedFS S3 gateway in dev/test, or a
# MinIO endpoint). `None` uses the AWS endpoint of `region`. Any `userinfo` in
# it is masked in every rendering and never sent. An `http://` URL is plain
# HTTP, which a dev SeaweedFS speaks; a `production` deployment names it as a
# gap. Optional, unset by default (infrastructure).
#? url = ""
# Target bucket for content-addressed blobs. Optional (infrastructure).
#? bucket = "openehr-multimedia"
# AWS region (S3 requires one even for non-AWS endpoints). Optional
# (infrastructure).
#? region = "us-east-1"
# Access key id. `None` (with `secret_access_key` also `None`) sends the
# requests unsigned, the mode a keyless dev SeaweedFS accepts. Optional, unset
# by default (infrastructure).
#? access_key_id = ""
# Secret access key (paired with `access_key_id`); never rendered. Optional,
# unset by default (infrastructure).
#? secret_access_key = ""
# File-based indirection for `Self::secret_access_key` (K8s/Docker secrets).
# Exactly one of the pair may be set; the loader reads and trims the file.
# Optional, unset by default (infrastructure).
#? secret_access_key_file = ""
# The outbound FHIR terminology server; absent, none is asked.
#? [terminology]
# On a binding the server cannot resolve: `accept` (the default) or `refuse`. A
# resolved non-member is refused under either setting. Optional
# (infrastructure).
#? on_error = "accept"
# `[terminology.endpoint]`, the family's outbound endpoint: the FHIR R4B base
# URL (`url`, such as `http://ferroterm:8080/r4b`, required), the timeouts, the
# `retry` of a call, the TLS and the credential. Any `userinfo` in the URL is
# masked in every rendering.
#? [terminology.endpoint]
# The service's URL (RFC 3986); required. It renders with its userinfo and its
# query masked, in `Debug` and when serialized. Optional (infrastructure).
#? url = ""
# How long one whole call may take; never zero. Optional (infrastructure).
#? timeout = "10s"
# How long opening the connection may take; unset, only `timeout` bounds it.
# Optional, unset by default (infrastructure).
#? connect_timeout = "500ms"
# How a failed call is tried again.
#? [terminology.endpoint.retry]
# How many times one call is tried in all; 1 tries once. Optional
# (infrastructure).
#? max_attempts = 3
# The wait before the second try. Optional (infrastructure).
#? initial_backoff = "200ms"
# The longest wait between two tries. Optional (infrastructure).
#? max_backoff = "5s"
# The TLS of the connection, built by the product's reader of TLS material.
#? [terminology.endpoint.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The credential the calls carry: HTTP Basic or the client credentials grant.
#? [terminology.endpoint.credentials]
# The Basic user-id. Optional (infrastructure).
#? user = ""
# The Basic password, rendered redacted. Optional, unset by default
# (infrastructure).
#? password = ""
# The file holding the Basic password. Optional, unset by default
# (infrastructure).
#? password_file = ""
# The client credentials grant.
#? [terminology.endpoint.credentials.oauth]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (infrastructure).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client identifier. Optional (infrastructure).
#? client_id = ""
# How the client authenticates. Optional (infrastructure).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default
# (infrastructure).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default
# (infrastructure).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (infrastructure).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (infrastructure).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (infrastructure).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (infrastructure).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (infrastructure).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (infrastructure).
#? audience = ""
# How long before the token expires a new one is fetched. Optional
# (infrastructure).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional
# (infrastructure).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (infrastructure).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (infrastructure).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional
# (infrastructure).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (infrastructure).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (infrastructure).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (infrastructure).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (infrastructure).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (infrastructure).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [terminology.endpoint.credentials.oauth.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The onward target the lane reaches on a caller's behalf, authenticating with
# `oauth`.
#? [terminology.endpoint.credentials.onward]
# The identifier of the issuer of the onward tokens, whose metadata names its
# token endpoint unless `token_endpoint` is set. It renders with any userinfo
# masked, as `SecretUrl` renders itself. Optional (infrastructure).
#? issuer = ""
# Whose tokens the issuer signs: `persons` (a delegated exchange), `patients`
# (a patient's own token) or `federation`; required, with no default. Optional,
# unset by default (infrastructure).
#? kind = "persons"
# The preset the issuer's profile starts from. Optional (infrastructure).
#? profile = "rfc9068"
# The token endpoint itself; empty to discover it from `issuer`. It renders
# with its userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client id at this issuer; empty for the lane's own. Optional
# (infrastructure).
#? client_id = ""
# The audiences an onward token may name, at least one. Optional
# (infrastructure).
#? audiences = []
# The `resource` or `audience` values the request names, as the profile's
# `onward_indicator` says. Optional (infrastructure).
#? indicators = []
# The `scope` the request names; empty for none. Optional (infrastructure).
#? scope = ""
# The claim a chained federation route carries from the subject token to the
# onward token; empty for none. Optional (infrastructure).
#? correlation_claim = ""
# Whether the lane holds the tokens it obtains until they near their `exp`.
# `false` exchanges a token at the issuer on every call, a setting for a
# performance measurement's self-test, never for production. `true` by default.
# Optional (infrastructure).
#? cache = true
# Whether every token exchange sent without an actor token names the lane's
# client as its actor with an assertion signed by the current key of its
# `oauth` table's key ring (RFC 8693 §2.1; `Onward::with_actor_assertion`).
# `false` by default. Optional (infrastructure).
#? actor_assertion = false
# The profile keys set over the preset; `max_onward_lifetime` is required, here
# or in the preset.
#? [terminology.endpoint.credentials.onward.keys]
# `Profile::person_key`. Optional, unset by default (infrastructure).
#? person_key = ""
# `Profile::tenant_claim`. Optional, unset by default (infrastructure).
#? tenant_claim = ""
# `Profile::client_claims`. Optional, unset by default (infrastructure).
#? client_claims = []
# `Profile::impersonation_marker`. Optional, unset by default (infrastructure).
#? impersonation_marker = ""
# `Profile::expect`. Optional, unset by default (infrastructure).
#? expect = {}
# `Profile::user_claims`. Optional, unset by default (infrastructure).
#? user_claims = []
# `Profile::person_equality`. Optional, unset by default (infrastructure).
#? person_equality = []
# `Profile::unstable_claims`. Optional, unset by default (infrastructure).
#? unstable_claims = []
# `Profile::first_party_clients`. Optional, unset by default (infrastructure).
#? first_party_clients = []
# `Profile::max_actor_chain`. Optional, unset by default (infrastructure).
#? max_actor_chain = 0
# `Profile::act_represents_patient`. Optional, unset by default
# (infrastructure).
#? act_represents_patient = false
# `Profile::token_types`. Optional, unset by default (infrastructure).
#? token_types = []
# `Profile::required_claims`. Optional, unset by default (infrastructure).
#? required_claims = []
# `Profile::adapter`. Optional, unset by default (infrastructure).
#? adapter = ""
# `Profile::max_onward_lifetime`, a duration such as `"10min"`. Optional, unset
# by default (infrastructure).
#? max_onward_lifetime = "500ms"
# `Profile::onward_grant`. Optional, unset by default (infrastructure).
#? onward_grant = "token_exchange"
# `Profile::onward_indicator`. Optional, unset by default (infrastructure).
#? onward_indicator = "resource"
# `Profile::onward_parameters`. Optional, unset by default (infrastructure).
#? onward_parameters = {}
# `Profile::onward_client_id`. Optional, unset by default (infrastructure).
#? onward_client_id = false
# `Profile::onward_subject_audience`. Optional, unset by default
# (infrastructure).
#? onward_subject_audience = false
# `Profile::onward_preview`. Optional, unset by default (infrastructure).
#? onward_preview = []
# `Profile::app_only`.
#? [[terminology.endpoint.credentials.onward.keys.app_only]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::guest`.
#? [[terminology.endpoint.credentials.onward.keys.guest]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::delegates`.
#? [[terminology.endpoint.credentials.onward.keys.delegates]]
# The actor's issuer. Optional, unset by default (infrastructure).
#? issuer = ""
# The actor's `sub`. Optional, unset by default (infrastructure).
#? sub = ""
# The client. Optional, unset by default (infrastructure).
#? client = ""
# `Profile::representation`.
#? [terminology.endpoint.credentials.onward.keys.representation]
# The claim naming the subject the person represents. Required in its table
# (infrastructure).
#? claim = ""
# The claim carrying the ground of the representation, as asserted. Optional,
# unset by default (infrastructure).
#? ground_claim = ""
# `Profile::scope_claim`.
#? [terminology.endpoint.credentials.onward.keys.scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# `Profile::app_only_scope_claim`.
#? [terminology.endpoint.credentials.onward.keys.app_only_scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# What a `federation` issuer asserts, over its preset's defaults;
# `exchanges_from` and `person_mapping` are required.
#? [terminology.endpoint.credentials.onward.federation]
# The `[auth.issuer]` this table describes, of kind `federation`. It renders
# with any userinfo masked, as `SecretUrl` renders itself. Optional
# (infrastructure).
#? issuer = ""
# Whether the issuer is a MyHealth@EU contact point; required, with no default.
# Optional, unset by default (infrastructure).
#? contact_point = false
# The default sources the table starts from. Optional, unset by default
# (infrastructure).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (infrastructure).
#? fields = {}
# The country codes a professional may carry. Optional (infrastructure).
#? countries = []
# The issuing authorities a professional or provider may name. Optional
# (infrastructure).
#? issuing_authorities = []
# The prefixes a healthcare provider identifier must start with. Optional
# (infrastructure).
#? provider_identifier_prefixes = []
# Whether the issuer attests the `authorization_details` it puts in a token,
# which RFC 9396 §12 has "sent through the user agent". Optional
# (infrastructure).
#? attests_authorization_details = false
# The `authorization_details` type the attributes are read from. Optional,
# unset by default (infrastructure).
#? authorization_details_type = ""
# The `authorization_details` types that state an organisation's access.
# Optional (infrastructure).
#? organisation_types = []
# The claim holding the Verifiable Presentations of a Nuts RFC021 §6
# introspection response, `vps`. Optional, unset by default (infrastructure).
#? presentations_claim = ""
# The credential types the deployment declares user-authenticated. Optional
# (infrastructure).
#? user_credential_types = []
# The fields every token of the issuer must carry, each with a source. Optional
# (infrastructure).
#? required_fields = []
# Whether the issuer's tokens must be sender-constrained, so the issuer fails
# to load without `sender_constraint = "required"`. Optional (infrastructure).
#? requires_sender_constraint = false
# The subject-token issuers whose persons this issuer is trusted to map to its
# own, when it issues onward tokens (`client::onward`). Optional
# (infrastructure).
#? exchanges_from = []
# The subject-token claim, a dotted path, whose value an onward token of this
# issuer must carry as `professional.hp_identifier`. Optional, unset by default
# (infrastructure).
#? person_mapping = ""
# The assurance level the issuer's tokens carry.
#? [terminology.endpoint.credentials.onward.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (infrastructure).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (infrastructure).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (infrastructure).
#? minimum = "low"
# The IHE PIXm patient identity source the subject index asks (ITI-83) under
# `record.subject_index = "pixm"`.
#? [pixm]
# The assigning authority of the clinical domain, an absolute URI such as
# `urn:oid:2.999.1`: the `targetSystem` of every ITI-83 query and the
# `EHR_STATUS.subject.external_ref.namespace` the answered identifier is stored
# under. It must be one of `privacy.subject_namespaces`. Optional
# (infrastructure).
#? assigning_authority = ""
# How the PIX Manager is asked: `post` (the default) or `get`. Optional
# (infrastructure).
#? method = "post"
# `[pixm.endpoint]`, the family's outbound endpoint: the FHIR base URL of the
# PIX Manager (`url`, the `[base]` of `[base]/Patient/$ihe-pix`, PIXm
# §2:3.83.4.1.2), the timeout of one ITI-83 exchange, its `retry`, the TLS
# (trust roots for a PIX Manager behind a private PKI, a client identity for
# mutual TLS) and the credential, such as the OAuth 2.0 client credentials
# grant whose access token every request carries (IUA ITI-72 §3.72.4.2). Any
# `userinfo` in the URL is masked in every rendering.
#? [pixm.endpoint]
# The service's URL (RFC 3986); required. It renders with its userinfo and its
# query masked, in `Debug` and when serialized. Optional (infrastructure).
#? url = ""
# How long one whole call may take; never zero. Optional (infrastructure).
#? timeout = "10s"
# How long opening the connection may take; unset, only `timeout` bounds it.
# Optional, unset by default (infrastructure).
#? connect_timeout = "500ms"
# How a failed call is tried again.
#? [pixm.endpoint.retry]
# How many times one call is tried in all; 1 tries once. Optional
# (infrastructure).
#? max_attempts = 3
# The wait before the second try. Optional (infrastructure).
#? initial_backoff = "200ms"
# The longest wait between two tries. Optional (infrastructure).
#? max_backoff = "5s"
# The TLS of the connection, built by the product's reader of TLS material.
#? [pixm.endpoint.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The credential the calls carry: HTTP Basic or the client credentials grant.
#? [pixm.endpoint.credentials]
# The Basic user-id. Optional (infrastructure).
#? user = ""
# The Basic password, rendered redacted. Optional, unset by default
# (infrastructure).
#? password = ""
# The file holding the Basic password. Optional, unset by default
# (infrastructure).
#? password_file = ""
# The client credentials grant.
#? [pixm.endpoint.credentials.oauth]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (infrastructure).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client identifier. Optional (infrastructure).
#? client_id = ""
# How the client authenticates. Optional (infrastructure).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default
# (infrastructure).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default
# (infrastructure).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (infrastructure).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (infrastructure).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (infrastructure).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (infrastructure).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (infrastructure).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (infrastructure).
#? audience = ""
# How long before the token expires a new one is fetched. Optional
# (infrastructure).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional
# (infrastructure).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (infrastructure).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (infrastructure).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional
# (infrastructure).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (infrastructure).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (infrastructure).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (infrastructure).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (infrastructure).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (infrastructure).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [pixm.endpoint.credentials.oauth.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The onward target the lane reaches on a caller's behalf, authenticating with
# `oauth`.
#? [pixm.endpoint.credentials.onward]
# The identifier of the issuer of the onward tokens, whose metadata names its
# token endpoint unless `token_endpoint` is set. It renders with any userinfo
# masked, as `SecretUrl` renders itself. Optional (infrastructure).
#? issuer = ""
# Whose tokens the issuer signs: `persons` (a delegated exchange), `patients`
# (a patient's own token) or `federation`; required, with no default. Optional,
# unset by default (infrastructure).
#? kind = "persons"
# The preset the issuer's profile starts from. Optional (infrastructure).
#? profile = "rfc9068"
# The token endpoint itself; empty to discover it from `issuer`. It renders
# with its userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client id at this issuer; empty for the lane's own. Optional
# (infrastructure).
#? client_id = ""
# The audiences an onward token may name, at least one. Optional
# (infrastructure).
#? audiences = []
# The `resource` or `audience` values the request names, as the profile's
# `onward_indicator` says. Optional (infrastructure).
#? indicators = []
# The `scope` the request names; empty for none. Optional (infrastructure).
#? scope = ""
# The claim a chained federation route carries from the subject token to the
# onward token; empty for none. Optional (infrastructure).
#? correlation_claim = ""
# Whether the lane holds the tokens it obtains until they near their `exp`.
# `false` exchanges a token at the issuer on every call, a setting for a
# performance measurement's self-test, never for production. `true` by default.
# Optional (infrastructure).
#? cache = true
# Whether every token exchange sent without an actor token names the lane's
# client as its actor with an assertion signed by the current key of its
# `oauth` table's key ring (RFC 8693 §2.1; `Onward::with_actor_assertion`).
# `false` by default. Optional (infrastructure).
#? actor_assertion = false
# The profile keys set over the preset; `max_onward_lifetime` is required, here
# or in the preset.
#? [pixm.endpoint.credentials.onward.keys]
# `Profile::person_key`. Optional, unset by default (infrastructure).
#? person_key = ""
# `Profile::tenant_claim`. Optional, unset by default (infrastructure).
#? tenant_claim = ""
# `Profile::client_claims`. Optional, unset by default (infrastructure).
#? client_claims = []
# `Profile::impersonation_marker`. Optional, unset by default (infrastructure).
#? impersonation_marker = ""
# `Profile::expect`. Optional, unset by default (infrastructure).
#? expect = {}
# `Profile::user_claims`. Optional, unset by default (infrastructure).
#? user_claims = []
# `Profile::person_equality`. Optional, unset by default (infrastructure).
#? person_equality = []
# `Profile::unstable_claims`. Optional, unset by default (infrastructure).
#? unstable_claims = []
# `Profile::first_party_clients`. Optional, unset by default (infrastructure).
#? first_party_clients = []
# `Profile::max_actor_chain`. Optional, unset by default (infrastructure).
#? max_actor_chain = 0
# `Profile::act_represents_patient`. Optional, unset by default
# (infrastructure).
#? act_represents_patient = false
# `Profile::token_types`. Optional, unset by default (infrastructure).
#? token_types = []
# `Profile::required_claims`. Optional, unset by default (infrastructure).
#? required_claims = []
# `Profile::adapter`. Optional, unset by default (infrastructure).
#? adapter = ""
# `Profile::max_onward_lifetime`, a duration such as `"10min"`. Optional, unset
# by default (infrastructure).
#? max_onward_lifetime = "500ms"
# `Profile::onward_grant`. Optional, unset by default (infrastructure).
#? onward_grant = "token_exchange"
# `Profile::onward_indicator`. Optional, unset by default (infrastructure).
#? onward_indicator = "resource"
# `Profile::onward_parameters`. Optional, unset by default (infrastructure).
#? onward_parameters = {}
# `Profile::onward_client_id`. Optional, unset by default (infrastructure).
#? onward_client_id = false
# `Profile::onward_subject_audience`. Optional, unset by default
# (infrastructure).
#? onward_subject_audience = false
# `Profile::onward_preview`. Optional, unset by default (infrastructure).
#? onward_preview = []
# `Profile::app_only`.
#? [[pixm.endpoint.credentials.onward.keys.app_only]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::guest`.
#? [[pixm.endpoint.credentials.onward.keys.guest]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::delegates`.
#? [[pixm.endpoint.credentials.onward.keys.delegates]]
# The actor's issuer. Optional, unset by default (infrastructure).
#? issuer = ""
# The actor's `sub`. Optional, unset by default (infrastructure).
#? sub = ""
# The client. Optional, unset by default (infrastructure).
#? client = ""
# `Profile::representation`.
#? [pixm.endpoint.credentials.onward.keys.representation]
# The claim naming the subject the person represents. Required in its table
# (infrastructure).
#? claim = ""
# The claim carrying the ground of the representation, as asserted. Optional,
# unset by default (infrastructure).
#? ground_claim = ""
# `Profile::scope_claim`.
#? [pixm.endpoint.credentials.onward.keys.scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# `Profile::app_only_scope_claim`.
#? [pixm.endpoint.credentials.onward.keys.app_only_scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# What a `federation` issuer asserts, over its preset's defaults;
# `exchanges_from` and `person_mapping` are required.
#? [pixm.endpoint.credentials.onward.federation]
# The `[auth.issuer]` this table describes, of kind `federation`. It renders
# with any userinfo masked, as `SecretUrl` renders itself. Optional
# (infrastructure).
#? issuer = ""
# Whether the issuer is a MyHealth@EU contact point; required, with no default.
# Optional, unset by default (infrastructure).
#? contact_point = false
# The default sources the table starts from. Optional, unset by default
# (infrastructure).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (infrastructure).
#? fields = {}
# The country codes a professional may carry. Optional (infrastructure).
#? countries = []
# The issuing authorities a professional or provider may name. Optional
# (infrastructure).
#? issuing_authorities = []
# The prefixes a healthcare provider identifier must start with. Optional
# (infrastructure).
#? provider_identifier_prefixes = []
# Whether the issuer attests the `authorization_details` it puts in a token,
# which RFC 9396 §12 has "sent through the user agent". Optional
# (infrastructure).
#? attests_authorization_details = false
# The `authorization_details` type the attributes are read from. Optional,
# unset by default (infrastructure).
#? authorization_details_type = ""
# The `authorization_details` types that state an organisation's access.
# Optional (infrastructure).
#? organisation_types = []
# The claim holding the Verifiable Presentations of a Nuts RFC021 §6
# introspection response, `vps`. Optional, unset by default (infrastructure).
#? presentations_claim = ""
# The credential types the deployment declares user-authenticated. Optional
# (infrastructure).
#? user_credential_types = []
# The fields every token of the issuer must carry, each with a source. Optional
# (infrastructure).
#? required_fields = []
# Whether the issuer's tokens must be sender-constrained, so the issuer fails
# to load without `sender_constraint = "required"`. Optional (infrastructure).
#? requires_sender_constraint = false
# The subject-token issuers whose persons this issuer is trusted to map to its
# own, when it issues onward tokens (`client::onward`). Optional
# (infrastructure).
#? exchanges_from = []
# The subject-token claim, a dotted path, whose value an onward token of this
# issuer must carry as `professional.hp_identifier`. Optional, unset by default
# (infrastructure).
#? person_mapping = ""
# The assurance level the issuer's tokens carry.
#? [pixm.endpoint.credentials.onward.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (infrastructure).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (infrastructure).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (infrastructure).
#? minimum = "low"
# The PMIR Patient Identity Registry FerroEHR subscribes to (ITI-94) and whose
# merges, unmerges and links it applies (ITI-93); absent, no subscription is
# held.
#? [pix]
# The issuer of the access token the Registry presents with every ITI-93
# message (§2:3.93.5, IUA): one of the `[auth]` issuers. Optional (trust).
#? feed_issuer = ""
# The `client_id` that access token names: the only client whose ITI-93
# messages are applied. Optional (trust).
#? feed_client_id = ""
# How many refused ITI-93 messages still to retry or settle turn the
# `pmir_refused_messages` health indicator `DEGRADED`; at least 1. A refused
# message keeps the identifiers it split unresolved until an operator acts on
# it. Optional.
#? refused_degraded_at = 1
# `[pix.endpoint]`, the family's outbound endpoint: the FHIR base URL of the
# Patient Identity Registry (`url`, the `[base]` of `[base]/Subscription`, PMIR
# 1.6.0 §2:3.94.4.1.2), the timeout of one ITI-94 exchange, its `retry`, the
# TLS and the credential by which the Registry authorizes the subscription
# (§2:3.94.5), such as the OAuth 2.0 client credentials grant (IUA ITI-72
# §3.72.4.2).
#? [pix.endpoint]
# The service's URL (RFC 3986); required. It renders with its userinfo and its
# query masked, in `Debug` and when serialized. Optional (infrastructure).
#? url = ""
# How long one whole call may take; never zero. Optional (infrastructure).
#? timeout = "10s"
# How long opening the connection may take; unset, only `timeout` bounds it.
# Optional, unset by default (infrastructure).
#? connect_timeout = "500ms"
# How a failed call is tried again.
#? [pix.endpoint.retry]
# How many times one call is tried in all; 1 tries once. Optional
# (infrastructure).
#? max_attempts = 3
# The wait before the second try. Optional (infrastructure).
#? initial_backoff = "200ms"
# The longest wait between two tries. Optional (infrastructure).
#? max_backoff = "5s"
# The TLS of the connection, built by the product's reader of TLS material.
#? [pix.endpoint.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The credential the calls carry: HTTP Basic or the client credentials grant.
#? [pix.endpoint.credentials]
# The Basic user-id. Optional (infrastructure).
#? user = ""
# The Basic password, rendered redacted. Optional, unset by default
# (infrastructure).
#? password = ""
# The file holding the Basic password. Optional, unset by default
# (infrastructure).
#? password_file = ""
# The client credentials grant.
#? [pix.endpoint.credentials.oauth]
# The issuer whose metadata names the token endpoint; exclusive with
# `token_endpoint`. It renders with any userinfo masked, as `SecretUrl` renders
# itself. Optional (infrastructure).
#? issuer = ""
# The token endpoint itself; exclusive with `issuer`. It renders with its
# userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client identifier. Optional (infrastructure).
#? client_id = ""
# How the client authenticates. Optional (infrastructure).
#? client_auth = "client_secret_basic"
# The client secret, rendered redacted. Optional, unset by default
# (infrastructure).
#? client_secret = ""
# The file holding the client secret. Optional, unset by default
# (infrastructure).
#? client_secret_file = ""
# The PEM file holding the private key of the client assertion under
# `private_key_jwt`, and of the actor assertion of an onward exchange
# (`credentials.onward.actor_assertion`) whatever the client authentication.
# Optional, unset by default (infrastructure).
#? private_key_file = ""
# The `kid` the assertion names; the RFC 7638 thumbprint when empty. Optional
# (infrastructure).
#? kid = ""
# The algorithm the assertion is signed with; when unset, by key type, an EC
# key by its curve (P-256 ES256, P-384 ES384). Optional, unset by default
# (infrastructure).
#? assertion_alg = ""
# The `scope` request parameter; empty for none. Optional (infrastructure).
#? scope = ""
# The RFC 8707 resource indicator; empty for none. Optional (infrastructure).
#? resource = ""
# The `audience` request parameter; empty for none. Optional (infrastructure).
#? audience = ""
# How long before the token expires a new one is fetched. Optional
# (infrastructure).
#? refresh_margin = "30s"
# How long one call to the authorization server may take. Optional
# (infrastructure).
#? timeout = "10s"
# The PEM file of the `DPoP` key the tokens are bound to (RFC 9449). Optional,
# unset by default (infrastructure).
#? dpop_key_file = ""
# Whether the tokens are bound to the client certificate (RFC 8705 §3).
# Optional (infrastructure).
#? certificate_bound = false
# The security profile: `oauth2` (the default) or `fapi2`. Optional
# (infrastructure).
#? security_profile = "oauth2"
# The hosts a FAPI 2.0 mutual-TLS alias may be on (RFC 8705 §5). Optional
# (infrastructure).
#? mtls_alias_hosts = []
# The PEM file of the previous assertion key, published, never signing.
# Optional, unset by default (infrastructure).
#? previous_private_key_file = ""
# How long the previous key stays published; `0s` for as long as it is set.
# Optional (infrastructure).
#? previous_key_overlap = "0s"
# The PEM file of the next assertion key, published and never signing.
# Optional, unset by default (infrastructure).
#? next_private_key_file = ""
# The RFC 9396 `authorization_details` JSON text; empty for none. Optional
# (infrastructure).
#? authorization_details = ""
# The TLS of the token endpoint connection: trust roots beside the platform's,
# the client identity presented over mutual TLS (RFC 8705 §2) and the minimum
# version. The crate reads none of it: a table that names material resolves
# through the product's `TlsBuilder`.
#? [pix.endpoint.credentials.oauth.tls]
# The client certificate chain and its private key, in one PEM. Optional, unset
# by default (infrastructure).
#? client_identity = ""
# A file holding `client_identity`. Optional, unset by default
# (infrastructure).
#? client_identity_file = ""
# A PEM bundle of trust roots beside the platform's. Optional, unset by default
# (infrastructure).
#? trust_roots_file = ""
# The oldest TLS version the client speaks: `"1.3"` unless lowered to `"1.2"`,
# as for the listener. Optional (infrastructure).
#? min_version = "1.3"
# The onward target the lane reaches on a caller's behalf, authenticating with
# `oauth`.
#? [pix.endpoint.credentials.onward]
# The identifier of the issuer of the onward tokens, whose metadata names its
# token endpoint unless `token_endpoint` is set. It renders with any userinfo
# masked, as `SecretUrl` renders itself. Optional (infrastructure).
#? issuer = ""
# Whose tokens the issuer signs: `persons` (a delegated exchange), `patients`
# (a patient's own token) or `federation`; required, with no default. Optional,
# unset by default (infrastructure).
#? kind = "persons"
# The preset the issuer's profile starts from. Optional (infrastructure).
#? profile = "rfc9068"
# The token endpoint itself; empty to discover it from `issuer`. It renders
# with its userinfo and its query masked. Optional (infrastructure).
#? token_endpoint = ""
# The client id at this issuer; empty for the lane's own. Optional
# (infrastructure).
#? client_id = ""
# The audiences an onward token may name, at least one. Optional
# (infrastructure).
#? audiences = []
# The `resource` or `audience` values the request names, as the profile's
# `onward_indicator` says. Optional (infrastructure).
#? indicators = []
# The `scope` the request names; empty for none. Optional (infrastructure).
#? scope = ""
# The claim a chained federation route carries from the subject token to the
# onward token; empty for none. Optional (infrastructure).
#? correlation_claim = ""
# Whether the lane holds the tokens it obtains until they near their `exp`.
# `false` exchanges a token at the issuer on every call, a setting for a
# performance measurement's self-test, never for production. `true` by default.
# Optional (infrastructure).
#? cache = true
# Whether every token exchange sent without an actor token names the lane's
# client as its actor with an assertion signed by the current key of its
# `oauth` table's key ring (RFC 8693 §2.1; `Onward::with_actor_assertion`).
# `false` by default. Optional (infrastructure).
#? actor_assertion = false
# The profile keys set over the preset; `max_onward_lifetime` is required, here
# or in the preset.
#? [pix.endpoint.credentials.onward.keys]
# `Profile::person_key`. Optional, unset by default (infrastructure).
#? person_key = ""
# `Profile::tenant_claim`. Optional, unset by default (infrastructure).
#? tenant_claim = ""
# `Profile::client_claims`. Optional, unset by default (infrastructure).
#? client_claims = []
# `Profile::impersonation_marker`. Optional, unset by default (infrastructure).
#? impersonation_marker = ""
# `Profile::expect`. Optional, unset by default (infrastructure).
#? expect = {}
# `Profile::user_claims`. Optional, unset by default (infrastructure).
#? user_claims = []
# `Profile::person_equality`. Optional, unset by default (infrastructure).
#? person_equality = []
# `Profile::unstable_claims`. Optional, unset by default (infrastructure).
#? unstable_claims = []
# `Profile::first_party_clients`. Optional, unset by default (infrastructure).
#? first_party_clients = []
# `Profile::max_actor_chain`. Optional, unset by default (infrastructure).
#? max_actor_chain = 0
# `Profile::act_represents_patient`. Optional, unset by default
# (infrastructure).
#? act_represents_patient = false
# `Profile::token_types`. Optional, unset by default (infrastructure).
#? token_types = []
# `Profile::required_claims`. Optional, unset by default (infrastructure).
#? required_claims = []
# `Profile::adapter`. Optional, unset by default (infrastructure).
#? adapter = ""
# `Profile::max_onward_lifetime`, a duration such as `"10min"`. Optional, unset
# by default (infrastructure).
#? max_onward_lifetime = "500ms"
# `Profile::onward_grant`. Optional, unset by default (infrastructure).
#? onward_grant = "token_exchange"
# `Profile::onward_indicator`. Optional, unset by default (infrastructure).
#? onward_indicator = "resource"
# `Profile::onward_parameters`. Optional, unset by default (infrastructure).
#? onward_parameters = {}
# `Profile::onward_client_id`. Optional, unset by default (infrastructure).
#? onward_client_id = false
# `Profile::onward_subject_audience`. Optional, unset by default
# (infrastructure).
#? onward_subject_audience = false
# `Profile::onward_preview`. Optional, unset by default (infrastructure).
#? onward_preview = []
# `Profile::app_only`.
#? [[pix.endpoint.credentials.onward.keys.app_only]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::guest`.
#? [[pix.endpoint.credentials.onward.keys.guest]]
# The claim of `{ claim, value }`. Optional, unset by default (infrastructure).
#? claim = ""
# The value of `{ claim, value }`. Optional, unset by default (infrastructure).
#? value = ""
# The claim of `{ absent_claim }`. Optional, unset by default (infrastructure).
#? absent_claim = ""
# The subjects of `{ subjects }`. Optional, unset by default (infrastructure).
#? subjects = []
# The `{ sub_is_client = true }` form. Optional, unset by default
# (infrastructure).
#? sub_is_client = false
# The claim of `{ differs_from_iss }`. Optional, unset by default
# (infrastructure).
#? differs_from_iss = ""
# `Profile::delegates`.
#? [[pix.endpoint.credentials.onward.keys.delegates]]
# The actor's issuer. Optional, unset by default (infrastructure).
#? issuer = ""
# The actor's `sub`. Optional, unset by default (infrastructure).
#? sub = ""
# The client. Optional, unset by default (infrastructure).
#? client = ""
# `Profile::representation`.
#? [pix.endpoint.credentials.onward.keys.representation]
# The claim naming the subject the person represents. Required in its table
# (infrastructure).
#? claim = ""
# The claim carrying the ground of the representation, as asserted. Optional,
# unset by default (infrastructure).
#? ground_claim = ""
# `Profile::scope_claim`.
#? [pix.endpoint.credentials.onward.keys.scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# `Profile::app_only_scope_claim`.
#? [pix.endpoint.credentials.onward.keys.app_only_scope_claim]
# The claim. Required in its table (infrastructure).
#? claim = ""
# Its JSON form. Optional (infrastructure).
#? form = "string"
# What a `federation` issuer asserts, over its preset's defaults;
# `exchanges_from` and `person_mapping` are required.
#? [pix.endpoint.credentials.onward.federation]
# The `[auth.issuer]` this table describes, of kind `federation`. It renders
# with any userinfo masked, as `SecretUrl` renders itself. Optional
# (infrastructure).
#? issuer = ""
# Whether the issuer is a MyHealth@EU contact point; required, with no default.
# Optional, unset by default (infrastructure).
#? contact_point = false
# The default sources the table starts from. Optional, unset by default
# (infrastructure).
#? mapping = "iua"
# The sources of each field, over the mapping's. Optional (infrastructure).
#? fields = {}
# The country codes a professional may carry. Optional (infrastructure).
#? countries = []
# The issuing authorities a professional or provider may name. Optional
# (infrastructure).
#? issuing_authorities = []
# The prefixes a healthcare provider identifier must start with. Optional
# (infrastructure).
#? provider_identifier_prefixes = []
# Whether the issuer attests the `authorization_details` it puts in a token,
# which RFC 9396 §12 has "sent through the user agent". Optional
# (infrastructure).
#? attests_authorization_details = false
# The `authorization_details` type the attributes are read from. Optional,
# unset by default (infrastructure).
#? authorization_details_type = ""
# The `authorization_details` types that state an organisation's access.
# Optional (infrastructure).
#? organisation_types = []
# The claim holding the Verifiable Presentations of a Nuts RFC021 §6
# introspection response, `vps`. Optional, unset by default (infrastructure).
#? presentations_claim = ""
# The credential types the deployment declares user-authenticated. Optional
# (infrastructure).
#? user_credential_types = []
# The fields every token of the issuer must carry, each with a source. Optional
# (infrastructure).
#? required_fields = []
# Whether the issuer's tokens must be sender-constrained, so the issuer fails
# to load without `sender_constraint = "required"`. Optional (infrastructure).
#? requires_sender_constraint = false
# The subject-token issuers whose persons this issuer is trusted to map to its
# own, when it issues onward tokens (`client::onward`). Optional
# (infrastructure).
#? exchanges_from = []
# The subject-token claim, a dotted path, whose value an onward token of this
# issuer must carry as `professional.hp_identifier`. Optional, unset by default
# (infrastructure).
#? person_mapping = ""
# The assurance level the issuer's tokens carry.
#? [pix.endpoint.credentials.onward.assurance]
# The claim carrying the authentication context class, a dotted path; `acr` by
# default (OpenID Connect Core 1.0 §2). Optional (infrastructure).
#? claim = "acr"
# The level each claim value the issuer emits stands for; a value the map does
# not name carries none. Optional (infrastructure).
#? levels = {}
# The level a request held to the section must carry; none refuses nothing.
# Optional, unset by default (infrastructure).
#? minimum = "low"
# The `DV_IDENTIFIER.type` a patient identifier of each domain is written with
# when the feed links it to a `PERSON` no other `PERSON` hands it from. A
# domain named nowhere takes the one type the patient `PERSON`s already carry
# it with; with none, a message linking one is refused and names the domain.
#? [[pix.identifier_domain]]
# The domain's `Identifier.system`, the `DV_IDENTIFIER.issuer` its identifiers
# are carried under, such as `urn:oid:2.999.1.1`. Optional (infrastructure).
#? system = ""
# The `DV_IDENTIFIER.type` they are written with, such as `MR`. Optional
# (infrastructure).
#? identifier_type = ""