Skip to content

Commit

Permalink
fix: Benchmark CI, Readme improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
Nereuxofficial committed Sep 7, 2023
1 parent 12b90a5 commit ae38e13
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ A high-performance MQTT network Fuzzer.

This is an implementation of [FUME-Fuzzing-MQTT-Brokers](https://github.com/PBearson/FUME-Fuzzing-MQTT-Brokers/) in Rust.

# Architecture
The Fuzzing process is based on a Markov Model seen in the following image:
![Markov Model](images/MarkovModel.png)
For more details see src/lib/lib.rs or the original paper.

Notable changes from the paper include:
- The use of multiple asynchronous threads for fuzzing by default
- Improved performance
- Only counting broker crashes as crashes(The original paper also counted refused connections as crashes)

# Running the project
After [installing Rust](https://rustup.rs), run the following command in the project directory:
```
Expand All @@ -35,7 +45,7 @@ Pull requests are welcome. For major changes, please open an issue first to disc
## Compatibility
Currently, the Windows build is failing in the ci, however i've only tested this on Linux so far. Maybe it works on Windows, maybe it doesn't. I don't know. Pull Requests to fix this if necessary are welcome.

## Trophies
## 🏆 Trophies
All bugs found with this software. If you find a bug using rusty-FUME, please open an issue and I'll add it to the list once it is patched.
- [FlashMQ Null pointer dereference](https://github.com/halfgaar/FlashMQ/commit/eb3acf88771af3eeddf086e4c9dc51d703456eee)

Expand Down
Binary file added images/MarkovModel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ae38e13

Please sign in to comment.