Attesto.PresentationRequest (Attesto v2.28.0)

Copy Markdown View Source

OID4VP Authorization Request (OpenID4VP 1.0, 2025-07-09, §5).

Build a string-keyed, JSON-ready request for a wallet and its DCQL query. This module is pure and conn-free; sending the request is the host's concern.

Summary

Functions

Build an OID4VP Authorization Request.

Whether path is a valid DCQL claims path pointer for a credential of format (OpenID4VP 1.0 "Claims Path Pointer").

Build a DCQL query object.

Encode an Authorization Request as an application/x-www-form-urlencoded query string.

Return whether value is a syntactically valid DCQL query or claim identifier ([A-Za-z0-9_-]+).

Functions

build(opts)

@spec build(keyword()) :: %{required(String.t()) => term()}

Build an OID4VP Authorization Request.

Standard redirect responses ("direct_post" and "direct_post.jwt") require :client_id, :nonce, :response_uri, and :dcql_query. DC API responses ("dc_api" and "dc_api.jwt") require :expected_origins instead of :response_uri and omit "state" and "response_uri". Optional values are included only when supplied with a non-nil value.

claim_path?(path, format)

@spec claim_path?(term(), String.t()) :: boolean()

Whether path is a valid DCQL claims path pointer for a credential of format (OpenID4VP 1.0 "Claims Path Pointer").

A pointer is a non-empty list whose elements are strings (object keys), non-negative integers (array indices), or nil (every element of an array). An "mso_mdoc" pointer is exactly a namespace and a data element identifier, both non-empty strings. dcql_query/1 applies this rule to every claim it builds; a Wallet applies the same rule to a query it receives.

dcql_query(opts)

@spec dcql_query(keyword() | map()) :: %{required(String.t()) => term()}

Build a DCQL query object.

to_query_string(params)

@spec to_query_string(map()) :: String.t()

Encode an Authorization Request as an application/x-www-form-urlencoded query string.

valid_dcql_id?(value)

@spec valid_dcql_id?(term()) :: boolean()

Return whether value is a syntactically valid DCQL query or claim identifier ([A-Za-z0-9_-]+).