diff --git a/docs/PROTOCOL.md b/docs/PROTOCOL.md index e847709..1c57b35 100644 --- a/docs/PROTOCOL.md +++ b/docs/PROTOCOL.md @@ -7,5 +7,6 @@ The protocol implemented is quite simple on purpose to optimize the number of by 3. The `client` will always send a pre-shared-key, the protocol version, the type of request (also known in the protocol as `route`) and the encoded data needed by the route. 4. The `server` will close the connection without replying if the size of the packet exeeds the max size defined in the server settings. 5. The `server` will always reply with a status code, and the encoded data linked to its status. +6. The `server` uses the pre-shared-key sent by the client to determine who can and cannot upload new data to the server. For more information please check the `service.proto` file available in both client and server repository. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..b7ba0f9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +# Documentation + +- [Protocol](https://github.com/rizinorg/rz-silhouette/blob/main/docs/PROTOCOL.md) +- [Hints](https://github.com/rizinorg/rz-silhouette/blob/main/docs/HINTS.md) +- [Signatures](https://github.com/rizinorg/rz-silhouette/blob/main/docs/SIGNATURES.md)