Phauxth v0.15.1 Phauxth.Remember View Source

Remember me module.

Calling Phauxth.Remember with plug checks for a remember_me cookie, which contains a token. The token is then checked, and if it is valid, the user is added to the session.

This module also contains functions to add / delete the remember_me cookie.

Options

There are two options:

max_age - the length of the validity of the token
- the default is two weeks
user_context - the user context module to be used
- the default is MyApp.Accounts

Examples

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

plug Phauxth.Authenticate
plug Phauxth.Remember

Make sure you add the Phauxth.Remember Plug after Phauxth.Authenticate.

Link to this section Summary

Functions

add_rem_cookie(conn, user_id, max_age \\ 1209600)

Add a token as a remember me cookie

check_session(conn)

Check the session for the current user

check_token(conn, token, max_age)

Check the token for the current user

delete_rem_cookie(conn)

Delete the remember_me cookie

get_user(conn, arg)

Get the user based on the session id or token id

get_user(conn, token, arg)

report(user)

Log the result of the authentication and return the user struct or nil

set_user(user, conn)

Set the current_user variable

Link to this section Functions

add_rem_cookie(conn, user_id, max_age \\ 1209600)

Add a token as a remember me cookie.

check_session(conn)

Check the session for the current user.

check_token(conn, token, max_age)

Check the token for the current user.

delete_rem_cookie(conn)

Delete the remember_me cookie.

get_user(conn, arg)

Get the user based on the session id or token id.

This function also calls the database to get user information.

get_user(conn, token, arg)

report(user)

Log the result of the authentication and return the user struct or nil.

set_user(user, conn)

Set the current_user variable.