Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zmoshansky/aeacus
A simple, secure, and highly configurable Elixir identity [username | email | id | etc.]/password authentication module to use with Ecto.
https://github.com/zmoshansky/aeacus
Last synced: 3 months ago
JSON representation
A simple, secure, and highly configurable Elixir identity [username | email | id | etc.]/password authentication module to use with Ecto.
- Host: GitHub
- URL: https://github.com/zmoshansky/aeacus
- Owner: zmoshansky
- License: other
- Created: 2015-07-04T01:00:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-02T21:38:53.000Z (about 3 years ago)
- Last Synced: 2024-05-02T08:19:13.472Z (10 months ago)
- Language: Elixir
- Size: 20.5 KB
- Stars: 37
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A simple configurable identity/password authentication module (Compatible with Ecto/Phoenix). (Authentication)
- fucking-awesome-elixir - aeacus - A simple configurable identity/password authentication module (Compatible with Ecto/Phoenix). (Authentication)
- awesome-elixir - aeacus - A simple configurable identity/password authentication module (Compatible with Ecto/Phoenix). (Authentication)
README
[Aeacus - The holder of keys](https://en.wikipedia.org/wiki/Aeacus)
======
A simple, secure, and highly configurable Elixir identity [username | email | id | etc.]/password authentication module to use with Map compatible data structures (ex.Ecto).
[](https://travis-ci.org/zmoshansky/aeacus) [](https://hex.pm/packages/aeacus) [](https://hex.pm/packages/aeacus) [](https://github.com/zmoshansky/aeacus/issues) [](https://github.com/zmoshansky/aeacus/pulls)
#### Description ####
Aeacus only performs authentication, making it well suited for integration with session storage, or a token system; like [Guardian](https://github.com/hassox/guardian) or [Phoenix Tokens](http://hexdocs.pm/phoenix/Phoenix.Token.html). For convenience, `authenticate/2` & `authenticate_resource/3` are delegated from `Aeacus` (`Aeacus.authenticate(...)`).
`Aeacus.hashpwsalt/1` delegates to the underlying crypto system to salt and hash a password.
#### Dependencies ####
Ecto is required only if you wish to use `Aeacus.authenticate/2`; if using `Aeacus.authenticate_resource/3` Ecto is not required.
#### Requirements ####
Aeacus requires that you have a Map compatible data structure (ex. Ecto Model) that has a UNIQUE(identity_field) and password_field. These fields can be configured to easily match your schema, whether it be `username`, `email`, or `pass`, `password`, `hash`, `hashed_password`, etc. Of course, the passwords must be stored using the same crypto system as Aeacus; The password should be salted and hashed, plaintext is heavily discouraged. See the tests for examples.
#### Config ####
You must set the `:repo` and `:model` for Aeacus. The other options have sane defaults.
```elixir
config :aeacus, Aeacus,
repo: MyApp.Repo,
model: MyApp.User,
# Optional, The following are the default options
crypto: Comeonin.Pbkdf2,
identity_field: :email,
password_field: :hashed_password,
error_message: "Invalid identity or password."
```
#### Example Session Controller ####
`Aeacus.authenticate` expects a `Map` with keys `:identity`, and `:password`. Alternatively, `Aeacus.authenticate_resource` can be used if a resource is already loaded.
```elixir
defmodule MyApp.SessionController do
def create(conn, params) do
case Aeacus.authenticate %{identity: params[:email], password: params[:pass]} do
{:ok, user} -> CreateTokenOrCookie
{:error, message} -> DisplayAuthenticationScreenAgain
end
end
end
```