README.md

Pwned

Check if your password has been pwned

It uses have i been pwned? to verify if a password has appeared in a data breach. In order to protect the value of the source password being searched the value is not sended through the network. Instead it uses a k-Anonymity model that allows a password to be searched for by partial hash. This allows the first 5 characters of a SHA-1 password hash to be passed to the API. Then search the results of the response for the presence of their source hash and if not found, the password does not exist in the data set.

Table of Contents

• Install
• Usage
• Contributing
• License

Install

The package can be installed by adding pwned to your list of dependencies in mix.exs:

def deps do
  [
    {:pwned, "~> 1.1"}
  ]
end

Usage

case Pwned.check_password("somepassword") do
  {:ok, false} ->
    IO.puts("Good news — no pwnage found! This password wasn't found in any of the Pwned Passwords loaded into Have I been pwned.")

  {:ok, count} ->
    IO.puts("Ohh, sorry! This password has appeared #{count} time on data breaches.")

  :error ->
    IO.puts("Something went wrong.")
end

Contributing

See the contributing file.

License

Apache License, Version 2.0 © Thiago Santos