diff options
| author | Thomas Lenz <tlenz@iaik.tugraz.at> | 2020-04-06 10:23:53 +0200 |
|---|---|---|
| committer | Thomas Lenz <tlenz@iaik.tugraz.at> | 2020-04-06 10:23:53 +0200 |
| commit | a056118bbfabb53dc2856ff07d068cd57ddc8be3 (patch) | |
| tree | e8972ade3b0137e8a61e10d9717a512787c16ba5 /id/server/doc/handbook_v40/config | |
| parent | 7fa91731a8b852e9a8a4ea1a152a5aa74523d47e (diff) | |
| parent | aebaed0e889413491b5769babf39a200bd312992 (diff) | |
| download | moa-id-spss-a056118bbfabb53dc2856ff07d068cd57ddc8be3.tar.gz moa-id-spss-a056118bbfabb53dc2856ff07d068cd57ddc8be3.tar.bz2 moa-id-spss-a056118bbfabb53dc2856ff07d068cd57ddc8be3.zip | |
Merge branch 'development_preview'
Diffstat (limited to 'id/server/doc/handbook_v40/config')
| -rw-r--r-- | id/server/doc/handbook_v40/config/config.html | 1168 |
1 files changed, 1168 insertions, 0 deletions
diff --git a/id/server/doc/handbook_v40/config/config.html b/id/server/doc/handbook_v40/config/config.html new file mode 100644 index 000000000..ad5592c54 --- /dev/null +++ b/id/server/doc/handbook_v40/config/config.html @@ -0,0 +1,1168 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" > + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> + <title>MOA-ID - Konfiguration</title> + <link rel="stylesheet" href="../common/MOA.css" type="text/css"> + <link href='https://fonts.googleapis.com/css?family=Roboto:300,400' rel='stylesheet' type='text/css'> +</head> +<body link="#990000"> + + <div id="headline"> + <div class="container"> + <a href="http://www.digitales.oesterreich.gv.at/"><img src="../common/logo_digAT.png"/></a> + <a href="../index.html"><h1>MOA-ID </h1></a> + <br/> + </div> + </div> +<div class="container"> +<h1 align="center">Konfiguration<h1> + +<h2>Inhalt</h2> + <ol class="index"> + <li> + <p><a href="#uebersicht">Übersicht</a></p> + <ol> + <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="#">Zentralers E-ID System</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">SAML1</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> + <li> <a href="#basisconfig_moa_id_auth_param_testing">Testing</a></li> +</ol> + </li> + </ol> + </li> + <li><a href="#uebersicht_logging">Konfiguration des Loggings</a></li> + </ol> + </li> + <li><a href="#konfigurationsparameter">Konfiguration MOA-ID-Auth</a> + <ol> + <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_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">E-ID System</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_saml1">SAML1 Konfiguration</a></li> + </ol> + </li> + <li><a href="#general_revision">Revisionssicherheit</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_eID_demo">E-ID System</a></li> + <li><a href="#konfigurationsparameter_oa_protocol">Authentifizierungsprotokolle</a> + <ol> + <li><a href="#konfigurationsparameter_oa_protocol_saml1">SAML 1</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 2.x.x)</a></li> + </ol> + </li> + </ol> + </li> + <li><a href="#sp-config">Konfiguration von MOA-SP</a></li> + <li><a href="#security">Tomcat Security Manager</a></li> + </ol> +<ol type="A" class="index"> + <li><a href="#referenzierte_spezifikation">Referenzierte Spezifikation</a></li> +</ol> + + <h2><a name="uebersicht" id="uebersicht"></a>1 Übersicht </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 properties-Konfigurationsdateien erfolgt. Der zweite Abschnitt behandelt die Konfiguration des Modules MOA-ID-Auth unter Zuhilfenahme des Modules MOA-ID-Configuration.</p> + <h3><a name="uebersicht_ablauf" id="uebersicht2"></a>1.1 Empfohlener Konfigurationsablauf</h3> + <ol> + <li><a href="#moa_id_config_parameters">Basiskonfiguration 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><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 2.x.x Konfiguration importiert</a> werden. Für bestehende Konfigurationen < 2.x.x wird eine vollständige Neukonfiguration empfohlen.</p> + <p><strong>Hinweis:</strong> Wenn eine bestehende MOA-ID 2.x.x Konfiguration importiert werden soll MUSS diese zuerst mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine XML Datei exportiert werden.</p> +<h2><a name="uebersicht_zentraledatei" id="uebersicht_zentraledatei"></a>2 Basiskonfiguration</h2> +<p>Die Basiskonfiguration für die Module MOA-ID-Auth und MOA-ID-Configuration erfolgt mit Hilfe textueller properties-Dateien. Diese properties-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> +<h3><a name="uebersicht_zentraledatei_aktualisierung" id="uebersicht_zentraledatei_aktualisierung"></a>2.1 MOA-ID-Configuration</h3> + <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> +<h4><a name="moa_id_config_property" id="uebersicht_zentraledatei_aktualisierung7"></a>2.1.1 Bekanntmachung der Konfigurationsdatei</h4> + <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>WINDOWS: -Dmoa.id.webconfig=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties +UNIX: -Dmoa.id.webconfig=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/moa-id-configuration.properties </pre> + <p>Zusätzlich gibt es für das Konfigurationsmodul ein Usermanagment welches ebenfalls über eine eigene Konfiguration verfügt. Die Konfiguration des Usermanagements 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>user.properties</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>WINDOWS: -Duser.properties=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties +UNIX: -Duser.properties=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id-configuration/userdatabase.properties </pre> + <p>Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Configuration erhalten Sie in <a href="../install/install.html#moa_id_configuration_deploy">Abschnitt 2.1.2.4</a> des Installationshandbuchs.</p> +<h4><a name="moa_id_config_parameters" id="uebersicht_zentraledatei_aktualisierung8"></a>2.1.2 Konfigurationsparameter</h4> +<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> +<h5><a name="moa_id_config_parameters_generel" id="uebersicht_zentraledatei_aktualisierung9"></a>2.1.2.1 Allgemeine Konfigurationsparameter</h5> +<p>Die folgenden Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden.</p> +<table class="configtable"> + <tr> + <th scope="col">Name</th> + <th scope="col">Beispielwert</th> + <th scope="col">Beschreibung</th> + </tr> + <tr> + <td>general.defaultlanguage</td> + <td>de, en</td> + <td><p>Hiermit kann die Sprache, welche für die Darstellung der Texte verwendet wird, festgelegt werden.</p> + <p><strong>Hinweis</strong>: Aktuell wird nur Deutsch (de) oder Englisch (en) unterstützt.</p></td> + </tr> + <tr> + <td>general.ssl.certstore</td> + <td>certs/certstore</td> + <td>Gibt den Pfadnamen zu einem Verzeichnis an, das als Zertifikatsspeicher im Zuge der TLS-Server-Zertifikatsüberprüfung verwendet wird.</td> + </tr> + <tr> + <td>general.ssl.truststore</td> + <td>certs/truststore</td> + <td>TrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), das jene Zertifikate enthält, die als vertrauenswürdig betrachtet werden. Im Zuge der Überprüfung der TLS-Serverzertifikate wird die Zertifikatspfaderstellung an einem dieser Zertifikate beendet. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate beim Download von PVP 2.1 Metadaten verwendet.</td> + </tr> + <tr> + <td>general.ssl.hostnamevalidation</td> + <td>true / false</td> + <td><p>Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden. </p> + <p><strong>Hinweis: </strong>Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.</p></td> + </tr> + <tr> + <td>general.moaconfig.key</td> + <td>ConfigurationEncryptionKey</td> + <td><p>Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.</p> + <p><strong>Hinweis:</strong> Dieses Passwort muss identisch zu dem im <a href="#basisconfig_moa_id_auth_param_general">Modul MOA-ID-Auth</a> hinterlegten Passwort sein.</p></td> + </tr> + <tr> + <td>general.pvp.schemavalidation</td> + <td>true / false</td> + <td><p>Hiermit kann die Schemavalidierung für konfigurierte PVP Metadaten deaktiviert werden.</p> + <strong>Hinweis:</strong> Standardmäßig ist die Schemavalidierung aktiv.</td> + </tr> +</table> +<h5>2.1.2.3 Datenbankzugriff</h5> +<p>Diese Konfigurationsparameter sind nicht optional und müssen in der Konfigurationsdatei enthalten sein und individuell angepasst werden. Für die 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 class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>hibernate.dialect</td> + <td><p>org.hibernate.dialect.MySQLDialect</p></td> + <td>Sprachtyp der verwenden Datenbank</td> + </tr> + <tr> + <td>hibernate.connection.url</td> + <td>jdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=true</td> + <td>URL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter <em>charSet=utf-8</em> als Zeichencodierung und <em>autoReconnect=true</em> für automatischen Verbindungsaufbau wird empfohlen</td> + </tr> + <tr> + <td><p>hibernate.connection.driver_class</p></td> + <td>com.mysql.jdbc.Driver</td> + <td>Typ der verwendeten Datenbank</td> + </tr> + <tr> + <td><p>hibernate.connection.username</p></td> + <td>moaconfig</td> + <td>Benutzername für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td><p>hibernate.connection.password</p></td> + <td>moaconfigpassword</td> + <td>Passwort für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td><p>dbcp.validationQuery</p></td> + <td>SELECT 1</td> + <td><p>SQL Query zum Validieren der Datenbank Verbindung</p> + <p><strong>mySQL:</strong> SELECT 1</p> + <p><strong>Oracle:</strong> select 1 from dual</p></td> + </tr> +</table> +<p> </p> +<p><strong>Hinweis:</strong> Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile <code>byteBasedConfig</code> siehe <a href="../install/install.html#moa_id_configuration_deploy">Kapitel Installation</a> als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).</p> +<p> </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_init" id="uebersicht_zentraledatei_aktualisierung13"></a>2.1.3 Initialisierung des Modules MOA-ID-Configuration</h4> +<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 erstellten 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 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> +<p><b>Hinweis:</b> Ein Betrieb des Moduls MOA-ID-Configuration ohne Authentifizierung ist ebenfalls m\F6glich. In diesem Fall wird jedoch empfohlen den Zugriff auf das Konfigurationstool mit anderen Mitteln einzuschr\E4nken.</b></p> +<h4><a name="moa_id_config_user" id="uebersicht_zentraledatei_aktualisierung14"></a>2.1.4 Benutzerverwaltung</h4> +<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> +<h5><a name="moa_id_config_user_add" id="uebersicht_zentraledatei_aktualisierung15"></a>2.1.4.1 Einen neuen Benutzer erstellen</h5> +<p>Für die Registrierung eins neuen Benutzeraccounts werden folgende Informationen benötigt.</p> +<table class="configtable"> + <tr> + <th >Name</th> + <th >Beschreibung</th> + <th align="center">Optional</th> + </tr> + <tr> + <td>Vorname</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 Registrierung mittels PVP 2.1 automatisch eingetragen</td> + <td align="center">nein</td> + </tr> + <tr> + <td>Organisation</td> + <td>Zugeordnete Organisation. Wir bei Registrierung mittels PVP 2.1 automatisch aus der Vollmacht eingetragen</td> + <td align="center">nein</td> + </tr> + <tr> + <td>eMail Adresse</td> + <td>eMail Adresse des Benutzers. Diese wird für weitere eMail Benachrichtigungen verwendet</td> + <td align="center">nein</td> + </tr> + <tr> + <td>Telefonnummer</td> + <td>Telefonnummer des Benutzers</td> + <td align="center">nein</td> + </tr> + <tr> + <td>Benutzername</td> + <td>Benutzername für eine Anmeldung mittels Benutzername und Passwort</td> + <td align="center">nein</td> + </tr> + <tr> + <td>Kennwort</td> + <td>Passwort für eine Anmeldung mittels Benutzername und Passwort</td> + <td align="center">ja</td> + </tr> + <tr> + <td>bPK / wbPK</td> + <td>bPK oder wbPK für eine Anmeldung mittels PVP 2.1</td> + <td align="center">ja</td> + </tr> + <tr> + <td>Benutzer ist aktiviert</td> + <td>Aktiviert oder deaktiviert den jeweiligen Benutzeraccount</td> + <td align="center">ja</td> + </tr> + <tr> + <td>Benutzer ist Admin</td> + <td>Definiert ob der Benutzeraccount über Administrator-Rechte verfügen soll. (siehe <a href="#moa_id_config_user_role">Kapitel 2.2.4.2</a>)</td> + <td align="center">ja</td> + </tr> + <tr> + <td>Benutzername/Passwort erlauben</td> + <td>Definiert ob eine Anmeldung mittels Benutzername und Passwort erlaubt ist. Falls nicht steht der Benutzerin / dem Benutzer nur eine Anmeldung mittels Bürgerkarte oder Handy-Signatur zur Verfügung.</td> + <td align="center">ja</td> + </tr> +</table> +<p> </p> +<p>Neue Benutzer können auf zwei Arten erstellt werden.</p> +<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 Authentifizierung wird die Benutzerin / der Benutzer an das 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> +<h5><a name="moa_id_config_user_role" id="uebersicht_zentraledatei_aktualisierung16"></a>2.1.4.2 Benutzerrechte</h5> +<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 nur folgende Operationen zur Verf\FCgung wobei diese auch besondere Einschr\E4nkungen aufweisen können.</p> +<ul> + <li><strong>Online-Applikationen bearbeiten:</strong> Ein Benutzer ohne Admin-Rechte kann nur jene Online-Applikationen bearbeiten die von ihm erstellt wurden. Das bearbeiten fremder Online-Applikationen ist nicht möglich. Folgende Parameter können durch diesen Benutzer bearbeitet werden. + <ul> + <li><a href="#konfigurationsparameter_oa_general">Informationen zur Online-Applikation</a></li> + <li><a href="#konfigurationsparameter_oa_mandates">Vollmachten</a></li> + <li><a href="#konfigurationsparameter_oa_sso">Single Sign-On verwenden</a></li> + <li><a href="#konfigurationsparameter_oa_stork">STORK</a></li> + <li><a href="#konfigurationsparameter_oa_protocol">Protokolle</a> +<ul> + <li><a href="#konfigurationsparameter_oa_protocol_pvp21">PVP 2.1</a></li> + <li><a href="#konfigurationsparameter_oa_protocol_openIDConnect">OpenID Connect</a></li> + </ul> + </li> + <li><a href="#konfigurationsparameter_oa_additional">bPK / wbPK im Authblock ausblenden</a></li> + </ul> + </li> + <li><strong>Online Applikation anlegen:</strong> Ein Benutzer ohne Admin-Rechte kann neue Online-Applikationen anlegen. Die Funktionen „Online-Applikation aktivieren“ (siehe <a href="#konfigurationsparameter_oa">Kapitel 3.2</a>: ) steht jedoch nicht zur Verfügung. Somit muss die Online-Applikation von einem Benutzer mit Admin-Rechten aktiv geschalten werden. </li> + <li><strong>Benutzerverwaltung:</strong> Ein Benutzer ohne Admin-Rechte kann keine neuen Benutzer erstellen. Dieser kann jedoch seinen Benutzeraccount bearbeiten und gegeben falls löschen. Beim Löschen eines Benutzeraccounts werden Online-Applikationen die von diesem erstellt wurden jedoch nicht automatisch gelöscht. </li> +</ul> +<h3><a name="basisconfig_moa_id_auth" id="uebersicht_zentraledatei_aktualisierung2"></a>2.2 MOA-ID-Auth</h3> + <p>Dieser Abschnitt behandelt die Basiskonfiguration des Modules MOA-ID-Auth. 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/moa-id.properties">hier</a>.</p> +<h4><a name="uebersicht_bekanntmachung" id="uebersicht_bekanntmachung"></a>2.2.1 Bekanntmachung der Konfigurationsdatei</h4> + <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>Windows: moa.id.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties +UNIX: moa.id.configuration=file:C:/Programme/apache/tomcat-8.x.x/conf/moa-id/moa-id.properties</pre> + <p>Weitere Informationen zum Bekanntmachen der zentralen Konfigurationsdatei für MOA-ID-Auth erhalten Sie in <a href="../install/install.html#webservice_basisinstallation_installation_spssdeploy">Abschnitt 2.1.2.3</a> des Installationshandbuchs.</p> + <h4><a name="basisconfig_moa_id_auth_param" id="uebersicht_bekanntmachung2"></a>2.2.2 Konfigurationsparameter</h4> + <p>Aus Gründen der Übersichtlichkeit werden die einzelnen Konfigurationsparameter in logisch zusammenhängende Blöcke unterteilt.</p> +<h5><a name="basisconfig_moa_id_auth_param_general" id="uebersicht_bekanntmachung4"></a>2.2.2.1 Allgemeine Konfigurationsparameter</h5> + <p>Die folgenden Konfigurationsparameter sind optional und müssen nicht zwingend angegeben werden. Im Falle eines produktiven Betriebs von MOA-ID-Auth wird jedoch die Angabe eines Schlüssels zur verschlüsselten Speicherung der Session Daten in der Datenbank dringend empfohlen. </p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>configuration.moasession.key</td> + <td>aX.J47s#bh7</td> + <td>Passwort zum Verschlüsseln von personenbezogenen Session Daten die während eines Anmeldevorgangs und für Single Sign-On in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.</td> + </tr> + <tr> + <td>configuration.moaconfig.key</td> + <td>ConfigurationEncryptionKey</td> + <td><p>Passwort zum Verschlüsseln von Konfigurationsteilen welche in der Datenbank abgelegt werden. Hierbei kann jede beliebige Zeichenfolge aus Buchstaben, Zahlen und Sonderzeichen verwendet werden.</p> + <p><strong>Hinweis:</strong> Dieses Passwort muss identisch zu dem im Modul <a href="#moa_id_config_parameters_generel">MOA-ID-Configuration</a> hinterlegten Passwort sein.</p></td> + </tr> + <tr> + <td>configuration.ssl.useStandardJavaTrustStore</td> + <td>true / false</td> + <td><p>Deaktiviert die MOA-ID spezifische SSL TrustStore Implementierung. Wird dieser Parameter auf <em>true</em> gesetzt, verwendet MOA-ID den TrustStore der Java VM.</p> + <p><strong>Defaultwert:</strong> false</p></td> + </tr> + <tr> + <td>configuration.ssl.validation.revocation.method.order</td> + <td>ocsp,crl</td> + <td><p>Definiert die Reihenfolge des Zertifikatsrevokierungschecks bei SSL Verbindungen. Die Defaultreihenfolge ist OCSP, CRL.</p> + <p><strong>Hinweis:</strong> Die Angabe erfolgt als CSV, wobei die Schlüsselwörter 'ocsp' und 'crl' lauten</p></td> + </tr> + <tr> + <td>configuration.ssl.validation.hostname</td> + <td>true / false</td> + <td><p>Hiermit kann die SSL Hostname validation für das abholen von PVP Metadaten deaktiviert werden. </p> + <p><strong>Hinweis: </strong>Workaround, da der httpClient der openSAML2 Implementierung kein SNI (Server Name Indication) unterstützt.</p></td> + </tr> + <tr> + <td>configuration.validate.authblock.targetfriendlyname</td> + <td>true / false</td> + <td>Hiermit kann die Überprüfung des 'TargetFriendlyName', welcher Teil des vom Benutzer signierten Authblock ist, deaktiviert werden. Eine Deaktivierung hat keinen Einfluss auf die Sicherheit des Authentifizierungsvorgangs mittels qualifizierter Signatur, jedoch kann der 'TargetFriendlyName im Authblock nicht als gesichert betrachtet werden.' Die Validierung ist deaktiviert wenn der Parameter auf <code>false</code> gesetzt wird.<br> + <strong>Hinweis:</strong> Hierbei handelt es sich um einen Workaround für Systeme auf denen die Validierung des 'TargetFriendlyName' wegen Problemen mit der Zeichencodierung fehlschlägt, die Signatur des AuthBlocks jedoch gültig ist.<br> + <strong>Defaultwert:</strong> true</td> + </tr> + <tr> + <td>configuration.bugfix.enable.idl.escaping</td> + <td>true / false</td> + <td><p>MOA-ID intern wurden einfache Anführungszeichen (') in Vornamen oder Nachnamen bis zur Version 4.3.2 durch &#39; escapted. Dieses Escaping hatte durch einen Fehler auch Einfluss auf die ausgelieferten Attributen in PVP2 S-Profil, OpenID-Connect, etc. . Dieser Fehler wurde in der Version 4.3.3 behoben.<br> + Aus Kompatibilitätsgründen kann das Escaping jedoch mittels Konfigurationsparameter wieder aktiviert werden. + </p> + <p><strong>Defaultwert:</strong> false</p></td> + </tr> + <tr> + <td>configuration.monitoring.active</td> + <td>true / false</td> + <td>Aktiviert das Modul für internes Monitoring / Testing.</td> + </tr> + <tr> + <td>configuration.monitoring.message.success</td> + <td>All Tests passed!</td> + <td>Statusmeldung wenn alle Tests erfolgreich ausgeführt wurden</td> + </tr> + <tr> + <td>configuration.monitoring.test.identitylink.url</td> + <td>monitoring/<br> + monitoring_idl.xml</td> + <td><p>Zur Überprüfung der gesamten Funktionalität von MOA-ID-Auth wird eine Personenbindung benötigt. Dieses Element definiert die URL auf eine Test Personenbindung welche für den Testablauf verwendet wird.</p> + <p><strong>Hinweis:</strong> Der Beispielkonfiguration ist eine Personenbindung beigelegt die für das Monitoring verwendet werden kann. Bei dieser Personenbindung handelt es sich jedoch um Keine durch die Stammzahlenregisterbehörde ausgestellte Personenbindung, wodurch nicht der gesamte Personenbindungsvalidierungsvorgang getestet werden kann.</p></td> + </tr> + <tr> + <td>configuration.advancedlogging.active</td> + <td>true / false</td> + <td>Aktiviert das erweiterte Logging zur Generierung von anonymisierten Statistikdaten aus den Anmeldeinformationen. Hierfür muss der entsprechende Datenbankzugriff (siehe <a href="#basisconfig_moa_id_auth_param_database">Kapitel 2.2.2.4</a>) ebenfalls konfiguriert werden.</td> + </tr> +</table> +<p> </p> +<p>Wenn das interne Monitoring aktiviert wurde kann ein Testvorgang durch einen Aufruf der folgenden Adresse gestartet werden.</p> +<pre>http://<host>:<port>/moa-id-auth/MonitoringServlet</pre> +<p>bzw. </p> +<pre> +https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> +<p>Nach einem erfolgreichen Testdurchlauf Antwortet das Monitoring 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> +<h5><a name="basisconfig_moa_id_auth_param_services" id="uebersicht_bekanntmachung5"></a>2.2.2.2 Anbindung an das E-ID System</h5> +<p>Die Anbindung und Weiterleitung an das zentrale E-ID System erfolgt via PVP2 S-Profil (SAML2). Für das in MOA-ID 4.x integrierte E-ID Proxy Authentifizierungsmodul sind folgende Konfigurationsparameter erforderlich.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>modules.eidproxyauth.keystore.path</td> + <td>keys/szrgw.p12</td> + <td>Dateiname des Java Keystore oder PKCS12 Keystore zur Signierung von PVP 2.x spezifischen Inhalten. (PVP 2.x Metadaten, PVP 2.1 Assertion)</td> + </tr> + <tr> + <td>modules.eidproxyauth.keystore.password</td> + <td>pass1234</td> + <td>Passwort zum Keystore</td> + </tr> + <tr> + <td>modules.eidproxyauth.metadata.sign.alias</td> + <td> </td> + <td>Name des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls</td> + </tr> + <tr> + <td>modules.eidproxyauth.metadata.sign.password</td> + <td> </td> + <td>Passwort des Schlüssels der zur Signierung der PVP 2.x Metadaten des E-ID Proxy Authentifizierungsmoduls</td> + </tr> + <tr> + <td>modules.eidproxyauth.request.sign.alias</td> + <td> </td> + <td>Name des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird</td> + </tr> + <tr> + <td>modules.eidproxyauth.request.sign.password</td> + <td> </td> + <td>Passwort des Schlüssels mit dem der PVP 2.x Authn. Request durch MOA-ID unterschieben wird</td> + </tr> + <tr> + <td>modules.eidproxyauth.response.encryption.alias</td> + <td> </td> + <td>Name des Schlüssels mit dem die PVP 2.x Assertion für MOA-ID verschlüsselt werden soll</td> + </tr> + <tr> + <td>modules.eidproxyauth.response.encryption.password</td> + <td> </td> + <td>Passwort des Schlüssels mit dem PVP 2.x Assertion für MOA-ID verschlüsselt werden soll</td> + </tr> + <tr> + <td>modules.eidproxyauth.EID.trustprofileID</td> + <td>eid_metadata</td> + <td>MOA-SP TrustProfil welches die vertrauenswürdigen Zertifikate zur Validierung der Metadaten des zentralen E-ID Systemas beinhaltet</td> + </tr> + <tr> + <td>modules.eidproxyauth.EID.entityId</td> + <td> </td> + <td><strong>Optional</strong>: EntityID des IDPs im zentralen E-ID System</td> + </tr> + <tr> + <td>modules.eidproxyauth.EID.metadataUrl</td> + <td> </td> + <td><strong>Optional:</strong> URL auf die SAML2 Metadaten des zentralen E-ID System, sofern diese nicht über die EntityID geladen werden können</td> + </tr> + <tr> + <td>modules.eidproxyauth.required.additional.attributes.x</td> + <td> </td> + <td><p><strong>Optional:</strong> zusätzliche Attribute welche vom zentralen E-ID System angefordert werden</p> + <p>Attribute werden entspechend PVP2 Attribute-Profil angegeben. Beispiele für die Konfiguration finden Sie in der Beispielkonfiguration</p></td> + </tr> +</table> +<p> </p> +<h5><a name="basisconfig_moa_id_auth_param_protocol" id="uebersicht_bekanntmachung9"></a>2.2.2.3 Protokolle</h5> +<p>MOA-ID 4.x unterstützt nur mehr SAML1 als Authentifizierungsprotokoll. </p> +<p> </p> +<h5><a name="basisconfig_moa_id_auth_param_database" id="uebersicht_bekanntmachung3"></a>2.2.2.4 Datenbank </h5> +<p>Das Modul MOA-ID-Auth benötigt für den Betrieb zwei (optional drei) separate 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> +<p> </p> +<h6><a name="basisconfig_moa_id_auth_param_database_conf" id="uebersicht_bekanntmachung12"></a>2.2.2.4.1 Konfiguration</h6> +<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 class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>configuration.hibernate.dialect</td> + <td><p>org.hibernate.dialect.MySQLDialect</p></td> + <td>Sprachtyp der verwenden Datenbank</td> + </tr> + <tr> + <td>configuration.hibernate.connection.url</td> + <td>jdbc:mysql://localhost/moa-id-config?charSet=utf-8&autoReconnect=true</td> + <td>URL unter dem das Datenbank Schema mit der Konfiguration von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter <em>charSet=utf-8</em> als Zeichencodierung und <em>autoReconnect=true</em> für automatischen Verbindungsaufbau wird empfohlen</td> + </tr> + <tr> + <td><p>configuration.hibernate.connection.driver_class</p></td> + <td>com.mysql.jdbc.Driver</td> + <td>Typ der verwendeten Datenbank</td> + </tr> + <tr> + <td><p>configuration.hibernate.connection.username</p></td> + <td>moaconfig</td> + <td>Benutzername für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td>configuration.hibernate.connection.password</td> + <td>moaconfigpassword</td> + <td>Passwort für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td><p>configuration.dbcp.validationQuery</p></td> + <td>SELECT 1</td> + <td><p>SQL Query zum Validieren der Datenbank Verbindung</p> + <p><strong>mySQL:</strong> SELECT 1</p> + <p><strong>Oracle:</strong> select 1 from dual</p></td> + </tr> +</table> +<p> </p> +<p><strong>Hinweis:</strong> Defaultmäßig werden Konfigurationswerte textuell in der Datenbank abgelegt. Sollte es mit dem verwendeten Datenbank-Backend Probleme mit rein textueller Representation von Konfigurationswerten geben kann alternativ eine generische Datenrepresentation verwendet werden. Zur Aktivierung dieser generischen Datenrepresentation muss das Spring Profile <code>byteBasedConfig</code> siehe <a href="../install/install.html#webservice_basisinstallation_installation_spssdeploy">Kapitel Installation</a> als System-Property gesetzt werden (z.B. -Dspring.profiles.active=byteBasedConfig).</p> + <h6><a name="basisconfig_moa_id_auth_param_database_session" id="uebersicht_bekanntmachung13"></a>2.2.2.4.2 Session Informationen</h6> + <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 class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>moasession.hibernate.dialect</td> + <td><p>org.hibernate.dialect.MySQLDialect</p></td> + <td>Sprachtyp der verwenden Datenbank</td> + </tr> + <tr> + <td>moasession.hibernate.connection.url</td> + <td>jdbc:mysql://localhost/moa-id-session?charSet=utf-8&autoReconnect=true</td> + <td>URL unter dem das Datenbank Schema mit den Session Information von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter <em>charSet=utf-8</em> als Zeichencodierung und <em>autoReconnect=true</em> für automatischen Verbindungsaufbau wird empfohlen</td> + </tr> + <tr> + <td><p>moasession.hibernate.connection.driver_class</p></td> + <td>com.mysql.jdbc.Driver</td> + <td>Typ der verwendeten Datenbank</td> + </tr> + <tr> + <td><p>moasession.hibernate.connection.username</p></td> + <td>moaconfig</td> + <td>Benutzername für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td><p>moasession.hibernate.connection.password</p></td> + <td>moaconfigpassword</td> + <td>Passwort für den Zugriff auf das Datenbank Schema</td> + </tr> +</table> +<p> </p> +<p><strong>Hinweis:</strong> Zusätzlich zum SQL based Datenbank Backend für Sessiondaten gibt es aber der Version 3.2.0 die Möglichkeit einen Redis Datenserver als Datenbank Backend für Kurzzeitsessiondaten zu verwenden. Wird dieser aktiviert werden nur mehr Single Sign-On Sessioninformationen in der Sessiondatenbank abgelegt. Alle anderen Prozessdaten werden ausschließlich über das Redis Backend abgewickelt.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>redis.active</td> + <td><p>true / false</p></td> + <td>Aktiviert das Redis Backend für Kurzzeitsessiondaten</td> + </tr> + <tr> + <td>redis.use-pool</td> + <td>true / false</td> + <td>Aktiviert / Deaktiviert den Connectionpool für Redis</td> + </tr> + <tr> + <td><p>redis.host-name</p></td> + <td>localhost</td> + <td>URL unter der der Redis Server erreichbar ist</td> + </tr> + <tr> + <td><p>redis.port</p></td> + <td>6379</td> + <td>Port unter dem der Redis Server erreichbar ist</td> + </tr> +</table> +<p> </p> +<p> </p> +<h6><a name="basisconfig_moa_id_auth_param_database_info" id="uebersicht_bekanntmachung14"></a>2.2.2.4.3 Statistikdaten</h6> +<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 class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>advancedlogging.hibernate.dialect</td> + <td><p>org.hibernate.dialect.MySQLDialect</p></td> + <td>Sprachtyp der verwenden Datenbank</td> + </tr> + <tr> + <td>advancedlogging.hibernate.connection.url</td> + <td>jdbc:mysql://localhost/moa-id-statistic?charSet=utf-8&autoReconnect=true</td> + <td>URL unter dem das Datenbank Schema für die Statistikfunktion von MOA-ID-Auth abgelegt werden soll. Die Verwendung der Parameter <em>charSet=utf-8</em> als Zeichencodierung und <em>autoReconnect=true</em> für automatischen Verbindungsaufbau wird empfohlen</td> + </tr> + <tr> + <td><p>advancedlogging.hibernate.connection.driver_class</p></td> + <td>com.mysql.jdbc.Driver</td> + <td>Typ der verwendeten Datenbank</td> + </tr> + <tr> + <td><p>advancedlogging.hibernate.connection.username</p></td> + <td>moaconfig</td> + <td>Benutzername für den Zugriff auf das Datenbank Schema</td> + </tr> + <tr> + <td><p>advancedlogging.hibernate.connection.password</p></td> + <td>moaconfigpassword</td> + <td>Passwort für den Zugriff auf das Datenbank Schema</td> + </tr> +</table> +<p> </p> + <p>Die Beispielkonfiguration beinhaltet noch zusätzliche Konfigurationsparameter für den Datenbankzugriff der einzelnen Schema 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> +<h5><a name="basisconfig_moa_id_auth_param_testing" id="uebersicht_bekanntmachung15"></a>2.2.2.5 Testing</h5> + <p>Diese Parameter dienen auf Testsystemen zur Deaktivierung einzelner Verarbeitungs- oder Prüfschritte. Standardmäßig ist jeweils die sichere Variante aktiviert.</p> + <table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>configuration.validation.certificate.QC.ignore</td> + <td><p>true / false</p></td> + <td><p>Deaktiviert die QC Prüfung von Signaturzertifikaten. Da manche Testzertifikate oder Testkarten keine QC Erweiterung aufweisen und somit eine Anmeldung mit diesen Zertifikaten nicht möglich ist, kann die QC Prüfung je Instanz deaktiviert werden.</p> + <p><strong>Defaultwert:</strong> false</p></td> + </tr> + <tr> + <td>protocols.pvp2.schemavalidation</td> + <td>true / false</td> + <td><p>Mit diesem Parameter kann die Schemavalidierung für PVP Metadaten deaktiviert werden.</p> + <strong>Defaultwert:</strong> true</td> + </tr> + <tr> + <td>protocols.pvp2.assertion.encryption.active</td> + <td>true / false</td> + <td><p>Mit diesem Parameter kann die Verschlüsselung der PVP2.1 Assertion für diese MOA-ID-Auth Instanz vollständig deaktiviert werden.</p> + <p><strong>Defaultwert:</strong> true</p></td> + </tr> + </table> + <p><strong>Hinweis:</strong> Detaillierte Informationen zu den einzelnen PVP spezifischen Konfigurationsparametern finden Sie in der entsprechenden PVP Spezifikation. </p> +<p> </p> + <h3><a name="uebersicht_logging" id="uebersicht_logging"></a>2.3 Konfiguration des Loggings</h3> + <p>Die Module MOA-ID-Auth und MOA-ID-Configuration verwendet als Framework für Logging-Information die Open Source Software <code>log4j</code>. Die Konfiguration der Logging-Information erfolgt nicht direkt durch die einzelnen Module, sondern über eine eigene Konfigurationsdatei, die der <span class="term">Java Virtual Machine</span> durch eine <span class="term">System Property </span> mitgeteilt wird. Der Name der <span class="term">System Property </span> lautet <code>log4j.configuration</code>; als Wert der <span class="term">System Property </span> ist eine URL anzugeben, die auf die <code>log4j</code>-Konfigurationsdatei verweist, z.B. </p> +<pre>log4j.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/log4j.properties</pre> + <p>Zustätzlich wird für einige Basiskomponenten, welche über Drittherstellerbibliotheken inkludiert sind, LogBack als Logging Framework verwendet. Die LogBack Konfiguration wird ebenfalls über den System Property angegeben</p> + <pre>logback.configuration=file:/C:/Programme/apache/tomcat-8.x.x/conf/moa-id/logback_config.xml</pre> + <p>Mit Hilfe von Konverertern kann eine bestehende log4j Konfiguration in das LogBack Format umgewandelt werden. Hierfür stehen divererse Tools Online zur Verfügung. (z.B. <a href="http://logback.qos.ch/translator/">http://logback.qos.ch/translator/</a>)</p> + <p> </p> + <p>Weitere Informationen zur Konfiguration des Loggings erhalten Sie in <a href="../install/install.html#webservice_basisinstallation_logging">Abschnitt 2.1.3</a> des Installationshandbuchs. + </p> + <p></p> +<h3><a name="uebersicht_samlengine" id="uebersicht_samlengine"></a>3 Konfiguration MOA-ID-Auth</h3> +<p>Dieser Abschnitt beschreibt die Konfiguration des Modules MOA-ID-Auth mithilfe der durch das Modul MOA-ID-Configuration zur Verfügung gestellten Web-Oberfläche. Hierzu muss das Konfigurationstool (Module MOA-ID-Konfiguration) bereits installiert und konfiguriert sein (siehe <a href="#uebersicht_zentraledatei_aktualisierung">Kapitel 2.1</a>). Nach erfolgreichem Login am Konfigurationstool kann das Modul MOA-ID-Auth über die Web-Oberfläche konfiguriert werden.</p> + <p>Die Konfiguration von MOA-ID-Auth ist in zwei Teilbereiche unterteilet. Diese behandeln die Allgemeine Konfiguration der MOA-ID-Auth Instanz und die Konfiguration von Online-Applikationen (Service Providern) welche dieser MOA-ID-Auth Instanz zugeordnet sind.</p> +<h3><a name="konfigurationsparameter_allgemein" id="konfigurationsparameter_allgemein"></a>3.1 + Allgemeine Konfiguration</h3> +<p>Die Allgemeine Konfiguration des Modules MOA-ID-Auth umfasst alle nicht online-applikationsspezifischen Konfigurationsparameter. Die Konfiguration dieser Parameter erfolgt über eine Web-Oberfläche, welche Eingabefelder für jeden Konfigurationsparameter zur Verfügung stellt. Jedes Eingabefeld wird validiert bevor der Konfigurationsparameter in der Datenbank gespeichert wird. Die Validierung erfolgt auf Basis des zu erwartenden Eingabewerts, wobei der erlaubte Zeichensatz für freidefinierbare textuelle Eingabefelder eingeschränkt sein kann. Detailinformationen zum erlaubten Zeichen finden Sie bei der jeweiligen Beschreibung des Konfigurationsparameters. </p> +<p>Nachfolgend finden Sie die Detailbeschreibung aller allgemeinen Konfigurationsparameter.</p> +<h4><a name="konfigurationsparameter_allgemein_publicurlprefix" id="konfigurationsparameter_allgemein_bku17"></a>3.1.1 Public URL Prefix</h4> +<p>Dieser Parameter definiert den Public URL Prefix unter welchem die MOA-ID Instanz erreichbar ist. Die Konfiguration dieses Parameters ist verpflichtend.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwerte</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>Public URL Prefix</td> + <td>https://demo.egiz.gv.at/moa-id-auth/</td> + <td><p>URL-Prefix der MOA-ID Instanz. Diese URL wird für die automatische Generierung von Formularen und Informationen verwendet und MUSS konfiguriert werden.</p> + <p><strong>Hinweis:</strong> Wenn virtuelle IDPs aktiviert sind muss hier für jede virtuelle MOA-ID Instanz, der Public URL Prefix als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen Public URL Prefix durch Beistrich (',') getrennt.<br> + (z.B.: https://demo.egiz.gv.at/moa-id-auth/,https://apps.egiz.gv.at/moa-id-auth/)</p></td> + </tr> + <tr> + <td>Virtuelle IDPs aktiviere</td> + <td> </td> + <td><p>Mit dieser Option können für diese MOA-ID Instanz mehrere virtuelle MOA-ID Instanzen, welche unter schiedenen Domains erreichbar sind aktiviert werden. Der Public URL-Prefix jeder virtuellen MOA-ID Instanz muss als Comma Separatet Value (CSV) im Konfigurationsfeld 'Public URL Prefix' angegeben werden.</p> + <p><strong>Hinweis:</strong> Bei Verwendung von virtuellen IDPs werden für jeden virtuellen IDP SAML2 Metadaten mit unterschiedlichen EntityIDs entsprechend dem virtuellen IDP erstellt. Somit muss jeder virtuelle IDP als MOA-ID E-ID Proxy am zentralen Applikationsregister hinterlegt sein.</p></td> + </tr> +</table> +<p> </p> +<h4><a name="konfigurationsparameter_allgemein_certvalidation" id="konfigurationsparameter_allgemein_bku3"></a>3.1.2 Zertifikatsprüfung</h4> +<p>Dieser Bereich behandelt die allgemeine Einstellungen zur Zertifikatsprüfung und die Konfiguration von vertrauenswürdigen Zertifikaten.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td><p>TrustManagerRevocation</p> + Checking</td> + <td> </td> + <td>Für die TLS-Server-Authentisierung dürfen nur Server-Zertifikate verwendet werden, die eine CRLDP-Extension enthalten (andernfalls kann von MOA-ID-Auth keine CRL-überprüfung durchgeführt werden). Soll das RevocationChecking generell ausgeschaltet werden, ist dieses Attribut anzugeben und auf "false" zu setzen</td> + </tr> + <tr> + <td><p>TrustedCACertificates</p></td> + <td>certs/ca-certs</td> + <td>TrustedCACertificates enthält das Verzeichnis (relativ zur MOA-ID-Auth Basiskonfigurationsdatei), das jene Zertifikate enthält, die als vertrauenswürdig betrachtet werden. Im Zuge der Überprüfung der TLS-Serverzertifikate wird die Zertifikatspfaderstellung an einem dieser Zertifikate beendet. Dieses Verzeichnis wird zur Prüfung der SSL Serverzertifikate für den Zugriff auf das Online-Vollmachten Service, den Stammzahlenregister Gateway und das Abholen von PVP 2.1 Metadaten via SSL verwendet.</td> + </tr> +</table> +<h4><a name="konfigurationsparameter_allgemein_timeouts" id="konfigurationsparameter_allgemein_bku4"></a>3.1.3 Session TimeOuts</h4> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert [sec]</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>Transaktion</td> + <td>300</td> + <td><p>Gibt die Zeitspanne in Sekunden an, für die Anmeldedaten, temporäre Sessiondaten oder Assertions in der Authentisierungskomponente (MOA-ID-Auth) vorrätig gehalten werden. Nach Ablauf dieser Zeitspanne werden diese Daten gelöscht oder der Anmeldevorgang abgebrochen. Dieser Parameter hat Einfluss auf folgende Funktionen:</p> + <ul> + <li>maximale Zeitspanne eines Anmeldevorgangs vom Authentification Request bis zur Authentification Response gerechnet.</li> + <li>maximale Zeitspanne welche einer Online-Applikation zum Abholen der Anmeldedaten zur Verfügung steht. (SAML mit Artifact Binding und OpenID Connect)</li> + <li>maximale Zeitspanne zum Abholen zusätzlicher STORK2 Attribute (Zeitdauer je Attribut)</li> + </ul> </td> + </tr> +</table> +<h4><a name="konfigurationsparameter_allgemein_moasp" id="konfigurationsparameter_allgemein_bku5"></a>3.1.4 MOA-SP</h4> +<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 SAML2 Metadaten des zentralen E-ID System benötigt. MOA-SP muss entsprechend konfiguriert werden - siehe hierzu Abschnitt <a href="#sp-config"> Konfiguration von MOA-SP</a>. Alle Details zur Konfiguration von MOA-SP finden sie in der Distribution von MOA-SP/SS beiliegenden Dokumentation im Abschnitt 'Konfiguration'. </p> +<h4><a name="konfigurationsparameter_allgemein_services" id="konfigurationsparameter_allgemein_bku6"></a>3.1.5 Externe Services</h4> +<p>Hiermit werden die URLs zum zentralen E-ID System konfiguriert.</p> +<table class="configtable"> + <tr> + <th width="10%">Name</th> + <th width="23%">Beispielwert</th> + <th width="67%">Beschreibung</th> + </tr> + <tr> + <td>zentrales E-ID System (CSV)</td> + <td>https://eid.egiz.gv.at/idp/shibboleth</td> + <td><p>URL(s) zu den SAML2 Metadaten des zentralen E-ID Systems</p> + <ul> + <li>Produktivsystem: </li> + <li>Testsystem: <a href="https://vollmachten.egiz.gv.at/mis-test/MandateIssueRequest">https://eid.egiz.gv.at/idp/shibboleth</a></li> + </ul> + <p><strong>Hinweis:</strong> Die URLs auf die unterschiedlichen Instanzen des zentralen E-ID Systems können auch als Comma Separatet Value (CSV) eingetragen werden. Bei CSV werden die einzelnen URLs durch Beistrich (',') getrennt. Sind mehrere URLs hinterlegt kann das zu verwendeten Service je Online Applikation konfiguriert werden (siehe <a href="#konfigurationsparameter_oa_mandates">Kapitel 3.2.4</a>).<br> + (z.B.: <a href="https://vollmachten.egiz.gv.at/mis-test/MandateIssueRequest">https://eid.egiz.gv.at/idp/shibboleth</a><a href="https://vollmachten.stammzahlenregister.gv.at/mis/MandateIssueRequest"></a>,<a href="https://vollmachten.egiz.gv.at/mis-test/MandateIssueRequest">https://eid.gv.at/idp/shibboleth</a>)</p> + <p><strong>Hinweis:</strong> Erfolgt in der Online Applikation keine konkrete Auswahl wird Standardmäßig <strong>das erste eingetragen Service</strong> verwendet.</p></td> + </tr> +</table> +<h4><a name="konfigurationsparameter_allgemein_protocol" id="konfigurationsparameter_allgemein_bku9"></a>3.1.6 Protokolle</h4> +<p>Hierbei handelt es ich um allgemeine Einstellungen zu den vom Modul MOA-ID-Auth unterstützen Authentifizierungsprotokollen.</p> +<h5><a name="konfigurationsparameter_allgemein_protocol_allowed" id="konfigurationsparameter_allgemein_bku10"></a>3.1.6.1 Protokolle aktivieren</h5> +<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> +<h5><a name="konfigurationsparameter_allgemein_protocol_saml1" id="konfigurationsparameter_allgemein_bku12"></a>3.1.6.2 SAML1 Konfiguration</h5> +<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 kann jedoch eine SourceID für die gesamte MOA-ID-Auth Instanz vergeben werden, welche für alle Online-Applikationen verwendet wird.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwerte</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>SourceID</td> + <td>MOA_Instanz_A</td> + <td>SourceID zu Generierung des SAML1 Artifacts wenn hierfür nicht die OA URL verwendet werden soll.</td> + </tr> +</table> +<p> </p> +<h5><a name="konfigurationsparameter_allgemein_protocol_pvp21" id="konfigurationsparameter_allgemein_bku13"></a>3.1.6.3 PVP 2.x Konfiguration</h5> +<p>Die allgemeinen Konfigurationsparameter für das Authentifizierungsprotokoll PVP 2.x behandeln Informationen zum Betreiber der MOA-ID-Auth Instanz und zu einer Ansprechperson für diese Instanz. Diese Parameter werden in den PVP 2.x Metadaten, welche dem zentralen E-ID System bereitgestellt werden, eingetragen.</p> +<h6><a name="konfigurationsparameter_allgemein_protocol_pvp21_org" id="konfigurationsparameter_allgemein_bku15"></a>3.1.6.3.1 Betreiberorganisation</h6> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </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> + </tr> + <tr> + <td><p>Kurzbezeichnung - Organisation</p></td> + <td>EGIZ</td> + <td>Kurzbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element <em>md:Organization</em>/<em>md:OrganizationName</em> angezeigt.</td> + </tr> + <tr> + <td>Vollständiger Name - Organisation</td> + <td>eGovernment Innovationszentrum</td> + <td>Vollbezeichnung der Organisation welche die MOA-ID-Auth Instanz betreibt. Dieser Parameter wird in den Metadaten im Element <em>md:Organization</em>/<em>md:OrganizationDisplayName</em> angezeigt.</td> + </tr> + <tr> + <td>URL der Organisation - Organisation</td> + <td>http://www.egiz.gv.at</td> + <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> +<h6><a name="konfigurationsparameter_allgemein_protocol_pvp21_contact" id="konfigurationsparameter_allgemein_bku16"></a>3.1.6.3.2 Kontaktperson</h6> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>Familienname</td> + <td>Mustermann</td> + <td>Familienname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element <em>md:ContactPerson</em>/<em>md:GivenName</em> angezeigt.</td> + </tr> + <tr> + <td><p>Vorname</p></td> + <td>Max</td> + <td>Vorname der Kontaktperson. Dieser Parameter wird in den Metadaten im Element <em>md:ContactPerson</em>/<em>md:SurName</em> angezeigt.</td> + </tr> + <tr> + <td><p>Mailadresse</p></td> + <td>max.mustermann@egiz.gv.at</td> + <td>eMail Adresse der Kontaktperson. Dieser Parameter wird in den Metadaten im Element <em>md:ContactPerson</em>/<em>md:GivenName</em> angezeigt.</td> + </tr> + <tr> + <td>Telefonnummer</td> + <td>+43012425478521</td> + <td>Telefonnummer der Kontaktperson. Dieser Parameter wird in den Metadaten im Element <em>md:ContactPerson</em>/<em>md:GivenName</em> angezeigt.</td> + </tr> + <tr> + <td>Unternehmen</td> + <td>EGIZ</td> + <td>Unternehmen für welches die Kontaktperson tätig ist. Dieser Parameter wird in den Metadaten im Element <em>md:ContactPerson</em>/<em>md:Company</em> angezeigt.</td> + </tr> + <tr> + <td>Type des Kontakts</td> + <td>technical</td> + <td><p>Type der Kontaktperson. Hierfür stehen folgende Typen zur Auswahl:</p> + <ul> + <li>technical</li> + <li>support</li> + <li>administrative</li> + <li>billing</li> + <li>other</li> + </ul> + <p>Dieser Name wird in den Metadaten im Element <em>md:ContactPerson</em>als Attribut <em>contactType</em> angezeigt.</p></td> + </tr> +</table> +<h4> </h4> + +<!-- <h4><a name="general_revision" id="konfigurationsparameter_allgemein_bku18"></a>3.1.12 Revisionssicherheit</h4> +<p>Ab MOA-ID 3.x steht ein erweitertes speziell für Revisionsaufgaben abgestimmtest Logging zur Verfügung. Über dieses Feld können die zu loggenden Events als CSV codierte Eventcodes konfiguriert werden. Werden keine Eventcodes konfiguriert wird eine in MOA-ID hinterlegte Defaultkonfiguration verwendet. Eine Liste aller möglichen Eventcodes finden Sie <a href="../additional/additional.html#revisionslog">hier</a>.</p> --> + +<h3><a name="konfigurationsparameter_oa" id="uebersicht_zentraledatei_aktualisierung3"></a>3.2 Online Applikationen</h3> +<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> +<h4><a name="konfigurationsparameter_oa_general" id="uebersicht_zentraledatei_aktualisierung17"></a>3.2.1 Informationen zur Online-Applikation (Service Provider)</h4> +<p>Dieser erste Abschnitt behandelt allgemeine Parameter zur Online-Applikation.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Admin</th> + <th>Optional</th> + <th>Beschreibung</th> + </tr> + <tr> + <td>Online-Applikation ist aktiviert</td> + <td> </td> + <td align="center">X</td> + <td align="center"> </td> + <td>Aktiviert oder deaktiviert die Online-Applikation. Eine Authentifizierung ist nur an aktiven Online-Applikationen möglich. Ein Anmeldeversuch an einer nicht aktiven Online-Applikation wird durch MOA-ID-Auth durch den Fehlercode <em>auth.00</em> und der Fehlerbeschreibung <em>Anmeldung an dieser Applikation wird nicht unterstützt</em> verweigert.</td> + </tr> + <tr> + <td><p>Eindeutiger Identifikatior</p></td> + <td>https://demo.egiz.gv.at/demologin/</td> + <td align="center"> </td> + <td align="center"> </td> + <td>Dieser Parameter dient als Schlüssel zum Auffinden der Konfigurationsparameter zur Online-Applikation. Hierfür ist ein eindeutiger Identifikator für die Online-Applikation erforderlich. Dieser eindeutige Identifikator muss mindestens dem URL-Präfix der nach außen sichtbaren Domäne der Online-Applikation entsprechen.</td> + </tr> + <tr> + <td><p>Name der <br> + Online-Applikation</p></td> + <td>Demo Applikation A</td> + <td align="center"> </td> + <td align="center"> </td> + <td>Hier muss ein benutzerfreundlicher Name für die Online-Applikation angegeben werden. Dieser Name scheint während der Authentifizierung des Benutzers oder am Online-Vollmachten Service bei der Vollmachten Auswahl auf.</td> + </tr> + <tr> + <td>Privatwirtschaftliche Applikation</td> + <td> </td> + <td align="center"> </td> + <td align="center"> </td> + <td>Definiert ob die Online-Applikation dem öffentlichen Bereich oder dem privatwirtschaftlichen Bereich (Business Service) zugeordnet ist. Ja nach Bereich sind unterschiedliche Konfigurationsparameter erforderlich.</td> + </tr> +</table> +<h5><a name="konfigurationsparameter_oa_general_public" id="uebersicht_zentraledatei_aktualisierung18"></a>3.2.1.1 Öffentlicher Bereich</h5> +<p>Wurde die Online-Applikation einem öffentlichen Bereich zugeordnet muss in weiterer Folge der zugeordnete Bereich definiert werden. Hierfür stehen folgende Parameter zur Verfügung.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Admin</th> + <th>Optional</th> + <th>Beschreibung</th> + </tr> + <tr> + <td><span id="wwlbl_loadOA_generalOA_target">Bereich (Target)</span></td> + <td>BF</td> + <td align="center"> </td> + <td align="center"> </td> + <td>Definiert den öffentlichen Bereich dem die Online-Applikation zugeordnet ist.</td> + </tr> + <tr> + <td><p><span id="wwlbl_OAisTargetSubSector">Target verfeinern</span></p></td> + <td> </td> + <td align="center"> </td> + <td align="center">X</td> + <td>Der angegebene öffentliche Bereich kann mit Hilfe eines Sub-Bereich verfeinert werden. Wird ein Sub-Bereich konfiguriert wird dieser an das Kürzel des öffentlichen Bereichs angehängt.</td> + </tr> + <tr> + <td><p><span id="wwlbl_adminTarget">Anderen Bereich frei definieren</span></p></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Diese Option erlaubt die freie Definition eines öffentlichen Bereichs. Soll ein freier Bereich für die Online-Applikation verwendet werden muss sowohl das Bereichskürzel als auch ein Name für den Bereich angegeben werden.</td> + </tr> +</table> +<p> </p> +<p><strong>Hinweis:</strong> Wird die Online-Applikation durch eine Benutzerin oder einem Benutzer ohne die Role <em>admin</em> angelegt, wird vor der Speicherung überprüft ob die Online-Applikation alle Anforderungen an eine öffentliche Applikation erfüllt. Die Überprüfung erfolgt auf Basis des eindeutigen Identifikators (Public-URL PRefix) der Online-Applikation und es muss mindestens eine der folgenden Anforderungen erfüllt sein. </p> +<ul> + <li>Die öffentliche URL unter der die Online-Applikation erreichbar ist (Public-URL Prefix) muss einen <em>*.gv.at</em> Domain aufweisen. (Beispiel: https://demo.egiz.gv.at/moa-id-oa)</li> + <li>Der SSL Serverzertifikat der Online-Applikation weist eine der folgenden Eigenschaften auf. + <ul> + <li>Veraltungseigenschaft (OID=1.2.40.0.10.1.1.1)</li> + <li>Dienstleistereigenschaft (OID=1.2.40.0.10.1.1.2)</li> + </ul> + </li> +</ul> +<h5><a name="konfigurationsparameter_oa_general_business" id="uebersicht_zentraledatei_aktualisierung19"></a>3.2.1.2 Privatwirtschaftlicher Bereich</h5> +<p>Wurde die Online-Applikation einem privatwirtschaftlichen Bereich zugeordnet muss in weiterer Folge die Stammzahl des privatwirtschaftlichen Unternehmens angegeben werden. Die Stammzahl des öffentlichen Bereichs muss mit dem entsprechenden Prefix des Bereichs angegeben werden, wobei der Prefix aus einer vorgegebenen Liste gewählt werden muss. </p> +<ul> + <li>FN: Die Stammzahl ist eine Firmenbuchnummer. (Beispiel: <em>FN468924i</em>)</li> + <li>ZVR: Die Stammzahl ist eine Vereinsnummer. (Beispiel: ZVR124572)</li> + <li>ERSB: Die Stammzahl ist einer Kennzahl aus dem Ergänzungsregister für sonstige Betroffene (ERsB) (Beispiel: ERSB1425367879)</li> + <li>STORK: Ländercode dem der Service Provider zugeordnet werden kann. Wird für die Ableitung des STORK-eIdentifiers verwendet.</li> +</ul> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwerte</th> + <th>Admin</th> + <th>Optional</th> + <th>Beschreibung</th> + </tr> + <tr> + <td><span id="wwlbl_loadOA_generalOA_identificationType">Identifikationsnummer</span></td> + <td><p><em>FN 468924i<br> + ZVR 124572<br> + STORK SI + </em></p></td> + <td align="center"> </td> + <td align="center"> </td> + <td>Stammzahl eines privatwirtschaftlichen Unternehmens oder Ländercode des STORK Service-Providers bei Verwendung des Modules MOA-ID als <a href="./../interfederation/interfederation.html#vidp">STORK VIDP</a>. Die Angabe erfolgt durch den Prefix des Bereichs aus dem die Stammzahl stammt und der eigentlichen Stammzahl oder des Ländercodes im Falle von STORK.</td> + </tr> +</table> + +<p> </p> +<h4><a name="konfigurationsparameter_oa_eID_demo" id="uebersicht_zentraledatei_aktualisierung32"></a>3.2.2 Neue Attribute des E-ID Systems</h4> +<p>Dieser Abschnitt behandelt die Änderungen am Attributset zur Person des neuen E-ID Systems. Ist der E-ID Modus aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird. Als Attributbezeichner in der nachfolgenden Liste werden die Attributebezeichnungen aus dem PVP Attribute-Profil verwendet. Ein Mapping auf OpenID-Connect Scopes oder SAML1 Attribute finden Sie in Kapitel <a href="../protocol/protocol.html#allgemeines_attribute">Protokolle</a>. </p> +<p>Folgende Attribute stehen nicht mehr zur Verfügung:</p> +<ul> + <li>EID-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.36)</li> + <li>EID-SOURCE-PIN-TYPE (1.2.40.0.10.2.1.1.261.104)</li> + <li>EID-IDENTITY-LINK (urn:oid:1.2.40.0.10.2.1.1.261.38)</li> + <li>EID-AUTH-BLOCK (urn:oid:1.2.40.0.10.2.1.1.261.62)</li> + <li>MANDATOR-NATURAL-PERSON-SOURCE-PIN (urn:oid:1.2.40.0.10.2.1.1.261.70)</li> + <li>MANDATOR-NATURAL-PERSON-SOURCE-PIN-TYPE (urn:oid:1.2.40.0.10.2.1.1.261.102)</li> + <li>MANDATE-FULL-MANDATE (urn:oid:1.2.40.0.10.2.1.1.261.92)</li> +</ul> +<p>Folgende neuen Attribute stehen zur Verfügung:</p> +<ul> + <li>ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.22)</li> + <li>BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.28) <em>(Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)</em></li> + <li>MANDATOR-NATURAL-PERSON-ENC-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.72)</li> + <li>MANDATOR-NATURAL-PERSON-BPK-LIST (urn:oid:1.2.40.0.10.2.1.1.261.73) <em>(Dieses Attribute ist im aktuellen PVP Attribut-Profil 2.1.3 noch nicht enthalten. Eine Aufnahme ist jedoch in Vorbereitung)</em></li> +</ul> +<p> </p> +<table class="configtable"> + <tr> + <th width="15%">Name</th> + <th width="15%">Beispielwerte</th> + <th width="8%">Admin</th> + <th width="12%">Optional</th> + <th width="50%">Beschreibung</th> + </tr> + <tr> + <td><span id="wwlbl_loadOA_targetConfig_eidDemoActive">E-ID Attribute ausliefern</span></td> + <td><p> </p></td> + <td align="center"> </td> + <td align="center">X</td> + <td>Aktiviert die neuen Attribute des E-ID für diese Online Applikation. </td> + </tr> +</table> +<p> </p> +<h4><a name="konfigurationsparameter_oa_protocol" id="uebersicht_zentraledatei_aktualisierung24"></a>3.2.3 Authentifizierungsprotokolle</h4> +<p>Dieser Abschnitt behandelt online-applikationsspezifische Einstellungen zu den von der Online-Applikation unterstützen Authentifizierungsprotokollen. Eine Verwendung aller zur Verfügung stehender Authentifizierungsprotokolle durch die Online-Applikation ist ebenfalls möglich. Hierfür müssen nur alle benötigten Protokolle konfiguriert werden. Nähere Informationen zu den unterstützten Protokollen finden sie im Kapitel <a href="./../protocol/protocol.html">Protokolle</a>.</p> +<p>Aus Gründen der Übersichtlichkeit kann der Konfigurationsbereich für jeden Protokoll, in der Web-Oberfläche des Konfigurationstools, ein- oder ausgeblendet werden.</p> +<h5><a name="konfigurationsparameter_oa_protocol_saml1" id="uebersicht_zentraledatei_aktualisierung25"></a>3.2.3.1 SAML1</h5> +<p>Für das Protokoll SAML1 stehen folgende Konfigurationsparameter zur Verfügung.</p> +<table class="configtable"> + <tr> + <th>Name</th> + <th>Beispielwert</th> + <th>Admin</th> + <th>Optional</th> + <th>Beschreibung</th> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_Active">SAML1 aktivieren</span></td> + <td>deaktiviert</td> + <td align="center">X</td> + <td align="center"> </td> + <td>Aktiviert SAML1 als erlaubtes Authentifizierungsprotokoll für diese Online-Applikation. Bei neuerstellten Online-Applikationen ist SAML1 per Default deaktiviert.</td> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_provideStammZahl">Stammzahl übertragen</span></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Das Attribut bestimmt, ob die Stammzahl in den Anmeldedaten aufscheint oder ob der Wert ausgeblendet (d.h. auf den Leerstring gesetzt) wird. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl immer ausgeblendet.</td> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_provideAuthBlock">Authentifizierungsblock übertragen</span></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Das Attribut bestimmt, ob der AuthBlock in den Anmeldedaten enthalten ist.</td> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_provideIdentityLink">Personenbindung übertragen</span></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Das Attribut bestimmt, ob die Personenbindung in den Anmeldedaten enthalten ist. Bei Online-Applikationen aus dem privatwirtschaftlichen Bereich wird die Stammzahl in der Personenbindung durch die jeweilige wbPK ersetzt.</td> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_provideCertificate">Zertifikat übertragen</span></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Das Attribut bestimmt, ob das Signatorzertifikat in den Anmeldedaten enthalten ist.</td> + </tr> + <tr> + <td><span id="wwlbl_loadOA_saml1OA_provideFullMandateData">Vollständige Vollmacht übertragen</span></td> + <td> </td> + <td align="center">X</td> + <td align="center">X</td> + <td>Das Attribut bestimmt ob bei einer Vollmachten-Anmeldung die vollständige Vollmacht in der SAML Assertion mitgegeben wird oder nur die Basisdaten wie Name, Geburtsdatum und bPK des Vertreters (bzw. Organwalter/PV) sowie Name, Geburtsdatum und bPK (bzw. Name und Stammzahl bei juristischen Personen) des Vertretenen in der Assertion übermittelt. Wird dieses Attribut gewählt wird zusätzlich die gesamte Vollmacht übergeben.</td> + </tr> +</table> +<p> </p> +<p> </p> +<h5><a name="import_export" id="uebersicht_zentraledatei_aktualisierung4"></a>3.3 Import / Export</h5> +<p>Üer diese Funktionalität besteht die Möglichkeit eine bestehende MOA-ID 2.x.x + Konfiguration in MOA-ID 3.x zu importieren. Zusätzlich besteht die Möglichkeit eine MOA-ID-Auth 3.0 + Konfiguration in ein Dokument zu exportieren oder in eine bestehende MOA-ID-Auth 3.0 + Konfiguration zu importieren. </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 3.0 Konfiguration + zu erstellen, bevor eine neue Konfiguration importiert wird. Hierfür kann die +Exportfunktion verwendet werden.</p> +<h4><a name="import_export_legacy" id="uebersicht_zentraledatei_aktualisierung5"></a>3.3.1 Import alter Konfigurationen ( MOA-ID 2.x.x)</h4> +<p>Es besteht auch die Möglichkeit eine bestehende MOA-ID 2.x.x Konfiguration zu importieren. Hierfür muss zuerst die bestehende MOA-ID 2.x.x Konfiguration mit Hilfe des in MOA-ID 2.x.x verwendeten Konfigurationstools in eine Datei exportiert werden. Anschließend kann die expotierte Datei in das neue Format konfertiert und wieder in die Konfigurationsdatenbank importiert werden. Die einzelnen Schritte werden in der nachfolgenden Aufzählung näher beschrieben.</p> +<ol> + <li>Exportieren Sie die aktuell in MOA-ID 2.x.x verwendete Konfiguration mit Hilfe der Import/Export Funktionen im Konfigurationstool der MOA-ID Version 2.x.x in eine XML Datei. Diese in eine XML Datei exportierte Konfiguration dient als Basis für die Konvertierung in das neue Format.</li> + <li>Konvertieren der Konfigurationsdatei in das neue Konfigurationsformat von MOA-ID 3.x. Die Konvertierung erfolgt mit Hilfe eines Java Programms aus der Konsole. Hierfür befindet sich im Release Package das Verzeichnis <code>$MOA_ID_AUTH_INST/migration</code> welches alle benötigten Java Bibliotheken beinhaltet. Das Programm kann mit Hilfe des nachfolgenden Kommantozeilenparameters gestartet werden. + <br> + <pre>java -jar moa-id-commons.jar -in ../URL_ZUR_MOA-ID-2.x.x-Config -out ./MOA-ID-3.x.properties</pre> + Hierbei wird die unter + <em>../URL_ZUR_MOA-ID-2.x.x-Config</em> verfügbare Konfiguration in das neue Format umgewandelt und in der Datei <em>./MOA-ID-3.x.properties</em> gespeichert.</li> + <li>Schreiben der konvertierten Konfiguration in die neue Konfigurationstabelle der Datenbank. Dies erfolgt ebenfall mit Hilfe des mitgelieferten Konsolenprogramms, welches mit dem nachstehenden Kommantozeilenparameter gestartet wird. + <pre>java -jar moa-id-commons.jar -in ./MOA-ID-3.x.properties -outdb ./moa-id-webgui.properties</pre> + Hierbei wird die unter <em>./MOA-ID-3.x.properties</em> verfügbare Konfiguration in die Datenbank geschrieben. Die Zugriffsparameter für den Datenbankzugriff werden aus der Konfigurationsdatei ./moa-id-webgui.properties entnommen, welche Identisch zur Konfiguration des neuen MOA-ID-Configuration Tools der Version 3.0 ist.</li> + </ol> +<p><strong>Hinweis:</strong> Zusätzlich besteht auch weiterhin die Möglichkeit eine MOA-ID 2.x.x Konfiguration über die Import/Export Funktion im Konfigurationstool zu importieren. Der Import einer Konfiguration kann jedoch eine längere Zeit in Anspruch nehmen wodurch TimeOut Problemen im Browser möglich sind..</p> +<h2><a name="security" id="security"></a>4 Tomcat Security Manager</h2> +<p>Apache Tomcat bietet die Möglichkeit den Server unter einem Security Manager zu betreiben. Damit ist es möglich den lokalen Dateizugriff zu beschränken. Mit Hilfe der Datei "catalina.policy" können so Zugriffe auf lokale Dateien und Verzeichnisse festgelegt werden. Eine beispielhafte catalina.policy Datei finden Sie im Verzeichnis $MOA_ID_INST_AUTH/tomcat. Diese Datei wurde unter Apache Tomcat 4.1.31, 5.0.28 und 5.5.27 getestet. </p> +<p>Mehr Informationen zum Security Manager entnehmen Sie bitte der entsprechenden Apache Tomcat Dokumentation. </p> +<p> </p> +<h2><a name="referenzierte_spezifikation" id="uebersicht_zentraledatei_aktualisierung30"></a>A Referenzierte Spezifikation</h2> +<table class="configtable"> + <tbody> + <tr> + <th>Spezifikation</th> + <th>Link</th> + </tr> + <tr id="sl"> + <td><p>Security Layer Spezifikation V1.2.0</p></td> + <td><a href="http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/">http://www.buergerkarte.at/konzept/securitylayer/spezifikation/20140114/</a></td> + </tr> + <tr> + <td>PVP 2.1 S-Profil Spezifikation</td> + <td><a href="http://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf">http://reference.e-government.gv.at/uploads/media/PVP2-S-Profil_2_0_0_a-2011-08-31.pdf</a></td> + </tr> + <tr> + <td>OpenID Connect</td> + <td><a href="http://openid.net/connect/">http://openid.net/connect/</a></td> + </tr> + <tr> + <td>Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0</td> + <td><a href="#http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf">http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf</a></td> + </tr> + <tr> + <td>Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V2.0</td> + <td><a href="http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf">http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf</a></td> + </tr> + <tr> + <td>Assertions and Protocols for the OASIS Security Assertion Markup Language (SAML) V1.1</td> + <td><a href="https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf">https://www.oasis-open.org/committees/download.php/3406/oasis-sstc-saml-core-1.1.pdf</a></td> + </tr> + </tbody> +</table> +<p> </p> +<p> </p> +</div> +</body> +</html> |