Current section

Files

Jump to
openmaize lib openmaize.ex
Raw

lib/openmaize.ex

defmodule Openmaize do
@moduledoc """
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:
* Openmaize.IdCheck
* checks to see if the user, based on id, is authorized to access the page / resource
* this plug needs to be called after Openmaize.Authorize
See the relevant module documentation for more details.
"""
end