| scripts | ||
| src | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Dockerfile | ||
| README.md | ||
ruck
ruck is a command line tool used for hosting relay servers and sending end-to-end encrypted files between clients. It was heavily inspired by croc, one of the easiest ways to send files between peers. This document describes the protocol ruck uses to support this functionality.
Version
This document refers to version 0.1.0 of ruck as defined by the Cargo.toml file.
Server
The server in ruck exposes a TCP port.
Its only functions are to staple connections and shuttle bytes between stapled connections.
The first 32 bytes sent over the wire from a new client are used as its unique identifier.
When a new client joins, if the server has another open connection with the same identifier, the connections are then stapled.
The clients have some mechanism for agreeing on these identifiers, however, from the server's perspective it doesn't matter how they agree.
Once the connection is stapled, all bytes are piped across until a client disconnects or times out.
The time out is set to remove idle connections.
The server does nothing else with the bytes, so the clients are free to end-to-end encrypt their messages.
For this reason, updates to the ruck protocol do not typically necessitate server redeployments.
Client
There are two types of clients - send and receive clients.
Out of band, the clients agree on a relay server and password, from which they can derive the 32 byte identifier used by the server to staple their connections.
Clients have the option of using the single-use, automatically generated passwords which ruck supplies by default.
Using the passwords per the Spake2 handshake algorithm, clients generate a symmetric key with which to encrypt their subsequent messages.
Once the handshake is complete, send and receive negotiate and exchange files per the following:
sendoffers a list of files and waits.receivespecifies which bytes it wants from these files.sendsends the specified bytes and waits.receivesends heartbeats with progress updates.sendhangs up once the heartbeats stop or received a successful heartbeat.receivehangs up once the downloads are complete.