diff options
Diffstat (limited to 'id/server/doc/handbook')
| -rw-r--r-- | id/server/doc/handbook/application/application.html | 24 | ||||
| -rw-r--r-- | id/server/doc/handbook/config/config.html | 42 | ||||
| -rw-r--r-- | id/server/doc/handbook/install/install.html | 10 |
3 files changed, 42 insertions, 34 deletions
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 @@ -110,6 +110,12 @@ https://<host>:<port>/moa-id-oa/ <th width="559" scope="col">Beschreibung</th> </tr> <tr> + <td>general.publicURLContext</td> + <td>https://localhost:8443/moa-id-oa</td> + <td><p>URL unter der das Modul MOA-ID-OA erreichbar ist.</p> + <p><strong>Hinweis:</strong> Ist dieser Parameter nicht vorhanden wird die URL aus dem ersten Request generiert.</p></td> + </tr> + <tr> <td>general.login.pvp2.idp.metadata.url</td> <td>https://demo.egiz.gv.at/moa-id-auth/<br> pvp2/metadata</td> @@ -117,7 +123,7 @@ https://<host>:<port>/moa-id-oa/ </tr> <tr> <td>general.login.pvp2.idp.metadata.certificate</td> - <td>keys/metadata.crt</td> + <td>keys/moa_idp.crt</td> <td>Zertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieser Zertifikat wird zur Prüfung der IDP Metadaten verwendet.</td> </tr> <tr> @@ -138,12 +144,12 @@ https://<host>:<port>/moa-id-oa/ </tr> <tr> <td>general.login.pvp2.keystore.url</td> - <td>keys/moa_idp.p12</td> + <td>keys/application[password].p12</td> <td>Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.</td> </tr> <tr> <td>general.login.pvp2.keystore.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Keystores</td> </tr> <tr> @@ -157,32 +163,32 @@ https://<host>:<port>/moa-id-oa/ </tr> <tr> <td>general.login.pvp2.keystore.metadata.key.alias</td> - <td>metadata</td> + <td>pvp_metadata</td> <td>Name des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll</td> </tr> <tr> <td>general.login.pvp2.keystore.metadata.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.encryption.key.alias</td> - <td>encryption</td> + <td>pvp_encryption</td> <td>Name des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.encryption.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels zum Verschlüsseln der Anmeldeinformation.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.key.alias</td> - <td>authrequest</td> + <td>pvp_request</td> <td>Name des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels zum Signieren des Authentifizierungsrequests.</td> </tr> </table> 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 @@ <link rel="stylesheet" href="../common/MOA.css" type="text/css"> </head> <body link="#990000"> + X <table class="logoTable" width="100%" border="0" cellspacing="0" cellpadding="10"> <tr> <td align="center" class="logoTitle" width="267"><img src="../common/LogoBKA.png" alt="Logo BKA" width="267" height="37" align="left"></td> @@ -167,7 +168,8 @@ </ol> <p>Optional kann nach dem Schritt 3 Basiskonfiguration des Modules MOA-ID-Auth eine <a href="#import_export_legacy">bestehende MOA-ID 1.5.1 Konfiguration importiert</a> werden. Für bestehende Konfigurationen < 1.5.1 wird eine vollständige Neukonfiguration empfohlen.</p> <h1><a name="uebersicht_zentraledatei" id="uebersicht_zentraledatei"></a>2 Basiskonfiguration</h1> -<p>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. </p> +<p>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.</p> +<p><strong>Hinweis:</strong> Alle URL Konfigurationsparameter auf Dateien ohne den Prefix <em>file:/</em> werden als relative Pfadangaben zum Konfigurationsbasisverzeichnis des jeweiligen Modules interpretiert.</p> <h2><a name="uebersicht_zentraledatei_aktualisierung" id="uebersicht_zentraledatei_aktualisierung"></a>2.1 MOA-ID-Configuration</h2> <p>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 <a href="../../conf/moa-id-configuration/moa-id-configtool.properties">hier</a>.</p> <h3><a name="moa_id_config_property" id="uebersicht_zentraledatei_aktualisierung7"></a>2.1.1 Bekanntmachung der Konfigurationsdatei</h3> @@ -268,7 +270,7 @@ </tr> <tr> <td>general.login.pvp2.idp.metadata.certificate</td> - <td>keys/metadata.crt</td> + <td>keys/moa_idp.crt</td> <td>Zertifikat mit dem die PVP2.1 Metadaten des IDP signiert sind. Dieser Zertifikat wird zur Prüfung der IDP Metadaten verwendet.</td> </tr> <tr> @@ -289,12 +291,12 @@ </tr> <tr> <td>general.login.pvp2.keystore.url</td> - <td>keys/moa_idp.p12</td> + <td>keys/application[password].p12</td> <td>Keystore mit Schlüssel und Zertifikaten welche für das signieren und verschlüsseln der PVP2.1 Nachrichten verwendet werden sollen.</td> </tr> <tr> <td>general.login.pvp2.keystore.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Keystores</td> </tr> <tr> @@ -308,32 +310,32 @@ </tr> <tr> <td>general.login.pvp2.keystore.metadata.key.alias</td> - <td>metadata</td> + <td>pvp_metadata</td> <td>Name des Schlüssels der zum Signieren der Metadaten des Modules MOA-ID-Configuration verwendet werden soll</td> </tr> <tr> <td>general.login.pvp2.keystore.metadata.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels der zum Signieren der Metadaten verwendet werden soll.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.encryption.key.alias</td> - <td>encryption</td> + <td>pvp_encryption</td> <td>Name des Schlüssels der zum Verschlüsseln der Anmeldeinformation, welche vom IDP an das Konfigurationstool übermittelt, verwendet werden soll</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.encryption.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels zum Verschlüsseln der Anmeldeinformation.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.key.alias</td> - <td>authrequest</td> + <td>pvp_request</td> <td>Name des Schlüssels zum Signieren des Authentifizierungsrequests der an den IDP gestellt wird.</td> </tr> <tr> <td>general.login.pvp2.keystore.authrequest.key.password</td> - <td>123456</td> + <td>password</td> <td>Passwort des Schlüssels zum Signieren des Authentifizierungsrequests.</td> </tr> </table> @@ -683,32 +685,32 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> <tr> <td>protocols.pvp2.idp.ks.file</td> - <td>keys/pvp.p12</td> + <td>keys/moa_idp[password].p12</td> <td>Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.1 spezifischen Inhalten. (PVP 2.1 Metadaten, PVP 2.1 Assertion)</td> </tr> <tr> <td>protocols.pvp2.idp.ks.kspassword</td> - <td>pass1234</td> + <td>password</td> <td>Passwort zum Keystore</td> </tr> <tr> <td>protocols.pvp2.idp.ks.metadata.alias</td> - <td>metadata</td> + <td>pvp_metadata</td> <td>Name des Schlüssels der zur Signierung der PVP 2.1 Metadaten </td> </tr> <tr> <td>protocols.pvp2.idp.ks.metadata.keypassword</td> - <td>pass1234</td> + <td>password</td> <td>Passwort des Schlüssels der zur Signierung der PVP 2.1 Metadaten </td> </tr> <tr> <td>protocols.pvp2.idp.ks.assertion.sign.alias</td> - <td>signing</td> + <td>pvp_assertion</td> <td>Name des Schlüssels mit dem die PVP 2.1 Assertion durch MOA-ID-Auth unterschieben wird</td> </tr> <tr> <td>protocols.pvp2.idp.ks.assertion.sign.keypassword</td> - <td>pass1234</td> + <td>password</td> <td>Passwort des Schlüssels mit dem die PVP 2.1 Assertion durch MOA-ID-Auth unterschieben wird</td> </tr> </table> @@ -722,22 +724,22 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> <tr> <td>protocols.oauth20.jwt.ks.file</td> - <td>keys/openID.p12</td> + <td>keys/moa_idp[password].p12</td> <td>Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung des OpenID Connect <em>id_token</em></td> </tr> <tr> <td>protocols.oauth20.jwt.ks.password=</td> - <td>pass1234</td> + <td>passsword</td> <td>Passwort zum Keystore</td> </tr> <tr> <td>protocols.oauth20.jwt.ks.key.name</td> - <td>openID</td> + <td>pvp_assertion</td> <td>Name des Schlüssels der zum Signieren des <em>id_tokens</em> verwendet wird</td> </tr> <tr> <td>protocols.oauth20.jwt.ks.key.password</td> - <td>pass1234</td> + <td>pasword</td> <td>Password des Schlüssels der zum Signieren des <em>id_tokens</em> verwendet wird</td> </tr> </table> 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 @@ <dd> Entpacken Sie die Datei <code>moa-id-auth-2.0.0.zip</code> in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren Verlauf als <code>$MOA_ID_AUTH_INST</code> bezeichnet. </dd> <dt>Installation der Kryptographiebibliotheken von SIC/IAIK</dt> <dd> - <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_SPSS_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength + <p>Kopieren Sie alle Dateien aus dem Verzeichnis <code>$MOA_ID_AUTH_INST/ext</code> in das Verzeichnis <code>$JAVA_HOME/jre/lib/ext</code>. Zusätzlich müssen Sie die Rechtedateien Ihrer Java SE austauschen. Laden Sie dazu die passenden <span class="term">Unlimited Strength Jurisdiction Policy Files</span> von der <a href="http://java.com/download" target="_blank">Java SE Downloadseite </a>und achten Sie darauf die für ihre verwendete Java SE Installation richtige Version zu nehmen. Anschließend folgen Sie der darin enthaltenen Installationsanweisung. </p> @@ -138,12 +138,12 @@ <p> Um die Module MOA-ID-Auth und MOA-ID-Configuratuion in Tomcat für den Einsatz vorzubereiten, sind folgende Schritte notwendig:</p> <ul> <li>Die Datei <code>$MOA_ID_AUTH_INST/moa-id_auth.war</code> enthält das einsatzfertige MOA-ID-Auth Webarchiv und muss ins Verzeichnis <code>$CATALINA_HOME/webapps</code> kopiert werden. Dort wird sie beim ersten Start von Tomcat automatisch ins Verzeichnis <code>$CATALINA_HOME/webapps/moa-id-auth</code> entpackt. </li> - <li>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. <code>$CATALINA_HOME/conf/moa-id</code>). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Basiskonfiguration des MOA-ID-Auth Modules dienen kann, finden Sie <a href="../../../conf/moa-id/moa-id.properties">hier</a>. <br> + <li>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. <code>$CATALINA_HOME/conf/moa-id</code>). Eine funktionsfähige Konfiguration, die als Ausgangspunkt für die Konfiguration des MOA-ID-Auth Modules dienen kann, finden Sie <a href="../../../conf/moa-id/moa-id.properties">hier</a>. 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.<br> </li> <li> Die Dateien <code>xalan.jar</code>, <code>xercesImpl.jar, serializer.jar </code> und <code>xml-apis.jar</code> aus dem Verzeichnis <code>$MOA_ID_AUTH_INST/endorsed</code> müssen in das Tomcat-Verzeichnis <code>$CATALINA_HOME/endorsed</code> (bzw. <code>$CATALINA_HOME/common/endorsed</code> 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 <code>xmlParserAPIs.jar</code> muss gelöscht werden. Sollte das Verzeichnis <code>endorsed</code> nicht vorhanden sein, dann muss dieses zuerst erstellt werden.</li> - <li>Folgende <span class="term">System Properties</span> können gesetzt werden (wird beim Starten von Tomcat der <span class="term">Java Virtual Machine</span> in der Umgebungsvariablen <code>CATALINA_OPTS</code> in der Form <code>-D<name>=<wert></code> übergeben): - <ul> - <li id="klein"><code>moa.id.configuration</code>: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei fnden Sie <a href="../../../conf/moa-id/moa-id.properties">hier</a>. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert.</li> + <li>Folgende <span class="term">System Properties</span> können gesetzt werden (wird beim Starten von Tomcat der <span class="term">Java Virtual Machine</span> in der Umgebungsvariablen <code>CATALINA_OPTS</code> in der Form <code>-D<name>=<wert></code> übergeben). Eine Beispielkonfiguration in welcher diese Umgebungsvariablen gesetzt werden finden Sie <a href="../../../deploy/tomcat/">hier</a>. +<ul> + <li id="klein"><code>moa.id.configuration</code>: Pfad und Name der Basiskonfigurationsdatei für MOA-ID-Auth. Eine beispielhafte Konfigurationsdatei fnden Sie <a href="../../../deploy/conf/moa-id/moa-id.properties">hier</a>. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert.</li> <li><code>moa.spss.server.configuration</code>: Pfad und Name der zentralen Konfigurationsdatei für MOA SP/SS. Eine beispielhafte Konfigurationsdatei finden Sie <a href="../../../conf/moa-spss/SampleMOASPSSConfiguration.xml">hier</a>. Wird ein relativer Pfad angegeben, wird dieser relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. Ist diese <span class="term">System Property</span> nicht gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/conf</code> enthaltene Default-Konfiguration herangezogen.</li> <li><code>eu.stork.samlengine.config.location</code>: Pfad auf den Ordner mit den zentralen Konfigurationsdateien für STORK. Die Beispielkonfiguration für das Modul MOA-ID-Auth enthält bereits den<a href="../../../conf/moa-id/stork/"> Ordner für die STORK Konfiguration</a>. </li> <li id="klein"><code>log4j.configuration</code>: URL der Log4j Konfigurationsdatei. Eine beispielhafte Log4j-Konfiguration finden Sie <a href="../../../conf/moa-id/log4j.properties">hier</a>. Wird eine relative URL angegeben, wird diese als File-URL relativ zum Startverzeichnis der <span class="term">Java Virtual Machine</span> interpretiert. Ist diese <span class="term">System Property</span> nicht gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/classes</code> enthaltene Default-Konfiguration herangezogen.</li> |