Wiki-Quellcode von BundID
Version 24.9 von MACH ProForms GmbH am 03.03.2025
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | Die BundID-Funktionalitäten stehen ab dem Release 4.92 zur Verfügung. | ||
2 | |||
3 | == Architektur-Varianten == | ||
4 | |||
5 | Es sind drei Architektur-Varianten der Anbindung von MACH formsolutions an die BundID möglich. | ||
6 | |||
7 | Für die Variante 1 und 3 sind Einstellungen in der Modulkonfiguration des Mandanten zu treffen. | ||
8 | |||
9 | Bei 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. | ||
10 | |||
11 | |||
12 | **Variante 1** - Anbindung an BundID direkt über die Software | ||
13 | |||
14 | [[image:Schaubild1.png||alt="Schaubild1" height="167" width="726"]] | ||
15 | |||
16 | |||
17 | **Variante 2** - Anbindung an BundID über die vorgelagerte Einstiegsseite | ||
18 | |||
19 | [[image:Schaubild2.png||alt="Schaubild2" height="192" width="733"]] | ||
20 | |||
21 | |||
22 | **Variante 3** - Anbindung an BundID direkt über die Software ohne Einstiegsseite | ||
23 | |||
24 | [[image:Schaubild3 (3).png||alt="Schaubild3" height="239" width="735"]] | ||
25 | |||
26 | |||
27 | |||
28 | === Anbindung des Mandanten === | ||
29 | |||
30 | Die Konfiguration für die Varianten 1 und 3 ist in der Anwenderdokumentation BundID beschrieben. | ||
31 | |||
32 | |||
33 | 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. | ||
34 | |||
35 | === Keystore generieren === | ||
36 | |||
37 | Den Keystore kann man per CLI generieren, wenn ein JDK auf dem Rechner vorhanden ist. | ||
38 | |||
39 | Folgender Befehl muss in der Konsole/Terminal ausgeführt werden: | ||
40 | |||
41 | $keytool -genkeypair -alias <ALIAS> -keyalg RSA -storetype jks -keysize 4096 -validity 730 -keystore <PFAD>\<ALIAS>.jks | ||
42 | \\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". | ||
43 | In der Konsole werden Sie nach Ihrem Passwort und einigen Details zur Organisation nach folgendem Schemata gefragt. Notieren Sie sich das Passwort, | ||
44 | dass Sie selber aussuchen, separat. Das Passwort wird in den nächsten Schritten benötigt: | ||
45 | |||
46 | |||
47 | Enter keystore password: | ||
48 | Re-enter new password: | ||
49 | |||
50 | What is your first and last name? | ||
51 | Unknown: | ||
52 | What is the name of your organizational unit? | ||
53 | Unknown: | ||
54 | What is the name of your organization? | ||
55 | Unknown: | ||
56 | What is the name of your City or Locality? | ||
57 | Unknown: | ||
58 | What is the name of your State or Province? | ||
59 | Unknown: | ||
60 | What is the two-letter country code for this unit? | ||
61 | Unknown: | ||
62 | Is CN=Unknown, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown correct? | ||
63 | no: yes | ||
64 | |||
65 | Enter key password for <alias> | ||
66 | (RETURN if same as keystore password): | ||
67 | |||
68 | |||
69 | Für die folgenden Schritte benötigt der Mandant, für den die Einstellungen zu treffen sind, das Mandantenrecht eID. | ||
70 | |||
71 | Einstellungen für das Bürgerportal: | ||
72 | |||
73 | 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. | ||
74 | |||
75 | [[image:1736859216979-481.png]] | ||
76 | |||
77 | |||
78 | [[image:1736859277992-433.png]] | ||
79 | |||
80 | |||
81 | 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. | ||
82 | |||
83 | Beim EntityID-Format "URL" auswählen. Die Option "Authentifizierungs-Anfrage signieren" muss auf "Ja" stehen. | ||
84 | |||
85 | (% class="box warningmessage" %) | ||
86 | ((( | ||
87 | **Der Keystoredateiupload und die Auswahl der EntityID "URL" müssen explizit durch Speichern an den Server übertragen werden.** | ||
88 | ))) | ||
89 | |||
90 | Es erscheint der grüne Balken mit dem Hinweis "Es wurde bereits eine Keystore-Datei hinterlegt." | ||
91 | Anschließend können Sie die "Service-Provider-Metadaten für BundID" herunterladen: | ||
92 | |||
93 | |||
94 | Bei der Auswahl der Portalanbieter stehen Ihnen das AKDB-Bürgerportal, das BundID-Bürgerportal, Mein UnternehmensKonto, 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. | ||
95 | |||
96 | |||
97 | 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. | ||
98 | |||
99 | Identity Provider XML-Datei für Testumgebung: [[idp.xml>>https://cloud.machproforms.de/index.php/s/E3aotLNafQPeRmc]] | ||
100 | |||
101 | Identity Provider XML-Datei für die Produktivumgebung: [[idp_prod.xml>>https://cloud.machproforms.de/index.php/s/P5tNDtQkyDc4QGY]] | ||
102 | |||
103 | (% class="box warningmessage" %) | ||
104 | ((( | ||
105 | Damit die Einstellungen im Reiter Bürgerportal aktiv werden, müssen Ihre Eingaben **explizit **gespeichert werden. | ||
106 | ))) | ||
107 | |||
108 | |||
109 | === Überprüfung der Metadaten für die BundID === | ||
110 | |||
111 | ==== EntityID Prüfung ==== | ||
112 | |||
113 | Kontrollieren Sie mit einem Texteditor, dass in der XML-Datei der Service-Provider-Metadaten die EntityID im Format ##"https:~/~/(Formularserveradresse)" angegeben ist.## | ||
114 | |||
115 | Beispiel: | ||
116 | |||
117 | {{code language="xml"}} | ||
118 | <md:EntityDescriptor entityID="https://pdf.form-solutions.net/00000000-0000/sso" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"> | ||
119 | {{/code}} | ||
120 | |||
121 | (% class="wikigeneratedid" %) | ||
122 | 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. | ||
123 | |||
124 | |||
125 | ==== Validierungstool ==== | ||
126 | |||
127 | Die Metadaten können Sie mit Hilfe dieses Tools validieren: | ||
128 | |||
129 | [[https:~~/~~/www.samltool.com/validate_xml.php>>url:https://www.samltool.com/validate_xml.php]] | ||
130 | |||
131 | Wählen Sie dabei XSD (schema file) für Metadata aus und kopieren Sie die Inhalte der XML in das angegebene Feld. |