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 (30)
......@@ -68,7 +68,7 @@ upload:production:
stop:preview:
stage: .post
image: alpine:latest
image: ${CI_REGISTRY}/fit-connect/baseimage:latest
environment:
name: preview/$CI_COMMIT_REF_NAME
action: stop
......@@ -88,11 +88,11 @@ link-check:
- if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH # live docs
variables:
CRAWLER_URL: https://docs.fitko.de/fit-connect/docs
CRAWLER_DOMAIN: docs.fitko.de/fit-connect/docs
CRAWLER_DOMAIN: docs.fitko.de
- if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH # preview docs
variables:
CRAWLER_URL: https://preview.docs.fitko.dev/fit-connect/$CI_COMMIT_REF_SLUG/
CRAWLER_DOMAIN: preview.docs.fitko.dev/fit-connect/$CI_COMMIT_REF_SLUG/
CRAWLER_DOMAIN: preview.docs.fitko.dev
trigger:
strategy: depend
project: fit-connect/schema-link-checker
......
<!--
SPDX-FileCopyrightText: 2022 FIT-Connect contributors
SPDX-License-Identifier: EUPL-1.2
-->
# Security Vulnerabilities
Our team is trying to make sure that our code is secure. Nevertheless, we are very grateful for anyone who finds a security vulnerability and reports it to us.
Please do not report security vulnerabilities through GitLab directly. Because GitLab issues are public, this could result in directly disclosing the vulnerability.
Please send any request regarding a potential security vulnerability with all the information that could help to `it-sicherheit <at> fitko.de`. See our [security.txt](https://www.fitko.de/.well-known/security.txt) for details.
If possible please note the release version or the commit id of the main branch that you have investigated.
......@@ -4,6 +4,47 @@ 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](getting-started/environments.mdx).
## 2022-11-10
### Dokumentation
- Löschung [nach Empfangsbestätigung bzw. Zurückweisung einer Einreichung](getting-started/notifications-and-deletion-deadlines.mdx) dokumentiert.
## 2022-11-08
### Zustelldienst 1.9.2
- Interne Anpassungen/Wartungsarbeiten ohne Außenwirkungen.
### Zustelldienst 1.9.1
- Fix: Endpunkt `/v1/info` gibt jetzt die korrekte Version `1.1.1` zurück.
### Self Service Portal 1.5.0
- Umstieg auf neue React UI für das Erstellen und Bearbeiten von Zustellpunkten im Self-Service-Portal ([Story](https://git.fitko.de/fit-connect/planning/-/issues/442))
### Self Service Portal 1.4.4
- Erweiterung / Konsolidierung Self-Service API ([Story](https://git.fitko.de/fit-connect/planning/-/issues/582))
### Self Service Portal 1.4.3
- Konfiguration von OAuth-Clients zur Nutzung der Self-Service-API im Self-Service-Portal ([Story](https://git.fitko.de/fit-connect/planning/-/issues/541))
- Erstellen von Destinations via Self-Service API im SSP ([Story](https://git.fitko.de/fit-connect/planning/-/issues/581))
### Self Service Portal 1.4.2
- Interne Anpassungen/Wartungsarbeiten ohne Außenwirkungen.
### Self Service Portal 1.4.1
- Interne Anpassungen/Wartungsarbeiten ohne Außenwirkungen.
### Self Service Portal 1.4.0
- Anzahl der Zustellpunkte pro Benutzerkonto auf 50 reduziert
## 2022-11-02
### Zustelldienst 1.9.0
- Einbindung der JWK-Zertifikatsprüfungs-Bibliothek (`jwk-validator`) ([Story](https://git.fitko.de/fit-connect/planning/-/issues/548))
- Feature: Auslagerung der Zertifikatsprüfung in die eigenständige Bibliothek JWK-Validator ([Story](https://git.fitko.de/fit-connect/planning/-/issues/497))
- Improvement: SET-Schema 1.0.1 mit verbesserten internen Referenzen ohne Sonderzeichen (z.B. Tilde in den Event-URIs). Außer strukturellen Änderungen gint es keine fachlichen Anpassungen.
### SET-Schema 1.0.1
- Improvement: SET-Schema 1.0.1 mit verbesserten internen Referenzen. Statt der Einbindung von Referenzen aus externen Dateien werden diese nun über das `definitions`-Attribut eingebunden (inline). Dies löst Problme mit JSON-Schema-Tooling. Das resultierende Schema entspricht semantisch exakt dem SET-Schema in Version 1.0.0. Insb. gibt es keine fachlichen Anpassungen.
## 2022-10-27
### Dokumentation
- Die Informationen zu den verfügbaren Betriebsumgebungen aus dem Artikel [Getting Started](getting-started/get-started.mdx) wurden in den neuen Artikel [Betriebsumgebungen](getting-started/environments.mdx) verschoben und um die URLs der Staging- und Produktivumgebung ergänzt.
......@@ -33,6 +74,15 @@ Unter dem Menüpunkt "Infos für Verantwortliche > Fachverfahren anbinden > Übe
### 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-10-04
### Zustelldienst 1.8.3
- Vereinheitlichen von Fehlermeldungen und erweitertes Logging
- Einschränkung der Werte der Callback-URL - Input Validation ([Story](https://git.fitko.de/fit-connect/planning/-/issues/206))
- Fix: Versenden von Callbacks an Sender bei Statusänderungen von Submissions ([Story](https://git.fitko.de/fit-connect/planning/-/issues/619))
### Zustelldienst 1.8.2
- Fix: Fehlerhafter Umgang mit doppelt vergebenen Attachment-IDs ([Story](https://git.fitko.de/fit-connect/planning/-/issues/493))
## 2022-09-16
### Submission API 1.1.1
- Der Endpunkt `POST /v1/destinations` wurde in die neue Gruppe `Internal` verschoben (reine Anpassung der API-Dokumentation ohne technische Änderungen).
......@@ -46,7 +96,7 @@ Unter dem Menüpunkt "Infos für Verantwortliche > Fachverfahren anbinden > Übe
## 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".
- 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
......
# Benachrichtigungen und Löschfristen
### Löschung nach erfolgreicher Abholung
Bei erfolgreicher Abholung einer Einreichung durch ein empfangendes System (Fachverfahren) wird dieser zustelldienstseitig nach 7 Tage gelöscht.
Bei erfolgreicher Abholung einer Einreichung durch ein empfangendes System (Fachverfahren) wird dieser zustelldienstseitig nach **7 Tagen** automatisch gelöscht.
#### Löschung nach Empfangsbestätigung / Rückweisung der Einreichung
Sobald das empfangende System (Subscriber) nach erfolgreicher Abholung den [erfolgreichen Empfang der Einreichung bestätigt oder die Einreichung zurückweist](../receiving/process-and-acknowledge.mdx), wird die Einreichung zustelldienstseitig **unmittelbar** gelöscht.
### Löschung unvollständiger Einreichungen
Unvollständige Einreichungen, die durch das sendende System (Onlinedienst) nicht abgeschlosen wurden und dem empfangenden System noch nicht bekannt sind, werden nach 1 Tag gelöscht.
Unvollständige Einreichungen, die durch das sendende System (Onlinedienst) nicht abgeschlosen wurden und dem empfangenden System noch nicht bekannt sind, werden nach **1 Tag** gelöscht.
### Löschung bei nicht erfolgter Abholung
Bei nicht erfolgter Abholung einer Einreichung durch ein empfangendes System (Fachverfahren) erfolgt eine Benachrichtigung des technischen Kontakts auf Empfängerseite 3 Tage nach Eingang der Einreichung.
14 Tage nach Eingang einer neuen Einreichung in der FIT-Connect-Infrastruktur erfolgt eine Markierung der Einreichung als nicht-zustellbar ("reject"-Event). Ab diesem Zeitpunkt können Einreichungen nicht mehr abgerufen werden. Nach weiteren 7 Tagen, die zu Debugging-Zwecken benötigt werden, erfolgt anschließend eine Löschung der übermittelten Einreichung.
Bei nicht erfolgter Abholung einer Einreichung durch ein empfangendes System (Fachverfahren) erfolgt eine Benachrichtigung des technischen Kontakts auf Empfängerseite **3 Tage** nach Eingang der Einreichung.
**14 Tage** nach Eingang einer neuen Einreichung in der FIT-Connect-Infrastruktur erfolgt eine Markierung der Einreichung als nicht-zustellbar ("reject"-Event). Ab diesem Zeitpunkt können Einreichungen nicht mehr abgerufen werden. Nach weiteren **7 Tagen**, die zu Debugging-Zwecken benötigt werden, erfolgt anschließend eine Löschung der übermittelten Einreichung.
| Zeitpunkt | Aktion |
| --------- | ------ |
......
......@@ -9,7 +9,7 @@ hide_table_of_contents: true
| 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. |
| Anlage (attachment) | Einer Einreichung können optional Anlagen beigefügt werden. Diese sind nicht zwingend maschinenlesbar oder an Standards geknüpft. |
| Anlage (attachment, auch: submission attachment) | Einer Einreichung können optional Anlagen beigefügt werden. Diese sind nicht zwingend maschinenlesbar oder an Standards geknüpft. |
| Antragsteller:in (applicant) | Bezeichnung der Person (Verwaltungskund:in), die über ein sendendes System (z.B. Onlinedienst) einen Antrag stellt. |
| Antwort (reply) | Alle auf eine Einreichung (submission) folgende Übertragungen, egal in welche Richtung (sender → subscriber oder subscriber → sender) |
| API-Client | Ein technisches System, dass auf die FIT-Connect-Schnittstellen zugreift. Dieser Begriff kann verwendet werden, wenn eine Unterscheidung zwischen Fachverfahren, virtueller Poststelle, Onlineservice oder Endgerät der antragstellenden Person nicht nötig ist. |
......@@ -22,14 +22,14 @@ hide_table_of_contents: true
| Empfangendes System (subscriber) | Das technische System, das Einreichungen auf Verwaltungsseite entgegennimmt. (z.B. Fachanwendung / virtuelle Poststelle) |
| Ereignis (event) | Ein in Form eines [Security Event Token](https://datatracker.ietf.org/doc/html/rfc8417) aufgezeichnetes Ereignis zu einer Einreichung oder einem Einreichungsvorgang. Dies kann z.B. das Absenden einer Einreichung sein. |
| Ereignisprotokoll (event log) | Der Zustelldienst bündelt alle einer Einreichung oder einem Einreichungsvorgang zugeordneten Ereignisse in einem Ereignisprotokoll. |
| Fachdatensatz (data) | Ist ein strukturierter Fachdatensatz im Rahmen der Einreichung. Kann JSON, XML oder ein anderes in verwaltungseigenen Datenstandards genutztes Datenformat sein. |
| Fachdatensatz (data, auch: submission data) | Ist ein strukturierter Fachdatensatz im Rahmen der Einreichung. Kann JSON, XML oder ein anderes in verwaltungseigenen Datenstandards genutztes Datenformat sein. |
| Fachschemareferenz (submission schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das für eine Einreichung verwendete Fachschema steht im Metadatensatz. Siehe auch: Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](details/schema-reference.md) |
| FIM | Föderales Informationsmanagement, bestehend aus den Bausteinen *FIM Leistungen* (siehe *Leistungsschlüssel*), FIM Datenfelder (siehe *Fachschema*) und FIM Prozesse (Prozessabbildungen zu einer Leistungserbringung). Weiterführende Informationen finden sich im [FIM-Portal](https://fimportal.de/) |
| Gebiet (area) | Eine räumlich abgegrenzte Fläche, z.B. ein Postleitzahlenbereich, ein Naturschutzgebiet oder eine Region im Sinne des Amtlichen Regionalschlüssels (siehe *Region*). |
| Kommunikationskanal (communication channel) | Beschreibt einen Kommunikationskanal, um zwischen der zuständigen Fachbehörde und der Verwaltungskund:in zu digital zu kommunizieren. Kommunikationskanäle können sein: <ul> <li>E-Mail</li> <li>De-Mail</li> <li>FIT-Connect Rückkanal</li> <li>Interoperable Postfächer (FINK)</li> <li>Elster-Transfer des einheitlichen Unternehmenskontos</li> </ul>Eine zuständige Fachbehörde kommuniziert über den Zustellpunkt, welche Kommunikationskanäle unterstützt werden und die Verwaltungskund:in legt fest, welche Kommunikationskanäle genutzt werden sollen. Für die Adressierung der Verwaltungskund:in werden alle für den Kommunikationskanal notwendigen Verbindungs- und Adressierungsparameter (einschließlich ggf. notwendiger Schlüssel/Zertifikate) im Metadatensatz übertragen. |
| Leistungsschlüssel, ehemals *LeiKa-Schlüssel* | Eindeutige Kennung einer Verwaltungsleistung aus dem FIM-Baustein Leistungen (beginnt immer mit `99`). Der Leistungsschlüssel wird im Leistungskatalog der öffentlichen Verwaltung (LeiKa) definiert. Der *Leistungsschlüssel*/*LeiKa-Schlüssel* ist abzugrenzen von der LeiKa-intern verwendeten *LeiKa-ID*, die im Projekt FIT-Connect keine Anwendung findet. Weitere Informationen finden sich im [FIM-Portal](https://fimportal.de/). Siehe auch: *Leistungs-ID* |
| Leistungs-ID | Eindeutige Kennung einer Verwaltungsleistung. Eine Identifikation des Leistungen erfolgt über eine aus einem Leistungsschlüssel abgeleitete eindeutige URN (z.B. `urn:de:fim:leika:leistung:99010003001006`) |
| Metadatensatz (metadata) | Ein Metadatensatz beschreibt: <ul> <li>Fachunabhängige Metadaten der Einreichung: Authentifizierung des Autors einer Einreichung oder Berichts (bspw. über einen eID-Laufzettel, Identification Report, Informationen über Signaturnutzung einschließlich Angabe des Signaturformats und ggf. separater Signaturdateien), Ergebnisse eines Bezahlvorgangs oder digitale Verbindungs- und Adressparameter für die Verfahrensinformationen (falls vom Verwaltungskund:in gewünscht).</li> <li>Strukturbeschreibung der Einreichung: Art der Leistung und Einreichungsbestandteile.</li> </ul> |
| Metadatensatz (metadata, auch: submission metadata) | Ein Metadatensatz beschreibt: <ul> <li>Fachunabhängige Metadaten der Einreichung: Authentifizierung des Autors einer Einreichung oder Berichts (bspw. über einen eID-Laufzettel, Identification Report, Informationen über Signaturnutzung einschließlich Angabe des Signaturformats und ggf. separater Signaturdateien), Ergebnisse eines Bezahlvorgangs oder digitale Verbindungs- und Adressparameter für die Verfahrensinformationen (falls vom Verwaltungskund:in gewünscht).</li> <li>Strukturbeschreibung der Einreichung: Art der Leistung und Einreichungsbestandteile.</li> </ul> |
| Region (region) | Eine verwaltungspolitische Region (Gebietskörperschaften) im Sinne des Amtlichen Regionalschlüssels (ARS). Regionen werden in FIT-Connect durch Angabe eines ARS mit vorangestelltem Präfix `DE` identifiziert. Z.B. `DE081150045045`. Siehe auch: *Gebiet* |
| Onlinedienst/Onlineservice (online service) | Ein Onlineservice kann entweder von einer Behörde, einem Unternehmen oder einer zivilgesesellschaftlichen Organisation betrieben wird. Er interagiert in der Art mit FIT-Connect, dass er Anträge im Namen bzw. Auftrag eines Endnutzers verschlüsselt übermittelt. |
| OAuth-Dienst | Der Autorisierungsdienst / OAuth-Dienst stellt Access-Tokens an API-Clients aus, mit denen diese sich anschließend gegenüber dem Zustelldienst (Submission API) authorisieren können. Zugänge für API-Clients können über das Self-Service-Portal konfiguriert werden. |
......
......@@ -65,7 +65,7 @@ Aktivieren Sie alle von Ihrem empfangenden System unterstützen Metadatenversion
src={useBaseUrl('/images/ssp/add-destination-section-5.png')}/>
</div>
In diesem Bereich müssen Sie zwei öffentliche Schlüssel für Ihren Zustellpunkt angeben.
In diesem Bereich müssen Sie zwei **öffentliche** Schlüssel für Ihren Zustellpunkt angeben.
Mit dem Verschlüsselungsschlüssel werden die Einreichungen verschlüsselt.
Mit dem öffentlichen Signaturschlüssel werden die von Ihrem System ausgestellten Empfangsquittungen geprüft.
......@@ -74,6 +74,10 @@ Beide Schlüssel müssen im JSON-Format vorliegen und den Anforderungen aus
Ein Tool und die zugehörige Anleitung um schnell und einfach passende Schlüssel für Testzwecke zu generieren finden Sie unter
[Tool zur Erstellung von JSON Web Keys](../details/jwk-creation.md).
:::caution Warnung!
In diesem Bereich dürfen **nur die öffentlichen Schlüssel** Ihres Fachverfahrens hochgeladen werden. Die privaten Schlüssel des Fachverfahrens **dürfen niemals an ein drittes System weitergegeben werden**. Wenn Sie das oben genannte [Tool zur Erstellung von JSON Web Keys](../details/jwk-creation.md) nutzen, erkennen Sie die öffentlichen Schlüssel an den Dateinamen `publicKey_encryption.jwk.json` (öffentlicher Verschlüsselungsschlüssel) und `publicKey_signature_verification.jwk.json` (öffentlicher Signaturschlüssel).
:::
<div class="center">
<img width="800" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 6"
src={useBaseUrl('/images/ssp/add-destination-section-6.png')}/>
......
......@@ -366,8 +366,7 @@ Nun zu den **Anhängen**:
### Verwaltungsleistung abgleichen (I)
Stimmt der Identifier des Metadatensatzes `publicServiceType/identifier`
mit dem der Submission `serviceType/identifier` überein?
Stimmt der Identifier `publicServiceType/identifier` im Metadatensatz mit dem der Submission `serviceType/identifier` (in der Submission API) überein?
Die Verwarbeitung sollte mit dem `identifier` aus dem Metadatensatz fortgesetzt werden.
......@@ -382,8 +381,7 @@ Die Verwarbeitung sollte mit dem `identifier` aus dem Metadatensatz fortgesetzt
### Verwaltungsleistung abgleichen (II)
Stimmt der Identifier unter `publicServiceType/identifier` mit einem der
Identifier der Destination unter `services[]/identifier` überein?
Stimmt der Identifier unter `publicServiceType/identifier` im Metadatensatz mit einem der Identifier der Destination unter `services[]/identifier` (in der Submission API) überein?
```json
{
......
......@@ -34,7 +34,7 @@ Der Endpunkt erwartet genau zwei Parameter:
Der Endpunkt <ApiLink api="routing-api" to="/routes" /> implementiert Pagination.
Das Ergebnis der Anfrage enthält daher neben der eigentlichen (Teil-)Ergebnismenge der Routing-Informationen (`routes`) auch Informationen wie Anzahl (`count`), Gesamtanzahl (`totalCount`) und Startpunkt der Ergebnismenge (`offset`).
Die zurückgegebene Teilergebnismenge ist standardmäßig auf 100 Einträge limitiert und kann über den GET-Parameter `limit` auf maximal 500 Einträge erweitert werden.
Über den GET-Paramter `offset` können weitere Teilmengen der Ergebnismenge ermittelt werden.
Über den GET-Parameter `offset` können weitere Teilmengen der Ergebnismenge ermittelt werden.
Der Endpunkt <ApiLink api="routing-api" to="/routes" /> ist auf die Anzahl von Anfragen in Zeitfenstern beschränkt. Es kann also vorkommen, das der Dienst einen `HTTP-Status-Code` `429` zurückliefert. Um diese Beschränkung auswerten zu können liefert der Endpunkt entspechende [RateLimit-Headers](../getting-started/rate-limiting.md) bei jeder Antwork zurück.
......
......@@ -158,7 +158,7 @@ module.exports = {
width: 250,
height: 30,
},
copyright: `Copyright © ${new Date().getFullYear()} FITKO (Föderale IT-Kooperation) | Zum Gottschalkhof 3 | 60594 Frankfurt am Main | E-Mail: poststelle@fitko.de | https://www.fitko.de | Die FITKO ist eine Anstalt des öffentlichen Rechts. Sie wird vertreten durch die Präsidentin Frau Dr. Annette Schmidt.`,
copyright: `Diese Seite ist Teil des <a href="https://docs.fitko.de/">Föderalen Entwicklungsportals</a>. Verantwortlich für die Inhalte der Seite sind die jeweiligen Autoren. Wenn nicht anders vermerkt, sind die Inhalte dieser Webseite lizenziert unter der <a href="https://creativecommons.org/licenses/by/4.0/deed.de">Creative Commons Namensnennung 4.0 International Public License (CC BY 4.0)</a>. Die technische Infrastruktur wird betrieben durch die FITKO. Es gilt das <a href="https://www.fitko.de/impressum">Impressum der FITKO</a> und die <a href="https://fitko.de/datenschutz">Datenschutzerklärung der FITKO</a> mit der Maßgabe, dass kein Tracking durchgeführt wird und keine Cookies gesetzt werden.`,
},
},
presets: [
......
This diff is collapsed.