Phauxth v2.0.0-alpha.1 Phauxth.Authenticate View Source

Authenticates the current user, using Phauxth sessions and a session id.

You need to define a get_by(%{"session_id" => session_id}) function in the session_module module you are using - see the documentation for Phauxth.Config for more information about the session_module.

For information about customizing this Plug, see the documentation for Phauxth.Authenticate.Base.

Phauxth session authentication

This module checks the current Plug session for a session_id. It then checks to see if the session id is valid.

Options

There are two options:

  • :session_module - the sessions module to be used

    • the default is Phauxth.Config.session_module()
  • :log_meta - additional custom metadata for Phauxth.Log

    • this should be a keyword list

Examples

Add the following line to the pipeline you want to authenticate in the web/router.ex file:

plug Phauxth.Authenticate

And if you are using a different sessions module:

plug Phauxth.Authenticate, session_module: MyApp.Sessions

In the example above, you need to have the get_by/1 function defined in MyApp.Sessions.

Link to this section Summary

Functions

Adds the session_id to the conn

Link to this section Functions

Link to this function add_session(conn, session_id) View Source
add_session(Plug.Conn.t(), binary()) :: Plug.Conn.t()

Adds the session_id to the conn.