Settings View Source Charon.TokenPlugs.PutAssigns (Charon v3.1.1)

After verifying everything you would want to verify about a token, assign the following to the conn:

• :user_id (bearer token claim "sub")
• :session_id (bearer token claim "sid")
• :token_payload
• :session (if fetched with Charon.TokenPlugs.load_session/2)

All of the assign names are overridable:

# assign the user ID to key :current_user_id
plug PutAssigns, claims: %{"sub" => :current_user_id, "sid" => :session_id}

doctests

Doctests

iex> opts = PutAssigns.init([])
iex> conn = conn() |> set_token_payload(%{"sub" => 1, "sid" => "a"})
iex> conn |> PutAssigns.call(opts) |> Map.get(:assigns)
%{session_id: "a", token_payload: %{"sid" => "a", "sub" => 1}, user_id: 1}

iex> opts = PutAssigns.init(session: :da_session_baby)
iex> conn = conn() |> set_token_payload(%{"sub" => 1, "sid" => "a"}) |> set_session("hii")
iex> conn |> PutAssigns.call(opts) |> Map.get(:assigns)
%{
  session_id: "a",
  token_payload: %{"sid" => "a", "sub" => 1},
  user_id: 1,
  da_session_baby: "hii"
}

# skipped on auth error
iex> opts = PutAssigns.init([])
iex> conn = conn() |> set_token_payload(%{"sub" => 1, "sid" => "a"}) |> set_auth_error("boom")
iex> conn |> PutAssigns.call(opts) |> Map.get(:assigns)
%{}