yajwt v1.0.1 JWT

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

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

Functions

sign(claims, options)
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)
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLCJodHRwOi8vZXhhbXBsZS5jb20vaXNfcm9vdCI6dHJ1ZSwiZXhwIjoxMzAwODE5MzgwfQ.Ktfu3EdLz0SpuTIMpMoRZMtZsCATWJHeDEBGrsZE6LI"

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

unify_header(options)
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

verify(jwt, options)
verify(binary, map) :: {:ok, map} | {:error, binary}

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

verify!(jwt, options)
verify!(binary, map) :: map | no_return