https://github.com/thiamsantos/pwned

Check if your password has been pwned
https://github.com/thiamsantos/pwned

Last synced: 11 days ago
JSON representation

Check if your password has been pwned

• Host: GitHub
• URL: https://github.com/thiamsantos/pwned
• Owner: thiamsantos
• License: apache-2.0
• Created: 2018-03-12T21:57:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-01T13:15:53.000Z (over 4 years ago)
• Last Synced: 2024-10-12T16:32:03.373Z (27 days ago)
• Language: Elixir
• Size: 17.6 KB
• Stars: 24
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Check if your password has been pwned. (Security)
• fucking-awesome-elixir - pwned - Check if your password has been pwned. (Security)
• awesome-elixir - pwned - Check if your password has been pwned. (Security)

README

        
# Pwned

[![Travis](https://img.shields.io/travis/thiamsantos/pwned.svg)](https://travis-ci.org/thiamsantos/pwned)

[![Hex.pm](https://img.shields.io/hexpm/v/pwned.svg)](https://hex.pm/packages/pwned)

[![Docs](https://img.shields.io/badge/hex-docs-green.svg)](https://hexdocs.pm/pwned)

> Check if your password has been pwned

It uses [have i been pwned?](https://haveibeenpwned.com) 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](https://en.wikipedia.org/wiki/K-anonymity) model that allows a [password to be searched for by partial hash](https://haveibeenpwned.com/API/v2#SearchingPwnedPasswordsByRange). 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](#install)

-   [Usage](#usage)

-   [Contributing](#contributing)

-   [License](#license)

## Install

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

```elixir

def deps do

  [

    {:pwned, "~> 1.1"}

  ]

end

```

## Usage

```elixir

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](CONTRIBUTING.md).

## License

[Apache License, Version 2.0](LICENSE.md) © [Thiago Santos](https://github.com/thiamsantos)