From 42819b8b0bc4a99a0e9ff47ea9d4b3228bc0648f Mon Sep 17 00:00:00 2001 From: Thomas Lenz Date: Thu, 10 Apr 2014 14:23:14 +0200 Subject: update handbook and default configuration --- .../doc/handbook/application/application.html | 24 ++++++++----- id/server/doc/handbook/config/config.html | 42 +++++++++++----------- id/server/doc/handbook/install/install.html | 10 +++--- 3 files changed, 42 insertions(+), 34 deletions(-) (limited to 'id/server/doc/handbook') diff --git a/id/server/doc/handbook/application/application.html b/id/server/doc/handbook/application/application.html index 83e301089..7fd729683 100644 --- a/id/server/doc/handbook/application/application.html +++ b/id/server/doc/handbook/application/application.html @@ -109,6 +109,12 @@ https://<host>:<port>/moa-id-oa/ Beispielwert Beschreibung + + general.publicURLContext + https://localhost:8443/moa-id-oa +

URL unter der das Modul MOA-ID-OA erreichbar ist.

Hinweis: Ist dieser Parameter nicht vorhanden wird die URL aus dem ersten Request generiert.

+ general.login.pvp2.idp.metadata.url https://demo.egiz.gv.at/moa-id-auth/
@@ -117,7 +123,7 @@ https://<host>:<port>/moa-id-oa/ general.login.pvp2.idp.metadata.certificate - keys/metadata.crt + keys/moa_idp.crt Zertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieser Zertifikat wird zur Prüfung der IDP Metadaten verwendet. @@ -138,12 +144,12 @@ https://<host>:<port>/moa-id-oa/ general.login.pvp2.keystore.url - keys/moa_idp.p12 + keys/application[password].p12 Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen. general.login.pvp2.keystore.password - 123456 + password Passwort des Keystores @@ -157,32 +163,32 @@ https://<host>:<port>/moa-id-oa/ general.login.pvp2.keystore.metadata.key.alias - metadata + pvp_metadata Name des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll general.login.pvp2.keystore.metadata.key.password - 123456 + password Passwort des Schlüssels der zum Signieren der Metadaten verwendet werden soll. general.login.pvp2.keystore.authrequest.encryption.key.alias - encryption + pvp_encryption Name des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll general.login.pvp2.keystore.authrequest.encryption.key.password - 123456 + password Passwort des Schlüssels zum Verschlüsseln der Anmeldeinformation. general.login.pvp2.keystore.authrequest.key.alias - authrequest + pvp_request Name des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird. general.login.pvp2.keystore.authrequest.key.password - 123456 + password Passwort des Schlüssels zum Signieren des Authentifizierungsrequests. diff --git a/id/server/doc/handbook/config/config.html b/id/server/doc/handbook/config/config.html index f794e0972..21d146b4d 100644 --- a/id/server/doc/handbook/config/config.html +++ b/id/server/doc/handbook/config/config.html @@ -6,6 +6,7 @@ + X @@ -167,7 +168,8 @@

Optional kann nach dem Schritt 3 Basiskonfiguration des Modules MOA-ID-Auth eine bestehende MOA-ID 1.5.1 Konfiguration importiert werden. Für bestehende Konfigurationen < 1.5.1 wird eine vollständige Neukonfiguration empfohlen.

2 Basiskonfiguration

Die Basiskonfiguration für die Module MOA-ID-Auth und MOA-ID-Configuration erfolgt mit Hilfe textueller propertie Dateien. Diese Propertie Dateien beinhalten alle Konfigurationsparameter welche für den Start der Module erforderlich sind und müssen der Java Virtual Machine durch eine System Property mitgeteilt werden. Alle Änderungen die an der Basiskonfiguration vorgenommen werden erfordern einen Neustart der jeweiligen Java Virtual Machine.

Hinweis: Alle URL Konfigurationsparameter auf Dateien ohne den Prefix file:/ werden als relative Pfadangaben zum Konfigurationsbasisverzeichnis des jeweiligen Modules interpretiert.

2.1 MOA-ID-Configuration

Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Configuration. Der erste Teilabschnitt behandelt die Bekanntmachung der Konfigurationsdatei mittels einer System Property und der zweite Teilabschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die individuelle Konfiguration verwendet werden kann finden Sie hier.

2.1.1 Bekanntmachung der Konfigurationsdatei

@@ -268,7 +270,7 @@ - + @@ -289,12 +291,12 @@ - + - + @@ -308,32 +310,32 @@ - + - + - + - + - + - +


general.login.pvp2.idp.metadata.certificate	keys/metadata.crt	keys/moa_idp.crt	Zertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieser Zertifikat wird zur Prüfung der IDP Metadaten verwendet.
general.login.pvp2.keystore.url	keys/moa_idp.p12	keys/application[password].p12	Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.
general.login.pvp2.keystore.password	123456	password	Passwort des Keystores
general.login.pvp2.keystore.metadata.key.alias	metadata	pvp_metadata	Name des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll
general.login.pvp2.keystore.metadata.key.password	123456	password	Passwort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.
general.login.pvp2.keystore.authrequest.encryption.key.alias	encryption	pvp_encryption	Name des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll
general.login.pvp2.keystore.authrequest.encryption.key.password	123456	password	Passwort des Schlüssels zum Verschlüsseln der Anmeldeinformation.
general.login.pvp2.keystore.authrequest.key.alias	authrequest	pvp_request	Name des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.
general.login.pvp2.keystore.authrequest.key.password	123456	password	Passwort des Schlüssels zum Signieren des Authentifizierungsrequests.

@@ -683,32 +685,32 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet protocols.pvp2.idp.ks.file - keys/pvp.p12 + keys/moa_idp[password].p12 Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.1 spezifischen Inhalten. (PVP 2.1 Metadaten, PVP 2.1 Assertion) protocols.pvp2.idp.ks.kspassword - pass1234 + password Passwort zum Keystore protocols.pvp2.idp.ks.metadata.alias - metadata + pvp_metadata Name des Schlüssels der zur Signierung der PVP 2.1 Metadaten protocols.pvp2.idp.ks.metadata.keypassword - pass1234 + password Passwort des Schlüssels der zur Signierung der PVP 2.1 Metadaten protocols.pvp2.idp.ks.assertion.sign.alias - signing + pvp_assertion Name des Schlüssels mit dem die PVP 2.1 Assertion durch MOA-ID-Auth unterschieben wird protocols.pvp2.idp.ks.assertion.sign.keypassword - pass1234 + password Passwort des Schlüssels mit dem die PVP 2.1 Assertion durch MOA-ID-Auth unterschieben wird @@ -722,22 +724,22 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet protocols.oauth20.jwt.ks.file - keys/openID.p12 + keys/moa_idp[password].p12 Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung des OpenID Connect id_token protocols.oauth20.jwt.ks.password= - pass1234 + passsword Passwort zum Keystore protocols.oauth20.jwt.ks.key.name - openID + pvp_assertion Name des Schlüssels der zum Signieren des id_tokens verwendet wird protocols.oauth20.jwt.ks.key.password - pass1234 + pasword Password des Schlüssels der zum Signieren des id_tokens verwendet wird diff --git a/id/server/doc/handbook/install/install.html b/id/server/doc/handbook/install/install.html index 3db04c197..ffd700a55 100644 --- a/id/server/doc/handbook/install/install.html +++ b/id/server/doc/handbook/install/install.html @@ -112,7 +112,7 @@

Entpacken Sie die Datei moa-id-auth-2.0.0.zip in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als $MOA_ID_AUTH_INST bezeichnet.

Installation der Kryptographiebibliotheken von SIC/IAIK

Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_SPSS_INST/ext in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden Unlimited Strength +

Kopieren Sie alle Dateien aus dem Verzeichnis $MOA_ID_AUTH_INST/ext in das Verzeichnis $JAVA_HOME/jre/lib/ext. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden Unlimited Strength Jurisdiction Policy Files von der Java SE Downloadseite und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung.

@@ -138,12 +138,12 @@

Um die Module MOA-ID-Auth und MOA-ID-Configuratuion in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:

Die Datei $MOA_ID_AUTH_INST/moa-id_auth.war enthält das einsatzfertige MOA-ID-Auth Webarchiv und muss ins Verzeichnis $CATALINA_HOME/webapps kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis $CATALINA_HOME/webapps/moa-id-auth entpackt.
Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier.
+
Die Konfigurationsdatei mit der Basiskonfiguration für MOA-ID-Auth und die zugehörigen Verzeichnisse müssen in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. $CATALINA_HOME/conf/moa-id). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA-ID-Auth Modules dienen kann, finden Sie hier. Diese funktionsfähige Konfiguration enthält auch eine MOA-SPSS Konfiguration, da das Modul MOA-SPSS zurSignaturprüfung im Modul MOA-ID-Auth verwendet wird.
Die Dateien xalan.jar, xercesImpl.jar, serializer.jar und xml-apis.jar aus dem Verzeichnis $MOA_ID_AUTH_INST/endorsed müssen in das Tomcat-Verzeichnis $CATALINA_HOME/endorsed (bzw. $CATALINA_HOME/common/endorsed bis Apache Tomcat Version 5.5) kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, müssen sie überschrieben werden. Die ggf. in diesem Verzeichnis vorhandene Datei xmlParserAPIs.jar muss gelöscht werden. Sollte das Verzeichnis endorsed nicht vorhanden sein, dann muss dieses zuerst erstellt 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.id.configuration: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei fnden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
- 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). Eine Beispielkonfiguration in welcher diese Umgebungsvariablen gesetzt werden finden Sie hier. +
  - moa.id.configuration: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei fnden Sie hier. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der Java Virtual Machine interpretiert.
  - 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.
  - eu.stork.samlengine.config.location: Pfad auf den Ordner mit den zentralen Konfigurationsdateien für STORK. Die Beispielkonfiguration für das Modul MOA-ID-Auth enthält bereits den Ordner für die STORK Konfiguration.
  - 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.