Packages

jose

1.3.0
1.11.12 1.11.11 1.11.10 1.11.9 1.11.8 1.11.7 1.11.6 1.11.5 1.11.4 1.11.2 1.11.1 1.11.0 1.10.1 1.10.0 1.9.0 1.8.4 1.8.3 1.8.2 1.8.1 1.8.0 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.1 1.6.0 1.5.2 1.5.1 1.5.0 1.4.2 1.4.1 1.4.0 1.3.0 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.1 1.0.0

JSON Object Signing and Encryption (JOSE) for Erlang and Elixir.

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
46 Versions
1 Dependency
Dependants
1 Advisory
Files
Activity
jose lib jose.ex
Raw

lib/jose.ex 

defmodule JOSE do



  @moduledoc """

  JOSE stands for JSON Object Signing and Encryption. It is a set of standards 

  specified by the IETF. The oficial specifications are described below:



  - JWS (Json Web Signature)  : [RFC7515](https://tools.ietf.org/html/rfc7515)

  - JWE (Json Web Encryption) : [RFC7516](https://tools.ietf.org/html/rfc7516)

  - JWK (Json Web Key)        : [RFC7517](https://tools.ietf.org/html/rfc7517)

  - JWA (Json Web Algorithms) : [RFC7518](https://tools.ietf.org/html/rfc7518)

  - JWT (Json Web Token)      : [RFC7519](https://tools.ietf.org/html/rfc7519)



  This module is the main entry point for decoding/encoding a JWT.

  """

  

  # API

  @doc """

  Decodes a JWT in binary form into a map of claims.

  """

  def decode(binary), do: :jose.decode(binary)



  @doc """

  Encodes a given JOSE term into a binary representation.

  """

  def encode(term), do: :jose.encode(term)



  @doc """

  Retrieves the current set JSON module. 

  """

  def json_module(), do: :jose.json_module()



  

  @doc """

  Sets the JSON module used for JSON encoding/decoding. Currently 

  supports Poison and JSX.

  """

  def json_module(module), do: :jose.json_module(module)



end