Lockspire.Protocol.Jarm (lockspire v1.0.0)

Copy Markdown

Core JARM (JWT Secured Authorization Response Mode) encoder.

Summary

Types

encoding_error()
signing_error()

Functions

encode(response_params, context)

Encodes the given authorization response as signed-only JARM or nested encrypted JARM.

sign(response_params, context)

Signs the given authorization response parameters into a JWS.

Types

encoding_error()

@type encoding_error() ::
  signing_error()
  | :invalid_jarm_client_metadata
  | :jarm_encryption_key_fetch_failed
  | :jarm_encryption_key_unavailable
  | :unsupported_jarm_encryption_alg
  | :unsupported_jarm_encryption_enc

signing_error()

@type signing_error() ::
  :invalid_signing_key
  | :invalid_algorithm
  | :invalid_jarm_client_metadata
  | term()

Functions

encode(response_params, context)

@spec encode(map(), map()) :: {:ok, String.t()} | {:error, encoding_error()}

Encodes the given authorization response as signed-only JARM or nested encrypted JARM.

sign(response_params, context)

@spec sign(map(), map()) :: {:ok, String.t()} | {:error, signing_error()}

Signs the given authorization response parameters into a JWS.