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 (9)
......@@ -2,8 +2,12 @@
Das Format dieser Datei basiert auf [Keep a Changelog](https://keepachangelog.com/de).
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).
Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Connect](getting-started/environments.mdx).
## 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.
- Hinweis auf Möglichkeit der Prüfung der für die SET-Erstellung genutzten Zertifikate in der Staging- und Produktivumgebung im Artikel [Prüfung eines Security-Event-Token (SET)](getting-started/event-log/set-validation.mdx) ergänzt
## 2022-10-17
### Dokumentation
......
......@@ -12,7 +12,7 @@ Als Voraussetzungen hierfür ist es notwendig, Accounts für [API-Clients im Sel
## Abruf von Access Tokens beim OAuth-Dienst
:::note Hinweis
Die URL der Submission API und die OAuth-Token-URL finden sich im Artikel [Erste Schritte](get-started.mdx#testing).
Die URL der Submission API und die OAuth-Token-URL finden sich im Artikel [Betriebsumgebungen](./environments.mdx#testing).
:::
Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden.
......@@ -125,5 +125,5 @@ Authorization: Bearer ey...
```
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](get-started.mdx#testing).
Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](./environments.mdx#testing).
:::
---
title: Betriebsumgebungen
---
# Betriebsumgebungen der FIT-Connect-Infrastruktur
## Übersicht
Für FIT-Connect stehen derzeit mehrere Betriebsumgebungen bereit, die jeweils einen etwas anderen Zweck erfüllen.
Umgebungen, die von der FITKO zu Test- und Entwicklungszwecken bereitgestellt werden, stehen unter einer Subdomain unterhalb von `fitko.dev` zur Verfügung.
Produktive und produktivnahe Umgebungen stehen unter einer Subdomain unterhalb von `fitko.net` (bzw. unterhalb von `niedersachsen.de` für die bei IT.Niedersachsen betriebenen Infrastrukturen) zur Verfügung.
| Umgebung | Zweck und Zielgruppe |
| ---------------------------------- | -------------------- |
| Testumgebung (`testing`) | **Zweck**: Die Testumgebung dient vorrangig Anbindungstests und der Erprobung neuer Features.<br/>**Zielgruppe**: Die Testumgebung steht allen Interessierten zur freien Nutzung zur Verfügung, darf nicht für produktive Zwecke genutzt werden und unterliegt keinerlei Verfügbarkeitsgarantien.<br/>**Besonderheiten**: In der Testumgebung können selbst-generierte Test-Zertifikate anstelle von Zertifikaten aus einer PKI-Infrastruktur genutzt werden. |
| Staging-/Referenzumgebung (`refz`) | **Zweck**: Die Stagingumgebung, auch Referenzumgebung genannt, ist identisch zur Produktivumgebung konfiguriert und dient dem Test von Updates der an FIT-Connect angebundenen Systeme, bevor diese an die Produktivumgebung angebunden werden. Zudem dient die Stagingumgebung der Gewährleistung einer reibungslosen Funktionalität von Updates der FIT-Connect-Infrastruktur selbst, bevor diese auf der Produktivumgebung ausgerollt werden.<br/>**Zielgruppe**: Die Stagingumgebung steht ausschließlich Systemen zur Verfügung, die ebenfalls zum Zugriff auf die Produktivumgebung berechtigt sind.<br/>**Besonderheiten**: Die Nutzung der Stagingumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. |
| Produktivumgebung (`prod`) | **Zweck**: Die Produktivumgebung dient der produktiven Nutzung der FIT-Connect-Infrastruktur.<br/>**Zielgruppe**: Die Nutzung der Produktivumgebung ist Betreiber:innen vorbehalten, die entsprechende Nutzungsbedingungen unterzeichnet und einen Auftragsdatenverarbeitungsvertrag mit der FITKO abgeschlossen haben.<br/>**Besonderheiten**: Die Nutzung der Produktivumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. |
## Testumgebung {#testing}
Für Anbindungstests in der Testumgebung können Sie die folgenden Endpunkte & Infos verwenden:
- [Self-Service-Portal](./account.mdx) der Testumgebung: [https://portal.auth-testing.fit-connect.fitko.dev](https://portal.auth-testing.fit-connect.fitko.dev)
- [OAuth Token URL](./authentication.mdx): `https://auth-testing.fit-connect.fitko.dev/token`
- [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev`
- [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev`
## Staging-Umgebung {#staging}
Für Integrationstests in der Staging-Umgebung, auch Referenz-Umgebung genannt, können Sie die folgenden Endpunkte & Infos verwenden:
- [Self-Service-Portal](./account.mdx) der Staging-Umgebung: [https://portal.auth-refz.fit-connect.fitko.net](https://portal.auth-refz.fit-connect.fitko.net)
- [OAuth Token URL](./authentication.mdx): `https://auth-refz.fit-connect.fitko.net/token`
- [Submission API](../apis/submission-api.mdx): `https://submission-api-refz.fit-connect.niedersachsen.de`
- [Routing API](../apis/routing-api.mdx): In der Staging-Umgebung steht keine eigene Routing-API zur Verfügung. Bitte nutzen Sie für Integrationstests stattdessen die Routing-API der Produktivumgebung.
## Produktivumgebung {#prod}
Für eine Anbindung in der Produktivumgebung können Sie die folgenden Endpunkte & Infos verwenden:
- [Self-Service-Portal](./account.mdx) der Produktivumgebung: [https://portal.auth-prod.fit-connect.fitko.net](https://portal.auth-prod.fit-connect.fitko.net)
- [OAuth Token URL](./authentication.mdx): `https://auth-prod.fit-connect.fitko.net/token`
- [Submission API](../apis/submission-api.mdx): `https://submission-api-prod.fit-connect.niedersachsen.de`
- [Routing API](../apis/routing-api.mdx): `https://routing-api-prod.fit-connect.fitko.net`
......@@ -18,7 +18,7 @@ In dem Fall, dass das SET-Payload-Schema nicht angegeben ist, müssen trotzdem d
Sowohl die Prüfung der kryptografischen Vorgaben, als auch die Prüfung der kryptografischen Signatur darf KEINESFALLS ausgelassen werden.
:::
## Prüfung der Einhaltung von kryptografischen Vorgaben und der Struktur
## Prüfung der Einhaltung von kryptografischen Vorgaben und der Struktur {#cryptoRequirements}
Alle generierten Security-Event-Tokens MÜSSEN den Vorgaben aus [RFC 7519](https://tools.ietf.org/html/rfc7519) entsprechen und über folgende Header-Attribute verfügen:
......@@ -278,7 +278,7 @@ Ein Beispiel für ein JWKS ist in folgendem Ausschnitt dargestellt:
Mit diesem JWK Set kann die Signatur eines Security-Event-Tokens überprüft werden.
Hierfür muss der Schlüssel mit der passenden `kid` aus dem Header des SET’s im JWK Set gesucht werden.
Dann kann man mit diesem und einer entsprechenden Bibliothek eine Signaturprüfung durchführen.
Nach Abschluss der [Prüfung aller kryptografischen Vorgaben](#cryptoRequirements) kann mit diesem und einer entsprechenden Bibliothek eine Signaturprüfung durchgeführt werden.
<Tabs
defaultValue="java"
......@@ -329,6 +329,11 @@ boolean verifyZustelldienstSignature(SignedJWT securityEventToken, String keyId)
</Tabs>
:::tip Hinweis
In der [Staging- und Produktivumgebung](../environments.mdx) ist das vom Zustelldienst für die Signaur der SET genutzte Schlüsselpaar über ein Zertifikat aus der Verwaltungs-PKI abgesichert (Attribut `x5c` des JWK).
Für eine vollständige Prüfung der Authentizität der augestellen SET SOLLTE daher – analog zur Prüfung der öffentlichen Schlüssel im Rahmen der Verschlüsselung – [eine Zertifikatsprüfung durchgeführt werden](../../sending/encrypt.mdx#certificateValidation).
:::
## Signaturprüfung eines vom empfangenden System ausgestellten SET
Um die Signatur eines von einem empfangenden System ausgestellen SET zu überprüfen ist es notwendig, auf den verwendeten Schlüssel zugreifen zu können.
......@@ -402,7 +407,7 @@ $ curl -X GET \
### Validierung des SET mit Hilfe des JWK
Die Verifikation des SET mit dem eben abgerufenen JWK ist dann ziemlich geradlinig.
Die Verifikation des SET mit dem eben abgerufenen JWK ist – nach Abschluss der [Prüfung aller kryptografischen Vorgaben](#cryptoRequirements) – ziemlich geradlinig.
Es wird zunächst geprüft ob der Schlüssel den passenden Algorithmus hat. Anschließend wird die eigentliche Verifikation durch die Bibliothek durchgeführt.
<Tabs
......@@ -448,3 +453,8 @@ boolean verifyClientSignature(SignedJWT securityEventToken, String keyId) {
</TabItem>
</Tabs>
:::tip Hinweis
In der [Staging- und Produktivumgebung](../environments.mdx) ist das von empfangenden Systemen (Subscriber) für die Signaur der SET genutzte Schlüsselpaar über ein Zertifikat aus der Verwaltungs-PKI abgesichert (Attribut `x5c` des JWK).
Für eine vollständige Prüfung der Authentizität der augestellen SET SOLLTE daher – analog zur Prüfung der öffentlichen Schlüssel im Rahmen der Verschlüsselung – [eine Zertifikatsprüfung durchgeführt werden](../../sending/encrypt.mdx#certificateValidation).
:::
......@@ -18,30 +18,10 @@ Auf den folgenden Seiten stellen wir Code-Beispiele für die Anbindung von IT-Sy
:::
## Betriebsumgebungen der FIT-Connect-Infrastruktur {#environments}
Eine Übersicht über die Betriebsumgebungen der FIT-Connect-Infrastruktur findet sich im Artikel [Betriebsumgebungen](./environments.mdx).
### Übersicht
Für FIT-Connect stehen derzeit mehrere Betriebsumgebungen bereit, die jeweils einen etwas anderen Zweck erfüllen.
Umgebungen, die von der FITKO zu Test- und Entwicklungszwecken bereitgestellt werden, stehen unter einer Subdomain unterhalb von `fitko.dev` zur Verfügung.
Produktive und produktivnahe Umgebungen stehen unter einer Subdomain unterhalb von `fitko.net` (bzw. unterhalb von `niedersachsen.de` für die bei IT.Niedersachsen betriebenen Infrastrukturen) zur Verfügung.
| Umgebung | Zweck und Zielgruppe |
| ---------------------------------- | -------------------- |
| Testumgebung (`testing`) | **Zweck**: Die Testumgebung dient vorrangig Anbindungstests und der Erprobung neuer Features.<br/>**Zielgruppe**: Die Testumgebung steht allen Interessierten zur freien Nutzung zur Verfügung, darf nicht für produktive Zwecke genutzt werden und unterliegt keinerlei Verfügbarkeitsgarantien.<br/>**Besonderheiten**: In der Testumgebung können selbst-generierte Test-Zertifikate anstelle von Zertifikaten aus einer PKI-Infrastruktur genutzt werden. |
| Staging-/Referenzumgebung (`refz`) | **Zweck**: Die Stagingumgebung, auch Referenzumgebung genannt, ist identisch zur Produktivumgebung konfiguriert und dient dem Test von Updates der an FIT-Connect angebundenen Systeme, bevor diese an die Produktivumgebung angebunden werden. Zudem dient die Stagingumgebung der Gewährleistung einer reibungslosen Funktionalität von Updates der FIT-Connect-Infrastruktur selbst, bevor diese auf der Produktivumgebung ausgerollt werden.<br/>**Zielgruppe**: Die Stagingumgebung steht ausschließlich Systemen zur Verfügung, die ebenfalls zum Zugriff auf die Produktivumgebung berechtigt sind.<br/>**Besonderheiten**: Die Nutzung der Stagingumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. |
| Produktivumgebung (`prod`) | **Zweck**: Die Produktivumgebung dient der produktiven Nutzung der FIT-Connect-Infrastruktur.<br/>**Zielgruppe**: Die Nutzung der Produktivumgebung ist Betreiber:innen vorbehalten, die entsprechende Nutzungsbedingungen unterzeichnet und einen Auftragsdatenverarbeitungsvertrag mit der FITKO abgeschlossen haben.<br/>**Besonderheiten**: Die Nutzung der Produktivumgebung setzt den Einsatz von Zertifikaten aus der Verwaltungs-PKI voraus. |
### Testumgebung {#testing}
Für Anbindungstests in der Testumgebung können Sie die folgenden Endpunkte & Infos verwenden:
- Self-Service-Portal der Testumgebung: siehe [Accountregistrierung und Client-Verwaltung](./account.mdx)
- [OAuth Token URL](./authentication.mdx): `https://auth-testing.fit-connect.fitko.dev/token`
- [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev`
- [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev`
<br/>
## Newsletter
:::note Newsletter
Bleiben Sie auf dem neusten Stand. <br/>
Bleiben Sie auf dem neusten Stand.<br/>
Unser [Newsletter](../contact/newsletter.mdx) informiert Sie über neue Releases von FIT-Connect, neue Features und sicherheitsrelevante Themen, siehe [Newsletter Abonnement](../contact/newsletter.mdx).
:::
......@@ -8,7 +8,7 @@ import ApiLink from '@site/src/components/ApiLink'
Der Abruf einer Einreichung ist über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}" /> möglich. Liegen zur Einreichung neben den verschlüsselten Metadaten (`encryptedMetadata`) und Fachdaten (`encryptedData`) zusätzlich weitere Anlagen vor, so sind die IDs der Anlagen im Feld `attachments` zu finden. Anlagen müssen separat heruntergeladen werden (siehe nächster Abschnitt). Einreichungen und deren Anlagen können dabei nur im Status Submitted oder Forwarded abgerufen werden.
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing).
Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing).
:::
```bash title="Abfrage der Einreichung inkl. Fachdaten und Metadaten"
......
......@@ -534,7 +534,7 @@ Beispiel für die Response
Zum Abruf der Zustellpunkt-Informationen stellt die Submission API einen Endpunkt bereit, der über Angabe des Parameters `destinationId` die technischen Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt. Diese kann genutzt werden, wenn die `destinationId` bereits bekannt ist. Die angebotenen Informationen über eine Destination unterscheiden sich fachlich nicht von den Information aus der Routing API. Bei der Submission API muss lediglich der Verschlüsselungsschlüssel über einen zusätzlichen Endpunkt abgerufen werden, anstatt diesen zusammen mit den anderen Informationen in einer Response zu erhalten (siehe Artikel [Verschlüsseln](../sending/encrypt.mdx)).
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing).
Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing).
:::
<Tabs
......
......@@ -29,7 +29,7 @@ Die für das Anlegen von Einreichungen notwendige Struktur von Einreichungen und
:::
:::note Hinweis
Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/get-started.mdx#testing).
Die URL der Submission API findet sich im Artikel [Betriebsumgebungen](../getting-started/environments.mdx#testing).
:::
......
......@@ -50,6 +50,7 @@ module.exports = {
'leitfaeden/integration-guide-subscriber',
]
},
'getting-started/environments',
'getting-started/account',
'getting-started/authentication',
{
......