authsense

v1.0.0

authsense v1.0.0 Authsense

Sensible authentication helpers for Phoenix/Ecto.

Basic use

Specify your configuration via Mix.Config in config/config.exs.

config :authsense, Myapp.Model,
  repo: Myapp.Repo

Authentication

Authsense.Service.authenticate/2 will validate a login.

authenticate(changeset)
#=> {:ok, user} or
#   {:error, changeset_with_errors}

authenticate({ "userid", "password" })
#=> {:ok, user} or {:error, nil}

Logging in/out

Authsense.Plug.put_current_user/2 will set session variables for logging in or out.

  conn |> put_current_user(user)  # login
  conn |> put_current_user(nil)   # logout

Get current user

Authsense.Plug.fetch_current_user/2 - to get authentication data, use Auth as a plug:

# controller
import Authsense.Plug
plug :fetch_current_user

When using this plug, you can then get the current user:

conn.assigns.current_user  #=> %User{} | nil

Usage in models

Authsense.Service.generate_hashed_password/2 will update :hashed_password in a user changeset.

User.changeset(...)
|> generate_hashed_password()

Configuration

Specify your configuration via Mix.Config in config/config.exs.

config :authsense, Myapp.User,
  repo: Myapp.Repo

If you have more than one user, you can specify multiple configurations. (See config/1 on info on how this is dealt with)

config :authsense, Myapp.User,
  repo: Myapp.Repo

config :authsense, Myapp.AdminUser,
  repo: Myapp.Repo

These keys are available:

  • repo (required) - the Ecto repo to connect to.
  • model (required) - the user model to use.
  • crypto - the crypto module to use. (default: Comeonin.Pbkdf2)
  • identity_field - field that identifies the user. (default: :email)
  • password_field - virtual field that has the plaintext password. (default: :password)
  • hashed_password_field - field where the password is stored. (default: :hashed_password)
  • login_error - the error to add to the changeset on Authsense.Service.authenticate/2. (default: ”Invalid credentials.”)

config/1 has more info on how config is used.

Recipes

For information on how to build login pages, secure your website, and other things: see Recipes.

Summary

Functions

config(opts \\ nil)

Internal: Retrieves configuration for a given model

Functions

config(opts \\ nil)

Internal: Retrieves configuration for a given model.

Practical use

This is used internally by other functions to retrieve your configuration. For example, you typically call Authsense.Service.authenticate/2 with one parameter:

authenticate({"[email protected]", "password"})

But you may pass options to it to override the config:

authenticate({"[email protected]", "password"},
  hashed_password_field: :hashed_password)

Or if you provide multiple models to Authsense, you can pick which one to use:

config :authsense,
  Myapp.User, repo: MyApp.Repo

config :authsense,
  Myapp.AdminUser, repo: MyApp.Repo

authenticate({"[email protected]", "password"}, Myapp.User)
authenticate({"[email protected]", "password"}, Myapp.AdminUser)

Internal use

> Authsense.config
%{ model: Example.User, repo: Example.Repo, ... }

If there are multiple configurations, you can pass a model.

> Authsense.config(Example.User)
%{ model: Example.User, repo: Example.Repo, ... }

You may also pass a list. Any values other than model will be added in.

> Authsense.config(model: Example.User, foo: :bar)
%{ model: Example.User, ... foo: :bar }