update handbook, readme, history, example configuration, ...

1 files changed, 262 insertions, 0 deletions

diff --git a/id/readme_3.4.0.txt b/id/readme_3.4.0.txt
new file mode 100644
index 000000000..81d4805a4
--- /dev/null
+++ b/id/readme_3.4.0.txt
@@ -0,0 +1,262 @@
+===============================================================================
+MOA ID Version Release 3.4.0 - Wichtige Informationen zur Installation
+===============================================================================
+
+-------------------------------------------------------------------------------
+A. Neuerungen/Änderungen
+-------------------------------------------------------------------------------
+
+Mit MOA ID Version 3.4.0 wurden folgende Neuerungen und Änderungen eingeführt, 
+die jetzt erstmals in der Veröffentlichung enthalten sind (siehe auch 
+history.txt im gleichen Verzeichnis).
+   
+- Änderungen
+  - Unerstützung der Authentifizierung von ausländischen Bürgern via eIDAS
+  - Authentifizierung via neuer VDA Schnittstelle (Security-Layer 2.0) 
+    (Im Betastatus, da die Schnittstellenspezifikation noch nicht final 
+     zur Verfügung steht)
+  - Erweiterung zur Einschränkung des Authentifzierungsvorgangs auf bestimmte
+    Benutzer via bPK
+  - Überarbeitung der Bürgerkartenauswahl und weiterer Templates  
+  - Bugfix - Probleme in Kombination mit postgreSQL Datenbanken behoben 
+  - Update von Libraries 
+
+-------------------------------------------------------------------------------
+B. Durchführung eines Updates
+-------------------------------------------------------------------------------
+
+Es wird generell eine Neuinstallation lt. Handbuch empfohlen! Dennoch ist auch
+eine Aktualisierung bestehender Installationen möglich. Je nachdem von welcher
+MOA-ID Version ausgegangen wird ergibt sich eine Kombination der nachfolgend 
+angebebenen Updateschritte.
+
+Hinweis: Wenn Sie die bestehende Konfiguration von MOA-ID 2.x.x in MOA-ID 3.4.x
+reimportieren möchten, so muss diese vor dem Update mit Hilfe der import/export
+Funktion der grafischen Konfigurationsoberfläche in eine Datei exportiert werden.
+Diese Datei dient dann als Basis für den Import in MOA-ID 3.4.x. 
+
+...............................................................................
+B.1 Durchführung eines Updates von Version 3.3.x auf Version 3.4.0
+...............................................................................
+1. Stoppen Sie den Tomcat, in dem Ihre bisherige Installation betrieben wird.
+   Fertigen Sie eine Sicherungskopie Ihrer kompletten Tomcat-Installation an.
+
+2. Entpacken Sie die Distribution von MOA-ID-Auth (moa-id-auth-3.4.0.zip) in
+   ein temporäres Verzeichnis, in weiterer Folge als MOA_ID_AUTH_INST 
+   bezeichnet.
+
+3. Wechseln Sie in jenes Verzeichnis, das die Webapplikation von MOA ID Auth
+   beinhaltet (für gewöhnlich ist dieses Verzeichnis CATALINA_HOME_ID/webapps,
+   wobei CATALINA_HOME_ID für das Basisverzeichnis der Tomcat-Installation 
+   für MOA ID steht). Löschen Sie darin sowohl die Dateien moa-id-auth.war 
+   als auch das komplette Verzeichnis moa-id-auth. 
+
+4. Kopieren Sie die Datei MOA_ID_AUTH_INST/moa-id-auth.war nach
+   CATALINA_HOME_ID/webapps.
+
+5. Kopieren Sie die Datei MOA_ID_AUTH_INST/moa-id-configuration.war nach
+   CATALINA_HOME_ID/webapps.
+
+6. Hinzufügen der zusätzlichen Konfigurationsparameter in der MOA-ID-Auth
+   Konfigurationsdatei CATALINA_HOME\conf\moa-id\moa-id.properties
+6.1 Anbindung an zentralen nationalen eIDAS Connector   
+   > modules.eidascentralauth.keystore.path=
+   > modules.eidascentralauth.keystore.password=
+   > modules.eidascentralauth.metadata.sign.alias=
+   > modules.eidascentralauth.metadata.sign.password=
+   > modules.eidascentralauth.request.sign.alias= 
+   > modules.eidascentralauth.request.sign.password=
+   > modules.eidascentralauth.response.encryption.alias= 
+   > modules.eidascentralauth.response.encryption.password= 
+   > modules.eidascentralauth.node.trustprofileID=centralnode_metadata    
+
+
+7. HTML Template updates
+7.1 Update der HTML Templates für Auswahl des zentralen nationalen eIDAS Connectors
+    Sollten Sie eigene     Modifikationen an den bestehenden Templates vorgenommen 
+    haben müssen die Anpassungen manuell in die neuen Templates übertragen werden. 
+    MOA-ID 3.4.0 kann jedoch auch mit den bestehenden Templates betrieben werden, sofern
+    keine Unterstützung für eIDAS benötigt wird.
+    a.) Erstellen Sie eine Sicherungskopie der Verzeichnisse:
+       - CATALINA_HOME\conf\moa-id\htmlTemplates
+       - CATALINA_HOME\conf\moa-id-configuration\htmlTemplates     
+    b.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id\htmlTemplates
+         in das Verzeichnis CATALINA_HOME\conf\moa-id\htmlTemplates          
+    d.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id-configuration\htmlTemplates
+         in das Verzeichnis CATALINA_HOME\conf\moa-id-configuration\htmlTemplates.     
+
+8. Update the MOA-ID Konfiguration via Web-basierten Konfigurationstool
+    Diese Schitte können erst nach der Installation und dem Start der Applikation
+    moa-id-configuration.war durchgeführt werden
+8.1 Anbindung an zentralen nationalen eIDAS Connector 
+    a.) Bekanntgabe von Endpunkten (Produktiv, Test, ... ) der verwendbaren 
+        zentralen nationalen eIDAS Connectoren. 
+        
+    b.) Auswahl des gewünschten zentraler nationaler eIDAS Connector je Online-Applikation
+        sofern im Schritt a. mehr als Ein Endpunkt konfiguriert wurde. 
+        Hinweis: Als Default wird immer der Erste im Schritt a. hinterlegte Endpunkt verwendet
+
+9. Optionale Updates:
+9.1. Unterstützung der neuen VDA Schnittstelle via Security-Layer 2.0:
+     Hierbei handelt es sich um eine Authentifizierungsschnittstelle im Beta Status
+     da die Spezifikation der Schnittstelle noch nicht Final ist. Die Schnittstelle ist in 
+     MOA-ID funktional umgesetzt, es kann jedoch noch offene Punkte bezüglich Fehlerhändlung
+     und Logging geben. 
+     a.) Hinzufügen der zusätzlichen Konfigurationsparameter in der MOA-ID-Auth
+         Konfigurationsdatei CATALINA_HOME\conf\moa-id\moa-id.properties
+         > modules.sl20.security.keystore.path=keys/sl20.jks
+         > modules.sl20.security.keystore.password=password
+         > modules.sl20.security.sign.alias=signing
+         > modules.sl20.security.sign.password=password
+         > modules.sl20.security.encryption.alias=encryption
+         > modules.sl20.security.encryption.password=password
+         
+     b.) Aktivierung je Online-Applikation im Web-basierten Konfigurationstool
+         Die neue VDA-Schnittstelle muss je Online-Applikation aktiviert werden, wobei 
+         die Aktivierung im Abschnitt "Security Layer für mobile Authententifizierung" 
+         der Online-Applikationskonfiguration erfolgt. 
+
+9.2. Umstellung auf Java JDK 9
+     Die 'JAVA_HOME\jre\lib\ext' und die 'CATALINA_HOME_ID\endorsed' wird in Java 9 
+     nicht mehr unterstützt und entsprechende Referenzen müssen aus den Start-Scripts
+     entfernt werden. Ab MOA-ID 3.3.2 sind die Bibliotheken, welche früher in 
+     den beiden Verzeichnissen hinterlegt waren, direkt in MOA-ID integriert.   
+   
+10. Starten Sie den Tomcat neu, achten Sie auf eventuelle Fehlermeldungen im
+    Logging von MOA ID beim Einlesen der Konfiguration.
+
+
+################################################################################################################
+
+...............................................................................
+B.1 Durchführung eines Updates von Version 3.2.x auf Version 3.4.0
+...............................................................................
+1. Stoppen Sie den Tomcat, in dem Ihre bisherige Installation betrieben wird.
+   Fertigen Sie eine Sicherungskopie Ihrer kompletten Tomcat-Installation an.
+
+2. Entpacken Sie die Distribution von MOA-ID-Auth (moa-id-auth-3.3.2.zip) in
+   ein temporäres Verzeichnis, in weiterer Folge als MOA_ID_AUTH_INST 
+   bezeichnet.
+
+3. Wechseln Sie in jenes Verzeichnis, das die Webapplikation von MOA ID Auth
+   beinhaltet (für gewöhnlich ist dieses Verzeichnis CATALINA_HOME_ID/webapps,
+   wobei CATALINA_HOME_ID für das Basisverzeichnis der Tomcat-Installation 
+   für MOA ID steht). Löschen Sie darin sowohl die Dateien moa-id-auth.war 
+   als auch das komplette Verzeichnis moa-id-auth. 
+
+4. Kopieren Sie die Datei MOA_ID_AUTH_INST/moa-id-auth.war nach
+   CATALINA_HOME_ID/webapps.
+
+5. Kopieren Sie die Datei MOA_ID_AUTH_INST/moa-id-configuration.war nach
+   CATALINA_HOME_ID/webapps.
+
+6. Erstellen Sie eine Sicherungskopie aller "iaik*.jar"-Dateien im Verzeichnis
+	 JAVA_HOME\jre\lib\ext und loeschen Sie diese Dateien danach.
+	
+7. Kopieren Sie alle Dateien aus dem Verzeichnis MOA_ID_AUTH_INST\ext in das 
+   Verzeichnis	JAVA_HOME\jre\lib\ext (Achtung: Java 1.4.x wird nicht mehr 
+   unterstuetzt).
+
+8. Erstellen Sie eine Sicherungskopie aller "*.jar"-Dateien im Verzeichnis
+   CATALINA_HOME_ID\endorsed und loeschen Sie diese Dateien danach.
+   
+9. Kopieren Sie alle Dateien aus dem Verzeichnis MOA_ID_AUTH_INST\endorsed in das 
+   Verzeichnis	CATALINA_HOME_ID\endorsed.
+
+10. Hinzufügen der zusätzlichen Konfigurationsparameter in der MOA-ID-Auth
+    Konfigurationsdatei CATALINA_HOME\conf\moa-id\moa-id.properties
+10.1 Anbindung an zentralen nationalen eIDAS Connector   
+    > modules.eidascentralauth.keystore.path=
+    > modules.eidascentralauth.keystore.password=
+    > modules.eidascentralauth.metadata.sign.alias=
+    > modules.eidascentralauth.metadata.sign.password=
+    > modules.eidascentralauth.request.sign.alias= 
+    > modules.eidascentralauth.request.sign.password=
+    > modules.eidascentralauth.response.encryption.alias= 
+    > modules.eidascentralauth.response.encryption.password= 
+    > modules.eidascentralauth.node.trustprofileID=centralnode_metadata    
+
+11. HTML Template updates
+11.1 Update der HTML Templates für Auswahl des zentralen nationalen eIDAS Connectors
+     Sollten Sie eigene     Modifikationen an den bestehenden Templates vorgenommen 
+     haben müssen die Anpassungen manuell in die neuen Templates übertragen werden. 
+     MOA-ID 3.4.0 kann jedoch auch mit den bestehenden Templates betrieben werden, sofern
+     keine Unterstützung für eIDAS benötigt wird.
+     a.) Erstellen Sie eine Sicherungskopie der Verzeichnisse:
+        - CATALINA_HOME\conf\moa-id\htmlTemplates
+        - CATALINA_HOME\conf\moa-id-configuration\htmlTemplates     
+     b.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id\htmlTemplates
+          in das Verzeichnis CATALINA_HOME\conf\moa-id\htmlTemplates          
+     d.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id-configuration\htmlTemplates
+          in das Verzeichnis CATALINA_HOME\conf\moa-id-configuration\htmlTemplates.     
+
+12. Update the MOA-ID Konfiguration via Web-basierten Konfigurationstool
+     Diese Schitte können erst nach der Installation und dem Start der Applikation
+     moa-id-configuration.war durchgeführt werden
+12.1 Anbindung an zentralen nationalen eIDAS Connector 
+     a.) Bekanntgabe von Endpunkten (Produktiv, Test, ... ) der verwendbaren 
+         zentralen nationalen eIDAS Connectoren. 
+        
+     b.) Auswahl des gewünschten zentraler nationaler eIDAS Connector je Online-Applikation
+         sofern im Schritt a. mehr als Ein Endpunkt konfiguriert wurde. 
+         Hinweis: Als Default wird immer der Erste im Schritt a. hinterlegte Endpunkt verwendet
+
+13. Optionale Updates:
+13.1. Unterstützung der neuen VDA Schnittstelle via Security-Layer 2.0:
+      Hierbei handelt es sich um eine Authentifizierungsschnittstelle im Beta Status
+      da die Spezifikation der Schnittstelle noch nicht Final ist. Die Schnittstelle ist in 
+      MOA-ID funktional umgesetzt, es kann jedoch noch offene Punkte bezüglich Fehlerhändlung
+      und Logging geben. 
+      a.) Hinzufügen der zusätzlichen Konfigurationsparameter in der MOA-ID-Auth
+          Konfigurationsdatei CATALINA_HOME\conf\moa-id\moa-id.properties
+          > modules.sl20.security.keystore.path=keys/sl20.jks
+          > modules.sl20.security.keystore.password=password
+          > modules.sl20.security.sign.alias=signing
+          > modules.sl20.security.sign.password=password
+          > modules.sl20.security.encryption.alias=encryption
+          > modules.sl20.security.encryption.password=password
+         
+      b.) Aktivierung je Online-Applikation im Web-basierten Konfigurationstool
+          Die neue VDA-Schnittstelle muss je Online-Applikation aktiviert werden, wobei 
+          die Aktivierung im Abschnitt "Security Layer für mobile Authententifizierung" 
+          der Online-Applikationskonfiguration erfolgt. 
+
+13.2. Umstellung auf Java JDK 9
+      Die 'JAVA_HOME\jre\lib\ext' und die 'CATALINA_HOME_ID\endorsed' wird in Java 9 
+      nicht mehr unterstützt und entsprechende Referenzen müssen aus den Start-Scripts
+      entfernt werden. Ab MOA-ID 3.3.2 sind die Bibliotheken, welche früher in 
+      den beiden Verzeichnissen hinterlegt waren, direkt in MOA-ID integriert.   
+
+13.3. Das BKU Auswahltemplate von MOA-ID wurde um eine Detection der lokalen BKU
+      erweitert und mocca Online wurde entfernt.
+      a.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id\htmlTemplates
+          in das Verzeichnis CATALINA_HOME\conf\moa-id\htmlTemplates
+      b.) Kopieren Sie die Dateien aus dem Verzeichnis MOA_ID_INST_AUTH\conf\moa-id-configuration\htmlTemplates
+          in das Verzeichnis CATALINA_HOME\conf\moa-id-configuration\htmlTemplates. 
+13.4. Die mySQL Treiber 'com.mysql.jdbc.Drive' und 'org.hibernate.dialect.MySQLDialect'
+      sind deprecated für aktuelle mySQL DB Versionen. Der neue Treiber 
+      für mySQL Datenbanken lautet 'com.mysql.cj.jdbc.Driver' und ein aktuellerer
+      Hibernate Dialect lautet 'org.hibernate.dialect.MySQL5Dialect'. 
+      Sollte es zu Problemen kommen ersetzen Sie entsprechenden Zeilen durch:
+      a.) Konfigurationsdatei CATALINA_HOME\conf\moa-id\moa-id.properties
+          moasession.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
+          moasession.hibernate.connection.driver_class=com.mysql.cj.jdbc.Driver
+          configuration.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
+          configuration.hibernate.connection.driver_class=com.mysql.cj.jdbc.Driver
+          advancedlogging.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
+          advancedlogging.hibernate.connection.driver_class=com.mysql.cj.jdbc.Driver
+      b.) Konfigurationsdatei CATALINA_HOME\conf\moa-id-configuration\moa-id-configtool.properties
+          hibernate.connection.driver_class=com.mysql.cj.jdbc.Driver
+   
+14.  Starten Sie den Tomcat neu, achten Sie auf eventuelle Fehlermeldungen im
+     Logging von MOA ID beim Einlesen der Konfiguration.
+
+
+...............................................................................
+B.2 Durchführung eines Updates von Version < 3.2.0
+...............................................................................
+
+Bitte führen Sie eine Neuinstallation von MOA ID laut Handbuch durch und passen
+Sie die mitgelieferte Musterkonfiguration entsprechend Ihren Bedürfnissen unter 
+Zuhilfenahme Ihrer bisherigen Konfiguration an.
+