Packages
openmaize
0.19.2
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.ex
defmodule Openmaize do
@moduledoc """
Openmaize is an authentication library for Elixir.
It provides the following functionality:
## Authentication
* Openmaize.Authenticate - authenticate the user, using JSON Web Tokens.
* Openmaize.Login - handle login POST requests.
* Openmaize.Logout - handle logout requests.
## Email confirmation and password resetting
* Openmaize.ConfirmEmail - verify the token that was sent to the user by email.
* Openmaize.ResetPassword - verify the token that was sent to the user by email,
but this time so that the user's password can be reset.
## Various helper functions
In the Openmaize.DB module:
* add_password_hash - take an Ecto changeset, hash the password and add the
password hash to the changeset.
* add_confirm_token - add a confirmation token to the changeset.
* add_reset_token - add a reset token to the changeset.
See the relevant module documentation for more details.
For configuration, see the documentation for Openmaize.Config.
## Using with Phoenix
You can generate an example Authorize module and / or a Confirm module
by running the command `mix openmaize.gen.phoenixauth`.
There is an example of Openmaize being used with Phoenix at
[Openmaize-phoenix](https://github.com/riverrun/openmaize-phoenix).
"""
end