|
MOA-ID
Konfiguration
|
Konfiguration von MOA ID-Auth v.1.5 und MOA-ID-Proxy 2.0.0
Konfiguration von MOA-ID-Auth v.1.5 und MOA-ID-Proxy 2.0.0
Die Konfiguration von MOA ID wird mittels einer XML-basierten
Konfigurationsdatei, die dem Schema
MOA-ID-Configuration-1.5.1.xsd entspricht, durchgeführt.
Der Ort der Konfigurationsdatei wird im Abschnitt Deployment
der Web-Applikation in Tomcat beschrieben.
Enthält die Konfigurationsdatei relative Pfadangaben, werden
diese relativ zum Verzeichnis in dem sich die MOA-ID Konfigurationsdatei
befindet interpretiert.
ConnectionParameter
Das Element ConnectionParameter enthält Parameter,
die MOA-ID für den Aufbau von Verbindungen zu anderen Komponenten
benötigt. Dieses Element tritt mehrfach in der Konfigurationsdatei
auf und wird daher vorab detailliert beschrieben.
Das Attribut URL enthält die URL der Komponente zu
der die Verbindung aufgebaut werden soll. Wird das Schema https
verwendet, können die Kind-Elemente AcceptedServerCertificates
und ClientKeyStore angegeben werden. Wird das Schema http
verwendet müssen keine Kind-Elemente angegeben werden bzw.
werden diese nicht ausgewertet. Andere Schemas werden nicht unterstützt.
Wird die Verbindung über TLS aufgebaut und erfordert der TLS-Server
eine Client-Authentisierung mittels Zertifikate, dann muss das Kind-Element
ClientKeyStore spezifiziert werden. Im Element ClientKeyStore
wird der Filename des PKCS#12-Keys (relativ zur MOA-ID Konfigurationsdatei)
angegeben. Diesem Keystore wird der private Schlüssel für
die TLS-Client-Authentisierung entnommen. Das Passwort zum Lesen
des privaten Schlüssels wird im Attribut ClientKeyStore/@password
konfiguriert.
Aufgrund der Tatsache, dass starke Verschlüsselung eine Voraussetzung
für MOA-ID darstellt, werden clientseitig nur die folgenden
Cipher Suites unterstützt:
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_RC4_128_MD5
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
Im Kind-Element AcceptedServerCertificates kann ein Verzeichnisname
(relativ zur MOA-ID Konfigurationsdatei) angegeben werden, in dem
die akzeptierten Zertifikate der TLS-Verbindung hinterlegt sind. In
diesem Verzeichnis werden nur Serverzertifikate abgelegt. Fehlt dieser
Parameter wird lediglich überprüft ob ein Zertifikatspfad
zu den im Element <TrustedCACertificates> angegebenen
Zertifikaten erstellt werden kann. Falls dies nicht möglich ist,
kommt es zu einem Fehlerfall.
AuthComponent
AuthComponent enthält Parameter, die nur die MOA-ID
Authentisierungskomponente betreffen. Das Element ist optional
und muss nicht verwendet werden, wenn auf dem Server keine MOA-ID
Authentisierungskomponente installiert wird.
Das Element AuthComponent hat sechs Kind-Elemente:
- BKUSelection (optional)
- Templates (optional)
- SecurityLayer
- MOA-SP
- IdentityLinkSigners
- VerifyInfoboxes (optional ab Version 1.4)
- ForeignIdentities
- OnlineMandates
AuthComponent/BKUSelection
Das optionale Element BKUSelection enthält Parameter
zur Nutzung eines Auswahldienstes für eine Bürgerkartenumgebung
(BKU). Wird das Element nicht angegeben, dann wird die lokale
Bürgerkartenumgebung auf http://localhost:3495/http-security-layer-request
verwendet.
Das Attribut BKUSelectionAlternative gibt an welche
Alternative zur BKU-Auswahl verwendet werden soll. MOA-ID unterstützt
die Werte HTMLComplete (vollständige HTML-Auswahl)
und HTMLSelect (HTML-Code für Auswahl) ["Auswahl
von Bürgerkartenumgebungen", Arno Hollosi].
Das Kind-Element ConnectionParameter spezifiziert die
Verbindung zum Auswahldienst (siehe ConnectionParameter),
jedoch kann das Kind-Element ClientKeyStore nicht angegeben
werden.
AuthComponent/Templates
Das optionale Element Templates kann genau einmal vorkommen, um
das Aussehen der Seiten "Auswahl der Bürgerkartenumgebung" sowie
"Anmeldung mit Bürgerkarte" anzupassen. Des Weiteren können die Templates zur Anmeldung mit Online-Vollmachten angepasst werden. Die hier
spezifizierten (globalen) Templates haben Priorität gegenüber Templates,
die in der aufrufenden URL (vgl. Aufruf von MOA-ID-AUTH)
übergeben werden, haben jedoch Nachrang gegenüber in
der Konfigurationsdatei für eine Online-Applikation individuell definierte (lokale)
Templates (siehe
OnlineApplication/AuthComponent/Templates).
Das heißt, sind in der Konfigurationsddatei für eine Online-Applikation lokale
Templates definiert (Element OnlineApplication/AuthComponent/Templates), so werden
die als global spezifizierten Templates (AuthComponent/Templates) für diese
OnlineApplikation ignoriert, jedoch für alle anderen Online-Applikationen
verwendet. Templates in der aufrufenden URL werden demnach nur mehr dann
herangezogen, wenn in der Konfigurationsdatei weder globale (für alle
Online-Applikationen gültig) noch lokale (Templates je Online-Applikation)
spezifiziert sind. Hinweis: Die Template zur Anmeldung mit Online-Vollmachten können nicht über die URL angegeben werden.
Das Templates-Element hat die zwei Kindelemente
BKUSelectionTemplateund Template. Jedes dieser
zwei Elemente kann genau einmal vorkommen oder fehlen.
Das Kindelement BKUSelectionTemplate spezifiziert ein Template
zur Gestaltung der Seite "Auswahl der Bürgerkartenumgebung",
während das Kindelement Template die Seite
"Anmeldung mit Bürgerkarte" referenziert. Dies beiden Elemente haben genau ein Attribut namens URL,
das die Lage des Templates im Form einer URL beschreibt.
Relative Pfadangaben werden dabei relativ zum Verzeichnis, in dem sich die
MOA-ID Konfigurationsdatei befindet, interpretiert. Bei Templates die über das Protokoll https referenziert werden, muss vor dem Start des Tomcat ein Truststore angegeben werden, das die notwendigen vertrauenswürdigen Zertifikate enthält. Siehe dazu die Parameter in den vorbereiteten Startdateien startTomcat.bat und tomcat-start.sh.
Richtlinien zur Struktur der Templates können der
MOA-ID-Spezifikation bzw. dem Abschnitt
Aufruf von MOA-ID-AUTH
dieses Handbuches entnommen werden.
AuthComponent/SecurityLayer
Das Element SecurityLayer enthält Parameter
zur Nutzung des Security-Layers.
Das Kind-Element TransformsInfo spezifiziert eine
Transformation, die für die Erstellung der Signatur des
AUTH-Blocks als Parameter in den CreateXMLSignatureRequest
des Security-Layers integriert werden muss. Mehrere unterschiedliche
Implementierungen des Security-Layer können durch die
Angabe mehrerer TransformsInfo-Elemente unterstützt
werden.
Das Attribut TransformsInfo/@filename verweist auf
eine Datei, die das globale Element TransformsInfo
vom Typ TransformsInfo enthält. Die Angabe erfolgt
relativ zur MOA-ID Konfigurationsdatei. Das Encoding dieser
Datei muss UTF-8 sein.
Beispiel für
eine TransformsInfo-Datei
AuthComponent/MOA-SP
Das Element MOA-SP enthält Parameter zur Nutzung
von MOA-SP. MOA-SP wird für die überprüfung
der Signatur der Personenbindung und des AUTH-Blocks verwendet.
Wird das Kind-Element ConnectionParameter angegeben,
dann wird MOA-SP über das Webservice angesprochen.
Wird das Kind-Element ConnectionParameter
nicht angegeben so wird eine MOA-ID beiligende Version von
MOA-SP direkt über das Java-API angesprochen. In diesem
Fall muss das System-Property auf die verwendete Konfigurationsdatei
von MOA-SP gesetzt werden. Eine beispielhafte MOA-SP Konfigurationsdatei
ist in $MOA_ID_INST_AUTH/conf/moa-spss/SampleMOASPSSConfiguration.xml
enthalten.
Hinweis: MOA-SP muss entsprechend konfiguriert
werden - siehe hierzu Abschnitt Konfiguration
von MOA-SP. Alle Details zur Konfiguration von MOA-SP
finden sie in der Distribution von MOA-SP/SS beiligenden
Dokumentation im Abschnitt 'Konfiguration'.
Das Kind-Element VerifyIdentityLink/TrustProfileID
spezifiziert eine TrustProfileID, die für den VerifyXMLSignatureRequest
zur Überprüfung der Signatur der Personenbindung
verwendet werden muss. Diese TrustProfileID muss beim
verwendeten MOA-SP Modul konfiguriert sein.
Die Kind-Elemente VerifyAuthBlock/TrustProfileID
und VerifyAuthBlock/VerifyTransformsInfoProfileID
spezifizieren eine TrustProfileID und eine ID für
ein Transformationsprofil, die für den VerifyXMLSignatureRequest
zur überprüfung der Signatur des Auth-Blocks
verwendet werden müssen. Diese TrustProfileID muss
beim verwendeten MOA-SP Modul konfiguriert sein.
AuthComponent/IdentityLinkSigners
Dieses Element gibt an von welchen Signatoren die Signatur
des IdentityLink erstellt werden musste damit der IdentityLink
akzeptiert wird. Für jeden Signator muss der X509SubjectName
nach RFC 2253 spezifiziert werden.
Beispiel
Anmerkung: Ab Version 1.4 ist dieses Element nicht mehr verpflichtend notwendig, da die
Berechtigung von Zertifikaten zum Signieren von Personenbindungen ab Februar
2007 über die Zertifikatseigenschaft "Eigenschaft zur Ausstellung von Personenbindungen"
(OID: 1.2.40.0.10.1.7.1) geprüft wird.
Der Namens-Check des alten Zertifikats wird fix in MOA-ID integriert, sodass das
IdentityLinkSigners-Element in der Konfiguration überflüssig wird.
AuthComponent/VerifyInfoboxes
Ab Version 1.4 bietet MOA-ID die Möglichkeit einer erweiterten Infobox-Validierung,
das heißt, es können neben der Personenbindung auch weitere ausgelesene Infoboxen
validiert werden. Die für die Validierung der Infoboxen notwendigen Parameter
können über die Konfigurationsdatei durch das VerifyInfoboxes
Element sowohl global als auch
lokal
je Online-Applikation gesetzt werden. MOA-ID übergibt diese Parameter der
Applikation, die für die Verifikation des Inhaltes der jeweilgen von der BKU
übermittelten Infobox verantwortlich ist. Im Folgenden wird eine derartige
Applikation als Prüfapplikation bezeichnet.
Das Verifyinfoboxes Element ist optional und kann fehlen,
wenn keine Infoboxen außer der der Personenbindung validiert werden müssen.
Das VerifyInfoboxes-Element hat folgende Kind-Elemente:
- DefaultTrustProfile: Dieses optionale
Element kann nur einmal vorkommen und spezifiziert ein Trust-Profil, das
von einer Prüfapplikation zur Validierung einer Infobox
herangezogen werden kann, wenn für diese Infobox kein eigenes
Trust-Profil gesetzt wurde. Es hat genau ein
Kindelement namens TrustProfileID, das die ID eines in MOA-SP
konfigurierten Trust-Profiles enthält.
Anmerkung: Das Trust-Profil für die
Personenbindung darf nicht
zur Validierung anderer Infoboxen verwendet werden. Das Trust-Profil für
die Bürgerkarte soll nur dann zur Validierung
anderer Infoboxen verwendet werden, wenn die zur Verifikation der Zertifikate benötigten
Wurzelzertifikate bereits im entsprechenden Trust-Store enthalten sind. (vgl.
MOA-ID Spezifikation, Abschnitt 4.6).
- Infobox: Dieses Element kann beliebig oft vorkommen
und kapselt die Parameter, die für die Validierung einer Infobox an die
jeweilige Prüfapplikation übergeben werden.
Das Infobox-Element hat folgende Attribute:
- Identifier: Dieses Attribut muss vorhanden sein und gibt
den Namen der Infobox an. Er muss dabei exakt dem Bezeichner
der jeweiligen zu validierenden Infobox aus der BKU entsprechen, also
zum Beispiel EHSPToken für die GDAToken-Infobox.
- required: Dieses Attribut vom Typ
boolean bestimmt, ob MOA-ID den Inhalt der entsprechenden Infobox
für die Anmeldung zwingend benötigt. Ist es auf true
gesetzt, und wird der entsprechende Infobox-Inhalt nicht von der BKU
übermittelt, so bricht MOA-ID den Anmeldevorgang mit einer Fehlermeldung
ab.
Fehlt dieses Attribut, so wird als Defaultwert false gesetzt.
- provideStammzahl: Dieses Attribut vom Typ
boolean bestimmt, ob die Prüfapplikation die Stammzahl aus der
Personenbindung erhalten darf. Fehlt dieses Attribut, so wird als Defaultwert
false gesetzt.
Anmerkung: Das Attribut steht in keinem Zusammenhang zum gleichnamigen
Attribut OnlineApplication/AuthComponent/@provideStammzahl,
das angibt ob die Stammzahl an die Online-Applikation weitergegeben werden darf.
- provideIdentityLink: Dieses Attribut vom Typ
boolean bestimmt, ob die Prüfapplikation die Personenbindung erhalten
soll. Hat es den Wert true, so wird ein Klone des Wurzel-Elements der Personenbindung
an die Prüfapplikation übergeben, wobei zu beachten ist, dass die
darin enthaltene Stammzahl auf einen leeren String gesetzt wird, falls das
Attribut provideStammzahl auf false
gesetzt ist.
Fehlt das provideIdentityLink-Attribut, so wird als Defaultwert false gesetzt.
Anmerkung 1: Das Attribut steht in keinem Zusammenhang zum gleichnamigen
Attribut OnlineApplication/AuthComponent/@provideIdentityLink,
das angibt ob die Online-Applikation die Personenbindung erhalten
soll.
Anmerkung 2: Der Prüfapplikation werden defaultmäßig der Vorname,
der Familienname, das Geburtsdatum, der Typ der Stammzahl, die Stammzahl
(konfigurierbar) und die öffentlichen Schlüssel aus der Personenbindung
übergeben. Das Attribut provideIdentityLink sollte deshalb
wirklich nur dann auf true gesetzt werden, wenn von der
Prüfapplikation noch andere Daten aus der Personenbindung benötigt
werden.
Das Infobox-Element hat folgende Kind-Elemente:
- FriendlyName: Das Element ist optional und
enthält einen Namen, der von MOA-ID zur Anzeige von, die jeweilige Infobox
betreffende, Fehlermeldungen im Browser verwendet wird. Im Regelfall wird man
hier den deutschen Namen der Infobox setzen, also z.B. GDAToken für die EHSPToken-Infobox.
Fehlt dieses Element, so wird für Fehlermeldungen der Wert des
Identifier-Attributes verwendet.
- TrustProfileID: Das Element ist optional und
bezeichnet ein in MOA-SP konfiguriertes Trust-Profil, das von MOA-ID
für die Validierung der Infobox verwendet wird.
Dabei ist wieder zu beachten, dass das Trust-Profil für die
Personenbindung nicht
zur Validierung anderer Infoboxen verwendet werden darf, und das Trust-Profil für
die Bürgerkarte nur dann zur Validierung
anderer Infoboxen verwendet werden soll, wenn die zur Verifikation der
Zertifikate benötigten Wurzelzertifikate bereits im entsprechenden
Trust-Store enthalten sind. (vgl. MOA-ID Spezifikation, Abschnitt 4.6).
Fehlt dieses Element, so wird das
Default-Trust-Profil
verwendet. Ist dieses auch nicht konfiguriert, so wird für die
Validierung der entsprechenden Infobox keine Zertifikatsprüfung
notwendig sein.
- ValidatorClass: Das Element ist optional
und bezeichnet den Namen der Klasse (voller Package-Name), die von MOA-ID
zur Validierung der Infobox geladen werden soll. Fehlt dieses Element,
so wird MOA-ID versuchen, eine Default-Klasse zu laden, deren Namen aus
dem Identifier-Attribut der Infobox abgeleitet
wird (vgl. MOA-ID-Spezifikation, Abschnitt 4.7.2.3,
Zuordnung eines InfoboxReadResponse zu einer implementierenden Klasse).
Anmerkung: Im Regelfall wird dieses Element fehlen, da bei der
Entwicklung einer Infobox-Prüfapplikation der Default-Klassennamen
verwendet werden sollte. Nur wenn es verschiedene Prüfapplikationen
für eine Infobox gibt, wird man das ValidatorClass
verwenden, um eine andere als die Default-Applikation zu laden.
- SchemaLocations: Das Element ist optional
und referenziert XML-Schemas, die von der Prüfapplikation zum
validierenden Parsen von Infoboxen verwendet werden können. Das
Element hat beliebig viele Schema-Kindelemente, dessen Attribute
namespace und schemaLocation jeweils die Namespace-URI
und den Ort (URI) des entsprechenden Schemas bezeichnen. Relative URIs im
schemaLocation-Attribut sind dabei relativ zum Verzeichnis der
MOA-ID-Konfigurationsdatei zu interpretieren.
Beispiel:
<SchemaLocations>
<Schema namespace="http://ns1.ns1" schemaLocation="schemas/ns1.xsd"/>
<Schema namespace="http://ns2.ns2" schemaLocation="schemas/ns2.xsd"/>
</SchemaLocations>
Weitere Möglichkeiten zur Übergabe von XML-Schemas an die
Prüfapplikation können in der MOA-ID-Spezifikation im
Abschnitt 4.7.2, Erweiterte Infoboxüberprüfung, nachgelesen werden.
- ApplicationSpecificParameters:
Das Element ist optional und nimmt Infobox-kontext-spezifische Parameter
auf.
Da MOA-ID die zusätzlichen zur Personenbindung abgefragten Infoboxen
(bzw. deren Inhalte) nicht a priori kennt, ist es unmöglich vorherzusehen,
welche Parameter eine Prüfapplikation zum Validieren einer Infobox
benötigt. Die Konfiguration sieht daher das Element
ApplicationSpecificParameters vor, um einer bestimmten
Prüfapplikation kontext spezifische Parameter zu übermitteln.
Dieses Element wird vollständig an die Prüfapplikation
weitergegeben, und es obliegt der Prüfapplikation die Kindelemente
des ApplicationSpecificParameters-Element zu extrahieren und zu
interpretieren.
Beispiel:
<ApplicationSpecificParameters>
<Parameter1>content1</Parameter1>
<Parameter2>content2</Parameter2>
<Parameter3>
<Parameter3a>content3a</Parameter3a>
<Parameter3b>content3b</Parameter3b>
</Parameter3>
</ApplicationSpecificParameters>
Eine Beispielkonfiguration finden sie am Ende das Abschnitts
OnlineApplication/AuthComponent/VerifyInfoboxes.
AuthComponent/ForeignIdentities
Ab Version 1.4.7 bietet MOA-ID die Möglichkeit der Nutzung von ausländischen Karten. Hierfür ist ein Stammzahlenregister-Gateway nötig, das einen entsprechenden Zugang zum Stammzahlenregister bereitstellt. Es ist hierzu ein entsprechender ConnectionParameter zu definieren, der die Zugangsdaten zum Gateway bereithält (siehe ConnectionParameter). In der Default-Konfiguration ist der Zugang zum Stammzahlenregister-Gateway bereits aktiviert. Es muss nur noch das Client-Zertifikat für die SSL-Verbinung zum Gateway angegeben werden. Voraussetzung dafür ist ein Zertifikat von A-Trust bzw. A-CERT mit Verwaltungseigenschaft oder Dienstleistereigenschaft. Wenn ihr MOA-ID Zertifikat diese Voraussetzung erfüllt, können Sie dieses hier angeben.
AuthComponent/OnlineMandates
Ab Version 1.5.0 bietet MOA-ID die Möglichkeit der Nutzung von Online-Vollmachten für Anwendungen aus dem öffentlichen Bereich. Hierfür ist ein Online-Vollmachten-Service nötig. Es ist hierzu ein ensprechender ConnectionParameter zu definieren, der die Zugangsdaten zum Online-Vollmachten-Service bereithält (siehe ConnectionParameter). In der Default-Konfiguration ist der Zugang zum Online-Vollmachten-Service bereits aktiviert. Es muss nur noch das Client-Zertifikat für die SSL-Verbinung zum Service angegeben werden. Voraussetzung dafür ist ein Zertifikat von A-Trust bzw. A-CERT mit Verwaltungseigenschaft oder Dienstleistereigenschaft. Wenn ihr MOA-ID Zertifikat diese Voraussetzung erfüllt, können Sie dieses hier angeben.
Hinweis: Um den Online-Vollmachten Modus für eine Online Applikation zu aktivieren, müssen Sie das Vollmachten Profil angeben - siehe hier.
ProxyComponent
ProxyComponent enthält Parameter, die
nur die MOA-ID Proxykomponente betreffen. Das Element
ist optional und muss nicht verwendet werden, wenn auf
dem Server keine MOA-ID Proxykomponente installiert
wird.
Das Element ProxyComponent hat nur das Kind-Element
AuthComponent, das die Verbindung zur Authentisierungs-komponente
beschreibt.
Baut die Proxykomponente die Verbindung zur Authentisierungs-komponente
über ein Webservice auf, dann muss das Element
ConnectionParameter spezifiziert werden.
Baut die Proxykomponente die Verbindung zur Authentisierungs-komponente
über das API auf, dann wird das Element ConnectionParameter
nicht spezifiziert.
OnlineApplication
Für jede Online-Applikation, die über MOA-ID
authentisiert wird, gibt es ein Element OnlineApplication.
Die Parameter betreffen teils die MOA-ID Authentisierungskomponente,
teils die MOA-ID Proxykomponente, teils beide.
Das ab Version 1.3 optionale Attribut OnlineApplication/@type
spezifiziert den Typ der OnlineApplikation und kann
die Werte publicService für eine Applikation
aus dem öffentlichen Bereich und businessService
für eine Anwendung aus dem privatwirtschaftlichen Bereich annehmen.
Ab Version 1.4 kann im Modus businessService ein zusätzliches
logisches Attribut OnlineApplication/@calculateHPI angegeben werden.
Dadurch wird im Falle von calculateHPI="true" im privatwirtschaftlichen
Bereich zur Identifikation der Health Professional Identifier HPI anstatt des wbPKs (siehe
OnlineApplication/AuthComponent/IdentificationNumber) berechnet
und zur Anmeldung weiterverwendet.
Ist dieses Attribut nicht gesetzt, so wird der Typ publicService
vorausgesetzt.
Das Attribut OnlineApplication/@publicURLPrefix
entspricht dem URL-Präfix der nach außen
sichtbaren Domäne der Online-Applikation, welcher
von der MOA-ID Proxykomponente durch den URL-Präfix
der wirklichen Domäne (Attribut OnlineApplication/ProxyComponent/ConnectionParameter/@URL)
ersetzt wird. Es dient als Schlüssel zum Auffinden
der Konfigurationsparameter zur Online-Applikation.
Mit dem Attribut OnlineApplication/@friendlyName kann eine benutzerfreundlicher Name für die Online-Applikation angegeben werden. Dieser Name scheint beim Login des Benutzer auf.
Das Attribut OnlineApplication/@keyBoxIdentifier gibt das Schlüsselpaar an, welches von der Bürgerkartenumgebung
zum Signieren des Auth Blocks verwendet wird. Mögliche
Werte: CertifiedKeypair sowie SecureSignatureKeypair.
Das Attribut OnlineApplication/@target gibt einen konkreten Geschäftsbereich für eine Online-Applikation vor. D.h. es wird der Target-Parameter aus dem Request mit diesem Wert überschrieben. Zusätzlich kann noch ein benutzerfreundlicher Name mittels des Attributs OnlineApplication/@targetFriendlyName für den Geschäftsbereich angegeben werden. Beide Attribute können nur bei einer Online-Applikation für den öffentlichen Bereich angegeben werden.
Das Element OnlineApplication hat optional
zwei Kind-Elemente: AuthComponent und ProxyComponent.
OnlineApplication/AuthComponent
Das Element OnlineApplication/AuthComponent
muss verwendet werden wenn auf dem Server die Authentisierungskomponente
installiert wird. Es enthält Parameter, die
das Verhalten der Authentisierungskomponente bezüglich
der Online-Applikation konfiguriert.
Das optionale Attribut slVersion definiert die Version des
verwendeten SecurityLayer und damit den Namespace aller
Requests, die von MOA-ID an die Bürgerkartenumgebung
geschickt werden. Dieses Attribut kann entweder den Wert 1.1
oder 1.2 annehmen. Fehlt das Attribut, so wird als
Defaultwert 1.1 gesetzt.
Wurde als Typ der Online-Applikation
der Wert businessService (vgl. Attribut OnlineApplication/@type)
spezifiziert, so wird das Attribut slVersion ignoriert
und immer der Wert 1.2 verwendet, da die für
Applikationen aus dem privatwirtschaftlichen Bereich notwendige
Berechnung des wirtschaftsbereichsspezifischen Personenkennzeichens
(wbPK) erst ab SecurityLayer Version 1.2 möglich ist.
Das Attribut provideStammzahl bestimmt,
ob die Stammzahl in den Anmeldedaten aufscheint
oder ob der Wert ausgeblendet (d.h. auf den Leerstring gesetzt)
wird. Die Attribute provideAUTHBlock und
provideIdentityLink steuern, ob die
Anmeldedaten den Auth-Block bzw. die Personenbindung enthalten.
Ab Version 1.3 kann das Attribut provideCertificate
verwendet werden, um das Signatorzertifikat in die
Anmeldedaten aufzunehmen.
Alle Attribute sind optional und haben den Default-Wert
false.
Das Attribut provideFullMandatorData bestimmt ob bei einer Vollmachten-Anmeldung die vollständigen Vollmacht in der SAML Assertion mitgegeben wird oder nur die Basisdaten wie Name, Geburtsdatum und bPK des Vertreters (bzw. Organwalter/PV) sowie Name, Geburtsdatum und bPK (bzw. Name und Stammzahl bei juristischen Personen) des Vertretenen in der Assertion übermittelt. Bei provideFullMandatorData=false werden nur die Basisdaten übermittelt (Defaulteinstellung). Bei provideFullMandatorData=true wird zusätzlich die gesamte Vollmacht übergeben.
Das Attribut useUTC bestimmt ob IssueInstant in der SAML Assertion als UTC (2012-01-26T18:38:35Z, useUTC=true) oder dem Default-Format (z.B.: 2012-01-26T19:38:35+01:00, useUTC=false) angegeben wird.
Anmerkung: Das Attribut provideStammzahl steht in keinem
Zusammenhang zum gleichnamigen Attribut
VerifyInfoboxes/@provideStammzahl,
das angibt ob die Stammzahl an eine Prüfapplikation weitergegeben
werden darf.
Anmerkung: Das Attribut provideIdentityLink steht in keinem
Zusammenhang zum gleichnamigen Attribut
VerifyInfoboxes/@provideIdentityLink,
das angibt ob die Personenbindung an eine Prüfapplikation
weitergegeben werden soll.
OnlineApplication/AuthComponent/IdentificationNumber
Das wirtschaftsbereichsspezifische Personenkennzeichen (wbPK)
wird aus der auf der Bürgerkarte gespeicherten Stammzahl des Bürgers
und der Stammzahl des Wirtschaftsunternehmens berechnet.
Laut E-Governmentgesetz
darf die Errechnung eines wbPK aus der Stammzahl nicht beim Auftraggeber eines
privaten Bereichs durchgeführt werden (vgl. E-GovGesetz §12(1).4), und muss deshalb
an die Bürgerkartenumgebung ausgelagert werden.
Das OnlineApplication/AuthComponent/IdentificationNumber Element
wird nun verwendet, um die Stammzahl des Wirtschaftsunternehmens zu spezifizieren,
welche in weiterer Folge von MOA-ID an die Bürgerkartenumgebung übergeben
wird.
Dieses Element muss bei privatwirtschaftlichen Applikationen
vorhanden sein und wird ignoriert, falls es im Kontext von Anwendungen aus
dem öffentlichen Bereich verwendet wird.
Das Element hat genau eines der folgenden möglichen Kindelemente
aus dem PersonData
Namespace, die als einzigen Inhalt die jeweilige Stammzahl des Unternehmens enthalten:
-
Das Element pr:Firmenbuchnummer enthält als einzigen Inhalt
die Firmenbuchnummer des Unternehmens.
-
Das Element pr:Vereinsnummer enthält als einzigen Inhalt
die Vereinsregisternummer des Unternehmens.
-
Das Element pr:ERJPZahl enthält als einzigen Inhalt eine
Zahl aus dem Ergänzungsregister für nicht-natürliche Personen (CorporateBody).
-
Das Element pr:ZMRzahl enthält als einzigen Inhalt eine
Stammzahl einer natürlichen in Österreich meldepflichtigen Person.
Die Stammzahl ist jeweils ohne Präfix anzugeben, also wird zum Beispiel
die Firmenbuchnummer FN468924i folgendermaßen definiert:
<pr:Firmenbuchnummer>468924i</pr:Firmenbuchnummer>
Leerzeichen werden ignoriert und im Falle einer Firmenbuchnummer werden
führende Nullen gelöscht und Bindestriche aus der Nummer entfernt.
Beispiele:
468924 i wird zu 468924i
00468924 wird zu 468924i
468924-i wird zu 468924i
Alternativ zu den oben angeführten Elementen aus dem
PersonData
Namespace kann auch das Element AnyNumber verwendet werden, um
Stammzahlen zu spezifizieren, die nicht einer der vier oben aufgelisteten
Kategorien zugeordnet werden können.
Das Element AnyNumber hat genau ein Attribut namens Identifier,
das das Präfix der jeweiligen Stammzahl entält. Der Inhalt des
Elements AnyNumber ist die Stammzahl selbst, wobei die selben Regeln
wie oben gelten.
Die Firmenbuchnummer aus obigem Beispiel könnte man nun beispielsweise mit Hilfe das Elements
AnyNumber auch folgendermaßen definieren:
<AnyNumber Identifier="FN">468924i</AnyNumber>
Es sei aber nochmals daraufhingewiesen, dass für Stammzahlen der
Kategorien Firmenbuchnummer, Vereinsnummer,
ERJPZahl und ZMRzahl die vordefinierten Elemente aus
dem PersonData
Namespace verwendet werden sollen. Das Element AnyNumber wurde hauptsächlich in
das Schema aufgenommen, um offen für mögliche Erweiterungen zu sein.
OnlineApplication/AuthComponent/Templates
Dieses Kindelement kann genau einmal vorkommen und entspricht in seiner Struktur dem
Element AuthComponent/Templates.
Es kann verwendet werden, um Templates zur Gestaltung der Seiten
"Auswahl der Bürgerkartenumgebung" und "Anmeldung mit Bürgerkarte" individuell für
eine Online-Applikation zu definieren. Die hier definierten Templates haben
Priorität gegenüber globalen Templates und Templates, die
in der aufrufenden URL übergeben werden.
OnlineApplication/AuthComponent/TransformsInfo
Dieses Kindelement kann mehrfach vorkommen und entspricht in seiner Struktur
dem Element AuthComponent/SecurityLayer/TransformsInfo.
Das Element kann verwendet werden, um für unterschiedliche
Online-Applikationen unterschiedliche Transformationen zu spezifizieren.
Alle über dieses Element definierten Transformationen haben
Vorrang gegenüber die durch AuthComponent/SecurityLayer/TransformsInfo
angegebenen Transformationen. Das heißt, ist für eine
Online-Applikation das Kindelement AuthComponent/TransformsInfo
vorhanden, so wird für diese Applikation die durch dieses Element
spezifizierte Transformation verwendet (das Element kann natürlich
mehrfach vorkommen, wodurch mehrere Transformationen bezeichnet werden).
Für alle Applkikationen, die kein Kindelement vom Typ
AuthComponent/TransformsInfo enthalten, werden die unter
AuthComponent/SecurityLayer/TransformsInfo spezifizierten
"Default-Transformationen" verwendet.
Dabei ist zu beachten, dass für jede definierte Transformation
ein entsprechendes MOA-SP/VerifyAuthBlock/VerifyTransformsInfoProfileID
Element vorhanden sein muss.
OnlineApplication/AuthComponent/VerifyInfoboxes
Dieses optionale Element entspricht dem VerifyInfoboxes-Element
aus der globalen AUTH-Komponente und überschreibt teilweise die
dort gesetzten Werte für die jeweilige Infobox pro Online-Applikation.
Dabei gelten die folgenden Regeln:
Ist nur das globale VerifyInfoboxes-Element
vorhanden, so gelten die dort definierten Parameter für alle
Online-Applikationen. Ist kein globales Element vorhanden, so kann
MOA-ID für alle Online-Applikation, in deren AUTH-Komponente
ein VerifyInfoboxes-Element enthalten ist, die darin
definierten Infoboxen überprüfen. Für
Online-Applikationen, in deren AUTH-Komponente kein
VerifyInfoboxes-Element gesetzt ist, kann demnach keine
andere Infobox als die der Personenbindung validiert werden.
Sind sowohl global (MOA-IDConfiguration/AuthComponent/VerifyInfoboxes)
als auch lokal (OnlineApplication/AuthComponent/VerifyInfoboxes)
in den Online-Applikationen Infobox-Validatoren konfiguriert, so verarbeitet
MOA-ID die darin enthaltenen Parameter wie folgt:
- DefaultTrustProfile: Ein lokal
definiertes Default-Trust-Profil hat sowohl Vorrang gegenüber einem
global gesetzten Default-Trust-Profil
als auch gegenüber einem global gesetzen
infobox-spezifischen Trustprofil. Ist
beispielsweise im globalen VerifyInfoboxes-Element zwar kein
Default-Trust-Profil, aber für die Infobox A ein eigenes Trust-Profil
definiert, so wird ein lokal definiertes Default-Trust-Profil dem global
für die Infobox A gesetzten Trust-Profil vorgezogen.
- Infobox: MOA-ID kann die Vereinigung aus den
global und lokal konfigurierten Infoboxen für eine Online-Applikation
validieren. Sind beispielsweise global Prüfapplikationen
für die Infoboxen mit den Bezeichnern
(Infobox/@Identifier-Attribut) A
und B konfiguriert, und lokal für die Online-Applikation
OA1 die Infoboxen B, C und D, so
kann MOA-ID für die Online-Applikation OA1 die
Infoboxen A, B, C und D validieren.
Für die Infobox A werden dabei die Parameter aus der
globalen Konfiguration verwendet und für die Infoboxen
C und D die lokalen Parameter. Für die Infobox
B sind sowohl globale als auch lokale Parameter vorhanden,
die von MOA-ID wie folgt interpretiert werden:
- Attribute:
Die Attribute required,
provideStammzahl und
provideIdentityLink überschreiben
die global gesetzten Werte. Dabei ist zu beachten, das ein Fehlen dieser
Attribute bedeutet, dass ihnen über das Schema der Defaultwert
false zugewiesen wird. Ist also beispielsweise für die
Infobox mit dem Bezeichner B das required-Attribut
global auf true gesetzt (<Infobox Identifier="B" required="true">)
und fehlt dieses Attribut lokal in der Online-Applikation OA1
(<Infobox Identifier="B">), so hat das required-Attribut
für die Infobox B den Wert false.
Die Attribute required,
provideStammzahl und
provideIdentityLink müssen also
für Infoboxen, die sowohl global als auch lokal konfiguriert sind,
in jeder lokalen Konfiguration neu gesetzt werden, wenn ihnen der Wert
true zugwiesen werden sollen.
- Kind-Elemente:
- FriendlyName:
Ein lokal gesetzter FriendlyName wird einem global
gesetzten vorgezogen. Ist sowohl lokal als auch global kein
FriendlyName definiert, so wird das
Identifier-Attribut als FriendlyName
verwendet.
- TrustProfileID:
Ein lokal definiertes Trust-Profil wird einem lokal definierten
Default-Trust-Profil vorgezogen. Sind lokal sowohl kein
Default-Trust-Profil als auch kein infobox-spezifisches Trust-Profil
definiert, so wird das global gesetzte infobox-spezifisches Trust-Profil
verwendet. Fehlt auch dieses, so wird das globale Default-Trust-Profil
selektiert. Ist weder lokal als auch lokal ein Trust-Profil
definiert, so wird für für die Validierung dieser
Infobox kein Trust-Profil benötigt.
- ValidatorClass:
Eine lokal gesetzte Validator-Klasse wird einer global gesetzten
vorgezogen. Ist sowohl lokal als auch global für eine Infobox
keine Validator-Klasse konfiguriert, so wird die Default-Klasse
geladen (siehe ValidatorClass).
- SchemaLocations:
Lokal definierte Schemas werden global definierten vorgezogen.
Sind lokal keine Schemas konfiguriert, so werden die globalen verwendet,
so sie vorhanden sind.
-
ApplicationSpecificParameters:
Lokal definierte applikationsspezifische Parameter werden global
definierten vorgezogen. Sind lokal keine derartigen Parameter
konfiguriert, so werden die globalen verwendet, so sie vorhanden
sind.
Beispiel: In der Konfigurationsdatei
SampleMOAIDVerifyInfoboxesConfiguration.xml sind global
( MOA-IDConfiguration/AuthComponent/VerifyInfoboxes)
Prüfapplikationen für die beiden Infoboxen mit den Bezeichnern
InfoboxA und InfoboxB konfiguriert.
InfoboxA demonstriert in diesem Beispiel die minimale Konfiguration
einer Prüfapplikation - es ist nur der Identifier angegeben. MOA-ID
wird in diesem Fall versuchen, die Default-Validatorklasse
at.gv.egovernment.moa.id.auth.validator.infoboxa.InfoboxAValidator
zu laden (siehe dazu auch MOA-ID-Spezifikation, Abschnitt 4.7.2.3,
Zuordnung eines InfoboxReadResponse zu einer implementierenden Klasse).
Da ein Default-Trust-Profil ( GlobalVIDefaultTrust) konfiguriert ist,
wird MOA-ID dieses Profil zur Verifikation von Zertifikaten heranziehen.
Da kein FriendlyName gesetzt ist, wird das Identifier Attibut
( InfoboxA) als FriendlyName verwendet. Weitere Parameter
sind für die Verifikation dieser Infobox nicht erforderlich.
Die Prüfapplikation für die InfoboxB setzt nahezu alle
möglichen Parameter mit Ausnahme der Validator-Klasse. MOA-ID wird
zur Verifikation dieser Infobox also auch die dafür zustädige Default-Klasse
( at.gv.egovernment.moa.id.auth.validator.infoboxb.InfoboxBValidator)
laden, und alle konfigurierten Parameter an diese Klasse übergeben.
In die Konfigurationsdatei sind drei Online-Applikationen mit den
public URL-Prefixen https://OA1/, https://OA2/ und
https://OA3/ eingetragen.
Online-Applikation OA1 konfiguriert Prüfapplikationen für
die drei Infoboxen InfoboxB, InfoboxC und
InfoboxD. Das heißt, MOA-ID kann für die Online-Applikation
OA1 insgesamt vier Infoboxen überprüfen: die
Parameter für die Infobox InfoboxA werden
von der entsprechenden global konfigurierten Prüapplikation
übernommen. Die Infoboxen InfoboxC und
InfoboxD sind nur lokal gesetzt. Für InfoboxB
übernimmt MOA-ID die applikationsspezifischen Parameter aus der
entsprechenden global konfigurierten Infobox und überschreibt
alle weiteren Parameter mit den lokalen Werten. Als Trust-Profil wird
das lokale Deafult-Trust-Profil ( LocalOA1DefaultTrust) genommen -
dieses hat Vorrang gegenüber den global gesetzten Profilen. Weiters
ist zu beachten, dass die Attribute provideStammzahl und
provideIdentityLink lokal nicht gesetzt sind, und daher den
Deafult-Wert false einnehmen.
Das VerifyInfoboxes-Element in der AUTH-Komponente der zweiten
Online-Applikation ( OA2) spezifiziert keine anderen Prüfapplikationen
als die global definierten, überschreibt aber für beide Infoboxen
teilweise die global gesetzten Parameter. InfoboxA verwendet
ein lokal definiertes Trust-Profil ( LocalInfoboxOA2ATrust),
InfoboxB übernimmt
alle globalen Parameter, setzt aber für die Attribute required,
provideStammzahl und provideIdentityLink jeweils den
Defaultwert false.
Die dritte Online-Applikation OA3 enthält in Ihrer AUTH-Komponente
kein VerifyInfoboxes-Element. MOA-ID übernimmt daher für
diese Online-Applikation die global konfigurierten Infobox-Prüapplikationen
( InfoboxA und InfoboxB) mit allen Paramertern genauso wie
sie dort gesetzt sind. Zu beachten ist hier, dass das in der AUTH-Komponente
auf true gesetzte Attribut proviedStammzahl die
Online-Applikation und nicht die Prüapplikation
betrifft.
OnlineApplication/AuthComponent/Mandates
Mit Hilfe dieses Elements werden die Online-Vollmachten für die Online-Applikation aktiviert.
Als Kindelement muss Profiles angegeben werden. Dieses Element beinhaltet eine (Komma-separierte)
Liste von Vollmachten-Profilen, die festlegen mit welchen Vollmachtstypen man sich bei der Online-Applikation anmelden kann.
Unter https://vollmachten.stammzahlenregister.gv.at/mis/ finden Sie eine Liste der unterstützen Vollmachten-Profile.
Hinweis: Hierzu muss auch die Verbindung zum Online-Vollmachten Service konfiguriert werden - siehe hier
OnlineApplication/ProxyComponent
Das Element OnlineApplication/ProxyComponent
muss verwendet werden wenn auf dem Server die
Proxykomponente installiert wird.
Das optionale Attribut configFileURL
verweist auf eine Konfigurationsdatei die dem Schema
MOA-ID-Configuration-1.5.1.xsd
entspricht mit Dokument-Element Configuration.
Die Angabe erfolgt relativ zur verwendeten MOA-ID
Konfigurationsdatei. Beispiel für das Element
configFileURL: "oa/SampleOAConfiguration.xml".
Defaultmäßig wird versucht die Datei
von der betreffenden OnlineApplikation unter dem
Wert: http://<realURLPrefix>/MOAConfig.xml
zu laden.
(<realURLPrefix> entspricht dem
Wert von OnlineApplication/ProxyComponent/ConnectionParameter/@URL)
Das optionale Attribut sessionTimeOut
legt das Timeout einer Benutzersession in der
Proxykomponente in Sekunden fest.
Default-Wert: 3600
Im optionalen Attribut loginParameterResolverImpl
kann der Klassenname eines zu verwendenden LoginParameterResolver
angegeben werden, welcher die Defaultimplementierung
ersetzt.
Im optionalen Attribut loginParameterResolverConfiguration
kann ein Configurationsstring für die
Initialisierung der betreffenden loginParameterResolverImpl
angegeben werden.
Im optionalen Attribut connectionBuilderImpl
kann der Klassenname eines zu verwendenden ConnectionBuilder
angegeben werden, welcher die Defaultimplementierung
ersetzt.
Im optionalen Attribut errorRedirectURL
kann eine URL auf ein Server zur Fehlerbehandlung eingetragen werden.
Dritt während des Anmeldevorgangs ein Fehler auf wird die Fehlermeldung and dieses
Service als http GET Request übertragen.
Im Kind-Element ConnectionParameter ist
konfiguriert, wie MOA-ID-PROXY zur Online-Applikation
verbindet.
ChainingModes
Das Element ChainingModes definiert,
ob bei der Zertifikatspfad-überprüfung
das Kettenmodell ("chaining") oder
das Modell nach PKIX RFC 3280 ("pkix")
verwendet werden soll.
Das Attribut systemDefaultMode spezifiziert
das Modell, das im Standardfall verwendet werden
soll.
Mit dem Kind-Element TrustAnchor kann
für jeden Trust Anchor ein abweichendes
Modell spezifiziert werden. Ein Trust Anchor
ist ein Zertifikat, das in TrustedCACertificates
spezifiziert ist. Ein Trust Anchor wird durch
den Typ <dsig:X509IssuerSerialType>
spezifiziert. Das für diesen Trust Anchor
gültige Modell wird durch das Attribut
mode spezifiziert.
Gültige Werte für die Attribute systemDefaultMode
und mode sind "chaining" und
"pkix".
Beispiel
TrustedCACertificates
Das Element TrustedCACertificates
enthält das Verzeichnis (relativ zur
MOA-ID Konfigurationsdatei), das jene Zertifikate
enthält, die als vertrauenswürdig
betrachtet werden. Im Zuge der Überprüfung
der TLS-Serverzertifikate wird die Zertifikatspfaderstellung
an einem dieser Zertifikate beendet.
GenericConfiguration
Das Element GenericConfiguration
ermöglicht das Setzen von Namen-Werte
Paaren mittels der Attribute name
und value. Die folgende Liste spezifiziert
- gültige Werte für das name-Attribut,
- eine Beschreibung
- gültige Werte für das value-Attribut
und (falls vorhanden)
- den Default-Wert für das value-Attribut.
| name: DirectoryCertStoreParameters.RootDir |
Gibt den Pfadnamen zu einem
Verzeichnis an, das als Zertifikatsspeicher
im Zuge der TLS-Server-Zertifikatsüberprüfung
verwendet wird.
value:
Gültige Werte: Name eines gültigen
Verzeichnisses (relativ zur MOA-ID Konfigurationsdatei)
Dieser Parameter muss angegeben werden.
|
| name: AuthenticationSession.TimeOut |
Gibt die Zeitspanne in
Sekunden vom Beginn der Authentisierung
bis zum Anlegen der Anmeldedaten an.
Wird die Angegebene Zeitspanne überschritten
wird der Anmeldevorgang abgebrochen.
value:
Gültige Werte: positive Ganzzahlen
Default-Wert: 120 |
| name: AuthenticationData.TimeOut |
Gibt die Zeitspanne in
Sekunden an, für die die Anmeldedaten
in der Authentisierungskomponente zum
Abholen durch die Proxykomponente oder
eine nachfolgende Applikation bereitstehen.
Nach Ablauf dieser Zeitspanne werden
die Anmeldedaten gelöscht.
value:
Gültige Werte: positive Ganzzahlen
Default-Wert: 600 |
| name: TrustManager.RevocationChecking |
Für die TLS-Server-Authentisierung
dürfen nur Server-Zertifikate verwendet
werden, die eine CRLDP-Extension enthalten
(andernfalls kann von MOA-ID keine CRL-überprüfung
durchgeführt werden).
Soll das RevocationChecking generell
ausgeschaltet werden, ist dieses Attribut
anzugeben und auf "false" zu setzen.
value:
Gültige Werte: true, false
Default-Wert: true |
| name: FrontendServlets.EnableHTTPConnection |
|
Standardmäßig können
die beiden Servlets "StartAuthentication"
und "SelectBKU" welche das
User-Frontend darstellen, aus Sicherheitsgründen,
nur über das Schema HTTPS aufgerufen
werden.
Wenn die beiden Servlets jedoch auch
Verbindungen nach dem Schema HTTP
entgegennehmen sollen, so kann mittels
dem Attribut "EnableHTTPServletConnection"
erlaubt werden.
Hinweis: Sicher und sinnvoll ist
das Erlauben der HTTP Verbindung nur
dann, wenn ein Vorgeschalteter Webserver
das HTTPS handling übernimmt,
und eine Verbindung zu den Servlets
nur über diesen Webserver möglich
ist.
value:
Gültige Werte: true, false
Default-Wert: false |
| name:
FrontendServlets.DataURLPrefix |
|
Standardmäßig wird als
DataURL Prefix das URL Präfix
unter dem die MOA-ID Servlets erreichbar
sind verwendet. Im Falle das sich
der MOA-ID Server hinter einer Firewall
befindet und die Requests von einem
vorgelagertem Webserver weitergereicht
werden, kann mit FrontendServlets.DataURLPrefix
ein alternatives URL Präfix angegeben
werden. In diesem Fall muss der Webserver
so konfiguriert sein, dass er Request
auf diese URLs an den MOA-ID Server
weiterleitet.
value:
Gültige Werte: URLs nach dem Schema
'http://' und 'https://'
Default-Wert: kein Default-Wert
Beispiel: <GenericConfiguration name="FrontendServlets.DataURLPrefix"
value="https://<your_webserver>/moa-id-auth/"/> |
TrustedBKUs
Das Element TrustedBKUs
ermöglicht das Setzen von vertrauenswürdigen Bürgerkartenumgebungen.
In BKUURL Unterelementen werden die vertrauenswürdigen URLs eingetragen. Diese Liste von URLs wird mit dem Parameter bkuURI abgeglichen. Lokale Bürgerkartenumgebungen müssen nicht eingetragen werden - diesen wird automatisch vertraut.
|
übersicht
Zurück