From 7389f9756947e4b19dee95d831456a574c3ff405 Mon Sep 17 00:00:00 2001 From: rudolf Date: Mon, 28 Jun 2004 20:41:11 +0000 Subject: documentation enhanced (RSCH) git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@141 d688527b-c9ab-4aba-bd8d-4036d912da1d --- id.server/doc/OID-1-0-3.pdf | Bin 0 -> 347041 bytes id.server/doc/moa_id/faqs.htm | 2 +- id.server/doc/moa_id/id-admin.htm | 26 +++----- id.server/doc/moa_id/id-admin_1.htm | 29 ++++----- id.server/doc/moa_id/id-admin_2.htm | 6 +- id.server/doc/moa_id/id-admin_3.htm | 2 +- id.server/doc/moa_id/id-anwendung_1.htm | 110 +++++++++++++++++++------------- id.server/doc/moa_id/id-anwendung_2.htm | 6 +- id.server/doc/moa_id/moa.htm | 9 +-- 9 files changed, 101 insertions(+), 89 deletions(-) create mode 100644 id.server/doc/OID-1-0-3.pdf diff --git a/id.server/doc/OID-1-0-3.pdf b/id.server/doc/OID-1-0-3.pdf new file mode 100644 index 000000000..4beab3e41 Binary files /dev/null and b/id.server/doc/OID-1-0-3.pdf differ diff --git a/id.server/doc/moa_id/faqs.htm b/id.server/doc/moa_id/faqs.htm index bad7a90e3..effc21637 100644 --- a/id.server/doc/moa_id/faqs.htm +++ b/id.server/doc/moa_id/faqs.htm @@ -184,7 +184,7 @@ MOA ist eine Entwicklung des Bundesrechenzentrums BRZ in Zusammenarbeit mit A-Tr org.apache.commons.logging.LogConfigurationException
: Class org.apache.commons.logging.impl.Jdk14Logger does not implement Log

-

A: $CATALINA_HOME\server\lib\tomcat-util.jar muss gegen eine +

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\ diff --git a/id.server/doc/moa_id/id-admin.htm b/id.server/doc/moa_id/id-admin.htm index fb545d560..46290b567 100644 --- a/id.server/doc/moa_id/id-admin.htm +++ b/id.server/doc/moa_id/id-admin.htm @@ -70,7 +70,7 @@ Projekt moa  -

MOA ID-Administration v.1.1
+
MOA ID-Administration v.1.2

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. @@ -244,20 +244,16 @@ Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapp Tomcat -

4.1.18 - bzw.
- 4.1.27 - + Patch (*)

+

4.1.30

MOA-ID-AUTH - 1.1 + 1.2.0 MOA-ID-PROXY - 1.1  - + 1.2.0 MOA-SPSS @@ -265,9 +261,9 @@ Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapp Apache Webserver - 1.3.23 + 1.3.X bzw.
- 2.0.45 + 2.0.X Microsoft Internet Information Server @@ -287,7 +283,7 @@ Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapp Jakarta Log4j - 1.2.7  + 1.2.8  @@ -298,12 +294,6 @@ Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapp
- (*) Aufgrund eines geringfügigen Mangels in Tomcat 4.1.27 - muss eine gepatchte Version von 'tomcat-util.jar' verwendet - werden. Diese gepatchte Version ist in der MOA-ID Distribution - enthalten.
- Details: Tomcat-Bugzilla - Bug id=22701.

(**) passend zur Version des Apache Webservers
@@ -316,7 +306,7 @@ Die Versionsangaben beziehen sich auf die Versionen, mit denen die MOA ID Webapp
-
© 2003
+
© 2004

diff --git a/id.server/doc/moa_id/id-admin_1.htm b/id.server/doc/moa_id/id-admin_1.htm index 73d5e3ef9..b7f197380 100644 --- a/id.server/doc/moa_id/id-admin_1.htm +++ b/id.server/doc/moa_id/id-admin_1.htm @@ -81,7 +81,7 @@ Projekt moa  -

Basis-Installation v.1.1

+

Basis-Installation v.1.2

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.
@@ -115,7 +115,7 @@ Unterschiede sind in der Installationsanweisung angeführt. bzw. $MOA_ID_INST_PROXY bezeichnet.

Installation der IAIK JCE, des IAIK LDAP Protocol Handlers und - von JSSE (JDK 1.3.1)
+ von JSSE (falls JDK 1.3.1 verwendet wird)
Da Java in der Version 1.3.1 ohne Unterstützung für Kryptographie, LDAP und SSL ausgeliefert wird, müssen diese Funktionalitäten nachträglich installiert werden. Es stehen hierfür zwei @@ -152,7 +152,7 @@ Unterschiede sind in der Installationsanweisung angeführt. wobei ';' durch ':' zu ersetzen ist.

Installation der IAIK JCE und des IAIK LDAP Protocol Handlers - (JDK 1.4.1 bzw. JDK 1.4.2)
+ (falls JDK 1.4.1 bzw. JDK 1.4.2 verwendet wird)
Die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext14 (oder $MOA_ID_INST_PROXY/ext14) müssen in das Verzeichnis $JAVA_HOME/jre/lib/ext kopiert werden. Anschließend steht eine Unterstützung für Kryptographie @@ -258,13 +258,14 @@ Um MOA-ID-AUTH in Tomcat für den Ablauf vorzubereiten, sind folgende Schrit
  • javax.net.ssl.trustStore=Name des Truststores für vertrauenswürdige SSL Client-Zertifikate (optional; nur, wenn SSL Client-Authentisierung durchgeführt werden - soll).
    • + 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 + 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). + $MOA_ID_INST_AUTH/tomcat/unix). Diese Skripte können sie nach $CATALINA_HOME kompieren und in Folge von dort starten nachdem die Variablen CATALINA_HOME sowie JAVA_HOME in den Skripten entsprechend den Pfaden der Installation gesetzt wurden.
    @@ -328,8 +329,7 @@ Um MOA-ID-PROXY in Tomcat für den Ablauf vorzubereiten, sind folgende Schri werden soll). Diese Java System-Properties werden Tomcat über die Umgebungsvariable - CATALINA_OPTS mitgeteilt (siehe Beispiele für Windows - und für Unix/Linux). + CATALINA_OPTS mitgeteilt (siehe Deployment von MOA-ID-AUTH).

    Beispiel-Skripts zum Setzen von CATALINA_OPTS und zum Starten @@ -482,8 +482,7 @@ Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fort 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 @@ -493,11 +492,11 @@ Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fort werden aus Effizienzgründen nur im Log-Level DEBUG angezeigt.

    -

    (*) Die gepatchte Version von tomcat-util.jar ist im - Verzeichnis $MOA_ID_INST_AUTH\tomcat\tomcat-util-4.1.27-patched\ - zu finden.

    +

    +

    +

    - +

    @@ -507,7 +506,7 @@ Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fort
    -
    © 2003
    +
    © 2004

    diff --git a/id.server/doc/moa_id/id-admin_2.htm b/id.server/doc/moa_id/id-admin_2.htm index 79b253fa5..dfe488830 100644 --- a/id.server/doc/moa_id/id-admin_2.htm +++ b/id.server/doc/moa_id/id-admin_2.htm @@ -216,7 +216,7 @@ Projekt moa  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 (anders als im Beispiel) UTF-8 sein.
    + Datei muss UTF-8 sein.

    Beispiel für eine TransformsInfo-Datei

    @@ -663,7 +663,7 @@ Werte annehmen. Gültige Werte von MOAAuthDataType sind:
  • MOABPK - die bereichsspezifische Personenkennzeichnung des Benutzers, wie von der Authentisierungskomponente berechnet
  • MOAPublicAuthority - wird durch true ersetzt, falls der Benutzer mit einem Zertifikat signierte, -welches eine Behördenerweiterung beinhaltet. Andernfalls wird false gesetzt +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 @@ -819,7 +819,7 @@ Im Falle einer fehlerhaften neuen Konfiguration wird die ursprüngliche Konf
    -
    © 2003
    +
    © 2004

    diff --git a/id.server/doc/moa_id/id-admin_3.htm b/id.server/doc/moa_id/id-admin_3.htm index 3a0bce74c..14c8aecce 100644 --- a/id.server/doc/moa_id/id-admin_3.htm +++ b/id.server/doc/moa_id/id-admin_3.htm @@ -194,7 +194,7 @@ Um das Logging in die Datenbank Log4j bekannt zu machen, muss die Log4j-Konfigur
    -
    © 2003
    +
    © 2004

    diff --git a/id.server/doc/moa_id/id-anwendung_1.htm b/id.server/doc/moa_id/id-anwendung_1.htm index 81c4ecc9e..c7f5f0e80 100644 --- a/id.server/doc/moa_id/id-anwendung_1.htm +++ b/id.server/doc/moa_id/id-anwendung_1.htm @@ -67,8 +67,6 @@ Projekt moa  Zurück

    - -

    Aufruf von MOA-ID-AUTH

    MOA-ID-AUTH wird immer durch eine andere (verweisende) Webseite aufgerufen. Diese Webseite kann z.B. Teil eines Portals sein. @@ -76,7 +74,6 @@ 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>">
    - @@ -96,39 +93,40 @@ StartAuthentication?Target=<gesch
    Template

    Ein Template für die Anmeldeseite von MOA-ID-AUTH kann aus folgender Grundstruktur aufgebaut werden:
    -
    -<form name="CustomizedForm" action="<BKU>" method="post">
- <input type="hidden"
-        name="XMLRequest"
-        value="<XMLRequest>"/>
- <input type="hidden"
-        name="DataURL"
-        value="<DataURL>"/>
- <input type="submit" value="Bürgerkarte lesen"/>
-</form>
-<form name="CustomizedInfoForm"
- action="<BKU>"
- method="post">
- <input type="hidden"
-        name="XMLRequest"
-        value="<CertInfoXMLRequest>"/>
- <input type="hidden"
-        name="DataURL"
-        value="<CertInfoDataURL>"/>
-Hier finden Sie weitere Informationen 
-zur Überprüfung der Zertifikate.<br/>
- <input type="submit" value="Weitere Info"/>
-</form>
-
    - -
    Innerhalb dieser <form>-Elemente können Texte, Beschriftungen und Styles modifiziert werden, +
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html>
    <head>
    <title>MOA ID - Identifizierter Zugang mit B&uuml;rgerkarte</title>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    </head>
    +

    <form name="CustomizedForm" action="<BKU>" method="post">
    +<div align="center">
    +<input type="hidden"
    +name="XMLRequest"
    +value="<XMLRequest>"/>
    +<input type="hidden"
    +name="DataURL"
    +value="<DataURL>"/>
    +<input type="submit" value="Anmeldung mit B&uuml;rgerkarte" name="submit"/>
    +</div>
    +</form>
    +<form name="CustomizedInfoForm"
    +action="<BKU>"
    +method="post">
    +<input type="hidden"
    +name="XMLRequest"
    +value="<CertInfoXMLRequest>"/>
    +<input type="hidden"
    +name="DataURL"
    +value="<CertInfoDataURL>"/>
    +

    +

    <input type="hidden" value="Weitere Info"/>
    +</form>

    </body>
    +</html>
    +

    +
    Innerhalb dieser <form>-Elemente können Texte, Beschriftungen und Styles modifiziert werden,
 und es können zusätzliche Elemente darin aufgenommen werden. 
 

    
 Die vorgegebene Grundstruktur ist aber in jedem Fall einzuhalten, und es müssen die speziellen
 Tags <BKU> (kommt 2x vor), <XMLRequest>, <DataURL>, <CertInfoXMLRequest> und <CertInfoDataURL>
 darin enthalten sein.
-
    -

    +

    BKU-Auswahl

    @@ -137,7 +135,6 @@ MOA-ID-AUTH bietet die Möglichkeit, die Bürgerkartenumgebung (BKU) aus SelectBKU?Target=<geschäftsbereich> &OA=<oa-url>&Template=<template-url> &BKUSelectionTemplate=<bku-template-url>"> -
    <moa-id-server-und-pfad>Server und Pfad, wo MOA-ID-AUTH installiert ist
    BKUSelectionTemplate= <bku-template-url> optional; HTML-Vorlage für der BKU-Auswahlseite von MOA-ID-AUTH. @@ -150,20 +147,43 @@ SelectBKU?Target=<gesch BKUSelectionTemplate

    Ein Template für die BKU-Auswahl von MOA-ID-AUTH kann aus folgender Grundstruktur aufgebaut werden: 
    -<form name="CustomizedForm" method="post" action="<StartAuth>">
- <BKUSelect>
- <input type="submit" value="Auswählen"/>
-</form>
-
    -
    Innerhalb dieser <form>-Elemente können Texte, Beschriftungen und Styles modifiziert werden, -und es können zusätzliche Elemente darin aufgenommen werden. -

    -Auch dabei ist die vorgegebene Grundstruktur einzuhalten, die speziellen Tags <StartAuth> und <BKUSelect> sind verpflichtend. -
    -

    +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html>
    <head>
    <title>MOA ID - Auswahl der B&uuuml;rgerkartenumgebung</title> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    </head>

    <form name="CustomizedForm" method="post" action="<StartAuth>">
    +<BKUSelect>
    +<input type="submit" value="Ausw&auml;hlen"/>
    +</form>
    +<br/>
    +<p></p>

    +

    <input type="hidden" value="Weitere Info"/>
    +</form>

    +

    </body>
    +</html>
    +

    +

    + + +Innerhalb dieser <form>-Elemente können Texte, Beschriftungen und Styles modifiziert werden, +und es können zusätzliche Elemente darin aufgenommen werden.
    +
    +Auch dabei ist die vorgegebene Grundstruktur einzuhalten, die speziellen Tags <StartAuth> und <BKUSelect> sind verpflichtend.

    +

    Wichtiger Hinweis: wenn die Templates über HTTPS geladen werden sollten, so muss das SSL/TLS Zertifikat des Servers in einem Java Truststore gespeichert werden und dieser beim Start von Tomcat angegeben werden.

    +Vorgeschlagene Vorgehensweise:
    +     +
     
+1. Webserver SSL/TLS Zertifikat speichern im .cer Format speichern (z.B. mittels Internet Explorer).
    
+2. Mittels Java Keytool das Zertifikat in einen Java Truststore importieren.
    -
    +Im folgenden Beispiel wird in den Java Truststore "truststore.jks" mit dem Passwort "changeit" importiert.
    +
    keytool -import -trustcacerts -alias mytomcat -file tomcat_localhost.cer -keystore truststore.jks
    +

    3. Truststore beim Starten von Tomcat angeben (über das Hinzufügen folgender Parameter in + die Variable CATALINA_OPTS im Tomcat Startskript).

    +


    +    -Djavax.net.ssl.trustStore=<PFAD>\truststore.jks
    
+    -Djavax.net.ssl.trustStorePassword=changeit
    
+    -Djavax.net.ssl.trustStoreType=jks
    +

    + @@ -172,7 +192,7 @@ Auch dabei ist die vorgegebene Grundstruktur einzuhalten, die speziellen Tags
    -
    © 2003
    +
    © 2004

    diff --git a/id.server/doc/moa_id/id-anwendung_2.htm b/id.server/doc/moa_id/id-anwendung_2.htm index 1ffeb4c08..a9b30b139 100644 --- a/id.server/doc/moa_id/id-anwendung_2.htm +++ b/id.server/doc/moa_id/id-anwendung_2.htm @@ -137,7 +137,7 @@ MOA-ID-AUTH liefert als Antwort einen <samlp:Response>. Die Anmeldedaten s
    SAML 1.0 Assertion Schema
    -Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.1 beschrieben. +Der detaillierte Aufbau der <saml:Assertion> zu den Anmeldedaten ist in der Spezifikation MOA-ID 1.2 beschrieben.

    Beispiel LoginServletExample

    Das Abholen der Anmeldedaten durch Aufruf des Web Service von MOA-ID-AUTH wird anhand eines beispielhaften Java Servlet gezeigt. @@ -162,7 +162,9 @@ Das Beispiel demonstriert insgesamt die Integration von MOA-ID-AUTH in die OA: Java-BibliothekVersionBemerkung -JDK1.3 bzw. 1.4.1Java Development Kit +JDK +1.3 bzw. 1.4.1, 1.4.2 +Java Development Kit Xerces
    XML Parser2.0.2+ nicht nötig wenn JDK 1.4 oder höher verwendet wird
    diff --git a/id.server/doc/moa_id/moa.htm b/id.server/doc/moa_id/moa.htm index 54bcf951d..9652c3936 100644 --- a/id.server/doc/moa_id/moa.htm +++ b/id.server/doc/moa_id/moa.htm @@ -80,7 +80,7 @@ Projekt moa  -
    Allgemein v.1.1
    +
    Allgemein v.1.2

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

      @@ -114,8 +114,9 @@ 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 Version 1.1 detailliert beschrieben. -

      +Spezifikation Version 1.2 detailliert beschrieben. +
      +
      Für den Betrieb von MOA-ID ist der Einsatz von MOA-Signaturprüfung (MOA-SP) erforderlich. @@ -237,7 +238,7 @@ an den Benutzer weitergeleitet und die Anfragen des Benutzers an die OA weiterge
      -
      © 2003
      +
      © 2004

      -- cgit v1.2.3