diff options
Diffstat (limited to 'id/server/doc/handbook/config/config.html')
| -rw-r--r-- | id/server/doc/handbook/config/config.html | 579 |
1 files changed, 496 insertions, 83 deletions
diff --git a/id/server/doc/handbook/config/config.html b/id/server/doc/handbook/config/config.html index 7e475fa51..df38abb3a 100644 --- a/id/server/doc/handbook/config/config.html +++ b/id/server/doc/handbook/config/config.html @@ -17,39 +17,154 @@ <p class="title"><a href="../index.html">MOA-ID (Identifikation) </a></p> <p class="subtitle">Konfiguration</p> <hr/> - <h1>Inhalt</h1> +<h1>Inhalt</h1> <ol> <li> <p><a href="#uebersicht">Übersicht</a></p> <ol> - <li><a href="#uebersicht_allgemeines">Allgemeines</a> </li> + <li><a href="#uebersicht_ablauf">Empfohlener Konfigurationsablauf</a> </li> + </ol> + </li> + <li><a href="#uebersicht_zentraledatei">Basiskonfiguration</a> + <ol> + <li><a href="#uebersicht_zentraledatei_aktualisierung">MOA-ID-Configuration</a> + <ol> + <li><a href="#moa_id_config_property">Bekanntmachung der Konfigurationsdatei</a></li> + <li><a href="#moa_id_config_parameters">Konfigurationsparameter</a> + <ol> + <li><a href="#moa_id_config_parameters_generel">Allgemeine Konfigurationsparameter</a></li> + <li><a href="#moa_id_config_parameters_database">Datenbankzugriff</a></li> + <li><a href="#moa_id_config_parameters_pvp2">Bürgerkarten LogIn</a></li> + <li><a href="#moa_id_config_parameters_mail">Mailversand</a></li> + </ol> + </li> + <li><a href="#moa_id_config_init">Initialisierung des Modules MOA-ID-Configuration</a></li> + <li><a href="#moa_id_config_user">Benutzerverwaltung</a> +<ol> + <li><a href="#moa_id_config_user_add">Einen neuen Benutzer erstellen</a></li> + <li><a href="#moa_id_config_user_role">Benutzerrechte</a></li> + </ol> + </li> + </ol> + </li> + <li><a href="#basisconfig_moa_id_auth">MOA-ID-Auth</a> +<ol> + <li><a href="#uebersicht_bekanntmachung">Bekanntmachung der Konfigurationsdatei</a></li> + <li><a href="#basisconfig_moa_id_auth_param">Konfigurationsparameter</a> +<ol> + <li><a href="#basisconfig_moa_id_auth_param_general">Allgemeine Konfigurationsparameter</a></li> + <li><a href="#basisconfig_moa_id_auth_param_services">Externe Services</a> +<ol> + <li><a href="#basisconfig_moa_id_auth_param_services_moasp">MOA-SP</a></li> + <li><a href="#basisconfig_moa_id_auth_param_services_mandates">Online-Vollmachen</a></li> + <li><a href="#">Foreign Identities</a></li> + </ol> + </li> + <li><a href="#basisconfig_moa_id_auth_param_protocol">Protokolle</a> +<ol> + <li><a href="#basisconfig_moa_id_auth_param_protocol_pvp21">PVP 2.1</a></li> + <li><a href="#basisconfig_moa_id_auth_param_protocol_openid">OpenID Connect</a></li> + </ol> + </li> + <li><a href="#basisconfig_moa_id_auth_param_database">Datenbank </a> +<ol> + <li><a href="#basisconfig_moa_id_auth_param_database_conf">Konfiguration</a></li> + <li><a href="#basisconfig_moa_id_auth_param_database_session">Session Informationen</a></li> + <li><a href="#basisconfig_moa_id_auth_param_database_info">Statistikdaten</a></li> + </ol> + </li> + </ol> + </li> + </ol> + </li> + <li><a href="#uebersicht_logging">Konfiguration des Loggings</a></li> </ol> </li> - <li><a href="#uebersicht_zentraledatei">Basiskonfiguration</a> </li> <li><a href="#konfigurationsparameter">Konfiguration MOA-ID-Auth</a> <ol> - <li><a href="#konfigurationsparameter_allgemein">Allgemeine Konfiguration</a></li> - <li><a href="#config_service_provider">Online-Applikationen</a></li> + <li><a href="#konfigurationsparameter_allgemein">Allgemeine Konfiguration</a> + <ol> + <li><a href="#konfigurationsparameter_allgemein_publicurlprefix">Public URL Prefix</a></li> + <li><a href="#konfigurationsparameter_allgemein_bku">Default BKUs</a></li> + <li><a href="#konfigurationsparameter_allgemein_sl-templates">Securtiy-Layer Request Templates</a></li> + <li><a href="#konfigurationsparameter_allgemein_certvalidation">Zertifikatsprüfung</a></li> + <li><a href="#konfigurationsparameter_allgemein_timeouts">Session TimeOuts</a></li> + <li><a href="#konfigurationsparameter_allgemein_moasp">MOA-SP</a></li> + <li><a href="#konfigurationsparameter_allgemein_services">Externe Services</a></li> + <li><a href="#konfigurationsparameter_allgemein_sso">Single-Sign On(SSO)</a></li> + <li><a href="#konfigurationsparameter_allgemein_stork">Secure idenTity acrOss boRders linKed (STORK)</a></li> + <li><a href="#konfigurationsparameter_allgemein_protocol">Protokolle</a> +<ol> + <li><a href="#konfigurationsparameter_allgemein_protocol_allowed">Protkolle aktivieren</a></li> + <li><a href="#konfigurationsparameter_allgemein_protocol_legacy">Legacy Modus</a></li> + <li><a href="#konfigurationsparameter_allgemein_protocol_saml1">SAML1 Konfiguration</a></li> + <li><a href="#konfigurationsparameter_allgemein_protocol_pvp21">PVP2.1 Konfiguration </a></li> + </ol> + </li> + <li><a href="#konfigurationsparameter_allgemein_sltransform">Security-Layer Transformationen</a></li> + </ol> + </li> + <li><a href="#konfigurationsparameter_oa">Online-Applikationen</a> + <ol> + <li><a href="#konfigurationsparameter_oa_general">Informationen zur Online-Applikation (Service Provider)</a> +<ol> + <li><a href="#konfigurationsparameter_oa_general_public">Öffentlicher Bereich</a></li> + <li><a href="#konfigurationsparameter_oa_general_business">Privatwirtschaftlicher Bereich</a></li> + </ol> + </li> + <li><a href="#konfigurationsparameter_oa_bku">BKU Konfiguration</a></li> + <li><a href="#konfigurationsparameter_oa_mandates">Vollmachten</a></li> + <li><a href="#konfigurationsparameter_oa_sso">Single Sign-On (SSO)</a></li> + <li><a href="#konfigurationsparameter_oa_stork">Secure idenTity acrOss boRders linKed (STORK)</a></li> + <li><a href="#konfigurationsparameter_oa_protocol">Authentifizierungsprotokolle</a> +<ol> + <li><a href="#konfigurationsparameter_oa_protocol_saml1">SAML 1</a></li> + <li><a href="#konfigurationsparameter_oa_protocol_pvp21">PVP 2.1</a></li> + <li><a href="#konfigurationsparameter_oa_protocol_openIDConnect">OpenID Connect</a></li> + </ol> + </li> + <li><a href="#konfigurationsparameter_oa_additional">Zusätzliche allgemeine Einstellungen</a> +<ol> + <li><a href="#konfigurationsparameter_oa_additional_formular">Login-Fenster Konfiguration</a></li> + </ol> + </li> + </ol> + </li> + <li><a href="#import_export">Import / Export</a> +<ol> + <li><a href="#import_export_legacy">Import alter Konfigurationen (<= MOA-ID 1.5.1)</a></li> + </ol> + </li> </ol> </li> - <li><a href="#usermanagement">Benutzerverwaltung</a></li> + <li><a href="#import_template_">Templates</a> +<ol> + <li><a href="#import_template_bku">Bürgerkartenauswahl</a></li> + <li><a href="#import_template_sso">Single Sign-On Anmeldeabfrage</a></li> + <li><a href="#import_template_sltemplate">Security-Layer Request</a></li> + </ol> + </li> + </ol> + <ol type="A"> + <li><a href="#referenzierte_spezifikation">Referenzierte Spezifikation</a></li> </ol> <hr/> <h1><a name="uebersicht" id="uebersicht"></a>1 Übersicht </h1> - <p>Dieses Handbuch beschreibt detailliert die Konfigurationsmöglichkeiten für die Module MOA-ID-Auth und MOA-ID-Configuration. Wobei das zentrale Einsatzgebiet des Modules MOA-ID-Configuration die Konfiguration des Modules MOA-ID-Auth darstellt.</p> - <p>Die Konfiguration der beiden Module MOA-ID-Auth und MOA-ID-Configuration kann in zwei Teilbereiche unterteilt werden. Der erste Abschnitt behandelt die Basiskonfiguration der beiden Module, welche in textueller Form mit Hilfe von propertie Konfigurationsdateier erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter zuhilfenahme des Modules MOA-ID-Configuration.</p> - <h2>1.1 Empfohlener Konfigurationsablauf</h2> +<p>Dieses Handbuch beschreibt detailliert die Konfigurationsmöglichkeiten für die Module MOA-ID-Auth und MOA-ID-Configuration. Wobei das zentrale Einsatzgebiet des Modules MOA-ID-Configuration die Konfiguration des Modules MOA-ID-Auth darstellt.</p> +<p>Die Konfiguration der beiden Module MOA-ID-Auth und MOA-ID-Configuration kann in zwei Teilbereiche unterteilt werden. Der erste Abschnitt behandelt die Basiskonfiguration der beiden Module, welche in textueller Form mit Hilfe von propertie Konfigurationsdateien erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter Zuhilfenahme des Modules MOA-ID-Configuration.</p> + <h2><a name="uebersicht_ablauf" id="uebersicht2"></a>1.1 Empfohlener Konfigurationsablauf</h2> <ol> <li><a href="#moa_id_config_parameters">Basiskonfiguration des Modules MOA-ID-Configuration</a></li> - <li><a href="#moa_id_config_init">Initalisierung des Modules MOA-ID-Configuration</a></li> + <li><a href="#moa_id_config_init">Initialisierung des Modules MOA-ID-Configuration</a></li> <li><a href="#basisconfig_moa_id_auth_param">Basiskonfiguration des Modules MOA-ID-Auth</a></li> - <li>Allgemeine Konfiguration des Modules MOA-ID-Auth</li> - <li>Konfiguration von Online-Applikationen</li> - </ol> + <li><a href="#konfigurationsparameter_allgemein">Allgemeine Konfiguration des Modules MOA-ID-Auth</a></li> + <li><a href="#konfigurationsparameter_oa">Konfiguration von Online-Applikationen</a></li> +</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 einer textuellen propertie Datei. 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> - <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 Teilbschnitt beschreibt die einzelnen Konfigurationsparameter im Detail. Eine Konfiguration die als Ausgangspunkt für die indivituelle Konfiguration verwendet werden kann finden Sie <a href="../../conf/moa-id-configuration/moa-id-configtool.properties">hier</a>.</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> <p>Die zentrale Konfigurationsdatei von MOA-ID-Configuration wird der <span class="term">Java Virtual Machine</span>, in der MOA-ID-Configuration läuft, durch eine <span class="term">System Property </span> mitgeteilt (wird beim Starten der <span class="term">Java Virtual Machine</span> in der Form <code>-D<name>=<wert></code> gemacht). Der Name der <span class="term">System Property</span> lautet <code>moa.id.webconfig</code> als Wert der <span class="term">System Property</span> ist der Pfad sowie der Name der Konfigurationsdatei im Dateisystem anzugeben, z.B.</p> <pre>moa.id.webconfig=C:/Programme/apache/tomcat-4.1.30/conf/moa-id-configuration/moa-id-configuration.properties</pre> @@ -57,7 +172,7 @@ <h3><a name="moa_id_config_parameters" id="uebersicht_zentraledatei_aktualisierung8"></a>2.1.2 Konfigurationsparameter</h3> <p>Aus gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt. Die Konfiguration der Blöcke <a href="#moa_id_config_parameters_generel">Allgemeine Konfigurationsparameter</a> und <a href="#moa_id_config_parameters_database">Datenbankzugriff</a> sind nicht optional und müssen für den Betrieb angepasst werden. </p> <h4><a name="moa_id_config_parameters_generel" id="uebersicht_zentraledatei_aktualisierung9"></a>2.1.2.1 Allgemeine Konfigurationsparameter</h4> -<p>Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und indivituell angepasst werden.</p> +<p>Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden.</p> <table width="1247" border="1"> <tr> <th width="176" scope="col">Name</th> @@ -67,7 +182,7 @@ <tr> <td>general.login.deaktivate</td> <td>true / false</td> - <td>Hiermit kann die Authentifizerung am Konfigurationstool deaktiviert werden. Diese Funktion ist für die <a href="#moa_id_config_init">Initalisierung</a> des Modules erforderlich.</td> + <td>Hiermit kann die Authentifizierung am Konfigurationstool deaktiviert werden. Diese Funktion ist für die <a href="#moa_id_config_init">Initialisierung</a> des Modules erforderlich.</td> </tr> <tr> <td>general.publicURLContext</td> @@ -86,7 +201,7 @@ </tr> </table> <h4><a name="moa_id_config_parameters_database" id="uebersicht_zentraledatei_aktualisierung10"></a>2.1.2.2 Datenbankzugriff</h4> -<p>Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und indivituell angepasst werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Configuration kann jedoch auch mit Datenbanken anderer Hersteller betrieben werden. Hierfür wird jedoch auf die <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> verwiesen, welches im Module MOA-ID-Configuration für den Datenbankzugriff verwendet wird. </p> +<p>Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Configuration kann jedoch auch mit Datenbanken anderer Hersteller betrieben werden. Hierfür wird jedoch auf die <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> verwiesen, welches im Module MOA-ID-Configuration für den Datenbankzugriff verwendet wird. </p> <table width="1247" border="1"> <tr> <th width="209" scope="col">Name</th> @@ -120,9 +235,9 @@ </tr> </table> <p> </p> -<p>Die Beispielkonfiguartion beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detailierte Beschreibung der einzelnen Einstellungsparameter kann der <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> entnommen werden.</p> +<p>Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff welche direkt aus der Beispielkonfiguration übernommen werden können. Eine detaillierte Beschreibung der einzelnen Einstellungsparameter kann der <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> entnommen werden.</p> <h4><a name="moa_id_config_parameters_pvp2" id="uebersicht_zentraledatei_aktualisierung11"></a>2.1.2.3 Bürgerkarten LogIn</h4> -<p>Zusätzlich zur Authentifzierung mittels Benutzername und Passwort unterstützt das Modul MOA-ID-Configuration auch eine Authentifizierung mittels Bürgerkarte oder Handy-Signatur unter Verwendung des <a href="./protocol/protocol.html">Authentifizierungsprotokolls PVP2.1</a>. Wenn eine Authentifizerung mittels Bürgerkarte oder Handy-Signature gewünscht wird müssen die nachfolgen Konfigurationsparameter gesetzt werden.</p> +<p>Zusätzlich zur Authentifizierung mittels Benutzername und Passwort unterstützt das Modul MOA-ID-Configuration auch eine Authentifizierung mittels Bürgerkarte oder Handy-Signatur unter Verwendung des <a href="./protocol/protocol.html">Authentifizierungsprotokolls PVP2.1</a>. Wenn eine Authentifizierung mittels Bürgerkarte oder Handy-Signatur gewünscht wird müssen die nachfolgen Konfigurationsparameter gesetzt werden.</p> <table width="1247" border="1"> <tr> <th width="395" scope="col">Name</th> @@ -143,7 +258,7 @@ <tr> <td>general.login.pvp2.idp.metadata.certificate</td> <td>keys/metadata.crt</td> - <td>Zertifikat mit dem die PVP2.1 Metdaten des IDP signiert sind. Dieser Zertifikat wird zur Prüfung der IDP Metadaten verwendet.</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> <td>general.login.pvp2.idp.metadata.entityID</td> @@ -234,7 +349,7 @@ https://<host>:<port>/moa-id-configuration/servlet/metadata</pre> <tr> <td>general.mail.host.port</td> <td> </td> - <td>Port an dem der SMTP Service erreichbar ist. Sollte kein Port angegebn werden wird automatisch das Port 25 verwendet.</td> + <td>Port an dem der SMTP Service erreichbar ist. Sollte kein Port angegeben werden wird automatisch das Port 25 verwendet.</td> </tr> <tr> <td>general.mail.host.username</td> @@ -308,14 +423,14 @@ https://<host>:<port>/moa-id-configuration/servlet/metadata</pre> </tr> </table> <p> </p> -<h3><a name="moa_id_config_init" id="uebersicht_zentraledatei_aktualisierung13"></a>2.1.3 Initalisierung des Modules MOA-ID-Configuration</h3> +<h3><a name="moa_id_config_init" id="uebersicht_zentraledatei_aktualisierung13"></a>2.1.3 Initialisierung des Modules MOA-ID-Configuration</h3> <p>Für den ersten Start muss die Authentifizierung deaktiviert werden (siehe <em>general.login.deaktivate</em> <a href="#moa_id_config_parameters_generel">Abschnitt 2.2.2.1</a>). Anschließend kann die Benutzerverwaltung des Modules MOA-ID-Configuration unter der folgenden Adresse aufgerufen werden.</p> <pre>http://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action</pre> <p>bzw. </p> <pre> https://<host>:<port>/moa-id-configuration/secure/usermanagementInit.action</pre> <p>Mit Hilfe dieser Benutzerverwaltung kann ein neuer Benutzeraccount am Konfigurationstool angelegt und ein Kennwort für den Benutzer vergeben werden. Zusätzlich müssen dem neu erstellte Benutzer die Eigenschaften <em>aktiv</em> und <em>admin</em> zugewiesen werden. Nach dem speichern wird der neu angelegte Benutzer in der Liste aller vorhandenen Benutzern dargestellt.</p> -<p>Hiermit ist die Initialisierung des Moduuls MOA-ID-Configuration abgeschlossen und die Authentifizerung kann wieder aktiviert werden (siehe <em>general.login.deaktivate</em> <a href="#moa_id_config_parameters_generel">Abschnitt 2.2.2.1</a>). Anschließend muss die Java Virtual Machine, in welchem das Modul MOA-ID-Configuration betrieben wird, neu gestartet werden.</p> +<p>Hiermit ist die Initialisierung des Moduls MOA-ID-Configuration abgeschlossen und die Authentifizierung kann wieder aktiviert werden (siehe <em>general.login.deaktivate</em> <a href="#moa_id_config_parameters_generel">Abschnitt 2.2.2.1</a>). Anschließend muss die Java Virtual Machine, in welchem das Modul MOA-ID-Configuration betrieben wird, neu gestartet werden.</p> <h3><a name="moa_id_config_user" id="uebersicht_zentraledatei_aktualisierung14"></a>2.1.4 Benutzerverwaltung</h3> <p>Das Modul MOA-ID-Configuration unterstützt die Benützung und Verwaltung unterschiedlicher Benutzeraccounts. Hierfür stellt die Web-Oberfläche des Modules MOA-ID-Configuration ein spezielles Interface zur Benutzerverwaltung zur Verfügung. </p> <h4><a name="moa_id_config_user_add" id="uebersicht_zentraledatei_aktualisierung15"></a>2.1.4.1 Einen neuen Benutzer erstellen</h4> @@ -328,17 +443,17 @@ https://<host>:<port>/moa-id-configuration/secure/usermanagementInit </tr> <tr> <td>Vorname</td> - <td>Vorname des Benutzers. Wir bei Registierung mittels PVP 2.1 automatisch eingetragen</td> + <td>Vorname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragen</td> <td align="center">nein</td> </tr> <tr> <td>Familienname</td> - <td>Familienname des Benutzers. Wir bei Registierung mittels PVP 2.1 automatisch eingetragen</td> + <td>Familienname des Benutzers. Wir bei Registrierung mittels PVP 2.1 automatisch eingetragen</td> <td align="center">nein</td> </tr> <tr> <td>Organisation</td> - <td>Zugeordnete Organisation. Wir bei Registierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragen</td> + <td>Zugeordnete Organisation. Wir bei Registrierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragen</td> <td align="center">nein</td> </tr> <tr> @@ -368,7 +483,7 @@ https://<host>:<port>/moa-id-configuration/secure/usermanagementInit </tr> <tr> <td>Benutzer ist aktiviert</td> - <td>Aktiviert oder deaktiert den jeweiligen Benutzeraccount</td> + <td>Aktiviert oder deaktiviert den jeweiligen Benutzeraccount</td> <td align="center">ja</td> </tr> <tr> @@ -387,8 +502,8 @@ https://<host>:<port>/moa-id-configuration/secure/usermanagementInit <ol> <li><strong>Durch Administrator:</strong> Bei dieser Variante wird der neue Benutzeraccount durch einen Administrator über die Web-Oberfläche erstellt und aktiviert. In diesem Fall müssen alle geforderten Daten durch den Administrator eingetragen werden. Bei dieser Variante ist die Validierung der eMail Adresse nicht zwingend erforderlich, kann jedoch optional aktiviert werden.<br> </li> - <li><strong>Durch PVP 2.1 Login:</strong> Bei dieser Variante wird die Generierung eines neues Benutzeraccounts durch einen Loginversuch mittels Bürgerkarte oder Handy-Signatur ausgelöst. Nach erfolgreicher Authentifzierung wird die BenutzerIn /der Benutzer an Konfigurationstool weitergeleitet. Hierbei wird geprüft ob aktuell ein Benutzeraccount für diese Person existiert. Wenn kein Account existiert wird die BenutzerIn / der Benutzer aufgefordert die fehlenden Informationen für die Registrierung eines neuen Benutzeraccounts einzutragen. In diesem Fall muss die eMail Adresse durch die BenutzerIn / den Benutzer zwingend validiert werden wofür der <a href="#moa_id_config_parameters_mail">Mailversand</a> am Module MOA-ID-Configuration konfiguriert sein muss. Nach erfolgreicher Validierung der eMail Adresse ist der Benutzeraccount als nicht aktiv registriert und muss anschließend durch einen Administrator aktiviert werden. Erst nach erfolgreicher Aktivierung ist eine gültige Anmeldung möglich.<br> - Sollte die Valdierung der eMail Adresse nicht innerhalb des in <a href="#moa_id_config_parameters_generel">Abschnitt 2.2.1.1</a> konfigurierten Zeitraums erfolgen, wird die Benutzeranforderung automatisch gelöscht und die BenutzerIn / der Benutzer muss sich erneut am Konfigurationstool registrieren.</li> + <li><strong>Durch PVP 2.1 Login:</strong> Bei dieser Variante wird die Generierung eines neues Benutzeraccounts durch einen Loginversuch mittels Bürgerkarte oder Handy-Signatur ausgelöst. Nach erfolgreicher Authentifizierung wird die BenutzerIn /der Benutzer an Konfigurationstool weitergeleitet. Hierbei wird geprüft ob aktuell ein Benutzeraccount für diese Person existiert. Wenn kein Account existiert wird die BenutzerIn / der Benutzer aufgefordert die fehlenden Informationen für die Registrierung eines neuen Benutzeraccounts einzutragen. In diesem Fall muss die eMail Adresse durch die BenutzerIn / den Benutzer zwingend validiert werden wofür der <a href="#moa_id_config_parameters_mail">Mailversand</a> am Module MOA-ID-Configuration konfiguriert sein muss. Nach erfolgreicher Validierung der eMail Adresse ist der Benutzeraccount als nicht aktiv registriert und muss anschließend durch einen Administrator aktiviert werden. Erst nach erfolgreicher Aktivierung ist eine gültige Anmeldung möglich.<br> + Sollte die Validierung der eMail Adresse nicht innerhalb des in <a href="#moa_id_config_parameters_generel">Abschnitt 2.2.1.1</a> konfigurierten Zeitraums erfolgen, wird die Benutzeranforderung automatisch gelöscht und die BenutzerIn / der Benutzer muss sich erneut am Konfigurationstool registrieren.</li> </ol> <h4><a name="moa_id_config_user_role" id="uebersicht_zentraledatei_aktualisierung16"></a>2.1.4.2 Benutzerrechte</h4> <p>Alle Benutzer die Admin–Rechte (Eigenschaft <em>admin</em>) besitzen haben vollen Zugriff auf die gesamte Konfiguration der verwalteten MOA-ID-Auth Instanz. Benutzer ohne Admin-Rechten stehen folgende Operationen nicht oder nur eingeschränkt zur Verfügung. </p> @@ -459,7 +574,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> <p>Nach einem erfolgreichen Testdurchlauf Antwortet das Moniting mit einen http Statuscode 200 und der oben definierten Statusmeldung aus dem Parameter <em>configuration.monitoring.message.success</em>. Im Falle eines Fehlers antwortet das Monitoring mit einem http Statuscode 500 und die Statusmeldung enthält eine Beschreibung des aufgetretenen Fehlers.</p> <h4><a name="basisconfig_moa_id_auth_param_services" id="uebersicht_bekanntmachung5"></a>2.2.2.2 Externe Services</h4> <p>Für den Aufbau von Verbindungen zu anderen Komponenten werden in manchen Fällen spezielle Client-Zertifikate oder Sicherheitseinstellungen benötigt. In diesem Abschnitt erfolgt die Konfiguration der für den Verbindungsaufbau benötigten Parameter. Die Konfiguration der URL zum jeweiligen Service wird jedoch über die Web-Oberfläche des Modules MOA-ID-Configuration vorgenommen (siehe Kapitel TODO:).</p> -<h5>2.2.2.2.1 MOA-SP</h5> +<h5><a name="basisconfig_moa_id_auth_param_services_moasp" id="uebersicht_bekanntmachung6"></a>2.2.2.2.1 MOA-SP</h5> <p>Wird MOA-SP über ein Web-Service, welches Client Authentifizierung voraussetzt, angesprochen müssen in diesem Abschnitt die erforerlichen Schlüssel hinterlegt werden.</p> <table width="1247" border="1"> <tr> @@ -484,7 +599,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> -<h5>2.2.2.2.2 Online-Vollmachen</h5> +<h5><a name="basisconfig_moa_id_auth_param_services_mandates" id="uebersicht_bekanntmachung7"></a>2.2.2.2.2 Online-Vollmachen</h5> <p>MOA-ID-Auth bietet die Möglichkeit der Nutzung von Online-Vollmachten für Anwendungen aus dem öffentlichen Bereich. Hierfür ist ein Online-Vollmachten-Service nötig, wobei die Zugangsdaten zum Online-Vollmachten-Service konfiguriert werden müssen. Der Zugang zum Online-Vollmachten-Service ein Client-Zertifikat für die SSL-Verbinung zum Service. Voraussetzung dafür ist ein Zertifikat von A-Trust bzw. A-CERT mit Verwaltungseigenschaft oder Dienstleistereigenschaft. Wenn ihr MOA-ID-Auth Zertifikat diese Voraussetzung erfüllt, können Sie dieses hier angeben. </p> <table width="1247" border="1"> <tr> @@ -509,7 +624,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> -<h5>2.2.2.2.3 Foreign Identities</h5> +<h5><a name="basisconfig_moa_id_auth_param_services_foreign" id="uebersicht_bekanntmachung8"></a>2.2.2.2.3 Foreign Identities</h5> <p>MOA-ID-Auth bietet die Möglichkeit der Nutzung von ausländischen Karten oder die Anmeldung auländischer Personen mittels STORK. Hierfür ist eine Verbindung zum Stammzahlenregister-Gateway nötig, das einen entsprechenden Zugang zum Stammzahlenregister bereitstellt. Für dieses Zugriff muss das Client-Zertifikat für die SSL-Verbinung zum Gateway angegeben werden. Voraussetzung dafür ist ein Zertifikat von A-Trust bzw. A-CERT mit Verwaltungseigenschaft oder Dienstleistereigenschaft. Wenn ihr MOA-ID-Auth Zertifikat diese Voraussetzung erfüllt, können Sie dieses hier angeben.</p> <table width="1247" border="1"> <tr> @@ -534,9 +649,9 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> -<h4>2.2.2.3 Protokolle</h4> +<h4><a name="basisconfig_moa_id_auth_param_protocol" id="uebersicht_bekanntmachung9"></a>2.2.2.3 Protokolle</h4> <p>MOA-ID-Auth unterstützt mehrere Authentifizierungsprotokolle zwischen einer Online-Applikation und MOA-ID-Auth. Manche dieser Protokolle benötigen Schlüssel zur Signierung von Authentifizierungsdaten. In diesem Abschnitt erfolgt die Konfiguration des zu verwendeten Schlüsselmaterials. </p> -<h5>2.2.2.3.1 PVP 2.1</h5> +<h5><a name="basisconfig_moa_id_auth_param_protocol_pvp21" id="uebersicht_bekanntmachung10"></a>2.2.2.3.1 PVP 2.1</h5> <table width="1247" border="1"> <tr> <th width="272" scope="col">Name</th> @@ -575,7 +690,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> -<h5>2.2.2.3.2 OpenID Connect</h5> +<h5><a name="basisconfig_moa_id_auth_param_protocol_openid" id="uebersicht_bekanntmachung11"></a>2.2.2.3.2 OpenID Connect</h5> <table width="1247" border="1"> <tr> <th width="272" scope="col">Name</th> @@ -605,8 +720,8 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </table> <p> </p> <h4><a name="basisconfig_moa_id_auth_param_database" id="uebersicht_bekanntmachung3"></a>2.2.2.4 Datenbank </h4> - <p>Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) seperate Datenbank Schema, welche in der Basiskonfiguration konfiguriert werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Auth kann jedoch auch mit Datenbanken anderer Hersteller oder einer InMemory Datenbank betrieben werden. Hierfür wird jedoch auf die <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> verwiesen. </p> -<h5>2.2.2.4.1 Konfiguration</h5> +<p>Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) seperate Datenbank Schema, welche in der Basiskonfiguration konfiguriert werden. Für Beispielkonfiguration wurde mySQL als Datenbank verwendet wodurch sich die Konfigurationsparameter auf mySQL beziehen. Das Modul MOA-ID-Auth kann jedoch auch mit Datenbanken anderer Hersteller oder einer InMemory Datenbank betrieben werden. Hierfür wird jedoch auf die <a href="http://docs.jboss.org/hibernate/core/4.2/manual/en-US/html/">Hibernate Dokumention</a> verwiesen. </p> +<h5><a name="basisconfig_moa_id_auth_param_database_conf" id="uebersicht_bekanntmachung12"></a>2.2.2.4.1 Konfiguration</h5> <p>Alle Parameter aus der Basiskonfiguration welche als Prefix <em>configuration.hibernate</em>. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nicht optional.</p> <table width="1247" border="1"> <tr> @@ -641,7 +756,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> - <h5>2.2.2.4.2 Session Informationen</h5> + <h5><a name="basisconfig_moa_id_auth_param_database_session" id="uebersicht_bekanntmachung13"></a>2.2.2.4.2 Session Informationen</h5> <p>Alle Parameter aus der Basiskonfiguration welche als Prefix <em>moasession.hibernate</em>. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema in welchem MOA-ID-Auth die Session Informationen temporär ablegt. Eine Konfiguration dieser Parameter ist nicht optional.</p> <table width="1247" border="1"> <tr> @@ -674,8 +789,8 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> <td>moaconfigpassword</td> <td>Passwort für den Zugriff auf das Datenbank Schema</td> </tr> - </table> -<h5>2.2.2.4.3 Statistikdaten</h5> +</table> +<h5><a name="basisconfig_moa_id_auth_param_database_info" id="uebersicht_bekanntmachung14"></a>2.2.2.4.3 Statistikdaten</h5> <p>Alle Parameter aus der Basiskonfiguration welche als Prefix <em>advancedlogging.hibernate</em>. im Parameternamen aufweisen konfigurieren den Zugriff auf das Datenbank Schema welches die Konfiguration von MOA-ID-Auth beinhaltet. Eine Konfiguration dieser Parameter ist nur erforderlich wenn <em>configuration.advancedlogging.active</em> auf <em>true</em> gesetzt wird. (siehe <a href="#basisconfig_moa_id_auth_param_general">Kapitel 2.2.2.1</a>)</p> <table width="1247" border="1"> <tr> @@ -726,7 +841,21 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> <p>Eine Änderung (Speicherung) an der allgemeinen Konfiguration wirkt sich nicht umgehend auf die zugeordnete MOA-ID-Auth Instanz aus, sondern erfolgt mit zeitlicher Verzögerung. Die zeitliche Verzögerung beträgt jedoch maximal eine Minute. Das die geänderte MOA-ID-Auth Konfiguration in der zugeordneten Instanz geladen wurde ist durch folgende Log Meldungen erkennbar.</p> <pre>INFO | 19 10:25:23,179 | ConfigurationLoader | check for new config.<br>INFO | 19 10:25:23,189 | ConfigurationLoader | Read MOA-ID 2.0 configuration from database.<br>INFO | 19 10:25:23,192 | ConfigurationLoader | MOA-ID 2.0 is loaded.</pre> <p>Nachfolgend finden Sie die Detailbeschreibung aller allgemeinen Konfigurationsparameter.</p> -<h3><a name="konfigurationsparameter_allgemein_bku" id="konfigurationsparameter_allgemein_bku"></a>3.1.1 Default BKUs</h3> +<h3><a name="konfigurationsparameter_allgemein_publicurlprefix" id="konfigurationsparameter_allgemein_bku17"></a>3.1.1 Public URL Prefix</h3> +<p>Dieser Paramter definiert den Public URL Prefix unter welchem die MOA-ID Instanz erreichbar ist. Die Konfiguration dieses Parameters ist verpflichtend.</p> +<table width="1247" border="1"> + <tr> + <th width="119" scope="col">Name</th> + <th width="263" scope="col">Beispielwerte</th> + <th width="843" scope="col">Beschreibung</th> + </tr> + <tr> + <td><span id="wwlbl_loadGeneralConfig_moaconfig_ssoPublicUrl2">Public URL Prefix</span></td> + <td>https://demo.egiz.gv.at/moa-id-auth/</td> + <td>URL-Prefix der MOA-ID Instanz. Diese URL wird für die automatische Generierung von Formularen und Informationen verwendet und MUSS konfiguriert werden.</td> + </tr> +</table> +<h3><a name="konfigurationsparameter_allgemein_bku" id="konfigurationsparameter_allgemein_bku"></a>3.1.2 Default BKUs</h3> <p>Hiermit werden die URLs zu den Defaul Bürgerkartenumgebungen (BKUs) definiert die von MOA-ID-Auth für einen Anmeldevorgang verwendet werden, wenn die Bürgerkartenauswahl nicht bereits auf Seiten der Online-Applikation erfolgt ist (siehe Protokolle: TODO) oder in der Online-Applikations Konfiguration keine BKU URLs konfiguriert wurden (siehe Kapitel TODO:).</p> <table width="1247" border="1"> <tr> @@ -750,7 +879,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> <td>URL auf die lokale BKU Instanz</td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_sl-templates" id="konfigurationsparameter_allgemein_bku2"></a>3.1.2 SecurtiyLayer Request Templates</h3> +<h3><a name="konfigurationsparameter_allgemein_sl-templates" id="konfigurationsparameter_allgemein_bku2"></a>3.1.3 SecurtiyLayer Request Templates</h3> <p>SecurityLayer (SL) Templates dienen der Kommunikation mit der gewählten Bürgerkartenumgebung. Die hier hinterlegen SL-Tempates werden für die Kommunikation mit der jeweiligen BKU verwendet. Nähere Details zum Aufbau dieser SL-Templates finden Sie im Kapitel Protokolle (TODO). </p> <p>Die Lage der Templates wird in Form einer URL beschrieben, wobei sowohl lokale Referenzen als der Bezug über https möglich sind. Relative Pfadangaben werden dabei relativ zum Verzeichnis, in dem sich die MOA-ID-Auth Basiskonfigurationsdatei befindet, interpretiert. Bei Templates die über das Protokoll https referenziert werden, muss vor dem Start des Tomcat ein Truststore angegeben werden, das die notwendigen vertrauenswürdigen Zertifikate enthält.</p> <table width="1247" border="1"> @@ -775,7 +904,7 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> <td>SL Template zur Kommunikation mit einer lokalen BKU Instanz</td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_certvalidation" id="konfigurationsparameter_allgemein_bku3"></a>3.1.3 Zertifikatsprüfung</h3> +<h3><a name="konfigurationsparameter_allgemein_certvalidation" id="konfigurationsparameter_allgemein_bku3"></a>3.1.4 Zertifikatsprüfung</h3> <p>Dieser Bereich behandelt die allgemeine Einstellungen zur Zertifikatsprüfung und die Konfiguration von vertrauenswürdigen Zertifikaten.</p> <table width="1247" border="1"> <tr> @@ -805,7 +934,7 @@ Checking</td> <td>ChainingMode definiert, ob bei der Zertifikatspfad-überprüfung das Kettenmodell ("chaining") oder das Modell nach PKIX RFC 3280 ("pkix") verwendet werden soll. </td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_timeouts" id="konfigurationsparameter_allgemein_bku4"></a>3.1.4 Session TimeOuts</h3> +<h3><a name="konfigurationsparameter_allgemein_timeouts" id="konfigurationsparameter_allgemein_bku4"></a>3.1.5 Session TimeOuts</h3> <table width="1247" border="1"> <tr> <th width="174" scope="col">Name</th> @@ -828,7 +957,7 @@ Checking</td> <td>Gibt die Zeitspanne in Sekunden an, die eine Single Sign-On (SSO) Session seit dem letzten Zugriff (Anmeldevorgang) ausgehend gültig ist. Nach Ablauf dieser Zeitspanne muss sich die BenutzerIn / der Benutzer bei einer erneuten Anmeldung neu authentifizieren.</td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_moasp" id="konfigurationsparameter_allgemein_bku5"></a>3.1.5 MOA-SP</h3> +<h3><a name="konfigurationsparameter_allgemein_moasp" id="konfigurationsparameter_allgemein_bku5"></a>3.1.6 MOA-SP</h3> <p>Der Abschnitt MOA-SP Konfiguration enthält Parameter zur Nutzung von MOA-SP. MOA-SP wird für die überprüfung der Signatur der Personenbindung und des AUTH-Blocks verwendet.</p> <p>MOA-SP muss entsprechend konfiguriert werden - siehe hierzu Abschnitt <a href="http://joinup.ec.europa.eu/site/moa-idspss/moa-id-1.5.1/doc/moa_id/id-admin_2.htm#sp-config">Konfiguration von MOA-SP</a> TODO!. Alle Details zur Konfiguration von MOA-SP finden sie in der Distribution von MOA-SP/SS beiligenden Dokumentation im Abschnitt 'Konfiguration'. </p> <table width="1247" border="1"> @@ -859,7 +988,7 @@ Checking</td> <strong>Hinweis:</strong> Wird kein <em>MOA-SP Service URL</em> angegeben so wird eine MOA-ID beiligende Version von MOA-SP direkt über das Java-API angesprochen. In diesem Fall muss das System-Property auf die verwendete Konfigurationsdatei von MOA-SP gesetzt werden. Eine beispielhafte MOA-SP Konfigurationsdatei ist in <em>$MOA_ID_INST_AUTH/conf/moa-spss/SampleMOASPSSConfiguration.xml </em>enthalten. </td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_services" id="konfigurationsparameter_allgemein_bku6"></a>3.1.6 Externe Services</h3> +<h3><a name="konfigurationsparameter_allgemein_services" id="konfigurationsparameter_allgemein_bku6"></a>3.1.7 Externe Services</h3> <p>Hiermit werden die URLs zum Online-Vollmachten Service und zum SZR-Gateway konfiguriert. Die Konfiguration der für den Zugriff benötigen Client-Zertifikate wurden bereits im Abschnitt <a href="#basisconfig_moa_id_auth_param_services">2.2.2.2</a> behandelt.</p> <table width="1247" border="1"> <tr> @@ -879,7 +1008,7 @@ Checking</td> <td>URL zum Stammzahlen-Register Gateway</td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_sso" id="konfigurationsparameter_allgemein_bku7"></a>3.1.7 Single-Sign On(SSO)</h3> +<h3><a name="konfigurationsparameter_allgemein_sso" id="konfigurationsparameter_allgemein_bku7"></a>3.1.8 Single-Sign On(SSO)</h3> <p>In der SSO Konfiguration muss angegen werden in welchem Bereich (öffentlicher oder privatwirschtlicher Bereich) die MOA-ID-Auth Instanz betrieben wird. Je nach dem zu welchem Bereich die Instanz zugeordnet ist ergibt sich ein unterschiedlicher Funktionsumfang der SSO Funktionalität.</p> <ol> <li><strong>Öffentlicher Bereich:</strong> Die MOA-ID-Auth Instanz ist einem öffentlichen Bereich für SSO zugeordnet. In diesem Fall können sowohl öffentlichen als auch privatwirtschaftliche Applikationen diese MOA-ID-Auth Instanz für eine Anmeldung mittels SSO Nutzen. Eine Zuordnung in den öffentlichen Bereich ist jedoch nur dann Möglich wenn mindestens eine der folgenden Anforderungen erfüllt ist. @@ -903,11 +1032,6 @@ Checking</td> <th width="843" scope="col">Beschreibung</th> </tr> <tr> - <td><span id="wwlbl_loadGeneralConfig_moaconfig_ssoPublicUrl">SSO Service URL-Prefix</span></td> - <td>https://demo.egiz.gv.at/moa-id-auth/</td> - <td>URL-Prefix der MOA-ID Instanz. Dieser URL wird als Service-URL im Authblock eingetragen und durch die BenutzerIn / den Benutzer signiert.</td> - </tr> - <tr> <td><p><span id="wwlbl_loadGeneralConfig_moaconfig_ssoFriendlyName">SSO Service Name</span></p></td> <td>EGIZ MOA-ID 2.0</td> <td>Öffentlicher Name der MOA-ID Instanz. Dieser Name wird in den Authblock eingetragen und durch die BenutzerIn / den Benutzer signiert.</td> @@ -940,16 +1064,16 @@ Checking</td> <p><em>Ich Max Mustermann stimme am 05.02.2014 um 10:35 einer Anmeldung mittels Single Sign-On zu.</em></p></td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_stork" id="konfigurationsparameter_allgemein_bku8"></a>3.1.8 Secure idenTity acrOss boRders linKed (STORK)</h3> +<h3><a name="konfigurationsparameter_allgemein_stork" id="konfigurationsparameter_allgemein_bku8"></a>3.1.9 Secure idenTity acrOss boRders linKed (STORK)</h3> <p>TODO:</p> -<h3><a name="konfigurationsparameter_allgemein_protocol" id="konfigurationsparameter_allgemein_bku9"></a>3.1.9 Protokolle</h3> +<h3><a name="konfigurationsparameter_allgemein_protocol" id="konfigurationsparameter_allgemein_bku9"></a>3.1.10 Protokolle</h3> <p>Hierbei handelt es ich um allgemeine Einstellungen zu den vom Modul MOA-ID-Auth unterstützen Authentifizierungsprotokollen.</p> -<h4><a name="konfigurationsparameter_allgemein_protocol_allowed" id="konfigurationsparameter_allgemein_bku10"></a>3.1.9.1 Protkolle aktivieren</h4> +<h4><a name="konfigurationsparameter_allgemein_protocol_allowed" id="konfigurationsparameter_allgemein_bku10"></a>3.1.10.1 Protkolle aktivieren</h4> <p>In diesem Abschnitt können die einzelnen von MOA-ID-Auth unterstützen Authentifizierungsprotokolle aktiviert oder deaktiviert werden. Diese Einstellung gilt für die gesamte MOA-ID-Auth Instanz.</p> -<h4><a name="konfigurationsparameter_allgemein_protocol_legacy" id="konfigurationsparameter_allgemein_bku11"></a>3.1.9.2 Legacy Modus</h4> +<h4><a name="konfigurationsparameter_allgemein_protocol_legacy" id="konfigurationsparameter_allgemein_bku11"></a>3.1.10.2 Legacy Modus</h4> <p>Ab der Version 2.0 des Modules MOA-ID-Auth wird die Bürgerkartenauswahl standardmäßig von MOA-ID-Auth bereitgestellt und erfolgt im Kontext von MOA-ID-Auth. Dem zu Folge müssen die aus MOA-ID 1.5.1 bekannten StartAuthentication Parameter (target, bkuURL, template, usemandate) nicht mehr im StartAuthentication Request übergeben werden.</p> Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der Online-Applikation erfolgen muss für das jeweilige Protokoll der Legacy Modus aktiviert werden. Wird der Legacy Modus verwendet müssen jedoch die bkuURL, das Security-Layer Template und der Target mit den bei MOA-ID-Auth hinterlegten Konfigurationsparametern der Online-Applikation übereinstimmten. Detailinformationen hierzu finden Sie im Kapitel Protokolle. TODO: -<h4><a name="konfigurationsparameter_allgemein_protocol_saml1" id="konfigurationsparameter_allgemein_bku12"></a>3.1.9.3 SAML1 Konfiguration</h4> +<h4><a name="konfigurationsparameter_allgemein_protocol_saml1" id="konfigurationsparameter_allgemein_bku12"></a>3.1.10.3 SAML1 Konfiguration</h4> <p>Die SourceID ist ein Teil des SAML1 Artifacts welches zur Abholung der SAML1 Assertion an die Online-Applikation zurückgegeben wird. Standardmäßig wird die SourceID aus der URL der jeweiligen Online-Applikation, an der die Anmeldung stattfinden, generiert. Optional kan jedoch eine SourceID für die gesamte MOA-ID-Auth Instanz vergeben werden, welche für alle Online-Applikationen verwendet wird.</p> <table width="1247" border="1"> <tr> @@ -964,9 +1088,9 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der </tr> </table> <p> </p> -<h4><a name="konfigurationsparameter_allgemein_protocol_pvp21" id="konfigurationsparameter_allgemein_bku13"></a>3.1.9.4 PVP2.1 Konfiguration</h4> +<h4><a name="konfigurationsparameter_allgemein_protocol_pvp21" id="konfigurationsparameter_allgemein_bku13"></a>3.1.10.4 PVP2.1 Konfiguration</h4> <p>Die allgemeinen Konfigurationsparameter für das Authentifizierungsprotkoll PVP2.1 behandeln Informationen zum Betreiber der MOA-ID-Auth Instanz und zu einer Ansprechperson für diese Instanz. Diese Parameter werden in den PVP2.1 Metadaten, die von MOA-ID-Auth für Online-Applikation (Service Providern) bereitgestellt werden, eingetragen.</p> -<h5><a name="konfigurationsparameter_allgemein_protocol_pvp21_org" id="konfigurationsparameter_allgemein_bku15"></a>3.1.9.4.1 Betreiberorganisation</h5> +<h5><a name="konfigurationsparameter_allgemein_protocol_pvp21_org" id="konfigurationsparameter_allgemein_bku15"></a>3.1.10.4.1 Betreiberorganisation</h5> <table width="1247" border="1"> <tr> <th width="210" scope="col">Name</th> @@ -974,11 +1098,6 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der <th width="823" scope="col">Beschreibung</th> </tr> <tr> - <td>PVP2 Service URL-Prefix</td> - <td>https://demo.egiz.gv.at/moa-id-auth/</td> - <td>Public-URL Prefix unter der die MOA-ID-Auth Instanz erreichbar ist.</td> - </tr> - <tr> <td><p>PVP Service Name</p></td> <td>MOA-ID 2.0 Demo IDP</td> <td>Name der MOA-ID-Auth Instanz. Dieser Name wird in den Metadaten im Element <em>md:EntitiesDescriptor</em> als Attribut <em>Name</em> angezeigt.</td> @@ -999,7 +1118,7 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der <td>URL zu einer Seite mit Informationen der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element <em>md:Organization</em>/<em>md:OrganizationURL</em> angezeigt.</td> </tr> </table> -<h5><a name="konfigurationsparameter_allgemein_protocol_pvp21_contact" id="konfigurationsparameter_allgemein_bku16"></a>3.1.9.4.2 Kontaktperson</h5> +<h5><a name="konfigurationsparameter_allgemein_protocol_pvp21_contact" id="konfigurationsparameter_allgemein_bku16"></a>3.1.10.4.2 Kontaktperson</h5> <p>TODO:</p> <table width="1247" border="1"> <tr> @@ -1046,7 +1165,7 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der <p>Dieser Name wird in den Metadaten im Element <em>md:ContactPerson</em>als Attribut <em>contactType</em> angezeigt.</p></td> </tr> </table> -<h3><a name="konfigurationsparameter_allgemein_sltransform" id="konfigurationsparameter_allgemein_bku14"></a>3.1.10 SecurityLayer Transformationen</h3> +<h3><a name="konfigurationsparameter_allgemein_sltransform" id="konfigurationsparameter_allgemein_bku14"></a>3.1.11 Security-Layer Transformationen</h3> <p>Die SecurityLayer (SL) Transformation, welche von MOA-ID-Auth für die Erstellung der Signatur des AuthBlock verwendet werden soll, muss hier angegebn weren. Über das Datei-Upload Feld kann die zu verwendende Transformation hochgeladen werden. Diese befindet sich in der MOA-ID-Auth Defaultkonfiguration im Ordner <em>/conf/moa-id/transforms/ TransformsInfoAuthBlockTable_DE_2.0.xml</em>. TODO: URL</p> <h2><a name="konfigurationsparameter_oa" id="uebersicht_zentraledatei_aktualisierung3"></a>3.2 Online Applikationen</h2> <p>Die Konfiguration von Online-Applikationen erfolgt ebenfalls mit Hilfe des Moduls MOA-ID-Configuration. Es können sowohl neue Online-Applikationen erstellt als auch bestehende Online-Applikationen bearbeitet oder gelöscht werden. Der erlaubte Konfigurationsumfang hängt jedoch von Role des aktuellen Benutzers ab, wobei eine Konfiguration der gesamten Parameter nur einem Benutzer mit der Role <em>admin</em> möglich ist. Alle Konfigurationsfelder die nur einem Benutzer mit der Role <em>admin</em> zur Verfügung stehen sind gesondert gekennzeichnet.</p> @@ -1157,7 +1276,7 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der <td align="center"> </td> <td>Stammzahl eines privatwirtschaftlichen Unternehmens. Die Angabe erfolgt durch den Prefix des Bereichs aus dem die Stammzahl stammt und der eigentlichen Stammzahl.</td> </tr> - </table> +</table> <h3><a name="konfigurationsparameter_oa_bku" id="uebersicht_zentraledatei_aktualisierung20"></a>3.2.2 BKU Konfiguration</h3> <p>In diesem Abschnitt behandelt online-applikationsspezifische Einstellungen zum Anmeldeprozess. Diese Einstellungen stehen jedoch nur einer BenutzerIn oder einem Benutzer mit der Role <em>admin</em> zur Verfügung.</p> @@ -1504,7 +1623,7 @@ Alle in diesem Abschnitt angegebenen Parameter sind Optional und werden bei Beda <td>#E5E5E5</td> <td align="center">X</td> <td align="center">X</td> - <td>Hintergrundfarbe der Bürgerkartenauswahl und Hintergrundfarbe des Java-Applets der Online-BKU. Die Angabe der Farbe erfolgt als RGB Wert in hexadezimaler Form.</td> + <td>Hintergrundfarbe der Bürgerkartenauswahl und Hintergrundfarbe des Java-Applets der Online-BKU (wird über den Security-Layer Request angegeben) . Die Angabe der Farbe erfolgt als RGB Wert in hexadezimaler Form.</td> </tr> <tr> <td>Vordergrundfarbe</td> @@ -1547,14 +1666,14 @@ Alle in diesem Abschnitt angegebenen Parameter sind Optional und werden bei Beda <td>220</td> <td align="center"> </td> <td align="center">X</td> - <td>Mit diesem Parameter kann die Höhe des Java-Applets der Online-BKU definiert werden.</td> + <td>Mit diesem Parameter kann die Höhe des Java-Applets der Online-BKU definiert werden. Dieser Parameter überschreibt einen in der BKU-Auswahl übergebenen Parameter (siehe <a href="#import_template_bku">Kapitel 3.4.1</a>).</td> </tr> <tr> <td>Appletbreite</td> <td>250</td> <td align="center"> </td> <td align="center">X</td> - <td>Mit diesem Parameter kann die Breite des Java-Appletes der Online-BKU definiert werden.</td> + <td>Mit diesem Parameter kann die Breite des Java-Appletes der Online-BKU definiert werden. Dieser Parameter überschreibt einen in der BKU-Auswahl übergebenen Parameter (siehe <a href="#import_template_bku">Kapitel 3.4.1</a>).</td> </tr> <tr> <td>Formularschrifttypen</td> @@ -1578,21 +1697,315 @@ Alle in diesem Abschnitt angegebenen Parameter sind Optional und werden bei Beda <p> </p> <h2><a name="import_export" id="uebersicht_zentraledatei_aktualisierung4"></a>3.3 Import / Export</h2> <p>Über diese Funktionalität besteht die Möglichkeit eine bestehende MOA-ID 1.5.1 -Konfiguration in MOA-ID 2.0 zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID 2.0 -Konfiguration in ein XML Dokument zu exportieren oder in eine bestehende MOA-ID 2.0 -XML Konfiguration zu importieren.</p> +Konfiguration in MOA-ID 2.0 zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID-Auth 2.0 +Konfiguration in ein XML Dokument zu exportieren oder in eine bestehende MOA-ID-Auth 2.0 +XML Konfiguration zu importieren. Eine exportierte MOA-ID-Auth 2.0 XML-Konfiguration kann auch direkt zur Konfiguration des Modules MOA-ID-Auth herangezogen werden (siehe <a href="#basisconfig_moa_id_auth_param_general">Kapitel 2.2.2.1</a>)</p> <p><strong>Hinweis:</strong> - Zu beachten ist, dass bei einem Import die aktuell vorhandene -Konfiguration vollständig gelöscht und durch die importierte Konfiguration ersetzt wird. -Es wird empfohlen ein Backup einer eventuell vorhandenen MOA-ID 2.0 Konfiguration -zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die + Zu beachten ist, dass bei einem Import die aktuell vorhandene + Konfiguration vollständig gelöscht und durch die importierte Konfiguration ersetzt wird. + Es wird empfohlen ein Backup einer eventuell vorhandenen MOA-ID 2.0 Konfiguration + zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die Exportfunktion verwendet werden.</p> -<p> </p> <h3><a name="import_export_legacy" id="uebersicht_zentraledatei_aktualisierung5"></a>3.3.1 Import alter Konfigurationen (<= MOA-ID 1.5.1)</h3> +<p>Es besteht auch die Möglichkeit eine bestehende MOA-ID 1.5.1 Konfiguration zu importieren. Da nicht alle neuen Konfigurationsparameter automatisiert aus der MOA-ID 1.5.1 Konfiguration erstellt werden sind für den Importforgang mehrere Schritte notwendig. Es wi</p> +<ol> + <li>Importieren einer bestehenden MOA-ID 1.5.1 Konfiguration mithilfe der Import Funktion des Modules MOA-ID-Configuration. Danach sollten sowohl die allgemeine Konfiguration als auch die Online-Applikationen eingetragen sein. </li> + <li>Allgemeine Konfiguration: Folgende Punkte der allgemeinen Konfiguration müssen auf jeden Fall kontrolliert und eventuell angepasst werden. + <ol> + <li><a href="#konfigurationsparameter_allgemein_publicurlprefix">Public URL Prefix</a>: Dieser Parameter MUSS konfiguriert werden.</li> + <li><a href="#konfigurationsparameter_allgemein_bku">Default BKU-URLs</a>: Die Konfiguration von default BKU URLs wird empfohlen.</li> + <li><a href="#konfigurationsparameter_allgemein_sl-templates">SecurityLayer Request Templates</a>: Dieser Parameter MUSS konfiguriert werden.</li> + <li><a href="#konfigurationsparameter_allgemein_sso">Single Sign-On Einstellungen</a></li> + <li><a href="#konfigurationsparameter_allgemein_protocol_pvp21">PVP 2.1 Konfiguration</a></li> + <li><a href="#konfigurationsparameter_allgemein_sltransform">SecurtiyLayer Transformation</a>: Sollte die SecurityLayer Transformation (siehe Kapitel 1.3.1.9) nicht korrekt importiert worden sein (Dateiname ist leer) muss diese neu hochgeladen werden. Die akuelle Transformation befindet sich in der MOA-ID-Auth Defaultkonfiguration im Ordner <em>/conf/moa-id/transforms/ TransformsInfoAuthBlockTable_DE_2.0.xml</em></li> + </ol> + </li> + <li>5. Online-Applikationen: Je nachdem welche Authentifizierungsprotokolle verwendet werden oder wenn Single Sign-On nicht unterstützen werden soll sind Änderungen an der Online-Applikationskonfiguration erforderlich. Hierfür muss die jeweilige Online-Applikation aus der Liste der Online-Applikationen auswählen und die jeweiligen Parameter anpassen. + <ol> + <li><a href="#konfigurationsparameter_oa_sso">Single Sign-On</a>: Standardmäßig ist Single Sign-On aktiviert.</li> + <li><a href="#konfigurationsparameter_oa_protocol_pvp21">PVP2 Konfiguration</a>: Soll für die Authentifizierung das PVP2.1 Protokoll verwendet werden, so müssen die PVP2 spezifischen Parameter bei der jeweiligen Online-Applikation eingetragen werden.</li> + <li><a href="#konfigurationsparameter_oa_protocol_openIDConnect">OponID Connect Konfiguration</a>: Soll für die Authentifizierung das Protokoll OpenID Connect verwendet werden, so müssen alle OpenID Connect spezifischen Parameter bei der jeweiligen Online-Applikation hinterlegt werden.</li> + <li><a href="#konfigurationsparameter_oa_bku">BKU Konfiguration</a>: Soll für die Online-Applikation spezielle BKU Instanzen verwendet werden, so müssen diese für die Online-Applikation konfiguriert werden. Diese Konfiguration ist auf bei Verwendung von SAML1 als Authentifizierungsprotokoll erforderlich. Nähere Informationen finden Sie im jeweiligen Kapitel der Dokumentation.</li> + </ol> + </li> + <li> Wenn alle Änderungen und Anpassungen abgeschlossen wurden wird ein Neustart des Tomcat, welcher das Module MOA-ID-Auth beinhaltet, empfohlen. Nach dem erfolgreichen Neustart steht die Anmeldung an den registrierten Online-Applikationen bereits zur Verfügung. Sollte das Module MOA-ID-Auth nicht erfolgreich starten, muss die Konfiguration, je nach gemeldetem Fehler, ergänzt oder geändert werden.</li> +</ol> +<h2><a name="import_template_" id="uebersicht_zentraledatei_Templates"></a>4 Templates</h2> +<p>Dieser Abschnitt spezifiziert den Mindestaufbau der Templates für die BKU Auswahl, die Single Sign-On Anmeldeabfrage und die Security-Layer Request Templates welche vo Module MOA-ID-Auth verwendet werden. Alle hier beschriebenen Templates werden durch MOA-ID-Auth geladen, erweitert und gegebenfalls der Benutzerin oder dem Benutzer im Web-Browser dargestellt. Um einen korrekten Anmeldeprozess zu gewährleisten müssen diese Templates mindestens folgende Formvorschriften und Strukturen aufweisen.</p> +<h3><a name="import_template_bku" id="uebersicht_zentraledatei_aktualisierung6"></a>4.1 Bürgerkartenauswahl</h3> +<p>Das BKU Template dient im Anmeldeprozess der Auswahl der gewünschten Bürgerkatenumgebung oder Handy-Signature. Nach erfolgter Auswahl durch die Benutzer oder dem Benutzer wird diese an MOA-ID-Auth übermittelt. Für die Übermittlung an MOA-ID-Auth ist ein http GET Request vorgesehen welcher folgende Parameter unterstützt. Die URL dieses http GET Request wird automatisiert über den Parameter „#AUTH_URL#“ (ohne „“) eingetragen und muss nicht manuell hinterlegt werden. Folgende http GET Parameter werden für die BKU-Auswahl akzeptiert.</p> +<table width="1201" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="168" scope="col">Beispielwert</th> + <th width="57" scope="col">Optional</th> + <th width="781" scope="col">Beschreibung</th> + </tr> + <tr> + <td>bkuURI</td> + <td>online / handy / local</td> + <td align="center"> </td> + <td><p>Ausgewählte Bürgerkartenumgebung. Für diesen Parameter stehen folgende Werte zur Verfügung. + </p> + <ul> + <li>online : Online BKU</li> + <li>handy : Handy BKU</li> + <li>local : locale BKU</li> + </ul> </td> + </tr> + <tr> + <td>MOASessionID</td> + <td>#SESSIONID#</td> + <td align="center"> </td> + <td>Internes SessionTokken. Der Parameterwert wird durch MOA-ID-Auth automatisch in das Formular eingefügt. Hierfür MUSS jedoch der Parameterwert durch Platzhalter #SESSIONID# gekennzeichnet werden.</td> + </tr> + <tr> + <td>useMandate</td> + <td>true / false</td> + <td align="center">X</td> + <td>Kennzeichnet eine Anmeldung mittels Online-Vollmacht.</td> + </tr> + <tr> + <td>CCC</td> + <td>ES, SI, ...</td> + <td align="center">X</td> + <td>Anmeldung mittels STORK, wobei in diesem Fall der jeweilige Ländercode angegeben werden muss.</td> + </tr> + <tr> + <td>heigth</td> + <td>200</td> + <td align="center">X</td> + <td>Höhe des Java Applets falls die Online-BKU gewählt wurde. Die Konfiguration der Höhe kann jedoch auch über die Konfiguration der Online-Applikation erfolgen. (siehe <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a>)</td> + </tr> + <tr> + <td>width</td> + <td>250</td> + <td align="center">X</td> + <td>Breite des Java Applets falls die Online-BKU gewählt wurde. Die Konfiguration der Breite kann jedoch auch über die Konfiguration der Online-Applikation erfolgen. (siehe <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a>)</td> + </tr> +</table> +<p><br> +Einige dieser Parameter werden jedoch nicht durch den Benutzer oder dem Service-Provider sondern durch das Modul MOA-ID-Auth im Rahmen des Anmeldeprozesses automatisiert, an im Template gekennzeichneten Stellen, eingetragen. Folgende Platzhalter stehen zur Verfügung und werden von MOA-ID-Auth durch die jeweiligen Werte ersetzt. Alle nicht als Optional gekennzeichneten Platzhalter müssen durch MOA-ID-Auth ersetzt werden.</p> +<table width="1198" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="63" scope="col">Optional</th> + <th width="946" scope="col">Beschreibung</th> + </tr> + <tr> + <td>#AUTH_URL#</td> + <td> </td> + <td>Dieser Platzhalter wird durch die URL, an welche die BKU Auswahl gesendet wird ersetzt. </td> + </tr> + <tr> + <td>#SESSIONID#</td> + <td> </td> + <td>Dieser Platzhalter wird durch ein internes SessionTokken ersetzt, welches als GET Parameter wieder an MOA-ID-Auth übergeben werden muss.</td> + </tr> + <tr> + <td>#LOCAL#</td> + <td align="center">X</td> + <td>Der Platzhalter wird durch den Parameterwert zur Auswahl der localen BKU erstetzt.</td> + </tr> + <tr> + <td>#ONLINE#</td> + <td align="center">X</td> + <td>Der Platzhalter wird durch den Parameterwert zur Auswahl der Online-BKU erstetzt.</td> + </tr> + <tr> + <td>#HANDY#</td> + <td align="center">X</td> + <td>Der Platzhalter wird durch den Parameterwert zur Auswahl der Handy-BKU erstetzt.</td> + </tr> +</table> +<p><br> + Die nachfolgenden Beispiele zeigen ein Beispiel für den Aufbau des im BKU-Auswahl Template zu verwendeten http GET Request Templates für die lokale BKU.</p> +<pre><form method="get" id="moaidform" action="#AUTH_URL#"><br> + <input type="hidden" name="bkuURI" value="#LOCAL#"> <br> + <input type="hidden" name="useMandate" id="useMandate"> <br> + <input type="hidden" name="CCC" id="ccc"> <input type="hidden"<br> + <input type="hidden" name="MOASessionID" value="#SESSIONID#"><br> + <input type="submit" value=">lokale Bürgerkartenumgebung"><br> +</form> +</pre> +<p>Als Beispiel für ein BKU-Auswahl Template steht auch das bei MOA-ID-Auth hinterlegte Standardtemplate zur Verfügung. Dieses finden Sie unter TODO:</p> +<h3><a name="import_template_sso" id="uebersicht_zentraledatei_aktualisierung7"></a>4.2 Single Sign-On Anmeldeabfrage</h3> +<p>Das Send-Assertion Template dient im Falle einer Anmeldung mittels Single Sign-On der Abfrage ob die Anmeldedaten an die betreffende Online Applikation übertragen werden dürfen. Ähnlich dem Template für die Bürgerkartenauswahl müssen auch hierbei Formvorschriften und Strukturen im Aufbau des Templates eingehalten werden.<br> +Für die Übermittlung an das Modul MOA-ID-Auth ist ein http POST Request vorgesehen welcher folgende Parameter unterstützt. Die URL, an welche dieser http POST Request gesendet werden muss, wird automatisiert über den Parameter „#URL#“ (ohne „“) eingetragen und muss nicht manuell hinterlegt werden.</p> +<table width="1201" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="168" scope="col">Beispielwert</th> + <th width="57" scope="col">Optional</th> + <th width="781" scope="col">Beschreibung</th> + </tr> + <tr> + <td>mod</td> + <td>#MODUL#</td> + <td align="center"> </td> + <td><p>Internes SessionTokken. Der Parameterwert wird durch MOA-ID-Auth automatisch in das Formular eingefügt. Hierfür MUSS jedoch der Parameterwert durch Platzhalter #MODUL# gekennzeichnet werden.</p></td> + </tr> + <tr> + <td>action</td> + <td>#ACTION#</td> + <td align="center"> </td> + <td>Internes SessionTokken. Der Parameterwert wird durch MOA-ID-Auth automatisch in das Formular eingefügt. Hierfür MUSS jedoch der Parameterwert durch Platzhalter #ACTION# gekennzeichnet werden.</td> + </tr> + <tr> + <td>identifier</td> + <td>#ID#</td> + <td align="center"> </td> + <td>Internes SessionTokken. Der Parameterwert wird durch MOA-ID-Auth automatisch in das Formular eingefügt. Hierfür MUSS jedoch der Parameterwert durch Platzhalter #ID# gekennzeichnet werden.</td> + </tr> + <tr> + <td>value</td> + <td>true / false</td> + <td align="center"> </td> + <td>Antwort des Benutzers ob die Anmeldedaten an die Online-Applikation übertragen werden dürfen. Dementsprechend wird der Anmeldevorgang vorgesetzt oder abgebrochen und die Anmeldedaten oder eine Fehlermeldung über den Abbruch an die Online-Applikation übermittelt.</td> + </tr> +</table> +<p><br> +Einige dieser Parameter werden jedoch nicht durch den Benutzer oder dem Service-Provider sondern durch das Modul MOA-ID-Auth im Rahmen des Anmeldeprozesses automatisiert, an im Template gekennzeichneten Stellen, eingetragen. Folgende Platzhalter stehen zur Verfügung und werden von MOA-ID-Auth durch die jeweiligen Werte ersetzt. Alle nicht als Optional gekennzeichneten Platzhalter müssen durch MOA-ID-Auth ersetzt werden.</p> +<table width="1198" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="63" scope="col">Optional</th> + <th width="946" scope="col">Beschreibung</th> + </tr> + <tr> + <td>#URL#</td> + <td> </td> + <td>Dieser Platzhalter wird durch die URL, an welche das Ergebnis der Single Sign-On Anmeldeabfrage gesendet wird ersetzt. </td> + </tr> + <tr> + <td>#MODUL#</td> + <td> </td> + <td>Dieser Platzhalter wird durch das verwendete Authentifizierungsprotokoll ersetzt, welches als GET Parameter wieder an MOA-ID-Auth übergeben werden muss.</td> + </tr> + <tr> + <td>#ACTION#</td> + <td align="center"> </td> + <td>Dieser Platzhalter wird durch einen Subtyp des verwendeten Authentifizierungsprotokolls, welches als GET Parameter wieder an MOA-ID-Auth übergeben werden muss.</td> + </tr> + <tr> + <td>#ID#</td> + <td align="center"> </td> + <td>Dieser Platzhalter wird durch ein internes SessionTokken ersetzt, welches als GET Parameter wieder an MOA-ID-Auth übergeben werden muss.</td> + </tr> +</table> +<p><br> +Die nachfolgenden Beispiele zeigen ein Beispiel für den Aufbau des im BKU-Auswahl Template zu verwendeten http GET Request Templates für die lokale BKU.</p> +<pre><form method="post" id="moaidform_yes" action="#URL#"><br> + <input type="hidden" name="value" value="true"><br> + <input type="hidden" name="mod" value="#MODUL#"><br> + <input type="hidden" name="action" value="#ACTION#"><br> + <input type="hidden" name="identifier" value="#ID#"><br> + <input type="submit" size="400" value="Ja"><br> +</form></pre> +<p>Als Beispiel für ein Single Sign-On Anmeldeabfrage Template steht auch das bei MOA-ID-Auth hinterlegte Standardtemplate zur Verfügung. Dieses finden Sie unter TODO:</p> +<h3><a name="import_template_sltemplate" id="uebersicht_zentraledatei_aktualisierung8"></a>4.3 Security-Layer Request</h3> +<p>Das Security-Layer (SL) Request Template dient zur Kommunikation zwischen dem Modul MOA-ID-Auth und der gewählten Bürgerkartenumgebung. Diese Kommunikation erfolgt über ein http Formular welches als http POST Request an die Bürgerkartenumgebung gesendet wird. Bei MOA-ID-Auth werden SL Templates mitgeliefert, wobei einige Template Parameter auch über das Konfigurationstool je Online-Applikation angepasst werden können (siehe <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a>).</p> +<p>Für den Fall dass indivituelle Anpassungen am SL Template erforderlich sind müssen diese folgende Formvorschriften erfüllen.</p> +<pre><form name="CustomizedForm" action="<BKU>" method="post"> + <input type="hidden" name="XMLRequest" value="<XMLRequest>"/> + <input type="hidden" name="DataURL" value="<DataURL>"/> + <input type="hidden" name="PushInfobox" value="<PushInfobox>"/> + <input type="submit" value="Anmeldung mit Bürgerkarte"/> +</form> +<form name="CustomizedInfoForm" action="<BKU>" method="post"> + <input type="hidden" name="XMLRequest" value="<CertInfoXMLRequest>"/> + <input type="hidden" name="DataURL" value="<CertInfoDataURL>"/> Hier finden Sie weitere Informationen zur Überprüfung der Zertifikate.<br/> + <input type="submit" value="Weitere Info"/> +</form></pre> +<p>Innerhalb dieser <form>-Elemente können Texte, Beschriftungen und Styles modifiziert werden, und es können zusätzliche Elemente darin aufgenommen werden. Die vorgegebene Grundstruktur ist aber in jedem Fall einzuhalten, und es müssen die speziellen Tags <em><BKU></em> (kommt 2x vor), <em><XMLRequest></em>, <em><DataURL></em>, <em><CertInfoXMLRequest></em> und <em><CertInfoDataURL></em> darin enthalten sein.</p> +<table width="1198" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="63" scope="col">Optional</th> + <th width="946" scope="col">Beschreibung</th> + </tr> + <tr> + <td><BKU></td> + <td> </td> + <td>Dieser Platzhalter wird durch die URL zur gewählten Bürgerkartenumgebung ersetzt.. </td> + </tr> + <tr> + <td><XMLRequest></td> + <td> </td> + <td>Dieser Platzhalter wird durch den XML basierten Security-Layer Request ersetzt. Dieser XML Request enthält die eigentliche Anfrage an die Bürgerkartenumgebung. Nähere Details zu diesem XML Request entnehmen Sie bitte der aktuellen Security-Layer Spezifikation.TODO:</td> + </tr> + <tr> + <td><DataURL></td> + <td align="center"> </td> + <td>Dieser Platzhalter wird durch eine URL, welche einen eindeutigen, für jeden Auslesevorgang unterschiedlichen Identifier beinhaltet. Diese URL verweist auf ein Servlet, welches die Personenbindung entgegennimmt und in Folge eine Antwort darauf erzeugt.</td> + </tr> + <tr> + <td><CertInfoXMLRequest></td> + <td align="center"> </td> + <td> </td> + </tr> + <tr> + <td><CertInfoDataURL></td> + <td align="center"> </td> + <td> </td> + </tr> +</table> +<p> </p> +<p>Folgende zusätzliche Tags zur Layoutanpassung (siehe <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a>) stehen optional zur Verfügung und können über das SL Template an die Bürgerkartenumgebung übergeben werden. Ein Beispiel für die Verwendung dieser zusätzlichen Tags finden Sie im beigelegten SL Tempalte. TODO: </p> +<table width="1198" border="1"> + <tr> + <th width="167" scope="col">Name</th> + <th width="63" scope="col">Optional</th> + <th width="946" scope="col">Beschreibung</th> + </tr> + <tr> + <td height="24"><REDIRECTTARGET></td> + <td align="center">X</td> + <td>Mit diesem Tag wird der Parameter <em>Targetparameter </em>aus <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a> an die Bürgerkartenumgebung übermittelt.</td> + </tr> + <tr> + <td><APPLETWIDTH></td> + <td align="center">X</td> + <td>Mit diesem Tag wird der Parameter <em>Appletbreite</em> aus <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a> an die Bürgerkartenumgebung übermittelt.</td> + </tr> + <tr> + <td><APPLETHEIGHT></td> + <td align="center">X</td> + <td>Mit diesem Tag wird der Parameter <em>Applethöhe</em> aus <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a> an die Bürgerkartenumgebung übermittelt.</td> + </tr> + <tr> + <td><COLOR></td> + <td align="center">X</td> + <td>Mit diesem Tag wird der Parameter <em>Hintergrundfarbe</em> aus <a href="#konfigurationsparameter_oa_additional_formular">Kapitel 3.2.7.1</a> an die Bürgerkartenumgebung übermittelt.</td> + </tr> +</table> +<p> </p> +<h1><a name="referenzierte_spezifikation" id="uebersicht_zentraledatei_aktualisierung30"></a>A Referenzierte Spezifikation</h1> +<table class="fixedWidth" border="1" cellpadding="2"> + <tbody> + <tr> + <th>Spezifikation</th> + <th>Link</th> + </tr> + <tr id="sl"> + <td><p>Security Layer Spezifikation V x.x @TODO Version einfügen</p></td> + <td>@TODO Link</td> + </tr> + <tr> + <td>PVP 2.1 S-Profil Spezifikation</td> + <td>@TODO Link</td> + </tr> + <tr> + <td>OpenID Connect</td> + <td>@TODO Link</td> + </tr> + <tr> + <td>STORK 2</td> + <td>@TODO Link</td> + </tr> + </tbody> +</table> +<p> </p> <p> </p> -<h2><a name="import_template_" id="uebersicht_zentraledatei_Templates"></a>3.4 Templates</h2> -<h3><a name="import_template_bku" id="uebersicht_zentraledatei_aktualisierung6"></a>3.4.1 Bürgerkartenauswahl</h3> -<h3><a name="import_template_sso" id="uebersicht_zentraledatei_aktualisierung7"></a>3.4.2 Single Sign-On Anmeldeabfrage</h3> -<h3><a name="import_template_sltemplate" id="uebersicht_zentraledatei_aktualisierung8"></a>3.4.3 Security-Layer Request</h3> </body> </html> |