Univrse.Envelope (Univrse v0.2.0) View Source

An Envelope is a structure for encoding any arbitrary data payload for data interchange and/or storage.

An Envelope consists of a set of headers and a data payload. Optionally one or more Univrse.Signature.t/0 structures may be used to protect data integrity with digital signature and MAC algorithms. And optionally, one or more Univrse.Recipient.t/0 structures may be used to ensure confidentiality of the data payload using encryption algorithms.

A Univrse Envelope can be serialised into several formats appropriate for data interchange or storage.

CBOR encoding
String encoding
Bitcoin script

Link to this section Summary

Types

encoding()

Envelope encoding

t()

Envelope struct

Functions

decode(binary)

Decodes the given binary into an Envelope structure.

decode(data, atom)

Decodes the given binary into an Envelope structure, using the specified t:encoding().

decode_payload(env, payload)

Decodes the given CBOR encoded payload and puts it in the envelope struct.

decrypt(env, key, opts \\ [])

See Univrse.Recipient.decrypt/3.

decrypt_at(env, idx, key, opts \\ [])

Decrypts the envelope payload by first decrypting the content key for the recipient at the specified index with the given key.

encode(env, encoding \\ :cbor)

Decodes the Envelope into a binary using the specified t:encoding().

encode_payload(envelope)

CBOR encodes the Envelope payload and returns the encoded binary.

encrypt(env, key, headers, opts \\ [])

See Univrse.Recipient.encrypt/4.

parse_script(script)

Parses the given Bitcoin Script and returns an Envelope structure.

push(env, signature)

Pushes the given t:Signature.t or t:Recipient.t into the Envelope.

sign(env, key, headers \\ %{})

See Univrse.Signature.sign/3.

to_script(env, false_return \\ true)

Encodes the envelope into a valid Univrse OP_RETURN script and returns the script.

verify(env, key)

See Univrse.Signature.verify/2.

wrap(payload, headers \\ %{})

Wraps the given payload and headers in a new Envelope structure.

Link to this section Types

encoding()

Specs

encoding() :: :cbor | :base64

Envelope encoding

t()

Specs

t() :: %Univrse.Envelope{
  header: Univrse.Header.t(),
  payload: any(),
  recipient: nil,
  signature: Univrse.Signature.t() | [Univrse.Signature.t()] | nil
}

Envelope struct

Link to this section Functions

decode(binary)

Specs

decode(binary()) :: {:ok, t()} | {:error, any()}

Decodes the given binary into an Envelope structure.

Automatically detects the correct encoding from the binary, assuming it is a supported t:encoding().

decode(data, atom)

Specs

decode(binary(), encoding()) :: {:ok, t()} | {:error, any()}

Decodes the given binary into an Envelope structure, using the specified t:encoding().

decode_payload(env, payload)

Specs

decode_payload(t(), binary()) :: {:ok, t()} | {:error, any()}

Decodes the given CBOR encoded payload and puts it in the envelope struct.

decrypt(env, key, opts \\ [])

See Univrse.Recipient.decrypt/3.

decrypt_at(env, idx, key, opts \\ [])

Specs

decrypt_at(t(), integer(), Univrse.Key.t(), keyword()) ::
  {:ok, t()} | {:error, any()}

Decrypts the envelope payload by first decrypting the content key for the recipient at the specified index with the given key.

The envelope must contain multiple recipients.

encode(env, encoding \\ :cbor)

Specs

encode(t(), encoding()) :: binary() | String.t()

Decodes the Envelope into a binary using the specified t:encoding().

Default encoding is :cbor.

encode_payload(envelope)

Specs

encode_payload(t()) :: binary()

CBOR encodes the Envelope payload and returns the encoded binary.

encrypt(env, key, headers, opts \\ [])

See Univrse.Recipient.encrypt/4.

parse_script(script)

Specs

parse_script(BSV.Script.t()) :: {:ok, t()} | {:error, any()}

Parses the given Bitcoin Script and returns an Envelope structure.

push(env, signature)

Specs

push(t(), Univrse.Signature.t() | Univrse.Recipient.t()) :: t()

Pushes the given t:Signature.t or t:Recipient.t into the Envelope.

sign(env, key, headers \\ %{})

See Univrse.Signature.sign/3.

to_script(env, false_return \\ true)

Specs

to_script(t(), boolean()) :: BSV.Script.t()

Encodes the envelope into a valid Univrse OP_RETURN script and returns the script.

verify(env, key)

See Univrse.Signature.verify/2.

wrap(payload, headers \\ %{})

Specs

wrap(any(), map() | Univrse.Header.t()) :: t()

Wraps the given payload and headers in a new Envelope structure.