From b232b84093993571da6efa97c25e1724370d6a6d Mon Sep 17 00:00:00 2001 From: Thomas Lenz Date: Wed, 12 Jun 2019 13:47:10 +0200 Subject: update handbook --- .../doc/handbook_v4/additional/additional.html | 363 +++++ .../doc/handbook_v4/application/application.html | 220 +++ id/server/doc/handbook_v4/application/iframe.png | Bin 0 -> 86175 bytes .../doc/handbook_v4/application/login_button.PNG | Bin 0 -> 70066 bytes .../doc/handbook_v4/application/mainframe.PNG | Bin 0 -> 59073 bytes .../handbook_v4/application/sso_sendassertion.PNG | Bin 0 -> 6041 bytes id/server/doc/handbook_v4/common/LogoEGIZ.png | Bin 0 -> 77395 bytes id/server/doc/handbook_v4/common/MOA.css | 501 +++++++ id/server/doc/handbook_v4/common/logo_digAT.png | Bin 0 -> 22964 bytes id/server/doc/handbook_v4/config/config.html | 1168 ++++++++++++++++ id/server/doc/handbook_v4/index.html | 55 + id/server/doc/handbook_v4/install/install.html | 331 +++++ id/server/doc/handbook_v4/intro/Blockdiagramm.png | Bin 0 -> 206722 bytes id/server/doc/handbook_v4/intro/E-ID-Proxy.png | Bin 0 -> 58311 bytes .../doc/handbook_v4/intro/Gesamtarchitektur.png | Bin 0 -> 477608 bytes id/server/doc/handbook_v4/intro/anmeldeablauf.png | Bin 0 -> 51158 bytes id/server/doc/handbook_v4/intro/intro.html | 84 ++ .../moduledevinfo/ProcessDefinition.xsd | 53 + .../handbook_v4/moduledevinfo/moduledevinfo.html | 388 ++++++ id/server/doc/handbook_v4/protocol/Assertion.xml | 81 ++ id/server/doc/handbook_v4/protocol/AuthRequest.xml | 38 + .../doc/handbook_v4/protocol/idp_metadata.xml | 188 +++ .../handbook_v4/protocol/openIDconnect_sequenz.png | Bin 0 -> 121367 bytes id/server/doc/handbook_v4/protocol/protocol.html | 756 ++++++++++ .../doc/handbook_v4/protocol/pvp21_sequence.png | Bin 0 -> 38601 bytes .../doc/handbook_v4/protocol/saml1_sequence.png | Bin 0 -> 32752 bytes .../protocol/serviceprovider_metadata.xml | 95 ++ .../doc/handbook_v4/protocol/sso_sequence.png | Bin 0 -> 56152 bytes id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl | 41 + id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf | Bin 0 -> 146062 bytes id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf | Bin 0 -> 288576 bytes id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl | 128 ++ id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd | 572 ++++++++ .../doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf | Bin 0 -> 577309 bytes .../doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf | Bin 0 -> 355156 bytes .../doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf | Bin 0 -> 239502 bytes .../doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf | Bin 0 -> 286834 bytes .../doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf | Bin 0 -> 134176 bytes id/server/doc/handbook_v4/spec/OID-1-0-3.pdf | Bin 0 -> 347041 bytes .../spec/cs-sstc-schema-assertion-01.xsd | 194 +++ .../spec/cs-sstc-schema-protocol-01.xsd | 127 ++ id/server/doc/htmlTemplates/BKU-selection.html | 120 -- id/server/doc/htmlTemplates/sendAssertion.html | 52 - .../doc/htmlTemplates/template_onlineBKU.html | 32 - .../handbook/examples/BKUSelectionTemplate.html | 41 - .../doc/proxy/handbook/examples/ChainingModes.txt | 6 - .../handbook/examples/IdentityLinkSigners.txt | 9 - .../handbook/examples/LoginServletExample.txt | 171 --- .../SampleMOAIDVerifyInfoboxesConfiguration.xml | 149 -- .../doc/proxy/handbook/examples/Template.html | 50 - .../examples/TransformsInfoAuthBlockTable_DE.xml | 161 --- .../examples/conf/MOA-ID-Configuration.xml | 118 -- .../handbook/examples/conf/OAConfBasicAuth.xml | 9 - .../handbook/examples/conf/OAConfHeaderAuth.xml | 10 - .../handbook/examples/conf/OAConfParamAuth.xml | 10 - .../doc/proxy/handbook/examples/moa-id-env.sh.txt | 15 - .../proxy/handbook/examples/startTomcat.bat.txt | 26 - id/server/doc/proxy/handbook/faqs.htm | 216 --- id/server/doc/proxy/handbook/id-admin.htm | 322 ----- id/server/doc/proxy/handbook/id-admin_1.htm | 549 -------- id/server/doc/proxy/handbook/id-admin_2.htm | 1470 -------------------- id/server/doc/proxy/handbook/id-admin_3.htm | 204 --- id/server/doc/proxy/handbook/id-anwendung.htm | 104 -- id/server/doc/proxy/handbook/id-anwendung_1.htm | 119 -- id/server/doc/proxy/handbook/id-anwendung_2.htm | 246 ---- id/server/doc/proxy/handbook/links.htm | 144 -- id/server/doc/proxy/handbook/moa-id-ablauf.jpg | Bin 15550 -> 0 bytes id/server/doc/proxy/handbook/moa.htm | 259 ---- .../VIDP Installation Manual_STORK2_v0.2.docx | Bin 2479329 -> 0 bytes .../stork/VIDP Installation Manual_STORK2_v0.2.pdf | Bin 1411275 -> 0 bytes 70 files changed, 5383 insertions(+), 4612 deletions(-) create mode 100644 id/server/doc/handbook_v4/additional/additional.html create mode 100644 id/server/doc/handbook_v4/application/application.html create mode 100644 id/server/doc/handbook_v4/application/iframe.png create mode 100644 id/server/doc/handbook_v4/application/login_button.PNG create mode 100644 id/server/doc/handbook_v4/application/mainframe.PNG create mode 100644 id/server/doc/handbook_v4/application/sso_sendassertion.PNG create mode 100644 id/server/doc/handbook_v4/common/LogoEGIZ.png create mode 100644 id/server/doc/handbook_v4/common/MOA.css create mode 100644 id/server/doc/handbook_v4/common/logo_digAT.png create mode 100644 id/server/doc/handbook_v4/config/config.html create mode 100644 id/server/doc/handbook_v4/index.html create mode 100644 id/server/doc/handbook_v4/install/install.html create mode 100644 id/server/doc/handbook_v4/intro/Blockdiagramm.png create mode 100644 id/server/doc/handbook_v4/intro/E-ID-Proxy.png create mode 100644 id/server/doc/handbook_v4/intro/Gesamtarchitektur.png create mode 100644 id/server/doc/handbook_v4/intro/anmeldeablauf.png create mode 100644 id/server/doc/handbook_v4/intro/intro.html create mode 100644 id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd create mode 100644 id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html create mode 100644 id/server/doc/handbook_v4/protocol/Assertion.xml create mode 100644 id/server/doc/handbook_v4/protocol/AuthRequest.xml create mode 100644 id/server/doc/handbook_v4/protocol/idp_metadata.xml create mode 100644 id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png create mode 100644 id/server/doc/handbook_v4/protocol/protocol.html create mode 100644 id/server/doc/handbook_v4/protocol/pvp21_sequence.png create mode 100644 id/server/doc/handbook_v4/protocol/saml1_sequence.png create mode 100644 id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml create mode 100644 id/server/doc/handbook_v4/protocol/sso_sequence.png create mode 100644 id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl create mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl create mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd create mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf create mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf create mode 100644 id/server/doc/handbook_v4/spec/OID-1-0-3.pdf create mode 100644 id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd create mode 100644 id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd delete mode 100644 id/server/doc/htmlTemplates/BKU-selection.html delete mode 100644 id/server/doc/htmlTemplates/sendAssertion.html delete mode 100644 id/server/doc/htmlTemplates/template_onlineBKU.html delete mode 100644 id/server/doc/proxy/handbook/examples/BKUSelectionTemplate.html delete mode 100644 id/server/doc/proxy/handbook/examples/ChainingModes.txt delete mode 100644 id/server/doc/proxy/handbook/examples/IdentityLinkSigners.txt delete mode 100644 id/server/doc/proxy/handbook/examples/LoginServletExample.txt delete mode 100644 id/server/doc/proxy/handbook/examples/SampleMOAIDVerifyInfoboxesConfiguration.xml delete mode 100644 id/server/doc/proxy/handbook/examples/Template.html delete mode 100644 id/server/doc/proxy/handbook/examples/TransformsInfoAuthBlockTable_DE.xml delete mode 100644 id/server/doc/proxy/handbook/examples/conf/MOA-ID-Configuration.xml delete mode 100644 id/server/doc/proxy/handbook/examples/conf/OAConfBasicAuth.xml delete mode 100644 id/server/doc/proxy/handbook/examples/conf/OAConfHeaderAuth.xml delete mode 100644 id/server/doc/proxy/handbook/examples/conf/OAConfParamAuth.xml delete mode 100644 id/server/doc/proxy/handbook/examples/moa-id-env.sh.txt delete mode 100644 id/server/doc/proxy/handbook/examples/startTomcat.bat.txt delete mode 100644 id/server/doc/proxy/handbook/faqs.htm delete mode 100644 id/server/doc/proxy/handbook/id-admin.htm delete mode 100644 id/server/doc/proxy/handbook/id-admin_1.htm delete mode 100644 id/server/doc/proxy/handbook/id-admin_2.htm delete mode 100644 id/server/doc/proxy/handbook/id-admin_3.htm delete mode 100644 id/server/doc/proxy/handbook/id-anwendung.htm delete mode 100644 id/server/doc/proxy/handbook/id-anwendung_1.htm delete mode 100644 id/server/doc/proxy/handbook/id-anwendung_2.htm delete mode 100644 id/server/doc/proxy/handbook/links.htm delete mode 100644 id/server/doc/proxy/handbook/moa-id-ablauf.jpg delete mode 100644 id/server/doc/proxy/handbook/moa.htm delete mode 100644 id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.docx delete mode 100644 id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.pdf (limited to 'id/server/doc') diff --git a/id/server/doc/handbook_v4/additional/additional.html b/id/server/doc/handbook_v4/additional/additional.html new file mode 100644 index 000000000..d7afc1961 --- /dev/null +++ b/id/server/doc/handbook_v4/additional/additional.html @@ -0,0 +1,363 @@ + + + + + + MOA-ID - Zusatzinformationen + + + + +
+
+ +

MOA-ID-AUTH

+
+
+
+
+

Zusatzinformationen

+ +

Inhalt

+
    +
  1. Datenmanagement +
      +
    1. Sessiondaten +
        +
      1. Allgemein
        2. +
      +
      2. +
    2. Logging von Statistikdaten
      3. +
    +
    2. +
  2. Benötigte Netzwerkverbindungen (incoming / outgoing)
    3. +
  3. Revisions-Logging
    4. +
+

1 Datenmanagement

+

Dieser Abschnitt spezifiziert jene Datensätze die während eines Anmeldevorgangs durch das Modul MOA-ID-Auth temporär oder permanent gespeichert werden. Hierbei handelt es sich sowohl um temporäre Sessiondaten als auch um dauerhaft gespeicherte Statistikdaten.

+

1.1 Sessiondaten

+

Dieser Abschnitt behandelt jene Informationen die das Modul MOA-ID-Auth während eines Authentifizierungsvorgangs oder während einer aktiven Single Sign-On Session im Speicher hält. Diese Datensätze werden nach Beendigung des Anmeldevorgangs, bei einfacher Anmeldung, oder nach Beendigung der Single Sign-On Session gelöscht. Die nachfolgenden Unterkapitel geben eine Aufstellung jener Daten die von MOA-ID im jeweiligen Falle gespeichert werden.

+

1.1.1 Allgemein

+

Folgende Daten müssen mindestens von MOA-ID gecached werden um einen korrekten Anmeldevorgang zu ermöglichen.

+ + + + + + + + + + + + + + + + + + + + + +

Element

Beschreibung

Authentication Request

Dieser wird von der Online-Applikation als Start des Anmeldevorgangs übertragen.

Session ID

Wird von MOA-ID generiert und dient zur Identifikation von Datensätzen.

Signaturzertifikat

Das Signaturzertifikat, welches zur Signierung des Authentifizierungsblocks verwendet wurde.

AuthTimeStampZeitpunkt an dem sich die Benutzerin oder der Benutzer an MOA-ID-Auth authentifiziert hat.
+

1.2 Logging von Statistikdaten

+

Zusätzlich zu den Daten aus den temporären Sessiondaten werden vom Modul MOA-ID-Auth auch Logging- und Statistikdaten generiert, welche nicht automatisiert gelöscht werden. Diese Daten dienen der Statuskontrolle und zur Protokollierung von Anmeldevorgängen an MOA-ID-Auth. Von MOA-ID-Auth werden folgende Statistikdaten je Anmeldevorgang gespeichert, wobei je nach Art der Anmeldung nicht alle Datenelemente gefüllt werden. Die nachstehende Tabelle beschreibt den maximalen Umfang der Loggingdaten, wobei keine Informationen zur anmeldenden Person gespeichert werden.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Element

Beschreibung

timestamp

Datum und Uhrzeit des Eintrags.

OAID

Eindeutige Datenbank ID der Online-Applikation.

OAURLPrefix

Publik URL Prefix der Online-Applikation

OAFriendlyName

Bezeichnung der Online-Applikation

isBusinessService

„True“ wenn die Online-Applikation aus dem privatwirtschaftlichen Bereich stammt.

OATarget

Bereichskennzeichen der Online-Applikation (Target oder privatwirtschaftlicher Bereich)

BKUType

Art der Bürgerkartenumgebung die für den Anmeldevorgang verwendet wurde. (online, local, handy)

BKUURL

URL der verwendeten Bürgerkartenumgebung

isSSOLogin

„True“ wenn die die Anmeldung als Teil einer SSO Anmeldung erfolgt ist.

isMandateLogin

„True“ wenn die Anmeldung in Vertretung erfolgt ist.

MandateType

Art der verwendeten Vollmacht (Einzelprofile des Vollmachtenservice oder OID des Organwalters / berufsmäßigen Parteienvertreters)

MandatorType

„jur“ / „nat“ je nach Art der vertretenen juristischen oder natürlichen Person

isPV

„True“ wenn die Anmeldung in Vertretung durch einen Organwalter oder berufsmäßigen Parteienvertreter erfolgt ist.

PVOID

OID des Organwalter oder berufsmäßigen Parteienvertreter

ProtocolType

Type des für die Anmeldung verwendeten Authentifizierungsprotokolls. (PVP21, OpenID, SAML1)

ProtocolSubType

Nähere Spezifizierung des Protokolltyps. (Im Falle von PVP 2.1: POST oder Redirect)

ExceptionType

Typ des Fehlers der während des Anmeldevorgangs aufgetreten ist. Aktuell werden folgende Typen unterschieden:

+
    +
  • bku: Fehler während der Kommunikation mit der Bürgerkartenumgebung.
    • +
  • moa-sp: Fehler bei der Kommunikation mit MOA-SP oder der Signaturprüfung.
    • +
  • mandate: Fehler beim Zugriff auf das Online-Vollmachten Service.
    • +
  • moa-id: Fehler während des Authentifizierungsvorgangs.
    • +
  • unknown: für allgemeine Fehler die keinem der oben genannten Typen entsprechen.
    • +

ExceptionCode

Fehlercode des aufgetretenen Fehlers falls vorhanden.

ExceptionMessage

Fehlermeldung in textueller Form (max. 255 Zeichen lang)

+

 

+

2 Benötigte Netzwerkverbindungen (incoming / outgoing)

+

Für die Betrieb des Modules MOA-ID-Auth werden Netzwerkverbindungen zu externen Service benötigt. Die nachfolgende Tabelle gibt eine Aufstellung der benötigten Verbindungen und eine kurze Beschreibung über deren Funktion.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ServiceURLPortRichtungBeschreibung

MOA-ID-Auth

*80, 443eingehend

Front-Channel und Back-Channel Verbinding zum IDP

MOA-ID-Auth

*80, 443ausgehendAbholen von Template oder PVP 2.1 Metadaten
LDAP*389, 636ausgehendZertifikatsprüfung

OSCP / CRL

*80, 443ausgehend

Zertifikatsprüfung

E-ID Systemvollmachten.stammzahlenregister.gv.at
+ Test: https://eid.egiz.gv.at/idp/shibboleth		443ausgehendSAML2 Metadaten des E-ID System
+

 

+

3 Revisions Logging

+

Ab der Version 3.x von MOA-ID-Auth steht zusätzlich zum normalen Logging und zur Generierung von Statisikdaten ein spezielles Reversions Logging zur Verfügung. Dieses Revisions Logging erstellt ein spezielles Log welches Informationen zum Identifikations- und Authentifikationsprozess mit Zeitstempel und Eventcode beinhaltet. Die Events, welche durch dieses Log aufgezeichnet werden lassen sich je MOA-ID-Auth Instanz und je Online-Applikation konfigurieren. Das Revisions Logging kann über die folgende Zeilen in der log4j Konfiguration der MOA-ID Instanz konfiguriert werden:

+

log4j.logger.at.gv.egiz.eventlog.plain.all=info,reversion

+

log4j.appender.reversion=org.apache.log4j.RollingFileAppender
+ log4j.appender.reversion.File=$logDirectory/moa-id-reversion.log
+ log4j.appender.reversion.MaxFileSize=10000KB
+ log4j.appender.reversion.MaxBackupIndex=9999
+ log4j.appender.reversion.layout=org.apache.log4j.PatternLayout
+ log4j.appender.reversion.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %t | %m%n

+

 

+

Die nachstehenden Tabellen beschreibt alle Events welche aktuell in MOA-ID zur Verfügung stehen, wobei die erste Tabelle alle Basisevents beinhaltet die von MOA-ID auf jeden Fall geloggt werden. Die in der zweiten Tabelle angegebenen Events sind immer einer Session und einer Transaktion aus Tabelle 1 zugeordnet und können durch die MOA-ID Konfiguration ausgewählt werden.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

EventCode

Wert

Beschreibung

1000

SessionID

Eine neue Session wurde mit der angegebenen ID gestartet

1001

SessionID

Die Session mit der angegebenen ID wurde beendet

1002

IP Adresse

IP Addresse des Hosts der die Session geöffnet hat

1003

SessionID

Die Session mit der angebenden ID wurde wegen eines Fehler beendet

1100

TransaktionsID

Eine neue Transaction wurde mit der angegebenen ID gestartet.  Eine Transaktion ist immer eine Session zugeordnet

1101

TransaktionsID

Die Transkation mit der angegebenen ID wurde beendet

1102

IP Adresse

IP Addresse des Hosts der die Transaction geöffnet hat

1103

TransaktionsID

Die Transkation mit der angebenden ID wurde wegen eines Fehler beendet

+

 

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

EventCode

Wert

Beschreibung

3000

Protokolltype

Type des verwendeten Authentifizierungsprotokolls (OpenID Connect, PVP2, STORK, SAML1)

3300

 

SAML1 StartAuthentication Request

4000

 

Identifizierungs- und Authentifizierungsprozess wurde gestartet

4001

 

Identifizierungs- und Authentifizierungsprozess wurde beendet

5000

bPK

bPK bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

5001

OID

OID bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

5002

JSON String

Pseudoanonymisierte Personendaten der sich anmeldeten natürlichen Person.

5100

Vollmachtstype

Type der ausgewählten Vollmacht

5101

jur / nat

Vollmacht - Type der vertretenen Person (Juristische / natürliche Person)

5102

JSON String

Pseudoanonymisierte Personendaten der vertretenen natürlichen Person.

5103

baseID

Stammzahl der vertretenen juristischen Person

6300EntityIDZentrales E-ID System ausgewählt
6301RequestIDZentrales E-ID System kontaktiert
6302ResponseIDGültige Response vom E-ID System erhalten
6303 Ungültige Response oder Fehlercode vom E-ID System erhalten
6304 Gültige Attribute vom E-ID System erhalten
+

 

+

Einzelne Events werden um einen Transaktionsparameter ergänzt, welcher in der Spalte Wert beschrieben ist.
+

+

Die pseudoanonymisierten Personendaten für natürliche Personen werden anhand des nachfolgenden Schemas generiert. Als pseudoanonymisiertes Personendatum dient der SHA256 Hash über die in eine JSON Struktur eingetragenen Personendaten. Hierfür wird das folgende JSON Schema verwendet, welches als Input für die SHA256 Berechnung dient.

+


+ {"person":{"givenname":"Vorname der Person","familyname":"Nachname der Person","dateofbirth":"Geburtsdatum der Person"},"salt":"Zufallszahl"}
+

+

Anschließend wird das pseudoanonymisiert Personendatum als JSON Wert bei den entsprechenden Events eingetragen. Der eingetragener JSON Wert entspricht dem folgenden Schema

+


+ {"hash":"BASE64 codierte Personendatum","salt:"Zufallzahl welche zur Generierung des Personendatums verwendet wurde"}

+

 

+
+ + diff --git a/id/server/doc/handbook_v4/application/application.html b/id/server/doc/handbook_v4/application/application.html new file mode 100644 index 000000000..60732acaf --- /dev/null +++ b/id/server/doc/handbook_v4/application/application.html @@ -0,0 +1,220 @@ + + + + + + MOA-ID - Anwendungen + + + + +
+
+ +

MOA-ID-AUTH

+
+
+
+
+

Anwendungen

+ +

Inhalt

+
    +
  1. Allgemeines
    2. +
  2. Integration in bestehende Online-Applikationen +
      +
    1. Bürgerkartenauswahl +
        +
      1. Request aus einem iFrame
        2. +
      2. Request aus dem Hauptframe
        3. +
      +
      2. +
    2. Single Sign-On Anmeldeabfrage
      3. +
    +
    3. +
  3. Demo Applikationen +
      +
    1. PVP 2.1 Demo +
        +
      1. Installation
        2. +
      2. Konfiguration Demo Applikation
        3. +
      3. Konfiguration von MOA-ID-Auth
        4. +
      4. Anwendung
        5. +
      +
      2. +
    +
    4. +
+ +

1 Allgemeines

+

Das erste Kapitel behandelt die Integration der von MOA-ID-Auth generierten Bürgerkartenauswahl in bestehende Online-Applikationen. Zusätzlich zur Beschreibung ist MOA-ID auch eine PVP 2.1 Demo Applikation beigelegt. Die Konfiguration und Verwendung dieser Demo Applikation ist Inhalt des letzten Kapitels.

+

2 Integration in bestehende Online-Applikationen

+

Ab MOA-ID 2.0 wird die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage standardmäßig vom Modul MOA-ID-Auth bereitgestellt und muss nicht mehr durch den Service Provider implementiert werden.

+

Die im Modul MOA-ID-Auth hinterlegten Standard Templates (Bürgerkartenauswahl, Single Sign-On Anmeldeabfrage) unterstützt Responsive Design und passt sich somit in einem weiten Bereich an die aktuelle Fenstergröße an, wodurch eine individuelle Integration der von MOA-ID-Auth erzeugten Formulare möglich ist. Zusätzlich bietet das Konfigurationstool die Möglichkeit der online-applikationsspezifischen Anpassung der Standard Templates. Mit dieser Funktion können einzelne Parameter der Standard Templates an die Online-Applikation individualisiert werden um die Integration weiter zu verfeinern.

+

Hinweis: Es besteht jedoch auch die Möglichkeit der Hinterlegung von vollständig benutzerdefinierten online-applikationsspezifischen Templates für die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage (siehe hier).

+

2.1 Bürgerkartenauswahl

+

Die Bürgerkartenauswahl wird ab MOA-ID 2.0 standardmäßig von MOA-ID-Auth, als Antwort auf einen eingehenden Authentifizierungsrequest, bereitgestellt. Dem zu Folge müssen die aus MOA-ID 1.5.1 bekannten Parameter (target, bkuURL, template, usemandate) nicht mehr im Authentifizierungsrequest an MOA-ID-Auth übergeben werden und es kann ein standardkonformer Protokollrequest verwendet werden. Die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl in der Online-Applikation des Service Providers steht jedoch weiterhin als Legacy Variante zur Verfügung.

+

Die Integration der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl in eine bestehende Online-Applikation kann auf zwei Arten erfolgen. Bei beiden Varianten erfolgt der Login Vorgang (senden des Authentifizierungsrequests an MOA-ID-Auth) durch den Klick auf einen Login Button. Die Auswahl der Bürgerkartenumgebung erfolgt somit erst im zweiten Schritt. Das Sequenzdiagramm eines solchen Anmeldevorgangs finden Sie hier und die nachfolgende Grafik zeigt ein Beispiel zur Integration eines Login Buttons.

+
Integration Login Button
+

2.1.1 Request aus einem iFrame

+

Bei dieser Variante wird der Authentifizierungsrequests aus einem iFrame, welcher in die Online-Applikation eingebunden ist, abgesetzt. MOA-ID-Auth antwortet auf diesen Request mit der konfigurierten Bürgerkartenauswahl welche durch Verwendung des iFrame in die Online-Applikation eingebunden werden kann. Die nachfolgende Grafik zeigt ein Beispiel für die von MOA-ID-Auth bereitgestellte Bürgerkartenauswahl, welche nach Betätigung des Login Buttons im iFrame dargestellt wird.

+
Bürgerkartenauswahl im iFrame
+

Hinweis: Bei dieser Variante wird die Assertion ebenfalls an den iFrame ausgeliefert wodurch der authentifizierte Bereich der Online-Applikation im iFrame dargestellt wird. Dieses Verhalten kann durch eine online-applikationsspezifischen Anpassung der Standard Templates und dem Parameter Targetparameter unterbunden werden.

+

2.1.2 Request aus dem Hauptframe

+

Bei dieser Variante wird der Authentifizierungsrequests direkt aus dem aktuell offenen Browserfenster an MOA-ID-Auth gesendet. In diesem Fall wird die Bürgerkartenauswahl fensterfüllend im Browser dargestellt und die Benutzerin oder der Benutzer befindet sich nicht mehr in der Domain der Online-Applikation (Service Provider). Nach erfolgreicher Authentifizierung wird die Benutzerin oder der Benutzer an die Online-Applikation zurückgeleitet. Die nachfolgende Grafik zeigt die Bürgerkartenauswahl im seitenfüllenden Layout.

+
Bürgerkartenauswahl im seitenfüllenden Layout
+

2.2 Single Sign-On Anmeldeabfrage

+

Wird für die Integration in die Online-Applikation die Variante mit dem Login Button und der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl verwendet (iFrame oder Hauptframe), ergeben sich für die Single Sign-On Anmeldeabfrage keine zusätzlichen Anforderungen. Im Falle einer aktiven Single Sign-On Session, würde MOA-ID-Auth mit der Single Sign-On Anmeldeabfrage anstatt der Bürgerkartenauswahl antworten. Auch in diesem Fall stehen beide Möglichkeiten der Integration, identisch zum Kapitel Bürgerkartenauswahl, zur Verfügung. Die nachfolgende Grafik zeigt eine Single Sign-On Abfrage welche je nach verwendeter Variante die Bürgerkartenauswahl, in den zuvor gezeigten Beispielen, ersetzen würde.

+
Single Sign-On Anmeldeabfrage
+

Hinweis: Wird für die Integration der Bürgerkartenauswahl jedoch die Legacy Variante verwendet (direkte Integration der Bürgerkartenauswahl in die Online-Applikation) kann es zu Inkompatibilitäten mit der Single Sign-On Anmeldeabfrage kommen, da diese Abfrage von MOA-ID-Auth generiert werden muss und eine direkte Integration in eine Online-Applikation nicht möglich ist.

+

3 Demo Applikationen

+

Dieser Abschnitt behandelt die Konfiguration und Verwendung der bei MOA-ID beigelegten Demo Applikationen.

+

3.1 PVP 2.1 Demo

+

Die PVP 2.1 Demo stellt das Minimalbeispiel einer Online-Applikation dar, welche zur Authentifizierung das Protokoll PVP 2.1 verwendet. Die nachfolgenden Abschnitte beschreiben die Installation, Konfiguration und Verwendung der PVP 2.1 Demo Applikation.

+

Hinweis: Der Source Code der PVP 2.1 Demo Applikation ist im Order $MOA_ID_AUTH_INST/source/moa-id-oa verfügbar. Jedoch ist die Validierung der PVP 2.1 Assertion in dieser Version nicht vollständig implementiert und müsste bei Verwendung in einem Produktivsystem noch erweitert werden.

+

3.1.1 Installation

+

Für die Installation der Demo Applikation wird ein Apache Tomcat benötigt. Die Konfiguration dieser Tomcat Instanz ist identisch zur Konfiguration der Tomcat Instanz der Module MOA-ID-Auth und MOA-ID-Configuration.

+
3.1.1.1 Einsatz der Demo Applikation in Tomcat
+ +
3.1.1.2 Einsatz der Demo Applikation in Tomcat
+

Das starten und stoppen der Demo Applikation erfolgt identisch zur Beschreibung für die Module MOA-ID-Auth und MOA-ID-Configuration.

+

Ein erfolgreicher Start der Demo Applikation ist an folgender Log-Meldung ersichtlich:

+
INFO at.gv.egovernment.moa.id.demoOA.Configuration  - Demo Application initializaten finished.
+

Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

+
http://<host>:<port>/moa-id-oa/
+

bzw.

+
+https://<host>:<port>/moa-id-oa/
+
+

3.1.2 Konfiguration Demo Applikation

+

Die zentrale Konfigurationsdatei für die Demo Applikation wird der Java Virtual Machine, in der die Demo Applikation läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.demoOA als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

+
moa.id.demoOA=C:/Programme/apache/tomcat-4.1.30/conf/moa-id-oa/oa.properties
+

Diese Konfigurationsdatei beinhaltet folgende Parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
general.publicURLContexthttps://localhost:8443/moa-id-oa

URL unter der das Modul MOA-ID-OA erreichbar ist.

+

Hinweis: Ist dieser Parameter nicht vorhanden wird die URL aus dem ersten Request generiert.

general.login.pvp2.idp.metadata.urlhttps://demo.egiz.gv.at/moa-id-auth/
+ pvp2/metadata		URL unter der die PVP2.1 Metadaten des IDP abgeholt werden können.
general.login.pvp2.idp.metadata.certificatekeys/moa_idp.crtZertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieses Zertifikat wird zur Prüfung der IDP Metadaten verwendet.
general.login.pvp2.idp.metadata.entityIDhttps://demo.egiz.gv.at/moa-id-auth/pvp2/metadataEntityID des IDP in den Metadaten (Details siehe PVP2.1 Spezifikation)
general.login.pvp2.idp.sso.logout.urlhttps://demo.egiz.gv.at/moa-id-auth/LogOut?redirect=
+ https://demo.egiz.gv.at/moa-id-oa		URL zum Single Log-Out (SLO) Service des IDP. Details zum SLO Service von MOA-ID-Auth finden Sie hier.
general.login.pvp2.metadata.entities.namePVP 2.1 DemoName der Applikation, welcher in den Metadaten der Applikation angegeben wird
general.login.pvp2.keystore.urlkeys/application[password].p12Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.
general.login.pvp2.keystore.passwordpasswordPasswort des Keystores
general.login.pvp2.keystore.typePKCS12

Type des Keystores. Aktuell werden folgende Keystore Typen unterstützt

+
    +
  • PKCS12: PKCS12 Keystore
    • +
  • JKS: Java-Keystore
    • +
general.login.pvp2.keystore.metadata.key.aliaspvp_metadataName des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll
general.login.pvp2.keystore.metadata.key.passwordpasswordPasswort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.
general.login.pvp2.keystore.authrequest.encryption.key.aliaspvp_encryptionName des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll
general.login.pvp2.keystore.authrequest.encryption.key.passwordpasswordPasswort des Schlüssels zum Verschlüsseln der Anmeldeinformation.
general.login.pvp2.keystore.authrequest.key.aliaspvp_requestName des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.
general.login.pvp2.keystore.authrequest.key.passwordpasswordPasswort des Schlüssels zum Signieren des Authentifizierungsrequests.
+

 

+

Die Metadaten des Modules MOA-ID-Configuration werden dynamisch erstellt und stehen unter folgender URL zum Download bereit.

+
+http://<host>:<port>/moa-id-oa/servlet/metadata
+

bzw.

+
+https://<host>:<port>/moa-id-oa/servlet/metadata
+

Nach erfolgreicher Konfiguration muss die Tomcat Instanz neu gestartet werden.

+

3.1.3 Konfiguration von MOA-ID-Auth

+

Bevor ein Anmeldevorgang gestartet werden kann muss die Demo Applikation auch als Online-Applikation für das Modul MOA-ID-Auth konfiguriert werden. Hierfür kann das Konfigurationstool (Modul MOA-ID-Configuration) verwendet werden. Tragen Sie die Demo Applikation als Online-Applikation bei Ihrer MOA-ID-Auth Instanz ein. Eine Beschreibung der einzelnen Konfigurationsparameter finden Sie hier.

+

3.1.4 Anwendung

+

Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

+
http://<host>:<port>/moa-id-oa/
+

bzw.

+
+https://<host>:<port>/moa-id-oa/
+
+

Die Startseite der Demo Applikation beinhaltet einen kurzen Beschreibungstext und den Login Button zum Start des Anmeldevorgangs. Für die Integration der Bürgerkartenumgebung verwendet die Demo die im Kapitel 2.1.1 beschriebene iFrame Variante. Nach Betätigung des Login Buttons wird der Anmeldevorgang gestartet. Der Protokollablauf ist identisch zu dem im Kapitel Protokolle beschriebenen Ablauf für das PVP 2.1 Protokoll.

+

Konnten die Metadaten und der Authentifizierungsrequest erfolgreich verifiziert werden, wird anschließend die Bürgerkartenauswahl in der Hauptseite der Demo Applikation dargestellt. Wählen Sie nur die gewünschte Authentifizierungsvariante. Danach erfolgt die Authentifizierung mittels der gewählten Variante.

+

Nach erfolgreicher Authentifizierung werden Sie an die Demo Applikation zurückgeleite. Diese extrahiert einige Basisdaten aus der PVP 2.1 Assertion und stellt diese im Browser dar. Zusätzlich kann die gesamte übertragene PVP 2.1 Assertion angezeigt werden.

+

Wurde der Anmeldevorgang durch einen Fehler abgebrochen werden Sie ebenfalls an die Demo Applikation zurückgeleitet. In diesem Fall wird eine kurze Fehlerbeschreibung dargestellt. Eine ausführliche Fehlerbeschreibung kann der PVP 2.1 Assertion entnommen werden.

+

 

+
+ + diff --git a/id/server/doc/handbook_v4/application/iframe.png b/id/server/doc/handbook_v4/application/iframe.png new file mode 100644 index 000000000..dcc6a932d Binary files /dev/null and b/id/server/doc/handbook_v4/application/iframe.png differ diff --git a/id/server/doc/handbook_v4/application/login_button.PNG b/id/server/doc/handbook_v4/application/login_button.PNG new file mode 100644 index 000000000..36d8921ce Binary files /dev/null and b/id/server/doc/handbook_v4/application/login_button.PNG differ diff --git a/id/server/doc/handbook_v4/application/mainframe.PNG b/id/server/doc/handbook_v4/application/mainframe.PNG new file mode 100644 index 000000000..0e597d3fc Binary files /dev/null and b/id/server/doc/handbook_v4/application/mainframe.PNG differ diff --git a/id/server/doc/handbook_v4/application/sso_sendassertion.PNG b/id/server/doc/handbook_v4/application/sso_sendassertion.PNG new file mode 100644 index 000000000..1a2ca6a67 Binary files /dev/null and b/id/server/doc/handbook_v4/application/sso_sendassertion.PNG differ diff --git a/id/server/doc/handbook_v4/common/LogoEGIZ.png b/id/server/doc/handbook_v4/common/LogoEGIZ.png new file mode 100644 index 000000000..39f05d131 Binary files /dev/null and b/id/server/doc/handbook_v4/common/LogoEGIZ.png differ diff --git a/id/server/doc/handbook_v4/common/MOA.css b/id/server/doc/handbook_v4/common/MOA.css new file mode 100644 index 000000000..f8fd01d8c --- /dev/null +++ b/id/server/doc/handbook_v4/common/MOA.css @@ -0,0 +1,501 @@ +.container { + margin: auto; + max-width: 1000px; + padding-left: 20px; + padding-right: 20px; +} + +body +{ + font-family: "Roboto", sans-serif; + + color: #000; + font-size: medium; + font-weight: 300; + margin-left: 0px; + margin-right: 0px; + margin-top: 0px; + background-color: white; + letter-spacing: 0.05em; + +} + +b{ + font-weight: 500; +} + +p +{ + margin-top: 0pt; + margin-bottom: 0.5em; + text-align: justify; + +} + +.centeredimage{ + text-align: center; + width:100%; +} + +.index{ + padding-left: 0; +} +.index a{ + color: #666; +} +.index a:hover +{ + color:#E10319; +} +.index ul{ + list-style-type: none; +} +.index li{ + list-style-type: none; +} + +td{ + font-weight: 300; +} + + + +pre +{ + font-family: "Courier New", monospace; + font-size: 90%; + background-color: #DDD; + color: #000000; + margin-left:1.5%; + margin-right:1.5%; + margin-top: 1em; + margin-bottom: 1em; + border: #008000 none; + white-space: pre-wrap; +} + +hr +{ + color: #000080; + background-color: #000080; + margin-top: 0.5em; + margin-bottom: 0.5em; +} + +table.fixedWidth +{ + width: 97%; + margin-left:1.5%; + margin-right:1.5%; + margin-top: 1em; + margin-bottom: 1em; + color:#404040; +} +table.varWidth +{ + margin-left:1.5%; + margin-top: 1em; + margin-bottom: 1em; +} + +table.configtable{ + width:100%; + border-collapse: collapse; + border-style:solid; + border-color: #404040; + border-width: 2px; + font-family: "Roboto",sans-serif +} +table.configtable th{ + border-style:solid; + border-color: #404040; + border-width: 2px; + padding:3px; +} +table.configtable th{ + font-weight: 300; + font-size: 120%; +} +table.configtable td{ + border-style:solid; + border-color: #404040; + border-width: 1px; + border-left-width: 2px; + border-right-width: 2px; + padding:3px; + font-weight: 300; +} + + +th +{ + text-align: left; + +} + +h1 +{ + font-size: 220%; + font-weight: 400; +} + +h2 +{ + letter-spacing: 1px; + font-size: 170%; + font-weight: 300; + +} + +h3 +{ + letter-spacing: 1px; + font-size: 160%; + font-weight: 300; +} + +h4 +{ + letter-spacing: 1px; + font-size: 150%; + font-weight: 300; + +} + +h5 +{ + letter-spacing: 1px; + font-size: 140%; + font-weight: 300; +} + +h6 +{ + letter-spacing: 1px; + font-size: 130%; + font-weight: 300; +} + +code +{ + font-family: "Roboto","Courier New", Courier, monospace; + font-size: 90%; + font-weight: 400; + color: #000000; +} + +dd +{ + margin-top: 0.8em; + margin-bottom: 0.8em; + text-align: justify; + +} + +dt +{ + margin-top: 0.8em; + color: #E10319; +} +dt a{ + text-decoration:none; +} + +ol +{ + margin-top: 0.5em; + margin-bottom: 0.5em; + padding-left:0.8em; +} + +ol.alpha +{ + list-style-type: lower-alpha +} + +li +{ + margin-top: 0.25em; + margin-bottom: 0.25em; + text-align: justify; +} + +a:hover +{ + color: #E10319; +} +a{ + color: #666; + text-decoration: none; +} + + +.title +{ + text-align: left; + font-size: 200%; + color: #000000; + font-family: "Roboto", sans-serif; + margin-top: 0.4em; + margin-bottom: 0.4em; +} + +.subtitle +{ + text-align: left; + font-size: 133%; + color: #000000; + font-family: "Roboto", sans-serif; + margin-top: 0.4em; + margin-bottom: 0.4em +} + +.glossaryTerm +{ + font-style: italic; + color: #006699 +} + +.example +{ + font-family: "Roboto", sans-serif; + background-color: #CCFFFF; + color: #000000; + margin: 0pt 0pt; + border: #008000 none +} + +.schema +{ + font-family: "Courier New", monospace; + background-color: #FFFFCC; + color: #000000; + margin: 0pt 0pt; + border: #008000 none +} + +.documentinfo +{ + font-family: "Roboto", sans-serif; + font-size: 100%; +} + +.ol-contents +{ + font-size: 100%; + margin-top: 0.0em; + margin-bottom: 0.0em; +} + +.li-contents +{ + font-size: 100%; + margin-top: 0.0em; + margin-bottom: 0.0em; +} + +.logoTitle +{ + text-align: center; + font-size: 200%; +} + +.logoTable +{ + margin-bottom: 0px; + margin-left: 0px; + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + border-color: #818286; + +} + +.superscript +{ + vertical-align: super; + font-size: 66%; +} + +.term +{ + font-style: italic; +} + +.strongerterm +{ + font-style: italic; + font-weight: 500; +} + + +.comment +{ + color: #000000; + background: #ffff00; + font-style: italic +} + +.addedErrata12 +{ + color: #FF0000; + background-color: #FFEEEE; + text-decoration: underline +} + +.deletedErrata12 +{ + color: #999999; + background-color: #EEEEEE; + text-decoration: line-through +} + +.added12 +{ + color: #FF0000; + text-decoration: underline; + background-color: #F8F0FF; +} + +.deleted12 +{ + color: #999999; + text-decoration: line-through +; background-color: #f8f0ff +} + +.rfc2119Keyword +{ + font-variant: small-caps; + font-style: normal; +} + +.remark { font-style: italic} + +li.faq +{ + margin-top: 1.5em; + margin-bottom: 1.5em; +} + +.faq-question +{ + color: #000080; + font-size: 100%; + font-family: "Roboto", sans-serif; + font-weight: 300; + margin-bottom: 0.4em; +} +/*********************************/ +@media ( min-width :600px) { + #headline { + /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + + } + #headline br { + clear: both; + } + + #headline h1 { + color: #404040; + padding-right: 1em; + padding-top: 0.15em; + margin-bottom: 0; + float: right; + } + #headline img { + width: 300px; + padding-left: 0; + padding-top: 35px; + padding-bottom:20px; + } + + .smallImgDiv{ + width:50%; + margin:auto; + margin-bottom:40px; + margin-top:20px; + } + .smallImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } + .largeImgDiv{ + width:100%; + margin: auto; + margin-bottom:40px; + margin-top:20px; + } + .largeImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } +} +/*****************************/ +@media ( max-width :599px) { + #headline { + /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + } + + #headline img { + width: 150px; + padding-left: 0; + padding-top: 0.5em; + padding-bottom:0.5em; + } + #headline br { + clear: both; + } + #demologin { + width: 100%; + box-sizing: border-box; + border: 1px solid; + border-radius: 1px; + border-color: #818286; + background: #F5F5F5; + height: 182px; + width: 242px; + margin-top: 18px; + padding-left:0; + } + #headline h1 { + color: #404040; + padding: 0; + margin-bottom: 0; + margin-top: 0; + text-align: center; + } + .smallImgDiv{ + width:100%; + margin:auto; + margin-bottom:40px; + margin-top:20px; + } + .smallImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } + .largeImgDiv{ + width:100%; + margin: auto; + margin-bottom:40px; + margin-top:20px; + } + .largeImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } +} + + diff --git a/id/server/doc/handbook_v4/common/logo_digAT.png b/id/server/doc/handbook_v4/common/logo_digAT.png new file mode 100644 index 000000000..4f36681e2 Binary files /dev/null and b/id/server/doc/handbook_v4/common/logo_digAT.png differ diff --git a/id/server/doc/handbook_v4/config/config.html b/id/server/doc/handbook_v4/config/config.html new file mode 100644 index 000000000..ad5592c54 --- /dev/null +++ b/id/server/doc/handbook_v4/config/config.html @@ -0,0 +1,1168 @@ + + + + + + MOA-ID - Konfiguration + + + + + +
+
+ +

MOA-ID

+
+
+
+
+

Konfiguration

+ +

Inhalt

+
    +
  1. +

    Übersicht

    +
      +
    1. Empfohlener Konfigurationsablauf
      2. +
    +
    2. +
  2. Basiskonfiguration +
      +
    1. MOA-ID-Configuration +
        +
      1. Bekanntmachung der Konfigurationsdatei
        2. +
      2. Konfigurationsparameter +
          +
        1. Allgemeine Konfigurationsparameter
          2. +
        2. Datenbankzugriff
          3. +
        3. Bürgerkarten LogIn
          4. +
        4. Mailversand
          5. +
        +
        3. +
      3. Initialisierung des Modules MOA-ID-Configuration
        4. +
      4. Benutzerverwaltung +
          +
        1. Einen neuen Benutzer erstellen
          2. +
        2. Benutzerrechte
          3. +
        +
        5. +
      +
      2. +
    2. MOA-ID-Auth +
        +
      1. Bekanntmachung der Konfigurationsdatei
        2. +
      2. Konfigurationsparameter +
          +
        1. Allgemeine Konfigurationsparameter
          2. +
        2. Externe Services +
            +
          1. Zentralers E-ID System
            2. +
          +
          3. +
        3. Protokolle +
            +
          1. SAML1
            2. +
          +
          4. +
        4. Datenbank +
            +
          1. Konfiguration
            2. +
          2. Session Informationen
            3. +
          3. Statistikdaten
            4. +
          +
          5. +
        5. Testing
          6. +
        +
        3. +
      +
      3. +
    3. Konfiguration des Loggings
      4. +
    +
    3. +
  3. Konfiguration MOA-ID-Auth +
      +
    1. Allgemeine Konfiguration +
        +
      1. Public URL Prefix
        2. +
      2. Zertifikatsprüfung
        3. +
      3. Session TimeOuts
        4. +
      4. MOA-SP
        5. +
      5. E-ID System
        6. +
      6. Protokolle +
          +
        1. Protkolle aktivieren
          2. +
        2. SAML1 Konfiguration
          3. +
        +
        7. +
      7. Revisionssicherheit
        8. +
      +
      2. +
    2. Online-Applikationen +
        +
      1. Informationen zur Online-Applikation (Service Provider) +
          +
        1. Öffentlicher Bereich
          2. +
        2. Privatwirtschaftlicher Bereich
          3. +
        +
        2. +
      2. E-ID System
        3. +
      3. Authentifizierungsprotokolle +
          +
        1. SAML 1
          2. +
        +
        4. +
      +
      3. +
    3. Import / Export +
        +
      1. Import alter Konfigurationen (= MOA-ID 2.x.x)
        2. +
      +
      4. +
    +
    4. +
  4. Konfiguration von MOA-SP
    5. +
  5. Tomcat Security Manager
    6. +
+
    +
  1. Referenzierte Spezifikation
    2. +
+ +

1 Übersicht

+

Dieses Handbuch beschreibt detailliert die Konfigurationsmöglichkeiten für die Module MOA-ID-Auth und MOA-ID-Configuration. Wobei das zentrale Einsatzgebiet des Modules MOA-ID-Configuration die Konfiguration des Modules MOA-ID-Auth darstellt.

+

Die Konfiguration der beiden Module MOA-ID-Auth und MOA-ID-Configuration kann in zwei Teilbereiche unterteilt werden. Der erste Abschnitt behandelt die Basiskonfiguration der beiden Module, welche in textueller Form mit Hilfe von properties-Konfigurationsdateien erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter Zuhilfenahme des Modules MOA-ID-Configuration.

+

1.1 Empfohlener Konfigurationsablauf

+
    +
  1. Basiskonfiguration des Modules MOA-ID-Configuration
    2. +
  2. Initialisierung des Modules MOA-ID-Configuration
    3. +
  3. Basiskonfiguration des Modules MOA-ID-Auth
    4. +
  4. Allgemeine Konfiguration des Modules MOA-ID-Auth
    5. +
  5. Konfiguration von Online-Applikationen
    6. +
+

Optional kann nach dem Schritt 3 Basiskonfiguration des Modules MOA-ID-Auth eine bestehende MOA-ID 2.x.x Konfiguration importiert werden. Für bestehende Konfigurationen < 2.x.x wird eine vollständige Neukonfiguration empfohlen.

+

Hinweis: Wenn eine bestehende MOA-ID 2.x.x Konfiguration importiert werden soll MUSS diese zuerst mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine XML Datei exportiert werden.

+

2 Basiskonfiguration

+

Die Basiskonfiguration für die Module MOA-ID-Auth und MOA-ID-Configuration erfolgt mit Hilfe textueller properties-Dateien. Diese properties-Dateien beinhalten alle Konfigurationsparameter welche für den Start der Module erforderlich sind und müssen der Java Virtual Machine durch eine System Property mitgeteilt werden. Alle Änderungen die an der Basiskonfiguration vorgenommen werden erfordern einen Neustart der jeweiligen Java Virtual Machine.

+

Hinweis: Alle URL Konfigurationsparameter auf Dateien ohne den Prefix file:/ werden als relative Pfadangaben zum Konfigurationsbasisverzeichnis des jeweiligen Modules interpretiert.

+

2.1 MOA-ID-Configuration

+

Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Configuration. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

+

2.1.1 Bekanntmachung der Konfigurationsdatei

+

Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

+
WINDOWS: -Dmoa.id.webconfig=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
+UNIX: -Dmoa.id.webconfig=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
+

Zusätzlich gibt es für das Konfigurationsmodul ein Usermanagment welches ebenfalls über eine eigene Konfiguration verfügt. Die Konfiguration des Usermanagements wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet user.properties als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

+ 
WINDOWS: -Duser.properties=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
+UNIX: -Duser.properties=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
+

Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Configuration erhalten Sie in Abschnitt 2.1.2.4 des Installationshandbuchs.

+

2.1.2 Konfigurationsparameter

+

Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt. Die Konfiguration der Blöcke Allgemeine Konfigurationsparameter und Datenbankzugriff sind nicht optional und müssen für den Betrieb angepasst werden.

+
2.1.2.1 Allgemeine Konfigurationsparameter
+

Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
general.defaultlanguagede, en

Hiermit kann die Sprache, welche für die Darstellung der Texte verwendet wird, festgelegt werden.

+

Hinweis: Aktuell wird nur Deutsch (de) oder Englisch (en) unterstützt.

general.ssl.certstorecerts/certstoreGibt den Pfadnamen zu einem Verzeichnis an, das als Zertifikatsspeicher im Zuge der TLS-Server-Zertifikatsüberprüfung verwendet wird.
general.ssl.truststorecerts/truststoreTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate beim Download von PVP 2.1 Metadaten verwendet.
general.ssl.hostnamevalidationtrue / false

Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

+

Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

general.moaconfig.keyConfigurationEncryptionKey

Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

+

Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Auth hinterlegten Passwort sein.

general.pvp.schemavalidationtrue / false

Hiermit kann die Schemavalidierung für konfigurierte PVP Metadaten deaktiviert werden.

+ Hinweis: Standardmäßig ist die Schemavalidierung aktiv.
+
2.1.2.3 Datenbankzugriff
+

Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden. Für die Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Configuration kann jedoch auch mit Datenbanken anderer Hersteller betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen, welches im Module MOA-ID-Configuration für den Datenbankzugriff verwendet wird.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
hibernate.dialect

org.hibernate.dialect.MySQLDialect

Sprachtyp der verwenden Datenbank
hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

hibernate.connection.driver_class

com.mysql.jdbc.DriverTyp der verwendeten Datenbank

hibernate.connection.username

moaconfigBenutzername für den Zugriff auf das Datenbank Schema

hibernate.connection.password

moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

dbcp.validationQuery

SELECT 1

SQL Query zum Validieren der Datenbank Verbindung

+

mySQL: SELECT 1

+

Oracle: select 1 from dual

+

 

+

Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

+

 

+

Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

+

2.1.3 Initialisierung des Modules MOA-ID-Configuration

+

Für den ersten Start muss die Authentifizierung deaktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend kann die Benutzerverwaltung des Modules MOA-ID-Configuration unter der folgenden Adresse aufgerufen werden.

+
http://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
+

bzw.

+
+https://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
+

Mit Hilfe dieser Benutzerverwaltung kann ein neuer Benutzeraccount am Konfigurationstool angelegt und ein Kennwort für den Benutzer vergeben werden. Zusätzlich müssen dem neu erstellten Benutzer die Eigenschaften aktiv und admin zugewiesen werden. Nach dem speichern wird der neu angelegte Benutzer in der Liste aller vorhandenen Benutzern dargestellt.

+

Hiermit ist die Initialisierung des Moduls MOA-ID-Configuration abgeschlossen und die Authentifizierung kann wieder aktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend muss die Java Virtual Machine, in welchem das Modul MOA-ID-Configuration betrieben wird, neu gestartet werden.

+

Hinweis: Ein Betrieb des Moduls MOA-ID-Configuration ohne Authentifizierung ist ebenfalls m\F6glich. In diesem Fall wird jedoch empfohlen den Zugriff auf das Konfigurationstool mit anderen Mitteln einzuschr\E4nken.

+

2.1.4 Benutzerverwaltung

+

Das Modul MOA-ID-Configuration unterstützt die Benützung und Verwaltung unterschiedlicher Benutzeraccounts. Hierfür stellt die Web-Oberfläche des Modules MOA-ID-Configuration ein spezielles Interface zur Benutzerverwaltung zur Verfügung.

+
2.1.4.1 Einen neuen Benutzer erstellen
+

Für die Registrierung eins neuen Benutzeraccounts werden folgende Informationen benötigt.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeschreibungOptional
VornameVorname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
FamiliennameFamilienname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
OrganisationZugeordnete Organisation. Wir bei Registrierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragennein
eMail AdresseeMail Adresse des Benutzers. Diese wird für weitere eMail Benachrichtigungen verwendetnein
TelefonnummerTelefonnummer des Benutzersnein
BenutzernameBenutzername für eine Anmeldung mittels Benutzername und Passwortnein
KennwortPasswort für eine Anmeldung mittels Benutzername und Passwortja
bPK / wbPKbPK oder wbPK für eine Anmeldung mittels PVP 2.1ja
Benutzer ist aktiviertAktiviert oder deaktiviert den jeweiligen Benutzeraccountja
Benutzer ist AdminDefiniert ob der Benutzeraccount über Administrator-Rechte verfügen soll. (siehe Kapitel 2.2.4.2)ja
Benutzername/Passwort erlaubenDefiniert ob eine Anmeldung mittels Benutzername und Passwort erlaubt ist. Falls nicht steht der Benutzerin / dem Benutzer nur eine Anmeldung mittels Bürgerkarte oder Handy-Signatur zur Verfügung.ja
+

 

+

Neue Benutzer können auf zwei Arten erstellt werden.

+
    +
  1. Durch Administrator: Bei dieser Variante wird der neue Benutzeraccount durch einen Administrator über die Web-Oberfläche erstellt und aktiviert. In diesem Fall müssen alle geforderten Daten durch den Administrator eingetragen werden. Bei dieser Variante ist die Validierung der eMail Adresse nicht zwingend erforderlich, kann jedoch optional aktiviert werden.
    +
    2. +
  2. Durch PVP 2.1 Login: Bei dieser Variante wird die Generierung eines neues Benutzeraccounts durch einen Loginversuch mittels Bürgerkarte oder Handy-Signatur ausgelöst. Nach erfolgreicher Authentifizierung wird die Benutzerin / der Benutzer an das Konfigurationstool weitergeleitet. Hierbei wird geprüft ob aktuell ein Benutzeraccount für diese Person existiert. Wenn kein Account existiert wird die Benutzerin / der Benutzer aufgefordert die fehlenden Informationen für die Registrierung eines neuen Benutzeraccounts einzutragen. In diesem Fall muss die eMail Adresse durch die Benutzerin / den Benutzer zwingend validiert werden wofür der Mailversand am Module MOA-ID-Configuration konfiguriert sein muss. Nach erfolgreicher Validierung der eMail Adresse ist der Benutzeraccount als nicht aktiv registriert und muss anschließend durch einen Administrator aktiviert werden. Erst nach erfolgreicher Aktivierung ist eine gültige Anmeldung möglich.
    + Sollte die Validierung der eMail Adresse nicht innerhalb des in Abschnitt 2.2.1.1 konfigurierten Zeitraums erfolgen, wird die Benutzeranforderung automatisch gelöscht und die Benutzerin / der Benutzer muss sich erneut am Konfigurationstool registrieren.
    3. +
+
2.1.4.2 Benutzerrechte
+

Alle Benutzer die Admin–Rechte (Eigenschaft admin) besitzen haben vollen Zugriff auf die gesamte Konfiguration der verwalteten MOA-ID-Auth Instanz. Benutzer ohne Admin-Rechten stehen nur folgende Operationen zur Verf\FCgung wobei diese auch besondere Einschr\E4nkungen aufweisen können.

+ +

2.2 MOA-ID-Auth

+

Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Auth. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

+

2.2.1 Bekanntmachung der Konfigurationsdatei

+

Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

+ 
Windows: moa.id.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
+UNIX: moa.id.configuration=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
+

Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Auth erhalten Sie in Abschnitt 2.1.2.3 des Installationshandbuchs.

+

2.2.2 Konfigurationsparameter

+

Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt.

+
2.2.2.1 Allgemeine Konfigurationsparameter
+

Die folgenden Konfigurationsparameter sind optional und müssen nicht zwingend angegeben werden. Im Falle eines produktiven Betriebs von MOA-ID-Auth wird jedoch die Angabe eines Schlüssels zur verschlüsselten Speicherung der Session Daten in der Datenbank dringend empfohlen.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
configuration.moasession.keyaX.J47s#bh7Passwort zum Verschlüsseln von personenbezogenen Session Daten die während eines Anmeldevorgangs und für Single Sign-On in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.
configuration.moaconfig.keyConfigurationEncryptionKey

Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

+

Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Configuration hinterlegten Passwort sein.

configuration.ssl.useStandardJavaTrustStoretrue / false

Deaktiviert die MOA-ID spezifische SSL TrustStore Implementierung. Wird dieser Parameter auf true gesetzt, verwendet MOA-ID den TrustStore der Java VM.

+

Defaultwert: false

configuration.ssl.validation.revocation.method.orderocsp,crl

Definiert die Reihenfolge des Zertifikatsrevokierungschecks bei SSL Verbindungen. Die Defaultreihenfolge ist OCSP, CRL.

+

Hinweis: Die Angabe erfolgt als CSV, wobei die Schlüsselwörter 'ocsp' und 'crl' lauten

configuration.ssl.validation.hostnametrue / false

Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

+

Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

configuration.validate.authblock.targetfriendlynametrue / falseHiermit kann die Überprüfung des 'TargetFriendlyName', welcher Teil des vom Benutzer signierten Authblock ist, deaktiviert werden. Eine Deaktivierung hat keinen Einfluss auf die Sicherheit des Authentifizierungsvorgangs mittels qualifizierter Signatur, jedoch kann der 'TargetFriendlyName im Authblock nicht als gesichert betrachtet werden.' Die Validierung ist deaktiviert wenn der Parameter auf false gesetzt wird.
+ Hinweis: Hierbei handelt es sich um einen Workaround für Systeme auf denen die Validierung des 'TargetFriendlyName' wegen Problemen mit der Zeichencodierung fehlschlägt, die Signatur des AuthBlocks jedoch gültig ist.
+ Defaultwert: true
configuration.bugfix.enable.idl.escapingtrue / false

MOA-ID intern wurden einfache Anführungszeichen (') in Vornamen oder Nachnamen bis zur Version 4.3.2 durch &#39; escapted. Dieses Escaping hatte durch einen Fehler auch Einfluss auf die ausgelieferten Attributen in PVP2 S-Profil, OpenID-Connect, etc. . Dieser Fehler wurde in der Version 4.3.3 behoben.
+ Aus Kompatibilitätsgründen kann das Escaping jedoch mittels Konfigurationsparameter wieder aktiviert werden. +

+

Defaultwert: false

configuration.monitoring.activetrue / falseAktiviert das Modul für internes Monitoring / Testing.
configuration.monitoring.message.successAll Tests passed!Statusmeldung wenn alle Tests erfolgreich ausgeführt wurden
configuration.monitoring.test.identitylink.urlmonitoring/
+ monitoring_idl.xml

Zur Überprüfung der gesamten Funktionalität von MOA-ID-Auth wird eine Personenbindung benötigt. Dieses Element definiert die URL auf eine Test Personenbindung welche für den Testablauf verwendet wird.

+

Hinweis: Der Beispielkonfiguration ist eine Personenbindung beigelegt die für das Monitoring verwendet werden kann. Bei dieser Personenbindung handelt es sich jedoch um Keine durch die Stammzahlenregisterbehörde ausgestellte Personenbindung, wodurch nicht der gesamte Personenbindungsvalidierungsvorgang getestet werden kann.

configuration.advancedlogging.activetrue / falseAktiviert das erweiterte Logging zur Generierung von anonymisierten Statistikdaten aus den Anmeldeinformationen. Hierfür muss der entsprechende Datenbankzugriff (siehe Kapitel 2.2.2.4) ebenfalls konfiguriert werden.
+

 

+

Wenn das interne Monitoring aktiviert wurde kann ein Testvorgang durch einen Aufruf der folgenden Adresse gestartet werden.

+
http://<host>:<port>/moa-id-auth/MonitoringServlet
+

bzw.

+
+https://<host>:<port>/moa-id-auth/MonitoringServlet
+

Nach einem erfolgreichen Testdurchlauf Antwortet das Monitoring mit einen http Statuscode 200 und der oben definierten Statusmeldung aus dem Parameter configuration.monitoring.message.success. Im Falle eines Fehlers antwortet das Monitoring mit einem http Statuscode 500 und die Statusmeldung enthält eine Beschreibung des aufgetretenen Fehlers.

+
2.2.2.2 Anbindung an das E-ID System
+

Die Anbindung und Weiterleitung an das zentrale E-ID System erfolgt via PVP2 S-Profil (SAML2). Für das in MOA-ID 4.x integrierte E-ID Proxy Authentifizierungsmodul sind folgende Konfigurationsparameter erforderlich.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
modules.eidproxyauth.keystore.pathkeys/szrgw.p12Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.x spezifischen Inhalten. (PVP 2.x Metadaten, PVP 2.1 Assertion)
modules.eidproxyauth.keystore.passwordpass1234Passwort zum Keystore
modules.eidproxyauth.metadata.sign.alias Name des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
modules.eidproxyauth.metadata.sign.password Passwort des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
modules.eidproxyauth.request.sign.alias Name des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
modules.eidproxyauth.request.sign.password Passwort des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
modules.eidproxyauth.response.encryption.alias Name des Schlüssels mit dem die PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
modules.eidproxyauth.response.encryption.password Passwort des Schlüssels mit dem PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
modules.eidproxyauth.EID.trustprofileIDeid_metadataMOA-SP TrustProfil welches die vertrauenswürdigen Zertifikate zur Validierung der Metadaten des zentralen E-ID Systemas beinhaltet
modules.eidproxyauth.EID.entityId Optional: EntityID des IDPs im zentralen E-ID System
modules.eidproxyauth.EID.metadataUrl Optional: URL auf die SAML2 Metadaten des zentralen E-ID System, sofern diese nicht über die EntityID geladen werden können
modules.eidproxyauth.required.additional.attributes.x 

Optional: zusätzliche Attribute welche vom zentralen E-ID System angefordert werden

+

Attribute werden entspechend PVP2 Attribute-Profil angegeben. Beispiele für die Konfiguration finden Sie in der Beispielkonfiguration

+

 

+
2.2.2.3 Protokolle
+

MOA-ID 4.x unterstützt nur mehr SAML1 als Authentifizierungsprotokoll.

+

 

+
2.2.2.4 Datenbank
+

Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) separate Datenbank Schema, welche in der Basiskonfiguration konfiguriert werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Auth kann jedoch auch mit Datenbanken anderer Hersteller oder einer InMemory Datenbank betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen.

+

 

+
2.2.2.4.1 Konfiguration
+

Alle Parameter aus der Basiskonfiguration welche als Prefix configuration.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nicht optional.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
configuration.hibernate.dialect

org.hibernate.dialect.MySQLDialect

Sprachtyp der verwenden Datenbank
configuration.hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

configuration.hibernate.connection.driver_class

com.mysql.jdbc.DriverTyp der verwendeten Datenbank

configuration.hibernate.connection.username

moaconfigBenutzername für den Zugriff auf das Datenbank Schema
configuration.hibernate.connection.passwordmoaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

configuration.dbcp.validationQuery

SELECT 1

SQL Query zum Validieren der Datenbank Verbindung

+

mySQL: SELECT 1

+

Oracle: select 1 from dual

+

 

+

Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

+
2.2.2.4.2 Session Informationen
+

Alle Parameter aus der Basiskonfiguration welche als Prefix moasession.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema in welchem MOA-ID-Auth die Session Informationen temporär ablegt. Eine Konfiguration dieser Parameter ist nicht optional.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
moasession.hibernate.dialect

org.hibernate.dialect.MySQLDialect

Sprachtyp der verwenden Datenbank
moasession.hibernate.connection.urljdbc:mysql://localhost/moa-id-session?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit den Session Information von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

moasession.hibernate.connection.driver_class

com.mysql.jdbc.DriverTyp der verwendeten Datenbank

moasession.hibernate.connection.username

moaconfigBenutzername für den Zugriff auf das Datenbank Schema

moasession.hibernate.connection.password

moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
+

 

+

Hinweis: Zusätzlich zum SQL based Datenbank Backend für Sessiondaten gibt es aber der Version 3.2.0 die Möglichkeit einen Redis Datenserver als Datenbank Backend für Kurzzeitsessiondaten zu verwenden. Wird dieser aktiviert werden nur mehr Single Sign-On Sessioninformationen in der Sessiondatenbank abgelegt. Alle anderen Prozessdaten werden ausschließlich über das Redis Backend abgewickelt.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
redis.active

true / false

Aktiviert das Redis Backend für Kurzzeitsessiondaten
redis.use-pooltrue / falseAktiviert / Deaktiviert den Connectionpool für Redis

redis.host-name

localhostURL unter der der Redis Server erreichbar ist

redis.port

6379Port unter dem der Redis Server erreichbar ist
+

 

+

 

+
2.2.2.4.3 Statistikdaten
+

Alle Parameter aus der Basiskonfiguration welche als Prefix advancedlogging.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nur erforderlich wenn configuration.advancedlogging.active auf true gesetzt wird. (siehe Kapitel 2.2.2.1)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
advancedlogging.hibernate.dialect

org.hibernate.dialect.MySQLDialect

Sprachtyp der verwenden Datenbank
advancedlogging.hibernate.connection.urljdbc:mysql://localhost/moa-id-statistic?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema für die Statistikfunktion von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

advancedlogging.hibernate.connection.driver_class

com.mysql.jdbc.DriverTyp der verwendeten Datenbank

advancedlogging.hibernate.connection.username

moaconfigBenutzername für den Zugriff auf das Datenbank Schema

advancedlogging.hibernate.connection.password

moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
+

 

+

Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff der einzelnen Schema welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

+
2.2.2.5 Testing
+

Diese Parameter dienen auf Testsystemen zur Deaktivierung einzelner Verarbeitungs- oder Prüfschritte. Standardmäßig ist jeweils die sichere Variante aktiviert.

+ + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
configuration.validation.certificate.QC.ignore

true / false

Deaktiviert die QC Prüfung von Signaturzertifikaten. Da manche Testzertifikate oder Testkarten keine QC Erweiterung aufweisen und somit eine Anmeldung mit diesen Zertifikaten nicht möglich ist, kann die QC Prüfung je Instanz deaktiviert werden.

+

Defaultwert: false

protocols.pvp2.schemavalidationtrue / false

Mit diesem Parameter kann die Schemavalidierung für PVP Metadaten deaktiviert werden.

+ Defaultwert: true
protocols.pvp2.assertion.encryption.activetrue / false

Mit diesem Parameter kann die Verschlüsselung der PVP2.1 Assertion für diese MOA-ID-Auth Instanz vollständig deaktiviert werden.

+

Defaultwert: true

+

Hinweis: Detaillierte Informationen zu den einzelnen PVP spezifischen Konfigurationsparametern finden Sie in der entsprechenden PVP Spezifikation.

+

 

+

2.3 Konfiguration des Loggings

+

Die Module MOA-ID-Auth und MOA-ID-Configuration verwendet als Framework für Logging-Information die Open Source Software log4j. Die Konfiguration der Logging-Information erfolgt nicht direkt durch die einzelnen Module, sondern über eine eigene Konfigurationsdatei, die der Java Virtual Machine durch eine System Property mitgeteilt wird. Der Name der System Property lautet log4j.configuration; als Wert der System Property ist eine URL anzugeben, die auf die log4j-Konfigurationsdatei verweist, z.B.

+
log4j.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/log4j.properties
+

Zustätzlich wird für einige Basiskomponenten, welche über Drittherstellerbibliotheken inkludiert sind, LogBack als Logging Framework verwendet. Die LogBack Konfiguration wird ebenfalls über den System Property angegeben

+ 
logback.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/logback_config.xml
+

Mit Hilfe von Konverertern kann eine bestehende log4j Konfiguration in das LogBack Format umgewandelt werden. Hierfür stehen divererse Tools Online zur Verfügung. (z.B. http://logback.qos.ch/translator/)

+

 

+

Weitere Informationen zur Konfiguration des Loggings erhalten Sie in Abschnitt 2.1.3 des Installationshandbuchs. +

+

+

3 Konfiguration MOA-ID-Auth

+

Dieser Abschnitt beschreibt die Konfiguration des Modules MOA-ID-Auth mithilfe der durch das Modul MOA-ID-Configuration zur Verfügung gestellten Web-Oberfläche. Hierzu muss das Konfigurationstool (Module MOA-ID-Konfiguration) bereits installiert und konfiguriert sein (siehe Kapitel 2.1). Nach erfolgreichem Login am Konfigurationstool kann das Modul MOA-ID-Auth über die Web-Oberfläche konfiguriert werden.

+

Die Konfiguration von MOA-ID-Auth ist in zwei Teilbereiche unterteilet. Diese behandeln die Allgemeine Konfiguration der MOA-ID-Auth Instanz und die Konfiguration von Online-Applikationen (Service Providern) welche dieser MOA-ID-Auth Instanz zugeordnet sind.

+

3.1 + Allgemeine Konfiguration

+

Die Allgemeine Konfiguration des Modules MOA-ID-Auth umfasst alle nicht online-applikationsspezifischen Konfigurationsparameter. Die Konfiguration dieser Parameter erfolgt über eine Web-Oberfläche, welche Eingabefelder für jeden Konfigurationsparameter zur Verfügung stellt. Jedes Eingabefeld wird validiert bevor der Konfigurationsparameter in der Datenbank gespeichert wird. Die Validierung erfolgt auf Basis des zu erwartenden Eingabewerts, wobei der erlaubte Zeichensatz für freidefinierbare textuelle Eingabefelder eingeschränkt sein kann. Detailinformationen zum erlaubten Zeichen finden Sie bei der jeweiligen Beschreibung des Konfigurationsparameters.

+

Nachfolgend finden Sie die Detailbeschreibung aller allgemeinen Konfigurationsparameter.

+

3.1.1 Public URL Prefix

+

Dieser Parameter definiert den Public URL Prefix unter welchem die MOA-ID Instanz erreichbar ist. Die Konfiguration dieses Parameters ist verpflichtend.

+ + + + + + + + + + + + + + + + +
NameBeispielwerteBeschreibung
Public URL Prefixhttps://demo.egiz.gv.at/moa-id-auth/

URL-Prefix der MOA-ID Instanz. Diese URL wird für die automatische Generierung von Formularen und Informationen verwendet und MUSS konfiguriert werden.

+

Hinweis: Wenn virtuelle IDPs aktiviert sind muss hier für jede virtuelle MOA-ID Instanz, der Public URL Prefix als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen Public URL Prefix durch Beistrich (',') getrennt.
+ (z.B.: https://demo.egiz.gv.at/moa-id-auth/,https://apps.egiz.gv.at/moa-id-auth/)

Virtuelle IDPs aktiviere 

Mit dieser Option können für diese MOA-ID Instanz mehrere virtuelle MOA-ID Instanzen, welche unter schiedenen Domains erreichbar sind aktiviert werden. Der Public URL-Prefix jeder virtuellen MOA-ID Instanz muss als Comma Separatet Value (CSV) im Konfigurationsfeld 'Public URL Prefix' angegeben werden.

+

Hinweis: Bei Verwendung von virtuellen IDPs werden für jeden virtuellen IDP SAML2 Metadaten mit unterschiedlichen EntityIDs entsprechend dem virtuellen IDP erstellt. Somit muss jeder virtuelle IDP als MOA-ID E-ID Proxy am zentralen Applikationsregister hinterlegt sein.

+

 

+

3.1.2 Zertifikatsprüfung

+

Dieser Bereich behandelt die allgemeine Einstellungen zur Zertifikatsprüfung und die Konfiguration von vertrauenswürdigen Zertifikaten.

+ + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung

TrustManagerRevocation

+ Checking		 Für die TLS-Server-Authentisierung dürfen nur Server-Zertifikate verwendet werden, die eine CRLDP-Extension enthalten (andernfalls kann von MOA-ID-Auth keine CRL-überprüfung durchgeführt werden). Soll das RevocationChecking generell ausgeschaltet werden, ist dieses Attribut anzugeben und auf "false" zu setzen

TrustedCACertificates

certs/ca-certsTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate für den Zugriff auf das Online-Vollmachten Service, den Stammzahlenregister Gateway und das Abholen von PVP 2.1 Metadaten via SSL verwendet.
+

3.1.3 Session TimeOuts

+ + + + + + + + + + + +
NameBeispielwert [sec]Beschreibung
Transaktion300

Gibt die Zeitspanne in Sekunden an, für die Anmeldedaten, temporäre Sessiondaten oder Assertions in der Authentisierungskomponente (MOA-ID-Auth) vorrätig gehalten werden. Nach Ablauf dieser Zeitspanne werden diese Daten gelöscht oder der Anmeldevorgang abgebrochen. Dieser Parameter hat Einfluss auf folgende Funktionen:

+
    +
  • maximale Zeitspanne eines Anmeldevorgangs vom Authentification Request bis zur Authentification Response gerechnet.
    • +
  • maximale Zeitspanne welche einer Online-Applikation zum Abholen der Anmeldedaten zur Verfügung steht. (SAML mit Artifact Binding und OpenID Connect)
    • +
  • maximale Zeitspanne zum Abholen zusätzlicher STORK2 Attribute (Zeitdauer je Attribut)
    • +
+

3.1.4 MOA-SP

+

Der Abschnitt MOA-SP Konfiguration enthält Parameter zur Nutzung von MOA-SP. MOA-SP wird für die Überprüfung der Signatur der SAML2 Metadaten des zentralen E-ID System benötigt. 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 beiliegenden Dokumentation im Abschnitt 'Konfiguration'.

+

3.1.5 Externe Services

+

Hiermit werden die URLs zum zentralen E-ID System konfiguriert.

+ + + + + + + + + + + +
NameBeispielwertBeschreibung
zentrales E-ID System (CSV)https://eid.egiz.gv.at/idp/shibboleth

URL(s) zu den SAML2 Metadaten des zentralen E-ID Systems

+ +

Hinweis: Die URLs auf die unterschiedlichen Instanzen des zentralen E-ID Systems können auch als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen URLs durch Beistrich (',') getrennt. Sind mehrere URLs hinterlegt kann das zu verwendeten Service je Online Applikation konfiguriert werden (siehe Kapitel 3.2.4).
+ (z.B.: https://eid.egiz.gv.at/idp/shibboleth,https://eid.gv.at/idp/shibboleth)

+

Hinweis: Erfolgt in der Online Applikation keine konkrete Auswahl wird Standardmäßig das erste eingetragen Service verwendet.

+

3.1.6 Protokolle

+

Hierbei handelt es ich um allgemeine Einstellungen zu den vom Modul MOA-ID-Auth unterstützen Authentifizierungsprotokollen.

+
3.1.6.1 Protokolle aktivieren
+

In diesem Abschnitt können die einzelnen von MOA-ID-Auth unterstützen Authentifizierungsprotokolle aktiviert oder deaktiviert werden. Diese Einstellung gilt für die gesamte MOA-ID-Auth Instanz.

+
3.1.6.2 SAML1 Konfiguration
+

Die SourceID ist ein Teil des SAML1 Artifacts welches zur Abholung der SAML1 Assertion an die Online-Applikation zurückgegeben wird. Standardmäßig wird die SourceID aus der URL der jeweiligen Online-Applikation, an der die Anmeldung stattfinden, generiert. Optional kann jedoch eine SourceID für die gesamte MOA-ID-Auth Instanz vergeben werden, welche für alle Online-Applikationen verwendet wird.

+ + + + + + + + + + + +
NameBeispielwerteBeschreibung
SourceIDMOA_Instanz_ASourceID zu Generierung des SAML1 Artifacts wenn hierfür nicht die OA URL verwendet werden soll.
+

 

+
3.1.6.3 PVP 2.x Konfiguration
+

Die allgemeinen Konfigurationsparameter für das Authentifizierungsprotokoll PVP 2.x behandeln Informationen zum Betreiber der MOA-ID-Auth Instanz und zu einer Ansprechperson für diese Instanz. Diese Parameter werden in den PVP 2.x Metadaten, welche dem zentralen E-ID System bereitgestellt werden, eingetragen.

+
3.1.6.3.1 Betreiberorganisation
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung

PVP Service Name

MOA-ID 2.0 Demo IDPName der MOA-ID-Auth Instanz. Dieser Name wird in den Metadaten im Element md:EntitiesDescriptor als Attribut Name angezeigt.

Kurzbezeichnung - Organisation

EGIZKurzbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationName angezeigt.
Vollständiger Name - OrganisationeGovernment InnovationszentrumVollbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationDisplayName angezeigt.
URL der Organisation - Organisationhttp://www.egiz.gv.atURL zu einer Seite mit Informationen der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationURL angezeigt.
+
3.1.6.3.2 Kontaktperson
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
FamiliennameMustermannFamilienname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.

Vorname

MaxVorname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:SurName angezeigt.

Mailadresse

max.mustermann@egiz.gv.ateMail Adresse der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
Telefonnummer+43012425478521Telefonnummer der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
UnternehmenEGIZUnternehmen für welches die Kontaktperson tätig ist. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:Company angezeigt.
Type des Kontaktstechnical

Type der Kontaktperson. Hierfür stehen folgende Typen zur Auswahl:

+
    +
  • technical
    • +
  • support
    • +
  • administrative
    • +
  • billing
    • +
  • other
    • +
+

Dieser Name wird in den Metadaten im Element md:ContactPersonals Attribut contactType angezeigt.

+

 

+ + + +

3.2 Online Applikationen

+

Die Konfiguration von Online-Applikationen erfolgt ebenfalls mit Hilfe des Moduls MOA-ID-Configuration. Es können sowohl neue Online-Applikationen erstellt als auch bestehende Online-Applikationen bearbeitet oder gelöscht werden. Der erlaubte Konfigurationsumfang hängt jedoch von Role des aktuellen Benutzers ab, wobei eine Konfiguration der gesamten Parameter nur einem Benutzer mit der Role admin möglich ist. Alle Konfigurationsfelder die nur einem Benutzer mit der Role admin zur Verfügung stehen sind gesondert gekennzeichnet.

+

3.2.1 Informationen zur Online-Applikation (Service Provider)

+

Dieser erste Abschnitt behandelt allgemeine Parameter zur Online-Applikation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertAdminOptionalBeschreibung
Online-Applikation ist aktiviert X Aktiviert oder deaktiviert die Online-Applikation. Eine Authentifizierung ist nur an aktiven Online-Applikationen möglich. Ein Anmeldeversuch an einer nicht aktiven Online-Applikation wird durch MOA-ID-Auth durch den Fehlercode auth.00 und der Fehlerbeschreibung Anmeldung an dieser Applikation wird nicht unterstützt verweigert.

Eindeutiger Identifikatior

https://demo.egiz.gv.at/demologin/  Dieser Parameter dient als Schlüssel zum Auffinden der Konfigurationsparameter zur Online-Applikation. Hierfür ist ein eindeutiger Identifikator für die Online-Applikation erforderlich. Dieser eindeutige Identifikator muss mindestens dem URL-Präfix der nach außen sichtbaren Domäne der Online-Applikation entsprechen.

Name der
+ Online-Applikation

Demo Applikation A  Hier muss ein benutzerfreundlicher Name für die Online-Applikation angegeben werden. Dieser Name scheint während der Authentifizierung des Benutzers oder am Online-Vollmachten Service bei der Vollmachten Auswahl auf.
Privatwirtschaftliche Applikation   Definiert ob die Online-Applikation dem öffentlichen Bereich oder dem privatwirtschaftlichen Bereich (Business Service) zugeordnet ist. Ja nach Bereich sind unterschiedliche Konfigurationsparameter erforderlich.
+
3.2.1.1 Öffentlicher Bereich
+

Wurde die Online-Applikation einem öffentlichen Bereich zugeordnet muss in weiterer Folge der zugeordnete Bereich definiert werden. Hierfür stehen folgende Parameter zur Verfügung.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertAdminOptionalBeschreibung
Bereich (Target)BF  Definiert den öffentlichen Bereich dem die Online-Applikation zugeordnet ist.

Target verfeinern

  XDer angegebene öffentliche Bereich kann mit Hilfe eines Sub-Bereich verfeinert werden. Wird ein Sub-Bereich konfiguriert wird dieser an das Kürzel des öffentlichen Bereichs angehängt.

Anderen Bereich frei definieren

 XXDiese Option erlaubt die freie Definition eines öffentlichen Bereichs. Soll ein freier Bereich für die Online-Applikation verwendet werden muss sowohl das Bereichskürzel als auch ein Name für den Bereich angegeben werden.
+

 

+

Hinweis: Wird die Online-Applikation durch eine Benutzerin oder einem Benutzer ohne die Role admin angelegt, wird vor der Speicherung überprüft ob die Online-Applikation alle Anforderungen an eine öffentliche Applikation erfüllt. Die Überprüfung erfolgt auf Basis des eindeutigen Identifikators (Public-URL PRefix) der Online-Applikation und es muss mindestens eine der folgenden Anforderungen erfüllt sein.

+ +
3.2.1.2 Privatwirtschaftlicher Bereich
+

Wurde die Online-Applikation einem privatwirtschaftlichen Bereich zugeordnet muss in weiterer Folge die Stammzahl des privatwirtschaftlichen Unternehmens angegeben werden. Die Stammzahl des öffentlichen Bereichs muss mit dem entsprechenden Prefix des Bereichs angegeben werden, wobei der Prefix aus einer vorgegebenen Liste gewählt werden muss.

+ + + + + + + + + + + + + + + + +
NameBeispielwerteAdminOptionalBeschreibung
Identifikationsnummer

FN 468924i
+ ZVR 124572
+ STORK SI +

  Stammzahl eines privatwirtschaftlichen Unternehmens oder Ländercode des STORK Service-Providers bei Verwendung des Modules MOA-ID als STORK VIDP. Die Angabe erfolgt durch den Prefix des Bereichs aus dem die Stammzahl stammt und der eigentlichen Stammzahl oder des Ländercodes im Falle von STORK.
+ +

 

+

3.2.2 Neue Attribute des E-ID Systems

+

Dieser Abschnitt behandelt die Änderungen am Attributset zur Person des neuen E-ID Systems. Ist der E-ID Modus aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

+

Folgende Attribute stehen nicht mehr zur Verfügung:

+ +

Folgende neuen Attribute stehen zur Verfügung:

+ +

 

+ + + + + + + + + + + + + + + +
NameBeispielwerteAdminOptionalBeschreibung
E-ID Attribute ausliefern

 

 XAktiviert die neuen Attribute des E-ID für diese Online Applikation.
+

 

+

3.2.3 Authentifizierungsprotokolle

+

Dieser Abschnitt behandelt online-applikationsspezifische Einstellungen zu den von der Online-Applikation unterstützen Authentifizierungsprotokollen. Eine Verwendung aller zur Verfügung stehender Authentifizierungsprotokolle durch die Online-Applikation ist ebenfalls möglich. Hierfür müssen nur alle benötigten Protokolle konfiguriert werden. Nähere Informationen zu den unterstützten Protokollen finden sie im Kapitel Protokolle.

+

Aus Gründen der Übersichtlichkeit kann der Konfigurationsbereich für jeden Protokoll, in der Web-Oberfläche des Konfigurationstools, ein- oder ausgeblendet werden.

+
3.2.3.1 SAML1
+

Für das Protokoll SAML1 stehen folgende Konfigurationsparameter zur Verfügung.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertAdminOptionalBeschreibung
SAML1 aktivierendeaktiviertX Aktiviert SAML1 als erlaubtes Authentifizierungsprotokoll für diese Online-Applikation. Bei neuerstellten Online-Applikationen ist SAML1 per Default deaktiviert.
Stammzahl übertragen XXDas Attribut bestimmt, ob die Stammzahl in den Anmeldedaten aufscheint oder ob der Wert ausgeblendet (d.h. auf den Leerstring gesetzt) wird. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl immer ausgeblendet.
Authentifizierungsblock übertragen XXDas Attribut bestimmt, ob der AuthBlock in den Anmeldedaten enthalten ist.
Personenbindung übertragen XXDas Attribut bestimmt, ob die Personenbindung in den Anmeldedaten enthalten ist. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl in der Personenbindung durch die jeweilige wbPK ersetzt.
Zertifikat übertragen XXDas Attribut bestimmt, ob das Signatorzertifikat in den Anmeldedaten enthalten ist.
Vollständige Vollmacht übertragen XXDas Attribut bestimmt ob bei einer Vollmachten-Anmeldung die vollständige 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. Wird dieses Attribut gewählt wird zusätzlich die gesamte Vollmacht übergeben.
+

 

+

 

+
3.3 Import / Export
+

Üer diese Funktionalität besteht die Möglichkeit eine bestehende MOA-ID 2.x.x + Konfiguration in MOA-ID 3.x zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID-Auth 3.0 + Konfiguration in ein Dokument zu exportieren oder in eine bestehende MOA-ID-Auth 3.0 + Konfiguration zu importieren.

+

Hinweis: + Zu beachten ist, dass bei einem Import die aktuell vorhandene + Konfiguration vollständig gelöscht und durch die importierte Konfiguration ersetzt wird. + Es wird empfohlen ein Backup einer eventuell vorhandenen MOA-ID 3.0 Konfiguration + zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die +Exportfunktion verwendet werden.

+

3.3.1 Import alter Konfigurationen ( MOA-ID 2.x.x)

+

Es besteht auch die Möglichkeit eine bestehende MOA-ID 2.x.x Konfiguration zu importieren. Hierfür muss zuerst die bestehende MOA-ID 2.x.x Konfiguration mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine Datei exportiert werden. Anschließend kann die expotierte Datei in das neue Format konfertiert und wieder in die Konfigurationsdatenbank importiert werden. Die einzelnen Schritte werden in der nachfolgenden Aufzählung näher beschrieben.

+
    +
  1. Exportieren Sie die aktuell in MOA-ID 2.x.x verwendete Konfiguration mit Hilfe der Import/Export Funktionen im Konfigurationstool der MOA-ID Version 2.x.x in eine XML Datei. Diese in eine XML Datei exportierte Konfiguration dient als Basis für die Konvertierung in das neue Format.
    2. +
  2. Konvertieren der Konfigurationsdatei in das neue Konfigurationsformat von MOA-ID 3.x. Die Konvertierung erfolgt mit Hilfe eines Java Programms aus der Konsole. Hierfür befindet sich im Release Package das Verzeichnis $MOA_ID_AUTH_INST/migration welches alle benötigten Java Bibliotheken beinhaltet. Das Programm kann mit Hilfe des nachfolgenden Kommantozeilenparameters gestartet werden. +
    + 
    java -jar moa-id-commons.jar -in ../URL_ZUR_MOA-ID-2.x.x-Config -out ./MOA-ID-3.x.properties
    + Hierbei wird die unter + ../URL_ZUR_MOA-ID-2.x.x-Config verfügbare Konfiguration in das neue Format umgewandelt und in der Datei ./MOA-ID-3.x.properties gespeichert.
    3. +
  3. Schreiben der konvertierten Konfiguration in die neue Konfigurationstabelle der Datenbank. Dies erfolgt ebenfall mit Hilfe des mitgelieferten Konsolenprogramms, welches mit dem nachstehenden Kommantozeilenparameter gestartet wird. + 
    java -jar moa-id-commons.jar -in ./MOA-ID-3.x.properties -outdb ./moa-id-webgui.properties
    + Hierbei wird die unter ./MOA-ID-3.x.properties verfügbare Konfiguration in die Datenbank geschrieben. Die Zugriffsparameter für den Datenbankzugriff werden aus der Konfigurationsdatei ./moa-id-webgui.properties entnommen, welche Identisch zur Konfiguration des neuen MOA-ID-Configuration Tools der Version 3.0 ist.
    4. +
+

Hinweis: Zusätzlich besteht auch weiterhin die Möglichkeit eine MOA-ID 2.x.x Konfiguration über die Import/Export Funktion im Konfigurationstool zu importieren. Der Import einer Konfiguration kann jedoch eine längere Zeit in Anspruch nehmen wodurch TimeOut Problemen im Browser möglich sind..

+

4 Tomcat Security Manager

+

Apache Tomcat bietet die Möglichkeit den Server unter einem Security Manager zu betreiben. Damit ist es möglich den lokalen Dateizugriff zu beschränken. Mit Hilfe der Datei "catalina.policy" können so Zugriffe auf lokale Dateien und Verzeichnisse festgelegt werden. Eine beispielhafte catalina.policy Datei finden Sie im Verzeichnis $MOA_ID_INST_AUTH/tomcat. Diese Datei wurde unter Apache Tomcat 4.1.31, 5.0.28 und 5.5.27 getestet.

+

Mehr Informationen zum Security Manager entnehmen Sie bitte der entsprechenden Apache Tomcat Dokumentation.

+

 

+

A Referenzierte Spezifikation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SpezifikationLink

Security Layer Spezifikation V1.2.0

http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
OpenID Connecthttp://openid.net/connect/
Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
+

 

+

 

+
+ + diff --git a/id/server/doc/handbook_v4/index.html b/id/server/doc/handbook_v4/index.html new file mode 100644 index 000000000..cd09a4704 --- /dev/null +++ b/id/server/doc/handbook_v4/index.html @@ -0,0 +1,55 @@ + + + + + + MOA ID - Übersicht + + + + + + +
+
+ +

MOA-ID E-ID Proxy

+
+
+
+ +
+

Übersicht zur Dokumentation der Version 4.0.x

+ +
+
Einführung
+
Übersicht über die einzelnen Module.
+
Installation
+
Detaillierte Anleitung für die Installation.
+
Konfiguration
+
Erläuterung aller Konfigurationsoptionen sowie Leitfaden für häufige Konfigurationsaufgaben.
+
Protokolle
+
Erläuterung der unterstützen Authentifizierungsprotokolle.
+
Anwendungen
+
Erläutert die Integration in bestehende Online-Applikationen und beschreibt die beigelegten Demo Applikationen
+
Zusatzinformationen
+
Spezifiziert allgemeine Funktionen des Modules MOA-ID-Auth
+
Informationen für Modul-Entwickler
+
Enthält Informationen für Entwickler von MOA-ID Modulen.
+
+
+
 
+
+
+ + diff --git a/id/server/doc/handbook_v4/install/install.html b/id/server/doc/handbook_v4/install/install.html new file mode 100644 index 000000000..6d11e0b72 --- /dev/null +++ b/id/server/doc/handbook_v4/install/install.html @@ -0,0 +1,331 @@ + + + + + + MOA-ID - Installation + + + + +
+
+ +

MOA-ID

+
+
+
+
+

Installation

+

Inhalt

+
    +
  1. +

    MOA-ID-Auth und MOA-ID-Configuration

    +
      +
    1. Basisinstallation +
        +
      1. Einführung
        2. +
      2. Installation +
          +
        1. Vorbereitung
          2. +
        2. Konfiguration von Apache Tomcat +
            +
          1. Konfiguration des HTTP Connectors
            2. +
          2. Konfiguration des HTTPS Connectors
            3. +
          +
          3. +
        3. Einsatz des Moduls MOA-ID-Auth in Tomcat
          4. +
        4. Einsatz des Moduls MOA-ID-Configuration in Tomcat
          5. +
        5. Starten und Stoppen von Tomcat +
            +
          1. Unter Windows
            2. +
          2. Unter Unix
            3. +
          3. Prüfen des erfolgreichen Starts
            4. +
          +
          6. +
        6. Änderung der Konfiguration im laufenden Betrieb
          7. +
        +
        3. +
      3. Logging +
          +
        1. Format der Log-Meldungen
          2. +
        2. Wichtige Log-Meldungen
          3. +
        +
        4. +
      +
      2. +
    2. Erweiterungsmöglichkeiten
        +
      1. Vorgeschalteter Webserver
          +
        1. Microsoft Internet Information Server (MS IIS)
            +
          1. Konfiguration von mod_jk im MS IIS
            2. +
          2. Konfiguration von Tomcat
            3. +
          3. Konfiguration von SSL
            4. +
          +
          2. +
        2. Apache
            +
          1. Konfiguration von mod_jk im Apache
            2. +
          2. Konfiguration von Tomcat
            3. +
          3. Konfiguration von SSL mit mod_SSL
            4. +
          +
          3. +
        +
        2. +
      +
      3. +
    +
+
    +
  1. Referenzierte Software
    2. +
+

1 Übersicht

+

Die Module MOA-ID-Auth und MOA-ID-Configuration sind als plattformunabhängige Module ausgelegt. MOA-ID-Auth bietet Webservices über HTTPS zur Identifizierung und Authentifizierung an. Das Modul MOA-ID-Configuration stellt eine Weboberfläche zur Konfiguration des MOA-ID-Auth Modules zur Verfügung.

+

Dieses Handbuch beschreibt die Installation der beiden Module.

+

2 MOA-ID-Auth und MOA-ID-Configuration

+

Dieser Abschnitt beschreibt die Installation von der Module MOA-ID-Auth und MOA-ID-Configuration. Im ersten Unterkapitel wird eine minimale Basisinstallation beschrieben. Das zweite Unterkapitel zeigt eine Reihe von optionalen Erweiterungsmöglichkeiten auf.

+

2.1 Basisinstallation

+

2.1.1 Einführung

+

Die Basisinstallation der Module MOA-ID-Auth und MOA-ID-Configuration stellt einerseits die minimalen Anforderungen für den Betrieb von MOA-ID dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.

+

Die Mindestanforderungen für die Basisinstallation sind:

+ +

Wir empfehlen jedoch jeweils aktuelle Version zu verwenden:

+ +

In diesem Betriebs-Szenario wird das MOA-ID-Auth Webservice und das MOA-ID Konfigurationstool in Tomcat zum Einsatz gebracht. Beide Module können sowohl in derselben Tomcat-Instanz, als auch in separaten Tomcat-Instanzen betrieben werden. Für den Fall des separaten Betriebs muss die Installation auf beiden Tomcat-Instanzen ausgeführt werden. In beiden Fällen fungiert der Tomcat gleichzeitig als HTTP- und HTTPS-Endpunkt für beide Module. Beide Protokolle werden direkt in Tomcat konfiguriert, wobei MOA-ID-Auth und MOA-ID-Configuration Log4j als Logging Toolkit verwenden.

+

2.1.2 Installation

+
2.1.2.1 Vorbereitung
+

Die folgenden Schritte dienen der Vorbereitung der Installation.

+
+
Installation von Java SE
+
Installieren Sie Java SE in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der Java SE Installation wird im weiteren Verlauf als $JAVA_HOME bezeichnet.
+
Installation von Apache Tomcat
+
Installieren Sie Apache Tomcat in ein Verzeichnis, das keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte die zu Ihrer Java SE passende Distribution von Tomcat. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet.
+
Entpacken der MOA-ID-Auth Webservice Distribution
+
Entpacken Sie die Datei moa-id-auth-4.x.x.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_ID_AUTH_INST bezeichnet.
+
Installation der Kryptographiebibliotheken von SIC/IAIK
+
+

Ab Java 9 ist eine Installation der Kryptographiebibliotheken nicht mehr notwendig.

+
+
+

Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_ID_AUTH_INST/ext in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden Unlimited Strength + + + Jurisdiction Policy Files von der Java SE Downloadseite und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung.

+
+
Installation einer Datenbank
+
Für den Betrieb von MOA-ID 4.x wird eine Datenbank benötigt, wobei mySQL als Datenbank empfohlen wird (wurde mit mySQL getestet). Der Einsatz eines alternativen Datenbanksystems ist jedoch ebenfalls möglich. Für den Betrieb werden mindestens zwei getrennte Datenbank Schema benötig, da die Konfiguration und die Session Informationen getrennt abgelegt werden. Erstellen Sie zwei Datenbank Schemas welche von MOA-ID-Auth verwendet werden sollen. Deren Namen können z.B. auf moa-id-session für Sessiondaten und moa-id-config für die Konfiguration lauten. Beliebige andere Namen für die Datenbank Schema sind jedoch auch möglich. +
+
+
2.1.2.2 Konfiguration von Apache Tomcat
+

Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. Tomcat wird grundsätzlich mit einer funktionierenden Default-Konfiguration ausgeliefert.

+
2.1.2.2.1 Konfiguration des HTTP Connectors
+

Die Tomcat Default-Konfiguration schaltet ausschließlich den Connector für HTTP auf Port 8080 frei. Wir empfehlen diese Konfiguration nur für Fälle, in denen das MOA-ID-Configuration Modul in einer abgeschlossenen Netzwerkumgebung betrieben wird. Das Modul MOA-ID-Auth verlangt für Authentifizierungsanfragen zwingend HTTPS.

+
2.1.2.2.2 Konfiguration des HTTPS Connectors
+

Für den sicheren Betrieb von MOA-ID-AUTH ist die Verwendung von SSL Voraussetzung, sofern nicht ein vorgelagerter Webserver (Apache oder IIS) das SSL-Handling übernimmt. Ebenso kann SSL auch für MOA-ID-Configuration verwendet werden.

+

Für die dazu notwendige Konfiguration kann die im vorigen Abschnitt besprochene minimale Tomcat-Konfiguration als Ausgangspunkt verwendet werden: Zunächst ist der HTTP Connector abzuschalten (auskommentieren). Anschließend ist der HTTPS Connector zu konfigurieren. Das Dokument Tomcat SSL Configuration HOW-TO gibt einen guten Überblick dazu. Grob zusammengefasst sind folgende Schritte durchzuführen:

+ +

Die Konfiguration des HTTPS Connectors kann entfallen, wenn Tomcat ein Webserver vorgeschaltet ist, und dieser die SSL-Kommunikation mit dem Kunden übernimmt (siehe Abschnitt 2.2.1).

+
2.1.2.3 Einsatz des Moduls MOA-ID-Auth in Tomcat
+

Um die Module MOA-ID-Auth und MOA-ID-Configuration in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

+ +
2.1.2.4 Einsatz des Moduls MOA-ID-Configuration in Tomcat
+ +
2.1.2.4 Starten und Stoppen von Tomcat
+
2.1.2.4.1 Unter Windows
+
+

Das Verzeichnis $MOA_IA_AUTH_INST/tomcat/win32 enthält Script-Dateien zum Starten und Stoppen von Tomcat. Vor der erstmaligen Verwendung der Scripts müssen in den ersten Zeilen die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden. Evtl. müssen Sie auch noch die in den Script-Dateien gesetzten, in Abschnitt 2.1.2.3 besprochenen System Properties anpassen.

+
+
2.1.2.4.2 Unter Unix
+

Zunächst müssen die in Abschnitt 2.1.2.3 besprochenen System Properties mit Hilfe der Umgebungsvariablen CATALINA_OPTS gesetzt sein. Die Datei $MOA_ID_AUTH_INST/tomcat/unix/moa-env.sh enthält ein Beispiel dafür. Des Weiteren müssen noch die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden.

+

Nun kann Tomcat aus seinem Basisverzeichnis mit

+
bin/catalina.sh start
+gestartet werden. Das Stoppen von Tomcat erfolgt analog mit +
bin/catalina.sh stop
+
2.1.2.4.3 Prüfen des erfolgreichen Starts
+
+

Ein erfolgreicher Start des MOA-ID-Auth Modules ist an folgender Log-Meldung ersichtlich:
+

+
+
32131 [localhost-startStop-1] INFO moa.id.auth  - MOA ID Authentisierung wurde erfolgreich gestartet 
+32131 [localhost-startStop-1] INFO moa.id.auth  - Dispatcher Servlet initialization finished.
+

Analog bei MOA-ID-Configuration

+
INFO | 21 10:16:22 | localhost-startStop-1 | Loading config module: MOAIDConfigurationModul
+

Bei leichten Fehlern in der Konfiguration geben WARN Log-Meldungen unmittelbar davor Aufschluss über fehlerhafte Konfigurations-Einträge. + Nach dem Starten von Tomcat stehen MOA-ID-Auth und MOA-ID-Configuration zur Verfügung. Die Einsprungspunkte der unterschiedlichen Authentifizierungsprotokolle von MOA-ID-Auth werden im Abschnitt Protokolle im Detail beschrieben.

+
+http://<host>:<port>/moa-id-auth/
+http://<host>:<port>/egiz-configuration-webapp/
+

bzw. +

+
+https://<host>:<port>/moa-id-auth/
+https://<host>:<port>/egiz-configuration-webapp/
+

Die Verfügbarkeit des Services können Sie einfach überprüfen, indem Sie die Endpunkte mit einem Web-Browser aufgerufen; dies sollte nach erfolgreichem Start zur Anzeige einer Informationsseite führen.

+
2.1.3 Logging
+

Beide Module verwenden Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: +

+

Hierbei werden folgende Log-Hierarchien verwendet:

+ +

Eine für beide Module passende Konfigurationsdatei für Log4j finden Sie hier. Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Dateien moa-id-auth.log und moa-id-configuration.log geschrieben.

+
2.1.3.1 Format der Log-Meldungen
+

Anhand einer konkreten Log-Meldung wird das Format der MOA SP/SS Log-Meldungen erläutert:

+ 
+ INFO | 2017-09-18 10:29:22,904 | SID-7947921060553739539 | TID-4708232418268334030 | https://sso.demosp.at/handysignatur 
+      | ajp-nio-28109-exec-7 | No SSO Session cookie found
+
+

Der Wert INFO besagt, dass die Log-Meldung im Log-Level INFO entstanden ist. Folgende Log-Levels existieren:

+ +

Der nächste Wert 01 21:25:26,540 gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in diesem Fall den 1. Tag im aktuellen Monat, sowie die genaue Uhrzeit).

+

Der Wert SID-7947921060553739539 bezeichnet die SessionID, welche diesem Request zugeordnet wurde. Eine SessionID ist innerhalb einer SSO auch über mehrere Authentifizierungsrequests eindeutig. Das Loggen der SessionID kann mittels %X{sessionId} in der log4j Konfiguration gesetzt werden

+

Der Wert TID-4708232418268334030 bezeichnet die TransactionsID, welche diesem Request zugeordnet wurde. Eine TransactionsID ist innerhalb eines Authentifizierungsrequests eindeutig. Das Loggen der TransactionsID kann mittels %X{transactionId} in der log4j Konfiguration gesetzt werden

+

Der Wert https://sso.demosp.at/handysignatur bezeichnet die Online Applikation (eindeutiger Identifier dieses Service Providers) für welchen dieser Authentifizierungsrequest durchgeführt wird. Das Loggen des OA Identifiers kann mittels %X{oaId} in der log4j Konfiguration gesetzt werden

+

Der Wert ajp-nio-28109-exec-7 bezeichnet den Thread, von dem die Anfrage bearbeitet wird.

+

Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist häufig ein Java Stack-Trace angefügt, der eine genauere Ursachen-Forschung ermöglicht.

+
2.1.3.2 Wichtige Log-Meldungen
+

Neben den im Abschnitt 2.1.2.4.3 beschriebenen Log-Meldungen, die anzeigen, ob das Service ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen.

+

Die Entgegennahme einer Anfrage wird angezeigt durch: + +

+ 
125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - REQUEST: /moa-id-auth/dispatcher
+125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - QUERY  : mod=id_pvp2x&action=Post&
+

Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch: +

2435298 [ajp-bio-129.27.142.119-38609-exec-10] ERROR moa.id.auth  - Failed to generate a valid protocol request!
+
+

In diesem Fall gibt der mitgeloggte Stacktrace Auskunft über die Art des Fehlers.

+

Die tatsächlich übertragenen Anfragen bzw. Antworten werden aus Effizienzgründen nur im Log-Level DEBUG angezeigt.

+
+

2.2 Erweiterungsmöglichkeiten

+

Ausgehend von der Basisinstallation können die optionalen Erweiterungen, die in den nachfolgenden Abschnitten beschrieben werden, unabhängig und in beliebiger Kombination aufgesetzt werden.

+

2.2.1 Vorgeschalteter Webserver

+
2.2.1.1 Microsoft Internet Information Server (MS IIS)
+

Den MOA SP/SS Webservices kann optional ein MS IIS vorgeschaltet sein. In diesem Fall übernimmt der MS IIS die HTTP- bzw. HTTPS-Kommunikation mit dem Aufrufer des Webservices. Die Kommunikation zwischen MS IIS und dem in Tomcat eingerichteten MOA-ID Modulen wird durch mod_jk durchgeführt. Die angeführten Konfigurationsschritte gehen von einer MS IIS Standard-Installation aus.

+
2.2.1.1.1 Konfiguration von mod_jk im MS IIS
+

Für die Kommunikation des MS IIS mit dem im Tomcat eingerichteten MOA SP/SS Webservice wird das ISAPI-Modul von mod_jk im MS IIS installiert und konfiguriert. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk IIS HowTo. Beispiele für workers.properties und uriworkermap.properties Dateien liegen im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

+
2.2.1.1.2 Konfiguration von Tomcat
+

Damit Tomcat die Aufrufe entgegennehmen kann, die von MS IIS mittels mod_jk weiterleitet werden, muss in $CATALINA_HOME/conf/server.xml der AJP Connector aktiviert werden. Im Gegenzug können die Konnektoren für HTTP und HTTPS deaktiviert werden. Das geschieht am einfachsten durch Ein- bzw. Auskommentieren der entsprechenden Connector Konfigurations-Elemente in dieser Datei.

+
2.2.1.1.3 Konfiguration von SSL
+

Die Dokumentation zum Einrichten von SSL auf dem MS IIS steht nach Installation des IIS unter http://localhost/iisHelp/ oder aber auch auf den Webseiten von Mircrosoft zur Verfügung.

+
2.2.1.2 Apache
+

Den MOA SP/SS Webservices kann ein Apache Webserver vorgeschaltet sein. Das Prinzip funktioniert wie bei MS IIS, auch hier wird mod_jk für die Kommunikation zwischen Webserver und Tomcat eingesetzt. Die angeführten Konfigurationsschritte gehen von einer Standard-Installation des Apache Webservers aus.

+
2.2.1.2.1 Konfiguration von mod_jk im Apache
+

Um die MOA-ID Module hinter einem Apache Webserver zu betreiben, ist die Konfiguration des Apache-Moduls mod_jk erforderlich. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk Apache HowTo. Ein Beispiel für eine workers.properties Datei liegt im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

+

Um die MOA-ID Module dem Apache Webserver bekannt zu machen, sind zumindest folgende Einträge im globalen Kontext der Apache-Konfigurationsdatei notwendig:

+
LoadModule jk_module /usr/lib/apache/mod_jk.so
AddModule jk_module
JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
JkWorkersFile conf/workers.properties 
JkMount /moa-spss/* moaworker
+

Die Pfad- und Dateinamen können je nach existierender Apache Installation geringfügig variieren.

+
2.2.1.2.2 Konfiguration von Tomcat
+

Die Konfiguration von Tomcat ist analog zu Abschnitt 2.2.1.1.2 durchzuführen.

+
2.2.1.2.2 Konfiguration von SSL mit mod_SSL
+

Apache kann in Verbindung mit mod_SSL als SSL-Endpunkt für die MOA-ID Module fungieren. In diesem Fall entfällt die SSL-Konfiguration in Tomcat, da Apache und Tomcat auch im Fall von SSL Daten via mod_jk austauschen. Eine detaillierte Installations- und Konfigurationsanleitung enthält die Online-Dokumentation von mod_SSL.

+

Bei der Verwendung von Client-Authentisierung muss darauf geachtet werden, dass mod_ssl die HTTP-Header mit den Informationen über das Client-Zertifikat exportiert. Dies wird durch Angabe der folgenden Option in der Apache-Konfiguration erreicht:

+ 
SSLOptions +ExportCertData +StdEnvVars
+

Je nach vorhandener SSL-Konfiguration des Apache Webservers kann diese Option im globalen Kontext, im Kontext des Virtual Hosts oder im Kontext eines Verzeichnisses spezifiziert werden.

+

A Referenzierte Software

+

Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

+ + + + + + + + + + + + + + + + + +
NameBeschreibung
Apache Tomcat Apache Tomcat Servlet-Container
Java SEJava Standard Edition (Software Development Kit bzw. Java Runtime Environment)
Log4J Logging Framework
+
+ + diff --git a/id/server/doc/handbook_v4/intro/Blockdiagramm.png b/id/server/doc/handbook_v4/intro/Blockdiagramm.png new file mode 100644 index 000000000..18d5b84a2 Binary files /dev/null and b/id/server/doc/handbook_v4/intro/Blockdiagramm.png differ diff --git a/id/server/doc/handbook_v4/intro/E-ID-Proxy.png b/id/server/doc/handbook_v4/intro/E-ID-Proxy.png new file mode 100644 index 000000000..2e7bb2896 Binary files /dev/null and b/id/server/doc/handbook_v4/intro/E-ID-Proxy.png differ diff --git a/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png b/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png new file mode 100644 index 000000000..7735679bf Binary files /dev/null and b/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png differ diff --git a/id/server/doc/handbook_v4/intro/anmeldeablauf.png b/id/server/doc/handbook_v4/intro/anmeldeablauf.png new file mode 100644 index 000000000..59bdefe62 Binary files /dev/null and b/id/server/doc/handbook_v4/intro/anmeldeablauf.png differ diff --git a/id/server/doc/handbook_v4/intro/intro.html b/id/server/doc/handbook_v4/intro/intro.html new file mode 100644 index 000000000..a7a4a6357 --- /dev/null +++ b/id/server/doc/handbook_v4/intro/intro.html @@ -0,0 +1,84 @@ + + + + + + MOA-ID - Einführung + + + + +
+
+ + +

MOA-ID

 +
+
+
+ +
+

Einführung

+

Allgemeines

+

MOA-ID E-ID Proxy

+

MOA-ID-Configuration

+

 

+

 

+

1 Allgemeines

+

Der neue elektronische Identitätsnachweis E-ID wird die alte Bürgerkarte ersetzen und stellt ein System mit mehr Einsatzmöglichkeiten dar. Der neue E-ID basiert auf der nachfolgend dargestellten Architektur, die sich aus einer Vielzahl verschiedener Komponenten zusammensetzt. Das Zusammenspiel der Komponenten, sowie eine kurze Definition wird nachfolgend beschrieben.

+

 

+

 

+

Architektur MOA-ID

+

 

+

Die Gesamtarchitektur besteht aus vier Ebenen. Benutzer authentifizieren sich in der Applikationsebene gegenüber einem bestimmten Service Provider. Dieser Identifikations- und Authentifizierungsprozess erfolgt über den zentralen Identity Provider und dem Vertrauensdiensteanbieter (VDA) in der Authentifizierungsebene. Ebenso erfolgt hier im Vertretungsfall die Auswahl einer adäquaten Vollmacht über das Online-Vollmachten Service (OVS). Die Authentifizierungsebene wird auch als „E-ID Front-End“ bezeichnet. Die Personenbindung wird im E-ID Backend, in der Datenaggregierungsebene erstellt und über das E-ID Frontend an den Service Provider ausgeliefert. Werden über das Minimum Data Set (MDS) hinaus, d.h. bPK(s), Name und Geburtsdatum, weitere Attribute benötigt, so werden diese vom E-ID Backend von den jeweiligen Registern (Datenebene) bezogen und in die Personenbindung aufgenommen.

+

 

+

 

+

2 MOA-ID E-ID Proxy

+

Der neue elektronische Identitätsnachweis E-ID bietet ein zentrales Identitätsmanagementsystem welches die aktuell dezentral betriebenen MOA-ID Instanzen ersetzt. Für die Anbindung von Service Providern (Applikationen) werden durch den Identity Provider (IDP) des E-ID System folgende, auch bereits von MOA-ID unterstütze, Authentifizierungsprotokolle angeboten:

+ +

Eine direkte Anbindung von Service Providern mittels des SAML1 Authentifizierungsprotokolls, welches in MOA-ID bereits seit der Version 2.x als "Deprecated" markiert war, ist am IDP den zentrales Identitätsmanagementsystem nicht mehr möglich. Alle Service Provider welche aktuell mittels SAML1 an MOA-ID Ankoppeln können somit nicht mehr direkt an den neue elektronische Identitätsnachweis ankopplen.
+

+

Das Modul MOA-ID E-ID Proxy wird als MOA-ID Version 4.x veröffentlicht und implementiert einen Adapter zwischen dem IDP des zentrales Identitätsmanagementsystems und Service Providern (Anwendungen), welcher dazu dient SAML1 Applikationen an den neue elektronische Identitätsnachweis ankopplen. Der MOA-ID E-ID Proxy bietet Anwendugnen die selbe SAML1 Schnittstelle, wie sie bereits aus den vorangegangenen MOA-ID Versionen bekannt ist, und leitet alle Authentifizierungsanfragen direkt an das E-ID System weiter. Diese Ankopplung an das zentrales Identitätsmanagementsystem ist im nachfolgenden Blockdiagramm auch grafisch dargestellt.

+

 

+
+

Architektur MOA-ID

+

 

+

Die Installation und der Betrieb ist identisch zur Version 3.x von MOA-ID, es steht jedoch ab der Version 4.x nur mehr die Funktion als E-ID Proxy zur Verfügung.

+

Die SAML1 Schnittstelle des MOA-ID E-ID Proxy ist zwar identisch, doch werden durch das zentrale E-ID System nicht mehr alle aus MOA-ID < v4.x bekannten Identitätsattribute bereitgestellt. Somit ändert sich der Inhalt der vom MOA-ID E-ID Proxy bereitgestellten SAML1 Assertion im Bezug auf die darin enthaltenten Attribute zur Person. Die nachfolgende Liste zeigt eine kurze Zusammenfassung der Änderungen. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

+

Folgende Attribute stehen nicht mehr zur Verfügung:

+ +

Folgende neuen Attribute stehen zur Verfügung:

+ +

Als weitere Anpassung wird die iFrame Integration der Handy-Signatur nicht mehr zur Verfügung stehen und es erfolgt eine vollformat Weiterleitung an das zentrale E-ID System.

+

 

+

3 MOA-ID-Configuration

+

Das Modul MOA-ID-Configuration stellt eine web-basierte Benutzerschnittstelle zur Konfiguration des Moduls MOA-ID E-ID Proxy zur Verfügung, wobei sich die Konfiguration in zwei Teilbereiche unterteilt ist. Eine detaillierte Aufstellung der einzelnen Konfigurationspunkte befindet sich im Kapitel Konfiguration.

+
    +
  1. Allgemeine Konfiguration
    + In diesem Bereich sind alle Basiseinstellungen der MOA-ID E-ID Proxy Instanz hinterlegt. Beispiele hierfür sind Single Sign-On, unterstütze Authentifizierungsprotokolle, Informationen zu MOA-ID E-ID Proxy, URLs zu externen Services, ... Eine Änderung der Basiseinstellung erfordert besondere Benutzerrechte am Konfigurationstool.
    2. +
  2. Online-Applikationen
    + In diesem Abschnitt erfolgt die Konfiguration der einzelnen bei MOA-ID E-ID Proxy registrierten Service-Provider. Hierbei handelt es sich um Authentifizierungsprotokoll-spezifische Einstellungen, Bereich des Service-Providers (öffentlich / Privatwirtschaftlich), Konfiguration der BKU Auswahl, .... Wobei sich die Konfigurationsmöglichkeiten je nachdem welche Benutzerrechten vergeben sind, unterscheiden können.
    3. +
+

Zusätzlich unterstützt das Module MOA-ID-Configuration auch eine einfache Benutzerverwaltung mit Rechtevergabe mit deren Hilfe die Verwaltung von Online-Applikationen an den jeweiligen Service-Provider ausgelagert werden kann. Die Anmeldung am Konfigurationstool erfolgt mittels Bürgerkarte, Handysignatur oder STORK, wobei optional auch eine Anmeldung mittels Benutzername und Passwort zur Verfügung steht.

+

 

+
+ + diff --git a/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd b/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd new file mode 100644 index 000000000..d6ab7ae46 --- /dev/null +++ b/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html b/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html new file mode 100644 index 000000000..28e4f1bb4 --- /dev/null +++ b/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html @@ -0,0 +1,388 @@ + + + + + + MOA-ID - Informationen für Modul-Entwickler + + + + + + + + + + + + +
+ Logo BKA + Dokumentation + Logo EGIZ +
+
+ +

+ MOA-ID (Identifikation) +

+

Informationen für Modul-Entwickler

+
+ + +

Inhalt

+
    +
  1. +

    + Übersicht +

    +
    2. +
  2. +

    + Prozesse +

    +
      +
    1. Aufgaben (Tasks)
      2. +
    2. Transitions
      3. +
    +
    3. +
  3. +

    + Module +

    +
      +
    1. Metadaten und Prozessauswahl
      2. +
    2. +

      + Discovery +

      +
        +
      1. Service Loader Mechanismus
        2. +
      2. Spring Bean Discovery
        3. +
      +
      3. +
    +
    4. +
  4. +

    + Hinweise +

    +
    5. +
+
+ + +

+ 1 Übersicht +

+

+ MOA-ID ab Version 2.2 ermöglicht die dynamische Erweiterung um zusätzliche Funktionalität durch die Nutzung der + integrierten Modularchitektur.
+ Entwickler können nun eigene Prozesse, um die MOA-ID erweitert werden soll, definieren (z.B. Unterstützung + eines speziellen Authentifizierungsworkflows, Erweiterung um Vollmachten oder ausländische Identitäten etc). + MOA-ID bietet eine Ablaufsteuerung ("ProcessEngine"), die einzelne Aufgaben (Tasks) entsprechend einer vorgegebenen Prozessdefinition + abarbeiten kann. +

+

+ Mehrere Prozesse können zu einzelnen Modulen zusammengefasst werden. Ein Modul, typischerweise repräsentiert durch eine separate JAR-Datei, wird automatisch erkannt, sobald sich + dieses im Classpath der Anwendung befindet. Damit stehen die in diesem Modul definierten Prozesse MOA-ID + automatisch zu Verfügung. +

+

+ Beim Starten eines Authentifizierungsvorgangs speichert MOA-ID die zu diesem Zeitpunkt zu Verfügung stehenden + Informationen (Ergebnis der BKU-Auswahl, Auswahl des Herkunftslandes, Wunsch nach Vollmachten-Nutzung etc.) in + eine Datenstruktur ("ExecutionContext"). Module entscheiden dann auf Basis dieser Informationen, ob sie entsprechende Prozesse für den gegebenen Kontext anbieten können. Sobald ein + passender Prozess gefunden wurde, beginnt die MOA-ID ProcessEngine mit der Ausführung der darin definierten + Aufgaben. +

+

+ Bei diesen Aufgaben handelt es sich typischerweise um einzelne synchrone oder asynchrone Schritte eines kompletten + Authentifizierungsvorgangs wie z.B. das Erstellen eines HTML-Formulars zum Auslesen der Personenbindung (synchron), + das Empfangen und Verarbeiten einer Personenbindung (asynchron), das Aushandeln einer Session mit dem Vollmachtenportal (synchron) etc. + Jeder Task erhält bei Ausführung automatisch Zugriff auf den ExecutionContext, der von Task zu Task weitergereicht, zum Austausch bzw. Akkumulieren von Daten dient und schließlich auch persistiert wird. + Darüber hinaus steht jeweils HttpServletRequest und HttpServletResponse zu Verfügung. +

+ +

+ 2 Prozesse +

+

+ Ein Prozess definiert sich primär über seine Tasks, die es in einer bestimmten Abfolge abzuarbeiten gilt. Um welche Tasks es sich handelt und wie die Abfolge unter welchen Bedingungen aussieht wird in einer + ProzessDefinition in Form eines XML-Dokuments festgelegt. +

+

Siehe ProcessDefinition.xsd.
 

+ +

+ Die folgende Prozessdefinition zeigt als Beispiel den internen Standard-Authentifizierungsprozess von MOA-ID. Dieser unterstützt Vollmachten uns ausländische Identitäten:
  +

+
<?xml version="1.0" encoding="UTF-8"?> +<pd:ProcessDefinition id="DefaultAuthentication" xmlns:pd="http://reference.e-government.gv.at/namespace/moa/process/definition/v1"> + + <pd:Task id="createIdentityLinkForm" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CreateIdentityLinkFormTask" /> + <pd:Task id="verifyIdentityLink" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyIdentityLinkTask" async="true" /> + <pd:Task id="verifyAuthBlock" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyAuthenticationBlockTask" async="true" /> + <pd:Task id="verifyCertificate" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyCertificateTask" async="true" /> + <pd:Task id="getMISSessionID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetMISSessionIDTask" async="true" /> + <pd:Task id="certificateReadRequest" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CertificateReadRequestTask" /> + <pd:Task id="prepareAuthBlockSignature" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.PrepareAuthBlockSignatureTask" /> + <pd:Task id="getForeignID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetForeignIDTask" async="true" /> + + <pd:StartEvent id="start" /> + + <pd:Transition from="start" to="createIdentityLinkForm" /> + + <pd:Transition from="createIdentityLinkForm" to="verifyIdentityLink" /> + + <pd:Transition from="verifyIdentityLink" to="certificateReadRequest" conditionExpression="!ctx['identityLinkAvailable'] || ctx['useMandate']" /> + <pd:Transition from="verifyIdentityLink" to="prepareAuthBlockSignature" /> + + <pd:Transition from="prepareAuthBlockSignature" to="verifyAuthBlock" /> + + <pd:Transition from="certificateReadRequest" to="verifyCertificate" /> + + <pd:Transition from="verifyCertificate" to="verifyAuthBlock" conditionExpression="ctx['useMandate']" /> + <pd:Transition from="verifyCertificate" to="getForeignID" /> + + <pd:Transition from="verifyAuthBlock" to="getMISSessionID" conditionExpression="ctx['useMandate']" /> + <pd:Transition from="verifyAuthBlock" to="end" /> + + <pd:Transition from="getMISSessionID" to="end" /> + <pd:Transition from="getForeignID" to="end" /> + + <pd:EndEvent id="end" /> + +</pd:ProcessDefinition> +
+

 

+ +

+ Jede Prozessbeschreibung muss zwingend ein StartEvent und ein EndEvent enthalten. + Einzelne Aufgaben sind durch Task-Elemente gekennzeichnet, wobei via Attribut async + festgelegt wird ob es sich dabei um einen synchronen (Standardeinstellung) oder um einen asynchronen Task handelt (siehe auch Abschnitt 2.1). +

+ +

+ 2.1 Aufgaben (Tasks) +

+

+ Aus technischer Sicht sind Aufgaben einfache Klassen, die die abstrakte Klasse at.gv.egovernment.moa.id.process.springweb.MoaIdTask (moa-id-lib-xy.jar) + implementieren. Diese definiert lediglich eine execute-Methode, die aufgerufen wird, sobald der Task + von der ProcessEngine gestartet wird. Über diese Methode erhält der Task Zugriff auf den ExecutionContext sowie + auf HttpServletRequest und HttpServletResponse. Der HttpServletRequest und der ExecutionContext können nun ausgewertet, bzw. falls notwendig der ExecutionContext und die HttpServletResponse auch manipuliert werden. +

+

+ Synchrone Tasks werden hintereinander ausgeführt. Trifft die Process Engine auf einen asynchronen Task wird dieser + nicht gleich ausgeführt, sondern der Prozess wird zunächst angehalten. Bei asynchronen Tasks handelt es sich meist um Tasks, + die zuvor eine Benutzerinteraktion erfordern (z.B. Signatur mit Bürgerkartenumgebung).
+ Als Beispiel eines asynchronen Tasks wäre ein VerifyIdentityLinkTask zu nennen, der nach Eintreffen + der Antwort der Bürgerkartenumgebung auf der DataURL aufgeweckt wird, um eine InfoBoxReadResponse mit + der Personenbindung entgegen zu nehmen, diese zu parsen und zu validieren. +

+

+ Die Aufgabe eines (DataURL-)Servlets, das den jeweiligen Prozess aufweckt, um die Ausführung eines nachfolgenden asynchronen + Tasks zu bewirken, übernimmt das interne Servlet at.gv.egovernment.moa.id.auth.servlet.ProcessEngineSignalServlet, + das auf die URL /signalProcess gemappt wurde. +

+

+ Hinweis: Das interne ProcessEngineSignalServlet bzw. dessen Methode getMoaSessionId(HttpServletRequest request) + können bei Bedarf durch eine Modulspezifische Implementierung überschrieben werden, um ggf. speziellen + Anforderungen in Bezug auf die Ermittlung der jeweiligen MOA Session Id Rechnung zu tragen (STORK PEPS + unterstützen keine Parameter wie MOASessionID in der assertion consumer url).
+ Als Beispiel dazu kann das Servlet at.gv.egovernment.moa.id.auth.modules.stork.STORKProcessEngineSignalServlet + des STORK-Moduls dienen. +

+

+  
+ Als Beispiele typischer Tasks können die Klassen im package at.gv.egovernment.moa.id.auth.modules.internal.tasks herangezogen werden.
+

+ +

+ 2.2 Transitions +

+

+ Die Abfolge der einzelnen Task wird in der Prozessbeschreibung durch die Transition-Elemente + bestimmt. Diese weisen die zwei verpflichtenden Attribute from und to auf, die jeweils einen Task (oder StartEvent) referenzieren von (from) dem die ProzessEngine zu (to) weiteren Task (oder EndEvent) traversiert. Betrachtet man einen + Prozess als Graphen, dann sind die Tasks als Knoten und die Transitions als Kanten anzusehen. +

+

+ Jede Prozessausführung beginnt mit dem StartEvent. Von diesem ausgehend werden alle möglichen + Transitions zu anderen Tasks untersucht. Die erste Transition, die eine gültige Verbindung zu einem anderen Task + aufweist wird für die weitere Prozessausführung herangezogen. Transitions können über das Attribut + conditionExpression mit einer Art Policy ausgestattet werden, die festlegt, ob eine Transition verwendet + werden kann oder nicht. Dies ermöglicht eine bedingte Ausführung von Tasks. +

+

+ Expressions müssen sich in eine booleschen Wert auflösen lassen: true (genauso + wie ein nicht gesetztes conditionExpression-Attribut) bedeutet, dass die Transition verwendet werden kann, + false bedeutet, dass die Transition nicht verwendet wird. + Bei den Expressions handelt es sich um Spring EL Expressions, + die einen leichten Zugriff auf den ExecutionContext, HttpServletRequestParameter sowie beliebige Spring-Beans ermöglichen: +

+ + + + + + + + + + + + + + + + + + + + + +
BezeichnerBeispielBedeutung
ctx!ctx['identityLinkAvailable']Erlaubt das Auswerten einzelner Variablen aus dem ExecutionContext, in diesem Fall einer booleschen Variable identityLinkAvailable
requestParameterrequestParameter['myParam'] != nullGreift auf RequestParameter aus dem HttpServletRequest zurück und ermöglicht so eine Requestparameter abhängige Abfolge von Tasks.
@@mySpringBean.isFoo()Greift auf ein Bean (in diesem Fall mit dem Namen mySpringBean) aus dem Spring ApplicationContext zurück.
+ +

+ 3 Module +

+

+ Bei einem Modul handelt es sich grundsätzlich lediglich um eine logische Gruppierung von Prozessen. + Module sind bedingt durch ihr automatisches Discovery als eine Art Plug-in zu betrachten, weshalb sie typischerweise + auch in eigene JAR-Dateien ausgelagert vorliegen. +

+

Als Beispiel eines solchen Moduls kann das STORK-Modul (moa-id-module-stork-xy.jar) gesehen werden. + +

+ 3.1 Metadaten und Prozessauswahl +

+

+ Jedes Modul muss das Interface at.gv.egovernment.moa.id.auth.modules.AuthModule implementieren, über + das der ProcessEngine zum einen Metadaten zu Verfügung gestellt werden, diese zum anderen aber auch die Prozessauswahl + (siehe Abschnitt 1) abgewickelt wird. +

+

+

+
int getPriority()
+
Über diese Methode gibt das Modul seine Priorität bekannt. Dies beeinflusst die Reihenfolge des Moduls + bei der Abfrage nach passenden Prozessen beim Starten eines Authentifizierungsprozesses.
+ Standardpriorität ist 0. Module die vorgereiht werden sollen, müssen eine höhere Priorität aufweisen.
+
+
+
String[] getProcessDefinitions()
+
Hierüber gibt das Modul die Prozessdefinitionen (bzw. ResourceUris zu den entsprechenden XML-Dateien) bekannt. + Diese werden automatisch von MOA-ID geparst und registriert. +
+
+
+
String selectProcess(ExecutionContext context)
+
Diese Methode wird von MOA-ID beim Starten eines Authentifizierungsprozesses aufgerufen. Der ExecutionContext + wird mit den in oben in Abschnitt 1 erwähnten Informationen befüllt und dieser + dann der selectProcess-Methode übergeben. Diese entscheidet, ob ein passender Prozess zu Verfügung + steht oder nicht. Eine eventuelle modulinterne Priorisierung muss das Modul selbst vornehmen.
+
+

+

+ Als Beispiel kann die Implementierung des STORK-Moduls herangezogen werden: at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl
+ Nähere Informationen sind der Javadoc Dokumentation des AuthModule Interfaces zu entnehmen. +

+ +

+ 3.2 Discovery +

+

+ Das bereits erwähnte automatische Discovery von Modulen beschränkt sich nun auf das automatische Auffinden der + jeweiligen AuthModule-Implementierung. MOA-ID sieht zwei Varianten vor, derartige Implementierung + aufzufinden. Welche der beiden zur Anwendung kommt (es können notfalls auch beide kombiniert werden), bleibt dem Modulentwickler überlassen. +

+ +

+ 3.2.1 Service Loader Mechanismus +

+

+ Diese Variante sieht vor, dass jedes Modul (d.h. jede JAR-Datei) eine Datei META-INF/services/at.gv.egovernment.moa.id.auth.modules.AuthModule + enhält, das die vorhandenen AuthModule-Implementierungen auflistet: +

+ 
at.gv.egovernment.moa.id.auth.modules.internal.DefaultAuthModuleImpl
+at.gv.egovernment.moa.id.auth.modules.mymodule.MyAuthModuleImpl
+

+ Nähere Informationen zu diesem Mechanismus können hier entnommen werden: + Javadoc ServiceLoader bzw. Java Tutorials: Creating Extensible Applications +

+ +

+ 3.2.2 Spring Bean Discovery +

+

+ Für den Fall, dass Module auf Basis des Spring Frameworks entwickelt werden, kann die AuthModule-Implementierung auch als Spring Bean erfolgen. +

+

+ MOA-ID sucht beim Starten im Classpath nach Bean-Definitionen, die der Dateinamenskonvention *.authmodule.beans.xml + entsprechen und importiert diese. Über diesen Mechanismus können modulspezifische Spring Beans geladen bzw. initialisiert werden, u.a. auch AuthModule-Beans.
  +

+

Beispiel: STORK.authmodule.beans.xml
 

+ +
<?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:context="http://www.springframework.org/schema/context" + xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> + + <context:annotation-config /> + + <bean id="storkAuthModule" class="at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl"> + <property name="priority" value="0" /> + </bean> + +</beans> +
+

 

+ +

+ 4 Hinweise +

+

+ Um einzelne Funktionen als Plug-In umzusetzen, muss nicht unbedingt ein ganzer Prozess definiert werden. MOA-ID ab + Version 2.2 unterstützt die Servlet 3.0 API, was u.a. den Einsatz von @WebServlet-Annotations ermöglicht. + Damit entfällt eine statische Registrierung von Servlets im web.xml. +

+

Am Beispiel des MonitoringServlets (at.gv.egovernment.moa.id.auth.servlet.MonitoringServlet), das als + separates JAR (moa-id-module-monitoring-xy.jar) ausgeführt wurde, kann dies anschaulich beobachtet werden. + +

 

+

 

+ + diff --git a/id/server/doc/handbook_v4/protocol/Assertion.xml b/id/server/doc/handbook_v4/protocol/Assertion.xml new file mode 100644 index 000000000..2654f2e80 --- /dev/null +++ b/id/server/doc/handbook_v4/protocol/Assertion.xml @@ -0,0 +1,81 @@ + + + https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata + + + + + + + + + + + + + fCE31ZeXZybQLOuNQBePLjFrCtKdvCmeyJ1tUW/ghtA= + + + vUFR3YPk5wiBJnrLh6Er7V46FNDMuB5Jcu73Rw7tipgr+bnV0reRNcZ5TGT+VMjNhtKJMcqgjrQWJ6tACe1r0mzhpRSVQkw7yFkTvIhQHX1a08yqJ4yy3qiN13ctDo4VgP9qHUim7b797oOKNhRXFk+2GJA5hRcpRliUjhBlzTYrxpkY5NcYDRhDPlvMx+l11oa1iDGuAylN+ty4h3P4fIoIgL9Tz1m3l65LqkV5RBc6avSeHw9OASMigPsjd5b0IBvhvJ611xLgzC1BOtJshiw1k/p8alv8TaUmYZ/kJbRN1tuTBL129edbS0Rz0faT0tniF42QHteJ214brK3rCg== + + + + xRE83dJy1dj+KVBp5Syo91fjGeG1MmJDSuTZ5MwdDzvIZrbK3YPh0jbJz4lOSrw9urRacavZX4m2 +XAKfSRxaowP3GqTh3Ew4WJE7yXEnWiic7bUz8uMIr020bsvqHCvY48+oPARbz/cEOf5NgMBWqo9E +nibdIyU5+AmfFzDaMwNocJEANoXrjLTpduCHvT0Qt/wH+7rVdgjX1djMrBhyMWs7GQyIBRfuf58m +8kdcoiMSm9AWA4d4GzXch+bi1QRzj+Ib80DeWdcXP3Hc6pcyp/+L+hya2jZ9NMS8yup6xuoAeh7w +6JNpfE9QnO3/CPrDZTtmjPK2OIRkhgn4Yi+iBQ== + AQAB + + + + + + + + + https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata + + QVGm48cqcM4UcyhDTNGYmVdrIoY= + + + + + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + + http://www.stork.gov.eu/1.0/citizenQAALevel/4 + + + + + 2.1 + + + Mustermann + + + Max + + + 1940-01-01 + + + BF:QVGm48cqcM4UcyhDTNGYmVdrIoY= + + + 4 + + + AT + + + urn:publicid:gv.at:cdid+BF + + + + diff --git a/id/server/doc/handbook_v4/protocol/AuthRequest.xml b/id/server/doc/handbook_v4/protocol/AuthRequest.xml new file mode 100644 index 000000000..f9de11c4c --- /dev/null +++ b/id/server/doc/handbook_v4/protocol/AuthRequest.xml @@ -0,0 +1,38 @@ + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + + + + + + + + sBVJQf9b+QIxRfH8YuTbF6hBrf4= + + + JK68H5XqmD2OEA8O/UCZFenVj0TrvauPhaKJt73pbHbi//hO1hBcRQbV2Qg3gQ11EcJ9Q+TM3TCe9nT6tdU/z7ry3qdZvlOfrkMF13fY4HOIuvB9AcySdxq2yKA3V5O9sLhf5S9qCyx9lMnTARC7wkVs4j2Pv00R6P/iROOHD5ryGF2J0FdtMp9VqhvQJ9yRGM2lTduF98MqxWA2EMk6AMo7qij0Bvha1B2OyFSU9HM3fyfRQpXDeiLnKHcjLpzu5TDNkKrP75c7vv85DDr7s2I0p74nAOVLMuLau5tEQ91Crk9QoqoqqEecKWcNJDXTO9MahCQw77hUDL1WOEMFFg== + + + + nEPzKMh3TovnfBnTyv+TMYFsGep8Uil7iNbfVyfLoBfqRdeGDOk4es2qWkgB6az+kM/9Js2H06m4 +pjEY7/RIjd0lMWqgi8eqdjilMmbFQykkYYQhlZbvi8KqoBcCKzj5N3GY4qh8A5qN4y85Q3sZj23T +iiIY1rphE+ZTOHCm6CKeRso9jj409YHP1xAXfPvtIYx2TA1uuagxOmL75OC/hr7gcUm0tmuKiSeq ++TO4VZw2Q7K7YESZ1WkiBoG2i4cHdcBFKnVrGNtyxl6UkjWxXRJSU9aNLs5QxsE6iFwCvFoIO+IU +cVWxfFHqOGbRtAcRUb4fk+KFHE2o1DLmfwZaUQ== + AQAB + + + + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + http://www.stork.gov.eu/1.0/citizenQAALevel/4 + + diff --git a/id/server/doc/handbook_v4/protocol/idp_metadata.xml b/id/server/doc/handbook_v4/protocol/idp_metadata.xml new file mode 100644 index 000000000..ffc15d461 --- /dev/null +++ b/id/server/doc/handbook_v4/protocol/idp_metadata.xml @@ -0,0 +1,188 @@ + + + + + + + + + + + + IjxuoZphYVmZdZ5HfoVDr35r2b1V840+SMeC89IO/SQ= + + + JILQKKPvsK7onsMweJauAcGEniFGJ5bXEOvfYhxAYCB+dXL6pH87USD1v9UqycllBDqQE/Rp2tPtqo11CjdcKs0KkceQCZjzmDlVPqMZrgh0FerTSysF0fcPKoKeAtqqk+WSu7Xk9lU+PCxGArGA+vBLTRRbAOuZpE7ORrS7AF2m5uaO1YOKfO0GN+LoxTiygI2aeqKsKMlPkboh4ZuEjv1ht9xUHeQtAf/MHtaXZDvaRQPXALf0oCRnDWpiiqvKdARJq5NXrrbrdow/M1FpoddtE0Mu65AsorIdXoPSXJnLhw/zDfHv82PQo0pW7ujc0yJY+5VzfURMZOyKmrfCmg== + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + + + EGIZ + E-Government Innovationszentrum + http://www.egiz.gv.at + + + E-Government Innovationszentrum + Lenz + Thomas + thomas.lenz@egiz.gv.at + +43 316 873 5525 + + + diff --git a/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png b/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png new file mode 100644 index 000000000..2faff33ed Binary files /dev/null and b/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png differ diff --git a/id/server/doc/handbook_v4/protocol/protocol.html b/id/server/doc/handbook_v4/protocol/protocol.html new file mode 100644 index 000000000..73465d55b --- /dev/null +++ b/id/server/doc/handbook_v4/protocol/protocol.html @@ -0,0 +1,756 @@ + + + + + MOA-ID - Protokolle + + + + +
+
+ +

MOA-ID

 +
+
+
+ +
+

Protokolle

+ +

Inhalt

+
    +
  1. Allgemeines +
      +
    1. Übersicht der Zugangspunkte
      2. +
    2. Übersicht der möglichen Attribute
      3. +
    3. Übersicht der möglichen MOA-ID spezifischen Statuscodes +
        +
      1. Statuscodes 1xxxx
        2. +
      2. Statuscodes 4xxxx
        3. +
      3. Statuscodes 6xxxx
        4. +
      4. Statuscodes 9xxxx
      4. +
    +
    2. +
  2. SAML 1 +
      +
    1. Ablauf einer Anmeldung mittels SAML 1
      2. +
    2. Zugangspunkte
      3. +
    3. StartAuthentication Request
      4. +
    4. GetAuthenticationData Request
      5. +
    +
    3. + +
  3. Referenzierte Spezifikation
    4. +
+ +

1 Allgemeines

+

Dieses Kapitel behandelt jene Authentifizierungsprotokolle die vom Modul MOA-ID-Auth unterstützt werden. + Wobei die Verwendung der Protokolle PVP 2.1 oder OpenID Connect empfohlen wird. Das Protokoll SAML 1, welches bis zur MOA-ID Version 1.5.1 + verwendet wurde, wird jedoch ab der Version 2.0 nur mehr aus Kompatibilitätsgründen angeboten und nicht mehr aktiv weiterentwickelt.

+

1.1 Übersicht der Zugangspunkte

+

In diesem Abschnitt sind die Zugangspunkte der vom Modul MOA-ID-Auth unterstützten Protokolle kurz zusammengefasst. Eine detaillierte Beschreibung der einzelnen Protokolle finden Sie in den anschließenden Unterkapiteln.

+ + + + + + + + + + + + + + + + +
ProtokollRequesttypURL
SAML 1Authentifizierungsrequest

https://<host>:<port>/moa-id-auth/StartAuthentication

SAML 1

GetAuthenticationData

https://<host>:<port>/moa-id-auth/services/GetAuthenticationData

+

http://<host>:<port>/moa-id-auth/services/GetAuthenticationData

+

1.2 Übersicht der möglichen Attribute

+

Die nachfolgende Tabelle beinhaltet eine Liste aller Attribute die vom Modul MOA-ID-Auth an die Online-Applikation zurückgeliefert werden können, sofern diese nach der Authentifizierung zur Verfügung stehen. Alle Namen beziehen sich auf den Attributnamen im jeweiligen Protokoll. Detailinformationen zu den einzelnen Attributen finden Sie in der PVP 2.1 Spezifikation der der STORK Spezifikation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProtokolleBeschreibung
PVP 2.2OpenID ConnectSAML 1
NameProfil
urn:oid:1.2.40.0.10.2.1.1.149BPKeID

/saml:Assertion/saml:AttributeStatement/

+

saml:Subject/saml:NameIdentifier

Bereichsspezifisches Personenkennzeichen (bPK / wbPK)

+

Hinweis: Der Syntax für dieses Attribut bei den Protokollen PVP 2.1 und OpenID Connect ist bPK-value := (BEREICH ":" bPK/wbPK) wobei unter Bereich der öffentliche Bereich (Target) der Online-Applikation oder die Stammzahl des Auftraggebers bei Anwendungs-verantwortlichen aus der Privatwirtschaft angegeben wird.

urn:oid:2.5.4.42

given_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname

urn:oid:1.2.40.0.10.2.1.1.261.20

family_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Familienname
urn:oid:1.2.40.0.10.2.1.1.55birthdateprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum im Format JJJJ-MM-TT
urn:oid:1.2.40.0.10.2.1.1.261.64EID-CCS-URLeID<saml:Attribute AttributeName="bkuURL" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">URL auf die Bürgerkartenumgebung die für die Authentifizierung verwendet wurde. Im Falle einer Anmeldung mittels STORK steht dieses Attribut NICHT zur Verfügung.
urn:oid:1.2.40.0.10.2.1.1.261.94EID-CITIZEN-QAA-LEVELeID Authentifizierungslevel des Bürgers
urn:oid:1.2.40.0.10.2.1.1.261.32EID-ISSUING-NATIONeID<saml:Attribute AttributeName="EID-ISSUING-NATION" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Landescode gem. ISO-3166 ALPHA-2
urn:oid:1.2.40.0.10.2.1.1.261.34EID-SECTOR-FOR-IDENTIFIEReID Bereich für den die bPK / wbPK berechnet wurde.
urn:oid:1.2.40.0.10.2.1.1.261.66EID-SIGNER-CERTIFICATEeID<saml:Attribute AttributeName="SignerCertificate" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Base64 kodiertes Zertifikat, dass für die Anmeldung verwendet wurde.
urn:oid:1.2.40.0.10.2.1.1.261.22ENC-BPK-LISTeID<saml:Attribute AttributeName="ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs für andere Bereiche als der Lebensbereich der Online Applikation
urn:oid:1.2.40.0.10.2.1.1.261.28BPK-LISTeID_gov<saml:Attribute AttributeName="BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs für andere Bereiche als der Lebensbereich der Online Applikation
urn:oid:1.2.40.0.10.2.1.1.261.39EID-ONLINE-IDENTITY-LINKeID_gov<saml:Attribute AttributeName="EID-ONLINE-IDENTITY-LINK" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Online Personenbindung des E-ID
urn:oid:1.2.40.0.10.2.1.1.261.109EID-IDENTITY-STATUS-LEVELeID_gov<saml:Attribute AttributeName="EID-IDENTITY-STATUS-LEVEL" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Kennzeichnet den Status der zusätzlich zu diesem Attribut übertragenen Identitätsdaten.
urn:oid:1.2.40.0.10.2.1.1.261.106MANDATE-TYPE-OIDmandate Bezeichnung als OID des verwendeten Vollmachten-Profils
urn:oid:1.2.40.0.10.2.1.1.261.68MANDATE-TYPEmandate<saml:Attribute AttributeName="RepresentationType" AttributeNamespace="http://reference.e-government.gv.at/namespace/mandates/20040701#">Bezeichnung des verwendeten Vollmachten-Profils.
urn:oid:1.2.40.0.10.2.1.1.261.76MANDATOR-LEGAL-PERSON-SOURCE-PIN-TYPEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Gibt an, um welche Art der Stammzahl einer vertretenen juristischen Person es sich handelt.
urn:oid:1.2.40.0.10.2.1.1.261.100MANDATOR-LEGAL-PERSON-SOURCE-PINmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Stammzahl der juristischen Person, für die Vollmachts- bzw. Vertretungsbe-fugnisse ausgeübt werden.
urn:oid:1.2.40.0.10.2.1.1.261.98MANDATOR-NATURAL-PERSON-BPKmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Bereichsspezifisches Personenkennzeichen des Vollmachtgebers
urn:oid:1.2.40.0.10.2.1.1.261.72MANDATOR-NATURAL-PERSON-ENC-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
urn:oid:1.2.40.0.10.2.1.1.261.73MANDATOR-NATURAL-PERSON-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
urn:oid:1.2.40.0.10.2.1.1.261.78MANDATOR-NATURAL-PERSON-GIVEN-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname(n) der natürlichen Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
urn:oid:1.2.40.0.10.2.1.1.261.80MANDATOR-NATURAL-PERSON-FAMILY-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Nachname der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
urn:oid:1.2.40.0.10.2.1.1.261.82MANDATOR-NATURAL-PERSON-BIRTHDATEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird im Format JJJJ-MM-TT
urn:oid:1.2.40.0.10.2.1.1.261.84MANDATOR-LEGAL-PERSON-FULL-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Name der juristischen Person bzw. Personenmehrheit gemäß zugrundeliegendem Register.
urn:oid:1.2.40.0.10.2.1.1.261.86MANDATE-PROF-REP-OIDmandate<saml:Attribute AttributeName="OID" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Object Identifiern (OID) zur Kennzeichnung von berufsmäßigen ParteienvertreterInnen bzw. OrganwalterInnen.
urn:oid:1.2.40.0.10.2.1.1.261.88MANDATE-PROF-REP-DESCRIPTIONmandate<saml:Attribute AttributeName="OIDTextualDescription" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Textuelle Beschreibung der Eigenschaft als berufsmäßiger ParteienvertreterIn.
urn:oid:1.2.40.0.10.2.1.1.261.90MANDATE-REFERENCE-VALUEmandate<saml:Attribute AttributeName="mandateReferenceValue" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Die im Rahmen einer elektronischen Vollmachtserstellung generierte Transaktionsnummer.
+

1.3 Übersicht der möglichen MOA-ID spezifischen Statuscodes

+

Vom Modul MOA-ID-Auth werden verschiedene Authentifizierungsprotokolle wobei diese Protokolle die Fehlerrückgabe unterschiedlich spezifizieren. Zusätzlich zu den protokollabhängigen Statuscodes (siehe Spezifikation des jeweiligen Protokolls) werden zusätzliche protokollunabhängige Statuscodes an den Service Provider zurückgeliefert, wobei sich das Format der Fehlerrückgabe jedoch weiterhin protokollspezifisch ist.

+

Die nachfolgende Tabelle zeigt alle protokollunabhängigen Statuscodes welche vom Modul MOA-ID-Auth zurückgeliefert werden können.

+

1.3.1 Statuscodes 1xxxx

+

Alle Statuscodes beginnend mit der Zahl eins beschreiben Fehler welche während des Identifizierungs- und Authentifizierungsvorgangs aufgetreten sind.

+
1.3.1.1 Authentifizierung (10xxx)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatuscodeBeschreibung
1000Anmeldung an der angeforderten Online-Applikation wird nicht unterstützt.
1001Es ist bereits eine Anmeldung im Gange.
1002Fehlerhafter Parameter
1003Anfrage nur über https möglich
1004Zertifikat konnte nicht ausgelesen werden
1005Die Authentifizierung wurde durch den Benutzer abgebrochen
1006Vollmachtsmodus für nicht-öffentlichen Bereich wird nicht unterstützt.
1007Vollmachtsmodus für ausländische Personen wird nicht unterstützt.
1008Es konnten nicht alle minimal erforderlichen Identifikations- oder Authentifikationsmerkmale ermittelt werden.
+
1.3.1.2 Validierung (11xxx)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatuscodeBeschreibung
1100Ungültige MOA SessionID
1101Fehler beim Parsen eines Parameters
1102Fehler beim Validieren der Personenbindung
1103Signatur ungültig
1104Zertifikat der Personenbindung ungültig
1105Zertifikat der Signatur ungültig
1106Fehler beim Validieren des AuthBlocks
1107Fehler beim Validieren eines SSL-Server-Endzertifikates
1108Fehler beim Validieren der Online Vollmacht.
1109Fehler beim Validieren der SZR-Gateway Response
1110Ungültige Single Sign-On Session
1111Der Anmeldevorgang wurde automatisiert abgebrochten da dem Benutzer die nötigen Zugriffsrechte für diese Online Applikation fehlen.
+
 
+

1.3.2 Statuscodes 4xxxx

+

Alles Statuscodes beginnend mit der Zahl vier beschreiben Fehler die während der Kommunikation mit externen Services aufgetreten sind.

+
1.3.2.1 BKU (40xxxx)
+

Tritt während des Anmeldevorgangs in der Bürgerkartenumgebung ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Bürgerkartenumgebungsfehler weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus zwei Dezimalstellen, kennzeichnet den Fehler als Fehler als Bürgerkartenumgebungsfehler. Der zweite Teil, bestehend aus vier Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus der Bürgerkartenumgebung (siehe SecurityLayer Spezifikation).

+

{40}{xxxxx}

+
+

{40} ... MOA-ID Statuscode für Fehler aus der Bürgerkartenumgebung

+

{xxxx} .... Fehlercode der Bürgerkartenumgebung.

+
+
1.3.2.2 MIS (41xxxx)
+

Tritt während der Kommunikation mit dem Online-Vollmachten Service oder der Vollmachtsauswahl ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Fehler aus dem Online-Vollmachten Service weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus drei Dezimalstellen, kennzeichnet den Fehler als Fehler als Online-Vollmachten Service Fehler. Der zweite Teil, bestehend aus drei Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus dem Online-Vollmachten Service (siehe Online-Vollmachten Spezifikation).

+

{411}{xxxx}

+
+

{411} ... MOA-ID Statuscode für Fehler aus dem Online-Vollmachten Service.

+

{xxx} .... Fehlercode des Online-Vollmachten Service.

+
+

Zusätzlich zu den gemappten Fehlern aus dem Online-Vollmachen Service werden zusätzliche weitere Fehlercodes definiert.

+ + + + + + + + + + + + + +
StatuscodeBeschreibung
41000Das Online-Vollmachten Service ist nicht erreichbar
41001Allgemeiner Fehler bei der Kommunikation mit dem Online-Vollmachten Service
+
1.3.2.3 SZR-Gateway (42xxx)
+ + + + + + + + + + + + + +
StatuscodeBeschreibung
4200Das SZR-Gateway Service ist nicht erreichbar
4201Die Antragung in das SZR ist fehlgeschlagen
+
1.3.2.4 MOA SP/SS(43xxx)
+ + + + + + + + + +
StatuscodeBeschreibung
4300Fehler beim Aufruf von MOA SP/SS
+
1.3.2.5 Interfederation (44xx)
+ + + + + + + + + + + + + +
StatuscodeBeschreibung
4400Fehler beim Generieren der Anmeldedaten
4401Die Verwendung des angeforderten federated IDP ist nicht erlaubt
+
1.3.2.6 Attributprovider (45xx)
+ + + + + + + + + + + + + + + + + + + + + +
StatuscodeBeschreibung
4500Der Zugriff auf einen Attributprovider ist nicht erlaubt
4501Die Requestgenerierung für den Zugriff auf den Attributprovider schlug fehl
4502Die Response vom Attributeprovider ist ungültig oder nicht errlaubt
4503Die Response vom Attributeprovider beinhaltet einen Fehlercode
+

1.3.3 Statuscodes 6xxxx

+

Alles Statuscodes beginnend mit der Zahl sechs beschreiben protokollspezifische Fehler die nicht durch das jeweilige Authentifizierungsprotokoll abgebildet werden.

+
1.3.3.1 Allgemein (61xxx)
+ + + + + + + + + + + + + +
StatuscodeBeschreibung
6000Das Authentifizierungsprotokoll wurde nicht erkannt oder wird nicht unterstützt
6001Der STORK Request wurde nicht erkannt oder wird nicht unterstützt
+
1.3.3.4 SAML 1(63xxx)
+ + + + + + + + + +
StatuscodeBeschreibung
6300Fehlerhaftes SAML Artifact Format
+

1.3.4 Statuscodes 9xxxx

+

Alles Statuscodes beginnend mit der Zahl neun beschreiben interne Serverfehler.

+
1.3.4.1 Konfigurationsfehler (90xxx)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatuscodeBeschreibung
9000Fehlerhaftes BKU-Selection Template
9001Fehlerhaftes Send-Assertion Template
9002Fehlerhaftes SecurityLayer Template.
9003Fehlerhafte STORK VIDP Konfiguration
9004Fehlerhafte STORK Konfiguration
9005Fehlerhafte OpenID Connect Konfiguration
9006Es sind keine Vollmachtsprofile konfiguriert.
9007Der SZR-Gateway Client konnte nicht initialisiert werden.
9008Fehler beim Verarbeiten eines Konfigurationsparameters.
9099Allgemeiner Konfigurationsfehler
+
1.3.4.2 Interne Fehler (91xxx)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StatuscodeBeschreibung
9100Fehler beim Einlesen einer externen Ressource.
9101Datenbankzugriffsfehler
9102Fehler beim Erzeugen einer internen Datenstruktur
9103Fehler bei der Verarbeitung eines Templates
9104Fehler bei der Auswahl oder Initialisierung des gewünschten Anmeldeprozesses
9105Fehler bei der Fortführung des Anmeldeprozesses
9199Allgemeiner interner Fehler
+

 

+

3 SAML 1

+

SAML 1 wird durch MOA-ID-Auth 2.0 auch weiterhin, aus Gründen der Abwärtskompatibilität, als Authentifizierungsprotokoll unterstützt. Es wird jedoch der Umstieg auf ein aktuelles Authentifizierungsprotokoll wie PVP 2.1 oder OpenID Connect empfohlen.

+

Die nachfolgenden Abschnitte beschreiben den Anmeldevorgang unter Verwendung von SAML1 wobei die Funktionalität, wie sie aus MOA-ID <= 1.5.1 bekannt ist, auch weiterhin unterstützt wird (Bürgerkartenauswahl auf Seiten des Service Provider). Zusätzlich steht für SAML 1 jedoch auch die Funktionalität der automatischen Generierung der Bürgerkartenauswahl durch das Modul MOA-ID-Auth zur Verfügung.

+

3.1 Ablauf einer Anmeldung mittels SAML 1

+

Die nachfolgende Abbildung zeigt das Sequenzdiagramm eines Anmeldevorgangs mittels SAML 1 und des Modules MOA-ID-Auth als Identity Provider. Hierbei wird die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl beim Service Provider verwenden. Aus Gründen der Übersichtlichkeit wurden die Teile welche die Kommunikation mit der Bürgerkartenumgebung oder die Vollmachten-Auswahl betreffen bewusst nicht berücksichtigt.

+

Sequenzdiagramm für SAML 1

+
    +
  1. Der Benutzer verbindet sich zu einem Web-Portal (Service Provider) über das die Online-Applikation erreichbar ist.
    2. +
  2. Der Service Provider antwortet mit einer öffentlichen Portalseite welche einen Login Bereich mit Bürgerkartenauswahl beinhaltet.
    3. +
  3. Nach Auswahl der gewünschten Authentifizierungsmethode (Bürgerkarte oder Handy-Signatur) wird der Anmeldevorgang ausgelöst und der StartAuthentication Request wird an das Modul MOA-ID-Auth gesendet.
    4. +
  4. MOA-ID-Auth validiert den StartAuthentication Request. Ist die Validierung erfolgreich wird der Anmeldevorgang vorgesetzt.
    5. +
  5. Die Benutzerin oder der Benutzer wird zur gewählten Bürgerkartenumgebung weitergeleitet. +
      +
    1. Die Benutzerin oder der Benutzer Authentifiziert sich mit der gewählten Methode.
      2. +
    +
    6. +
  6. War die Authentifizierung der Benutzerin oder des Benutzers erfolgreich generiert MOA-ID-Auth die Assertion mit den Anmeldedaten des Benutzers.
    7. +
  7. MOA-ID-Auth senden das SAML 1 Artifact, welches zur Abholung der Assertion verwendet werden kann, über den Browser an den Service Provider.
    8. +
  8. Der Service Provider stellt einen GetAuthenticationData Request an MOA-ID-Auth unter Verwendung des zuvor übermittelten Artifacts.
    9. +
  9. MOA-ID-Auth validiert das Artifact. Ist die Validierung erfolgreich antwortet MOA-ID-Auth mit der SAML 1 Assertion, welche die Anmeldedaten beinhaltet.
    10. +
  10. Der Service Provider verarbeitet die Assertion und danach ist der Benutzer an der Online-Applikation angemeldet.
    11. +
+

3.2 Zugangspunkte

+

Zur Verwendung von SAML 1 stellt das Modul MOA-ID-Auth zwei Zugangspunkte zur Kommunikation mit der Online-Applikation (Service Provider) zur Verfügung. Diese Zugangspunkte bezeichnen die URLs unter welchen das Modul MOA-ID-Auth die entsprechenden SAML1 Nachrichten entgegennimmt.

+ +

3.3 StartAuthentication Request

+

MOA-ID-Auth wird immer durch eine andere (verweisende) Webseite aufgerufen. Diese Webseite kann z.B. Teil eines Portals sein. Der Aufruf erfolgt durch einen Verweis der Form, wobei die Parameter sowohl als http GET als auch als http POST an MOA-ID-Auth übergeben werden können.

+
<a href="https://<moa-id-server-und-pfad>/StartAuthentication
+  ?Target=<geschäftsbereich>  
+  &OA=<oa-url>
+	&bkuURI=<bku-url>
+  &Template=<template-url>
+	&useMandate=false
+  &CCC=<ccc>">
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeispielwertBeschreibung
<moa-id-server-und-pfad>https://demo.egiz.gv.at/
+ demoportal_moaid-2.0/

Server und Pfad, wo MOA-ID-AUTH installiert ist

Target=<geschäftsbereich>BF

Angabe, für welches Verfahren (öffentlicher Bereich) der Benutzer authentisiert werden soll. Dieser Parameter wird jedoch durch den in entsprechenden Parameter in der online-applikationsspezifischen Konfiguration überschrieben.

OA=<oa-url>https://demo.egiz.gv.at/demoportal-demologin/securearea.actionWebseite, auf die der Browser nach erfolgter Authentisierung weitergeleitet werden soll
bkuURI=<bku-url>https://127.0.0.1:3496/https-security-layer-request

URL auf die Bürgerkartenumgebung, welche für die Authentifizierung der Benutzerin oder des Benutzers verwendet werden soll.

+

Hinweis: Wird dieser Parameter nicht übertragen, antwortet das Modul MOA-ID-Auth mit einem bei MOA-ID-Auth hinterlegten Bürgerkartentemplate.

Template=<template-url>https://demo.egiz.gv.at/moa-id-auth/template_onlineBKU.htmlOptional: URL auf die HTML Vorlage für den Security-Layer Request, welcher für die Kommunikation mit der Bürgerkartenumgebung verwendet wird. Die URL muss in der online-applikationsspezifischen Konfiguration von MOA-ID-Auth hinterlegt werden (siehe Parameter SecurityLayerTemplates).
+ Ist dieser Parameter nicht vorhanden, verwendet MOA-ID-Auth das für diese Online-Applikation hinterlegten Security-Layer Template (siehe Parameter SecurityLayerTemplates).
useMandate=<true/false>true / falseOptional: Gibt an ob eine Anmeldung im Online-Vollmachten-Modus durchgeführt werden soll (=true) oder nicht (=false);
CCC=<ccc>BE, SI, Optional: Gibt an ob die Anmeldung mittels STORK im angegebenen Land erfolgen soll. Die Angabe erfolgt mit dem Ländercode (Bsp: PT, LU, ES, ...) des jeweiligen Landes.
sourceID=<xxxxxxx>abcdef141245Optional: Die sourceID fließt in die Generierung des SAML1 Artifacts, welches an den Service Provider returniert wird, ein. Detailinformationen zur Generierung des SAML1 Artifacts und zur sourceID finden Sie in der SAML1 Spezifikation.
+

3.4 GetAuthenticationData Request

+

Nach erfolgter Authentisierung stehen in MOA-ID-AUTH Anmeldedaten zum Abholen bereit, und MOA-ID-AUTH veranlasst einen Redirect zur Online-Applikation (OA).
+
+In diesem Redirect werden der Geschäftsbereich und ein SAML-Artifact als Parameter übergeben.

+
<a href="https://<oa-url>?Target=<geschäftsbereich>&SAMLArtifact=<saml-artifact>">
+ + + + + + + + + + + + + + + +
oa-url>URL, der beim Aufruf von MOA-ID-AUTH als Parameter "OA" übergeben wurde
Target=<geschäftsbereich>Parameter, der beim Aufruf von MOA-ID-AUTH übergeben wurde
SAMLArtifact=<saml-artifact>SAML-Artifact, das von MOA-ID-AUTH zu den Anmeldedaten erstellt wurde. Mithilfe dieses SAML-Artifacts kann die OA die Anmeldedaten von MOA-ID-AUTH abholen.
+

 

+

Der Service Provider kann anschließend die Assertion, welche die Anmeldedaten oder eine Fehlermeldung beinhaltet, unter Verwendung des SAMLArtifact, am Modul MOA-ID-Auth abholen.

+

Das MOA-ID-AUTH Web Service wird über einen <samlp:Request> aufgerufen. Der <samlp:Request> enthält in einem <samlp:AssertionArtifact> das von MOA-ID-AUTH übergebene SAML-Artifact.
+
+MOA-ID-AUTH liefert als Antwort einen <samlp:Response>. Die Anmeldedaten sind im <samlp:Response> in Form einer <saml:Assertion> enthalten.
+Sollte während des Anmeldevorgangs ein Fehler aufgetreten sein, antwortet das Modul MOA-ID-Auth mit einer Fehlerbeschreibung in der SAML Response. Das Element /samlp:Response/samlp:Status/samlp:StatusCode/ beinhaltet auf jeden Fall einen allgemeinen Fehlercode laut SAML1 Spezifikation. Zusätzlich kann das Element /samlp:Response/samlp:Status/samlp:StatusCode/samlp:StatusCode/einen MOA-ID-Auth Fehlercode (siehe Kapitel 1.3) beinhalten. Außerdem erfolgt eine kurze textuelle Fehlerbeschreibung im Element /samlp:Response/samlp:Status/samlp:StatusMessage/.

+ +

Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.4 beschrieben.

+

A Referenzierte Spezifikation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SpezifikationLink

Security Layer Spezifikation V1.2.0

http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
Online-Vollmachten Spezifikation http://reference.e-government.gv.at/AG-II-Architektur-mis-1-1-0.2890.0.html
PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
OpenID Connecthttp://openid.net/connect/
STORK 2@TODO Link
Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
+
+ + diff --git a/id/server/doc/handbook_v4/protocol/pvp21_sequence.png b/id/server/doc/handbook_v4/protocol/pvp21_sequence.png new file mode 100644 index 000000000..c915531cc Binary files /dev/null and b/id/server/doc/handbook_v4/protocol/pvp21_sequence.png differ diff --git a/id/server/doc/handbook_v4/protocol/saml1_sequence.png b/id/server/doc/handbook_v4/protocol/saml1_sequence.png new file mode 100644 index 000000000..e863d74c1 Binary files /dev/null and b/id/server/doc/handbook_v4/protocol/saml1_sequence.png differ diff --git a/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml b/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml new file mode 100644 index 000000000..15e26469c --- /dev/null +++ b/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml @@ -0,0 +1,95 @@ + + + + + + + + + + + + + xLFVU7fH3+IC84vAuSZTP7+oeGk= + + + d1GD51DilpbwQdL9BONrhQS9zeydpWw8r/DKp/k5nLDQ6Tpw+OQgqYWvsMcnMgrltJa/4Q326fEf6HdFbLfrHSij8Nfx8i2idJ9JUwpj1R2GE0eo+8NXvJ/1H9Nf0pPjZ35MXQ9bC2fN/HnPalRaJSd9gCk/hW/KtB0r4qODkppz0hHplIKs7kqDnzd7ZT7golGI801N6DwzJ3jW8U26OOhzXtCbTsDdZE5gvA34kH5EDaa9RMx2JIPqBjzvDAE7oylKg2VcQdpJ1xLEi3zOF2kvgTLi6+CLHbQDc1JKcWJ10FC9yATT7poHJOgjoZ8Vt5QZJ12PKJ1NnopwcsvJ4g== + + + + + + + MIIDhTCCAm2gAwIBAgIEUflpdjANBgkqhkiG9w0BAQsFADBzMRAwDgYDVQQGEwdVbmtub3duMRAw +DgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdVbmtub3duMRAwDgYD +VQQLEwdVbmtub3duMRcwFQYDVQQDEw5QVlAgU2FtcGxlIElEUDAeFw0xMzA1MDIwODE5MDlaFw0x +MzA3MzEwODE5MDlaMHMxEDAOBgNVBAYTB1Vua25vd24xEDAOBgNVBAgTB1Vua25vd24xEDAOBgNV +BAcTB1Vua25vd24xEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xFzAVBgNVBAMT +DlBWUCBTYW1wbGUgSURQMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWrWy07+hO2V +oMeOHpizN3qU2cL2e3EkzAkowmG+OpsR3UpI0dvolRuzaxDPUeANfE913KPempsT3cOKGS5IIBmx +PgZM1H7EcEPVS2PYimMr1HztBMJMGAdFVFeVFsgdYP4cbwPUs03/E6kVmN7/C+vMyRPMD7i83YL8 +/IHChymZ5aJTsRXUpM0TjQQPBQbnnHVWzjcUJ9z9KataS/KpUUM8iSWk73u/gWOs3vbQLoro80xj +LsSdXyJ9dVTCTwCpdP5UJPlsNLg1F7AU+OHwem76rezI0JJZhHUMg6v1xWzh8XycI6CizpD6RmkM +XfICbFD8TR5zcNBieH/yNQeAEwIDAQABoyEwHzAdBgNVHQ4EFgQUoLaHuWuxRrEh37oIQ0GzfDpy +h4MwDQYJKoZIhvcNAQELBQADggEBAAaAJVSji/OMCUZtSSIYM37go1+JLSamSkkftbkKmMWGBeKj +i9ndilpFY/Fbslt+lUueOyd5VawWPYorQBksyJH7glmQexMzEbwqPR8t+++Dq5+mj/XjXrYHlPej +FvCMy5kElxXczIQZmsutGtamreyAMpFMa3T2pU5tuVNwSbe754dOztaX6E92IGZtApKIHm/uLU75 +JQkTWhP9I3DaNX593VYPkeAoYxzaX1ElE2HFs4ELRzMXa0joTaGLyZ6LdLcK1bR3um9OywHWeiab +xtSAML1SoKfTcmzWCpb0yFhfOUKXyw+SikBAkiQruMK8PcboY9VFrKUSzKHBvnDC4U4= + + + + + + + MIIELTCCAxWgAwIBAgIJALF/kMqjWCxQMA0GCSqGSIb3DQEBCwUAMGwxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSowKAYDVQQD +EyFNT0EtSUQtQ29uZmlndXJhdGlvbiAoRW5jcnlwdGlvbikwHhcNMTQwMTIxMDkzMDIzWhcNMTUw +MTIxMDkzMDIzWjBsMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTENMAsGA1UEBxME +R3JhejENMAsGA1UEChMERUdJWjEqMCgGA1UEAxMhTU9BLUlELUNvbmZpZ3VyYXRpb24gKEVuY3J5 +cHRpb24pMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr+5eXUViI2d/KLqfej29BNeD +DiDzhWlpAViPconGsEDHrXFNeSd3DTuJKH6x06wrpGfvtTh91ThId0R0hthS82aaKTlW1SgX/Rps +5VlmiNXQty8/UrrnqAsIO65jbsy41EXTDVrnDbg5WmK2xsowk7d4jUE4cdk3VKu07Kzg9ZiQHz8V +WMmGGPIXVs87+wgjq68tvo3+Nk5fcKPyV4ff2oc5/muxjavGdAIDJV2E/dDHwM3fbNFXk5OAse2V +8/vmHCm0bzVOP+V5vNxp1r8myZ914WYFt0WJL4/oyyrerGK6gqGdkLcGfMutaJvBxV+hNIMGLWMc +6LjCWVARIXvHyQIDAQABo4HRMIHOMB0GA1UdDgQWBBR9aJK1JouIYwcn2ycQUsPv4Q8BaDCBngYD +VR0jBIGWMIGTgBR9aJK1JouIYwcn2ycQUsPv4Q8BaKFwpG4wbDELMAkGA1UEBhMCQVQxEzARBgNV +BAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTALBgNVBAoTBEVHSVoxKjAoBgNVBAMTIU1P +QS1JRC1Db25maWd1cmF0aW9uIChFbmNyeXB0aW9uKYIJALF/kMqjWCxQMAwGA1UdEwQFMAMBAf8w +DQYJKoZIhvcNAQELBQADggEBAFSMmGNTAhDfoadFz0SrMDLjrPGIGjanbijLTOEURZYJiB4sQxa8 +3H6FNy1zvfzmPnrdbFr15w/6KgF9YP/0/JMUalrhm1JKWBY4TqJcG2BumAUcLSdsHOsezRi5E14s +WF2sNRa8C0LkfMfCW/wBCLXPn68XhQW7MuGgpEVrRenXQ3hwSykNiKq4vfn8tg+1hKwlrM3pbQQw +7YmXUm9TnHmkvJfZJEgSiFiLUjc1HxUFNl23PGjKJ1GxDerS7pBHG23KkVZTacuKM/MjVfFeFQJ4 +8JcRJUO0HuM6O1v/1sumtq/4wrKYo5I5LZPRuEKGNFme9hi/1BQT9bK9roZlxH0= + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + Default Service + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/protocol/sso_sequence.png b/id/server/doc/handbook_v4/protocol/sso_sequence.png new file mode 100644 index 000000000..19e50100d Binary files /dev/null and b/id/server/doc/handbook_v4/protocol/sso_sequence.png differ diff --git a/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl b/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl new file mode 100644 index 000000000..d83556540 --- /dev/null +++ b/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf b/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf new file mode 100644 index 000000000..6709a4081 Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf new file mode 100644 index 000000000..1e65beca9 Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl new file mode 100644 index 000000000..4f9deee38 --- /dev/null +++ b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl @@ -0,0 +1,128 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd new file mode 100644 index 000000000..73d145ecf --- /dev/null +++ b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd @@ -0,0 +1,572 @@ + + + + + + + + + + + + + + + + + + + + Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements + + + + + + + + + + + + + + + + + + + + + + Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage + + + + Resultat, falls die Signaturerstellung erfolgreich war + + + + + + + + + + + + + + + + + + + + Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements + + + + + + + + + + + + + + + + + + + Auswahl: Entweder explizite Angabe des Signaturorts sowie ggf. sinnvoller Supplements im Zshg. mit der Signaturumgebung, oder Verweis auf ein benanntes Profil + + + + + + + + + + + + + + + + + + Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage + + + + Resultat, falls die Signaturerstellung erfolgreich war + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert + + + + + + + + + + + only ds:X509Data and RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any;publicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pro dsig:Reference-Element in der zu überprüfenden XML-Signatur muss hier ein ReferenceInfo-Element erscheinen. Die Reihenfolge der einzelnen ReferenceInfo Elemente entspricht jener der dsig:Reference Elemente in der XML-Signatur. + + + + + + + + + + mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert + + + + + + + + + + + only ds:X509Data and ds:RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any; PublicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Auswahl: Entweder explizite Angabe EINER Transformationskette inklusive ggf. sinnvoller Supplements oder Verweis auf ein benanntes Profil + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Resultat, falls die Signaturerstellung gescheitert ist + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Ein oder mehrere Transformationswege können von der Applikation an MOA mitgeteilt werden. Die zu prüfende Signatur hat zumindest einem dieser Transformationswege zu entsprechen. Die Angabe kann explizit oder als Profilbezeichner erfolgen. + + + + + Profilbezeichner für einen Transformationsweg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Die Angabe des Transformationsparameters (explizit oder als Hashwert) kann unterlassen werden, wenn die Applikation von der Unveränderlichkeit des Inhalts der in "Transformationsparamter", Attribut "URI" angegebenen URI ausgehen kann. + + + + Der Transformationsparameter explizit angegeben. + + + + + Der Hashwert des Transformationsparameters. + + + + + + + + + + + + + + + + + + + + + + Explizite Angabe des Transformationswegs + + + + + + + Alle impliziten Transformationsparameter, die zum Durchlaufen der oben angeführten Transformationskette bekannt sein müssen, müssen hier angeführt werden. Das Attribut "URI" bezeichnet den Transformationsparameter in exakt jener Weise, wie er in der zu überprüfenden Signatur gebraucht wird. + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf new file mode 100644 index 000000000..0c89c2730 Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf new file mode 100644 index 000000000..c9b0d160c Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf new file mode 100644 index 000000000..a3a2f1177 Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf new file mode 100644 index 000000000..0c923666f Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf new file mode 100644 index 000000000..ed2743d3c Binary files /dev/null and b/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf differ diff --git a/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf b/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf new file mode 100644 index 000000000..4beab3e41 Binary files /dev/null and b/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf differ diff --git a/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd b/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd new file mode 100644 index 000000000..d41f3e817 --- /dev/null +++ b/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd @@ -0,0 +1,194 @@ + + + + + + + Document identifier: cs-sstc-schema-assertion-01 + Location: http://www.oasis-open.org/committees/security/docs/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd b/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd new file mode 100644 index 000000000..d939fa732 --- /dev/null +++ b/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd @@ -0,0 +1,127 @@ + + + + + + + + Document identifier: cs-sstc-schema-protocol-01 + Location: http://www.oasis-open.org/committees/security/docs/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/htmlTemplates/BKU-selection.html b/id/server/doc/htmlTemplates/BKU-selection.html deleted file mode 100644 index 4e548e58c..000000000 --- a/id/server/doc/htmlTemplates/BKU-selection.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - - - - - -Anmeldung mittels Bürgerkarte oder Handy-Signatur - - - -
-
-

Anmeldung an: $OAName

-
-
-
-

$HEADER_TEXT

-
-
-
-
- - - -
-
-
-
- OnlineBKU - - - - -
- - - - - - -
- - - - - -
- -
- HandyBKU - -
- - -
- EULogin -
- - - - -
-
- - - - - - - - - - -
-

Anscheinend verwenden Sie Internet Explorer im - Metro-Modus. Wählen Sie bitte "Auf dem Desktop anzeigen" aus den - Optionen um die Karten-Anmeldung starten zu können.

-
-
-
-
-
-
- - diff --git a/id/server/doc/htmlTemplates/sendAssertion.html b/id/server/doc/htmlTemplates/sendAssertion.html deleted file mode 100644 index 7ae4b3f92..000000000 --- a/id/server/doc/htmlTemplates/sendAssertion.html +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - Anmeldung an Online-Applikation - - - - -
- -
- - - -
-
-
-

- Anmeldeinformationen: -

-
- -
-

Anmeldung an: $OAName

- - -
-
- - - -
-
-
-
- - - -
-
- -
-
-
-
-
- - diff --git a/id/server/doc/htmlTemplates/template_onlineBKU.html b/id/server/doc/htmlTemplates/template_onlineBKU.html deleted file mode 100644 index 928c9f17b..000000000 --- a/id/server/doc/htmlTemplates/template_onlineBKU.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - -
- Falls Sie nicht automatisch weitergeleitet werden klicken Sie bitte hier: - - - - - - - - - - - - -
- -
- - -
-
-
- - diff --git a/id/server/doc/proxy/handbook/examples/BKUSelectionTemplate.html b/id/server/doc/proxy/handbook/examples/BKUSelectionTemplate.html deleted file mode 100644 index 731cc36fd..000000000 --- a/id/server/doc/proxy/handbook/examples/BKUSelectionTemplate.html +++ /dev/null @@ -1,41 +0,0 @@ - - - -MOA ID - Auswahl der B&uuuml;rgerkartenumgebung - - - - - - - - -Organisation XY -

Auswahl der Bürgerkartenumgebung

-

-

Sie haben sich für Anmeldung mit Ihrer Bürgerkarte entschieden. Da es verschiedene Formen der Bürgerkarte gibt, müssen Sie nun wählen, welche Sie bei der Anmeldung verwenden wollen.

-

Auswahl der Bürgerkarte

-
- - - -
-

- - - - -

Hinweise:

-
    -
  • -

    Wollen Sie eine A-Trust Bürgerkarte erwerben? Hier finden Sie Informationen - dazu: A-Trust - Bürgerkarte. Bei der Anmeldung mit der A-Trust Bürgerkarte - benötigen Sie eine funktionsfähige Bürgerkartensoftware sowie - einen passenden Kartenleser.

    -
    • -
- - - - diff --git a/id/server/doc/proxy/handbook/examples/ChainingModes.txt b/id/server/doc/proxy/handbook/examples/ChainingModes.txt deleted file mode 100644 index 820b60d06..000000000 --- a/id/server/doc/proxy/handbook/examples/ChainingModes.txt +++ /dev/null @@ -1,6 +0,0 @@ - - - CN=A-Trust-nQual-0,OU=A-Trust-nQual-0,O=A-Trust,C=AT - 536 - - diff --git a/id/server/doc/proxy/handbook/examples/IdentityLinkSigners.txt b/id/server/doc/proxy/handbook/examples/IdentityLinkSigners.txt deleted file mode 100644 index 15269ad79..000000000 --- a/id/server/doc/proxy/handbook/examples/IdentityLinkSigners.txt +++ /dev/null @@ -1,9 +0,0 @@ - - - - CN=zmr,OU=BMI-IV-2,O=BMI,C=AT - - T=Dr.,CN=Nikolaus Schwab,O=BM f. Inneres i.A. des gf. Mitgieds der Datenschutzkommission - - T=Dr.,CN=Nikolaus Schwab,O=BM f. Inneres i.A. des gf. Mitglieds der Datenschutzkommission - \ No newline at end of file diff --git a/id/server/doc/proxy/handbook/examples/LoginServletExample.txt b/id/server/doc/proxy/handbook/examples/LoginServletExample.txt deleted file mode 100644 index 587ef5e97..000000000 --- a/id/server/doc/proxy/handbook/examples/LoginServletExample.txt +++ /dev/null @@ -1,171 +0,0 @@ -import java.io.IOException; -import java.util.Vector; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import javax.servlet.http.HttpSession; -import javax.xml.namespace.QName; -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.rpc.Call; -import javax.xml.rpc.Service; -import javax.xml.rpc.ServiceFactory; - -import org.apache.axis.message.SOAPBodyElement; -import org.apache.xml.serialize.LineSeparator; -import org.apache.xml.serialize.OutputFormat; -import org.apache.xml.serialize.XMLSerializer; -import org.jaxen.JaxenException; -import org.jaxen.SimpleNamespaceContext; -import org.jaxen.dom.DOMXPath; -import org.w3c.dom.Attr; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; - -/** - * Beispiel für ein Login-Servlet, das von MOA-ID-AUTH über einen Redirect aufgerufen wird. - * Es werden demonstriert: - * - Parameterübergabe von MOA-ID-AUTH - * - Aufruf des MOA-ID-AUTH Web Service zum Abholen der Anmeldedaten über das Apache Axis Framework - * - Parsen der Anmeldedaten mittels der XPath Engine "Jaxen" - * - Speichern der Anmeldedaten in der HTTPSession - * - Redirect auf die eigentliche Startseite der OA - * - * @author Paul Ivancsics - */ -public class LoginServletExample extends HttpServlet { - - // Web Service QName und Endpoint - private static final QName SERVICE_QNAME = new QName("GetAuthenticationData"); - private static final String ENDPOINT = - "http://localhost:8080/moa-id-auth/services/GetAuthenticationData"; - // NamespaceContext für Jaxen - private static SimpleNamespaceContext NS_CONTEXT; - static { - NS_CONTEXT = new SimpleNamespaceContext(); - NS_CONTEXT.addNamespace("saml", "urn:oasis:names:tc:SAML:1.0:assertion"); - NS_CONTEXT.addNamespace("samlp", "urn:oasis:names:tc:SAML:1.0:protocol"); - NS_CONTEXT.addNamespace("pr", "http://reference.e-government.gv.at/namespace/persondata/20020228#"); - } - - /** - * Servlet wird von MOA-ID-AUTH nach erfolgter Authentisierung über ein Redirect aufgerufen. - */ - protected void doGet(HttpServletRequest req, HttpServletResponse resp) - throws ServletException, IOException { - - // Parameter "Target" und "SAMLArtifact" aus dem Redirect von MOA-ID-AUTH lesen - String target = req.getParameter("Target"); - String samlArtifact = req.getParameter("SAMLArtifact"); - - try { - // DOMBuilder instanzieren - DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); - factory.setNamespaceAware(true); - DocumentBuilder builder = factory.newDocumentBuilder(); - - // zusammenstellen und in einen DOM-Baum umwandeln - String samlRequest = - "" - + samlArtifact - + ""; - Document root_request = builder.parse(new ByteArrayInputStream(samlRequest.getBytes())); - - // Neues SOAPBodyElement anlegen und mit dem DOM-Baum füllen - SOAPBodyElement body = new SOAPBodyElement(root_request.getDocumentElement()); - SOAPBodyElement[] params = new SOAPBodyElement[] { body }; - - // AXIS-Service für Aufruf von MOA-ID-AUTH instanzieren - Service service = ServiceFactory.newInstance().createService(SERVICE_QNAME); - - // Axis-Call erzeugen und mit Endpoint verknüpfen - Call call = service.createCall(); - call.setTargetEndpointAddress(ENDPOINT); - - // Call aufrufen und die Antwort speichern - System.out.println("Calling MOA-ID-AUTH ..."); - Vector responses = (Vector) call.invoke(params); - - // erstes BodyElement auslesen - SOAPBodyElement response = (SOAPBodyElement) responses.get(0); - - // als DOM-Baum holen - Document responseDocument = response.getAsDocument(); - Element samlResponse = responseDocument.getDocumentElement(); - - // auf System.out ausgeben - System.out.println("Response received:"); - OutputFormat format = new OutputFormat((Document) responseDocument); - format.setLineSeparator(LineSeparator.Windows); - format.setIndenting(true); - format.setLineWidth(0); - XMLSerializer serializer = new XMLSerializer(System.out, format); - serializer.asDOMSerializer(); - serializer.serialize(responseDocument); - - // auslesen - Attr statusCodeAttr = (Attr)getNode(samlResponse, "/samlp:Response/samlp:Status/samlp:StatusCode/@Value"); - String samlStatusCode = statusCodeAttr.getValue(); - System.out.println("StatusCode: " + samlStatusCode); - - // auslesen - if ("samlp:Success".equals(samlStatusCode)) { - Element samlAssertion = (Element)getNode(samlResponse, "/samlp:Response/saml:Assertion"); - - // FamilyName aus der parsen - Node familyNameNode = getNode(samlAssertion, "//saml:AttributeStatement/saml:Attribute[@AttributeName=\"PersonData\"]/saml:AttributeValue/pr:Person/pr:Name/pr:FamilyName"); - String familyName = getText(familyNameNode); - System.out.println("Family name: " + familyName); - - // weitere Anmeldedaten aus der parsen - // ... - - // Anmeldedaten und Target in der HTTPSession speichern - HttpSession session = req.getSession(); - session.setAttribute("UserFamilyName", familyName); - session.setAttribute("Geschaeftsbereich", target); - - // weitere Anmeldedaten in der HTTPSession speichern - // ... - - // Redirect auf die eigentliche Startseite - resp.sendRedirect("/index.jsp"); - } - } - catch (Exception ex) { - ex.printStackTrace(); - } - } - /** Returns the first node matching an XPath expression. */ - private static Node getNode(Node contextNode, String xpathExpression) throws JaxenException { - DOMXPath xpath = new DOMXPath(xpathExpression); - xpath.setNamespaceContext(NS_CONTEXT); - return (Node) xpath.selectSingleNode(contextNode); - } - /** Returns the text that a node contains. */ - public static String getText(Node node) { - if (!node.hasChildNodes()) { - return ""; - } - - StringBuffer result = new StringBuffer(); - NodeList list = node.getChildNodes(); - for (int i = 0; i < list.getLength(); i++) { - Node subnode = list.item(i); - if (subnode.getNodeType() == Node.TEXT_NODE) { - result.append(subnode.getNodeValue()); - } else if (subnode.getNodeType() == Node.CDATA_SECTION_NODE) { - result.append(subnode.getNodeValue()); - } else if (subnode.getNodeType() == Node.ENTITY_REFERENCE_NODE) { - // Recurse into the subtree for text - // (and ignore comments) - result.append(getText(subnode)); - } - } - return result.toString(); - } -} diff --git a/id/server/doc/proxy/handbook/examples/SampleMOAIDVerifyInfoboxesConfiguration.xml b/id/server/doc/proxy/handbook/examples/SampleMOAIDVerifyInfoboxesConfiguration.xml deleted file mode 100644 index f31730a06..000000000 --- a/id/server/doc/proxy/handbook/examples/SampleMOAIDVerifyInfoboxesConfiguration.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - - - - - - - - - - - - MOAIDBuergerkartePersonenbindung - - - - MOAIDBuergerkarteAuthentisierungsDaten - - - MOAIDTransformAuthBlockTable_DE - - - - - - GlobalVIDefaultTrust - - - - Beispiel Infobox B - GlobalInfoboxBTrust - - - - - - content1 - content2 - - content3a - content3b - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - LocalOA1DefaultTrust - - - - Demo Infobox B - oa1.validate.InfoboxBValidator - - - - - - - - Demo Infobox C - LocalInfoboxOA1CTrust - - - - - - - - - - - - - - LocalInfoboxOA2ATrust - - - - - - - - - - - - - - - certs/ca-certs - - - - - - - - - - - - - - https://www.handy-signatur.at/mobile/https-security-layer-request/default.aspx - https://www.a-trust.at/mobile/https-security-layer-request/default.aspx - - diff --git a/id/server/doc/proxy/handbook/examples/Template.html b/id/server/doc/proxy/handbook/examples/Template.html deleted file mode 100644 index 5074f5beb..000000000 --- a/id/server/doc/proxy/handbook/examples/Template.html +++ /dev/null @@ -1,50 +0,0 @@ - - - -MOA ID - Identifizierter Zugang mit Bürgerkarte - - - -Organisation XY -

Sicherer Zugang zur Online-Anwendung mit Bürgerkarte

-

- -Der identifizierte Zugang erfolgt über die Module für Online Applikationen (MOA) unter Verwendung einer Bürgerkarte und deren Signaturfunktion. - -

-

Wenn Sie in Folge die Schaltfläche "Anmeldung mit Bürgerkarte" -aktivieren, so werden zur Signatur der Anmeldedaten aufgefordert. Wenn sie diese -signieren, so werden sie zur Online-Anwendung weitergeleitet und angemeldet.

- - -
-
- - - - - -
-
-
- - - - - -
- - - diff --git a/id/server/doc/proxy/handbook/examples/TransformsInfoAuthBlockTable_DE.xml b/id/server/doc/proxy/handbook/examples/TransformsInfoAuthBlockTable_DE.xml deleted file mode 100644 index 1165d8b32..000000000 --- a/id/server/doc/proxy/handbook/examples/TransformsInfoAuthBlockTable_DE.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - - - Signatur der Anmeldedaten - - - -

Anmeldedaten:

-

Daten zur Person

- - - - - - - - - - - - - - - - - - - - - - - - - -
Name: - -
Geburtsdatum: - - . - - . - -
Rolle: - -
Vollmacht: - Ich melde mich in Vertretung an. Im nächsten Schritt wird mir eine Liste der für mich verfügbaren Vertretungsverhältnisse angezeigt, aus denen ich eines auswählen werde. -
-

Daten zur Anwendung

- - - - - - - - - -
Name: - -
Staat:Österreich
-

Technische Parameter

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
URL: - -
Bereich: - -
- Vollmachten-Referenz: - -
- : - -
Identifikator: - - -
OID: - -
HPI: - -
Datum: - - . - - . - -
Uhrzeit: - - : - - : - -
- - - - - - - - - application/xhtml+xml - - diff --git a/id/server/doc/proxy/handbook/examples/conf/MOA-ID-Configuration.xml b/id/server/doc/proxy/handbook/examples/conf/MOA-ID-Configuration.xml deleted file mode 100644 index 2cdc61653..000000000 --- a/id/server/doc/proxy/handbook/examples/conf/MOA-ID-Configuration.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - - - - - - - - - - - - MOAIDBuergerkartePersonenbindung - - - - MOAIDBuergerkarteAuthentisierungsDaten - - - MOAIDTransformAuthBlockTable_DE - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - certs/ca-certs - - - - - - - - - - - - - - - - https://www.handy-signatur.at/mobile/https-security-layer-request/default.aspx - https://www.a-trust.at/mobile/https-security-layer-request/default.aspx - - diff --git a/id/server/doc/proxy/handbook/examples/conf/OAConfBasicAuth.xml b/id/server/doc/proxy/handbook/examples/conf/OAConfBasicAuth.xml deleted file mode 100644 index fc99cea79..000000000 --- a/id/server/doc/proxy/handbook/examples/conf/OAConfBasicAuth.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - stateless - - MOAFamilyName - MOAGivenName - - diff --git a/id/server/doc/proxy/handbook/examples/conf/OAConfHeaderAuth.xml b/id/server/doc/proxy/handbook/examples/conf/OAConfHeaderAuth.xml deleted file mode 100644 index 4d34c3646..000000000 --- a/id/server/doc/proxy/handbook/examples/conf/OAConfHeaderAuth.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - stateless - - -
-
- - diff --git a/id/server/doc/proxy/handbook/examples/conf/OAConfParamAuth.xml b/id/server/doc/proxy/handbook/examples/conf/OAConfParamAuth.xml deleted file mode 100644 index 979faca95..000000000 --- a/id/server/doc/proxy/handbook/examples/conf/OAConfParamAuth.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - stateless - - - - - - diff --git a/id/server/doc/proxy/handbook/examples/moa-id-env.sh.txt b/id/server/doc/proxy/handbook/examples/moa-id-env.sh.txt deleted file mode 100644 index 466b2762e..000000000 --- a/id/server/doc/proxy/handbook/examples/moa-id-env.sh.txt +++ /dev/null @@ -1,15 +0,0 @@ -rem insert Tomcat 4.1.x home directory (no trailing path separator) -set CATALINA_HOME= - -CONFIG_OPT_SPSS=-Dmoa.spss.server.configuration=$CATALINA_HOME/conf/moa-spss/SampleMOASPSSConfiguration.xml -CONFIG_OPT_ID=-Dmoa.id.configuration=$CATALINA_HOME/conf/moa-id/SampleMOAIDConfiguration.xml - - -LOGGING_OPT=-Dlog4j.configuration=file:$CATALINA_HOME/conf/moa-id/log4j.properties -# TRUST_STORE_OPT=-Djavax.net.ssl.trustStore=truststore.jks -# TRUST_STORE_PASS_OPT=-Djavax.net.ssl.trustStorePassword=changeit -# TRUST_STORE_TYPE_OPT=-Djavax.net.ssl.trustStoreType=jks - -export CATALINA_OPTS="$CONFIG_OPT_SPSS $CONFIG_OPT_ID $LOGGING_OPT $TRUST_STORE_OPT $TRUST_STORE_PASS_OPT $TRUST_STORE_TYPE_OPT" -echo CATALINA_OPTS=$CATALINA_OPTS - diff --git a/id/server/doc/proxy/handbook/examples/startTomcat.bat.txt b/id/server/doc/proxy/handbook/examples/startTomcat.bat.txt deleted file mode 100644 index 29588120c..000000000 --- a/id/server/doc/proxy/handbook/examples/startTomcat.bat.txt +++ /dev/null @@ -1,26 +0,0 @@ -rem ---------------------------------------------------------------------------------------------- -rem Modify these entries according to your needs - -rem JDK home directory (no trailing path separator) -set JAVA_HOME= - -rem Tomcat 4.1.x home directory (no trailing path separator) -set CATALINA_HOME= - -rem ---------------------------------------------------------------------------------------------- - -set CONFIG_OPT_SPSS=-Dmoa.spss.server.configuration=%CATALINA_HOME%/conf/moa-spss/SampleMOASPSSConfiguration.xml -set CONFIG_OPT_ID=-Dmoa.id.configuration=%CATALINA_HOME%/conf/moa-id/SampleMOAIDConfiguration.xml -set LOGGING_OPT=-Dlog4j.configuration=file:%CATALINA_HOME%/conf/moa-id/log4j.properties - -set PARAMS_MOA=%CONFIG_OPT_SPSS% %CONFIG_OPT_ID% %LOGGING_OPT% - -rem set PARAM_TRUST_STORE=-Djavax.net.ssl.trustStore=truststore.jks -rem set PARAM_TRUST_STORE_PASS=-Djavax.net.ssl.trustStorePassword=changeit -rem set PARAM_TRUST_STORE_TYPE=-Djavax.net.ssl.trustStoreType=jks -rem set PARAMS_SSL=%PARAM_TRUST_STORE% %PARAM_TRUST_STORE_PASS% %PARAM_TRUST_STORE_TYPE% - -set CATALINA_OPTS=%PARAMS_MOA% %PARAMS_SSL% - -cd %CATALINA_HOME% -bin\catalina.bat start \ No newline at end of file diff --git a/id/server/doc/proxy/handbook/faqs.htm b/id/server/doc/proxy/handbook/faqs.htm deleted file mode 100644 index 814d0c9f7..000000000 --- a/id/server/doc/proxy/handbook/faqs.htm +++ /dev/null @@ -1,216 +0,0 @@ - - - FAQs - Häufig gestellte Fragen - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - - - - - - -
-
FAQs
-
- -
- - 		-
FAQs - Häufig gestellte Fragen
-

Frage 1 - Mit dem Internet Explorer kommt es bei einer Anmeldung an der lokal - installierten Version von MOA-ID zu Fehlern beim Redirect. Warum?

-

Frage 2 - Wenn die Proxy-Komponente lokal läuft und per TLS/SSL aufgerufen - wird, kommt es zu einer Fehlermeldung. Wie kann dies verhindert werden?

-

Frage 3 - Es soll serverseitig lediglich starke TLS/SSL Verschlüsselung (>100 - Bit) unterstützt werden. Wie kann dies erzwungen werden?

-

Frage 4 Beim Starten von - MOA ID bzw. MOA SPSS tritt folgende Exception auf: java.lang.ClassCastException: - iaik.asn1.structures.Name. Was kann der Fehler sein?

-

Frage 5 Ich möchte - MOA in einer Umgebung betreiben, die einen Internet-Zugang nur über - einen Proxy erlaubt. Funktioniert das?

-

Frage 6 Tomcat: Wärend - des Betriebs kommt es zu org.apache.commons.logging.LogConfigurationException. - Wie kann dies verhindert werden?

-
-

-

Frage 1

-

Q: Mit dem Internet Explorer kommt es bei einer Anmeldung - an der lokal installierten Version von MOA-ID zu Fehlern beim Redirect. - Warum?

-

A: Aufgrund eines Fehlers in Microsofts Internet - Explorer schlägt der (lokale) Redirect auf dem lokal installierten - Tomcat fehl.

-

Als Workaround empfiehlt es sich, zum lokalen Testen einen - alternativen Browser wie Opera, - Mozilla oder Netscape - zu verwenden, da diese Probleme dort nicht auftreten. Von einem anderen - Rechner aus kann jedoch die Anmeldung an MOA-ID auch mit dem Internet - Explorer erfolgen.

-
-

Frage 2

-

Q: Wenn die Proxy-Komponente lokal läuft und - per TLS/SSL aufgerufen wird, kommt es zu einer Fehlermeldung. Wie kann - dies verhindert werden?

-

A: Wenn in der Konfiguration statt 'localhost' der - eigene Rechnername verwendet wird, funktioniert die Proxy-Komponente - wie gewohnt.
-
- Zum Herausfinden des Rechnernamens wechselt man unter Windows auf die - Kommandozeile und kann mittels 'ipconfig /all' den Rechnernamen herausfinden. - Unix/Linux-Anwender sehen bspw. mittels 'cat' in der Datei /etc/hosts - nach, der Texteintrag hinter der eigenen IP-Adresse spezifiziert den - Rechnernamen.

-
-

Frage 3

-

Q: Es soll serverseitig lediglich starke TLS/SSL - Verschlüsselung (>100 Bit) unterstützt werden. Wie kann - dies erzwungen werden?

-

A: Tomcat bietet (bis dato) keine einfache Möglichkeit - die serverseitig verwendeten TLS/SSL Verschlüsselungsalgorithmen - zu konfigurieren. Daher empfiehlt es sich in diesem Fall, einen Web-Server - wie Apache oder den Microsoft Internet-Information-Server für das - SSL-Handling vorzuschalten und dort in der jeweiligen Konfiguration - starke Verschlüsselung zu erzwingen.

-
- -

Frage 4

- Q: Beim Starten von MOA SPSS tritt folgende Exception auf: java.lang.ClassCastException: - iaik.asn1.structures.Name. Was kann der Fehler sein? -

A: Auf Grund einer mangelhaften Implementierung - in einigen Versionen des JDK 1.3.1 kann es beim Betrieb von MOA zu folgendem - Problem kommen: Sun macht in der Implementierung von PKCS7.getCertificate() - einen Downcast vom Interface java.security.Principal auf die eigene - Implementierung, was zu einer ClassCastException führt, wenn der JCE-Provider - von Sun nicht an erster Stelle in der List der Security-Provider installiert - ist. MOA geht nun aber so vor, dass der JCE-Provider des IAIK an die - erste Stelle installiert wird, wenn er zum Zeitpunkt der Konfiguration - noch nicht installiert war. Wird dann von irgendeinem ClassLoader der - jar-Verifier benützt, wird PKCS7.getCertificate() verwendet, und - es kommt zu einer ClassCastException.

-

Wird MOA über die API-Schnittstelle verwendet, ist ein - Workaround die manuelle Installation des IAIK-JCE-Providers nach dem - Sun JCE-Provider (etwa an die letzte Stelle), bevor die MOA-Konfiguration - aufgerufen wird. Bei Verwendung der Webservices ist die Möglichkeit - der statischen Konfiguration der JCE-Provider mittels Angabe in der - Datei $JAVA_HOME/jre/lib/security/java.security der einzige bekannte - Workaround. Hierzu müssen die Einträge - 

-  security.provider.1=sun.security.provider.Sun
-  security.provider.2=com.sun.rsajca.Provider
-
- durch folgenden Eintrag ergänzt werden: - 
-  security.provider.3=iaik.security.provider.IAIK
-
-

- -
-

Frage 5

-
-

Q: Ich möchte MOA in einer Umgebung betreiben, - die einen Internet-Zugang nur über einen Proxy erlaubt. Funktioniert - das?

-

A: Ja, zumindest für Zugriffe über HTTP. - Sie müssen dazu die nachfolgenden JAVA System-Properties setzen:

-
-

http.proxyHost=<proxyhost>
- http.proxyPort=<proxyport>
- http.nonProxyHosts="<exceptionhosts>"

-
-

<proxyhost> gibt den Namen oder die IP-Adresse des - Proxies an.

-

<proxyport> gibt den Port des Proxies an.

-

<exceptionhosts> enthält eine Liste von Rechnernamen, - die nicht über den Proxy laufen sollen. Jedenfalls müssen - sie hier localhost angeben. Einzelne Namen sind durch eine - Pipe (|) zu trennen. Bitte beachten Sie, dass IP-Addressen - nicht angegeben werden dürfen, sowie die verpflichtend zu verwendenen - Anführungszeichen.

-
-
-

Frage 6

-

Q: Tomcat: Wärend des Betriebs kommt es zu org.apache.commons.logging.LogConfigurationException. - Wie kann dies verhindert werden?

-

org.apache.commons.logging.LogConfigurationException: org.apache.commons.logging.LogConfigurationException: - org.apache.commons.logging.LogConfigurationException
- : Class org.apache.commons.logging.impl.Jdk14Logger does not implement - Log

-

A: Dies ist ein Fehler in tomcat in der Version 4.1.27. $CATALINA_HOME\server\lib\tomcat-util.jar muss gegen eine - gepatchte Version ausgetauscht werden, da ein BUG in der Originalversion - von tomcat 4.1.27. Diese gepatchte Version ist in der MOA-ID Distribution - im Verzeichnis $MOA_ID_INST_AUTH\tomcat\tomcat-util-4.1.27-patched\ - zu finden.

-

 

-
  
- - - - - - - -

- 		-
-
© 2012
-
- - -
- - diff --git a/id/server/doc/proxy/handbook/id-admin.htm b/id/server/doc/proxy/handbook/id-admin.htm deleted file mode 100644 index 9c723cc96..000000000 --- a/id/server/doc/proxy/handbook/id-admin.htm +++ /dev/null @@ -1,322 +0,0 @@ - - - MOA ID-Administration - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - -
-
MOA-ID

-
- Übersicht
- - - -
- -
-		 -
MOA ID-Administration MOA-ID-Auth v.1.5 und MOA-ID-Proxy v.2.0.0
-

-Die Komponenten des Moduls Identifikation (MOA-ID), MOA-ID-AUTH und MOA-ID-PROXY, sind als plattformunabhängige Webapplikationen ausgelegt. -MOA-ID-AUTH ist die Basiskomponente des Moduls, und MOA-ID-PROXY ist eine optionale Zusatzkomponente. -Für den Betrieb dieser Webapplikationen wird eine Java Virtual Machine und ein Java Servlet Container vorausgesetzt. -

-Dieses Handbuch beschreibt die Installation und Konfiguration von MOA-ID-AUTH und von MOA-ID-PROXY, und die Einrichtung der Systemumgebungen. -

-
-
- - - -
- - - -
-

 

-		 -

Übersicht

-
-Für den Betrieb von MOA-ID-AUTH sind unterschiedliche Szenarien möglich, die unterschiedliche Möglichkeiten bieten und die Installation unterschiedlicher Software- und Hardware-Komponenten erfordern. Dieser Abschnitt gibt einen kurzen Überblick über die notwendige Basis-Installation und optionale weitere Konfigurationsmöglichkeiten. -
-
-
- -
- - - -
-

 

-		 -
Basis-Installation von MOA-ID-AUTH
-
-Die Basis-Installation stellt einerseits die minimalen Anforderungen für den Betrieb von MOA-ID-AUTH dar, andererseits dient sie als Ausgangspunkt für weitere (optionale) Konfigurations-Möglichkeiten. -

-Folgende Software ist Voraussetzung für die Basis-Installation: - -
    -
  • JDK 1.4.0, JDK 1.4.2, JDK 1.5.0 oder JDK 1.6*)
    • -
  • Tomcat 4.1.31, Tomcat 5.0.28, Tomcat 5.5 oder Tomcat 6
    • -
  • MOA-ID-AUTH 1.5
    • -
  • MOA SP/SS 1.5 oder neuer (entweder als WebService oder direkt als interne Bibliothek)
    • -
-

*) Für den Online-Vollmachten-Modus müssen zumindest JDK 6 Update 22, JDK 5 Update 26 oder JDK 1.4.2 Update 28 eingesetzt werden.

-
-
-Um möglichen Versionskonflikten aus dem Weg zu gehen sollten stets die neuesten Versionen von MOA-ID als auch von MOA-SP/SS verwendet werden.
-In diesem Betriebs-Szenario wird MOA-ID-AUTH in Tomcat deployt. Tomcat fungiert gleichzeitig als HTTP- und HTTPS-Endpunkt für MOA-ID-AUTH. Beide Protokolle werden direkt in Tomcat konfiguriert. -

-Die Webapplikation verwendet Log4j als Logging Toolkit. -
-
-
- -
- - - -
-

 

-		 -

Basis-Installation von MOA-ID-PROXY (optional)

-
-Einer Online-Applikation, für die MOA-ID-AUTH die Authentisierung übernimmt, kann die Komponente MOA-ID-PROXY vorgeschaltet werden. Diese Komponente übernimmt die Anmeldedaten von MOA-ID-AUTH, führt die Anmeldung an der Online Applikation durch und schleust in der Folge Daten an die Online-Applikation und Daten an den Benutzer durch. - -Die Basis-Installation von MOA-ID-PROXY geschieht im Wesentlichen analog zur Basis-Installation von MOA-ID-AUTH. -

-MOA-ID-AUTH und MOA-ID-PROXY können in verschiedenen Konstellationen zum Einsatz gebracht werden: -
    -
  • auf verschiedenen Rechnern
    • -
  • auf ein und demselben Rechner in verschiedenen Java Servlet Containern
    • -
  • auf ein und demselben Rechner in ein und demselben Java Servlet Container
    • -
-
-Ausgehend von der Basis-Installation können die optionalen Konfigurationen, die in den nachfolgenden Abschnitten beschrieben werden, unabhängig und in beliebiger Kombination aufgesetzt werden. -
-
-
- -
- - - -
-

 

-		 -

Konfiguration mit vorgeschaltetem Webserver (optional)

-
-Den MOA ID Webapplikationen kann jeweils optional ein Webserver vorgeschaltet sein. Unter Microsoft Windows ist das im Regelfall der Microsoft Internet Information Server (MS IIS), auf Unix-Systemen kommt üblicherweise der Apache Webserver zum Einsatz. -

- Folgende Software ist unter Windows Voraussetzung: -
-
    -
  • MS IIS 5.0
    • -
  • Jakarta mod_jk 1.2.2
    • -
-
Folgende Software ist unter Unix/Linux Voraussetzung:
-
    -
  • Apache Webserver 2.0.x mit mod_SSL
    • -
  • Jakarta mod_jk 1.2.2
    • -
-
In diesem Fall übernimmt der vorgeschaltete Webserver die Funktion des HTTP- und HTTPS-Endpunktes. Beide Protokolle werden im Webserver konfiguriert. -

-Mittels mod_jk werden die Webservice-Aufrufe, die im vorgeschalteten Webserver eintreffen, an Tomcat weiter geleitet, bzw. die Antwort von Tomcat wieder an den Webserver zurück übermittelt. -
-
-
- -
- - - -
-

 

-		 -

Konfiguration mit PostgreSQL (optional)

-
-Das MOA ID Webservice kann eine PostgreSQL Datenbank nutzen, um: -
-
    -
  • Log-Meldungen zu speichern
    • -
-
Für den Zugriff auf PostgreSQL ist die Installation folgender Software Voraussetzung:
-
    -
  • PostgreSQL 7.3
    • -
-
-
- -
- - - -
-

 

-		 -

Zusammenfassung

-
-Notwendig für den Betrieb von MOA ID ist eine Basis-Installation. Weitere optionale Konfigurationen können unabhängig und in beliebiger Kombination miteinander durchgeführt werden, um eine bessere Integration der MOA ID Webapplikationen in die vorhandene Betriebs-Infrastruktur zu erreichen. -
-
-

- - - -
- - - -
-

 

-		 -

Referenzierte Software

-
-Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapplikationen entwickelt und getestet wurde. Geringfügig andere Software-Versionen stellen üblicherweise kein Problem dar. -
-

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KomponenteGetestete Version
JDK (SDK)

min. 1.4.0 bzw.
- 1.4.2
- 1.5.0
- 1.6.0 -

-
Tomcat -

4.1.31
- 5.5.x
- 6.0.x

-
MOA-ID-AUTH 2.0.0 (neueste Version)
MOA-ID-PROXY 2.0.0 (neueste Version)
MOA-SPSS 2.0.0 (neueste Version) 
Apache Webserver 1.3.X - bzw.
- 2.0.X
Microsoft Internet Information Server - 5.0 
- 6.0 
mod_SSL (**)  -
Jakarta mod_jk 1.2.2  -
Jakarta Log4j 1.2.8  -
PostgreSQL 7.3  -
-
-
-
- -
(**) passend zur Version des Apache Webservers
-
-

- - - - - -

 -
-
© 2012
-
-
- - -
-
- diff --git a/id/server/doc/proxy/handbook/id-admin_1.htm b/id/server/doc/proxy/handbook/id-admin_1.htm deleted file mode 100644 index 74db7a410..000000000 --- a/id/server/doc/proxy/handbook/id-admin_1.htm +++ /dev/null @@ -1,549 +0,0 @@ - - - MOA ID-Administration - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - -
-
MOA-ID

- -
- Basis-Installation
- - -
- -
- -		 -

Basis-Installation MOA-ID-Auth v.1.5 und MOA-ID-Proxy v.2.0.0

-Bei der Basis-Installation von MOA-ID-AUTH und von MOA-ID-PROXY ist grundsätzlich gleichartig vorzugehen. -Unterschiede sind in der Installationsanweisung angeführt. -
-

Vorbereitung

-
-

Installation des JDK
- Installieren Sie das JDK in ein - beliebiges Verzeichnis. Das Wurzelverzeichnis der JDK-Installation - wird im weiteren Verlauf als $JAVA_HOME bezeichnet.
-
- Installation von Tomcat
- Installieren Sie Tomcat in ein Verzeichnis, das keine Leer- und - Sonderzeichen im Pfadnamen enthält. Am Besten verwenden - die referenzierte Version von Tomcat im zip-Format. (Hinweis f. - Windows: nicht die selbstinstallierende exe Version verwenden.) - Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf - als $CATALINA_HOME bezeichnet.
-
- Entpacken der MOA ID Webapplikation
- Entpacken Sie die ausgelieferten Dateien der Webapplikation (moa-id-auth-x.y.zip - oder moa-id-proxy-x.y.zip; ersetzen Sie x.y durch die Releasenummer - von MOA-ID-AUTH bzw. MOA-ID-PROXY) in ein beliebiges Verzeichnis. - Diese Verzeichnisse werden im weiteren Verlauf als $MOA_ID_INST_AUTH - bzw. $MOA_ID_INST_PROXY bezeichnet.
-
- Installation der IAIK JCE und des IAIK LDAP Protocol Handlers
- Die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext (oder $MOA_ID_INST_PROXY/ext) - müssen in das Verzeichnis $JAVA_HOME/jre/lib/ext kopiert werden. - Anschließend steht eine Unterstützung für Kryptographie - und SSL jeder Java-Anwendung die dieses JDK verwendet zur Verfügung.
-
- Zusätzlich müssen die so genannten Unlimited Strength - Jurisdiction Policy Files heruntergeladen, entpackt - und ins Verzeichnis $JAVA_HOME/jre/lib/security kopiert werden.

-

Der Download für diese Dateien findet sich am unteren Ende - der Download-Seite des jeweiligen JDK in der Sektion "Other - Downloads". D.h. JDK - hier für 1.4.0, das JDK hier - für 1.4.2, das JDK hier - für 1.5.0 bzw. das JDK hier - für 1.6.0

-
- -
- -
- - -
-

 

-
-

-
-		 -

Konfiguration von Tomcat

-
-Minimale Konfiguration
-Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. Tomcat wird grundsätzlich mit -einer funktionierenden Default-Konfiguration ausgeliefert, die jedoch einiges an Ballast enthält und viele Ports -offen lässt. Die Datei server.xml im Verzeichnis mit der Versionsnummer des verwendeten Tomcats unter $MOA_ID_INST_AUTH/tomcat (bzw. $MOA_ID_INST_PROXY/tomcat) enthält eine minimale -Tomcat-Konfiguration, die je einen Connector für HTTP und für HTTPS freischaltet. Die jeweilige Datei server.mod_jk.xml schaltet zusätzlich den AJP Connector Port für den Apache Webserver frei (falls diese Datei verwendet werden soll ist sie zuvor noch auf server.xml umzubenennen).

-SSL
-Für den sicheren Betrieb von MOA-ID-AUTH ist die Verwendung von SSL Voraussetzung, sofern nicht ein vorgelagerter WebServer (Apache oder IIS) das SSL-Handling übernimmt. -Ebenso kann SSL auch für MOA-ID-PROXY verwendet werden. -Das Dokument Tomcat SSL Configuration HOW-TO gibt einen guten Überblick über die Konfiguration von SSL in Tomcat. Da die für SSL notwendigen Bibliotheken bereits im Abschnitt "Vorbereitung" eingebunden wurden, sind nur noch folgende Schritte notwendig: -
-
    -
  • Erstellung eines Server-Keystores, welches den privaten Schlüssel des Servers sowie das Server-Zertifikat enthält, -z.B. mit dem Java Keytool.
    -Hinweis: Standardmäßig wird beim Erzeugen eines neuen Keystores im Home-Verzeichnis des Benutzers die Datei ".keystore" angelegt. Möchte man den Dateinamen und Pfad ändern, kann man das dem SSL-Connector in $CATALINA_HOME/conf/server.xml durch hinzufügen des Attributes keystoreFile="NAME DES KEYSTORES" im Element <Factory> bekannt machen. Das zum Keystore gehörende Passwort übergibt man Tomcat mittels des Attributes keystorePass= "PASSWORT DES KEYSTORES" im Element <Factory>.
    • -
  • Erstellung eines Keystores mit vertrauenswürdigen Client-Zertifikaten, z.B. mit dem Java Keytool (nur, wenn SSL Client-Authentisierung verwendet werden soll)
    • -
  • Falls eine Client-Authentisierung gewünscht ist, muss die Konfiguration des SSL-Connectors in $CATALINA_HOME/conf/server.xml angepasst werden.
    • -
- -
-MOA Administrator
-Der Aufruf der URL für die dynamische Konfiguration von MOA-ID-AUTH ist durch eine Passwort-Abfrage geschützt, und kann nur von Benutzern aufgerufen werden, die der Benutzer-Rolle moa-admin zugeordnet werden können.
-Um diese Benutzer-Rolle und einen oder mehrere Benutzer einzurichten, müssen in der Datei $CATALINA_HOME/conf/tomcat-users.xml unter dem Element <tomcat-users> sinngemäß folgende Einträge hinzugefügt werden: -
-<role rolename="moa-admin"/>
-<user username="moa" password="moa" roles="moa-admin"/>
-
-
-
- -
- - -
-

 

-
-

-
-		 -

Deployment von MOA-ID-AUTH in Tomcat

-
-Um MOA-ID-AUTH in Tomcat für den Ablauf vorzubereiten, sind folgende Schritte notwendig:
-
    -
  • Die Datei $MOA_ID_INST_AUTH/moa-id-auth.war wird ins Verzeichnis - $CATALINA_HOME/webapps kopiert. Dort wird sie beim ersten Start - von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-auth - entpackt.
    • -
  • Die MOA-ID Konfigurationsdatei und die zugehörigen Verzeichnisse - "certs" und "transforms" werden in ein beliebiges Verzeichnis - im Filesystem kopiert (z.B. $CATALINA_HOME/conf/moa-id).
    - Im Verzeichnis $MOA_ID_INST_AUTH/conf/moa-id befinden sich - acht verschiedene Beispielkonfigurationen, die als Ausgangspunkte - für die Konfiguration von MOA-ID-AUTH dienen können: -
      -
    • SampleMOAIDConfiguration.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem öffentlichen Bereich. -
      Karte: Bürgerkarte -
      Konfiguration ohne Proxykomponente
      • -
    • SampleMOAIDConfiguration_withTestBKs.xml: Konfiguration von MOA-ID - für eine Anwendung aus dem öffentlichen Bereich. -
      Karte: Bürgerkarte und Testkarte -
      Konfiguration ohne Proxykomponente
      • -
    • SampleMOAWIDConfiguration.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). -
      Karte: Bürgerkarte -
      Konfiguration ohne Proxykomponente
      • -
    • SampleMOAWIDConfiguration_withTestBKs.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). -
      Karte: Bürgerkarte und Testkarte -
      Konfiguration ohne Proxykomponente
      • -
    • SampleMOAIDConfigurationProxy.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem öffentlichen Bereich. -
      Karte: Bürgerkarte -
      Konfiguration mit Proxykomponente.
      • -
    • SampleMOAIDConfiguration_withTestBKsProxy.xml: Konfiguration von MOA-ID - für eine Anwendung aus dem öffentlichen Bereich. -
      Karte: Bürgerkarte und Testkarte -
      Konfiguration mit Proxykomponente
      • -
    • SampleMOAWIDConfigurationProxy.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). -
      Karte: Bürgerkarte -
      Konfiguration mit Proxykomponente
      • -
    • SampleMOAWIDConfiguration_withTestBKsProxy.xml: Konfiguration von MOA-ID für - eine Anwendung aus dem privatwirtschaftlichen Bereich (MOA-WID Modus). -
      Karte: Bürgerkarte und Testkarte -
      Konfiguration mit Proxykomponente
      • -
    -
    • -
  • Die endorsed Libraries für Tomcat müssen aus dem - Verzeichnis $MOA_ID_INST_AUTH/endorsed in das Tomcat-Verzeichnis - $CATALINA_HOME/common/endorsed kopieren werden. Für Tomcat 6 müssen die Dateien in das Verzeichnis $CATALINA_HOME/endorsed kopiert werden (das Verzeichnis endorsed ist dabei im Allgemein erst anzulegen). Folgende Libraries - sind für das Deployment im endorsed Verzeichnis vorgesehen: -
      -
    • xalan.jar
      • -
    • serializer.jar (für Xalan benötigt)
      • -
    • xml-apis.jar
      • -
    • xercesImpl.jar
      • -
    - Eventuell vorhandene Dateien mit dem gleichen Namen müssen - ersetzt werden. Die ggf. in diesem Verzeichnis vorhandene Datei - xmlParserAPIs.jar muss gelöscht werden.
    • -
  • Folgende Java System Properties sind zu setzen:
    -
      -
    • moa.id.configuration=Name der MOA ID Konfigurationsdatei. - Eine beispielhafte MOA ID Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/ - SampleMOAIDConfiguration.xml enthalten.
      • -
    • log4j.configuration=URL der Log4j Konfigurationsdatei. - Eine beispielhafte Log4j-Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties - enthalten.
      • -
    • javax.net.ssl.trustStore=Name des Truststores - für vertrauenswürdige SSL Client-Zertifikate (optional; - nur, wenn SSL Client-Authentisierung durchgeführt werden - soll).
      -
      • -
    - Diese Java System-Properties werden Tomcat über die Umgebungsvariable - CATALINA_OPTS mitgeteilt (Beispiel-Skripte zum Setzen dieser - Properties für Windows und für Unix bzw. - Linux finden sie unter $MOA_ID_INST_AUTH/tomcat/win32 bzw. - $MOA_ID_INST_AUTH/tomcat/unix). Diese Skripte können sie nach $CATALINA_HOME kopieren und in Folge von dort starten nachdem die Variablen CATALINA_HOME sowie JAVA_HOME in den Skripten entsprechend den Pfaden der Installation gesetzt wurden. -
-
-
- - -
- - -
-

 

-
-

-
-		 -

Deployment von MOA-ID-PROXY in Tomcat

-
-Um MOA-ID-PROXY in Tomcat für den Ablauf vorzubereiten, sind folgende Schritte notwendig: -
-
    -
  • - Für Tomcat 4.1.31: -
      -
    • Die Datei $MOA_ID_INST_PROXY/moa-id-proxy.war wird in ein - beliebiges Verzeichnis (bspw. $CATALINA_HOME/webappsProxy) kopiert. HINWEIS: - Das Verzeichnis darf sich NICHT unterhalb $CATALINA_HOME/webapps befinden!
      -
      • -
    • Anschließend muss in der Datei $CATALINA_HOME/conf/server.xml der - Tomcat-Root-Context auf diese Datei gesetzt werden: wenn - das war-file sich in $CATALINA_HOME/webappsProxy befindet, geschieht dies - mit dem Einfügen von folgendem Element innerhalb von - <Server>...<Service>...<Engine>...<Host>: - 
      <Context path=""
-    docBase="../webappsProxy/moa-id-proxy.war"
-    debug="0"/>
      - Anmerkung: Der Root-Context von Tomcat ist normalerweise auskommentiert. -
      • -
    -
    • -
  • - Für Tomcat 5.0.28: -
      -
    • Die Datei $MOA_ID_INST_PROXY/moa-id-proxy.war ist in ein - beliebiges Verzeichnis (bspw. $CATALINA_HOME/webappsProxy) zu entpacken - (diese Datei ist mittels ZIP Algorithmus komprimiert und kann mit jedem Tool, - das mit .ZIP-Dateien umgehen kann, geöffnet werden). HINWEIS: - Das Verzeichnis darf sich NICHT unterhalb $CATALINA_HOME/webapps befinden!
      -
      • -
    • Anschließend muss in der Datei $CATALINA_HOME/conf/server.xml der - Tomcat-Root-Context auf diese Datei gesetzt werden: wenn die Proxy Web-Applikation - nach $CATALINA_HOME\webappsProxy entpackt wurde, geschieht dies mit dem Einfügen - von folgendem Element innerhalb von - <Server>...<Service>...<Engine>...<Host>:
      • - 
      <Context path="" docBase="../webappsProxy"
-    debug="0"/>
      - Alternativ kann statt die Datei server.xml zu ändern in $CATALINA_HOME\conf\Catalina\localhost eine Datei moa-id-proxy.xml mit vorhin angegebenen Inhalt erstellt werden. -
    -
    • -
- -
- Tomcat Konfiguration: -
    -
  • Die MOA-ID Konfigurationsdatei und die zugehörigen - Verzeichnisse "certs" und "oa" werden in ein beliebiges Verzeichnis - im Filesystem kopiert (z.B. $CATALINA_HOME/ conf/moa-id). -
    - Im Verzeichnis $MOA_ID_INST_PROXY/conf/moa-id befinden sich - vier verschiedene Beispielkonfigurationen, - die als Ausgangspunkte für die Konfiguration von MOA-ID-PROXY - dienen können. -
    • -
  • Die endorsed Libraries für Tomcat müssen aus dem - Verzeichnis $MOA_ID_INST_PROXY/endorsed in das Tomcat-Verzeichnis - $CATALINA_HOME/common/endorsed kopiert werden. Folgende Libraries - sind für das Deployment im endorsed Verzeichnis vorgesehen: -
      -
    • Xerces-J-2.4.0 (bestehend aus xercesImpl.jar - und xmlParserAPIs.jar)
      • -
    - Eventuell vorhandene Dateien mit dem gleichen Namen müssen - ersetzt werden. -
    • -
  • Folgende Java System Properties sind zu setzen:
    -
      -
    • moa.id.configuration=Name der MOA ID Konfigurationsdatei. - Eine beispielhafte MOA ID Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/ - SampleMOAIDConfiguration.xml enthalten.
      • -
    • log4j.configuration=URL der Log4j Konfigurationsdatei. - Eine beispielhafte Log4j-Konfiguration ist in $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties - enthalten.
      • -
    • javax.net.ssl.trustStore=Name des Truststores - für vertrauenswürdige SSL Client-Zertifikate - (optional; nur, wenn SSL Client-Authentisierung durchgeführt - werden soll).
      • -
    -
    • - Diese Java System-Properties werden Tomcat über die Umgebungsvariable - CATALINA_OPTS mitgeteilt (siehe Deployment von MOA-ID-AUTH moa-id-env.sh.txt). -
    -
    - Beispiel-Skripts zum Setzen von CATALINA_OPTS und zum Starten - von Tomcat sind in $MOA_ID_INST_AUTH\tomcat\ zu finden - Sie - können diese für Ihre Zwecke adaptieren (JAVA_HOME - und $CATALINA_HOME setzen) und nach $CATALINA_HOME kopieren. -
-
-
- -
- - -
-

 

-
-

-
-		 -

Starten und Stoppen von Tomcat

-
Nach dem Deployment und der Konfiguration kann - Tomcat aus seinem Wurzelverzeichnis ($CATALINA_HOME) mit
- 
-    startTomcat (unter Windows) oder
-    moa-id-env.sh
-    bin/catalina.sh start (unter Unix/Linux)
-
-gestartet werden. Das Stoppen von Tomcat erfolgt analog mit
-
-    bin\catalina stop  (unter Windows) oder
-    bin/catalina.sh stop (unter Unix/Linux)
-
-Ein erfolgreicher Startvorgang von MOA-ID-AUTH ist an folgender Log-Meldung ersichtlich:
-
-    INFO | 08 13:33:38,497 | main |
-    	MOA ID Authentisierung wurde
-    	erfolgreich gestartet
-
-Analog bei MOA-ID-PROXY:
-
-    INFO | 08 13:35:49,876 | main |
-    	MOA ID Proxy wurde erfolgreich gestartet
-
- -Nach dem erfolgreichen Starten von Tomcat steht MOA-ID-AUTH unter der URL -
-http(s)://host:port/moa-id-auth/StartAuthentication
-
-zur Verfügung. Der WebService ist unter -
-http(s)://host:port/moa-id-auth/services/GetAuthenticationData
-
-

erreichbar. Die Verfügbarkeit der Anwendung kann überprüft werden, indem die URLs mit einem Web-Browser aufgerufen werden.

-

Musterseite (MOA-Template zur Bürgerkartenauswahl)
-Nach dem erfolgreichen Starten von Tomcat steht eine Musterseite unter der URL

-
-http(s)://host:port/moa-id-auth/index.html
-

zur Verfügung. Diese Musterseite bietet eine integrierte Darstellung der Bürgerkartenauswahl bei MOA-ID. Die Musterseite stellt dabei beispielhaft dar, wie eine Bürgerkartenauswahl möglichst nahtlos in MOA-ID integriert werde kann. Sie umfaßt dabei vorkonfigurierte Loginmöglichkeiten mittels Online-BKU, lokaler BKU und Handy-BKU. Anmerkung: Um sich über die Musterseite einloggen zu können, müssen noch die Parameter für den MOA-ID Aufruf angegeben werden - siehe Dokumentation der Musterseite, die über die Musterseite verlinkt ist bzw. über folgende URL abgerufen werden kann

-
-http(s)://host:port/moa-id-auth/BKAuswahl-MOA-Template-Howto.pdf
-

Dynamische Konfigurations-Updates
- Dynamische Konfigurations-Updates können für MOA-ID-AUTH durch den Aufruf der URL http://hostname:port/moa-id-auth/ConfigurationUpdate (z.B. durch Eingabe in einem Browser) durchgeführt werden. Analog wird die Konfiguration von MOA-ID-PROXY mittels http://hostname:port/ConfigurationUpdate aktualisiert.
-
- Hinweis: Konfigurationsänderungen für die Online-Applikationen betreffen grundsätzlich sowohl die Auth- als auch die Proxy-Komponente. -Wenn bspw. das publicURLPrefix der OA geändert wird, muss sowohl für die Auth- als auch für die Proxy-Komponente ein ConfigurationUpdate durchgeführt werden.
-
-Konnte MOA-ID-AUTH bzw. MOA-ID-PROXY nicht ordnungsgemäß konfiguriert und gestartet werden, geht das aus der Log-Meldung hervor:
-

-
-FATAL | 03 13:19:06,924 | main | Fehler
-	beim Starten des Service MOA ID Authentisierung
-
-bzw. -
-FATAL | 03 13:19:06,924 | main | Fehler
-	beim Starten des Service MOA ID Proxy
-
-In diesem Fall geben die WARN bzw. ERROR Log-Meldungen unmittelbar davor Aufschluss über den genaueren Grund.
-
-
- - -
- - -
-

 

-
-

-
-		 -
-

Logging

-
-Die MOA ID Webapplikation verwendet Jakarta Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen:
-
    -
  • Das verwendete Log-Level (DEBUG, INFO, WARN, ERROR, FATAL).
    • -
  • Name und maximale Größe der Log-Datei(en).
    • -
  • Das Aussehen der Log-Einträge.
    • -
-Es werden folgende Log-Hierarchien verwendet: -
-
    -
  • moa.id.auth für alle Log-Meldungen aus dem MOA-ID-AUTH Modul
    • -
  • moa.id.proxy für alle Log-Meldungen aus dem MOA-ID-PROXY Modul
    • -
  • moa.spss.server für alle Log-Meldungen aus dem MOA-SPSS Modul
    • -
  • iaik.server für alle Log-Meldungen aus den IAIK Kryptographie-Modulen
    • -
-
-Als Ausgangspunkt für die Logging-Konfiguration liegt die Datei $MOA_ID_INST_AUTH/conf/moa-id/log4j.properties (bzw. $MOA_ID_INST_PROXY/conf/moa-id/log4j.properties) bei. -Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Datei $CATALINA_HOME/logs/moa-id.log geschrieben. -

-Format der Log-Meldungen
-Anhand einer konkreten Log-Meldung wird das Format der MOA ID Log-Meldungen erläutert: -
-    INFO | 09 08:23:59,385 | Thread-8 |
-    	Anmeldedaten zu MOASession -5468974113772848113
-    	angelegt, SAML Artifakt
-    	AAF/BrdRfnMaQVGIbP/Gf9OwDUwwsXChb7nuT+VXQzOoHbV
-
- -Der Wert INFO besagt, dass die Log-Meldung im Log-Level INFO entstanden ist. Folgende Log-Levels existieren:
-
    -
  • DEBUG: Log-Meldungen im Log-Level DEBUG geben Auskunft über die innere Arbeitsweise des Systems. Sie sind hauptsächlich für Entwickler interessant.
    • -
  • INFO: Diese Log-Meldungen geben informative Status-Informationen über den Ablauf der Webapplikation, wie z.B., dass eine neue Anfrage eingelangt ist.
    • -
  • WARN: Bei der Ausführung einer Operation sind leichte Fehler aufgetreten. Der Ablauf der Webapplikation ist nicht weiter beeinträchtigt.
    • -
  • ERROR: Die Ausführung einer Operation musste abgebrochen werden. Die Webapplikation ist davon nicht beeinträchtigt.
    • -
  • FATAL: Es ist ein Fehler aufgetreten, der den weiteren Betrieb der Webapplikation nicht mehr sinnvoll macht.
    • -
-Der nächste Wert 09 08:23:59,385, gibt den Zeitpunkt an, an dem die Log-Meldung generiert wurde (in diesem Fall den 9. Tag im aktuellen Monat, sowie die genaue Uhrzeit).
-Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist häufig ein Java Stack-Trace angefügt, der eine genauere Ursachen-Forschung ermöglicht. -

- - -Wichtige Log-Meldungen
-Neben den im Abschnitt "Starten und Stoppen von Tomcat" beschriebenen Log-Meldungen, die anzeigen, ob die Webapplikation -ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen. -Die Annahme einer Anfrage wird beispielsweise angezeigt durch: -
-
-    INFO | 09 08:37:17,663 | Thread-9 |
-      MOASession 6576509775379152205 angelegt
-
-    INFO | 09 08:37:20,828 | Thread-9 |
-      Anmeldedaten zu MOASession 6576509775379152205
-      angelegt, SAML Artifakt
-      AAF/BrdRfnMaQVGIbP/Gf9OwDUwwsXChb7nuT+VXQzOoHbV
-
-
- -
-Die 1. Log-Meldung besagt, dass sich ein Benutzer an MOA-ID-AUTH angemeldet und eine eindeutige SessionID zugewiesen bekommen hat.
-Die 2. Log-Meldung informiert darüber, dass die Anmeldedaten des Benutzers unter dem angezeigten SAML Artifakt abgeholt werden können.
-
-Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fortzusetzen erhält man folgende Log-Meldung:
-
-    ERROR | 09 09:34:27,105 | Thread-8 |
-	at.gv.egovernment.moa.id.AuthenticationException:
-	MOASessionID ist unbekannt
-	(MOASessionID=-8650403497547200032)
-
-

In diesem Fall gibt der mitgeloggte Stacktrace Auskunft - über die Art des Fehlers. Der Aufrufer der MOA ID - Webapplikation bekommt einen Fehlercode sowie eine kurze - Beschreibung des Fehlers als Antwort zurück.
-
- Die Tatsächlich übertragenen Anfragen bzw. Antworten - werden aus Effizienzgründen nur im Log-Level DEBUG - angezeigt.

-
-

-

-

- -
-

- - - - - - -

 -
-
© 2012
-
-
- - -
-
- diff --git a/id/server/doc/proxy/handbook/id-admin_2.htm b/id/server/doc/proxy/handbook/id-admin_2.htm deleted file mode 100644 index b301ad144..000000000 --- a/id/server/doc/proxy/handbook/id-admin_2.htm +++ /dev/null @@ -1,1470 +0,0 @@ - - - MOA ID-Administration - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - - -
-
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. -

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -

-
- - - -
-

 

-
-

-
-		 -

Konfiguration der Online-Applikation

-
-Die Konfiguration der OA beschreibt die Art und Weise, wie die Proxykomponente die Anmeldung an der Online-Applikation -durchführt. -

-Der Name der Konfigurationsdatei wird in der Konfiguration von MOA-ID als Wert des Attributs -configFileURL des Elements MOA-IDConfiguration/OnlineApplication/ProxyComponent hinterlegt. -
Ist dieses Attribut nicht gesetzt, dann wird die Datei von http://<realURLPrefix>/MOAConfig.xml geladen, -wobei <realURLPrefix> dem Konfigurationswert OnlineApplication/ProxyComponent/ConnectionParameter/@URL entspricht. -

-Die Konfigurationsdatei ist eine XML-Datei, die dem Schema -MOA-ID-Configuration-1.5.1.xsd mit dem Wurzelelement -Configuration entspricht. -
- -
-

-LoginType
-Das Element LoginType gibt an, ob die Online-Applikation ein einmaliges Login erwartet (stateful), -oder ob die Login-Parameter bei jedem Request mitgegeben werden müssen (stateless). Im Fall einer stateful -Online-Applikation werden die in der HTTP-Session der Proxykomponente gespeicherten Anmeldedaten nur für den Aufruf -des Login-Scripts verwendet. Unmittelbar nach dem Aufruf werden sie gelöscht. -
-Default-Wert: stateful -

-
- -
-

-ParamAuth
-Konfiguriert die übergabe der Authentisierungs-Parameter an die Online-Applikation mittels URL-Parametern. Das Element -kann ein oder mehrere Kind-Elemente <Parameter> beinhalten. -

-
- -
-

-ParamAuth/Parameter
-Das Element <Parameter> enthält die Attribute Name und Value. -

-Das Attribut Name beschreibt den Namen des Parameters und ist ein frei zu wählender String. -

-Das Attribut Value beschreibt den Inhalt des Parameters und kann einen der durch MOAAuthDataType beschriebenen -Werte annehmen. Gültige Werte von MOAAuthDataType sind: -

    -
  • MOAGivenName - der Vorname des Benutzers, wie in der Personenbindung enthalten -
  • MOAFamilyName - der Nachname des Benutzers, wie in der Personenbindung enthalten -
  • MOADateOfBirth - das Geburtsdatum des Benutzers, wie in der Personenbindung enthalten -
  • MOABPK - die bereichsspezifische Personenkennzeichnung des Benutzers, wie von der -Authentisierungskomponente berechnet -
  • MOAWBPK - das wirtschaftsbereichsspezifische Personenkennzeichen des Benutzers, wie von der -Bügerkartenumgebung berechnet -
  • MOAPublicAuthority - wird durch true ersetzt, falls der Benutzer mit einem Zertifikat signierte, -welches eine Behördenerweiterung beinhaltet. Andernfalls wird false gesetzt -
  • MOABKZ - das Behördenkennzeichen (nur sinnvoll, wenn MOAPublicAuthority den Wert true -ergibt) -
  • MOAQualifiedCertificate - wird durch true ersetzt, falls das Zertifikat des Benutzers -qualifiziert ist, andernfalls wird false gesetzt -
  • MOAStammzahl - die Stammzahl des Benutzers; diese ist nur dann verfügbar, wenn die Online-Applikation -die Stammzahl bekommen darf (und daher in der Personenbindung enthalten ist) -
  • MOAIPAddress - IP-Adresse des Client des Benutzers. -
- -Anhand der <Parameter>-Elemente wird der Request für den Login-Vorgang (für stateful Online-Applikationen) -folgendermaßen zusammenge-stellt:
-
-GET https://<login-url>?
-  <p1.name=p1.resolvedValue>&
-  <p2.name=p2.resolvedValue>... -
-

-Die <login-url> ergibt sich aus dem Parameter OA des Aufrufs von MOA-ID-AUTH, -zusammen mit der Konfiguration von OnlineApplication/@publicURLPrefix und von OnlineApplication/ProxyComponent/ConnectionParameter/@URL. -
Der Wert resolvedValue wird in MOA-ID-PROXY je nach Wert des Platzhalters eingesetzt. -

-
-
-

-BasicAuth
-Das Element BasicAuth konfiguriert die übergabe der Authentisierungs-Parameter an die Online-Appliktion -mittels HTTP Basic Authentication. Es enthält zwei Kind-Elemente. -

-Das Element UserID gibt die UserId des zu authentisierenden Benutzers an und kann einen der durch -MOAAuthDataType beschriebenen Werte annehmen. -

-Das Element Password gibt das Passwort des zu authentisierenden Benutzers an und kann einen der durch -MOAAuthDataType beschriebenen Werte annehmen. -

-
- -
-

-HeaderAuth
-Das Element HeaderAuth konfiguriert die übergabe der Authentisierungs-Parameter an die Online-Applikation -in HTTP Request Headern. Das Element kann ein oder mehrere Kind-Elemente <Header> beinhalten. -

-
- - -
- - -
- - - -
-

 

-
-

-
-		 -

Konfiguration von MOA-SP

-
- -

MOA-ID überprüft die Signaturen der Personenbindung und - des AUTH-Blocks mit dem VerifyXMLSignatureRequest von - MOA-SP. Dazu muss MOA-SP wie unten beschreiben konfiguriert werden. -
-
- VerifyTransformsInfoProfile
- Der Request zum überprüfen der Signatur des AUTH-Blocks - verwendet ein vordefiniertes VerifyTransformsInfoProfile. Die - im Request verwendete Profil-ID wird in der MOA-ID Konfigurationsdatei - im Element /MOA-IDConfiguration/ AuthComponent/MOA-SP/VerifyAuthBlock/ - VerifyTransformsInfoProfileID definiert. Entsprechend muss - am MOA-SP Server ein VerifyTransformsInfoProfile mit gleichlautender - ID definiert werden. Die Profiledefinition selbst ist in der Auslieferung - von MOA-ID in $MOA_ID_INST_AUTH/conf/moa-spss/profiles/MOAIDTransformAuthBlock.xml - enthalten. Diese Profildefinition muss unverändert übernommen - werden.

-
- -
-

-TrustProfile
-Die Requests zur überprüfung der Signatur verwenden vordefinierte TrustProfile. -Die im Request verwendete Profil-IDs werden in der MOA-ID Konfigurationsdatei -in den Elementen /MOA-IDConfiguration/AuthComponent/MOA-SP/VerifyIdentityLink/ TrustProfileID und -/MOA-IDConfiguration/AuthComponent/MOA-SP/VerifyAuthBlock/TrustProfileID definiert. Diese beiden Elemente -können unterschiedliche oder identische TrustProfileIDs enthalten. -Am MOA-SP Server müssen TrustProfile mit gleichlautender ID definiert werden. -Die Auslieferung von MOA-ID enthält das Verzeichnis $MOA_ID_INST_AUTH/conf/moa-spss/trustprofiles/MOAIDBuergerkarteRoot, -das als TrustProfile verwendet werden kann. Weitere Zertifikate können als vertrauenswürdig hinzugefügt werden. -

-
- -
-

-Certstore
-Zum Aufbau eines Zertifikatspfades können benötigte Zertifikate aus einem Zertifikatsspeicher verwendet werden. -Die Auslieferung von MOA-ID enthält das Verzeichnis $MOA_ID_INST_AUTH/conf/moa-spss/certstore, das als initialer -Zertifikatsspeicher verwendet werden kann. -

-
- -
-Hinweis: Mit dem Wechsel auf Version 1.3 verwendet MOA SP/SS ein neues Format für die XML-Konfigurationsdatei. -Für die Konvertierung einer älteren Konfigurationsdatei auf das neue Format steht Ihnen ein Tool -zur Verfügung. Details dazu finden sie in der der Distribution von MOA-SP/SS beiligenden -Dokumentation im Kapitel 'Konfiguration', Abschnitt 1.2.1.
- -
-
- - -
- - - - - - - - -
-
- - - - - - - - - -
-

 

-
-

-
-		 -

Änderung der Konfiguration während des Betriebs

-
-Der Inhalt dieser Konfiguration, bzw. jene Teile, auf die indirekt verwiesen wird, können während des laufenden -Betriebes des MOA-Servers geändert werden. Der Server selbst wird durch den Aufruf einer URL -(im Applikationskontext von MOA ID) dazu veranlasst, die geänderte Konfiguration neu einzulesen. -Im Falle einer fehlerhaften neuen Konfiguration wird die ursprüngliche Konfiguration beibehalten. -
- - -
-

 

-
-

-
-		 -

Ändern der Default Errorpages

-
-

Die Default-Errorpages geben bei MOA-ID-AUTH und MOA-ID-PROXY immer die entsprechende Fehlermeldung aus, so eine vorhanden ist. Möchte man dies verhindern bzw. abhängig vom eingestellten Log-Level machen so können diese Errorpages ersetzt werden. Entsprechende Errorpages sind unter $MOA_ID_INST_AUTH/errorpages bzw. $MOA_ID_INST_PROXY/errorpages zu finden. Diese können die Default-Errorpages unter dem jeweiligen webapps-Kontext von MOA-ID-AUTH (errorpage-auth.jsp) bzw. MOA-ID-PROXY (errorpage-proxy.jsp )ersetzen.

-

Die in $MOA_ID_INST_AUTH/errorpages bzw. $MOA_ID_INST_PROXY/errorpages enthaltenen Errorpages bedeuten dabei folgendes:

-
    -
  • errorpage-auth_debug.jsp und errorpage-proxy_debug.jsp:
    - Geben erweiterte Meldungen wie (ErrorMessage, ExceptionThrown) aus, wenn der Log-Level für - moa.id.auth bzw. moa.id.proxy auf debug gesetzt sind. Ansonsten erfolgt nur eine allgemeine Ausgabe, dass ein - Fehler aufgetreten ist.
    • -
  • errorpage-auth_empty.jsp und errorpage-proxy_empty.jsp:
    - Unabhängig vom Log-Level erfolgt nur einen allgemeine Ausgabe, dass ein Fehler aufgetreten ist.
    -
    • -
-

-
-

 

-
-

-
-		 -
-

Tomcat Security Manager

-
-

Apache Tomcat bietet die Möglichkeit den Server unter einem Security Manager zu betreiben. Damit ist es möglich den lokalen Dateizugriff zu beschränken. Mit Hilfe der Datei "catalina.policy" können so Zugriffe auf lokale Dateien und Verzeichnisse festgelegt werden. Eine beispielhafte catalina.policy Datei finden Sie im Verzeichnis $MOA_ID_INST_AUTH/tomcat bzw. $MOA_ID_INST_PROXY/tomcat. Diese Datei wurde unter Apache Tomcat 4.1.31, 5.0.28 und 5.5.27 getestet.

-

Mehr Informationen zum Security Manager entnehmen Sie bitte der entsprechenden Apache Tomcat Dokumentation.

-
-

- - - - - - -

 -
-
© 2012
-
-
- - -
-
- diff --git a/id/server/doc/proxy/handbook/id-admin_3.htm b/id/server/doc/proxy/handbook/id-admin_3.htm deleted file mode 100644 index 5b95feca8..000000000 --- a/id/server/doc/proxy/handbook/id-admin_3.htm +++ /dev/null @@ -1,204 +0,0 @@ - - - MOA ID-Administration - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - -
-
-
MOA-ID

- - - -
- Optionale
    Komponenten
-
- -
-
-Optionale
Komponenten
-IIS
-Apache
-PostgreSQL
-
-		 -

Konfiguration der optionalen Komponenten

-

Konfiguration des Microsoft Internet Information Server (optional)

-
-Vor MOA-ID-AUTH oder MOA-ID-PROXY kann optional ein MS IIS vorgeschaltet sein. In diesem Fall übernimmt der MS IIS die HTTP bzw. HTTPS-Kommunikation mit dem Aufrufer des Webservices. Die Kommunikation zwischen MS IIS und dem in Tomcat deployten Webservice wird durch Jakarta mod_jk durchgeführt.

-Konfiguration von Jakarta mod_jk im MS IIS
-Für die Kommunikation des MS IIS mit dem im Tomcat deployten Webservice wird das ISAPI-Modul von Jakarta mod_jk im MS IIS installiert und konfiguriert. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk IIS HowTo. Beispiele für workers.properties und uriworkermap.properties Dateien liegen im ausgelieferten moa-id-auth-x.y.zip bzw. moa-id-proxy-x.y.zip, Verzeichnis tomcat bei. -

-Konfiguration von Tomcat
-Damit Tomcat die Aufrufe, die von MS IIS mittels Jakarta mod_jk weiterleitet, entgegennehmen kann, muss in $CATALINA_HOME/conf/server.xml der AJP 1.3 Connector aktiviert werden. Im Gegenzug können die Connectoren für HTTP und HTTPS deaktiviert werden. Das geschieht am einfachsten durch ein- bzw. auskommentieren der entsprechenden Connector Konfigurations-Elemente in dieser Datei. -

-
-
-

Konfiguration von SSL
- Die Dokumentation zum Einrichten von SSL auf dem MS IIS steht nach - Installation des IIS unter http://localhost/iisHelp/ bzw. online - zur Verfügung.

-

Konfiguration des zu verwendenden DATA-URL - Präfix
- Befindet sich der Rechner auf dem MOA-ID installiert wird hinter - einer Firewall welche zwar Zugriffe vom vorgelagerten Webserver - zulässt, nicht jedoch direkte Zugriffe (von den Rechnern von - MOA-ID Benutzern), so muss manuell in der Konfigurationsdatei von - MOA-ID ein s.g. DATA-URL Präfix vergeben werden. An dieses - URL-Präfix werden Daten von der verwendeten Bürgerkartenumgebung - gesendet. Details finden sie im Abschnitt Konfiguration. - Requests an das DataURL-Präfix> müssen durch den Webserver - an https://<moa-id-rechnername>/moa-id-auth/ bzw. an http://<moa-id-rechnername>/moa-id-auth/ - weitergeleitet werden.

-
-
-

- - -
- - - -
-

 

-
-

-
-		 -

Konfiguration des Apache Webservers (optional)

-
-Vor MOA-ID-AUTH oder MOA-ID-PROXY kann ein Apache Webserver vorgeschaltet sein. Das Prinzip funktioniert wie bei MS IIS, auch hier wird Jakarta mod_jk für die Kommunikation zwischen Webserver und Tomcat eingesetzt. -

-Konfiguration von Jakarta mod_jk im Apache Webserver
- Um MOA-ID-AUTH oder MOA-ID-PROXY hinter einem Apache Webserver zu betreiben, ist die Konfiguration des Apache-Moduls mod_jk erforderlich. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk Apache HowTo. Ein Beispiel für eine workers.properties Datei liegt im Verzeichnis $MOA_SPSS_INST/conf/moa bei.
-Um MOA-ID-AUTH oder MOA-ID-PROXY dem Apache Webserver bekannt zu machen, muss folgender Eintrag in die Apache Konfigurationsdatei gemacht werden: -
-    JkMount /moa-id-auth/* moaworker
-
-oder für die Proxy-Komponente -
-    JkMount /* moaworker
-
-
-Konfiguration von Tomcat
-Die Konfiguration von Tomcat ist analog wie im Abschnitt über den MS IIS durchzuführen. -

- -Konfiguration von SSL mit mod_SSL
-Apache kann in Verbindung mit mod_SSL als SSL-Endpunkt für das MOA-ID-AUTH Webservice fungieren. In diesem Fall entfällt die SSL-Konfiguration in Tomcat, da Apache und Tomcat auch im Fall von SSL Daten via mod_jk austauschen. Eine detaillierte Installations- und Konfigurationsanleitung von mod_SSL gibt die Online-Dokumentation. -

-Bei der Verwendung von Client-Authentisierung muss darauf geachtet werden, dass mod_ssl die HTTP-Header mit den Informationen über das Client-Zertifikat exportiert. Dies wird durch Angabe der Option
-
-    SSLOptions +ExportCertData +StdEnvVars
-
-in der Apache-Konfiguration erreicht.
-Weiters muss Jakarta mod_jk angewiesen werden, die SSL Schlüssellänge zu exportieren. Dies geschieht mit der Direktive: -
-    JkOptions +ForwardKeySize
-              +ForwardURICompat
-              -ForwardDirectories
-
-

Konfiguration des zu verwendenden DATA-URL Präfix

-

siehe gleichnamige Überschrift - in Abschnitt "Konfiguration des Microsoft Internet Information - Server (optional)"

-
-
-

- - -
- - - -
-

 

-		 -

Konfiguration von PostgreSQL

-
-MOA-ID-AUTH bzw. MOA-ID-PROXY kann PostgreSQL zum Abspeichern von Log-Meldungen verwenden. Hierfür wird eine installierte und konfigurierte Datenbank vorausgesetzt. Eine detaillierte Übersicht über die Installation und Konfiguration von PostgreSQL gibt die Online-Dokumentation.

-Logging
-Für das Logging in eine PostgreSQL Datenbank mittels Jakarta Log4j muss zunächst eine Tabelle für die Log-Meldungen angelegt werden. Dies kann mit folgendem SQL-Statement erreicht werden: -
-    create table spss_log
-      (log_time timestamp,
-       log_level varchar(5),
-       log_msg varchar(256));
-
-Um das Logging in die Datenbank Log4j bekannt zu machen, muss die Log4j-Konfiguration adaptiert werden. Die Datei $MOA_SPSS_INST/conf/moa/log4.properties enthält bereits eine beispielhafte Jakarta Log4j-Konfiguration für das Logging in eine PostgreSQL Datenbank, die standardmäßig ausgeschaltet ist. Hinweis: Bei Tests hat sich das Logging in eine Datenbank mit Jakarta Log4j als Performance-Engpaß herausgestellt. Es wird deshalb empfohlen, auf dieses Feature zu verzichten. -

-
- -
-

- - - - - - -

 -
-
© 2012
-
-
- - -
-
- diff --git a/id/server/doc/proxy/handbook/id-anwendung.htm b/id/server/doc/proxy/handbook/id-anwendung.htm deleted file mode 100644 index c77f15c93..000000000 --- a/id/server/doc/proxy/handbook/id-anwendung.htm +++ /dev/null @@ -1,104 +0,0 @@ - - - MOA ID-Anwendung - - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - -
-
MOA-ID

-
- Übersicht
- - -
- -
-		 -
MOA ID-Anwendung
-

-MOA-ID führt für eine Online-Applikation (OA) die Benutzeridentifizierung und -authentisierung mit Hilfe der Bürgerkarte durch. -

-

Übersicht

-Um diese Funktionalität verfügbar zu machen, ist folgendermaßen vorzugehen:
-

-
    -
  • Die OA muss als Webapplikation installiert werden.
    • -
  • MOA-ID-AUTH muss als Webapplikation installiert und für die OA konfiguriert werden. Hierbei kann sowohl MOA-ID-Auth 1.5.1 als auch MOA-ID-Auth 2.0.0 verwendet werden. Verwenden Sie hierfür das beigelegte Handbuch der verwendeten Version.
    • -
  • MOA-ID-AUTH wird durch einen Verweis von einer Webseite aufgerufen. -Diese Webseite kann z.B. Teil eines Portals sein.
    • -
  • Nach erfolgter Authentisierung holt die OA die bereitgestellten Anmeldedaten zum Bürger von MOA-ID-AUTH ab. -Dies kann unter Mithilfe der Webapplikation MOA-ID-PROXY geschehen, die für diesen Zweck installiert und für die OA konfiguriert werden muss.
    • -
-
-
- - - - - - -

 -
-
© 2012
-
-
- - -
- - diff --git a/id/server/doc/proxy/handbook/id-anwendung_1.htm b/id/server/doc/proxy/handbook/id-anwendung_1.htm deleted file mode 100644 index 4b23b36e0..000000000 --- a/id/server/doc/proxy/handbook/id-anwendung_1.htm +++ /dev/null @@ -1,119 +0,0 @@ - - - MOA ID-Anwendung - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - -
-
MOA-ID

- - - -
- -

-		 -

Aufruf von MOA-ID-AUTH (SAML 1 Protokoll)

-
MOA-ID-AUTH wird immer durch eine andere (verweisende) Webseite aufgerufen. Diese Webseite kann z.B. Teil eines Portals sein. -Der Aufruf erfolgt durch einen Verweis der Form:
-
<a href="https://<moa-id-server-und-pfad>/
-StartAuthentication?Target=<geschäftsbereich>
-&OA=<oa-url>&Template=<template-url>&useMandate=false&sourceID=<sourceID>">
- - - - - - - - - - - - - - - - - - - - - - - -
<moa-id-server-und-pfad>Server und Pfad, wo MOA-ID-AUTH installiert ist
Target=<geschäftsbereich>Angabe, für welches Verfahren der Benutzer authentisiert werden soll
OA=<oa-url>Webseite, auf die der Browser nach erfolgter Authentisierung weitergeleitet werden soll
Template=<template-url>optional; HTML-Vorlage für der Anmeldeseite von MOA-ID-AUTH, über die der Bürger den Authentisierungsvorgang startet. Über diesen Parameter kann das Aussehen der Anmeldeseite an das Aussehen der Online-Applikation angepasst werden.
useMandate=<true/false>optional; Gibt an ob eine Anmeldung im Online-Vollmachten-Modus durchgeführt werden soll (=true) oder nicht (=false);
sourceID=<sourceID>optional; Gibt eine sourceID an, die (wenn sie gesetzt ist) zur Berechnung des SAML-Artifacts herangezogen wird.
-

-

- - - - - - -

 -
-
© 2012
-
-
- - -
- - diff --git a/id/server/doc/proxy/handbook/id-anwendung_2.htm b/id/server/doc/proxy/handbook/id-anwendung_2.htm deleted file mode 100644 index 6fc746383..000000000 --- a/id/server/doc/proxy/handbook/id-anwendung_2.htm +++ /dev/null @@ -1,246 +0,0 @@ - - - MOA ID-Anwendung - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - - -
-
MOA-ID

- - - -
- -

-
-Abfragearten: -
-Web Service
-MOA-ID-PROXY
-
-		 -

Abfrage der Anmeldedaten von MOA-ID-AUTH

-
Nach erfolgter Authentisierung stehen in MOA-ID-AUTH SAML1 Anmeldedaten zum Abholen bereit, -und MOA-ID-AUTH veranlasst einen Redirect zur Online-Applikation (OA). -

-In diesem Redirect werden der Geschäftsbereich und ein SAML-Artifact als Parameter übergeben. -
-
<a href="https://<oa-url>
-?Target=<geschäftsbereich>
-&SAMLArtifact=<saml-artifact>">
- - - - - -
<oa-url>URL, der beim Aufruf von MOA-ID-AUTH als Parameter "OA" übergeben wurde
Target=<geschäftsbereich>Parameter, der beim Aufruf von MOA-ID-AUTH übergeben wurde
SAMLArtifact=<saml-artifact>SAML-Artifact, das von MOA-ID-AUTH zu den Anmeldedaten erstellt wurde. -Mithilfe dieses SAML-Artifacts kann die OA die Anmeldedaten von MOA-ID-AUTH abholen.
-

-
Grundsätzlich stehen einer OA mehrere Arten zum Abholen der Anmeldedaten von MOA-ID-AUTH zur Verfügung:
-
    -
  1. Die Applikation ruft selbst das MOA-ID-AUTH SAML1 Web Service auf. -
    Die Implementierung dieser Variante wird empfohlen, insbesondere für Online-Applikationen, die neu erstellt werden. -
    2. -
  2. Es wird die MOA-ID-PROXY Webapplikation eingesetzt, um die Anmeldedaten abzuholen und an die OA zu übergeben. -
    Aus Sicht von MOA-ID-PROXY ist bedeutsam, ob die OA die Anmeldedaten nach Abarbeitung des HTTP-Requests behält. -
      -
    • Stateful OA: MOA-ID-PROXY übergibt einmalig die Anmeldedaten an die OA, und die OA speichert die Anmeldedaten, typischerweise unter Einsatz von Cookies.
      • -
    • Stateless OA: MOA-ID-PROXY übergibt die Anmeldedaten bei jedem HTTP-Request vom Browser des Bürgers an die OA.
      • -
    -Diese Variante ist vorzuziehen, wenn -
      -
    • für die Plattform, auf der die OA aufbaut, Web Service-Schnittstellen nicht verfügbar sind
      • -
    • das nötige Web Service-Know How nicht zur Verfügung steht
      • -
    • die Implementierung von Variante 1 zu aufwändig wäre
      • -
    • eine Anpassung der OA aus bestimmten Gründen nicht möglich ist
      • -
    -
    3. -
-
- - - -
- - - -
-

 

-
-

-
-		 -

Aufruf des MOA-ID-AUTH Web Service

-
Das MOA-ID-AUTH Web Service wird über einen <samlp:Request> aufgerufen. -Der <samlp:Request> enthält in einem <samlp:AssertionArtifact> das von MOA-ID-AUTH übergebene SAML-Artifact. -

-MOA-ID-AUTH liefert als Antwort einen <samlp:Response>. Die Anmeldedaten sind im <samlp:Response> in Form einer <saml:Assertion> enthalten. -

-SAML 1.0 Protocol Schema -
-SAML 1.0 Assertion Schema -
-Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.4 beschrieben. -

-

Beispiel LoginServletExample

-Das Abholen der Anmeldedaten durch Aufruf des Web Service von MOA-ID-AUTH wird anhand eines beispielhaften Java Servlet gezeigt. -Das LoginServletExample wird in einer Stateful OA von MOA-ID-AUTH nach erfolgter Authentisierung über Redirect aufgerufen. -

-Das Beispiel demonstriert insgesamt die Integration von MOA-ID-AUTH in die OA: -
-
    -
  • Parameterübergabe von MOA-ID-AUTH an die OA
    • -
  • Aufruf des MOA-ID-AUTH Web Service mittels des SOAP Frameworks "Apache AXIS"
    • -
  • Parsen der Anmeldedaten mittels der XPath Engine "Jaxen"
    • -
  • Speichern der Anmeldedaten in der HTTPSession
    • -
  • Redirect auf die eigentliche Startseite der OA
    • -
- - -Voraussetzungen
-
Die folgende Liste enthält die für das Beispiel erforderlichen Java-Bibliotheken. Die angeführten Versionsnummern bezeichnen jene Versionen dieser Java-Bibliotheken, mit denen das Beispiel getestet wurde.
-
- - - - - - - - - - - - - - - - - - - - - -
Java-BibliothekVersionBemerkung
JDK1.4.0+, 1.5.0Java Development Kit
Xerces
XML Parser		2.0.2+Download: xml.apache.org/xerces2-j
AXIS
SOAP Framework		1.0+Download: xml.apache.org/axis
Jaxen XPath Engine1.0+Download: http://jaxen.sourceforge.net
Servlet API2.3+Download: java.sun.com/products/servlet
-
-Code
-LoginServletExample - -
- -
- - - -
- - -
-

 

-
-

-
-		 -

Einsatz von MOA-ID-PROXY zum Abfragen der Anmeldedaten von MOA-ID-AUTH

-
-Anstatt den Aufruf des MOA-ID-AUTH Web Service in der OA zu implementieren, kann die MOA-ID-PROXY Webapplikation eingesetzt werden, um dies für die OA zu erledigen. MOA-ID-PROXY muss für die OA konfiguriert werden, so wie in MOA-ID-Administration beschrieben. -

-Bei der Konfiguration ist speziell zu beachten: -

-Konfigurationsdatei zur OA
-Der LoginType (stateful oder stateless) ist gemäß dem Applikationstyp zu setzen. -

-Die Übergabe der Anmeldedaten ist in Form und Inhalt zu konfigurieren. -
-
    -
  • BasicAuth: HTTP Basic Authentication (Beispiel)
    • -
  • ParamAuth: Übergabe über Requestparameter (Beispiel)
    • -
  • HeaderAuth: Übergabe über Requestheader (Beispiel)
    • -
- -
-LoginParameterResolver
-Das Übergabe der Anmeldedaten an die OA über Request Parameter oder Header geschieht in einer Standardimplementierung des Interface -
at.gv.egovernment.moa.proxy.LoginParameterResolver
-Falls die Erfordernisse der OA mittels Konfiguration nicht abgedeckt werden können, -so kann eine maßgeschneiderte Implementierung von LoginParameterResolver erstellt und zusammen mit MOA-ID-PROXY zum Einsatz gebracht werden -(siehe API). -

-ConnectionBuilder -Das Herstellen einer URL-Verbindung von MOA-ID-PROXY zur OA geschieht einer Standardimplementierung des Interface -
at.gv.egovernment.moa.proxy.ConnectionBuilder
-Falls nötig, kann eine maßgeschneiderte Implementierung von ConnectionBuilder erstellt und zusammen mit MOA-ID-PROXY zum Einsatz gebracht werden -(siehe API). -
-
- - - - - -

 -
-
© 2012
-
- - -
- - diff --git a/id/server/doc/proxy/handbook/links.htm b/id/server/doc/proxy/handbook/links.htm deleted file mode 100644 index 2956c6263..000000000 --- a/id/server/doc/proxy/handbook/links.htm +++ /dev/null @@ -1,144 +0,0 @@ - - - MOA Grundlagen - - - - - - - - - -
- - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - - - - - - -
-
MOA Links

- - - - -
- -
-		 -
MOA Links
- -
  
- - - - - - - -

 -
-
© 2012
-
-
- - -
- - diff --git a/id/server/doc/proxy/handbook/moa-id-ablauf.jpg b/id/server/doc/proxy/handbook/moa-id-ablauf.jpg deleted file mode 100644 index 0585664f4..000000000 Binary files a/id/server/doc/proxy/handbook/moa-id-ablauf.jpg and /dev/null differ diff --git a/id/server/doc/proxy/handbook/moa.htm b/id/server/doc/proxy/handbook/moa.htm deleted file mode 100644 index 1d3aabc1d..000000000 --- a/id/server/doc/proxy/handbook/moa.htm +++ /dev/null @@ -1,259 +0,0 @@ - - - MOA Module fuer Online Applikationen - - - - - - - - - -
- - - - -
- Module für Online-Applikationen -
-
-  -
-
-Projekt moa  -
-
- - - - - - - - -
-
MOA-ID

-
- Allgemein
- - - - - -
- -
-
-
-		 - -
Allgemein v.2.0.0
-

-Dieses Dokument enthält die Dokumentation für das Modul
-

    -
  • MOA-ID-Proxy
    • -
-

- Die in diesem Dokument beschriebene Konfiguration für das Modul MOA-ID-Auth bezieht sich auf die MOA-ID-Auth Version 1.5.1. Ein Betrieb von MOA-ID-Proxy in Kombination mit MOA-ID-Auth 2.0.0 ist jedoch weiterhin möglich. -

Hinweis: Bei der Version 2.0.0 handelt es sich um das letzten Release dass von MOA-ID-Proxy veröffentlich wird.

- -
- - - -
-

 

-
-
-		 -
-Das Modul Identifikation stellt Online-Applikationen Funktionalität zur Verfügung zu stellen, damit diese -eine Benutzer-Identifikation und -Authentisierung mit Hilfe der Bürgerkarte und deren Signaturfunktion -realisieren können. -

-Das Modul besteht aus zwei Komponenten: -
    -
  • Die Authentisierungskomponente (MOA-ID-AUTH) führt die eigentliche Authentisierung des Benutzers durch und übergibt der -Proxykomponente die Anmeldedaten.
    • -
  • Die Proxykomponente (MOA-ID-PROXY) übernimmt die Anmeldedaten von der Authentisierungskomponente, -führt die Anmeldung an der Online Applikation durch und schleust in der Folge Daten an die Online-Applikation -und Daten an den Benutzer durch.
    • -
-Diese beiden Komponenten können auf unterschiedlichen Rechnern -oder auf dem gleichen Rechner eingesetzt werden. -

-Die Funktionalität und der Aufbau der Schnittstelle zu MOA-ID ist in der -Spezifikation bzw. im Anhang zur Spezifikation detailliert beschrieben. -
-
-Für den Betrieb von MOA-ID ist der Einsatz von MOA-Signaturprüfung (MOA-SP) erforderlich. -
- -

-
Ablauf einer Anmeldung
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1Der Benutzer verbindet sich zu einem Web-Portal, über das die verfügbaren Online-Applikationen (OA) erreichbar sind. Jeder Link zu einer OA verweist auf die Authentisierungs-komponente. -
2Der Benutzer verbindet sich mit MOA-ID-AUTH, die die Authentisierung des -Benutzers durchführt:
2.1MOA-ID-AUTH bietet dem Benutzer optional eine Auswahl von verfügbaren Bürgerkartenumgebungen (engl. Bezeichnung: Security-Layer) an.
2.2MOA-ID-AUTH erzeugt eine HTML-Seite mit einem <InfoboxReadRequest> - zum Auslesen der Personenbindung. Diese HTML-Seite wird an den Browser geschickt.
2.3Der Browser schickt den <InfoboxReadRequest> an den ausgewählten Security-Layer. Der Security-Layer liest die -Personenbindung von der Bürgerkarte und sendet diese an MOA-ID-AUTH, die die Signatur der Personenbindung durch -einen Aufruf von MOA-SP überprüft. -
2.4MOA-ID-AUTH erstellt den AUTH-Block. Der AUTH-Block enthält -
    -
  • Vor- und Nachname aus der Personenbindung,
    • -
  • URL von MOA-ID-AUTH,
    • -
  • URL und Geschäftsbereich der Online-Applikation,
    • -
  • die aktuelle Zeit.
    • -
-Anschließend wird -eine XML Antwortseite, die das Kommando zum Signieren (<CreateXMLSignatureRequest>) des generierten -AUTH-Blocks enthält, an den ausgewählten Security-Layer gesendet.
2.5Der Request wird vom Security-Layer verarbeitet. Die signierten Daten werden an -MOA-ID-AUTH zurückgesendet.
2.6MOA-ID-AUTH überprüft den signierten AUTH-Block und legt für den Benutzer die Anmeldedaten -an. Die Anmeldedaten enthalten -
    -
  • die bereichsspezifische Personenkennzeichen (bPK),
    • -
  • den signierten AUTH-Block (optional),
    • -
  • die Personenbindung (optional),
    • -
  • die PersonData-Struktur aus der Personenbindung (optional),
    • -
  • die Information, ob die Signatur des AUTH-Blocks mit einem qualifiziertem Zertifikat erfolgte,
    • -
  • Informationen zur Behörde, falls die Signatur mit einem Behördenzertifikat erzeugt wurde.
    • -
-
2.7Ist der obige Authentisierungsvorgang erfolgreich, dann wird eine Redirect-Seite -zum Browser gesendet.
3Der Browser führt das Redirect zur Proxykomponente durch. Als Parameter wird das von MOA-ID-AUTH -erzeugte SAML-Artifact übergeben.
4Die Proxykomponente verwendet dieses eindeutige SAML-Artifact, um die Anmeldedaten -von MOA-ID-AUTH zu erhal-ten. Danach werden die Anmeldedaten in MOA-ID-AUTH gelöscht.
5MOA-ID-PROXY liest die Konfigurationsdatei der zugehörigen Online-Applikation, die beschreibt, wie die Anmeldedaten -an die nachfolgende Applikation übergeben werden müssen, und meldet den Benutzer bei der Applikation an.
6Ist die betreffende OA als stateless konfiguriert, so werden in weiterer Folge die Antworten der OA -an den Benutzer weitergeleitet und die Anfragen des Benutzers an die OA weitergeleitet.
-
Ergänzung für ausländische Bürger
-
-

Ab der MOA Release 1.4.7 ist es möglich, dass sich auch ausländische Bürger mittels MOA-ID einloggen können. Hierzu wird eine Verbindung zu einem sogenannten Stammzahlenregister-Gateway aufgebaut, dass basierend auf den Zertifikatsdaten des ausländischen Bürgers eine Eintragung im Ergänzungsregister für natürliche Personen gemäß E-Government Gesetz §6(5) vornimmt. Somit ist es möglich, dass eine Personenbindung ausgestellt werden kann, die in weitere Folge an MOA-ID weitergeleitet wird.

-

Der Zugang zu diesem Stammzahlenregister-Gateway ist über eine Client-Server Authentifizierung abgesichert. Als Client-Zertifikate werden Zertifikate der Firmen A-Trust bzw. A-CERT, die mit der Verwaltungs- oder Dienstleistereigenschaft versehen sind, akzeptiert.

-
- -
Online-Vollmachten
-
-

Ab der MOA Release 1.5.0 werden Online-Vollmachten (für Anwendungen aus dem öffentlichen Bereich) unterstützt. Hierzu werden diese Vollmachten über eine Online-Vollmachten-Service ausgewählt. Der Zugang zu diesem Online-Vollmachten Service ist über eine Client-Server Authentifizierung abgesichert. Als Client-Zertifikate werden Zertifikate der Firmen A-Trust bzw. A-CERT, die mit der Verwaltungs- oder Dienstleistereigenschaft versehen sind, akzeptiert.

-
- -
- -

- - - - - -

 -
-
© 2012
-
-
- - -
- - diff --git a/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.docx b/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.docx deleted file mode 100644 index 249d13cae..000000000 Binary files a/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.docx and /dev/null differ diff --git a/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.pdf b/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.pdf deleted file mode 100644 index e199f1810..000000000 Binary files a/id/server/doc/stork/VIDP Installation Manual_STORK2_v0.2.pdf and /dev/null differ -- cgit v1.2.3 From e4fa532f93f10115e1f39c97cc96e5950a048884 Mon Sep 17 00:00:00 2001 From: Thomas Lenz Date: Wed, 11 Dec 2019 16:01:38 +0100 Subject: update to EAAF-Components 1.0.13.1 Enforce E-ID authentication based on Service-Provider configuration --- id/server/doc/handbook/protocol/protocol.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'id/server/doc') diff --git a/id/server/doc/handbook/protocol/protocol.html b/id/server/doc/handbook/protocol/protocol.html index 2b3dbff98..dc55dda3b 100644 --- a/id/server/doc/handbook/protocol/protocol.html +++ b/id/server/doc/handbook/protocol/protocol.html @@ -123,12 +123,12 @@ Redirect Binding OpenID Connect Authentifizierungsrequest
(AuthCode-Request) - https://<host>:<port>/moa-id-auth/oauth3/auth + https://<host>:<port>/moa-id-auth/oauth2/auth OpenID Connect

AccessToken-Request

- https://<host>:<port>/moa-id-auth/oauth3/token + https://<host>:<port>/moa-id-auth/oauth2/token SAML 1 @@ -1320,8 +1320,8 @@ https://<host>:<port>/moa-id-auth/pvp2/metadata

3.2 Zugangspunkte

Zur Verwendung von OpenID Connect stellt das Modul MOA-ID-Auth zwei Zugangspunkte zur Kommunikation mit der Online-Applikation zur Verfügung. Diese Zugangspunkte bezeichnen die URLs unter welchen das Modul MOA-ID-Auth die entsprechenden OpenID Connect Nachrichten entgegennimmt.

    -
  • AuthCode-Request: https://<host>:<port>/moa-id-auth/oauth3/auth
    Unter dieser URL wird der Authn Request entgegengenommen. Dieser Request startet den Authentifizierungsvorgang an der Online-Applikation. Hier finden Sie Detailinformationen zum Request und zur Response.
    • -
  • AccessToken-Request: https://<host>:<port>/moa-id-auth/oauth3/token
    Unter dieser URL können nach erfolgreicher Authentifizierung die eigentlichen Authentifizierungsdaten am Modul MOA-ID-Auth abgeholt werden. Hier finden Sie Detailinformationen zum Request und zur Response.
    • +
  • AuthCode-Request: https://<host>:<port>/moa-id-auth/oauth2/auth
    Unter dieser URL wird der Authn Request entgegengenommen. Dieser Request startet den Authentifizierungsvorgang an der Online-Applikation. Hier finden Sie Detailinformationen zum Request und zur Response.
    • +
  • AccessToken-Request: https://<host>:<port>/moa-id-auth/oauth2/token
    Unter dieser URL können nach erfolgreicher Authentifizierung die eigentlichen Authentifizierungsdaten am Modul MOA-ID-Auth abgeholt werden. Hier finden Sie Detailinformationen zum Request und zur Response.

3.3 Beschreibung der Nachrichten

Dieser Abschnitt beschreibt die einzelnen OpenID Connect spezifischen Nachrichten, welche zwischen der Online-Applikation und dem Modul MOA-ID-Auth während eines Authentifizierungsvorgangs ausgetauscht werden. Hierbei wird auch auf das Sequenzdiagramm aus Abschnitt 3.1 Bezug genommen.

@@ -1376,7 +1376,7 @@ Folgende Parameter müssen mit dem AuthCode-Request mitgesendet werden, wobe

 

Nachfolgend ein Beispiel für einen OpenID Connect Authentifizierungsrequest an das Modul MOA-ID-Auth.

-
<form method="get" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth3/auth">
+
<form method="get" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth2/auth">
   <input type="hidden" value="code" name="response_type">
   <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo" name="client_id">
   <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo/securearea.action" name="redirect_uri">
@@ -1442,7 +1442,7 @@ Folgende Parameter müssen mit dem AuthCode-Request mitgesendet werden, wobe
 
 
 

 
Nachfolgend ein Beispiel für einen AccessToken Request

-
<form method="POST" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth3/token">
+
<form method="POST" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth2/token">
   <input type="hidden" value="authorization_code" name="grant_type">
   <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo" name="client_id">
   <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo/securearea.action" name="redirect_uri">
-- 
cgit v1.2.3


From 6bcda4bc120c743bab2296c72b22d1db0ba4ccfc Mon Sep 17 00:00:00 2001
From: Thomas Lenz 
Date: Fri, 13 Dec 2019 09:04:58 +0100
Subject: update configuration examples activate MOA-ID mode in configuration
 module as default

---
 id/server/doc/handbook/config/config.html | 99 ++++++++++++++++++++++++-------
 1 file changed, 77 insertions(+), 22 deletions(-)

(limited to 'id/server/doc')

diff --git a/id/server/doc/handbook/config/config.html b/id/server/doc/handbook/config/config.html
index 4fb57cb3a..0b9f7e614 100644
--- a/id/server/doc/handbook/config/config.html
+++ b/id/server/doc/handbook/config/config.html
@@ -60,6 +60,7 @@
     
  • MOA-SP
    • 
     
  • Online-Vollmachen
    • 
     
  • Zentraler eIDAS Knoten
    • 
+    
  • E-ID Anbindung
    • 
     
     
   
  • Protokolle
@@ -119,7 +120,7 @@
                 
  • Privatwirtschaftlicher Bereich
    • 
               
             
-            
  • Demo-Modus für E-ID
    • 
+            
  • Aktivierung der E-ID Anbindung
    • 
             
  • BKU Konfiguration
    • 
             
  • Security Layer für mobile Authententifizierung
    • 
             
  • Test Credentials
    • 
@@ -563,6 +564,77 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet
    
   
 
 
     
    
+
    2.2.2.2.4 Anbindung an das E-ID System
    
+
    Die Anbindung und Weiterleitung an das zentrale E-ID System erfolgt via PVP2 S-Profil (SAML2). Für das in MOA-ID 4.x integrierte E-ID Proxy Authentifizierungsmodul sind folgende Konfigurationsparameter erforderlich.
    
+
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+
    NameBeispielwertBeschreibung
    modules.eidproxyauth.keystore.pathkeys/szrgw.p12Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.x spezifischen Inhalten. (PVP 2.x Metadaten, PVP 2.1 Assertion)
    modules.eidproxyauth.keystore.passwordpass1234Passwort zum Keystore
    modules.eidproxyauth.metadata.sign.alias Name des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.metadata.sign.password Passwort des Schlüssels der zur Signierung der PVP 2.x Metadaten  des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.request.sign.alias Name des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.request.sign.password Passwort des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.response.encryption.alias Name des Schlüssels mit dem die PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.response.encryption.password Passwort des Schlüssels mit dem PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.EID.trustprofileIDeid_metadataMOA-SP TrustProfil welches die vertrauenswürdigen Zertifikate zur Validierung der Metadaten des zentralen E-ID Systemas beinhaltet
    modules.eidproxyauth.EID.entityId Optional: EntityID des IDPs im zentralen E-ID System
    modules.eidproxyauth.EID.metadataUrl Optional: URL auf die SAML2 Metadaten des zentralen E-ID System, sofern diese nicht über die EntityID geladen werden können
    modules.eidproxyauth.required.additional.attributes.x 
    Optional: zusätzliche Attribute welche vom zentralen E-ID System angefordert werden
    
+      
    Attribute werden entspechend PVP2 Attribute-Profil angegeben. Beispiele für die Konfiguration finden Sie in der Beispielkonfiguration
    
+
     
    
 
    2.2.2.3 Protokolle
    
 
    MOA-ID-Auth unterstützt mehrere Authentifizierungsprotokolle. Manche dieser Protokolle benötigen Schlüssel zur Signierung von Authentifizierungsdaten oder Metadaten. In diesem Abschnitt erfolgt die Konfiguration des zu verwendeten Schlüsselmaterials. 
    
 
    2.2.2.3.1 PVP 2.1
    
@@ -1569,8 +1641,8 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID  1.5.1 im Kontext der
 
 
 
     
    
-
    3.2.2 Demo-Modus für E-ID
    
-
    Dieser Abschnitt behandelt den Demo-Modus für die kommende E-ID welcher mit der MOA-ID Version 3.4.2 eingeführt wurde. Ist der Demo-Modus aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle. Als weitere Anpassung wird mit hoher Wahrscheinlichkeit die iFrame Integration der Handy-Signatur nicht mehr zur Verfügung stehen und es erfolgt eine vollformat Weiterleitung an den E-ID. Diese Anpassung ist in der MOA-ID Version 3.4.2 noch nicht berücksichtig.
    
+
    3.2.2 Aktivierung der E-ID Anbindung
    
+
    Dieser Abschnitt behandelt den E-ID Proxy Mode von MOA-ID welcher mit der Version 4.0 eingeführt wurde. Ist der E-ID Proxy Mode aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird, da der Benutzer an das E-ID System zur Authentifizierung weitergeleitet wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle. 
    
 
    Folgende Attribute stehen nicht mehr zur Verfügung:
    
 
      
   
    • EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)
      • 
@@ -1598,28 +1670,11 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID  1.5.1 im Kontext der
     Beschreibung
   
   
-    Demo-Modus aktivieren
+    E-ID aktivieren
     
       
      
      
     X
-    Aktiviert den Demo-Modus für die E-ID in dieser Online Applikation. 
-  
-  
-    Sektoren für Fremd-bPKs
-    wbpk+FN+468924i,BMI+T1
-     
-    X
-    
      Eine CSV Liste von Bereichen für welche die Online Applikation verschlüsselte Fremd-bPKs benötigt. 
      
-      
      Hinweis: Da es sich hierbei nur um eine Demo handelt muss das Schlüsselmaterial für die Verschlüsselung in MOA-ID hinterlegt werden.
      
-  
-  
-    Sektoren für weitere bPKs
-    
      urn:publicid:gv.at:cdid+T1,
      
-      
      urn:publicid:gv.at:wbpk+FN+468924i
      
-     
-    X
-    
      Eine CSV Liste von Bereichen für welche die Online Applikation bPKs aus anderen Bereichen benötogt.
      
-      
      Hinweis: Die Angabe der Bereiche erfolgt mit dem vollständigen Bereichsidentifier inkl. Prefix.
      
+    Aktiviert die Weiterleitung an den E-ID für diese Online Applikation. 
   
 
 
       
      
-- 
cgit v1.2.3


From 30995fdadab5d9446e8ecccab48dac6fafcd7ae4 Mon Sep 17 00:00:00 2001
From: Thomas Lenz 
Date: Wed, 15 Jan 2020 13:52:16 +0100
Subject: update handbook and release infos

---
 id/server/doc/handbook/index.html                  |    2 +-
 .../doc/handbook_v4/additional/additional.html     |  363 ------
 .../doc/handbook_v4/application/application.html   |  220 ----
 id/server/doc/handbook_v4/application/iframe.png   |  Bin 86175 -> 0 bytes
 .../doc/handbook_v4/application/login_button.PNG   |  Bin 70066 -> 0 bytes
 .../doc/handbook_v4/application/mainframe.PNG      |  Bin 59073 -> 0 bytes
 .../handbook_v4/application/sso_sendassertion.PNG  |  Bin 6041 -> 0 bytes
 id/server/doc/handbook_v4/common/LogoEGIZ.png      |  Bin 77395 -> 0 bytes
 id/server/doc/handbook_v4/common/MOA.css           |  501 ---------
 id/server/doc/handbook_v4/common/logo_digAT.png    |  Bin 22964 -> 0 bytes
 id/server/doc/handbook_v4/config/config.html       | 1168 --------------------
 id/server/doc/handbook_v4/index.html               |   55 -
 id/server/doc/handbook_v4/install/install.html     |  331 ------
 id/server/doc/handbook_v4/intro/Blockdiagramm.png  |  Bin 206722 -> 0 bytes
 id/server/doc/handbook_v4/intro/E-ID-Proxy.png     |  Bin 58311 -> 0 bytes
 .../doc/handbook_v4/intro/Gesamtarchitektur.png    |  Bin 477608 -> 0 bytes
 id/server/doc/handbook_v4/intro/anmeldeablauf.png  |  Bin 51158 -> 0 bytes
 id/server/doc/handbook_v4/intro/intro.html         |   84 --
 .../moduledevinfo/ProcessDefinition.xsd            |   53 -
 .../handbook_v4/moduledevinfo/moduledevinfo.html   |  388 -------
 id/server/doc/handbook_v4/protocol/Assertion.xml   |   81 --
 id/server/doc/handbook_v4/protocol/AuthRequest.xml |   38 -
 .../doc/handbook_v4/protocol/idp_metadata.xml      |  188 ----
 .../handbook_v4/protocol/openIDconnect_sequenz.png |  Bin 121367 -> 0 bytes
 id/server/doc/handbook_v4/protocol/protocol.html   |  756 -------------
 .../doc/handbook_v4/protocol/pvp21_sequence.png    |  Bin 38601 -> 0 bytes
 .../doc/handbook_v4/protocol/saml1_sequence.png    |  Bin 32752 -> 0 bytes
 .../protocol/serviceprovider_metadata.xml          |   95 --
 .../doc/handbook_v4/protocol/sso_sequence.png      |  Bin 56152 -> 0 bytes
 id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl     |   41 -
 id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf    |  Bin 146062 -> 0 bytes
 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf  |  Bin 288576 -> 0 bytes
 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl |  128 ---
 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd  |  572 ----------
 .../doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf   |  Bin 577309 -> 0 bytes
 .../doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf   |  Bin 355156 -> 0 bytes
 .../doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf   |  Bin 239502 -> 0 bytes
 .../doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf     |  Bin 286834 -> 0 bytes
 .../doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf     |  Bin 134176 -> 0 bytes
 id/server/doc/handbook_v4/spec/OID-1-0-3.pdf       |  Bin 347041 -> 0 bytes
 .../spec/cs-sstc-schema-assertion-01.xsd           |  194 ----
 .../spec/cs-sstc-schema-protocol-01.xsd            |  127 ---
 .../doc/handbook_v40/additional/additional.html    |  363 ++++++
 .../doc/handbook_v40/application/application.html  |  220 ++++
 id/server/doc/handbook_v40/application/iframe.png  |  Bin 0 -> 86175 bytes
 .../doc/handbook_v40/application/login_button.PNG  |  Bin 0 -> 70066 bytes
 .../doc/handbook_v40/application/mainframe.PNG     |  Bin 0 -> 59073 bytes
 .../handbook_v40/application/sso_sendassertion.PNG |  Bin 0 -> 6041 bytes
 id/server/doc/handbook_v40/common/LogoEGIZ.png     |  Bin 0 -> 77395 bytes
 id/server/doc/handbook_v40/common/MOA.css          |  501 +++++++++
 id/server/doc/handbook_v40/common/logo_digAT.png   |  Bin 0 -> 22964 bytes
 id/server/doc/handbook_v40/config/config.html      | 1168 ++++++++++++++++++++
 id/server/doc/handbook_v40/index.html              |   55 +
 id/server/doc/handbook_v40/install/install.html    |  331 ++++++
 id/server/doc/handbook_v40/intro/Blockdiagramm.png |  Bin 0 -> 206722 bytes
 id/server/doc/handbook_v40/intro/E-ID-Proxy.png    |  Bin 0 -> 58311 bytes
 .../doc/handbook_v40/intro/Gesamtarchitektur.png   |  Bin 0 -> 477608 bytes
 id/server/doc/handbook_v40/intro/anmeldeablauf.png |  Bin 0 -> 51158 bytes
 id/server/doc/handbook_v40/intro/intro.html        |   84 ++
 .../moduledevinfo/ProcessDefinition.xsd            |   53 +
 .../handbook_v40/moduledevinfo/moduledevinfo.html  |  388 +++++++
 id/server/doc/handbook_v40/protocol/Assertion.xml  |   81 ++
 .../doc/handbook_v40/protocol/AuthRequest.xml      |   38 +
 .../doc/handbook_v40/protocol/idp_metadata.xml     |  188 ++++
 .../protocol/openIDconnect_sequenz.png             |  Bin 0 -> 121367 bytes
 id/server/doc/handbook_v40/protocol/protocol.html  |  756 +++++++++++++
 .../doc/handbook_v40/protocol/pvp21_sequence.png   |  Bin 0 -> 38601 bytes
 .../doc/handbook_v40/protocol/saml1_sequence.png   |  Bin 0 -> 32752 bytes
 .../protocol/serviceprovider_metadata.xml          |   95 ++
 .../doc/handbook_v40/protocol/sso_sequence.png     |  Bin 0 -> 56152 bytes
 id/server/doc/handbook_v40/spec/MOA ID 1.x.wsdl    |   41 +
 id/server/doc/handbook_v40/spec/MOA-SPSS-1.3.pdf   |  Bin 0 -> 146062 bytes
 id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.pdf |  Bin 0 -> 288576 bytes
 .../doc/handbook_v40/spec/MOA-SPSS-2.0.0.wsdl      |  128 +++
 id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.xsd |  572 ++++++++++
 .../doc/handbook_v40/spec/MOA_ID_1.2_20040315.pdf  |  Bin 0 -> 577309 bytes
 .../doc/handbook_v40/spec/MOA_ID_1.3_20060315.pdf  |  Bin 0 -> 355156 bytes
 .../doc/handbook_v40/spec/MOA_ID_1.4_20070802.pdf  |  Bin 0 -> 239502 bytes
 .../doc/handbook_v40/spec/MOA_ID_1.4_Anhang.pdf    |  Bin 0 -> 286834 bytes
 .../doc/handbook_v40/spec/MOA_ID_1.5_Anhang.pdf    |  Bin 0 -> 134176 bytes
 id/server/doc/handbook_v40/spec/OID-1-0-3.pdf      |  Bin 0 -> 347041 bytes
 .../spec/cs-sstc-schema-assertion-01.xsd           |  194 ++++
 .../spec/cs-sstc-schema-protocol-01.xsd            |  127 +++
 83 files changed, 5384 insertions(+), 5384 deletions(-)
 delete mode 100644 id/server/doc/handbook_v4/additional/additional.html
 delete mode 100644 id/server/doc/handbook_v4/application/application.html
 delete mode 100644 id/server/doc/handbook_v4/application/iframe.png
 delete mode 100644 id/server/doc/handbook_v4/application/login_button.PNG
 delete mode 100644 id/server/doc/handbook_v4/application/mainframe.PNG
 delete mode 100644 id/server/doc/handbook_v4/application/sso_sendassertion.PNG
 delete mode 100644 id/server/doc/handbook_v4/common/LogoEGIZ.png
 delete mode 100644 id/server/doc/handbook_v4/common/MOA.css
 delete mode 100644 id/server/doc/handbook_v4/common/logo_digAT.png
 delete mode 100644 id/server/doc/handbook_v4/config/config.html
 delete mode 100644 id/server/doc/handbook_v4/index.html
 delete mode 100644 id/server/doc/handbook_v4/install/install.html
 delete mode 100644 id/server/doc/handbook_v4/intro/Blockdiagramm.png
 delete mode 100644 id/server/doc/handbook_v4/intro/E-ID-Proxy.png
 delete mode 100644 id/server/doc/handbook_v4/intro/Gesamtarchitektur.png
 delete mode 100644 id/server/doc/handbook_v4/intro/anmeldeablauf.png
 delete mode 100644 id/server/doc/handbook_v4/intro/intro.html
 delete mode 100644 id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd
 delete mode 100644 id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html
 delete mode 100644 id/server/doc/handbook_v4/protocol/Assertion.xml
 delete mode 100644 id/server/doc/handbook_v4/protocol/AuthRequest.xml
 delete mode 100644 id/server/doc/handbook_v4/protocol/idp_metadata.xml
 delete mode 100644 id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png
 delete mode 100644 id/server/doc/handbook_v4/protocol/protocol.html
 delete mode 100644 id/server/doc/handbook_v4/protocol/pvp21_sequence.png
 delete mode 100644 id/server/doc/handbook_v4/protocol/saml1_sequence.png
 delete mode 100644 id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml
 delete mode 100644 id/server/doc/handbook_v4/protocol/sso_sequence.png
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/OID-1-0-3.pdf
 delete mode 100644 id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd
 delete mode 100644 id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd
 create mode 100644 id/server/doc/handbook_v40/additional/additional.html
 create mode 100644 id/server/doc/handbook_v40/application/application.html
 create mode 100644 id/server/doc/handbook_v40/application/iframe.png
 create mode 100644 id/server/doc/handbook_v40/application/login_button.PNG
 create mode 100644 id/server/doc/handbook_v40/application/mainframe.PNG
 create mode 100644 id/server/doc/handbook_v40/application/sso_sendassertion.PNG
 create mode 100644 id/server/doc/handbook_v40/common/LogoEGIZ.png
 create mode 100644 id/server/doc/handbook_v40/common/MOA.css
 create mode 100644 id/server/doc/handbook_v40/common/logo_digAT.png
 create mode 100644 id/server/doc/handbook_v40/config/config.html
 create mode 100644 id/server/doc/handbook_v40/index.html
 create mode 100644 id/server/doc/handbook_v40/install/install.html
 create mode 100644 id/server/doc/handbook_v40/intro/Blockdiagramm.png
 create mode 100644 id/server/doc/handbook_v40/intro/E-ID-Proxy.png
 create mode 100644 id/server/doc/handbook_v40/intro/Gesamtarchitektur.png
 create mode 100644 id/server/doc/handbook_v40/intro/anmeldeablauf.png
 create mode 100644 id/server/doc/handbook_v40/intro/intro.html
 create mode 100644 id/server/doc/handbook_v40/moduledevinfo/ProcessDefinition.xsd
 create mode 100644 id/server/doc/handbook_v40/moduledevinfo/moduledevinfo.html
 create mode 100644 id/server/doc/handbook_v40/protocol/Assertion.xml
 create mode 100644 id/server/doc/handbook_v40/protocol/AuthRequest.xml
 create mode 100644 id/server/doc/handbook_v40/protocol/idp_metadata.xml
 create mode 100644 id/server/doc/handbook_v40/protocol/openIDconnect_sequenz.png
 create mode 100644 id/server/doc/handbook_v40/protocol/protocol.html
 create mode 100644 id/server/doc/handbook_v40/protocol/pvp21_sequence.png
 create mode 100644 id/server/doc/handbook_v40/protocol/saml1_sequence.png
 create mode 100644 id/server/doc/handbook_v40/protocol/serviceprovider_metadata.xml
 create mode 100644 id/server/doc/handbook_v40/protocol/sso_sequence.png
 create mode 100644 id/server/doc/handbook_v40/spec/MOA ID 1.x.wsdl
 create mode 100644 id/server/doc/handbook_v40/spec/MOA-SPSS-1.3.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.wsdl
 create mode 100644 id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.xsd
 create mode 100644 id/server/doc/handbook_v40/spec/MOA_ID_1.2_20040315.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA_ID_1.3_20060315.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA_ID_1.4_20070802.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA_ID_1.4_Anhang.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/MOA_ID_1.5_Anhang.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/OID-1-0-3.pdf
 create mode 100644 id/server/doc/handbook_v40/spec/cs-sstc-schema-assertion-01.xsd
 create mode 100644 id/server/doc/handbook_v40/spec/cs-sstc-schema-protocol-01.xsd

(limited to 'id/server/doc')

diff --git a/id/server/doc/handbook/index.html b/id/server/doc/handbook/index.html
index 73ece89e3..80d2d3fe8 100644
--- a/id/server/doc/handbook/index.html
+++ b/id/server/doc/handbook/index.html
@@ -29,7 +29,7 @@
    -

    Übersicht zur Dokumentation der Version 3.4.x

    +

    Übersicht zur Dokumentation der Version 4.1.x

    Einführung
    diff --git a/id/server/doc/handbook_v4/additional/additional.html b/id/server/doc/handbook_v4/additional/additional.html deleted file mode 100644 index d7afc1961..000000000 --- a/id/server/doc/handbook_v4/additional/additional.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - MOA-ID - Zusatzinformationen - - - - -
    -
    - -

    MOA-ID-AUTH

    -
    -
    -
    -
    -

    Zusatzinformationen

    - -

    Inhalt

    -
      -
    1. Datenmanagement -
        -
      1. Sessiondaten -
          -
        1. Allgemein
          2. -
        -
        2. -
      2. Logging von Statistikdaten
        3. -
      -
      2. -
    2. Benötigte Netzwerkverbindungen (incoming / outgoing)
      3. -
    3. Revisions-Logging
      4. -
    -

    1 Datenmanagement

    -

    Dieser Abschnitt spezifiziert jene Datensätze die während eines Anmeldevorgangs durch das Modul MOA-ID-Auth temporär oder permanent gespeichert werden. Hierbei handelt es sich sowohl um temporäre Sessiondaten als auch um dauerhaft gespeicherte Statistikdaten.

    -

    1.1 Sessiondaten

    -

    Dieser Abschnitt behandelt jene Informationen die das Modul MOA-ID-Auth während eines Authentifizierungsvorgangs oder während einer aktiven Single Sign-On Session im Speicher hält. Diese Datensätze werden nach Beendigung des Anmeldevorgangs, bei einfacher Anmeldung, oder nach Beendigung der Single Sign-On Session gelöscht. Die nachfolgenden Unterkapitel geben eine Aufstellung jener Daten die von MOA-ID im jeweiligen Falle gespeichert werden.

    -

    1.1.1 Allgemein

    -

    Folgende Daten müssen mindestens von MOA-ID gecached werden um einen korrekten Anmeldevorgang zu ermöglichen.

    - - - - - - - - - - - - - - - - - - - - - -

    Element

    Beschreibung

    Authentication Request

    Dieser wird von der Online-Applikation als Start des Anmeldevorgangs übertragen.

    Session ID

    Wird von MOA-ID generiert und dient zur Identifikation von Datensätzen.

    Signaturzertifikat

    Das Signaturzertifikat, welches zur Signierung des Authentifizierungsblocks verwendet wurde.

    AuthTimeStampZeitpunkt an dem sich die Benutzerin oder der Benutzer an MOA-ID-Auth authentifiziert hat.
    -

    1.2 Logging von Statistikdaten

    -

    Zusätzlich zu den Daten aus den temporären Sessiondaten werden vom Modul MOA-ID-Auth auch Logging- und Statistikdaten generiert, welche nicht automatisiert gelöscht werden. Diese Daten dienen der Statuskontrolle und zur Protokollierung von Anmeldevorgängen an MOA-ID-Auth. Von MOA-ID-Auth werden folgende Statistikdaten je Anmeldevorgang gespeichert, wobei je nach Art der Anmeldung nicht alle Datenelemente gefüllt werden. Die nachstehende Tabelle beschreibt den maximalen Umfang der Loggingdaten, wobei keine Informationen zur anmeldenden Person gespeichert werden.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Element

    Beschreibung

    timestamp

    Datum und Uhrzeit des Eintrags.

    OAID

    Eindeutige Datenbank ID der Online-Applikation.

    OAURLPrefix

    Publik URL Prefix der Online-Applikation

    OAFriendlyName

    Bezeichnung der Online-Applikation

    isBusinessService

    „True“ wenn die Online-Applikation aus dem privatwirtschaftlichen Bereich stammt.

    OATarget

    Bereichskennzeichen der Online-Applikation (Target oder privatwirtschaftlicher Bereich)

    BKUType

    Art der Bürgerkartenumgebung die für den Anmeldevorgang verwendet wurde. (online, local, handy)

    BKUURL

    URL der verwendeten Bürgerkartenumgebung

    isSSOLogin

    „True“ wenn die die Anmeldung als Teil einer SSO Anmeldung erfolgt ist.

    isMandateLogin

    „True“ wenn die Anmeldung in Vertretung erfolgt ist.

    MandateType

    Art der verwendeten Vollmacht (Einzelprofile des Vollmachtenservice oder OID des Organwalters / berufsmäßigen Parteienvertreters)

    MandatorType

    „jur“ / „nat“ je nach Art der vertretenen juristischen oder natürlichen Person

    isPV

    „True“ wenn die Anmeldung in Vertretung durch einen Organwalter oder berufsmäßigen Parteienvertreter erfolgt ist.

    PVOID

    OID des Organwalter oder berufsmäßigen Parteienvertreter

    ProtocolType

    Type des für die Anmeldung verwendeten Authentifizierungsprotokolls. (PVP21, OpenID, SAML1)

    ProtocolSubType

    Nähere Spezifizierung des Protokolltyps. (Im Falle von PVP 2.1: POST oder Redirect)

    ExceptionType

    Typ des Fehlers der während des Anmeldevorgangs aufgetreten ist. Aktuell werden folgende Typen unterschieden:

    -
      -
    • bku: Fehler während der Kommunikation mit der Bürgerkartenumgebung.
      • -
    • moa-sp: Fehler bei der Kommunikation mit MOA-SP oder der Signaturprüfung.
      • -
    • mandate: Fehler beim Zugriff auf das Online-Vollmachten Service.
      • -
    • moa-id: Fehler während des Authentifizierungsvorgangs.
      • -
    • unknown: für allgemeine Fehler die keinem der oben genannten Typen entsprechen.
      • -

    ExceptionCode

    Fehlercode des aufgetretenen Fehlers falls vorhanden.

    ExceptionMessage

    Fehlermeldung in textueller Form (max. 255 Zeichen lang)

    -

     

    -

    2 Benötigte Netzwerkverbindungen (incoming / outgoing)

    -

    Für die Betrieb des Modules MOA-ID-Auth werden Netzwerkverbindungen zu externen Service benötigt. Die nachfolgende Tabelle gibt eine Aufstellung der benötigten Verbindungen und eine kurze Beschreibung über deren Funktion.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ServiceURLPortRichtungBeschreibung

    MOA-ID-Auth

    		*80, 443eingehend

    Front-Channel und Back-Channel Verbinding zum IDP

    MOA-ID-Auth

    		*80, 443ausgehendAbholen von Template oder PVP 2.1 Metadaten
    LDAP*389, 636ausgehendZertifikatsprüfung

    OSCP / CRL

    		*80, 443ausgehend

    Zertifikatsprüfung

    E-ID Systemvollmachten.stammzahlenregister.gv.at
    - Test: https://eid.egiz.gv.at/idp/shibboleth    		443ausgehendSAML2 Metadaten des E-ID System
    -

     

    -

    3 Revisions Logging

    -

    Ab der Version 3.x von MOA-ID-Auth steht zusätzlich zum normalen Logging und zur Generierung von Statisikdaten ein spezielles Reversions Logging zur Verfügung. Dieses Revisions Logging erstellt ein spezielles Log welches Informationen zum Identifikations- und Authentifikationsprozess mit Zeitstempel und Eventcode beinhaltet. Die Events, welche durch dieses Log aufgezeichnet werden lassen sich je MOA-ID-Auth Instanz und je Online-Applikation konfigurieren. Das Revisions Logging kann über die folgende Zeilen in der log4j Konfiguration der MOA-ID Instanz konfiguriert werden:

    -

    log4j.logger.at.gv.egiz.eventlog.plain.all=info,reversion

    -

    log4j.appender.reversion=org.apache.log4j.RollingFileAppender
    - log4j.appender.reversion.File=$logDirectory/moa-id-reversion.log
    - log4j.appender.reversion.MaxFileSize=10000KB
    - log4j.appender.reversion.MaxBackupIndex=9999
    - log4j.appender.reversion.layout=org.apache.log4j.PatternLayout
    - log4j.appender.reversion.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %t | %m%n

    -

     

    -

    Die nachstehenden Tabellen beschreibt alle Events welche aktuell in MOA-ID zur Verfügung stehen, wobei die erste Tabelle alle Basisevents beinhaltet die von MOA-ID auf jeden Fall geloggt werden. Die in der zweiten Tabelle angegebenen Events sind immer einer Session und einer Transaktion aus Tabelle 1 zugeordnet und können durch die MOA-ID Konfiguration ausgewählt werden.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    EventCode

    Wert

    Beschreibung

    1000

    SessionID

    Eine neue Session wurde mit der angegebenen ID gestartet

    1001

    SessionID

    Die Session mit der angegebenen ID wurde beendet

    1002

    IP Adresse

    IP Addresse des Hosts der die Session geöffnet hat

    1003

    SessionID

    Die Session mit der angebenden ID wurde wegen eines Fehler beendet

    1100

    TransaktionsID

    Eine neue Transaction wurde mit der angegebenen ID gestartet.  Eine Transaktion ist immer eine Session zugeordnet

    1101

    TransaktionsID

    Die Transkation mit der angegebenen ID wurde beendet

    1102

    IP Adresse

    IP Addresse des Hosts der die Transaction geöffnet hat

    1103

    TransaktionsID

    Die Transkation mit der angebenden ID wurde wegen eines Fehler beendet

    -

     

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    EventCode

    Wert

    Beschreibung

    3000

    Protokolltype

    Type des verwendeten Authentifizierungsprotokolls (OpenID Connect, PVP2, STORK, SAML1)

    3300

     

    SAML1 StartAuthentication Request

    4000

     

    Identifizierungs- und Authentifizierungsprozess wurde gestartet

    4001

     

    Identifizierungs- und Authentifizierungsprozess wurde beendet

    5000

    bPK

    bPK bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

    5001

    OID

    OID bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

    5002

    JSON String

    Pseudoanonymisierte Personendaten der sich anmeldeten natürlichen Person.

    5100

    Vollmachtstype

    Type der ausgewählten Vollmacht

    5101

    jur / nat

    Vollmacht - Type der vertretenen Person (Juristische / natürliche Person)

    5102

    JSON String

    Pseudoanonymisierte Personendaten der vertretenen natürlichen Person.

    5103

    baseID

    Stammzahl der vertretenen juristischen Person

    6300EntityIDZentrales E-ID System ausgewählt
    6301RequestIDZentrales E-ID System kontaktiert
    6302ResponseIDGültige Response vom E-ID System erhalten
    6303 Ungültige Response oder Fehlercode vom E-ID System erhalten
    6304 Gültige Attribute vom E-ID System erhalten
    -

     

    -

    Einzelne Events werden um einen Transaktionsparameter ergänzt, welcher in der Spalte Wert beschrieben ist.
    -

    -

    Die pseudoanonymisierten Personendaten für natürliche Personen werden anhand des nachfolgenden Schemas generiert. Als pseudoanonymisiertes Personendatum dient der SHA256 Hash über die in eine JSON Struktur eingetragenen Personendaten. Hierfür wird das folgende JSON Schema verwendet, welches als Input für die SHA256 Berechnung dient.

    -


    - {"person":{"givenname":"Vorname der Person","familyname":"Nachname der Person","dateofbirth":"Geburtsdatum der Person"},"salt":"Zufallszahl"}
    -

    -

    Anschließend wird das pseudoanonymisiert Personendatum als JSON Wert bei den entsprechenden Events eingetragen. Der eingetragener JSON Wert entspricht dem folgenden Schema

    -


    - {"hash":"BASE64 codierte Personendatum","salt:"Zufallzahl welche zur Generierung des Personendatums verwendet wurde"}

    -

     

    -
    - - diff --git a/id/server/doc/handbook_v4/application/application.html b/id/server/doc/handbook_v4/application/application.html deleted file mode 100644 index 60732acaf..000000000 --- a/id/server/doc/handbook_v4/application/application.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - MOA-ID - Anwendungen - - - - -
    -
    - -

    MOA-ID-AUTH

    -
    -
    -
    -
    -

    Anwendungen

    - -

    Inhalt

    -
      -
    1. Allgemeines
      2. -
    2. Integration in bestehende Online-Applikationen -
        -
      1. Bürgerkartenauswahl -
          -
        1. Request aus einem iFrame
          2. -
        2. Request aus dem Hauptframe
          3. -
        -
        2. -
      2. Single Sign-On Anmeldeabfrage
        3. -
      -
      3. -
    3. Demo Applikationen -
        -
      1. PVP 2.1 Demo -
          -
        1. Installation
          2. -
        2. Konfiguration Demo Applikation
          3. -
        3. Konfiguration von MOA-ID-Auth
          4. -
        4. Anwendung
          5. -
        -
        2. -
      -
      4. -
    - -

    1 Allgemeines

    -

    Das erste Kapitel behandelt die Integration der von MOA-ID-Auth generierten Bürgerkartenauswahl in bestehende Online-Applikationen. Zusätzlich zur Beschreibung ist MOA-ID auch eine PVP 2.1 Demo Applikation beigelegt. Die Konfiguration und Verwendung dieser Demo Applikation ist Inhalt des letzten Kapitels.

    -

    2 Integration in bestehende Online-Applikationen

    -

    Ab MOA-ID 2.0 wird die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage standardmäßig vom Modul MOA-ID-Auth bereitgestellt und muss nicht mehr durch den Service Provider implementiert werden.

    -

    Die im Modul MOA-ID-Auth hinterlegten Standard Templates (Bürgerkartenauswahl, Single Sign-On Anmeldeabfrage) unterstützt Responsive Design und passt sich somit in einem weiten Bereich an die aktuelle Fenstergröße an, wodurch eine individuelle Integration der von MOA-ID-Auth erzeugten Formulare möglich ist. Zusätzlich bietet das Konfigurationstool die Möglichkeit der online-applikationsspezifischen Anpassung der Standard Templates. Mit dieser Funktion können einzelne Parameter der Standard Templates an die Online-Applikation individualisiert werden um die Integration weiter zu verfeinern.

    -

    Hinweis: Es besteht jedoch auch die Möglichkeit der Hinterlegung von vollständig benutzerdefinierten online-applikationsspezifischen Templates für die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage (siehe hier).

    -

    2.1 Bürgerkartenauswahl

    -

    Die Bürgerkartenauswahl wird ab MOA-ID 2.0 standardmäßig von MOA-ID-Auth, als Antwort auf einen eingehenden Authentifizierungsrequest, bereitgestellt. Dem zu Folge müssen die aus MOA-ID 1.5.1 bekannten Parameter (target, bkuURL, template, usemandate) nicht mehr im Authentifizierungsrequest an MOA-ID-Auth übergeben werden und es kann ein standardkonformer Protokollrequest verwendet werden. Die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl in der Online-Applikation des Service Providers steht jedoch weiterhin als Legacy Variante zur Verfügung.

    -

    Die Integration der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl in eine bestehende Online-Applikation kann auf zwei Arten erfolgen. Bei beiden Varianten erfolgt der Login Vorgang (senden des Authentifizierungsrequests an MOA-ID-Auth) durch den Klick auf einen Login Button. Die Auswahl der Bürgerkartenumgebung erfolgt somit erst im zweiten Schritt. Das Sequenzdiagramm eines solchen Anmeldevorgangs finden Sie hier und die nachfolgende Grafik zeigt ein Beispiel zur Integration eines Login Buttons.

    -
    Integration Login Button
    -

    2.1.1 Request aus einem iFrame

    -

    Bei dieser Variante wird der Authentifizierungsrequests aus einem iFrame, welcher in die Online-Applikation eingebunden ist, abgesetzt. MOA-ID-Auth antwortet auf diesen Request mit der konfigurierten Bürgerkartenauswahl welche durch Verwendung des iFrame in die Online-Applikation eingebunden werden kann. Die nachfolgende Grafik zeigt ein Beispiel für die von MOA-ID-Auth bereitgestellte Bürgerkartenauswahl, welche nach Betätigung des Login Buttons im iFrame dargestellt wird.

    -
    Bürgerkartenauswahl im iFrame
    -

    Hinweis: Bei dieser Variante wird die Assertion ebenfalls an den iFrame ausgeliefert wodurch der authentifizierte Bereich der Online-Applikation im iFrame dargestellt wird. Dieses Verhalten kann durch eine online-applikationsspezifischen Anpassung der Standard Templates und dem Parameter Targetparameter unterbunden werden.

    -

    2.1.2 Request aus dem Hauptframe

    -

    Bei dieser Variante wird der Authentifizierungsrequests direkt aus dem aktuell offenen Browserfenster an MOA-ID-Auth gesendet. In diesem Fall wird die Bürgerkartenauswahl fensterfüllend im Browser dargestellt und die Benutzerin oder der Benutzer befindet sich nicht mehr in der Domain der Online-Applikation (Service Provider). Nach erfolgreicher Authentifizierung wird die Benutzerin oder der Benutzer an die Online-Applikation zurückgeleitet. Die nachfolgende Grafik zeigt die Bürgerkartenauswahl im seitenfüllenden Layout.

    -
    Bürgerkartenauswahl im seitenfüllenden Layout
    -

    2.2 Single Sign-On Anmeldeabfrage

    -

    Wird für die Integration in die Online-Applikation die Variante mit dem Login Button und der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl verwendet (iFrame oder Hauptframe), ergeben sich für die Single Sign-On Anmeldeabfrage keine zusätzlichen Anforderungen. Im Falle einer aktiven Single Sign-On Session, würde MOA-ID-Auth mit der Single Sign-On Anmeldeabfrage anstatt der Bürgerkartenauswahl antworten. Auch in diesem Fall stehen beide Möglichkeiten der Integration, identisch zum Kapitel Bürgerkartenauswahl, zur Verfügung. Die nachfolgende Grafik zeigt eine Single Sign-On Abfrage welche je nach verwendeter Variante die Bürgerkartenauswahl, in den zuvor gezeigten Beispielen, ersetzen würde.

    -
    Single Sign-On Anmeldeabfrage
    -

    Hinweis: Wird für die Integration der Bürgerkartenauswahl jedoch die Legacy Variante verwendet (direkte Integration der Bürgerkartenauswahl in die Online-Applikation) kann es zu Inkompatibilitäten mit der Single Sign-On Anmeldeabfrage kommen, da diese Abfrage von MOA-ID-Auth generiert werden muss und eine direkte Integration in eine Online-Applikation nicht möglich ist.

    -

    3 Demo Applikationen

    -

    Dieser Abschnitt behandelt die Konfiguration und Verwendung der bei MOA-ID beigelegten Demo Applikationen.

    -

    3.1 PVP 2.1 Demo

    -

    Die PVP 2.1 Demo stellt das Minimalbeispiel einer Online-Applikation dar, welche zur Authentifizierung das Protokoll PVP 2.1 verwendet. Die nachfolgenden Abschnitte beschreiben die Installation, Konfiguration und Verwendung der PVP 2.1 Demo Applikation.

    -

    Hinweis: Der Source Code der PVP 2.1 Demo Applikation ist im Order $MOA_ID_AUTH_INST/source/moa-id-oa verfügbar. Jedoch ist die Validierung der PVP 2.1 Assertion in dieser Version nicht vollständig implementiert und müsste bei Verwendung in einem Produktivsystem noch erweitert werden.

    -

    3.1.1 Installation

    -

    Für die Installation der Demo Applikation wird ein Apache Tomcat benötigt. Die Konfiguration dieser Tomcat Instanz ist identisch zur Konfiguration der Tomcat Instanz der Module MOA-ID-Auth und MOA-ID-Configuration.

    -
    3.1.1.1 Einsatz der Demo Applikation in Tomcat
    -
      -
    • Die Datei $MOA_ID_AUTH_INST/moa-id_oa.war enthält das einsatzfertige Webarchiv der Demo Applikation und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-oa entpackt.
      • -
    • Die Konfigurationsdatei mit der Basiskonfiguration für die Demo Applikation und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id-oa). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration der Demo Applikation dienen kann, finden Sie hier.
      -
      • -
    • Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • -
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben): -
        -
      • moa.id.demoOA: Pfad und Name der Basiskonfigurationsdatei für die Demo Applikation. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • -
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Client-Zertifikate (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • -
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • -
      -
      • -
    -
    3.1.1.2 Einsatz der Demo Applikation in Tomcat
    -

    Das starten und stoppen der Demo Applikation erfolgt identisch zur Beschreibung für die Module MOA-ID-Auth und MOA-ID-Configuration.

    -

    Ein erfolgreicher Start der Demo Applikation ist an folgender Log-Meldung ersichtlich:

    -
    INFO at.gv.egovernment.moa.id.demoOA.Configuration  - Demo Application initializaten finished.
    -

    Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

    -
    http://<host>:<port>/moa-id-oa/
    -

    bzw.

    -
    -https://<host>:<port>/moa-id-oa/
-
    -

    3.1.2 Konfiguration Demo Applikation

    -

    Die zentrale Konfigurationsdatei für die Demo Applikation wird der Java Virtual Machine, in der die Demo Applikation läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.demoOA als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    -
    moa.id.demoOA=C:/Programme/apache/tomcat-4.1.30/conf/moa-id-oa/oa.properties
    -

    Diese Konfigurationsdatei beinhaltet folgende Parameter.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    general.publicURLContexthttps://localhost:8443/moa-id-oa

    URL unter der das Modul MOA-ID-OA erreichbar ist.

    -

    Hinweis: Ist dieser Parameter nicht vorhanden wird die URL aus dem ersten Request generiert.

    general.login.pvp2.idp.metadata.urlhttps://demo.egiz.gv.at/moa-id-auth/
    - pvp2/metadata    		URL unter der die PVP2.1 Metadaten des IDP abgeholt werden können.
    general.login.pvp2.idp.metadata.certificatekeys/moa_idp.crtZertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieses Zertifikat wird zur Prüfung der IDP Metadaten verwendet.
    general.login.pvp2.idp.metadata.entityIDhttps://demo.egiz.gv.at/moa-id-auth/pvp2/metadataEntityID des IDP in den Metadaten (Details siehe PVP2.1 Spezifikation)
    general.login.pvp2.idp.sso.logout.urlhttps://demo.egiz.gv.at/moa-id-auth/LogOut?redirect=
    - https://demo.egiz.gv.at/moa-id-oa    		URL zum Single Log-Out (SLO) Service des IDP. Details zum SLO Service von MOA-ID-Auth finden Sie hier.
    general.login.pvp2.metadata.entities.namePVP 2.1 DemoName der Applikation, welcher in den Metadaten der Applikation angegeben wird
    general.login.pvp2.keystore.urlkeys/application[password].p12Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.
    general.login.pvp2.keystore.passwordpasswordPasswort des Keystores
    general.login.pvp2.keystore.typePKCS12

    Type des Keystores. Aktuell werden folgende Keystore Typen unterstützt

    -
      -
    • PKCS12: PKCS12 Keystore
      • -
    • JKS: Java-Keystore
      • -
    general.login.pvp2.keystore.metadata.key.aliaspvp_metadataName des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll
    general.login.pvp2.keystore.metadata.key.passwordpasswordPasswort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.
    general.login.pvp2.keystore.authrequest.encryption.key.aliaspvp_encryptionName des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll
    general.login.pvp2.keystore.authrequest.encryption.key.passwordpasswordPasswort des Schlüssels zum Verschlüsseln der Anmeldeinformation.
    general.login.pvp2.keystore.authrequest.key.aliaspvp_requestName des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.
    general.login.pvp2.keystore.authrequest.key.passwordpasswordPasswort des Schlüssels zum Signieren des Authentifizierungsrequests.
    -

     

    -

    Die Metadaten des Modules MOA-ID-Configuration werden dynamisch erstellt und stehen unter folgender URL zum Download bereit.

    -
    -http://<host>:<port>/moa-id-oa/servlet/metadata
    -

    bzw.

    -
    -https://<host>:<port>/moa-id-oa/servlet/metadata
    -

    Nach erfolgreicher Konfiguration muss die Tomcat Instanz neu gestartet werden.

    -

    3.1.3 Konfiguration von MOA-ID-Auth

    -

    Bevor ein Anmeldevorgang gestartet werden kann muss die Demo Applikation auch als Online-Applikation für das Modul MOA-ID-Auth konfiguriert werden. Hierfür kann das Konfigurationstool (Modul MOA-ID-Configuration) verwendet werden. Tragen Sie die Demo Applikation als Online-Applikation bei Ihrer MOA-ID-Auth Instanz ein. Eine Beschreibung der einzelnen Konfigurationsparameter finden Sie hier.

    -

    3.1.4 Anwendung

    -

    Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

    -
    http://<host>:<port>/moa-id-oa/
    -

    bzw.

    -
    -https://<host>:<port>/moa-id-oa/
-
    -

    Die Startseite der Demo Applikation beinhaltet einen kurzen Beschreibungstext und den Login Button zum Start des Anmeldevorgangs. Für die Integration der Bürgerkartenumgebung verwendet die Demo die im Kapitel 2.1.1 beschriebene iFrame Variante. Nach Betätigung des Login Buttons wird der Anmeldevorgang gestartet. Der Protokollablauf ist identisch zu dem im Kapitel Protokolle beschriebenen Ablauf für das PVP 2.1 Protokoll.

    -

    Konnten die Metadaten und der Authentifizierungsrequest erfolgreich verifiziert werden, wird anschließend die Bürgerkartenauswahl in der Hauptseite der Demo Applikation dargestellt. Wählen Sie nur die gewünschte Authentifizierungsvariante. Danach erfolgt die Authentifizierung mittels der gewählten Variante.

    -

    Nach erfolgreicher Authentifizierung werden Sie an die Demo Applikation zurückgeleite. Diese extrahiert einige Basisdaten aus der PVP 2.1 Assertion und stellt diese im Browser dar. Zusätzlich kann die gesamte übertragene PVP 2.1 Assertion angezeigt werden.

    -

    Wurde der Anmeldevorgang durch einen Fehler abgebrochen werden Sie ebenfalls an die Demo Applikation zurückgeleitet. In diesem Fall wird eine kurze Fehlerbeschreibung dargestellt. Eine ausführliche Fehlerbeschreibung kann der PVP 2.1 Assertion entnommen werden.

    -

     

    -
    - - diff --git a/id/server/doc/handbook_v4/application/iframe.png b/id/server/doc/handbook_v4/application/iframe.png deleted file mode 100644 index dcc6a932d..000000000 Binary files a/id/server/doc/handbook_v4/application/iframe.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/application/login_button.PNG b/id/server/doc/handbook_v4/application/login_button.PNG deleted file mode 100644 index 36d8921ce..000000000 Binary files a/id/server/doc/handbook_v4/application/login_button.PNG and /dev/null differ diff --git a/id/server/doc/handbook_v4/application/mainframe.PNG b/id/server/doc/handbook_v4/application/mainframe.PNG deleted file mode 100644 index 0e597d3fc..000000000 Binary files a/id/server/doc/handbook_v4/application/mainframe.PNG and /dev/null differ diff --git a/id/server/doc/handbook_v4/application/sso_sendassertion.PNG b/id/server/doc/handbook_v4/application/sso_sendassertion.PNG deleted file mode 100644 index 1a2ca6a67..000000000 Binary files a/id/server/doc/handbook_v4/application/sso_sendassertion.PNG and /dev/null differ diff --git a/id/server/doc/handbook_v4/common/LogoEGIZ.png b/id/server/doc/handbook_v4/common/LogoEGIZ.png deleted file mode 100644 index 39f05d131..000000000 Binary files a/id/server/doc/handbook_v4/common/LogoEGIZ.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/common/MOA.css b/id/server/doc/handbook_v4/common/MOA.css deleted file mode 100644 index f8fd01d8c..000000000 --- a/id/server/doc/handbook_v4/common/MOA.css +++ /dev/null @@ -1,501 +0,0 @@ -.container { - margin: auto; - max-width: 1000px; - padding-left: 20px; - padding-right: 20px; -} - -body -{ - font-family: "Roboto", sans-serif; - - color: #000; - font-size: medium; - font-weight: 300; - margin-left: 0px; - margin-right: 0px; - margin-top: 0px; - background-color: white; - letter-spacing: 0.05em; - -} - -b{ - font-weight: 500; -} - -p -{ - margin-top: 0pt; - margin-bottom: 0.5em; - text-align: justify; - -} - -.centeredimage{ - text-align: center; - width:100%; -} - -.index{ - padding-left: 0; -} -.index a{ - color: #666; -} -.index a:hover -{ - color:#E10319; -} -.index ul{ - list-style-type: none; -} -.index li{ - list-style-type: none; -} - -td{ - font-weight: 300; -} - - - -pre -{ - font-family: "Courier New", monospace; - font-size: 90%; - background-color: #DDD; - color: #000000; - margin-left:1.5%; - margin-right:1.5%; - margin-top: 1em; - margin-bottom: 1em; - border: #008000 none; - white-space: pre-wrap; -} - -hr -{ - color: #000080; - background-color: #000080; - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -table.fixedWidth -{ - width: 97%; - margin-left:1.5%; - margin-right:1.5%; - margin-top: 1em; - margin-bottom: 1em; - color:#404040; -} -table.varWidth -{ - margin-left:1.5%; - margin-top: 1em; - margin-bottom: 1em; -} - -table.configtable{ - width:100%; - border-collapse: collapse; - border-style:solid; - border-color: #404040; - border-width: 2px; - font-family: "Roboto",sans-serif -} -table.configtable th{ - border-style:solid; - border-color: #404040; - border-width: 2px; - padding:3px; -} -table.configtable th{ - font-weight: 300; - font-size: 120%; -} -table.configtable td{ - border-style:solid; - border-color: #404040; - border-width: 1px; - border-left-width: 2px; - border-right-width: 2px; - padding:3px; - font-weight: 300; -} - - -th -{ - text-align: left; - -} - -h1 -{ - font-size: 220%; - font-weight: 400; -} - -h2 -{ - letter-spacing: 1px; - font-size: 170%; - font-weight: 300; - -} - -h3 -{ - letter-spacing: 1px; - font-size: 160%; - font-weight: 300; -} - -h4 -{ - letter-spacing: 1px; - font-size: 150%; - font-weight: 300; - -} - -h5 -{ - letter-spacing: 1px; - font-size: 140%; - font-weight: 300; -} - -h6 -{ - letter-spacing: 1px; - font-size: 130%; - font-weight: 300; -} - -code -{ - font-family: "Roboto","Courier New", Courier, monospace; - font-size: 90%; - font-weight: 400; - color: #000000; -} - -dd -{ - margin-top: 0.8em; - margin-bottom: 0.8em; - text-align: justify; - -} - -dt -{ - margin-top: 0.8em; - color: #E10319; -} -dt a{ - text-decoration:none; -} - -ol -{ - margin-top: 0.5em; - margin-bottom: 0.5em; - padding-left:0.8em; -} - -ol.alpha -{ - list-style-type: lower-alpha -} - -li -{ - margin-top: 0.25em; - margin-bottom: 0.25em; - text-align: justify; -} - -a:hover -{ - color: #E10319; -} -a{ - color: #666; - text-decoration: none; -} - - -.title -{ - text-align: left; - font-size: 200%; - color: #000000; - font-family: "Roboto", sans-serif; - margin-top: 0.4em; - margin-bottom: 0.4em; -} - -.subtitle -{ - text-align: left; - font-size: 133%; - color: #000000; - font-family: "Roboto", sans-serif; - margin-top: 0.4em; - margin-bottom: 0.4em -} - -.glossaryTerm -{ - font-style: italic; - color: #006699 -} - -.example -{ - font-family: "Roboto", sans-serif; - background-color: #CCFFFF; - color: #000000; - margin: 0pt 0pt; - border: #008000 none -} - -.schema -{ - font-family: "Courier New", monospace; - background-color: #FFFFCC; - color: #000000; - margin: 0pt 0pt; - border: #008000 none -} - -.documentinfo -{ - font-family: "Roboto", sans-serif; - font-size: 100%; -} - -.ol-contents -{ - font-size: 100%; - margin-top: 0.0em; - margin-bottom: 0.0em; -} - -.li-contents -{ - font-size: 100%; - margin-top: 0.0em; - margin-bottom: 0.0em; -} - -.logoTitle -{ - text-align: center; - font-size: 200%; -} - -.logoTable -{ - margin-bottom: 0px; - margin-left: 0px; - background: linear-gradient(#FAFAFA, #F5F5F5); - border-bottom: 1px solid #EEE; - border-color: #818286; - -} - -.superscript -{ - vertical-align: super; - font-size: 66%; -} - -.term -{ - font-style: italic; -} - -.strongerterm -{ - font-style: italic; - font-weight: 500; -} - - -.comment -{ - color: #000000; - background: #ffff00; - font-style: italic -} - -.addedErrata12 -{ - color: #FF0000; - background-color: #FFEEEE; - text-decoration: underline -} - -.deletedErrata12 -{ - color: #999999; - background-color: #EEEEEE; - text-decoration: line-through -} - -.added12 -{ - color: #FF0000; - text-decoration: underline; - background-color: #F8F0FF; -} - -.deleted12 -{ - color: #999999; - text-decoration: line-through -; background-color: #f8f0ff -} - -.rfc2119Keyword -{ - font-variant: small-caps; - font-style: normal; -} - -.remark { font-style: italic} - -li.faq -{ - margin-top: 1.5em; - margin-bottom: 1.5em; -} - -.faq-question -{ - color: #000080; - font-size: 100%; - font-family: "Roboto", sans-serif; - font-weight: 300; - margin-bottom: 0.4em; -} -/*********************************/ -@media ( min-width :600px) { - #headline { - /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ - background: linear-gradient(#FAFAFA, #F5F5F5); - border-bottom: 1px solid #EEE; - - } - #headline br { - clear: both; - } - - #headline h1 { - color: #404040; - padding-right: 1em; - padding-top: 0.15em; - margin-bottom: 0; - float: right; - } - #headline img { - width: 300px; - padding-left: 0; - padding-top: 35px; - padding-bottom:20px; - } - - .smallImgDiv{ - width:50%; - margin:auto; - margin-bottom:40px; - margin-top:20px; - } - .smallImgDiv img{ - max-width: 100%; - max-height: 100%; - margin:auto; - display: block; - } - .largeImgDiv{ - width:100%; - margin: auto; - margin-bottom:40px; - margin-top:20px; - } - .largeImgDiv img{ - max-width: 100%; - max-height: 100%; - margin:auto; - display: block; - } -} -/*****************************/ -@media ( max-width :599px) { - #headline { - /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ - background: linear-gradient(#FAFAFA, #F5F5F5); - border-bottom: 1px solid #EEE; - } - - #headline img { - width: 150px; - padding-left: 0; - padding-top: 0.5em; - padding-bottom:0.5em; - } - #headline br { - clear: both; - } - #demologin { - width: 100%; - box-sizing: border-box; - border: 1px solid; - border-radius: 1px; - border-color: #818286; - background: #F5F5F5; - height: 182px; - width: 242px; - margin-top: 18px; - padding-left:0; - } - #headline h1 { - color: #404040; - padding: 0; - margin-bottom: 0; - margin-top: 0; - text-align: center; - } - .smallImgDiv{ - width:100%; - margin:auto; - margin-bottom:40px; - margin-top:20px; - } - .smallImgDiv img{ - max-width: 100%; - max-height: 100%; - margin:auto; - display: block; - } - .largeImgDiv{ - width:100%; - margin: auto; - margin-bottom:40px; - margin-top:20px; - } - .largeImgDiv img{ - max-width: 100%; - max-height: 100%; - margin:auto; - display: block; - } -} - - diff --git a/id/server/doc/handbook_v4/common/logo_digAT.png b/id/server/doc/handbook_v4/common/logo_digAT.png deleted file mode 100644 index 4f36681e2..000000000 Binary files a/id/server/doc/handbook_v4/common/logo_digAT.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/config/config.html b/id/server/doc/handbook_v4/config/config.html deleted file mode 100644 index ad5592c54..000000000 --- a/id/server/doc/handbook_v4/config/config.html +++ /dev/null @@ -1,1168 +0,0 @@ - - - - - - MOA-ID - Konfiguration - - - - - -
    -
    - -

    MOA-ID

    -
    -
    -
    -
    -

    Konfiguration

    - -

    Inhalt

    -
      -
    1. -

      Übersicht

      -
        -
      1. Empfohlener Konfigurationsablauf
        2. -
      -
      2. -
    2. Basiskonfiguration -
        -
      1. MOA-ID-Configuration -
          -
        1. Bekanntmachung der Konfigurationsdatei
          2. -
        2. Konfigurationsparameter -
            -
          1. Allgemeine Konfigurationsparameter
            2. -
          2. Datenbankzugriff
            3. -
          3. Bürgerkarten LogIn
            4. -
          4. Mailversand
            5. -
          -
          3. -
        3. Initialisierung des Modules MOA-ID-Configuration
          4. -
        4. Benutzerverwaltung -
            -
          1. Einen neuen Benutzer erstellen
            2. -
          2. Benutzerrechte
            3. -
          -
          5. -
        -
        2. -
      2. MOA-ID-Auth -
          -
        1. Bekanntmachung der Konfigurationsdatei
          2. -
        2. Konfigurationsparameter -
            -
          1. Allgemeine Konfigurationsparameter
            2. -
          2. Externe Services -
              -
            1. Zentralers E-ID System
              2. -
            -
            3. -
          3. Protokolle -
              -
            1. SAML1
              2. -
            -
            4. -
          4. Datenbank -
              -
            1. Konfiguration
              2. -
            2. Session Informationen
              3. -
            3. Statistikdaten
              4. -
            -
            5. -
          5. Testing
            6. -
          -
          3. -
        -
        3. -
      3. Konfiguration des Loggings
        4. -
      -
      3. -
    3. Konfiguration MOA-ID-Auth -
        -
      1. Allgemeine Konfiguration -
          -
        1. Public URL Prefix
          2. -
        2. Zertifikatsprüfung
          3. -
        3. Session TimeOuts
          4. -
        4. MOA-SP
          5. -
        5. E-ID System
          6. -
        6. Protokolle -
            -
          1. Protkolle aktivieren
            2. -
          2. SAML1 Konfiguration
            3. -
          -
          7. -
        7. Revisionssicherheit
          8. -
        -
        2. -
      2. Online-Applikationen -
          -
        1. Informationen zur Online-Applikation (Service Provider) -
            -
          1. Öffentlicher Bereich
            2. -
          2. Privatwirtschaftlicher Bereich
            3. -
          -
          2. -
        2. E-ID System
          3. -
        3. Authentifizierungsprotokolle -
            -
          1. SAML 1
            2. -
          -
          4. -
        -
        3. -
      3. Import / Export -
          -
        1. Import alter Konfigurationen (= MOA-ID 2.x.x)
          2. -
        -
        4. -
      -
      4. -
    4. Konfiguration von MOA-SP
      5. -
    5. Tomcat Security Manager
      6. -
    -
      -
    1. Referenzierte Spezifikation
      2. -
    - -

    1 Übersicht

    -

    Dieses Handbuch beschreibt detailliert die Konfigurationsmöglichkeiten für die Module MOA-ID-Auth und MOA-ID-Configuration. Wobei das zentrale Einsatzgebiet des Modules MOA-ID-Configuration die Konfiguration des Modules MOA-ID-Auth darstellt.

    -

    Die Konfiguration der beiden Module MOA-ID-Auth und MOA-ID-Configuration kann in zwei Teilbereiche unterteilt werden. Der erste Abschnitt behandelt die Basiskonfiguration der beiden Module, welche in textueller Form mit Hilfe von properties-Konfigurationsdateien erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter Zuhilfenahme des Modules MOA-ID-Configuration.

    -

    1.1 Empfohlener Konfigurationsablauf

    -
      -
    1. Basiskonfiguration des Modules MOA-ID-Configuration
      2. -
    2. Initialisierung des Modules MOA-ID-Configuration
      3. -
    3. Basiskonfiguration des Modules MOA-ID-Auth
      4. -
    4. Allgemeine Konfiguration des Modules MOA-ID-Auth
      5. -
    5. Konfiguration von Online-Applikationen
      6. -
    -

    Optional kann nach dem Schritt 3 Basiskonfiguration des Modules MOA-ID-Auth eine bestehende MOA-ID 2.x.x Konfiguration importiert werden. Für bestehende Konfigurationen < 2.x.x wird eine vollständige Neukonfiguration empfohlen.

    -

    Hinweis: Wenn eine bestehende MOA-ID 2.x.x Konfiguration importiert werden soll MUSS diese zuerst mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine XML Datei exportiert werden.

    -

    2 Basiskonfiguration

    -

    Die Basiskonfiguration für die Module MOA-ID-Auth und MOA-ID-Configuration erfolgt mit Hilfe textueller properties-Dateien. Diese properties-Dateien beinhalten alle Konfigurationsparameter welche für den Start der Module erforderlich sind und müssen der Java Virtual Machine durch eine System Property mitgeteilt werden. Alle Änderungen die an der Basiskonfiguration vorgenommen werden erfordern einen Neustart der jeweiligen Java Virtual Machine.

    -

    Hinweis: Alle URL Konfigurationsparameter auf Dateien ohne den Prefix file:/ werden als relative Pfadangaben zum Konfigurationsbasisverzeichnis des jeweiligen Modules interpretiert.

    -

    2.1 MOA-ID-Configuration

    -

    Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Configuration. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

    -

    2.1.1 Bekanntmachung der Konfigurationsdatei

    -

    Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    -
    WINDOWS: -Dmoa.id.webconfig=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
-UNIX: -Dmoa.id.webconfig=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
    -

    Zusätzlich gibt es für das Konfigurationsmodul ein Usermanagment welches ebenfalls über eine eigene Konfiguration verfügt. Die Konfiguration des Usermanagements wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet user.properties als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    - 
    WINDOWS: -Duser.properties=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
-UNIX: -Duser.properties=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
    -

    Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Configuration erhalten Sie in Abschnitt 2.1.2.4 des Installationshandbuchs.

    -

    2.1.2 Konfigurationsparameter

    -

    Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt. Die Konfiguration der Blöcke Allgemeine Konfigurationsparameter und Datenbankzugriff sind nicht optional und müssen für den Betrieb angepasst werden.

    -
    2.1.2.1 Allgemeine Konfigurationsparameter
    -

    Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    general.defaultlanguagede, en

    Hiermit kann die Sprache, welche für die Darstellung der Texte verwendet wird, festgelegt werden.

    -

    Hinweis: Aktuell wird nur Deutsch (de) oder Englisch (en) unterstützt.

    general.ssl.certstorecerts/certstoreGibt den Pfadnamen zu einem Verzeichnis an, das als Zertifikatsspeicher im Zuge der TLS-Server-Zertifikatsüberprüfung verwendet wird.
    general.ssl.truststorecerts/truststoreTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate beim Download von PVP 2.1 Metadaten verwendet.
    general.ssl.hostnamevalidationtrue / false

    Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

    -

    Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

    general.moaconfig.keyConfigurationEncryptionKey

    Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

    -

    Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Auth hinterlegten Passwort sein.

    general.pvp.schemavalidationtrue / false

    Hiermit kann die Schemavalidierung für konfigurierte PVP Metadaten deaktiviert werden.

    - Hinweis: Standardmäßig ist die Schemavalidierung aktiv.
    -
    2.1.2.3 Datenbankzugriff
    -

    Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden. Für die Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Configuration kann jedoch auch mit Datenbanken anderer Hersteller betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen, welches im Module MOA-ID-Configuration für den Datenbankzugriff verwendet wird.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

    dbcp.validationQuery

    		SELECT 1

    SQL Query zum Validieren der Datenbank Verbindung

    -

    mySQL: SELECT 1

    -

    Oracle: select 1 from dual

    -

     

    -

    Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

    -

     

    -

    Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

    -

    2.1.3 Initialisierung des Modules MOA-ID-Configuration

    -

    Für den ersten Start muss die Authentifizierung deaktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend kann die Benutzerverwaltung des Modules MOA-ID-Configuration unter der folgenden Adresse aufgerufen werden.

    -
    http://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
    -

    bzw.

    -
    -https://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
    -

    Mit Hilfe dieser Benutzerverwaltung kann ein neuer Benutzeraccount am Konfigurationstool angelegt und ein Kennwort für den Benutzer vergeben werden. Zusätzlich müssen dem neu erstellten Benutzer die Eigenschaften aktiv und admin zugewiesen werden. Nach dem speichern wird der neu angelegte Benutzer in der Liste aller vorhandenen Benutzern dargestellt.

    -

    Hiermit ist die Initialisierung des Moduls MOA-ID-Configuration abgeschlossen und die Authentifizierung kann wieder aktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend muss die Java Virtual Machine, in welchem das Modul MOA-ID-Configuration betrieben wird, neu gestartet werden.

    -

    Hinweis: Ein Betrieb des Moduls MOA-ID-Configuration ohne Authentifizierung ist ebenfalls m\F6glich. In diesem Fall wird jedoch empfohlen den Zugriff auf das Konfigurationstool mit anderen Mitteln einzuschr\E4nken.

    -

    2.1.4 Benutzerverwaltung

    -

    Das Modul MOA-ID-Configuration unterstützt die Benützung und Verwaltung unterschiedlicher Benutzeraccounts. Hierfür stellt die Web-Oberfläche des Modules MOA-ID-Configuration ein spezielles Interface zur Benutzerverwaltung zur Verfügung.

    -
    2.1.4.1 Einen neuen Benutzer erstellen
    -

    Für die Registrierung eins neuen Benutzeraccounts werden folgende Informationen benötigt.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeschreibungOptional
    VornameVorname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
    FamiliennameFamilienname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
    OrganisationZugeordnete Organisation. Wir bei Registrierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragennein
    eMail AdresseeMail Adresse des Benutzers. Diese wird für weitere eMail Benachrichtigungen verwendetnein
    TelefonnummerTelefonnummer des Benutzersnein
    BenutzernameBenutzername für eine Anmeldung mittels Benutzername und Passwortnein
    KennwortPasswort für eine Anmeldung mittels Benutzername und Passwortja
    bPK / wbPKbPK oder wbPK für eine Anmeldung mittels PVP 2.1ja
    Benutzer ist aktiviertAktiviert oder deaktiviert den jeweiligen Benutzeraccountja
    Benutzer ist AdminDefiniert ob der Benutzeraccount über Administrator-Rechte verfügen soll. (siehe Kapitel 2.2.4.2)ja
    Benutzername/Passwort erlaubenDefiniert ob eine Anmeldung mittels Benutzername und Passwort erlaubt ist. Falls nicht steht der Benutzerin / dem Benutzer nur eine Anmeldung mittels Bürgerkarte oder Handy-Signatur zur Verfügung.ja
    -

     

    -

    Neue Benutzer können auf zwei Arten erstellt werden.

    -
      -
    1. Durch Administrator: Bei dieser Variante wird der neue Benutzeraccount durch einen Administrator über die Web-Oberfläche erstellt und aktiviert. In diesem Fall müssen alle geforderten Daten durch den Administrator eingetragen werden. Bei dieser Variante ist die Validierung der eMail Adresse nicht zwingend erforderlich, kann jedoch optional aktiviert werden.
      -
      2. -
    2. Durch PVP 2.1 Login: Bei dieser Variante wird die Generierung eines neues Benutzeraccounts durch einen Loginversuch mittels Bürgerkarte oder Handy-Signatur ausgelöst. Nach erfolgreicher Authentifizierung wird die Benutzerin / der Benutzer an das Konfigurationstool weitergeleitet. Hierbei wird geprüft ob aktuell ein Benutzeraccount für diese Person existiert. Wenn kein Account existiert wird die Benutzerin / der Benutzer aufgefordert die fehlenden Informationen für die Registrierung eines neuen Benutzeraccounts einzutragen. In diesem Fall muss die eMail Adresse durch die Benutzerin / den Benutzer zwingend validiert werden wofür der Mailversand am Module MOA-ID-Configuration konfiguriert sein muss. Nach erfolgreicher Validierung der eMail Adresse ist der Benutzeraccount als nicht aktiv registriert und muss anschließend durch einen Administrator aktiviert werden. Erst nach erfolgreicher Aktivierung ist eine gültige Anmeldung möglich.
      - Sollte die Validierung der eMail Adresse nicht innerhalb des in Abschnitt 2.2.1.1 konfigurierten Zeitraums erfolgen, wird die Benutzeranforderung automatisch gelöscht und die Benutzerin / der Benutzer muss sich erneut am Konfigurationstool registrieren.
      3. -
    -
    2.1.4.2 Benutzerrechte
    -

    Alle Benutzer die Admin–Rechte (Eigenschaft admin) besitzen haben vollen Zugriff auf die gesamte Konfiguration der verwalteten MOA-ID-Auth Instanz. Benutzer ohne Admin-Rechten stehen nur folgende Operationen zur Verf\FCgung wobei diese auch besondere Einschr\E4nkungen aufweisen können.

    -
      -
    • Online-Applikationen bearbeiten: Ein Benutzer ohne Admin-Rechte kann nur jene Online-Applikationen bearbeiten die von ihm erstellt wurden. Das bearbeiten fremder Online-Applikationen ist nicht möglich. Folgende Parameter können durch diesen Benutzer bearbeitet werden. - -
      • -
    • Online Applikation anlegen: Ein Benutzer ohne Admin-Rechte kann neue Online-Applikationen anlegen. Die Funktionen „Online-Applikation aktivieren“ (siehe Kapitel 3.2: ) steht jedoch nicht zur Verfügung. Somit muss die Online-Applikation von einem Benutzer mit Admin-Rechten aktiv geschalten werden.
      • -
    • Benutzerverwaltung: Ein Benutzer ohne Admin-Rechte kann keine neuen Benutzer erstellen. Dieser kann jedoch seinen Benutzeraccount bearbeiten und gegeben falls löschen. Beim Löschen eines Benutzeraccounts werden Online-Applikationen die von diesem erstellt wurden jedoch nicht automatisch gelöscht.
      • -
    -

    2.2 MOA-ID-Auth

    -

    Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Auth. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

    -

    2.2.1 Bekanntmachung der Konfigurationsdatei

    -

    Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    - 
    Windows: moa.id.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
-UNIX: moa.id.configuration=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
    -

    Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Auth erhalten Sie in Abschnitt 2.1.2.3 des Installationshandbuchs.

    -

    2.2.2 Konfigurationsparameter

    -

    Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt.

    -
    2.2.2.1 Allgemeine Konfigurationsparameter
    -

    Die folgenden Konfigurationsparameter sind optional und müssen nicht zwingend angegeben werden. Im Falle eines produktiven Betriebs von MOA-ID-Auth wird jedoch die Angabe eines Schlüssels zur verschlüsselten Speicherung der Session Daten in der Datenbank dringend empfohlen.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    configuration.moasession.keyaX.J47s#bh7Passwort zum Verschlüsseln von personenbezogenen Session Daten die während eines Anmeldevorgangs und für Single Sign-On in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.
    configuration.moaconfig.keyConfigurationEncryptionKey

    Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

    -

    Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Configuration hinterlegten Passwort sein.

    configuration.ssl.useStandardJavaTrustStoretrue / false

    Deaktiviert die MOA-ID spezifische SSL TrustStore Implementierung. Wird dieser Parameter auf true gesetzt, verwendet MOA-ID den TrustStore der Java VM.

    -

    Defaultwert: false

    configuration.ssl.validation.revocation.method.orderocsp,crl

    Definiert die Reihenfolge des Zertifikatsrevokierungschecks bei SSL Verbindungen. Die Defaultreihenfolge ist OCSP, CRL.

    -

    Hinweis: Die Angabe erfolgt als CSV, wobei die Schlüsselwörter 'ocsp' und 'crl' lauten

    configuration.ssl.validation.hostnametrue / false

    Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

    -

    Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

    configuration.validate.authblock.targetfriendlynametrue / falseHiermit kann die Überprüfung des 'TargetFriendlyName', welcher Teil des vom Benutzer signierten Authblock ist, deaktiviert werden. Eine Deaktivierung hat keinen Einfluss auf die Sicherheit des Authentifizierungsvorgangs mittels qualifizierter Signatur, jedoch kann der 'TargetFriendlyName im Authblock nicht als gesichert betrachtet werden.' Die Validierung ist deaktiviert wenn der Parameter auf false gesetzt wird.
    - Hinweis: Hierbei handelt es sich um einen Workaround für Systeme auf denen die Validierung des 'TargetFriendlyName' wegen Problemen mit der Zeichencodierung fehlschlägt, die Signatur des AuthBlocks jedoch gültig ist.
    - Defaultwert: true
    configuration.bugfix.enable.idl.escapingtrue / false

    MOA-ID intern wurden einfache Anführungszeichen (') in Vornamen oder Nachnamen bis zur Version 4.3.2 durch &#39; escapted. Dieses Escaping hatte durch einen Fehler auch Einfluss auf die ausgelieferten Attributen in PVP2 S-Profil, OpenID-Connect, etc. . Dieser Fehler wurde in der Version 4.3.3 behoben.
    - Aus Kompatibilitätsgründen kann das Escaping jedoch mittels Konfigurationsparameter wieder aktiviert werden. -

    -

    Defaultwert: false

    configuration.monitoring.activetrue / falseAktiviert das Modul für internes Monitoring / Testing.
    configuration.monitoring.message.successAll Tests passed!Statusmeldung wenn alle Tests erfolgreich ausgeführt wurden
    configuration.monitoring.test.identitylink.urlmonitoring/
    - monitoring_idl.xml

    Zur Überprüfung der gesamten Funktionalität von MOA-ID-Auth wird eine Personenbindung benötigt. Dieses Element definiert die URL auf eine Test Personenbindung welche für den Testablauf verwendet wird.

    -

    Hinweis: Der Beispielkonfiguration ist eine Personenbindung beigelegt die für das Monitoring verwendet werden kann. Bei dieser Personenbindung handelt es sich jedoch um Keine durch die Stammzahlenregisterbehörde ausgestellte Personenbindung, wodurch nicht der gesamte Personenbindungsvalidierungsvorgang getestet werden kann.

    configuration.advancedlogging.activetrue / falseAktiviert das erweiterte Logging zur Generierung von anonymisierten Statistikdaten aus den Anmeldeinformationen. Hierfür muss der entsprechende Datenbankzugriff (siehe Kapitel 2.2.2.4) ebenfalls konfiguriert werden.
    -

     

    -

    Wenn das interne Monitoring aktiviert wurde kann ein Testvorgang durch einen Aufruf der folgenden Adresse gestartet werden.

    -
    http://<host>:<port>/moa-id-auth/MonitoringServlet
    -

    bzw.

    -
    -https://<host>:<port>/moa-id-auth/MonitoringServlet
    -

    Nach einem erfolgreichen Testdurchlauf Antwortet das Monitoring mit einen http Statuscode 200 und der oben definierten Statusmeldung aus dem Parameter configuration.monitoring.message.success. Im Falle eines Fehlers antwortet das Monitoring mit einem http Statuscode 500 und die Statusmeldung enthält eine Beschreibung des aufgetretenen Fehlers.

    -
    2.2.2.2 Anbindung an das E-ID System
    -

    Die Anbindung und Weiterleitung an das zentrale E-ID System erfolgt via PVP2 S-Profil (SAML2). Für das in MOA-ID 4.x integrierte E-ID Proxy Authentifizierungsmodul sind folgende Konfigurationsparameter erforderlich.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    modules.eidproxyauth.keystore.pathkeys/szrgw.p12Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.x spezifischen Inhalten. (PVP 2.x Metadaten, PVP 2.1 Assertion)
    modules.eidproxyauth.keystore.passwordpass1234Passwort zum Keystore
    modules.eidproxyauth.metadata.sign.alias Name des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.metadata.sign.password Passwort des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.request.sign.alias Name des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.request.sign.password Passwort des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.response.encryption.alias Name des Schlüssels mit dem die PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.response.encryption.password Passwort des Schlüssels mit dem PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.EID.trustprofileIDeid_metadataMOA-SP TrustProfil welches die vertrauenswürdigen Zertifikate zur Validierung der Metadaten des zentralen E-ID Systemas beinhaltet
    modules.eidproxyauth.EID.entityId Optional: EntityID des IDPs im zentralen E-ID System
    modules.eidproxyauth.EID.metadataUrl Optional: URL auf die SAML2 Metadaten des zentralen E-ID System, sofern diese nicht über die EntityID geladen werden können
    modules.eidproxyauth.required.additional.attributes.x 

    Optional: zusätzliche Attribute welche vom zentralen E-ID System angefordert werden

    -

    Attribute werden entspechend PVP2 Attribute-Profil angegeben. Beispiele für die Konfiguration finden Sie in der Beispielkonfiguration

    -

     

    -
    2.2.2.3 Protokolle
    -

    MOA-ID 4.x unterstützt nur mehr SAML1 als Authentifizierungsprotokoll.

    -

     

    -
    2.2.2.4 Datenbank
    -

    Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) separate Datenbank Schema, welche in der Basiskonfiguration konfiguriert werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Auth kann jedoch auch mit Datenbanken anderer Hersteller oder einer InMemory Datenbank betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen.

    -

     

    -
    2.2.2.4.1 Konfiguration
    -

    Alle Parameter aus der Basiskonfiguration welche als Prefix configuration.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nicht optional.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    configuration.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    configuration.hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    configuration.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    configuration.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema
    configuration.hibernate.connection.passwordmoaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

    configuration.dbcp.validationQuery

    		SELECT 1

    SQL Query zum Validieren der Datenbank Verbindung

    -

    mySQL: SELECT 1

    -

    Oracle: select 1 from dual

    -

     

    -

    Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

    -
    2.2.2.4.2 Session Informationen
    -

    Alle Parameter aus der Basiskonfiguration welche als Prefix moasession.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema in welchem MOA-ID-Auth die Session Informationen temporär ablegt. Eine Konfiguration dieser Parameter ist nicht optional.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    moasession.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    moasession.hibernate.connection.urljdbc:mysql://localhost/moa-id-session?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit den Session Information von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    moasession.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    moasession.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    moasession.hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
    -

     

    -

    Hinweis: Zusätzlich zum SQL based Datenbank Backend für Sessiondaten gibt es aber der Version 3.2.0 die Möglichkeit einen Redis Datenserver als Datenbank Backend für Kurzzeitsessiondaten zu verwenden. Wird dieser aktiviert werden nur mehr Single Sign-On Sessioninformationen in der Sessiondatenbank abgelegt. Alle anderen Prozessdaten werden ausschließlich über das Redis Backend abgewickelt.

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    redis.active

    true / false

    		Aktiviert das Redis Backend für Kurzzeitsessiondaten
    redis.use-pooltrue / falseAktiviert / Deaktiviert den Connectionpool für Redis

    redis.host-name

    		localhostURL unter der der Redis Server erreichbar ist

    redis.port

    		6379Port unter dem der Redis Server erreichbar ist
    -

     

    -

     

    -
    2.2.2.4.3 Statistikdaten
    -

    Alle Parameter aus der Basiskonfiguration welche als Prefix advancedlogging.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nur erforderlich wenn configuration.advancedlogging.active auf true gesetzt wird. (siehe Kapitel 2.2.2.1)

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    advancedlogging.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    advancedlogging.hibernate.connection.urljdbc:mysql://localhost/moa-id-statistic?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema für die Statistikfunktion von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    advancedlogging.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    advancedlogging.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    advancedlogging.hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
    -

     

    -

    Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff der einzelnen Schema welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

    -
    2.2.2.5 Testing
    -

    Diese Parameter dienen auf Testsystemen zur Deaktivierung einzelner Verarbeitungs- oder Prüfschritte. Standardmäßig ist jeweils die sichere Variante aktiviert.

    - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    configuration.validation.certificate.QC.ignore

    true / false

    Deaktiviert die QC Prüfung von Signaturzertifikaten. Da manche Testzertifikate oder Testkarten keine QC Erweiterung aufweisen und somit eine Anmeldung mit diesen Zertifikaten nicht möglich ist, kann die QC Prüfung je Instanz deaktiviert werden.

    -

    Defaultwert: false

    protocols.pvp2.schemavalidationtrue / false

    Mit diesem Parameter kann die Schemavalidierung für PVP Metadaten deaktiviert werden.

    - Defaultwert: true
    protocols.pvp2.assertion.encryption.activetrue / false

    Mit diesem Parameter kann die Verschlüsselung der PVP2.1 Assertion für diese MOA-ID-Auth Instanz vollständig deaktiviert werden.

    -

    Defaultwert: true

    -

    Hinweis: Detaillierte Informationen zu den einzelnen PVP spezifischen Konfigurationsparametern finden Sie in der entsprechenden PVP Spezifikation.

    -

     

    -

    2.3 Konfiguration des Loggings

    -

    Die Module MOA-ID-Auth und MOA-ID-Configuration verwendet als Framework für Logging-Information die Open Source Software log4j. Die Konfiguration der Logging-Information erfolgt nicht direkt durch die einzelnen Module, sondern über eine eigene Konfigurationsdatei, die der Java Virtual Machine durch eine System Property mitgeteilt wird. Der Name der System Property lautet log4j.configuration; als Wert der System Property ist eine URL anzugeben, die auf die log4j-Konfigurationsdatei verweist, z.B.

    -
    log4j.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/log4j.properties
    -

    Zustätzlich wird für einige Basiskomponenten, welche über Drittherstellerbibliotheken inkludiert sind, LogBack als Logging Framework verwendet. Die LogBack Konfiguration wird ebenfalls über den System Property angegeben

    - 
    logback.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/logback_config.xml
    -

    Mit Hilfe von Konverertern kann eine bestehende log4j Konfiguration in das LogBack Format umgewandelt werden. Hierfür stehen divererse Tools Online zur Verfügung. (z.B. http://logback.qos.ch/translator/)

    -

     

    -

    Weitere Informationen zur Konfiguration des Loggings erhalten Sie in Abschnitt 2.1.3 des Installationshandbuchs. -

    -

    -

    3 Konfiguration MOA-ID-Auth

    -

    Dieser Abschnitt beschreibt die Konfiguration des Modules MOA-ID-Auth mithilfe der durch das Modul MOA-ID-Configuration zur Verfügung gestellten Web-Oberfläche. Hierzu muss das Konfigurationstool (Module MOA-ID-Konfiguration) bereits installiert und konfiguriert sein (siehe Kapitel 2.1). Nach erfolgreichem Login am Konfigurationstool kann das Modul MOA-ID-Auth über die Web-Oberfläche konfiguriert werden.

    -

    Die Konfiguration von MOA-ID-Auth ist in zwei Teilbereiche unterteilet. Diese behandeln die Allgemeine Konfiguration der MOA-ID-Auth Instanz und die Konfiguration von Online-Applikationen (Service Providern) welche dieser MOA-ID-Auth Instanz zugeordnet sind.

    -

    3.1 - Allgemeine Konfiguration

    -

    Die Allgemeine Konfiguration des Modules MOA-ID-Auth umfasst alle nicht online-applikationsspezifischen Konfigurationsparameter. Die Konfiguration dieser Parameter erfolgt über eine Web-Oberfläche, welche Eingabefelder für jeden Konfigurationsparameter zur Verfügung stellt. Jedes Eingabefeld wird validiert bevor der Konfigurationsparameter in der Datenbank gespeichert wird. Die Validierung erfolgt auf Basis des zu erwartenden Eingabewerts, wobei der erlaubte Zeichensatz für freidefinierbare textuelle Eingabefelder eingeschränkt sein kann. Detailinformationen zum erlaubten Zeichen finden Sie bei der jeweiligen Beschreibung des Konfigurationsparameters.

    -

    Nachfolgend finden Sie die Detailbeschreibung aller allgemeinen Konfigurationsparameter.

    -

    3.1.1 Public URL Prefix

    -

    Dieser Parameter definiert den Public URL Prefix unter welchem die MOA-ID Instanz erreichbar ist. Die Konfiguration dieses Parameters ist verpflichtend.

    - - - - - - - - - - - - - - - - -
    NameBeispielwerteBeschreibung
    Public URL Prefixhttps://demo.egiz.gv.at/moa-id-auth/

    URL-Prefix der MOA-ID Instanz. Diese URL wird für die automatische Generierung von Formularen und Informationen verwendet und MUSS konfiguriert werden.

    -

    Hinweis: Wenn virtuelle IDPs aktiviert sind muss hier für jede virtuelle MOA-ID Instanz, der Public URL Prefix als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen Public URL Prefix durch Beistrich (',') getrennt.
    - (z.B.: https://demo.egiz.gv.at/moa-id-auth/,https://apps.egiz.gv.at/moa-id-auth/)

    Virtuelle IDPs aktiviere 

    Mit dieser Option können für diese MOA-ID Instanz mehrere virtuelle MOA-ID Instanzen, welche unter schiedenen Domains erreichbar sind aktiviert werden. Der Public URL-Prefix jeder virtuellen MOA-ID Instanz muss als Comma Separatet Value (CSV) im Konfigurationsfeld 'Public URL Prefix' angegeben werden.

    -

    Hinweis: Bei Verwendung von virtuellen IDPs werden für jeden virtuellen IDP SAML2 Metadaten mit unterschiedlichen EntityIDs entsprechend dem virtuellen IDP erstellt. Somit muss jeder virtuelle IDP als MOA-ID E-ID Proxy am zentralen Applikationsregister hinterlegt sein.

    -

     

    -

    3.1.2 Zertifikatsprüfung

    -

    Dieser Bereich behandelt die allgemeine Einstellungen zur Zertifikatsprüfung und die Konfiguration von vertrauenswürdigen Zertifikaten.

    - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung

    TrustManagerRevocation

    - Checking    		 Für die TLS-Server-Authentisierung dürfen nur Server-Zertifikate verwendet werden, die eine CRLDP-Extension enthalten (andernfalls kann von MOA-ID-Auth keine CRL-überprüfung durchgeführt werden). Soll das RevocationChecking generell ausgeschaltet werden, ist dieses Attribut anzugeben und auf "false" zu setzen

    TrustedCACertificates

    		certs/ca-certsTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate für den Zugriff auf das Online-Vollmachten Service, den Stammzahlenregister Gateway und das Abholen von PVP 2.1 Metadaten via SSL verwendet.
    -

    3.1.3 Session TimeOuts

    - - - - - - - - - - - -
    NameBeispielwert [sec]Beschreibung
    Transaktion300

    Gibt die Zeitspanne in Sekunden an, für die Anmeldedaten, temporäre Sessiondaten oder Assertions in der Authentisierungskomponente (MOA-ID-Auth) vorrätig gehalten werden. Nach Ablauf dieser Zeitspanne werden diese Daten gelöscht oder der Anmeldevorgang abgebrochen. Dieser Parameter hat Einfluss auf folgende Funktionen:

    -
      -
    • maximale Zeitspanne eines Anmeldevorgangs vom Authentification Request bis zur Authentification Response gerechnet.
      • -
    • maximale Zeitspanne welche einer Online-Applikation zum Abholen der Anmeldedaten zur Verfügung steht. (SAML mit Artifact Binding und OpenID Connect)
      • -
    • maximale Zeitspanne zum Abholen zusätzlicher STORK2 Attribute (Zeitdauer je Attribut)
      • -
    -

    3.1.4 MOA-SP

    -

    Der Abschnitt MOA-SP Konfiguration enthält Parameter zur Nutzung von MOA-SP. MOA-SP wird für die Überprüfung der Signatur der SAML2 Metadaten des zentralen E-ID System benötigt. 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 beiliegenden Dokumentation im Abschnitt 'Konfiguration'.

    -

    3.1.5 Externe Services

    -

    Hiermit werden die URLs zum zentralen E-ID System konfiguriert.

    - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    zentrales E-ID System (CSV)https://eid.egiz.gv.at/idp/shibboleth

    URL(s) zu den SAML2 Metadaten des zentralen E-ID Systems

    - -

    Hinweis: Die URLs auf die unterschiedlichen Instanzen des zentralen E-ID Systems können auch als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen URLs durch Beistrich (',') getrennt. Sind mehrere URLs hinterlegt kann das zu verwendeten Service je Online Applikation konfiguriert werden (siehe Kapitel 3.2.4).
    - (z.B.: https://eid.egiz.gv.at/idp/shibboleth,https://eid.gv.at/idp/shibboleth)

    -

    Hinweis: Erfolgt in der Online Applikation keine konkrete Auswahl wird Standardmäßig das erste eingetragen Service verwendet.

    -

    3.1.6 Protokolle

    -

    Hierbei handelt es ich um allgemeine Einstellungen zu den vom Modul MOA-ID-Auth unterstützen Authentifizierungsprotokollen.

    -
    3.1.6.1 Protokolle aktivieren
    -

    In diesem Abschnitt können die einzelnen von MOA-ID-Auth unterstützen Authentifizierungsprotokolle aktiviert oder deaktiviert werden. Diese Einstellung gilt für die gesamte MOA-ID-Auth Instanz.

    -
    3.1.6.2 SAML1 Konfiguration
    -

    Die SourceID ist ein Teil des SAML1 Artifacts welches zur Abholung der SAML1 Assertion an die Online-Applikation zurückgegeben wird. Standardmäßig wird die SourceID aus der URL der jeweiligen Online-Applikation, an der die Anmeldung stattfinden, generiert. Optional kann jedoch eine SourceID für die gesamte MOA-ID-Auth Instanz vergeben werden, welche für alle Online-Applikationen verwendet wird.

    - - - - - - - - - - - -
    NameBeispielwerteBeschreibung
    SourceIDMOA_Instanz_ASourceID zu Generierung des SAML1 Artifacts wenn hierfür nicht die OA URL verwendet werden soll.
    -

     

    -
    3.1.6.3 PVP 2.x Konfiguration
    -

    Die allgemeinen Konfigurationsparameter für das Authentifizierungsprotokoll PVP 2.x behandeln Informationen zum Betreiber der MOA-ID-Auth Instanz und zu einer Ansprechperson für diese Instanz. Diese Parameter werden in den PVP 2.x Metadaten, welche dem zentralen E-ID System bereitgestellt werden, eingetragen.

    -
    3.1.6.3.1 Betreiberorganisation
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung

    PVP Service Name

    		MOA-ID 2.0 Demo IDPName der MOA-ID-Auth Instanz. Dieser Name wird in den Metadaten im Element md:EntitiesDescriptor als Attribut Name angezeigt.

    Kurzbezeichnung - Organisation

    		EGIZKurzbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationName angezeigt.
    Vollständiger Name - OrganisationeGovernment InnovationszentrumVollbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationDisplayName angezeigt.
    URL der Organisation - Organisationhttp://www.egiz.gv.atURL zu einer Seite mit Informationen der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationURL angezeigt.
    -
    3.1.6.3.2 Kontaktperson
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    FamiliennameMustermannFamilienname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.

    Vorname

    		MaxVorname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:SurName angezeigt.

    Mailadresse

    		max.mustermann@egiz.gv.ateMail Adresse der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
    Telefonnummer+43012425478521Telefonnummer der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
    UnternehmenEGIZUnternehmen für welches die Kontaktperson tätig ist. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:Company angezeigt.
    Type des Kontaktstechnical

    Type der Kontaktperson. Hierfür stehen folgende Typen zur Auswahl:

    -
      -
    • technical
      • -
    • support
      • -
    • administrative
      • -
    • billing
      • -
    • other
      • -
    -

    Dieser Name wird in den Metadaten im Element md:ContactPersonals Attribut contactType angezeigt.

    -

     

    - - - -

    3.2 Online Applikationen

    -

    Die Konfiguration von Online-Applikationen erfolgt ebenfalls mit Hilfe des Moduls MOA-ID-Configuration. Es können sowohl neue Online-Applikationen erstellt als auch bestehende Online-Applikationen bearbeitet oder gelöscht werden. Der erlaubte Konfigurationsumfang hängt jedoch von Role des aktuellen Benutzers ab, wobei eine Konfiguration der gesamten Parameter nur einem Benutzer mit der Role admin möglich ist. Alle Konfigurationsfelder die nur einem Benutzer mit der Role admin zur Verfügung stehen sind gesondert gekennzeichnet.

    -

    3.2.1 Informationen zur Online-Applikation (Service Provider)

    -

    Dieser erste Abschnitt behandelt allgemeine Parameter zur Online-Applikation.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertAdminOptionalBeschreibung
    Online-Applikation ist aktiviert X Aktiviert oder deaktiviert die Online-Applikation. Eine Authentifizierung ist nur an aktiven Online-Applikationen möglich. Ein Anmeldeversuch an einer nicht aktiven Online-Applikation wird durch MOA-ID-Auth durch den Fehlercode auth.00 und der Fehlerbeschreibung Anmeldung an dieser Applikation wird nicht unterstützt verweigert.

    Eindeutiger Identifikatior

    		https://demo.egiz.gv.at/demologin/  Dieser Parameter dient als Schlüssel zum Auffinden der Konfigurationsparameter zur Online-Applikation. Hierfür ist ein eindeutiger Identifikator für die Online-Applikation erforderlich. Dieser eindeutige Identifikator muss mindestens dem URL-Präfix der nach außen sichtbaren Domäne der Online-Applikation entsprechen.

    Name der
    - Online-Applikation

    		Demo Applikation A  Hier muss ein benutzerfreundlicher Name für die Online-Applikation angegeben werden. Dieser Name scheint während der Authentifizierung des Benutzers oder am Online-Vollmachten Service bei der Vollmachten Auswahl auf.
    Privatwirtschaftliche Applikation   Definiert ob die Online-Applikation dem öffentlichen Bereich oder dem privatwirtschaftlichen Bereich (Business Service) zugeordnet ist. Ja nach Bereich sind unterschiedliche Konfigurationsparameter erforderlich.
    -
    3.2.1.1 Öffentlicher Bereich
    -

    Wurde die Online-Applikation einem öffentlichen Bereich zugeordnet muss in weiterer Folge der zugeordnete Bereich definiert werden. Hierfür stehen folgende Parameter zur Verfügung.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertAdminOptionalBeschreibung
    Bereich (Target)BF  Definiert den öffentlichen Bereich dem die Online-Applikation zugeordnet ist.

    Target verfeinern

    		  XDer angegebene öffentliche Bereich kann mit Hilfe eines Sub-Bereich verfeinert werden. Wird ein Sub-Bereich konfiguriert wird dieser an das Kürzel des öffentlichen Bereichs angehängt.

    Anderen Bereich frei definieren

    		 XXDiese Option erlaubt die freie Definition eines öffentlichen Bereichs. Soll ein freier Bereich für die Online-Applikation verwendet werden muss sowohl das Bereichskürzel als auch ein Name für den Bereich angegeben werden.
    -

     

    -

    Hinweis: Wird die Online-Applikation durch eine Benutzerin oder einem Benutzer ohne die Role admin angelegt, wird vor der Speicherung überprüft ob die Online-Applikation alle Anforderungen an eine öffentliche Applikation erfüllt. Die Überprüfung erfolgt auf Basis des eindeutigen Identifikators (Public-URL PRefix) der Online-Applikation und es muss mindestens eine der folgenden Anforderungen erfüllt sein.

    -
      -
    • Die öffentliche URL unter der die Online-Applikation erreichbar ist (Public-URL Prefix) muss einen *.gv.at Domain aufweisen. (Beispiel: https://demo.egiz.gv.at/moa-id-oa)
      • -
    • Der SSL Serverzertifikat der Online-Applikation weist eine der folgenden Eigenschaften auf. -
        -
      • Veraltungseigenschaft (OID=1.2.40.0.10.1.1.1)
        • -
      • Dienstleistereigenschaft (OID=1.2.40.0.10.1.1.2)
        • -
      -
      • -
    -
    3.2.1.2 Privatwirtschaftlicher Bereich
    -

    Wurde die Online-Applikation einem privatwirtschaftlichen Bereich zugeordnet muss in weiterer Folge die Stammzahl des privatwirtschaftlichen Unternehmens angegeben werden. Die Stammzahl des öffentlichen Bereichs muss mit dem entsprechenden Prefix des Bereichs angegeben werden, wobei der Prefix aus einer vorgegebenen Liste gewählt werden muss.

    -
      -
    • FN: Die Stammzahl ist eine Firmenbuchnummer. (Beispiel: FN468924i)
      • -
    • ZVR: Die Stammzahl ist eine Vereinsnummer. (Beispiel: ZVR124572)
      • -
    • ERSB: Die Stammzahl ist einer Kennzahl aus dem Ergänzungsregister für sonstige Betroffene (ERsB) (Beispiel: ERSB1425367879)
      • -
    • STORK: Ländercode dem der Service Provider zugeordnet werden kann. Wird für die Ableitung des STORK-eIdentifiers verwendet.
      • -
    - - - - - - - - - - - - - - - -
    NameBeispielwerteAdminOptionalBeschreibung
    Identifikationsnummer

    FN 468924i
    - ZVR 124572
    - STORK SI -

    		  Stammzahl eines privatwirtschaftlichen Unternehmens oder Ländercode des STORK Service-Providers bei Verwendung des Modules MOA-ID als STORK VIDP. Die Angabe erfolgt durch den Prefix des Bereichs aus dem die Stammzahl stammt und der eigentlichen Stammzahl oder des Ländercodes im Falle von STORK.
    - -

     

    -

    3.2.2 Neue Attribute des E-ID Systems

    -

    Dieser Abschnitt behandelt die Änderungen am Attributset zur Person des neuen E-ID Systems. Ist der E-ID Modus aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

    -

    Folgende Attribute stehen nicht mehr zur Verfügung:

    -
      -
    • EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)
      • -
    • EID-SOURCE-PIN-TYPE (1.2.40.0.10.2.1.1.261.104)
      • -
    • EID-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.38)
      • -
    • EID-AUTH-BLOCK (urn:oid:1.2.40.0.10.2.1.1.261.62)
      • -
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.70)
      • -
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN-TYPE (urn:oid:1.2.40.0.10.2.1.1.261.102)
      • -
    • MANDATE-FULL-MANDATE (urn:oid:1.2.40.0.10.2.1.1.261.92)
      • -
    -

    Folgende neuen Attribute stehen zur Verfügung:

    -
      -
    • ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.22)
      • -
    • BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.28) (Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)
      • -
    • MANDATOR-NATURAL-PERSON-ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.72)
      • -
    • MANDATOR-NATURAL-PERSON-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.73) (Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)
      • -
    -

     

    - - - - - - - - - - - - - - - -
    NameBeispielwerteAdminOptionalBeschreibung
    E-ID Attribute ausliefern

     

    		 XAktiviert die neuen Attribute des E-ID für diese Online Applikation.
    -

     

    -

    3.2.3 Authentifizierungsprotokolle

    -

    Dieser Abschnitt behandelt online-applikationsspezifische Einstellungen zu den von der Online-Applikation unterstützen Authentifizierungsprotokollen. Eine Verwendung aller zur Verfügung stehender Authentifizierungsprotokolle durch die Online-Applikation ist ebenfalls möglich. Hierfür müssen nur alle benötigten Protokolle konfiguriert werden. Nähere Informationen zu den unterstützten Protokollen finden sie im Kapitel Protokolle.

    -

    Aus Gründen der Übersichtlichkeit kann der Konfigurationsbereich für jeden Protokoll, in der Web-Oberfläche des Konfigurationstools, ein- oder ausgeblendet werden.

    -
    3.2.3.1 SAML1
    -

    Für das Protokoll SAML1 stehen folgende Konfigurationsparameter zur Verfügung.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertAdminOptionalBeschreibung
    SAML1 aktivierendeaktiviertX Aktiviert SAML1 als erlaubtes Authentifizierungsprotokoll für diese Online-Applikation. Bei neuerstellten Online-Applikationen ist SAML1 per Default deaktiviert.
    Stammzahl übertragen XXDas Attribut bestimmt, ob die Stammzahl in den Anmeldedaten aufscheint oder ob der Wert ausgeblendet (d.h. auf den Leerstring gesetzt) wird. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl immer ausgeblendet.
    Authentifizierungsblock übertragen XXDas Attribut bestimmt, ob der AuthBlock in den Anmeldedaten enthalten ist.
    Personenbindung übertragen XXDas Attribut bestimmt, ob die Personenbindung in den Anmeldedaten enthalten ist. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl in der Personenbindung durch die jeweilige wbPK ersetzt.
    Zertifikat übertragen XXDas Attribut bestimmt, ob das Signatorzertifikat in den Anmeldedaten enthalten ist.
    Vollständige Vollmacht übertragen XXDas Attribut bestimmt ob bei einer Vollmachten-Anmeldung die vollständige 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. Wird dieses Attribut gewählt wird zusätzlich die gesamte Vollmacht übergeben.
    -

     

    -

     

    -
    3.3 Import / Export
    -

    Üer diese Funktionalität besteht die Möglichkeit eine bestehende MOA-ID 2.x.x - Konfiguration in MOA-ID 3.x zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID-Auth 3.0 - Konfiguration in ein Dokument zu exportieren oder in eine bestehende MOA-ID-Auth 3.0 - Konfiguration zu importieren.

    -

    Hinweis: - Zu beachten ist, dass bei einem Import die aktuell vorhandene - Konfiguration vollständig gelöscht und durch die importierte Konfiguration ersetzt wird. - Es wird empfohlen ein Backup einer eventuell vorhandenen MOA-ID 3.0 Konfiguration - zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die -Exportfunktion verwendet werden.

    -

    3.3.1 Import alter Konfigurationen ( MOA-ID 2.x.x)

    -

    Es besteht auch die Möglichkeit eine bestehende MOA-ID 2.x.x Konfiguration zu importieren. Hierfür muss zuerst die bestehende MOA-ID 2.x.x Konfiguration mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine Datei exportiert werden. Anschließend kann die expotierte Datei in das neue Format konfertiert und wieder in die Konfigurationsdatenbank importiert werden. Die einzelnen Schritte werden in der nachfolgenden Aufzählung näher beschrieben.

    -
      -
    1. Exportieren Sie die aktuell in MOA-ID 2.x.x verwendete Konfiguration mit Hilfe der Import/Export Funktionen im Konfigurationstool der MOA-ID Version 2.x.x in eine XML Datei. Diese in eine XML Datei exportierte Konfiguration dient als Basis für die Konvertierung in das neue Format.
      2. -
    2. Konvertieren der Konfigurationsdatei in das neue Konfigurationsformat von MOA-ID 3.x. Die Konvertierung erfolgt mit Hilfe eines Java Programms aus der Konsole. Hierfür befindet sich im Release Package das Verzeichnis $MOA_ID_AUTH_INST/migration welches alle benötigten Java Bibliotheken beinhaltet. Das Programm kann mit Hilfe des nachfolgenden Kommantozeilenparameters gestartet werden. -
      - 
      java -jar moa-id-commons.jar -in ../URL_ZUR_MOA-ID-2.x.x-Config -out ./MOA-ID-3.x.properties
      - Hierbei wird die unter - ../URL_ZUR_MOA-ID-2.x.x-Config verfügbare Konfiguration in das neue Format umgewandelt und in der Datei ./MOA-ID-3.x.properties gespeichert.
      3. -
    3. Schreiben der konvertierten Konfiguration in die neue Konfigurationstabelle der Datenbank. Dies erfolgt ebenfall mit Hilfe des mitgelieferten Konsolenprogramms, welches mit dem nachstehenden Kommantozeilenparameter gestartet wird. - 
      java -jar moa-id-commons.jar -in ./MOA-ID-3.x.properties -outdb ./moa-id-webgui.properties
      - Hierbei wird die unter ./MOA-ID-3.x.properties verfügbare Konfiguration in die Datenbank geschrieben. Die Zugriffsparameter für den Datenbankzugriff werden aus der Konfigurationsdatei ./moa-id-webgui.properties entnommen, welche Identisch zur Konfiguration des neuen MOA-ID-Configuration Tools der Version 3.0 ist.
      4. -
    -

    Hinweis: Zusätzlich besteht auch weiterhin die Möglichkeit eine MOA-ID 2.x.x Konfiguration über die Import/Export Funktion im Konfigurationstool zu importieren. Der Import einer Konfiguration kann jedoch eine längere Zeit in Anspruch nehmen wodurch TimeOut Problemen im Browser möglich sind..

    -

    4 Tomcat Security Manager

    -

    Apache Tomcat bietet die Möglichkeit den Server unter einem Security Manager zu betreiben. Damit ist es möglich den lokalen Dateizugriff zu beschränken. Mit Hilfe der Datei "catalina.policy" können so Zugriffe auf lokale Dateien und Verzeichnisse festgelegt werden. Eine beispielhafte catalina.policy Datei finden Sie im Verzeichnis $MOA_ID_INST_AUTH/tomcat. Diese Datei wurde unter Apache Tomcat 4.1.31, 5.0.28 und 5.5.27 getestet.

    -

    Mehr Informationen zum Security Manager entnehmen Sie bitte der entsprechenden Apache Tomcat Dokumentation.

    -

     

    -

    A Referenzierte Spezifikation

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    SpezifikationLink

    Security Layer Spezifikation V1.2.0

    		http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
    PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
    OpenID Connecthttp://openid.net/connect/
    Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
    -

     

    -

     

    -
    - - diff --git a/id/server/doc/handbook_v4/index.html b/id/server/doc/handbook_v4/index.html deleted file mode 100644 index cd09a4704..000000000 --- a/id/server/doc/handbook_v4/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MOA ID - Übersicht - - - - - - -
    -
    - -

    MOA-ID E-ID Proxy

    -
    -
    -
    - -
    -

    Übersicht zur Dokumentation der Version 4.0.x

    - -
    -
    Einführung
    -
    Übersicht über die einzelnen Module.
    -
    Installation
    -
    Detaillierte Anleitung für die Installation.
    -
    Konfiguration
    -
    Erläuterung aller Konfigurationsoptionen sowie Leitfaden für häufige Konfigurationsaufgaben.
    -
    Protokolle
    -
    Erläuterung der unterstützen Authentifizierungsprotokolle.
    -
    Anwendungen
    -
    Erläutert die Integration in bestehende Online-Applikationen und beschreibt die beigelegten Demo Applikationen
    -
    Zusatzinformationen
    -
    Spezifiziert allgemeine Funktionen des Modules MOA-ID-Auth
    -
    Informationen für Modul-Entwickler
    -
    Enthält Informationen für Entwickler von MOA-ID Modulen.
    -
    -
    -
     
    -
    -
    - - diff --git a/id/server/doc/handbook_v4/install/install.html b/id/server/doc/handbook_v4/install/install.html deleted file mode 100644 index 6d11e0b72..000000000 --- a/id/server/doc/handbook_v4/install/install.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - MOA-ID - Installation - - - - -
    -
    - -

    MOA-ID

    -
    -
    -
    -
    -

    Installation

    -

    Inhalt

    -
      -
    1. -

      MOA-ID-Auth und MOA-ID-Configuration

      -
        -
      1. Basisinstallation -
          -
        1. Einführung
          2. -
        2. Installation -
            -
          1. Vorbereitung
            2. -
          2. Konfiguration von Apache Tomcat -
              -
            1. Konfiguration des HTTP Connectors
              2. -
            2. Konfiguration des HTTPS Connectors
              3. -
            -
            3. -
          3. Einsatz des Moduls MOA-ID-Auth in Tomcat
            4. -
          4. Einsatz des Moduls MOA-ID-Configuration in Tomcat
            5. -
          5. Starten und Stoppen von Tomcat -
              -
            1. Unter Windows
              2. -
            2. Unter Unix
              3. -
            3. Prüfen des erfolgreichen Starts
              4. -
            -
            6. -
          6. Änderung der Konfiguration im laufenden Betrieb
            7. -
          -
          3. -
        3. Logging -
            -
          1. Format der Log-Meldungen
            2. -
          2. Wichtige Log-Meldungen
            3. -
          -
          4. -
        -
        2. -
      2. Erweiterungsmöglichkeiten
          -
        1. Vorgeschalteter Webserver
            -
          1. Microsoft Internet Information Server (MS IIS)
              -
            1. Konfiguration von mod_jk im MS IIS
              2. -
            2. Konfiguration von Tomcat
              3. -
            3. Konfiguration von SSL
              4. -
            -
            2. -
          2. Apache
              -
            1. Konfiguration von mod_jk im Apache
              2. -
            2. Konfiguration von Tomcat
              3. -
            3. Konfiguration von SSL mit mod_SSL
              4. -
            -
            3. -
          -
          2. -
        -
        3. -
      -
    -
      -
    1. Referenzierte Software
      2. -
    -

    1 Übersicht

    -

    Die Module MOA-ID-Auth und MOA-ID-Configuration sind als plattformunabhängige Module ausgelegt. MOA-ID-Auth bietet Webservices über HTTPS zur Identifizierung und Authentifizierung an. Das Modul MOA-ID-Configuration stellt eine Weboberfläche zur Konfiguration des MOA-ID-Auth Modules zur Verfügung.

    -

    Dieses Handbuch beschreibt die Installation der beiden Module.

    -

    2 MOA-ID-Auth und MOA-ID-Configuration

    -

    Dieser Abschnitt beschreibt die Installation von der Module MOA-ID-Auth und MOA-ID-Configuration. Im ersten Unterkapitel wird eine minimale Basisinstallation beschrieben. Das zweite Unterkapitel zeigt eine Reihe von optionalen Erweiterungsmöglichkeiten auf.

    -

    2.1 Basisinstallation

    -

    2.1.1 Einführung

    -

    Die Basisinstallation der Module MOA-ID-Auth und MOA-ID-Configuration stellt einerseits die minimalen Anforderungen für den Betrieb von MOA-ID dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.

    -

    Die Mindestanforderungen für die Basisinstallation sind:

    - -

    Wir empfehlen jedoch jeweils aktuelle Version zu verwenden:

    - -

    In diesem Betriebs-Szenario wird das MOA-ID-Auth Webservice und das MOA-ID Konfigurationstool in Tomcat zum Einsatz gebracht. Beide Module können sowohl in derselben Tomcat-Instanz, als auch in separaten Tomcat-Instanzen betrieben werden. Für den Fall des separaten Betriebs muss die Installation auf beiden Tomcat-Instanzen ausgeführt werden. In beiden Fällen fungiert der Tomcat gleichzeitig als HTTP- und HTTPS-Endpunkt für beide Module. Beide Protokolle werden direkt in Tomcat konfiguriert, wobei MOA-ID-Auth und MOA-ID-Configuration Log4j als Logging Toolkit verwenden.

    -

    2.1.2 Installation

    -
    2.1.2.1 Vorbereitung
    -

    Die folgenden Schritte dienen der Vorbereitung der Installation.

    -
    -
    Installation von Java SE
    -
    Installieren Sie Java SE in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der Java SE Installation wird im weiteren Verlauf als $JAVA_HOME bezeichnet.
    -
    Installation von Apache Tomcat
    -
    Installieren Sie Apache Tomcat in ein Verzeichnis, das keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte die zu Ihrer Java SE passende Distribution von Tomcat. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet.
    -
    Entpacken der MOA-ID-Auth Webservice Distribution
    -
    Entpacken Sie die Datei moa-id-auth-4.x.x.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_ID_AUTH_INST bezeichnet.
    -
    Installation der Kryptographiebibliotheken von SIC/IAIK
    -
    -

    Ab Java 9 ist eine Installation der Kryptographiebibliotheken nicht mehr notwendig.

    -
    -
    -

    Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_ID_AUTH_INST/ext in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden Unlimited Strength - - - Jurisdiction Policy Files von der Java SE Downloadseite und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung.

    -
    -
    Installation einer Datenbank
    -
    Für den Betrieb von MOA-ID 4.x wird eine Datenbank benötigt, wobei mySQL als Datenbank empfohlen wird (wurde mit mySQL getestet). Der Einsatz eines alternativen Datenbanksystems ist jedoch ebenfalls möglich. Für den Betrieb werden mindestens zwei getrennte Datenbank Schema benötig, da die Konfiguration und die Session Informationen getrennt abgelegt werden. Erstellen Sie zwei Datenbank Schemas welche von MOA-ID-Auth verwendet werden sollen. Deren Namen können z.B. auf moa-id-session für Sessiondaten und moa-id-config für die Konfiguration lauten. Beliebige andere Namen für die Datenbank Schema sind jedoch auch möglich. -
    -
    -
    2.1.2.2 Konfiguration von Apache Tomcat
    -

    Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. Tomcat wird grundsätzlich mit einer funktionierenden Default-Konfiguration ausgeliefert.

    -
    2.1.2.2.1 Konfiguration des HTTP Connectors
    -

    Die Tomcat Default-Konfiguration schaltet ausschließlich den Connector für HTTP auf Port 8080 frei. Wir empfehlen diese Konfiguration nur für Fälle, in denen das MOA-ID-Configuration Modul in einer abgeschlossenen Netzwerkumgebung betrieben wird. Das Modul MOA-ID-Auth verlangt für Authentifizierungsanfragen zwingend HTTPS.

    -
    2.1.2.2.2 Konfiguration des HTTPS Connectors
    -

    Für den sicheren Betrieb von MOA-ID-AUTH ist die Verwendung von SSL Voraussetzung, sofern nicht ein vorgelagerter Webserver (Apache oder IIS) das SSL-Handling übernimmt. Ebenso kann SSL auch für MOA-ID-Configuration verwendet werden.

    -

    Für die dazu notwendige Konfiguration kann die im vorigen Abschnitt besprochene minimale Tomcat-Konfiguration als Ausgangspunkt verwendet werden: Zunächst ist der HTTP Connector abzuschalten (auskommentieren). Anschließend ist der HTTPS Connector zu konfigurieren. Das Dokument Tomcat SSL Configuration HOW-TO gibt einen guten Überblick dazu. Grob zusammengefasst sind folgende Schritte durchzuführen:

    -
      -
    • Erstellung eines Server-Keystores, der den privaten Schlüssel sowie das zugehörige Zertifikat des Webservices enthält, mit dem es sich bei Aufbau einer SSL-Verbindung gegenüber dem Kunden ausweist sowie das dazugehörige Server-Zertifikat enthält. Sie können diesen Keystore z.B. mit keytool erstellen, einem Programm, das Ihrer Java SE beiliegt.
      • -
    • Konfiguration des HTTPS Connectors in $CATALINA_HOME/conf/server.xml.
      • -
    • Falls eine Client-Authentisierung gewünscht ist, muss die Konfiguration des SSL-Connectors in $CATALINA_HOME/conf/server.xml angepasst werden.
      • -
    -

    Die Konfiguration des HTTPS Connectors kann entfallen, wenn Tomcat ein Webserver vorgeschaltet ist, und dieser die SSL-Kommunikation mit dem Kunden übernimmt (siehe Abschnitt 2.2.1).

    -
    2.1.2.3 Einsatz des Moduls MOA-ID-Auth in Tomcat
    -

    Um die Module MOA-ID-Auth und MOA-ID-Configuration in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

    -
      -
    • Die Datei $MOA_ID_AUTH_INST/moa-id_auth.war enthält das einsatzfertige MOA-ID-Auth Webarchiv und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-auth entpackt.
      • -
    • Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier. Diese funktionsfähige Konfiguration enthält auch eine MOA-SPSS Konfiguration, da das Modul MOA-SPSS zur Signaturprüfung im Modul MOA-ID-Auth verwendet wird.
      -
      • -
    • Ab JAVA 9 wird dieser Schritt nicht nicht mehr benötigt.
      - Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • -
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben). Eine Beispielkonfiguration in welcher diese Umgebungsvariablen gesetzt werden finden Sie hier. -
        -
      • moa.id.configuration: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • moa.spss.server.configuration: Pfad und Name der zentralen Konfigurationsdatei für MOA SP/SS. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/conf enthaltene Default-Konfiguration herangezogen.
        • -
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • -
      • -Dlogback.configurationFile: URL der LogBack Konfigurationsdatei. Eine beispielhafte LobBack-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen. Überdies besteht die Möglichkeit eine bestehende Log44 Konfigurationsdatei in der LogBack Format zu überführen (http://logback.qos.ch/translator/).
        • -
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Zertifikate. Die SSL Serverzertifikate der Server von denen mittels https Dateien bezogen werden müssen im Truststore abgelegt werden. Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • -
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • -
      • spring.profiles.active: Set generic configuration parameters in MOA-ID-Auth Spring-Context. Configuartion values are added as comma-separated list (e.g. byteBasedConfig,value2,value3). Details on possible configuration values are in Chapter Configuration.
        • -
      -
      • -
    -
    2.1.2.4 Einsatz des Moduls MOA-ID-Configuration in Tomcat
    -
      -
    • Die Datei $MOA_ID_AUTH_INST/egiz-configuration-webapp.war enthält das einsatzfertige MOA-ID-Configuration Webarchiv und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/egiz-configuration-webapp entpackt.
      • -
    • Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id-configuration). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier.
      -
      • -
    • Ab JAVA 9 wird dieser Schritt nicht nicht mehr benötigt.
      - Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • -
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben): -
        -
      • moa.id.webconfig: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Configuration. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • user.properties: Pfad und Name der Basiskonfigurationsdatei für das Usermanagement der Konfigurationsoberfläche. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • -
      • logback.configurationFile: URL der LogBack Konfigurationsdatei. Eine beispielhafte LobBack-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen. Überdies besteht die Möglichkeit eine bestehende Log44 Konfigurationsdatei in der LogBack Format zu überführen (http://logback.qos.ch/translator/).
        • -
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Zertifikate Die SSL Serverzertifikate der Server von denen mittels https Dateien bezogen werden müssen im Truststore abgelegt werden. Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • -
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • -
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • -
      • spring.profiles.active: Set generic configuration parameters in MOA-ID-Configuration Spring-Context. Configuartion values are added as comma-separated list (e.g. byteBasedConfig,value2,value3). Details on possible configuration values are in Chapter Configuration.
        • -
      -
      • -
    -
    2.1.2.4 Starten und Stoppen von Tomcat
    -
    2.1.2.4.1 Unter Windows
    -
    -

    Das Verzeichnis $MOA_IA_AUTH_INST/tomcat/win32 enthält Script-Dateien zum Starten und Stoppen von Tomcat. Vor der erstmaligen Verwendung der Scripts müssen in den ersten Zeilen die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden. Evtl. müssen Sie auch noch die in den Script-Dateien gesetzten, in Abschnitt 2.1.2.3 besprochenen System Properties anpassen.

    -
    -
    2.1.2.4.2 Unter Unix
    -

    Zunächst müssen die in Abschnitt 2.1.2.3 besprochenen System Properties mit Hilfe der Umgebungsvariablen CATALINA_OPTS gesetzt sein. Die Datei $MOA_ID_AUTH_INST/tomcat/unix/moa-env.sh enthält ein Beispiel dafür. Des Weiteren müssen noch die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden.

    -

    Nun kann Tomcat aus seinem Basisverzeichnis mit

    -
    bin/catalina.sh start
    -gestartet werden. Das Stoppen von Tomcat erfolgt analog mit -
    bin/catalina.sh stop
    -
    2.1.2.4.3 Prüfen des erfolgreichen Starts
    -
    -

    Ein erfolgreicher Start des MOA-ID-Auth Modules ist an folgender Log-Meldung ersichtlich:
    -

    -
    -
    32131 [localhost-startStop-1] INFO moa.id.auth  - MOA ID Authentisierung wurde erfolgreich gestartet 
-32131 [localhost-startStop-1] INFO moa.id.auth  - Dispatcher Servlet initialization finished.
    -

    Analog bei MOA-ID-Configuration

    -
    INFO | 21 10:16:22 | localhost-startStop-1 | Loading config module: MOAIDConfigurationModul
    -

    Bei leichten Fehlern in der Konfiguration geben WARN Log-Meldungen unmittelbar davor Aufschluss über fehlerhafte Konfigurations-Einträge. - Nach dem Starten von Tomcat stehen MOA-ID-Auth und MOA-ID-Configuration zur Verfügung. Die Einsprungspunkte der unterschiedlichen Authentifizierungsprotokolle von MOA-ID-Auth werden im Abschnitt Protokolle im Detail beschrieben.

    -
    -http://<host>:<port>/moa-id-auth/
-http://<host>:<port>/egiz-configuration-webapp/
    -

    bzw. -

    -
    -https://<host>:<port>/moa-id-auth/
-https://<host>:<port>/egiz-configuration-webapp/
    -

    Die Verfügbarkeit des Services können Sie einfach überprüfen, indem Sie die Endpunkte mit einem Web-Browser aufgerufen; dies sollte nach erfolgreichem Start zur Anzeige einer Informationsseite führen.

    -
    2.1.3 Logging
    -

    Beide Module verwenden Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: -

      -
    • -

      Das verwendete Log-Level (DEBUG, INFO, WARN, ERROR, FATAL);

      -
      • -
    • -

      Name und maximale Größe der Log-Datei(en);

      -
      • -
    • -

      Das Aussehen der Log-Einträge.

      -
      • -
    -

    Hierbei werden folgende Log-Hierarchien verwendet:

    -
      -
    • -

      at.gv.egiz.components.configuration für Log-Meldungen aus allgemeinen EGIZ KonfigurationsGUI

      -
      • -
    • -

      at.gv.egovernment.moa.id.configuration für Log-Meldungen aus MOA-ID Configurationsmodul

      -
      • -
    • at.gv.egovernment.moa.id für alle Log-Meldungen aus MOA-ID-Auth
      • -
    • -

      at.gv.egovernment.moa.spss für alle Log-Meldungen aus dem MOA/SPSS

      -
      • -
    • -

      at.gv.egiz.eventlog.plain.all für alle Log-Meldungen aus dem MOA-ID EventLog zur Revisionssicherung

      -
      • -
    • -

      iaik.server für alle Log-Meldungen aus den SIC/IAIK Kryptographie-Modulen.

      -
      • -
    -

    Eine für beide Module passende Konfigurationsdatei für Log4j finden Sie hier. Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Dateien moa-id-auth.log und moa-id-configuration.log geschrieben.

    -
    2.1.3.1 Format der Log-Meldungen
    -

    Anhand einer konkreten Log-Meldung wird das Format der MOA SP/SS Log-Meldungen erläutert:

    - 
    - INFO | 2017-09-18 10:29:22,904 | SID-7947921060553739539 | TID-4708232418268334030 | https://sso.demosp.at/handysignatur 
-      | ajp-nio-28109-exec-7 | No SSO Session cookie found
-
    -

    Der Wert INFO besagt, dass die Log-Meldung im Log-Level INFO entstanden ist. Folgende Log-Levels existieren:

    -
      -
    • -

      DEBUG: Log-Meldungen im Log-Level DEBUG geben Auskunft über die innere Arbeitsweise des Systems. Sie sind hauptsächlich für Entwickler interessant.

      -
      • -
    • -

      INFO: Diese Log-Meldungen geben Status-Informationen über den Ablauf des Webservices, wie z.B. über das Einlangen einer neuen Anfrage.

      -
      • -
    • -

      WARN: Bei der Ausführung einer Anfrage sind leichte Fehler aufgetreten. Der Ablauf des Webservices ist nicht weiter beeinträchtigt.

      -
      • -
    • -

      ERROR: Die Ausführung einer Anfrage musste abgebrochen werden. Das Webservice ist davon nicht beeinträchtigt.

      -
      • -
    • -

      FATAL: Es ist ein Fehler aufgetreten, der den weiteren Betrieb des Webservices nicht mehr erlaubt.

      -
      • -
    -

    Der nächste Wert 01 21:25:26,540 gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in diesem Fall den 1. Tag im aktuellen Monat, sowie die genaue Uhrzeit).

    -

    Der Wert SID-7947921060553739539 bezeichnet die SessionID, welche diesem Request zugeordnet wurde. Eine SessionID ist innerhalb einer SSO auch über mehrere Authentifizierungsrequests eindeutig. Das Loggen der SessionID kann mittels %X{sessionId} in der log4j Konfiguration gesetzt werden

    -

    Der Wert TID-4708232418268334030 bezeichnet die TransactionsID, welche diesem Request zugeordnet wurde. Eine TransactionsID ist innerhalb eines Authentifizierungsrequests eindeutig. Das Loggen der TransactionsID kann mittels %X{transactionId} in der log4j Konfiguration gesetzt werden

    -

    Der Wert https://sso.demosp.at/handysignatur bezeichnet die Online Applikation (eindeutiger Identifier dieses Service Providers) für welchen dieser Authentifizierungsrequest durchgeführt wird. Das Loggen des OA Identifiers kann mittels %X{oaId} in der log4j Konfiguration gesetzt werden

    -

    Der Wert ajp-nio-28109-exec-7 bezeichnet den Thread, von dem die Anfrage bearbeitet wird.

    -

    Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist häufig ein Java Stack-Trace angefügt, der eine genauere Ursachen-Forschung ermöglicht.

    -
    2.1.3.2 Wichtige Log-Meldungen
    -

    Neben den im Abschnitt 2.1.2.4.3 beschriebenen Log-Meldungen, die anzeigen, ob das Service ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen.

    -

    Die Entgegennahme einer Anfrage wird angezeigt durch: - -

    - 
    125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - REQUEST: /moa-id-auth/dispatcher
-125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - QUERY  : mod=id_pvp2x&action=Post&
    -

    Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch: -

    2435298 [ajp-bio-129.27.142.119-38609-exec-10] ERROR moa.id.auth  - Failed to generate a valid protocol request!
    -
    -

    In diesem Fall gibt der mitgeloggte Stacktrace Auskunft über die Art des Fehlers.

    -

    Die tatsächlich übertragenen Anfragen bzw. Antworten werden aus Effizienzgründen nur im Log-Level DEBUG angezeigt.

    -
    -

    2.2 Erweiterungsmöglichkeiten

    -

    Ausgehend von der Basisinstallation können die optionalen Erweiterungen, die in den nachfolgenden Abschnitten beschrieben werden, unabhängig und in beliebiger Kombination aufgesetzt werden.

    -

    2.2.1 Vorgeschalteter Webserver

    -
    2.2.1.1 Microsoft Internet Information Server (MS IIS)
    -

    Den MOA SP/SS Webservices kann optional ein MS IIS vorgeschaltet sein. In diesem Fall übernimmt der MS IIS die HTTP- bzw. HTTPS-Kommunikation mit dem Aufrufer des Webservices. Die Kommunikation zwischen MS IIS und dem in Tomcat eingerichteten MOA-ID Modulen wird durch mod_jk durchgeführt. Die angeführten Konfigurationsschritte gehen von einer MS IIS Standard-Installation aus.

    -
    2.2.1.1.1 Konfiguration von mod_jk im MS IIS
    -

    Für die Kommunikation des MS IIS mit dem im Tomcat eingerichteten MOA SP/SS Webservice wird das ISAPI-Modul von mod_jk im MS IIS installiert und konfiguriert. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk IIS HowTo. Beispiele für workers.properties und uriworkermap.properties Dateien liegen im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

    -
    2.2.1.1.2 Konfiguration von Tomcat
    -

    Damit Tomcat die Aufrufe entgegennehmen kann, die von MS IIS mittels mod_jk weiterleitet werden, muss in $CATALINA_HOME/conf/server.xml der AJP Connector aktiviert werden. Im Gegenzug können die Konnektoren für HTTP und HTTPS deaktiviert werden. Das geschieht am einfachsten durch Ein- bzw. Auskommentieren der entsprechenden Connector Konfigurations-Elemente in dieser Datei.

    -
    2.2.1.1.3 Konfiguration von SSL
    -

    Die Dokumentation zum Einrichten von SSL auf dem MS IIS steht nach Installation des IIS unter http://localhost/iisHelp/ oder aber auch auf den Webseiten von Mircrosoft zur Verfügung.

    -
    2.2.1.2 Apache
    -

    Den MOA SP/SS Webservices kann ein Apache Webserver vorgeschaltet sein. Das Prinzip funktioniert wie bei MS IIS, auch hier wird mod_jk für die Kommunikation zwischen Webserver und Tomcat eingesetzt. Die angeführten Konfigurationsschritte gehen von einer Standard-Installation des Apache Webservers aus.

    -
    2.2.1.2.1 Konfiguration von mod_jk im Apache
    -

    Um die MOA-ID Module hinter einem Apache Webserver zu betreiben, ist die Konfiguration des Apache-Moduls mod_jk erforderlich. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk Apache HowTo. Ein Beispiel für eine workers.properties Datei liegt im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

    -

    Um die MOA-ID Module dem Apache Webserver bekannt zu machen, sind zumindest folgende Einträge im globalen Kontext der Apache-Konfigurationsdatei notwendig:

    -
    LoadModule jk_module /usr/lib/apache/mod_jk.so
    AddModule jk_module
    JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
    JkWorkersFile conf/workers.properties 
    JkMount /moa-spss/* moaworker
    -

    Die Pfad- und Dateinamen können je nach existierender Apache Installation geringfügig variieren.

    -
    2.2.1.2.2 Konfiguration von Tomcat
    -

    Die Konfiguration von Tomcat ist analog zu Abschnitt 2.2.1.1.2 durchzuführen.

    -
    2.2.1.2.2 Konfiguration von SSL mit mod_SSL
    -

    Apache kann in Verbindung mit mod_SSL als SSL-Endpunkt für die MOA-ID Module fungieren. In diesem Fall entfällt die SSL-Konfiguration in Tomcat, da Apache und Tomcat auch im Fall von SSL Daten via mod_jk austauschen. Eine detaillierte Installations- und Konfigurationsanleitung enthält die Online-Dokumentation von mod_SSL.

    -

    Bei der Verwendung von Client-Authentisierung muss darauf geachtet werden, dass mod_ssl die HTTP-Header mit den Informationen über das Client-Zertifikat exportiert. Dies wird durch Angabe der folgenden Option in der Apache-Konfiguration erreicht:

    - 
    SSLOptions +ExportCertData +StdEnvVars
    -

    Je nach vorhandener SSL-Konfiguration des Apache Webservers kann diese Option im globalen Kontext, im Kontext des Virtual Hosts oder im Kontext eines Verzeichnisses spezifiziert werden.

    -

    A Referenzierte Software

    -

    Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

    - - - - - - - - - - - - - - - - - -
    NameBeschreibung
    Apache Tomcat Apache Tomcat Servlet-Container
    Java SEJava Standard Edition (Software Development Kit bzw. Java Runtime Environment)
    Log4J Logging Framework
    -
    - - diff --git a/id/server/doc/handbook_v4/intro/Blockdiagramm.png b/id/server/doc/handbook_v4/intro/Blockdiagramm.png deleted file mode 100644 index 18d5b84a2..000000000 Binary files a/id/server/doc/handbook_v4/intro/Blockdiagramm.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/intro/E-ID-Proxy.png b/id/server/doc/handbook_v4/intro/E-ID-Proxy.png deleted file mode 100644 index 2e7bb2896..000000000 Binary files a/id/server/doc/handbook_v4/intro/E-ID-Proxy.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png b/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png deleted file mode 100644 index 7735679bf..000000000 Binary files a/id/server/doc/handbook_v4/intro/Gesamtarchitektur.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/intro/anmeldeablauf.png b/id/server/doc/handbook_v4/intro/anmeldeablauf.png deleted file mode 100644 index 59bdefe62..000000000 Binary files a/id/server/doc/handbook_v4/intro/anmeldeablauf.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/intro/intro.html b/id/server/doc/handbook_v4/intro/intro.html deleted file mode 100644 index a7a4a6357..000000000 --- a/id/server/doc/handbook_v4/intro/intro.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MOA-ID - Einführung - - - - -
    -
    - - -

    MOA-ID

     -
    -
    -
    - -
    -

    Einführung

    -

    Allgemeines

    -

    MOA-ID E-ID Proxy

    -

    MOA-ID-Configuration

    -

     

    -

     

    -

    1 Allgemeines

    -

    Der neue elektronische Identitätsnachweis E-ID wird die alte Bürgerkarte ersetzen und stellt ein System mit mehr Einsatzmöglichkeiten dar. Der neue E-ID basiert auf der nachfolgend dargestellten Architektur, die sich aus einer Vielzahl verschiedener Komponenten zusammensetzt. Das Zusammenspiel der Komponenten, sowie eine kurze Definition wird nachfolgend beschrieben.

    -

     

    -

     

    -

    Architektur MOA-ID

    -

     

    -

    Die Gesamtarchitektur besteht aus vier Ebenen. Benutzer authentifizieren sich in der Applikationsebene gegenüber einem bestimmten Service Provider. Dieser Identifikations- und Authentifizierungsprozess erfolgt über den zentralen Identity Provider und dem Vertrauensdiensteanbieter (VDA) in der Authentifizierungsebene. Ebenso erfolgt hier im Vertretungsfall die Auswahl einer adäquaten Vollmacht über das Online-Vollmachten Service (OVS). Die Authentifizierungsebene wird auch als „E-ID Front-End“ bezeichnet. Die Personenbindung wird im E-ID Backend, in der Datenaggregierungsebene erstellt und über das E-ID Frontend an den Service Provider ausgeliefert. Werden über das Minimum Data Set (MDS) hinaus, d.h. bPK(s), Name und Geburtsdatum, weitere Attribute benötigt, so werden diese vom E-ID Backend von den jeweiligen Registern (Datenebene) bezogen und in die Personenbindung aufgenommen.

    -

     

    -

     

    -

    2 MOA-ID E-ID Proxy

    -

    Der neue elektronische Identitätsnachweis E-ID bietet ein zentrales Identitätsmanagementsystem welches die aktuell dezentral betriebenen MOA-ID Instanzen ersetzt. Für die Anbindung von Service Providern (Applikationen) werden durch den Identity Provider (IDP) des E-ID System folgende, auch bereits von MOA-ID unterstütze, Authentifizierungsprotokolle angeboten:

    -
      -
    • PVP2 S-Profil (SAML2)
      • -
    • OpenID Connect
      • -
    -

    Eine direkte Anbindung von Service Providern mittels des SAML1 Authentifizierungsprotokolls, welches in MOA-ID bereits seit der Version 2.x als "Deprecated" markiert war, ist am IDP den zentrales Identitätsmanagementsystem nicht mehr möglich. Alle Service Provider welche aktuell mittels SAML1 an MOA-ID Ankoppeln können somit nicht mehr direkt an den neue elektronische Identitätsnachweis ankopplen.
    -

    -

    Das Modul MOA-ID E-ID Proxy wird als MOA-ID Version 4.x veröffentlicht und implementiert einen Adapter zwischen dem IDP des zentrales Identitätsmanagementsystems und Service Providern (Anwendungen), welcher dazu dient SAML1 Applikationen an den neue elektronische Identitätsnachweis ankopplen. Der MOA-ID E-ID Proxy bietet Anwendugnen die selbe SAML1 Schnittstelle, wie sie bereits aus den vorangegangenen MOA-ID Versionen bekannt ist, und leitet alle Authentifizierungsanfragen direkt an das E-ID System weiter. Diese Ankopplung an das zentrales Identitätsmanagementsystem ist im nachfolgenden Blockdiagramm auch grafisch dargestellt.

    -

     

    -
    -

    Architektur MOA-ID

    -

     

    -

    Die Installation und der Betrieb ist identisch zur Version 3.x von MOA-ID, es steht jedoch ab der Version 4.x nur mehr die Funktion als E-ID Proxy zur Verfügung.

    -

    Die SAML1 Schnittstelle des MOA-ID E-ID Proxy ist zwar identisch, doch werden durch das zentrale E-ID System nicht mehr alle aus MOA-ID < v4.x bekannten Identitätsattribute bereitgestellt. Somit ändert sich der Inhalt der vom MOA-ID E-ID Proxy bereitgestellten SAML1 Assertion im Bezug auf die darin enthaltenten Attribute zur Person. Die nachfolgende Liste zeigt eine kurze Zusammenfassung der Änderungen. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

    -

    Folgende Attribute stehen nicht mehr zur Verfügung:

    -
      -
    • EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)
      • -
    • EID-SOURCE-PIN-TYPE (1.2.40.0.10.2.1.1.261.104)
      • -
    • EID-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.38)
      • -
    • EID-AUTH-BLOCK (urn:oid:1.2.40.0.10.2.1.1.261.62)
      • -
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.70)
      • -
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN-TYPE (urn:oid:1.2.40.0.10.2.1.1.261.102)
      • -
    • MANDATE-FULL-MANDATE (urn:oid:1.2.40.0.10.2.1.1.261.92)
      • -
    -

    Folgende neuen Attribute stehen zur Verfügung:

    -
      -
    • ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.22)
      • -
    • BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.28) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • -
    • MANDATOR-NATURAL-PERSON-ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.72)
      • -
    • MANDATOR-NATURAL-PERSON-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.73) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • -
    • EID-ONLINE-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.39) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • -
    • EID-IDENTITY-STATUS-LEVEL (urn:oid:1.2.40.0.10.2.1.1.261.109) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • -
    -

    Als weitere Anpassung wird die iFrame Integration der Handy-Signatur nicht mehr zur Verfügung stehen und es erfolgt eine vollformat Weiterleitung an das zentrale E-ID System.

    -

     

    -

    3 MOA-ID-Configuration

    -

    Das Modul MOA-ID-Configuration stellt eine web-basierte Benutzerschnittstelle zur Konfiguration des Moduls MOA-ID E-ID Proxy zur Verfügung, wobei sich die Konfiguration in zwei Teilbereiche unterteilt ist. Eine detaillierte Aufstellung der einzelnen Konfigurationspunkte befindet sich im Kapitel Konfiguration.

    -
      -
    1. Allgemeine Konfiguration
      - In diesem Bereich sind alle Basiseinstellungen der MOA-ID E-ID Proxy Instanz hinterlegt. Beispiele hierfür sind Single Sign-On, unterstütze Authentifizierungsprotokolle, Informationen zu MOA-ID E-ID Proxy, URLs zu externen Services, ... Eine Änderung der Basiseinstellung erfordert besondere Benutzerrechte am Konfigurationstool.
      2. -
    2. Online-Applikationen
      - In diesem Abschnitt erfolgt die Konfiguration der einzelnen bei MOA-ID E-ID Proxy registrierten Service-Provider. Hierbei handelt es sich um Authentifizierungsprotokoll-spezifische Einstellungen, Bereich des Service-Providers (öffentlich / Privatwirtschaftlich), Konfiguration der BKU Auswahl, .... Wobei sich die Konfigurationsmöglichkeiten je nachdem welche Benutzerrechten vergeben sind, unterscheiden können.
      3. -
    -

    Zusätzlich unterstützt das Module MOA-ID-Configuration auch eine einfache Benutzerverwaltung mit Rechtevergabe mit deren Hilfe die Verwaltung von Online-Applikationen an den jeweiligen Service-Provider ausgelagert werden kann. Die Anmeldung am Konfigurationstool erfolgt mittels Bürgerkarte, Handysignatur oder STORK, wobei optional auch eine Anmeldung mittels Benutzername und Passwort zur Verfügung steht.

    -

     

    -
    - - diff --git a/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd b/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd deleted file mode 100644 index d6ab7ae46..000000000 --- a/id/server/doc/handbook_v4/moduledevinfo/ProcessDefinition.xsd +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html b/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html deleted file mode 100644 index 28e4f1bb4..000000000 --- a/id/server/doc/handbook_v4/moduledevinfo/moduledevinfo.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - MOA-ID - Informationen für Modul-Entwickler - - - - - - - - - - - - -
    - Logo BKA - Dokumentation - Logo EGIZ -
    -
    - -

    - MOA-ID (Identifikation) -

    -

    Informationen für Modul-Entwickler

    -
    - - -

    Inhalt

    -
      -
    1. -

      - Übersicht -

      -
      2. -
    2. -

      - Prozesse -

      -
        -
      1. Aufgaben (Tasks)
        2. -
      2. Transitions
        3. -
      -
      3. -
    3. -

      - Module -

      -
        -
      1. Metadaten und Prozessauswahl
        2. -
      2. -

        - Discovery -

        -
          -
        1. Service Loader Mechanismus
          2. -
        2. Spring Bean Discovery
          3. -
        -
        3. -
      -
      4. -
    4. -

      - Hinweise -

      -
      5. -
    -
    - - -

    - 1 Übersicht -

    -

    - MOA-ID ab Version 2.2 ermöglicht die dynamische Erweiterung um zusätzliche Funktionalität durch die Nutzung der - integrierten Modularchitektur.
    - Entwickler können nun eigene Prozesse, um die MOA-ID erweitert werden soll, definieren (z.B. Unterstützung - eines speziellen Authentifizierungsworkflows, Erweiterung um Vollmachten oder ausländische Identitäten etc). - MOA-ID bietet eine Ablaufsteuerung ("ProcessEngine"), die einzelne Aufgaben (Tasks) entsprechend einer vorgegebenen Prozessdefinition - abarbeiten kann. -

    -

    - Mehrere Prozesse können zu einzelnen Modulen zusammengefasst werden. Ein Modul, typischerweise repräsentiert durch eine separate JAR-Datei, wird automatisch erkannt, sobald sich - dieses im Classpath der Anwendung befindet. Damit stehen die in diesem Modul definierten Prozesse MOA-ID - automatisch zu Verfügung. -

    -

    - Beim Starten eines Authentifizierungsvorgangs speichert MOA-ID die zu diesem Zeitpunkt zu Verfügung stehenden - Informationen (Ergebnis der BKU-Auswahl, Auswahl des Herkunftslandes, Wunsch nach Vollmachten-Nutzung etc.) in - eine Datenstruktur ("ExecutionContext"). Module entscheiden dann auf Basis dieser Informationen, ob sie entsprechende Prozesse für den gegebenen Kontext anbieten können. Sobald ein - passender Prozess gefunden wurde, beginnt die MOA-ID ProcessEngine mit der Ausführung der darin definierten - Aufgaben. -

    -

    - Bei diesen Aufgaben handelt es sich typischerweise um einzelne synchrone oder asynchrone Schritte eines kompletten - Authentifizierungsvorgangs wie z.B. das Erstellen eines HTML-Formulars zum Auslesen der Personenbindung (synchron), - das Empfangen und Verarbeiten einer Personenbindung (asynchron), das Aushandeln einer Session mit dem Vollmachtenportal (synchron) etc. - Jeder Task erhält bei Ausführung automatisch Zugriff auf den ExecutionContext, der von Task zu Task weitergereicht, zum Austausch bzw. Akkumulieren von Daten dient und schließlich auch persistiert wird. - Darüber hinaus steht jeweils HttpServletRequest und HttpServletResponse zu Verfügung. -

    - -

    - 2 Prozesse -

    -

    - Ein Prozess definiert sich primär über seine Tasks, die es in einer bestimmten Abfolge abzuarbeiten gilt. Um welche Tasks es sich handelt und wie die Abfolge unter welchen Bedingungen aussieht wird in einer - ProzessDefinition in Form eines XML-Dokuments festgelegt. -

    -

    Siehe ProcessDefinition.xsd.
     

    - -

    - Die folgende Prozessdefinition zeigt als Beispiel den internen Standard-Authentifizierungsprozess von MOA-ID. Dieser unterstützt Vollmachten uns ausländische Identitäten:
      -

    -
    <?xml version="1.0" encoding="UTF-8"?> -<pd:ProcessDefinition id="DefaultAuthentication" xmlns:pd="http://reference.e-government.gv.at/namespace/moa/process/definition/v1"> - - <pd:Task id="createIdentityLinkForm" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CreateIdentityLinkFormTask" /> - <pd:Task id="verifyIdentityLink" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyIdentityLinkTask" async="true" /> - <pd:Task id="verifyAuthBlock" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyAuthenticationBlockTask" async="true" /> - <pd:Task id="verifyCertificate" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyCertificateTask" async="true" /> - <pd:Task id="getMISSessionID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetMISSessionIDTask" async="true" /> - <pd:Task id="certificateReadRequest" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CertificateReadRequestTask" /> - <pd:Task id="prepareAuthBlockSignature" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.PrepareAuthBlockSignatureTask" /> - <pd:Task id="getForeignID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetForeignIDTask" async="true" /> - - <pd:StartEvent id="start" /> - - <pd:Transition from="start" to="createIdentityLinkForm" /> - - <pd:Transition from="createIdentityLinkForm" to="verifyIdentityLink" /> - - <pd:Transition from="verifyIdentityLink" to="certificateReadRequest" conditionExpression="!ctx['identityLinkAvailable'] || ctx['useMandate']" /> - <pd:Transition from="verifyIdentityLink" to="prepareAuthBlockSignature" /> - - <pd:Transition from="prepareAuthBlockSignature" to="verifyAuthBlock" /> - - <pd:Transition from="certificateReadRequest" to="verifyCertificate" /> - - <pd:Transition from="verifyCertificate" to="verifyAuthBlock" conditionExpression="ctx['useMandate']" /> - <pd:Transition from="verifyCertificate" to="getForeignID" /> - - <pd:Transition from="verifyAuthBlock" to="getMISSessionID" conditionExpression="ctx['useMandate']" /> - <pd:Transition from="verifyAuthBlock" to="end" /> - - <pd:Transition from="getMISSessionID" to="end" /> - <pd:Transition from="getForeignID" to="end" /> - - <pd:EndEvent id="end" /> - -</pd:ProcessDefinition> -
    -

     

    - -

    - Jede Prozessbeschreibung muss zwingend ein StartEvent und ein EndEvent enthalten. - Einzelne Aufgaben sind durch Task-Elemente gekennzeichnet, wobei via Attribut async - festgelegt wird ob es sich dabei um einen synchronen (Standardeinstellung) oder um einen asynchronen Task handelt (siehe auch Abschnitt 2.1). -

    - -

    - 2.1 Aufgaben (Tasks) -

    -

    - Aus technischer Sicht sind Aufgaben einfache Klassen, die die abstrakte Klasse at.gv.egovernment.moa.id.process.springweb.MoaIdTask (moa-id-lib-xy.jar) - implementieren. Diese definiert lediglich eine execute-Methode, die aufgerufen wird, sobald der Task - von der ProcessEngine gestartet wird. Über diese Methode erhält der Task Zugriff auf den ExecutionContext sowie - auf HttpServletRequest und HttpServletResponse. Der HttpServletRequest und der ExecutionContext können nun ausgewertet, bzw. falls notwendig der ExecutionContext und die HttpServletResponse auch manipuliert werden. -

    -

    - Synchrone Tasks werden hintereinander ausgeführt. Trifft die Process Engine auf einen asynchronen Task wird dieser - nicht gleich ausgeführt, sondern der Prozess wird zunächst angehalten. Bei asynchronen Tasks handelt es sich meist um Tasks, - die zuvor eine Benutzerinteraktion erfordern (z.B. Signatur mit Bürgerkartenumgebung).
    - Als Beispiel eines asynchronen Tasks wäre ein VerifyIdentityLinkTask zu nennen, der nach Eintreffen - der Antwort der Bürgerkartenumgebung auf der DataURL aufgeweckt wird, um eine InfoBoxReadResponse mit - der Personenbindung entgegen zu nehmen, diese zu parsen und zu validieren. -

    -

    - Die Aufgabe eines (DataURL-)Servlets, das den jeweiligen Prozess aufweckt, um die Ausführung eines nachfolgenden asynchronen - Tasks zu bewirken, übernimmt das interne Servlet at.gv.egovernment.moa.id.auth.servlet.ProcessEngineSignalServlet, - das auf die URL /signalProcess gemappt wurde. -

    -

    - Hinweis: Das interne ProcessEngineSignalServlet bzw. dessen Methode getMoaSessionId(HttpServletRequest request) - können bei Bedarf durch eine Modulspezifische Implementierung überschrieben werden, um ggf. speziellen - Anforderungen in Bezug auf die Ermittlung der jeweiligen MOA Session Id Rechnung zu tragen (STORK PEPS - unterstützen keine Parameter wie MOASessionID in der assertion consumer url).
    - Als Beispiel dazu kann das Servlet at.gv.egovernment.moa.id.auth.modules.stork.STORKProcessEngineSignalServlet - des STORK-Moduls dienen. -

    -

    -  
    - Als Beispiele typischer Tasks können die Klassen im package at.gv.egovernment.moa.id.auth.modules.internal.tasks herangezogen werden.
    -

    - -

    - 2.2 Transitions -

    -

    - Die Abfolge der einzelnen Task wird in der Prozessbeschreibung durch die Transition-Elemente - bestimmt. Diese weisen die zwei verpflichtenden Attribute from und to auf, die jeweils einen Task (oder StartEvent) referenzieren von (from) dem die ProzessEngine zu (to) weiteren Task (oder EndEvent) traversiert. Betrachtet man einen - Prozess als Graphen, dann sind die Tasks als Knoten und die Transitions als Kanten anzusehen. -

    -

    - Jede Prozessausführung beginnt mit dem StartEvent. Von diesem ausgehend werden alle möglichen - Transitions zu anderen Tasks untersucht. Die erste Transition, die eine gültige Verbindung zu einem anderen Task - aufweist wird für die weitere Prozessausführung herangezogen. Transitions können über das Attribut - conditionExpression mit einer Art Policy ausgestattet werden, die festlegt, ob eine Transition verwendet - werden kann oder nicht. Dies ermöglicht eine bedingte Ausführung von Tasks. -

    -

    - Expressions müssen sich in eine booleschen Wert auflösen lassen: true (genauso - wie ein nicht gesetztes conditionExpression-Attribut) bedeutet, dass die Transition verwendet werden kann, - false bedeutet, dass die Transition nicht verwendet wird. - Bei den Expressions handelt es sich um Spring EL Expressions, - die einen leichten Zugriff auf den ExecutionContext, HttpServletRequestParameter sowie beliebige Spring-Beans ermöglichen: -

    - - - - - - - - - - - - - - - - - - - - - -
    BezeichnerBeispielBedeutung
    ctx!ctx['identityLinkAvailable']Erlaubt das Auswerten einzelner Variablen aus dem ExecutionContext, in diesem Fall einer booleschen Variable identityLinkAvailable
    requestParameterrequestParameter['myParam'] != nullGreift auf RequestParameter aus dem HttpServletRequest zurück und ermöglicht so eine Requestparameter abhängige Abfolge von Tasks.
    @@mySpringBean.isFoo()Greift auf ein Bean (in diesem Fall mit dem Namen mySpringBean) aus dem Spring ApplicationContext zurück.
    - -

    - 3 Module -

    -

    - Bei einem Modul handelt es sich grundsätzlich lediglich um eine logische Gruppierung von Prozessen. - Module sind bedingt durch ihr automatisches Discovery als eine Art Plug-in zu betrachten, weshalb sie typischerweise - auch in eigene JAR-Dateien ausgelagert vorliegen. -

    -

    Als Beispiel eines solchen Moduls kann das STORK-Modul (moa-id-module-stork-xy.jar) gesehen werden. - -

    - 3.1 Metadaten und Prozessauswahl -

    -

    - Jedes Modul muss das Interface at.gv.egovernment.moa.id.auth.modules.AuthModule implementieren, über - das der ProcessEngine zum einen Metadaten zu Verfügung gestellt werden, diese zum anderen aber auch die Prozessauswahl - (siehe Abschnitt 1) abgewickelt wird. -

    -

    -

    -
    int getPriority()
    -
    Über diese Methode gibt das Modul seine Priorität bekannt. Dies beeinflusst die Reihenfolge des Moduls - bei der Abfrage nach passenden Prozessen beim Starten eines Authentifizierungsprozesses.
    - Standardpriorität ist 0. Module die vorgereiht werden sollen, müssen eine höhere Priorität aufweisen.
    -
    -
    -
    String[] getProcessDefinitions()
    -
    Hierüber gibt das Modul die Prozessdefinitionen (bzw. ResourceUris zu den entsprechenden XML-Dateien) bekannt. - Diese werden automatisch von MOA-ID geparst und registriert. -
    -
    -
    -
    String selectProcess(ExecutionContext context)
    -
    Diese Methode wird von MOA-ID beim Starten eines Authentifizierungsprozesses aufgerufen. Der ExecutionContext - wird mit den in oben in Abschnitt 1 erwähnten Informationen befüllt und dieser - dann der selectProcess-Methode übergeben. Diese entscheidet, ob ein passender Prozess zu Verfügung - steht oder nicht. Eine eventuelle modulinterne Priorisierung muss das Modul selbst vornehmen.
    -
    -

    -

    - Als Beispiel kann die Implementierung des STORK-Moduls herangezogen werden: at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl
    - Nähere Informationen sind der Javadoc Dokumentation des AuthModule Interfaces zu entnehmen. -

    - -

    - 3.2 Discovery -

    -

    - Das bereits erwähnte automatische Discovery von Modulen beschränkt sich nun auf das automatische Auffinden der - jeweiligen AuthModule-Implementierung. MOA-ID sieht zwei Varianten vor, derartige Implementierung - aufzufinden. Welche der beiden zur Anwendung kommt (es können notfalls auch beide kombiniert werden), bleibt dem Modulentwickler überlassen. -

    - -

    - 3.2.1 Service Loader Mechanismus -

    -

    - Diese Variante sieht vor, dass jedes Modul (d.h. jede JAR-Datei) eine Datei META-INF/services/at.gv.egovernment.moa.id.auth.modules.AuthModule - enhält, das die vorhandenen AuthModule-Implementierungen auflistet: -

    - 
    at.gv.egovernment.moa.id.auth.modules.internal.DefaultAuthModuleImpl
-at.gv.egovernment.moa.id.auth.modules.mymodule.MyAuthModuleImpl
    -

    - Nähere Informationen zu diesem Mechanismus können hier entnommen werden: - Javadoc ServiceLoader bzw. Java Tutorials: Creating Extensible Applications -

    - -

    - 3.2.2 Spring Bean Discovery -

    -

    - Für den Fall, dass Module auf Basis des Spring Frameworks entwickelt werden, kann die AuthModule-Implementierung auch als Spring Bean erfolgen. -

    -

    - MOA-ID sucht beim Starten im Classpath nach Bean-Definitionen, die der Dateinamenskonvention *.authmodule.beans.xml - entsprechen und importiert diese. Über diesen Mechanismus können modulspezifische Spring Beans geladen bzw. initialisiert werden, u.a. auch AuthModule-Beans.
      -

    -

    Beispiel: STORK.authmodule.beans.xml
     

    - -
    <?xml version="1.0" encoding="UTF-8"?> -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:context="http://www.springframework.org/schema/context" - xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd - http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> - - <context:annotation-config /> - - <bean id="storkAuthModule" class="at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl"> - <property name="priority" value="0" /> - </bean> - -</beans> -
    -

     

    - -

    - 4 Hinweise -

    -

    - Um einzelne Funktionen als Plug-In umzusetzen, muss nicht unbedingt ein ganzer Prozess definiert werden. MOA-ID ab - Version 2.2 unterstützt die Servlet 3.0 API, was u.a. den Einsatz von @WebServlet-Annotations ermöglicht. - Damit entfällt eine statische Registrierung von Servlets im web.xml. -

    -

    Am Beispiel des MonitoringServlets (at.gv.egovernment.moa.id.auth.servlet.MonitoringServlet), das als - separates JAR (moa-id-module-monitoring-xy.jar) ausgeführt wurde, kann dies anschaulich beobachtet werden. - -

     

    -

     

    - - diff --git a/id/server/doc/handbook_v4/protocol/Assertion.xml b/id/server/doc/handbook_v4/protocol/Assertion.xml deleted file mode 100644 index 2654f2e80..000000000 --- a/id/server/doc/handbook_v4/protocol/Assertion.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata - - - - - - - - - - - - - fCE31ZeXZybQLOuNQBePLjFrCtKdvCmeyJ1tUW/ghtA= - - - vUFR3YPk5wiBJnrLh6Er7V46FNDMuB5Jcu73Rw7tipgr+bnV0reRNcZ5TGT+VMjNhtKJMcqgjrQWJ6tACe1r0mzhpRSVQkw7yFkTvIhQHX1a08yqJ4yy3qiN13ctDo4VgP9qHUim7b797oOKNhRXFk+2GJA5hRcpRliUjhBlzTYrxpkY5NcYDRhDPlvMx+l11oa1iDGuAylN+ty4h3P4fIoIgL9Tz1m3l65LqkV5RBc6avSeHw9OASMigPsjd5b0IBvhvJ611xLgzC1BOtJshiw1k/p8alv8TaUmYZ/kJbRN1tuTBL129edbS0Rz0faT0tniF42QHteJ214brK3rCg== - - - - xRE83dJy1dj+KVBp5Syo91fjGeG1MmJDSuTZ5MwdDzvIZrbK3YPh0jbJz4lOSrw9urRacavZX4m2 -XAKfSRxaowP3GqTh3Ew4WJE7yXEnWiic7bUz8uMIr020bsvqHCvY48+oPARbz/cEOf5NgMBWqo9E -nibdIyU5+AmfFzDaMwNocJEANoXrjLTpduCHvT0Qt/wH+7rVdgjX1djMrBhyMWs7GQyIBRfuf58m -8kdcoiMSm9AWA4d4GzXch+bi1QRzj+Ib80DeWdcXP3Hc6pcyp/+L+hya2jZ9NMS8yup6xuoAeh7w -6JNpfE9QnO3/CPrDZTtmjPK2OIRkhgn4Yi+iBQ== - AQAB - - - - - - - - - https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata - - QVGm48cqcM4UcyhDTNGYmVdrIoY= - - - - - - - https://demo.egiz.gv.at/demoportal_demologin/ - - - - - http://www.stork.gov.eu/1.0/citizenQAALevel/4 - - - - - 2.1 - - - Mustermann - - - Max - - - 1940-01-01 - - - BF:QVGm48cqcM4UcyhDTNGYmVdrIoY= - - - 4 - - - AT - - - urn:publicid:gv.at:cdid+BF - - - - diff --git a/id/server/doc/handbook_v4/protocol/AuthRequest.xml b/id/server/doc/handbook_v4/protocol/AuthRequest.xml deleted file mode 100644 index f9de11c4c..000000000 --- a/id/server/doc/handbook_v4/protocol/AuthRequest.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - https://demo.egiz.gv.at/demoportal_demologin/ - - - - - - - - - - - sBVJQf9b+QIxRfH8YuTbF6hBrf4= - - - JK68H5XqmD2OEA8O/UCZFenVj0TrvauPhaKJt73pbHbi//hO1hBcRQbV2Qg3gQ11EcJ9Q+TM3TCe9nT6tdU/z7ry3qdZvlOfrkMF13fY4HOIuvB9AcySdxq2yKA3V5O9sLhf5S9qCyx9lMnTARC7wkVs4j2Pv00R6P/iROOHD5ryGF2J0FdtMp9VqhvQJ9yRGM2lTduF98MqxWA2EMk6AMo7qij0Bvha1B2OyFSU9HM3fyfRQpXDeiLnKHcjLpzu5TDNkKrP75c7vv85DDr7s2I0p74nAOVLMuLau5tEQ91Crk9QoqoqqEecKWcNJDXTO9MahCQw77hUDL1WOEMFFg== - - - - nEPzKMh3TovnfBnTyv+TMYFsGep8Uil7iNbfVyfLoBfqRdeGDOk4es2qWkgB6az+kM/9Js2H06m4 -pjEY7/RIjd0lMWqgi8eqdjilMmbFQykkYYQhlZbvi8KqoBcCKzj5N3GY4qh8A5qN4y85Q3sZj23T -iiIY1rphE+ZTOHCm6CKeRso9jj409YHP1xAXfPvtIYx2TA1uuagxOmL75OC/hr7gcUm0tmuKiSeq -+TO4VZw2Q7K7YESZ1WkiBoG2i4cHdcBFKnVrGNtyxl6UkjWxXRJSU9aNLs5QxsE6iFwCvFoIO+IU -cVWxfFHqOGbRtAcRUb4fk+KFHE2o1DLmfwZaUQ== - AQAB - - - - - - https://demo.egiz.gv.at/demoportal_demologin/ - - - - http://www.stork.gov.eu/1.0/citizenQAALevel/4 - - diff --git a/id/server/doc/handbook_v4/protocol/idp_metadata.xml b/id/server/doc/handbook_v4/protocol/idp_metadata.xml deleted file mode 100644 index ffc15d461..000000000 --- a/id/server/doc/handbook_v4/protocol/idp_metadata.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - - - - - - IjxuoZphYVmZdZ5HfoVDr35r2b1V840+SMeC89IO/SQ= - - - JILQKKPvsK7onsMweJauAcGEniFGJ5bXEOvfYhxAYCB+dXL6pH87USD1v9UqycllBDqQE/Rp2tPtqo11CjdcKs0KkceQCZjzmDlVPqMZrgh0FerTSysF0fcPKoKeAtqqk+WSu7Xk9lU+PCxGArGA+vBLTRRbAOuZpE7ORrS7AF2m5uaO1YOKfO0GN+LoxTiygI2aeqKsKMlPkboh4ZuEjv1ht9xUHeQtAf/MHtaXZDvaRQPXALf0oCRnDWpiiqvKdARJq5NXrrbrdow/M1FpoddtE0Mu65AsorIdXoPSXJnLhw/zDfHv82PQo0pW7ujc0yJY+5VzfURMZOyKmrfCmg== - - - MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw -EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD -ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx -OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL -BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm -tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu -y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 -utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq -lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj -gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP -tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN -MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W -ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi -UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l -G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 -z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz -lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ -cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= - - - - - - - - - MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw -EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD -ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx -OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL -BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm -tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu -y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 -utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq -lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj -gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP -tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN -MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W -ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi -UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l -G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 -z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz -lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ -cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= - - - - - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw -EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD -ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx -OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL -BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm -tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu -y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 -utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq -lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj -gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP -tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN -MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W -ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi -UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l -G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 -z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz -lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ -cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= - - - - - - - MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw -EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD -ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx -OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL -BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG -SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm -tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu -y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 -utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq -lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj -gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP -tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN -MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W -ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi -UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l -G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 -z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz -lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ -cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= - - - - - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified - - - - - EGIZ - E-Government Innovationszentrum - http://www.egiz.gv.at - - - E-Government Innovationszentrum - Lenz - Thomas - thomas.lenz@egiz.gv.at - +43 316 873 5525 - - - diff --git a/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png b/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png deleted file mode 100644 index 2faff33ed..000000000 Binary files a/id/server/doc/handbook_v4/protocol/openIDconnect_sequenz.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/protocol/protocol.html b/id/server/doc/handbook_v4/protocol/protocol.html deleted file mode 100644 index 73465d55b..000000000 --- a/id/server/doc/handbook_v4/protocol/protocol.html +++ /dev/null @@ -1,756 +0,0 @@ - - - - - MOA-ID - Protokolle - - - - -
    -
    - -

    MOA-ID

     -
    -
    -
    - -
    -

    Protokolle

    - -

    Inhalt

    -
      -
    1. Allgemeines -
        -
      1. Übersicht der Zugangspunkte
        2. -
      2. Übersicht der möglichen Attribute
        3. -
      3. Übersicht der möglichen MOA-ID spezifischen Statuscodes -
          -
        1. Statuscodes 1xxxx
          2. -
        2. Statuscodes 4xxxx
          3. -
        3. Statuscodes 6xxxx
          4. -
        4. Statuscodes 9xxxx
        4. -
      -
      2. -
    2. SAML 1 -
        -
      1. Ablauf einer Anmeldung mittels SAML 1
        2. -
      2. Zugangspunkte
        3. -
      3. StartAuthentication Request
        4. -
      4. GetAuthenticationData Request
        5. -
      -
      3. - -
    3. Referenzierte Spezifikation
      4. -
    - -

    1 Allgemeines

    -

    Dieses Kapitel behandelt jene Authentifizierungsprotokolle die vom Modul MOA-ID-Auth unterstützt werden. - Wobei die Verwendung der Protokolle PVP 2.1 oder OpenID Connect empfohlen wird. Das Protokoll SAML 1, welches bis zur MOA-ID Version 1.5.1 - verwendet wurde, wird jedoch ab der Version 2.0 nur mehr aus Kompatibilitätsgründen angeboten und nicht mehr aktiv weiterentwickelt.

    -

    1.1 Übersicht der Zugangspunkte

    -

    In diesem Abschnitt sind die Zugangspunkte der vom Modul MOA-ID-Auth unterstützten Protokolle kurz zusammengefasst. Eine detaillierte Beschreibung der einzelnen Protokolle finden Sie in den anschließenden Unterkapiteln.

    - - - - - - - - - - - - - - - - -
    ProtokollRequesttypURL
    SAML 1Authentifizierungsrequest

    https://<host>:<port>/moa-id-auth/StartAuthentication

    SAML 1

    GetAuthenticationData

    https://<host>:<port>/moa-id-auth/services/GetAuthenticationData

    -

    http://<host>:<port>/moa-id-auth/services/GetAuthenticationData

    -

    1.2 Übersicht der möglichen Attribute

    -

    Die nachfolgende Tabelle beinhaltet eine Liste aller Attribute die vom Modul MOA-ID-Auth an die Online-Applikation zurückgeliefert werden können, sofern diese nach der Authentifizierung zur Verfügung stehen. Alle Namen beziehen sich auf den Attributnamen im jeweiligen Protokoll. Detailinformationen zu den einzelnen Attributen finden Sie in der PVP 2.1 Spezifikation der der STORK Spezifikation.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ProtokolleBeschreibung
    PVP 2.2OpenID ConnectSAML 1
    NameProfil
    urn:oid:1.2.40.0.10.2.1.1.149BPKeID

    /saml:Assertion/saml:AttributeStatement/

    -

    saml:Subject/saml:NameIdentifier

    Bereichsspezifisches Personenkennzeichen (bPK / wbPK)

    -

    Hinweis: Der Syntax für dieses Attribut bei den Protokollen PVP 2.1 und OpenID Connect ist bPK-value := (BEREICH ":" bPK/wbPK) wobei unter Bereich der öffentliche Bereich (Target) der Online-Applikation oder die Stammzahl des Auftraggebers bei Anwendungs-verantwortlichen aus der Privatwirtschaft angegeben wird.

    urn:oid:2.5.4.42

    		given_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname

    urn:oid:1.2.40.0.10.2.1.1.261.20

    		family_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Familienname
    urn:oid:1.2.40.0.10.2.1.1.55birthdateprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum im Format JJJJ-MM-TT
    urn:oid:1.2.40.0.10.2.1.1.261.64EID-CCS-URLeID<saml:Attribute AttributeName="bkuURL" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">URL auf die Bürgerkartenumgebung die für die Authentifizierung verwendet wurde. Im Falle einer Anmeldung mittels STORK steht dieses Attribut NICHT zur Verfügung.
    urn:oid:1.2.40.0.10.2.1.1.261.94EID-CITIZEN-QAA-LEVELeID Authentifizierungslevel des Bürgers
    urn:oid:1.2.40.0.10.2.1.1.261.32EID-ISSUING-NATIONeID<saml:Attribute AttributeName="EID-ISSUING-NATION" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Landescode gem. ISO-3166 ALPHA-2
    urn:oid:1.2.40.0.10.2.1.1.261.34EID-SECTOR-FOR-IDENTIFIEReID Bereich für den die bPK / wbPK berechnet wurde.
    urn:oid:1.2.40.0.10.2.1.1.261.66EID-SIGNER-CERTIFICATEeID<saml:Attribute AttributeName="SignerCertificate" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Base64 kodiertes Zertifikat, dass für die Anmeldung verwendet wurde.
    urn:oid:1.2.40.0.10.2.1.1.261.22ENC-BPK-LISTeID<saml:Attribute AttributeName="ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.28BPK-LISTeID_gov<saml:Attribute AttributeName="BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.39EID-ONLINE-IDENTITY-LINKeID_gov<saml:Attribute AttributeName="EID-ONLINE-IDENTITY-LINK" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Online Personenbindung des E-ID
    urn:oid:1.2.40.0.10.2.1.1.261.109EID-IDENTITY-STATUS-LEVELeID_gov<saml:Attribute AttributeName="EID-IDENTITY-STATUS-LEVEL" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Kennzeichnet den Status der zusätzlich zu diesem Attribut übertragenen Identitätsdaten.
    urn:oid:1.2.40.0.10.2.1.1.261.106MANDATE-TYPE-OIDmandate Bezeichnung als OID des verwendeten Vollmachten-Profils
    urn:oid:1.2.40.0.10.2.1.1.261.68MANDATE-TYPEmandate<saml:Attribute AttributeName="RepresentationType" AttributeNamespace="http://reference.e-government.gv.at/namespace/mandates/20040701#">Bezeichnung des verwendeten Vollmachten-Profils.
    urn:oid:1.2.40.0.10.2.1.1.261.76MANDATOR-LEGAL-PERSON-SOURCE-PIN-TYPEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Gibt an, um welche Art der Stammzahl einer vertretenen juristischen Person es sich handelt.
    urn:oid:1.2.40.0.10.2.1.1.261.100MANDATOR-LEGAL-PERSON-SOURCE-PINmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Stammzahl der juristischen Person, für die Vollmachts- bzw. Vertretungsbe-fugnisse ausgeübt werden.
    urn:oid:1.2.40.0.10.2.1.1.261.98MANDATOR-NATURAL-PERSON-BPKmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Bereichsspezifisches Personenkennzeichen des Vollmachtgebers
    urn:oid:1.2.40.0.10.2.1.1.261.72MANDATOR-NATURAL-PERSON-ENC-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.73MANDATOR-NATURAL-PERSON-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.78MANDATOR-NATURAL-PERSON-GIVEN-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname(n) der natürlichen Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
    urn:oid:1.2.40.0.10.2.1.1.261.80MANDATOR-NATURAL-PERSON-FAMILY-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Nachname der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
    urn:oid:1.2.40.0.10.2.1.1.261.82MANDATOR-NATURAL-PERSON-BIRTHDATEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird im Format JJJJ-MM-TT
    urn:oid:1.2.40.0.10.2.1.1.261.84MANDATOR-LEGAL-PERSON-FULL-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Name der juristischen Person bzw. Personenmehrheit gemäß zugrundeliegendem Register.
    urn:oid:1.2.40.0.10.2.1.1.261.86MANDATE-PROF-REP-OIDmandate<saml:Attribute AttributeName="OID" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Object Identifiern (OID) zur Kennzeichnung von berufsmäßigen ParteienvertreterInnen bzw. OrganwalterInnen.
    urn:oid:1.2.40.0.10.2.1.1.261.88MANDATE-PROF-REP-DESCRIPTIONmandate<saml:Attribute AttributeName="OIDTextualDescription" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Textuelle Beschreibung der Eigenschaft als berufsmäßiger ParteienvertreterIn.
    urn:oid:1.2.40.0.10.2.1.1.261.90MANDATE-REFERENCE-VALUEmandate<saml:Attribute AttributeName="mandateReferenceValue" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Die im Rahmen einer elektronischen Vollmachtserstellung generierte Transaktionsnummer.
    -

    1.3 Übersicht der möglichen MOA-ID spezifischen Statuscodes

    -

    Vom Modul MOA-ID-Auth werden verschiedene Authentifizierungsprotokolle wobei diese Protokolle die Fehlerrückgabe unterschiedlich spezifizieren. Zusätzlich zu den protokollabhängigen Statuscodes (siehe Spezifikation des jeweiligen Protokolls) werden zusätzliche protokollunabhängige Statuscodes an den Service Provider zurückgeliefert, wobei sich das Format der Fehlerrückgabe jedoch weiterhin protokollspezifisch ist.

    -

    Die nachfolgende Tabelle zeigt alle protokollunabhängigen Statuscodes welche vom Modul MOA-ID-Auth zurückgeliefert werden können.

    -

    1.3.1 Statuscodes 1xxxx

    -

    Alle Statuscodes beginnend mit der Zahl eins beschreiben Fehler welche während des Identifizierungs- und Authentifizierungsvorgangs aufgetreten sind.

    -
    1.3.1.1 Authentifizierung (10xxx)
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    1000Anmeldung an der angeforderten Online-Applikation wird nicht unterstützt.
    1001Es ist bereits eine Anmeldung im Gange.
    1002Fehlerhafter Parameter
    1003Anfrage nur über https möglich
    1004Zertifikat konnte nicht ausgelesen werden
    1005Die Authentifizierung wurde durch den Benutzer abgebrochen
    1006Vollmachtsmodus für nicht-öffentlichen Bereich wird nicht unterstützt.
    1007Vollmachtsmodus für ausländische Personen wird nicht unterstützt.
    1008Es konnten nicht alle minimal erforderlichen Identifikations- oder Authentifikationsmerkmale ermittelt werden.
    -
    1.3.1.2 Validierung (11xxx)
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    1100Ungültige MOA SessionID
    1101Fehler beim Parsen eines Parameters
    1102Fehler beim Validieren der Personenbindung
    1103Signatur ungültig
    1104Zertifikat der Personenbindung ungültig
    1105Zertifikat der Signatur ungültig
    1106Fehler beim Validieren des AuthBlocks
    1107Fehler beim Validieren eines SSL-Server-Endzertifikates
    1108Fehler beim Validieren der Online Vollmacht.
    1109Fehler beim Validieren der SZR-Gateway Response
    1110Ungültige Single Sign-On Session
    1111Der Anmeldevorgang wurde automatisiert abgebrochten da dem Benutzer die nötigen Zugriffsrechte für diese Online Applikation fehlen.
    -
     
    -

    1.3.2 Statuscodes 4xxxx

    -

    Alles Statuscodes beginnend mit der Zahl vier beschreiben Fehler die während der Kommunikation mit externen Services aufgetreten sind.

    -
    1.3.2.1 BKU (40xxxx)
    -

    Tritt während des Anmeldevorgangs in der Bürgerkartenumgebung ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Bürgerkartenumgebungsfehler weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus zwei Dezimalstellen, kennzeichnet den Fehler als Fehler als Bürgerkartenumgebungsfehler. Der zweite Teil, bestehend aus vier Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus der Bürgerkartenumgebung (siehe SecurityLayer Spezifikation).

    -

    {40}{xxxxx}

    -
    -

    {40} ... MOA-ID Statuscode für Fehler aus der Bürgerkartenumgebung

    -

    {xxxx} .... Fehlercode der Bürgerkartenumgebung.

    -
    -
    1.3.2.2 MIS (41xxxx)
    -

    Tritt während der Kommunikation mit dem Online-Vollmachten Service oder der Vollmachtsauswahl ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Fehler aus dem Online-Vollmachten Service weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus drei Dezimalstellen, kennzeichnet den Fehler als Fehler als Online-Vollmachten Service Fehler. Der zweite Teil, bestehend aus drei Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus dem Online-Vollmachten Service (siehe Online-Vollmachten Spezifikation).

    -

    {411}{xxxx}

    -
    -

    {411} ... MOA-ID Statuscode für Fehler aus dem Online-Vollmachten Service.

    -

    {xxx} .... Fehlercode des Online-Vollmachten Service.

    -
    -

    Zusätzlich zu den gemappten Fehlern aus dem Online-Vollmachen Service werden zusätzliche weitere Fehlercodes definiert.

    - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    41000Das Online-Vollmachten Service ist nicht erreichbar
    41001Allgemeiner Fehler bei der Kommunikation mit dem Online-Vollmachten Service
    -
    1.3.2.3 SZR-Gateway (42xxx)
    - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    4200Das SZR-Gateway Service ist nicht erreichbar
    4201Die Antragung in das SZR ist fehlgeschlagen
    -
    1.3.2.4 MOA SP/SS(43xxx)
    - - - - - - - - - -
    StatuscodeBeschreibung
    4300Fehler beim Aufruf von MOA SP/SS
    -
    1.3.2.5 Interfederation (44xx)
    - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    4400Fehler beim Generieren der Anmeldedaten
    4401Die Verwendung des angeforderten federated IDP ist nicht erlaubt
    -
    1.3.2.6 Attributprovider (45xx)
    - - - - - - - - - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    4500Der Zugriff auf einen Attributprovider ist nicht erlaubt
    4501Die Requestgenerierung für den Zugriff auf den Attributprovider schlug fehl
    4502Die Response vom Attributeprovider ist ungültig oder nicht errlaubt
    4503Die Response vom Attributeprovider beinhaltet einen Fehlercode
    -

    1.3.3 Statuscodes 6xxxx

    -

    Alles Statuscodes beginnend mit der Zahl sechs beschreiben protokollspezifische Fehler die nicht durch das jeweilige Authentifizierungsprotokoll abgebildet werden.

    -
    1.3.3.1 Allgemein (61xxx)
    - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    6000Das Authentifizierungsprotokoll wurde nicht erkannt oder wird nicht unterstützt
    6001Der STORK Request wurde nicht erkannt oder wird nicht unterstützt
    -
    1.3.3.4 SAML 1(63xxx)
    - - - - - - - - - -
    StatuscodeBeschreibung
    6300Fehlerhaftes SAML Artifact Format
    -

    1.3.4 Statuscodes 9xxxx

    -

    Alles Statuscodes beginnend mit der Zahl neun beschreiben interne Serverfehler.

    -
    1.3.4.1 Konfigurationsfehler (90xxx)
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    9000Fehlerhaftes BKU-Selection Template
    9001Fehlerhaftes Send-Assertion Template
    9002Fehlerhaftes SecurityLayer Template.
    9003Fehlerhafte STORK VIDP Konfiguration
    9004Fehlerhafte STORK Konfiguration
    9005Fehlerhafte OpenID Connect Konfiguration
    9006Es sind keine Vollmachtsprofile konfiguriert.
    9007Der SZR-Gateway Client konnte nicht initialisiert werden.
    9008Fehler beim Verarbeiten eines Konfigurationsparameters.
    9099Allgemeiner Konfigurationsfehler
    -
    1.3.4.2 Interne Fehler (91xxx)
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    StatuscodeBeschreibung
    9100Fehler beim Einlesen einer externen Ressource.
    9101Datenbankzugriffsfehler
    9102Fehler beim Erzeugen einer internen Datenstruktur
    9103Fehler bei der Verarbeitung eines Templates
    9104Fehler bei der Auswahl oder Initialisierung des gewünschten Anmeldeprozesses
    9105Fehler bei der Fortführung des Anmeldeprozesses
    9199Allgemeiner interner Fehler
    -

     

    -

    3 SAML 1

    -

    SAML 1 wird durch MOA-ID-Auth 2.0 auch weiterhin, aus Gründen der Abwärtskompatibilität, als Authentifizierungsprotokoll unterstützt. Es wird jedoch der Umstieg auf ein aktuelles Authentifizierungsprotokoll wie PVP 2.1 oder OpenID Connect empfohlen.

    -

    Die nachfolgenden Abschnitte beschreiben den Anmeldevorgang unter Verwendung von SAML1 wobei die Funktionalität, wie sie aus MOA-ID <= 1.5.1 bekannt ist, auch weiterhin unterstützt wird (Bürgerkartenauswahl auf Seiten des Service Provider). Zusätzlich steht für SAML 1 jedoch auch die Funktionalität der automatischen Generierung der Bürgerkartenauswahl durch das Modul MOA-ID-Auth zur Verfügung.

    -

    3.1 Ablauf einer Anmeldung mittels SAML 1

    -

    Die nachfolgende Abbildung zeigt das Sequenzdiagramm eines Anmeldevorgangs mittels SAML 1 und des Modules MOA-ID-Auth als Identity Provider. Hierbei wird die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl beim Service Provider verwenden. Aus Gründen der Übersichtlichkeit wurden die Teile welche die Kommunikation mit der Bürgerkartenumgebung oder die Vollmachten-Auswahl betreffen bewusst nicht berücksichtigt.

    -

    Sequenzdiagramm für SAML 1

    -
      -
    1. Der Benutzer verbindet sich zu einem Web-Portal (Service Provider) über das die Online-Applikation erreichbar ist.
      2. -
    2. Der Service Provider antwortet mit einer öffentlichen Portalseite welche einen Login Bereich mit Bürgerkartenauswahl beinhaltet.
      3. -
    3. Nach Auswahl der gewünschten Authentifizierungsmethode (Bürgerkarte oder Handy-Signatur) wird der Anmeldevorgang ausgelöst und der StartAuthentication Request wird an das Modul MOA-ID-Auth gesendet.
      4. -
    4. MOA-ID-Auth validiert den StartAuthentication Request. Ist die Validierung erfolgreich wird der Anmeldevorgang vorgesetzt.
      5. -
    5. Die Benutzerin oder der Benutzer wird zur gewählten Bürgerkartenumgebung weitergeleitet. -
        -
      1. Die Benutzerin oder der Benutzer Authentifiziert sich mit der gewählten Methode.
        2. -
      -
      6. -
    6. War die Authentifizierung der Benutzerin oder des Benutzers erfolgreich generiert MOA-ID-Auth die Assertion mit den Anmeldedaten des Benutzers.
      7. -
    7. MOA-ID-Auth senden das SAML 1 Artifact, welches zur Abholung der Assertion verwendet werden kann, über den Browser an den Service Provider.
      8. -
    8. Der Service Provider stellt einen GetAuthenticationData Request an MOA-ID-Auth unter Verwendung des zuvor übermittelten Artifacts.
      9. -
    9. MOA-ID-Auth validiert das Artifact. Ist die Validierung erfolgreich antwortet MOA-ID-Auth mit der SAML 1 Assertion, welche die Anmeldedaten beinhaltet.
      10. -
    10. Der Service Provider verarbeitet die Assertion und danach ist der Benutzer an der Online-Applikation angemeldet.
      11. -
    -

    3.2 Zugangspunkte

    -

    Zur Verwendung von SAML 1 stellt das Modul MOA-ID-Auth zwei Zugangspunkte zur Kommunikation mit der Online-Applikation (Service Provider) zur Verfügung. Diese Zugangspunkte bezeichnen die URLs unter welchen das Modul MOA-ID-Auth die entsprechenden SAML1 Nachrichten entgegennimmt.

    -
      -
    • StartAuthentication Request: https://<host>:<port>/moa-id-auth/StartAuthentication
      - Unter dieser URL wird der Authn Request entgegengenommen. Dieser Request startet den Authentifizierungsvorgang an der Online-Applikation.
      • -
    • GetAuthenticationData: http(s)://<host>:<port>/moa-id-auth/services/GetAuthenticationData
      - Unter dieser URL können nach erfolgreicher Authentifizierung die eigentlichen Authentifizierungsdaten am Modul MOA-ID-Auth abgeholt werden.
      • -
    -

    3.3 StartAuthentication Request

    -

    MOA-ID-Auth wird immer durch eine andere (verweisende) Webseite aufgerufen. Diese Webseite kann z.B. Teil eines Portals sein. Der Aufruf erfolgt durch einen Verweis der Form, wobei die Parameter sowohl als http GET als auch als http POST an MOA-ID-Auth übergeben werden können.

    -
    <a href="https://<moa-id-server-und-pfad>/StartAuthentication
-  ?Target=<geschäftsbereich>  
-  &OA=<oa-url>
-	&bkuURI=<bku-url>
-  &Template=<template-url>
-	&useMandate=false
-  &CCC=<ccc>">
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameBeispielwertBeschreibung
    <moa-id-server-und-pfad>https://demo.egiz.gv.at/
    - demoportal_moaid-2.0/

    Server und Pfad, wo MOA-ID-AUTH installiert ist

    Target=<geschäftsbereich>BF

    Angabe, für welches Verfahren (öffentlicher Bereich) der Benutzer authentisiert werden soll. Dieser Parameter wird jedoch durch den in entsprechenden Parameter in der online-applikationsspezifischen Konfiguration überschrieben.

    OA=<oa-url>https://demo.egiz.gv.at/demoportal-demologin/securearea.actionWebseite, auf die der Browser nach erfolgter Authentisierung weitergeleitet werden soll
    bkuURI=<bku-url>https://127.0.0.1:3496/https-security-layer-request

    URL auf die Bürgerkartenumgebung, welche für die Authentifizierung der Benutzerin oder des Benutzers verwendet werden soll.

    -

    Hinweis: Wird dieser Parameter nicht übertragen, antwortet das Modul MOA-ID-Auth mit einem bei MOA-ID-Auth hinterlegten Bürgerkartentemplate.

    Template=<template-url>https://demo.egiz.gv.at/moa-id-auth/template_onlineBKU.htmlOptional: URL auf die HTML Vorlage für den Security-Layer Request, welcher für die Kommunikation mit der Bürgerkartenumgebung verwendet wird. Die URL muss in der online-applikationsspezifischen Konfiguration von MOA-ID-Auth hinterlegt werden (siehe Parameter SecurityLayerTemplates).
    - Ist dieser Parameter nicht vorhanden, verwendet MOA-ID-Auth das für diese Online-Applikation hinterlegten Security-Layer Template (siehe Parameter SecurityLayerTemplates).
    useMandate=<true/false>true / falseOptional: Gibt an ob eine Anmeldung im Online-Vollmachten-Modus durchgeführt werden soll (=true) oder nicht (=false);
    CCC=<ccc>BE, SI, Optional: Gibt an ob die Anmeldung mittels STORK im angegebenen Land erfolgen soll. Die Angabe erfolgt mit dem Ländercode (Bsp: PT, LU, ES, ...) des jeweiligen Landes.
    sourceID=<xxxxxxx>abcdef141245Optional: Die sourceID fließt in die Generierung des SAML1 Artifacts, welches an den Service Provider returniert wird, ein. Detailinformationen zur Generierung des SAML1 Artifacts und zur sourceID finden Sie in der SAML1 Spezifikation.
    -

    3.4 GetAuthenticationData Request

    -

    Nach erfolgter Authentisierung stehen in MOA-ID-AUTH Anmeldedaten zum Abholen bereit, und MOA-ID-AUTH veranlasst einen Redirect zur Online-Applikation (OA).
    -
    -In diesem Redirect werden der Geschäftsbereich und ein SAML-Artifact als Parameter übergeben.

    -
    <a href="https://<oa-url>?Target=<geschäftsbereich>&SAMLArtifact=<saml-artifact>">
    - - - - - - - - - - - - - - - -
    oa-url>URL, der beim Aufruf von MOA-ID-AUTH als Parameter "OA" übergeben wurde
    Target=<geschäftsbereich>Parameter, der beim Aufruf von MOA-ID-AUTH übergeben wurde
    SAMLArtifact=<saml-artifact>SAML-Artifact, das von MOA-ID-AUTH zu den Anmeldedaten erstellt wurde. Mithilfe dieses SAML-Artifacts kann die OA die Anmeldedaten von MOA-ID-AUTH abholen.
    -

     

    -

    Der Service Provider kann anschließend die Assertion, welche die Anmeldedaten oder eine Fehlermeldung beinhaltet, unter Verwendung des SAMLArtifact, am Modul MOA-ID-Auth abholen.

    -

    Das MOA-ID-AUTH Web Service wird über einen <samlp:Request> aufgerufen. Der <samlp:Request> enthält in einem <samlp:AssertionArtifact> das von MOA-ID-AUTH übergebene SAML-Artifact.
    -
    -MOA-ID-AUTH liefert als Antwort einen <samlp:Response>. Die Anmeldedaten sind im <samlp:Response> in Form einer <saml:Assertion> enthalten.
    -Sollte während des Anmeldevorgangs ein Fehler aufgetreten sein, antwortet das Modul MOA-ID-Auth mit einer Fehlerbeschreibung in der SAML Response. Das Element /samlp:Response/samlp:Status/samlp:StatusCode/ beinhaltet auf jeden Fall einen allgemeinen Fehlercode laut SAML1 Spezifikation. Zusätzlich kann das Element /samlp:Response/samlp:Status/samlp:StatusCode/samlp:StatusCode/einen MOA-ID-Auth Fehlercode (siehe Kapitel 1.3) beinhalten. Außerdem erfolgt eine kurze textuelle Fehlerbeschreibung im Element /samlp:Response/samlp:Status/samlp:StatusMessage/.

    - -

    Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.4 beschrieben.

    -

    A Referenzierte Spezifikation

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    SpezifikationLink

    Security Layer Spezifikation V1.2.0

    		http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
    Online-Vollmachten Spezifikation http://reference.e-government.gv.at/AG-II-Architektur-mis-1-1-0.2890.0.html
    PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
    OpenID Connecthttp://openid.net/connect/
    STORK 2@TODO Link
    Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
    -
    - - diff --git a/id/server/doc/handbook_v4/protocol/pvp21_sequence.png b/id/server/doc/handbook_v4/protocol/pvp21_sequence.png deleted file mode 100644 index c915531cc..000000000 Binary files a/id/server/doc/handbook_v4/protocol/pvp21_sequence.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/protocol/saml1_sequence.png b/id/server/doc/handbook_v4/protocol/saml1_sequence.png deleted file mode 100644 index e863d74c1..000000000 Binary files a/id/server/doc/handbook_v4/protocol/saml1_sequence.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml b/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml deleted file mode 100644 index 15e26469c..000000000 --- a/id/server/doc/handbook_v4/protocol/serviceprovider_metadata.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - - - - - - xLFVU7fH3+IC84vAuSZTP7+oeGk= - - - d1GD51DilpbwQdL9BONrhQS9zeydpWw8r/DKp/k5nLDQ6Tpw+OQgqYWvsMcnMgrltJa/4Q326fEf6HdFbLfrHSij8Nfx8i2idJ9JUwpj1R2GE0eo+8NXvJ/1H9Nf0pPjZ35MXQ9bC2fN/HnPalRaJSd9gCk/hW/KtB0r4qODkppz0hHplIKs7kqDnzd7ZT7golGI801N6DwzJ3jW8U26OOhzXtCbTsDdZE5gvA34kH5EDaa9RMx2JIPqBjzvDAE7oylKg2VcQdpJ1xLEi3zOF2kvgTLi6+CLHbQDc1JKcWJ10FC9yATT7poHJOgjoZ8Vt5QZJ12PKJ1NnopwcsvJ4g== - - - - - - - MIIDhTCCAm2gAwIBAgIEUflpdjANBgkqhkiG9w0BAQsFADBzMRAwDgYDVQQGEwdVbmtub3duMRAw -DgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdVbmtub3duMRAwDgYD -VQQLEwdVbmtub3duMRcwFQYDVQQDEw5QVlAgU2FtcGxlIElEUDAeFw0xMzA1MDIwODE5MDlaFw0x -MzA3MzEwODE5MDlaMHMxEDAOBgNVBAYTB1Vua25vd24xEDAOBgNVBAgTB1Vua25vd24xEDAOBgNV -BAcTB1Vua25vd24xEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xFzAVBgNVBAMT -DlBWUCBTYW1wbGUgSURQMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWrWy07+hO2V -oMeOHpizN3qU2cL2e3EkzAkowmG+OpsR3UpI0dvolRuzaxDPUeANfE913KPempsT3cOKGS5IIBmx -PgZM1H7EcEPVS2PYimMr1HztBMJMGAdFVFeVFsgdYP4cbwPUs03/E6kVmN7/C+vMyRPMD7i83YL8 -/IHChymZ5aJTsRXUpM0TjQQPBQbnnHVWzjcUJ9z9KataS/KpUUM8iSWk73u/gWOs3vbQLoro80xj -LsSdXyJ9dVTCTwCpdP5UJPlsNLg1F7AU+OHwem76rezI0JJZhHUMg6v1xWzh8XycI6CizpD6RmkM -XfICbFD8TR5zcNBieH/yNQeAEwIDAQABoyEwHzAdBgNVHQ4EFgQUoLaHuWuxRrEh37oIQ0GzfDpy -h4MwDQYJKoZIhvcNAQELBQADggEBAAaAJVSji/OMCUZtSSIYM37go1+JLSamSkkftbkKmMWGBeKj -i9ndilpFY/Fbslt+lUueOyd5VawWPYorQBksyJH7glmQexMzEbwqPR8t+++Dq5+mj/XjXrYHlPej -FvCMy5kElxXczIQZmsutGtamreyAMpFMa3T2pU5tuVNwSbe754dOztaX6E92IGZtApKIHm/uLU75 -JQkTWhP9I3DaNX593VYPkeAoYxzaX1ElE2HFs4ELRzMXa0joTaGLyZ6LdLcK1bR3um9OywHWeiab -xtSAML1SoKfTcmzWCpb0yFhfOUKXyw+SikBAkiQruMK8PcboY9VFrKUSzKHBvnDC4U4= - - - - - - - MIIELTCCAxWgAwIBAgIJALF/kMqjWCxQMA0GCSqGSIb3DQEBCwUAMGwxCzAJBgNVBAYTAkFUMRMw -EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSowKAYDVQQD -EyFNT0EtSUQtQ29uZmlndXJhdGlvbiAoRW5jcnlwdGlvbikwHhcNMTQwMTIxMDkzMDIzWhcNMTUw -MTIxMDkzMDIzWjBsMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTENMAsGA1UEBxME -R3JhejENMAsGA1UEChMERUdJWjEqMCgGA1UEAxMhTU9BLUlELUNvbmZpZ3VyYXRpb24gKEVuY3J5 -cHRpb24pMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr+5eXUViI2d/KLqfej29BNeD -DiDzhWlpAViPconGsEDHrXFNeSd3DTuJKH6x06wrpGfvtTh91ThId0R0hthS82aaKTlW1SgX/Rps -5VlmiNXQty8/UrrnqAsIO65jbsy41EXTDVrnDbg5WmK2xsowk7d4jUE4cdk3VKu07Kzg9ZiQHz8V -WMmGGPIXVs87+wgjq68tvo3+Nk5fcKPyV4ff2oc5/muxjavGdAIDJV2E/dDHwM3fbNFXk5OAse2V -8/vmHCm0bzVOP+V5vNxp1r8myZ914WYFt0WJL4/oyyrerGK6gqGdkLcGfMutaJvBxV+hNIMGLWMc -6LjCWVARIXvHyQIDAQABo4HRMIHOMB0GA1UdDgQWBBR9aJK1JouIYwcn2ycQUsPv4Q8BaDCBngYD -VR0jBIGWMIGTgBR9aJK1JouIYwcn2ycQUsPv4Q8BaKFwpG4wbDELMAkGA1UEBhMCQVQxEzARBgNV -BAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTALBgNVBAoTBEVHSVoxKjAoBgNVBAMTIU1P -QS1JRC1Db25maWd1cmF0aW9uIChFbmNyeXB0aW9uKYIJALF/kMqjWCxQMAwGA1UdEwQFMAMBAf8w -DQYJKoZIhvcNAQELBQADggEBAFSMmGNTAhDfoadFz0SrMDLjrPGIGjanbijLTOEURZYJiB4sQxa8 -3H6FNy1zvfzmPnrdbFr15w/6KgF9YP/0/JMUalrhm1JKWBY4TqJcG2BumAUcLSdsHOsezRi5E14s -WF2sNRa8C0LkfMfCW/wBCLXPn68XhQW7MuGgpEVrRenXQ3hwSykNiKq4vfn8tg+1hKwlrM3pbQQw -7YmXUm9TnHmkvJfZJEgSiFiLUjc1HxUFNl23PGjKJ1GxDerS7pBHG23KkVZTacuKM/MjVfFeFQJ4 -8JcRJUO0HuM6O1v/1sumtq/4wrKYo5I5LZPRuEKGNFme9hi/1BQT9bK9roZlxH0= - - - - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified - - - Default Service - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/protocol/sso_sequence.png b/id/server/doc/handbook_v4/protocol/sso_sequence.png deleted file mode 100644 index 19e50100d..000000000 Binary files a/id/server/doc/handbook_v4/protocol/sso_sequence.png and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl b/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl deleted file mode 100644 index d83556540..000000000 --- a/id/server/doc/handbook_v4/spec/MOA ID 1.x.wsdl +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf b/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf deleted file mode 100644 index 6709a4081..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA-SPSS-1.3.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf deleted file mode 100644 index 1e65beca9..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl deleted file mode 100644 index 4f9deee38..000000000 --- a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.wsdl +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd b/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd deleted file mode 100644 index 73d145ecf..000000000 --- a/id/server/doc/handbook_v4/spec/MOA-SPSS-2.0.0.xsd +++ /dev/null @@ -1,572 +0,0 @@ - - - - - - - - - - - - - - - - - - - - Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements - - - - - - - - - - - - - - - - - - - - - - Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage - - - - Resultat, falls die Signaturerstellung erfolgreich war - - - - - - - - - - - - - - - - - - - - Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements - - - - - - - - - - - - - - - - - - - Auswahl: Entweder explizite Angabe des Signaturorts sowie ggf. sinnvoller Supplements im Zshg. mit der Signaturumgebung, oder Verweis auf ein benanntes Profil - - - - - - - - - - - - - - - - - - Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage - - - - Resultat, falls die Signaturerstellung erfolgreich war - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert - - - - - - - - - - - only ds:X509Data and RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any;publicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Pro dsig:Reference-Element in der zu überprüfenden XML-Signatur muss hier ein ReferenceInfo-Element erscheinen. Die Reihenfolge der einzelnen ReferenceInfo Elemente entspricht jener der dsig:Reference Elemente in der XML-Signatur. - - - - - - - - - - mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert - - - - - - - - - - - only ds:X509Data and ds:RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any; PublicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Auswahl: Entweder explizite Angabe EINER Transformationskette inklusive ggf. sinnvoller Supplements oder Verweis auf ein benanntes Profil - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Resultat, falls die Signaturerstellung gescheitert ist - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Ein oder mehrere Transformationswege können von der Applikation an MOA mitgeteilt werden. Die zu prüfende Signatur hat zumindest einem dieser Transformationswege zu entsprechen. Die Angabe kann explizit oder als Profilbezeichner erfolgen. - - - - - Profilbezeichner für einen Transformationsweg - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Die Angabe des Transformationsparameters (explizit oder als Hashwert) kann unterlassen werden, wenn die Applikation von der Unveränderlichkeit des Inhalts der in "Transformationsparamter", Attribut "URI" angegebenen URI ausgehen kann. - - - - Der Transformationsparameter explizit angegeben. - - - - - Der Hashwert des Transformationsparameters. - - - - - - - - - - - - - - - - - - - - - - Explizite Angabe des Transformationswegs - - - - - - - Alle impliziten Transformationsparameter, die zum Durchlaufen der oben angeführten Transformationskette bekannt sein müssen, müssen hier angeführt werden. Das Attribut "URI" bezeichnet den Transformationsparameter in exakt jener Weise, wie er in der zu überprüfenden Signatur gebraucht wird. - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf deleted file mode 100644 index 0c89c2730..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA_ID_1.2_20040315.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf deleted file mode 100644 index c9b0d160c..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA_ID_1.3_20060315.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf deleted file mode 100644 index a3a2f1177..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_20070802.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf deleted file mode 100644 index 0c923666f..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA_ID_1.4_Anhang.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf b/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf deleted file mode 100644 index ed2743d3c..000000000 Binary files a/id/server/doc/handbook_v4/spec/MOA_ID_1.5_Anhang.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf b/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf deleted file mode 100644 index 4beab3e41..000000000 Binary files a/id/server/doc/handbook_v4/spec/OID-1-0-3.pdf and /dev/null differ diff --git a/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd b/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd deleted file mode 100644 index d41f3e817..000000000 --- a/id/server/doc/handbook_v4/spec/cs-sstc-schema-assertion-01.xsd +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - Document identifier: cs-sstc-schema-assertion-01 - Location: http://www.oasis-open.org/committees/security/docs/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd b/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd deleted file mode 100644 index d939fa732..000000000 --- a/id/server/doc/handbook_v4/spec/cs-sstc-schema-protocol-01.xsd +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - Document identifier: cs-sstc-schema-protocol-01 - Location: http://www.oasis-open.org/committees/security/docs/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/id/server/doc/handbook_v40/additional/additional.html b/id/server/doc/handbook_v40/additional/additional.html new file mode 100644 index 000000000..d7afc1961 --- /dev/null +++ b/id/server/doc/handbook_v40/additional/additional.html @@ -0,0 +1,363 @@ + + + + + + MOA-ID - Zusatzinformationen + + + + +
    +
    + +

    MOA-ID-AUTH

    +
    +
    +
    +
    +

    Zusatzinformationen

    + +

    Inhalt

    +
      +
    1. Datenmanagement +
        +
      1. Sessiondaten +
          +
        1. Allgemein
          2. +
        +
        2. +
      2. Logging von Statistikdaten
        3. +
      +
      2. +
    2. Benötigte Netzwerkverbindungen (incoming / outgoing)
      3. +
    3. Revisions-Logging
      4. +
    +

    1 Datenmanagement

    +

    Dieser Abschnitt spezifiziert jene Datensätze die während eines Anmeldevorgangs durch das Modul MOA-ID-Auth temporär oder permanent gespeichert werden. Hierbei handelt es sich sowohl um temporäre Sessiondaten als auch um dauerhaft gespeicherte Statistikdaten.

    +

    1.1 Sessiondaten

    +

    Dieser Abschnitt behandelt jene Informationen die das Modul MOA-ID-Auth während eines Authentifizierungsvorgangs oder während einer aktiven Single Sign-On Session im Speicher hält. Diese Datensätze werden nach Beendigung des Anmeldevorgangs, bei einfacher Anmeldung, oder nach Beendigung der Single Sign-On Session gelöscht. Die nachfolgenden Unterkapitel geben eine Aufstellung jener Daten die von MOA-ID im jeweiligen Falle gespeichert werden.

    +

    1.1.1 Allgemein

    +

    Folgende Daten müssen mindestens von MOA-ID gecached werden um einen korrekten Anmeldevorgang zu ermöglichen.

    + + + + + + + + + + + + + + + + + + + + + +

    Element

    Beschreibung

    Authentication Request

    Dieser wird von der Online-Applikation als Start des Anmeldevorgangs übertragen.

    Session ID

    Wird von MOA-ID generiert und dient zur Identifikation von Datensätzen.

    Signaturzertifikat

    Das Signaturzertifikat, welches zur Signierung des Authentifizierungsblocks verwendet wurde.

    AuthTimeStampZeitpunkt an dem sich die Benutzerin oder der Benutzer an MOA-ID-Auth authentifiziert hat.
    +

    1.2 Logging von Statistikdaten

    +

    Zusätzlich zu den Daten aus den temporären Sessiondaten werden vom Modul MOA-ID-Auth auch Logging- und Statistikdaten generiert, welche nicht automatisiert gelöscht werden. Diese Daten dienen der Statuskontrolle und zur Protokollierung von Anmeldevorgängen an MOA-ID-Auth. Von MOA-ID-Auth werden folgende Statistikdaten je Anmeldevorgang gespeichert, wobei je nach Art der Anmeldung nicht alle Datenelemente gefüllt werden. Die nachstehende Tabelle beschreibt den maximalen Umfang der Loggingdaten, wobei keine Informationen zur anmeldenden Person gespeichert werden.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Element

    Beschreibung

    timestamp

    Datum und Uhrzeit des Eintrags.

    OAID

    Eindeutige Datenbank ID der Online-Applikation.

    OAURLPrefix

    Publik URL Prefix der Online-Applikation

    OAFriendlyName

    Bezeichnung der Online-Applikation

    isBusinessService

    „True“ wenn die Online-Applikation aus dem privatwirtschaftlichen Bereich stammt.

    OATarget

    Bereichskennzeichen der Online-Applikation (Target oder privatwirtschaftlicher Bereich)

    BKUType

    Art der Bürgerkartenumgebung die für den Anmeldevorgang verwendet wurde. (online, local, handy)

    BKUURL

    URL der verwendeten Bürgerkartenumgebung

    isSSOLogin

    „True“ wenn die die Anmeldung als Teil einer SSO Anmeldung erfolgt ist.

    isMandateLogin

    „True“ wenn die Anmeldung in Vertretung erfolgt ist.

    MandateType

    Art der verwendeten Vollmacht (Einzelprofile des Vollmachtenservice oder OID des Organwalters / berufsmäßigen Parteienvertreters)

    MandatorType

    „jur“ / „nat“ je nach Art der vertretenen juristischen oder natürlichen Person

    isPV

    „True“ wenn die Anmeldung in Vertretung durch einen Organwalter oder berufsmäßigen Parteienvertreter erfolgt ist.

    PVOID

    OID des Organwalter oder berufsmäßigen Parteienvertreter

    ProtocolType

    Type des für die Anmeldung verwendeten Authentifizierungsprotokolls. (PVP21, OpenID, SAML1)

    ProtocolSubType

    Nähere Spezifizierung des Protokolltyps. (Im Falle von PVP 2.1: POST oder Redirect)

    ExceptionType

    Typ des Fehlers der während des Anmeldevorgangs aufgetreten ist. Aktuell werden folgende Typen unterschieden:

    +
      +
    • bku: Fehler während der Kommunikation mit der Bürgerkartenumgebung.
      • +
    • moa-sp: Fehler bei der Kommunikation mit MOA-SP oder der Signaturprüfung.
      • +
    • mandate: Fehler beim Zugriff auf das Online-Vollmachten Service.
      • +
    • moa-id: Fehler während des Authentifizierungsvorgangs.
      • +
    • unknown: für allgemeine Fehler die keinem der oben genannten Typen entsprechen.
      • +

    ExceptionCode

    Fehlercode des aufgetretenen Fehlers falls vorhanden.

    ExceptionMessage

    Fehlermeldung in textueller Form (max. 255 Zeichen lang)

    +

     

    +

    2 Benötigte Netzwerkverbindungen (incoming / outgoing)

    +

    Für die Betrieb des Modules MOA-ID-Auth werden Netzwerkverbindungen zu externen Service benötigt. Die nachfolgende Tabelle gibt eine Aufstellung der benötigten Verbindungen und eine kurze Beschreibung über deren Funktion.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ServiceURLPortRichtungBeschreibung

    MOA-ID-Auth

    		*80, 443eingehend

    Front-Channel und Back-Channel Verbinding zum IDP

    MOA-ID-Auth

    		*80, 443ausgehendAbholen von Template oder PVP 2.1 Metadaten
    LDAP*389, 636ausgehendZertifikatsprüfung

    OSCP / CRL

    		*80, 443ausgehend

    Zertifikatsprüfung

    E-ID Systemvollmachten.stammzahlenregister.gv.at
    + Test: https://eid.egiz.gv.at/idp/shibboleth    		443ausgehendSAML2 Metadaten des E-ID System
    +

     

    +

    3 Revisions Logging

    +

    Ab der Version 3.x von MOA-ID-Auth steht zusätzlich zum normalen Logging und zur Generierung von Statisikdaten ein spezielles Reversions Logging zur Verfügung. Dieses Revisions Logging erstellt ein spezielles Log welches Informationen zum Identifikations- und Authentifikationsprozess mit Zeitstempel und Eventcode beinhaltet. Die Events, welche durch dieses Log aufgezeichnet werden lassen sich je MOA-ID-Auth Instanz und je Online-Applikation konfigurieren. Das Revisions Logging kann über die folgende Zeilen in der log4j Konfiguration der MOA-ID Instanz konfiguriert werden:

    +

    log4j.logger.at.gv.egiz.eventlog.plain.all=info,reversion

    +

    log4j.appender.reversion=org.apache.log4j.RollingFileAppender
    + log4j.appender.reversion.File=$logDirectory/moa-id-reversion.log
    + log4j.appender.reversion.MaxFileSize=10000KB
    + log4j.appender.reversion.MaxBackupIndex=9999
    + log4j.appender.reversion.layout=org.apache.log4j.PatternLayout
    + log4j.appender.reversion.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %t | %m%n

    +

     

    +

    Die nachstehenden Tabellen beschreibt alle Events welche aktuell in MOA-ID zur Verfügung stehen, wobei die erste Tabelle alle Basisevents beinhaltet die von MOA-ID auf jeden Fall geloggt werden. Die in der zweiten Tabelle angegebenen Events sind immer einer Session und einer Transaktion aus Tabelle 1 zugeordnet und können durch die MOA-ID Konfiguration ausgewählt werden.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    EventCode

    Wert

    Beschreibung

    1000

    SessionID

    Eine neue Session wurde mit der angegebenen ID gestartet

    1001

    SessionID

    Die Session mit der angegebenen ID wurde beendet

    1002

    IP Adresse

    IP Addresse des Hosts der die Session geöffnet hat

    1003

    SessionID

    Die Session mit der angebenden ID wurde wegen eines Fehler beendet

    1100

    TransaktionsID

    Eine neue Transaction wurde mit der angegebenen ID gestartet.  Eine Transaktion ist immer eine Session zugeordnet

    1101

    TransaktionsID

    Die Transkation mit der angegebenen ID wurde beendet

    1102

    IP Adresse

    IP Addresse des Hosts der die Transaction geöffnet hat

    1103

    TransaktionsID

    Die Transkation mit der angebenden ID wurde wegen eines Fehler beendet

    +

     

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    EventCode

    Wert

    Beschreibung

    3000

    Protokolltype

    Type des verwendeten Authentifizierungsprotokolls (OpenID Connect, PVP2, STORK, SAML1)

    3300

     

    SAML1 StartAuthentication Request

    4000

     

    Identifizierungs- und Authentifizierungsprozess wurde gestartet

    4001

     

    Identifizierungs- und Authentifizierungsprozess wurde beendet

    5000

    bPK

    bPK bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

    5001

    OID

    OID bei Vollmacht mit berufsmäßigem Parteienvertreter oder Organwalter

    5002

    JSON String

    Pseudoanonymisierte Personendaten der sich anmeldeten natürlichen Person.

    5100

    Vollmachtstype

    Type der ausgewählten Vollmacht

    5101

    jur / nat

    Vollmacht - Type der vertretenen Person (Juristische / natürliche Person)

    5102

    JSON String

    Pseudoanonymisierte Personendaten der vertretenen natürlichen Person.

    5103

    baseID

    Stammzahl der vertretenen juristischen Person

    6300EntityIDZentrales E-ID System ausgewählt
    6301RequestIDZentrales E-ID System kontaktiert
    6302ResponseIDGültige Response vom E-ID System erhalten
    6303 Ungültige Response oder Fehlercode vom E-ID System erhalten
    6304 Gültige Attribute vom E-ID System erhalten
    +

     

    +

    Einzelne Events werden um einen Transaktionsparameter ergänzt, welcher in der Spalte Wert beschrieben ist.
    +

    +

    Die pseudoanonymisierten Personendaten für natürliche Personen werden anhand des nachfolgenden Schemas generiert. Als pseudoanonymisiertes Personendatum dient der SHA256 Hash über die in eine JSON Struktur eingetragenen Personendaten. Hierfür wird das folgende JSON Schema verwendet, welches als Input für die SHA256 Berechnung dient.

    +


    + {"person":{"givenname":"Vorname der Person","familyname":"Nachname der Person","dateofbirth":"Geburtsdatum der Person"},"salt":"Zufallszahl"}
    +

    +

    Anschließend wird das pseudoanonymisiert Personendatum als JSON Wert bei den entsprechenden Events eingetragen. Der eingetragener JSON Wert entspricht dem folgenden Schema

    +


    + {"hash":"BASE64 codierte Personendatum","salt:"Zufallzahl welche zur Generierung des Personendatums verwendet wurde"}

    +

     

    +
    + + diff --git a/id/server/doc/handbook_v40/application/application.html b/id/server/doc/handbook_v40/application/application.html new file mode 100644 index 000000000..60732acaf --- /dev/null +++ b/id/server/doc/handbook_v40/application/application.html @@ -0,0 +1,220 @@ + + + + + + MOA-ID - Anwendungen + + + + +
    +
    + +

    MOA-ID-AUTH

    +
    +
    +
    +
    +

    Anwendungen

    + +

    Inhalt

    +
      +
    1. Allgemeines
      2. +
    2. Integration in bestehende Online-Applikationen +
        +
      1. Bürgerkartenauswahl +
          +
        1. Request aus einem iFrame
          2. +
        2. Request aus dem Hauptframe
          3. +
        +
        2. +
      2. Single Sign-On Anmeldeabfrage
        3. +
      +
      3. +
    3. Demo Applikationen +
        +
      1. PVP 2.1 Demo +
          +
        1. Installation
          2. +
        2. Konfiguration Demo Applikation
          3. +
        3. Konfiguration von MOA-ID-Auth
          4. +
        4. Anwendung
          5. +
        +
        2. +
      +
      4. +
    + +

    1 Allgemeines

    +

    Das erste Kapitel behandelt die Integration der von MOA-ID-Auth generierten Bürgerkartenauswahl in bestehende Online-Applikationen. Zusätzlich zur Beschreibung ist MOA-ID auch eine PVP 2.1 Demo Applikation beigelegt. Die Konfiguration und Verwendung dieser Demo Applikation ist Inhalt des letzten Kapitels.

    +

    2 Integration in bestehende Online-Applikationen

    +

    Ab MOA-ID 2.0 wird die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage standardmäßig vom Modul MOA-ID-Auth bereitgestellt und muss nicht mehr durch den Service Provider implementiert werden.

    +

    Die im Modul MOA-ID-Auth hinterlegten Standard Templates (Bürgerkartenauswahl, Single Sign-On Anmeldeabfrage) unterstützt Responsive Design und passt sich somit in einem weiten Bereich an die aktuelle Fenstergröße an, wodurch eine individuelle Integration der von MOA-ID-Auth erzeugten Formulare möglich ist. Zusätzlich bietet das Konfigurationstool die Möglichkeit der online-applikationsspezifischen Anpassung der Standard Templates. Mit dieser Funktion können einzelne Parameter der Standard Templates an die Online-Applikation individualisiert werden um die Integration weiter zu verfeinern.

    +

    Hinweis: Es besteht jedoch auch die Möglichkeit der Hinterlegung von vollständig benutzerdefinierten online-applikationsspezifischen Templates für die Bürgerkartenauswahl und die Single Sign-On Anmeldeabfrage (siehe hier).

    +

    2.1 Bürgerkartenauswahl

    +

    Die Bürgerkartenauswahl wird ab MOA-ID 2.0 standardmäßig von MOA-ID-Auth, als Antwort auf einen eingehenden Authentifizierungsrequest, bereitgestellt. Dem zu Folge müssen die aus MOA-ID 1.5.1 bekannten Parameter (target, bkuURL, template, usemandate) nicht mehr im Authentifizierungsrequest an MOA-ID-Auth übergeben werden und es kann ein standardkonformer Protokollrequest verwendet werden. Die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl in der Online-Applikation des Service Providers steht jedoch weiterhin als Legacy Variante zur Verfügung.

    +

    Die Integration der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl in eine bestehende Online-Applikation kann auf zwei Arten erfolgen. Bei beiden Varianten erfolgt der Login Vorgang (senden des Authentifizierungsrequests an MOA-ID-Auth) durch den Klick auf einen Login Button. Die Auswahl der Bürgerkartenumgebung erfolgt somit erst im zweiten Schritt. Das Sequenzdiagramm eines solchen Anmeldevorgangs finden Sie hier und die nachfolgende Grafik zeigt ein Beispiel zur Integration eines Login Buttons.

    +
    Integration Login Button
    +

    2.1.1 Request aus einem iFrame

    +

    Bei dieser Variante wird der Authentifizierungsrequests aus einem iFrame, welcher in die Online-Applikation eingebunden ist, abgesetzt. MOA-ID-Auth antwortet auf diesen Request mit der konfigurierten Bürgerkartenauswahl welche durch Verwendung des iFrame in die Online-Applikation eingebunden werden kann. Die nachfolgende Grafik zeigt ein Beispiel für die von MOA-ID-Auth bereitgestellte Bürgerkartenauswahl, welche nach Betätigung des Login Buttons im iFrame dargestellt wird.

    +
    Bürgerkartenauswahl im iFrame
    +

    Hinweis: Bei dieser Variante wird die Assertion ebenfalls an den iFrame ausgeliefert wodurch der authentifizierte Bereich der Online-Applikation im iFrame dargestellt wird. Dieses Verhalten kann durch eine online-applikationsspezifischen Anpassung der Standard Templates und dem Parameter Targetparameter unterbunden werden.

    +

    2.1.2 Request aus dem Hauptframe

    +

    Bei dieser Variante wird der Authentifizierungsrequests direkt aus dem aktuell offenen Browserfenster an MOA-ID-Auth gesendet. In diesem Fall wird die Bürgerkartenauswahl fensterfüllend im Browser dargestellt und die Benutzerin oder der Benutzer befindet sich nicht mehr in der Domain der Online-Applikation (Service Provider). Nach erfolgreicher Authentifizierung wird die Benutzerin oder der Benutzer an die Online-Applikation zurückgeleitet. Die nachfolgende Grafik zeigt die Bürgerkartenauswahl im seitenfüllenden Layout.

    +
    Bürgerkartenauswahl im seitenfüllenden Layout
    +

    2.2 Single Sign-On Anmeldeabfrage

    +

    Wird für die Integration in die Online-Applikation die Variante mit dem Login Button und der von MOA-ID-Auth bereitgestellten Bürgerkartenauswahl verwendet (iFrame oder Hauptframe), ergeben sich für die Single Sign-On Anmeldeabfrage keine zusätzlichen Anforderungen. Im Falle einer aktiven Single Sign-On Session, würde MOA-ID-Auth mit der Single Sign-On Anmeldeabfrage anstatt der Bürgerkartenauswahl antworten. Auch in diesem Fall stehen beide Möglichkeiten der Integration, identisch zum Kapitel Bürgerkartenauswahl, zur Verfügung. Die nachfolgende Grafik zeigt eine Single Sign-On Abfrage welche je nach verwendeter Variante die Bürgerkartenauswahl, in den zuvor gezeigten Beispielen, ersetzen würde.

    +
    Single Sign-On Anmeldeabfrage
    +

    Hinweis: Wird für die Integration der Bürgerkartenauswahl jedoch die Legacy Variante verwendet (direkte Integration der Bürgerkartenauswahl in die Online-Applikation) kann es zu Inkompatibilitäten mit der Single Sign-On Anmeldeabfrage kommen, da diese Abfrage von MOA-ID-Auth generiert werden muss und eine direkte Integration in eine Online-Applikation nicht möglich ist.

    +

    3 Demo Applikationen

    +

    Dieser Abschnitt behandelt die Konfiguration und Verwendung der bei MOA-ID beigelegten Demo Applikationen.

    +

    3.1 PVP 2.1 Demo

    +

    Die PVP 2.1 Demo stellt das Minimalbeispiel einer Online-Applikation dar, welche zur Authentifizierung das Protokoll PVP 2.1 verwendet. Die nachfolgenden Abschnitte beschreiben die Installation, Konfiguration und Verwendung der PVP 2.1 Demo Applikation.

    +

    Hinweis: Der Source Code der PVP 2.1 Demo Applikation ist im Order $MOA_ID_AUTH_INST/source/moa-id-oa verfügbar. Jedoch ist die Validierung der PVP 2.1 Assertion in dieser Version nicht vollständig implementiert und müsste bei Verwendung in einem Produktivsystem noch erweitert werden.

    +

    3.1.1 Installation

    +

    Für die Installation der Demo Applikation wird ein Apache Tomcat benötigt. Die Konfiguration dieser Tomcat Instanz ist identisch zur Konfiguration der Tomcat Instanz der Module MOA-ID-Auth und MOA-ID-Configuration.

    +
    3.1.1.1 Einsatz der Demo Applikation in Tomcat
    +
      +
    • Die Datei $MOA_ID_AUTH_INST/moa-id_oa.war enthält das einsatzfertige Webarchiv der Demo Applikation und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-oa entpackt.
      • +
    • Die Konfigurationsdatei mit der Basiskonfiguration für die Demo Applikation und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id-oa). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration der Demo Applikation dienen kann, finden Sie hier.
      +
      • +
    • Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • +
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben): +
        +
      • moa.id.demoOA: Pfad und Name der Basiskonfigurationsdatei für die Demo Applikation. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • +
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Client-Zertifikate (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • +
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • +
      +
      • +
    +
    3.1.1.2 Einsatz der Demo Applikation in Tomcat
    +

    Das starten und stoppen der Demo Applikation erfolgt identisch zur Beschreibung für die Module MOA-ID-Auth und MOA-ID-Configuration.

    +

    Ein erfolgreicher Start der Demo Applikation ist an folgender Log-Meldung ersichtlich:

    +
    INFO at.gv.egovernment.moa.id.demoOA.Configuration  - Demo Application initializaten finished.
    +

    Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

    +
    http://<host>:<port>/moa-id-oa/
    +

    bzw.

    +
    +https://<host>:<port>/moa-id-oa/
+
    +

    3.1.2 Konfiguration Demo Applikation

    +

    Die zentrale Konfigurationsdatei für die Demo Applikation wird der Java Virtual Machine, in der die Demo Applikation läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.demoOA als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    +
    moa.id.demoOA=C:/Programme/apache/tomcat-4.1.30/conf/moa-id-oa/oa.properties
    +

    Diese Konfigurationsdatei beinhaltet folgende Parameter.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    general.publicURLContexthttps://localhost:8443/moa-id-oa

    URL unter der das Modul MOA-ID-OA erreichbar ist.

    +

    Hinweis: Ist dieser Parameter nicht vorhanden wird die URL aus dem ersten Request generiert.

    general.login.pvp2.idp.metadata.urlhttps://demo.egiz.gv.at/moa-id-auth/
    + pvp2/metadata    		URL unter der die PVP2.1 Metadaten des IDP abgeholt werden können.
    general.login.pvp2.idp.metadata.certificatekeys/moa_idp.crtZertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieses Zertifikat wird zur Prüfung der IDP Metadaten verwendet.
    general.login.pvp2.idp.metadata.entityIDhttps://demo.egiz.gv.at/moa-id-auth/pvp2/metadataEntityID des IDP in den Metadaten (Details siehe PVP2.1 Spezifikation)
    general.login.pvp2.idp.sso.logout.urlhttps://demo.egiz.gv.at/moa-id-auth/LogOut?redirect=
    + https://demo.egiz.gv.at/moa-id-oa    		URL zum Single Log-Out (SLO) Service des IDP. Details zum SLO Service von MOA-ID-Auth finden Sie hier.
    general.login.pvp2.metadata.entities.namePVP 2.1 DemoName der Applikation, welcher in den Metadaten der Applikation angegeben wird
    general.login.pvp2.keystore.urlkeys/application[password].p12Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.
    general.login.pvp2.keystore.passwordpasswordPasswort des Keystores
    general.login.pvp2.keystore.typePKCS12

    Type des Keystores. Aktuell werden folgende Keystore Typen unterstützt

    +
      +
    • PKCS12: PKCS12 Keystore
      • +
    • JKS: Java-Keystore
      • +
    general.login.pvp2.keystore.metadata.key.aliaspvp_metadataName des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll
    general.login.pvp2.keystore.metadata.key.passwordpasswordPasswort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.
    general.login.pvp2.keystore.authrequest.encryption.key.aliaspvp_encryptionName des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll
    general.login.pvp2.keystore.authrequest.encryption.key.passwordpasswordPasswort des Schlüssels zum Verschlüsseln der Anmeldeinformation.
    general.login.pvp2.keystore.authrequest.key.aliaspvp_requestName des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.
    general.login.pvp2.keystore.authrequest.key.passwordpasswordPasswort des Schlüssels zum Signieren des Authentifizierungsrequests.
    +

     

    +

    Die Metadaten des Modules MOA-ID-Configuration werden dynamisch erstellt und stehen unter folgender URL zum Download bereit.

    +
    +http://<host>:<port>/moa-id-oa/servlet/metadata
    +

    bzw.

    +
    +https://<host>:<port>/moa-id-oa/servlet/metadata
    +

    Nach erfolgreicher Konfiguration muss die Tomcat Instanz neu gestartet werden.

    +

    3.1.3 Konfiguration von MOA-ID-Auth

    +

    Bevor ein Anmeldevorgang gestartet werden kann muss die Demo Applikation auch als Online-Applikation für das Modul MOA-ID-Auth konfiguriert werden. Hierfür kann das Konfigurationstool (Modul MOA-ID-Configuration) verwendet werden. Tragen Sie die Demo Applikation als Online-Applikation bei Ihrer MOA-ID-Auth Instanz ein. Eine Beschreibung der einzelnen Konfigurationsparameter finden Sie hier.

    +

    3.1.4 Anwendung

    +

    Nach dem Starten von Tomcat steht die Demo Applikation zur Verfügung.

    +
    http://<host>:<port>/moa-id-oa/
    +

    bzw.

    +
    +https://<host>:<port>/moa-id-oa/
+
    +

    Die Startseite der Demo Applikation beinhaltet einen kurzen Beschreibungstext und den Login Button zum Start des Anmeldevorgangs. Für die Integration der Bürgerkartenumgebung verwendet die Demo die im Kapitel 2.1.1 beschriebene iFrame Variante. Nach Betätigung des Login Buttons wird der Anmeldevorgang gestartet. Der Protokollablauf ist identisch zu dem im Kapitel Protokolle beschriebenen Ablauf für das PVP 2.1 Protokoll.

    +

    Konnten die Metadaten und der Authentifizierungsrequest erfolgreich verifiziert werden, wird anschließend die Bürgerkartenauswahl in der Hauptseite der Demo Applikation dargestellt. Wählen Sie nur die gewünschte Authentifizierungsvariante. Danach erfolgt die Authentifizierung mittels der gewählten Variante.

    +

    Nach erfolgreicher Authentifizierung werden Sie an die Demo Applikation zurückgeleite. Diese extrahiert einige Basisdaten aus der PVP 2.1 Assertion und stellt diese im Browser dar. Zusätzlich kann die gesamte übertragene PVP 2.1 Assertion angezeigt werden.

    +

    Wurde der Anmeldevorgang durch einen Fehler abgebrochen werden Sie ebenfalls an die Demo Applikation zurückgeleitet. In diesem Fall wird eine kurze Fehlerbeschreibung dargestellt. Eine ausführliche Fehlerbeschreibung kann der PVP 2.1 Assertion entnommen werden.

    +

     

    +
    + + diff --git a/id/server/doc/handbook_v40/application/iframe.png b/id/server/doc/handbook_v40/application/iframe.png new file mode 100644 index 000000000..dcc6a932d Binary files /dev/null and b/id/server/doc/handbook_v40/application/iframe.png differ diff --git a/id/server/doc/handbook_v40/application/login_button.PNG b/id/server/doc/handbook_v40/application/login_button.PNG new file mode 100644 index 000000000..36d8921ce Binary files /dev/null and b/id/server/doc/handbook_v40/application/login_button.PNG differ diff --git a/id/server/doc/handbook_v40/application/mainframe.PNG b/id/server/doc/handbook_v40/application/mainframe.PNG new file mode 100644 index 000000000..0e597d3fc Binary files /dev/null and b/id/server/doc/handbook_v40/application/mainframe.PNG differ diff --git a/id/server/doc/handbook_v40/application/sso_sendassertion.PNG b/id/server/doc/handbook_v40/application/sso_sendassertion.PNG new file mode 100644 index 000000000..1a2ca6a67 Binary files /dev/null and b/id/server/doc/handbook_v40/application/sso_sendassertion.PNG differ diff --git a/id/server/doc/handbook_v40/common/LogoEGIZ.png b/id/server/doc/handbook_v40/common/LogoEGIZ.png new file mode 100644 index 000000000..39f05d131 Binary files /dev/null and b/id/server/doc/handbook_v40/common/LogoEGIZ.png differ diff --git a/id/server/doc/handbook_v40/common/MOA.css b/id/server/doc/handbook_v40/common/MOA.css new file mode 100644 index 000000000..f8fd01d8c --- /dev/null +++ b/id/server/doc/handbook_v40/common/MOA.css @@ -0,0 +1,501 @@ +.container { + margin: auto; + max-width: 1000px; + padding-left: 20px; + padding-right: 20px; +} + +body +{ + font-family: "Roboto", sans-serif; + + color: #000; + font-size: medium; + font-weight: 300; + margin-left: 0px; + margin-right: 0px; + margin-top: 0px; + background-color: white; + letter-spacing: 0.05em; + +} + +b{ + font-weight: 500; +} + +p +{ + margin-top: 0pt; + margin-bottom: 0.5em; + text-align: justify; + +} + +.centeredimage{ + text-align: center; + width:100%; +} + +.index{ + padding-left: 0; +} +.index a{ + color: #666; +} +.index a:hover +{ + color:#E10319; +} +.index ul{ + list-style-type: none; +} +.index li{ + list-style-type: none; +} + +td{ + font-weight: 300; +} + + + +pre +{ + font-family: "Courier New", monospace; + font-size: 90%; + background-color: #DDD; + color: #000000; + margin-left:1.5%; + margin-right:1.5%; + margin-top: 1em; + margin-bottom: 1em; + border: #008000 none; + white-space: pre-wrap; +} + +hr +{ + color: #000080; + background-color: #000080; + margin-top: 0.5em; + margin-bottom: 0.5em; +} + +table.fixedWidth +{ + width: 97%; + margin-left:1.5%; + margin-right:1.5%; + margin-top: 1em; + margin-bottom: 1em; + color:#404040; +} +table.varWidth +{ + margin-left:1.5%; + margin-top: 1em; + margin-bottom: 1em; +} + +table.configtable{ + width:100%; + border-collapse: collapse; + border-style:solid; + border-color: #404040; + border-width: 2px; + font-family: "Roboto",sans-serif +} +table.configtable th{ + border-style:solid; + border-color: #404040; + border-width: 2px; + padding:3px; +} +table.configtable th{ + font-weight: 300; + font-size: 120%; +} +table.configtable td{ + border-style:solid; + border-color: #404040; + border-width: 1px; + border-left-width: 2px; + border-right-width: 2px; + padding:3px; + font-weight: 300; +} + + +th +{ + text-align: left; + +} + +h1 +{ + font-size: 220%; + font-weight: 400; +} + +h2 +{ + letter-spacing: 1px; + font-size: 170%; + font-weight: 300; + +} + +h3 +{ + letter-spacing: 1px; + font-size: 160%; + font-weight: 300; +} + +h4 +{ + letter-spacing: 1px; + font-size: 150%; + font-weight: 300; + +} + +h5 +{ + letter-spacing: 1px; + font-size: 140%; + font-weight: 300; +} + +h6 +{ + letter-spacing: 1px; + font-size: 130%; + font-weight: 300; +} + +code +{ + font-family: "Roboto","Courier New", Courier, monospace; + font-size: 90%; + font-weight: 400; + color: #000000; +} + +dd +{ + margin-top: 0.8em; + margin-bottom: 0.8em; + text-align: justify; + +} + +dt +{ + margin-top: 0.8em; + color: #E10319; +} +dt a{ + text-decoration:none; +} + +ol +{ + margin-top: 0.5em; + margin-bottom: 0.5em; + padding-left:0.8em; +} + +ol.alpha +{ + list-style-type: lower-alpha +} + +li +{ + margin-top: 0.25em; + margin-bottom: 0.25em; + text-align: justify; +} + +a:hover +{ + color: #E10319; +} +a{ + color: #666; + text-decoration: none; +} + + +.title +{ + text-align: left; + font-size: 200%; + color: #000000; + font-family: "Roboto", sans-serif; + margin-top: 0.4em; + margin-bottom: 0.4em; +} + +.subtitle +{ + text-align: left; + font-size: 133%; + color: #000000; + font-family: "Roboto", sans-serif; + margin-top: 0.4em; + margin-bottom: 0.4em +} + +.glossaryTerm +{ + font-style: italic; + color: #006699 +} + +.example +{ + font-family: "Roboto", sans-serif; + background-color: #CCFFFF; + color: #000000; + margin: 0pt 0pt; + border: #008000 none +} + +.schema +{ + font-family: "Courier New", monospace; + background-color: #FFFFCC; + color: #000000; + margin: 0pt 0pt; + border: #008000 none +} + +.documentinfo +{ + font-family: "Roboto", sans-serif; + font-size: 100%; +} + +.ol-contents +{ + font-size: 100%; + margin-top: 0.0em; + margin-bottom: 0.0em; +} + +.li-contents +{ + font-size: 100%; + margin-top: 0.0em; + margin-bottom: 0.0em; +} + +.logoTitle +{ + text-align: center; + font-size: 200%; +} + +.logoTable +{ + margin-bottom: 0px; + margin-left: 0px; + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + border-color: #818286; + +} + +.superscript +{ + vertical-align: super; + font-size: 66%; +} + +.term +{ + font-style: italic; +} + +.strongerterm +{ + font-style: italic; + font-weight: 500; +} + + +.comment +{ + color: #000000; + background: #ffff00; + font-style: italic +} + +.addedErrata12 +{ + color: #FF0000; + background-color: #FFEEEE; + text-decoration: underline +} + +.deletedErrata12 +{ + color: #999999; + background-color: #EEEEEE; + text-decoration: line-through +} + +.added12 +{ + color: #FF0000; + text-decoration: underline; + background-color: #F8F0FF; +} + +.deleted12 +{ + color: #999999; + text-decoration: line-through +; background-color: #f8f0ff +} + +.rfc2119Keyword +{ + font-variant: small-caps; + font-style: normal; +} + +.remark { font-style: italic} + +li.faq +{ + margin-top: 1.5em; + margin-bottom: 1.5em; +} + +.faq-question +{ + color: #000080; + font-size: 100%; + font-family: "Roboto", sans-serif; + font-weight: 300; + margin-bottom: 0.4em; +} +/*********************************/ +@media ( min-width :600px) { + #headline { + /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + + } + #headline br { + clear: both; + } + + #headline h1 { + color: #404040; + padding-right: 1em; + padding-top: 0.15em; + margin-bottom: 0; + float: right; + } + #headline img { + width: 300px; + padding-left: 0; + padding-top: 35px; + padding-bottom:20px; + } + + .smallImgDiv{ + width:50%; + margin:auto; + margin-bottom:40px; + margin-top:20px; + } + .smallImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } + .largeImgDiv{ + width:100%; + margin: auto; + margin-bottom:40px; + margin-top:20px; + } + .largeImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } +} +/*****************************/ +@media ( max-width :599px) { + #headline { + /*background: linear-gradient(center top , #FAFAFA, #F5F5F5) repeat scroll 0% 0% transparent;*/ + background: linear-gradient(#FAFAFA, #F5F5F5); + border-bottom: 1px solid #EEE; + } + + #headline img { + width: 150px; + padding-left: 0; + padding-top: 0.5em; + padding-bottom:0.5em; + } + #headline br { + clear: both; + } + #demologin { + width: 100%; + box-sizing: border-box; + border: 1px solid; + border-radius: 1px; + border-color: #818286; + background: #F5F5F5; + height: 182px; + width: 242px; + margin-top: 18px; + padding-left:0; + } + #headline h1 { + color: #404040; + padding: 0; + margin-bottom: 0; + margin-top: 0; + text-align: center; + } + .smallImgDiv{ + width:100%; + margin:auto; + margin-bottom:40px; + margin-top:20px; + } + .smallImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } + .largeImgDiv{ + width:100%; + margin: auto; + margin-bottom:40px; + margin-top:20px; + } + .largeImgDiv img{ + max-width: 100%; + max-height: 100%; + margin:auto; + display: block; + } +} + + diff --git a/id/server/doc/handbook_v40/common/logo_digAT.png b/id/server/doc/handbook_v40/common/logo_digAT.png new file mode 100644 index 000000000..4f36681e2 Binary files /dev/null and b/id/server/doc/handbook_v40/common/logo_digAT.png differ diff --git a/id/server/doc/handbook_v40/config/config.html b/id/server/doc/handbook_v40/config/config.html new file mode 100644 index 000000000..ad5592c54 --- /dev/null +++ b/id/server/doc/handbook_v40/config/config.html @@ -0,0 +1,1168 @@ + + + + + + MOA-ID - Konfiguration + + + + + +
    +
    + +

    MOA-ID

    +
    +
    +
    +
    +

    Konfiguration

    + +

    Inhalt

    +
      +
    1. +

      Übersicht

      +
        +
      1. Empfohlener Konfigurationsablauf
        2. +
      +
      2. +
    2. Basiskonfiguration +
        +
      1. MOA-ID-Configuration +
          +
        1. Bekanntmachung der Konfigurationsdatei
          2. +
        2. Konfigurationsparameter +
            +
          1. Allgemeine Konfigurationsparameter
            2. +
          2. Datenbankzugriff
            3. +
          3. Bürgerkarten LogIn
            4. +
          4. Mailversand
            5. +
          +
          3. +
        3. Initialisierung des Modules MOA-ID-Configuration
          4. +
        4. Benutzerverwaltung +
            +
          1. Einen neuen Benutzer erstellen
            2. +
          2. Benutzerrechte
            3. +
          +
          5. +
        +
        2. +
      2. MOA-ID-Auth +
          +
        1. Bekanntmachung der Konfigurationsdatei
          2. +
        2. Konfigurationsparameter +
            +
          1. Allgemeine Konfigurationsparameter
            2. +
          2. Externe Services +
              +
            1. Zentralers E-ID System
              2. +
            +
            3. +
          3. Protokolle +
              +
            1. SAML1
              2. +
            +
            4. +
          4. Datenbank +
              +
            1. Konfiguration
              2. +
            2. Session Informationen
              3. +
            3. Statistikdaten
              4. +
            +
            5. +
          5. Testing
            6. +
          +
          3. +
        +
        3. +
      3. Konfiguration des Loggings
        4. +
      +
      3. +
    3. Konfiguration MOA-ID-Auth +
        +
      1. Allgemeine Konfiguration +
          +
        1. Public URL Prefix
          2. +
        2. Zertifikatsprüfung
          3. +
        3. Session TimeOuts
          4. +
        4. MOA-SP
          5. +
        5. E-ID System
          6. +
        6. Protokolle +
            +
          1. Protkolle aktivieren
            2. +
          2. SAML1 Konfiguration
            3. +
          +
          7. +
        7. Revisionssicherheit
          8. +
        +
        2. +
      2. Online-Applikationen +
          +
        1. Informationen zur Online-Applikation (Service Provider) +
            +
          1. Öffentlicher Bereich
            2. +
          2. Privatwirtschaftlicher Bereich
            3. +
          +
          2. +
        2. E-ID System
          3. +
        3. Authentifizierungsprotokolle +
            +
          1. SAML 1
            2. +
          +
          4. +
        +
        3. +
      3. Import / Export +
          +
        1. Import alter Konfigurationen (= MOA-ID 2.x.x)
          2. +
        +
        4. +
      +
      4. +
    4. Konfiguration von MOA-SP
      5. +
    5. Tomcat Security Manager
      6. +
    +
      +
    1. Referenzierte Spezifikation
      2. +
    + +

    1 Übersicht

    +

    Dieses Handbuch beschreibt detailliert die Konfigurationsmöglichkeiten für die Module MOA-ID-Auth und MOA-ID-Configuration. Wobei das zentrale Einsatzgebiet des Modules MOA-ID-Configuration die Konfiguration des Modules MOA-ID-Auth darstellt.

    +

    Die Konfiguration der beiden Module MOA-ID-Auth und MOA-ID-Configuration kann in zwei Teilbereiche unterteilt werden. Der erste Abschnitt behandelt die Basiskonfiguration der beiden Module, welche in textueller Form mit Hilfe von properties-Konfigurationsdateien erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter Zuhilfenahme des Modules MOA-ID-Configuration.

    +

    1.1 Empfohlener Konfigurationsablauf

    +
      +
    1. Basiskonfiguration des Modules MOA-ID-Configuration
      2. +
    2. Initialisierung des Modules MOA-ID-Configuration
      3. +
    3. Basiskonfiguration des Modules MOA-ID-Auth
      4. +
    4. Allgemeine Konfiguration des Modules MOA-ID-Auth
      5. +
    5. Konfiguration von Online-Applikationen
      6. +
    +

    Optional kann nach dem Schritt 3 Basiskonfiguration des Modules MOA-ID-Auth eine bestehende MOA-ID 2.x.x Konfiguration importiert werden. Für bestehende Konfigurationen < 2.x.x wird eine vollständige Neukonfiguration empfohlen.

    +

    Hinweis: Wenn eine bestehende MOA-ID 2.x.x Konfiguration importiert werden soll MUSS diese zuerst mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine XML Datei exportiert werden.

    +

    2 Basiskonfiguration

    +

    Die Basiskonfiguration für die Module MOA-ID-Auth und MOA-ID-Configuration erfolgt mit Hilfe textueller properties-Dateien. Diese properties-Dateien beinhalten alle Konfigurationsparameter welche für den Start der Module erforderlich sind und müssen der Java Virtual Machine durch eine System Property mitgeteilt werden. Alle Änderungen die an der Basiskonfiguration vorgenommen werden erfordern einen Neustart der jeweiligen Java Virtual Machine.

    +

    Hinweis: Alle URL Konfigurationsparameter auf Dateien ohne den Prefix file:/ werden als relative Pfadangaben zum Konfigurationsbasisverzeichnis des jeweiligen Modules interpretiert.

    +

    2.1 MOA-ID-Configuration

    +

    Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Configuration. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

    +

    2.1.1 Bekanntmachung der Konfigurationsdatei

    +

    Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    +
    WINDOWS: -Dmoa.id.webconfig=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
+UNIX: -Dmoa.id.webconfig=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties
    +

    Zusätzlich gibt es für das Konfigurationsmodul ein Usermanagment welches ebenfalls über eine eigene Konfiguration verfügt. Die Konfiguration des Usermanagements wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet user.properties als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    + 
    WINDOWS: -Duser.properties=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
+UNIX: -Duser.properties=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties
    +

    Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Configuration erhalten Sie in Abschnitt 2.1.2.4 des Installationshandbuchs.

    +

    2.1.2 Konfigurationsparameter

    +

    Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt. Die Konfiguration der Blöcke Allgemeine Konfigurationsparameter und Datenbankzugriff sind nicht optional und müssen für den Betrieb angepasst werden.

    +
    2.1.2.1 Allgemeine Konfigurationsparameter
    +

    Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    general.defaultlanguagede, en

    Hiermit kann die Sprache, welche für die Darstellung der Texte verwendet wird, festgelegt werden.

    +

    Hinweis: Aktuell wird nur Deutsch (de) oder Englisch (en) unterstützt.

    general.ssl.certstorecerts/certstoreGibt den Pfadnamen zu einem Verzeichnis an, das als Zertifikatsspeicher im Zuge der TLS-Server-Zertifikatsüberprüfung verwendet wird.
    general.ssl.truststorecerts/truststoreTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate beim Download von PVP 2.1 Metadaten verwendet.
    general.ssl.hostnamevalidationtrue / false

    Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

    +

    Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

    general.moaconfig.keyConfigurationEncryptionKey

    Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

    +

    Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Auth hinterlegten Passwort sein.

    general.pvp.schemavalidationtrue / false

    Hiermit kann die Schemavalidierung für konfigurierte PVP Metadaten deaktiviert werden.

    + Hinweis: Standardmäßig ist die Schemavalidierung aktiv.
    +
    2.1.2.3 Datenbankzugriff
    +

    Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden. Für die Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Configuration kann jedoch auch mit Datenbanken anderer Hersteller betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen, welches im Module MOA-ID-Configuration für den Datenbankzugriff verwendet wird.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

    dbcp.validationQuery

    		SELECT 1

    SQL Query zum Validieren der Datenbank Verbindung

    +

    mySQL: SELECT 1

    +

    Oracle: select 1 from dual

    +

     

    +

    Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

    +

     

    +

    Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

    +

    2.1.3 Initialisierung des Modules MOA-ID-Configuration

    +

    Für den ersten Start muss die Authentifizierung deaktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend kann die Benutzerverwaltung des Modules MOA-ID-Configuration unter der folgenden Adresse aufgerufen werden.

    +
    http://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
    +

    bzw.

    +
    +https://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action
    +

    Mit Hilfe dieser Benutzerverwaltung kann ein neuer Benutzeraccount am Konfigurationstool angelegt und ein Kennwort für den Benutzer vergeben werden. Zusätzlich müssen dem neu erstellten Benutzer die Eigenschaften aktiv und admin zugewiesen werden. Nach dem speichern wird der neu angelegte Benutzer in der Liste aller vorhandenen Benutzern dargestellt.

    +

    Hiermit ist die Initialisierung des Moduls MOA-ID-Configuration abgeschlossen und die Authentifizierung kann wieder aktiviert werden (siehe general.login.deaktivate Abschnitt 2.2.2.1). Anschließend muss die Java Virtual Machine, in welchem das Modul MOA-ID-Configuration betrieben wird, neu gestartet werden.

    +

    Hinweis: Ein Betrieb des Moduls MOA-ID-Configuration ohne Authentifizierung ist ebenfalls m\F6glich. In diesem Fall wird jedoch empfohlen den Zugriff auf das Konfigurationstool mit anderen Mitteln einzuschr\E4nken.

    +

    2.1.4 Benutzerverwaltung

    +

    Das Modul MOA-ID-Configuration unterstützt die Benützung und Verwaltung unterschiedlicher Benutzeraccounts. Hierfür stellt die Web-Oberfläche des Modules MOA-ID-Configuration ein spezielles Interface zur Benutzerverwaltung zur Verfügung.

    +
    2.1.4.1 Einen neuen Benutzer erstellen
    +

    Für die Registrierung eins neuen Benutzeraccounts werden folgende Informationen benötigt.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeschreibungOptional
    VornameVorname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
    FamiliennameFamilienname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragennein
    OrganisationZugeordnete Organisation. Wir bei Registrierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragennein
    eMail AdresseeMail Adresse des Benutzers. Diese wird für weitere eMail Benachrichtigungen verwendetnein
    TelefonnummerTelefonnummer des Benutzersnein
    BenutzernameBenutzername für eine Anmeldung mittels Benutzername und Passwortnein
    KennwortPasswort für eine Anmeldung mittels Benutzername und Passwortja
    bPK / wbPKbPK oder wbPK für eine Anmeldung mittels PVP 2.1ja
    Benutzer ist aktiviertAktiviert oder deaktiviert den jeweiligen Benutzeraccountja
    Benutzer ist AdminDefiniert ob der Benutzeraccount über Administrator-Rechte verfügen soll. (siehe Kapitel 2.2.4.2)ja
    Benutzername/Passwort erlaubenDefiniert ob eine Anmeldung mittels Benutzername und Passwort erlaubt ist. Falls nicht steht der Benutzerin / dem Benutzer nur eine Anmeldung mittels Bürgerkarte oder Handy-Signatur zur Verfügung.ja
    +

     

    +

    Neue Benutzer können auf zwei Arten erstellt werden.

    +
      +
    1. Durch Administrator: Bei dieser Variante wird der neue Benutzeraccount durch einen Administrator über die Web-Oberfläche erstellt und aktiviert. In diesem Fall müssen alle geforderten Daten durch den Administrator eingetragen werden. Bei dieser Variante ist die Validierung der eMail Adresse nicht zwingend erforderlich, kann jedoch optional aktiviert werden.
      +
      2. +
    2. Durch PVP 2.1 Login: Bei dieser Variante wird die Generierung eines neues Benutzeraccounts durch einen Loginversuch mittels Bürgerkarte oder Handy-Signatur ausgelöst. Nach erfolgreicher Authentifizierung wird die Benutzerin / der Benutzer an das Konfigurationstool weitergeleitet. Hierbei wird geprüft ob aktuell ein Benutzeraccount für diese Person existiert. Wenn kein Account existiert wird die Benutzerin / der Benutzer aufgefordert die fehlenden Informationen für die Registrierung eines neuen Benutzeraccounts einzutragen. In diesem Fall muss die eMail Adresse durch die Benutzerin / den Benutzer zwingend validiert werden wofür der Mailversand am Module MOA-ID-Configuration konfiguriert sein muss. Nach erfolgreicher Validierung der eMail Adresse ist der Benutzeraccount als nicht aktiv registriert und muss anschließend durch einen Administrator aktiviert werden. Erst nach erfolgreicher Aktivierung ist eine gültige Anmeldung möglich.
      + Sollte die Validierung der eMail Adresse nicht innerhalb des in Abschnitt 2.2.1.1 konfigurierten Zeitraums erfolgen, wird die Benutzeranforderung automatisch gelöscht und die Benutzerin / der Benutzer muss sich erneut am Konfigurationstool registrieren.
      3. +
    +
    2.1.4.2 Benutzerrechte
    +

    Alle Benutzer die Admin–Rechte (Eigenschaft admin) besitzen haben vollen Zugriff auf die gesamte Konfiguration der verwalteten MOA-ID-Auth Instanz. Benutzer ohne Admin-Rechten stehen nur folgende Operationen zur Verf\FCgung wobei diese auch besondere Einschr\E4nkungen aufweisen können.

    +
      +
    • Online-Applikationen bearbeiten: Ein Benutzer ohne Admin-Rechte kann nur jene Online-Applikationen bearbeiten die von ihm erstellt wurden. Das bearbeiten fremder Online-Applikationen ist nicht möglich. Folgende Parameter können durch diesen Benutzer bearbeitet werden. + +
      • +
    • Online Applikation anlegen: Ein Benutzer ohne Admin-Rechte kann neue Online-Applikationen anlegen. Die Funktionen „Online-Applikation aktivieren“ (siehe Kapitel 3.2: ) steht jedoch nicht zur Verfügung. Somit muss die Online-Applikation von einem Benutzer mit Admin-Rechten aktiv geschalten werden.
      • +
    • Benutzerverwaltung: Ein Benutzer ohne Admin-Rechte kann keine neuen Benutzer erstellen. Dieser kann jedoch seinen Benutzeraccount bearbeiten und gegeben falls löschen. Beim Löschen eines Benutzeraccounts werden Online-Applikationen die von diesem erstellt wurden jedoch nicht automatisch gelöscht.
      • +
    +

    2.2 MOA-ID-Auth

    +

    Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Auth. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

    +

    2.2.1 Bekanntmachung der Konfigurationsdatei

    +

    Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der Java Virtual Machine, in der MOA-ID-Configuration läuft, durch eine System Property mitgeteilt (wird beim Starten der Java Virtual Machine in der Form -D<name>=<wert> gemacht). Der Name der System Property lautet moa.id.webconfig als Wert der System Property ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.

    + 
    Windows: moa.id.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
+UNIX: moa.id.configuration=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties
    +

    Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Auth erhalten Sie in Abschnitt 2.1.2.3 des Installationshandbuchs.

    +

    2.2.2 Konfigurationsparameter

    +

    Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt.

    +
    2.2.2.1 Allgemeine Konfigurationsparameter
    +

    Die folgenden Konfigurationsparameter sind optional und müssen nicht zwingend angegeben werden. Im Falle eines produktiven Betriebs von MOA-ID-Auth wird jedoch die Angabe eines Schlüssels zur verschlüsselten Speicherung der Session Daten in der Datenbank dringend empfohlen.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    configuration.moasession.keyaX.J47s#bh7Passwort zum Verschlüsseln von personenbezogenen Session Daten die während eines Anmeldevorgangs und für Single Sign-On in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.
    configuration.moaconfig.keyConfigurationEncryptionKey

    Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.

    +

    Hinweis: Dieses Passwort muss identisch zu dem im Modul MOA-ID-Configuration hinterlegten Passwort sein.

    configuration.ssl.useStandardJavaTrustStoretrue / false

    Deaktiviert die MOA-ID spezifische SSL TrustStore Implementierung. Wird dieser Parameter auf true gesetzt, verwendet MOA-ID den TrustStore der Java VM.

    +

    Defaultwert: false

    configuration.ssl.validation.revocation.method.orderocsp,crl

    Definiert die Reihenfolge des Zertifikatsrevokierungschecks bei SSL Verbindungen. Die Defaultreihenfolge ist OCSP, CRL.

    +

    Hinweis: Die Angabe erfolgt als CSV, wobei die Schlüsselwörter 'ocsp' und 'crl' lauten

    configuration.ssl.validation.hostnametrue / false

    Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden.

    +

    Hinweis: Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.

    configuration.validate.authblock.targetfriendlynametrue / falseHiermit kann die Überprüfung des 'TargetFriendlyName', welcher Teil des vom Benutzer signierten Authblock ist, deaktiviert werden. Eine Deaktivierung hat keinen Einfluss auf die Sicherheit des Authentifizierungsvorgangs mittels qualifizierter Signatur, jedoch kann der 'TargetFriendlyName im Authblock nicht als gesichert betrachtet werden.' Die Validierung ist deaktiviert wenn der Parameter auf false gesetzt wird.
    + Hinweis: Hierbei handelt es sich um einen Workaround für Systeme auf denen die Validierung des 'TargetFriendlyName' wegen Problemen mit der Zeichencodierung fehlschlägt, die Signatur des AuthBlocks jedoch gültig ist.
    + Defaultwert: true
    configuration.bugfix.enable.idl.escapingtrue / false

    MOA-ID intern wurden einfache Anführungszeichen (') in Vornamen oder Nachnamen bis zur Version 4.3.2 durch &#39; escapted. Dieses Escaping hatte durch einen Fehler auch Einfluss auf die ausgelieferten Attributen in PVP2 S-Profil, OpenID-Connect, etc. . Dieser Fehler wurde in der Version 4.3.3 behoben.
    + Aus Kompatibilitätsgründen kann das Escaping jedoch mittels Konfigurationsparameter wieder aktiviert werden. +

    +

    Defaultwert: false

    configuration.monitoring.activetrue / falseAktiviert das Modul für internes Monitoring / Testing.
    configuration.monitoring.message.successAll Tests passed!Statusmeldung wenn alle Tests erfolgreich ausgeführt wurden
    configuration.monitoring.test.identitylink.urlmonitoring/
    + monitoring_idl.xml

    Zur Überprüfung der gesamten Funktionalität von MOA-ID-Auth wird eine Personenbindung benötigt. Dieses Element definiert die URL auf eine Test Personenbindung welche für den Testablauf verwendet wird.

    +

    Hinweis: Der Beispielkonfiguration ist eine Personenbindung beigelegt die für das Monitoring verwendet werden kann. Bei dieser Personenbindung handelt es sich jedoch um Keine durch die Stammzahlenregisterbehörde ausgestellte Personenbindung, wodurch nicht der gesamte Personenbindungsvalidierungsvorgang getestet werden kann.

    configuration.advancedlogging.activetrue / falseAktiviert das erweiterte Logging zur Generierung von anonymisierten Statistikdaten aus den Anmeldeinformationen. Hierfür muss der entsprechende Datenbankzugriff (siehe Kapitel 2.2.2.4) ebenfalls konfiguriert werden.
    +

     

    +

    Wenn das interne Monitoring aktiviert wurde kann ein Testvorgang durch einen Aufruf der folgenden Adresse gestartet werden.

    +
    http://<host>:<port>/moa-id-auth/MonitoringServlet
    +

    bzw.

    +
    +https://<host>:<port>/moa-id-auth/MonitoringServlet
    +

    Nach einem erfolgreichen Testdurchlauf Antwortet das Monitoring mit einen http Statuscode 200 und der oben definierten Statusmeldung aus dem Parameter configuration.monitoring.message.success. Im Falle eines Fehlers antwortet das Monitoring mit einem http Statuscode 500 und die Statusmeldung enthält eine Beschreibung des aufgetretenen Fehlers.

    +
    2.2.2.2 Anbindung an das E-ID System
    +

    Die Anbindung und Weiterleitung an das zentrale E-ID System erfolgt via PVP2 S-Profil (SAML2). Für das in MOA-ID 4.x integrierte E-ID Proxy Authentifizierungsmodul sind folgende Konfigurationsparameter erforderlich.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    modules.eidproxyauth.keystore.pathkeys/szrgw.p12Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.x spezifischen Inhalten. (PVP 2.x Metadaten, PVP 2.1 Assertion)
    modules.eidproxyauth.keystore.passwordpass1234Passwort zum Keystore
    modules.eidproxyauth.metadata.sign.alias Name des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.metadata.sign.password Passwort des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls
    modules.eidproxyauth.request.sign.alias Name des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.request.sign.password Passwort des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird
    modules.eidproxyauth.response.encryption.alias Name des Schlüssels mit dem die PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.response.encryption.password Passwort des Schlüssels mit dem PVP 2.x Assertion für MOA-ID verschlüsselt werden soll
    modules.eidproxyauth.EID.trustprofileIDeid_metadataMOA-SP TrustProfil welches die vertrauenswürdigen Zertifikate zur Validierung der Metadaten des zentralen E-ID Systemas beinhaltet
    modules.eidproxyauth.EID.entityId Optional: EntityID des IDPs im zentralen E-ID System
    modules.eidproxyauth.EID.metadataUrl Optional: URL auf die SAML2 Metadaten des zentralen E-ID System, sofern diese nicht über die EntityID geladen werden können
    modules.eidproxyauth.required.additional.attributes.x 

    Optional: zusätzliche Attribute welche vom zentralen E-ID System angefordert werden

    +

    Attribute werden entspechend PVP2 Attribute-Profil angegeben. Beispiele für die Konfiguration finden Sie in der Beispielkonfiguration

    +

     

    +
    2.2.2.3 Protokolle
    +

    MOA-ID 4.x unterstützt nur mehr SAML1 als Authentifizierungsprotokoll.

    +

     

    +
    2.2.2.4 Datenbank
    +

    Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) separate Datenbank Schema, welche in der Basiskonfiguration konfiguriert werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Auth kann jedoch auch mit Datenbanken anderer Hersteller oder einer InMemory Datenbank betrieben werden. Hierfür wird jedoch auf die Hibernate Dokumention verwiesen.

    +

     

    +
    2.2.2.4.1 Konfiguration
    +

    Alle Parameter aus der Basiskonfiguration welche als Prefix configuration.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nicht optional.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    configuration.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    configuration.hibernate.connection.urljdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    configuration.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    configuration.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema
    configuration.hibernate.connection.passwordmoaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema

    configuration.dbcp.validationQuery

    		SELECT 1

    SQL Query zum Validieren der Datenbank Verbindung

    +

    mySQL: SELECT 1

    +

    Oracle: select 1 from dual

    +

     

    +

    Hinweis: Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile byteBasedConfig siehe Kapitel Installation als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).

    +
    2.2.2.4.2 Session Informationen
    +

    Alle Parameter aus der Basiskonfiguration welche als Prefix moasession.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema in welchem MOA-ID-Auth die Session Informationen temporär ablegt. Eine Konfiguration dieser Parameter ist nicht optional.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    moasession.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    moasession.hibernate.connection.urljdbc:mysql://localhost/moa-id-session?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema mit den Session Information von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    moasession.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    moasession.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    moasession.hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
    +

     

    +

    Hinweis: Zusätzlich zum SQL based Datenbank Backend für Sessiondaten gibt es aber der Version 3.2.0 die Möglichkeit einen Redis Datenserver als Datenbank Backend für Kurzzeitsessiondaten zu verwenden. Wird dieser aktiviert werden nur mehr Single Sign-On Sessioninformationen in der Sessiondatenbank abgelegt. Alle anderen Prozessdaten werden ausschließlich über das Redis Backend abgewickelt.

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    redis.active

    true / false

    		Aktiviert das Redis Backend für Kurzzeitsessiondaten
    redis.use-pooltrue / falseAktiviert / Deaktiviert den Connectionpool für Redis

    redis.host-name

    		localhostURL unter der der Redis Server erreichbar ist

    redis.port

    		6379Port unter dem der Redis Server erreichbar ist
    +

     

    +

     

    +
    2.2.2.4.3 Statistikdaten
    +

    Alle Parameter aus der Basiskonfiguration welche als Prefix advancedlogging.hibernate. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nur erforderlich wenn configuration.advancedlogging.active auf true gesetzt wird. (siehe Kapitel 2.2.2.1)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    advancedlogging.hibernate.dialect

    org.hibernate.dialect.MySQLDialect

    		Sprachtyp der verwenden Datenbank
    advancedlogging.hibernate.connection.urljdbc:mysql://localhost/moa-id-statistic?charSet=utf-8&autoReconnect=trueURL unter dem das Datenbank Schema für die Statistikfunktion von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter charSet=utf-8 als Zeichencodierung und autoReconnect=true für automatischen Verbindungsaufbau wird empfohlen

    advancedlogging.hibernate.connection.driver_class

    		com.mysql.jdbc.DriverTyp der verwendeten Datenbank

    advancedlogging.hibernate.connection.username

    		moaconfigBenutzername für den Zugriff auf das Datenbank Schema

    advancedlogging.hibernate.connection.password

    		moaconfigpasswordPasswort für den Zugriff auf das Datenbank Schema
    +

     

    +

    Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff der einzelnen Schema welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der Hibernate Dokumention entnommen werden.

    +
    2.2.2.5 Testing
    +

    Diese Parameter dienen auf Testsystemen zur Deaktivierung einzelner Verarbeitungs- oder Prüfschritte. Standardmäßig ist jeweils die sichere Variante aktiviert.

    + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    configuration.validation.certificate.QC.ignore

    true / false

    Deaktiviert die QC Prüfung von Signaturzertifikaten. Da manche Testzertifikate oder Testkarten keine QC Erweiterung aufweisen und somit eine Anmeldung mit diesen Zertifikaten nicht möglich ist, kann die QC Prüfung je Instanz deaktiviert werden.

    +

    Defaultwert: false

    protocols.pvp2.schemavalidationtrue / false

    Mit diesem Parameter kann die Schemavalidierung für PVP Metadaten deaktiviert werden.

    + Defaultwert: true
    protocols.pvp2.assertion.encryption.activetrue / false

    Mit diesem Parameter kann die Verschlüsselung der PVP2.1 Assertion für diese MOA-ID-Auth Instanz vollständig deaktiviert werden.

    +

    Defaultwert: true

    +

    Hinweis: Detaillierte Informationen zu den einzelnen PVP spezifischen Konfigurationsparametern finden Sie in der entsprechenden PVP Spezifikation.

    +

     

    +

    2.3 Konfiguration des Loggings

    +

    Die Module MOA-ID-Auth und MOA-ID-Configuration verwendet als Framework für Logging-Information die Open Source Software log4j. Die Konfiguration der Logging-Information erfolgt nicht direkt durch die einzelnen Module, sondern über eine eigene Konfigurationsdatei, die der Java Virtual Machine durch eine System Property mitgeteilt wird. Der Name der System Property lautet log4j.configuration; als Wert der System Property ist eine URL anzugeben, die auf die log4j-Konfigurationsdatei verweist, z.B.

    +
    log4j.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/log4j.properties
    +

    Zustätzlich wird für einige Basiskomponenten, welche über Drittherstellerbibliotheken inkludiert sind, LogBack als Logging Framework verwendet. Die LogBack Konfiguration wird ebenfalls über den System Property angegeben

    + 
    logback.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/logback_config.xml
    +

    Mit Hilfe von Konverertern kann eine bestehende log4j Konfiguration in das LogBack Format umgewandelt werden. Hierfür stehen divererse Tools Online zur Verfügung. (z.B. http://logback.qos.ch/translator/)

    +

     

    +

    Weitere Informationen zur Konfiguration des Loggings erhalten Sie in Abschnitt 2.1.3 des Installationshandbuchs. +

    +

    +

    3 Konfiguration MOA-ID-Auth

    +

    Dieser Abschnitt beschreibt die Konfiguration des Modules MOA-ID-Auth mithilfe der durch das Modul MOA-ID-Configuration zur Verfügung gestellten Web-Oberfläche. Hierzu muss das Konfigurationstool (Module MOA-ID-Konfiguration) bereits installiert und konfiguriert sein (siehe Kapitel 2.1). Nach erfolgreichem Login am Konfigurationstool kann das Modul MOA-ID-Auth über die Web-Oberfläche konfiguriert werden.

    +

    Die Konfiguration von MOA-ID-Auth ist in zwei Teilbereiche unterteilet. Diese behandeln die Allgemeine Konfiguration der MOA-ID-Auth Instanz und die Konfiguration von Online-Applikationen (Service Providern) welche dieser MOA-ID-Auth Instanz zugeordnet sind.

    +

    3.1 + Allgemeine Konfiguration

    +

    Die Allgemeine Konfiguration des Modules MOA-ID-Auth umfasst alle nicht online-applikationsspezifischen Konfigurationsparameter. Die Konfiguration dieser Parameter erfolgt über eine Web-Oberfläche, welche Eingabefelder für jeden Konfigurationsparameter zur Verfügung stellt. Jedes Eingabefeld wird validiert bevor der Konfigurationsparameter in der Datenbank gespeichert wird. Die Validierung erfolgt auf Basis des zu erwartenden Eingabewerts, wobei der erlaubte Zeichensatz für freidefinierbare textuelle Eingabefelder eingeschränkt sein kann. Detailinformationen zum erlaubten Zeichen finden Sie bei der jeweiligen Beschreibung des Konfigurationsparameters.

    +

    Nachfolgend finden Sie die Detailbeschreibung aller allgemeinen Konfigurationsparameter.

    +

    3.1.1 Public URL Prefix

    +

    Dieser Parameter definiert den Public URL Prefix unter welchem die MOA-ID Instanz erreichbar ist. Die Konfiguration dieses Parameters ist verpflichtend.

    + + + + + + + + + + + + + + + + +
    NameBeispielwerteBeschreibung
    Public URL Prefixhttps://demo.egiz.gv.at/moa-id-auth/

    URL-Prefix der MOA-ID Instanz. Diese URL wird für die automatische Generierung von Formularen und Informationen verwendet und MUSS konfiguriert werden.

    +

    Hinweis: Wenn virtuelle IDPs aktiviert sind muss hier für jede virtuelle MOA-ID Instanz, der Public URL Prefix als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen Public URL Prefix durch Beistrich (',') getrennt.
    + (z.B.: https://demo.egiz.gv.at/moa-id-auth/,https://apps.egiz.gv.at/moa-id-auth/)

    Virtuelle IDPs aktiviere 

    Mit dieser Option können für diese MOA-ID Instanz mehrere virtuelle MOA-ID Instanzen, welche unter schiedenen Domains erreichbar sind aktiviert werden. Der Public URL-Prefix jeder virtuellen MOA-ID Instanz muss als Comma Separatet Value (CSV) im Konfigurationsfeld 'Public URL Prefix' angegeben werden.

    +

    Hinweis: Bei Verwendung von virtuellen IDPs werden für jeden virtuellen IDP SAML2 Metadaten mit unterschiedlichen EntityIDs entsprechend dem virtuellen IDP erstellt. Somit muss jeder virtuelle IDP als MOA-ID E-ID Proxy am zentralen Applikationsregister hinterlegt sein.

    +

     

    +

    3.1.2 Zertifikatsprüfung

    +

    Dieser Bereich behandelt die allgemeine Einstellungen zur Zertifikatsprüfung und die Konfiguration von vertrauenswürdigen Zertifikaten.

    + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung

    TrustManagerRevocation

    + Checking    		 Für die TLS-Server-Authentisierung dürfen nur Server-Zertifikate verwendet werden, die eine CRLDP-Extension enthalten (andernfalls kann von MOA-ID-Auth keine CRL-überprüfung durchgeführt werden). Soll das RevocationChecking generell ausgeschaltet werden, ist dieses Attribut anzugeben und auf "false" zu setzen

    TrustedCACertificates

    		certs/ca-certsTrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), 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. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate für den Zugriff auf das Online-Vollmachten Service, den Stammzahlenregister Gateway und das Abholen von PVP 2.1 Metadaten via SSL verwendet.
    +

    3.1.3 Session TimeOuts

    + + + + + + + + + + + +
    NameBeispielwert [sec]Beschreibung
    Transaktion300

    Gibt die Zeitspanne in Sekunden an, für die Anmeldedaten, temporäre Sessiondaten oder Assertions in der Authentisierungskomponente (MOA-ID-Auth) vorrätig gehalten werden. Nach Ablauf dieser Zeitspanne werden diese Daten gelöscht oder der Anmeldevorgang abgebrochen. Dieser Parameter hat Einfluss auf folgende Funktionen:

    +
      +
    • maximale Zeitspanne eines Anmeldevorgangs vom Authentification Request bis zur Authentification Response gerechnet.
      • +
    • maximale Zeitspanne welche einer Online-Applikation zum Abholen der Anmeldedaten zur Verfügung steht. (SAML mit Artifact Binding und OpenID Connect)
      • +
    • maximale Zeitspanne zum Abholen zusätzlicher STORK2 Attribute (Zeitdauer je Attribut)
      • +
    +

    3.1.4 MOA-SP

    +

    Der Abschnitt MOA-SP Konfiguration enthält Parameter zur Nutzung von MOA-SP. MOA-SP wird für die Überprüfung der Signatur der SAML2 Metadaten des zentralen E-ID System benötigt. 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 beiliegenden Dokumentation im Abschnitt 'Konfiguration'.

    +

    3.1.5 Externe Services

    +

    Hiermit werden die URLs zum zentralen E-ID System konfiguriert.

    + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    zentrales E-ID System (CSV)https://eid.egiz.gv.at/idp/shibboleth

    URL(s) zu den SAML2 Metadaten des zentralen E-ID Systems

    + +

    Hinweis: Die URLs auf die unterschiedlichen Instanzen des zentralen E-ID Systems können auch als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen URLs durch Beistrich (',') getrennt. Sind mehrere URLs hinterlegt kann das zu verwendeten Service je Online Applikation konfiguriert werden (siehe Kapitel 3.2.4).
    + (z.B.: https://eid.egiz.gv.at/idp/shibboleth,https://eid.gv.at/idp/shibboleth)

    +

    Hinweis: Erfolgt in der Online Applikation keine konkrete Auswahl wird Standardmäßig das erste eingetragen Service verwendet.

    +

    3.1.6 Protokolle

    +

    Hierbei handelt es ich um allgemeine Einstellungen zu den vom Modul MOA-ID-Auth unterstützen Authentifizierungsprotokollen.

    +
    3.1.6.1 Protokolle aktivieren
    +

    In diesem Abschnitt können die einzelnen von MOA-ID-Auth unterstützen Authentifizierungsprotokolle aktiviert oder deaktiviert werden. Diese Einstellung gilt für die gesamte MOA-ID-Auth Instanz.

    +
    3.1.6.2 SAML1 Konfiguration
    +

    Die SourceID ist ein Teil des SAML1 Artifacts welches zur Abholung der SAML1 Assertion an die Online-Applikation zurückgegeben wird. Standardmäßig wird die SourceID aus der URL der jeweiligen Online-Applikation, an der die Anmeldung stattfinden, generiert. Optional kann jedoch eine SourceID für die gesamte MOA-ID-Auth Instanz vergeben werden, welche für alle Online-Applikationen verwendet wird.

    + + + + + + + + + + + +
    NameBeispielwerteBeschreibung
    SourceIDMOA_Instanz_ASourceID zu Generierung des SAML1 Artifacts wenn hierfür nicht die OA URL verwendet werden soll.
    +

     

    +
    3.1.6.3 PVP 2.x Konfiguration
    +

    Die allgemeinen Konfigurationsparameter für das Authentifizierungsprotokoll PVP 2.x behandeln Informationen zum Betreiber der MOA-ID-Auth Instanz und zu einer Ansprechperson für diese Instanz. Diese Parameter werden in den PVP 2.x Metadaten, welche dem zentralen E-ID System bereitgestellt werden, eingetragen.

    +
    3.1.6.3.1 Betreiberorganisation
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung

    PVP Service Name

    		MOA-ID 2.0 Demo IDPName der MOA-ID-Auth Instanz. Dieser Name wird in den Metadaten im Element md:EntitiesDescriptor als Attribut Name angezeigt.

    Kurzbezeichnung - Organisation

    		EGIZKurzbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationName angezeigt.
    Vollständiger Name - OrganisationeGovernment InnovationszentrumVollbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationDisplayName angezeigt.
    URL der Organisation - Organisationhttp://www.egiz.gv.atURL zu einer Seite mit Informationen der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element md:Organization/md:OrganizationURL angezeigt.
    +
    3.1.6.3.2 Kontaktperson
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    FamiliennameMustermannFamilienname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.

    Vorname

    		MaxVorname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:SurName angezeigt.

    Mailadresse

    		max.mustermann@egiz.gv.ateMail Adresse der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
    Telefonnummer+43012425478521Telefonnummer der Kontaktperson. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:GivenName angezeigt.
    UnternehmenEGIZUnternehmen für welches die Kontaktperson tätig ist. Dieser Parameter wird in den Metadaten im Element md:ContactPerson/md:Company angezeigt.
    Type des Kontaktstechnical

    Type der Kontaktperson. Hierfür stehen folgende Typen zur Auswahl:

    +
      +
    • technical
      • +
    • support
      • +
    • administrative
      • +
    • billing
      • +
    • other
      • +
    +

    Dieser Name wird in den Metadaten im Element md:ContactPersonals Attribut contactType angezeigt.

    +

     

    + + + +

    3.2 Online Applikationen

    +

    Die Konfiguration von Online-Applikationen erfolgt ebenfalls mit Hilfe des Moduls MOA-ID-Configuration. Es können sowohl neue Online-Applikationen erstellt als auch bestehende Online-Applikationen bearbeitet oder gelöscht werden. Der erlaubte Konfigurationsumfang hängt jedoch von Role des aktuellen Benutzers ab, wobei eine Konfiguration der gesamten Parameter nur einem Benutzer mit der Role admin möglich ist. Alle Konfigurationsfelder die nur einem Benutzer mit der Role admin zur Verfügung stehen sind gesondert gekennzeichnet.

    +

    3.2.1 Informationen zur Online-Applikation (Service Provider)

    +

    Dieser erste Abschnitt behandelt allgemeine Parameter zur Online-Applikation.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertAdminOptionalBeschreibung
    Online-Applikation ist aktiviert X Aktiviert oder deaktiviert die Online-Applikation. Eine Authentifizierung ist nur an aktiven Online-Applikationen möglich. Ein Anmeldeversuch an einer nicht aktiven Online-Applikation wird durch MOA-ID-Auth durch den Fehlercode auth.00 und der Fehlerbeschreibung Anmeldung an dieser Applikation wird nicht unterstützt verweigert.

    Eindeutiger Identifikatior

    		https://demo.egiz.gv.at/demologin/  Dieser Parameter dient als Schlüssel zum Auffinden der Konfigurationsparameter zur Online-Applikation. Hierfür ist ein eindeutiger Identifikator für die Online-Applikation erforderlich. Dieser eindeutige Identifikator muss mindestens dem URL-Präfix der nach außen sichtbaren Domäne der Online-Applikation entsprechen.

    Name der
    + Online-Applikation

    		Demo Applikation A  Hier muss ein benutzerfreundlicher Name für die Online-Applikation angegeben werden. Dieser Name scheint während der Authentifizierung des Benutzers oder am Online-Vollmachten Service bei der Vollmachten Auswahl auf.
    Privatwirtschaftliche Applikation   Definiert ob die Online-Applikation dem öffentlichen Bereich oder dem privatwirtschaftlichen Bereich (Business Service) zugeordnet ist. Ja nach Bereich sind unterschiedliche Konfigurationsparameter erforderlich.
    +
    3.2.1.1 Öffentlicher Bereich
    +

    Wurde die Online-Applikation einem öffentlichen Bereich zugeordnet muss in weiterer Folge der zugeordnete Bereich definiert werden. Hierfür stehen folgende Parameter zur Verfügung.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertAdminOptionalBeschreibung
    Bereich (Target)BF  Definiert den öffentlichen Bereich dem die Online-Applikation zugeordnet ist.

    Target verfeinern

    		  XDer angegebene öffentliche Bereich kann mit Hilfe eines Sub-Bereich verfeinert werden. Wird ein Sub-Bereich konfiguriert wird dieser an das Kürzel des öffentlichen Bereichs angehängt.

    Anderen Bereich frei definieren

    		 XXDiese Option erlaubt die freie Definition eines öffentlichen Bereichs. Soll ein freier Bereich für die Online-Applikation verwendet werden muss sowohl das Bereichskürzel als auch ein Name für den Bereich angegeben werden.
    +

     

    +

    Hinweis: Wird die Online-Applikation durch eine Benutzerin oder einem Benutzer ohne die Role admin angelegt, wird vor der Speicherung überprüft ob die Online-Applikation alle Anforderungen an eine öffentliche Applikation erfüllt. Die Überprüfung erfolgt auf Basis des eindeutigen Identifikators (Public-URL PRefix) der Online-Applikation und es muss mindestens eine der folgenden Anforderungen erfüllt sein.

    +
      +
    • Die öffentliche URL unter der die Online-Applikation erreichbar ist (Public-URL Prefix) muss einen *.gv.at Domain aufweisen. (Beispiel: https://demo.egiz.gv.at/moa-id-oa)
      • +
    • Der SSL Serverzertifikat der Online-Applikation weist eine der folgenden Eigenschaften auf. +
        +
      • Veraltungseigenschaft (OID=1.2.40.0.10.1.1.1)
        • +
      • Dienstleistereigenschaft (OID=1.2.40.0.10.1.1.2)
        • +
      +
      • +
    +
    3.2.1.2 Privatwirtschaftlicher Bereich
    +

    Wurde die Online-Applikation einem privatwirtschaftlichen Bereich zugeordnet muss in weiterer Folge die Stammzahl des privatwirtschaftlichen Unternehmens angegeben werden. Die Stammzahl des öffentlichen Bereichs muss mit dem entsprechenden Prefix des Bereichs angegeben werden, wobei der Prefix aus einer vorgegebenen Liste gewählt werden muss.

    +
      +
    • FN: Die Stammzahl ist eine Firmenbuchnummer. (Beispiel: FN468924i)
      • +
    • ZVR: Die Stammzahl ist eine Vereinsnummer. (Beispiel: ZVR124572)
      • +
    • ERSB: Die Stammzahl ist einer Kennzahl aus dem Ergänzungsregister für sonstige Betroffene (ERsB) (Beispiel: ERSB1425367879)
      • +
    • STORK: Ländercode dem der Service Provider zugeordnet werden kann. Wird für die Ableitung des STORK-eIdentifiers verwendet.
      • +
    + + + + + + + + + + + + + + + +
    NameBeispielwerteAdminOptionalBeschreibung
    Identifikationsnummer

    FN 468924i
    + ZVR 124572
    + STORK SI +

    		  Stammzahl eines privatwirtschaftlichen Unternehmens oder Ländercode des STORK Service-Providers bei Verwendung des Modules MOA-ID als STORK VIDP. Die Angabe erfolgt durch den Prefix des Bereichs aus dem die Stammzahl stammt und der eigentlichen Stammzahl oder des Ländercodes im Falle von STORK.
    + +

     

    +

    3.2.2 Neue Attribute des E-ID Systems

    +

    Dieser Abschnitt behandelt die Änderungen am Attributset zur Person des neuen E-ID Systems. Ist der E-ID Modus aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

    +

    Folgende Attribute stehen nicht mehr zur Verfügung:

    +
      +
    • EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)
      • +
    • EID-SOURCE-PIN-TYPE (1.2.40.0.10.2.1.1.261.104)
      • +
    • EID-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.38)
      • +
    • EID-AUTH-BLOCK (urn:oid:1.2.40.0.10.2.1.1.261.62)
      • +
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.70)
      • +
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN-TYPE (urn:oid:1.2.40.0.10.2.1.1.261.102)
      • +
    • MANDATE-FULL-MANDATE (urn:oid:1.2.40.0.10.2.1.1.261.92)
      • +
    +

    Folgende neuen Attribute stehen zur Verfügung:

    +
      +
    • ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.22)
      • +
    • BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.28) (Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)
      • +
    • MANDATOR-NATURAL-PERSON-ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.72)
      • +
    • MANDATOR-NATURAL-PERSON-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.73) (Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)
      • +
    +

     

    + + + + + + + + + + + + + + + +
    NameBeispielwerteAdminOptionalBeschreibung
    E-ID Attribute ausliefern

     

    		 XAktiviert die neuen Attribute des E-ID für diese Online Applikation.
    +

     

    +

    3.2.3 Authentifizierungsprotokolle

    +

    Dieser Abschnitt behandelt online-applikationsspezifische Einstellungen zu den von der Online-Applikation unterstützen Authentifizierungsprotokollen. Eine Verwendung aller zur Verfügung stehender Authentifizierungsprotokolle durch die Online-Applikation ist ebenfalls möglich. Hierfür müssen nur alle benötigten Protokolle konfiguriert werden. Nähere Informationen zu den unterstützten Protokollen finden sie im Kapitel Protokolle.

    +

    Aus Gründen der Übersichtlichkeit kann der Konfigurationsbereich für jeden Protokoll, in der Web-Oberfläche des Konfigurationstools, ein- oder ausgeblendet werden.

    +
    3.2.3.1 SAML1
    +

    Für das Protokoll SAML1 stehen folgende Konfigurationsparameter zur Verfügung.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertAdminOptionalBeschreibung
    SAML1 aktivierendeaktiviertX Aktiviert SAML1 als erlaubtes Authentifizierungsprotokoll für diese Online-Applikation. Bei neuerstellten Online-Applikationen ist SAML1 per Default deaktiviert.
    Stammzahl übertragen XXDas Attribut bestimmt, ob die Stammzahl in den Anmeldedaten aufscheint oder ob der Wert ausgeblendet (d.h. auf den Leerstring gesetzt) wird. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl immer ausgeblendet.
    Authentifizierungsblock übertragen XXDas Attribut bestimmt, ob der AuthBlock in den Anmeldedaten enthalten ist.
    Personenbindung übertragen XXDas Attribut bestimmt, ob die Personenbindung in den Anmeldedaten enthalten ist. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl in der Personenbindung durch die jeweilige wbPK ersetzt.
    Zertifikat übertragen XXDas Attribut bestimmt, ob das Signatorzertifikat in den Anmeldedaten enthalten ist.
    Vollständige Vollmacht übertragen XXDas Attribut bestimmt ob bei einer Vollmachten-Anmeldung die vollständige 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. Wird dieses Attribut gewählt wird zusätzlich die gesamte Vollmacht übergeben.
    +

     

    +

     

    +
    3.3 Import / Export
    +

    Üer diese Funktionalität besteht die Möglichkeit eine bestehende MOA-ID 2.x.x + Konfiguration in MOA-ID 3.x zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID-Auth 3.0 + Konfiguration in ein Dokument zu exportieren oder in eine bestehende MOA-ID-Auth 3.0 + Konfiguration zu importieren.

    +

    Hinweis: + Zu beachten ist, dass bei einem Import die aktuell vorhandene + Konfiguration vollständig gelöscht und durch die importierte Konfiguration ersetzt wird. + Es wird empfohlen ein Backup einer eventuell vorhandenen MOA-ID 3.0 Konfiguration + zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die +Exportfunktion verwendet werden.

    +

    3.3.1 Import alter Konfigurationen ( MOA-ID 2.x.x)

    +

    Es besteht auch die Möglichkeit eine bestehende MOA-ID 2.x.x Konfiguration zu importieren. Hierfür muss zuerst die bestehende MOA-ID 2.x.x Konfiguration mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine Datei exportiert werden. Anschließend kann die expotierte Datei in das neue Format konfertiert und wieder in die Konfigurationsdatenbank importiert werden. Die einzelnen Schritte werden in der nachfolgenden Aufzählung näher beschrieben.

    +
      +
    1. Exportieren Sie die aktuell in MOA-ID 2.x.x verwendete Konfiguration mit Hilfe der Import/Export Funktionen im Konfigurationstool der MOA-ID Version 2.x.x in eine XML Datei. Diese in eine XML Datei exportierte Konfiguration dient als Basis für die Konvertierung in das neue Format.
      2. +
    2. Konvertieren der Konfigurationsdatei in das neue Konfigurationsformat von MOA-ID 3.x. Die Konvertierung erfolgt mit Hilfe eines Java Programms aus der Konsole. Hierfür befindet sich im Release Package das Verzeichnis $MOA_ID_AUTH_INST/migration welches alle benötigten Java Bibliotheken beinhaltet. Das Programm kann mit Hilfe des nachfolgenden Kommantozeilenparameters gestartet werden. +
      + 
      java -jar moa-id-commons.jar -in ../URL_ZUR_MOA-ID-2.x.x-Config -out ./MOA-ID-3.x.properties
      + Hierbei wird die unter + ../URL_ZUR_MOA-ID-2.x.x-Config verfügbare Konfiguration in das neue Format umgewandelt und in der Datei ./MOA-ID-3.x.properties gespeichert.
      3. +
    3. Schreiben der konvertierten Konfiguration in die neue Konfigurationstabelle der Datenbank. Dies erfolgt ebenfall mit Hilfe des mitgelieferten Konsolenprogramms, welches mit dem nachstehenden Kommantozeilenparameter gestartet wird. + 
      java -jar moa-id-commons.jar -in ./MOA-ID-3.x.properties -outdb ./moa-id-webgui.properties
      + Hierbei wird die unter ./MOA-ID-3.x.properties verfügbare Konfiguration in die Datenbank geschrieben. Die Zugriffsparameter für den Datenbankzugriff werden aus der Konfigurationsdatei ./moa-id-webgui.properties entnommen, welche Identisch zur Konfiguration des neuen MOA-ID-Configuration Tools der Version 3.0 ist.
      4. +
    +

    Hinweis: Zusätzlich besteht auch weiterhin die Möglichkeit eine MOA-ID 2.x.x Konfiguration über die Import/Export Funktion im Konfigurationstool zu importieren. Der Import einer Konfiguration kann jedoch eine längere Zeit in Anspruch nehmen wodurch TimeOut Problemen im Browser möglich sind..

    +

    4 Tomcat Security Manager

    +

    Apache Tomcat bietet die Möglichkeit den Server unter einem Security Manager zu betreiben. Damit ist es möglich den lokalen Dateizugriff zu beschränken. Mit Hilfe der Datei "catalina.policy" können so Zugriffe auf lokale Dateien und Verzeichnisse festgelegt werden. Eine beispielhafte catalina.policy Datei finden Sie im Verzeichnis $MOA_ID_INST_AUTH/tomcat. Diese Datei wurde unter Apache Tomcat 4.1.31, 5.0.28 und 5.5.27 getestet.

    +

    Mehr Informationen zum Security Manager entnehmen Sie bitte der entsprechenden Apache Tomcat Dokumentation.

    +

     

    +

    A Referenzierte Spezifikation

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SpezifikationLink

    Security Layer Spezifikation V1.2.0

    		http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
    PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
    OpenID Connecthttp://openid.net/connect/
    Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
    +

     

    +

     

    +
    + + diff --git a/id/server/doc/handbook_v40/index.html b/id/server/doc/handbook_v40/index.html new file mode 100644 index 000000000..cd09a4704 --- /dev/null +++ b/id/server/doc/handbook_v40/index.html @@ -0,0 +1,55 @@ + + + + + + MOA ID - Übersicht + + + + + + +
    +
    + +

    MOA-ID E-ID Proxy

    +
    +
    +
    + +
    +

    Übersicht zur Dokumentation der Version 4.0.x

    + +
    +
    Einführung
    +
    Übersicht über die einzelnen Module.
    +
    Installation
    +
    Detaillierte Anleitung für die Installation.
    +
    Konfiguration
    +
    Erläuterung aller Konfigurationsoptionen sowie Leitfaden für häufige Konfigurationsaufgaben.
    +
    Protokolle
    +
    Erläuterung der unterstützen Authentifizierungsprotokolle.
    +
    Anwendungen
    +
    Erläutert die Integration in bestehende Online-Applikationen und beschreibt die beigelegten Demo Applikationen
    +
    Zusatzinformationen
    +
    Spezifiziert allgemeine Funktionen des Modules MOA-ID-Auth
    +
    Informationen für Modul-Entwickler
    +
    Enthält Informationen für Entwickler von MOA-ID Modulen.
    +
    +
    +
     
    +
    +
    + + diff --git a/id/server/doc/handbook_v40/install/install.html b/id/server/doc/handbook_v40/install/install.html new file mode 100644 index 000000000..6d11e0b72 --- /dev/null +++ b/id/server/doc/handbook_v40/install/install.html @@ -0,0 +1,331 @@ + + + + + + MOA-ID - Installation + + + + +
    +
    + +

    MOA-ID

    +
    +
    +
    +
    +

    Installation

    +

    Inhalt

    +
      +
    1. +

      MOA-ID-Auth und MOA-ID-Configuration

      +
        +
      1. Basisinstallation +
          +
        1. Einführung
          2. +
        2. Installation +
            +
          1. Vorbereitung
            2. +
          2. Konfiguration von Apache Tomcat +
              +
            1. Konfiguration des HTTP Connectors
              2. +
            2. Konfiguration des HTTPS Connectors
              3. +
            +
            3. +
          3. Einsatz des Moduls MOA-ID-Auth in Tomcat
            4. +
          4. Einsatz des Moduls MOA-ID-Configuration in Tomcat
            5. +
          5. Starten und Stoppen von Tomcat +
              +
            1. Unter Windows
              2. +
            2. Unter Unix
              3. +
            3. Prüfen des erfolgreichen Starts
              4. +
            +
            6. +
          6. Änderung der Konfiguration im laufenden Betrieb
            7. +
          +
          3. +
        3. Logging +
            +
          1. Format der Log-Meldungen
            2. +
          2. Wichtige Log-Meldungen
            3. +
          +
          4. +
        +
        2. +
      2. Erweiterungsmöglichkeiten
          +
        1. Vorgeschalteter Webserver
            +
          1. Microsoft Internet Information Server (MS IIS)
              +
            1. Konfiguration von mod_jk im MS IIS
              2. +
            2. Konfiguration von Tomcat
              3. +
            3. Konfiguration von SSL
              4. +
            +
            2. +
          2. Apache
              +
            1. Konfiguration von mod_jk im Apache
              2. +
            2. Konfiguration von Tomcat
              3. +
            3. Konfiguration von SSL mit mod_SSL
              4. +
            +
            3. +
          +
          2. +
        +
        3. +
      +
    +
      +
    1. Referenzierte Software
      2. +
    +

    1 Übersicht

    +

    Die Module MOA-ID-Auth und MOA-ID-Configuration sind als plattformunabhängige Module ausgelegt. MOA-ID-Auth bietet Webservices über HTTPS zur Identifizierung und Authentifizierung an. Das Modul MOA-ID-Configuration stellt eine Weboberfläche zur Konfiguration des MOA-ID-Auth Modules zur Verfügung.

    +

    Dieses Handbuch beschreibt die Installation der beiden Module.

    +

    2 MOA-ID-Auth und MOA-ID-Configuration

    +

    Dieser Abschnitt beschreibt die Installation von der Module MOA-ID-Auth und MOA-ID-Configuration. Im ersten Unterkapitel wird eine minimale Basisinstallation beschrieben. Das zweite Unterkapitel zeigt eine Reihe von optionalen Erweiterungsmöglichkeiten auf.

    +

    2.1 Basisinstallation

    +

    2.1.1 Einführung

    +

    Die Basisinstallation der Module MOA-ID-Auth und MOA-ID-Configuration stellt einerseits die minimalen Anforderungen für den Betrieb von MOA-ID dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.

    +

    Die Mindestanforderungen für die Basisinstallation sind:

    + +

    Wir empfehlen jedoch jeweils aktuelle Version zu verwenden:

    + +

    In diesem Betriebs-Szenario wird das MOA-ID-Auth Webservice und das MOA-ID Konfigurationstool in Tomcat zum Einsatz gebracht. Beide Module können sowohl in derselben Tomcat-Instanz, als auch in separaten Tomcat-Instanzen betrieben werden. Für den Fall des separaten Betriebs muss die Installation auf beiden Tomcat-Instanzen ausgeführt werden. In beiden Fällen fungiert der Tomcat gleichzeitig als HTTP- und HTTPS-Endpunkt für beide Module. Beide Protokolle werden direkt in Tomcat konfiguriert, wobei MOA-ID-Auth und MOA-ID-Configuration Log4j als Logging Toolkit verwenden.

    +

    2.1.2 Installation

    +
    2.1.2.1 Vorbereitung
    +

    Die folgenden Schritte dienen der Vorbereitung der Installation.

    +
    +
    Installation von Java SE
    +
    Installieren Sie Java SE in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der Java SE Installation wird im weiteren Verlauf als $JAVA_HOME bezeichnet.
    +
    Installation von Apache Tomcat
    +
    Installieren Sie Apache Tomcat in ein Verzeichnis, das keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte die zu Ihrer Java SE passende Distribution von Tomcat. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet.
    +
    Entpacken der MOA-ID-Auth Webservice Distribution
    +
    Entpacken Sie die Datei moa-id-auth-4.x.x.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_ID_AUTH_INST bezeichnet.
    +
    Installation der Kryptographiebibliotheken von SIC/IAIK
    +
    +

    Ab Java 9 ist eine Installation der Kryptographiebibliotheken nicht mehr notwendig.

    +
    +
    +

    Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_ID_AUTH_INST/ext in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden Unlimited Strength + + + Jurisdiction Policy Files von der Java SE Downloadseite und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung.

    +
    +
    Installation einer Datenbank
    +
    Für den Betrieb von MOA-ID 4.x wird eine Datenbank benötigt, wobei mySQL als Datenbank empfohlen wird (wurde mit mySQL getestet). Der Einsatz eines alternativen Datenbanksystems ist jedoch ebenfalls möglich. Für den Betrieb werden mindestens zwei getrennte Datenbank Schema benötig, da die Konfiguration und die Session Informationen getrennt abgelegt werden. Erstellen Sie zwei Datenbank Schemas welche von MOA-ID-Auth verwendet werden sollen. Deren Namen können z.B. auf moa-id-session für Sessiondaten und moa-id-config für die Konfiguration lauten. Beliebige andere Namen für die Datenbank Schema sind jedoch auch möglich. +
    +
    +
    2.1.2.2 Konfiguration von Apache Tomcat
    +

    Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. Tomcat wird grundsätzlich mit einer funktionierenden Default-Konfiguration ausgeliefert.

    +
    2.1.2.2.1 Konfiguration des HTTP Connectors
    +

    Die Tomcat Default-Konfiguration schaltet ausschließlich den Connector für HTTP auf Port 8080 frei. Wir empfehlen diese Konfiguration nur für Fälle, in denen das MOA-ID-Configuration Modul in einer abgeschlossenen Netzwerkumgebung betrieben wird. Das Modul MOA-ID-Auth verlangt für Authentifizierungsanfragen zwingend HTTPS.

    +
    2.1.2.2.2 Konfiguration des HTTPS Connectors
    +

    Für den sicheren Betrieb von MOA-ID-AUTH ist die Verwendung von SSL Voraussetzung, sofern nicht ein vorgelagerter Webserver (Apache oder IIS) das SSL-Handling übernimmt. Ebenso kann SSL auch für MOA-ID-Configuration verwendet werden.

    +

    Für die dazu notwendige Konfiguration kann die im vorigen Abschnitt besprochene minimale Tomcat-Konfiguration als Ausgangspunkt verwendet werden: Zunächst ist der HTTP Connector abzuschalten (auskommentieren). Anschließend ist der HTTPS Connector zu konfigurieren. Das Dokument Tomcat SSL Configuration HOW-TO gibt einen guten Überblick dazu. Grob zusammengefasst sind folgende Schritte durchzuführen:

    +
      +
    • Erstellung eines Server-Keystores, der den privaten Schlüssel sowie das zugehörige Zertifikat des Webservices enthält, mit dem es sich bei Aufbau einer SSL-Verbindung gegenüber dem Kunden ausweist sowie das dazugehörige Server-Zertifikat enthält. Sie können diesen Keystore z.B. mit keytool erstellen, einem Programm, das Ihrer Java SE beiliegt.
      • +
    • Konfiguration des HTTPS Connectors in $CATALINA_HOME/conf/server.xml.
      • +
    • Falls eine Client-Authentisierung gewünscht ist, muss die Konfiguration des SSL-Connectors in $CATALINA_HOME/conf/server.xml angepasst werden.
      • +
    +

    Die Konfiguration des HTTPS Connectors kann entfallen, wenn Tomcat ein Webserver vorgeschaltet ist, und dieser die SSL-Kommunikation mit dem Kunden übernimmt (siehe Abschnitt 2.2.1).

    +
    2.1.2.3 Einsatz des Moduls MOA-ID-Auth in Tomcat
    +

    Um die Module MOA-ID-Auth und MOA-ID-Configuration in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

    +
      +
    • Die Datei $MOA_ID_AUTH_INST/moa-id_auth.war enthält das einsatzfertige MOA-ID-Auth Webarchiv und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-auth entpackt.
      • +
    • Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier. Diese funktionsfähige Konfiguration enthält auch eine MOA-SPSS Konfiguration, da das Modul MOA-SPSS zur Signaturprüfung im Modul MOA-ID-Auth verwendet wird.
      +
      • +
    • Ab JAVA 9 wird dieser Schritt nicht nicht mehr benötigt.
      + Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • +
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben). Eine Beispielkonfiguration in welcher diese Umgebungsvariablen gesetzt werden finden Sie hier. +
        +
      • moa.id.configuration: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • moa.spss.server.configuration: Pfad und Name der zentralen Konfigurationsdatei für MOA SP/SS. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/conf enthaltene Default-Konfiguration herangezogen.
        • +
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • +
      • -Dlogback.configurationFile: URL der LogBack Konfigurationsdatei. Eine beispielhafte LobBack-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen. Überdies besteht die Möglichkeit eine bestehende Log44 Konfigurationsdatei in der LogBack Format zu überführen (http://logback.qos.ch/translator/).
        • +
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Zertifikate. Die SSL Serverzertifikate der Server von denen mittels https Dateien bezogen werden müssen im Truststore abgelegt werden. Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • +
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • +
      • spring.profiles.active: Set generic configuration parameters in MOA-ID-Auth Spring-Context. Configuartion values are added as comma-separated list (e.g. byteBasedConfig,value2,value3). Details on possible configuration values are in Chapter Configuration.
        • +
      +
      • +
    +
    2.1.2.4 Einsatz des Moduls MOA-ID-Configuration in Tomcat
    +
      +
    • Die Datei $MOA_ID_AUTH_INST/egiz-configuration-webapp.war enthält das einsatzfertige MOA-ID-Configuration Webarchiv und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/egiz-configuration-webapp entpackt.
      • +
    • Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id-configuration). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier.
      +
      • +
    • Ab JAVA 9 wird dieser Schritt nicht nicht mehr benötigt.
      + Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt werden.
      • +
    • Folgende System Properties können gesetzt werden (wird beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben): +
        +
      • moa.id.webconfig: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Configuration. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • user.properties: Pfad und Name der Basiskonfigurationsdatei für das Usermanagement der Konfigurationsoberfläche. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • log4j.configuration: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen.
        • +
      • logback.configurationFile: URL der LogBack Konfigurationsdatei. Eine beispielhafte LobBack-Konfiguration finden Sie hier. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der Java Virtual Machine interpretiert. Ist diese System Property nicht gesetzt, wird automatisch eine im Webarchiv unter WEB-INF/classes enthaltene Default-Konfiguration herangezogen. Überdies besteht die Möglichkeit eine bestehende Log44 Konfigurationsdatei in der LogBack Format zu überführen (http://logback.qos.ch/translator/).
        • +
      • javax.net.ssl.trustStore: Pfad und Dateiname des Truststores für vertrauenswürdige SSL Zertifikate Die SSL Serverzertifikate der Server von denen mittels https Dateien bezogen werden müssen im Truststore abgelegt werden. Ein relativer Pfad werden relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
        • +
      • javax.net.ssl.trustStorePassword: Passwort für den Truststore (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll).
        • +
      • javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.
        • +
      • spring.profiles.active: Set generic configuration parameters in MOA-ID-Configuration Spring-Context. Configuartion values are added as comma-separated list (e.g. byteBasedConfig,value2,value3). Details on possible configuration values are in Chapter Configuration.
        • +
      +
      • +
    +
    2.1.2.4 Starten und Stoppen von Tomcat
    +
    2.1.2.4.1 Unter Windows
    +
    +

    Das Verzeichnis $MOA_IA_AUTH_INST/tomcat/win32 enthält Script-Dateien zum Starten und Stoppen von Tomcat. Vor der erstmaligen Verwendung der Scripts müssen in den ersten Zeilen die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden. Evtl. müssen Sie auch noch die in den Script-Dateien gesetzten, in Abschnitt 2.1.2.3 besprochenen System Properties anpassen.

    +
    +
    2.1.2.4.2 Unter Unix
    +

    Zunächst müssen die in Abschnitt 2.1.2.3 besprochenen System Properties mit Hilfe der Umgebungsvariablen CATALINA_OPTS gesetzt sein. Die Datei $MOA_ID_AUTH_INST/tomcat/unix/moa-env.sh enthält ein Beispiel dafür. Des Weiteren müssen noch die Umgebungsvariablen JAVA_HOME (Basisverzeichnis der eingesetzten Java SE) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden.

    +

    Nun kann Tomcat aus seinem Basisverzeichnis mit

    +
    bin/catalina.sh start
    +gestartet werden. Das Stoppen von Tomcat erfolgt analog mit +
    bin/catalina.sh stop
    +
    2.1.2.4.3 Prüfen des erfolgreichen Starts
    +
    +

    Ein erfolgreicher Start des MOA-ID-Auth Modules ist an folgender Log-Meldung ersichtlich:
    +

    +
    +
    32131 [localhost-startStop-1] INFO moa.id.auth  - MOA ID Authentisierung wurde erfolgreich gestartet 
+32131 [localhost-startStop-1] INFO moa.id.auth  - Dispatcher Servlet initialization finished.
    +

    Analog bei MOA-ID-Configuration

    +
    INFO | 21 10:16:22 | localhost-startStop-1 | Loading config module: MOAIDConfigurationModul
    +

    Bei leichten Fehlern in der Konfiguration geben WARN Log-Meldungen unmittelbar davor Aufschluss über fehlerhafte Konfigurations-Einträge. + Nach dem Starten von Tomcat stehen MOA-ID-Auth und MOA-ID-Configuration zur Verfügung. Die Einsprungspunkte der unterschiedlichen Authentifizierungsprotokolle von MOA-ID-Auth werden im Abschnitt Protokolle im Detail beschrieben.

    +
    +http://<host>:<port>/moa-id-auth/
+http://<host>:<port>/egiz-configuration-webapp/
    +

    bzw. +

    +
    +https://<host>:<port>/moa-id-auth/
+https://<host>:<port>/egiz-configuration-webapp/
    +

    Die Verfügbarkeit des Services können Sie einfach überprüfen, indem Sie die Endpunkte mit einem Web-Browser aufgerufen; dies sollte nach erfolgreichem Start zur Anzeige einer Informationsseite führen.

    +
    2.1.3 Logging
    +

    Beide Module verwenden Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: +

      +
    • +

      Das verwendete Log-Level (DEBUG, INFO, WARN, ERROR, FATAL);

      +
      • +
    • +

      Name und maximale Größe der Log-Datei(en);

      +
      • +
    • +

      Das Aussehen der Log-Einträge.

      +
      • +
    +

    Hierbei werden folgende Log-Hierarchien verwendet:

    +
      +
    • +

      at.gv.egiz.components.configuration für Log-Meldungen aus allgemeinen EGIZ KonfigurationsGUI

      +
      • +
    • +

      at.gv.egovernment.moa.id.configuration für Log-Meldungen aus MOA-ID Configurationsmodul

      +
      • +
    • at.gv.egovernment.moa.id für alle Log-Meldungen aus MOA-ID-Auth
      • +
    • +

      at.gv.egovernment.moa.spss für alle Log-Meldungen aus dem MOA/SPSS

      +
      • +
    • +

      at.gv.egiz.eventlog.plain.all für alle Log-Meldungen aus dem MOA-ID EventLog zur Revisionssicherung

      +
      • +
    • +

      iaik.server für alle Log-Meldungen aus den SIC/IAIK Kryptographie-Modulen.

      +
      • +
    +

    Eine für beide Module passende Konfigurationsdatei für Log4j finden Sie hier. Wird diese Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen sowohl in die Konsole, als auch in die Dateien moa-id-auth.log und moa-id-configuration.log geschrieben.

    +
    2.1.3.1 Format der Log-Meldungen
    +

    Anhand einer konkreten Log-Meldung wird das Format der MOA SP/SS Log-Meldungen erläutert:

    + 
    + INFO | 2017-09-18 10:29:22,904 | SID-7947921060553739539 | TID-4708232418268334030 | https://sso.demosp.at/handysignatur 
+      | ajp-nio-28109-exec-7 | No SSO Session cookie found
+
    +

    Der Wert INFO besagt, dass die Log-Meldung im Log-Level INFO entstanden ist. Folgende Log-Levels existieren:

    +
      +
    • +

      DEBUG: Log-Meldungen im Log-Level DEBUG geben Auskunft über die innere Arbeitsweise des Systems. Sie sind hauptsächlich für Entwickler interessant.

      +
      • +
    • +

      INFO: Diese Log-Meldungen geben Status-Informationen über den Ablauf des Webservices, wie z.B. über das Einlangen einer neuen Anfrage.

      +
      • +
    • +

      WARN: Bei der Ausführung einer Anfrage sind leichte Fehler aufgetreten. Der Ablauf des Webservices ist nicht weiter beeinträchtigt.

      +
      • +
    • +

      ERROR: Die Ausführung einer Anfrage musste abgebrochen werden. Das Webservice ist davon nicht beeinträchtigt.

      +
      • +
    • +

      FATAL: Es ist ein Fehler aufgetreten, der den weiteren Betrieb des Webservices nicht mehr erlaubt.

      +
      • +
    +

    Der nächste Wert 01 21:25:26,540 gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in diesem Fall den 1. Tag im aktuellen Monat, sowie die genaue Uhrzeit).

    +

    Der Wert SID-7947921060553739539 bezeichnet die SessionID, welche diesem Request zugeordnet wurde. Eine SessionID ist innerhalb einer SSO auch über mehrere Authentifizierungsrequests eindeutig. Das Loggen der SessionID kann mittels %X{sessionId} in der log4j Konfiguration gesetzt werden

    +

    Der Wert TID-4708232418268334030 bezeichnet die TransactionsID, welche diesem Request zugeordnet wurde. Eine TransactionsID ist innerhalb eines Authentifizierungsrequests eindeutig. Das Loggen der TransactionsID kann mittels %X{transactionId} in der log4j Konfiguration gesetzt werden

    +

    Der Wert https://sso.demosp.at/handysignatur bezeichnet die Online Applikation (eindeutiger Identifier dieses Service Providers) für welchen dieser Authentifizierungsrequest durchgeführt wird. Das Loggen des OA Identifiers kann mittels %X{oaId} in der log4j Konfiguration gesetzt werden

    +

    Der Wert ajp-nio-28109-exec-7 bezeichnet den Thread, von dem die Anfrage bearbeitet wird.

    +

    Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist häufig ein Java Stack-Trace angefügt, der eine genauere Ursachen-Forschung ermöglicht.

    +
    2.1.3.2 Wichtige Log-Meldungen
    +

    Neben den im Abschnitt 2.1.2.4.3 beschriebenen Log-Meldungen, die anzeigen, ob das Service ordnungsgemäß gestartet wurde, geben nachfolgenden Log-Meldungen Aufschluss über die Abarbeitung von Anfragen.

    +

    Die Entgegennahme einer Anfrage wird angezeigt durch: + +

    + 
    125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - REQUEST: /moa-id-auth/dispatcher
+125690 [ajp-bio-129.27.142.119-38609-exec-1] INFO moa.id.auth  - QUERY  : mod=id_pvp2x&action=Post&
    +

    Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch: +

    2435298 [ajp-bio-129.27.142.119-38609-exec-10] ERROR moa.id.auth  - Failed to generate a valid protocol request!
    +
    +

    In diesem Fall gibt der mitgeloggte Stacktrace Auskunft über die Art des Fehlers.

    +

    Die tatsächlich übertragenen Anfragen bzw. Antworten werden aus Effizienzgründen nur im Log-Level DEBUG angezeigt.

    +
    +

    2.2 Erweiterungsmöglichkeiten

    +

    Ausgehend von der Basisinstallation können die optionalen Erweiterungen, die in den nachfolgenden Abschnitten beschrieben werden, unabhängig und in beliebiger Kombination aufgesetzt werden.

    +

    2.2.1 Vorgeschalteter Webserver

    +
    2.2.1.1 Microsoft Internet Information Server (MS IIS)
    +

    Den MOA SP/SS Webservices kann optional ein MS IIS vorgeschaltet sein. In diesem Fall übernimmt der MS IIS die HTTP- bzw. HTTPS-Kommunikation mit dem Aufrufer des Webservices. Die Kommunikation zwischen MS IIS und dem in Tomcat eingerichteten MOA-ID Modulen wird durch mod_jk durchgeführt. Die angeführten Konfigurationsschritte gehen von einer MS IIS Standard-Installation aus.

    +
    2.2.1.1.1 Konfiguration von mod_jk im MS IIS
    +

    Für die Kommunikation des MS IIS mit dem im Tomcat eingerichteten MOA SP/SS Webservice wird das ISAPI-Modul von mod_jk im MS IIS installiert und konfiguriert. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk IIS HowTo. Beispiele für workers.properties und uriworkermap.properties Dateien liegen im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

    +
    2.2.1.1.2 Konfiguration von Tomcat
    +

    Damit Tomcat die Aufrufe entgegennehmen kann, die von MS IIS mittels mod_jk weiterleitet werden, muss in $CATALINA_HOME/conf/server.xml der AJP Connector aktiviert werden. Im Gegenzug können die Konnektoren für HTTP und HTTPS deaktiviert werden. Das geschieht am einfachsten durch Ein- bzw. Auskommentieren der entsprechenden Connector Konfigurations-Elemente in dieser Datei.

    +
    2.2.1.1.3 Konfiguration von SSL
    +

    Die Dokumentation zum Einrichten von SSL auf dem MS IIS steht nach Installation des IIS unter http://localhost/iisHelp/ oder aber auch auf den Webseiten von Mircrosoft zur Verfügung.

    +
    2.2.1.2 Apache
    +

    Den MOA SP/SS Webservices kann ein Apache Webserver vorgeschaltet sein. Das Prinzip funktioniert wie bei MS IIS, auch hier wird mod_jk für die Kommunikation zwischen Webserver und Tomcat eingesetzt. Die angeführten Konfigurationsschritte gehen von einer Standard-Installation des Apache Webservers aus.

    +
    2.2.1.2.1 Konfiguration von mod_jk im Apache
    +

    Um die MOA-ID Module hinter einem Apache Webserver zu betreiben, ist die Konfiguration des Apache-Moduls mod_jk erforderlich. Eine detaillierte Installations- und Konfigurationsanleitung gibt das mod_jk Apache HowTo. Ein Beispiel für eine workers.properties Datei liegt im Verzeichnis $MOA_ID_AUTH_INST/tomcat bei.

    +

    Um die MOA-ID Module dem Apache Webserver bekannt zu machen, sind zumindest folgende Einträge im globalen Kontext der Apache-Konfigurationsdatei notwendig:

    +
    LoadModule jk_module /usr/lib/apache/mod_jk.so
    AddModule jk_module
    JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
    JkWorkersFile conf/workers.properties 
    JkMount /moa-spss/* moaworker
    +

    Die Pfad- und Dateinamen können je nach existierender Apache Installation geringfügig variieren.

    +
    2.2.1.2.2 Konfiguration von Tomcat
    +

    Die Konfiguration von Tomcat ist analog zu Abschnitt 2.2.1.1.2 durchzuführen.

    +
    2.2.1.2.2 Konfiguration von SSL mit mod_SSL
    +

    Apache kann in Verbindung mit mod_SSL als SSL-Endpunkt für die MOA-ID Module fungieren. In diesem Fall entfällt die SSL-Konfiguration in Tomcat, da Apache und Tomcat auch im Fall von SSL Daten via mod_jk austauschen. Eine detaillierte Installations- und Konfigurationsanleitung enthält die Online-Dokumentation von mod_SSL.

    +

    Bei der Verwendung von Client-Authentisierung muss darauf geachtet werden, dass mod_ssl die HTTP-Header mit den Informationen über das Client-Zertifikat exportiert. Dies wird durch Angabe der folgenden Option in der Apache-Konfiguration erreicht:

    + 
    SSLOptions +ExportCertData +StdEnvVars
    +

    Je nach vorhandener SSL-Konfiguration des Apache Webservers kann diese Option im globalen Kontext, im Kontext des Virtual Hosts oder im Kontext eines Verzeichnisses spezifiziert werden.

    +

    A Referenzierte Software

    +

    Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

    + + + + + + + + + + + + + + + + + +
    NameBeschreibung
    Apache Tomcat Apache Tomcat Servlet-Container
    Java SEJava Standard Edition (Software Development Kit bzw. Java Runtime Environment)
    Log4J Logging Framework
    +
    + + diff --git a/id/server/doc/handbook_v40/intro/Blockdiagramm.png b/id/server/doc/handbook_v40/intro/Blockdiagramm.png new file mode 100644 index 000000000..18d5b84a2 Binary files /dev/null and b/id/server/doc/handbook_v40/intro/Blockdiagramm.png differ diff --git a/id/server/doc/handbook_v40/intro/E-ID-Proxy.png b/id/server/doc/handbook_v40/intro/E-ID-Proxy.png new file mode 100644 index 000000000..2e7bb2896 Binary files /dev/null and b/id/server/doc/handbook_v40/intro/E-ID-Proxy.png differ diff --git a/id/server/doc/handbook_v40/intro/Gesamtarchitektur.png b/id/server/doc/handbook_v40/intro/Gesamtarchitektur.png new file mode 100644 index 000000000..7735679bf Binary files /dev/null and b/id/server/doc/handbook_v40/intro/Gesamtarchitektur.png differ diff --git a/id/server/doc/handbook_v40/intro/anmeldeablauf.png b/id/server/doc/handbook_v40/intro/anmeldeablauf.png new file mode 100644 index 000000000..59bdefe62 Binary files /dev/null and b/id/server/doc/handbook_v40/intro/anmeldeablauf.png differ diff --git a/id/server/doc/handbook_v40/intro/intro.html b/id/server/doc/handbook_v40/intro/intro.html new file mode 100644 index 000000000..a7a4a6357 --- /dev/null +++ b/id/server/doc/handbook_v40/intro/intro.html @@ -0,0 +1,84 @@ + + + + + + MOA-ID - Einführung + + + + +
    +
    + + +

    MOA-ID

     +
    +
    +
    + +
    +

    Einführung

    +

    Allgemeines

    +

    MOA-ID E-ID Proxy

    +

    MOA-ID-Configuration

    +

     

    +

     

    +

    1 Allgemeines

    +

    Der neue elektronische Identitätsnachweis E-ID wird die alte Bürgerkarte ersetzen und stellt ein System mit mehr Einsatzmöglichkeiten dar. Der neue E-ID basiert auf der nachfolgend dargestellten Architektur, die sich aus einer Vielzahl verschiedener Komponenten zusammensetzt. Das Zusammenspiel der Komponenten, sowie eine kurze Definition wird nachfolgend beschrieben.

    +

     

    +

     

    +

    Architektur MOA-ID

    +

     

    +

    Die Gesamtarchitektur besteht aus vier Ebenen. Benutzer authentifizieren sich in der Applikationsebene gegenüber einem bestimmten Service Provider. Dieser Identifikations- und Authentifizierungsprozess erfolgt über den zentralen Identity Provider und dem Vertrauensdiensteanbieter (VDA) in der Authentifizierungsebene. Ebenso erfolgt hier im Vertretungsfall die Auswahl einer adäquaten Vollmacht über das Online-Vollmachten Service (OVS). Die Authentifizierungsebene wird auch als „E-ID Front-End“ bezeichnet. Die Personenbindung wird im E-ID Backend, in der Datenaggregierungsebene erstellt und über das E-ID Frontend an den Service Provider ausgeliefert. Werden über das Minimum Data Set (MDS) hinaus, d.h. bPK(s), Name und Geburtsdatum, weitere Attribute benötigt, so werden diese vom E-ID Backend von den jeweiligen Registern (Datenebene) bezogen und in die Personenbindung aufgenommen.

    +

     

    +

     

    +

    2 MOA-ID E-ID Proxy

    +

    Der neue elektronische Identitätsnachweis E-ID bietet ein zentrales Identitätsmanagementsystem welches die aktuell dezentral betriebenen MOA-ID Instanzen ersetzt. Für die Anbindung von Service Providern (Applikationen) werden durch den Identity Provider (IDP) des E-ID System folgende, auch bereits von MOA-ID unterstütze, Authentifizierungsprotokolle angeboten:

    +
      +
    • PVP2 S-Profil (SAML2)
      • +
    • OpenID Connect
      • +
    +

    Eine direkte Anbindung von Service Providern mittels des SAML1 Authentifizierungsprotokolls, welches in MOA-ID bereits seit der Version 2.x als "Deprecated" markiert war, ist am IDP den zentrales Identitätsmanagementsystem nicht mehr möglich. Alle Service Provider welche aktuell mittels SAML1 an MOA-ID Ankoppeln können somit nicht mehr direkt an den neue elektronische Identitätsnachweis ankopplen.
    +

    +

    Das Modul MOA-ID E-ID Proxy wird als MOA-ID Version 4.x veröffentlicht und implementiert einen Adapter zwischen dem IDP des zentrales Identitätsmanagementsystems und Service Providern (Anwendungen), welcher dazu dient SAML1 Applikationen an den neue elektronische Identitätsnachweis ankopplen. Der MOA-ID E-ID Proxy bietet Anwendugnen die selbe SAML1 Schnittstelle, wie sie bereits aus den vorangegangenen MOA-ID Versionen bekannt ist, und leitet alle Authentifizierungsanfragen direkt an das E-ID System weiter. Diese Ankopplung an das zentrales Identitätsmanagementsystem ist im nachfolgenden Blockdiagramm auch grafisch dargestellt.

    +

     

    +
    +

    Architektur MOA-ID

    +

     

    +

    Die Installation und der Betrieb ist identisch zur Version 3.x von MOA-ID, es steht jedoch ab der Version 4.x nur mehr die Funktion als E-ID Proxy zur Verfügung.

    +

    Die SAML1 Schnittstelle des MOA-ID E-ID Proxy ist zwar identisch, doch werden durch das zentrale E-ID System nicht mehr alle aus MOA-ID < v4.x bekannten Identitätsattribute bereitgestellt. Somit ändert sich der Inhalt der vom MOA-ID E-ID Proxy bereitgestellten SAML1 Assertion im Bezug auf die darin enthaltenten Attribute zur Person. Die nachfolgende Liste zeigt eine kurze Zusammenfassung der Änderungen. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel Protokolle.

    +

    Folgende Attribute stehen nicht mehr zur Verfügung:

    +
      +
    • EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)
      • +
    • EID-SOURCE-PIN-TYPE (1.2.40.0.10.2.1.1.261.104)
      • +
    • EID-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.38)
      • +
    • EID-AUTH-BLOCK (urn:oid:1.2.40.0.10.2.1.1.261.62)
      • +
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.70)
      • +
    • MANDATOR-NATURAL-PERSON-SOURCE-PIN-TYPE (urn:oid:1.2.40.0.10.2.1.1.261.102)
      • +
    • MANDATE-FULL-MANDATE (urn:oid:1.2.40.0.10.2.1.1.261.92)
      • +
    +

    Folgende neuen Attribute stehen zur Verfügung:

    +
      +
    • ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.22)
      • +
    • BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.28) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • +
    • MANDATOR-NATURAL-PERSON-ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.72)
      • +
    • MANDATOR-NATURAL-PERSON-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.73) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • +
    • EID-ONLINE-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.39) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • +
    • EID-IDENTITY-STATUS-LEVEL (urn:oid:1.2.40.0.10.2.1.1.261.109) (siehe kommendes PVP Attribut-Profil 2.2.0)
      • +
    +

    Als weitere Anpassung wird die iFrame Integration der Handy-Signatur nicht mehr zur Verfügung stehen und es erfolgt eine vollformat Weiterleitung an das zentrale E-ID System.

    +

     

    +

    3 MOA-ID-Configuration

    +

    Das Modul MOA-ID-Configuration stellt eine web-basierte Benutzerschnittstelle zur Konfiguration des Moduls MOA-ID E-ID Proxy zur Verfügung, wobei sich die Konfiguration in zwei Teilbereiche unterteilt ist. Eine detaillierte Aufstellung der einzelnen Konfigurationspunkte befindet sich im Kapitel Konfiguration.

    +
      +
    1. Allgemeine Konfiguration
      + In diesem Bereich sind alle Basiseinstellungen der MOA-ID E-ID Proxy Instanz hinterlegt. Beispiele hierfür sind Single Sign-On, unterstütze Authentifizierungsprotokolle, Informationen zu MOA-ID E-ID Proxy, URLs zu externen Services, ... Eine Änderung der Basiseinstellung erfordert besondere Benutzerrechte am Konfigurationstool.
      2. +
    2. Online-Applikationen
      + In diesem Abschnitt erfolgt die Konfiguration der einzelnen bei MOA-ID E-ID Proxy registrierten Service-Provider. Hierbei handelt es sich um Authentifizierungsprotokoll-spezifische Einstellungen, Bereich des Service-Providers (öffentlich / Privatwirtschaftlich), Konfiguration der BKU Auswahl, .... Wobei sich die Konfigurationsmöglichkeiten je nachdem welche Benutzerrechten vergeben sind, unterscheiden können.
      3. +
    +

    Zusätzlich unterstützt das Module MOA-ID-Configuration auch eine einfache Benutzerverwaltung mit Rechtevergabe mit deren Hilfe die Verwaltung von Online-Applikationen an den jeweiligen Service-Provider ausgelagert werden kann. Die Anmeldung am Konfigurationstool erfolgt mittels Bürgerkarte, Handysignatur oder STORK, wobei optional auch eine Anmeldung mittels Benutzername und Passwort zur Verfügung steht.

    +

     

    +
    + + diff --git a/id/server/doc/handbook_v40/moduledevinfo/ProcessDefinition.xsd b/id/server/doc/handbook_v40/moduledevinfo/ProcessDefinition.xsd new file mode 100644 index 000000000..d6ab7ae46 --- /dev/null +++ b/id/server/doc/handbook_v40/moduledevinfo/ProcessDefinition.xsd @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/moduledevinfo/moduledevinfo.html b/id/server/doc/handbook_v40/moduledevinfo/moduledevinfo.html new file mode 100644 index 000000000..28e4f1bb4 --- /dev/null +++ b/id/server/doc/handbook_v40/moduledevinfo/moduledevinfo.html @@ -0,0 +1,388 @@ + + + + + + MOA-ID - Informationen für Modul-Entwickler + + + + + + + + + + + + +
    + Logo BKA + Dokumentation + Logo EGIZ +
    +
    + +

    + MOA-ID (Identifikation) +

    +

    Informationen für Modul-Entwickler

    +
    + + +

    Inhalt

    +
      +
    1. +

      + Übersicht +

      +
      2. +
    2. +

      + Prozesse +

      +
        +
      1. Aufgaben (Tasks)
        2. +
      2. Transitions
        3. +
      +
      3. +
    3. +

      + Module +

      +
        +
      1. Metadaten und Prozessauswahl
        2. +
      2. +

        + Discovery +

        +
          +
        1. Service Loader Mechanismus
          2. +
        2. Spring Bean Discovery
          3. +
        +
        3. +
      +
      4. +
    4. +

      + Hinweise +

      +
      5. +
    +
    + + +

    + 1 Übersicht +

    +

    + MOA-ID ab Version 2.2 ermöglicht die dynamische Erweiterung um zusätzliche Funktionalität durch die Nutzung der + integrierten Modularchitektur.
    + Entwickler können nun eigene Prozesse, um die MOA-ID erweitert werden soll, definieren (z.B. Unterstützung + eines speziellen Authentifizierungsworkflows, Erweiterung um Vollmachten oder ausländische Identitäten etc). + MOA-ID bietet eine Ablaufsteuerung ("ProcessEngine"), die einzelne Aufgaben (Tasks) entsprechend einer vorgegebenen Prozessdefinition + abarbeiten kann. +

    +

    + Mehrere Prozesse können zu einzelnen Modulen zusammengefasst werden. Ein Modul, typischerweise repräsentiert durch eine separate JAR-Datei, wird automatisch erkannt, sobald sich + dieses im Classpath der Anwendung befindet. Damit stehen die in diesem Modul definierten Prozesse MOA-ID + automatisch zu Verfügung. +

    +

    + Beim Starten eines Authentifizierungsvorgangs speichert MOA-ID die zu diesem Zeitpunkt zu Verfügung stehenden + Informationen (Ergebnis der BKU-Auswahl, Auswahl des Herkunftslandes, Wunsch nach Vollmachten-Nutzung etc.) in + eine Datenstruktur ("ExecutionContext"). Module entscheiden dann auf Basis dieser Informationen, ob sie entsprechende Prozesse für den gegebenen Kontext anbieten können. Sobald ein + passender Prozess gefunden wurde, beginnt die MOA-ID ProcessEngine mit der Ausführung der darin definierten + Aufgaben. +

    +

    + Bei diesen Aufgaben handelt es sich typischerweise um einzelne synchrone oder asynchrone Schritte eines kompletten + Authentifizierungsvorgangs wie z.B. das Erstellen eines HTML-Formulars zum Auslesen der Personenbindung (synchron), + das Empfangen und Verarbeiten einer Personenbindung (asynchron), das Aushandeln einer Session mit dem Vollmachtenportal (synchron) etc. + Jeder Task erhält bei Ausführung automatisch Zugriff auf den ExecutionContext, der von Task zu Task weitergereicht, zum Austausch bzw. Akkumulieren von Daten dient und schließlich auch persistiert wird. + Darüber hinaus steht jeweils HttpServletRequest und HttpServletResponse zu Verfügung. +

    + +

    + 2 Prozesse +

    +

    + Ein Prozess definiert sich primär über seine Tasks, die es in einer bestimmten Abfolge abzuarbeiten gilt. Um welche Tasks es sich handelt und wie die Abfolge unter welchen Bedingungen aussieht wird in einer + ProzessDefinition in Form eines XML-Dokuments festgelegt. +

    +

    Siehe ProcessDefinition.xsd.
     

    + +

    + Die folgende Prozessdefinition zeigt als Beispiel den internen Standard-Authentifizierungsprozess von MOA-ID. Dieser unterstützt Vollmachten uns ausländische Identitäten:
      +

    +
    <?xml version="1.0" encoding="UTF-8"?> +<pd:ProcessDefinition id="DefaultAuthentication" xmlns:pd="http://reference.e-government.gv.at/namespace/moa/process/definition/v1"> + + <pd:Task id="createIdentityLinkForm" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CreateIdentityLinkFormTask" /> + <pd:Task id="verifyIdentityLink" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyIdentityLinkTask" async="true" /> + <pd:Task id="verifyAuthBlock" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyAuthenticationBlockTask" async="true" /> + <pd:Task id="verifyCertificate" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.VerifyCertificateTask" async="true" /> + <pd:Task id="getMISSessionID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetMISSessionIDTask" async="true" /> + <pd:Task id="certificateReadRequest" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.CertificateReadRequestTask" /> + <pd:Task id="prepareAuthBlockSignature" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.PrepareAuthBlockSignatureTask" /> + <pd:Task id="getForeignID" class="at.gv.egovernment.moa.id.auth.modules.internal.tasks.GetForeignIDTask" async="true" /> + + <pd:StartEvent id="start" /> + + <pd:Transition from="start" to="createIdentityLinkForm" /> + + <pd:Transition from="createIdentityLinkForm" to="verifyIdentityLink" /> + + <pd:Transition from="verifyIdentityLink" to="certificateReadRequest" conditionExpression="!ctx['identityLinkAvailable'] || ctx['useMandate']" /> + <pd:Transition from="verifyIdentityLink" to="prepareAuthBlockSignature" /> + + <pd:Transition from="prepareAuthBlockSignature" to="verifyAuthBlock" /> + + <pd:Transition from="certificateReadRequest" to="verifyCertificate" /> + + <pd:Transition from="verifyCertificate" to="verifyAuthBlock" conditionExpression="ctx['useMandate']" /> + <pd:Transition from="verifyCertificate" to="getForeignID" /> + + <pd:Transition from="verifyAuthBlock" to="getMISSessionID" conditionExpression="ctx['useMandate']" /> + <pd:Transition from="verifyAuthBlock" to="end" /> + + <pd:Transition from="getMISSessionID" to="end" /> + <pd:Transition from="getForeignID" to="end" /> + + <pd:EndEvent id="end" /> + +</pd:ProcessDefinition> +
    +

     

    + +

    + Jede Prozessbeschreibung muss zwingend ein StartEvent und ein EndEvent enthalten. + Einzelne Aufgaben sind durch Task-Elemente gekennzeichnet, wobei via Attribut async + festgelegt wird ob es sich dabei um einen synchronen (Standardeinstellung) oder um einen asynchronen Task handelt (siehe auch Abschnitt 2.1). +

    + +

    + 2.1 Aufgaben (Tasks) +

    +

    + Aus technischer Sicht sind Aufgaben einfache Klassen, die die abstrakte Klasse at.gv.egovernment.moa.id.process.springweb.MoaIdTask (moa-id-lib-xy.jar) + implementieren. Diese definiert lediglich eine execute-Methode, die aufgerufen wird, sobald der Task + von der ProcessEngine gestartet wird. Über diese Methode erhält der Task Zugriff auf den ExecutionContext sowie + auf HttpServletRequest und HttpServletResponse. Der HttpServletRequest und der ExecutionContext können nun ausgewertet, bzw. falls notwendig der ExecutionContext und die HttpServletResponse auch manipuliert werden. +

    +

    + Synchrone Tasks werden hintereinander ausgeführt. Trifft die Process Engine auf einen asynchronen Task wird dieser + nicht gleich ausgeführt, sondern der Prozess wird zunächst angehalten. Bei asynchronen Tasks handelt es sich meist um Tasks, + die zuvor eine Benutzerinteraktion erfordern (z.B. Signatur mit Bürgerkartenumgebung).
    + Als Beispiel eines asynchronen Tasks wäre ein VerifyIdentityLinkTask zu nennen, der nach Eintreffen + der Antwort der Bürgerkartenumgebung auf der DataURL aufgeweckt wird, um eine InfoBoxReadResponse mit + der Personenbindung entgegen zu nehmen, diese zu parsen und zu validieren. +

    +

    + Die Aufgabe eines (DataURL-)Servlets, das den jeweiligen Prozess aufweckt, um die Ausführung eines nachfolgenden asynchronen + Tasks zu bewirken, übernimmt das interne Servlet at.gv.egovernment.moa.id.auth.servlet.ProcessEngineSignalServlet, + das auf die URL /signalProcess gemappt wurde. +

    +

    + Hinweis: Das interne ProcessEngineSignalServlet bzw. dessen Methode getMoaSessionId(HttpServletRequest request) + können bei Bedarf durch eine Modulspezifische Implementierung überschrieben werden, um ggf. speziellen + Anforderungen in Bezug auf die Ermittlung der jeweiligen MOA Session Id Rechnung zu tragen (STORK PEPS + unterstützen keine Parameter wie MOASessionID in der assertion consumer url).
    + Als Beispiel dazu kann das Servlet at.gv.egovernment.moa.id.auth.modules.stork.STORKProcessEngineSignalServlet + des STORK-Moduls dienen. +

    +

    +  
    + Als Beispiele typischer Tasks können die Klassen im package at.gv.egovernment.moa.id.auth.modules.internal.tasks herangezogen werden.
    +

    + +

    + 2.2 Transitions +

    +

    + Die Abfolge der einzelnen Task wird in der Prozessbeschreibung durch die Transition-Elemente + bestimmt. Diese weisen die zwei verpflichtenden Attribute from und to auf, die jeweils einen Task (oder StartEvent) referenzieren von (from) dem die ProzessEngine zu (to) weiteren Task (oder EndEvent) traversiert. Betrachtet man einen + Prozess als Graphen, dann sind die Tasks als Knoten und die Transitions als Kanten anzusehen. +

    +

    + Jede Prozessausführung beginnt mit dem StartEvent. Von diesem ausgehend werden alle möglichen + Transitions zu anderen Tasks untersucht. Die erste Transition, die eine gültige Verbindung zu einem anderen Task + aufweist wird für die weitere Prozessausführung herangezogen. Transitions können über das Attribut + conditionExpression mit einer Art Policy ausgestattet werden, die festlegt, ob eine Transition verwendet + werden kann oder nicht. Dies ermöglicht eine bedingte Ausführung von Tasks. +

    +

    + Expressions müssen sich in eine booleschen Wert auflösen lassen: true (genauso + wie ein nicht gesetztes conditionExpression-Attribut) bedeutet, dass die Transition verwendet werden kann, + false bedeutet, dass die Transition nicht verwendet wird. + Bei den Expressions handelt es sich um Spring EL Expressions, + die einen leichten Zugriff auf den ExecutionContext, HttpServletRequestParameter sowie beliebige Spring-Beans ermöglichen: +

    + + + + + + + + + + + + + + + + + + + + + +
    BezeichnerBeispielBedeutung
    ctx!ctx['identityLinkAvailable']Erlaubt das Auswerten einzelner Variablen aus dem ExecutionContext, in diesem Fall einer booleschen Variable identityLinkAvailable
    requestParameterrequestParameter['myParam'] != nullGreift auf RequestParameter aus dem HttpServletRequest zurück und ermöglicht so eine Requestparameter abhängige Abfolge von Tasks.
    @@mySpringBean.isFoo()Greift auf ein Bean (in diesem Fall mit dem Namen mySpringBean) aus dem Spring ApplicationContext zurück.
    + +

    + 3 Module +

    +

    + Bei einem Modul handelt es sich grundsätzlich lediglich um eine logische Gruppierung von Prozessen. + Module sind bedingt durch ihr automatisches Discovery als eine Art Plug-in zu betrachten, weshalb sie typischerweise + auch in eigene JAR-Dateien ausgelagert vorliegen. +

    +

    Als Beispiel eines solchen Moduls kann das STORK-Modul (moa-id-module-stork-xy.jar) gesehen werden. + +

    + 3.1 Metadaten und Prozessauswahl +

    +

    + Jedes Modul muss das Interface at.gv.egovernment.moa.id.auth.modules.AuthModule implementieren, über + das der ProcessEngine zum einen Metadaten zu Verfügung gestellt werden, diese zum anderen aber auch die Prozessauswahl + (siehe Abschnitt 1) abgewickelt wird. +

    +

    +

    +
    int getPriority()
    +
    Über diese Methode gibt das Modul seine Priorität bekannt. Dies beeinflusst die Reihenfolge des Moduls + bei der Abfrage nach passenden Prozessen beim Starten eines Authentifizierungsprozesses.
    + Standardpriorität ist 0. Module die vorgereiht werden sollen, müssen eine höhere Priorität aufweisen.
    +
    +
    +
    String[] getProcessDefinitions()
    +
    Hierüber gibt das Modul die Prozessdefinitionen (bzw. ResourceUris zu den entsprechenden XML-Dateien) bekannt. + Diese werden automatisch von MOA-ID geparst und registriert. +
    +
    +
    +
    String selectProcess(ExecutionContext context)
    +
    Diese Methode wird von MOA-ID beim Starten eines Authentifizierungsprozesses aufgerufen. Der ExecutionContext + wird mit den in oben in Abschnitt 1 erwähnten Informationen befüllt und dieser + dann der selectProcess-Methode übergeben. Diese entscheidet, ob ein passender Prozess zu Verfügung + steht oder nicht. Eine eventuelle modulinterne Priorisierung muss das Modul selbst vornehmen.
    +
    +

    +

    + Als Beispiel kann die Implementierung des STORK-Moduls herangezogen werden: at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl
    + Nähere Informationen sind der Javadoc Dokumentation des AuthModule Interfaces zu entnehmen. +

    + +

    + 3.2 Discovery +

    +

    + Das bereits erwähnte automatische Discovery von Modulen beschränkt sich nun auf das automatische Auffinden der + jeweiligen AuthModule-Implementierung. MOA-ID sieht zwei Varianten vor, derartige Implementierung + aufzufinden. Welche der beiden zur Anwendung kommt (es können notfalls auch beide kombiniert werden), bleibt dem Modulentwickler überlassen. +

    + +

    + 3.2.1 Service Loader Mechanismus +

    +

    + Diese Variante sieht vor, dass jedes Modul (d.h. jede JAR-Datei) eine Datei META-INF/services/at.gv.egovernment.moa.id.auth.modules.AuthModule + enhält, das die vorhandenen AuthModule-Implementierungen auflistet: +

    + 
    at.gv.egovernment.moa.id.auth.modules.internal.DefaultAuthModuleImpl
+at.gv.egovernment.moa.id.auth.modules.mymodule.MyAuthModuleImpl
    +

    + Nähere Informationen zu diesem Mechanismus können hier entnommen werden: + Javadoc ServiceLoader bzw. Java Tutorials: Creating Extensible Applications +

    + +

    + 3.2.2 Spring Bean Discovery +

    +

    + Für den Fall, dass Module auf Basis des Spring Frameworks entwickelt werden, kann die AuthModule-Implementierung auch als Spring Bean erfolgen. +

    +

    + MOA-ID sucht beim Starten im Classpath nach Bean-Definitionen, die der Dateinamenskonvention *.authmodule.beans.xml + entsprechen und importiert diese. Über diesen Mechanismus können modulspezifische Spring Beans geladen bzw. initialisiert werden, u.a. auch AuthModule-Beans.
      +

    +

    Beispiel: STORK.authmodule.beans.xml
     

    + +
    <?xml version="1.0" encoding="UTF-8"?> +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:context="http://www.springframework.org/schema/context" + xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> + + <context:annotation-config /> + + <bean id="storkAuthModule" class="at.gv.egovernment.moa.id.auth.modules.stork.STORKAuthModuleImpl"> + <property name="priority" value="0" /> + </bean> + +</beans> +
    +

     

    + +

    + 4 Hinweise +

    +

    + Um einzelne Funktionen als Plug-In umzusetzen, muss nicht unbedingt ein ganzer Prozess definiert werden. MOA-ID ab + Version 2.2 unterstützt die Servlet 3.0 API, was u.a. den Einsatz von @WebServlet-Annotations ermöglicht. + Damit entfällt eine statische Registrierung von Servlets im web.xml. +

    +

    Am Beispiel des MonitoringServlets (at.gv.egovernment.moa.id.auth.servlet.MonitoringServlet), das als + separates JAR (moa-id-module-monitoring-xy.jar) ausgeführt wurde, kann dies anschaulich beobachtet werden. + +

     

    +

     

    + + diff --git a/id/server/doc/handbook_v40/protocol/Assertion.xml b/id/server/doc/handbook_v40/protocol/Assertion.xml new file mode 100644 index 000000000..2654f2e80 --- /dev/null +++ b/id/server/doc/handbook_v40/protocol/Assertion.xml @@ -0,0 +1,81 @@ + + + https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata + + + + + + + + + + + + + fCE31ZeXZybQLOuNQBePLjFrCtKdvCmeyJ1tUW/ghtA= + + + vUFR3YPk5wiBJnrLh6Er7V46FNDMuB5Jcu73Rw7tipgr+bnV0reRNcZ5TGT+VMjNhtKJMcqgjrQWJ6tACe1r0mzhpRSVQkw7yFkTvIhQHX1a08yqJ4yy3qiN13ctDo4VgP9qHUim7b797oOKNhRXFk+2GJA5hRcpRliUjhBlzTYrxpkY5NcYDRhDPlvMx+l11oa1iDGuAylN+ty4h3P4fIoIgL9Tz1m3l65LqkV5RBc6avSeHw9OASMigPsjd5b0IBvhvJ611xLgzC1BOtJshiw1k/p8alv8TaUmYZ/kJbRN1tuTBL129edbS0Rz0faT0tniF42QHteJ214brK3rCg== + + + + xRE83dJy1dj+KVBp5Syo91fjGeG1MmJDSuTZ5MwdDzvIZrbK3YPh0jbJz4lOSrw9urRacavZX4m2 +XAKfSRxaowP3GqTh3Ew4WJE7yXEnWiic7bUz8uMIr020bsvqHCvY48+oPARbz/cEOf5NgMBWqo9E +nibdIyU5+AmfFzDaMwNocJEANoXrjLTpduCHvT0Qt/wH+7rVdgjX1djMrBhyMWs7GQyIBRfuf58m +8kdcoiMSm9AWA4d4GzXch+bi1QRzj+Ib80DeWdcXP3Hc6pcyp/+L+hya2jZ9NMS8yup6xuoAeh7w +6JNpfE9QnO3/CPrDZTtmjPK2OIRkhgn4Yi+iBQ== + AQAB + + + + + + + + + https://demo.egiz.gv.at/demoportal_moaid-2.0/pvp/metadata + + QVGm48cqcM4UcyhDTNGYmVdrIoY= + + + + + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + + http://www.stork.gov.eu/1.0/citizenQAALevel/4 + + + + + 2.1 + + + Mustermann + + + Max + + + 1940-01-01 + + + BF:QVGm48cqcM4UcyhDTNGYmVdrIoY= + + + 4 + + + AT + + + urn:publicid:gv.at:cdid+BF + + + + diff --git a/id/server/doc/handbook_v40/protocol/AuthRequest.xml b/id/server/doc/handbook_v40/protocol/AuthRequest.xml new file mode 100644 index 000000000..f9de11c4c --- /dev/null +++ b/id/server/doc/handbook_v40/protocol/AuthRequest.xml @@ -0,0 +1,38 @@ + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + + + + + + + + sBVJQf9b+QIxRfH8YuTbF6hBrf4= + + + JK68H5XqmD2OEA8O/UCZFenVj0TrvauPhaKJt73pbHbi//hO1hBcRQbV2Qg3gQ11EcJ9Q+TM3TCe9nT6tdU/z7ry3qdZvlOfrkMF13fY4HOIuvB9AcySdxq2yKA3V5O9sLhf5S9qCyx9lMnTARC7wkVs4j2Pv00R6P/iROOHD5ryGF2J0FdtMp9VqhvQJ9yRGM2lTduF98MqxWA2EMk6AMo7qij0Bvha1B2OyFSU9HM3fyfRQpXDeiLnKHcjLpzu5TDNkKrP75c7vv85DDr7s2I0p74nAOVLMuLau5tEQ91Crk9QoqoqqEecKWcNJDXTO9MahCQw77hUDL1WOEMFFg== + + + + nEPzKMh3TovnfBnTyv+TMYFsGep8Uil7iNbfVyfLoBfqRdeGDOk4es2qWkgB6az+kM/9Js2H06m4 +pjEY7/RIjd0lMWqgi8eqdjilMmbFQykkYYQhlZbvi8KqoBcCKzj5N3GY4qh8A5qN4y85Q3sZj23T +iiIY1rphE+ZTOHCm6CKeRso9jj409YHP1xAXfPvtIYx2TA1uuagxOmL75OC/hr7gcUm0tmuKiSeq ++TO4VZw2Q7K7YESZ1WkiBoG2i4cHdcBFKnVrGNtyxl6UkjWxXRJSU9aNLs5QxsE6iFwCvFoIO+IU +cVWxfFHqOGbRtAcRUb4fk+KFHE2o1DLmfwZaUQ== + AQAB + + + + + + https://demo.egiz.gv.at/demoportal_demologin/ + + + + http://www.stork.gov.eu/1.0/citizenQAALevel/4 + + diff --git a/id/server/doc/handbook_v40/protocol/idp_metadata.xml b/id/server/doc/handbook_v40/protocol/idp_metadata.xml new file mode 100644 index 000000000..ffc15d461 --- /dev/null +++ b/id/server/doc/handbook_v40/protocol/idp_metadata.xml @@ -0,0 +1,188 @@ + + + + + + + + + + + + IjxuoZphYVmZdZ5HfoVDr35r2b1V840+SMeC89IO/SQ= + + + JILQKKPvsK7onsMweJauAcGEniFGJ5bXEOvfYhxAYCB+dXL6pH87USD1v9UqycllBDqQE/Rp2tPtqo11CjdcKs0KkceQCZjzmDlVPqMZrgh0FerTSysF0fcPKoKeAtqqk+WSu7Xk9lU+PCxGArGA+vBLTRRbAOuZpE7ORrS7AF2m5uaO1YOKfO0GN+LoxTiygI2aeqKsKMlPkboh4ZuEjv1ht9xUHeQtAf/MHtaXZDvaRQPXALf0oCRnDWpiiqvKdARJq5NXrrbrdow/M1FpoddtE0Mu65AsorIdXoPSXJnLhw/zDfHv82PQo0pW7ujc0yJY+5VzfURMZOyKmrfCmg== + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + + + MIIEFTCCAv2gAwIBAgIJAI/HXXgQpJtFMA0GCSqGSIb3DQEBCwUAMGQxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSIwIAYDVQQD +ExlNT0EtSUQgSURQIChUZXN0LVZlcnNpb24pMB4XDTE0MDEyMTA4NDAxOFoXDTE1MDEyMTA4NDAx +OFowZDELMAkGA1UEBhMCQVQxEzARBgNVBAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTAL +BgNVBAoTBEVHSVoxIjAgBgNVBAMTGU1PQS1JRCBJRFAgKFRlc3QtVmVyc2lvbikwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFETzd0nLV2P4pUGnlLKj3V+MZ4bUyYkNK5NnkzB0PO8hm +tsrdg+HSNsnPiU5KvD26tFpxq9lfibZcAp9JHFqjA/capOHcTDhYkTvJcSdaKJzttTPy4wivTbRu +y+ocK9jjz6g8BFvP9wQ5/k2AwFaqj0SeJt0jJTn4CZ8XMNozA2hwkQA2heuMtOl24Ie9PRC3/Af7 +utV2CNfV2MysGHIxazsZDIgFF+5/nybyR1yiIxKb0BYDh3gbNdyH5uLVBHOP4hvzQN5Z1xc/cdzq +lzKn/4v6HJraNn00xLzK6nrG6gB6HvDok2l8T1Cc7f8I+sNlO2aM8rY4hGSGCfhiL6IFAgMBAAGj +gckwgcYwHQYDVR0OBBYEFKG3LzuPtAGCXUPTw3fo9dtsS9wWMIGWBgNVHSMEgY4wgYuAFKG3LzuP +tAGCXUPTw3fo9dtsS9wWoWikZjBkMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTEN +MAsGA1UEBxMER3JhejENMAsGA1UEChMERUdJWjEiMCAGA1UEAxMZTU9BLUlEIElEUCAoVGVzdC1W +ZXJzaW9uKYIJAI/HXXgQpJtFMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAME3wzEi +UAcF2pCDtMMJzX4IDhSkWNuvWtSMMy8Vgtcc2t570teIKh+qNKQWZyX3QFVE6ovDABg3ZUhn780l +G4/t6aMOUEeGg4udl7l0QRBRbdd+9oc0Aw5dQqku02AQ6wQd695PLj+F0GeA7cdef90aLPu6Rwa5 +z5BiKpReJZoul3NpjQXz7A1IslZOlIhEDcFUlBSn/+QfLOeNDKurvPT0OzUGSGfrv0AoniNHc/fz +lfyRmgFbzAVHedU5cIxcE0yHtEKFjFSVwtGng9rTJpoOoY4pvGvAHlw6GEgO+HwFukPDtnvY8vi/ +cfmNJhb06H+6mmHz929Bk4HuHoQj8X8= + + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + + + EGIZ + E-Government Innovationszentrum + http://www.egiz.gv.at + + + E-Government Innovationszentrum + Lenz + Thomas + thomas.lenz@egiz.gv.at + +43 316 873 5525 + + + diff --git a/id/server/doc/handbook_v40/protocol/openIDconnect_sequenz.png b/id/server/doc/handbook_v40/protocol/openIDconnect_sequenz.png new file mode 100644 index 000000000..2faff33ed Binary files /dev/null and b/id/server/doc/handbook_v40/protocol/openIDconnect_sequenz.png differ diff --git a/id/server/doc/handbook_v40/protocol/protocol.html b/id/server/doc/handbook_v40/protocol/protocol.html new file mode 100644 index 000000000..73465d55b --- /dev/null +++ b/id/server/doc/handbook_v40/protocol/protocol.html @@ -0,0 +1,756 @@ + + + + + MOA-ID - Protokolle + + + + +
    +
    + +

    MOA-ID

     +
    +
    +
    + +
    +

    Protokolle

    + +

    Inhalt

    +
      +
    1. Allgemeines +
        +
      1. Übersicht der Zugangspunkte
        2. +
      2. Übersicht der möglichen Attribute
        3. +
      3. Übersicht der möglichen MOA-ID spezifischen Statuscodes +
          +
        1. Statuscodes 1xxxx
          2. +
        2. Statuscodes 4xxxx
          3. +
        3. Statuscodes 6xxxx
          4. +
        4. Statuscodes 9xxxx
        4. +
      +
      2. +
    2. SAML 1 +
        +
      1. Ablauf einer Anmeldung mittels SAML 1
        2. +
      2. Zugangspunkte
        3. +
      3. StartAuthentication Request
        4. +
      4. GetAuthenticationData Request
        5. +
      +
      3. + +
    3. Referenzierte Spezifikation
      4. +
    + +

    1 Allgemeines

    +

    Dieses Kapitel behandelt jene Authentifizierungsprotokolle die vom Modul MOA-ID-Auth unterstützt werden. + Wobei die Verwendung der Protokolle PVP 2.1 oder OpenID Connect empfohlen wird. Das Protokoll SAML 1, welches bis zur MOA-ID Version 1.5.1 + verwendet wurde, wird jedoch ab der Version 2.0 nur mehr aus Kompatibilitätsgründen angeboten und nicht mehr aktiv weiterentwickelt.

    +

    1.1 Übersicht der Zugangspunkte

    +

    In diesem Abschnitt sind die Zugangspunkte der vom Modul MOA-ID-Auth unterstützten Protokolle kurz zusammengefasst. Eine detaillierte Beschreibung der einzelnen Protokolle finden Sie in den anschließenden Unterkapiteln.

    + + + + + + + + + + + + + + + + +
    ProtokollRequesttypURL
    SAML 1Authentifizierungsrequest

    https://<host>:<port>/moa-id-auth/StartAuthentication

    SAML 1

    GetAuthenticationData

    https://<host>:<port>/moa-id-auth/services/GetAuthenticationData

    +

    http://<host>:<port>/moa-id-auth/services/GetAuthenticationData

    +

    1.2 Übersicht der möglichen Attribute

    +

    Die nachfolgende Tabelle beinhaltet eine Liste aller Attribute die vom Modul MOA-ID-Auth an die Online-Applikation zurückgeliefert werden können, sofern diese nach der Authentifizierung zur Verfügung stehen. Alle Namen beziehen sich auf den Attributnamen im jeweiligen Protokoll. Detailinformationen zu den einzelnen Attributen finden Sie in der PVP 2.1 Spezifikation der der STORK Spezifikation.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ProtokolleBeschreibung
    PVP 2.2OpenID ConnectSAML 1
    NameProfil
    urn:oid:1.2.40.0.10.2.1.1.149BPKeID

    /saml:Assertion/saml:AttributeStatement/

    +

    saml:Subject/saml:NameIdentifier

    Bereichsspezifisches Personenkennzeichen (bPK / wbPK)

    +

    Hinweis: Der Syntax für dieses Attribut bei den Protokollen PVP 2.1 und OpenID Connect ist bPK-value := (BEREICH ":" bPK/wbPK) wobei unter Bereich der öffentliche Bereich (Target) der Online-Applikation oder die Stammzahl des Auftraggebers bei Anwendungs-verantwortlichen aus der Privatwirtschaft angegeben wird.

    urn:oid:2.5.4.42

    		given_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname

    urn:oid:1.2.40.0.10.2.1.1.261.20

    		family_nameprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Familienname
    urn:oid:1.2.40.0.10.2.1.1.55birthdateprofile<saml:Attribute AttributeName="PersonData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum im Format JJJJ-MM-TT
    urn:oid:1.2.40.0.10.2.1.1.261.64EID-CCS-URLeID<saml:Attribute AttributeName="bkuURL" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">URL auf die Bürgerkartenumgebung die für die Authentifizierung verwendet wurde. Im Falle einer Anmeldung mittels STORK steht dieses Attribut NICHT zur Verfügung.
    urn:oid:1.2.40.0.10.2.1.1.261.94EID-CITIZEN-QAA-LEVELeID Authentifizierungslevel des Bürgers
    urn:oid:1.2.40.0.10.2.1.1.261.32EID-ISSUING-NATIONeID<saml:Attribute AttributeName="EID-ISSUING-NATION" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Landescode gem. ISO-3166 ALPHA-2
    urn:oid:1.2.40.0.10.2.1.1.261.34EID-SECTOR-FOR-IDENTIFIEReID Bereich für den die bPK / wbPK berechnet wurde.
    urn:oid:1.2.40.0.10.2.1.1.261.66EID-SIGNER-CERTIFICATEeID<saml:Attribute AttributeName="SignerCertificate" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Base64 kodiertes Zertifikat, dass für die Anmeldung verwendet wurde.
    urn:oid:1.2.40.0.10.2.1.1.261.22ENC-BPK-LISTeID<saml:Attribute AttributeName="ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.28BPK-LISTeID_gov<saml:Attribute AttributeName="BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.39EID-ONLINE-IDENTITY-LINKeID_gov<saml:Attribute AttributeName="EID-ONLINE-IDENTITY-LINK" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Online Personenbindung des E-ID
    urn:oid:1.2.40.0.10.2.1.1.261.109EID-IDENTITY-STATUS-LEVELeID_gov<saml:Attribute AttributeName="EID-IDENTITY-STATUS-LEVEL" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Kennzeichnet den Status der zusätzlich zu diesem Attribut übertragenen Identitätsdaten.
    urn:oid:1.2.40.0.10.2.1.1.261.106MANDATE-TYPE-OIDmandate Bezeichnung als OID des verwendeten Vollmachten-Profils
    urn:oid:1.2.40.0.10.2.1.1.261.68MANDATE-TYPEmandate<saml:Attribute AttributeName="RepresentationType" AttributeNamespace="http://reference.e-government.gv.at/namespace/mandates/20040701#">Bezeichnung des verwendeten Vollmachten-Profils.
    urn:oid:1.2.40.0.10.2.1.1.261.76MANDATOR-LEGAL-PERSON-SOURCE-PIN-TYPEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Gibt an, um welche Art der Stammzahl einer vertretenen juristischen Person es sich handelt.
    urn:oid:1.2.40.0.10.2.1.1.261.100MANDATOR-LEGAL-PERSON-SOURCE-PINmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Stammzahl der juristischen Person, für die Vollmachts- bzw. Vertretungsbe-fugnisse ausgeübt werden.
    urn:oid:1.2.40.0.10.2.1.1.261.98MANDATOR-NATURAL-PERSON-BPKmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Bereichsspezifisches Personenkennzeichen des Vollmachtgebers
    urn:oid:1.2.40.0.10.2.1.1.261.72MANDATOR-NATURAL-PERSON-ENC-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-ENC-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von verschlüsselten bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.73MANDATOR-NATURAL-PERSON-BPK-LISTmandate<saml:Attribute AttributeName="MANDATOR-NATURAL-PERSON-BPK-LIST" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Liste von bPKs des Mandators für andere Bereiche als der Lebensbereich der Online Applikation
    urn:oid:1.2.40.0.10.2.1.1.261.78MANDATOR-NATURAL-PERSON-GIVEN-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Vorname(n) der natürlichen Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
    urn:oid:1.2.40.0.10.2.1.1.261.80MANDATOR-NATURAL-PERSON-FAMILY-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Nachname der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird.
    urn:oid:1.2.40.0.10.2.1.1.261.82MANDATOR-NATURAL-PERSON-BIRTHDATEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Geburtsdatum der Person, die die Vollmacht erteilt hat, bzw. die vertreten wird im Format JJJJ-MM-TT
    urn:oid:1.2.40.0.10.2.1.1.261.84MANDATOR-LEGAL-PERSON-FULL-NAMEmandate<saml:Attribute AttributeName="MandateData" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Name der juristischen Person bzw. Personenmehrheit gemäß zugrundeliegendem Register.
    urn:oid:1.2.40.0.10.2.1.1.261.86MANDATE-PROF-REP-OIDmandate<saml:Attribute AttributeName="OID" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Object Identifiern (OID) zur Kennzeichnung von berufsmäßigen ParteienvertreterInnen bzw. OrganwalterInnen.
    urn:oid:1.2.40.0.10.2.1.1.261.88MANDATE-PROF-REP-DESCRIPTIONmandate<saml:Attribute AttributeName="OIDTextualDescription" AttributeNamespace="http://reference.e-government.gv.at/namespace/persondata/20020228#">Textuelle Beschreibung der Eigenschaft als berufsmäßiger ParteienvertreterIn.
    urn:oid:1.2.40.0.10.2.1.1.261.90MANDATE-REFERENCE-VALUEmandate<saml:Attribute AttributeName="mandateReferenceValue" AttributeNamespace="http://reference.e-government.gv.at/namespace/moa/20020822#">Die im Rahmen einer elektronischen Vollmachtserstellung generierte Transaktionsnummer.
    +

    1.3 Übersicht der möglichen MOA-ID spezifischen Statuscodes

    +

    Vom Modul MOA-ID-Auth werden verschiedene Authentifizierungsprotokolle wobei diese Protokolle die Fehlerrückgabe unterschiedlich spezifizieren. Zusätzlich zu den protokollabhängigen Statuscodes (siehe Spezifikation des jeweiligen Protokolls) werden zusätzliche protokollunabhängige Statuscodes an den Service Provider zurückgeliefert, wobei sich das Format der Fehlerrückgabe jedoch weiterhin protokollspezifisch ist.

    +

    Die nachfolgende Tabelle zeigt alle protokollunabhängigen Statuscodes welche vom Modul MOA-ID-Auth zurückgeliefert werden können.

    +

    1.3.1 Statuscodes 1xxxx

    +

    Alle Statuscodes beginnend mit der Zahl eins beschreiben Fehler welche während des Identifizierungs- und Authentifizierungsvorgangs aufgetreten sind.

    +
    1.3.1.1 Authentifizierung (10xxx)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    1000Anmeldung an der angeforderten Online-Applikation wird nicht unterstützt.
    1001Es ist bereits eine Anmeldung im Gange.
    1002Fehlerhafter Parameter
    1003Anfrage nur über https möglich
    1004Zertifikat konnte nicht ausgelesen werden
    1005Die Authentifizierung wurde durch den Benutzer abgebrochen
    1006Vollmachtsmodus für nicht-öffentlichen Bereich wird nicht unterstützt.
    1007Vollmachtsmodus für ausländische Personen wird nicht unterstützt.
    1008Es konnten nicht alle minimal erforderlichen Identifikations- oder Authentifikationsmerkmale ermittelt werden.
    +
    1.3.1.2 Validierung (11xxx)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    1100Ungültige MOA SessionID
    1101Fehler beim Parsen eines Parameters
    1102Fehler beim Validieren der Personenbindung
    1103Signatur ungültig
    1104Zertifikat der Personenbindung ungültig
    1105Zertifikat der Signatur ungültig
    1106Fehler beim Validieren des AuthBlocks
    1107Fehler beim Validieren eines SSL-Server-Endzertifikates
    1108Fehler beim Validieren der Online Vollmacht.
    1109Fehler beim Validieren der SZR-Gateway Response
    1110Ungültige Single Sign-On Session
    1111Der Anmeldevorgang wurde automatisiert abgebrochten da dem Benutzer die nötigen Zugriffsrechte für diese Online Applikation fehlen.
    +
     
    +

    1.3.2 Statuscodes 4xxxx

    +

    Alles Statuscodes beginnend mit der Zahl vier beschreiben Fehler die während der Kommunikation mit externen Services aufgetreten sind.

    +
    1.3.2.1 BKU (40xxxx)
    +

    Tritt während des Anmeldevorgangs in der Bürgerkartenumgebung ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Bürgerkartenumgebungsfehler weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus zwei Dezimalstellen, kennzeichnet den Fehler als Fehler als Bürgerkartenumgebungsfehler. Der zweite Teil, bestehend aus vier Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus der Bürgerkartenumgebung (siehe SecurityLayer Spezifikation).

    +

    {40}{xxxxx}

    +
    +

    {40} ... MOA-ID Statuscode für Fehler aus der Bürgerkartenumgebung

    +

    {xxxx} .... Fehlercode der Bürgerkartenumgebung.

    +
    +
    1.3.2.2 MIS (41xxxx)
    +

    Tritt während der Kommunikation mit dem Online-Vollmachten Service oder der Vollmachtsauswahl ein Fehler auf so wird der entsprechende Fehlercode an den Service Provider weitergereicht. Der der durch das Modul MOA-ID-Auth weitergereichte Statuscode für Fehler aus dem Online-Vollmachten Service weißt das folgende zweiteilige Format auf. Der erste Teil, bestehend aus drei Dezimalstellen, kennzeichnet den Fehler als Fehler als Online-Vollmachten Service Fehler. Der zweite Teil, bestehend aus drei Dezimalstellen bezeichnet den eindeutigen Identifikator des Fehlers aus dem Online-Vollmachten Service (siehe Online-Vollmachten Spezifikation).

    +

    {411}{xxxx}

    +
    +

    {411} ... MOA-ID Statuscode für Fehler aus dem Online-Vollmachten Service.

    +

    {xxx} .... Fehlercode des Online-Vollmachten Service.

    +
    +

    Zusätzlich zu den gemappten Fehlern aus dem Online-Vollmachen Service werden zusätzliche weitere Fehlercodes definiert.

    + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    41000Das Online-Vollmachten Service ist nicht erreichbar
    41001Allgemeiner Fehler bei der Kommunikation mit dem Online-Vollmachten Service
    +
    1.3.2.3 SZR-Gateway (42xxx)
    + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    4200Das SZR-Gateway Service ist nicht erreichbar
    4201Die Antragung in das SZR ist fehlgeschlagen
    +
    1.3.2.4 MOA SP/SS(43xxx)
    + + + + + + + + + +
    StatuscodeBeschreibung
    4300Fehler beim Aufruf von MOA SP/SS
    +
    1.3.2.5 Interfederation (44xx)
    + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    4400Fehler beim Generieren der Anmeldedaten
    4401Die Verwendung des angeforderten federated IDP ist nicht erlaubt
    +
    1.3.2.6 Attributprovider (45xx)
    + + + + + + + + + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    4500Der Zugriff auf einen Attributprovider ist nicht erlaubt
    4501Die Requestgenerierung für den Zugriff auf den Attributprovider schlug fehl
    4502Die Response vom Attributeprovider ist ungültig oder nicht errlaubt
    4503Die Response vom Attributeprovider beinhaltet einen Fehlercode
    +

    1.3.3 Statuscodes 6xxxx

    +

    Alles Statuscodes beginnend mit der Zahl sechs beschreiben protokollspezifische Fehler die nicht durch das jeweilige Authentifizierungsprotokoll abgebildet werden.

    +
    1.3.3.1 Allgemein (61xxx)
    + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    6000Das Authentifizierungsprotokoll wurde nicht erkannt oder wird nicht unterstützt
    6001Der STORK Request wurde nicht erkannt oder wird nicht unterstützt
    +
    1.3.3.4 SAML 1(63xxx)
    + + + + + + + + + +
    StatuscodeBeschreibung
    6300Fehlerhaftes SAML Artifact Format
    +

    1.3.4 Statuscodes 9xxxx

    +

    Alles Statuscodes beginnend mit der Zahl neun beschreiben interne Serverfehler.

    +
    1.3.4.1 Konfigurationsfehler (90xxx)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    9000Fehlerhaftes BKU-Selection Template
    9001Fehlerhaftes Send-Assertion Template
    9002Fehlerhaftes SecurityLayer Template.
    9003Fehlerhafte STORK VIDP Konfiguration
    9004Fehlerhafte STORK Konfiguration
    9005Fehlerhafte OpenID Connect Konfiguration
    9006Es sind keine Vollmachtsprofile konfiguriert.
    9007Der SZR-Gateway Client konnte nicht initialisiert werden.
    9008Fehler beim Verarbeiten eines Konfigurationsparameters.
    9099Allgemeiner Konfigurationsfehler
    +
    1.3.4.2 Interne Fehler (91xxx)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatuscodeBeschreibung
    9100Fehler beim Einlesen einer externen Ressource.
    9101Datenbankzugriffsfehler
    9102Fehler beim Erzeugen einer internen Datenstruktur
    9103Fehler bei der Verarbeitung eines Templates
    9104Fehler bei der Auswahl oder Initialisierung des gewünschten Anmeldeprozesses
    9105Fehler bei der Fortführung des Anmeldeprozesses
    9199Allgemeiner interner Fehler
    +

     

    +

    3 SAML 1

    +

    SAML 1 wird durch MOA-ID-Auth 2.0 auch weiterhin, aus Gründen der Abwärtskompatibilität, als Authentifizierungsprotokoll unterstützt. Es wird jedoch der Umstieg auf ein aktuelles Authentifizierungsprotokoll wie PVP 2.1 oder OpenID Connect empfohlen.

    +

    Die nachfolgenden Abschnitte beschreiben den Anmeldevorgang unter Verwendung von SAML1 wobei die Funktionalität, wie sie aus MOA-ID <= 1.5.1 bekannt ist, auch weiterhin unterstützt wird (Bürgerkartenauswahl auf Seiten des Service Provider). Zusätzlich steht für SAML 1 jedoch auch die Funktionalität der automatischen Generierung der Bürgerkartenauswahl durch das Modul MOA-ID-Auth zur Verfügung.

    +

    3.1 Ablauf einer Anmeldung mittels SAML 1

    +

    Die nachfolgende Abbildung zeigt das Sequenzdiagramm eines Anmeldevorgangs mittels SAML 1 und des Modules MOA-ID-Auth als Identity Provider. Hierbei wird die aus MOA-ID 1.5.1 bekannte Variante der Bürgerkartenauswahl beim Service Provider verwenden. Aus Gründen der Übersichtlichkeit wurden die Teile welche die Kommunikation mit der Bürgerkartenumgebung oder die Vollmachten-Auswahl betreffen bewusst nicht berücksichtigt.

    +

    Sequenzdiagramm für SAML 1

    +
      +
    1. Der Benutzer verbindet sich zu einem Web-Portal (Service Provider) über das die Online-Applikation erreichbar ist.
      2. +
    2. Der Service Provider antwortet mit einer öffentlichen Portalseite welche einen Login Bereich mit Bürgerkartenauswahl beinhaltet.
      3. +
    3. Nach Auswahl der gewünschten Authentifizierungsmethode (Bürgerkarte oder Handy-Signatur) wird der Anmeldevorgang ausgelöst und der StartAuthentication Request wird an das Modul MOA-ID-Auth gesendet.
      4. +
    4. MOA-ID-Auth validiert den StartAuthentication Request. Ist die Validierung erfolgreich wird der Anmeldevorgang vorgesetzt.
      5. +
    5. Die Benutzerin oder der Benutzer wird zur gewählten Bürgerkartenumgebung weitergeleitet. +
        +
      1. Die Benutzerin oder der Benutzer Authentifiziert sich mit der gewählten Methode.
        2. +
      +
      6. +
    6. War die Authentifizierung der Benutzerin oder des Benutzers erfolgreich generiert MOA-ID-Auth die Assertion mit den Anmeldedaten des Benutzers.
      7. +
    7. MOA-ID-Auth senden das SAML 1 Artifact, welches zur Abholung der Assertion verwendet werden kann, über den Browser an den Service Provider.
      8. +
    8. Der Service Provider stellt einen GetAuthenticationData Request an MOA-ID-Auth unter Verwendung des zuvor übermittelten Artifacts.
      9. +
    9. MOA-ID-Auth validiert das Artifact. Ist die Validierung erfolgreich antwortet MOA-ID-Auth mit der SAML 1 Assertion, welche die Anmeldedaten beinhaltet.
      10. +
    10. Der Service Provider verarbeitet die Assertion und danach ist der Benutzer an der Online-Applikation angemeldet.
      11. +
    +

    3.2 Zugangspunkte

    +

    Zur Verwendung von SAML 1 stellt das Modul MOA-ID-Auth zwei Zugangspunkte zur Kommunikation mit der Online-Applikation (Service Provider) zur Verfügung. Diese Zugangspunkte bezeichnen die URLs unter welchen das Modul MOA-ID-Auth die entsprechenden SAML1 Nachrichten entgegennimmt.

    +
      +
    • StartAuthentication Request: https://<host>:<port>/moa-id-auth/StartAuthentication
      + Unter dieser URL wird der Authn Request entgegengenommen. Dieser Request startet den Authentifizierungsvorgang an der Online-Applikation.
      • +
    • GetAuthenticationData: http(s)://<host>:<port>/moa-id-auth/services/GetAuthenticationData
      + Unter dieser URL können nach erfolgreicher Authentifizierung die eigentlichen Authentifizierungsdaten am Modul MOA-ID-Auth abgeholt werden.
      • +
    +

    3.3 StartAuthentication Request

    +

    MOA-ID-Auth wird immer durch eine andere (verweisende) Webseite aufgerufen. Diese Webseite kann z.B. Teil eines Portals sein. Der Aufruf erfolgt durch einen Verweis der Form, wobei die Parameter sowohl als http GET als auch als http POST an MOA-ID-Auth übergeben werden können.

    +
    <a href="https://<moa-id-server-und-pfad>/StartAuthentication
+  ?Target=<geschäftsbereich>  
+  &OA=<oa-url>
+	&bkuURI=<bku-url>
+  &Template=<template-url>
+	&useMandate=false
+  &CCC=<ccc>">
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeispielwertBeschreibung
    <moa-id-server-und-pfad>https://demo.egiz.gv.at/
    + demoportal_moaid-2.0/

    Server und Pfad, wo MOA-ID-AUTH installiert ist

    Target=<geschäftsbereich>BF

    Angabe, für welches Verfahren (öffentlicher Bereich) der Benutzer authentisiert werden soll. Dieser Parameter wird jedoch durch den in entsprechenden Parameter in der online-applikationsspezifischen Konfiguration überschrieben.

    OA=<oa-url>https://demo.egiz.gv.at/demoportal-demologin/securearea.actionWebseite, auf die der Browser nach erfolgter Authentisierung weitergeleitet werden soll
    bkuURI=<bku-url>https://127.0.0.1:3496/https-security-layer-request

    URL auf die Bürgerkartenumgebung, welche für die Authentifizierung der Benutzerin oder des Benutzers verwendet werden soll.

    +

    Hinweis: Wird dieser Parameter nicht übertragen, antwortet das Modul MOA-ID-Auth mit einem bei MOA-ID-Auth hinterlegten Bürgerkartentemplate.

    Template=<template-url>https://demo.egiz.gv.at/moa-id-auth/template_onlineBKU.htmlOptional: URL auf die HTML Vorlage für den Security-Layer Request, welcher für die Kommunikation mit der Bürgerkartenumgebung verwendet wird. Die URL muss in der online-applikationsspezifischen Konfiguration von MOA-ID-Auth hinterlegt werden (siehe Parameter SecurityLayerTemplates).
    + Ist dieser Parameter nicht vorhanden, verwendet MOA-ID-Auth das für diese Online-Applikation hinterlegten Security-Layer Template (siehe Parameter SecurityLayerTemplates).
    useMandate=<true/false>true / falseOptional: Gibt an ob eine Anmeldung im Online-Vollmachten-Modus durchgeführt werden soll (=true) oder nicht (=false);
    CCC=<ccc>BE, SI, Optional: Gibt an ob die Anmeldung mittels STORK im angegebenen Land erfolgen soll. Die Angabe erfolgt mit dem Ländercode (Bsp: PT, LU, ES, ...) des jeweiligen Landes.
    sourceID=<xxxxxxx>abcdef141245Optional: Die sourceID fließt in die Generierung des SAML1 Artifacts, welches an den Service Provider returniert wird, ein. Detailinformationen zur Generierung des SAML1 Artifacts und zur sourceID finden Sie in der SAML1 Spezifikation.
    +

    3.4 GetAuthenticationData Request

    +

    Nach erfolgter Authentisierung stehen in MOA-ID-AUTH Anmeldedaten zum Abholen bereit, und MOA-ID-AUTH veranlasst einen Redirect zur Online-Applikation (OA).
    +
    +In diesem Redirect werden der Geschäftsbereich und ein SAML-Artifact als Parameter übergeben.

    +
    <a href="https://<oa-url>?Target=<geschäftsbereich>&SAMLArtifact=<saml-artifact>">
    + + + + + + + + + + + + + + + +
    oa-url>URL, der beim Aufruf von MOA-ID-AUTH als Parameter "OA" übergeben wurde
    Target=<geschäftsbereich>Parameter, der beim Aufruf von MOA-ID-AUTH übergeben wurde
    SAMLArtifact=<saml-artifact>SAML-Artifact, das von MOA-ID-AUTH zu den Anmeldedaten erstellt wurde. Mithilfe dieses SAML-Artifacts kann die OA die Anmeldedaten von MOA-ID-AUTH abholen.
    +

     

    +

    Der Service Provider kann anschließend die Assertion, welche die Anmeldedaten oder eine Fehlermeldung beinhaltet, unter Verwendung des SAMLArtifact, am Modul MOA-ID-Auth abholen.

    +

    Das MOA-ID-AUTH Web Service wird über einen <samlp:Request> aufgerufen. Der <samlp:Request> enthält in einem <samlp:AssertionArtifact> das von MOA-ID-AUTH übergebene SAML-Artifact.
    +
    +MOA-ID-AUTH liefert als Antwort einen <samlp:Response>. Die Anmeldedaten sind im <samlp:Response> in Form einer <saml:Assertion> enthalten.
    +Sollte während des Anmeldevorgangs ein Fehler aufgetreten sein, antwortet das Modul MOA-ID-Auth mit einer Fehlerbeschreibung in der SAML Response. Das Element /samlp:Response/samlp:Status/samlp:StatusCode/ beinhaltet auf jeden Fall einen allgemeinen Fehlercode laut SAML1 Spezifikation. Zusätzlich kann das Element /samlp:Response/samlp:Status/samlp:StatusCode/samlp:StatusCode/einen MOA-ID-Auth Fehlercode (siehe Kapitel 1.3) beinhalten. Außerdem erfolgt eine kurze textuelle Fehlerbeschreibung im Element /samlp:Response/samlp:Status/samlp:StatusMessage/.

    + +

    Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.4 beschrieben.

    +

    A Referenzierte Spezifikation

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SpezifikationLink

    Security Layer Spezifikation V1.2.0

    		http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/
    Online-Vollmachten Spezifikation http://reference.e-government.gv.at/AG-II-Architektur-mis-1-1-0.2890.0.html
    PVP 2.1 S-Profil Spezifikationhttp://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf
    OpenID Connecthttp://openid.net/connect/
    STORK 2@TODO Link
    Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf
    Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf
    +
    + + diff --git a/id/server/doc/handbook_v40/protocol/pvp21_sequence.png b/id/server/doc/handbook_v40/protocol/pvp21_sequence.png new file mode 100644 index 000000000..c915531cc Binary files /dev/null and b/id/server/doc/handbook_v40/protocol/pvp21_sequence.png differ diff --git a/id/server/doc/handbook_v40/protocol/saml1_sequence.png b/id/server/doc/handbook_v40/protocol/saml1_sequence.png new file mode 100644 index 000000000..e863d74c1 Binary files /dev/null and b/id/server/doc/handbook_v40/protocol/saml1_sequence.png differ diff --git a/id/server/doc/handbook_v40/protocol/serviceprovider_metadata.xml b/id/server/doc/handbook_v40/protocol/serviceprovider_metadata.xml new file mode 100644 index 000000000..15e26469c --- /dev/null +++ b/id/server/doc/handbook_v40/protocol/serviceprovider_metadata.xml @@ -0,0 +1,95 @@ + + + + + + + + + + + + + xLFVU7fH3+IC84vAuSZTP7+oeGk= + + + d1GD51DilpbwQdL9BONrhQS9zeydpWw8r/DKp/k5nLDQ6Tpw+OQgqYWvsMcnMgrltJa/4Q326fEf6HdFbLfrHSij8Nfx8i2idJ9JUwpj1R2GE0eo+8NXvJ/1H9Nf0pPjZ35MXQ9bC2fN/HnPalRaJSd9gCk/hW/KtB0r4qODkppz0hHplIKs7kqDnzd7ZT7golGI801N6DwzJ3jW8U26OOhzXtCbTsDdZE5gvA34kH5EDaa9RMx2JIPqBjzvDAE7oylKg2VcQdpJ1xLEi3zOF2kvgTLi6+CLHbQDc1JKcWJ10FC9yATT7poHJOgjoZ8Vt5QZJ12PKJ1NnopwcsvJ4g== + + + + + + + MIIDhTCCAm2gAwIBAgIEUflpdjANBgkqhkiG9w0BAQsFADBzMRAwDgYDVQQGEwdVbmtub3duMRAw +DgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdVbmtub3duMRAwDgYD +VQQLEwdVbmtub3duMRcwFQYDVQQDEw5QVlAgU2FtcGxlIElEUDAeFw0xMzA1MDIwODE5MDlaFw0x +MzA3MzEwODE5MDlaMHMxEDAOBgNVBAYTB1Vua25vd24xEDAOBgNVBAgTB1Vua25vd24xEDAOBgNV +BAcTB1Vua25vd24xEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xFzAVBgNVBAMT +DlBWUCBTYW1wbGUgSURQMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWrWy07+hO2V +oMeOHpizN3qU2cL2e3EkzAkowmG+OpsR3UpI0dvolRuzaxDPUeANfE913KPempsT3cOKGS5IIBmx +PgZM1H7EcEPVS2PYimMr1HztBMJMGAdFVFeVFsgdYP4cbwPUs03/E6kVmN7/C+vMyRPMD7i83YL8 +/IHChymZ5aJTsRXUpM0TjQQPBQbnnHVWzjcUJ9z9KataS/KpUUM8iSWk73u/gWOs3vbQLoro80xj +LsSdXyJ9dVTCTwCpdP5UJPlsNLg1F7AU+OHwem76rezI0JJZhHUMg6v1xWzh8XycI6CizpD6RmkM +XfICbFD8TR5zcNBieH/yNQeAEwIDAQABoyEwHzAdBgNVHQ4EFgQUoLaHuWuxRrEh37oIQ0GzfDpy +h4MwDQYJKoZIhvcNAQELBQADggEBAAaAJVSji/OMCUZtSSIYM37go1+JLSamSkkftbkKmMWGBeKj +i9ndilpFY/Fbslt+lUueOyd5VawWPYorQBksyJH7glmQexMzEbwqPR8t+++Dq5+mj/XjXrYHlPej +FvCMy5kElxXczIQZmsutGtamreyAMpFMa3T2pU5tuVNwSbe754dOztaX6E92IGZtApKIHm/uLU75 +JQkTWhP9I3DaNX593VYPkeAoYxzaX1ElE2HFs4ELRzMXa0joTaGLyZ6LdLcK1bR3um9OywHWeiab +xtSAML1SoKfTcmzWCpb0yFhfOUKXyw+SikBAkiQruMK8PcboY9VFrKUSzKHBvnDC4U4= + + + + + + + MIIELTCCAxWgAwIBAgIJALF/kMqjWCxQMA0GCSqGSIb3DQEBCwUAMGwxCzAJBgNVBAYTAkFUMRMw +EQYDVQQIEwpTb21lLVN0YXRlMQ0wCwYDVQQHEwRHcmF6MQ0wCwYDVQQKEwRFR0laMSowKAYDVQQD +EyFNT0EtSUQtQ29uZmlndXJhdGlvbiAoRW5jcnlwdGlvbikwHhcNMTQwMTIxMDkzMDIzWhcNMTUw +MTIxMDkzMDIzWjBsMQswCQYDVQQGEwJBVDETMBEGA1UECBMKU29tZS1TdGF0ZTENMAsGA1UEBxME +R3JhejENMAsGA1UEChMERUdJWjEqMCgGA1UEAxMhTU9BLUlELUNvbmZpZ3VyYXRpb24gKEVuY3J5 +cHRpb24pMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr+5eXUViI2d/KLqfej29BNeD +DiDzhWlpAViPconGsEDHrXFNeSd3DTuJKH6x06wrpGfvtTh91ThId0R0hthS82aaKTlW1SgX/Rps +5VlmiNXQty8/UrrnqAsIO65jbsy41EXTDVrnDbg5WmK2xsowk7d4jUE4cdk3VKu07Kzg9ZiQHz8V +WMmGGPIXVs87+wgjq68tvo3+Nk5fcKPyV4ff2oc5/muxjavGdAIDJV2E/dDHwM3fbNFXk5OAse2V +8/vmHCm0bzVOP+V5vNxp1r8myZ914WYFt0WJL4/oyyrerGK6gqGdkLcGfMutaJvBxV+hNIMGLWMc +6LjCWVARIXvHyQIDAQABo4HRMIHOMB0GA1UdDgQWBBR9aJK1JouIYwcn2ycQUsPv4Q8BaDCBngYD +VR0jBIGWMIGTgBR9aJK1JouIYwcn2ycQUsPv4Q8BaKFwpG4wbDELMAkGA1UEBhMCQVQxEzARBgNV +BAgTClNvbWUtU3RhdGUxDTALBgNVBAcTBEdyYXoxDTALBgNVBAoTBEVHSVoxKjAoBgNVBAMTIU1P +QS1JRC1Db25maWd1cmF0aW9uIChFbmNyeXB0aW9uKYIJALF/kMqjWCxQMAwGA1UdEwQFMAMBAf8w +DQYJKoZIhvcNAQELBQADggEBAFSMmGNTAhDfoadFz0SrMDLjrPGIGjanbijLTOEURZYJiB4sQxa8 +3H6FNy1zvfzmPnrdbFr15w/6KgF9YP/0/JMUalrhm1JKWBY4TqJcG2BumAUcLSdsHOsezRi5E14s +WF2sNRa8C0LkfMfCW/wBCLXPn68XhQW7MuGgpEVrRenXQ3hwSykNiKq4vfn8tg+1hKwlrM3pbQQw +7YmXUm9TnHmkvJfZJEgSiFiLUjc1HxUFNl23PGjKJ1GxDerS7pBHG23KkVZTacuKM/MjVfFeFQJ4 +8JcRJUO0HuM6O1v/1sumtq/4wrKYo5I5LZPRuEKGNFme9hi/1BQT9bK9roZlxH0= + + + + urn:oasis:names:tc:SAML:2.0:nameid-format:persistent + urn:oasis:names:tc:SAML:2.0:nameid-format:transient + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + Default Service + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/protocol/sso_sequence.png b/id/server/doc/handbook_v40/protocol/sso_sequence.png new file mode 100644 index 000000000..19e50100d Binary files /dev/null and b/id/server/doc/handbook_v40/protocol/sso_sequence.png differ diff --git a/id/server/doc/handbook_v40/spec/MOA ID 1.x.wsdl b/id/server/doc/handbook_v40/spec/MOA ID 1.x.wsdl new file mode 100644 index 000000000..d83556540 --- /dev/null +++ b/id/server/doc/handbook_v40/spec/MOA ID 1.x.wsdl @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/spec/MOA-SPSS-1.3.pdf b/id/server/doc/handbook_v40/spec/MOA-SPSS-1.3.pdf new file mode 100644 index 000000000..6709a4081 Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA-SPSS-1.3.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.pdf b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.pdf new file mode 100644 index 000000000..1e65beca9 Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.wsdl b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.wsdl new file mode 100644 index 000000000..4f9deee38 --- /dev/null +++ b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.wsdl @@ -0,0 +1,128 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.xsd b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.xsd new file mode 100644 index 000000000..73d145ecf --- /dev/null +++ b/id/server/doc/handbook_v40/spec/MOA-SPSS-2.0.0.xsd @@ -0,0 +1,572 @@ + + + + + + + + + + + + + + + + + + + + Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements + + + + + + + + + + + + + + + + + + + + + + Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage + + + + Resultat, falls die Signaturerstellung erfolgreich war + + + + + + + + + + + + + + + + + + + + Ermöglichung der Stapelsignatur durch wiederholte Angabe dieses Elements + + + + + + + + + + + + + + + + + + + Auswahl: Entweder explizite Angabe des Signaturorts sowie ggf. sinnvoller Supplements im Zshg. mit der Signaturumgebung, oder Verweis auf ein benanntes Profil + + + + + + + + + + + + + + + + + + Kardinalität 1..oo erlaubt die Antwort auf eine Stapelsignatur-Anfrage + + + + Resultat, falls die Signaturerstellung erfolgreich war + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert + + + + + + + + + + + only ds:X509Data and RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any;publicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pro dsig:Reference-Element in der zu überprüfenden XML-Signatur muss hier ein ReferenceInfo-Element erscheinen. Die Reihenfolge der einzelnen ReferenceInfo Elemente entspricht jener der dsig:Reference Elemente in der XML-Signatur. + + + + + + + + + + mit diesem Profil wird eine Menge von vertrauenswürdigen Wurzelzertifikaten spezifiziert + + + + + + + + + + + only ds:X509Data and ds:RetrievalMethod is supported; QualifiedCertificate is included as X509Data/any; PublicAuthority is included as X509Data/any; SecureSignatureCreationDevice is included as X509Data/any, IssuingCountry is included as X509Data/any + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Auswahl: Entweder explizite Angabe EINER Transformationskette inklusive ggf. sinnvoller Supplements oder Verweis auf ein benanntes Profil + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Resultat, falls die Signaturerstellung gescheitert ist + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Ein oder mehrere Transformationswege können von der Applikation an MOA mitgeteilt werden. Die zu prüfende Signatur hat zumindest einem dieser Transformationswege zu entsprechen. Die Angabe kann explizit oder als Profilbezeichner erfolgen. + + + + + Profilbezeichner für einen Transformationsweg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Die Angabe des Transformationsparameters (explizit oder als Hashwert) kann unterlassen werden, wenn die Applikation von der Unveränderlichkeit des Inhalts der in "Transformationsparamter", Attribut "URI" angegebenen URI ausgehen kann. + + + + Der Transformationsparameter explizit angegeben. + + + + + Der Hashwert des Transformationsparameters. + + + + + + + + + + + + + + + + + + + + + + Explizite Angabe des Transformationswegs + + + + + + + Alle impliziten Transformationsparameter, die zum Durchlaufen der oben angeführten Transformationskette bekannt sein müssen, müssen hier angeführt werden. Das Attribut "URI" bezeichnet den Transformationsparameter in exakt jener Weise, wie er in der zu überprüfenden Signatur gebraucht wird. + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/spec/MOA_ID_1.2_20040315.pdf b/id/server/doc/handbook_v40/spec/MOA_ID_1.2_20040315.pdf new file mode 100644 index 000000000..0c89c2730 Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA_ID_1.2_20040315.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA_ID_1.3_20060315.pdf b/id/server/doc/handbook_v40/spec/MOA_ID_1.3_20060315.pdf new file mode 100644 index 000000000..c9b0d160c Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA_ID_1.3_20060315.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA_ID_1.4_20070802.pdf b/id/server/doc/handbook_v40/spec/MOA_ID_1.4_20070802.pdf new file mode 100644 index 000000000..a3a2f1177 Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA_ID_1.4_20070802.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA_ID_1.4_Anhang.pdf b/id/server/doc/handbook_v40/spec/MOA_ID_1.4_Anhang.pdf new file mode 100644 index 000000000..0c923666f Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA_ID_1.4_Anhang.pdf differ diff --git a/id/server/doc/handbook_v40/spec/MOA_ID_1.5_Anhang.pdf b/id/server/doc/handbook_v40/spec/MOA_ID_1.5_Anhang.pdf new file mode 100644 index 000000000..ed2743d3c Binary files /dev/null and b/id/server/doc/handbook_v40/spec/MOA_ID_1.5_Anhang.pdf differ diff --git a/id/server/doc/handbook_v40/spec/OID-1-0-3.pdf b/id/server/doc/handbook_v40/spec/OID-1-0-3.pdf new file mode 100644 index 000000000..4beab3e41 Binary files /dev/null and b/id/server/doc/handbook_v40/spec/OID-1-0-3.pdf differ diff --git a/id/server/doc/handbook_v40/spec/cs-sstc-schema-assertion-01.xsd b/id/server/doc/handbook_v40/spec/cs-sstc-schema-assertion-01.xsd new file mode 100644 index 000000000..d41f3e817 --- /dev/null +++ b/id/server/doc/handbook_v40/spec/cs-sstc-schema-assertion-01.xsd @@ -0,0 +1,194 @@ + + + + + + + Document identifier: cs-sstc-schema-assertion-01 + Location: http://www.oasis-open.org/committees/security/docs/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/id/server/doc/handbook_v40/spec/cs-sstc-schema-protocol-01.xsd b/id/server/doc/handbook_v40/spec/cs-sstc-schema-protocol-01.xsd new file mode 100644 index 000000000..d939fa732 --- /dev/null +++ b/id/server/doc/handbook_v40/spec/cs-sstc-schema-protocol-01.xsd @@ -0,0 +1,127 @@ + + + + + + + + Document identifier: cs-sstc-schema-protocol-01 + Location: http://www.oasis-open.org/committees/security/docs/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3 From f1fe1293fb6632136d1cfb78181a00fb0c60544a Mon Sep 17 00:00:00 2001 From: Thomas Lenz Date: Wed, 19 Feb 2020 14:59:12 +0100 Subject: add new readme_4.1.1 update history.txt and config.html --- id/server/doc/handbook/config/config.html | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'id/server/doc') diff --git a/id/server/doc/handbook/config/config.html b/id/server/doc/handbook/config/config.html index 0b9f7e614..a67de86d0 100644 --- a/id/server/doc/handbook/config/config.html +++ b/id/server/doc/handbook/config/config.html @@ -1670,12 +1670,19 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der Beschreibung - E-ID aktivieren + E-ID Proxy-Mode aktivieren

     

      X Aktiviert die Weiterleitung an den E-ID für diese Online Applikation. + + E-ID Demo-Mode aktivieren +   +   + X + Aktiviert das angepasst E-ID Attributset für diese Online Applikation, es erfolgt jedoch KEINE Weiterleitung an den E-ID. +

     

    3.2.3 BKU Konfiguration

    -- cgit v1.2.3