Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • fit-connect/docs
1 result
Show changes
Commits on Source (32)
Hide whitespace changes
Inline Side-by-side
Showing
with 295 additions and 107 deletions
docs/changelog.md
View file @ c5d1946d
......@@ -5,69 +5,64 @@ Das Format dieser Datei basiert auf [Keep a Changelog](https://keepachangelog.co
Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Connect](https://docs.fitko.de/fit-connect/docs/getting-started/get-started#testing).
## 2022-09-12
## 2022-10-10
### Dokumentation
- Dokumentation zum Abruf des Event Log überarbeitet: Die Informationen des bisherigen Artikels "Status abfragen" wurden aufgeteilt in einen generischen Artikel [Event Log abrufen](getting-started/event-log/get-events.mdx) im Abschnitt "Ereignisprotokoll" und den bestehenden Artikel [Empfangsbestätigung oder Zurückweisung](sending/accept-reject.mdx). Zudem wurde ein Hinweis zur Prüfung der Authentizität und Integrität des Event Log ergänzt.
- Dokumentation der [Überprüfung des öffentlichen Schlüssels](sending/encrypt.mdx#certificateValidation) beim Verschlüsseln von Antragsdaten konkretisiert.
## 2022-10-07
### Dokumentation
- Der Menüpunkt "Termine" wurde in die Hauptnavigation eingefügt. Dieser Menüpunkt führt zu einer Seite, die die Beschreibung der Online-Veranstaltungen der FITKO enthält.
## 2022-09-12
### Dokumentation
- Die Seite "Zustellpunkt ermitteln" befindet sich nun unter dem Menüpunkt "Infos für Entwickler:innen > Versand von Einreichungen".
- Die Seite "Konfiguration des Antragsroutings" ist nun in die Seite "Fachverfahren anbinden" integriert.
- Der Menüpunkt "Zuständigkeitsermittlung" ist entfallen.
## 2022-08-22
### Dokumentation
- Die Startseite wurde geändert.
- Inhalte, die bislang auf der Startseite zu finden waren, sind nun in den neuen Seiten "Anträge senden" und "Anträge empfangen" vorhanden, unterhalb des Menüpunkts "FIT-Connect nutzen".
- Der Menüpunkt "Infos für Verantwortliche" wurde eingeführt, mit den neuen Seiten "Fachverfahren anbinden", Onlinedienste/Softwareprogramme anbinden" und "Zertifikate beantragen".
## 2022-08-18
### Dokumentation
- Der Menüpunkt "Grundlagen" wurde umbenannt in "Infos für Entwickler:innen".
- Die Menüpunkte "Versand von Einreichung" und "Abruf von Einreichungen" befinden sich jetzt unterhalb des Menüpunkts "Grundlagen für Entwickler:innen".
## 2022-07-26
### Zustelldienst 1.8.1
- Fix: Eine erfolgreiche Prüfung der Signatur von Zustellpunkten ohne Antwortkanäle (`replyChannels`) war nicht möglich. Dies wurde behoben. Alle alten Signaturen wurden erneut berechnet und im DVDV aktualisiert. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/487))
- Fix: Unter bestimmten Umständen war es möglich einen Anhang doppelt mit gleicher `attachmentId` zu hinterlegen.
### Zustelldienst 1.8.0
- Keine Exceptions in HTTP-Responses im Produktivbetrieb. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/59))
- Fix: Header callback-timestamp wird bei Wiederholungen des Callbacks nicht aktualisiert ([Bug](https://git.fitko.de/fit-connect/planning/-/issues/500))
## 2022-06-29
### Zustelldienst 1.6.1
### Zustelldienst 1.7.0, 1.7.1
- Callback um Destination-ID ergänzen: Callbacks wurden um das Array 'submissions' ergänzt. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/301))
- API-Version wurde auf `1.1.0` geändert.
- Prüfung der JWE Objekte durch den Zustelldienst. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/338))
## 2022-06-29
### Zustelldienst 1.6.0, 1.6.1
- Anfertigen von Statistiken von Submissions (Fachdaten) und deren Anhängen. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/272))
## 2022-06-14
### Zustelldienst 1.5.15
- Prüfung der in Zustellpunkten hinterlegten Zertifikate (JWK). ([Story](https://git.fitko.de/fit-connect/planning/-/issues/119))
Fehler in der Zertifikatskette werden vorerst nur geloggt.
## 2022-06-02
### Self Service Portal 1.3.7
- Fix: Es war möglich, sich über das Self-Service-Portal Zugriff auf fremde Destinations zu verschaffen
<!-- https://git.fitko.de/fit-connect/planning/-/issues/449 -->
### Zustelldienst 1.5.14
- Fix: SQL Fehler in DB Migration bzgl. Jobrunr
### Zustelldienst 1.5.13
- Benachrichtigung des technischen Ansprechpartners bei nicht-erfolgtem Abruf durch Subscriber - Szenario 1. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/304))
- Benachrichtigung des technischen Ansprechpartners bei nicht-erfolgtem Abruf durch Subscriber - Szenario 2. ([Story](https://git.fitko.de/fit-connect/planning/-/issues/372))
- Umsetzung korrekter HTTP Header wie Content-Security-Policy ([Story](https://git.fitko.de/fit-connect/planning/-/issues/308)) sowie X-Frame-Options und X-XSS-Protection ([Story](https://git.fitko.de/fit-connect/planning/-/issues/309)).
......
docs/details/callbacks.mdx
View file @ c5d1946d
......@@ -6,7 +6,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ApiLink from '@site/src/components/ApiLink';
Der FIT-Connect Zustelldienst informiert sendende und empfangende Systeme (API-Clients) aktiv über [neue Einreichungen](../receiving/notification.mdx) oder [Statusupdates](../sending/query-status.mdx).
Der FIT-Connect Zustelldienst informiert sendende und empfangende Systeme (API-Clients) aktiv über [neue Einreichungen](../receiving/notification.mdx) oder [Statusupdates](../sending/accept-reject.mdx).
Hierzu werden HTTP-Callbacks genutzt, die auch als [Webhooks](https://de.wikipedia.org/wiki/WebHooks) bezeichnet werden.
Webhooks ermöglichen es, API-Clients aktiv über diese Ereignisse zu informieren, ohne dass eine regelmäßige Abfrage ([Polling](https://de.wikipedia.org/wiki/Polling_(Informatik))) nötig wäre.
Technisch werden Webhooks als HTTP-POST-Request realisiert.
......
docs/details/responsible-disclosure.mdx
View file @ c5d1946d
......@@ -12,7 +12,7 @@ Alternativ findet ihr die wesentlichen Informationen in Kurzform nach dem [Secur
## Meldung von Schwachstellen
Wenn ihr glaubt, eine Schwachstelle in FIT-Connect oder einem anderen von der FITKO betriebenen Dienst gefunden zu haben, teilt uns dies bitte so schnell wie möglich nach Entdeckung mit, vorzugsweise per E-Mail an `it-sicherheit`@`fitko.de`.
Verwendet dabei bitte [unseren PGP-Schlüssel](https://keys.openpgp.org/search?q=924BDA2DF08D50B179CE3A46E4EDC7C651502C53) mit dem Fingerprint `924B DA2D F08D 50B1 79CE 3A46 E4ED C7C6 5150 2C53`.
Verwendet dabei bitte [unseren PGP-Schlüssel](https://keys.openpgp.org/search?q=924BDA2DF08D50B179CE3A46E4EDC7C651502C53) mit dem Fingerprint `924B DA2D F08D 50B1 79CE 3A46 E4ED C7C6 5150 2C53` sowie den Betreff `Responsible Disclosure: <ihr Betreff>`.
Wenn ihr einen telefonischen Austausch wünscht, gebt bitte eine Telefonnummer an, unter der wir euch erreichen können.
Folgende Details sind dabei für uns besonders relevant und helfen etwaiige Lücken schneller zu beheben:
......
docs/sending/query-status.mdx → docs/getting-started/event-log/get-events.mdx
View file @ c5d1946d
---
title: Status abfragen
title: Event Log abrufen
---
import ApiLink from '@site/src/components/ApiLink'
Nachdem die Einreichung versendet worden ist, kann der Status dieser abgefragt werden.
Der Status ist für das sendende System relevant, da hierüber das empfangende System mitteilt, ob es die Einreichung technisch korrekt verarbeiten konnte.
Bis zu einer Bestätigung über den Status `accepted` sollte das System sämtliche Inhalte einer Einreichung vorhalten.
Dies sollte es tun, damit es im Falle eines Fehlers (aufgrund eines inkorrekten Schemas oder eines falschen Public Keys), den Fehler eventuell korrigieren kann und Informationen korrekt übermitteln kann, ohne den Nutzer (bspw. einen Antragssteller) zu einer erneuten Dateneingabe aufzufordern.
Zudem stellt der Status in Form des signierten Security-Event-Tokens einen sicheren Nachweis der Übermittlung und des Empfangs dar, der gegenüber Dritten genutzt werden kann.
Das Statusmodell einer Einreichung ist in der folgenden Grafik dargestellt und enthält fünf Zustände (in orange), die in der darunterliegenden Tabelle beschrieben sind.
Die in blau und grün dargestellten [Ereignisse](../getting-started/event-log/events.mdx) werden unter "Ereignisprotokoll" im Bereich "Grundlagen" beschreiben.
![Statusdiagramm](/images/status/status.svg)
| Status | Bedeutung |
|---------------|---------------------------------------------------------------------------------------------------------|
| `incomplete` | Das sendende System hat begonnen, die Einreichung zu übermitteln. Sie jedoch noch nicht abgesendet. |
| `submitted` | Das sendende System hat die Einreichung vollständig übermittelt und abgesendet. |
| `forwarded` | Ein vermittelndes System hat die Einreichung übernommen, sie aber noch nicht dem Zielsystem zugestellt. |
| `rejected` | Die Einreichung wurde durch den Empfänger zurückgewiesen. |
| `accepted` | Die Einreichung wurde durch den Empfänger akzeptiert. |
# Abruf von Ereignissen über das Event Log
Der Event Log einer Einreichung kann über den Endpunkt <ApiLink api="submission-api" to="/v1/cases/{caseId}/events" /> abgefragt werden.
Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert. Dieser Event Log beinhaltet die verschiedenen Statusübergänge bzw. abgelegten Ereignisse.
Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
:::tip Hinweis
Die Authentizität und Integrität der aus dem Event Log abgerufenen Ereignisse SOLLTE bei jedem Abruf geprüft werden. Die notwendigen Prüfungen sind im Artikel [Prüfung eines Security-Event-Token](set-validation.mdx) beschrieben.
:::
Über die Queryparameter `offset` und `limit` kann das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen:
......@@ -81,4 +67,4 @@ In dem SET ist folgende Information abgelegt:
Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung in diesem Case `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 10:48:52 war.
Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden.
Die Überprüfung ist im Artikel [Prüfung eines Security-Event-Token (SET)](../getting-started/event-log/set-validation.mdx) beschrieben.
Die Überprüfung ist im Artikel [Prüfung eines Security-Event-Token (SET)](set-validation.mdx) beschrieben.
docs/getting-started/event-log/set-validation.mdx
View file @ c5d1946d
......@@ -6,10 +6,6 @@ import ApiLink from '@site/src/components/ApiLink'
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
# SET Prüfung
## Einleitung {#einleitung}
Um eine vollständige Prüfung eines Security-Event-Tokens durchzuführen, MUSS zwingend sowohl die Einhaltung der (kryptografischen) Vorgaben als auch die Signatur geprüft werden.
Die Prüfung der Signatur des SET ist abhängig vom ausstellenden System (Zustelldienst, Subscriber oder Sender).
Aus technischer Sicht sollte auch das unter `$schema` angegebene SET-Payload-Schema validiert werden.
......@@ -17,6 +13,7 @@ Dies wird z.B. auch schon vom zuständigen Zustelldienst gemacht.
Aktuell ist die Angabe eines SET-Payload-Schemas aber noch optional und kann nicht existieren.
Dies wird in unspezifizierter Zukunft `deprecated` und alle SETs müssen ein valides SET-Payload-Schema verwenden und angeben.
In dem Fall, dass das SET-Payload-Schema nicht angegeben ist, müssen trotzdem die kryptografischen Vorgaben bzw. die kryptografische Signatur validiert werden.
:::caution Warnung
Sowohl die Prüfung der kryptografischen Vorgaben, als auch die Prüfung der kryptografischen Signatur darf KEINESFALLS ausgelassen werden.
:::
......
docs/organisation-tasks/certificates.mdx
View file @ c5d1946d
......@@ -44,6 +44,8 @@ Nun wird eine Seite angezeigt, auf der Sie eine Domäne auswählen können, die
:::info Hinweis
Bei der Beantragung von Zertifikaten über die **Thüringer Registrierungsstelle** beim TLRZ wählen Sie stattdessen die Sub-Domäne `Kommunikation Thüringen`.
Wenn Ihnen Informationen zur Beantragung bei anderen Registrierungsstellen vorliegen, freuen wir uns über einen Hinweis an `fit-connect <ät> fitko.de`.
:::
<img width="600" alt="Auswahl der Domäne" src={useBaseUrl('/images/certificate_registration/certificate_registration_2.png')} />
......
docs/receiving/process-and-acknowledge.mdx
View file @ c5d1946d
......@@ -129,4 +129,4 @@ private static void validateTrueOrElseThrow(boolean expression, String msg) {
## Event Log abfragen
Auch empfangende Systeme können das Event Log abfragen.
Die Abfrage des Event Log erfolgt analog zur Abfrage für sendende Systeme und ist im Artikel [Status abfragen](../sending/query-status.mdx) beschrieben.
Die Abfrage des Event Log erfolgt analog zur Abfrage für sendende Systeme und ist im Artikel [Status abfragen](../getting-started/event-log/events.mdx) beschrieben.
docs/receiving/verification.mdx
View file @ c5d1946d
......@@ -534,8 +534,6 @@ Handelt es sich beim Fachdatensatz um valides JSON bzw. XML gemäß dem MIME-Typ
Ist der Fachdatensatz valide bezüglich des verwendeten Fachdatenschemas?
Falls die Abweichung nicht zu groß ist, sollte die Verarbeitung fortgesetzt werden.
```json
{
"type": "https://schema.fitko.de/fit-connect/events/problems/schema-violation",
......
docs/sending/accept-reject.mdx
View file @ c5d1946d
......@@ -4,14 +4,39 @@ title: Empfangsbestätigung oder Zurückweisung
import ApiLink from '@site/src/components/ApiLink'
Eine Einreichung wird immer mit einer Empfangsbestätigung (`accept-submission`) akzeptiert oder mit einer Zurückweisung
(`reject-submission`) abgelehnt.
Eine Empfangsbestätigung kann, eine Zurückweisung muss eine Liste von Problemen (`problems`) enthalten.
Nachdem die Einreichung versendet worden ist, kann der Status dieser abgefragt werden.
Der Status ist für das sendende System relevant, da hierüber das empfangende System mitteilt, ob es die Einreichung technisch korrekt verarbeiten konnte.
Bis zu einer Bestätigung über den Status `accepted` sollte das System sämtliche Inhalte einer Einreichung vorhalten.
Dies sollte es tun, damit es im Falle eines Fehlers (aufgrund eines inkorrekten Schemas oder eines falschen Public Keys), den Fehler eventuell korrigieren kann und Informationen korrekt übermitteln kann, ohne den Nutzer (bspw. eine Antragssteller:in) zu einer erneuten Dateneingabe aufzufordern.
## Darstellung für Nutzer
Zudem stellt der Status in Form des signierten Security-Event-Tokens einen sicheren Nachweis der Übermittlung und des Empfangs dar, der gegenüber Dritten genutzt werden kann.
:::caution Hinweis
:::caution Wichtig
Die Authentizität und Integrität der [aus dem Event Log abgerufenen Ereignisse](../getting-started/event-log/get-events.mdx) SOLLTE bei jedem Abruf geprüft werden. Die notwendigen Prüfungen sind im Artikel [Prüfung eines Security-Event-Token](../getting-started/event-log/set-validation.mdx) beschrieben.
:::
:::tip Hinweis
Wie Ereignisse aus dem Ereignisprotokoll abgerufen werden können, ist im Artikel [Event Log abfragen](../getting-started/event-log/get-events.mdx) beschrieben.
:::
## Statusmodell
Das Statusmodell einer Einreichung ist in der folgenden Grafik dargestellt und enthält fünf Zustände (in orange), die in der darunterliegenden Tabelle beschrieben sind.
Die in blau und grün dargestellten [Ereignisse](../getting-started/event-log/events.mdx) im Abschnitt "Ereignisprotokoll" beschreiben.
Eine Einreichung wird immer mit einer Empfangsbestätigung (`accept-submission`) akzeptiert oder mit einer Zurückweisung (`reject-submission`) abgelehnt.
![Statusdiagramm](/images/status/status.svg)
| Status | Bedeutung |
|---------------|---------------------------------------------------------------------------------------------------------|
| `incomplete` | Das sendende System hat begonnen, die Einreichung zu übermitteln. Sie jedoch noch nicht abgesendet. |
| `submitted` | Das sendende System hat die Einreichung vollständig übermittelt und abgesendet. |
| `forwarded` | Ein vermittelndes System hat die Einreichung übernommen, sie aber noch nicht dem Zielsystem zugestellt. |
| `rejected` | Die Einreichung wurde durch den Empfänger zurückgewiesen. |
| `accepted` | Die Einreichung wurde durch den Empfänger akzeptiert. |
## Darstellung für Nutzer
:::caution Hinweis
Die Fehlermeldungen im Problem-Datensatz dürfen den Nutzern des Systems (z.B. Bürgern, die einen Online-Antrag nutzen)
nicht angezeigt werden!
......@@ -19,7 +44,6 @@ Die Anzeige für die Nutzer (Bürger) sollte sich daher auf drei Status beschrä
- Die Einreichung wurde abgeschickt/ist auf dem Zustellweg.
- Die Einreichung wurde empfangen.
- Die Einreichung konnte nicht verarbeitet werden.
:::
### Beim Versand der Einreichung
......@@ -47,9 +71,35 @@ Bei der Formulierung sollte darauf geachtet werden, dass der Nutzer darüber inf
dass eine Klärung der technischen Fehler erfolgt und ggf. ein neuer Antrag mit seiner Beteiligung versendet werden muss.
Ob der Nutzer den Antrag erneut eingeben muss, ergibt sich aus dem Fehler und wie/ob die Daten beim sendenden System noch vorgehalten werden.
## Aufbau einer Zurückweisung
## Verarbeitung einer Empfangsbestätigung
Nachdem das empfangende System den Empfang bestätigt hat (`accept-submission`), informiert FIT-Connect das sendende
System per Callback, sofern ein Callback hinterlegt wurde.
Sollte der Callback fehlschlagen, wiederholt FIT-Connect diesen, bis er erfolgreich zugestellt werden konnte.
Eine Rückweisung könnte wie folgt aussehen.
Auch eine Empfangsbestätigung kann Probleme enthalten.
In diesem Fall waren diese nicht so gravieren, dass das empfangende System die Verarbeitung abbrechen musste.
Sie sollten protokolliert und von einem Systemadministrator überprüft werden.
Hieraus können sich Anpassungsbedarfe in der Software ergeben, wenn bspw. Fehler bzgl. der Nutzung veralteter Schemata oder deren inkorrekten Umsetzung ergeben.
![Verarbeitung einer Empfangsbestätigung](/images/events/accept-submission.svg)
## Verarbeitung einer Zurückweisung
Nachdem das empfangende System die Einreichung zurückgewiesen hat (`reject-submission`), informiert FIT-Connect das
sendende System per Callback, sofern ein Callback hinterlegt wurde.
Sollte der Callback fehlschlagen, wiederholt FIT-Connect diesen, bis er erfolgreich zugestellt werden konnte.
Eine Zurückweisung erfolgt aufgrund von technischen Problemen, die im Normalfall das sendende System vor dem Versand
verhindern muss.
Die Probleme aus der Zurückweisung müssen protokolliert und zeitnah von einem Systemadministrator überprüft werden.
![Verarbeitung einer Zurückweisung](/images/events/reject-submission.svg)
### Aufbau einer Zurückweisung
Eine Zurückweisung enthält immer eine Liste von Problemen (`problems`).
Eine Rückweisung könnte wie folgt aussehen:
```json
{
......@@ -93,7 +143,7 @@ Das Problem-Objekt enthält drei Informationen:
Mögliche Werte sind: `submission`, `metadata`, `data`, `attachment:` + UUID des Attachments oder `other`
- `title`, `detail` und evtl. weitere vorhandene Werte geben Detailinformationen zum Fehler.
## Fehlercodes (`type`) {#type}
### Fehlercodes (`type`) {#type}
| Fehlercode (`type`) | Bedeutung | Fehlerbehebung |
|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
......@@ -116,36 +166,9 @@ Das Problem-Objekt enthält drei Informationen:
| `https://schema.fitko.de/fit-connect/events/problems/unsupported-schema` [↓](#unsupported-schema) | Das angegebene Schema wird nicht unterstützt. | [Aufbau einer Einreichung](#aufbau) |
| `https://schema.fitko.de/fit-connect/events/problems/unsupported-service` [↓](#unsupported-service) | Die angegebene Verwaltungsleistung wird nicht unterstützt. | [Aufbau einer Einreichung](#aufbau) |
## Verhalten des sendenden Systems
### Verarbeitung einer Empfangsbestätigung
Nachdem das empfangende System den Empfang bestätigt hat (`accept-submission`), informiert FIT-Connect das sendende
System per Callback, sofern ein Callback hinterlegt wurde.
Sollte der Callback fehlschlagen, wiederholt FIT-Connect diesen, bis er erfolgreich zugestellt werden konnte.
Auch eine Empfangsbestätigung kann Probleme enthalten.
In diesem Fall waren diese nicht so gravieren, dass das empfangende System die Verarbeitung abbrechen musste.
Sie sollten protokolliert und von einem Systemadministrator überprüft werden.
Hieraus können sich Anpassungsbedarfe in der Software ergeben, wenn bspw. Fehler bzgl. der Nutzung veralteter Schemata oder deren inkorrekten Umsetzung ergeben.
![Verarbeitung einer Empfangsbestätigung](/images/events/accept-submission.svg)
### Verarbeitung einer Zurückweisung
### Mögliche automatische Korrekturen
Nachdem das empfangende System die Einreichung zurückgewiesen hat (`reject-submission`), informiert FIT-Connect das
sendende System per Callback, sofern ein Callback hinterlegt wurde.
Sollte der Callback fehlschlagen, wiederholt FIT-Connect diesen, bis er erfolgreich zugestellt werden konnte.
Eine Zurückweisung erfolgt aufgrund von technischen Problemen, die im Normalfall das sendende System vor dem Versand
verhindern muss.
Die Probleme aus der Zurückweisung müssen protokolliert und zeitnah von einem Systemadministrator überprüft werden.
![Verarbeitung einer Zurückweisung](/images/events/reject-submission.svg)
## Mögliche automatische Korrekturen
### `https://schema.fitko.de/fit-connect/events/problems/encryption-issue`
#### `https://schema.fitko.de/fit-connect/events/problems/encryption-issue`
Im Falle, dass ein inkorrekter Key genutzt wurde und die Einreichung unverschlüsselt vorliegt, verschlüsseln Sie diese erneut mit dem korrekten Key der Destination:
1. Rufen Sie den betreffenden Zustellpunkt erneut ab: <ApiLink api="submission-api" to="/v1/destinations/{destinationId}" withMethod="get" />
......@@ -155,12 +178,8 @@ Im Falle, dass ein inkorrekter Key genutzt wurde und die Einreichung unverschlü
Sollte die Einreichung nur noch in verschlüsselter Form vorliegen, melden sie beim Service Desk, um eine Problemlösung zu erreichen.
## Klärungsmöglichkeiten
### Probleme mit den übersendeten Daten (Schemafehler, nicht nutzbare Datenformate, etc.)
Falls es Probleme mit den übersendeten Daten hinsichtlich der Verarbeitbarkeit gekommen ist, dass die empfangende Stelle eine Annahme der Daten verweigert,
besteht die Möglichkeit über das Service Desk von FIT-Connect mit der empfangenden Stelle in Kontakt zu treten, um eventuell das Problem bilateral zu klären und zu lösen.
### Klärungsmöglichkeiten bei Zurückweisung der Einreichung
Falls es Probleme mit den übersendeten Daten hinsichtlich der Verarbeitbarkeit gekommen ist, sodass die empfangende Stelle eine Annahme der Daten verweigert, besteht die Möglichkeit über das Service Desk von FIT-Connect mit der empfangenden Stelle in Kontakt zu treten, um eventuell das Problem bilateral zu klären und zu lösen.
Es besteht jedoch keine Garantie, dass die Daten auf Seite der empfangenden Stelle nach einem Reject aufbewahrt werden oder die auf der Seite des sendenden Systems eventuell noch verschlüsselt vorgehaltenen Daten sich für eine Korrektur eignen.
Es wird daher dazu geraten, sich präzise an die Vorgaben der Destination hinsichtlich der zu versendenden Fachdatenformate und -standards zu halten und die Nutzung dieser Standards ausreichend zu testen.
......@@ -643,4 +662,4 @@ Mögliche Gründe sind:
}
```
Bei der Verarbeitung im empfangenden System trat ein teschnischer Fehler auf.
Bei der Verarbeitung im empfangenden System trat ein technischer Fehler auf.
docs/sending/encrypt.mdx
View file @ c5d1946d
......@@ -50,15 +50,17 @@ Eine Prüfung der Zertifikate kann in diesem Fall zu Testzwecken entfallen.
Öffentliche Schlüssel MÜSSEN vor der Verwendung zwingend im Client auf Gültigkeit geprüft werden. Diese Prüfung umfasst folgende Schritte:
- Überprüfung, dass der JSON Web Key für die Verschlüsselung geeignet ist (`"keyops": ["wrap_key"]`)
- Überprüfung, dass der JSON Web Key gemäß den [Vorgaben für kryptographische Verfahren](../details/crypto.md) eine Schlüssellänge von mind. 4096 Bit aufweist
- Überprüfung, dass der JSON Web Key gemäß den [Vorgaben für kryptographische Verfahren](../details/crypto.md) für die Verschlüsselung geeignet ist (`"keyops": ["wrap_key"]`)
- Überprüfung, dass der JSON Web Key gemäß den [Vorgaben für kryptographische Verfahren](../details/crypto.md) zur Nutzung des Verfahrens `RSA-OAEP-256` geeignet ist (`"kty":"RSA", "alg": "RSA-OAEP-256"`)
- Überprüfung, dass der öffentliche Schlüssel mit dem im JSON Web Key hinterlegten Zertifikat übereinstimmt (Attribute `n` und `e`)
- Überprüfung der Zertifikats-Kette bis zum Wurzelzertifikat (BSI)
- Überprüfung gegen eine Certificate Revocation List und/oder einen OCSP-Endpunkt mit signierten Antworten
- Überprüfung, dass das Zertifikat der Verwaltungs-PKI entstammt, d.h Überprüfung der Zertifikats-Kette bis zum Wurzelzertifikat (BSI) (Attribut `x5c`)
- Überprüfung, dass der im Zertifikat angegebene Gültigkeitszeitraum nicht überschritten wurde
- Überprüfung, dass das Zertifikat nicht zurückgezogen wurde (mittels Validierungsdienst, gegen eine Certificate Revocation List (CRL) und/oder einen OCSP-Endpunkt mit signierten Antworten)
Weitere Informationen zur Gültigkeitsprüfung finden sich in der technischen Richtlinie [BSI TR-02103](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR02103/BSI-TR-02103.pdf?__blob=publicationFile&v=4) des BSI.
Der [folgende Code](https://git.fitko.de/fit-connect/examples/) kann zur Validierung der Schlüssel benutzt werden.
Der [folgende Code](https://git.fitko.de/fit-connect/examples/) kann zur Validierung der [Vorgaben für kryptographische Verfahren](../details/crypto.md) benutzt werden. Zusätzlich MUSS eine Zertifikatsprüfung inkl. Prüfung der Zertifikatskette erfolgen.
<Tabs
defaultValue="js"
......
docusaurus.config.js
View file @ c5d1946d
......@@ -105,6 +105,7 @@ module.exports = {
]
},
*/
{to: '/termine', label: 'Termine'},
{to: '/contact', label: 'Kontakt'},
{
type: 'dropdown',
......
sidebar.js
View file @ c5d1946d
......@@ -54,7 +54,6 @@ module.exports = {
'sending/encrypt',
'sending/attachments',
'sending/submit',
'sending/query-status',
'sending/accept-reject',
]
},
......@@ -78,6 +77,7 @@ module.exports = {
items: [
'getting-started/event-log/overview',
'getting-started/event-log/events',
'getting-started/event-log/get-events',
'getting-started/event-log/set-creation',
'getting-started/event-log/set-validation',
]
......@@ -143,4 +143,4 @@ module.exports = {
'metadata/replyChannel',
'metadata/additionalReferenceInfo'
]
}
\ No newline at end of file
}
src/components/BannerTermine.jsx 0 → 100644
View file @ c5d1946d
import React from 'react';
import useBaseUrl from '@docusaurus/useBaseUrl'
export default function BannerTermine({children}) {
const bgSource = useBaseUrl('/images/banner.svg')
return <div className={'flex'}>
<div className={'w-screen bg-repeat-x bg-yellow-400 max-w-screen'}
style={{backgroundImage: `url('${bgSource}')`, margin: '0 -9999rem', padding: '2rem 9999rem'}}>
</div>
<div className={'flex p-8 gap-8'} style={{ width: "100%" }}>
{children}
</div>
</div>
}
\ No newline at end of file
src/components/CardTermine.jsx 0 → 100644
View file @ c5d1946d
import React, {useEffect, useState} from 'react';
// <p className="text-gray-600 text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
export default function Card({title, icon, children}) {
const [svgData, setSvgData] = useState(undefined)
useEffect(async () => {
if (icon) {
const svgData = (await import(`@icons/${icon}.svg`)).default
setSvgData(svgData);
}
}, [icon])
return <div className="p-6 bg-white rounded shadow-xl text-center">
{svgData && <img className="w-16 h-16 mb-2" src={svgData}/>}
<br/>
<h4 className="text-xl font-bold leading-snug mb-1 text-center fitko-termine-heading-h4" >FIT-Connect</h4>
<h3 className="text-xl font-bold leading-snug mb-1 text-center fitko-termine-heading-h3" >für {title}</h3>
{children}
</div>
}
src/components/MailToButtonTermine.jsx 0 → 100644
View file @ c5d1946d
import React from 'react'
export default function MailToButtonTermine({ recipient, label, subject, body }) {
return <a className={'btn border border-yellow-400 text-gray-800 hover:text-yellow-600 hover:border-yellow-600 cursor-pointer'} target={'_blank'} onClick={(e) => {
window.open(`mailto:${recipient}?subject=${subject}&body=${body}`, '_blank')
e.preventDefault()
}}>{label}</a>
}
src/css/style.scss
View file @ c5d1946d
......@@ -111,6 +111,7 @@ img {
display: none !important;
}
@media (min-width: 997px) {
.navbar__items--right [class^="searchBox"] {
position: right;
......
src/css/termine.css 0 → 100644
View file @ c5d1946d
.fitko-termine {
text-align: center;
min-height: 500px;
}
.fitko-termine-heading-h3 {
text-align: center;
height: 50px;
font-size: 1.40em;
}
.fitko-termine-heading-h4 {
text-align: center;
height: 30px;
}
.fitko-termine-before-button {
text-align: center;
min-height: 120px;
}
.fitko-termine-after-button {
text-align: center;
min-height: 280px;
margin-top: 25px;
}
@media screen and (max-width: 900px){
.fitko-termine {
text-align: center;
min-height: 500px;
}
}
@media screen and (max-width: 900px){
.fitko-termine-before-button {
height: 210px !important;
}
}
@media screen and (max-width: 900px){
.fitko-termine-after-button {
height: 600px !important;
}
}
\ No newline at end of file
src/pages/docs/responsibilities/routing.js
View file @ c5d1946d
......@@ -4,7 +4,7 @@ import {Redirect} from '@docusaurus/router';
export default function routing() {
return (
<p>
<Redirect to="../../../docs/organisation-tasks/publish_destination#signierte-adressierungsinformationen" />
<Redirect to="../../../docs/organisation-tasks/subscriber#Redaktionssysteme" />
</p>
);
......
src/pages/docs/sending/query-status.js 0 → 100644
View file @ c5d1946d
import React from 'react';
import {Redirect} from '@docusaurus/router';
export default function query_status() {
return (
<p>
<Redirect to="../../../docs/sending/accept-reject.mdx" />
</p>
);
}
src/pages/termine.mdx 0 → 100644
View file @ c5d1946d
---
hide_table_of_contents: true
---
import MailToButtonTermine from '@components/MailToButtonTermine'
import BannerTermine from '@components/BannerTermine'
import CardTermine from '@components/CardTermine'
import MailToButton from '@components/MailToButton'
import '../css/termine.css';
<header className="max-w-3xl mx-auto text-center pb-16">
<h1 className="h1 mb-4">Termine</h1>
<h3 className="h3 mb-4">Veranstaltungen</h3>
<p className="wtext-xl text-gray-600">Möchten Sie mehr über FIT-Connect erfahren? Sprechen Sie mit uns in Online-Veranstaltungen, die regelmäßig stattfinden. Die folgenden Themen stehen zur Auswahl:</p>
</header>
<BannerTermine>
<div style={{ width: "33%" }} >
<CardTermine title="Interessierte" icon={'Send'}>
<br/>
<div className="fitko-termine" >
<p className="fitko-termine-before-button" >
Diese Veranstaltungen richten sich an alle, die mehr über die Anbindung an FIT-Connect erfahren wollen.
</p>
<MailToButtonTermine label={'Anmelden'} recipient={'fit-connect@fitko.de'} subject={'Anfrage%20Teilnahme%20an%20der%20Online-Veranstaltung%20Anbindungsinteressent%3Ainnenkreis&body=Liebes%20FIT-Connect-Team%2C%0D%0A%0D%0Aber%C3%BCcksichtigen%20Sie%20mich%20bitte%20f%C3%BCr%20die%20n%C3%A4chste%20Online-Veranstaltung%20%E2%80%9EFIT-Connect%20Anbindungsinteressent%3Ainnenkreis%E2%80%9C.%0D%0A%0D%0AIch%20interessiere%20mich%20f%C3%BCr%20FIT-Connect%20und%20m%C3%B6chte%20mehr%20%C3%BCber%20die%20Anbindung%20an%20FIT-Connect%20erfahren.%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A'} />
<br/>
<p className="fitko-termine-after-button" >
Zum Anmelden per E-Mail klicken Sie auf die Schaltfläche oben. <br/>
Bei diesen Veranstaltungen erhalten Verantwortliche für die Umsetzung des Onlinezugangsgesetzes (OZG) und Entwickler:innen Informationen darüber, wie sie Onlinedienste und Fachverfahren an FIT-Connect anbinden können.
</p>
</div>
</CardTermine>
</div>
<div style={{ width: "33%" }} >
<CardTermine title={'Verantwortliche'} icon={'Support'}>
<br/>
<div className="fitko-termine" >
<p className="fitko-termine-before-button" >
Diese Veranstaltungen richten sich an Verantwortliche, die ihre Systeme anbinden oder angebunden haben.
</p>
<MailToButtonTermine label={'Anmelden'} recipient={'fit-connect@fitko.de'} subject={'Anfrage%20Teilnahme%20an%20der%20Online-Veranstaltung%20Nutzer%3Ainnenkreis&body=Liebes%20FIT-Connect-Team%2C%0D%0A%0D%0Aber%C3%BCcksichtigen%20Sie%20mich%20bitte%20f%C3%BCr%20die%20n%C3%A4chste%20Online-Veranstaltung%20%E2%80%9EFIT-Connect%20Nutzer%3Ainnenkreis%E2%80%9C.%0D%0A%0D%0AWir%20nutzen%20FIT-Connect%20und%20haben%20bereits%20ein%20System%20an%20FIT-Connect%20angebunden%20bzw.%20sind%20gerade%20dabei%2C%20an%20FIT-Connect%20anzubinden.%0D%0A%0D%0A%0D%0A'} />
<br/>
<p className="fitko-termine-after-button" >
Zum Anmelden per E-Mail klicken Sie auf die Schaltfläche oben. <br/>
Diese Veranstaltungen finden monatlich statt. Bei diesen Veranstaltungen erfahren Verantwortliche für die Umsetzung Informationen zu Themen wie die Feature-Roadmap, konzeptionelle Überlegungen, anstehende Upgrades und individuelle Themen.
</p>
</div>
</CardTermine>
</div>
<div style={{ width: "33%" }} >
<CardTermine title={'Entwickler:innen'} icon={'Bug'}>
<br/>
<div className="fitko-termine" >
<p className="fitko-termine-before-button" >
Diese Veranstaltungen richten sich an Entwickler:innen, die ihre Systeme anbinden oder angebunden haben.
</p>
<MailToButtonTermine label={'Anmelden'} recipient={'fit-connect@fitko.de'} subject={'Anfrage%20Teilnahme%20an%20der%20Online-Veranstaltung%20%22FIT-Connect%20Austausch%20zur%20Technik%22&body=Liebes%20FIT-Connect-Team%2C%0D%0A%0D%0Aber%C3%BCcksichtigen%20Sie%20mich%20bitte%20f%C3%BCr%20die%20n%C3%A4chste%20Online-Veranstaltung%20%E2%80%9EFIT-Connect%20Austausch%20zur%20Technik%E2%80%9C.%0D%0A%0D%0AWir%20nutzen%20bereits%20FIT-Connect%20und%20m%C3%B6chten%20uns%20aktiv%20in%20die%20Weiterentwicklung%20von%20FIT-Connect%20einbringen.%0D%0A%0D%0A%0D%0A'} />
<br/>
<p className="fitko-termine-after-button" >
Zum Anmelden per E-Mail klicken Sie auf die Schaltfläche oben. <br/>
Diese Veranstaltungen finden monatlich statt. Schwerpunkte sind die Feature-Roadmap, konzeptionelle Überlegungen, Upgrades. Teilnehmer sind Entwwickler:innen, die mit FIT-Connect arbeiten und sich in die Weiterentwicklung einbringen möchten.
</p>
</div>
</CardTermine>
</div>
</BannerTermine>