Wiki-Quellcode von BundID
Version 20.1 von MACH ProForms GmbH am 20.08.2024
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | Die BundID-Funktionalitäten stehen ab dem Release 4.92 zur Verfügung. | ||
2 | |||
3 | In der Praxis können mehrere Architektur-Varianten für die Anbindung der MACH formsolutions an die BundID vorkommen. | ||
4 | |||
5 | |||
6 | **Variante 1** - Anbindung an BundID direkt über die Software | ||
7 | |||
8 | [[image:Schaubild1.png||alt="Schaubild1" height="167" width="726"]] | ||
9 | |||
10 | |||
11 | **Variante 2** - Anbindung an BundID über die vorgelagerte Einstiegsseite | ||
12 | |||
13 | [[image:Schaubild2.png||alt="Schaubild2" height="192" width="733"]] | ||
14 | |||
15 | |||
16 | **Variante 3** - Anbindung an BundID direkt über die Software ohne Einstiegsseite | ||
17 | |||
18 | [[image:Schaubild3 (3).png||alt="Schaubild3" height="239" width="735"]] | ||
19 | |||
20 | |||
21 | Für die Variante 1 und 3 sind einige Einstellungen in der Modulkonfiguration des Mandanten zu treffen. | ||
22 | |||
23 | Im Falle der Variante 2 können die Daten über die [[SecurePostData Schnittstelle>>doc:Main.03_Steuerungsprozess.02_Vorbefüllung.02_SecurePostdata.WebHome]] direkt in den Assistenten übergeben werden. | ||
24 | |||
25 | |||
26 | === Einstellungen in der Modulkonfiguration === | ||
27 | |||
28 | Die folgenden Einstellungen gelten nur für die Variante 1 oder 3. | ||
29 | |||
30 | Wir empfehlen die Nutzung des Browser **Chrome oder Edge **bei der Einstellung der Modulkonfiguration. Firefox stellt auf Grund eines sehr alten Bugs die XML Datei teils falsch dar. | ||
31 | |||
32 | === Keystore generieren === | ||
33 | |||
34 | Den Keystore kann man per CLI generieren, wenn ein JDK auf dem Rechner vorhanden ist. | ||
35 | |||
36 | Folgender Befehl muss in der Konsole/Terminal ausgeführt werden: | ||
37 | |||
38 | $keytool -genkeypair -alias <ALIAS> -keyalg RSA -storetype jks -keysize 4096 -validity 730 -keystore <PFAD>\<ALIAS>.jks | ||
39 | \\Der Pfad steht für die Location an der der Keystore gespeichert werden soll. Der Alias ist gleichzusetzen mit dem Namen der Kommune, bspw. "NewYorkCity". | ||
40 | In der Konsole werden Sie nach Ihrem Passwort und einigen Details zur Organisation nach folgendem Schemata gefragt. Notieren Sie sich das Passwort, | ||
41 | dass Sie selber aussuchen, separat. Das Passwort wird in den nächsten Schritten benötigt: | ||
42 | |||
43 | |||
44 | Enter keystore password: | ||
45 | Re-enter new password: | ||
46 | |||
47 | What is your first and last name? | ||
48 | Unknown: | ||
49 | What is the name of your organizational unit? | ||
50 | Unknown: | ||
51 | What is the name of your organization? | ||
52 | Unknown: | ||
53 | What is the name of your City or Locality? | ||
54 | Unknown: | ||
55 | What is the name of your State or Province? | ||
56 | Unknown: | ||
57 | What is the two-letter country code for this unit? | ||
58 | Unknown: | ||
59 | Is CN=Unknown, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown correct? | ||
60 | no: yes | ||
61 | |||
62 | Enter key password for <alias> | ||
63 | (RETURN if same as keystore password): | ||
64 | |||
65 | |||
66 | Für die folgenden Schritte benötigt der Mandant, für den die Einstellungen zu treffen sind, das Mandantenrecht eID. | ||
67 | |||
68 | Einstellungen für das Bürgerportal: | ||
69 | |||
70 | Unter dem Reiter Login-Anbieter/ Bürgerportal der Modulkonfiguration finden Sie die Seite, auf der die Einstellungen für die Anbindung der BundID vorzunehmen sind. | ||
71 | |||
72 | [[image:Bürgerportal Schaubild.png||alt="Schaubild Buergerportal" height="494" width="720"]] | ||
73 | |||
74 | |||
75 | Die vorher generierte Keystore Datei muss für den jeweiligen Mandanten hochgeladen werden. Das Passwort der Keystore Datei sowie der KeyStore Alias müssen angegeben werden. | ||
76 | |||
77 | Beim EntityID-Format "URL" auswählen. Die Option "Authentifizierungs-Anfrage signieren" muss auf "Ja" stehen. | ||
78 | |||
79 | (% class="box warningmessage" %) | ||
80 | ((( | ||
81 | **Der Keystoredateiupload und die Auswahl der EntityID "URL" müssen explizit durch Speichern an den Server übertragen werden.** | ||
82 | ))) | ||
83 | |||
84 | Es erscheint der grüne Balken mit dem Hinweis "Es wurde bereits eine Keystore-Datei hinterlegt." | ||
85 | Anschließend können Sie die "Service-Provider-Metadaten für BundID" herunterladen: | ||
86 | |||
87 | [[image:Portale.png||alt="Schaubild Portale" height="409" width="712"]] | ||
88 | |||
89 | |||
90 | Bei der Auswahl der Portalanbieter stehen Ihnen das AKDB-Bürgerportal, das BundID-Bürgerportal sowie das OSI-Bürgerportal zur Verfügung. Sollten Sie schon ein Portal ausgewählt haben, benötigen jedoch für die Anbindung des neuen Bürgerportals eine andere Service-Provider-Metadaten Datei, können Sie diese durch Anklicken des Links jederzeit generieren. Für die Anbindung an BundID generieren Sie die "**Service-Provider-Metadaten für BundID**". Es öffnet sich eine neue Seite, deren Inhalte in eine XML-Datei gespeichert werden muss. Diese Datei ist notwendig zur Weiterleitung an den Mandanten beziehungsweise das Bundesministerium des Innern. Nur auf Basis der Kenntnis der Inhalte dieser XML-Datei ist es möglich, dass die BundID-Systeme mit der MACH formsolutions Plattform kommunizieren können. | ||
91 | |||
92 | |||
93 | Beim "SAML-Identity-Provider" laden Sie die Identity Provider XML-Datei hoch. Für jedes Portal ist diese unterschiedlich. Nach erfolgreicher Freigabe durch das BMI und der Einpflege der IDP-XML ist die Anbindung komplett. | ||
94 | |||
95 | Identity Provider XML-Datei für Testumgebung: [[idp.xml>>https://cloud.machproforms.de/index.php/s/E3aotLNafQPeRmc]] | ||
96 | |||
97 | Identity Provider XML-Datei für die Produktivumgebung: [[idp_prod.xml>>https://cloud.machproforms.de/index.php/s/P5tNDtQkyDc4QGY]] | ||
98 | |||
99 | (% class="box warningmessage" %) | ||
100 | ((( | ||
101 | Damit die Einstellungen im Reiter Bürgerportal aktiv werden, müssen Ihre Eingaben **explizit **gespeichert werden. | ||
102 | ))) | ||
103 | |||
104 | |||
105 | === Überprüfung der Metadaten für die BundID === | ||
106 | |||
107 | ==== EntityID Prüfung ==== | ||
108 | |||
109 | Kontrollieren Sie mit einem Texteditor, dass in der XML-Datei der Service-Provider-Metadaten die EntityID im Format ##"https:~/~/(Formularserveradresse)" angegeben ist.## | ||
110 | |||
111 | Beispiel: | ||
112 | |||
113 | {{code language="xml"}} | ||
114 | <md:EntityDescriptor entityID="https://pdf.form-solutions.net/00000000-0000/sso" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"> | ||
115 | {{/code}} | ||
116 | |||
117 | (% class="wikigeneratedid" %) | ||
118 | Sollte hier stattdessen die Adresse im Format "##entityID="urn:pdf.form-solutions.de:00000000-0000:sso"## stehen, generieren Sie die Service-Provider-Metadaten neu. Achten Sie dabei darauf, zwischen dem Konfigurieren und dem Herunterladen der Metadaten zu speichern. | ||
119 | |||
120 | |||
121 | ==== Validierungstool ==== | ||
122 | |||
123 | Die Metadaten können Sie dies mit Hilfe dieses Tools validieren: | ||
124 | |||
125 | [[https:~~/~~/www.samltool.com/validate_xml.php>>url:https://www.samltool.com/validate_xml.php]] | ||
126 | |||
127 | Wählen Sie dabei XSD (schema file) für Metadata aus und kopieren Sie die Inhalte der XML in das angegebene Feld. |