pwn

README

Have I Been Pwned

Go library for interacting with HaveIBeenPwned.

Implemented:

• Breaches
• Pastes
• Passwords

License

MIT

Documentation

Index

• func IsErrEmptyPassword(err error) bool
• func WithContext(ctx context.Context) func(pwnClient *Client)
• func WithHTTP(httpClient *http.Client) func(pwnClient *Client)
• type Client
  • func New(options ...ClientOption) *Client
  • func (c *Client) CheckPassword(pw string, padding bool) (int, error)
• type ClientOption
• type ErrEmptyPassword
  • func (e ErrEmptyPassword) Error() string

Functions

func IsErrEmptyPassword

func IsErrEmptyPassword(err error) bool

IsErrEmptyPassword checks if an error is ErrEmptyPassword

func WithContext

func WithContext(ctx context.Context) func(pwnClient *Client)

WithContext will set the context.Context of a Client

func WithHTTP

func WithHTTP(httpClient *http.Client) func(pwnClient *Client)

WithHTTP will set the http.Client of a Client

Types

type Client

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

Client is a HaveIBeenPwned client

func New

func New(options ...ClientOption) *Client

New returns a new HaveIBeenPwned Client

func (*Client) CheckPassword

func (c *Client) CheckPassword(pw string, padding bool) (int, error)

CheckPassword returns the number of times a password has been compromised Adding padding will make requests more secure, however is also slower because artificial responses will be added to the response For more information, see https://www.troyhunt.com/enhancing-pwned-passwords-privacy-with-padding/

type ClientOption

type ClientOption func(*Client)

ClientOption is a way to modify a new Client

type ErrEmptyPassword

type ErrEmptyPassword struct{}

ErrEmptyPassword is an empty password error

func (ErrEmptyPassword) Error

func (e ErrEmptyPassword) Error() string

Error fulfills the error interface