Skip to content

Commit

Permalink
binfuse docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oschonrock committed Dec 19, 2024
1 parent b2d0686 commit 194c5ce
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,28 @@ warnings to the user that they using a compromised password.

For production, make this server a proper "autostart service" on your distribution.

### Binary fuse filters

If you want reduced storage requirements and/or faster queries, and
can tolerate a non-zero false positive rate (with zero false negative),
then you should consider the binfuse formats.

```bash
hibp-download --binfuse16-out hibp_binfuse16.bin
```
This converts the 37GB download into an immutable 2GB [binary fuse16 filter](https://github.com/oschonrock/binfuse).
Alternatively `--binfuse8-out` produces a 1GB file with a higher false positive rate
(see [format comparison](https://github.com/oschonrock/hibp?tab=readme-ov-file#design-high-performance-with-a-small-memory-disk-and-cpu-footprint))

and then run a server
```bash
hibp-server --binfuse16-filter=hibp_binfuse16.bin
```
and then query with plain or 64bit hashed passwords
```bash
curl http://localhost:8082/check/binfuse8/password123
```

#### Uninstall

To remove the package:
Expand Down

0 comments on commit 194c5ce

Please sign in to comment.