goauth

commit be5f05742816b9f9f144d2ea62cce1811911bcfb
parent ff965b0b15356011b0f338550a2412d2a7f98a92
Author: bain <bain@bain.cz>
Date:   Sat, 27 Nov 2021 17:06:56 +0100

fix protocol in README

Diffstat:
M
README
 | 
7
++++---

1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README b/README
@@ -10,11 +10,12 @@ user to limit the resource usage.
 
 A socket is open on a port specified in goauth.properties
 (default 8001). This socket communicates with this protocol:
-    client> send 4 bytes indicating the payload size
+    client> send 4 bytes (int) indicating the payload size
     server> 0x00 if size is small enough, 0x01 if not
     client> sends 12 byte nonce for ChaCha20-Poly1305 encryption
-    client> sends $size bytes of payload
-            ex: {"type": "add", "username": "bain"}
+    client> sends $size bytes of encrypted payload with pre-set key
+            ex. 1: {"type": "add", "username": "bain"}
+            ex. 2: {"type": "remove", "username": "bain"}
     server> 0x01 if the payload is invalid, 0x00 if the transaction
             was successful