Elektronische Gesundheitskarte und Telematikinfrastruktur
Spezifikation
Konfigurationsdienst
Version | 2.5.0 |
Revision | 548770 |
Stand | 02.03.2020 |
Status | freigegeben |
Klassifizierung | öffentlich |
Referenzierung | gemSpec_KSR |
Änderungen zur Vorversion
Anpassungen des vorliegenden Dokumentes im Vergleich zur Vorversion können Sie der nachfolgenden Tabelle entnehmen.
Dokumentenhistorie
Version | Stand | Kap./ Seite | Grund der Änderung, besondere Hinweise | Bearbeitung |
---|---|---|---|---|
2.0.0 | 02.08.17 | Initialversion Online-Rollout (Stufe 2.1) |
gematik | |
2.1.0 | 14.05.18 | Einarbeitung lt. Änderungsliste |
gematik | |
2.2.0 | 26.10.19 | Einarbeitung lt. Änderungsliste P15.9 |
gematik | |
2.3.0 | 15.05.19 | Einarbeitung lt. Änderungsliste P18.1 |
gematik | |
2.4.0 | 02.10.19 | Einarbeitung lt. Änderungsliste P20.1 und 16.1/2 |
gematik | |
Einarbeitung lt. Änderungsliste P21.1 | gematik | |||
2.5.0 | 02.03.20 | freigegeben | gematik |
Das Dokument definiert die Anforderungen an den Konfigurationsdienst, inkl. der durch diesen Dienst bereitgestellten Schnittstellen.
Das Dokument richtet sich an Hersteller und Anbieter eines Konfigurationsdienstes der TI sowie Hersteller und Anbieter von Produkttypen, die hierzu eine Schnittstelle besitzen.
Dieses Dokument enthält normative Festlegungen zur Telematikinfrastruktur des Deutschen Gesundheitswesens. Der Gültigkeitszeitraum der vorliegenden Version und deren Anwendung in Zulassungsverfahren wird durch die gematik GmbH in gesonderten Dokumenten (z.B. Dokumentenlandkarte, Produkttypsteckbrief, Leistungsbeschreibung) festgelegt und bekannt gegeben.
Schutzrechts-/Patentrechtshinweis
Die nachfolgende Spezifikation ist von der gematik allein unter technischen Gesichtspunkten erstellt worden. Im Einzelfall kann nicht ausgeschlossen werden, dass die Implementierung der Spezifikation in technische Schutzrechte Dritter eingreift. Es ist allein Sache des Anbieters oder Herstellers, durch geeignete Maßnahmen dafür Sorge zu tragen, dass von ihm aufgrund der Spezifikation angebotene Produkte und/oder Leistungen nicht gegen Schutzrechte Dritter verstoßen und sich ggf. die erforderlichen Erlaubnisse/Lizenzen von den betroffenen Schutzrechtsinhabern einzuholen. Die gematik GmbH übernimmt insofern keinerlei Gewährleistungen.
Spezifiziert werden in diesem Dokument die vom Produkttyp Konfigurationsdienst bereitgestellten (angebotenen) Schnittstellen. Benutzte Schnittstellen werden hingegen in der Spezifikation desjenigen Produkttyps beschrieben, der diese Schnittstelle bereitstellt. Auf die entsprechenden Dokumente wird referenziert (siehe auch Anhang Kap. 7.5).
Die vollständige Anforderungslage für den Produkttyp Konfigurationsdienst ergibt sich aus weiteren Konzept- und Spezifikationsdokumenten, diese sind in dem Produkttypsteckbrief des Produkttyps Konfigurationsdienst verzeichnet.
Anforderungen als Ausdruck normativer Festlegungen werden durch eine eindeutige ID sowie die dem RFC 2119 [RFC2119] entsprechenden, in Großbuchstaben geschriebenen deutschen Schlüsselworte MUSS, DARF NICHT, SOLL, SOLL NICHT, KANN gekennzeichnet.
Sie werden im Dokument wie folgt dargestellt:
<AFO-ID> - <Titel der Afo>
Text / Beschreibung
[<=]
Dabei umfasst die Anforderung sämtliche innerhalb der Afo-ID und der Textmarke angeführten Inhalte.
Der Konfigurationsdienst der TI ist ein betriebsunterstützendes System und speichert Update-Pakete für dezentrale Produkte der TI (z. B. Konnektoren und eHealth-Kartenterminals). Unabhängig vom Konfigurationsdienst können Updates der dezentralen Komponenten auch über lokale Mechanismen geladen werden.
Der Konfigurationsdienst stellt zugelassene Update-Pakete zum Download bereit.
Darüber hinaus stellt der Konfigurationsdienst zentrale Konfigurationsdatenfiles für Konnektoren bereit.
Das Dokument spezifiziert neben den Anforderungen Interfaces hinsichtlich:
Die Aktivierung der Firmware-Versionen erfolgt mittels der Gerätefunktionen der dezentralen Produkte.
Aktuell wird der Konfigurationsdienst zur Verteilung von Update-Paketen für folgende dezentrale Komponenten genutzt:
Die Abbildungen Abb_KSR_001 und Abb_KSR_011 geben einen Überblick über die externen Akteure und Use Cases des Konfigurationsdienstes.
Der Konfigurationsdienst wird für jede Umgebung (Referenzumgebung, Testumgebung, Produktivumgebung) bereitgestellt. Für die Skalierung des Konfigurationsdienstes für die jeweilige Umgebung ist der Anbieter des Konfigurationsdienstes verantwortlich.
Die Akteure zur Erteilung von Aufträgen zum Freigeben und Löschen von Update-Paketen etc. sind abhängig von der Umgebung und werden wie folgt festgelegt:
Die Bereitstellung der Update-Pakete auf dem Konfigurationsdienst kann durch den Hersteller der jeweiligen dezentralen Komponente oder die oben aufgezählten Akteure der Umgebungen erfolgen. Mit der Bereitstellung der Update-Pakete werden diese noch nicht automatisch in die TI (bzw. RU/TU/PU) geladen. Dies erfolgt erst nach Freigabe durch die jeweils verantwortliche Instanz.
Aufträge zum Bereitstellen von zentralen Konfigurationsdaten im Konfigurationsdienst werden durch die verantwortliche Instanz der jeweiligen Umgebung erteilt und durch den Anbieter des Konfigurationsdienstes ausgeführt. Für diese Konfigurationsdaten erfolgt ebenfalls eine Freigabe durch die jeweils verantwortliche Instanz.
Die Anlässe, auf Grund derer berechtigte Akteure Aufträge zur Aufnahme oder Löschung von Update-Paketen an den Anbieter des Konfigurationsdienstes stellen, sind unterschiedlicher Natur und ergeben sich aus vorgelagerten Prozessen, wie beispielsweise Zulassung, Test, Release- und Changemanagement.
Die einzige Ausprägung eines zentralen Konfigurationsdatenfiles ist zu diesem Zeitpunkt das Konfigurationsdatenfile zur Netzkonfiguration aAdG-NetG (siehe Anhang C).
Die Abbildung Abb_KSR_002 zeigt die Nachbarsysteme und Akteure des Konfigurationsdienstes.
Im Folgenden wird die Zerlegung des Konfigurationsdienstes dargestellt, welche für die Übersicht der funktionalen Leistungsmerkmale in vorliegender Spezifikation nötig ist.
Die Abbildung Abb_KSR_003 zeigt die Einbettung des Konfigurationsdienstes in die Produktivumgebung (PU).
Abbildung Abb_KSR_012 gibt einen Überblick über die Verteilung eines Update-Pakets in der Produktivumgebung (PU):
1. Der Hersteller der jeweiligen dezentralen Komponente transferiert das Update-Paket in den Upload-Bereich des Konfigurationsdienstes (siehe Kapitel 4.1 und 6.1.1).
2. Falls die Eingangsprüfung des Update-Paketes erfolgreich war, erfolgt der Transfer in den Managementbereich der jeweiligen Umgebung (siehe Kapitel 4.3 und 6.2.4).
Vor dem Transfer in die jeweilige Umgebung muss die Eingangsprüfung erfolgreich durchgeführt werden und das Update-Paket darf nach dieser Prüfung nicht manipulierbar sein.
3. Der GTI oder Hersteller erteilt die Freigabe für die jeweilige Umgebung mit einem Auftrag an den Konfigurationsdienst (siehe Kapitel 4.3 und 6.2.4).
4. Der Freigabeauftrag wird von KSR-Upload an KSR-Management weitergegeben.
5. Der Freigabeauftrag wird von KSR-Management (Internetanteil) an KSR-Management in der jeweiligen TI-Umgebung weitergegeben.
6. Das Update-Paket wird vom Managementbereich an den Downloadbereich der jeweiligen Umgebung übergeben.
7. Der Konnektor fragt bei dem Konfigurationsdienst nach verfügbaren Updates und erhält eine Liste der aktuell verfügbaren Update-Pakete (siehe Kapitel 4.2 und 6.1.1).
8. Der Konnektor selektiert (entweder automatisch die höchste Version oder manuell durch den Administrator) ein Update-Paket und lädt es vom Konfigurationsdienst (siehe Kapitel 4.2 und 6.1.1.2).
9. Der Administrator des Konnektors wird informiert, wenn ein neues Update-Paket auf dem Konnektor vorliegt (siehe [gemSpec_Kon]).
10. Der Administrator des Konnektors installiert das Update-Paket (siehe [gemSpec_Kon]).
Für die Referenzumgebung (RU) und die Testumgebung (TU) gelten vom Prinzip her die gleichen Abläufe, jedoch erfolgt die Freigabe durch die jeweils verantwortende Instanz der Umgebung. Die Installation eines Update-Pakets auf einem Kartenterminal wird in diesem Beispiel nicht gezeigt (wäre eine Variante von Schritt 8).
Die Komponente KSR-Upload stellt folgende Funktionalitäten bereit:
Während KSR-Upload einen direkten Zugang für die Hersteller – außerhalb der TI – bereitstellt, wird KSR-Download innerhalb der zentralen TI-Plattform der jeweiligen Betriebsumgebung angeboten. Da der Konfigurationsdienst einen Informationsfluss zwischen KSR-Upload und KSR-Download realisiert, müssen die Übergänge zwischen diesen Komponenten so geschützt werden, dass keine zusätzlichen Bedrohungen für die Betriebsumgebungen der TI entstehen (siehe [TIP1-A_3312] und [TIP1-A_3313]). Der Schutz dieser Übergänge wird auf Basis der in [gemProdT_KSR] verzeichneten Anforderungen (z.B. Anforderungen aus [gemSpec_Net]) realisiert.
TIP1-A_3312 - Nur zugelassene Update-Pakete im Downloadbereich der PU
Der Konfigurationsdienst MUSS sicherstellen, dass nur Update-Pakete in den Downloadbereich der Produktivumgebung der TI (PU) gelangen
TIP1-A_5157 - Nur freigegebene Konfigurationsdatenfiles im Downloadbereich der PU
Der Konfigurationsdienst MUSS sicherstellen, dass nur Konfigurationsdatenfiles in den Downloadbereich der Produktivumgebung der TI (PU) gelangen
TIP1-A_3313 - Anzahl Update-Pakete pro dezentralem Produkt
Der Konfigurationsdienst MUSS für alle dezentralen Produkte mindestens die Update-Pakete speichern können, die der Hersteller in der aktuellen Firmware-Gruppen-Informationen referenziert. Der Speicherplatz für die Update-Pakete muss skalierbar sein.
[<=]TIP1-A_6129 - Bereitzustellende Dateien pro Update-Paket
Der Konfigurationsdienst MUSS für jedes freigegebene Update-Paket die folgenden Dateien im KSR Downloadbereich zur Übertragung mit Operation I_KSRS_Download::getUpdates für den KSR Client bereitstellen:
Die in UpdateInfo.xml referenzierten Dateien
Die optionale detached Signatur „UpdateInfo.sig
KSR-Management stellt die Funktionalitäten für das Management der Update-Pakete bereit. Dazu gehören die Schnittstelle zum Gesamtverantwortlichen TI (GTI) sowie zu der Testbetriebsinstanz (TBI) der RU und TU.
Die ausführliche Beschreibung von KSR-Management inklusive Anforderungen enthält Kapitel 6.2.4.
Die Tabelle Tab_KSR_001 erläutert die Schnittstellen des Konfigurationsdienstes.
Bereitgestellte Schnittstellen |
||
---|---|---|
Schnittstelle |
Nutzer |
Spezifikation |
I_KSRS_Download |
Konnektor |
[gemSpec_KSR] |
|
Der KSR-Client im Konnektor nutzt den Konfigurationsdienst zur Aktualisierung der Firmware von dezentralen Komponenten. |
|
P_KSRS_Upload |
Hersteller, GTI, TBI RU/TU |
[gemSpec_KSR] |
|
Für die dezentralen Komponenten werden Update-Pakete auf dem Konfigurationsdienst bereitgestellt. |
|
P_KSRS_Operations |
Hersteller, GTI, TBI RU/TU |
[gemSpec_KSR] |
|
Der Gesamtverantwortliche TI (GTI) [gemKPT_Betr#3.1] überwacht und steuert den Betrieb der TI. Für die RU und TU übernimmt diese Aufgabe die jeweilige TBI und/oder der Hersteller. |
|
Benötigte Schnittstellen |
||
Schnittstelle |
Anbieter |
Spezifikation |
I_NTP_Time_Information |
Zeitdienst |
[gemSpec_Net] |
|
Über den Zeitdienst wird innerhalb der TI die Zeit aller Komponenten synchronisiert. |
|
I_DNS_Name_Resolution |
Namensdienst |
[gemSpec_Net] |
|
Der Namensdienst löst Hostnamen zu IP-Adressen auf. |
|
I_IP Transport |
Zentrales Netz TI |
[gemSpec_Net] |
|
Das Zentrale Netz TI stellt die Transportmechanismen in der zentralen TI bereit. |
|
I_Monitoring_Update |
Service Monitoring |
[gemSpec_ServiceMon] |
Über diese Schnittstelle werden Verfügbarkeits- und Performancedaten an das Service Monitoring gesendet. |
||
I_OpsData_Update |
Service Monitoring |
[gemSpec_ServiceMon] |
Über diese Schnittstelle werden Log- und Statistikdaten an das Service Monitoring gesendet. |
Die Tabelle Tab_KSR_002 zeigt die Abbildung der – in vorliegender Spezifikation definierten – Spezifikationsschnittstellen des Konfigurationsdienstes auf die konzeptionellen Schnittstellen aus [gemKPT_Arch_TIP].
Spezifikationsschnittstelle [gemSpec_KSR] |
Konzeptionelle Schnittstelle [gemKPT_Arch_TIP] |
---|---|
I_KSRS_Download |
I_KSRS_Download I_KSRS_Net_Config |
P_KSRS_Upload |
P_KSRS_Maintenance |
P_KSRS_Operations |
P_KSRS_Maintenance |
Durch den Konfigurationsdienst werden Firmware-Update-Pakete für die dezentralen Komponenten bereitgestellt.
In den folgenden Kapiteln werden die notwendigen übergreifenden Festlegungen zur Verteilung dieser Daten beschrieben.
Hersteller dezentraler Komponenten stellen Firmware-Update-Pakete bereit. Neben der Möglichkeit lokale Firmware-Updates durchzuführen werden durch den Konfigurationsdienst den dezentralen Komponenten zugelassene und geeignete Firmware-Update-Pakete zum Download bereitgestellt. Zur Verwaltung und Auswahl der geeigneten Pakete im Konfigurationsdienst sind Festlegungen zum Inhalt von Update-Paketen nötig. Dieser Inhalt muss vom Hersteller der Komponenten geliefert werden, deren Update-Pakete über den Konfigurationsdienst verteilt werden.
Die Tabelle Tab_KSR_003 zeigt den Schutz der Update-Pakete und der enthaltenen Informationen. Dabei stellt der Konfigurationsdienst zusammen mit dem Hersteller einer dezentralen Komponente, die den KSR nutzt, die Integrität und Authentizität des gesamten Update-Pakets sicher. Der Schutz von enthaltenen Teilinformationen ist für den Konfigurationsdienst transparent und wird von ihm nicht geprüft.
Informationsobjekt |
Schutzanforderungen |
Prüfung durch |
KSR Anforderungen |
|
---|---|---|---|---|
Updatepaket |
Integritäts- und Authentizitätsschutz Gesamtpaket durch Hersteller |
Konfigurationsdienst |
TIP1-A_3347 |
|
|
UpdateInformation |
Integritäts- und Authentizitätsschutz durch Hersteller |
Konnektor |
TIP-A_3896 TIP-A_3897 |
|
Firmwarefiles |
Integritäts- und Authentizitätsschutz durch Hersteller |
dezentrale Komponenten, die den KSR nutzen |
siehe [gemSpec_Kon], [gemSpec_KT] |
|
DocumentationFiles |
Keine |
- |
Keine |
|
Firmware-Gruppen Information |
Integritäts- und Authentizitätsschutz durch Hersteller |
Konfigurationsdienst |
TIP1-A_3322 |
Konfigurationsdatenfile |
Keine |
- |
- |
TIP1-A_3314 - Inhalt Update-Paket – Hersteller-Update-Informationen
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN in jedem Firmware-Update-Paket ein File mit Namen UpdateInfo.xml mit Hersteller-Update-Informationen gemäß Element UpdateInformation aus Konfigurationsdienst.xsd (siehe auch Abbildung Abb_KSR_005 und Tabellen Tab_KSR_004-009, Tab_KSR_012-020) liefern.
[<=]TIP1-A_3895 - Inhalt Update-Paket – Konnektor FirmwareFiles
Hersteller von Konnektoren MÜSSEN in jedem Firmware-Update-Paket 0 bis maximal 999 Firmwarefile(s) liefern.
[<=]TIP1-A_5158 - Inhalt Update-Paket – Kartenterminal FirmwareFiles
Hersteller von Kartenterminals MÜSSEN in jedem Firmware-Update-Paket genau ein Firmware File liefern.
[<=]
TIP1-A_3315 - Inhalt Update-Paket – DokumentationFiles
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN in jedem Firmware-Update-Paket bis zu maximal 999 Files mit Dokumentationen für das Update liefern.
[<=]
TIP1-A_5159 - Inhalt Update-Paket – Firmware-Gruppen-Information
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN in jedem Firmware-Update-Paket ein File mit der aktuell gültigen Firmware-Gruppen-Information gemäß „Abb_KSR_007 Firmware-Gruppen-Informationen“ liefern. Diese Firmware-Gruppen-Information muss der im Firmwarefile enthaltenen Information entsprechen.
[<=]TIP1-A_3347 - Integrität und Authentizität
Der Konfigurationsdienst MUSS die Integrität und Authentizität der durch den Hersteller von Komponenten, die den KSR nutzen, übermittelten Update-Pakete (Gesamtpaket) bis zur Übertragung an den KSR-Client durch die Prüfung der Update-Paket – Signatur (TIP1-A_6123) gewährleisten.
[<=]TIP1-A_6777 - KSR, Hersteller von Konnektoren, Deadline und alternative URL
Hersteller von Konnektoren MÜSSEN im Update-Paket in der Datei UpdateInfo.xml im Element KSR:FirmwareReleaseNotes eine URL für einen separaten Downloadpunkt des Update-Pakets im Internet angeben und, wenn das Element KSR:Priority den Wert „Kritisch“ hat, im Element UpdateInformation das Element KSR:Deadline mit einem gültigen Wert befüllen.
[<=]TIP1-A_6778 - KSR, GTI, Deadline und alternative URL
Der GTI MUSS im Rahmen der Freigabe eines Konnektor-Update-Pakets für die PU prüfen, dass das Update-Paket in der Datei UpdateInfo.xml im Element KSR:FirmwareReleaseNotes eine URL für einen separaten Downloadpunkt des Update-Pakets im Internet enthalten ist und, wenn das Element KSR:Priority den Wert „Kritisch“ hat, im Element UpdateInformation das Element KSR:Deadline mit einem gültigen Wert enthalten ist.
Wenn die Deadline (bei KSR:Priority = „Kritisch“) oder die URL nicht enthalten sind, muss die Freigabe abgelehnt werden.
[<=]
In diesem Kapitel werden die enthaltenen Hersteller-Update-Informationen erläutert. Die Befüllung und Prüfung der Hersteller-Update-Informationen (UpdateInfo.xml) erfolgt
TIP1-A_3896 - Signatur der Update-Informationen durch Konnektorhersteller
Konnektorhersteller MÜSSEN die Update-Informationen (UpdateInfo.xml) signieren. Dazu kann er das Element UpdateInformationSignature in den Update-Informationen oder eine detached Signatur nutzen.
[<=]Die Update-Informationen (UpdateInfo.xml) werden durch den Konnektorhersteller signiert und gemäß Anforderung [TIP1-A_3314] und Kapitel 5.2 an den Konfigurationsdienst geliefert. Der Konfigurationsdienst liefert die Update-Informationen wiederum in Operation I_KSRS_Download::listUpdates Response als Liste von Update-Informationen an den Konnektor.
A_14538 - KSR – Richtlinien zum Erhalt der Update-Informationen Signatur
Der Konfigurationsdienst MUSS gewährleisten, dass die UpdateInformation-Elemente in der I_KSRS_Download::listUpdates Response an den Konnektor bis auf kanonische Transformationen gleich denen der zugehörigen Dateien in den Firmware-Update-Paketen sind.
Die Prüfung der Gleichheit MUSS durch folgende Schritte möglich sein:
TIP1-A_3897 - Keine Signatur der Update-Informationen durch Kartenterminalhersteller
Kartenterminalhersteller SOLLEN die Update-Informationen (UpdateInfo.xml) NICHT signieren.
[<=]Kartenterminals erhalten die Update-Informationen nicht und der Konnektor kann diese Kartenterminalherstellersignatur nicht prüfen.
Die UpdateInformation der Hersteller setzen sich aus folgenden Daten zusammen:
Bezeichnung |
UpdateID |
---|---|
Beschreibung |
Identifiziert das Update eindeutig. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit Pattern "[a-zA-Z0-9]{1,24}_[a-zA-Z0-9]{1,7}". Maximale Länge: 32 Zeichen Syntax: <eindeutiger Teil, max. 24 Zeichen>_<OPB oder Name der Erprobung, max. 7 Zeichen> Die UpdateID ist vom Hersteller von Komponenten, die den KSR nutzen, so zu generieren, dass sie für diesen Hersteller eindeutig ist und in eine URL eingebunden werden kann, d.h. die Pfadangabe zusammen mit der Hostadresse des Download-Bereiches muss eine gültige URL ergeben. Der Suffix OPB gibt an, dass es sich um ein Update-Paket für den Online-Produktivbetrieb handelt. Andere Suffixe geben an, dass es sich um ein Update-Paket für eine Erprobung handelt. Der Hersteller muss die zulässigen Erprobungs-Suffixe vor der Verwendung mit dem Gesamtverantwortlichen der TI (GTI) abstimmen. Eine einmal benutzte ID für einen Upload kann auch im Falle einer nicht bestandenen Eingangsprüfung mit anschliessender Löschung des Paketes nicht ein weiteres Mal genutzt werden. |
Bezeichnung |
ProductVendorID |
---|---|
Beschreibung |
Identifiziert den Hersteller des Produkts, für welches das Update geeignet ist. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Hersteller-/Anbieter-ID“ ausführlich. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML Datentyp „string“ mit Pattern "[a-zA-Z0-9_]*". Maximale Länge 5 Zeichen. |
Bezeichnung |
ProductCode |
---|---|
Beschreibung |
Identifiziert das Produkt zusammen mit dem ProductVendorID, für welches das Update geeignet ist. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Produktkürzel“ ausführlich. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML Datentyp „string“ mit Pattern "[a-zA-Z0-9_]*". Maximale Länge 8 Zeichen. |
Bezeichnung |
HWVersion |
---|---|
Beschreibung |
Identifiziert zusammen mit ProductCode und ProductVendorID die Hardware, für welche das Update geeignet ist. [gemSpec_OM] beschreibt dieses Element ausführlich. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht genau einem Eintrag mit dem Wertebereich vom XML-Datentyp „string“ mit Pattern „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“ |
Bezeichnung |
ProductName |
---|---|
Beschreibung |
Name des Produkts, für welches das Update geeignet ist. Dies ist der ausgeschriebene Produktname. Dieses Element kann vom Client zur Auswahl des Updates genutzt werden, wenn ein sprechender Name benötigt wird. [gemSpec_OM] beschreibt dieses Element ausführlich. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. Maximale Länge 256 Zeichen. |
Bezeichnung |
CreationDate |
---|---|
Beschreibung |
Datum der Firmware. Es dient der Information des Clients zur Auswahl des Updates. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „date“. |
Mit den Unterelementen von DeploymentInformation kann der Hersteller Hinweise zum Aktivierungszeitraum geben:
Bezeichnung |
DeploymentInformation.StartDate |
---|---|
Beschreibung |
Frühestes Aktivierungsdatum. Falls nicht vorhanden, kann sofort aktiviert werden. Diese Information ist zur Information der dezentralen Komponente gedacht. Durch den Konfigurationsdienst wird dieser Wert nicht ausgewertet. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
ja |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „date“. |
Bezeichnung |
DeploymentInformation.Deadline |
---|---|
Beschreibung |
Zeigt an, bis wann das Update aktiviert werden sollte. Falls nicht vorhanden, gibt es keine derartige Empfehlung. Diese Information ist zur Information der dezentralen Komponente gedacht. Im Element UpdateInformation muss dieses Element enthalten und mit einem Wert ausgefüllt sein, wenn das Element FWPriority den Wert „Kritisch“ hat. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
ja |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „date“. |
Die Unterelemente von Firmware enthalten die Informationen zum Firmware-Update selbst:
Bezeichnung |
FWVersion |
---|---|
Beschreibung |
Die Firmware-Version des vorliegenden Updates. [gemSpec_OM] beschreibt dieses Element ausführlich. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit Pattern "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}" |
In den „Files“-Unterelementen können mehrere FirmwareFiles und DocumentationFiles angegeben werden.
Bezeichnung |
FWPriority |
---|---|
Beschreibung |
Mit diesem Element definiert der Hersteller der dezentralen Komponente die Kritikalität des Firmware Updates. Auf kritische Updates wird der Administrator des Konnektors besonders hingewiesen. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
„Normal“, „Kritisch“ |
In den „Files“-Unterelementen können mehrere FirmwareFiles und DocumentationFiles angegeben werden.
Bezeichnung |
Files.Firmwarefiles.Filename |
---|---|
Beschreibung |
Filename inklusive absolutem Pfad. Dieser Wert wird in der Operation getUpdates HTTP Request als Parameter <filename> genutzt. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen (z.B. „/ProductVendorID/ProductCode/UpdateID/KonFW123.fw“) Der Pfad muss der Definition in TIP1-A_6122 Pfadreferenz genügen und am Ende einen Filename enthalten, der im Update-Paket eindeutig zu finden ist. |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. |
Bezeichnung |
Files.Firmwarefiles.FileSize |
---|---|
Beschreibung |
Größe des Files in Byte. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit Pattern "[0-9]{1,10}". |
Bezeichnung |
Files.Firmwarefiles.Notes |
---|---|
Beschreibung |
Kurze Erläuterung zum Inhalt/Zweck des zugehörigen Files. Diese Information dient der Information der dezentralen Komponente. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. Maximale Länge 256 Zeichen. |
Bezeichnung |
Files.Documentationfiles.Filename |
---|---|
Beschreibung |
Filename inklusive absolutem Pfad. Dieser Wert wird in der Operation getUpdates HTTP Request als Parameter <filename> genutzt. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen . (z.B. „/ProductVendorID/ProductCode/UpdateID/KonFW123.pdf“) |
Optional |
Ja |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. |
Bezeichnung |
Files.Documentationfiles.FileSize |
---|---|
Beschreibung |
Größe des Files in Byte. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit Pattern "[0-9]{1,10}". |
Bezeichnung |
Files.Documentationfiles.Notes |
---|---|
Beschreibung |
Kurze Erläuterung des zugehörigen Files. Diese Information dient der Information der dezentralen Komponente. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein, falls zugehörigen File vorhanden. |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. Maximale Länge 256 Zeichen. |
Bezeichnung |
FirmwareReleaseNotes |
---|---|
Beschreibung |
Durch den Hersteller erstellte Beschreibung des Updates. Hersteller von Konnektoren müssen innerhalb dieses Elements eine URL mit einem alternativen Downloadpunkt im Internet für das Update-Paket angeben. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. Maximale Länge 2048 Zeichen. |
Bezeichnung |
UpdateInformationSignature |
---|---|
Beschreibung |
Dieses Element kann ein Hersteller von Komponenten, die den KSR nutzen, zur Signatur der UpdateInformation nutzen. Die Signatur kann auch als „Detached-Signature“ in einer eigenen Datei übermittelt werden. Das Signaturverfahrenen liegt in Verantwortung des Herstellers, der Konfigurationsdienst wertet dieses Feld nicht aus. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Ja. |
Wertebereich |
Any (vom Hersteller festzulegen) |
Das nachfolgende Beispiel zeigt eine ausgefüllte UpdateInfo.xml. Die Datei definiert eine Firmware-Datei und eine Dokumentations-Datei. Eine Signatur ist nicht eingefügt.
Über das Firmware-Gruppenkonzept für dezentrale Komponenten wird gesteuert, welche Firmware lokal auf der Komponente installiert werden darf. Das Firmware-Gruppenkonzept für dezentrale Komponenten wird in der Übergreifenden Spezifikation
Operations und Maintenance [gemSpec_OM#2.5] beschrieben.
Die nötigen Daten für das Firmware-Gruppenkonzept sind in der Firmware der jeweiligen dezentralen Komponenten enthalten und können durch den Konfigurationsdienst nicht ausgewertet werden. Deshalb liefern die Hersteller von diesen dezentralen Komponenten in einer separaten Datei die aktuellen Firmware-Gruppen-Informationen in einem vom Konfigurationsdienst vorgegebenen Format (siehe unten). Die vom Hersteller gelieferten Firmware-Gruppen-Informationen müssen immer den Informationen, die auch in der aktuellsten Firmware selbst enthalten sind, entsprechen. Der Hersteller kann die Firmware-Gruppen-Informationen auch unabhängig von einem Firmware-Update liefern, um z. B. eine fehlerhafte Firmware-Version von der Verteilung über den Konfigurationsdienst zu entfernen. (In diesem Fall erhält zunächst nur der Konfigurationsdienst die neuen Firmware-Gruppen-Information. Zur Aktualisierung der Firmware-Gruppe in der dezentralen Komponente muss die neue Firmware-Gruppen-Information in das nächste Firmware-Update einfließen.)
Abbildung Abb_KSR_013 gibt einen Überblick über die Verteilung von Firmware-Gruppen-Informationen in der Produktivumgebung (PU) am Beispiel für einen Konnektor:
Der Hersteller kann die Firmware-Gruppen-Information auch ohne Firmware Update liefern. Dann gilt der Ablauf bis zum Schritt 4 mit folgenden Abweichungen:
TIP1-A_3316 - Firmware-Gruppenkonzept Informationen für den Konfigurationsdienst
Der Hersteller einer dezentralen Komponente, welche das Firmware-Gruppenkonzept unterstützt und Firmware an den Konfigurationsdienst liefert, MUSS dem Konfigurationsdienst Informationen über die aktuelle Firmware-Gruppe bereitstellen.
Der Hersteller MUSS für die aktuelle Firmware-Gruppe folgende Informationen bereitstellen:
Bezeichnung |
FirmwareGroupID |
---|---|
Beschreibung |
Identifiziert die Firmware-Gruppe eindeutig. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit dem Pattern „[a-zA-Z0-9_]*“. Maximale Länge: 32 Zeichen |
Bezeichnung |
FirmwareGroupVersion |
---|---|
Beschreibung |
Die Versionsnummer der aktuellen Firmware-Gruppe. Laut GS-A_4868 [gemSpec_OM] muss die Firmware-Gruppe mit aufsteigenden ganzzahligen Nummern versioniert werden. Der Inhalt wird als nummerisches Feld interpretiert. |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit dem Pattern „[0-9]*“ (ganzzahlige Zahlen). Maximale Länge 5 Zeichen. |
Bezeichnung |
FirmwareGroupReleaseNotes |
---|---|
Beschreibung |
Durch den Hersteller von Komponenten, die den KSR nutzen, erstellte Beschreibung der Firmware-Gruppe. Falls es Abhängigkeiten zwischen den referenzierten Produktversionen (Update-Paketen) gibt, MUSS der Hersteller sie hier beschreiben. |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“. Maximale Länge 2048 Zeichen. |
Bezeichnung |
FirmwareGroupSignature |
---|---|
Beschreibung |
Dieses Element kann der Hersteller von Komponenten, die den KSR nutzen, zur Signatur der Firmware-Gruppen-Information nutzen. Die Signatur wird in TIP1-A_6133 definiert. Der Hersteller kann die Signatur auch als „Detached“-Signature nach dem in 5.3.1 definierten Verfahren im Update-Paket speichern. Sofern dieses Feld durch den Hersteller verwendet wird, entspricht der Inhalt des Feldes einer Detached-Signature in einem Base64-Codierten String. |
Befüllung |
Hersteller von Komponenten, die den KSR nutzen |
Optional |
Ja. |
Wertebereich |
Any (vom Hersteller festzulegen) |
TIP1-A_6131 - FirmwareGroupInfo.xml und UpdateInfo.xml - Format
Der Konfigurationsdienst und Hersteller von Komponenten, die den KSR nutzen, MÜSSEN die Datei FirmwareGroupInfo.xml und UpdateInfo.xml nach folgenden Vorgaben prüfen bzw. bereitstellen:
Die Datei verwendet das charset-encoding „UTF-8“
Die Datei definiert den Namespace http://ws.gematik.de/ksr/v1.1 als Default-Namespace.
Es ist keine „schemaLocation“ enthalten. Die Validierung erfolgt ausschließlich mit lokalen Schemadateien im jeweiligen System.
Die Datei kann erfolgreich gegen das XSD-Schema „Konfigurationsdienst.xsd“ validiert werden.
TIP1-A_3317 - Firmware-Gruppenkonzept – Lieferung mit Firmware
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN die Firmware-Gruppen-Information zusammen mit dem Firmware-Update, welches die neue Firmware-Gruppe enthält an den Konfigurationsdienst übergeben.
[<=]Mit der Eingangsprüfung der Updatepakete (siehe Anforderung TIP1-A_3346) wird die korrekte Lieferung von Firmware-Gruppen-Informationen sichergestellt.
TIP1-A_3908 - Firmware-Gruppenkonzept – Streichung Firmware
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN eine aktualisierte Firmware-Gruppen-Information an den Konfigurationsdienst übergeben, wenn eine bisher enthaltene Firmwareversion ungültig (z.B. Sicherheitsproblem, fehlerhafte Firmware, nicht mehr unterstützte Firmware,…) wird.
[<=]TIP1-A_3318 - Firmware-Gruppenkonzept – Lieferung ohne Firmware
Hersteller von Komponenten, die den KSR nutzen, KÖNNEN die Firmware-Gruppen-Information ohne Zusammenhang zu einem Firmware-Update an den Konfigurationsdienst übergeben, falls zu dieser Firmware-Gruppen-Information kein Firmware-Update gehört.
[<=]Dies kann z.B. der Fall sein, wenn eine fehlerhafte Firmware von der Download-Liste gestrichen werden soll.
TIP1-A_3319 - Firmware-Gruppenkonzept – Aktive Firmware-Gruppen-Information
Der Konfigurationsdienst MUSS für jedes Produkt vom Produkttyp Konnektor und eHealth-Kartenterminal genau eine „aktive“ Firmware-Gruppen-Information verwalten.
Ein Produkt ist eindeutig identifiziert über die Attribute
Hersteller-/Anbieter-ID
Produktkürzel
Hardwareversion.
TIP1-A_3320 - Firmware-Gruppenkonzept - Übernahme Firmware-Gruppe
Der Konfigurationsdienst MUSS die in einem Update enthaltene bzw. einzeln gelieferte Firmware-Gruppen-Information übernehmen, wenn
eine Freigabe für das Update-Paket, welches die Firmware-Gruppen-Information enthält, bzw. die einzeln gelieferte Firmware-Gruppen-Information vorliegt und
die Firmware-Gruppen-Information eine höhere Versionsnummer hat als die der aktuell vorliegenden Firmware-Gruppen-Information und
Integrität und Authentizität der Firmware-Gruppen-Information erfolgreich geprüft wurde.
TIP1-A_3321 - Firmware-Gruppenkonzept – Unterstützte Firmware Versionen
Der Konfigurationsdienst MUSS für jedes Produkt ausschließlich die Firmware-Versionen der „aktiven“ Firmware-Gruppen-Information zum Download anbieten.
[<=]TIP1-A_3322 - Firmware-Gruppenkonzept – Integritäts- und Authentizitätsschutz
Der Konfigurationsdienst MUSS – zusammen mit dem Hersteller von Komponenten, die den KSR nutzen, – die Integrität und Authentizität der Firmware-Gruppen-Information für die gesamte Lebenszeit dieser Informationen gewährleisten.
[<=]Das nachfolgende Beispiel zeigt den Inhalt einer ausgefüllten FirmwareGroupInfo.xml.
Das Element „FirmwareGroupSignature“ kann der Hersteller von Komponenten, die den KSR nutzen, zur Signatur der Firmware-Gruppen-Information nutzen.
Für die Signatur der Datei „FirmwareGroupInfo.xml“ sind die in [gemSpec_Krypt#3.1] definierten Standards bindend. Dazu gehört u.a. der Signatur-Standard [ETSI-XAdES].
TIP1-A_6108 - FirmwareGroupInfo.xml Signatur
Der Konfigurationsdienst und Hersteller von Komponenten, die den KSR nutzen, MÜSSEN die Detached-Signature der FirmwareGroupInfo.xml und das in TIP1-A_6133 definierte FirmwareGroupInfo.xml - Element „FirmwareGroupSignature“ unterstützen bzw. prüfen.
[<=]
TIP1-A_6132 - Detached-Signature der FirmwareGroupInfo.xml
Bei Verwendung einer Detached-Signatur MÜSSEN Hersteller von Komponenten, die den KSR nutzen, und der Konfigurationsdienst eine Detached-Signature (UTF-8-kodierte XML-Datei) zur Datei „FirmwareGroupInfo.xml“ mit folgenden Eigenschaften bereitstellen bzw. prüfen:
Hinweis zur Möglichkeit zum Erzeugen der Detached-Signature:
Erstellung einer enveloped-signature als letzter Kind-Knoten des Wurzel-XML-Elementes im Eingabe-XML-Text nach [XMLDSig] und anschließend Verschieben (Kopie und Löschen) des XML-Blockes des resultierenden XML-Elementes signature in eine neue UTF-8-kodierte XML-Datei der Detached-Signature.
TIP1-A_6133 - FirmwareGroupInfo.xml - Element „FirmwareGroupSignature“
Bei Verwendung des Elements „FirmwareGroupSignature“ in der Datei „FirmwareGroupInfo.xml“ MÜSSEN Hersteller von Komponenten, die den KSR nutzen, und der Konfigurationsdienst den Inhalt nach folgender Vorgabe bereitstellen bzw. prüfen:
Die einzige Ausprägung eines zentralen Konfigurationsdatenfiles ist das Konfigurationsdatenfile zur Anbindung von Bestandsnetzen.
TIP1-A_5154 - Konfigurationsdatenfiles zur Anbindung von Bestandsnetzen
Der Anbieter des Konfigurationsdienstes MUSS für die über Aufträge bereitgestellten Konfigurationsdaten zur Anbindung von Bestandsnetzen Konfigurationsdatenfiles erstellen. Die Konfigurationsdatenfiles MÜSSEN auf dem XML-Schema [InfrastrukturKonfig.xsd] entsprechend Abb_KSR_014 basieren und den Vorgaben aus Tabelle Tab_KSR_045 genügen.
[<=] Hinweis: Abb_KSR_014 und Tab_KSR_045 befinden sich im Anhang C.
TIP1-A_6134 - Konfigurationsdatenfile - Format
Der Konfigurationsdienst DARF NICHT von folgenden Vorgaben abweichende Formate akzeptieren:
Wie in [gemKPT_Arch_TIP] dargestellt, wird die Verbindung zwischen Konnektor und Konfigurationsdienst durch TLS abgesichert, um dem Schutzbedarf der übertragenen Informationen (Operationen listUpdates und getUpdates) zu entsprechen.
TIP1-A_3323 - Konfigurationsdienst TLS-Authentisierung
Der Konfigurationsdienst MUSS bei der Absicherung der Verbindung zum Konnektor durch TLS die einseitige Serverauthentisierung unter Nutzung des X.509-Komponentenzertifikats mit der TLS-Server-Identität ID.ZD.TLS_S zur Serverauthentisierung umsetzen.
[<=]TIP1-A_3324 - Konfigurationsdienst TLS-Zertifikatserstellung
Der Anbieter des Konfigurationsdienstes MUSS beim zuständigen PKI-Registrierungsdienst über die Schnittstelle I_Cert_Provisioning [gemKPT_Arch_TIP] das X.509-Komponentenzertifikat mit der TLS-Server-Identität ID.ZD.TLS_S zur TLS Serverauthentisierung beantragen.
TIP1-A_3325 - Konfigurationsdienst Keine Verbindungen ohne TLS
Der Konfigurationsdienst MUSS an der Schnittstelle zum Konnektor ausschließlich Verbindungen mit TLS akzeptieren.
[<=]TIP1-A_3326 - IPv4 und Ipv6 Unterstützung
Der Konfigurationsdienst MUSS IPv4 und IPv6 parallel unterstützen (Dual-Stack-Modus).
[<=]Die Schnittstelle I_KSRS_Download stellt Funktionen bereit, die über URLs aufgerufen werden können.
TIP1-A_6130 - Bereitstellung DNS Resource Records
Der Anbieter des KSR MUSS SRV und optional TXT Resource Records im DNS bereitstellen. Wenn die TXT Resource Records nicht existieren MÜSSEN die <PFAD1> und <PFAD2> Anteile der URL leere Strings sein.
Im DNS sind dazu folgende Einträge durch den KSR Anbieter einzutragen:
Owner TTL Class Type Data
_ksrfirmware._tcp.ksr.<TOP_LEVEL_DOMAIN_TI> <TTL1> <IN> <SRV> <Priorität1> <Gewicht1> <Port1> <FQDN1>
_ksrfirmware._tcp.ksr.<TOP_LEVEL_DOMAIN_TI> <TTL2> <IN> <TXT> "txtvers=<VERSION1>" "path=<PFAD1>"
_ksrkonfig._tcp.ksr.<TOP_LEVEL_DOMAIN_TI> <TTL3> <IN> <SRV> <Priorität2> <Gewicht2> <Port2> <FQDN2>
_ksrkonfig._tcp.ksr.<TOP_LEVEL_DOMAIN_TI> <TTL4> <IN> <TXT> "txtvers=<VERSION2>" "path=<PFAD2>"
TOP_LEVEL_DOMAIN_TI: in der PU = telematik.; in der RU/TU = telematik-test.
[<=]
Die URLs werden vom Konnektor automatisch durch Abfrage der DNS SRV und TXT Resource Records ermittelt. Vom Konnektor werden immer die SRV und TXT Resource Records abgefragt. Wenn die TXT Resource Records nicht existieren sind die <PFAD1> und <PFAD2> Anteile der URL leere Strings.
Die URLs werden wie folgt gebildet:
URL für I_KSRS_Download::listUpdates: https://<FQDN1>:<PORT1><PFAD1>/
URL für I_KSRS_Download „Get File“: https://<FQDN1>:<PORT1><PFAD1>/<relativer_Pfad_und_Dateiname_der_Firmware>
URL für I_KSRS_Download::get_Ext_Net_Config: https://<FQDN2>:<PORT2><PFAD1>/Bestandsnetze.xml
Beispiele
DNS-Abfragen in der TU
[root@srv02 ~]# dig _ksrfirmware._tcp.ksr.telematik-test. SRV +noall +answer
; <<>> DiG 9.10.2-RedHat-9.10.2-0.el6 <<>> _ksrfirmware._tcp.ksr.telematik-test. SRV +noall +answer
_ksrfirmware._tcp.ksr.telematik-test. 86400 IN SRV 10 10 443 download-test.ksr.telematik-test.
[root@srv02 ~]# dig _ksrfirmware._tcp.ksr.telematik-test. TXT +noall +answer
; <<>> DiG 9.10.2-RedHat-9.10.2-0.el6 <<>> _ksrfirmware._tcp.ksr.telematik-test. TXT +noall +answer
_ksrfirmware._tcp.ksr.telematik-test. 86400 IN TXT "txtvers=1" "path=/"
[root@srv02 ~]# dig _ksrkonfig._tcp.ksr.telematik-test. SRV +noall +answer
; <<>> DiG 9.10.2-RedHat-9.10.2-0.el6 <<>> _ksrkonfig._tcp.ksr.telematik-test. SRV +noall +answer
_ksrkonfig._tcp.ksr.telematik-test. 86400 IN SRV 10 10 443 download-test.ksr.telematik-test.
[root@srv02 ~]# dig _ksrkonfig._tcp.ksr.telematik-test. TXT +noall +answer
; <<>> DiG 9.10.2-RedHat-9.10.2-0.el6 <<>> _ksrkonfig._tcp.ksr.telematik-test. TXT +noall +answer
_ksrkonfig._tcp.ksr.telematik-test. 86400 IN TXT "txtvers=1" "path=/"
Die Spezifikation [gemSpec_OM] beschreibt die allgemeinen Anforderungen an das Logging und Tracing. Im Folgenden werden die spezifischen Anforderungen an das Logging des Konfigurationsdienstes beschrieben.
TIP1-A_3328 - Logging Datenänderungen im Konfigurationsdienst
Der Konfigurationsdienst MUSS für alle Aktionen (sowohl intern wie auch an den Außenschnittstellen) mit Update-Paketen und Firmware-Gruppen-Informationen und Konfigurationsdatenfiles Log-Informationen erfassen. Dabei MUSS mindestens folgende Information gespeichert/bereitgestellt werden:
Wer hat etwas getan
Was hat er getan
Mit welchem Informationsobjekt
Zeitpunkt der Aktion
TIP1-A_6135 - Löschen der Logging-Daten
Der Konfigurationsdienst MUSS die gesammelten Logging-Daten nach einer konfigurierten Zeitspanne, spätestens aber nach 90 Tagen aus dem Konfigurationsdienst entfernen.
TIP1-A_6136 - Umfang der gespeicherten Logdaten
Der Konfigurationsdienst MUSS die in Tabelle 26 „Logdatenformat“ enthaltenen Felder entsprechend ihrer Definition füllen und persistent speichern.
Position |
Feld |
Beschreibung |
Typ |
---|---|---|---|
1 |
Timestamp |
Zeitpunkt, zu dem die Aktion gestartet wurde. |
String, Timestamp-Format „YYYY-MM-DD HH:mm:SS,SSS”, Beispiel: „2014-01-08 09:46:18,780“. Die Zeitzone ist UTC |
2 |
UserID |
Eindeutiger Identifikator des eingeloggten Users, bzw. des ausführenden Herstellers (z.B. beim Upload oder Download einer Datei). Sofern das System selbst die Aktion gestartet hat (z.B. durch einen Timer), wird das Feld mit der ID „SYSTEM_KSR“ belegt. |
String, max. 32 Zeichen |
3 |
InfoID |
Identifiziert das Informationsobjekt, mit dem die Aktion ausgeführt wurde. Z.B. UpdateID, FirmwareGroupId |
String, max. 255 Zeichen |
4 |
Action |
Bezeichner der durchgeführten Aktion, z.B. „FREIGABE“, „UPLOAD“, |
String, max. 32 Zeichen |
5 |
State |
Status-Ergebnis der durchgeführten Aktion. |
String, entweder „ERFOLG“, „FEHLER“ oder „REMOTE-FEHLER“ |
6 |
Description |
Textuelle Beschreibung des Ergebnisses der ausgeführten Aktion. Kann leer sein, wenn die Aktion korrekt ausgeführt wurde, enthält in einem Fehlerfall, die Fehlerbeschreibung. |
String, max. 2048 Zeichen |
Action |
InfoID |
---|---|
FILE_UPLOAD |
FILE-IDENTIFIER |
INSERT_CONFIG |
FILE-IDENTIFIER |
PROZESS_FREIGABE_UPDATE_PAKET_AKZEPTIERT |
UPDATE-ID | FIRMWAREGROUP-ID |
PROZESS_FREIGABE_UPDATE_PAKET_FREIGEGEBEN |
UPDATE-ID | FIRMWAREGROUP-ID |
PROZESS_FREIGABE_UPDATE_PAKET_AKTIVIERT |
UPDATE-ID | FIRMWAREGROUPID |
PROZESS_FREIGABE_UPDATE_PAKET_ABGELEHNT |
FILE-IDENTIFIER |
PROZESS_FREIGABE_UPDATE_PAKET_DEAKTIVIERT |
UPDATE-ID | FIRMWAREGROUP-ID |
get_Updates |
UPDATE-ID | Bestandsnetze.xml |
list_Updates |
FIRMWAREGROUP-ID |
BESTANDSNETZE_UPLOAD |
Bestandsnetze.xml |
BESTANDSNETZE_CONFIRM |
Bestandsnetze.xml |
BESTANDSNETZE_REJECT |
Bestandsnetze.xml |
A_17455 - KSR Logging-Daten – Bereitstellung
Der Konfigurationsdienst MUSS täglich zu einem konfigurierbaren Zeitpunkt - die im Konfigurationsdienst angefallenen - Logging-Daten entsprechend Tab_KSR_048 an die Schnittstelle I_OpsData_Update [gemSpec_SST_LD_BD] liefern. Dazu MUSS die Schnittstelle I_OpsData_Update::fileUpload benutzt werden.
Die Logging-Daten MÜSSEN für jeden vollständigen Berichtszeitraum in einer Datei mit folgenden Namenskonventionen gesendet werden:
KSR_Logging_<Start>_<Ende>.csv
<Start> und <Ende> entspricht den Festlegungen in A_17453.
Der Konfigurationsdienst MUSS in jedem Sendevorgang alle seit dem letzten Senden angefallenen Dateien senden.
[<=]
TIP1-A_6102 - Datei-Format Logging- und Statistik-Daten
Der Konfigurationsdienst MUSS die Logging- und Statistik-Daten im CSV-Format bereitstellen.
TIP1-A_5038 - FehlerLog
Der Konfigurationsdienst MUSS lokal erkannte Fehler und Remote-Fehler im lokalen Protokollspeicher (FehlerLog) protokollieren.
[<=]TIP1-A_5039 - Remote-Fehlerbehandlung
Der Konfigurationsdienst MUSS für empfangene Fehlermeldungen von anderen Komponenten folgende allgemeine Vorgaben berücksichtigen:
Empfangene Fehlermeldungen sind als Remote-Fehler zu protokollieren.
Durch empfangene Fehlermeldungen resultierende Folgefehler KÖNNEN an die Fehlermeldung angefügt werden.
TIP1-A_3353-01 - Inhalt der statistischen Daten
Der Anbieter des Konfigurationsdienstes MUSS in den statistischen Daten des Konfigurationsdienstes, die pro Produkt im Downloadbereich angefragten Updates (Operation I_KSRS_Download::listUpdates inklusive aller Parameter des Requests) und bereitgestellten Updates (Operation I_KSRS_Download::getUpdates inklusive UpdateID und Filename) inklusive aller Anfragen bei KSR Download Cache Servern, aufgeschlüsselt nach Produkt und Update-Paket (Element „UpdateID“) im zeitlichen Verlauf entsprechend Tab_KSR_046-01 auflisten.
Position |
Feld |
Beschreibung |
Typ |
---|---|---|---|
1 |
Timestamp |
Zeitpunkt, zu dem der Download gestartet wurde. |
String, Timestamp-Format „YYYY-MM-DD HH:mm:SS,SSS”, Beispiel: „2014-01-08 09:46:18,780“. Die Zeitzone ist UTC |
2 |
ProductVendorID |
Identifiziert den Hersteller des Produkts. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Hersteller-/Anbieter-ID“ ausführlich. |
String, max. 5 Zeichen Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die ProductVendorID der gesendeten Datei. |
3 |
ProductCode |
Identifiziert das Produkt zusammen mit der ProductVendorID. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Produktkürzel“ ausführlich. |
String, max. 8 Zeichen Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ den ProductCode der gesendeten Datei. |
4 |
HWVersion |
Identifiziert zusammen mit ProductCode und ProductVendorID die Hardware. [gemSpec_OM] beschreibt dieses Element ausführlich. |
String „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“) Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die Hardware-Version der gesendeten Datei. |
5 |
FWVersion |
Firmware Version des heruntergeladenen Updates. [gemSpec_OM] beschreibt dieses Element ausführlich. |
String „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“) Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die Firmware-Version der gesendeten Datei. |
6 |
Action |
Ausgeführte Aktion |
String, “listUpdates” für einen Aufruf der Operation “listUpdates”. “getUpdates“, wenn die Operation „getUpdates“ aufgerufen wurde. |
7 |
UpdateID |
Eindeutige Bezeichnung des Updates. |
String, wenn „listUpdates“ aufgerufen wurde, ist dieses Feld leer, ansonsten enthält es die UpdateID des Paketes. |
8 |
Filename |
Dateiname des heruntergeladenen Paketes. |
String, wenn „listUpdates“ aufgerufen wurde, ist dieses Feld leer, ansonsten enthält es den Filename der aufgerufenen Datei ohne den Pfad. |
9 | SZZP-ID | SZZP-ID über den die Anfrage kam. Dient der Ermittlung des betroffenen VPN-Anbieters. | String, max. 5 Zeichen |
TIP1-A_3354 - KSR-Statistiken – Format
Der Anbieter des Konfigurationsdienstes MUSS alle Download-Berichte und Berichte über die listUpdates Abfragen im CSV-Format bereitstellen. Die CSV-Datei MUSS im durch TIP1-A_3353 definierten Format vorliegen.
[<=]A_17453 - KSR-Statistiken – Bereitstellung
Der Konfigurationsdienst MUSS täglich zu einem konfigurierbaren Zeitpunkt KSR-Statistiken im CSV-Format an die Schnittstelle I_OpsData_Update [gemSpec_SST_LD_BD] liefern. Dazu MUSS die Schnittstelle I_OpsData_Update::fileUpload benutzt werden.
Die Statistik-Daten MÜSSEN für jeden vollständigen Berichtszeitraum in einer Datei mit folgenden Namenskonventionen gesendet werden:
KSR_Statistik_<Start>_<Ende>.csv
Aus besonderen Anlässen kann eine Lokalisierung von dezentralen Komponenten nötig sein. Ein Beispiel dafür ist das Finden von Geräten mit nicht zugelassener Firmware.
A_18383 - KSR, Lokalisierung von Firmware
Der Konfigurationsdienst MUSS eine tagesaktuelle Log-Datei bereitstellen, die für alle Aufrufe der Operation-I_KSRS_Download::listUpdates die Parameter entsprechend Tab_KSR_051 enthält.
Position |
Feld |
Beschreibung |
Typ |
1 |
Timestamp |
Zeitpunkt, zu dem die Operation aufgerufen wurde. |
String, Timestamp-Format „YYYY-MM-DD HH:mm:SS,SSS”, Beispiel: „2014-01-08 09:46:18,780“. Die Zeitzone ist UTC |
2 |
ProductVendorID |
Identifiziert den Hersteller des Produkts. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Hersteller-/Anbieter-ID“ ausführlich. |
String, max. 5 Zeichen Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die ProductVendorID der gesendeten Datei. |
3 |
ProductCode |
Identifiziert das Produkt zusammen mit der ProductVendorID. [gemSpec_OM] beschreibt dieses Element unter der Bezeichnung „Produktkürzel“ ausführlich. |
String, max. 8 Zeichen Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ den ProductCode der gesendeten Datei. |
4 |
HWVersion |
Identifiziert zusammen mit ProductCode und ProductVendorID die Hardware. [gemSpec_OM] beschreibt dieses Element ausführlich. |
String „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“) Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die Hardware-Version der gesendeten Datei. |
5 |
FWVersion |
Firmware-Version des heruntergeladenen Updates. [gemSpec_OM] beschreibt dieses Element ausführlich. |
String „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“) Wenn „listUpdates“ aufgerufen wurde, enthält dieses Feld den entsprechenden Parameter des Requests, beim Aufruf von „getUpdates“ die Firmware-Version der gesendeten Datei. |
6 |
Client Adresse |
IP Adresse des Clients. |
String. Darstellung entsprechend RFC791. |
A_18384 - KSR, Lokalisierungsdaten – Format
Der Konfigurationsdienst MUSS die Lokalisierungsdaten im CSV-Format bereitstellen. Die CSV-Datei MUSS im durch TIP1-A_6102 definierten Format und entsprechend A_18383 vorliegen.
[<=]
A_18385-01 - KSR, Lokalisierungsdaten – Bereitstellung
Der Konfigurationsdienst MUSS die tagesaktuellen KSR-Lokalisierungsdaten im CSV-Formatt über eine organisatorische Schnittstelle bereitstellen.
[<=]
A_18386 - KSR, Lokalisierungsdaten – Löschen
Der Konfigurationsdienst MUSS KSR-Lokalisierungsdaten automatisch nach einer konfigurierbaren Anzahl von Tagen löschen.
[<=]
A_18495 - KSR, Lokalisierungsdaten – Abruf nur durch dedizierten VPN-Zugangsdienst
Der Anbieter des Konfigurationsdienstes MUSS sicherstellen, dass die tagesaktuellen KSR-Lokalisierungsdaten nur dem jeweiligen netzsegment-entsprechenden VPN-Zugangsdienst über einen Service-Abruf, der vorher von der gematik zu genehmigen ist, bereitgestellt werden.
[<=]
TIP1-A_5040 - Schlüssel sicher speichern
Der Konfigurationsdienst MUSS Schlüssel sicher speichern und ihr Auslesen verhindern.
[<=]Kryptographische Algorithmen haben eine zeitlich begrenzte Zulässigkeit. Der Konfigurationsdienst muss den Wechsel auf neue kryptographische Algorithmen unterstützen. Im KSR sind folgende Themenbereiche betroffen:
Der Konfigurationsdienst muss für die Migration zu neuen kryptographischen Algorithmen folgende Funktionalitäten unterstützen:
Die Signaturen der Update-Pakete (TIP1-A_6123) und der Datei FirmwareGroupInfo.xml (TIP1-A_6132) werden durch den Hersteller der dezentralen Komponente erstellt (z.B. mit dem "Signier-Tool" (TIP1-A_6066)) und durch den Konfigurationsdienst geprüft. Diese Signaturen werden nicht an die Konnektoren weitergeleitet. Deshalb ist der Konnektor nicht von Änderungen dieser Signaturen betroffen.
Die Signatur der Update-Informationen (TIP1-A_3896) wird durch den Konnektor Hersteller erstellt und durch den Konfigurationsdienst mit dem I_KSRS_Download::listUpdates Response an den Konnektor weitergeleitet. Der Konfigurationsdienst prüft diese Signatur nicht. Diese Signatur wird nicht in vorliegendem Dokument beschrieben. Der Konnektor Hersteller ist für die Kompatibilität dieser Signatur mit den Konnektoren an welche sie weitergeleitet wird zuständig.
Das vorliegende Kapitel spezifiziert das technische Interface I_KSRS_Download.
Über diese Schnittstelle können die zur Verfügung stehenden Update-Pakete vom Konfigurationsdienst abgefragt und heruntergeladen werden.
Im vorliegenden Kapitel werden die Operationen der Schnittstellen detailliert beschrieben. Zu jeder Operation gibt es ein Request- und ein Response-Element.
TIP1-A_3909 - Bereitstellung I_KSRS_Download
Der Konfigurationsdienst MUSS für Clients den Dienst I_KSRS_Download entsprechend der Tabelle Tab_KSR_025 bereitstellen.
Name |
I_KSRS_Download |
|
---|---|---|
Version (KDV) |
gemäß Produkttypversion |
|
Namensraum |
http://ws.gematik.de/ksr/v1.1 |
|
Namensraum-Kürzel |
KSR |
|
Operationen |
Name |
Kurzbeschreibung |
listUpdates |
Auflisten verfügbarer Updates |
|
WSDL |
Konfigurationsdienst.wsdl |
|
Schema |
Konfigurationsdienst.xsd |
TIP1-A_6103 - SOAP-Version
Der Konfigurationsdienst und der Konnektor (KSR-Client) MÜSSEN ausschließlich „SOAP über http“, Version 1.1 für ihre Kommunikation verwenden.
[<=]
Über diese Operation können zur Verfügung stehende Update-Pakete vom Konfigurationsdienst abgefragt werden.
Als Technologie wird für diese Operation SOAP genutzt.
TIP1-A_3330 - I_KSRS_Download::listUpdates
Der Konfigurationsdienst MUSS die logische Operation listUpdates entsprechend der Tabelle Tab_KSR_026 implementieren.
Element |
Beschreibung |
---|---|
Name |
I_KSRS_Download::listUpdates |
Beschreibung |
Die Operation listet die auf dem Konfigurationsdienst verfügbaren Update-Pakete für eine dezentrale Komponente der TI-Plattform auf. |
Initiierender Akteur |
Konnektor |
Weitere Akteure |
Keine |
Auslöser |
Konnektor |
Berechtigungen |
Konnektor |
Vorbedingungen |
Aufgebaute TLS-Verbindung vom Konnektor zum Konfigurationsdienst entsprechend Kapitel 5.5.1. |
Nachbedingungen |
Konfigurationsdienst hat Log-Daten der Abfrage gespeichert und KSR-Client hat UpdateInfos vorliegen sowie gespeichert. |
Aufruf |
Der Aufrufer (Konnektor) ruft über die hier definierte Schnittstelle den Konfigurationsdienst mit den in Kapitel 6.1.1.1.1 definierten Parametern auf. Aufruf der Operation listUpdates mit der URL https://<host>:<port><path> (<host>:<port> wird durch Abfrage des DNS SRV Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt. <path> wird durch Abfrage des DNS TXT Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt.) |
Antwort |
Die Liste der auf dem Konfigurationsdienst verfügbaren Update-Pakete für die dezentrale Komponente entsprechend Beschreibung in Kapitel 6.1.1.1.2. |
Standardablauf |
Der Konfigurationsdienst MUSS die Liste der verfügbaren Updates für die dezentrale Komponente der TI-Plattform zusammenstellen. Diese Liste entspricht dem Element Firmware-Version der „aktiven“ Firmware-Gruppe (siehe Kapitel 5.3) für die Komponente. Der Konfigurationsdienst MUSS im Response die Liste der verfügbaren Updates (Parameter UpdateInformation) sowie die FirmwareGroupReleaseNotes (entspricht Element FirmwareGroupReleaseNotes der „aktiven“ Firmware-Gruppe) an den Client senden. Der Konfigurationsdienst MUSS – entsprechend Festlegungen in Kapitel 5.6 – Log-Daten von dieser Operation speichern. |
Fehlerfälle |
Tritt während der Verarbeitung ein Fehler auf, so MUSS der Konfigurationsdienst die Webservice-Anfrage mit einem SOAP-Fault entsprechend [gemSpec_OM] beantworteten. Die Fehlercodes sind entsprechend Tabelle Tab_Gen_Fehler aus [gemSpec_OM] zu nutzen. |
TIP1-A_3331 - I_KSRS_Download::listUpdates Request
Für den Konfigurationsdienst MUSS die Operation I_KSRS_Download::listUpdates Request mit folgenden Parametern bereitstellen:
Bezeichnung |
I_KSRS_Download::listUpdates Request |
---|---|
Beschreibung |
Operations-Element des Request der Operation I_KSRS_Download::listUpdates |
Bezeichnung |
ProductVendorID |
---|---|
Beschreibung |
Identifiziert den Hersteller des Produkts, für welches auf Updates geprüft werden soll. |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string““ mit Pattern „[a-zA-Z0-9_]*“. Maximale Länge 5 Zeichen. |
Bezeichnung |
ProductCode |
---|---|
Beschreibung |
Identifiziert das Produkt zusammen mit dem ProductVendorID, für welches auf Updates geprüft werden soll. |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string““ mit Pattern „[a-zA-Z0-9_]*“. Maximale Länge 8 Zeichen. |
Bezeichnung |
HWVersion |
---|---|
Beschreibung |
Identifiziert die Hardware zusammen mit ProductCode und ProductVendorID, für welches auf Updates geprüft werden soll. [gemSpec_OM] beschreibt dieses Element ausführlich. |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML Datentyp „string“ mit Pattern „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“. |
Bezeichnung |
FWVersion |
---|---|
Beschreibung |
Die FirmwareVersion des Produkts, für welches auf Updates geprüft werden soll. |
Optional |
Nein |
Wertebereich |
Entspricht dem Wertebereich vom XML-Datentyp „string“ mit Pattern „[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}“. |
TIP1-A_3332 - I_KSRS_Download::listUpdates Response
Der Konfigurationsdienst MUSS die Operation I_KSRS_Download::listUpdates Response mit folgenden Parametern (siehe Abb_KSR_009, Tab_KSR_032, Tab_KSR_033, Tab_KSR_034) bereitstellen:
Bezeichnung |
I_KSRS_Download::listUpdates Response |
---|---|
Beschreibung |
Operations-Element des Response der Operation I_KSRS_Download::listUpdates |
Bezeichnung |
FirmwareGroupReleaseNotes |
---|---|
Beschreibung |
Dieses Element enthält die Release Notes der Firmware-Gruppen-Information. Es beschreibt die Update-Pakete bzw. Firmware der Firmware-Gruppe. |
Optional |
Ja (falls keine Update-Pakete auf dem Konfigurationsdienst vorhanden sind) |
Bezeichnung |
UpdateInformation |
---|---|
Beschreibung |
Dieses Element liefert eine Liste mit bis zu 999 verfügbaren Updates für den im Request spezifizierten Client. Jedes Element der Liste beschreibt ein Update mit allen Elementen der Hersteller-Update-Informationen (siehe Kapitel 5.2). |
Optional |
Ja (falls keine Update-Pakete auf dem Konfigurationsdienst vorhanden sind) |
TIP1-A_3333 - Konfigurationsdienst SOAP-Fehlercodes
Der Konfigurationsdienst MUSS für seine SOAP-Schnittstelle die generischen Fehlercodes
Code 2: Verbindung zurückgewiesen
Code 3: Nachrichtenschema fehlerhaft
Code 4: Version Nachrichtenschema fehlerhaft
Code 6: Protokollfehler
aus Tabelle Tab_Gen_Fehler aus [gemSpec_OM] im SOAP-Fault verwenden. Erkannte Fehler auf Transportprotokollebene müssen auf gematik SOAP Faults (Code 6 aus Tabelle Tab_Gen_Fehler aus [gemSpec_OM]) abgebildet werden.
[<=]Code |
ErrorType |
Severity |
ErrorText |
Auslösende Bedingung |
---|---|---|---|---|
2 |
Technical |
Fatal |
Verbindung zurückgewiesen |
Die Verbindung wurde vom angefragten System zurückgewiesen |
3 |
Technical |
Fatal |
Nachrichtenschema fehlerhaft |
Das Nachrichtenschema war inkorrekt |
4 |
Technical |
Fatal |
Version Nachrichtenschema fehlerhaft |
Die Version des Nachrichtenschemas stimmt nicht mit der geforderten Version überein |
6 |
Technical |
Fatal |
Protokollfehler |
Genauere Aufschlüsselung des Protokollfehlers werden in den Details erfasst |
TIP1-A_3334 - I_KSRS_Download::getUpdates
Der Konfigurationsdienst MUSS die Operation I_KSRS_Download::getUpdates für die Übertragung von Aktualisierungspaketen an dezentrale Komponente der TI-Plattform durch den Konfigurationsdienst entsprechend Tabelle Tab_KSR_035 bereitstellen.
Element |
Beschreibung |
---|---|
Name |
I_KSRS_Download::getUpdates |
Beschreibung |
Mit dieser Operation ruft der Konnektor verfügbare Updates für eine dezentrale Komponente der TI-Plattform vom Konfigurationsdienst ab. Die Auswahl der Files zum Download erfolgt auf Grundlage der zurückgegebenen Werte in Operation listUpdates Response. Die optionale detached Signatur „UpdateInfo.sig“ kann ebenfalls mit dieser Operation übertragen werden. Mit jedem Aufruf dieser Operation wird ein File übertragen. |
Initiierender Akteur |
Konnektor |
Weitere Akteure |
keine |
Auslöser |
Konnektor |
Vorbedingungen |
Aufgebaute TLS-Verbindung vom Konnektor zum Konfigurationsdienst entsprechend Kapitel 5.5.1. |
Nachbedingungen |
Konfigurationsdienst hat Log-Daten gespeichert und der Konnektor hat die Update-Datei vorliegen und gespeichert. |
Aufruf |
Aufruf von TUC_KSR_001 „Get File“ mit der URL https://<host>:<port><path>/<filename> (<host>:<port> wird durch Abfrage des DNS SRV Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt. <path> wird durch Abfrage des DNS TXT Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt. <filename> entspricht dem Filename der Firmwaredatei inklusive absoluten Pfad (siehe z.B. Tab_KSR_015).) |
Standardablauf |
Der KSR sendet die angeforderte Datei an den aufrufenden Konnektor. |
Fehlerfälle |
Neben den Fehlercodes der aufgerufenen technischen Use Cases können keine weiteren Fehlercodes auftreten. |
Der Konnektor kann das Vorhandensein von Updatepaketen mit folgendem Beispielablauf prüfen:
1 Der Konnektor ruft vom KSR mit Operation I_KSRS_Download::listUpdates die Liste der vorliegenden Updatepakete ab (TIP1-A_3331, TIP1-A_3332 ) ab.
2 Der Konnektor prüft für jedes im listUpdates Response vorhandene Konnektor Updatepaket die Signatur ([gemSpec_Kon#TAB_KON_664] Punkt 1, Tab_KSR_003).
2.1 Falls das Konnektor Updatepaket die Signatur im XML Element UpdateInformationSignature enthält wird UpdateInformation mit dieser Signatur validiert (TIP1-A_3896, Tab_KSR_020).
2.2 Falls das Konnektor Updatepaket die Signatur nicht im XML Element UpdateInformationSignature enthält wird es mit seiner detached Signatur validiert (TIP1-A_3896, TIP1-A_6120).
2.2.1 Mit Operation I_KSRS_Download::getUpdates wird die detached Signatur vom KSR geladen (TIP1-A_3334):
2.2.1.1 Zum Aufruf der Operation werden die - noch nicht vorhandenen - Elemente zur Bildung der URL ermittelt:
2.2.1.1.1 Dem Konnektor Updatepaket werden aus UpdateInformation die Werte der XML-Elemente <ProductVendorId>, <ProductCode> und <UpdateID> entnommen (TIP1-A_3332, Tab_KSR_004 , Tab_KSR_005, Tab_KSR_006).
2.2.1.1.2 Für die detached Signatur des Elementes „UpdateInformation“ ist der Dateiname „UpdateInfo.sig“ festgelegt (TIP1-A_6120).
2.2.1.1.3 <host>:<port> wird durch Abfrage des DNS SRV Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt (TIP1-A_3334).
2.2.1.1.4 <path> wird durch Abfrage des DNS TXT Resource Record „_ksrfirmware._tcp.ksr.telematik“ ermittelt (TIP1-A_3334).
2.2.1.2 Aus diesen Werten wird für Operation I_KSRS_Download::getUpdates die URL nach folgendem Schema gebildet: https://<host>:<port><path>/<ProductVendorId>/<ProductCode>/<UpdateID>/UpdateInfo.sig (TIP1-A_3334, Tab_KSR_015)
2.2.1.3 Mit der über diese URL aufgerufenen Operation I_KSRS_Download::getUpdates wird die detached Signaturdatei UpdateInfo.sig auf den Konnektor geladen.
2.2.2 Der Konnektor validiert die UpdateInformation des Konnektor Updatepaketes mit dieser detached Signatur ([gemSpec_Kon#TAB_KON_664] Punkt 1, Tab_KSR_003).
2.3 Falls das Konnektor Updatepaket (UpdateInformation) nicht validiert werden kann wird es nicht weiter verarbeitet ([gemSpec_Kon#TAB_KON_664], TIP1-A_3896).
Für den Download von Konnektor-Konfigurationsdatenfiles wird der technische Use Case TUC_KSR_001 „Get File“ (Kapitel 6.1.1.4) genutzt. Die Konnektor-Konfigurationsdatenfiles erhalten im Gegensatz zu Firmware-Update-Paketen feste URLs. Deshalb können die Konnektor Clients zum Download diese URL direkt – ohne Aufruf von I_KSRS_Download::listUpdates (Kapitel 6.1.1.1) – zum Download nutzen. Die Konnektor-Konfigurationsdatenfiles enthalten immer die aktuellen Konfigurationsdaten, d.h. es gibt jeweils nur eine Version des Konfigurationsdatenfiles im Konfigurationsdienst. Die Aktualisierung der Konnektor-Konfigurationsdaten erfolgt über die organisatorischen Schnittstellen (Kapitel 6.2).
TIP1-A_5160 - I_KSRS_Download::get_Ext_Net_Config
Der Konfigurationsdienst MUSS die Operation I_KSRS_Download::get_Ext_Net_Config für die Übertragung von Konfigurationsdatenfiles an dezentrale Komponenten der TI-Plattform durch den Konfigurationsdienst entsprechend Tabelle Tab_KSR_044 bereitstellen.
Element |
Beschreibung |
---|---|
Name |
I_KSRS_Download::get_Ext_Net_Config |
Beschreibung |
Mit dieser Operation ruft der Konnektor verfügbare Konfigurationsdatenfiles vom Konfigurationsdienst ab. Die Auswahl der Konfigurationsdatenfiles zum Download erfolgt auf Grundlage ihrer fest vorgegebenen Filenamen. Mit jedem Aufruf dieser Operation wird ein File übertragen. |
Initiierender Akteur |
Konnektor |
Weitere Akteure |
keine |
Auslöser |
Konnektor |
Vorbedingungen |
Aufgebaute TLS-Verbindung vom Konnektor zum Konfigurationsdienst entsprechend Kapitel 5.5.1. |
Nachbedingungen |
Konfigurationsdienst hat Log-Daten gespeichert und der Konnektor hat das Konfigurationsdatenfile vorliegen und gespeichert. |
Aufruf |
Aufruf von TUC_KSR_001 „Get File“ mit der URL https://<host>:<port><path>/<filename> (<host> und <port> werden durch Abfrage des DNS SRV Resource Record „_ksrkonfig._tcp.ksr.telematik“ ermittelt. <path> wird durch Abfrage des DNS TXT Resource Record „_ksrkonfig._tcp.ksr.telematik“ ermittelt und enthält den Pfad des Konfigurationsdatenfiles.) |
Standardablauf |
Der KSR sendet das angeforderte Konfigurationsdatenfile an den aufrufenden Konnektor. |
Fehlerfälle |
Neben den Fehlercodes der aufgerufenen technischen Use Cases können keine weiteren Fehlercodes auftreten. |
TIP1-A_5375 - Filename des Konfigurationsdatenfiles zur Anbindung von Bestandsnetzen
Der Konfigurationsdienst MUSS das Konfigurationsdatenfile zur Anbindung von Bestandsnetzen unter dem Filenamen „Bestandsnetze.xml“ zum Download bereitstellen.
[<=]TIP1-A_5161 - TUC_KSR_001 „Get File“
Der Konfigurationsdienst MUSS den technischen Use Case für die Übertragung von Files an dezentrale Komponente der TI-Plattform durch den Konfigurationsdienst entsprechend Tabelle Tab_KSR_043 TUC_KSR_001 „Get File“ bereitstellen.
Element |
Beschreibung |
---|---|
Name |
TUC_KSR_001 „Get File“ |
Beschreibung |
Dieser technische Use Case wird von den Operationen zum Abruf von Files durch den Konnektor vom Konfigurationsdienst genutzt. Mit jedem Aufruf dieser Operation wird ein File übertragen. |
Initiierender Akteur |
Konnektor (bzw. I_KSRS_Download::getUpdates, I_KSRS_Download::get_Ext_Net_Config) |
Weitere Akteure |
keine |
Auslöser |
Konnektor (bzw. I_KSRS_Download::getUpdates, I_KSRS_Download::get_Ext_Net_Config) |
Vorbedingungen |
Aufgebaute TLS-Verbindung vom Konnektor zum Konfigurationsdienst entsprechend Kapitel 5.5.1. |
Eingangsdaten |
filename (Filename welches vom KSR geladen werden soll) |
Nachbedingungen |
Konfigurationsdienst hat Log-Daten gespeichert und der Konnektor hat die Update-Datei vorliegen und gespeichert. |
Aufruf |
http GET entsprechend TIP1-A_3335. |
Standardablauf |
Der Konfigurationsdienst MUSS dem Client das angegebene File mit dem Bezeichner filename entsprechend http 1.1 [RFC2616] übertragen. Der Konfigurationsdienst MUSS Log-Daten von dieser Operation speichern (siehe Kapitel 5.6). |
Fehlerfälle |
Tritt während der Verarbeitung ein Fehler auf, so MUSS der Konfigurationsdienst im http-Response einen entsprechenden http Status Code senden (siehe TIP1-A_4120). |
TIP1-A_3335 - Konfigurationsdienst File Transfer HTTP Request
Der Konfigurationsdienst MUSS den Download eines Files mit einem http GET unterstützen. Dafür MUSS ein http URL-Schema entsprechend [RFC1738] sowie Tabellen Tab_KSR_036 und Tab_KSR_037 unterstützt werden:
https://<host>/<path>
Bezeichnung |
host |
---|---|
Beschreibung |
Der FQDN (fully qualified domain name) des Konfigurationsdienstes und optional eine Portnummer. |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom Datentyp „string“. |
Bezeichnung |
path |
---|---|
Beschreibung |
Absoluter Pfad (siehe z.B. Tab_KSR_015, Tab_KSR_017. |
Optional |
nein |
Wertebereich |
Entspricht dem Wertebereich vom Datentyp „string“. |
TIP1-A_3336 - File Transfer HTTP Response
Der Konfigurationsdienst MUSS in das http-Response die notwendigen http-Header-Datenfelder gemäß [RFC2616] aufnehmen. Im http-Body MUSS der Konfigurationsdienst das angeforderte File zurückgeben.
[<=]TIP1-A_4120 - File Transfer HTTP Status Codes
Der Konfigurationsdienst MUSS die http Status Codes entsprechend [RFC2616] unterstützen.
[<=]TIP1-A_5162 - http Status Code „Retry After“
Wenn der Konfigurationsdienst den getUpdates Request wegen temporärer Überlast oder Maintenance nicht verarbeiten kann, MUSS er den http Status Code 503 Server Unavailable an den Client zurückgeben. Falls dem Konfigurationsdienst der Zeitraum der Nichtverfügbarkeit bekannt ist, SOLL er den Retry-After Header zur Information des Clients nutzen. Der Retry-After Header MUSS ebenfalls bei Überlast zur zeitlichen Lastverteilung genutzt werden. [<=]
TIP1-A_3910 - Konfigurationsdienst File Transfer http Komprimierung
Der Konfigurationsdienst MUSS die Komprimierung des File Transfers über http unterstützen. Dazu muss er das „Content Coding“ [RFC2616] „gzip“ implementieren.
[<=]TIP1-A_7221 - Konfigurationsdienst File Transfer Range Requests
Der Konfigurationsdienst MUSS für den File Transfers über http die Option Range Requests [RFC7233#3.1] zur Fortsetzung von unterbrochenen Transfers unterstützen. [<=]
Zur Entlastung des zentralen Netzes von häufigen Update-Paket-Übertragungen wird im SZZP (Sicherer Zentraler Zugangspunkt) der VPN-Zugangsdienste ein KSR Download Cache Server vorgesehen.
TIP1-A_6104 - KSR Download Cache Server
Der Konfigurationsdienst MUSS für jeden SZZP der VPN-Zugangsdienste einen KSR Download Cache Server vorsehen. Jeder einzelne dieser KSR Download Cache Server MUSS dabei autark laufen und sich eigenständig synchronisieren. Für die zentralen Komponenten des Konfigurationsdienstes MUSS das Vorhandensein und die Anzahl von KSR Download Cache Servern transparent sein.
Die KSR Download Cache Server MÜSSEN folgende Eigenschaften haben:
Jede Instanz MUSS separat in den Umgebungen deploybar sein.
Jede Instanz MUSS eine eigene lokale Datenhaltung besitzen.
Jede Instanz MUSS die Anfragen dezentraler Komponenten ohne die Kommunikation mit anderen Instanzen beantworten können.
TIP1-A_6105 - KSR Download Cache Server Transparenz
Der Konfigurationsdienst MUSS für die dezentralen Komponenten die Transparenz der KSR Cache Server sicherstellen. Mit den KSR Download Cache Servern MUSS die gleiche Schnittstelle I_KSRS_Download bereitgestellt werden wie sie der KSR selbst unterstützt. Der Konfigurationsdienst MUSS sicherstellen, dass Hinzufügen, Entfernen und Ausfall (Redundanzfall) eines KSR Download Cache Servers keinerlei Anpassungen in dezentralen Komponenten erfordert.
[<=]TIP1-A_6106 - KSR Download Cache Server Redundanz
Der Konfigurationsdienst MUSS für die KSR Download Cache Server eine redundante Lösung vorsehen. Der Konfigurationsdienst MUSS sicherstellen, dass Aktivieren und Deaktivieren der Redundanzlösung keinerlei Anpassungen in dezentralen Komponenten erfordert.
[<=]TIP1-A_6125 - KSR Störungsampel Monitoringdaten
Der Konfigurationsdienst MUSS für alle seine Komponenten inklusive der KSR Download Cache Server Monitoringdaten an die Störungsampel senden [gemSpec_St_Ampel] (Schnittstelle I_Monitoring_Update).
[<=]TIP1-A_6109 - KSR Nutzung des zentralen Netzes während Redundanz
Der Konfigurationsdienst KANN während des Ausfalls eines KSR Download Cache Servers für die Übertragung der Update-Pakete zu den dezentralen Komponenten das zentrale Netz verwenden.
[<=]Das vorliegende Kapitel spezifiziert die organisatorischen Interfaces P_KSRS_Upload und P_KSRS_Operations auf Basis der konzeptionellen Schnittstelle P_KSRS_Maintenance (siehe [gemKPT_Arch_TIP#TIP1-A_2394]). Dieses Interface kann vom Anbieter des Konfigurationsdienstes durch technische Schnittstellen und/oder organisatorische Prozesse umgesetzt werden.
Die organisatorischen Schnittstellen ermöglichen es berechtigten Akteuren, Update-Pakete und Konfigurationsdaten in den Download-Bereichen der unterschiedlichen Umgebungen (RU, TU, PU) verfügbar zu machen beziehungsweise und sich über den Status der Update-Pakete im KSR zu informieren. Dies wird durch Aufträge der berechtigten Akteure an den Anbieter des Konfigurationsdienstes realisiert.
Hersteller und TBI/GTI müssen sich für den Zugang zu den organisatorischen KSR-Schnittstellen registrieren. Nach der erfolgreichen Einrichtung werden die Zugangsdaten dem Anwender mitgeteilt und für den Konfigurationsdienst freigeschaltet. Erst nach Freischaltung kann der Anwender sich beim Konfigurationsdienst anmelden und z. B. Update-Pakete einspielen. Hersteller von Komponenten, die den KSR nutzen, bekommen die Berechtigung sich im Upload-Bereich anzumelden, Update-Pakete hochzuladen und Statistikdaten herunterzuladen. Die TBI/GTI der jeweiligen Umgebung erhalten Berechtigung für den Upload- und dem Konfigurationsbereich. Die TBI/GTI können damit Update-Pakete im Upload-Bereich einspielen und die hoch geladenen Pakete im Konfigurationsbereich bearbeiten, d.h. Aufträge zum Deaktivieren oder zur Freigabe des Update-Paketes erteilen. Hersteller von Komponenten, die den KSR nutzen, können – nach Prüfung durch die gematik - Berechtigungen für den Konfigurationsbereich der Testumgebungen erhalten. Die jeweilige Berechtigung wird bei Nutzung der organisatorischen KSR-Schnittstellen durch den Konfigurationsdienst durch die Zugehörigkeit eines Anwenders zu einer Berechtigungsgruppe des Konfigurationsdienstes ermittelt.
TIP1-A_6107 - Bereitstellung Registrierungsinterface
Der Anbieter des Konfigurationsdienstes MUSS berechtigten Akteuren die Registrierung für die Nutzung der organisatorischen KSR-Schnittstellen ermöglichen und ihnen die nötigen Zugangsdaten bereitstellen.
[<=]
TIP1-A_6110 - Authentisierung und Autorisierung
Der Konfigurationsdienst MUSS Akteure der organisatorischen KSR-Schnittstellen authentisieren und autorisieren.
[<=]Im vorliegenden Dokument werden Hersteller von Komponenten, die den KSR nutzen, TBI, GTI oder allgemein Akteure (außer Konnektoren) aus technischer Sicht als Anwender mit einer oder mehreren Rollen betrachtet. Jede Rolle besitzt unterschiedliche Berechtigungen innerhalb des Konfigurationsdienstes.
TIP1-A_6111 - Gruppen und Berechtigungen
Der Konfigurationsdienst MUSS den Akteuren der organisatorischen KSR-Schnittstellen jeweils Rollen gemäß ihrer Gruppenzugehörigkeit und Umgebung entsprechend Tab_KSR_011 zuweisen.
Rolle/Gruppe |
Berechtigung |
---|---|
Hersteller_RU |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in RU anmelden, Pakete hochladen, den Status einsehen und Statistikdaten herunterladen. |
Hersteller_RU_RO |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in RU anmelden, den Status einsehen und Statistikdaten herunterladen. Es sind keine Änderungen von Daten im Konfigurationsdienst erlaubt. |
Hersteller_TU |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in TU anmelden, Pakete hochladen, den Status einsehen und Statistikdaten herunterladen. |
Hersteller_TU_RO |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in TU anmelden, den Status einsehen und Statistikdaten herunterladen. Es sind keine Änderungen von Daten im Konfigurationsdienst erlaubt. |
Hersteller_RU_Konfig |
Die Rolle kann sich an der Web-Applikation des Konfigurationsbereichs in RU anmelden, die Auftragsliste einsehen, Pakete ablehnen, freigeben oder deaktivieren, Statistikdaten herunterladen. Akteure mit dieser Rolle dürfen nur auf eigene Pakete (Pakete mit dem ProductVendorID des Akteurs) und Daten über eigene Pakete zugreifen. |
Hersteller_TU_Konfig |
Die Rolle kann sich an der Web-Applikation des Konfigurationsbereichs in TU anmelden, die Auftragsliste einsehen, Pakete ablehnen, freigeben oder deaktivieren, Statistikdaten herunterladen. Akteure mit dieser Rolle dürfen nur auf eigene Pakete (Pakete mit dem ProductVendorID des Akteurs) und Daten über eigene Pakete zugreifen. |
Hersteller_PU |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in PU anmelden, Pakete hochladen, den Status einsehen und Statistikdaten herunterladen. Diese Rolle erlaubt in der PU nicht die Funktionalitäten Pakete ablehnen, freigeben oder deaktivieren. |
Hersteller_PU_RO |
Die Rolle kann sich an der Web-Applikation des Upload-Bereichs in PU anmelden, den Status einsehen und Statistikdaten herunterladen. Es sind keine Änderungen von Daten im Konfigurationsdienst erlaubt. |
TBI_RU |
Die Rolle kann sich an der Web-Applikation des Konfigurationsbereichs in RU anmelden, die Auftragsliste einsehen, Pakete ablehnen, freigeben oder deaktivieren, Statistik- und Logdaten herunterladen sowie Konfigurationsdatenfiles für RU hochladen, freigeben oder ablehnen. |
TBI_TU |
Die Rolle kann sich an der Web-Applikation des Konfigurationsbereichs in TU anmelden, die Auftragsliste einsehen, Pakete ablehnen, freigeben oder deaktivieren, Statistik- und Logdaten herunterladen sowie Konfigurationsdatenfiles für TU hochladen, freigeben oder ablehnen. |
GTI_PU |
Die Rolle kann sich an der Web-Applikation des Konfigurationsbereichs in PU anmelden, die Auftragsliste einsehen, Pakete ablehnen, freigeben oder deaktivieren, Statistik- und Logdaten herunterladen sowie Konfigurationsdatenfiles für PU hochladen, freigeben oder ablehnen. |
Im vorliegenden Dokument wird von folgenden Rollenzugehörigkeiten ausgegangen. Die Zuordnung dient ausschließlich als Beispiel für dieses Dokument.
Akteur |
Mitgliedschaft in Gruppe |
---|---|
Hersteller |
Hersteller_PU, Hersteller_TU und Hersteller_RU Optional und nach gematik-Bestätigung: Hersteller_RU_Konfig |
Hersteller_RO |
Hersteller_PU_RO, Hersteller_TU_RO und Hersteller_RU_RO |
TBI |
Hersteller_TU, Hersteller_RU, TBI_RU, TBI_TU Optional und nach gematik-Bestätigung: Hersteller_TU_Konfig |
GTI |
Hersteller_PU, GTI |
Diese Kapitel beschreibt die organisatorische Schnittstelle des Konfigurationsdienstes zum „Befüllen“ des Konfigurationsdienstes (Upload-Bereich) durch die Hersteller dezentraler Komponenten.
Über KSR-Upload können Hersteller dezentraler Komponenten Update-Pakete für die Verteilung über den Konfigurationsdienst bereitstellen.
KSR-Upload stellt folgende Funktionalitäten bereit:
TIP1-A_3342 - Bereitstellung P_KSRS_Upload
Der Anbieter des Konfigurationsdienstes MUSS berechtigten Herstellern dezentraler Komponenten der TI, dem Gesamtverantwortlichen TI (PU) und der Testbetriebsinstanz TU/RU eine Möglichkeit zum Übermitteln von Update-Paketen und zugehörigen Firmware-Gruppen-Informationen entsprechend Tabelle Tab_KSR_039 zur Verfügung stellen (P_KSRS_Upload).
Name |
P_KSRS_Upload |
|
---|---|---|
Version (KDV) |
gemäß Produkttypversion |
|
Namensraum |
http://ws.gematik.de/ksr/v1.1 |
|
Namensraum-Kürzel |
KSR |
|
Informationsobjekte |
Name |
Kurzbeschreibung |
UpdateInformation |
Metainformationen zum Update-Paket |
|
FirmwareGroupInformation |
Liste der aktuell freigegebenen Firmware-Versionen eines Produkts. |
|
Schema |
Konfigurationsdienst.xsd |
TIP1-A_3343 - Berechtigung P_KSRS_Upload
Der Anbieter des Konfigurationsdienstes MUSS sicherstellen, dass nur berechtigte Akteure (berechtigte Hersteller von Komponenten, die den KSR nutzen, Gesamtverantwortlicher TI (PU), Testbetriebsinstanz TU und Testbetriebsinstanz (RU) auf P_KSRS_Upload der jeweiligen Umgebung zugreifen können.
[<=]
TIP1-A_3348 - Form und Inhalt Upload-Interface
Der Anbieter des Konfigurationsdienstes MUSS die Form des Upload-Interfaces definieren und mit den berechtigten Akteuren abstimmen.
[<=]TIP1-A_5042 - P_KSRS_Upload parallel nutzbar
Der Konfigurationsdienst SOLL die Kommunikationsschnittstelle von KSR-Upload so implementieren, dass sie parallel durch mehrere Aufrufer nutzbar ist.
[<=]TIP1-A_3345 - KSR Logging – Upload-Interface
Der Konfigurationsdienst MUSS mindestens für folgende Vorgänge Logging-Daten erfassen:
Upload von Update-Paketen und Firmware-Gruppen-Informationen
Ergebnis der Eingangsprüfung
Ein Log-Eintrag MUSS mindestens folgende Informationen erfassen:
Wer hat etwas getan
Was wurde getan
Zeitpunkt
Updatepaket.UpdateInformation.UpdateID bzw. FirmwareGroupInformation.FirmwareGroupID
TIP1-A_6065 - KSR Fortschrittsinformation im Interface P_KSRS_Upload
Der Konfigurationsdienst MUSS während des Übermittelns von Update-Paketen den Nutzer über den Fortschritt des Filetransfers informieren.
[<=]A_14540 - P_KSRS_Upload & P_KSRS_Operations, Optionen zur Anzeige von Listen
Der Anbieter des Konfigurationsdienstes MUSS in den Schnittstellen P_KSRS_Upload und P_KSRS_Operations Nutzern folgende Optionen bei der Anzeige von Update-Paketen – zur Erleichterung der Arbeit mit langen Listen – bereitstellen:
A_15171 - P_KSRS_Upload & P_KSRS_Operations, Gesicherter Zugang
Der Anbieter des Konfigurationsdienstes MUSS in den Schnittstellen P_KSRS_Upload und P_KSRS_Operations den Zugriff der Anwender auf diese Schnittstellen ausschließlich über eine TLS-Verbindung mit serverseitiger Authentifizierung ermöglichen. [<=]
TIP1-A_3346 - Eingangsprüfung
Der Konfigurationsdienst MUSS die übermittelten Update-Pakete und Firmware-Gruppen-Informationen einer Eingangsprüfung unterziehen.
Die Eingangsprüfung MUSS folgende Prüfungen enthalten:
Der Hersteller von Komponenten, die den KSR nutzen, erstellt das entsprechende Update-Paket für seine Komponente. Das Update-Paket für eine Komponente entspricht genau einer Datei. Zur Übertragung des Update-Paketes an den Konfigurationsdienst wird ein ZIP-Container verwendet. Der ZIP-Container ist nach dem Standard [ZIP-APP] formatiert und ist nicht mit einem Passwort geschützt.
Der Konfigurationsdienst soll das Update-Paket in der Eingangsprüfung möglichst vollständig prüfen. Nur bei fehlgeschlagener Prüfung von Integrität und Authentizität muss die Prüfung sofort abgebrochen werden.
TIP1-A_6112 - Name des Update-Paketes
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN den Dateinamen so wählen, das er dem Pattern „[A-Za-z0-9_-.]*“ entspricht und nicht länger als 32 Zeichen ist und der Konfigurationsdienst MUSS die Einhaltung dieser Definition prüfen.
[<=]TIP1-A_6113 - Definition Update-Paket-Struktur
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN Update-Pakete mit den in Tab_KSR_010 (Struktur Update-Paket) definierten Elementen in Form eines ZIP-Containers nach dem Standard [ZIP-APP] erzeugen und der Konfigurationsdienst MUSS die Einhaltung dieser Definition prüfen.
[<=]TIP1-A_6114 - Passwort des Update-Paketes
Hersteller von Komponenten, die den KSR nutzen, DÜRFEN NICHT den ZIP-Container mit einem Passwort schützen und der Konfigurationsdienst DARF NICHT passwortgeschützte ZIP-Container akzeptieren.
[<=]TIP1-A_6115 - Größe des Update-Paketes
Hersteller von Komponenten, die den KSR nutzen, DÜRFEN NICHT Update-Pakete hochladen, deren entkomprimierte Paketgröße den abgestimmten Maximalwert übersteigt und der Konfigurationsdienst DARF NICHT Update-Pakete akzeptieren welche diesen Maximalwert übersteigen.
[<=]
TIP1-A_7253 - KSR – Konfigurierbare Maximalgröße von Update-Paketen
Der Konfigurationsdienst MUSS die Konfiguration der maximalen Größe von Update-Paketen erlauben. Der initiale Wert für diesen Konfigurationsparameter MUSS 1500 Mbyte betragen. Die Änderung des Wertes dieses Konfigurationsparameters durch die gematik MUSS ermöglicht werden. [<=]
TIP1-A_7346 - KSR – Löschen von deaktivierten Update-Paketen
Der Konfigurationsdienst SOLL bei Deaktivierung von Update-Paketen die – vom Hersteller gelieferten – Daten des Update-Paketes im Konfigurationsdienst löschen und die im Konfigurationsdienst vorhandenen Metadaten (Daten über das Update-Paket, welche im GUI angezeigt oder in Logfiles und Reports enthalten sind) entsprechend der vorgegebenen Speicherdauer für diese Daten weiterhin zur Verfügung stellen. [<=]
TIP1-A_7347 - KSR – Anzahl Update-Pakete
Der Konfigurationsdienst MUSS pro Hersteller von dezentralen Produkttypen mindestens 10 Update-Pakete speichern und zum Download anbieten können.
Diese Anzahl muss erweiterbar sein. [<=]
Das Update-Paket enthält folgende Elemente im Wurzel-Verzeichnis des Containers:
Element |
Beschreibung |
Anzahl |
---|---|---|
UpdateInformation |
XML- Datei mit den Metadaten des Update-Paketes. Der Dateiname des Elementes „UpdateInformation“ ist festgelegt auf „UpdateInfo.xml“. Der Typ „UpdateInformation“ wird in dem Schema „Konfigurationsdienst.xsd“ spezifiziert. |
0..1 |
UpdateInfo_Signature |
Optionale „Detached Signature“ für das Element „UpdateInformation“. Der Dateiname ist auf „UpdateInfo.sig“ festgelegt. Die Datei darf höchstens einmal im Paket vorhanden sein. |
0..1 |
FirmwareFiles |
Firmware Dateien zum späteren Download. Maximal dürfen 999 Firmware-Dateien enthalten sein. Sofern eine UpdateInformation im Paket enthalten ist, muss mindestens eine Firmware-Datei enthalten sein. |
0..999 |
DocumentationFiles |
Dokumentationsdateien zum späteren Download. Maximal dürfen 999 Dokumentationsdateien enthalten sein. |
0...999 |
Firmware-Gruppen-Information |
XML-Datei mit den Firmware-Gruppen-Informationen. Der Typ „FirmwareGroupInformation“ wird in dem Schema „Konfigurationsdienst.xsd“ spezifiziert. Der Dateiname des Elementes „Firmware-Gruppen-Information“ ist festgelegt auf „FirmwareGroupInfo.xml“. Das Element „Firmware-Gruppen-Information“ muss in jedem Update-Paket genau einmal vorhanden sein. |
1 |
FirmwareGroupInfo_Signature |
Optionale „Detached Signature“ für das Element „Firmware-Gruppen-Information“. Der Dateiname ist auf „FirmwareGroupInfo.sig“ festgelegt. Die Datei darf höchstens einmal im Paket vorhanden sein. |
0..1 |
TIP1-A_6116 - Update-Paket - Dateinamen und Unterverzeichnisse
Der Konfigurationsdienst und Hersteller von Komponenten, die den KSR nutzen, MÜSSEN folgende Vorgaben im ZIP-Container gewährleisten und fehlerhafte Update-Pakete MÜSSEN abgelehnt werden:
TIP1-A_6117 - Referenzierungen des Update-Paketes
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN Update-Pakete erstellen, in denen alle Firmware- und Dokumentationsdateien in der Datei UpdateInfo.xml referenziert werden.
TIP1-A_6118 - Zusätzliche Dateien im Update-Paket
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN das Update-Paket so erstellen, das nur die in Tab_KSR_010 definierten Elemente in ihr enthalten sind.
TIP1-A_6119 - Update-Paket – Übertragung „Firmware-Gruppen-Information“
Hersteller von Komponenten, die den KSR nutzen, MÜSSEN, sofern es sich um ein Update einer Firmware-Gruppen-Information ohne neue Firmware handelt, das Update-Paket ausschließlich mit dem Element „Firmware-Gruppen-Information“ und dem optionalen Element „FirmwareGroupInfo-Signature“ füllen.
TIP1-A_6120 - Update-Paket – Dateinamen der UpdateInformation Detached-Signatur
Hersteller von Komponenten, die den KSR nutzen, und der Konfigurationsdienst MÜSSEN, sofern das Update-Paket eine Detached-Signatur der Datei UpdateInfo.xml enthält, die Signatur in der Datei mit dem Namen „UpdateInfo.sig“ erstellen bzw. prüfen und fehlerhafte Update-Pakete ablehnen.
[<=]
TIP1-A_6121 - Update-Paket – Dateinamen der FirmwareGroupInfo Detached-Signatur
Hersteller von Komponenten, die den KSR nutzen, und der Konfigurationsdienst MÜSSEN, sofern das Update-Paket eine Detached-Signatur der Datei FirmwareGroupInfo.xml enthält, die Signatur in der Datei mit dem Namen „FirmwareGroupInfo.sig“ erstellen bzw. prüfen und fehlerhafte Update-Pakete ablehnen.
[<=]
TIP1-A_6128 - Vollständige Update-Pakete
Der Konfigurationsdienst DARF unvollständige Update-Pakete NICHT verarbeiten.
[<=]
Für den Download der Dateien des Update-Paketes über die Schnittstelle I_KSRS_Download::getUpdates muss das Update-Paket mit der Pfadreferenz eindeutig bestimmt werden. In der Datenstruktur der Datei „UpdateInfo.xml“ müssen die Felder „Filename“ die Pfadangabe und den Dateinamen enthalten.
TIP1-A_6122 - Pfadreferenz
Die Pfadangabe dient als Referenz auf das Update-Paket beim Download. Innerhalb des Paketes liegen die Dateien im Wurzel(root)-Verzeichnis (siehe Kapitel 6.2.3.1) und werden mit dem <Filename> am Pfadende eindeutig referenziert.
Damit wird es notwendig die UpdateID so zu generieren, dass sie für diesen Hersteller eindeutig und in eine URL eingebunden werden kann, d.h. die Pfadangabe zusammen mit der Hostadresse des Download-Bereiches muss eine gültige URL ergeben.
Der Hersteller von Komponenten, die den KSR nutzen, hat ein - entsprechend den Vorgaben des Konfigurationsdienst-Anbieters beantragtes - X.509-Zertifikat mit einem Private-Key zum Signieren der Dateien erhalten. Mit dem privaten Schlüssel dieses Zertifikats kann der Hersteller mit Hilfe eines Tools die Update-Pakete signieren. Die Grundlage des Signaturverfahrens ist in [gemSpec_Krypt#3.7] definiert. Darin ist der Signaturstandard [ETSI-CAdES] vorgegeben.
Der Konfigurationsdienst verwendet die Signatur des Herstellers zum Verifizieren der Gültigkeit und des Zertifikates.
Folgendes Verfahren wird angewendet zur Verifikation der Signatur der Datei:
TIP1-A_6123 - Update-Paket – Signatur
Der Konfigurationsdienst und Hersteller von Komponenten, die den KSR nutzen, MÜSSEN die detached PKCS#7-Signatur zum Update-Paket mit Signatur-Vorgaben entsprechend [gemSpec_Krypt#A_17359] unterstützen. Das Feld certificates des Feldes signedData der Signatur MUSS das Zertifikat des Signers enthalten (Validation Policy zu [ETSI-CAdES#5.4]). Das Feld signedAttrs der Signatur MUSS die Attribute content-type (OID 1.2.840.113549.1.9.3), message-digest (OID 1.2.840.113549.1.9.4) und ESS signing-certificate-v2 (OID 1.2.840.113549.1.9.16.2.47) enthalten laut [ETSI-CAdES#5.7]. [<=]
TIP1-A_6124 - Bereitstellung KSR Update-Paket Zertifikat
Der KSR-Anbieter MUSS für die Hersteller dezentraler Komponenten X.509-Zertifikate und zugehörige private Schlüssel zum Signieren der Update-Pakete bereitstellen und ihnen Vorgaben machen wie diese Zertifikate beantragt werden können. Hersteller von Komponenten, die den KSR nutzen, MÜSSEN den privaten Schlüssel des bereitgestellten X.509-Zertifikats zum Signieren ihrer Update-Pakete verwenden.
[<=]
TIP1-A_6127 - Fehlerhafte Signaturen
Der Konfigurationsdienst DARF Pakete mit einer fehlerhaften oder nicht verifizierten Signatur NICHT weiter verarbeiten.
[<=]
A_17344 - KSR Bereitstellung "Signier-Tool" für neue kryptographische Algorithmen (ECC-Migration)
Der Anbieter des Konfigurationsdienstes MUSS berechtigten Herstellern dezentraler Komponenten der TI, dem Gesamtverantwortlichen TI (PU) und der Testbetriebsinstanz TU/RU das Tool zur ECC-Signatur von Update-Paketen rechtzeitig vor Auslauf der bisherigen kryptographische Algorithmen bereitstellen.
[<=]
A_17759 - KSR Informationspflicht über neue kryptographische Algorithmen (ECC-Migration)
Der Anbieter des Konfigurationsdienstes MUSS die registrierten Nutzer von dem Upload-Interface – spätestens ab Bereitstellung des Tools – auf das geänderte Tool und den Zeitplan für den Wechsel der kryptographischen Algorithmen hinweisen. [<=]
A_17374 - KSR Gültigkeit der Update-Pakete bei Migration zu neuen kryptographischen Algorithmen (ECC-Migration)
Der Konfigurationsdienst MUSS Update-Pakete, welche erfolgreich die Eingangsprüfung bestanden haben, aber mit abgelösten kryptographischen Algorithmen signiert wurden, weiterhin für die dezentralen Produkte bereitstellen.
[<=]
Hersteller dezentraler Komponenten der TI - welche Update-Pakete über den KSR verteilen - müssen diese Update-Pakete signieren. Der Konfigurationsdienst prüft Signaturen dieser Update-Pakete.
Zur Vereinfachung der Signatur von Update-Paketen stellt der Anbieter des Konfigurationsdienstes ein Signatur-Tool bereit. Dieses Signatur-Tool können Hersteller dezentraler Komponenten zur Erstellung der - durch den KSR geprüften - Signaturen nutzen. Damit werden die Hersteller dezentraler Komponenten entlastet und die Weiterentwicklung dieser Signaturen (z.B. Wechsel von Signaturalgorithmen) kann zentral erfolgen.
TIP1-A_6066 - KSR Bereitstellung "Signier-Tool"
Der Anbieter des Konfigurationsdienstes MUSS berechtigten Herstellern dezentraler Komponenten der TI, dem Gesamtverantwortlichen TI (PU) und der Testbetriebsinstanz TU/RU ein plattformunabhängiges Tool (z.B. auf Java Basis) zur Signatur von Update-Paketen - mit dem vom Anbieter des Konfigurationsdienstes gelieferten X.509-Zertifikat (TIP1-A_6124) - bereitstellen, welches alle durch den KSR geprüften Signaturen eines Update-Paketes erstellen kann. Das sind
Dieses Kapitel beschreibt die organisatorische Schnittstelle des Konfigurationsdienstes zum Gesamtverantwortlichen TI und zur Testbetriebsinstanz der RU und TU.
Wird für diese Schnittstelle TLS zur Verschlüsselung der übertragenen Daten eingesetzt, dann gelten alle - im Produkttypsteckbrief aufgeführten - TLS Anforderungen.
KSR-Management bietet für den Gesamtverantwortlichen TI Funktionalität zur Steuerung und Kontrolle der Verteilung von Update-Paketen.
TIP1-A_3349 - Organisatorische Schnittstelle zur Erteilung von Aufträgen
Der Anbieter des Konfigurationsdienstes MUSS ein Web-Interface für jede Umgebung (RU, TU, PU) im Internet bereitstellen, über die berechtigte Akteure Aufträge zur Aufnahme und Löschung von Update-Paketen und Konfigurationsdatenfiles in die Download-Bereiche der von ihnen verantworteten Umgebungen erteilen können.
[<=]
TIP1-A_3350 - Organisatorische Schnittstelle Form und Inhalt von Aufnahme-Aufträgen
Der Anbieter des Konfigurationsdienstes MUSS Form und Inhalt eines Auftrags zur Aufnahme eines Update-Pakets/Firmware-Gruppen-Informationen und Konfigurationsdatenfiles in den Download-Bereich definieren und mit den berechtigten Akteuren abstimmen. [<=]
TIP1-A_6126 - Organisatorische Schnittstelle Form und Inhalt Ergebnisse von Aufnahme-Aufträgen
Der Anbieter des Konfigurationsdienstes MUSS Form und Inhalt des Ergebnisses eines Auftrags definieren und mit den berechtigten Akteuren abstimmen. Die Ergebnisse MÜSSEN permanent gespeichert und durch berechtigte Nutzer im Web-Interface abrufbar sein. Folgende Informationen MÜSSEN mindestens enthalten sein:
Status |
Beschreibung |
---|---|
Neu |
Das Paket wurde an den Konfigurationsbereich übergeben und wartet auf den Start der Eingangsprüfung. Der Start erfolgt automatisch. |
Test |
Die Eingangsprüfung wird gerade durchgeführt (für Update-Pakete). |
Akzeptiert |
Die Eingangsprüfung wurde erfolgreich durchgeführt. Das Paket wartet auf die Freigabe. |
Abgelehnt |
Die Eingangsprüfung meldete einen Fehler, das Update-Paket wird zurückgewiesen. |
Freigegeben |
Das Paket wurde zum Download freigegeben und wird an den Download-Bereich übertragen. Sobald die Übertragung abgeschlossen ist, wird das Paket automatisch aktiviert. |
Aktiviert |
Das Update-Paket ist in Download-Bereich übertragen und steht dort zum Download durch die Konnektoren bereit. |
Deaktiviert |
Das Update-Paket wurde deaktiviert und ist nicht mehr im Download-Bereich verfügbar. |
TIP1-A_5163 - Organisatorische Schnittstelle zur Übergabe von Konfigurationsdaten
Der Anbieter des Konfigurationsdienstes MUSS Form und Inhalt eines Auftrags zur Übergabe von Konfigurationsdaten definieren und mit den berechtigten Akteuren abstimmen. Folgende Informationen MÜSSEN zwingend enthalten sein:
Auftraggeber
Umgebung, in der der Auftrag ausgeführt werden soll
Name des Konfigurationsdatenfiles
Format für die Übergabe der zugehörigen Konfigurationsdaten
Die übergebenen Konfigurationsdaten ersetzen (nach Freigabe durch die verantwortliche Instanz) die aktuellen Konfigurationsdaten.
[<=]TIP1-A_3913 - Organisatorische Schnittstelle Form und Inhalt von Lösch-Aufträgen
Der Anbieter des Konfigurationsdienstes MUSS Form und Inhalt eines Auftrags zur Löschung eines Update-Pakets/Firmware-Gruppen-Informationen aus dem Download-Bereich definieren und mit den berechtigten Akteuren abstimmen. Folgende Informationen MÜSSEN zwingend enthalten sein:
Auftraggeber
Umgebung, in der der Auftrag ausgeführt werden soll
Eindeutige Referenz auf das bereitzustellende Update-Paket „UpdateID“ bzw. Firmware-Gruppen-Informationen „FirmwareGroupID“
TIP1-A_3355 - Schutz Managementschnittstelle
Der Anbieter des Konfigurationsdienstes MUSS die Kommunikationsschnittstelle P_KSRS_Operations gegen unberechtigte Nutzung schützen. Dazu muss der Anbieter des Konfigurationsdienstes den Auftraggeber identifizieren und authentisieren. Der Anbieter des Konfigurationsdienstes kann weitere Schutzmaßnahmen definieren.
[<=]A_14541 - Status Update-Pakete P_KSRS_Operations
Der Anbieter des Konfigurationsdienstes MUSS sicherstellen, dass berechtigte Akteure (berechtigte Hersteller von Komponenten, die den KSR nutzen, GTI (PU), TBI (TU) und TBI (RU)) in Schnittstelle P_KSRS_Operations der jeweiligen Umgebung den Status der Update-Pakete einsehen können.
[<=]
TIP1-A_3917 - Keine Aufnahme von invaliden Update-Paket bzw. Firmware-Gruppen-Informationen
Ist ein zur Aufnahme beauftragtes Update-Paket bzw. Firmware-Gruppen-Informationen technisch nicht valide (siehe Eingangsprüfung), so DARF der Anbieter des Konfigurationsdienstes es NICHT in den entsprechenden Download-Bereich einstellen.
[<=]TIP1-A_3918 - Aufnahme von validen Update-Paket bzw. Firmware-Gruppen-Informationen
Ist ein zur Aufnahme beauftragtes Update-Paket bzw. eine Firmware-Gruppen-Information technisch valide, so MUSS der Anbieter des Konfigurationsdienstes es nach erfolgreicher Prüfung des Auftrags in den entsprechenden Download-Bereich einstellen.
[<=]TIP1-A_3919 - Durchführungsbestätigung eines Auftrags
Nach Ausführung eines Auftrags MUSS der Anbieter des Konfigurationsdienstes den Auftraggeber die erfolgreiche Durchführung des Auftrages bestätigen bzw. über aufgetretene Fehler informieren.
[<=]TIP1-A_3920 - Form und Inhalt der Durchführungsbestätigung eines Auftrags
Der Anbieter des Konfigurationsdienstes MUSS Form und Inhalt der Durchführungsbestätigung eines Auftrags definieren und mit den berechtigten Akteuren abstimmen.
[<=]TIP1-A_3921 - Logging der Auftragsbearbeitung
Der Anbieter des Konfigurationsdienstes MUSS die Durchführung des Prozesses einschließlich der Beauftragung und Bestätigung in Log-Dateien dokumentieren.
[<=]TIP1-A_3351 - Organisatorische Schnittstelle zur Bereitstellung von PU-Log-Daten
Der Anbieter des Konfigurationsdienstes MUSS dem Gesamtverantwortlichen TI auf Anforderung die Log-Dateien des Upload- und Download-Bereiches der Produktivumgebung (PU) übermitteln.
[<=]
TIP1-A_3922 - Organisatorische Schnittstelle zur Bereitstellung von RU-Log-Daten
Der Anbieter des Konfigurationsdienstes MUSS der Testbetriebsinstanz RU auf Anforderung die Log-Dateien des Upload- und Download-Bereiches der Referenzumgebung (RU) übermitteln.
[<=]
TIP1-A_3923 - Organisatorische Schnittstelle zur Bereitstellung von TU-Log-Daten
Der Anbieter des Konfigurationsdienstes MUSS der Testbetriebsinstanz TU auf Anforderung die Log-Dateien des Upload- und Download-Bereiches der Testumgebung (TU) übermitteln.
[<=]
TIP1-A_3352 - Organisatorische Schnittstelle zur Bereitstellung von statistischen Daten der PU
Der Anbieter des Konfigurationsdienstes MUSS dem Gesamtverantwortlicher TI zyklisch jeden Monat und zusätzlich auf Anfrage adhoc einen Bericht mit den statistischen Daten der Produktivumgebung (PU) übermitteln.
[<=]
TIP1-A_3924 - Organisatorische Schnittstelle zur Bereitstellung von statistischen Daten der RU
Der Anbieter des Konfigurationsdienstes MUSS der Testbetriebsinstanz RU zyklisch jeden Monat und zusätzlich auf Anfrage adhoc einen Bericht mit den statistischen Daten der Referenzumgebung (RU) übermitteln.
[<=]
A_14542 - Berechtigung P_KSRS_Operations
Der Anbieter des Konfigurationsdienstes MUSS sicherstellen, dass
A_14543 - P_KSRS_Operations parallel nutzbar
Der Konfigurationsdienst SOLL die Kommunikationsschnittstelle von P_KSRS_Operations so implementieren, dass sie parallel durch mehrere Aufrufer nutzbar ist.
[<=]
A_14544 - KSR Logging – P_KSRS_Operations
Der Konfigurationsdienst MUSS mindestens für alle Vorgänge welche Daten im Konfigurationsdienst ändern (z.B. Aufnahme-Aufträge und Lösch-Aufträge) Logging-Daten erfassen.
Ein Log-Eintrag MUSS mindestens folgende Informationen erfassen:
TIP1-A_3925 - Organisatorische Schnittstelle zur Bereitstellung von statistischen Daten der TU
Der Anbieter des Konfigurationsdienstes MUSS der Testbetriebsinstanz TU zyklisch jeden Monat und zusätzlich auf Anfrage adhoc einen Bericht mit den statistischen Daten der Testumgebung (TU) übermitteln.
[<=]
TIP1-A_5043 - Organisatorische Schnittstellen parallel nutzbar
Der Konfigurationsdienst SOLL die organisatorischen Schnittstellen so realisieren, dass sie parallel durch mehrere Aufrufer nutzbar sind.
[<=]TIP1-A_6067 - Organisatorische Schnittstelle zur Bereitstellung von KSR Statusberichten der PU
Der Anbieter des Konfigurationsdienstes MUSS dem Gesamtverantwortlichen TI einen Statusbericht im XML-Format mit den Informationen aller auf dem KSR vorliegenden Firmware-Pakete der Produktivumgebung (PU) übermitteln. Dieser Statusbericht MUSS bei jeder Änderung der enthaltenen Daten übermittelt werden.
[<=]
TIP1-A_6074 - Organisatorische Schnittstelle zur Bereitstellung von KSR Statusberichten der PU – Inhalt
Der Anbieter des Konfigurationsdienstes MUSS in dem Statusbericht zu jedem Firmware-Paket mindestens folgende Informationen liefern:
TIP1-A_6075 - Organisatorische Schnittstelle zur Bereitstellung von KSR- Statusberichten der PU – Anhänge
Der Anbieter des Konfigurationsdienstes MUSS mit dem Statusbericht als Anlage alle weiteren aktuell gültigen Konfigurationsdateien hinzufügen, welche die Auswahl von Update-Paketen beeinflussen.
[<=]TIP1-A_6076 - Organisatorische Schnittstelle zur Bereitstellung von KSR- Statusberichten der PU – Excel-Import
Der Anbieter des Konfigurationsdienstes MUSS den Statusbericht in einem XML-Format liefern, welches den Excel-Import und die weitere Analyse des Reports in Excel ermöglicht.
[<=]Kürzel |
Erläuterung |
---|---|
FQDN |
Fully Qualified Domain Name |
GTI | Gesamtverantwortlicher der TI |
KSR |
Konfigurations- und Software Repository |
PU |
Produktivumgebung |
RU |
Referenzumgebung |
SOAP |
Simple Object Access Protocol |
TBI | Testbetriebsinstanz |
TLS |
Transport Layer Security |
TU |
Testumgebung |
Das Glossar wird als eigenständiges Dokument (vgl. [gemGlossar]) zur Verfügung gestellt.
Die nachfolgende Tabelle enthält die Bezeichnung der in dem vorliegenden Dokument referenzierten Dokumente der gematik zur Telematikinfrastruktur. Der mit der vorliegenden Version korrelierende Entwicklungsstand dieser Konzepte und Spezifikationen wird pro Release in einer Dokumentenlandkarte definiert; Version und Stand der referenzierten Dokumente sind daher in der nachfolgenden Tabelle nicht aufgeführt. Deren zu diesem Dokument jeweils gültige Versionsnummern sind in der aktuellen, von der gematik veröffentlichten Dokumentenlandkarte enthalten, in der die vorliegende Version aufgeführt wird.
[Quelle] |
Herausgeber: Titel |
---|---|
[gemGlossar] |
gematik: Glossar der Telematikinfrastruktur |
[gemKPT_Arch_TIP] |
gematik: Konzept Architektur der TI-Plattform |
[gemKPT_Betr] |
gematik: Betriebskonzept |
[gemSpec_Kon] |
gematik: Konnektorspezifikation |
[gemSpec_KT] |
gematik: Spezifikation eHealth-Kartenterminal |
[gemSpec_Net] |
gematik: Spezifikation Netzwerk |
[gemSpec_OM] |
gematik: Spezifikation Operations und Maintenance |
[gemProdT_KSR] |
gematik: Produkttypsteckbrief Konfigurationsdienst |
[gemSpec_Krypt] |
gematik. Verwendung kryptographischer Algorithmen in der Telematikinfrastruktur |
[gemSpec_Perf] |
gematik: Performance und Mengengerüst TI-Plattform |
[gemSpec_SST_LD_BD] |
gematik: Spezifikation Logdaten- und Betriebsdatenerfassung |
[gemSpec_StAmpel] |
gematik: Spezifikation Störungsampel |
[Quelle] |
Herausgeber (Erscheinungsdatum): Titel |
---|---|
[RFC1738] |
Uniform Resource Locators (URL) |
[RFC2119] |
RFC 2119 (März 1997): Key words for use in RFCs to Indicate Requirement Levels S. Bradner, http://tools.ietf.org/html/rfc2109 |
[RFC2616] |
Hypertext Transfer Protocol – http/1.1 |
[ZIP-APP] |
http://www.pkware.com/documents/casestudies/APPNOTE.TXT |
[XMLDSig] |
XML Signature Syntax and Processing (Second Edition) W3C Recommendation 10 June 2008 http://www.w3.org/TR/2008/PER-xmldsig-core-20080326/ |
[ETSI-CAdES] |
ETSI TS 101 733 V1.7.4 (2008-07), Electronic Signatures and Infrastructures (ESI); CMS AdvancedElectronic Signatures (CAdES) |
[ETSI-XAdES] |
ETSI TS 101 903 V1.4.2 (2010-12), Electronic Signatures and Infrastructures (ESI); XML Advanced Electronic Signatures (XAdES) |
Im Folgenden wird ein Beispiel für die Aktualisierung einer dezentralen Komponente beschrieben.
Das Update-Paket besteht im Beispiel aus
Der Administrator / Konnektor befragt zuerst den Konfigurationsdienst nach verfügbaren Updates (Operation listUpdates). Der Konfigurationsdienst gibt eine Liste von verfügbaren Update-Paketen inklusive Release Notes für den angefragten Client zurück. Falls weitere Informationen benötigt werden, können die Dokumentation der Update-Pakete vom Konfigurationsdienst geladen werden.
Der Administrator wählt aus der Liste ein Update-Paket aus und startet das Update (Operation do_Update) für ein ausgewähltes Firmwarefile.
Wahlweise kann sich der Administrator vor dem Download der Firmware die Dokumentation ansehen. Der Administrator kann dann den Download der Firmware ausführen oder den Ablauf ohne Firmware-Download beenden.
Datenelement |
Typ |
Beschreibung |
Wertebereich |
---|---|---|---|
Version |
string |
Version des Konfigurationsdatenfiles |
entsprechend gemSpec_OM# GS-A_3695 |
InventoryNetworks |
complex type |
Netzwerkinformation zu einem oder mehreren Bestandsnetzen |
|
InventoryNetwork |
complex type |
Netzwerkinformation für ein Bestandsnetz |
|
ID |
string |
Identifier des Bestandsnetzes - Der Identifier muss innerhalb von Bestandsnetze.xml eindeutig sein. - Der Identifier darf für ein einmal propagiertes Bestandsnetz nicht geändert werden, da sonst dieses Bestandsnetz als ein neues Bestandsnetz interpretiert wird. |
|
Name |
string |
Name des Bestandsnetzes |
|
Networks |
complex type |
Netzwerkinformation zu einem oder mehreren Netzwerken |
|
Network |
complex type |
Netzwerkwerkinformation zu einem Netzwerk |
|
NetworkAddress |
string |
Netzwerkadresse |
Darstellung entsprechend RFC791 |
NetworkPrefix |
string |
Netzwerkpräfix |
Entsprechend RFC 4632 (1-32) |
DNS |
complex type |
DNS-Information zu einer |
|
Domain |
complex type |
Domaininformation zu einer Domain |
|
DomainName |
string |
Domain Name |
Darstellung entsprechend RFC1035 |
Servers |
complex type |
Liste von einem oder mehreren DNS-Servern |
|
Server |
string |
Host-Adresse für einen DNS-Server |
Darstellung entsprechend RFC791 |
History |
complex type |
Informationen zum Gültigkeitsdatum und Änderungsdatum |
|
ValidFromDate |
string |
Gültig ab |
YYYY-MM-DD |
ValidTilDate |
string |
Gültig bis |
YYYY-MM-DD |
LastChangeDate |
string |
Änderungsdatum |
YYYY-MM-DD |