api

Documentation

Overview

Package api implements an HIBP API client.

Example

{ //nolint:testableexamples
	matches, err := Lookup("sha1sum of secret")
	if err != nil {
		panic(err)
	}
	fmt.Printf("Number of matches: %d", matches)
}

Index

• Variables
• func Download(ctx context.Context, path string, keep bool) error
• func Lookup(shaSum string) (uint64, error)

Examples

• Package

Variables

var URL = "https://api.pwnedpasswords.com"

URL is the HIBPv2 API URL.

Functions

func Download

func Download(ctx context.Context, path string, keep bool) error

Download will download the list of all hashes from the API to a single, gzipped txt file. This is inspired by the "official" .NET based download tool. It does exactly 16⁵ / 1024*1024 (1M) requests to fetch all the possible prefixes.

func Lookup

func Lookup(shaSum string) (uint64, error)

Lookup performs a lookup against the HIBP v2 API.