Änderungen von Dokument Digitale Mitgliederverwaltung

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
  • Confluence.Code.ConfluencePageClass[0]

Details

Seiteneigenschaften

Inhalt

...	...	@@ -78,7 +78,7 @@
78	78	)))|=(% scope="col" %)(((
79	79	Prozess heute
80	80	)))|=(% scope="col" %)(((
81		-Prozess Zukunft
	81	+Notwendige Änderungen
82	82	)))
83	83	|(((
84	84	Mitgliedsantrag
...	...	@@ -92,7 +92,7 @@
92	92	* Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn
93	93	* Mitgliederakte wird angelegt, der Antrag wird in der Akte abgeheftet
94	94	)))|(((
95		-Der Antrag kann komplett **digital unterschrieben** werden. Vorgehen:
	95	+Der Antrag soll komplett **digital unterschrieben** werden. Vorgehen:
96	96
97	97	* Interessent:in füllt den Online-Antrag auf der Homepage aus
98	98	* Nach Bestätigung der E-Mail Adresse wird ein Vorgang zur digitalen Unterschrift ausgelöst
...	...	@@ -163,11 +163,7 @@
163	163	Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird.
164	164	Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde.
165	165	)))|(((
166		-**Vollständig digital**.
167		-
168		-* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
169		-* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
170		-* Nach Unterschrift wird das Flag automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen.
	166	+**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter.
171	171	)))
172	172	|(((
173	173	Übungsleitervertrag
...	...	@@ -181,12 +181,9 @@
181	181	* Bestätigung dass der Vertrag vorliegt
182	182	* Ein Flag ob das Mitglied die Übungsleiterpauschale an den Verein spendet oder nicht
183	183	)))|(((
184		-**Vollständig digital**.
	180	+**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter.
185	185
186		-* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
187		-* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
188		-* Nach Unterschrift wird das erste automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen.
189		-* Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht.
	182	+Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht.
190	190	)))
191	191	|(((
192	192	Nutzungsvereinbarung Schulungsinhalte
...	...	@@ -197,7 +197,7 @@
197	197
198	198	Urheberrecht, Übertragung von Nutzungsrechten sollte in Schriftform erfolgen
199	199	)))|(((
200		-Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner Einscannen und in Paperless dem Mitglied zuweisen.
	193	+Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner einscannen und in Paperless dem Mitglied zuweisen.
201	201	)))
202	202	|(((
203	203	Bestellung eines Einweisers
...	...	@@ -258,7 +258,7 @@
258	258	** Muss für den Einweisenden eine Auszahlung veranlasst werden?
259	259	* Danach wird der Zettel in die jeweiligen Akten einsortiert.
260	260	)))|(((
261		-\\
	254	+Der Einweisungszettel ist das bei weitem komplizierteste Dokument, hierfür wird ein separater Workshop stattfinden. Siehe weiter unten für Details.
262	262	)))
263	263	|(((
264	264	Lagervertrag Kistenlager
...	...	@@ -272,7 +272,7 @@
272	272
273	273	Nach Erfassen kann die Person eine Kiste beantragen, die dann monatliche Kosten auslöst
274	274	)))|(((
275		-\\
	268	+**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
276	276	)))
277	277	|(((
278	278	Lagervertrag Projektlager
...	...	@@ -286,7 +286,7 @@
286	286
287	287	Nach Erfassen kann die Person das Projektlager automatisch nutzen.
288	288	)))|(((
289		-\\
	282	+**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
290	290	)))
291	291
292	292	== {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung ==
...	...	@@ -813,55 +813,230 @@
813	813
814	814	Paperless unterstützt die automatische Zuordnung von Metadaten basierend auf festen Strings. So kann man beispielsweise angeben, dass ein Dokumententyp "Haftungsausschluss" zugewiesen werden soll, wenn der String "Haftungsausschluss" irgendwo im Dokument vorkommt. Dies ist allerdings auf eine korrekte Funktion der Texterkennung angewiesen und funktioniert erfahrungsgemäß nur in manchen Fällen, sodass mindestens eine manuelle Überprüfung trotzdem notwendig kommt. Wenn beispielsweise ein Brief mit dem Satz "ich dachte, ich hätte den Haftungsausschluss bereits abgegeben, könntet ihr dies bitte prüfen" erfasst wird, würde der basierend auf der Regel ebenfalls kategorisiert werden.
815	815
816		-Aus diesem Grund nutzen wir einen speziellen QR Code in einem für den Makerspace spezifischen Format, welches nachstehend detailliert beschrieben wird.
	809	+**Aus diesem Grund wird auf jedes Dokument einen spezieller QR Code aufgedruckt**. Der QR code wird vom Post-Consume Script verwendet um die Metadaten in Paperless zuzuordnen. Weiterhin können Daten übermittelt werden, die dann mittels Webhook an N8n übermittelt werden und dort im Workflow verwendet werden können. Der Aufbau orientiert sich an dem Aufbau eines **JSON Web Tokens (JWT).**
817	817
818		-{{code language="json"}}
819		-{
820		- "payload": {
821		-        "timestamp": "YYYY-MM-DDTHH:mm:ss",
822		- "uuid": "260171c3-c71c-4da2-b13e-bf1386fe9eac",
823		- "correspondent": "Daniel Herrmann (#250)",
824		- "type": "mksp-doc-sepamandat",
825		- "tags": [
826		- "tag1",
827		- "tag2"
828		- ],
829		-"storage_path": "Mitgliederverwaltung"
830		- },
831		- "sig": "signature over the entire payload block"
832		-}
833		-{{/code}}
	811	+=== {{id name="DigitaleMitgliederverwaltung-Barcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) ===
834	834
835		-Die beiden Einträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload müssen der **timestamp** **und die UUID** **vorhanden** sein, alle anderen Felder sind optional, jedoch muss mindestens eins angegeben werden. Der QR Code kann dann - insbesondere bei der Digitalen Unterschrift oder bei Workflows, wo die Formulare ohnehin on demand erzeugt werden bereits mit allen Daten bestückt werden. In Paperless gibt es dann ein Postconsume Script, welches den QR Code ausliest, die Signatur prüft und - falls die Signatur korrekt ist - automatisch die Meta-Daten übernimmt.
	813	+(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
836	836
837		-=== {{id name="DigitaleMitgliederverwaltung-Signatur"/}}Signatur ===
	815	+* **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden.
	816	+* JWT erzeugen und signieren. der JWT besteht aus drei Teilen:
	817	+** **Header**: **alg** (Algorithmus) und **typ** (JWT) sind verpflichtend. Zusätzlich fügen wir einen Timestamp, eine eindeutige ID und eine Gültigkeitsdauer hinzu.
	818	+** **Body**: beinhaltet die eigentlichen Daten.
	819	+** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt.
	820	+* PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden.
838	838
839		-Die Signatur wird kryptographisch mit Hilfe asymmetrischen Verschlüsselung erzeugt. Wir erzeugen ein RSA 2048 Key Pair. Der öffentliche Schlüssel steht Paperless zur Verfügung, sodass Paperless die Signaturen verifizieren kann. Der private Teil des Schlüssels wird von den Makerspace-Systemem verwendet, welche die Formulare erzeugen. Im Detail:
	822	+=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header ===
840	840
841		-* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent
842		-* **Signatur**: SHA256 Signatur, PKCS1v15 Padding
843		-* (((
844		-**Payload**: Als Payload wird nur der Inhalt der Payload verwendet, als **JSON String ohne Whitespaces, byte encoded in UTF-8.** Das oben genannte Beispiel würde die Signatur über den folgenden String erstellen:
845		-\\
	824	+Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ.
846	846
847		-{{code language="json"}}
848		-{"payload":{"correspondent":"Daniel Herrmann (#250)","type":"SEPA Mandat","tags":["tag1","tag2"]},"timestamp":"YYYY-MM-DDTHH:mm:ss","sig":"this-would-be-the-signature-appended-to-the-data"}
849		-{{/code}}
	826	+=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body ===
850	850
	828	+Die folgenden Claims sind im Body verfügbar:
851	851
852		-Als Referenz, die in Python wäre der Input der Signatur:
853		-\\
	830	+(% class="" %)|=(((
	831	+Claim
	832	+)))|=(((
	833	+Type
	834	+)))|=(((
	835	+Pflicht
	836	+)))|=(((
	837	+Beschreibung
	838	+)))
	839	+|(((
	840	+id
	841	+)))|(((
	842	+UUID4
	843	+)))|(((
	844	+✅️
	845	+)))|(((
	846	+Eindeutige ID dieses Dokuments
	847	+)))
	848	+|(((
	849	+time
	850	+)))|(((
	851	+Zahl
	852	+)))|(((
	853	+✅️
	854	+)))|(((
	855	+UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden
	856	+)))
	857	+|(((
	858	+exp
	859	+)))|(((
	860	+Zahl
	861	+)))|(((
	862	+✅️
	863	+)))|(((
	864	+UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist.
	865	+)))
	866	+(% class="" %)|(((
	867	+(% class="code" %)
	868	+(((
	869	+typ
	870	+)))
	871	+)))|(((
	872	+String
	873	+)))|(((
	874	+✅️
	875	+)))|(((
	876	+Typ des Dokuments basierend auf der unten definierten Liste.
	877	+)))
	878	+(% class="" %)|(((
	879	+(% class="code" %)
	880	+(((
	881	+cor
	882	+)))
	883	+)))|(((
	884	+String
	885	+)))|(((
	886	+❌️
	887	+)))|(((
	888	+Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll
	889	+)))
	890	+(% class="" %)|(((
	891	+tags
	892	+)))|(((
	893	+List[String]
	894	+)))|(((
	895	+❌️
	896	+)))|(((
	897	+Liste an Tags, die dem Dokument zugeordnet werden soll
	898	+)))
	899	+|(((
	900	+spth
	901	+)))|(((
	902	+String
	903	+)))|(((
	904	+❌️
	905	+)))|(((
	906	+Storage Path, das dem Dokument zugeordnet werden soll
	907	+)))
	908	+|(((
	909	+opt
	910	+)))|(((
	911	+dict
	912	+)))|(((
	913	+❌️
	914	+)))|(((
	915	+Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden.
	916	+)))
854	854
855		-{{code language="python"}}
856		-import json
	918	+=== {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer ===
857	857
858		-input_data = {'payload': {'correspondent': 'Daniel Herrmann (#250)', 'type': 'SEPA Mandat', 'tags': ['tag1', 'tag2']}, 'timestamp': 'YYYY-MM-DDTHH:mm:ss', 'sig': 'this-would-be-the-signature-appended-to-the-data'}
859		-signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8')
860		-{{/code}}
	920	+Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur.
	921	+
	922	+{{confluence_tip title="Algorithmus"}}
	923	+Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher.
	924	+
	925	+Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus).
	926	+{{/confluence_tip}}
	927	+
	928	+=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library ===
	929	+
	930	+Die Implementierung für die Erzeugung und das Validieren erfolgt in Python. Dies hat den Hintergrund, dass sowohl unser Backend als auch Paperless NGX (und damit das Post-Consumption Script) in Python implementiert ist. Es gibt verschiedene Libraries, die betrachtet wurden:
	931	+
	932	+|=(% scope="col" %)(((
	933	+Name
	934	+)))|=(% scope="col" %)(((
	935	+CVE
	936	+)))|=(% scope="col" %)(((
	937	+Github
	938	+)))|=(% scope="col" %)(((
	939	+GH⭐
	940	+)))|=(% scope="col" %)(((
	941	+Letztes Release
	942	+)))|=(% scope="col" %)(((
	943	+Offene Issues
	944	+)))|=(% scope="col" %)(((
	945	+Dokumentation
	946	+)))|=(% scope="col" %)(((
	947	+Qualität Dokumentation
	948	+)))|=(% scope="col" %)(((
	949	+In Backend vorhanden?
	950	+)))|=(% scope="col" %)(((
	951	+In Paperless vorhanden?
861	861	)))
	953	+|(((
	954	+python-jose
	955	+)))|(((
	956	+3/0
	957	+)))|(((
	958	+[[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]]
	959	+)))|(((
	960	+1.7k
	961	+)))|(((
	962	+28.05.2025
	963	+)))|(((
	964	+83
	965	+)))|(((
	966	+[[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]]
	967	+)))|(((
	968	+⛔ Wenige Bespiele, API Dokumentation fehlt komplett
	969	+)))|(((
	970	+❌️
	971	+)))|(((
	972	+❌️
	973	+)))
	974	+|(((
	975	+pyJWT
	976	+)))|(((
	977	+4/0
	978	+)))|(((
	979	+[[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]]
	980	+)))|(((
	981	+5.4k
	982	+)))|(((
	983	+28.11.2024
	984	+)))|(((
	985	+30
	986	+)))|(((
	987	+[[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]]
	988	+)))|(((
	989	+➕️ Gute Dokumentation, API, Beispiele, Changelog
	990	+)))|(((
	991	+✅️ 2.10.1
	992	+Dep von firebase
	993	+)))|(((
	994	+✅️ 2.10.1
	995	+)))
	996	+|(((
	997	+JWCrypto
	998	+)))|(((
	999	+5/0
	1000	+)))|(((
	1001	+[[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]]
	1002	+)))|(((
	1003	+465
	1004	+)))|(((
	1005	+06.03.2024
	1006	+)))|(((
	1007	+8
	1008	+)))|(((
	1009	+[[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]]
	1010	+)))|(((
	1011	+➕️ API Doc, einige Beispiele
	1012	+)))|(((
	1013	+✅️ 1.5.6
	1014	+Dep von python-keycloak
	1015	+)))|(((
	1016	+❌️
	1017	+)))
862	862
863		-\\
	1019	+Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben.
864	864
	1021	+=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code ===
	1022	+
	1023	+Als Format für den Code wurde PDF417 ausgewählt, da dieser mehr Platz und Fehlerkorrektur bietet. Weiterhin gibt es eine einfach zu nutzende Library für Python (Erzeugung) und PDF417 wird von (% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)ZXING unterstützt, welches in Paperless eingebettet ist. Ein solcher Barcode sieht beispielsweise so aus:
	1024	+
	1025	+(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]]
	1026	+
	1027	+(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Daraus kann dann eine Base64 basierte Repräsentation berechnet werden, die einfach in Docuseal hochgeladen werden kann.
	1028	+
	1029	+=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung ===
	1030	+
	1031	+Eine Referenz-Implementierung befindet sich im Makerspace Gitlab: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/paperless-pdf417-reference>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/paperless-pdf417-reference||shape="rect"]]
	1032	+
865	865	== {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup ==
866	866
867	867	Owner: zwei Owner
...	...	@@ -870,46 +870,7 @@
870	870	Tag: owner = grp owner, view = jeweilige Gruppe, edit = it admin
871	871	Doc Type: owner = grp owner, view = jeweilige Gruppe, edit = it admin
872	872
873		-TODO
	1041	+= {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte =
874	874
875		-\\
876		-
877		-=== {{id name="DigitaleMitgliederverwaltung-AusFace2Faceam20.8(DH,YS)"/}}Aus Face 2 Face am 20.8  (DH,YS) ===
878		-
879		-* Schritt 1: Einweisungszettel erzeugen
880		-** Checkliste in Directus hinterlegen, eine pro Einweisung
881		-** N8n Workflow, welches die Liste aus Directus herunterlädt und Template mit Puppetteer Script Node erzeugen
882		-** Aus diesem Template dann ein DocuSeal Template erstellen
883		-* Schritt 2: Zettel für Einweisungen generieren
884		-** Tablet für Einweiser im makerspace
885		-** Authentifizierung über Token an der Freigabebox
886		-*** Neue Maschine, User schaltet die Maschine "Tablet" frei
887		-*** Datenbank erzeugt JWT und signiert es mit einem RSA Priv Key
888		-*** Wird als Payload in der MQTT unlock message mitgeschickt
889		-** Tablet nutzt dieses Token für API Requests gegen Homepage Backend
890		-** Backend wird um weitere Middleware angepasst, die dieses Token für manche Endpoints akzeptiert
891		-** Einweiser:in bekommt aktive Einweisung angezeigt und kann Teilnehmer Entfernern (no-show) oder hinzufügen (spontan)
892		-*** Option eine Einweisung ohne Rechnungsstellung vorzunehmen
893		-** PDFs werden automatisch ausgedruckt
894		-*** Tablet triggert einen Backend endpoint
895		-**** übergibt teilnehmer als parameter (auth über token) und
896		-**** erzeugt die entsprechenden PDFs in DocuSeal
897		-**** Gibt PDF als Return
898		-*** Tablet kann PDF über Netzwerk print drucken
899		-* Schritt 3: Einweisungen erfassen
900		-** QR code wird in Schritt 2 aufgedruckt und enthält:
901		-*** Einweisung
902		-*** Datum
903		-*** Einweiser
904		-*** Teilnehmer
905		-*** Flag Rechnung
906		-** Dokument wird über ScanSnap eingescannt und automatisch an paperless übergeben
907		-** Paperless Post Consume erkennt den QR Code, validiert ihn und löst über einen Webook einen Flow in N8n aus
908		-** N8n erstellt dann einen temporären Eintrag im Backend, ähnlich dem der heute bei "Einweisung erfassen" sichtbar ist
909		-** Die Mitgliederverwaltung hat dann x Tage Zeit, die Einträge zu korrigieren und zu prüfen (beispielsweise ob Voraussetzungen erfüllt sind)
910		-** Danach werden alle Schritte wie bisher ausgelöst (Berechtigung, Rechnung, Auszahlung an Einweiser, E-Mail Bestätigung, ...)
911		-
912		-TODO:
913		-
914	914	* Docuseal Logging + Monitoring
915	915	* N8n Error Handling

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-202867277
	1	+205586461

URL

...	...	@@ -1,1 +1,1 @@
1		-https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867277/Digitale Mitgliederverwaltung
	1	+https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/205586461/Digitale Mitgliederverwaltung