Merge branch 'contact-info-metadata' into 'main'

first draft of metadata schema for contactInformation

See merge request fit-connect/api!46

.gitignore

@@ -3,6 +3,8 @@
 *.iml
 .idea/
 
+spec/zustelldienst-bundled.yml
+
 # Dependencies
 node_modules/
 

metadata-schema/README.md

+# Dokumentation für das Metadatenschema
+
+## Feld `contactInformation.e-mail.pgpPublicKey`
+
+Der Inhalt des Feldes ist ein durch `gpg --export --armor "$KEY_ID"` erzeugter ASCII-String
+in dem Zeilenumbrüche durch die Escape-Sequenz (`\n`) ersetzt wurden.
+
+Die Kodierung erfolgt wie folgt:
+
+```
+$ KEY_ID='EEADEDE070FA9658F0BE084AC20D38DB3EA14B59'
+$ gpg --export --armor "$KEY_ID" | python3 -c 'import sys; print(sys.stdin.read().replace("\n", "\\n"))'
+-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBEBEADSlS<snip>9jlG\n-----END PGP PUBLIC KEY BLOCK-----\n
+```
+
+Die Dekodierung ist obiger Schritt in Gegenrichtung:
+
+```
+$ KEY_ASCII='-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBEBEADSlS<snip>9jlG\n-----END PGP PUBLIC KEY BLOCK-----\n'
+$ echo "$KEY_ASCII" | python3 -c 'import sys; print(sys.stdin.read().replace("\\n", "\n"))'
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBEBEADSlS<snip>9jlG
+-----END PGP PUBLIC KEY BLOCK-----
+
+```
+
+Möchte man den eben ausgegeneben Schlüssel auch direkt importieren kann man hinter dem Dekodierungssnippet noch ein `| pgp --import` setzen.

metadata-schema/antragsmetadaten.schema.json

@@ -83,6 +83,89 @@
           "description": "Antragsdatum"
         }
       }
+    },
+    "replyChannel": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "eMail": {
+          "type": "object",
+          "properties": {
+            "address": {
+              "type": "string",
+              "format": "email"
+            },
+            "pgpPublicKey": {
+              "type": "string",
+              "description": "Hilfe zur Erstellung gibt es in der Dokumentation unter TODO.",
+              "pattern": "^-----BEGIN PGP PUBLIC KEY BLOCK-----\\n\\n"
+            }
+          },
+          "required": [
+            "address"
+          ],
+          "additionalProperties": false
+        },
+        "deMail": {
+          "type": "object",
+          "description": "Akkreditierte Anbieter siehe https://www.bsi.bund.de/DE/Themen/Oeffentliche-Verwaltung/Moderner-Staat/De-Mail/Akkreditierte-DMDA/akkreditierte-dmda_node.html",
+          "properties": {
+            "address": {
+              "type": "string",
+              "format": "email"
+            }
+          },
+          "required": [
+            "address"
+          ],
+          "additionalProperties": false
+        },
+        "fink": {
+          "type": "object",
+          "description": "Postfachadresse in einem interoperablen Servicekonto (FINK.PFISK)",
+          "properties": {
+            "finkPostfachRef": {
+              "type": "string",
+              "description": "FINK Postfachadresse",
+              "example": "hh/by/12345",
+              "maxLength": 150,
+              "pattern": "^[-._a-z0-9~\/]*$"
+            },
+            "host": {
+              "type": "string",
+              "description": "URL des Servicekontos, in dem das Ziel-Postfach liegt",
+              "format": "uri",
+              "example": "https://servicekonto1.example.com/"
+            }
+          },
+          "required": [
+            "finkPostfachRef"
+          ],
+          "additionalProperties": false
+        },
+        "elster": {
+          "type": "object",
+          "description": "Siehe https://www.elster.de/elsterweb/infoseite/elstertransfer_hilfe_schnittstellen",
+          "properties": {
+            "accountId": {
+              "type": "string",
+              "pattern": "^\\d{10}$"
+            },
+            "lieferTicket": {
+              "type": "string"
+            },
+            "geschaeftszeichen": {
+              "type": "string",
+              "maxLength": 10
+            }
+          },
+          "required": [
+            "accountId"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
     }
   },
   "required": [

metadata-schema/contact-information.example.json

+{
+  "replyChannel": {
+    "eMail": {
+      "address": "hello@fitko.de",
+      "pgpPublicKey": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\n"
+    },
+    "deMail": {
+      "address": "hello@de-mail.de"
+    },
+    "fink": {
+      "finkPostfachRef": "hh/by/12"
+    },
+    "elster": {
+      "accountId": "0123456789",
+      "lieferTicket": "Ticket-123",
+      "geschaeftszeichen": "XY-123"
+    }
+  }
+}