@spec chacha20_poly1305_module() :: module()

Gets the current ChaCha20/Poly1305 module used by jose_chacha20_poly1305.

See chacha20_poly1305_module/1 for default.

@spec chacha20_poly1305_module(module()) :: :ok

Sets the current ChaCha20/Poly1305 module used by jose_chacha20_poly1305.

Currently supported ChaCha20/Poly1305 modules (first found is used as default):

• crypto - only when 96-bit nonce is supported
• libsodium
• jose_jwa_chacha20_poly1305 - only supported when crypto_fallback/0 is true

Additional modules that implement the jose_chacha20_poly1305 behavior may also be used.

@spec crypto_fallback() :: boolean()

Gets the current Cryptographic Algorithm Fallback state

Defaults to false.

@spec crypto_fallback(boolean()) :: :ok

Sets the current Cryptographic Algorithm Fallback state.

@spec curve448_module() :: module()

Gets the current Curve448 module used by jose_curve448

See curve448_module/1 for default.

@spec curve448_module(module()) :: :ok

Sets the current Curve448 module used by jose_curve448.

Currently supported Curve448 modules (first found is used as default):

• libdecaf
• jose_jwa_curve448 - only supported when crypto_fallback/0 is true

Additional modules that implement the jose_curve448 behavior may also be used.

@spec curve25519_module() :: module()

Gets the current Curve25519 module used by jose_curve25519

See curve25519_module/1 for default.

@spec curve25519_module(module()) :: :ok

Sets the current Curve25519 module used by jose_curve25519.

Currently supported Curve25519 modules (first found is used as default):

• libdecaf
• libsodium
• jose_jwa_curve25519 - only supported when crypto_fallback/0 is true

Additional modules that implement the jose_curve25519 behavior may also be used.

@spec decode(binary()) :: term()

Decodes JSON to a term using the module returned by json_module/0.

Returns the decoded term, or raises if binary contains invalid JSON.

@spec encode(term()) :: binary()

Encodes a term to JSON using the module returned by json_module/0.

Returns the encoded JSON, or raises if term cannot be encoded.

@spec json_module() :: module()

Gets the current JSON module used by decode/1 and encode/1, see json_module/1 for default.

@spec json_module(module()) :: :ok

Sets the current JSON module used by decode/1 and encode/1.

Currently supported JSON modules (first found is used as default):

• ojson
• Jason
• Poison
• jiffy
• jsone
• jsx

Additional modules that implement the :jose_json behavior may also be used.

@spec sha3_module() :: module()

Gets the current SHA3 module used by jose_sha3, see sha3_module/1 for default.

@spec sha3_module(module()) :: :ok

Sets the current SHA3 module used by jose_sha3.

Currently supported SHA3 modules (first found is used as default):

• keccakf1600
• libdecaf
• jose_jwa_sha3 - only supported when crypto_fallback/0 is true

Additional modules that implement the jose_sha3 behavior may also be used.

@spec unsecured_signing() :: boolean()

Gets the current Unsecured Signing state, defaults to false.

@spec unsecured_signing(boolean()) :: :ok

Sets the current Unsecured Signing state.

Enables/disables the "none" algorithm used for signing and verifying.

See Critical vulnerabilities in JSON Web Token libraries for more information.