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 (12)
......@@ -5,6 +5,16 @@ 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
### 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
......@@ -13,9 +23,10 @@ Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Co
- 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
## 2022-08-18
### Dokumentation
- Der Menüpunkt "Grundlagen" wurde umbenannt in "Infos für Entwickler:innen".
......@@ -29,6 +40,7 @@ Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Co
- 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.
## 2022-06-29
### Zustelldienst 1.6.1
......@@ -45,6 +57,7 @@ Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Co
## 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 -->
......@@ -256,7 +269,7 @@ Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Co
## 2022-01-11
### Dokumentation
- [Abschnitt zur Pflege der FIT-Connect „destinationSignatur“ in FIM-Redaktionssytemen](./organisation-tasks/publish_destination#signierte-adressierungsinformationen) ergänzt
- [Abschnitt zur Pflege der FIT-Connect „destinationSignatur“ in FIM-Redaktionssytemen](./organisation-tasks/subscriber#signierte-adressierungsinformationen) ergänzt
### Self Service Portal 1.3.1
- Fix: Anpassung des Address Export und Zustelldienst Signature Typs um dem JWT Standard besser gerecht zu werden (`JWT` statt `jwt`)
......
......@@ -125,14 +125,14 @@ callback-authentication = HEX(HMAC(key={callback-secret}, message={timestamp}.{h
Um den HMAC zu verifizieren, bildet der API-Client mithilfe des *Callback Secret* den HMAC nach und vergleicht diesen mit dem im HTTP-Header `callback-authentication` übertragenen HMAC.
Bei der Prüfung **MÜSSEN** die folgenden Implementierungshinweise zwingend zu beachten:
Bei der Prüfung **MÜSSEN** die folgenden Implementierungshinweise zwingend beachtet werden:
- Das Callback Secret **MUSS** in API-Clients konfigurierbar sein und **DARF NICHT** fest im Quellcode eines API-Clients einprogrammiert sein.
- Dies kann beispielsweise durch die Konfiguration des Callback Secret in einer Konfigurationsdatei oder über eine Umgebungsvariable (`$ export CALLBACK_SECRET=your_secret`) erreicht werden.
- Bei der Erzeugung des HMAC **MUSS** der Hash-Algorithmus `SHA-512` verwendet werden.
- Es **MUSS** geprüft werden, dass der angegebene Zeitstempel nicht älter als **5 Minuten** ist.
- Beim Vergleich des übertragenen HMAC und des vom API-Client gebildeteten HMAC **MUSS** ein zeitlich konstanter Zeichenfolgenvergleich (*constant time string comparison*) verwendet werden.
- In Python kann dies über die Verwendung der Methode [`hmac.compare_digest`](https://docs.python.org/2/library/hmac.html#hmac.compare_digest) erreicht werden.
- In Ruby kann dies über die Verwendung der Methode [`secure_compare`](https://rubydoc.info/github/rack/rack/master/Rack/Utils:secure_compare) erreicht werden.
- In Ruby kann dies über die Verwendung der Methode [`secure_compare`](https://rubydoc.info/github/rack/rack/main/Rack/Utils:secure_compare) erreicht werden.
- Callbacks mit ungültigem HMAC **MÜSSEN** von API-Clients ignoriert werden.
Dabei ist zunächst
......
......@@ -5,7 +5,7 @@ hide_table_of_contents: true
| Begriff | Beschreibung |
|---------|--------------|
| FIT-Connect Adressierungsinformationen | Für die Zuständigkeitsfindung im Portalverbund ist eine Hinterlegung von signierten Adressierungsinformationen in einem Landes-Redaktionssystem notwendig (siehe Artikel [Konfiguration des Antragsroutings](organisation-tasks/publish_destination#signierte-adressierungsinformationen)). Die FIT-Connect-Adressierungsinformationen werden im Format XZuFi von den Landes-Redaktionssystemen an das Onlinegateway des Portalverbundes (PVOG) übermittelt und vom FIT-Connect Routingdienst in Kombination mit den im Deutschen Verwaltungsdiensteverzeichnis (DVDV) zur Zuständigkeitsfindung / technischen Adressierung von *Zustellpunkten* genutzt. |
| FIT-Connect Adressierungsinformationen | Für die Zuständigkeitsfindung im Portalverbund ist eine Hinterlegung von signierten Adressierungsinformationen in einem Landes-Redaktionssystem notwendig (siehe Artikel [Konfiguration des Antragsroutings](organisation-tasks/subscriber#signierte-adressierungsinformationen)). Die FIT-Connect-Adressierungsinformationen werden im Format XZuFi von den Landes-Redaktionssystemen an das Onlinegateway des Portalverbundes (PVOG) übermittelt und vom FIT-Connect Routingdienst in Kombination mit den im Deutschen Verwaltungsdiensteverzeichnis (DVDV) zur Zuständigkeitsfindung / technischen Adressierung von *Zustellpunkten* genutzt. |
| Amtlicher Gemeindeschlüssel (AGS) | Schlüssel zur Identifizierung von verwaltungspolitischen Gebieten. Siehe [AGS](./details/ags.mdx) |
| Amtlicher Regionalschlüssel (ARS) | Schlüssel zur Identifizierung von verwaltungspolitischen Gebieten. Nachfolger des AGS. Siehe [ARS](./details/ars.mdx) |
| Angekündige Anlage | Angabe gegenüber dem Zustelldienst, welche Anlagen übermittelt werden. Teilmenge der Angaben in der `contentStructure` im verschlüsselten Metadatensatz. |
......
......@@ -14,7 +14,7 @@ Die Zertifikate enthalten öffentliche und private Schlüssel für Verschlüssel
#### Überblick
Das Beantragen von Zertifikaten ist eine Aufgabe, die Verantwortliche für Fachverfahren beachten müssen, um Fachverfahren an FIT-Connect anzubinden.
Alle Aufgaben sind [hier im Überblick](./publish_destination) aufgelistet. <br/>
Alle Aufgaben sind [hier im Überblick](./subscriber) aufgelistet. <br/>
:::note Hinweis
Pro Fachverfahren ist ein Zertifikat der Verwaltungs-PKI erforderlich, um ein Fachverfahren an das Produktivsystem anzubinden. <br/>
......
......@@ -39,7 +39,7 @@ Die rechtlichen Vertreter:innen eines Fachverfahrens, die FIT-Connect für ihre
Die FITKO legt anschließend für das Fachverfahren einen Account für FITKO-GitLab an, sodass Sie auf dem Self-Service-Portal der Produktivumgebung Daten pflegen können (oder ein von Ihnen beauftragter Mitarbeiter oder Dienstleister pflegt die Daten).
### 2. Beantragen Sie Zertifikate der Verwaltungs-PKI.
Wie Sie Zertifikate beantragen, das ist [hier](./apply-for-certificates#zertifikate-der-verwaltungs-pki-beantragen) beschrieben.
Wie Sie Zertifikate beantragen, das ist [hier](./certificates#zertifikate-der-verwaltungs-pki-beantragen) beschrieben.
### 3. Zustellpunkt und API-Client anlegen
Beauftragen Sie Administrator:innen Ihrer Behörde (oder Dienstleister) damit, einen Zustellpunkt und einen API-Client des Typs "Subscriber" anzulegen. Hierfür benötigen die Administrator:innen die Zertifikate, die Sie im Schritt 2 erhalten haben. <br/>
......@@ -74,7 +74,7 @@ Das PVOG sendet Informationen zu den online beantragbaren Leistungen der Fachver
src={useBaseUrl('/images/routing/routing-architecture-overview.png')}/>
</div>
### 4. Adressierungsinformationen in Redaktionssysteme einfügen
### 4. Adressierungsinformationen in Redaktionssysteme einfügen{#Redaktionssysteme}
Das Self-Service-Portal (SSP) stellt Informationen über Zustellpunkte in signierter Form zur Verfügung. <br/>
Wie Sie diese Informationen aus dem SSP kopieren, das ist [hier](#signierte-adressierungsinformationen) beschrieben.
......
......@@ -15,7 +15,7 @@ Die Zertifikate und die damit verbundenen JWKs haben eine begrenzte Gültigkeit
### Zertifikate der Verwaltungs-PKI
Sie benötigen Zertifikate der Verwaltungs-PKI, um ein Fachverfahren an das Produktivsystem von FIT-Connect anzubinden.
Wie Sie Zertifikate der Verwaltungs-PKI beantragen, das ist [hier](../organisation-tasks/apply-for-certificates) beschrieben.
Wie Sie Zertifikate der Verwaltungs-PKI beantragen, das ist [hier](../organisation-tasks/certificates) beschrieben.
:::note Hinweis
Für die Testumgebung von FIT-Connect sind keine Zertifikate der Verwaltungs-PKI erforderlich. Hier können selbst signierte Zertifikate genutzt werden. Das Vorgehen ist im Artikel [Erstellen von JSON Web Keys für Testzwecke](../details/jwk-creation.md) beschrieben.
......
......@@ -98,7 +98,7 @@ Anschließend kann der Zustellpunkt entweder über das Self-Service-Portal oder
:::
:::caution Hinweis
Um eine [Auffindbarkeit des Zustellpunktes über die Routing API](../sending/get-destination.mdx) zu ermöglichen, müssen die konfigurierten Zuständigkeitsinformationen zunächst in einem an den Portalverbund angeschlossenen Landes-Redaktionssystem des FIM-Bausteins Leistungen hinterlegt werden. Weitere Informationen hierzu finden sich im Artikel [Konfiguration des Antragsroutings](../organisation-tasks/publish_destination#signierte-adressierungsinformationen).
Um einen [Zustellpunkt mithilfe der Routing-API](../sending/get-destination.mdx) zu finden, müssen die Adressierungsinformationen in einem Redaktionssystem hinterlegt sein. Weitere Informationen hierzu finden sich im Artikel [Konfiguration des Antragsroutings](../organisation-tasks/subscriber.mdx#Redaktionssysteme).
:::
## Zugriff auf Zustellpunkte einrichten
......
......@@ -17,7 +17,7 @@ Für eine Auffindbarkeit der Zustellpunkte über die Routing-API ist in der Test
Sofern eine Destination-ID bereits bekannt ist, können die in einem Zustellpunkt hinterlegten technischen Parameter alternativ auch über den Endpunkt <ApiLink api="submission-api" to="/v1/destinations/{destinationId}" /> der Submission API des zuständigen Zustelldienstes [abgerufen werden (siehe unten)](#submissionapi).
Die Konfiguration des Antragsroutings in der produktiven Umgebung ist bereits jetzt möglich. Die [in den Landesredaktionen konfigurierten Zustellpunkte](../organisation-tasks/publish_destination.mdx) sind in der Produktivumgebung über Routing API abrufbar.
Die Konfiguration des Antragsroutings in der produktiven Umgebung ist bereits jetzt möglich. Die [in den Landesredaktionen konfigurierten Zustellpunkte](../organisation-tasks/subscriber.mdx#Redaktionssysteme) sind in der Produktivumgebung über die Routing-API abrufbar.
:::
Die Ermittlung der `destinationId` und die Ermittlung der technischen Parameter über die Routing-API erfolgt über einen GET-Request auf den Endpunkt <ApiLink api="routing-api" to="/routes" /> des FIT-Connect Routingdienstes.
......
......@@ -33,7 +33,7 @@ abgebildet. Fachliche schon.
### Technische Fehler
| `type` des technischen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
| `type` des technischen Fehlers | Titel laut [httpstatus.es](https://www.webfx.com/web-development/glossary/http-status-codes/) | Beschreibung |
|---------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------------------------------------------------------------------------------|
| https://schema.fitko.de/fit-connect/submission-api/problems/constraint-violation | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/submission-api/problems/request-binding-error | 400 Bad Request | |
......@@ -53,7 +53,7 @@ abgebildet. Fachliche schon.
### Fachliche Fehler
| `type` des fachlichen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
| `type` des fachlichen Fehlers | Titel laut [httpstatus.es](https://www.webfx.com/web-development/glossary/http-status-codes//) | Beschreibung |
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| https://schema.fitko.de/fit-connect/submission-api/problems/access-forbidden | 403 Forbidden | |
| https://schema.fitko.de/fit-connect/submission-api/problems/submission-already-fetched | 410 Gone | |
......
......@@ -29,7 +29,7 @@ Nach dem Abruf einer Einreichung bestätigt das empfangende Systeme den Erhalt d
### Empfangende Systeme anmelden
Um FIT-Connect zu nutzen, müssen Sie empfangende Systeme bei FIT-Connect als API-Clients anmelden und konfigurieren (siehe "1. Konfiguration von API-Clients und Zustellpunkten" in der Grafik oben). <br/>
Das Anlegen von API-Clients für empfangende Systeme ist [hier](../organisation-tasks/publish_destination) beschrieben.
Das Anlegen von API-Clients für empfangende Systeme ist [hier](../organisation-tasks/subscriber) beschrieben.
### Weitere Anwendungsfälle
Das Senden von Anträgen und das Ermitteln des zuständigen Fachverfahrens sind [hier](./sender) beschrieben.
......@@ -37,5 +37,5 @@ Das Senden von Anträgen und das Ermitteln des zuständigen Fachverfahrens sind
<br/>
:::note Hinweis
Verantwortliche für Fachverfahren, die beabsichtigen, die Produktivumgebung von FIT-Connect zu nutzen, sollten alle [hier](../organisation-tasks/publish_destination#aufgaben-f%C3%BCr-die-anbindung-an-das-produktivsystem) beschriebenen Aufgaben beachten.
Verantwortliche für Fachverfahren, die beabsichtigen, die Produktivumgebung von FIT-Connect zu nutzen, sollten alle [hier](../organisation-tasks/subscriber#aufgaben-f%C3%BCr-die-anbindung-an-das-produktivsystem) beschriebenen Aufgaben beachten.
:::
\ No newline at end of file
......@@ -22,7 +22,7 @@ Zum Abrufen des Ereignisprotokolls dient die Schnittstelle "Submission API" des
### Sendende Systeme anmelden
Um FIT-Connect zu nutzen, müssen Sie sendende Systeme als API-Clients anmelden und konfigurieren (siehe "1. Konfiguration von API-Clients" in der Grafik oben).
Das Anlegen von API-Clients für sendende Systeme (Antragsplattformen oder Softwareprogramme) ist [hier](../organisation-tasks/register_onlineservice#2-api-client-f%C3%BCr-sender-anlegen) beschrieben.
Das Anlegen von API-Clients für sendende Systeme (Antragsplattformen oder Softwareprogramme) ist [hier](../organisation-tasks/sender#2-api-client-f%C3%BCr-sender-anlegen) beschrieben.
### Fachverfahren ermitteln
......@@ -36,5 +36,5 @@ Das Empfangen von Einreichungen (Anträgen oder Berichtsmeldungen) ist [hier](./
<br/>
:::note Hinweis
Verantwortliche für Onlinedienste, die beabsichtigen, die Produktivumgebung von FIT-Connect zu nutzen, sollten alle [hier](../organisation-tasks/register_onlineservice#aufgaben-zur-anbindung-an-das-produktivsystem) beschriebenen Aufgaben beachten.
Verantwortliche für Onlinedienste, die beabsichtigen, die Produktivumgebung von FIT-Connect zu nutzen, sollten alle [hier](../organisation-tasks/sender#aufgaben-zur-anbindung-an-das-produktivsystem) beschriebenen Aufgaben beachten.
:::
\ No newline at end of file
......@@ -20,11 +20,11 @@ module.exports = {
label: 'Fachverfahren anbinden',
collapsed: true,
items: [
'organisation-tasks/publish_destination',
'organisation-tasks/apply-for-certificates',
'organisation-tasks/subscriber',
'organisation-tasks/certificates',
],
},
'organisation-tasks/register_onlineservice',
'organisation-tasks/sender',
],
},
'changelog',
......