Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions crates/chaff-datasets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<class_name>-<instance_number>`.
- [Tik-Tok](https://github.com/msrocean/Tik_Tok)
Loading