From 3273662291b6177336f27e665392898840d6b07a Mon Sep 17 00:00:00 2001 From: Nate Koenig Date: Mon, 15 Jun 2020 09:05:35 -0700 Subject: [PATCH] Updated readme Signed-off-by: Nate Koenig --- plugins/websocket_server/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/plugins/websocket_server/README.md b/plugins/websocket_server/README.md index 94c18ac6..3f1f8c0d 100644 --- a/plugins/websocket_server/README.md +++ b/plugins/websocket_server/README.md @@ -33,6 +33,20 @@ ign launch -f examples/websocket.ign -v 4 firefox plugins/websocket_server/index.html ``` + +# Authorization + +The `websocket_server` plugin accepts to authentication keys: + +* `` : If this is set, then a connection must provide the +matching key using an "auth" call on the websocket. If the `` is set, then the connection can provide that key. + +* `` : If this is set, then a connection must provide the matching key using an "auth" call on the websocket. If the `` is set, then the connection can provide that key. + +Two keys are used in order to support authorization of different users. +A competition scenario may require admin access while prohibiting user +access. + # SSL 1. Use the `localhost.cert` and `localhost.key` files for testing purposes.