Reliable Message Bus

Reliable message bus is a secure communication panel that allows bots to communicate together in a chat like way. It makes it very easy to host a service or a set of functions to be used by anyone, even if your service is running behind NAT.

Out of the box RMB provides the following:

• Guarantee authenticity of the messages. You are always sure that the received message is from whoever is pretending to be
• End to End encryption
• Support for 3rd party hosted relays. Anyone can host a relay and people can use it safely since there is no way messages can be inspected while using e2e. That's similar to home servers by matrix

Why

RMB is developed by ThreefoldTech to create a global network of nodes that are available to host capacity. Each node will act like a single bot where you can ask to host your capacity. This enforced a unique set of requirements:

• Communication needed to be reliable
  • Minimize and completely eliminate message loss
  • Reduce downtime
• Node need to authenticate and authorize calls
  • Guarantee identity of the other peer so only owners of data can see it
• Fast request response time

Starting from this we came up with a more detailed requirements:

• User (or rather bots) need their identity maintained by tfchain (a blockchain) hence each bot needs an account on tfchain to be able to use rmb
• Then each message then can be signed by the bot keys, hence make it easy to verify the identity of the sender of a message. This is done both ways.
• To support federation (using 3rd party relays) we needed to add e2e encryption to make sure messages that are surfing the public internet can't be sniffed
• e2e encryption is done by deriving an encryption key from the same identity seed, and share the public key on tfchain hence it's available to everyone to use

Specification

For details about protocol itself please check the docs

How to use

There are many ways to use rmb because it was built for bots and software to communicate. Hence, there is no mobile app for it for example, but instead a set of libraries where you can use to connect to the network, make chitchats with other bots then exit.

Or you can keep the connection forever to answer other bots requests if you are providing a service.

If there is a library in your preferred language

Then you are in luck, follow the library documentations to implement a service bot, or to make requests to other bots.

known libraries

• Golang rmb-sdk-go
• Typescript rmb-sdk-ts

Well, I am not that lucky

In that case:

• Implement a library in your preferred language
• If it's too much to do all the signing, verification, e2e in your language then use rmb-peer

What is rmb-peer

think of rmb-peer as a gateway that stands between you and the relay. rmb-peer uses your mnemonics (your identity secret key) to assume your identity and it connects to the relay on your behalf, it maintains the connection forever and takes care of

• reconnecting if connection was lost
• verifying received messages
• decrypting received messages
• sending requests on your behalf, taking care of all crypto heavy lifting.

Then it provide a simple (plain-text) api over redis. means to send messages (or handle requests) you just need to be able to push and pop messages from some redis queues. Messages are simple plain text json.

More details about the structure of the messages are also in the docs page

Download

Please check the latest releases normally you only need the rmb-peer binary, unless you want to host your own relay.

Build from source

Perquisites

• download Rustup and install Rust, run the following in your terminal, then follow the on-screen instructions:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Install the standard library for the target x86_64-unknown-linux-musl, which is a Linux platform that uses the musl libc implementation instead of the glibc one. This allows you to compile Rust programs that can run on Linux systems that do not have glibc installed, or to create fully static binaries that do not depend on any shared libraries.

  rustup target add x86_64-unknown-linux-musl

• To use this target, you also need to install a linker that supports musl, such as musl-gcc.

  sudo apt update
  sudo apt install musl-tools

  You can then pass the --target=x86_64-unknown-linux-musl option to cargo build or cargo run to compile and run your program for this target.

• Install pre-compiled protoc binary to ensure that you’re using the latest release of protoc.

  PB_REL="https://github.com/protocolbuffers/protobuf/releases"
  curl -LO $PB_REL/download/v23.4/protoc-23.4-linux-x86_64.zip
  sudo unzip -d /usr/local protoc-23.4-linux-x86_64.zip
  protoc --version  # Ensure compiler version is updated

• Redis:

  • Install Redis server using the apt package manager:

    sudo apt update
    sudo apt install redis-server

  • Configure Redis server by editing the /etc/redis/redis.conf file (optional)

  • Enable Redis server to start automatically on boot:

    sudo systemctl enable redis-server

  • Start Redis server using systemd:

    sudo systemctl start redis-server

Building

git clone [email protected]:threefoldtech/rmb-rs.git
cd rmb-rs
cargo build --release --target=x86_64-unknown-linux-musl

Troubleshooting

• If you encounter an error like the one below, it is likely that the protoc version installed by your package manager is too old.

  --- stderr
    types.proto: This file contains proto3 optional fields, but --experimental_allow_proto3_optional was not set.
    codegen failed: parse and typecheck

  Solution: The best way to ensure that you’re using the latest release of protoc is installing from pre-compiled binaries. See perquisites.

• A peer must use a unique mnemonic or keys. It's not correct if multiple peers uses the same mnemonic this will make it impossible to route messages correctly. It's possible for the same peer to make multiple connections to the same relay given that it uses different session ids. A session id identify the connection and hence make routing messages possible.

• A single peer on the other hand can make multiple connections to multiple relays for redundancy given that his data on the tfchain must reflect that

RUNNING MULTIPLE PEERS WITH THE SAME MNEMONIC MUST BE AVOIDED UNLESS FOLLOWING THE GUIDE LINES ABOVE

Running tests

While inside the repository

cargo test