Packages
openmaize
0.8.0
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
README.md
# Openmaize
Authentication and authorization library for Elixir
## Goals
Openmaize aims to provide developers the following:
* a secure, but lightweight, framework-agnostic authentication and authorization
mechanism that is easy to use.
* excellent documentation.
## Installation
1. Add openmaize to your `mix.exs` dependencies
```elixir
defp deps do
[ {:openmaize, "~> 0.8"} ]
end
```
2. List `:openmaize` as an application dependency
```elixir
def application do
[applications: [:logger, :openmaize]]
end
```
3. Run `mix do deps.get, compile`
## Use
Before you use Openmaize, you need to make sure that your user model
contains an `id`, `name` (which identifies the user) and `role`.
You then need to configure Openmaize. For more information, see the documentation
for the Openmaize.Config module.
Openmaize provides the following main plugs:
* Openmaize.LoginoutCheck
* checks the path to see if it is for the login or logout page
* handles login or logout if necessary
* Openmaize.Authenticate
* authenticates the user
* sets (adds to the assigns map) the current_user variable
* Openmaize.Authorize
* checks to see if the user is authorized to access the page / resource
There is also the following plug, which can be used to perform an extra
authorization check based on user id:
* Openmaize.Authorize.IdCheck
* checks to see if the user, based on id, is authorized to access the page / resource
See the relevant module documentation for more details.
There is an example of Openmaize being used with Phoenix at
[Openmaize-phoenix](https://github.com/riverrun/openmaize-phoenix).
### License
BSD