diff --git a/README.md b/README.md index 54be769..04245d8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Chaff is a website fingerprinting (WF) defence framework inspired by Maybenot[^1 ### Why experimental? -The reason why Chaff is experimental is because it is unproven. Chaff hasn't been integrated into any existing privacy-enhancing technologies, it is still missing a host of features that would make it complete, and it might not even work that well. One of the key aims for Chaff was to evaluate if the queue machine model is valid and/or useful for developing safe WF defences. +The reason why Chaff is experimental is because it is unproven. Chaff hasn't been integrated into any existing privacy-enhancing technologies, it is still missing a host of features that would make it complete, and your mileage may vary. One of the key aims for Chaff was to evaluate if the queue machine model is valid and/or useful for developing safe WF defences. ### Why Chaff? @@ -58,6 +58,27 @@ nix build The resulting artefacts will be put in `result/`. +If you don't want to use Nix, you can use `cargo` directly, but you may need external libraries such as `libpcap`: + +```sh +cargo build --release +``` + +To use the command line: + +```sh +cargo run --release -- --help +``` + +To install: + +```sh +cargo install --path ./crates/chaff-cli/ + +# then +chaff-cli --help +``` + ## Development For development purposes, you might want to enter the default development shell: diff --git a/crates/chaff-datasets/README.md b/crates/chaff-datasets/README.md index 8d175c8..265c3d5 100644 --- a/crates/chaff-datasets/README.md +++ b/crates/chaff-datasets/README.md @@ -6,4 +6,5 @@ This crate is used for parsing different datasets from different papers into a c This can currently parse: +- Chaff's own dataset format. A collection of traces in chaff file format within a flat directory with names `-`. - [Tik-Tok](https://github.com/msrocean/Tik_Tok)