yajwt v1.2.1 JWT View Source

Encode claims for transmission as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure, enabling the claims to be integrity protected with a Message Authentication Code (MAC), to be later verified

see http://tools.ietf.org/html/rfc7519

Link to this section Summary

Functions

Return a JSON Web Token (JWT), a string representing a set of claims as a JSON object that is encoded in a JWS

Given an options map, return a map of header options

Return a tuple {:ok, claims (map)} if the JWT signature is verified, or {:error, "invalid"} otherwise

Link to this section Functions

Link to this function

sign(claims, options)

View Source
sign(map(), Keyword.t() | map()) :: binary()

Return a JSON Web Token (JWT), a string representing a set of claims as a JSON object that is encoded in a JWS

Example

iex> claims = %{iss: "joe", exp: 1300819380, "http://example.com/is_root": true}
...> key = "gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C"
...> JWT.sign(claims, key: key)
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzMDA4MTkzODAsImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlLCJpc3MiOiJqb2UifQ.C5kby-t7W1CM1VB_avPCCHbtOXsNsywYAKYex8rHZh8"

see http://tools.ietf.org/html/rfc7519#section-7.1

Link to this function

unify_header(options)

View Source
unify_header(Keyword.t() | map()) :: map()

Given an options map, return a map of header options

Example

iex> JWT.unify_header(alg: "RS256", key: "key")
%{typ: "JWT", alg: "RS256"}

Filters out unsupported claims options and ignores any encryption keys

Link to this function

verify(jwt, options)

View Source
verify(binary(), map()) :: {:ok, map()} | {:error, Keyword.t()}

Return a tuple {:ok, claims (map)} if the JWT signature is verified, or {:error, "invalid"} otherwise

Example

iex> jwt ="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiam9lIiwiaHR0cDovL2V4YW1wbGUuY29tL2lzX3Jvb3QiOnRydWUsImRhdGV0aW1lIjoxMzAwODE5MzgwfQ.8CbXtOJ51MfPLlNTDpMMBHExFZGmqIC2c_hjuY0Dp24"
...> key = "gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C"
...> JWT.verify(jwt, %{key: key})
{:ok, %{"name" => "joe", "datetime" => 1300819380, "http://example.com/is_root" => true}}

see http://tools.ietf.org/html/rfc7519#section-7.2

Link to this function

verify!(jwt, options)

View Source
verify!(binary(), map()) :: map() | no_return()