From d33225cb248b68f792cdb00702c0b560d011417c Mon Sep 17 00:00:00 2001 From: eichehome Date: Sat, 15 Apr 2023 19:45:47 +0200 Subject: [PATCH] Weitere Details aufgeschrieben --- API.md | 106 ++++++++++++++++++++++++++++++++++++++++++++- Datei-Austausch.md | 4 ++ Message.md | 68 +++++++++++++++++++++++++++++ Multi-Device.md | 10 +++++ Registriren.md | 18 ++++++++ 5 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 Datei-Austausch.md create mode 100644 Message.md create mode 100644 Multi-Device.md create mode 100644 Registriren.md diff --git a/API.md b/API.md index 21eab1e..01064b2 100644 --- a/API.md +++ b/API.md @@ -1,4 +1,108 @@ # General -- https vorgeschrieben +- `https://` vorgeschrieben +- Signatur-Verifikation vorgeschriben # API-Endpunkte +## Server +GET `/pubkey` +- 404: Not Found +- 200: OK +- 30?: Changed +- ???: Too Many Requests +- ???: No Key + +GET `/login` +- 404: Not Found +- 200: OK +- ???: Too Many Requests + +POST `/login` +- 404: Not Found +- 200: OK +- 40?: Authorisation Failed +- ???: Too Many Requests + +POST `/inbox` +- 404: Not Found +- 200: OK +- ???: Too Many Requests +- ???: No Message + +## Account +GET `/@/pubkey` +- 404: Not Found +- 200: OK +- 30?: Changed +- ???: Too Many Requests +- ???: No Key + +POST `/@/pubkey` +- 404: Not Found +- 200: OK +- 40?: Authorisation Failed +- ???: Too Many Requests +- ???: No Key + +PUT `/@/pubkey` +- 404: Not Found +- 200: OK +- 40?: Authorisation Failed +- ???: Too Many Requests +- ???: No Key + +GET `/@/inbox` +- 404: Not Found +- 200: OK +- 40?: Authorisation Failed +- ???: Too Many Requests +- ???: No Message + +PUT `/@/outbox` +- 404: Not Found +- 200: OK +- 40?: Authorisation Failed +- ???: Too Many Requests +- ???: No Message + +GET `/@/privkey` +- 404: Not Found +- 200: OK +- ???: Too Many Requests +- ???: No Key + +POST `/@/privkey` +- 404: Not Found +- 200: OK +- ???: Too Many Requests +- ???: No Key + +PUT `/@/privkey` +- 404: Not Found +- 200: OK +- ???: Too Many Requests +- ???: No Key + +GET `/@/messages` +- 404: Not Found +- 200: OK +- ???: Too Many Requests + +GET `/@/groups` +- 404: Not Found +- 200: OK +- ???: Too Many Requests + +POST `/@/groups` +- 404: Not Found +- 200: OK +- ???: Too Many Requests + +GET `/@/trusted` +- 404: Not Found +- 200: OK +- ???: Too Many Requests + +POST `/@/trusted` +- 404: Not Found +- 200: OK +- ???: Too Many Requests \ No newline at end of file diff --git a/Datei-Austausch.md b/Datei-Austausch.md new file mode 100644 index 0000000..6db43f4 --- /dev/null +++ b/Datei-Austausch.md @@ -0,0 +1,4 @@ +# Datei-Austausch +In der Nachricht: Link und SymKey + +Zusätzlich: Signierte Datei, verschlüsselt mit SymKey \ No newline at end of file diff --git a/Message.md b/Message.md new file mode 100644 index 0000000..96c7ec3 --- /dev/null +++ b/Message.md @@ -0,0 +1,68 @@ +# Sending and Reciving Messages +To: @contact@second.test + +From: @eichehome@test.social + +Dies ist eine Nachricht im Chat. +``` +| (Client) +v +``` +To: @contact@second.test + +From: @eichehome@test.social + +Dies ist eine Nachricht im Chat. + +------------GPG----------------- + +Signatur der Nachricht. + +Inhalt: To, From, Nachricht + +------------GPG----------------- +``` +| (Client) +v +``` +To: @contact@second.test + +------------GPG----------------- + +Verschlüsselte Nachricht + +Inhalt: From, Nachricht, Signatur + +------------GPG----------------- +``` +| (Server) +v +``` +To: @contact@second.test + +------------GPG----------------- + +Verschlüsselte Nachricht + +Inhalt: From, Nachricht, Signatur + +------------GPG----------------- + +------------GPG----------------- + +Signatur der Nachricht. + +Inhalt: Verschlüsselte Nachricht, To + +------------GPG----------------- +``` +| (Server) +v +``` +------------GPG----------------- + +Verschlüsselte Nachricht + +Inhalt: Verschlüsselte Nachricht, Signatur + +------------GPG----------------- \ No newline at end of file diff --git a/Multi-Device.md b/Multi-Device.md new file mode 100644 index 0000000..fcc1e0f --- /dev/null +++ b/Multi-Device.md @@ -0,0 +1,10 @@ +# Multi-Device +``` +login +Wenn PubKey existiert + Nutze diesen und den zugehörigen PrivKey (von Online/extern) +wenn nicht + Frage, ob Key-Paar generiert oder importiert werden soll + Lade PubKey hoch +ende +``` \ No newline at end of file diff --git a/Registriren.md b/Registriren.md new file mode 100644 index 0000000..afa47e8 --- /dev/null +++ b/Registriren.md @@ -0,0 +1,18 @@ +# Registrieren + +``` +Checken, ob der Nutzername schon benutzt wird +Wenn PublicRegistration aktiviert + Checken, ob der E-Mail-Provider gesperrt/erlaubt ist +Wenn TokenRegistration aktiviert + Zeige Token-Input Feld +Passwort-Stärke prüfen +Wenn Passwort-Reset gewünscht ist + Frage nach 3? Fragen und deren Antworten (Warnung: Nachrichten nur wenn Key gesichert) +Sende Konfirmations-E-Mail (Signiert, Verschlüsselt, wenn WKD vorhanden) + +``` +Features: +- E-Mail-Provider White/BlackList +- Passwort-Stärke definitionen +- Passwort-Reset per E-Mail \ No newline at end of file