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 | |
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')
-rw-r--r-- | id/server/doc/handbook/config/config.html | 98 | ||||
-rw-r--r-- | id/server/doc/handbook/index.html | 2 | ||||
-rw-r--r-- | id/server/doc/handbook/protocol/protocol.html | 12 |
3 files changed, 87 insertions, 25 deletions
diff --git a/id/server/doc/handbook/config/config.html b/id/server/doc/handbook/config/config.html index 4fb57cb3a..a67de86d0 100644 --- a/id/server/doc/handbook/config/config.html +++ b/id/server/doc/handbook/config/config.html @@ -60,6 +60,7 @@ <li><a href="#basisconfig_moa_id_auth_param_services_moasp">MOA-SP</a></li> <li><a href="#basisconfig_moa_id_auth_param_services_mandates">Online-Vollmachen</a></li> <li><a href="#">Zentraler eIDAS Knoten</a></li> + <li><a href="#basisconfig_moa_id_auth_param_services_EID">E-ID Anbindung</a></li> </ol> </li> <li><a href="#basisconfig_moa_id_auth_param_protocol">Protokolle</a> @@ -119,7 +120,7 @@ <li><a href="#konfigurationsparameter_oa_general_business">Privatwirtschaftlicher Bereich</a></li> </ol> </li> - <li><a href="#konfigurationsparameter_oa_eID_demo">Demo-Modus für E-ID</a></li> + <li><a href="#konfigurationsparameter_oa_eID_demo">Aktivierung der E-ID Anbindung</a></li> <li><a href="#konfigurationsparameter_oa_bku">BKU Konfiguration</a></li> <li><a href="#konfigurationsparameter_oa_sl20">Security Layer für mobile Authententifizierung</a></li> <li><a href="#konfigurationsparameter_oa_testcredentials">Test Credentials</a></li> @@ -563,6 +564,77 @@ https://<host>:<port>/moa-id-auth/MonitoringServlet</pre> </tr> </table> <p> </p> +<h5><a name="basisconfig_moa_id_auth_param_services_EID" id="uebersicht_bekanntmachung6"></a>2.2.2.2.4 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-Auth unterstützt mehrere Authentifizierungsprotokolle. Manche dieser Protokolle benötigen Schlüssel zur Signierung von Authentifizierungsdaten oder Metadaten. In diesem Abschnitt erfolgt die Konfiguration des zu verwendeten Schlüsselmaterials. </p> <h6><a name="basisconfig_moa_id_auth_param_protocol_pvp21" id="uebersicht_bekanntmachung10"></a>2.2.2.3.1 PVP 2.1</h6> @@ -1569,8 +1641,8 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der </table> <p> </p> -<h4><a name="konfigurationsparameter_oa_eID_demo" id="uebersicht_zentraledatei_aktualisierung32"></a>3.2.2 Demo-Modus für E-ID</h4> -<p>Dieser Abschnitt behandelt den Demo-Modus für die kommende E-ID welcher mit der MOA-ID Version 3.4.2 eingeführt wurde. Ist der Demo-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>. Als weitere Anpassung wird mit hoher Wahrscheinlichkeit die iFrame Integration der Handy-Signatur nicht mehr zur Verfügung stehen und es erfolgt eine vollformat Weiterleitung an den E-ID. Diese Anpassung ist in der MOA-ID Version 3.4.2 noch nicht berücksichtig.</p> +<h4><a name="konfigurationsparameter_oa_eID_demo" id="uebersicht_zentraledatei_aktualisierung32"></a>3.2.2 Aktivierung der E-ID Anbindung</h4> +<p>Dieser Abschnitt behandelt den E-ID Proxy Mode von MOA-ID welcher mit der Version 4.0 eingeführt wurde. Ist der E-ID Proxy Mode aktiviert ändert sich das mögliche Attribut-Set welches Online Applikation zur Verfügung gestellt wird, da der Benutzer an das E-ID System zur Authentifizierung weitergeleitet 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> @@ -1598,28 +1670,18 @@ Soll die Bürgerkartenauswahl weiterhin, wie in MOA-ID 1.5.1 im Kontext der <th width="50%">Beschreibung</th> </tr> <tr> - <td><span id="wwlbl_loadOA_targetConfig_eidDemoActive">Demo-Modus aktivieren</span></td> + <td><span id="wwlbl_loadOA_targetConfig_eidDemoActive">E-ID Proxy-Mode aktivieren</span></td> <td><p> </p></td> <td align="center"> </td> <td align="center">X</td> - <td>Aktiviert den Demo-Modus für die E-ID in dieser Online Applikation. </td> - </tr> - <tr> - <td><span id="wwlbl_loadOA_targetConfig_foreignbPKTargets">Sektoren für Fremd-bPKs</span></td> - <td>wbpk+FN+468924i,BMI+T1</td> - <td align="center"> </td> - <td align="center">X</td> - <td><p>Eine CSV Liste von Bereichen für welche die Online Applikation verschlüsselte Fremd-bPKs benötigt. </p> - <p><strong>Hinweis:</strong> Da es sich hierbei nur um eine Demo handelt muss <a href="#basisconfig_moa_id_auth_others">das Schlüsselmaterial für die Verschlüsselung in MOA-ID hinterlegt werden</a>.</p></td> + <td>Aktiviert die Weiterleitung an den E-ID für diese Online Applikation. </td> </tr> <tr> - <td><span id="wwlbl_loadOA_targetConfig_additionalbPKTargets">Sektoren für weitere bPKs</span></td> - <td><p>urn:publicid:gv.at:cdid+T1,</p> - <p>urn:publicid:gv.at:wbpk+FN+468924i</p></td> + <td>E-ID Demo-Mode aktivieren</td> + <td> </td> <td align="center"> </td> <td align="center">X</td> - <td><p>Eine CSV Liste von Bereichen für welche die Online Applikation bPKs aus anderen Bereichen benötogt.</p> - <p><strong>Hinweis:</strong> Die Angabe der Bereiche erfolgt mit dem vollständigen Bereichsidentifier inkl. Prefix.</p></td> + <td>Aktiviert das angepasst E-ID Attributset für diese Online Applikation, es erfolgt jedoch KEINE Weiterleitung an den E-ID. </td> </tr> </table> <p> </p> diff --git a/id/server/doc/handbook/index.html b/id/server/doc/handbook/index.html index 73ece89e3..80d2d3fe8 100644 --- a/id/server/doc/handbook/index.html +++ b/id/server/doc/handbook/index.html @@ -29,7 +29,7 @@ </div> <div class="container"> - <h2>Übersicht zur Dokumentation der Version 3.4.x </h2> + <h2>Übersicht zur Dokumentation der Version 4.1.x </h2> <dl> <dt><a href="./intro/intro.html">Einführung</a></dt> diff --git a/id/server/doc/handbook/protocol/protocol.html b/id/server/doc/handbook/protocol/protocol.html index 2b3dbff98..dc55dda3b 100644 --- a/id/server/doc/handbook/protocol/protocol.html +++ b/id/server/doc/handbook/protocol/protocol.html @@ -123,12 +123,12 @@ Redirect Binding</td> <td><a href="#openid">OpenID Connect</a></td> <td>Authentifizierungsrequest <br> (AuthCode-Request)</td> - <td>https://<host>:<port>/moa-id-auth/oauth3/auth</td> + <td>https://<host>:<port>/moa-id-auth/oauth2/auth</td> </tr> <tr> <td><a href="#openid">OpenID Connect</a></td> <td><p>AccessToken-Request</p></td> - <td>https://<host>:<port>/moa-id-auth/oauth3/token</td> + <td>https://<host>:<port>/moa-id-auth/oauth2/token</td> </tr> <tr> <td><a href="#saml1">SAML 1</a></td> @@ -1320,8 +1320,8 @@ https://<host>:<port>/moa-id-auth/pvp2/metadata <h3><a name="openid_interface"></a>3.2 Zugangspunkte</h3> <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> <em>https://<host>:<port>/moa-id-auth/oauth3/auth</em><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> <em>https://<host>:<port>/moa-id-auth/oauth3/token</em><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> + <li><b>AuthCode-Request:</b> <em>https://<host>:<port>/moa-id-auth/oauth2/auth</em><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> <em>https://<host>:<port>/moa-id-auth/oauth2/token</em><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> <h3><a name="openid_requests"></a>3.3 Beschreibung der Nachrichten</h3> <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> @@ -1376,7 +1376,7 @@ Folgende Parameter müssen mit dem AuthCode-Request mitgesendet werden, wobe </table> <p> </p> <p>Nachfolgend ein Beispiel für einen OpenID Connect Authentifizierungsrequest an das Modul MOA-ID-Auth.</p> -<pre><form method="get" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth3/auth"> +<pre><form method="get" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth2/auth"> <input type="hidden" value="code" name="response_type"> <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo" name="client_id"> <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo/securearea.action" name="redirect_uri"> @@ -1442,7 +1442,7 @@ Folgende Parameter müssen mit dem AuthCode-Request mitgesendet werden, wobe </table> <p> </p> <p>Nachfolgend ein Beispiel für einen AccessToken Request</p> -<pre><form method="POST" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth3/token"> +<pre><form method="POST" action="https://demo.egiz.gv.at/demoportal_moaid-2.0/oauth2/token"> <input type="hidden" value="authorization_code" name="grant_type"> <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo" name="client_id"> <input type="hidden" value="https://demo.egiz.gv.at/demoportal-openID_demo/securearea.action" name="redirect_uri"> |