@spec get_auth_error(Plug.Conn.t()) :: binary() | nil

Get auth errors, if present.

@spec get_bearer_token_payload(Plug.Conn.t()) :: map() | nil

Get the payload of the bearer token, if present.

@spec get_session(Plug.Conn.t()) :: Charon.Models.Session.t() | nil

Get current session, if present.

@spec get_token_signature_transport(Plug.Conn.t()) :: atom() | nil

Get token signature transport mechanism, if present.

@spec get_tokens(Plug.Conn.t()) :: Charon.Models.Tokens.t() | nil

Get tokens, if present.

@spec set_auth_error(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put an auth error on the conn

@spec set_session(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a session on the conn

@spec set_token(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a token on the conn

@spec set_token_payload(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a token payload on the conn

@spec set_token_signature_transport(Plug.Conn.t(), binary() | :bearer | :cookie) ::
  Plug.Conn.t()

Set token signature transport mechanism. Must be one of "bearer", "cookie", :bearer or :cookie.

examples-doctests

Examples / doctests

iex> :bearer = %Conn{} |> set_token_signature_transport("bearer") |> get_token_signature_transport()
iex> :bearer = %Conn{} |> set_token_signature_transport(:bearer) |> get_token_signature_transport()
iex> :cookie = %Conn{} |> set_token_signature_transport("cookie") |> get_token_signature_transport()
iex> :cookie = %Conn{} |> set_token_signature_transport(:cookie) |> get_token_signature_transport()

iex> set_token_signature_transport(%Conn{}, "anything else")
** (FunctionClauseError) no function clause matching in Charon.Internal.parse_sig_transport/1

@spec set_user_id(Plug.Conn.t(), any()) :: Plug.Conn.t()

Set user id for session creation