Wiki-Quellcode von Plugin Setup

Zeige letzte Bearbeiter
1 {{content depth="4"/}}
2
3 == Initiale Installation ==
4
5 Das **BürgerService Plugin** muss im System Bereich von {{formcycle/}} installiert werden (Menüpunkt: System > [[Systemplugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins||target="_blank"]]).
6 Es bietet aktuell die Anbindung an folgende Servicekonten:
7
8 * **BundID**
9 * **BayernID**
10 * **ELSTER** //Mein Unternehmenskonto//
11
12 == Migration bestehender Service-Konten-Anbindungen ==
13
14 Bestehende Anbindungen zu Service-Konten von **BundID**, **BayernID** und **ELSTER** werden bei der Installation des Plugins automatisch auf das neue Plugin umgestellt.
15 Die veralteten Plugins bleiben dabei auf dem System werden aber deaktiviert. Alle zuvor konfigurierten Anbindungen werden als Externe Benutzer im jeweiligen Bereich(System oder Mandant) definiert.
16 Designer-Vorlagen, die mit den veralteten Plugins in das System gekommen sind, werden entfernt.
17 \\**Migrations-Beispiel für BayernID Anbindung:**
18 Ausgangspunkt ist ein FORMCYCLE System mit mehreren Mandanten. In zwei Mandanten ist jeweils das// AKDB: Bürgerkonto-Service-Plugin //(Anbindung an **BayernID**) installiert.
19 Einer der **BayernID **Mandanten hat die Einbindung des Bürgerkonto Logins als Externer Benutzer konfiguriert.
20
21 Nachdem das** BürgerService Plugin** im [[System Bereich>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins||target="_blank"]] installiert wurde ergibt sich folgendes Bild:
22
23 * Die veralteten //AKDB: Bürgerkonto-Service-Plugins// in den jeweiligen Mandanten sind deaktiviert, aber noch vorhanden.
24 * In beiden Mandanten mit **BayernID **Anbindung befindet sich jetzt ein Externer Benutzer, welcher zukünftig die Authentifizierung mit dem **BayernID**-Portal realisiert.
25 In einem Mandanten wurde dazu im Zuge der Migration der Externe Benutzer neu angelegt. In dem Mandanten, wo bereits ein Externer Benutzer bestand, wurde dieser um notwendige Daten (Zertifikate zur Kommunikation, Anbindungsdaten für den Postkorb-Schnittstelle) erweitert, sodass er auch weiterhin in den bereits bestehenden Formularanbindungen genutzt werden kann.
26 * Der Menüpunkt //AKDB Setup// ist in den Mandanten nicht mehr vorhanden. Die Einstellungen, welche den Postkorb betreffen (z.B.: Zertifikat für Postkorb-Kommunikation) sind jetzt direkt am neu erstellten bzw. migrierten Externen Benutzer zu finden.
27 * Alte Designer-Vorlagen für die Anzeige der Bürgerkonto-Daten wurden durch neue Vorlagen ersetzt.
28 * Die Formulare welche bisher die **BayernID** über den Login-Button eingebunden hatten müssen nicht angepasst werden. Bei Nutzung des Login-Buttons, sowie der Postkorb-Aktion im Workflow erfolgt eine automatische Weiterleitung  an die durch das **BürgerService Plugin** bereitgestellte Funktionalität.
29
30 {{info}}
31 Hinweis: Es werden nur fertig konfigurierte **BayernID **Anbindungen migriert. Ist nur das Plugin im Mandaten vorhanden ist, sind aber keine Einstellungen zur Anbindung (Keystore, EntityID etc.) konfiguriert, kann keine Migration in einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] erfolgen.
32 {{/info}}
33
34
35 **Migration für BundID Anbindung:**
36 Bei bestehenden **BundID** Anbindungen werden die vorhandenen Externen Benutzer mit der neuen Konfigurationseinstellungen erweitert. Vorhandene Formulare mit BundID Anbindung, können ähnlich, wie bei der BayernId ohne Anpassung genutzt werden. 
37
38 == Konfiguration neuer Servicekonto Anbindungen ==
39
40 Neue Anbindungen an Servicekonten müssen im {{formcycle/}} System als [[Externe Benutzer>>doc:Formcycle.SystemSettings.UserInterface.ExternalUsers.WebHome]] (auch als Authentikatoren bezeichnet) angelegt werden. Dabei ist es möglich diese im System- als auch im Bereich des Mandanten anzulegen.
41 Folgende Überlegungen sollten für eine Entscheidung des Bereichs, in welchem die Externen Benutzer angelegt werden, herangezogen werden.
42
43 **Ist ein Multi-Mandanten {{formcycle/}} System mit unterschiedlichen Host-Adressen für die Ansteuerung der Formulare in den einzelnen Mandanten vorhanden (meist realisiert über Anbindung mehrerer Frontend-Server)?**
44
45 In diesem Fall sollte jeweils im Mandanten ein Externer Benutzer angelegt werden, welcher die Anbindung an des Servicekonto realisiert. Die aktuellen Anbindungen an die **BundID**, die **BayernID **sowie an das **ELSTER**-Portal arbeiten alle auf Grundlage des [[SAML 2.0>>https://en.wikipedia.org/wiki/SAML_2.0||rel="noopener noreferrer" target="_blank"]] - Protokolls. Eine Festlegung bei der Kommunikation über das SAML Protokoll ist es, dass im Vorfeld zwischen dem jeweiligen Identity Provider und dem Service Provider (FORMCYCLE) Metadaten ausgetauscht werden müssen, wo die Rücksprungziele in das jeweils andere System (per URL) fest definiert sind. Durch das Anlegen des Externen Benutzers im Bereich des jeweiligen Mandanten kann hier eine saubere Trennung und damit auch Nutzung in den Formularen stattfinden.
46 Legt man bei dieser Systemkonstellation die verschiedenen Externen Benutzer im System - Bereich an, so muss der Formularentwickler dann innerhalb des Formular die für seinen Mandanten korrekte Anbindung auswählen, was eine potenzielle Fehlerquelle sein kann.
47
48 **Ist ein Multi-Mandanten- oder ein Single-Mandat- {{formcycle/}} System mit einer Host-Adresse für die Ansteuerung der Formulare vorhanden?**
49
50 Hier sollten alle Externen Benutzer für die Servicekonten-Ansteuerung im System-Bereich angelegt werden. Der Vorteil ist an dieser Stelle, dass alle Anbindungen zentral an einer Stelle vorhanden sind und alle Formular-Benutzer in den verschiedenen Mandanten Zugriff auf diese erhalten.
51
52 === Anbindung eines Servicekontos ===
53
54 {{figure image="extUser_selection.png"}}
55 Auswahl eines Servicekontos
56 {{/figure}}
57
58 In diesem Abschnitt werden die allgemeinen Schritte, welche für die Anbindung der unterschiedlichen Servicekonten notwendig sind, erläutert.
59
60 Bevor man ein Servicekonto anbindet sollten folgende Voraussetzungen erfüllt sein:
61
62 * Die im Unternehmen verantwortlichen technischen und organisatorischen Ansprechpartner müssen bekannt sein (Namen, E-Mail-Adressen). Diese Informationen werden innerhalb des Registrierungs-Prozesses für die einzelnen Servicekonten an unterschiedlichen Stellen benötigt.
63 * URLs für die Anbindung des FORMCYCLE-Systems müssen eingerichtet und **von außen erreichbar** sein. Dabei ist zu beachten, dass bei Verwendung eines Frontend-Servers die URL zu diesem verwendet wird.
64
65 Die Anbindung eines Servicekontos lässt sich allgemein in folgende Schritte gliedern:
66
67 1. Anlegen einen neuen Externen Benutzer (Authentikator) unter dem Menüpunkt System > [[Systemplugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins||target="_blank"]] oder Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins||target="_blank"]].
68 1. Spezifische Authentikator Konfiguration über die zur Verfügung gestellte Oberfläche ausführen. Die Konfigurationsoberfläche unterscheidet sich je nach ausgewählten Servicekonto. Auf die Unterschiede bei der Anbindung des jeweiligen Servicekonto-Typs wird in den nachfolgenden Abschnitten näher eingegangen.
69 1. Download und Weiterleitung der festgelegten Konfigurationsdaten (Metadaten), sowie der Vertragsdaten an den jeweiligen Identity Provider (**BundID**, **BayernID**) bzw.
70 selbst durchzuführende Konfiguration auf Seiten des Identity Providers über ein Self-Service Portal (ELSTER)
71 1. Freigabe des Authentikators in {{formcycle/}}, nach erfolgter Rückmeldung über die erfolgte Registrierung der Metadaten durch den jeweiligen Identity Provider bzw. Freigabe durch Prüfungsinstanz (bei ELSTER Self Service Portal Registrierung) und damit Beginn der Einbindung des Servicekontos in Formulare
72
73 === Details zur Anbindung BundID ===
74
75 === Details zur Anbindung ELSTER //Mein Unternehmenskonto// ===
76
77 === Details zur Anbindung BayernID ===
78
79 Um das Servicekonto der **BayernID** anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp **BayernID** auszuwählen.
80
81 ==== Schritt 1: Konfiguration anlegen ====
82
83 {{figure image="bayernID_config1.png"}}
84 Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen
85 {{/figure}}
86
87 * Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen:
88 ** Festlegung, ob Test- oder Live-Umgebung der **BayernID** anzubinden ist.
89 ** Erhebung von Zertifikatsinformationen, welche anschließend zur Generierung eines privaten und öffentlichen Schlüssels herangezogen werden. Dieses Schlüsselpaar dient zur Ver- und Entschlüssung der Kommunikation, zwischen {{formcycle/}} und der **BayernID**.
90 ** Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das **BayernID**-Portal weitergegeben.
91 * Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung.
92
93 ==== Schritt 2: Metadaten erzeugen und registrieren ====
94
95 {{figure image="bayernID_config2.png"}}
96 Schritt 2 und 3: Download der erzeugten Meta- und vorbefüllten Vertragsdaten für eine jeweiligen Host-Adresse; Aktivierung der BayernID Authentifizierung für Formulare
97 {{/figure}}
98
99 * In diesem Schritt werden die SAML-Metadaten für die Registrierung auf Seiten der **BayernID **erzeugt. Dafür steht in der Oberfläche ein Button mit Auswahlfeld zur Verfügung. Das Auswahlfeld enthält alle im {{formcycle/}} System gefundenen Host-Adressen, über die das System erreichbar ist. Auf der Grundlage der jeweiligen Host-Adresse werden dann die Metadaten erzeugt und als Download zurück geliefert. Die jeweilige Host-Adresse bildet dabei einen Teil der Rücksprung-URL, welche später vom Identity Provider (BayernID) zur Übermittlung der Authentifizierungsdaten genutzt wird.
100 Hinweis: Soll der BayernID-Login über unterschiedliche Host-Adressen erreichbar sein, so muss für jeden Host die Metadaten-Datei erzeugt und an das **BayernID**-Portal zur Registrierung übermittelt werden.(((
101 {{info}}
102 Hinweis: Soll der BayernID-Login über unterschiedliche Host-Adressen erreichbar sein,
103 so muss für jeden Host die Metadaten-Datei erzeugt und an das BayernID-Portal zur Registrierung übermittelt werden.
104 {{/info}}
105 )))
106 * Weiterhin kann eine vorbefüllte Beitrittserklärung für den jeweiligen Host heruntergeladen werden. Die Beitrittserklärung ist bereits mit den im vorherigen Schritt erhobenen Daten vorbefüllt und muss um die noch fehlenden Daten ergänzt werden.
107 * **Beitrittserklärung** und **SAML-Metadaten** sind an das **BayernID** Portal (Mail: **BayernID@akdb.de**) zu senden, mit der Bitte, um Aufnahme in den Portalverbund.
108 * Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom **BayernID** Portal muss abgewartet werden.
109
110 ==== Schritt 3: BayernID-Login Aktivierung ====
111
112 {{figure image="bayernID_config3.png"}}
113 BayernID Postkorbanbindung konfigurieren
114 {{/figure}}
115
116 * Dieser Schritt sollte erst durchgeführt werden, wenn Sie vom BayernID Portal Rückmeldung erhalten haben, dass ihre übermittelten Metadaten im Portal registriert und freigegeben sind. Erst mit dem Button //BayernId-Login aktivieren// wird der Authentikator im System aktiviert. Er ist damit in den Formularen verfügbar und kann eingebunden werden.(((
117 {{info}}
118 Hinweis: Wenn Sie den Login **vor** einer positiven Rückmeldung des BayernID-Portals aktivieren,
119 so kann das die BayernID zwar bereits in den Formularen eingebunden werden,
120 wird aber beim Aufruf in einem Fehler resultieren,
121 dass der anfragende Service dem Portal nicht bekannt ist.
122 {{/info}}
123 )))
124 * Nach Aktivierung des Logins erscheint erweitert sich die Konfigurationsoberfläche des Authentikators.
125 Unter dem Punkt //Erweiterte Einstellungen// > //Konfigurtion BayernID Postkorbanbindung// kann