Fetching latest commit…
Comm
A hypothetical, distributed, encrypted, instant messaging protocol.
- Read the protocol for an overview of how comm works.
- See the GTK-based GUI client
Project Goals
- No centralized server
- Messages should be stored in the network for some reasonable amount of time until recipient is available
- It should be difficult for an adversary to silence a participant (prevent them from sending messages)
- It should be difficult for an adversary to deafen a participant (prevent them from receiving messages)
What the what
- Client relays a message to the network
- Network nodes store and re-relay messages they receive
- Network nodes drop messages that they've relayed for a reasonable amount of time, and a reasonable number of times
- Recipient finally gets message, relays acknowledgement
- Network nodes drop messages after verifying their acknowledgement
- Network nodes re-relay acknowledgement to nodes that need to stop relaying the message
Please read the protocol for a more detailed overview.
Development
You need to have the protobuf crate installed and in your path. Add your multirust
crate bin path to your PATH if you use multirust:
cargo install protobuf
PATH=~/.multirust/toolchains/stable/cargo/bin:$PATH
Usage
You can fire up a CLI chat client by running
cargo run comm -- $SECRET 0.0.0.0:$PORT [1.2.3.4:$OTHER_NODE_PORT]
Where SECRET is a word that will be SHA1 hashed into your node's address, PORT
is the local port you want to run on, and then third argument is the address
and port of another node. This other node is a "bootstrap node" and will be
your entrypoint into the network. It can be another comm client running
without a bootstrap router of it's own.
An interactive CLI will start, and you can send a message to another node by entering its address, followed by a message:
44751799925b964a00bae3863cc4236f9bb8d519 Hi there!
Documentation
Documenation is still forthcoming, but many of the modules have doc comments. I'm still trying to figure out a good way to host rust docs out of GitHub Pages.