enhance README

This commit is contained in:
Youngjoon Lee 2024-05-15 19:19:55 +09:00
parent 91284196c1
commit 7d640ca36a
No known key found for this signature in database
GPG Key ID: 09B750B5BD6F08A2

View File

@ -1,32 +1,38 @@
# Mixnet v2 Simulation
* [How to run](#how-to-run)
* [Mixnet Functionalities](#mixnet-functionalities)
* [Adversary Models](#adversary-models)
## How to run
First, make sure that all dependencies specified in the `requirements.txt` in the project root.
Then, configure parameters in the [config.yaml](./config.yaml), and run the following command:
Then, configure parameters in the [`config.yaml`](./config.yaml), and run the following command:
```bash
python main.py --config ./config.yaml
```
The simulation runs during a specified duration, prints the results to the console, and show some plots.
TODO: Add more details
## Development Status
## Mixnet Functionalities
- Modified Sphinx
- [x] Without encryption
- [ ] With encryption
- P2P Broadcasting
- [x] Naive 1:N
- [ ] More realistic broadcasting (e.g. gossipsub)
- [x] Forwarding messages through mixes, and then broadcasting messages to all nodes
- Cover traffic
- [x] With a constant rate
- [ ] More sophisticated rate (e.g. based on the approximate block interval)
- [x] Sending a real message to the mixnet at the promised interval
- Each node has its own probability of sending a real message at each interval.
- [x] Cover traffic
- All nodes have the same probability of sending a cover message at each interval.
- [x] Forwarding messages through mixes, and then broadcasting messages to all nodes if the message is real.
- Mix delays
- [x] Naive random delays
- [ ] More sophisticated delays (e.g. Poisson)
- [Adversary simulations](https://www.notion.so/Mixnet-v2-Proof-of-Concept-102d0563e75345a3a6f1c11791fbd746?pvs=4#c5ffa49486ce47ed81d25028bc0d9d40)
- [ ] Observing message emission patterns
- [ ] Correlating senders-receivers based on timing
- [ ] Active attacks
- [ ] Reporting & Visualization
- [ ] More sophisticated delays (e.g. Poisson) if necessary
## [Adversary Models](https://www.notion.so/Mixnet-v2-Proof-of-Concept-102d0563e75345a3a6f1c11791fbd746?pvs=4#c5ffa49486ce47ed81d25028bc0d9d40)
- [x] Identifying nodes emitting messages around the promised interval.
- [ ] With partial visibility
- [ ] Correlating senders-receivers based on timing
- [ ] Active attacks
- [ ] Reporting & Visualization
- With quantifying the effect of attacks above based on parameter changes.