hibp

README

go-hibp - Simple go client for the HIBP API

Usage

Pwned Passwords API

package main

import (
	"fmt"
	"github.com/wneessen/go-hibp"
)

func main() {
	hc := New()
	m, _, err := hc.PwnedPassword.CheckPassword("test123")
	if err != nil {
		panic(err)
	}
	if m != nil && m.Count != 0 {
		fmt.Println("Your password was found in the pwned passwords DB")
    }
}

Documentation

Index

• Constants
• type Client
  • func New(options ...Option) *Client
  • func (c *Client) HttpReq(m, p string) (*http.Request, error)
• type Match
• type Option
  • func WithApiKey(k string) Option
  • func WithHttpTimeout(t time.Duration) Option
• type PwnedPassword
  • func (p *PwnedPassword) CheckPassword(pw string) (*Match, *http.Response, error)
  • func (p *PwnedPassword) CheckSHA1(h string) (*Match, *http.Response, error)

Constants

const Version = "0.1.1"

Version represents the version of this package

Types

type Client

type Client struct {
	PwnedPassword *PwnedPassword // Reference to the PwnedPassword API
	// contains filtered or unexported fields
}

Client is the HIBP client object

func New

func New(options ...Option) *Client

New creates and returns a new HIBP client object

func (*Client) HttpReq

func (c *Client) HttpReq(m, p string) (*http.Request, error)

HttpReq performs an HTTP request to the corresponding API

type Match

type Match struct {
	Hash  string
	Count int64
}

Match represents a match in the Pwned Passwords API

type Option

type Option func(*Client)

Option is a function that is used for grouping of Client options.

func WithApiKey

func WithApiKey(k string) Option

WithApiKey set the optional API key to the Client object

func WithHttpTimeout

func WithHttpTimeout(t time.Duration) Option

WithHttpTimeout overrides the default http client timeout

type PwnedPassword

type PwnedPassword struct {
	// contains filtered or unexported fields
}

PwnedPassword is a HIBP Pwned Passwords API client

func (*PwnedPassword) CheckPassword

func (p *PwnedPassword) CheckPassword(pw string) (*Match, *http.Response, error)

CheckPassword checks the Pwned Passwords database against a given password string

func (*PwnedPassword) CheckSHA1

func (p *PwnedPassword) CheckSHA1(h string) (*Match, *http.Response, error)

CheckSHA1 checks the Pwned Passwords database against a given SHA1 checksum of a password