Weitere Details aufgeschrieben
This commit is contained in:
parent
8e9462ca52
commit
d33225cb24
5 changed files with 205 additions and 1 deletions
106
API.md
106
API.md
|
@ -1,4 +1,108 @@
|
||||||
# General
|
# General
|
||||||
- https vorgeschrieben
|
- `https://` vorgeschrieben
|
||||||
|
- Signatur-Verifikation vorgeschriben
|
||||||
|
|
||||||
# API-Endpunkte
|
# 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 `/@<account>/pubkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- 30?: Changed
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
POST `/@<account>/pubkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- 40?: Authorisation Failed
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
PUT `/@<account>/pubkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- 40?: Authorisation Failed
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
GET `/@<account>/inbox`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- 40?: Authorisation Failed
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Message
|
||||||
|
|
||||||
|
PUT `/@<account>/outbox`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- 40?: Authorisation Failed
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Message
|
||||||
|
|
||||||
|
GET `/@<account>/privkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
POST `/@<account>/privkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
PUT `/@<account>/privkey`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
- ???: No Key
|
||||||
|
|
||||||
|
GET `/@<account>/messages`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
|
||||||
|
GET `/@<account>/groups`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
|
||||||
|
POST `/@<account>/groups`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
|
||||||
|
GET `/@<account>/trusted`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
||||||
|
|
||||||
|
POST `/@<account>/trusted`
|
||||||
|
- 404: Not Found
|
||||||
|
- 200: OK
|
||||||
|
- ???: Too Many Requests
|
4
Datei-Austausch.md
Normal file
4
Datei-Austausch.md
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
# Datei-Austausch
|
||||||
|
In der Nachricht: Link und SymKey
|
||||||
|
|
||||||
|
Zusätzlich: Signierte Datei, verschlüsselt mit SymKey
|
68
Message.md
Normal file
68
Message.md
Normal file
|
@ -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-----------------
|
10
Multi-Device.md
Normal file
10
Multi-Device.md
Normal file
|
@ -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
|
||||||
|
```
|
18
Registriren.md
Normal file
18
Registriren.md
Normal file
|
@ -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
|
Loading…
Reference in a new issue