From 64c052c310ff1d23997efeb7f579d56e5ee13eec Mon Sep 17 00:00:00 2001 From: gregor Date: Tue, 30 May 2006 20:12:30 +0000 Subject: =?UTF-8?q?Betriebshandbuch=20und=20Systemhandbuch=20=C3=BCberarbe?= =?UTF-8?q?itet=20bzw.=20erweitert.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@707 d688527b-c9ab-4aba-bd8d-4036d912da1d --- spss.slinterface/handbook/constraints.txt | 6 + .../handbook/operation/images/testapp.screen1.png | Bin 0 -> 38150 bytes .../handbook/operation/images/testapp.screen2.png | Bin 0 -> 44749 bytes .../handbook/operation/images/testapp.screen3.png | Bin 0 -> 16625 bytes .../handbook/operation/images/testapp.screen4.png | Bin 0 -> 40110 bytes spss.slinterface/handbook/operation/operation.html | 1746 +++++++++++++++----- .../handbook/system/images/Zusammenspiel.VSD | Bin 0 -> 138240 bytes .../handbook/system/images/Zusammenspiel.mit.png | Bin 0 -> 48649 bytes .../handbook/system/images/Zusammenspiel.ohne.png | Bin 0 -> 36106 bytes spss.slinterface/handbook/system/system.html | 960 +++++------ 10 files changed, 1823 insertions(+), 889 deletions(-) create mode 100644 spss.slinterface/handbook/constraints.txt create mode 100644 spss.slinterface/handbook/operation/images/testapp.screen1.png create mode 100644 spss.slinterface/handbook/operation/images/testapp.screen2.png create mode 100644 spss.slinterface/handbook/operation/images/testapp.screen3.png create mode 100644 spss.slinterface/handbook/operation/images/testapp.screen4.png create mode 100644 spss.slinterface/handbook/system/images/Zusammenspiel.VSD create mode 100644 spss.slinterface/handbook/system/images/Zusammenspiel.mit.png create mode 100644 spss.slinterface/handbook/system/images/Zusammenspiel.ohne.png diff --git a/spss.slinterface/handbook/constraints.txt b/spss.slinterface/handbook/constraints.txt new file mode 100644 index 000000000..f21d385c8 --- /dev/null +++ b/spss.slinterface/handbook/constraints.txt @@ -0,0 +1,6 @@ +- Prüfung eines ggf. vorhandenen SL-Manifests wird nicht durchgeführt. + In der Antwort wird der Code 98 zurückgeliefert. + +- Prüfung von dsig-Manifesten escheint nicht in der Auswertungsseite. + +- Bei signiertem XHTML-Dokument wird list-style-image-URL nicht geprüft. \ No newline at end of file diff --git a/spss.slinterface/handbook/operation/images/testapp.screen1.png b/spss.slinterface/handbook/operation/images/testapp.screen1.png new file mode 100644 index 000000000..38a226d09 Binary files /dev/null and b/spss.slinterface/handbook/operation/images/testapp.screen1.png differ diff --git a/spss.slinterface/handbook/operation/images/testapp.screen2.png b/spss.slinterface/handbook/operation/images/testapp.screen2.png new file mode 100644 index 000000000..45230d5c9 Binary files /dev/null and b/spss.slinterface/handbook/operation/images/testapp.screen2.png differ diff --git a/spss.slinterface/handbook/operation/images/testapp.screen3.png b/spss.slinterface/handbook/operation/images/testapp.screen3.png new file mode 100644 index 000000000..7d5db9cad Binary files /dev/null and b/spss.slinterface/handbook/operation/images/testapp.screen3.png differ diff --git a/spss.slinterface/handbook/operation/images/testapp.screen4.png b/spss.slinterface/handbook/operation/images/testapp.screen4.png new file mode 100644 index 000000000..9fe7ee264 Binary files /dev/null and b/spss.slinterface/handbook/operation/images/testapp.screen4.png differ diff --git a/spss.slinterface/handbook/operation/operation.html b/spss.slinterface/handbook/operation/operation.html index fbdda0b9e..05287b293 100644 --- a/spss.slinterface/handbook/operation/operation.html +++ b/spss.slinterface/handbook/operation/operation.html @@ -1,449 +1,1351 @@ + MOA SL - Betriebshandbuch + + + - - - - - - - -

Open Source
- für das E-Government

MOA: Serverseitige Signaturprüfung (SL), V 1.0

Betriebshandbuch

Inhalt

-
Übersicht
-
Installation -
1. Einführung
-
Konfiguration
-
Webservice
-
1. Basisinstallation -
  1. Einführung
  2. Installation -
    -
  3. Logging -
    1. Format der Log-Meldungen
    2. Wichtige Log-Meldungen
    -
  -
2. Erweiterungsmöglichkeiten
  1. Vorgeschalteter Webserver
    1. Microsoft Internet Information Server (MS IIS)
      -
    2. Apache
      -
    -
  2. Datenbank
    1. PostgreSQL
      -
    2. Andere Datenbanken
    -
  -
-
Klassenbibliothek -
1. Basisinstallation -
  1. Einführung
  2. Vorbereitung
  3. Verwendung
  4. Logging
  -
2. Erweiterungsmöglichkeiten
-

Referenzierte Software

1 Übersicht

Das Modul Serverseitige Signaturprüfung (SL) ist als plattformunabhängiges Modul ausgelegt, das als Webservice über HTTP bzw. HTTPS angesprochen werden kann.

Dieses Handbuch beschreibt einerseits die Installation des Moduls, andererseits werden die Konfigurationsmöglichkeiten dargestellt. Für eine funktionale Beschreibung des Moduls siehe Systemhandbuch.

2 Installation

2.1 Einführung

Das MOA SL Webservice wurde plattformunabhänig konzipiert und in Java entwickelt. Es benötigt als Ablaufumgebung eine Java 2 Standard Edition (J2SE SDK, Version 1.4.2 oder 5.0) sowie einen Java Servlet Container, der die Java Servlet Specification in der Version x.y erfüllt.

In diesem Betriebshandbuch wird davon ausgegangen, dass MOA SL Apache Tomcat (Version 4.1 oder höher) als Servlet Container verwendet. Die Verwendung eines anderen Servlet Containers ist grundsätzlich möglich, wurde aber nicht getestet und ist auch nicht Gegenstand dieses Betriebshandbuchs.

Weiters wird davon ausgegangen, dass Apache Tomcat gleichzeitig als HTTP- bzw. HTTPS-Endpunkt für das MOA SL Webservice dient, d.h. beide Protokolle werden direkt in Tomcat konfiguriert. Die Verwendung eines vor Apache Tomcat geschalteten Webservers ist grundsätzlich möglich. So werden etwa als Teil des Apache Tomcat Projekts Module zur Verbindung mit einem vorgeschalteten Microsoft Internet Information Server oder mit einem vorgeschalteten Apache Webserver angeboten. Die Beschreibung der möglichen Vorschaltungen ist jedoch nicht Teil dieses Betriebshandbuchs.

Das MOA SL Webservice nimmt Signaturprüfungsrequests für XML-Signaturen entsprechend der Spezifikation des Security-Layers zur österreichischen Bürgerkarte in den Versionen 1.1 und 1.2 entgegen. Für die Durchführung der Signaturprüfung bedient sich MOA SL des Moduls MOA Signaturprüfung (SP). Für den Betrieb von MOA SL ist daher die Verfügbarkeit einer Webservice-Installation von MOA SP in der Version 1.2 oder höher Voraussetzung.

Als Logging Toolkit verwendet das MOA SL Webservice Apache Log4j.

2.2 Vorbereitung

Die folgenden Schritte dienen der Vorbereitung der Installation.

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

Open +Source
+ +für das E-Government

+ +

MOA: +Serverseitige Signaturprüfung (SL), V 1.1

+ +

Betriebshandbuch

+ +

Inhalt

+ +

+
Übersicht
+ +
Installation +
1. Einführung
2. Vorbereitung
3. Konfiguration +von Apache Tomcat +
  1. Konfiguration +des HTTP Connectors
  2. Konfiguration +des HTTPS Connectors
  + +
4. Einsatz des +MOA SL Webservices in Tomcat
5. Starten +und Stoppen von Tomcat +
  1. Unter +Windows
  2. Unter +Unix
  3. Logging +
    1. Format +der Log-Meldungen
    + +
  4. Prüfen +des erfolgreichen Starts
  + +
+ +
Konfiguration +
1. Zentrale +Konfigurationsdatei +
  + +
2. Layout des +Prüfberichts
+ +
Durchlaufen der +Testapplikation

+ +

1 +Übersicht

+ +

Das Modul Serverseitige +Signaturprüfung (MOA SL) ist als +plattformunabhängiges Modul ausgelegt, das als Webservice +über HTTP bzw. HTTPS angesprochen werden kann.

+ +

Dieses Handbuch beschreibt einerseits die Installation des +Moduls, andererseits werden die Konfigurationsmöglichkeiten +dargestellt. Für eine funktionale Beschreibung des Moduls +siehe Systemhandbuch. +

+ +

2 +Installation

+ +

2.1 +Einführung

+ +

Das MOA SL Webservice wurde plattformunabhänig +konzipiert und in Java entwickelt. Es benötigt als +Ablaufumgebung eine Java 2 Standard Edition (J2SE SDK, Version 1.4.2 oder 5.0) sowie +einen Java Servlet Container, der die Java +Servlet Specification in der Version 2.3 erfüllt.

+ +

In diesem Betriebshandbuch wird davon ausgegangen, dass MOA SL +Apache +Tomcat (Version 4.1 oder höher) als Servlet +Container verwendet. Die Verwendung eines anderen Servlet Containers +ist grundsätzlich möglich, wurde aber nicht getestet +und ist auch nicht Gegenstand dieses Betriebshandbuchs.

+ +

Weiters wird davon ausgegangen, dass Apache Tomcat +gleichzeitig als HTTP- bzw. HTTPS-Endpunkt für das MOA SL +Webservice dient, d.h. beide Protokolle werden direkt in Tomcat +konfiguriert. Die Verwendung eines vor Apache Tomcat geschalteten +Webservers ist grundsätzlich möglich. So werden etwa +als Teil des Apache Tomcat Projekts Module +zur Verbindung mit einem vorgeschalteten Microsoft Internet Information +Server oder mit einem vorgeschalteten Apache Webserver angeboten. Die +Beschreibung der möglichen Vorschaltungen ist jedoch nicht +Teil dieses Betriebshandbuchs.

+ +

Das MOA SL Webservice nimmt Signaturprüfungsrequests +für XML-Signaturen entsprechend der Spezifikation des +Security-Layers zur österreichischen Bürgerkarte in +den Versionen 1.1 und 1.2 entgegen. Für die +Durchführung der Signaturprüfung bedient sich MOA SL +des Moduls MOA Signaturprüfung (SP). Für den Betrieb +von MOA SL ist daher die Verfügbarkeit einer +Webservice-Installation von MOA SP in der Version 1.2 oder +höher Voraussetzung.

+ +

Als Logging Toolkit verwendet das MOA SL Webservice Apache Log4j. +

+ +

2.2 Vorbereitung

+ +

Die folgenden Schritte dienen der Vorbereitung der +Installation.

+ +

Installation von J2SE SDK: Installieren Sie J2SE 1.4.2 SDK oder J2SE 5.0 SDK in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der J2SE SDK Installation wird im weiteren Verlauf als $JAVA_HOME bezeichnet.; Installieren Sie J2SE 1.4.2 SDK +oder J2SE 5.0 +SDK in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der +J2SE SDK Installation wird im weiteren Verlauf als $JAVA_HOME +bezeichnet.
Installation von Apache Tomcat: Installieren Sie Apache Tomcat 4.1.31 oder höher in ein Verzeichnis, das keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte die zu Ihrem J2SE SDK passende Distribution von Tomcat. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet.; Installieren Sie Apache +Tomcat 4.1.31 oder höher in ein Verzeichnis, das +keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte +die zu Ihrem J2SE SDK passende Distribution von Tomcat. Das +Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME +bezeichnet.
Installation von MOA SP: Installieren Sie das Kombinationsmodul MOA SPSS Version 1.2 oder höher entsprechend seiner Installationsanleitung. Sie benötigen die Webservice-Schnittstelle von MOA SP. Es ist ausreichend, mittels entsprechender Konfigurationseinstellungen ausschließlich MOA SP zu aktivieren; MOA SS kann deaktiviert bleiben. Wenn Sie sowohl für MOA SPSS als auch für MOA SL Apache Tomcat als Servlet Container verwenden möchten, empfehlen wir, MOA SPSS und MOA SL in jeweils eigenständigen Instanzen von Apache Tomcat zu betreiben.; Installieren Sie das Kombinationsmodul +MOA SPSS Version 1.3 oder höher entsprechend seiner +Installationsanleitung. Sie benötigen die +Webservice-Schnittstelle von MOA SP. Es ist ausreichend, mittels +entsprechender Konfigurationseinstellungen ausschließlich MOA +SP zu aktivieren; MOA SS kann deaktiviert bleiben. Wenn Sie sowohl +für MOA SPSS als auch für MOA SL Apache Tomcat als +Servlet Container verwenden möchten, empfehlen wir, MOA SPSS +und MOA SL in jeweils eigenständigen Instanzen von Apache +Tomcat zu betreiben.
Entpacken der MOA SL Distribution: Entpacken Sie die Datei moa-sl-1.0.x.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_SL_INST bezeichnet.; Entpacken Sie die Datei moa-sl-1.1.x.zip +in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren +Verlauf als $MOA_SL_INST bezeichnet.

2.3 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, die jedoch einiges an Ballast enthält und viele Ports offen lässt.

2.3.1 Konfiguration des HTTP Connectors

Die Datei $MOA_SL_INST/conf/tomcat/server.xml enthält eine minimale Tomcat-Konfiguration, die ausschließlich den Connector für HTTP auf Port 8080 freischaltet. Durch kopieren dieser Datei nach $CATALINA_HOME/conf/server.xml kann Tomcat mit dieser Konfiguration gestartet werden. Wir empfehlen diese Konfiguration nur für Fälle, in denen das MOA SL Webservice in einer abgeschlossenen Netzwerkumgebung betrieben wird.

2.3.2 Konfiguration des HTTPS Connectors

Wird das MOA SL Webservice in einer nicht abgeschlossenen Umgebung (z.B. Erreichbarkeit über das Internet) betrieben, ist es für den Benutzer von MOA SL essentiell, die Identität des Webservice eindeutig feststellen zu können, denn er vertraut dem Webservice ja die Prüfung einer elektronischen Signatur an. Diese Identitätsprüfung kann mit hoher Qualität vorgenommen werden, wenn die Erreichbarkeit des Webservice auf HTTPS mit Serverauthentisierung eingeschränkt wird.

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 (auszukommentieren). 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. Sie können diesen Keystore z.B. mit keytool erstellen, einem Programm, das Ihrem J2SE SDK beiliegt.
Erstellung eines Client-Keystores, der die Zertifikate aller Kunden des Webservices enthält. Nur Kunden des MOA SL Webservices, die sich beim Aufbau einer SSL-Verbindung gegenüber dem Webservice mit einem im Client-Keystore enthaltenen Zertifikat ausweisen, erhalten Zugriff zu den Diensten des MOA SL Webservices. Auch dieser Keystore kann z.B. mit keytool erstellt werden. Dieser Keystore ist optional und braucht nur erstellt zu werden, wenn sich die Kunden gegenüber dem MOA SL Webservice authentisieren müssen.
Konfiguration des HTTPS Connectors in $CATALINA_HOME/conf/server.xml.

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.1).

2.4 Einsatz des MOA SL Webservices in Tomcat

Um das MOA SL Webservice in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

Die Datei $MOA_SL_INST/moa-sl.war enthält das einsatzfertige MOA SL 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-sl entpackt.
Die zentrale Konfigurationsdatei für MOA SL muss in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-sl). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA SL Webservices dienen kann, finden Sie hier.
Die Dateien xalan.jar, xercesImpl.jar und xmlParserAPIs.jar aus dem Verzeichnis $MOA_SL_INST/endorsed14 müssen in das Tomcat-Verzeichnis $CATALINA_HOME/common/endorsed kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xml-apis.jar muss gelöscht werden.

Folgende System Properties müssen bzw. können gesetzt werden (werden beim Starten von Tomcat der Java Virtual Machine in der Umgebungsvariablen CATALINA_OPTS in der Form -D<name>=<wert> übergeben): -

at.gv.egovernment.moa.spss.slinterface.PropertiesLocation: Pfad und Name der zentralen Konfigurationsdatei für MOA SL. Eine beispielhafte Konfigurationsdatei finden Sie hier. Wird ein relativer Pfad angegeben, wird zuerst versucht, diesen relativ zum Wurzelverzeichnis der Webapplikation (also $CATALINA_HOME/webapps/moa-sl) zu interpretieren. Klappt das nicht, wird dann versucht, den relativen Pfad relativ zum Startverzeichnis der Java Virtual Machine zu interpretieren. Diese System Property muss jedenfalls gesetzt werden.
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 kein Webserver vor Tomcat geschalten wird und 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 kein Webserver vor Tomcat geschalten wird und SSL Client-Authentisierung durchgeführt werden soll).
javax.net.ssl.trustStoreType: Truststore-Typ (optional; nur wenn kein Webserver vor Tomcat geschalten wird und SSL Client-Authentisierung durchgeführt werden soll). Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 (PKCS#12-Datei) angegeben werden.

+ +

2.3 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, die jedoch einiges an Ballast +enthält und viele Ports offen lässt.

+ +

2.3.1 +Konfiguration des HTTP Connectors

+ +

Die Datei $MOA_SL_INST/conf/tomcat/server.xml +enthält eine minimale Tomcat-Konfiguration, die +ausschließlich den Connector für HTTP auf Port 8080 +freischaltet. Durch kopieren dieser Datei nach $CATALINA_HOME/conf/server.xml +kann Tomcat mit dieser Konfiguration gestartet werden. Wir empfehlen +diese Konfiguration nur für Fälle, in denen das MOA +SL Webservice in einer abgeschlossenen Netzwerkumgebung betrieben wird. +

+ +

2.3.2 +Konfiguration des HTTPS Connectors

+ +

Wird das MOA SL Webservice in einer nicht abgeschlossenen +Umgebung (z.B. Erreichbarkeit über das Internet) betrieben, +ist es für den Benutzer von MOA SL essentiell, die +Identität des Webservice eindeutig feststellen zu +können, denn er vertraut dem Webservice ja die +Prüfung einer elektronischen Signatur an. Diese +Identitätsprüfung kann mit hoher Qualität +vorgenommen werden, wenn die Erreichbarkeit des Webservice auf HTTPS +mit Serverauthentisierung eingeschränkt wird.

+ +

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 (auszukommentieren). 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. Sie +können diesen Keystore z.B. mit keytool +erstellen, einem Programm, das Ihrem J2SE SDK beiliegt.
Erstellung eines Client-Keystores, +der die Zertifikate aller Kunden des Webservices enthält. Nur +Kunden des MOA SL Webservices, die sich beim Aufbau einer +SSL-Verbindung gegenüber dem Webservice mit einem im Client-Keystore enthaltenen +Zertifikat ausweisen, erhalten Zugriff zu den Diensten des MOA SL +Webservices. Auch dieser Keystore kann z.B. mit keytool +erstellt werden. Dieser Keystore ist optional und braucht nur erstellt +zu werden, wenn sich die Kunden gegenüber dem MOA SL +Webservice authentisieren müssen.
Konfiguration des HTTPS Connectors in $CATALINA_HOME/conf/server.xml.

+ +

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.1).

+ +

2.4 Einsatz des MOA SL +Webservices in Tomcat

+ +

Um das MOA SL Webservice in Tomcat für den Einsatz +vorzubereiten, sind folgende Schritte notwendig:

+ +

Die Datei $MOA_SL_INST/moa-sl.war +enthält das einsatzfertige MOA SL 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-sl +entpackt.
Die zentrale Konfigurationsdatei für MOA SL muss +in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-sl/). +Eine funktionsfähige Konfiguration, die als Ausgangspunkt +für die Konfiguration des MOA SL Webservices dienen kann, +finden Sie unter $MOA_SL_INST/conf/moa-sl/moa-sl.properties. +
Die Dateien xalan.jar, xercesImpl.jar +und xmlParserAPIs.jar aus dem Verzeichnis $MOA_SL_INST/endorsed14 +müssen in das Tomcat-Verzeichnis $CATALINA_HOME/common/endorsed +kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, +müssen sie überschrieben werden. Die ggf. in diesem +Verzeichnis vorhandene Datei xml-apis.jar +muss gelöscht werden.
Folgende System Properties +für die Java Virtual Machine +müssen bzw. können gesetzt werden. Am einfachsten +können diese System Properties +beim Starten von Tomcat in der Umgebungsvariablen CATALINA_OPTS +in der Form -D<name>=<wert> +übergeben werden. +
- at.gv.egovernment.moa.spss.slinterface.PropertiesLocation: +Pfad und Name der zentralen Konfigurationsdatei für MOA SL. +Eine beispielhafte Konfigurationsdatei finden Sie unter $MOA_SL_INST/conf/moa-sl/moa-sl.properties. +Wird ein relativer Pfad angegeben, wird zuerst versucht, diesen relativ +zum Wurzelverzeichnis der Webapplikation (also $CATALINA_HOME/webapps/moa-sl) +zu interpretieren. Klappt das nicht, wird dann versucht, den relativen +Pfad relativ zum Startverzeichnis der Java +Virtual Machine zu interpretieren. Diese System Property muss jedenfalls +gesetzt werden.
- log4j.configuration: +URL der Log4j Konfigurationsdatei. Eine beispielhafte +Log4j-Konfiguration finden Sie unter $MOA_SL_INST/conf/log4j/log4j.properties. 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 kein Webserver vor Tomcat geschalten wird und 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 kein Webserver vor Tomcat geschalten wird und SSL +Client-Authentisierung durchgeführt werden soll).
- javax.net.ssl.trustStoreType: +Truststore-Typ (optional; nur wenn kein Webserver vor Tomcat geschalten +wird und SSL Client-Authentisierung durchgeführt werden soll). +Je nach verwendetem Keystore-Typ muss jks (Java Key Store) oder pkcs12 +(PKCS#12-Datei) angegeben werden.
+

2.5 Starten und Stoppen von Tomcat

2.5.1 Unter Windows

Das Verzeichnis $MOA_SL_INST/conf/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 des eingesetzten J2SE SDK) 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.4 besprochenen System Properties anpassen.

2.5.2 Unter Unix

Zunächst müssen die in Abschnitt 2.4 besprochenen System Properties mit Hilfe der Umgebungsvariablen CATALINA_OPTS gesetzt wrden. Die Datei $MOA_SL_INST/tomcat/unix/moa-env.sh enthält ein Beispiel dafür. Weiters müssen noch die Umgebungsvariablen JAVA_HOME (Basisverzeichnis des eingesetzten J2SE SDK) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden.

Nun kann Tomcat aus seinem Basisverzeichnis mit

+ +

2.5 Starten und +Stoppen von Tomcat

+ +

2.5.1 +Unter Windows

+ +

Das Verzeichnis $MOA_SL_INST/conf/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 des eingesetzten J2SE SDK) 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.4 +besprochenen System Properties +anpassen.

+ +

2.5.2 Unter +Unix

+ +

Zunächst müssen die in Abschnitt 2.4 +besprochenen System Properties +mit Hilfe der Umgebungsvariablen CATALINA_OPTS +gesetzt werden. Die Datei $MOA_SL_INST/tomcat/unix/moa-env.sh +enthält ein Beispiel dafür. Weiters müssen +noch die Umgebungsvariablen JAVA_HOME +(Basisverzeichnis des eingesetzten J2SE SDK) 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.5.3 Prüfen des erfolgreichen Starts

Ein erfolgreicher Start des MOA SL Webservices ist an folgender Log-Meldung ersichtlich:

2.5.3 +Logging

INFO | 18 10:09:45,155 | main | TID=startup NID=<null> MSG=MOA Konfiguration erfolgreich geladen
-

Bei leichten Fehlern in der Konfiguration geben WARN Log-Meldungen unmittelbar davor Aufschluss über fehlerhafte Konfigurations-Einträge. - Nach dem Starten von Tomcat steht das MOA SP/SS Webservice für die Server-Signatur und Signatur-Prüfung unter den Endpunkten

http://<host>:<port>/moa-spss/services/SignatureCreation
-

bzw. +

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

http://<host>:<port>/moa-spss/services/SignatureVerification
-

zur Verfügung. 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.

Konnte das MOA SP/SS Webservice nicht ordnungsgemäß gestartet werden, führt das zu folgender Log-Meldung:

FATAL | 18 10:17:03,475 | main | TID=startup NID=<null> 
  MSG=Fehler beim Lesen der MOA Konfiguration: das Service steht nicht zur Verfügung
-

-In diesem Fall geben die WARN bzw. ERROR Log-Meldungen unmittelbar davor Aufschluss über den genaueren Grund. -

2.1.3 Logging

Das MOA SL Webservice verwendet Apache Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j bietet zahlreiche Konfigurationsmöglichkeiten, die ausführlich im Apache 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.
-
+
Das verwendete Log-Level (DEBUG, INFO, + WARN, ERROR, FATAL);
+ +
+
Name und maximale Größe der +Log-Datei(en);
+ +
+
Das Aussehen der Log-Einträge.
+ +

Das MOA SL Webservice verwendet folgende Log-Hierarchien:

-
moa.spss.server für alle Log-Meldungen aus dem MOA/SPSS Webservice;
-
-
iaik.server für alle Log-Meldungen aus den SIC/IAIK Kryptographie-Modulen.
-

Das MOA SL Webservice verwendet für alle +Logeinträge die Log-Hierarchie slinterface. +Für die einzelnen Pakete des MOA SL Webservices werden davon +abgeleitete Sub-Hierarchien eingesetzt, z.B. slinterface.xmlparser, +slinterface.beans oder slinterface.filters.

Eine für MOA SL passende Konfigurationsdatei +für Log4j finden Sie unter $MOA_SL_INST/conf/log4j/log4j.properties. 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-sl.log +geschrieben.

2.5.3.1 +Format der Log-Meldungen

Anhand einer konkreten Log-Meldung wird das Format der MOA SL +Log-Meldungen erläutert:

INFO | 10 15:58:45,531 | slinterface.listeners | main | 
 Web application initialization succeeded..

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

Eine für MOA SP/SS 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 Datei moa-spss.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 | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=node1 
-  MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification
-

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 Thread-3 bezeichnet den Thread, von dem die Anfrage bearbeitet wird.

Der Wert von TID gibt die für jede Anfrage eindeutige Transaktions-ID an. Log-Meldungen, die bei der Abarbeitung dieser Anfrage geschrieben werden, enthalten alle einen Hinweis auf die entsprechende Transaktions-ID.

Der Wert von NID gibt den Rechner-Knoten an, auf dem das MOA SP/SS Webservice läuft (bei NID=<null> ist dieser Wert nicht konfiguriert, vergleiche Abschnitt 2.1.2.3).

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

INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification
-INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Aufruf von Adresse=127.0.0.1
-INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Client-Zertifikat nicht verfügbar

Die dritte Log-Meldung besagt, dass für die Abarbeitung dieser Anfrage kein Client-Zertifikat verfügbar ist (entweder, weil die Anfrage über HTTP eingelangt ist, oder weil die SSL Client-Authentisierung nicht eingeschaltet ist). Bei erfolgreicher SSL Client-Authentisierung, gibt beispielsweise folgende Log-Meldung Informationen über das Client-Zertifikat aus: -

INFO | 12 13:58:08,772 | Thread-10 | TID=1045054687159-2 NID=<null> 
-  MSG=Client-Zertifikat: Subject=CN=Testuser, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT, 
-  Serial=1.039.104.204, Issuer=CN=TestCA, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT

Eine erfolgreich abgearbeitete Anfrage wird angezeigt durch: -

INFO | 01 21:25:53,168 | Thread-3 | TID=1049225059594-106 NID=<null> 
-  MSG=Anfrage erfolgreich abgearbeitet

Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch:

INFO | 01 21:25:27,642 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Fehler beim Abarbeiten der Anfrage

In diesem Fall gibt der mitgeloggte Stacktrace Auskunft über die Art des Fehlers. Der Aufrufer des MOA SP/SS Webservices 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.

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 SP/SS Webservice wird durch Jakarta mod_jk durchgeführt. Die angeführten Konfigurationsschritte gehen von einer MS IIS Standard-Installation aus.

2.2.1.1.1 Konfiguration von Jakarta 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 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 Verzeichnis $MOA_SL_INST/tomcat bei.

2.2.1.1.2 Konfiguration von Tomcat

Damit Tomcat die Aufrufe entgegennehmen kann, die von MS IIS mittels Jakarta mod_jk weiterleitet werden, muss in $CATALINA_HOME/conf/server.xml der AJP 1.3 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. Die Datei $MOA_SL_INST/tomcat/server.mod_jk.xml enthält eine Konfiguration, die ausschließlich den Port für den AJP 1.3 Connector offen lässt.

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 Websiten vo 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 Jakarta mod_jk für die Kommunikation zwischen Webserver und Tomcat eingesetzt. Die angeführten Konfigurationsschritte gehen von einer Standard-Installation des Apache Webservers aus und sind ident für die Versionen 1.3.x und 2.0.x.

2.2.1.2.1 Konfiguration von Jakarta mod_jk im Apache

Um das MOA-SPSS Webservice 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_SL_INST/tomcat bei.

Um das MOA SP/SS Webservice 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 das MOA SP/SS 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 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 Kontexts eines Verzeichnisses spezifiziert werden.

2.2.2 Datenbank

Die MOA SP/SS Module können eine Datenbank zum Archivieren von Certificate Revocation Lists (CRLs), sowie zum Abspeichern von Log-Meldungen verwenden. In beiden Fällen wird eine installierte und konfigurierte Datenbank vorausgesetzt.

2.2.2.1 PostgreSQL

Eine detaillierte Übersicht über die Installation und Konfiguration von PostgreSQL gibt die Online-Dokumentation.

Bitte beachten Sie: Eine Möglichkeit, PostgreSQL unter MS Windows zu installieren, besteht darin, Cygwin mit dem PostgreSQL-Package zu installieren. Alternative Installationsvarianten werden auf dieser Seite angeführt.

2.2.2.1.1 Anlegen eines Benutzers und einer Datenbank für MOA SP/SS

Damit die MOA SP/SS Module eine Verbindung zu PostgreSQL aufbauen kann, müssen der Name eines PostgreSQL-Benutzers und einer PostgreSQL-Datenbank bekannt sein. Sollten diese nicht vorhanden sein, kann mit folgenden Kommandos ein Benutzer namens moa und eine Datenbank namens moadb angelegt werden:

createuser -U postgres -d -A -P moa
createdb -U moa moadb

Da die MOA SP/SS Module über JDBC mit der Datenbank kommunizieren, ist in der Folge die Angabe einer JDBC-URL notwendig, welche die Verbindungsparameter enthält. Wurden der Benutzer und die Datenbank wie im obigen Beispiel angelegt, ist folgende JDBC-URL anzugeben (Annahme: als Passwort für den Benutzer moa wurde moapass gewählt):

 jdbc:postgresql://host/moadb?user=moa&password=moapass

Die Zeichen jdbc:postgresql:// sind unveränderliche Bestandteile einer PostgreSQL JDBC-URL. host gibt den Rechner an, auf dem PostgreSQL läuft. moadb identifiziert den Namen der Datenbank. Über die Parameter user= und pass= werden Benutzername und Passwort für den DB-User bekanntgegeben.

2.2.2.1.2 Archivierung von CRLs

Zum Archivieren von CRLs müssen in der MOA SP/SS Konfigurationsdatei die Kinder des Elements cfg:MOAConfiguration/cfg:SignatureVerification/cfg:CertificateValidation/cfg:RevocationChecking/cfg:Archiving entsprechend - konfiguriert werden:

cfg:EnableArchiving muss auf den Wert true gesetzt sein;
cfg:ArchiveDuration muss als nichtnegative Ganzzahl die maximale Archivierungsdauer in Tagen enthalten;
cfg:Archive muss genau ein Element cfg:DatabaseArchive enthalten, das wiederum aus zwei Elementen - bestehen muss: -
- cfg:JDBCURL muss eine gültige JDBC-URL enthalten, mit der auf die Datenbank zur Archivierung - zugegriffen werden kann (Hinweis: da es sich hierbei um einen Eintrag - in eine XML-Datei handelt, muss das Zeichen & in der in Abschnitt 2.2.2.1.1 gezeigten - JDBC-URL - durch die Zeichenfolge & ersetzt werden.);
- cfg:JDBCDriverClassName muss den vollständig qualifizierten Java-Klassennamen des JDBC-Treibers - enthalten.
-

Vergleiche auch Abschnitt 2.3.1.3.4 im - Konfigurationshandbuch.

2.2.2.1.3 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 text);

Damit Log4j die Log-Meldungen in diese Datenbanktabelle schreibt, muss die Log4j-Konfiguration adaptiert werden. Die mit MOA SP/SS mitgelieferte, beispielhafte Log4j-Konfiguration enthält bereits die notwendigen Einträge für das Logging in eine PostgreSQL Datenbank, die jedoch standardmäßig ausgeschaltet sind.

Wie beim Caching von CRLs ist auch hier die Angabe einer JDBC-URL notwendig, damit die MOA SP/SS Module eine Verbindung zur Datenbank aufnehmen können.

Bitte beachten Sie: Bei Tests hat sich das Logging in eine Datenbank mit Jakarta Log4j als Performance-Engpass herausgestellt. Es wird deshalb empfohlen, dieses Feature mit Bedacht einzusetzen.

2.2.2.2 Andere Datenbanken

Über die generische Anbindung JDBC können auch andere Datenbanken für die Archivierung von CRLs bzw. für die Speicherung der Log-Meldungen eingesetzt werden. Hinweise zu bestimmten Datenbanken finden Sie in den FAQ.

Die in Abschnitt 2.2.2.1 gemachten Angaben zu Archivierung von CRLs bzw. zur Speicherung von Log-Meldungen gelten sinngemäß.

2.2.3 Hardware Security Module (HSM)

MOA SS kann für die Erstellung von Signaturen auf die Dienste eines HSM zurückgreifen. Voraussetzung dafür ist, dass für das HSM eine Implementierung der Schnittstelle PCKS#11 (PKCS#11-Bibliothek) angeboten wird.

Für die Einbindung des HSM in MOA SS müssen zunächst die Bibliotheken aus $MOA_SL_INST/pkcs11 in ein beliebiges Verzeichnis kopiert werden, welches dann in den Libray-Pfad des jeweiligen Betriebssystems aufgenommen werden muss (Windows: Umgebungsvariable PATH; Linux: Umgebungsvariable LD_LIBRARY_PATH).

Der Name der für das HSM spezifischen PKCS#11-Bibliothek muss in der Konfigurationsdatei eingetragen werden (vergleiche Abschnitt 2.2.1.1 des Konfigurationshandbuchs).

3 Klassenbibliothek

Dieser Abschnitt beschreibt die Verwendung von MOA SP/SS als Klassenbibliothek. Im ersten Unterkapitel wird eine minimale Basisinstallation beschrieben. Das zweite Unterkapitel zeigt eine Reihe von optionalen Erweiterungsmöglichkeiten auf.

3.1 Basisinstallation

3.1.1 Einführung

Die Basisinstallation der Klassenbibliothek stellt einerseits die minimalen Anforderungen für den Einsatz von MOA SP/SS als Klassenbibliothek dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.

Folgende Software ist Voraussetzung für die Basisinstallation der Klassenbibliothek:

J2SE 1.3.1 JRE oder J2SE 1.4.2 JRE oder J2SE 5.0 JRE

3.1.2 Vorbereitung

Die folgenden Schritte dienen der Vorbereitung der Installation.

Installation von J2SE SDK

Installieren Sie J2SE 1.3.1 SDK oder J2SE 1.4.2 SDK oder J2SE 5.0 SDK in ein beliebiges Verzeichnis. Wir empfehlen die Installation von J2SE 5.0 SDK. Das Wurzelverzeichnis der J2SE SDK Installation wird im weiteren Verlauf als $JAVA_HOME bezeichnet.

Entpacken der MOA SP/SS Klassenbibliotheks-Distribution

Entpacken Sie die Datei moa-spss-1.2.x-lib.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_SL_INST bezeichnet.

Installation der Krypographiebibliotheken von SIC/IAIK

Die Installation der Kryptographiebibliotheken von SIC/IAIK ist abhängig vom eingesetzten J2SE SDK:

J2SE 1.3.1 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SL_INST/ext13 in das Verzeichnis $JAVA_HOME/jre/lib/ext.
J2SE 1.4.2 SDK oder JSE 5.0 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SL_INST/ext14 in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihres J2SE 1.4.2 SDK bzw. J2SE 5.0 SDK austauschen. Laden Sie dazu die Unlimited Strength Jurisdiction Policy Files von der J2SE 1.4.2 SDK Downloadseite bzw. J2SE 5.0 SDK Downloadseite und folgen Sie der darin enthaltenen Installationsanweisung.

3.1.3 Verwendung

Um die MOA SP/SS Klassenbibliothek in einer Applikation verwenden zu können, müssen die mit MOA SP/SS ausgelieferten Bibliotheken in den Java Klassenpfad der Applikation eingebunden werden.

Die nachfolgende Tabelle listet diese Klassenbibliotheken auf; die Einträge in der Spalte Dateien sind relativ zum Verzeichnis $MOA_SL_INST zu interpretieren.

Der nächste Wert 10 15:58:45,531 +gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in +diesem Fall den 10. Tag im aktuellen Monat, sowie die genaue Uhrzeit).

Der Wert slinterface.listeners gibt +die Log-Hierarchie an, aus der die Log-Meldung stammt.

Der Wert main bezeichnet den Thread, +aus der die Log-Meldung stammt.

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.5.4 +Prüfen des erfolgreichen Starts

Ein erfolgreicher Start des MOA SL Webservices ist an +folgender Log-Meldung ersichtlich:

INFO | 10 15:58:45,531 | slinterface.listeners | main | 
 Web application initialization succeeded..

Konnte das MOA SL Webservice nicht +ordnungsgemäß gestartet werden, führt das +zu folgender Log-Meldung:

FATAL | 18 10:17:03,475 | main | TID=startup NID=<null> 
 Web application initialization failed.

In diesem Fall geben die Log-Meldungen +unmittelbar davor Aufschluss über den genaueren Grund.

Fehlermeldungen während der Initialisierung des +XML-Parsers, die wie nachfolgend dargestellt aussehen, können +ignoriert werden. Sie resultieren aus einem Bug im eingesetzten +XML-Parser Apache Xerces in der Version 2.6.2.

[Error] xhtml-attribs-1.xsd:xx:xx: src-attribute_group.3: 
 Circular definitions detected for attribute group 'xxx'. 
 Recursively following attribute group references eventually leads back to itself.
[Error] xhtml-attribs-1.xsd:xx:xx: src-redefine.7.2.1: 
 No attributeGroup in the redefined schema has a name matching 'xx'.

3 +Konfiguration

3.1 +Zentrale Konfigurationsdatei

Alle Konfigurationsparameter von MOA SL mit Ausnahme des +Layouts für den Prüfbericht (siehe Abschnitt 3.2) sind in einer +zentralen Konfigurationsdatei zusammengefasst. Eine beispielhafte +Konfigurationsdatei finden Sie unter $MOA_SL_INST/conf/moa-sl/moa-sl.properties. +Für Hinweise, wie Sie dem MOA SL Webservice mitteilen, welche +Konfigurationsdatei es verwenden soll, siehe Abschnitt 2.4.

In den folgenden Abschnitten werden die einzelnen +Konfigurationsparameter der zentralen Konfigurationsdatei im Detail +besprochen. Die meisten Konfigurationsparameter werden leichter +verständlich, wenn Sie zunächst das Systemhandbuch lesen. Dort werden +der gesamte Ablauf eines Signaturprüfvorgangs in MOA SL sowie +die daran beteiligten Komponenten erklärt.

Die Konfigurationsdatei ist als Java +Properties Datei aufgebaut, d. h. jede Zeile +enthält den Namen sowie den Wert des jeweiligen +Konfigurationsparameters in der Form name=wert. +Details zum Aufbau einer Java +Properties Datei finden Sie in der API-Dokumentation zu +Ihrem Java JDK, beispielsweise hier. +

3.1.1 +XML-Schemata für Request- und Response-Validierung

Name location.schema.sl

Erläuterung

Mit diesem Konfigurationsparameter wird MOA SL +mitgeteilt, wo es das XML-Schema für die Validierung eines +eingehenden Signaturprüfungsrequests nach Security-Layer V1.2 +findet.

+ +

Der Konfigurationsparameter muss als Wert einen Pfad +enthalten, der mit / beginnt, und der von MOA +SL als relativ zum Context Root +der Webapplikation interpretiert wird.

+ +

Beispiel

/WEB-INF/classes/resources/schemas/Core.20031231.xsd

+ +

Klassenbibliothek	Version	Dateien
MOA SP/SS	1.2.x	`moa-spss.jar`, `moa-common.jar`
MOA IAIK	1.0.7	`lib/iaik_moa_full.jar`, `lib/iaik_Pkcs11Wrapper.jar`, - `lib/iaik_cms.jar`, `lib/iaik_ixsil.jar` -
JAXP	1.2_01	`lib/jaxp-api.jar`, `lib/sax.jar`, `lib/dom.jar`
Xerces-J	2.4.0	`lib/xercesImpl.jar`, `lib/xmlParserAPIs.jar`
Xalan-J	2.5.1	`lib/xalan.jar` - Bitte beachten Sie: Wenn Sie J2SE 1.4.2 JRE oder J2SE 5.0 JRE verwenden, müssen Sie diese Bibliothek der Java VM als endorsed bekanntgeben. Sie können dies tun, indem Sie entweder - - die Bibliothek in das (ggf. vorher anzulegende) Verzeichnis `$JAVA_HOME/jre/lib/endorsed/` kopieren; oder - die System Property `java.endorsed.dirs` verwenden, und als Wert den Pfad zu jenem Verzeichnis angeben, in dem Sie die Bibliothek vorhalten (also z.B. `java.endorsed.dirs=c:/mylibdir`). -
Jaxen	1.0	`lib/jaxen-core.jar`, `lib/jaxen-dom.jar`, `lib/saxpath.jar`
Commons-Logging	1.0.4	`lib/commons-logging-api.jar`, `lib/commons-logging.jar`
Log4j	1.2.7	`lib/log4j-1.2.7.jar`
Commons-Discovery	0.2	`lib/commons-discovery.jar`
JSSE	1.0.3_01	Diese Bibliotheken benötigen Sie nur, wenn Sie J2SE 1.3.1 verwenden: - `lib/ext13/jsse.jar`, `lib/ext13/jcert.jar`, `lib/ext13/jnet.jar` - Bitte beachten Sie: Diese Bibliotheken benötigen Sie nur, wenn Sie J2SE 1.3.1 verwenden.
Postgres JDBC2	7.3	`lib/pg73jdbc2.jar` - Bitte beachten Sie: Wenn Sie keine Datenbank für MOA SP/SS verwenden (vergleiche 2.2.2), benötigen Sie diese Bibliothek nicht.

3.1.4 Logging

Die MOA SP/SS Klassenbibliothek verwendet Jakarta Log4j für die Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Die im Abschnitt 2.1.3 gemachten Aussagen lassen sich großteils auf den Einsatz der MOA SP/SS Klassenbibliothek übertragen.

3.2 Erweiterungsmöglichkeiten

Die im Abschnitt 2.2 angeführten Erweiterungsmöglichkeiten für die MOA SP/SS Webservices gelten in analoger Weise auch für die Klassenbibliothek.

A Referenzierte Software

Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

Name	Beschreibung
Apache Tomcat 4.1.x	Servlet-Container des Apache Jakarta Projekts in der Version 4.1.x
J2SE 1.4.2 SDK/JRE	Java 2 Standard Edition in der Version 1.4.2 (Software Development Kit bzw. Java Runtime Environment)
J2SE 5.0 SDK/JRE	Java 2 Standard Edition in der Version 5.0 (Software Development Kit bzw. Java Runtime Environment)
Apache Log4J	Logging Framework des Apache Projekts
Name	`location.schema.moa`
Erläuterung	+ Mit diesem Konfigurationsparameter wird MOA SL +mitgeteilt, wo es das XML-Schema für die Validierung eines von +MOA SP empfangenen Signaturprüfungsresponses nach MOA SPSS +V1.3 findet. + + Der Konfigurationsparameter muss als Wert einen Pfad +enthalten, der mit `/` beginnt, und der von MOA +SL als relativ zum Context Root +der Webapplikation interpretiert wird. + +
Beispiel	+ `/WEB-INF/classes/resources/schemas/MOA-SPSS-1.3.xsd` + +

3.1.2 +Arbeitsverzeichnis

Name location.tempdir

Erläuterung

Mit diesem Konfigurationsparameter wird MOA SL +mitgeteilt, wo es das Arbeitsverzeichnis zum Ablegen der von einer +geprüften Signatur abgesicherten Dokumente findet. Diese +Dokumente werden temporär gespeichert, damit sie vom Benutzer +über den Prüfbericht abgerufen werden +können.

+ +

Der Konfigurationsparameter muss als Wert einen Pfad +enthalten, der von MOA SL als relativ zum Context +Root der Webapplikation interpretiert wird. Der angegebene +Pfad muss einen abschließenden / +aufweisen und im Dateisystem tatsächlich existieren.

+ +

Beispiel

/workdir/temp/

+ +

3.1.3 +Parameter der verwendeten MOA SP Installation

Name service.sp.endpoint

Erläuterung

Mit diesem Konfigurationsparameter wird MOA SL der +Zugangspunkt zum Webservice von MOA SP mitgeteilt.

+ +

Der Konfigurationsparameter muss eine URL enthalten, die +von MOA SL aus erreichbar ist und den Zugangspunkt zu MOA SP +adressiert.

+ +

Beispiel

http://localhost:8080/moa-spss/services/SignatureVerification

+ +

Name service.sp.trustProfileId

Erläuterung

Mit diesem Konfigurationsparameter wird MOA SL +mitgeteilt, welches Vertrauensprofil es im Signaturprüfrequest +an MOA SP verwenden soll.

+ +

Der Konfigurationsparameter muss den Bezeichner eines in +MOA SP hinterlegten Vertrauensprofils enthalten.

+ +

Hinweis: Zum Durchlaufen der +Testapplikation nach Abschnitt 4 +dieses Handbuchs müssen Sie in MOA SP ein Vertrauensprofil mit +dem Namen MOA-SL-Test einrichten. Unter $MOA_SL_INST/conf/moa-spss/trustprofiles/spssconfig.fragment +finden Sie das dazu notwendige XML-Fragment zum +Einfügen in die Konfigurationsdatei von MOA SP. Unter $MOA_SL_INST/conf/moa-spss/trustprofiles/moa-sl/test/ +finden Sie das im XML-Fragment referenzierte Verzeichnis mit den +für das Vertrauensprofil notwendigen Zertifikatsdateien.

+ +

Beispiel

MOA-SL-Test

+ +

3.1.4 +Umfang der Prüfberichtseite

Name result.showetsi

Erläuterung

Dieser Konfigurationsparameter gibt an, ob MOA SL auf +der Prüfberichtseite unter den signierten Dokumenten auch +eventuell vorhandenene, mitsignierte Signatureigenschaften (z.B. das +Signaturdatum) auflisten soll. Signatureigenschaften sind in der Regel +vorhanden, wenn die zur Prüfung eingereichte Signatur von +einer Bürgerkartenumgebung erstellt worden ist.

+ +

Der Konfigurationsparamter muss einen der Werte true +oder false aufweisen.

+ +

Beispiel

false

+ +

Name result.showslmanifest

Erläuterung

Dieser Konfigurationsparameter gibt an, ob MOA SL auf +der Prüfberichtseite unter den signierten Dokumenten auch ein +eventuell vorhandenes, mitsigniertes Signaturmanifest +nach Security-Layer V1.2 auflisten soll.

+ +

Der Konfigurationsparamter muss einen der Werte true +oder false aufweisen.

+ +

Beispiel

false

+ +

3.1.5 +Parameter für das Umschreiben der Links in der +Prüfberichtseite

Insbesondere zum Verständnis dieses Abschnitts +sollten Sie zunächst das Systemhandbuch lesen. +Dort werden der gesamte Ablauf eines Signaturprüfvorgangs in +MOA SL sowie die daran beteiligten Komponenten erklärt.

Name rewrite

Erläuterung

Dieser Konfigurationsparameter gibt an, ob MOA SL Links +auf der Prüfberichtseite umschreiben soll.

+ +

der

+ +

Beispiel

true

+ +

Name rewrite.proxyURL

Erläuterung

Dieser Konfigurationsparameter enthält die URL +des Rewrite-Proxy. Der Rewrite-Proxy ist jener Rechner, +der (möglicherweise im Gegensatz zum Rechner, auf dem MOA SL +läuft) vom Internet aus erreichbar ist, und über den +alle Anfragen vom Benutzer an MOA SL geleitet werden.

+ +

Teil der mit diesem Konfigurationsparameter angegebenen +URL ist der Platzhalter für den Domänennamen des Rewrite-Proxy. Wie dieser +Platzhalter aussehen muss, wird im Konfigurationsparameter rewrite.proxyURL.proxyhostDummy +festgelegt. Im unten angegebenen Beispiel lautet der Platzhalter <proxyhost>.

+ +

Beispiel

http://<rewriteproxyhost>:1234/rewrite

+ +

Name rewrite.proxyURL.proxyhostDummy

Erläuterung

Dieser Konfigurationsparameter enthält das +Format für den Platzhalter für den +Domänennamen des Rewrite-Proxy. +Der Platzhalter im Konfigurationsparameter rewrite.proxyURL +muss genau diesem Format entsprechen.

+ +

Notwendig ist dieser Platzhalter, weil MOA SL bei der +Erstellung der Prüfberichtseite alle Vorkommnisse dieses +Platzhalters in der Prüfberichtseite durch den +Domänennamen jener IP-Adresse ersetzt, von der aus der +Signaturprüfrequest an MOA SL gesendet wurde. Die +Konfiguration des dazu notwendigen Reverse +DNS Lookup geschieht mit dem Konfigurationsparameter rewrite.dn.*. +

+ +

Beispiel

<rewriteproxyhost>

+ +

Name rewrite.dn.*

Erläuterung

Dieser (bzw. diese) Konfigurationsparameter definieren +die Lookup-Tabelle für das Reverse +DNS Lookup im Zuge der Umschreibung von Links in der +Prüfberichtseite, damit diese ausschließlich +über den Rewrite-Proxy +abgerufen werden können.

+ +

Der Aufbau der Konfigurationsparameter entspricht dabei +dem Schema+rewrite.dn.<IP-Adresse>=<Domänenname>. +

+ +

Der Default-Domänenname, der für die +Umschreibung verwendet wird, wenn für die IP-Adresse des Rewrite-Proxy kein Eintrag in der +Lookup-Tabelle definiert wurde, wird wie folgt angegeben: rewrite.dn.default=<Domänenname>. +

+ +

Das Beispiel geht von zwei möglichen Rewrite-Proxys aus, denen die +IP-Adressen 192.168.0.101 bzw. 192.168.0.102 +zugeordnet sind. Die nach außen sichtbaren Namen dieser Rewrite-Proxys lauten rewriteproxyhost1 +und rewriteproxyhost2. rewriteproxyhost1 +ist als Standard-Rewrite-Proxy +konfiguriert.

+ +

Beispiel

rewrite.dn.192.168.0.101=rewriteproxyhost1 + +rewrite.dn.192.168.0.102=rewriteproxyhost2 + +rewrite.dn.default=rewriteproxyhost1

+ +

Name rewrite.MOASLUrlParamName

Erläuterung

Dieser Konfigurationsparameter gibt den Namen des +URL-Parameters in den im Signaturprüfbericht für den Rewrite-Proxy umgeschriebenen +Links an, dessen Wert die vom Rewrite-Proxy +für den tatsächlichen Abruf von Daten von MOA SL +enthält.

+ +

Am Wert dieses Konfigurationsparameters erkennt der Rewrite-Proxy, wie der +HTTP-Request an den Rewrite-Proxy +in einen HTTP-Request an das MOA SL Webservice umzusetzen ist. Lautet +eine im Signaturprüfbericht enthaltene URL z.B. http://rewriteproxyhost1:1234/rewrite?targetURL=http://moaslhost:8080/moa-sl/showdata?hidCount=0, +dann geht zunächst ein HTTP-Request an den Rewrite-Proxy (der auf dem +Rechner mit dem Namen rewriteproxyhost1 unter Port 1234 +lauscht). Der Rewrite-Proxy +entnimmt nun aus dem URL-Parameter targetURL +die URL für die Umsetzung an MOA SL, also http://moaslhost:8080/moa-sl/showdata?hidCount=0. +Der Rewrite-Proxy setzt +nun einen entsprechenden HTTP-Request an MOA SL ab; die Antwort von MOA +SL wird als Antwort auf den an den Rewrite-Proxy +gerichteten HTTP-Request weitergegeben.

+ +

Beispiel

targetURL

+ +

Name rewrite.MOASLWebAppServUrl

Erläuterung

Dieser Konfigurationsparameter gibt jene URL an, unter +der der Webapplikationsserver mit MOA SL vom Rewrite-Proxy +aus erreichbar ist.

+ +

Die URL besteht aus Protokoll, Domänennamen +sowie gegebenenfalls Port (wenn dieser nicht dem Standardport +für das Protokoll entspricht). Nach dem Domänennamen +bzw. Port dürfen keine weiteren Bestandteile mehr vorkommen.

+ +

Verwendung findet dieser Konfigurationsparameter als +erster Teil des Werts für den oben besprochenen URL-Parameter (rewrite.sliUrlParamName). +

+ +

Beispiel

http://moaslhost:8080

+ +

3.2 Layout des +Prüfberichts

Die einzige Schnittstelle des MOA SL Webservices zum Benutzer +ist der Prüfbericht über die eingereichte Signatur, +den das Service dem Benutzer in einer für ihn gut +aufbereiteten Form darstellt, bevor das automatisch auswertbare +Prüfprotokoll an die aufrufende Applikation +zurückübermittelt (für eine +Erklärung des gesamten Signaturprüfvorgangs in MOA SL +sowie der daran beteiligten Komponenten vergleiche das Systemhandbuch).

Das Layout des Prüfberichts, das in der JSP-Seite $MOA_SL_WEBAPP/pages/resultOverview.jsp +($MOA_SL_WEBAPP steht für den Ort der +Webapplikatioin, für gewöhnlich ist das+$CATALINA_HOME/webapps) festgelegt ist, kann +völlig frei gestaltet werden.

Wenn Sie das Layout gegenüber der Vorgabe +verändern möchten, editieren Sie einfach die +HTML-Teile dieser JSP-Seite. Beachten Sie bitte, dass Sie dabei die +JSP-Scriptelemente unverändert lassen. JSP-Scriptelemente sind +entweder Tags, die mit dem Präfix jsp +gekennzeichnet sind (z.B. <jsp:useBean> +oder <jsp:getProperty>, oder +Bereiche die mit der Kennzeichnung <% +eingeleitet bzw. mit der Kennzeichnung %> +ausgeleitet werden.

4 +Durchlaufen der Testapplikation

Konnte das MOA SL Webservice entsprechend Abschnitt 2.5.4 +erfolgreich initialisiert werden, und haben Sie weiters die +Konfiguration des MOA SL Webservices entsprechend Abschnitt 3 an Ihre Anforderungen +angepasst, sollten Sie schließlich prüfen, ob die +mit MOA SL mitgelieferte Testapplikation erfolgreich durchlaufen werden +kann.

Beginnen Sie bitte, in dem Sie einen Webbrowser starten und +sich mit folgender Seite verbinden, die Teil des MOA SL Webservices +ist. Sollte Ihre Tomcat-Installation unter einer anderen Adresse als localhost:8080 +erreichbar sein, passen Sie die URL bitte entsprechend an.

http://localhost:8080/moa-sl/pages/test/forms/verify.slxhtml.jsp

Die aufgerufene Webseite sollte in etwa wie folgt aussehen +(für eine größere Darstellung bitte +klicken):

Durch Abschicken des dargestellten Formulars wird ein +vorbereiteter Signaturprüfungsrequest entsprechend der +Spezifikation des Security-Layers an MOA SL übermittelt. Als +weiterer Parameter wird eine DataURL ebenfalls ensprechend der +Spezifikation des Security-Layers angegeben. Beide Parameter sind auf +das installierte MOA SL Webservice abgestimmt und können +unverändert übernommen werden.

Wenn das Formular an an MOA SL übermittelt wurde, +antwortet MOA SL mit dem Signaturprüfbericht, der in etwa wie +folgt aussehen sollte:

Sollten Sie an statt des Prüfberichts eine +Fehlerseite von Tomcat erhalten, liegt das mit hoher Wahrscheinlichkeit +daran, dass das Zusammenspiel von MOA SL mit MOA SPSS nicht korrekt +konfiguriert wurde. Prüfen Sie dann Ihre Konfiguration +entsprechend den Angaben in Abschnitt 3.1.3.

Wenn Sie den Prüfbericht zwar erhalten, der Text zu +Prüfungen/Zertifikat jedoch in rot gehalten ist und auf einen +Fehler bei der Zertifikatsprüfung hinweist, wurde das +für die Testapplikation notwendige Vertrauensprofil in MOA +SPSS nicht korrekt konfiguriert. Folgen Sie dann den Hinweisen in +Abschnitt 3.1.3.

Der Prüfbericht selbst enthält Informationen +zum Ersteller der Signatur, zum Aussteller des Zertifikats, +über Seriennummer und Qualität des Zertifikats, sowie +über die durchgeführten Prüfungen +bezüglich der Signatur selbst sowie des verwendeten +Zertifikats. Nach diesen Informationen enthält der +Prüfbericht eine Liste der von der Signatur gesicherten +Dokumente. In unserem Fall erstreckt sich die Signatur über +genau ein Dokument. Dieses Dokument kann durch einen Klick auf den +entsprechenden Link in einem neuen Fenster geöffnet werden. +Das geöffnete Dokument sollte in etwa wie folgt aussehen:

Wenn Sie schließlich im Prüfbericht dem +Link Zurück zur Anwendung ... +folgen, gelangen Sie zur Abschlussseite der Testapplikation:

Die Abschlussseite präsentiert in Tabellenform die +Informationen, die vom MOA SL Webservice als automatisch auswertbare +Information entsprechend der Spezifikation des Security-Layers an den DataURL-Server +(vergleiche Parameter auf der Startseite der Testapplikation) +übermittelt. Im Wesentlichen ist das der +Signaturprüfresponse entsprechend der Spezifikation des +Security-Layers.

MOA SS und SP - Installation

MOA SL - Systemhandbuch

Open Source
- für das E-Government

Open +Source
+ +für das E-Government

MOA: Serversignatur (SS) und Signaturprüfung (SP), V 1.3

Installation

Inhalt

-
Übersicht
-
-
Webservice
-
1. Basisinstallation -
  1. Einführung
  2. Installation -
    -
  3. Logging -
    1. Format der Log-Meldungen
    2. Wichtige Log-Meldungen
    -
  -
2. Erweiterungsmöglichkeiten
  1. Vorgeschalteter Webserver
    1. Microsoft Internet Information Server (MS IIS)
      -
    2. Apache
      -
    -
  2. Datenbank
    1. PostgreSQL
      -
    2. Andere Datenbanken
    -
  -
-
Klassenbibliothek -
1. Basisinstallation -
  1. Einführung
  2. Vorbereitung
  3. Verwendung
  4. Logging
  -
2. Erweiterungsmöglichkeiten
-

Referenzierte Software

1 Übersicht

Die Module Signaturprüfung (SP) und Serversignatur (SS) sind als plattformunabhängige Module ausgelegt, die entweder als Webservice über HTTP bzw. HTTPS oder als Klassenbibliothek über ein API angesprochen werden können. Dieses Handbuch beschreibt die Installation der beiden Module als Webservice oder als Klassenbibliothek, sowie die Einrichtung der Systemumgebung.

2 Webservice

Dieser Abschnitt beschreibt die Installation von MOA SP/SS als Webservice. 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 des Webservices stellt einerseits die minimalen Anforderungen für den Betrieb von MOA SP/SS als Webservices dar, andererseits dient sie als Ausgangspunkt für optionale Erweiterungsmöglichkeiten.

Folgende Software ist Voraussetzung für die Basisinstallation des Webservices:

J2SE 1.3.1 SDK oder J2SE 1.4.2 SDK oder J2SE 5.0 SDK
Apache Tomcat 4.1.18 oder höher

In diesem Betriebs-Szenario wird das MOA SP/SS Webservice in Tomcat zum Einsatz gebracht. Tomcat fungiert gleichzeitig als HTTP- und HTTPS-Endpunkt für das MOA SP/SS Webservice. Beide Protokolle werden direkt in Tomcat konfiguriert. Das MOA SP/SS Webservice verwendet Log4j als Logging Toolkit.

2.1.2 Installation

2.1.2.1 Vorbereitung

Die folgenden Schritte dienen der Vorbereitung der Installation.

Installation von J2SE SDK

Installation von Apache Tomcat 4.1

Installieren Sie Apache Tomcat 4.1.18 oder höher in ein Verzeichnis, das keine Leerzeichen im Pfadnamen enthält. Wir empfehlen die Installation von Apache Tomcat 4.1.31. Verwenden Sie bitte die zu Ihrem J2SE SDK passende Distribution von Tomcat. Das Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als $CATALINA_HOME bezeichnet.

Entpacken der MOA SP/SS Webservice Distribution

Entpacken Sie die Datei moa-spss-1.2.x.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_SPSS_INST bezeichnet.

Installation der Krypographiebibliotheken von SIC/IAIK

Die Installation der Kryptographiebibliotheken von SIC/IAIK ist abhängig vom eingesetzten J2SE SDK:

J2SE 1.3.1 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis - - - $MOA_SPSS_INST/ext13 in das Verzeichnis $JAVA_HOME/jre/lib/ext.
J2SE 1.4.2 SDK oder JSE 5.0 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SPSS_INST/ext14 in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihres J2SE 1.4.2 SDK bzw. J2SE 5.0 SDK austauschen. Laden Sie dazu die Unlimited Strength - - - Jurisdiction Policy Files von der J2SE 1.4.2 SDK Downloadseite bzw. J2SE 5.0 SDK Downloadseite und folgen Sie der darin enthaltenen Installationsanweisung.

2.1.2.2 Konfiguration von Apache Tomcat

2.1.2.2.1 Konfiguration des HTTP Connectors

Die Datei $MOA_SPSS_INST/tomcat/server.xml enthält eine minimale Tomcat-Konfiguration, die ausschließlich den Connector für HTTP auf Port 8080 freischaltet. Durch kopieren dieser Datei nach $CATALINA_HOME/conf/server.xml kann Tomcat mit dieser Konfiguration gestartet werden. Wir empfehlen diese Konfiguration nur für Fälle, in denen das MOA SP/SS Webservice in einer abgeschlossenen Netzwerkumgebung betrieben wird.

2.1.2.2.2 Konfiguration des HTTPS Connectors

Wird das MOA SP/SS Webservice in einer nicht abgeschlossenen Umgebung (z.B. Erreichbarkeit über das Internet) betrieben, ist die gegenseitige Identitätsfeststellung von Kunde und Webservice essentiell:

Nutzt ein Kunde MOA SP, ist es für ihn wichtig, die Identität des Webservice eindeutig feststellen zu können, denn er vertraut dem Webservice ja die Prüfung einer elektronischen Signatur an.
Nutzt ein Kunde MOA SS, ist es für ihn wesentlich, dass nur er Zugriff auf die für ihn vom Webservice verwalteten privaten Schlüssel hat, um elektronische Signaturen zu erstellen. Das Webservice muss also die Identität des Kunden prüfen.

Beide Identitätsprüfungen können mit hoher Qualität vorgenommen werden, wenn die Erreichbarkeit des Webservice auf SSL mit Server- (für MOA SP) bzw. Client- und Serverauthentisierung (für MOA SS) eingeschränkt wird.

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 ZertiServer-Zertifikat enthält. Sie können diesen Keystore z.B. mit keytool erstellen, einem Programm, das Ihrem J2SE SDK beiliegt.
Erstellung eines Client-Keystores, der die Zertifikate aller Kunden des Webservices enthält. Nur Kunden des Webservices, die sich beim Aufbau einer SSL-Verbindung gegenüber dem Webservice mit einem im Client-Keystore enthaltenen Zertifikat ausweisen, erhalten grundsätzlich Zugriff zu den Diensten des Webservices (für die Konfiguration, welcher Kunde welche Schlüssel von MOA SS verwenden darf, siehe Abschnitt 2.2.3 des Konfigurationshandbuchs). Auch dieser Keystore kann z.B. mit keytool erstellt werden. Dieser Keystore ist optional und braucht nur erstellt zu werden, wenn sich die Kunden gegenüber dem Webservice authentisieren müssen.
Konfiguration des HTTPS Connectors in $CATALINA_HOME/conf/server.xml.

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.2.3 Einrichten des MOA SP/SS Administrators

Das MOA SP/SS Webservice kann remote durch den Aufruf einer speziellen URL des Webservices dazu veranlasst werden, seine Konfiguration neu einzulesen (vergleiche Abschnitt 2.1.2.5). Der Zugriff auf diese URL ist durch eine Passwort-Abfrage geschützt, und kann nur von Tomcat-Benutzern aufgerufen werden, denen die Tomcat-Benutzer-Rolle moa-admin zugeordnet wurde.

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-chief" password="openSesam" roles="moa-admin"/>

Soll der Aufruf dieser URL niemandem ermöglicht werden, sind die oben beschriebenen Einträge einfach nicht vorzunehmen.

2.1.2.3 Einsatz des MOA SP/SS Webservices in Tomcat

Um das MOA SP/SS Webservice in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

MOA: +Serverseitige Signaturprüfung (SL), V 1.1

Systemhandbuch

Inhalt

+
Einführung
+ +
Überblick
Komponenten +
1. Der +Filter SL2MOAFilter +
2. Das +Servlet MOAServlet +
3. Die +JSP-Seite resultOverview.jsp +
4. Das +Servlet HashInputDataServlet
5. Das +Servlet ReturnServlet
6. Die +Klasse URLRewriter
7. Der +Deployment Descriptor web.xml
+ +
Zusammenspiel der +Komponenten +
1. Basisablauf
2. Ablauf mit Rewrite-Proxy
+ +

1 +Einführung

Das Modul Serverseitige +Signaturprüfung (MOA SL) ist als +plattformunabhängiges Modul ausgelegt, das als Webservice +über HTTP bzw. HTTPS angesprochen werden kann.

Dieses Handbuch beschreibt den Aufbau von MOA SL. Abschnitt 2 +bietet einen groben Überblick über die Funktionsweise +von MOA SL. Abschnitt 3 beschreibt die einzelnen Komponenenten, aus +denen MOA SL aufgebaut ist. Abschnitt 4 schließlich +beschreibt das Zusammenspiel der einzelnen Komponenten.

Für die Installation und die Konfiguration von MOA SL +siehe Betriebshandbuch. +

2 +Überblick

Das Modul Serverseitige +Signaturprüfung (MOA SL) bietet für +Signaturprüfung eine serverseitige Implementierung einer +Bürgerkarten-Umgebung entsprechend den Spezifikationen +zur österreichischen Bürgerkarte in der +Version 1.2.

Der Funktionsumfang von MOA SL kann wie folgt zusammengefasst +werden:

Die Datei $MOA_SPSS_INST/moa-spss.war enthält das einsatzfertige MOA SP/SS 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-spss entpackt.
Die zentrale Konfigurationsdatei für MOA SP/SS und die zugehörigen Profil-Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-spss). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA SP/SS Webservices dienen kann, finden Sie hier.
Wird Tomcat unter J2SE 1.4.x SDK oder höher betrieben, müssen die Dateien xalan.jar, xercesImpl.jar und xmlParserAPIs.jar aus dem Verzeichnis $MOA_SPSS_INST/endorsed14 in das Tomcat-Verzeichnis $CATALINA_HOME/common/endorsed kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xml-apis.jar muss gelöscht 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.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.
- moa.node.id: Frei wählbarer Name des Rechner-Knotens, auf dem MOA SP/SS läuft. Der Name des Knotens wird bei Log-Ausgaben von MOA SP/SS angeführt und dient zur Unterscheidung mehrerer gleichzeitig betriebener MOA SP/SS Webservice-Instanzen.
- 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.
+ +
Von den XML-Befehlen der Applikationsschnittstelle +Security-Layer wird genau ein Befehl unterstützt, +und zwar jener zur Prüfung von XML-Signaturen (VerifyXMLSignature).
Hinsichtlich der Transportprotokolle +des Security-Layer wird ausschließlich die +HTTP-Bindung unterstützt, wobei für diese Bindung +zusätzlich folgende Einschränkungen gelten: +
- Keine Unterstützung der Formularparameter +RedirectURL und StylesheetURL.
- Verpflichtende Verwendung des Formularparameters +DataURL.
- Keine Unterstützung von Weitergabe-Parametern +und Weitergabe-Headern.
- Keine Referenzierbarkeit von Formularfeldern.
- Hinsichtlich der Ablaufsteuerung laut Abschnitt +3.2.3 wird ausschließlich Fall 5e +unterstützt.
+
Hinsichtlich der Anzeigeformate des Security-Layer wird +ausschließlich das Standardanzeigeformat +des Security-Layers unterstützt. Liegen die von der +zu prüfenden Signatur gesicherten Daten in einem anderen +Format vor, können diese nicht angezeigt, sondern stattdessen +per Download bezogen werden.

2.1.2.4 Starten und Stoppen von Tomcat

2.1.2.4.1 Unter Windows

Das Verzeichnis $MOA_SPSS_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 des eingesetzten J2SE SDK) 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_SPSS_INST/tomcat/unix/moa-env.sh enthält ein Beispiel dafür. Weiters müssen noch die Umgebungsvariablen JAVA_HOME (Basisverzeichnis des eingesetzten J2SE SDK) und CATALINA_HOME (Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst werden.

Nun kann Tomcat aus seinem Basisverzeichnis mit

bin/catalina.sh start

bin/catalina.sh stop

2.1.2.4.3 Prüfen des erfolgreichen Starts

Ein erfolgreicher Start des MOA SP/SS Webservices ist an folgender Log-Meldung ersichtlich:
-

INFO | 18 10:09:45,155 | main | TID=startup NID=<null> MSG=MOA Konfiguration erfolgreich geladen
-

http://<host>:<port>/moa-spss/services/SignatureCreation
-

bzw. + +

3 +Komponenten

3.1 +Der Filter `SL2MOAFilter`

Die Klasse SL2MOAFilter +ist ein +Filter, +der einerseits +den HttpServletRequest +verändert, bevor er an das Servlet MOAServlet +weitergeleitet wird, und andererseits den HttpServletResponse +verändert, nachdem er vom Servlet MOAServlet +bearbeitet wurde.

Der HttpServletRequest +enhält ja zunächst den Request zur Prüfung +der XML-Signatur in einem Format entsprechend der Spezifikationen +zur österreichischen Bürgerkarte in der +Version 1.2 (SL-Request). Das MOAServlet +erwartet sich jedoch den +Request zur Prüfung der XML-Signatur in einem Format +entsprechend der Webservice-Schnittstelle für das Basismodul +MOA SP (MOA-Request). Aufgabe des SL2MOAFilters +ist es daher, vor der Ausführung des MOAServlets +für eine passende Umsetzung des SL-Requests in den +entsprechenden MOA-Request zu sorgen. Zur Erfüllung dieser +Aufgabe bedient sich der SL2MOAFilter +der Klasse SL2MOA, +in der die +Request-Transformation gekapselt ist.

Das MOAServlet +würde dann die Antwort des Basismoduls MOA SP in einem Format +entsprechend der Webservice-Schnittstelle für das Basismodul +MOA SP (MOA-Response) retournieren. Die Anwendung, die das MOAServlet +aufruft, erwartet sich jedoch die Antwort auf den Request zur +Prüfung +der XML-Signatur in einem Format entsprechend der Spezifikationen +zur österreichischen Bürgerkarte in der +Version 1.2 (SL-Response). Aufgabe des SL2MOAFilters +ist es daher, nach der Ausführung des MOAServlets +für eine passende Umsetzung der MOA-Response in die +entsprechende SL-Response zu sorgen. Zur Erfüllung +dieser +Aufgabe bedient sich der SL2MOAFilter +der Klasse MOA2SL, +in der die +Response-Transformation gekapselt ist.

Eine weitere Aufgabe der Klasse SL2MOAFilter +ist es schließlich, die JSP-Seite resultoverview.jsp +einzubinden, die für eine benutzertaugliche HTML-Darstellung +der SL-Response sorgt. Diese benutzertaugliche Darstellung wird dann +tatsächlich als finales Resultat des MOAServlets +an die Anwendung zurückübermittelt. Bevor die +JSP-Seite eingebunden wird, erzeugt SL2MOAFilter +Java Beans aus den Informationen der SL-Response und speichert sie im +Request Scope bzw. Session Scope. Diese Java Beans werden dann von der +JSP-Seite zum +Aufbau der benutzertauglichen HTML-Darstellung herangezogen. +Für weitere Informationen zur JSP-Seite sowie zu den von ihr +verwendeten Java Beans siehe Abschnitt 3.3.

http://<host>:<port>/moa-spss/services/SignatureVerification
-

Konnte das MOA SP/SS Webservice nicht ordnungsgemäß gestartet werden, führt das zu folgender Log-Meldung:

FATAL | 18 10:17:03,475 | main | TID=startup NID=<null> 
  MSG=Fehler beim Lesen der MOA Konfiguration: das Service steht nicht zur Verfügung
-

WARN

ERROR

2.1.2.5 Änderung der Konfiguration im laufenden Betrieb

Sie können die Konfiguration für MOA SP/SS im laufenden Betrieb aktualisieren, in dem Sie mittels eines Web-Browsers folgende URL aufrufen:

 http://<host>:<port>/moa-spss/ConfigurationUpdate

Damit dies funktioniert, muss in der Konfiguration von Tomcat ein spezieller Benutzer sowie eine spezielle Benutzerrolle eingerichtet werden (vergleiche Abschnitt 2.1.2.2.3).

2.1.3 Logging

Das MOA SP/SS Webservice 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 Jakarta Log4j Handbuch beschrieben sind. Unter anderem gibt es die Möglichkeit, folgende Einstellungen vorzunehmen: + +

3.2 +Das Servlet `MOAServlet`

Die Klasse +MOAServlet ist ein HttpServlet +und als solches für die Kommunikation mit dem Basismodul MOA +SP verantwortlich.

Das Servlet liest aus dem ServletInputStream +des HttpServletRequests +den MOA SP Request +zur Prüfung der XML-Signatur und sendet diesen XML-Request +unter Verwendung der Webservice-Schnittstelle von MOA SP an das +Basismodul MOA SP.

Danach liest das Servlet die vom Basismodul MOA SP auf den +Request zur Prüfung der XML-Signatur +rückübermittelte Response und schreibt diese +XML-Response in den ServletOutputStream +der HttpServletResponse.

Das MOAServlet bedient sich zur Kommunikation mit MOA SP der +Klasse +MOAInvoker, in der die +Funktionalität des Webservice-Clients für MOA SP +gekapselt ist.

3.3 Die JSP-Seite `resultOverview.jsp`

Die JSP-Seite resultOverview.jsp ist +verantwortlich für die Aufbereitung +einer benutzertauglichen HTML-Darstellung der SL-Response, die +das Servlet MOAServlet +im Zusammenspiel mit dem Filter SL2MOAFilter +erzeugt.

Die für die Aufbereitung erforderlichen Informationen +werden der JSP-Seite in Form von Java Beans zur Verfügung +gestellt, die zuvor vom SL2MOAFilter +erzeugt worden sind (vergleiche Abschnitt 3.1). +Folgende Java Beans stehen der JSP-Seite zur Verfügung:

-
Das verwendete Log-Level (DEBUG, INFO, WARN, ERROR, FATAL);
-
-
Name und maximale Größe der Log-Datei(en);
-
-
Das Aussehen der Log-Einträge.
-
DataInfoBean: +Enthält +alle notwendigen Informationen zu den von der geprüften +XML-Signatur gesicherten Dokumenten. Beim Erzeugen dieser Java Bean +werden unter anderem die gesicherten Dokumente für den +späteren Abruf durch die Anwendung (vergleiche + Abschnitt 3.4) +im Filesystem zwischengespeichert sowie die Prüfung +vorgenommen, ob es sich bei einem gesicherten Dokument um ein +XHTML-Dokument gemäß Spezifikationen +zur österreichischen Bürgerkarte in der +Version 1.2 handelt (SLXHTML-Dokument) oder nicht. Die Bean ist im +Session Scope abgelegt.
SignerInfoBean: +Enthält +alle notwendigen Informationen zum Ersteller der geprüften +XML-Signatur. Die Bean ist im Servlet Scope abgelegt.
ChecksInfoBean: +Enthält +alle notwendigen Informationen zum Ergebnis der Prüfung der +XML-Signatur. Die Bean ist im Servlet Scope abgelegt.

Das MOA SP/SS Webservice verwendet folgende Log-Hierarchien:

Die JSP-Seite resultOverview.jsp +erzeugt aus den mittels der erwähnten Java Beans zur +Verfügung gestellten Informationen eine HTML-Darstellung. +Diese HTML-Darstellung ist in die folgenden Informationsblöcke +unterteilt:

-
moa.spss.server für alle Log-Meldungen aus dem MOA/SPSS Webservice;
-
-
iaik.server für alle Log-Meldungen aus den SIC/IAIK Kryptographie-Modulen.
-
Informationen zum Ersteller der geprüften +XML-Signatur: Name des Erstellers, Name des Ausstellers des +Zertifikats, Angaben zur Qualität des Zertifikats.
Informationen zum Ergebnis der Prüfung der +XML-Signatur: Ergebnis der Signaturprüfung, Ergebnis der +Prüfung des Zertifikats.
Informationen zu jedem von der XML-Signatur gesicherten +Dokument: Angabe, ob es sich beim Dokument um ein SLXHTML-Dokument +handelt, Link zum Download des gesicherten Dokuments. Wenn es sich um +ein SLXHTML-Dokument handelt, wird das Dokument bei Verfolgung des +Links in einem neuen Browserfenster angezeigt, ansonsten kann das +Dokument heruntergeladen und gespeichert werden.

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 
-  MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification
-

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 Thread-3 bezeichnet den Thread, von dem die Anfrage bearbeitet wird.

Der Wert von NID gibt den Rechner-Knoten an, auf dem das MOA SP/SS Webservice läuft (bei NID=<null> ist dieser Wert nicht konfiguriert, vergleiche Abschnitt 2.1.2.3).

2.1.3.2 Wichtige Log-Meldungen

Die Entgegennahme einer Anfrage wird angezeigt durch: - -

INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Starte neue Transaktion: TID=1049225059594-100, Service=SignatureVerification
-INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Aufruf von Adresse=127.0.0.1
-INFO | 01 21:25:26,540 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Client-Zertifikat nicht verfügbar

INFO | 12 13:58:08,772 | Thread-10 | TID=1045054687159-2 NID=<null> 
-  MSG=Client-Zertifikat: Subject=CN=Testuser, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT, 
-  Serial=1.039.104.204, Issuer=CN=TestCA, OU=MOA, O=BRZ, L=Vienna, ST=Vienna, C=AT

Eine erfolgreich abgearbeitete Anfrage wird angezeigt durch: -

INFO | 01 21:25:53,168 | Thread-3 | TID=1049225059594-106 NID=<null> 
-  MSG=Anfrage erfolgreich abgearbeitet

Ein Fehler beim Abarbeiten der Anfrage wird angezeigt durch:

INFO | 01 21:25:27,642 | Thread-3 | TID=1049225059594-100 NID=<null> 
-  MSG=Fehler beim Abarbeiten der Anfrage

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)

2.2.1.1.1 Konfiguration von Jakarta mod_jk im MS IIS

2.2.1.1.2 Konfiguration von Tomcat

Damit Tomcat die Aufrufe entgegennehmen kann, die von MS IIS mittels Jakarta mod_jk weiterleitet werden, muss in $CATALINA_HOME/conf/server.xml der AJP 1.3 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. Die Datei $MOA_SPSS_INST/tomcat/server.mod_jk.xml enthält eine Konfiguration, die ausschließlich den Port für den AJP 1.3 Connector offen lässt.

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 Websiten vo Mircrosoft zur Verfügung.

2.2.1.2 Apache

2.2.1.2.1 Konfiguration von Jakarta mod_jk im Apache

Um das MOA SP/SS Webservice 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

SSLOptions +ExportCertData +StdEnvVars

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

2.2.2 Datenbank

2.2.2.1 PostgreSQL

Eine detaillierte Übersicht über die Installation und Konfiguration von PostgreSQL gibt die Online-Dokumentation.

2.2.2.1.1 Anlegen eines Benutzers und einer Datenbank für MOA SP/SS

createuser -U postgres -d -A -P moa
createdb -U moa moadb

 jdbc:postgresql://host/moadb?user=moa&password=moapass

2.2.2.1.2 Archivierung von CRLs

cfg:EnableArchiving muss auf den Wert true gesetzt sein;
cfg:ArchiveDuration muss als nichtnegative Ganzzahl die maximale Archivierungsdauer in Tagen enthalten;
cfg:Archive muss genau ein Element cfg:DatabaseArchive enthalten, das wiederum aus zwei Elementen - bestehen muss: -
- cfg:JDBCURL muss eine gültige JDBC-URL enthalten, mit der auf die Datenbank zur Archivierung - zugegriffen werden kann (Hinweis: da es sich hierbei um einen Eintrag - in eine XML-Datei handelt, muss das Zeichen & in der in Abschnitt 2.2.2.1.1 gezeigten - JDBC-URL - durch die Zeichenfolge & ersetzt werden.);
- cfg:JDBCDriverClassName muss den vollständig qualifizierten Java-Klassennamen des JDBC-Treibers - enthalten.
-

Vergleiche auch Abschnitt 2.3.1.3.4 im - Konfigurationshandbuch.

2.2.2.1.3 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 text);

Wie beim Caching von CRLs ist auch hier die Angabe einer JDBC-URL notwendig, damit die MOA SP/SS Module eine Verbindung zur Datenbank aufnehmen können.

Bitte beachten Sie: Bei Tests hat sich das Logging in eine Datenbank mit Jakarta Log4j als Performance-Engpass herausgestellt. Es wird deshalb empfohlen, dieses Feature mit Bedacht einzusetzen.

2.2.2.2 Andere Datenbanken

Die in Abschnitt 2.2.2.1 gemachten Angaben zu Archivierung von CRLs bzw. zur Speicherung von Log-Meldungen gelten sinngemäß.

2.2.3 Hardware Security Module (HSM)

Für die Einbindung des HSM in MOA SS müssen zunächst die Bibliotheken aus $MOA_SPSS_INST/pkcs11 in ein beliebiges Verzeichnis kopiert werden, welches dann in den Libray-Pfad des jeweiligen Betriebssystems aufgenommen werden muss (Windows: Umgebungsvariable PATH; Linux: Umgebungsvariable LD_LIBRARY_PATH).

Der Name der für das HSM spezifischen PKCS#11-Bibliothek muss in der Konfigurationsdatei eingetragen werden (vergleiche Abschnitt 2.2.1.1 des Konfigurationshandbuchs).

3 Klassenbibliothek

3.1 Basisinstallation

3.1.1 Einführung

Folgende Software ist Voraussetzung für die Basisinstallation der Klassenbibliothek:

J2SE 1.3.1 JRE oder J2SE 1.4.2 JRE oder J2SE 5.0 JRE

3.1.2 Vorbereitung

Die folgenden Schritte dienen der Vorbereitung der Installation.

Installation von J2SE SDK

Entpacken der MOA SP/SS Klassenbibliotheks-Distribution

Entpacken Sie die Datei moa-spss-1.2.x-lib.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_SPSS_INST bezeichnet.

Installation der Krypographiebibliotheken von SIC/IAIK

Die Installation der Kryptographiebibliotheken von SIC/IAIK ist abhängig vom eingesetzten J2SE SDK:

J2SE 1.3.1 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SPSS_INST/ext13 in das Verzeichnis $JAVA_HOME/jre/lib/ext.
J2SE 1.4.2 SDK oder JSE 5.0 SDK: Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SPSS_INST/ext14 in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihres J2SE 1.4.2 SDK bzw. J2SE 5.0 SDK austauschen. Laden Sie dazu die Unlimited Strength Jurisdiction Policy Files von der J2SE 1.4.2 SDK Downloadseite bzw. J2SE 5.0 SDK Downloadseite und folgen Sie der darin enthaltenen Installationsanweisung.

3.1.3 Verwendung

Um die MOA SP/SS Klassenbibliothek in einer Applikation verwenden zu können, müssen die mit MOA SP/SS ausgelieferten Bibliotheken in den Java Klassenpfad der Applikation eingebunden werden.

Die nachfolgende Tabelle listet diese Klassenbibliotheken auf; die Einträge in der Spalte Dateien sind relativ zum Verzeichnis $MOA_SPSS_INST zu interpretieren.

Klassenbibliothek	Version	Dateien
MOA SP/SS	1.2.x	`moa-spss.jar`, `moa-common.jar`
MOA IAIK	1.0.7	`lib/iaik_moa_full.jar`, `lib/iaik_Pkcs11Wrapper.jar`, - `lib/iaik_cms.jar`, `lib/iaik_ixsil.jar` -
JAXP	1.2_01	`lib/jaxp-api.jar`, `lib/sax.jar`, `lib/dom.jar`
Xerces-J	2.4.0	`lib/xercesImpl.jar`, `lib/xmlParserAPIs.jar`
Xalan-J	2.5.1	`lib/xalan.jar` - Bitte beachten Sie: Wenn Sie J2SE 1.4.2 JRE oder J2SE 5.0 JRE verwenden, müssen Sie diese Bibliothek der Java VM als endorsed bekanntgeben. Sie können dies tun, indem Sie entweder - - die Bibliothek in das (ggf. vorher anzulegende) Verzeichnis `$JAVA_HOME/jre/lib/endorsed/` kopieren; oder - die System Property `java.endorsed.dirs` verwenden, und als Wert den Pfad zu jenem Verzeichnis angeben, in dem Sie die Bibliothek vorhalten (also z.B. `java.endorsed.dirs=c:/mylibdir`). -
Jaxen	1.0	`lib/jaxen-core.jar`, `lib/jaxen-dom.jar`, `lib/saxpath.jar`
Commons-Logging	1.0.4	`lib/commons-logging-api.jar`, `lib/commons-logging.jar`
Log4j	1.2.7	`lib/log4j-1.2.7.jar`
Commons-Discovery	0.2	`lib/commons-discovery.jar`
JSSE	1.0.3_01	Diese Bibliotheken benötigen Sie nur, wenn Sie J2SE 1.3.1 verwenden: - `lib/ext13/jsse.jar`, `lib/ext13/jcert.jar`, `lib/ext13/jnet.jar` - Bitte beachten Sie: Diese Bibliotheken benötigen Sie nur, wenn Sie J2SE 1.3.1 verwenden.
Postgres JDBC2	7.3	`lib/pg73jdbc2.jar` - Bitte beachten Sie: Wenn Sie keine Datenbank für MOA SP/SS verwenden (vergleiche 2.2.2), benötigen Sie diese Bibliothek nicht.

3.1.4 Logging

3.2 Erweiterungsmöglichkeiten

Die im Abschnitt 2.2 angeführten Erweiterungsmöglichkeiten für die MOA SP/SS Webservices gelten in analoger Weise auch für die Klassenbibliothek.

A Referenzierte Software

Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

Ein Beispiel für die resultierende HTML-Darstellung +befindet sich hier.

3.4 Das Servlet `HashInputDataServlet`

Das Servlet HashInputServlet +ist +für die Verfügbarkeit der von der geprüften +XML-Signatur gesicherten Dokumente verantwortlich.

In der HTML-Aufbereitung der SL-Response, die von der +JSP-Seite resultOverview.jsp erzeugt wird, +(vergleiche Abschnitt +3.3) befinden sich Links auf alle gesicherten Dokumente. +Diese Links führen jeweils auf das Servlet HashInputServlet.

Das Servlet entnimmt aus der aufgerufenen URL die Parameter +zum Auffinden des Session Scopes sowie die fortlaufende Nummer des +gesicherten Dokuments. Im Session Scope ist als Attribut die in Abschnitt 3.3 +erwähnte DataInfoBean: +gespeichert, die alle notwendigen Informationen enthält, damit +das Servlet das angefragte gesicherte Dokument aus dem Filesystem lesen +und als Ergebnis an den Browser zurückliefern kann. Je nach +dem, ob es sich beim gesicherten Dokument um ein SLXHTML-Dokument +handelt oder nicht, wird der Content-Type Header der HTTP Response an +den Browser passend gesetzt.

3.5 +Das Servlet `ReturnServlet`

Das Servlet ReturnServlet +ist nach Quittierung der HTML-Darstellung zur geprüften +XML-Signatur durch den Benutzer für die Weiterleitung der +SL-Response an den DataURL-Server sowie für die Weiterleitung +der daraus resultierenden Antwort des DataURL-Servers an den Benutzer +verantwortlich.

Damit verhält sich MOA SL genau wie in der +Spezifikation Transportprotokolle +Security-Layer (Teil der Spezifikationen +zur österreichischen Bürgerkarte in der +Version 1.2) in Abschnitt +3.2.3 für den Fall 5e beschrieben ist: Wenn der +Benutzer die HTML-Aufbereitung der Ergebnisse der geprüften +XML-Signatur gesichtet hat und durch Verfolgung des darin enthaltenen +Links quittiert, sendet das ReturnServlet +die SL-Response an den DataURL-Server. Die URL des DataURL-Servers +wurde von der Anwendung im ursprünglichen Request an das MOAServlet +als Formular-Parameter angegeben. Der DataURL-Server antwortet auf das +Eintreffen der SL-Response mit einem HTTP-Response an das ReturnServlet, +diese wird vom ReturnServlet +als Antwort auf das Quittieren der HTML-Darstellung an den Browser +weitergeleitet.

Nachdem mit diesem Schritt die Bearbeitung der zur +Prüfung übermittelten XML-Signatur durch MOA-SL +abgeschlossen ist, wird am Ende des ReturnServlet +die Session und damit alle gespeicherten Informationen zur +geprüften XML-Signatur gelöscht.

3.6 +Die Klasse `URLRewriter`

Die Klasse URLRewriter +ist +für das Umschreiben von URLs verantwortlich die in der +HTML-Aufbereitung der SL-Response enthalten sind, die dem Benutzer in +seinem Webbrowser angezeigt wird.

MOA SL kann so konfiguriert werden, dass die in der +HTML-Aufbereitung der SL-Response enthaltenen +URLs nicht direkt +auf +Ressourcen von MOA SL (z.B. die von der Signatur gesicherten +Dokumente), sondern auf einen Rewrite-Proxy +verweisen. Die URL auf die eigentliche Ressource von MOA SL ist in dem +umgeschriebenen Link als URL-Parameter kodiert. Der Rewrite-Proxy sorgt +für die Umsetzung des aus dem umgeschriebenen Link +resultierenden +Requests an ihn selbst in einen Request an MOA SL.

Sinnvoll ist diese Konfigurationsvariante dann, wenn MOA SL +nicht direkt vom Internet aus erreichbar sein soll, sondern nur auf dem +Umweg über einen dedizierten Webserver, dem Rewrite-Proxy.

Die Methode rewrite der Klasse URLRewriter +wird bei der Erstellung der HTML-Aufbereitung der SL-Response durch die +JSP-Seite resultOverview.jsp jedenfalls +aufgerufen; die Entscheidung, ob die in die Methode übergebene +URL tatsächlich umgeschrieben wird oder nicht, entscheidet die +Methode auf Grund der Konfigurationseinstellungen von MOA SL.

3.7 +Der Deployment Descriptor `web.xml`

+Im Deployment Descriptor web.xmldes +Web Archives (WAR-File) von MOA SL sind im Wesentlichen folgende +Konfigurationen eingerichtet, die im Normalfall nicht verändert +werden müssen:

Definition der URLs, unter denen die Servlets von MOA SL (MOAServlet, HashInputServlet, ReturnServlet) relativ zum Root der Web Application erreichbar sind (XML-Elemente servlet bzw. servlet-mapping).
Definition der Filter, die für das Servlet MOAServlet zur Anwendung kommen sollen (XML Elemente filter bzw. filter-mapping). Die Konfiguration ist so eingerichtet, dass für das Servlet MOAServlet genau ein Filter, nämlich SL2MOAFilter konfiguriert ist.

4 +Zusammenspiel der Komponenten

4.1 Basisablauf

Die nachfolgende Grafik stellt das Zusammenspiel der Komponenten aus Abschnitt 3 mit dem Anwender und dem DataURL-Server dar.

Zusammenspiel der Komponenten - Basisablauf

Name	Beschreibung
Apache Tomcat 4.1.x	Servlet-Container des Apache Jakarta Projekts in der Version 4.1.x
J2SE 1.3.1 SDK/JRE	Java 2 Standard Edition in der Version 1.3.1 (Software Development Kit bzw. Java Runtime Environment)
J2SE 1.4.2 SDK/JRE	Java 2 Standard Edition in der Version 1.4.2 (Software Development Kit bzw. Java Runtime Environment)
J2SE 5.0 SDK/JRE	Java 2 Standard Edition in der Version 5.0 (Software Development Kit bzw. Java Runtime Environment)
Jakarta Log4J	Logging Framework des Apache Jakarta Projekts

1, 2	+ Prüfung der Signatur: Anfrage wird eigentlich an `MOAServlet` gerichtet, durch die Filter-Konfiguration über den Deployment-Descriptor web.xml wird jedoch vorher und nachher der `SL2MOAFilter` dazwischengeschalten. Die Aufbereitung der HTML-Darstellung der SL-Response wird vom `SL2MOAFilter` an die JSP-Seite `resultOverview.jsp` delegiert. +
3,4	+ Über die HTML-Ansicht der SL-Response kann der Anwender +die einzelnen, von der XML-Signatur gesicherten Dokumente abrufen. +Die Links für die Dokumente verweisen auf das `HashInputServlet`, die Zuordnung im Servlet passiert über URL-Parameter (Session-ID, fortlaufende Nummer des Dokuments). +
5, 6, 7, 8	+ In Schritt 5 quittiert der Anwender die HTML-Darstellung der +SL-Response. Das Quittieren funktioniert über einen Link in der +HTML-Darstellung, der auf das `ReturnServlet` verweist. Das `ReturnServlet` +sendet die SL-Response an den DataURL-Server. Der DataURL-Server +antwortet entsprechend auf die übermittelte SL-Response; diese +Antwort wird vom `ReturnServlet` unverändert an den Antwender weitergeleitet. +

4.2 Ablauf mit Rewrite-Proxy

Zusemmenspiel der Komponenten - mit Rewrite-Proxy

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

1, 2	+ Prüfung der Signatur: Anfrage wird eigentlich an `MOAServlet` gerichtet, durch die Filter-Konfiguration über den Deployment-Descriptor web.xml wird jedoch vorher und nachher der `SL2MOAFilter` dazwischengeschalten. Die Aufbereitung der HTML-Darstellung der SL-Response wird vom `SL2MOAFilter` an die JSP-Seite `resultOverview.jsp` delegiert. Die Anfrage des Anwenders wird nicht direkt an das `MOAServlet` gerichtet, sondern über den Rewrite-Proxy, der die Anfrage-URL passend umschreibt. +
3,4	+ Über +die HTML-Ansicht der SL-Response kann der Anwender die einzelnen, von +der XML-Signatur gesicherten Dokumente abrufen. Die Links für die +Dokumente verweisen nicht direkt auf das `HashInputServlet`, sondern zunächst auf den Rewrite-Proxy, der die Links passend auf das `HashInputServlet` umsetzt. Die Zuordnung im Servlet passiert über URL-Parameter (Session-ID, fortlaufende Nummer des Dokuments). +
5, 6, 7, 8	+ In +Schritt 5 quittiert der Anwender die HTML-Darstellung der SL-Response. +Das Quittieren funktioniert über einen Link in der HTML-Darstellung, +der nicht direkt auf das `ReturnServlet` verweist, sondern zunächst auf den Rewrite-Proxy, der die Links passend auf das `ReturnServlet` umsetzt. Das `ReturnServlet` +sendet die SL-Response an den DataURL-Server. Der DataURL-Server +antwortet entsprechend auf die übermittelte SL-Response; diese Antwort +wird vom `ReturnServlet` unverändert an den Antwender weitergeleitet. +