Packages
openmaize
0.16.1
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 / authorization library for Elixir.
It provides the following functionality:
## Authentication
* 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.
## Authorization
In the Openmaize.AccessControl module:
* authorize - verify that the user, based on user role, is authorized to
access the requested page.
* authorize_id - verify that the user, based on the user id, is authorized to
access the requested page.
## User creation 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.
In the Openmaize.Confirm module:
* confirm_email - verify the token that was sent to the user by email.
* reset_password - like `confirm_email`, verify the token that was sent
to the user by email, but this time so that the user's password can be reset.
See the relevant module documentation for more details.
For configuration, see the documentation for Openmaize.Config.
There is an example of Openmaize being used with Phoenix at
[Openmaize-phoenix](https://github.com/riverrun/openmaize-phoenix).
"""
use Application
@doc false
def start(_type, _args) do
import Supervisor.Spec
children = [
worker(Openmaize.Keymanager, [])
]
opts = [strategy: :one_for_one, name: Openmaize.Supervisor]
Supervisor.start_link(children, opts)
end
@doc """
Stop the keymanager child process without keeping state.
This can be used to remove the old keys and generate new ones.
After being stopped, the keymanager will be restarted and new keys
will be created.
"""
def stop_keymanager do
Process.whereis(Openmaize.Keymanager) |> Process.exit(:kill)
end
end