AuthN v0.2.0 AuthN.SessionStorage behaviour View Source

Module used for storing, retrieving and deleting the user ID into/from the session.

This module serves as an interface, delegating calls to another module implementing the session's storage logic. The default implementation module is AuthN.SessionStorage.StatelessCookie, which stores sessions into stateless cookies. Another module implementing sessions storage can be specified by adding the module name into the :session_storage key of conn.private.

Link to this section Summary

Link to this section Types

Link to this type

conn()

View Source
conn() :: %Plug.Conn{
  adapter: term(),
  assigns: term(),
  before_send: term(),
  body_params: term(),
  cookies: term(),
  halted: term(),
  host: term(),
  method: term(),
  owner: term(),
  params: term(),
  path_info: term(),
  path_params: term(),
  port: term(),
  private: term(),
  query_params: term(),
  query_string: term(),
  remote_ip: term(),
  req_cookies: term(),
  req_headers: term(),
  request_path: term(),
  resp_body: term(),
  resp_cookies: term(),
  resp_headers: term(),
  scheme: term(),
  script_name: term(),
  secret_key_base: term(),
  state: term(),
  status: term()
}

Link to this section Functions

Link to this function

delete_user_id(conn)

View Source
delete_user_id(conn()) :: conn()
Link to this function

get_user_id(conn)

View Source
get_user_id(conn()) :: term() | nil
Link to this function

put_user_id(conn, user_id)

View Source
put_user_id(conn(), term()) :: conn()

Link to this section Callbacks

Link to this callback

delete_user_id(conn)

View Source
delete_user_id(conn()) :: conn()
Link to this callback

get_user_id(conn)

View Source
get_user_id(conn()) :: term()
Link to this callback

put_user_id(conn, user)

View Source
put_user_id(conn(), user :: term()) :: conn()