SignCore.XML.Builder (sign_core v0.1.1)

Copy Markdown View Source

Builds XML-DSig elements for the XAdES B-B sign flow.

The shape produced is the W3C XML Signature 1.1 envelope:

<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
  <ds:SignedInfo>
    <ds:CanonicalizationMethod Algorithm=".../exc-c14n#"/>
    <ds:SignatureMethod Algorithm="..."/>
    <ds:Reference URI="...">
      <ds:Transforms>
        <ds:Transform Algorithm=".../enveloped-signature"/>
        <ds:Transform Algorithm=".../exc-c14n#"/>
      </ds:Transforms>
      <ds:DigestMethod Algorithm=".../sha256"/>
      <ds:DigestValue>...</ds:DigestValue>
    </ds:Reference>
    <ds:Reference Type="...SignedProperties" URI="#xades-...">
      <ds:Transforms>
        <ds:Transform Algorithm=".../exc-c14n#"/>
      </ds:Transforms>
      <ds:DigestMethod Algorithm=".../sha256"/>
      <ds:DigestValue>...</ds:DigestValue>
    </ds:Reference>
  </ds:SignedInfo>
  <ds:SignatureValue>...</ds:SignatureValue>
  <ds:KeyInfo>
    <ds:X509Data>
      <ds:X509Certificate>...</ds:X509Certificate>
      ...
    </ds:X509Data>
  </ds:KeyInfo>
  <ds:Object>
    <xades:QualifyingProperties .../>
  </ds:Object>
</ds:Signature>

Builder functions emit raw binary XML — exc-c14n is applied during digest / signature computation, so attribute order and whitespace in these strings is normalised away before any hash is taken.

Summary

Functions

alg_from_signature_method_uri(other)

Map an XML Signature URI back to a JOSE alg atom. Inverse of signature_method_uri/1.

c14n_exclusive_uri()

Canonicalisation method URI for Exclusive XML C14N 1.0.

digest_sha256_uri()

Digest method URI for SHA-256.

ds_ns()

URI namespace for the XML Signature ds: prefix (W3C XMLDSig).

random_id()

Helper: 8-byte hex random id suitable for XML Id attributes.

reference(uri, transforms, digest_value_b64, opts \\ [])

Build a <ds:Reference> element targeting a fragment of the enveloping document. :transforms is a list of transform URIs applied left-to-right; the typical XAdES B-B set is [envelope, exc_c14n] for the data reference and [exc_c14n] for the SignedProperties reference.

reference_xades_signed_properties_type()

URI tag for the standard XAdES SignedProperties reference Type attribute.

signature(signed_info_xml, signature_value_b64, x509_chain_b64, qualifying_properties_xml, opts \\ [])

Build the full <ds:Signature> envelope. Ready to splice into the document at the chosen insertion point.

signature_method_uri(atom)

Returns the XML Signature URI for a given JOSE alg atom.

signature_value(value_b64)

Build a standalone <ds:SignatureValue> element with the ds namespace declared inline. Used by the B-T attach path to compute the canonical bytes of the signature-value element exactly the way a verifier would re-derive them when extracting it from the signed document.

signed_info(references_xml, alg)

Build a <ds:SignedInfo> element wrapping the supplied references. The :alg selects the <ds:SignatureMethod> URI.

transform_envelope_uri()

Transform URI for the enveloped-signature rewrite.

xades_ns()

URI namespace for the XAdES xades: prefix.

Functions

alg_from_signature_method_uri(other)

@spec alg_from_signature_method_uri(String.t()) :: {:ok, atom()} | {:error, term()}

Map an XML Signature URI back to a JOSE alg atom. Inverse of signature_method_uri/1.

c14n_exclusive_uri()

Canonicalisation method URI for Exclusive XML C14N 1.0.

digest_sha256_uri()

Digest method URI for SHA-256.

ds_ns()

URI namespace for the XML Signature ds: prefix (W3C XMLDSig).

random_id()

@spec random_id() :: String.t()

Helper: 8-byte hex random id suitable for XML Id attributes.

reference(uri, transforms, digest_value_b64, opts \\ [])

@spec reference(String.t(), [String.t()], binary(), keyword()) :: String.t()

Build a <ds:Reference> element targeting a fragment of the enveloping document. :transforms is a list of transform URIs applied left-to-right; the typical XAdES B-B set is [envelope, exc_c14n] for the data reference and [exc_c14n] for the SignedProperties reference.

reference_xades_signed_properties_type()

URI tag for the standard XAdES SignedProperties reference Type attribute.

signature(signed_info_xml, signature_value_b64, x509_chain_b64, qualifying_properties_xml, opts \\ [])

@spec signature(String.t(), binary(), [binary()], String.t(), keyword()) :: String.t()

Build the full <ds:Signature> envelope. Ready to splice into the document at the chosen insertion point.

Args:

  • signed_info_xml — the <ds:SignedInfo> block produced by signed_info/2. Used verbatim (after exc-c14n) so that the signature is computed over the same bytes the verifier sees.
  • signature_value_b64 — base64 of the raw signature.
  • x509_chain_b64 — list of base64-encoded DER certs. Leaf first.
  • qualifying_properties_xml — the XAdES <xades:QualifyingProperties> element produced by SignCore.XML.XAdES.
  • :signature_id — the Id attribute on <ds:Signature>. Required for XAdES-LT compatibility; v1 just emits a fresh one if not supplied.

signature_method_uri(atom)

@spec signature_method_uri(atom()) :: String.t()

Returns the XML Signature URI for a given JOSE alg atom.

iex> SignCore.XML.Builder.signature_method_uri(:RS256)
"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"

iex> SignCore.XML.Builder.signature_method_uri(:PS256)
"http://www.w3.org/2007/05/xmldsig-more#sha256-rsa-MGF1"

signature_value(value_b64)

@spec signature_value(binary()) :: String.t()

Build a standalone <ds:SignatureValue> element with the ds namespace declared inline. Used by the B-T attach path to compute the canonical bytes of the signature-value element exactly the way a verifier would re-derive them when extracting it from the signed document.

value_b64 MUST be base64 already (RFC 4648). The caller is responsible for producing it; this builder just wraps the bytes.

signed_info(references_xml, alg)

@spec signed_info([String.t()], atom()) :: String.t()

Build a <ds:SignedInfo> element wrapping the supplied references. The :alg selects the <ds:SignatureMethod> URI.

transform_envelope_uri()

Transform URI for the enveloped-signature rewrite.

xades_ns()

URI namespace for the XAdES xades: prefix.