Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svileng/password
Flexible password policies for Elixir.
https://github.com/svileng/password
Last synced: about 1 month ago
JSON representation
Flexible password policies for Elixir.
- Host: GitHub
- URL: https://github.com/svileng/password
- Owner: svileng
- License: mit
- Created: 2018-04-20T16:01:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-22T16:44:23.000Z (almost 6 years ago)
- Last Synced: 2024-10-20T10:20:33.654Z (3 months ago)
- Language: Elixir
- Size: 2.33 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Password [](https://hex.pm/packages/password) [](https://hexdocs.pm/password)
Flexible password policies for Elixir.
Comes with a built-in data set with the most widely used passwords (**~400K** records) from Mark Burnett / xato.net.
## Installation
Add to your `mix.exs`:
```elixir
def deps do
[
{:password, "~> 1.0"}
]
end
```
If you're not using [application inference](https://elixir-lang.org/blog/2017/01/05/elixir-v1-4-0-released/#application-inference), then add `:password` to your `applications` list.
## Usage
Create a new file and define a module like so:
```elixir
defmodule MyApp.Password do
use Password, [
# Policies
]
end
```
The empty list is where password policies go. For example:
```elixir
defmodule MyApp.Password do
use Password, [
{Password.Policy.SpecialCharacters}
]
end
```
To run the policies agains an input, use the `validate/1` function:
```elixir
iex> MyApp.Password.validate("password")
{:error, [Password.Policy.SpecialCharacters]}
iex> MyApp.Password.validate("password$")
:ok
```
To learn more about the included password policies and how to configure them,
see below.
## Password policies
Password's Policy modules are essentially middleware that you can plug
in or extend to create your own. At moment, the current modules are included:
- [Password.Policy.Length](https://hexdocs.pm/password/Password.Policy.Length.html) - verifies input is of minimum length
- [Password.Policy.SpecialCharacters](https://hexdocs.pm/password/Password.Policy.SpecialCharacters.html) - verifies input includes 1 (or more) special characters
- [Password.Policy.CommonPasswords](https://hexdocs.pm/password/Password.Policy.CommonPasswords.html) - verifies input is not one of the most common used passwords (data set includes ~400K passwords, credits to Mark Burnett / xato.net)
Check documentation on [hexdocs](https://hexdocs.pm/password/api-reference.html).
To create your own password policies, simply create a module that implements the `Password.Policy` behaviour and provide the `validate/2` function. See source of included modules as an example.
## About
This project is sponsored by [Heresy](http://heresy.io). We're always looking for great engineers to join our team, so if you love Elixir, open source and enjoy some challenge, drop us a line and say hello!
## License
* Password: See LICENSE file.
* "Heresy" name and logo: Copyright © 2019 Heresy Software Ltd