From 4be68fb9fecc579e2dae08be0af0b527d69387d8 Mon Sep 17 00:00:00 2001 From: Christian Maierhofer Date: Wed, 7 Jan 2015 13:43:17 +0100 Subject: new format(css) for the handbook --- .../doc/handbook/application/application.html | 73 +++++++++++----------- 1 file changed, 37 insertions(+), 36 deletions(-) (limited to 'id/server/doc/handbook/application/application.html') diff --git a/id/server/doc/handbook/application/application.html b/id/server/doc/handbook/application/application.html index 8dbae87ed..3558a6e09 100644 --- a/id/server/doc/handbook/application/application.html +++ b/id/server/doc/handbook/application/application.html @@ -2,23 +2,23 @@ + MOA-ID - Anwendungen - - - - - - -
Logo BKADokumentationLogo EGIZ
-
-

MOA-ID (Identifikation)

-

Anwendungen

-
-

Inhalt

-
    +
    +
    + +

    MOA-ID-AUTH

    +
    +
    +
    +
    +

    Anwendungen

    + +

    Inhalt

    +
    1. Allgemeines
    2. Integration in bestehende Online-Applikationen
        @@ -44,36 +44,36 @@
    -
    -

    1 Allgemeines

    + +

    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

    +

    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

    +

    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

    +
    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

    +
    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

    +

    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

    +
    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

    +
    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

    +

    3 Demo Applikationen

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

    -

    3.1 PVP 2.1 Demo

    +

    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

    +

    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.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.
      @@ -89,7 +89,7 @@
    -

    3.1.1.2 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.
    @@ -99,15 +99,15 @@ 
     https://<host>:<port>/moa-id-oa/
    -

    3.1.2 Konfiguration Demo Applikation

    +

    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.

    - +
    - - - + + + @@ -200,9 +200,9 @@ http://<host>:<port>/moa-id-oa/servlet/metadata
     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

    +

    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

    +

    3.1.4 Anwendung

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

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

    bzw.

    @@ -214,5 +214,6 @@ https://<host>:<port>/moa-id-oa/

    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.

     

    + -- cgit v1.2.3
    NameBeispielwertBeschreibungNameBeispielwertBeschreibung
    general.publicURLContext