Export von Adressierungsinformationen als JWS [L]
Warum machen wir das?
Um über die Routing API nach fachlichen Zuständigkeitskriterien gefunden zu werden, muss die Destination-ID in einem FIM Redaktionssystem manuell eingetragen werden werden. Um weitere Plausibilisierungen und Validierungen zu ermöglichen, soll die Adresse des Zustelldienstes, die Leistungen und Regionen mit im XZuFi hinterlegt werden.
Eine Hinterlegung der in XZuFi hinterlegten Informationen soll zur Integritätssicherung signiert erfolgen. Hierdurch werden nicht nur Manipulationen der Daten verhindert, sondern auch Fehler bei der Eintragung von Informationen (Zahlendreher, etc.) in das XZuFi-System vermieden.
Die Signatur der Adressierungsinformationen wird durch das FIT-Connect-Self-Service-Portal erstellt und kann mit Hilfe des öffentlichen Schlüssels des Self-Service-Portals geprüft werden.
Relevante Links und Bemerkungen
- Konzept zu Eintragung in XZuFI: https://git.fitko.de/fit-connect/konzepte/-/blob/main/Konzept_Eintragung_Zustellpunkte_XZuFi.md
- Architekturabbildung zum Datenfluss des JWS Token hin zum Routingdienst: Architektur_Anbindung_Routingdienst.pptx
Akzeptanzkriterien
-
Das Self-Service-Portal erstellt einen JWS mit dem Payload und der Signatur gemäß dem Konzept für eine ausgewählte Destination. Das JWS enthält alle Serviceobjekte die für eine Destination hinterlegt sind. -
Der Public Key des vom Self-Service-Portal genutzten Schlüsselpaares wird über einen .well-known
-Endpunkt bereitgestellt. Dieser Endpunkt ist frei aus dem Internet erreichbar. -
Der .well-known
-Endpunkt verfügt über Cache-Control-Header. siehe #242 -
Die Adresse des .well-known
-Endpunkts ist prominent im Kontext des SSP für die Allgemeinheit dokumentiert. Für die Entwickler/Betreiber des Routingdienstes muss die technische Adresse zuverlässig mitgeteilt werden. -
Die Signatur erfüllt alle Signaturvorgaben. -
Die Signatur wird im UI dargestellt und kann von Nutzer:innen kopiert werden. Das Self-Service-Portal exportiert den Datenbestand in der Compact Serialization -
Im SSP wird ein entsprechender Hinweis angezeigt, was es mit den Zuständigkeitsinformationen auf sich hat und was mit diesen gemacht werden muss (-> Eintragung in XZuFi via FIM-Redaktionssytem). Ggf. wird hier entsprechende Dokumentation unter docs.fitko.de verlinkt. (@Marco_Holz liefert einen Textvorschlag) -> Bitte verlinken auf https://docs.fitko.de/fit-connect/docs/getting-started/receiving/routing. Siehe docs!84 (merged) -
Das SSP exportiert immer den aktuellen Datenbestand als JWS.
Umsetzungsschritte
-
.well-known Endpunkt im Self Service Protal nach Vorbild im Zustelldienst erstellen (https://git.fitko.de/fit-connect/infrastruktur/-/merge_requests/38) -
Self Service Portal kann über Button eine JWS in der Destination Liste erstellen und kopierbar machen. (https://git.fitko.de/fit-connect/self-service-portal/-/merge_requests/27) -
Docs anpassen (SSP Screenshots ergänzen) (docs!84 (merged)) -
Release Changelog vorbereiten (docs!88 (merged))