Reactive Interaction Gateway v3.0.0-alpha.2

RIG.JWT behaviour (Reactive Interaction Gateway v3.0.0-alpha.2) View Source

JSON Web Token handling.

Link to this section Summary

Types

claims()
claims_and_errors()
ensure_not_blacklisted()

Turns claims into errors for blacklisted JWTs.

http_header()
http_header_value()
http_headers()
jwt_conf()
token()
validation_result()

Functions

config()

Returns module configuration.

encode(claims, jwt_conf \\ config().jwt_conf)

See RIG.JWT.Claims.encode/2.

parse_http_header(http_headers, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)
parse_token(token, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)
valid?(token, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)

Callbacks

parse_http_header(arg1, jwt_conf, ensure_not_blacklisted)

Find JWT claims in one or more HTTP headers.

parse_token(token, jwt_conf, ensure_not_blacklisted)

Extract claims from a given encoded JWT.

valid?(token, jwt_conf, ensure_not_blacklisted)

Checks an encoded JWT for validity.

Link to this section Types

Link to this type

claims()

View Source

Specs

claims() :: %{optional(String.t()) => String.t()}
Link to this type

claims_and_errors()

View Source

Specs

claims_and_errors() :: [validation_result()]
Link to this type

ensure_not_blacklisted()

View Source

Specs

ensure_not_blacklisted() :: (claims() -> validation_result())

Turns claims into errors for blacklisted JWTs.

Link to this type

http_header()

View Source

Specs

http_header() :: {http_header_name :: String.t(), http_header_value()}
Link to this type

http_header_value()

View Source

Specs

http_header_value() :: String.t()
Link to this type

http_headers()

View Source

Specs

http_headers() :: [http_header()]
Link to this type

jwt_conf()

View Source

Specs

jwt_conf() :: %{alg: String.t(), key: String.t()}
Link to this type

token()

View Source

Specs

token() :: String.t()
Link to this type

validation_result()

View Source

Specs

validation_result() ::
  {:ok, claims()}
  | {:error, %RIG.JWT.DecodeError{__exception__: term(), cause: term()}}

Link to this section Functions

Link to this function

config()

View Source

Specs

config() :: any()

Returns module configuration.

If application environment contains values in Keyword or Map struct, defaults from macro usage will be recursively merged with application configuration.

If one of the configuration parameters does not exist or can not be resolved, raises ArgumentError.

Link to this function

encode(claims, jwt_conf \\ config().jwt_conf)

View Source

Specs

encode(claims(), jwt_conf()) :: token()

See RIG.JWT.Claims.encode/2.

Link to this function

parse_http_header(http_headers, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)

View Source
Link to this function

parse_token(token, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)

View Source
Link to this function

valid?(token, jwt_conf \\ config().jwt_conf, ensure_not_blacklisted \\ &ensure_not_blacklisted/1)

View Source

Link to this section Callbacks

Link to this callback

parse_http_header(arg1, jwt_conf, ensure_not_blacklisted)

View Source

Specs

parse_http_header(
  http_header_value() | http_headers(),
  jwt_conf(),
  ensure_not_blacklisted()
) :: claims_and_errors()

Find JWT claims in one or more HTTP headers.

All "Authorization" headers are considered. A single header may contain one or more credentials. Only "Bearer"-type (scheme) credentials are interpreted as JSON Web Tokens. Each of those JWTs is validated using their signature. The result contains JWT claims for successfully validated tokens and errors where the validation failed.

Link to this callback

parse_token(token, jwt_conf, ensure_not_blacklisted)

View Source

Specs

parse_token(token(), jwt_conf(), ensure_not_blacklisted()) ::
  validation_result()

Extract claims from a given encoded JWT.

Link to this callback

valid?(token, jwt_conf, ensure_not_blacklisted)

View Source

Specs

valid?(token(), jwt_conf(), ensure_not_blacklisted()) :: boolean()

Checks an encoded JWT for validity.