From edc10681ce6d045d57d5dc7a544f3081f6eb41a7 Mon Sep 17 00:00:00 2001 From: rudolf Date: Fri, 19 Dec 2003 09:09:41 +0000 Subject: MOA-ID 1.1.1D01 git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@82 d688527b-c9ab-4aba-bd8d-4036d912da1d --- id.server/doc/moa_id/id-admin_1.htm | 275 +++++++++++++++++++++++++----------- 1 file changed, 196 insertions(+), 79 deletions(-) (limited to 'id.server/doc/moa_id/id-admin_1.htm') diff --git a/id.server/doc/moa_id/id-admin_1.htm b/id.server/doc/moa_id/id-admin_1.htm index f56338747..73d5e3ef9 100644 --- a/id.server/doc/moa_id/id-admin_1.htm +++ b/id.server/doc/moa_id/id-admin_1.htm @@ -67,7 +67,7 @@ Projekt moa 
Zurück
-

+
Installationsschritte:
@@ -87,25 +87,59 @@ Unterschiede sind in der Installationsanweisung angeführt.

Vorbereitung

-Installation des JDK
-Installieren Sie das JDK 1.3.1 oder JDK 1.4.1 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 Leerzeichen im Pfadnamen enthält. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet. Hinweis: Tomcat wird in einer Distribution für JDKs ab Version 1.2 und in einer Distribution speziell für JDK 1.4 ausgeliefert. Installieren Sie die zur Version Ihres JDK passende Tomcat-Version. -

-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, des IAIK LDAP Protocol Handlers und von JSSE (JDK 1.3.1)
-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 Möglichkeiten zur Verfügung:
-1. Installation innerhalb des JDK 1.3.1:
-Die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext13 (oder $MOA_ID_INST_PROXY/ext13) 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.
-2. Installation ausschließlich für Applikationen innerhalb von Tomcat:
-Um die o.g. Unterstützung nur Tomcat-Anwendungen zu ermöglichen, können die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext13 (oder $MOA_ID_INST_PROXY/ext13) in ein beliebiges Verzeichnis kopiert werden. Im Folgenden wird dieses Verzeichnis $MOA_ID_EXT genannt. Anschließend muss der Tomcat-Klassenpfad angepasst werden:
-Für Windows-Betriebssysteme ist dafür die Datei $CATALINA_HOME\bin\setclasspath.bat anzupassen:
-Hinter 'set CLASSPATH=%JAVA_HOME%\lib\tools.jar' müssen nun jeweils mit Semikolon getrennt, die Dateien aus $MOA_ID_EXT inklusive der vollständigen Pfadangaben angefügt werden.
-Anschließend sieht diese Zeile beispielsweise folgendermaßen aus: -
+            
Installation des JDK

+              Installieren Sie das JDK 1.3.1, JDK 1.4.1 oder JDK 1.4.2 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. 

+            
Hinweis: Tomcat 4.1.18 wird in einer Distribution für 
+              JDKs ab Version 1.2 und in einer Distribution speziell für 
+              JDK 1.4 ausgeliefert. Installieren Sie die zur Version Ihres JDK 
+              passende Tomcat-Version. 

+            
Hinweis: Wenn Sie Tomcat 4.1.27 einsetzen, so müssen 
+              sie $CATALINA_HOME/server/lib/tomcat-util.jar durch die gepatchte 
+              Version welche in der MOA-ID Distribution (*) enthalten ist ersetzen.

+              

+              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, des IAIK LDAP Protocol Handlers und 
+              von JSSE (JDK 1.3.1)

+              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 
+              Möglichkeiten zur Verfügung: 

+              1. Installation innerhalb des JDK 1.3.1:

+              Die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext13 (oder $MOA_ID_INST_PROXY/ext13) 
+              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.

+              2. Installation ausschließlich für Applikationen innerhalb 
+              von Tomcat:

+              Um die o.g. Unterstützung nur Tomcat-Anwendungen zu ermöglichen, 
+              können die Dateien aus dem Verzeichnis $MOA_ID_INST_AUTH/ext13 
+              (oder $MOA_ID_INST_PROXY/ext13) in ein beliebiges Verzeichnis kopiert 
+              werden. Im Folgenden wird dieses Verzeichnis $MOA_ID_EXT genannt. 
+              Anschließend muss der Tomcat-Klassenpfad angepasst werden:

+              Für Windows-Betriebssysteme ist dafür die Datei $CATALINA_HOME\bin\setclasspath.bat 
+              anzupassen:

+              Hinter 'set CLASSPATH=%JAVA_HOME%\lib\tools.jar' müssen 
+              nun jeweils mit Semikolon getrennt, die Dateien aus $MOA_ID_EXT 
+              inklusive der vollständigen Pfadangaben angefügt werden.

+              Anschließend sieht diese Zeile beispielsweise folgendermaßen 
+              aus: 

+            
 	set CLASSPATH=%JAVA_HOME%\lib\tools.jar;
 		      $MOA_ID_EXT\iaik_jce_full.jar;
 		      $MOA_ID_EXT\iaik_ldap.jar;
@@ -113,14 +147,29 @@ Anschließend sieht diese Zeile beispielsweise folgendermaßen aus:
 		      $MOA_ID_EXT\jnet.jar;
 		      $MOA_ID_EXT\jsse.jar 
 

-($MOA_ID_EXT ist durch den tatsächlichen Pfad zu ersetzen)

-Unix/Linux-Anwender verfahren analog mit der Datei $CATALINA_HOME/bin/setclasspath.sh wobei ';' durch ':' zu ersetzen ist.


-Installation der IAIK JCE und des IAIK LDAP Protocol Handlers (JDK 1.4.1)

-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 und SSL jeder Java-Anwendung die dieses JDK verwendet zur Verfügung.

-Zusätzlich müssen die so genannten "Unlimited Strength Jurisdiction Policy Files 1.4.1" 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 für das JDK 1.4.1 in der Sektion "Other Downloads".
-
+

($MOA_ID_EXT ist durch den tatsächlichen Pfad zu ersetzen)
+ Unix/Linux-Anwender verfahren analog mit der Datei $CATALINA_HOME/bin/setclasspath.sh + wobei ';' durch ':' zu ersetzen ist.
+
+ Installation der IAIK JCE und des IAIK LDAP Protocol Handlers + (JDK 1.4.1 bzw. JDK 1.4.2)
+ 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 + und SSL jeder Java-Anwendung die dieses JDK verwendet zur Verfügung.
+
+ Zusätzlich müssen die so genannten Unlimited Strength + Jurisdiction Policy Files 1.4.1 (bzw. 1.4.2) 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 1.4.x in der Sektion "Other + Downloads". D.h. JDK + hier für 1.4.1 bzw. das JDK hier + für 1.4.2.

+
- +
@@ -174,24 +223,49 @@ Um diese Benutzer-Rolle und einen oder mehrere Benutzer einzurichten, müsse

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).
    In $MOA_ID_INST_AUTH/conf/moa-id befindet sich eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration von MOA-ID-AUTH dienen kann.
    • -
  • 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. Folgende Libraries sind für das Deployment im endorsed Verzeichnis vorgesehen: -
      -
    • Xerces-J-2.0.2 (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 Beispiele für Windows und für Linux). -
+
    +
  • 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).
    + In $MOA_ID_INST_AUTH/conf/moa-id befindet sich eine funktionsfähige + Konfiguration, die als Ausgangspunkt für die Konfiguration + von MOA-ID-AUTH dienen kann.
    • +
  • 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. Folgende Libraries + sind für das Deployment im endorsed Verzeichnis vorgesehen: +
      +
    • Xerces-J-2.0.2 (bestehend aus xercesImpl.jar + und xmlParserAPIs.jar) - für alle JDKs.
      +
      • +
    • Nur im Fall von JDK 1.4.1: kopieren sie auch die Xalan-j-2.2 + Libraries ( bestehend aus bsf.jar und xalan.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 (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). +
@@ -208,29 +282,62 @@ Diese Java System-Properties werden Tomcat über die Umgebungsvariable CATAL

Deployment von MOA-ID-PROXY in Tomcat

Um MOA-ID-PROXY in Tomcat für den Ablauf vorzubereiten, sind folgende Schritte notwendig:
-
    -
  • Die Datei $MOA_ID_INST_PROXY/moa-id-proxy.war wird in ein beliebiges Verzeichnis (bspw. $CATALINA_HOME) kopiert. HINWEIS: Das Verzeichnis darf NICHT $CATALINA_HOME/webapps sein!
    - Anschliessend 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 befindet, geschieht dies mit dem Einfügen von folgendem Element innerhalb von <Server>...<Service>...<Engine>...<Host>:
    • -
    <Context path="" docBase="../moa-id-proxy.war" debug="0"/>
    -Anmerkung: Der Root-Context von Tomcat ist normalerweise auskommentiert.

    -
  • 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).
    -In $MOA_ID_INST_PROXY/conf/moa-id befindet sich eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration von MOA-ID-PROXY dienen kann.
    • -
  • 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.0.2 (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 Beispiele für Windows und für Linux). -
-
+ +
@@ -243,10 +350,11 @@ Diese Java System-Properties werden Tomcat über die Umgebungsvariable CATAL

Starten und Stoppen von Tomcat

-
-Nach dem Deployment und der Konfiguration kann Tomcat aus seinem Wurzelverzeichnis mit
-
-    bin\catalina start (unter Windows) oder 
+                
 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 

@@ -293,7 +401,7 @@ FATAL | 03 13:19:06,924 | main | Fehler
In diesem Fall geben die WARN bzw. ERROR Log-Meldungen unmittelbar davor Aufschluss über den genaueren Grund.
- +
@@ -376,11 +484,20 @@ Wenn nun versucht wird, eine Transaktion mit einer ungültigen SessionID fort (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. -
- +

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.

+
+

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

+
+

@@ -396,5 +513,5 @@ Die Tatsächlich übertragenen Anfragen bzw. Antworten werden aus Effizi - + \ No newline at end of file -- cgit v1.2.3