Packages
openmaize
1.0.0-beta.5
3.0.1
retired
3.0.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.1
2.5.0
2.4.0
2.3.2
2.3.1
2.3.0
2.2.0
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
1.0.1
1.0.0
1.0.0-beta.5
1.0.0-beta.4
1.0.0-beta.3
1.0.0-beta.2
1.0.0-beta.1
1.0.0-beta.0
0.19.3
0.19.2
0.19.1
0.19.0
0.18.1
0.18.0
0.17.2
0.17.1
0.17.0
0.16.2
0.16.1
0.16.0
0.15.1
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.8.1
0.8.0
0.7.5
0.7.4
0.7.2
0.7.1
0.7.0
0.6.7
0.6.6
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
Authentication library for Elixir using Plug
Current section
Files
Jump to
Current section
Files
lib/openmaize/password.ex
defmodule Openmaize.Password do
@moduledoc """
Check the password is valid, and optionally, check the password is
strong enough.
To perform the password strength checks, you need to have NotQwerty123
installed.
## Basic checks
The basic check just checks that the password is a string and that it
is more than `min_length` characters long. The minimum length is 8
characters by default.
The following command is an example of how you can call `valid_password?`
checking that the password is at least 12 characters long:
Openmaize.Password.valid_password?(password, [min_length: 12])
## Password strength checks
If you have NotQwerty123 installed, there are three options:
* min_length - the minimum length of the password
* extra_chars - check for punctuation characters (including spaces) and digits
* common - check to see if the password is too common (too easy to guess)
The default value for `min_length` is 8 characters if `extra_chars` is true,
but 12 characters if `extra_chars` is false. This is because the password
should be longer if the character set is restricted to upper and lower case
letters.
`extra_chars` and `common` are true by default.
Openmaize.Password.valid_password?("verylongpassword", [min_length: 16, extra_chars: false])
The above command will check that the password is at least 16 characters long and
will skip the check for punctuation characters or digits.
"""
if Code.ensure_loaded?(NotQwerty123) do
def valid_password?(password, opts) when is_binary(password) do
case NotQwerty123.PasswordStrength.strong_password?(password, opts) do
true -> {:ok, password}
message -> {:error, message}
end
end
def valid_password?(_, _), do: {:error, "The password should be a string"}
else
def valid_password?(password, opts) when is_binary(password) do
String.length(password) >= Keyword.get(opts, :min_length, 8) and
{:ok, password} || {:error, "The password is too short"}
end
def valid_password?(_, _), do: {:error, "The password should be a string"}
end
end