Packages

phauxth

1.2.9
2.5.1 retired 2.5.0 2.4.0 2.3.2 2.3.1 2.3.0 2.2.0 2.1.1 2.1.0 2.0.1 2.0.0 2.0.0-rc.2 2.0.0-rc.1 2.0.0-rc.0 2.0.0-beta.1 2.0.0-beta.0 2.0.0-alpha.5 2.0.0-alpha.4 retired 2.0.0-alpha.3 retired 2.0.0-alpha.2 retired 2.0.0-alpha.1 retired 2.0.0-alpha.0 retired 1.2.9 1.2.8 1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.1 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.3 1.0.2 1.0.1 1.0.0 0.17.1 0.17.0 0.16.0 0.15.1 0.15.0 0.14.0 0.13.0-rc.1 0.13.0-rc.0 0.12.1-rc.1 0.12.1-rc.0 0.12.0-rc 0.11.0 0.10.3 0.10.2 0.10.0 0.9.0 0.8.2 0.8.1 0.8.0

Authentication library for Phoenix, and other Plug-based, web applications

HexDocs

Current section

Files

Jump to
Readme
58 Versions
6 Dependencies
Dependants
Files
Activity
phauxth lib phauxth authenticate.ex
Raw

lib/phauxth/authenticate.ex 

defmodule Phauxth.Authenticate do

  @moduledoc """

  Authenticate the current user, using sessions or api tokens.



  For information about customizing this Plug, see the documentation

  for Phauxth.Authenticate.Base.



  ## Session authentication



  This module checks the current Plug session for a `phauxth_session_id`,

  which contains a session id and the user id. It then checks the user

  schema to see if the session id is valid. The sessions are stored in

  a map with session ids as keys and timestamps as values.



  This process can be customized by overriding the `get_user` and / or

  `check_session` function in Phauxth.Authenticate.Base.



  ## Token authentication



  This module looks for a token in the request headers. It then uses

  Phauxth.Token to check that it is valid. If it is valid, user information

  is retrieved from the database.



  This process can be customized by overriding the `get_user` and / or

  `check_token` function in Phauxth.Authenticate.Base.



  ## Options



  There are four options:



    * `:method` - the method used to authenticate the user

      * this is either `:session` (using sessions) or `:token` (using api tokens)

      * the default is `:session`

    * `:max_age` - the length of the validity of the session / token

      * the default is four hours

    * `:user_context` - the user context module to be used

      * the default is MyApp.Accounts

    * `:log_meta` - additional custom metadata for Phauxth.Log

      * this should be a keyword list



  There are also options for signing / verifying the token.

  See the documentation for the Phauxth.Token module for details.



  ## Examples



  Add the following line to the pipeline you want to authenticate in

  the `web/router.ex` file:



      plug Phauxth.Authenticate



  To use with an api, add the token method option:



      plug Phauxth.Authenticate, method: :token



  """



  use Phauxth.Authenticate.Base

end