Handbook: add protocol chapter

author: Thomas Lenz <thomas.lenz@egiz.gv.at> 2014-03-03 07:05:02 +0100
committer: Thomas Lenz <thomas.lenz@egiz.gv.at> 2014-03-03 07:05:02 +0100
commit: 8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c (patch)
tree: b075f8847aeb68beaafc02b6be5af6e2918b5920 /id
parent: 0113065f164f15967473c90def2c88ba0cb936f1 (diff)
download: moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.tar.gz
moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.tar.bz2
moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.zip
3 files changed, 115 insertions, 1 deletions
diff --git a/id/server/doc/handbook/index.html b/id/server/doc/handbook/index.html
index c071caf59..12c598c9d 100644
--- a/id/server/doc/handbook/index.html
+++ b/id/server/doc/handbook/index.html
@@ -1,7 +1,7 @@
 <!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 http-equiv="content-type" content="text/html; charset=ISO-8859-1" >
   <title>MOA ID - &Uuml;bersicht</title>
   <link rel="stylesheet" href="./common/MOA.css" type="text/css">
 </head>
diff --git a/id/server/doc/handbook/protocol/openIDconnect_sequenz.png b/id/server/doc/handbook/protocol/openIDconnect_sequenz.png
new file mode 100644
index 000000000..47b8f2784
--- /dev/null
+++ b/id/server/doc/handbook/protocol/openIDconnect_sequenz.png
diff --git a/id/server/doc/handbook/protocol/protocol.html b/id/server/doc/handbook/protocol/protocol.html
new file mode 100644
index 000000000..bd6893af0
--- /dev/null
+++ b/id/server/doc/handbook/protocol/protocol.html
@@ -0,0 +1,114 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" >
+  <title>MOA-ID - Einf&uuml;hrung</title>
+  <link rel="stylesheet" href="../common/MOA.css" type="text/css">
+</head>
+<body link="#990000"> 
+  <table class="logoTable" width="100%" border="0" cellspacing="0" cellpadding="10">
+    <tr>
+      <td align="center" class="logoTitle" width="267"><img src="../common/LogoBKA.png" alt="Logo BKA" width="267" height="37" align="left"></td>
+      <td align="center" class="logoTitle">Dokumentation</td>
+      <td align="center" class="logoTitle" width="123"><img src="../common/LogoEGIZ.png" alt="Logo EGIZ" width="230" height="81" align="right"></td>
+    </tr>
+  </table>
+  <hr/> 
+  <p class="title"><a href="../index.html">MOA-ID (Identifikation) </a></p> 
+<p class="subtitle">Protokolle</p> 
+  <hr/>
+  <h1>Inhalt</h1>
+  <ol>
+    <li><a href="#allgemeines">Allgemeines</a></li>
+  			<li><a href="#pvp21">PVP 2.1 </a></li>
+    <li><a href="#openid">OpenID Connect</a></li>
+    <li><a href="#saml1">SAML 1</a></li>
+  </ol>
+  <ol type="A">
+    <li><a href="#referenzierte_spezifikation">Referenzierte Spezifikation</a></li>
+  </ol>
+<hr/>
+  <h1><a name="allgemeines"></a>1 Allgemeines</h1>
+  <p>Dieses Kapitel behandelt jene Authentifizierungsprotokolle die vom Modul MOA-ID-Auth unterstützt werden. 
+  Wobei die Verwendung der Protokolle PVP 2.1 oder OpenID Connect empfohlen wird. Das Protokoll SAML 1, welches bis zur MOA-ID Version 1.5.1 
+  verwendet wurde, wird jedoch ab der Version 2.0 nur mehr aus Kompatibilitätsgründen angeboten und nicht mehr aktiv weiterentwickelt.</p>
+
+<h1><a name="pvp21"></a>2 PVP 2.1</h1>
+
+
+<h1><a name="openid"></a>3 OpenID Connect </h1>
+<p>OpenID Connect ist ein Authentifizierungsprotkoll welches auf dem OAuth 2.0 Protokoll aufbaut. Dieses Protokoll erlaubt Online-Applikationen die Identifizierung und Authentifizierung von Benutzern, mit Hilfe des Modules MOA-ID-Auth. Der Vorteil von OpenID Connect im Vergleich zu auf SAML basierten Protkollen (PVP 2.1, SAML 1) ist der einfachere Aufbau der einzelnen Protokollnachrichten. Zusätzlich existieren einige frei Verfügbare Bibliotheken für unterschiedliche Programmiersprachen, welche OpenID Connect implementieren.</p>
+<p>Bevor OpenID Connect in Kombination mit dem Modul MOA-ID-Auth verwendet werden kann muss das Modul MOA-ID-Auth konfiguriert werden. Detailinformationen zur <a href="" >Allgemeinen Konfiguration</a> und zur <a href="">online-applikationsspezifischen Konfiguration</a> finden Sie im jeweiligen Abschnitt des Kapitels Konfiguration. TODO!</p>
+<p>Die nachfolgende Beschreibung gibt einen kurzen Überblick zur Verwendung des Protkolls OpenID Connect in Kombination mit dem Modul MOA-ID-Auth. Detailinformationen zu OpenID Connect entnehmen Sie bitte der aktuellen <a href="#referenzierte_spezifikation">OpenID Connect Spezifikation</a></p>
+
+<h2><a name="openid_sequenzdiagramm"></a>3.1 Ablauf einer Anmeldung mittels OpenID Connect</h2>
+<p>Die nachfolgende Abbildung zeigt das Sequenzdiagramm eines Anmeldevorgangs mittels OpenID Connect und des Modules MOA-ID-Auth als Identityprovider. Aus Gründen der Übersichtlichkeit wurden die Teile welche die Kommunikation mit der Bürgerkartenumgebung oder die Vollmachten-Auswahl betreffen bewusst nicht berücksichtigt.</p>
+
+<p>TODO:</p>
+
+<h2><a name="openid_interface"></a>3.2 Zugangspunkte</h2>
+<p>Zur Verwendung von OpenID Connect stellt das Modul MOA-ID-Auth zwei Zugangspunkte zur Kommunikation mit der Online-Applikation zur Verfügung. Diese Zugangspunkte bezeichnen die URLs unter welchen das Modul MOA-ID-Auth die entsprechenden OpenID Connect Nachrichten entgegennimmt.</p>
+<ul>
+<li><b>AuthCode-Request:</b> https://ihr-moa-server/moa-id-auth/oauth2/auth <br> Unter dieser URL wird der Authn Request entgegengenommen. Dieser Request startet den Authentifizierungsvorgang an der Online-Applikation. Hier finden Sie Detailinformationen zum <a href="#openid_req_authnreq"> Request </a>und zur <a href="#openid_req_authnresp">Response</a>.</li>
+<li><b>AccessToken-Request:</b> https://ihr-moa-server/moa-id-auth/oauth2/token <br> Unter dieser URL können nach erfolgreicher Authentifizierung die eigentlichen Authentifizierungsdaten am Modul MOA-ID-Auth abgeholt werden. Hier finden Sie Detailinformationen zum <a href="#openid_req_tokenreq"> Request </a>und zur <a href="#openid_req_tokenresp">Response</a>.</li>
+</ul>
+
+<h2><a name="openid_requests"></a>3.3 Beschreibung der Nachrichten</h2>
+<p>Dieser Abschnitt beschreibt die einzelnen OpenID Connect spezifischen Nachrichten, welche zwischen der Online-Applikation und dem Modul MOA-ID-Auth während eines Authentifizierungsvorgangs ausgetauscht werden. Hierbei wird auch auf das Sequenzdiagramm aus <a href="#openid_sequenzdiagramm">Abschnitt 3.1</a> Bezug genommen.</p>
+
+<h3><a name="openid_req_authnreq"></a>3.2.1 AuthCode Request</h3>
+<p>Der AuthCode Request ist die Authentifizierungsanfrage einer Online-Applikation für eine BenutzerIn oder einen Benutzer.
+Folgende Parameter müssen oder können mit dem AuthCode-Request mitgesendet werden, wobei für die Übertragung der Parameter sowohl http GET als auch http POST verwendet werden kann.</p>
+
+
+<h3><a name="openid_req_authnresp"></a>3.2.2 AuthCode Response</h3>
+
+<h3><a name="openid_req_tokenreq"></a>3.2.3 AccessToken Request</h3>
+
+<h3><a name="openid_req_tokenresp"></a>3.2.4 AccessToken Response</h3>
+
+
+
+<p>&nbsp;</p>
+
+<h1><a name="saml1"></a>3 SAML 1 </h1>
+
+<h1><a name="referenzierte_spezifikation" id="uebersicht_zentraledatei_aktualisierung30"></a>A Referenzierte Spezifikation</h1>
+<table class="fixedWidth" border="1" cellpadding="2">
+  <tbody>
+    <tr>
+      <th>Spezifikation</th>
+      <th>Link</th>
+    </tr>
+    <tr id="sl">
+      <td><p>Security Layer Spezifikation 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>STORK 2</td>
+      <td>@TODO Link</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>
+</body>
+</html>
author	Thomas Lenz <thomas.lenz@egiz.gv.at>	2014-03-03 07:05:02 +0100
committer	Thomas Lenz <thomas.lenz@egiz.gv.at>	2014-03-03 07:05:02 +0100
commit	8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c (patch)
tree	b075f8847aeb68beaafc02b6be5af6e2918b5920 /id
parent	0113065f164f15967473c90def2c88ba0cb936f1 (diff)
download	moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.tar.gz moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.tar.bz2 moa-id-spss-8b8e4c9c3c9ff5e3855be8b177b58387ee6b625c.zip