goauth

Fabric plugin for enhanced whitelists
git clone git://git.bain.cz/goauth.git
Log | Files | Refs | README | LICENSE

commit ff965b0b15356011b0f338550a2412d2a7f98a92
parent 6445d708894d4256bccc750a1065c555ea711ef7
Author: bain <bain@bain.cz>
Date:   Sat, 27 Nov 2021 16:26:23 +0100

add README

Diffstat:
AREADME | 23+++++++++++++++++++++++
1 file changed, 23 insertions(+), 0 deletions(-)

diff --git a/README b/README @@ -0,0 +1,23 @@ +GOAuth + +GOAuth is a fabric plugin which adds an authentication limbo +for players that are not on the whitelist. + +The authentication limbo is a stripped down connection that +lets the user join, sends him a fake empty world and a message +saying he should authenticate. It then proceeds to ignore the +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 + 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"} + server> 0x01 if the payload is invalid, 0x00 if the transaction + was successful + +The socket allows a remote server to modify the whitelist. +Whitelist modification is stricter, it kicks the users if they are +removed from the whitelist (and from limbo when they are added).