Repository navigation
0.0.12
Security fixes until 2031-10-24, 5 years from this release (Regulation (EU) 2024/2847 Art 13(8), (19)), shipped only in the newest release (Art 13(10)). This release is supported while it is the newest; upgrade to the newest release to get a fix, as SECURITY.md says.
Upgrade notes
- The release's compose file and the Kubernetes example now set
FERROFED__USAGE_REPORT__STATE_DIR, so a gateway started from them sends
the installation report to FerroPULSE. Set
FERROFED__USAGE_REPORT__ENABLED=falsebefore you upgrade to keep it off
(#1122). [auth]is now theferrohealth-smartsection every FerroHEALTH product
reads (#1174). Move each issuer's FerroFED policy (backend_clients,
demographic_clients,client_tokens_act_for_professional,
professional_issuing_authority,[auth.issuer.patient],
[auth.issuer.requester],[auth.issuer.assurance],
[auth.issuer.national_contact_point]and an introspected issuer's
introspection_endpoint,client_idandclient_secret_file) to a
[[trust.issuer]]entry naming the sameissuer, andauth.mode,
[auth.edge]and[auth.purpose_of_use]totrust.mode,[trust.edge]
and[trust.purpose_of_use]. Dropjwks_urifrom each issuer: the key
set is read from the issuer's RFC 8414 metadata, or fromjwks_file.
Replace each issuer'soperator_scopewith the oneauth.product_scope,
a string starting with__or a full URI you control.auth.audienceis
a list, and the clock skew, key set and timeout keys are
clock_skew_seconds,jwks_max_age_seconds,
jwks_refresh_interval_secondsandtimeout_ms.- Every static bearer token is gone (#1163). Replace
bearer_tokenand
bearer_token_filein a[credentials."<endpoint>"]section or a
service's credentials withuserandpassword_file, or with anoauth
table, the client credentials grant offerrohealth-smart; Mitz, the NVI
and the terminology server takeuserandpassword_file. Replace
[metrics] scrape_token_filewithscrape_users, naming users of
[[auth.basic.users]]whose Argon2idpassword_hash_fileyou write, and
give Prometheusbasic_auth. Replace[pmir] feed_token_filewith
feed_users, naming the Registry's own[[auth.basic.users]]user, and
give the Registry its password. - An
oauth2section that asks for a plain client-credentials token, with
no token exchange, noDPoPkey, no binding to or authentication by the
TLS client certificate and an assertion naming the token endpoint, is
refused: move it to anoauthtable, whoseprivate_key_jwtsigns with
its ownprivate_key_file. - A log filter that names
ihe_iti::atna(the audit spool and forwarder)
namesihe_atna::atnainstead; the events are the same. - The operator console is now
ferrofed-console(#1219). Pull
ghcr.io/ferrohealth/ferrofed-consolein place of
ghcr.io/ferrohealth/ferrofed-viewer, rename every
FERROFED_VIEWER__<SECTION>__<KEY>override to
FERROFED_CONSOLE__<SECTION>__<KEY>andFERROFED_VIEWER_CONFIGto
FERROFED_CONSOLE_CONFIG, and run the binary asferrofed-console. The
session and theme cookies are renamed, so every operator signs in once
more after the upgrade. - If you edited the
ferroehr-configblock of the quickstart's
compose.yaml, FerroEHR 5.3.2 refuses the 4.3.9 Basic user keys at boot:
renameusernametouser, give each user itsscopes(the quickstart
grantsuser/composition-*.cruds,user/template-*.cruds,
user/aql-*.crudsand__ferroehr.platform), and move each user's
rolesto[authz.rbac.basic_roles]keyed by the user (#1226). - Bookmarks of the operator console's
/members,/routingand/federationpages answer404: use/organisations, a node's Routes tab under/organisations/{org}/{node}/routes, and/self-description(#1230). Each preference is now a cookie of its own (ferrofed_console_theme,ferrofed_console_density,ferrofed_console_motionand the others); the theme cookie isferrofed_console_themein place of 0.0.11'sferrofed_viewer_theme, so each operator chooses the theme once more. A deployment that builds the site bundle itself runscargo leptos build --split, asscripts/release/console-site.shdoes.
Added
- The gateway sends the FerroHEALTH installation report to FerroPULSE on its
envelope v2: onestartreport per process start and onedailyreport a
day, carrying a random instance id, the version, the deployment kind,
coarse host size, the member count as a range, the configured identity and
consent services, latency per route group and the node request counts, and
no patient data, AQL, path, node name or URL. It is on by default once
[usage_report] state_dirnames a writable directory, which the release's
compose file and the Kubernetes example set;enabled = false
(FERROFED__USAGE_REPORT__ENABLED=false) stops it, a CI environment stops
it, and one boot line says which. The book's
usage report page
lists every field and carries the privacy notice (#1122). - Mitz takes the OAuth 2.0 client credentials grant of
[nl_gf.mitz.credentials.oauth]beside basic credentials. The gateway
obtains the token at the token endpoint, which must behttpsoutside
profile = "development", caches it while it is fresh, and sends it with
each closed authorization question as a bearer token; a question Mitz
answers401is asked once more with a fresh token. Anoauth2,nuts
orfapi2grant is still refused at load (#1180). - The configuration page explains how it works in a dialog that How configuration works opens. The History tab filters its revisions by origin in an Origin menu that works with no WebAssembly, and each origin is a badge of its own colour. A secret's value field shows what you typed while you hold its eye, and stays masked otherwise (#1233).
- OpenVEX statements for FerroFED under
security/vex/: the Rust advisory
the dependency gate accepts (RUSTSEC-2024-0436,paste) with its
argument and dependency path, generated fromdeny.toml. Each release
attachesferrofed-vX.Y.Z-vulnerability-record.json, every finding of a
full scan of both images and the binaries with the statement that judges
it, and is refused while a finding has none; each image is scanned before
it is tagged, and the published images are scanned every week with the
VEX applied (#1238).
Changed
scripts/checks/changelog-guard.shandcrate-version-guard.shtake
origin/mainas the base when run with no refs, andstray-literals.sh
reads the console's sources when given no directory, so a local run of the
guards passes on a clean branch;docs/ci-cd.mdnames the guards that need
a built input first (#1151).- The book's dashboard and Integrity screenshots show an open incident, a
resolved one and a cleared collision, each with its time, so the visual
review covers the console's timestamp rows (#1154). - CI checks the operator console's
view!formatting with leptosfmt 0.1.33,
the version theui-gatesskill runs, before rustfmt, and the console's
sources pass it (#1155). - Only the newest release is supported.
SECURITY.md, the book and the
release notes say that every earlier release stops receiving fixes when a
new one is published, with no maintenance branches, no long-term-support
line and no backports, and that upgrading is free. Cadasto B.V. commits to
keep publishing security fixes for at least five years after each release
(Regulation (EU) 2024/2847 Art 13(8)) and ships them only in the newest
release (Art 13(10)); the end date each release states is the date until
which that commitment runs. The startup banner'sSupportline reads
newest release only, fixes until YYYY-MM-DD, the notice for a release
past its end date says to upgrade to the newest release, and the console
labels the dateFixes until. Thesupported_untilmember of
OPTIONS {base}/keeps its name and value. - Client authentication, the SMART on openEHR grants and the gateway's own
OAuth 2.0 client credentials run onferrohealth-smart0.3.1, the
resource-server crate every FerroHEALTH product shares (#1174). Every
token that does not verify is answered one401with
error="invalid_token"and no description (RFC 6750 §3.1, RFC 9068 §4),
and the security log names the failed check ascheck. Two
Authorizationfields, or one that is no credential, are a400
credential-malformedwitherror="invalid_request". A403names the
error code and no scope. An issuer's metadata and key set are read when
its first token arrives, so an issuer that cannot be reached is a503
authentication-unavailablethen, never a refused start. - The metrics scrape and the PMIR feed authenticate HTTP Basic users of
[[auth.basic.users]], named bymetrics.scrape_usersand
pmir.feed_users; one from another Basic user is answered403. - The audit trail and the access record come from the FerroHEALTH audit
library, FerroAUDIT: the ATNA ITI-20 sender, the BALPAuditEventwith
its FHIR Feed, and the European logging component are the published crates
ihe-atnaandehds-logging0.1.0, pinned exactly, and their local copies
incrates/ihe-itiandcrates/ehds-loggingare gone. What the gateway
records, where it sends it and how it spools it are unchanged. The log
events of the spool and the forwarder now carry the targets
ihe_atna::atna::spoolandihe_atna::atna::forwarderin place of
ihe_iti::atna::spoolandihe_iti::atna::forwarder. - The
openehr-*crates move to 0.0.90 withfhirconnect0.1.173,
openehr-mapping-core0.1.124 andfhir-types0.1.127, the line
ferrohealth-smart0.4.0 builds on, so the build holds one copy of
openehr-sdtand of every other family member (#1181). ferrohealth-smart0.4.0 (#1186). Every[<section>.oauth]table takes
the keys the crate adds:client_auth = "tls_client_auth"or
"self_signed_tls_client_auth"withclient_certificate_fileand
client_key_filefor RFC 8705 §2 mutual TLS to the token endpoint,
ca_filefor trust roots added to the platform's, and
assertion_audience = "issuer"(RFC 7523 §3). An issuer's metadata and
key set are still read on its first token, now by the crate; the
key-set-unavailableevent is written once per failed read. The answers
do not change.- The
e2e-placementguard now refuses a CI workflow that could skip the
container tests: a path filter on its triggers, a condition on the
e2e (containers)job beyond the workspace check, or aconclusioncheck
that does not wait for it. A change to the auth, credentials or
configuration code, an e2e fixture or the configuration reference always
runs the container tests (#1187). - The audit library and the identity crates move together:
ihe-atnaand
ehds-logging0.2.1 from FerroAUDIT,ihe-iti0.0.41 from FerroPIX on
thatihe-atna, andnl-generic-functions0.0.26 from FerroPIX on
ferrohealth-smart0.4.0, so the gateway carries one copy of it. What the
gateway records, where it sends it and how it spools it are unchanged; the
log targets of the spool and the forwarder stayihe_atna::atna::spool
andihe_atna::atna::forwarder, now a stable interface ofihe-atna. The
identity binding's FHIR Feed reaches anhttpbase throughihe-atna's
FeedRepository::cleartext, which names the operator's acceptance of clear
text (#1194). - The workspace builds with Rust 1.99.1 in place of 1.98.1, and the MSRV
stays at 1.98: the FerroHEALTH family builds with the latest stable
toolchain and declares the release before it as its MSRV. - The audit library moves to
ihe-atnaandehds-logging0.2.3, FerroAUDIT's
only supported release, with FerroPIX'sihe-iti0.0.43 on it. Nothing the
gateway records changes: FerroFED declares its category map with exact
matching, so its map digest is unchanged (#1211). - Breaking: the operator console is renamed from
ferrofed-viewerto
ferrofed-console(#1219): the crate and its binary
(app/ferrofed-console), the image (ghcr.io/ferrohealth/ferrofed-console
in place ofghcr.io/ferrohealth/ferrofed-viewer, which is not published
again), the release workflow and its attestation signer
(.github/workflows/release-console.yml), the Dockerfile
(docker/console/Dockerfile), the site and bundle scripts
(scripts/release/console-site.sh,console-tools.sh,
scripts/checks/console-bundle.sh,console-paths.sh), the CI job
(console), the configuration file variable (FERROFED_CONSOLE_CONFIG),
the environment prefix (FERROFED_CONSOLE__), the cookies
(ferrofed_console_session,ferrofed_console_sign_in,
ferrofed_console_theme, each with the__Host-prefix where secure) and
the catalog (locales/en/ferrofed-console.ftl). - The quickstart's four member CDRs and the test harness's FerroEHR nodes
move from FerroEHR 4.3.9 to 5.3.2, the release on the same corrected base,
with the node database image beside them (#1226). FerroEHR 5.1.0 changed
its Basic user keys and checks a Basic user's SMART on openEHR scopes on
every route, so the quickstart's FerroEHR configuration names its user with
user, grants it the three resource-family scopes and FerroEHR's product
scope, and moves its roles to[authz.rbac.basic_roles]; the restricted
harness node does the same for its two users. - The operator console is rebuilt on FerroUI 0.3.6 (
ferrohealth-ui,
pinned exactly, with itssplitfeature) in islands mode (#1230, #1233,
FerroHEALTH/FerroUI#161). The server draws every page whole from
FerroUI's components, stylesheet and FerroFED theme, and the browser
hydrates only FerroUI's interactive parts and the AQL editor, so every
page reads and every action works with no WebAssembly. Every action is a
plain form post to the page it sits on, answered by that page drawn again
with the outcome at its top; a form the console or a replica refuses is
drawn again as you typed it, the refused field marked. The pages follow
FerroUI's reviewed FerroFED design: a dashboard, the topology (with "How
it is drawn"), the organisations with their nodes (each node with its
endpoints and its routes), the services, the integrity incidents, the
stored queries with their versions, the query console, the
self-description on five tabs with the manufacturer the gateway
declares, the configuration, Your preferences and a find in the top bar.
The top bar names the replica that answered. Every state is FerroUI's
state mark (a shape and a word), and organisations and services carry
their own glyphs. On the configuration's Members and Credentials and
bindings tabs, each row's menu (⋯) holds Edit and Remove…, whose
confirmation asks for the reason the revision keeps; endpoints, settings
and new secrets are sub-cards whose rows Add and Remove change in place.
The site bundle is built withcargo leptos build --split. - The operator console is ready for more languages, English the one that
ships (#1162). Its words and FerroUI's come from Fluent catalogs, the
console's underapp/ferrofed-console/locales/en/, so a language joins as
a catalog directory with no code change. The locale is chosen once per
request: the language the operator chose in Your preferences, else the
best language ofAccept-Languagethe catalog holds, else the new
[server] locale(defaulten), and the page writes it as<html lang>.
scripts/checks/stray-literals.shfails CI on a console string outside
the catalog beyond the per-file baseline (94 literals) the remaining
strings hold while they move. - The release notes end with a link to the CRA information and
instructions to the user, and the release lane refuses a cut whose
Security section names an entry without its GitHub security advisory
(GHSA-) or VEX statement, or sits beside other changes without
"Shipped with functional changes because:" and its reason (Regulation
(EU) 2024/2847 Annex I Part II(2), (4), (8)).SECURITY.mdstates that a
security fix ships alone or the release says why, how a fixed
vulnerability's advisory is published with its release, and the
info@cadasto.comroute for a report without a GitHub account.
scripts/release/preflight.sh <tag>runs the release plan's checks
before the tag (#1237). ihe-iticomes from crates.io at=0.0.40, published by
FerroHEALTH/FerroPIX, which owns the crate from here on; the local copy
undercrates/is gone. Its features and its behaviour are the ones the
gateway already used: the PIXm, PDQm, mCSD, PMIR and XCPD clients, with
balpfor the FHIR profiles' audit records andatnafor the ITI-55
audit message, both written throughihe-atna.nl-generic-functionscomes from crates.io at=0.0.25, published by
FerroHEALTH/FerroPIX, which owns the crate from here on; the local copy
undercrates/is gone. Its Nuts grant now holds the authorization
server's issuer to the RFC 8414 rule offerrohealth-smart, so a plain
httpissuer is accepted on a loopback host only. The NVI, Mitz, LRZa and
Nuts behaviour is otherwise unchanged.- The patient summary the FHIR face writes applies the exchange format's
term-mapping rule: an RMTERM_MAPPINGwhosematchis broader, narrower
or unknown is written as no coding, and the section's narrative carries
it, naming the element, the relation, the target and the member it came
from (eHN PS Art 10(3)). An equivalent mapping stays a coding after the
original (#926).
Removed
- The Tailwind CSS CLI pin and its download are gone: the operator console
draws with ferrohealth-ui's stylesheet, soscripts/release/console-tools.sh
installs wasm-opt alone and the site build needs no Tailwind (#1150). - Static bearer tokens, inbound and outbound:
bearer_tokenand
bearer_token_filein every credentials section,[metrics] scrape_tokenandscrape_token_file, and[pmir] feed_tokenand
feed_token_file(#1163). Machine-to-machine authentication is HTTP Basic
or the OAuth 2.0 client credentials grant. - The operator console's routes
/members,/members/{node},/routingand/federationare gone: the members are/organisationsand/organisations/{org}/{node}, a node's routing table is its Routes tab, and the self-description is/self-description(#1230). The theme toggle is gone from the top bar; the theme is chosen in the operator's menu and in Your preferences. The console's server functions under/api/are gone, and with them its own stylesheet (style/theme.css) and scripts: it serves FerroUI's as the crate ships them.
Fixed
- The configuration journeys read the focused element and the credential's
value field afresh while they wait, so a re-render after a save no longer
fails them with a stale element (#1149). - The endpoint details show a dash for a value the gateway did not report
(the latency and row count of an excluded node, an organisation, or the
error of a node that answered), where a stacked card on a phone showed a
label with nothing after it. - The configuration screen labels
node_idandsystem_idas "Node id"
and "System id", with the configuration key as the field's hint (#1168). - The dashboard's card-header link is FerroUI's shared card action, so its
arrow keeps the space before it (#1169). - The book's screenshot of the console's Credentials and bindings tab, in
the light and the dark theme, is taken again and no longer shows the
removedbearer_tokenrow, and the environment override example on the
configuration page sets a password file in place of the removed
bearer_token_file(#1179). - The interoperability component's reference property admits
#from the
Patient entry, which FHIR R4 resolves to the holding resource itself, so
the test no longer fails when its generator draws that input; the case is
kept as a regression seed (#1195). - The trace hygiene tests name their synthetic patient with letters, so a
span'sbusy_nsoridle_nscan no longer spell the identifier and fail
the scan by chance (#1198). - A browser journey whose chromedriver loses its port to another process
starts another chromedriver, up to three times, so parallel journeys no
longer fail before they drive the browser (#1209). - The operator console's dashboard draws its cards two to a row, so the recent incidents table no longer overflows its card when an incident kind is long (#1207).
Security
Shipped with functional changes because: the three fixes reached main
between 2026-10-20 and 2026-10-23, and the owner cut this release from
main on 2026-10-24 with no security-only patch of 0.0.11 before it; only
the newest release is supported (SECURITY.md), so such a patch would be out
of support the moment this release lands and give no one a release to stay
on. Each fix is a dependency or base-image bump with no behaviour change of
its own.
- The TLS stack takes
rustls-webpki0.103.16 andwebpki-root-certs
1.0.10, the releases that fix RUSTSEC-2026-0382 and RUSTSEC-2026-0383
(distrusted emSign intermediates; GHSA-w3hc-w475-673c). - The gateway and console images no longer trust the compromised eMudhra
(emSign) intermediates in the system trust store (Debian DSA-6572-1,
GHSA-w3hc-w475-673c, #1226). The distroless base
gcr.io/distroless/static-debian13:nonrootmoves to index digest
d620678, which shipsca-certificates20250419+deb13u1, in theFROM
ofdocker/Dockerfileanddocker/console/Dockerfileand in the pin
row.rustls-webpki0.103.16 andwebpki-root-certs1.0.10 were
already in the lock file. ctutilsmoves from 0.4.2 to 0.4.4 (RUSTSEC-2026-0385,
GHSA-rv83-4vc9-vqxg): before 0.4.4 its constant-time mask generation and
u128comparisons could compile to a branch on a secret value. It
reaches the gateway throughdigestand the Argon2 password hashing of
ferrohealth-smart(#1232).
Information and instructions to the user (CRA Annex II)
CRA information and instructions to the user: the manufacturer, the vulnerability contact, the support period of every release, secure use, updates and decommissioning (Regulation (EU) 2024/2847 Art 13(18) and Annex II).