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 --- id/server/doc/handbook/install/install.html | 93 ++++++++++++++--------------- 1 file changed, 44 insertions(+), 49 deletions(-) (limited to 'id/server/doc/handbook/install') diff --git a/id/server/doc/handbook/install/install.html b/id/server/doc/handbook/install/install.html index 3b1a7e905..fb3239dfb 100644 --- a/id/server/doc/handbook/install/install.html +++ b/id/server/doc/handbook/install/install.html @@ -2,26 +2,22 @@ + MOA-ID - Installation -< - - - - - - -
Logo BKADokumentation 
-
-

MOA-ID (Identifikation)

-

Installation

-
-

Inhalt

-
    -
  1. -

    ÜbersichtLogo EGIZ

    -
  2. + +
    +
    + +

    MOA-ID-AUTH

    +
    +
    +
    +
    +

    Installation

    +

    Inhalt

    +
    1. MOA-ID-Auth und MOA-ID-Configuration

        @@ -77,17 +73,16 @@
    -
      +
      1. Referenzierte Software
      -
      -

      1 Übersicht

      +

      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

      +

      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

      +

      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:

      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

      +

      2.1.2 Installation

      +
      2.1.2.1 Vorbereitung

      Die folgenden Schritte dienen der Vorbereitung der Installation.

      Installation von Java SE
      @@ -121,11 +116,11 @@
      Für den Betrieb von MOA-ID 2.0 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

      +
      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
      +
      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
      +
      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:

        @@ -134,7 +129,7 @@
      • 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
      +
      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.
      • @@ -153,7 +148,7 @@
      -
      2.1.2.4 Einsatz des Moduls MOA-ID-Configuration in Tomcat
      +
      2.1.2.4 Einsatz des Moduls MOA-ID-Configuration in Tomcat
      • Die Datei $MOA_ID_AUTH_INST/moa-id_configuration.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/moa-id-configuration 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.
        @@ -169,18 +164,18 @@
      -

      2.1.2.4 Starten und Stoppen von Tomcat

      -
      2.1.2.4.1 Unter Windows
      +
      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
      +
      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
      +
      2.1.2.4.3 Prüfen des erfolgreichen Starts

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

      @@ -200,7 +195,7 @@ http://<host>:<port>/moa-id-configuration/ https://<host>:<port>/moa-id-auth/ https://<host>:<port>/moa-id-configuration/

      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

      +
      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:

      • @@ -227,7 +222,7 @@ https://<host>:<port>/moa-id-configuration/

      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

      +
      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 | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1 
      @@ -254,7 +249,7 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1
           

      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 Thread-3 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

      +
      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: @@ -267,32 +262,32 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1

      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

      +

      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)

      +

      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
      +
      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
      +
      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
      +
      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

      +
      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
      +
      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
      +
      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
      +
      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

      +

      A Referenzierte Software

      Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

      @@ -312,6 +307,6 @@ INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1
      Logging Framework
      - +
    -- cgit v1.2.3 From 4bf73cfd794a8ecb90c856d97e2aabdcb443f8e8 Mon Sep 17 00:00:00 2001 From: Christian Maierhofer Date: Fri, 16 Jan 2015 08:32:36 +0100 Subject: modified handbook --- id/server/doc/handbook/install/install.html | 1 + 1 file changed, 1 insertion(+) (limited to 'id/server/doc/handbook/install') diff --git a/id/server/doc/handbook/install/install.html b/id/server/doc/handbook/install/install.html index fb3239dfb..a84bbb9ec 100644 --- a/id/server/doc/handbook/install/install.html +++ b/id/server/doc/handbook/install/install.html @@ -5,6 +5,7 @@ MOA-ID - Installation +
    -- cgit v1.2.3 From 0442791f0196e19a900edfe72eae5ef34d11d7da Mon Sep 17 00:00:00 2001 From: Christian Maierhofer Date: Fri, 16 Jan 2015 10:14:07 +0100 Subject: changed font location to https --- id/server/doc/handbook/install/install.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'id/server/doc/handbook/install') diff --git a/id/server/doc/handbook/install/install.html b/id/server/doc/handbook/install/install.html index a84bbb9ec..aa508183e 100644 --- a/id/server/doc/handbook/install/install.html +++ b/id/server/doc/handbook/install/install.html @@ -5,7 +5,7 @@ MOA-ID - Installation - +
    -- cgit v1.2.3