From d2ab372857ec9165a069c5109328941a71b66739 Mon Sep 17 00:00:00 2001 From: gregor Date: Mon, 23 May 2005 18:26:38 +0000 Subject: =?UTF-8?q?Kapitel=20=C3=BCber=20Webserviceclients=20(2.2)=20hinzu?= =?UTF-8?q?gef=C3=BCgt.?= 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@327 d688527b-c9ab-4aba-bd8d-4036d912da1d --- spss.handbook/handbook/usage/usage.html | 110 ++++++++++++++++++++++++++++---- 1 file changed, 97 insertions(+), 13 deletions(-) (limited to 'spss.handbook/handbook/usage') diff --git a/spss.handbook/handbook/usage/usage.html b/spss.handbook/handbook/usage/usage.html index 889a7dfed..f355a5676 100644 --- a/spss.handbook/handbook/usage/usage.html +++ b/spss.handbook/handbook/usage/usage.html @@ -53,8 +53,8 @@
  1. Übersicht
  2. Gemeinsamkeiten
    3. -
  3. Besonderheiten von HTTPSServerAuth
    4. -
  4. Besonderheiten von HTTPSClientAuth
    5. +
  5. Besonderheiten von HTTPSServerAuth.java
    6. +
  6. Besonderheiten von HTTPSClientAuth.java
@@ -68,12 +68,14 @@ +
    +
  1. Referenzierte Software
    2. +

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 Anwendung der beiden Module auf jede dieser beiden Arten.

-

TODO: Referenzierte Daten

2 Verwendung des Webservices

-

Dieser Abschnitt beschreibt die Verwendung der Module SP und SS über die Webservice-Schnittstelle. Im ersten Unterabschnitt werden typische XML-Requests zur Signaturerstellung mittels SS bzw. zur Signaturprüfung mittels SP vorgestellt, wie sie an das Webservice gesendet werden können. Der zweite Unterabschnitt stellt beispielhafte Implementierungen eines Webservice-Clients in Java vor, mit dem die Requests aus dem ersten Unterabschnitt an das Webservice gesendet werden können..

+

Dieser Abschnitt beschreibt die Verwendung der Module SP und SS über die Webservice-Schnittstelle. Im ersten Unterabschnitt werden typische XML-Requests zur Signaturerstellung mittels SS bzw. zur Signaturprüfung mittels SP vorgestellt, wie sie an das Webservice gesendet werden können. Der zweite Unterabschnitt stellt beispielhafte Implementierungen eines Webservice-Clients in Java vor, mit dem die Requests aus dem ersten Unterabschnitt an das Webservice gesendet werden können.

2.1 XML-Requests

Dieser Abschnitt stellt typische XML-Requests für die Erstellung einer XML-Signatur mittels SS bzw. zur Prüfung einer CMS- bzw. XML-Signatur mittels SP vor. Zu jedem Request wird jeweils auch eine typische Response des Services besprochen.

2.1.1 Erstellung einer XML-Signatur

@@ -1091,17 +1093,99 @@ Ich habe weiters ein eigenens ID-Attribut bekommen.</doc:Paragraph>

Das Element CertificateCheck enthält das Resultat der Zertifikatsprüfung (siehe Einfaches Beispiel).

2.2 Webservice-Clients

-

2.1. zeigte requests, mit 2.2. können die nun gesendet werden

+

Abschnitt 2.1 bespricht eine Reihe von typischen XML-Requests, die über die Webservice-Schnittstelle an MOA SP/SS gesendet werden können, um entweder Signaturen zu erstellen (MOA SS) oder Signaturen zu prüfen (MOA SP). Dieser Abschnitt zeigt die Verwendung des prototypischen Webservice-Clients, der mit dieser Dokumentation zu MOA SP/SS ausgeliefert wird.

2.2.1 Übersicht

-

kurzvorstellung der drei clients (http, httpsserverauth, httpsclientauth), einsatzszenario für jeden client

+

Der Webservice-Client existiert in drei Varianten, wobei jede Variante in einer eigenen Java-Klasse implementiert ist:

+ +

Welcher der drei Varianten des Webservice-Clients zum Einsatz kommen soll, hängt von der Art ab, wie das MOA-Webservice betrieben wird, d.h. ob es Server- bzw. Client-Authentisierung unterstützt bzw. verlangt. Befinden sich sowohl MOA-Webservice als auch der Webservice-Client im gleichen, abgeschotteten Netzwerk, kann auch eine Kommunikation ohne Authenifikation in Betracht gezogen werden. Ansonsten wird der Standardfall wohl der Betrieb mit Server-Authentisierung (Verwendung von MOA SP) bzw. mit Server- und Client-Authentisierung (Verwendung von MOA SS) sein.

+

Hinweis: Das Wurzelverzeichnis dieses Handbuchs stellt ein komplettes und sofort verwendbares Eclipse Projekt dar.

2.2.2 Gemeinsamkeiten

-

voraussetzungen (bibliotheken)

-

ablauf: request von file lesen, soap-request erstellen, soap-request senden, soap-response empfanden, payload extrahieren, payload als file speichern

-

2.2.3 Besonderheiten von HTTPSServerAuth

-

debug property

-

2.2.4 Besonderheiten von HTTPSClientAuth

-

debug property

+

Dieser Abschnitt beschreibt die Gemeinsamkeiten aller drei Varianten des Webservice-Clients.

+

Zunächst einmal benötigen alle drei Varianten die folgenden Java-Bibliotheken, die im Ordner clients/webservice/lib/ dieses Handbuchs bereits enthalten sind:

+ + + + + + + + + + + + + + + + + + + + + + +
Java-BibliothekBemerkung
J2SE J2SE 1.3.1 SDK oder J2SE 1.4.2 SDK oder J2SE 5.0 SDK.
Apache XercesXML-Parser, Version 2.0.2 oder höher; nicht nötig wenn JDSE 1.4.2 oder höher verwendet wird.
AXIS FrameworkWebservice-Framework, Version 1.1.
JSSEJava Secure Socket Extension, Version 1.0.3 oder höher; nur notwendig für die Varianten HTTPServerAuth und HTTPClientAuth.
+

Weiters ist allen drei Varianten der folgende Kern-Ablauf gemeinsam:

+
    +
  1. Der Webservice-Client liest einen vorbereiteten MOA-XML-Request (z. B. einen der in Abschnitt 2.1 gezeigten) vom Dateisystem ein.
    2. +
  2. Der Webservice-Client erstellt einen SOAP-Request mit dem vom Dateisystem gelesenen MOA-XML-Request als Nutzlast.
    3. +
  3. Der Webservice-Client sendet den erstellten SOAP-Request über HTTP an MOA SP/SS.
    4. +
  4. Der Webservice-Client empfängt die SOAP-Response von MOA SP/SS.
    5. +
  5. Der Webservice-Client extrahiert die Nutzlast des SOAP-Responses (d. h. die zum MOA-XML-Request aus Schritt 1 passende MOA-XML-Response), gibt diese auf die Konsole aus und speichert sie im Dateisystem.
    6. +
+

Konfiguriert werden können alle drei Varianten mit Hilfe von zwei Kommandozeilen-Parametern:

+
    +
  1. Der erste Kommandozeilenparameter gibt an, ob MOA SS (Wert sign) oder MOA SP (Wert verify) kontaktiert werden soll.
    2. +
  2. Der zweite Kommandozeilenparameter enthält Pfad und Dateiname einer Java-Properties-Datei, die die weiteren Konfigurationsparameter für den Webservice-Client enthält. Ein relativer Pfad wird als relativ zum Arbeitsverzeichnis der Java Virtual Machine interpretiert. Genaue Infos zu den möglichen Konfigurationsparametern entnehmen Sie bitte der Quellcodedokumentation der jeweiligen Variante des Webservice-Clients. http.properties enthält eine auf dieses Handbuch abgestimmte Konfiguration.
    3. +
+

2.2.3 Besonderheiten von HTTPSServerAuth.java

+

Diese Variante des Webservice-Clients verwendet JSSE, um im Schritt 3 des Kernablaufs aus Abschnitt 2.2.2 eine SSL-Verbindung mit Server-Authentifizierung zum MOA SP/SS Server aufzubauen. In dieser SSL-Verbindung sendet der Webservice-Client dann den erstellten SOAP-Request über HTTPS.

+

Die Konfiguration von JSSE (Speicher für die vertrauenswürdigen Serverzertifikate, Typ dieses Speichers, Passwort für diesen Speicher) wird mittels zusätzlicher Parameter in der in Abschnitt 2.2.2 besprochenen Java-Properties-Datei vorgenommen. Genaue Infos zu diesen Konfigurationsparametern entnehmen Sie bitte der Quellcodedokumentation von HTTPSServerAuth.java. http.properties enthält eine auf dieses Handbuch abgestimmte Konfiguration.

+

Falls Sie Probleme beim SSL-Verbindungsaufbau zwischen Webservice-Client und MOA SP/SS Webservice haben, empfiehlt sich die Aktivierung des JSSE Loggings. Das Setzen der dafür notwendigen Java System Property ist im Quellcode von HTTPSServerAuth.java bereits enthalten, jedoch auskommentiert. Suchen Sie einfach nach dem String javax.net.debug, um zur entsprechenden Stelle im Quellcode zu gelangen.

+

2.2.4 Besonderheiten von HTTPSClientAuth.java

+

Diese Variante des Webservice-Clients verwendet JSSE, um im Schritt 3 des Kernablaufs aus Abschnitt 2.2.2 eine SSL-Verbindung mit Server- und Client-Authentifizierung zum MOA SP/SS Server aufzubauen. In dieser SSL-Verbindung sendet der Webservice-Client dann den erstellten SOAP-Request über HTTPS.

+

Die gegenüber Abschnitt 2.2.3 zusätzlich notwendige Konfiguration von JSSE (Speicher für das SSL-Client-Zertifikat sowie den dazugehörigen privaten Schlüssel, Typ dieses Speichers, Passwort für diesen Speicher) wird mittels zusätzlicher Parameter in der in Abschnitt 2.2.2 besprochenen Java-Properties-Datei vorgenommen. Genaue Infos zu diesen Konfigurationsparametern entnehmen Sie bitte der Quellcodedokumentation von HTTPSClientAuth.java. http.properties enthält eine auf dieses Handbuch abgestimmte Konfiguration.

+

Beachten Sie bitte auch den Hinweis zum JSSE Logging aus Abschnitt 2.2.3.

3 Verwendung der Klassenbibliothek

-

3.1

+

abschnitt aus alter doc übernehmen

+

A Referenzierte Software

+

Auf folgende Software-Pakete wird in diesem Handbuch verwiesen:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameBeschreibung
Apache Xerces 2 XML-Parser aus dem Apache Project
Apache AxisWebservice-Framework aus dem Apache Project
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/JREJava 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)
JSSEJava Secure Socket Extension
+

 

-- cgit v1.2.3