keycloak

v0.1.1

keycloak v0.1.1 Keycloak.Plug.VerifyToken View Source

Plug for verifying authorization on a per request basis, verifies that a token is set in the Authorization header.

Example Usage 

config :keycloak, Keycloak.Plug.VerifyToken, hmac: "foo"

# In your plug pipeline
plug Keycloak.Plug.VerifyToken

Link to this section Summary

Functions

call(conn, _)

Fetches the Authorization header, and verifies the token if present. If a valid token is passed, the decoded %Joken.Token{} is added as :token to the conn assigns

fetch_token(list)

Fetches the token from the Authorization headers array, attempting to match the token in the format Bearer <token>

signer_azp()

Returns the configured signer authorized party to validate against the azp token claim

signer_key()

Returns the configured public_key or hmac key used to sign the token

verify_token(token)

Attemps to verify that the passed token can be trusted

Link to this section Functions

Link to this function call(conn, _) View Source 
call(Plug.Conn.t, keyword) :: Plug.Conn.t

Fetches the Authorization header, and verifies the token if present. If a valid token is passed, the decoded %Joken.Token{} is added as :token to the conn assigns.

Link to this function fetch_token(list) View Source 
fetch_token([String.t] | []) :: String.t | nil

Fetches the token from the Authorization headers array, attempting to match the token in the format Bearer <token>.

Example 

iex> fetch_token([])
nil

iex> fetch_token(["abc123"])
nil

iex> fetch_token(["Bearer abc123"])
"abc123"
Link to this function signer_azp() View Source 
signer_azp() :: String.t

Returns the configured signer authorized party to validate against the azp token claim.

Link to this function signer_key() View Source 
signer_key() :: Joken.Signer.t

Returns the configured public_key or hmac key used to sign the token.

Example 

iex> %Joken.Signer{} = signer_key()
%Joken.Signer{jwk: %{"k" => "YWtiYXI", "kty" => "oct"}, jws: %{"alg" => "HS512"}}
Link to this function verify_token(token) View Source 
verify_token(String.t | nil) :: {atom, Joken.Token.t | atom}

Attemps to verify that the passed token can be trusted.

Example 

iex> verify_token(nil)
{:error, :not_authenticated}

iex> verify_token("abc123")
{:error, "Invalid signature"}