MessageSignatures.SignatureParams (MessageSignatures v0.1.0)

Copy Markdown View Source

The covered components + signature parameters of one signature: the value of a Signature-Input dictionary member, and (identically serialized) the value of the @signature-params base line.

On verify, this struct is built from the parsed wire form: component order, parameter order, and unknown parameter bare values survive the round trip (RFC 9421 Section 2.5). Serialization uses canonical Structured Fields encoding; unrecoverable source spelling is not retained.

Summary

Functions

The alg parameter value, or nil.

The created parameter value, or nil.

The expires parameter value, or nil.

The keyid parameter value, or nil.

The nonce parameter value, or nil.

The tag parameter value, or nil.

Types

member()

t()

@type t() :: %MessageSignatures.SignatureParams{
  components: [MessageSignatures.Component.t()],
  params: MessageSignatures.Component.params()
}

Functions

alg(signature_params)

The alg parameter value, or nil.

created(signature_params)

The created parameter value, or nil.

expires(signature_params)

The expires parameter value, or nil.

from_member(arg1)

@spec from_member(member()) :: {:ok, t()} | {:error, MessageSignatures.Error.t()}

keyid(signature_params)

The keyid parameter value, or nil.

new(component_strings, params_kw)

@spec new(
  [String.t()],
  keyword()
) :: {:ok, t()} | {:error, MessageSignatures.Error.t()}

nonce(signature_params)

The nonce parameter value, or nil.

serialize(signature_params)

@spec serialize(t()) :: {:ok, String.t()} | {:error, MessageSignatures.Error.t()}

tag(signature_params)

The tag parameter value, or nil.