README
¶
pwned-passwords
A light-weight Go client for checking compromised passwords against HIBP Pwned Passwords.
Installation
go get -u github.com/mattevans/pwned-passwords
Usage
package main
import (
"fmt"
"net/http"
"os"
"time"
hibp "github.com/mattevans/pwned-passwords"
)
func main() {
// Init a client.
client := hibp.NewClient()
// Optional: Use a custom http client
client.SetHTTPClient(&http.Client{
Timeout: 3 * time.Second,
})
// Check to see if your given string is compromised.
pwned, err := client.Compromised("string to check")
if err != nil {
os.Exit(1)
}
if pwned {
// Oh dear! 😱 -- You should avoid using that password
fmt.Print("Found to be compromised")
}
}
Contributing
If you've found a bug or would like to contribute, please create an issue here on GitHub, or better yet fork the project and submit a pull request!
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
UserAgent string
BackendURL *url.URL
// contains filtered or unexported fields
}
Client holds a connection to the HIBP API.
func NewClient ¶
func NewClient() *Client
NewClient creates a new Client with the appropriate connection details and services used for communicating with the API.
func (*Client) Compromised ¶ added in v0.5.0
Compromised will build and execute a request to HIBP to check to see if the passed value is compromised or not.
func (*Client) NewRequest ¶
NewRequest creates an API request. A relative URL can be provided in urlPath, which will be resolved to the BackendURL of the Client.
Source Files