Home
Softono
mqtt-broker

mqtt-broker

Open source MIT Rust
GitHub
154
Stars
27
Forks
20
Issues
7
Watchers
3 years
Last Commit
API Tools Networking & Hosting

About mqtt-broker

mqtt-broker is a work-in-progress MQTT v5 broker written in Rust using the tokio async runtime. The project aims to fully adhere to the MQTT v5 specification while remaining easily deployable as a single binary with reasonable performance and memory usage on a single node. It was originally created as a simple open-source broker for IoT products, prioritizing the ability for users to run their own broker with minimal effort. The core focus is implementing the MQTT V5 spec, including the WebSocket transport. Advanced features like broker clustering and additional transport layers are deferred until core V5 compliance is achieved. The project is not yet fully spec compliant. Built using Rust 1.39 or later with cargo, it supports standard development workflows including building, testing with cargo test, formatting with nightly rustfmt, linting with clippy, and fuzzing for protocol decoders and topic parsing. It is intended as a lightweight, self-hostable MQTT broker, with alternatives like rumqtt recommended fo

Platforms

Web Self-hosted

Languages

Rust

Links

Source Code
b
Published by
bschwind
Visit View Profile

README.md

View on GitHub

mqtt-broker

A tokio-based MQTT v5 broker written in Rust.

Project Goals

The goals for this project are fairly straightforward:

  • Adhere to the MQTT V5 Spec
  • Be easily deployable as a single binary
  • Have reasonable performance and memory usage on a single node

I originally started this project as a simple, open-source broker for any IoT products I might make. If I were to sell such products, I would want to allow users to run their own broker in case I can no longer run one, and it should be as easy as possible to do so.

Extra features like a broker cluster or extra transport layers are nice to have features, but won't be considered until the core V5 spec is implemented. The exception to this is the WebSocket transport, which is specifically mentioned in the spec and quite useful to have.

Comparison to Other Brokers

Wikipedia has a fairly comprehensive list of brokers to choose from.

rumqtt at the moment appears to be the most fully-featured broker. Take a look there first if you're looking for a more "ready-to-go" Rust broker.

PubSubRT is another interesting Rust-based broker. It's an alternative to MQTT, not an implementation of it.

NATS.rs seems really nice too, but I haven't looked further into it yet.

Spec Compliance

This broker is currently not compliant with the MQTT V5 spec. Visit the spec compliance milestone to see the current progress.

Dependencies

  • cargo
  • rustc (version 1.39 or later)

Build

$ cargo build --release

Run

$ cargo run --release

Testing

$ cargo test

Code Format

The formatting options currently use nightly-only options.

$ cargo +nightly fmt

Code Linting

$ cargo clippy

Code Fuzzing

Fuzzing requires a nightly toolchain. Fuzzing for this project is currently confirmed to work with:

rustc 1.42.0-nightly (6d3f4e0aa 2020-01-25)

Running

cargo install cargo-fuzz
cargo +nightly fuzz run decoder_fuzzer_v311
cargo +nightly fuzz run decoder_fuzzer_v500
cargo +nightly fuzz run topic_filter_fuzzer
cargo +nightly fuzz run topic_fuzzer