Authentication library for Elixir
There have been a few changes in the newest versions, 0.19 and 0.18, and there were
many changes in version 0.17.
Please check the UPGRADE_0.18.md guide in this directory for details.
Openmaize is an authentication library that aims to be:
- secure
- lightweight
- easy to use
- well documented
It should work with any application that uses Plug, but it has only been tested with the Phoenix Web Framework.
- Add openmaize to your
mix.exsdependencies
defp deps do
[ {:openmaize, "~> 0.19"} ]
end- List
:openmaizeas an application dependency
def application do
[applications: [:logger, :openmaize]]
end- Run
mix do deps.get, compile
Before you use Openmaize, you need to make sure that your user model is configured correctly. See the documentation for Openmaize.DB for details.
You then need to configure Openmaize. For more information, see the documentation for the Openmaize.Config module.
It provides the following functionality:
- Openmaize.Authenticate - plug to authenticate users, using JSON Web Tokens.
- Openmaize.Login - plug to handle login POST requests.
- Openmaize.Logout - plug to handle logout requests.
- 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.
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.
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.
BSD