update first parts of MOA-ID 3.x handbook

1 files changed, 285 insertions, 2 deletions

diff --git a/id/server/doc/handbook/additional/additional.html b/id/server/doc/handbook/additional/additional.html
index d26447748..fb9735990 100644
--- a/id/server/doc/handbook/additional/additional.html
+++ b/id/server/doc/handbook/additional/additional.html
@@ -32,6 +32,7 @@
       </ol>
     </li>
     <li><a href="#networkconnections">Ben&ouml;tigte Netzwerkverbindungen (incoming / outgoing)</a></li>
+    <li><a href="#revisionslog">Revisions-Logging</a></li>
   </ol>
   <h2><a name="allgemeines"></a>1 Datenmanagement</h2>
   <p>Dieser Abschnitt spezifiziert jene Datens&auml;tze die w&auml;hrend eines Anmeldevorgangs durch das Modul MOA-ID-Auth tempor&auml;r oder permanent gespeichert werden. Hierbei handelt es sich sowohl um tempor&auml;re Sessiondaten als auch um dauerhaft gespeicherte Statistikdaten.</p>
@@ -248,7 +249,289 @@
     <td>Stammzahlenregister Gateway via SOAP Service</td>
   </tr>
 </table>
-
-    </div>
+  <p>&nbsp;</p>
+  <h2><a name="revisionslog" id="networkconnections2"></a>3 Revisions Logging</h2>
+  <p>Ab der Version 3.x von MOA-ID-Auth steht zus&auml;tzlich zum normalen Logging und zur Generierung von Statisikdaten ein spezielles Reversions Logging zur Verf&uuml;gung. Dieses Revisions Logging erstellt ein spezielles Log welches Informationen zum Identifikations- und Authentifikationsprozess mit Zeitstempel und Eventcode beinhaltet. Die Events, welche durch dieses Log aufgezeichnet werden lassen sich je MOA-ID-Auth Instanz und je Online-Applikation konfigurieren. Das Revisions Logging kann &uuml;ber die folgende Zeilen in der log4j Konfiguration der MOA-ID Instanz konfiguriert werden:</p>
+  <p><em>log4j.logger.at.gv.egiz.eventlog.plain.all=info,reversion</em></p>
+  <p><em>log4j.appender.reversion=org.apache.log4j.RollingFileAppender<br>
+    log4j.appender.reversion.File=$logDirectory/moa-id-reversion.log<br>
+    log4j.appender.reversion.MaxFileSize=10000KB<br>
+    log4j.appender.reversion.MaxBackupIndex=9999<br>
+    log4j.appender.reversion.layout=org.apache.log4j.PatternLayout<br>
+    log4j.appender.reversion.layout.ConversionPattern=%5p | %d{dd HH:mm:ss,SSS} | %t | %m%n</em></p>
+  <p>&nbsp;</p>
+  <p>Die nachstehenden Tabellen beschreibt alle Events welche aktuell in MOA-ID zur Verf&uuml;gung stehen, wobei die erste Tabelle alle Basisevents beinhaltet die von MOA-ID auf jeden Fall geloggt werden.  Die in der zweiten Tabelle angegebenen Events sind immer einer Session und einer Transaktion aus Tabelle 1 zugeordnet und k&ouml;nnen durch die MOA-ID Konfiguration ausgew&auml;hlt werden.</p>
+  <table border="1" cellpadding="0" cellspacing="0" class="configtable">
+    <tr>
+      <td width="125" valign="top"><p align="left"><strong>EventCode</strong></p></td>
+      <td width="201" valign="top"><p align="left"><strong>Wert</strong></p></td>
+      <td width="964" valign="top"><p align="left"><strong>Beschreibung</strong></p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1000</p></td>
+      <td width="201"><p align="left">SessionID</p></td>
+      <td width="964" valign="top"><p>Eine neue Session wurde mit der angegebenen ID gestartet</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1001</p></td>
+      <td width="201"><p align="left">SessionID</p></td>
+      <td width="964" valign="top"><p>Die Session mit der angegebenen ID wurde    beendet</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1002</p></td>
+      <td width="201"><p align="left">IP Adresse</p></td>
+      <td width="964" valign="top"><p>IP Addresse des Hosts der die Session ge&ouml;ffnet hat</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1003</p></td>
+      <td width="201"><p align="left">SessionID</p></td>
+      <td width="964" valign="top"><p>Die Session mit der angebenden ID wurde wegen    eines Fehler beendet</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1100</p></td>
+      <td width="201"><p align="left">TransaktionsID</p></td>
+      <td width="964" valign="top"><p>Eine neue Transaction wurde mit der angegebenen ID gestartet. &nbsp;Eine Transaktion ist immer eine Session    zugeordnet</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1101</p></td>
+      <td width="201"><p align="left">TransaktionsID</p></td>
+      <td width="964" valign="top"><p>Die Transkation mit der angegebenen ID wurde    beendet</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1102</p></td>
+      <td width="201"><p align="left">IP Adresse</p></td>
+      <td width="964" valign="top"><p>IP Addresse des Hosts der die Transaction ge&ouml;ffnet hat</p></td>
+    </tr>
+    <tr>
+      <td width="125"><p align="center">1103</p></td>
+      <td width="201" valign="top"><p>TransaktionsID</p></td>
+      <td width="964" valign="top"><p>Die Transkation mit der angebenden ID wurde    wegen eines Fehler beendet</p></td>
+    </tr>
+  </table>
+  <p>&nbsp;</p>
+  <table border="1" cellpadding="0" cellspacing="0" class="configtable">
+    <tr>
+      <td width="131" valign="top"><p align="left"><strong>EventCode</strong></p></td>
+      <td width="208" valign="top"><p align="left"><strong>Wert</strong></p></td>
+      <td width="946" valign="top"><p align="left"><strong>Beschreibung</strong></p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3000</p></td>
+      <td width="208" valign="top"><p align="left">Protokolltype</p></td>
+      <td width="946" valign="top"><p>Type des verwendeten Authentifizierungsprotokolls (OpenID Connect,    PVP2, STORK, SAML1)</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3100</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>PVP 2.x Metadaten Request</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3101</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>PVP 2.x Authentifizierungsrequest</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3102</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>PVP 2.x Authentifizierungsresponse</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3103</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>PVP 2.x Single LogOut Request</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3104</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>PVP    2.x Attribute Query (im Fall IDP Interfederation mit zwischen MOA-IDs)</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3200</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>OpenID Connect Auth Requsst</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3201</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>OpenID Connect Tokken Request</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">3300</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>SAML1 StartAuthentication Request</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4000</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Identifizierungs- und Authentifizierungsprozess    wurde gestartet</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4001</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Identifizierungs- und Authentifizierungsprozess wurde beendet</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4002</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Anmeldeprozess mit Online Vollmachten</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4003</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Anmeldeprozess mit STORK</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4004</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Anmeldeprozess mit Single Sign-On</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4005</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Ung&uuml;ltige Single Sign-On Session</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4006</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Benutzeranfrage f&uuml;r Single Sign-On Verwendung    gestellt</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4007</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Benutzerantwort f&uuml;r Single Sign-On Verwendung empfangen</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4008</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Anmeldeprozess &uuml;ber IDP F&ouml;deration</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4009</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>G&uuml;ltige Response von f&ouml;deriertem IDP erhalten</p></td>
+    </tr>
+    <tr>
+      <td height="30" valign="top">4010</td>
+      <td valign="top">EntityID    des IDP</td>
+      <td valign="top">Verwendeter IDP f&uuml;r f&ouml;derierte Anmeldung</td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4011</p></td>
+      <td width="208" valign="top"><p align="left">Service Identifikator</p></td>
+      <td width="946" valign="top"><p>Eindeutiger Identifikator der/des Online-Applikation/Service an der/dem die Anmeldung erfolgt</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4110</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>BKU Auswahl gestartet</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4111</p></td>
+      <td width="208" valign="top"><p align="left">Bkutype (z.b.    online, handy, local)</p></td>
+      <td width="946" valign="top"><p>Ausgew&auml;hlter BKU Type</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4112</p></td>
+      <td width="208" valign="top"><p align="left">URL</p></td>
+      <td width="946" valign="top"><p>Verwendete BKU URL</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4113</p></td>
+      <td width="208" valign="top"><p align="left">IP    Adresse</p></td>
+      <td width="946" valign="top"><p>IP Adresse mit der die BKU Daten an MOA-ID    liefert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4220</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Personenbindung ausgelesen und g&uuml;ltig validiert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4221</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Signaturzertifikat ausgelesen und validiert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4222</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>AuthBlock signiert und g&uuml;ltig validiert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4223</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Wechsel in den Modus f&uuml;r ausl&auml;ndische    Signaturkarten</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4224</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>SZR-Gateway wird kontaktiert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4225</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Personenbindung von SZR-Gateway erhalten</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4300</p></td>
+      <td width="208" valign="top"><p align="left">ReferenceID des Vollmachtensystems</p></td>
+      <td width="946" valign="top"><p>Online-Vollmachten Service wird kontaktiert</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4301</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Redirekt zum Online-Vollmachten Service</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">4302</p></td>
+      <td width="208" valign="top"><p align="left">&nbsp;</p></td>
+      <td width="946" valign="top"><p>Vollmacht vom Online-Vollmachten Service erhalten</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5000</p></td>
+      <td width="208" valign="top"><p align="left">bPK</p></td>
+      <td width="946" valign="top"><p>bPK bei Vollmacht mit berufsm&auml;&szlig;igem Parteienvertreter    oder Organwalter</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5001</p></td>
+      <td width="208" valign="top"><p align="left">OID</p></td>
+      <td width="946" valign="top"><p>OID bei Vollmacht mit berufsm&auml;&szlig;igem Parteienvertreter oder Organwalter</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5002</p></td>
+      <td width="208" valign="top"><p align="left">JSON    String</p></td>
+      <td width="946" valign="top"><p>Pseudoanonymisierte Personendaten der sich    anmeldeten nat&uuml;rlichen Person.</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5100</p></td>
+      <td width="208" valign="top"><p align="left">Vollmachtstype</p></td>
+      <td width="946" valign="top"><p>Type der ausgew&auml;hlten Vollmacht</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5101</p></td>
+      <td width="208" valign="top"><p align="left">jur / nat</p></td>
+      <td width="946" valign="top"><p>Vollmacht - Type der vertretenen Person (Juristische    / nat&uuml;rliche Person)</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5102</p></td>
+      <td width="208" valign="top"><p align="left">JSON String</p></td>
+      <td width="946" valign="top"><p>Pseudoanonymisierte Personendaten der vertretenen nat&uuml;rlichen Person.</p></td>
+    </tr>
+    <tr>
+      <td width="131" valign="top"><p align="center">5103</p></td>
+      <td width="208" valign="top"><p align="left">baseID</p></td>
+      <td width="946" valign="top"><p>Stammzahl der vertretenen juristischen Person </p></td>
+    </tr>
+  </table>
+<p>&nbsp;</p>
+<p>Einzelne  Events werden um einen Transaktionsparameter erg&auml;nzt, welcher in der Spalte  Wert beschrieben ist. <br>
+  </p>
+<p>Die pseudoanonymisierten Personendaten f&uuml;r  nat&uuml;rliche Personen werden anhand des nachfolgenden Schemas generiert. Als  pseudoanonymisiertes Personendatum dient der SHA256 Hash &uuml;ber die in eine JSON Struktur  eingetragenen Personendaten. Hierf&uuml;r wird das folgende JSON Schema verwendet,  welches als Input f&uuml;r die SHA256 Berechnung dient.</p>
+<p><br>
+  {&quot;person&quot;:{&quot;givenname&quot;:&quot;<em>Vorname der Person</em>&quot;,&quot;familyname&quot;:&quot;<em>Nachname der Person</em>&quot;,&quot;dateofbirth&quot;:&quot;<em>Geburtsdatum der Person</em>&quot;},&quot;salt&quot;:&quot;<em>Zufallszahl</em>&quot;}<br>
+  </p>
+<p>Anschlie&szlig;end wird das pseudoanonymisiert  Personendatum als JSON Wert bei den entsprechenden Events eingetragen. Der  eingetragener JSON Wert entspricht dem folgenden Schema</p>
+<p><br>
+  {&quot;hash&quot;:&quot;<em>BASE64 codierte Personendatum</em>&quot;,&quot;salt:&quot;<em>Zufallzahl welche zur  Generierung des Personendatums verwendet wurde</em>&quot;}</p>
+<p>&nbsp;</p>
+  </div>
 </body>
 </html>