View Source Charon.Utils (Charon v3.1.1)
Utility functions, mainly getters and setters for module internals.
Link to this section Summary
Functions
Get auth errors, if present.
Get the bearer token, if present.
Get the payload of the bearer token, if present.
Get current session, if present.
Get token signature transport mechanism, if present.
Get token transport mechanism, if present.
Get tokens, if present.
Put an auth error on the conn
Put a session on the conn
Put a token on the conn
Put a token payload on the conn
Set token signature transport mechanism.
Must be one of "bearer", "cookie_only", "cookie" :bearer, :cookie_only or :cookie.
Set user id for session creation
Link to this section Functions
@spec get_auth_error(Plug.Conn.t()) :: binary() | nil
Get auth errors, if present.
@spec get_bearer_token(Plug.Conn.t()) :: map() | nil
Get the bearer token, 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_token_transport(Plug.Conn.t()) :: atom() | nil
Get token 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() | :cookie | :bearer | :cookie_only ) :: Plug.Conn.t()
Set token signature transport mechanism.
Must be one of "bearer", "cookie_only", "cookie" :bearer, :cookie_only or :cookie.
This function only results in transports :bearer and :cookie, never in :cookie_only,
in contrast with set_token_signature_transport/2, to maintain backwards compatibility.
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_only") |> get_token_signature_transport()
iex> :cookie = %Conn{} |> set_token_signature_transport(:cookie_only) |> 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()@spec set_user_id(Plug.Conn.t(), any()) :: Plug.Conn.t()
Set user id for session creation