Skip to content

Commit

Permalink
Add install and setup notes
Browse files Browse the repository at this point in the history
Signed-off-by: Dominik Schulz <[email protected]>
  • Loading branch information
dominikschulz committed Jan 7, 2023
1 parent aaca562 commit 8e462bb
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,34 @@
# gopass-hibp

Gopass haveibeenpwnd.com integration

## Installation

### Fedora

To install gopass-hibp in Fedora you can do:

```bash
sudo dnf install gopass-hibp
```

### From Source

```bash
go install github.com/gopasspw/gopass-hibp@latest
```

## Setup

If you want to use the offline mode (`dump`) you need to obtain a HIBP dump (SHA1, ordered by hash).
You can use one of the [official sources](https://haveibeenpwned.com/Passwords) but they haven't been
updated in a while and it [seems](https://www.troyhunt.com/downloading-pwned-passwords-hashes-with-the-hibp-downloader/) like they won't receive further updates.

Instead prefer the built-in downloader. It does use the same approach as the official .NET tool.

```bash
gopass-hibp download --output /some/folder/with/40G/dump.txt.gz
```

The data will be downloaded into a million chunks first and then assembled to a large file later.
The output file will be around 18GB in size. During assembly of the chunks it will use twice that space for a short time.

0 comments on commit 8e462bb

Please sign in to comment.