Zum Inhalt springen

Änderungen von Dokument Digitale Mitgliederverwaltung

Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version Icon 35.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/22 18:17
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 36.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/23 12:04
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Icon Seiteneigenschaften
Inhalt
... ... @@ -806,53 +806,227 @@
806 806  
807 807  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.
808 808  
809 -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).**
810 810  
811 -{{code language="json"}}
812 -{
813 - "payload": {
814 -        "timestamp": "YYYY-MM-DDTHH:mm:ss",
815 - "uuid": "260171c3-c71c-4da2-b13e-bf1386fe9eac",
816 - "correspondent": "Daniel Herrmann (#250)",
817 - "type": "mksp-doc-sepamandat",
818 - "tags": [
819 - "tag1",
820 - "tag2"
821 - ],
822 -"storage_path": "Mitgliederverwaltung"
823 - },
824 - "sig": "signature over the entire payload block"
825 -}
826 -{{/code}}
811 +=== {{id name="DigitaleMitgliederverwaltung-QRcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)**QR **(% style="color: rgb(53, 44, 99)" %)code erzeugen(%%) ===
827 827  
828 -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: rgb(53,44,99);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
829 829  
830 -=== {{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 +* QR code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden.
831 831  
832 -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 ===
833 833  
834 -* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent
835 -* **Signatur**: SHA256 Signatur, PKCS1v15 Padding
836 -* (((
837 -**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:
838 -\\
824 +Der Header enthält wichtige Meta-Daten:
839 839  
840 -{{code language="json"}}
841 -{"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"}
842 -{{/code}}
826 +|=(% scope="col" %)(((
827 +Claim
828 +)))|=(% scope="col" %)(((
829 +Type
830 +)))|=(% scope="col" %)(((
831 +Pflicht
832 +)))|=(% scope="col" %)(((
833 +Beschreibung
834 +)))
835 +|(((
836 +time
837 +)))|(((
838 +Timestamp
839 +Format: YYYY-MM-DDTHH:mm:ss
840 +)))|(((
841 +✅️
842 +)))|(((
843 +Timestamp an dem das Dokument und der QR Code erzeugt wurden
844 +)))
845 +|(((
846 +id
847 +)))|(((
848 +UUID4
849 +)))|(((
850 +✅️
851 +)))|(((
852 +Eindeutige ID dieses Dokuments
853 +)))
854 +|(((
855 +exp
856 +)))|(((
857 +Zahl
858 +)))|(((
859 +✅️
860 +)))|(((
861 +Dauer der Gültigkeit gemessen in Sekunden, beispielsweise 1209600 für 2 Wochen.
862 +)))
843 843  
864 +=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body ===
844 844  
845 -Als Referenz, die in Python wäre der Input der Signatur:
846 -\\
866 +Die folgenden Claims sind im Body verfügbar:
847 847  
848 -{{code language="python"}}
849 -import json
868 +(% class="" %)|=(((
869 +Claim
870 +)))|=(((
871 +Type
872 +)))|=(((
873 +Pflicht
874 +)))|=(((
875 +Beschreibung
876 +)))
877 +(% class="" %)|(((
878 +(% class="code" %)
879 +(((
880 +typ
881 +)))
882 +)))|(((
883 +String
884 +)))|(((
885 +✅️
886 +)))|(((
887 +Typ des Dokuments basierend auf der unten definierten Liste.
888 +)))
889 +(% class="" %)|(((
890 +(% class="code" %)
891 +(((
892 +cor
893 +)))
894 +)))|(((
895 +String
896 +)))|(((
897 +❌️
898 +)))|(((
899 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll
900 +)))
901 +(% class="" %)|(((
902 +tags
903 +)))|(((
904 +List[String]
905 +)))|(((
906 +❌️
907 +)))|(((
908 +Liste an Tags, die dem Dokument zugeordnet werden soll
909 +)))
910 +|(((
911 +spth
912 +)))|(((
913 +String
914 +)))|(((
915 +❌️
916 +)))|(((
917 +Storage Path, das dem Dokument zugeordnet werden soll
918 +)))
919 +|(((
920 +opt
921 +)))|(((
922 +dict
923 +)))|(((
924 +❌️
925 +)))|(((
926 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden.
927 +)))
850 850  
851 -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'}
852 -signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8')
853 -{{/code}}
929 +=== {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer ===
930 +
931 +Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur.
932 +
933 +{{confluence_tip title="Algorithmus"}}
934 +Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher.
935 +
936 +Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus).
937 +{{/confluence_tip}}
938 +
939 +=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library ===
940 +
941 +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:
942 +
943 +|=(% scope="col" %)(((
944 +Name
945 +)))|=(% scope="col" %)(((
946 +CVE
947 +)))|=(% scope="col" %)(((
948 +Github
949 +)))|=(% scope="col" %)(((
950 +GH⭐
951 +)))|=(% scope="col" %)(((
952 +Letztes Release
953 +)))|=(% scope="col" %)(((
954 +Offene Issues
955 +)))|=(% scope="col" %)(((
956 +Dokumentation
957 +)))|=(% scope="col" %)(((
958 +Qualität Dokumentation
959 +)))|=(% scope="col" %)(((
960 +In Backend vorhanden?
961 +)))|=(% scope="col" %)(((
962 +In Paperless vorhanden?
854 854  )))
964 +|(((
965 +python-jose
966 +)))|(((
967 +3/0
968 +)))|(((
969 +[[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]]
970 +)))|(((
971 +1.7k
972 +)))|(((
973 +28.05.2025
974 +)))|(((
975 +83
976 +)))|(((
977 +[[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]]
978 +)))|(((
979 +⛔ Wenige Bespiele, API Dokumentation fehlt komplett
980 +)))|(((
981 +❌️
982 +)))|(((
983 +❌️
984 +)))
985 +|(((
986 +pyJWT
987 +)))|(((
988 +4/0
989 +)))|(((
990 +[[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]]
991 +)))|(((
992 +5.4k
993 +)))|(((
994 +28.11.2024
995 +)))|(((
996 +30
997 +)))|(((
998 +[[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]]
999 +)))|(((
1000 +➕️ Gute Dokumentation, API, Beispiele, Changelog
1001 +)))|(((
1002 +✅️ 2.10.1
1003 +)))|(((
1004 +✅️ 2.10.1
1005 +)))
1006 +|(((
1007 +JWCrypto
1008 +)))|(((
1009 +5/0
1010 +)))|(((
1011 +[[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]]
1012 +)))|(((
1013 +465
1014 +)))|(((
1015 +06.03.2024
1016 +)))|(((
1017 +8
1018 +)))|(((
1019 +[[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]]
1020 +)))|(((
1021 +➕️ API Doc, einige Beispiele
1022 +)))|(((
1023 +✅️ 1.5.6
1024 +)))|(((
1025 +❌️
1026 +)))
855 855  
1028 +Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben.
1029 +
856 856  == {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup ==
857 857  
858 858  Owner: zwei Owner
Icon Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -202867287
1 +202867288
URL
... ... @@ -1,1 +1,1 @@
1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867287/Digitale Mitgliederverwaltung
1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867288/Digitale Mitgliederverwaltung