KittenBlue.JWS (kitten_blue v0.9.1)

This module provides JOSE.JWS wrappter functions using KittenBlue.JWK

verify : Signature verification using KittenBlue.JWK list.
sign : Sign payload with KittenBlue.JWK

Link to this section Summary

Functions

sign(payload, key, header \\ %{}, opts \\ [])

Sign payload with KittenBlue.JWK

verify(token, keys, required_header \\ nil)

Signature verification using KittenBlue.JWK list.

verify_without_kid(token, key, required_header \\ nil)

Link to this section Functions

sign(payload, key, header \\ %{}, opts \\ [])

Specs

sign(
  payload :: map(),
  key :: KittenBlue.JWK.t(),
  header :: map(),
  opts :: Keyword.t()
) ::
  {:ok, String.t()} | {:error, :invalid_key}

Sign payload with KittenBlue.JWK

{:ok, token} = KittenBlue.JWS.sign(payload, kb_jwk)

# use header param
{:ok, token} = KittenBlue.JWS.sign(payload, kb_jwk, %{"typ" => "my_jwt_usage"})

verify(token, keys, required_header \\ nil)

Specs

verify(token :: String.t(), keys :: List.t(), required_header :: map()) ::
  {:error, :invalid_jwt_format}
  | {:error, :invalid_jwt_kid}
  | {:error, :invalid_jwt_signature}
  | {:error, :invalid_jwt_header}
  | {:ok, payload :: map()}

Signature verification using KittenBlue.JWK list.

{:ok, payload} = KittenBlue.JWS.verify(token, kb_jwk_list)

# with header param
{:ok, payload} = KittenBlue.JWS.verify(token, kb_jwk_list, %{"typ" => "my_jwt_usage"})

verify_without_kid(token, key, required_header \\ nil)

Specs

verify_without_kid(
  token :: String.t(),
  key :: KittenBlue.JWK.t(),
  required_header :: map()
) ::
  {:error, :invalid_jwt_format}
  | {:error, :invalid_jwt_signature}
  | {:error, :invalid_jwt_header}
  | {:ok, payload :: map()}