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