| Internet-Draft | json-proof-algorithms | July 2025 |
| Jones, et al. | Expires 8 January 2026 | [Page] |
The JSON Proof Algorithms (JPA) specification registers cryptographic algorithms and identifiers to be used with the JSON Web Proof, JSON Web Key (JWK), and COSE specifications. It defines IANA registries for these identifiers.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 8 January 2026.¶
Copyright (c) 2025 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
The JSON Web Proof (JWP) [I-D.ietf-jose-json-web-proof] draft establishes a new secure container format that supports selective disclosure and unlinkability using Zero-Knowledge Proofs (ZKPs) or other cryptographic algorithms.¶
Editor's Note: This draft is still early and incomplete. There will be significant changes to the algorithms as currently defined here. Please do not use any of these definitions or examples for anything except personal experimentation and learning. Contributions and feedback are welcomed at https://github.com/ietf-wg-jose/json-web-proof.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The roles of "issuer", "holder", and "verifier" are used as defined by the VC Data Model [VC-DATA-MODEL-2.0]. The term "presentation" is also used as defined by this source, but the term "credential" is avoided in this specification to minimize confusion with other definitions.¶
The terms "JSON Web Signature (JWS)", "Base64url Encoding", "Header Parameter", "JOSE Header", "JWS Payload", "JWS Signature", and "JWS Protected Header" are defined by [RFC7515].¶
The terms "JSON Web Proof (JWP)", "JWP Payload", "JWP Proof", and "JWP Protected Header" are defined by [I-D.ietf-jose-json-web-proof].¶
These terms are defined by this specification:¶
JWP defines a container binding together a protected header, one or more payloads, and a cryptographic proof. It does not define any details about the interactions between an application and the cryptographic libraries that implement proof-supporting algorithms.¶
Due to the nature of ZKPs, this specification also documents the subtle but important differences in proof algorithms versus those defined by the JSON Web Algorithms [RFC7518]. These differences help support more advanced capabilities such as blinded signatures and predicate proofs.¶
The four principal interactions that every proof algorithm MUST support are issue, confirm, present, and verify.¶
The JWP is first created as the output of a JPA's issue operation.¶
Every algorithm MUST support a JSON issuer protected header along with one or more octet string payloads. The algorithm MAY support using additional items provided by the holder for issuance such as blinded payloads, keys for replay prevention, etc.¶
All algorithms MUST provide integrity protection for the issuer header and all payloads and MUST specify all digest and/or hash2curve methods used.¶
Performed by the holder to validate that the issued JWP is correctly formed and protected.¶
Each algorithm MAY support using additional input items options, such as those sent to the issuer for issuance. After confirmation, an algorithm MAY return a modified JWP for serialized storage without the local state (such as with blinded payloads now unblinded).¶
The algorithm MUST fully verify the issued proof value against the issuer protected header and all payloads. If given a presented JWP instead of an issued one, the confirm process MUST return an error.¶
Used to apply any selective disclosure choices and perform any unlinkability transformations, as well as to show binding.¶
An algorithm MAY support additional input options from the requesting party, such as for predicate proofs and verifiable computation requests.¶
Every algorithm MUST support the ability to hide any or all payloads. It MUST always include the issuer protected header unmodified in the presentation.¶
The algorithm MUST replace the issued proof value and generate a new presented proof value. It also MUST include a new presentation protected header that provides replay protection.¶
Performed by the verifier to verify the protected headers along with any disclosed payloads and/or assertions about them from the proving party, while also verifying they are the same payloads and ordering as witnessed by the issuer.¶
The algorithm MUST verify the integrity of all disclosed payloads and MUST also verify the integrity of both the issuer and presentation protected headers.¶
If the presented proof contains any assertions about the hidden payloads, the algorithm MUST also verify all of those assertions. It MAY support additional options, such as those sent to the holder to generate the presentation.¶
If given an issued JWP for verification, the algorithm MUST return an error.¶
This section defines how to use specific algorithms for JWPs.¶
The Single Use (SU) algorithm is based on composing multiple traditional asymmetric signatures into a single JWP proof. It enables a very simple form of selective disclosure without requiring any advanced cryptographic techniques.¶
It does not support unlinkability if the same JWP is presented multiple times, therefore when privacy is required the holder will need to interact with the issuer again to receive new single-use JWPs (dynamically or in batches).¶
The Single Use algorithm uses multiple signing keys to protect the protected header as well as individual payloads of an Issued JWP. The issuer uses a stable public key to sign each protected header, and a per-JWP ephemeral key (conveyed within the protected header) to protect the individual payloads. These signatures are all created using the same Asymmetric Algorithm, with the JOSE and COSE name/label of this algorithm being part of registration for a fully-specified Single Use algorithm identifier.¶
The issuer protected header also conveys a holder presentation key, an ephemeral asymmetric key meant to only be used for presenting a single JWP. The fully-specified algorithm the holder must use for presentations is also included. This algorithm MAY be different from the algorithm used by the issuer.¶
The chosen algorithms MUST be asymmetric signing algorithms, so that each signature can be verified without sharing any private values between the parties.¶
In order to support the protection of a presentation by a holder to a verifier, the holder MUST use a Holder Presentation Key during the issuance and the presentation of every Single Use JWP. This Holder Presentation Key MUST be generated and used for only one JWP if unlinkability is desired.¶
The issuer MUST verify that the holder has possession of this key. The holder-issuer communication to exchange this information is out of scope of this specification, but can be accomplished by the holder using this key to generate a JWS that signs a value the issuer can verify as unique.¶
The issuer MUST determine an appropriate holder presentation algorithm
corresponding to the holder presentation key. If the holder and
verifier cannot be assumed to know this algorithm is the appropriate
choice for a given holder presentation key, this value MUST be conveyed
in the hpa issuer protected header.¶
To create a Single Use JWP, the issuer first generates a unique Ephemeral Key using the selected internal algorithm. This key-pair will be used to sign each of the payloads of a single JWP and then discarded.¶
Each individual payload is signed using the selected internal algorithm using the Ephemeral Key.¶
The Issuer's Ephemeral Key MUST be included via the Issuer Ephemeral Key header parameter.¶
The Holder's Presentation Key MUST be included via the Holder Presentation Key header parameter.¶
The Holder's Presentation Algorithm MUST be included via the Holder Presentation Algorithm header parameter unless there is another way for the holder and verifier to unambiguously determine the appropriate algorithm to use.¶
The Issuer Protected Header is signed using the appropriate internal signing algorithm for the given fully-specified single use algorithm, using the issuer's Stable Key.¶
Each JWP payload is processed in order and signed using the given JWA using the issuer's Ephemeral Key.¶
The proof value is an octet string array. The first entry is the octet string of the issuer protected header signature, with an additional entry for each payload signature.¶
To generate a new presentation, the holder first creates a presentation
protected header that is specific to the verifier being presented to.
This header MUST contain a parameter that both the holder and verifier
trust as being unique and non-replayable. Use of the nonce header
parameter is RECOMMENDED for this purpose.¶
This specification registers the nonce header parameter for the
presentation protected header that contains a string value either
generated by the verifier or derived from values provided by the
verifier. When present, the verifier MUST ensure the nonce value
matches during verification.¶
The presentation protected header MAY contain other header parameters that are either provided by the verifier or by the holder. These presentation header parameters SHOULD NOT contain values that are common across multiple presentations and SHOULD be unique to a single presentation and verifier.¶
The presentation protected header MUST contain the same Algorithm protected header as the issuer protected header. The Holder Presentation Algorithm protected header MUST NOT be included.¶
The holder derives a new proof as part of presentation. The holder will also use these components to generate a presentation internal representation. The number of components depends on the number of payloads which are being disclosed in the presented JWP.¶
The first proof component will be the signature over the issuer protected header made by the issuer's Stable Key.¶
For each payload which is to be disclosed, the corresponding payload signature (from the issued JWP) is included as a subsequent proof component. If the payload is being omitted, the corresponding payload signature is omitted from the proof components.¶
The holder protected header, issuer protected header, payload slots (distinguishing which are being disclosed) and these proof components are inputs to determine the presentation internal representation.¶
The holder's signature over the presentation internal representation (using the holder's private key and the holder presentation algorithm) is then included as one additional proof component in the final presentation.¶
For example, if only the second and fifth of five payloads are being disclosed, then the proof at this stage will consist of three values:¶
The presentation internal representation would be calculated with these three proof components, while the final presentation would have an additional fourth component containing the signature using the holder's private key.¶
Since the individual signatures in the proof value are unique and remain unchanged across multiple presentations, a Single Use JWP SHOULD only be presented a single time to each verifier in order for the holder to remain unlinkable across multiple presentations.¶
Verification is performed using the following steps.¶
The proposed JWP alg value is of the format "SU-" appended with the
relevant JWS alg value for the chosen public and ephemeral key-pair
algorithm, for example "SU-ES256".¶
Some algorithms (such as Single use and MAC) use a holder key to provide integrity over the presentation. For these algorithms, an internal binary form of the presentation must be generated both for signing by the holder, and for verification by the verifier. Other algorithms MAY use this same form for consistency.¶
The instructions for creating this binary representation will also create well-formed CBOR, although this data is not meant to be shared outside the implementing algorithm. Instead, it focuses on simplicity of generation by the holder and verifier implementations. Although CBOR has multiple representations of the same underlying information, this same octet string MUST be generated by an implementation.¶
When a length or count is added by the steps below, it is added as its 8
byte, network-ordered representation. For example, the length of a
1,234 byte payload would have a length representation of
0x00 00 00 00 00 00 04 D2.¶
The binary representation is created by appending data into a single octet string in the following order:¶
0x84 5B¶
0x5B¶
0x9B¶
For each payload representation:¶
0x9B¶
The number of proof components as specified by the algorithm¶
For each proof component, append:¶
The BBS Signature Scheme [I-D.irtf-cfrg-bbs-signatures] is under active development within the CRFG.¶
This algorithm supports both selective disclosure and unlinkability, enabling the holder to generate multiple presentations from one issued JWP without a verifier being able to correlate those presentations together based on the proof.¶
The BBS algorithm corresponds to a ciphersuite identifier of
BBS_BLS12381G1_XMD:SHA-256_SSWU_RO_.¶
The key used for the BBS algorithm is an elliptic curve-based key
pair, specifically against the G_2 subgroup of a pairing friendly curve.
Additional details on key generation can be found in
Section 3.4. The JWK and Cose Key
Object representations of the key are detailed in
[I-D.ietf-cose-bls-key-representations].¶
There is no additional holder presentation key necessary for presentation proofs.¶
Issuance is performed using the Sign operation from
Section 3.5.1 of [I-D.irtf-cfrg-bbs-signatures]. This operation
utilizes the issuer's BLS12-381 G2 key pair as SK and PK, along with
desired protected header octets as header, and the array of payload
octet string as messages.¶
The octets resulting from this operation form a single octet string in the issuance proof array, to be used along with the protected header and payloads to serialize the JWP.¶
Holder verification of the signature on issuance form is performed using
the Verify operation from [@!I-D.irtf-cfrg-bbs-signatures, section
3.5.2].¶
This operation utilizes the issuer's public key as PK, the proof as
signature, the protected header octets as header and the array of
payload octets as messages.¶
Derivation of a presentation is done by the holder using the ProofGen
operation from Section 3.5.3 of [I-D.irtf-cfrg-bbs-signatures].¶
This operation utilizes the issuer's public key as PK, the issuer
protected header as header, the issuance proof as signature, the
issuance payloads as messages, and the holder's presentation protected
header as ph.¶
The operation also takes a vector of indexes into messages, describing
which payloads the holder wishes to disclose. All payloads are required
for proof generation, but only these indicated payloads will be required
to be disclosed for later proof verification.¶
The output of this operation is the presentation proof, as a single octet string.¶
Presentation serialization leverages the two protected headers and
presentation proof, along with the disclosed payloads. Non-disclosed
payloads are represented with the absent value of null in CBOR
serialization and a zero-length string in compact serialization.¶
Verification of a presentation is done by the verifier using the
ProofVerify operation from [@!I-D.irtf-cfrg-bbs-signatures, Section
3.5.4].¶
This operation utilizes the issuer's public key as PK, the issuer
protected header as header, the issuance proof as signature, the
holder's presentation protected header as ph, and the payloads as
disclosed_messages.¶
In addition, the disclosed_indexes scalar array is calculated from the
payloads provided. Values disclosed in the presented payloads have a
zero-based index in this array, while the indices of absent payloads are
omitted.¶
The Message Authentication Code (MAC) JPA uses a MAC to both generate ephemeral secrets and to authenticate payloads, along with an asymmetric signature to provide integrity to the issued JWP.¶
The holder can manipulate which payloads are disclosed from the issued JWP, and uses the Holder Presentation Key to create a presentation. The signature created from the Holder Presentation Key MAY use a different algorithm than the Issuer used to sign the issued form.¶
Like the Single Use algorithm family, it also does not support unlinkability if the same JWP is presented multiple times and requires an individually issued JWP for each presentation in order to fully protect privacy. When compared to the JWS approach, using a MAC requires less computation but can result in potentially larger presentation proof values.¶
The design is intentionally minimal and only involves using a single standardized MAC method instead of a mix of MAC/hash methods or a custom hash-based construct. It is able to use any published cryptographic MAC method such as HMAC [RFC2104] or KMAC. It uses traditional public key-based signatures to verify the authenticity of the issuer and holder.¶
In order to support the protection of a presentation by a holder to a verifier, the holder MUST use a Holder Presentation Key during the issuance and the presentation of every MAC JWP. This Holder Presentation Key MUST be generated and used for only one JWP if unlinkability is desired.¶
The issuer MUST verify that the holder has possession of this key. The holder-issuer communication to exchange this information is out of scope of this specification, but can be accomplished by the holder using this key to generate a JWS that signs a value the issuer can verify as unique.¶
The holder's presentation key MUST be included in the issuer's protected header using the Holder Presentation Key header parameter.¶
The issuer MUST determine an appropriate holder presentation algorithm corresponding to the holder presentation key. If the holder and verifier cannot be assumed to know this algorithm is the appropriate choice for a given holder presentation key, this value MUST be conveyed in the Holder Protected Algorithm header parameter.¶
To use the MAC algorithm, the issuer must have a stable public key pair to perform signing. To start the issuance process, a single 32-byte random Shared Secret must first be generated. This value will be shared privately with the holder as part of the issuer's JWP proof value.¶
The Shared Secret is used by both the issuer and holder as the MAC method's key to generate a new set of unique ephemeral keys. These keys are then used as the input to generate a MAC that protects each payload.¶
The combined MAC representation is a single octet string representing the MAC values of the issuer protected header, along with each payload provided by the issuer. This representation is signed by the issuer, but not shared - parties will recreate this octet string and verify the signature to verify the integrity of supplied issuer protected header and the integrity of any disclosed payloads.¶
The steps below describe a sequential concatenation of binary values to generate the Combined MAC Representation. The instructions for generating this octet string will also generate well-formed CBOR, although this data is not meant to be shared outside the implementing algorithm. Instead, it focuses on simplicity of generation by the issuer, holder, and verifier implementations. Although CBOR has multiple representations of the same underlying information, this same octet string MUST be generated by an implementation.¶
When a length or count is added by steps in this section, it is added as
its 8-byte, network-ordered representation. For example, the length of
a 1,234-byte payload would have a length representation of
0x00 00 00 00 00 00 04 D2.¶
The holder will a unique key per payload value using a MAC, with the Shared Secret as the key and a generated binary value. This binary value is constructed by appending data into a single octet string:¶
The holder will also compute a corresponding MAC of each payload. This MAC uses the unique key above and the payload octet string as the value.¶
When verifying a presentation, the shared secret will be unavailable so the unique key cannot be calculated. The payload octet string may also be omitted in the presentation. The following instructions describe how to get the corresponding MAC of each payload:¶
The binary representation is created by appending data into a single octet string in the following order:¶
The Holder's Presentation Key MUST be included via the Holder Presentation Key header parameter.¶
The Holder's Presentation Algorithm MUST be included via the Holder Presentation Algorithm header parameter unless there is another way for the holder and verifier to unambiguously determine the appropriate algorithm to use.¶
The issuer proof consists of two octet strings.¶
The first octet string is the issuer signature over the combined MAC representation. The issuer signs the combined MAC representation using its stable public key, and the internal signing algorithm for the given fully-specified MAC algorithm variant.¶
The second octet string is the Shared Secret used to generate the per-payload keys for the combined representation.¶
See the Presentation Protected Header section given for Single Use algorithms.¶
The presentation proof is made of multiple components.¶
The first proof component is the issuer signature over the Combined MAC Representation, which is provided as the first proof component from the issued form.¶
There will now be one proof component per payload slot in the issued JWP. These are used by the verifier to reconstruct the combined MAC representation without access to the Shared Secret. The proof components are calculated per the instructions used to generate the Combined MAC Representation¶
If a payload is disclosed, the corresponding proof component will be the unique key.¶
If a payload is not disclosed, the corresponding proof component will be the payload's MAC (using the unique key.)¶
The holder protected header, issuer protected header, payload slots (distinguishing which are being disclosed) and above proof components are inputs to determine the presentation internal representation.¶
The holder's signature over the presentation internal representation (using the holder's private key and the holder presentation algorithm) is then included as one additional proof component in the final presentation.¶
The presented form should have two more proof components than payload slots in the issued JWP.¶
Note that the second component of the issued JWP is a shared secret for use by the holder to generate the unique keys used in the Combined MAC Representation. This MUST NOT be included in the presentation.¶
Verification is performed using the following steps.¶
Proposed JWP alg value is of the format "MAC-" appended with a unique
identifier for the set of MAC and signing algorithms used. Below are
the initial registrations:¶
MAC-H256 uses HMAC SHA-256 as the MAC and
ECDSA using P-256 and SHA-256 for the signatures¶
MAC-H384 uses HMAC SHA-384 as the MAC and
ECDSA using P-384 and SHA-384 for the signatures¶
MAC-H512 uses HMAC SHA-512 as the MAC and
ECDSA using P-521 and SHA-512 for the signatures¶
MAC-K25519 uses KMAC SHAKE128 as the MAC and
EdDSA using Curve25519 for the signatures¶
MAC-K448 uses KMAC SHAKE256 as the MAC and EdDSA using Curve448
for the signatures¶
MAC-H256K uses HMAC SHA-256 as the MAC and
ECDSA using secp256k1 and SHA-256 for the signatures¶
Editor's Note: This will follow once the algorithms defined here have become more stable.¶
The following registration procedure is used for all the registries established by this specification.¶
Values are registered on a Specification Required [RFC5226] basis after a three-week review period on the jose-reg-review@ietf.org mailing list, on the advice of one or more Designated Experts. However, to allow for the allocation of values prior to publication, the Designated Experts may approve registration once they are satisfied that such a specification will be published.¶
Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register JWP algorithm: example").¶
Within the review period, the Designated Experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. Registration requests that are undetermined for a period longer than 21 days can be brought to the IESG's attention (using the iesg@ietf.org mailing list) for resolution.¶
Criteria that should be applied by the Designated Experts include determining whether the proposed registration duplicates existing functionality, whether it is likely to be of general applicability or useful only for a single application, and whether the registration description is clear.¶
IANA must only accept registry updates from the Designated Experts and should direct all requests for registration to the review mailing list.¶
It is suggested that multiple Designated Experts be appointed who are able to represent the perspectives of different applications using this specification, in order to enable broadly informed review of registration decisions. In cases where a registration decision could be perceived as creating a conflict of interest for a particular Expert, that Expert should defer to the judgment of the other Experts.¶
This specification establishes the IANA "JSON Web Proof Algorithms"
registry for values of the JWP alg (algorithm) parameter in JWP Header
Parameters. The registry records the algorithm name, the algorithm
description, the algorithm usage locations, the implementation
requirements, the change controller, and a reference to the
specification that defines it. The same algorithm name can be
registered multiple times, provided that the sets of usage locations are
disjoint.¶
It is suggested that the length of the key be included in the algorithm name when multiple variations of algorithms are being registered that use keys of different lengths and the key lengths for each need to be fixed (for instance, because they will be created by key derivation functions). This allows readers of the JSON text to more easily make security decisions.¶
The Designated Experts should perform reasonable due diligence that algorithms being registered either are currently considered cryptographically credible or are being registered as Deprecated or Prohibited.¶
The implementation requirements of an algorithm may be changed over time as the cryptographic landscape evolves, for instance, to change the status of an algorithm to Deprecated or to change the status of an algorithm from Optional to Recommended+ or Required. Changes of implementation requirements are only permitted on a Specification Required basis after review by the Designated Experts, with the new specification defining the revised implementation requirements level.¶
Single-Use JWP using ES256.)
Descriptive names may not match other registered names unless the
Designated Experts state that there is a compelling reason to
allow an exception.¶
SU-ES256). This label is a
case-sensitive ASCII string. JSON Labels may not match other
registered labels in a case-insensitive manner unless the
Designated Experts state that there is a compelling reason to allow
an exception.¶
1). CBOR Labels may not match
other registered labels unless the Designated Experts state that there
is a compelling reason to allow an exception.¶
Issued or Presented. Other values may be used with the
approval of a Designated Expert.¶
Required, Recommended, Optional, Deprecated, or
Prohibited. Optionally, the word can be followed by a + or -.
The use of + indicates that the requirement strength is likely to be
increased in a future version of the specification. The use of -
indicates that the requirement strength is likely to be decreased in a
future version of the specification. Any identifiers registered for
algorithms that are otherwise unsuitable for direct use as JWP
algorithms must be registered as Prohibited.¶
SU-ES256¶
SU-ES384¶
SU-ES512¶
BBS¶
BBS_BLS12381G1_XMD:SHA-256_SSWU_RO_H2G_HM2S_¶
MAC-H256¶
MAC-H256 uses HMAC SHA-256 as the MAC, and
ECDSA using P-256 and SHA-256 for the signatures¶
MAC-H384¶
MAC-H384 uses HMAC SHA-384 as the MAC, and
ECDSA using P-384 and SHA-384 for the signatures¶
MAC-H512¶
MAC-H512 uses HMAC SHA-512 as the MAC, and
ECDSA using P-521 and SHA-512 for the signatures¶
MAC-K25519¶
MAC-K25519 uses KMAC SHAKE128 as the MAC,
and EdDSA using Curve25519 for the signatures¶
MAC-K448¶
MAC-K448 uses KMAC SHAKE256 as the MAC, and
EdDSA using Curve448 for the signatures¶
MAC-H256K¶
MAC-H256K uses HMAC SHA-256 as the MAC, and
ECDSA using secp256k1 and SHA-256 for the signatures¶
The following examples use algorithms defined in JSON Proof Algorithms and also contain the keys used, so that implementations can validate these samples.¶
This example uses the Single-Use Algorithm as defined in JSON Proof Algorithms to create a JSON Proof Token. It demonstrates how to apply selective disclosure using an array of traditional JWS-based signatures. Unlinkability is only achieved by using each JWP one time, as multiple uses are inherently linkable via the traditional ECDSA signature embedded in the proof.¶
To begin, we need two asymmetric keys for Single Use: one that represents the JPT Issuer's stable key and the other is an ephemeral key generated by the Issuer just for this JWP.¶
This is the Issuer's stable private key used in this example in the JWK format:¶
{
"kty": "EC",
"crv": "P-256",
"x": "w0Cp0EHZsqo6bfcVisBIh7YD63niYBR-cZtQQI9Ecjg",
"y": "c-iH_xhJvZP-XF_1dy89BSa_0txk0IQjqTqxEVz88lQ",
"d": "-rjlG05jRNS9tkl4rxQ4iv0qakc04za6LCm_af6r2_c"
}
This is the ephemeral private key used in this example in the JWK format:¶
{
"kty": "EC",
"crv": "P-256",
"x": "TvODdykVxGdJGmra-PC6v8VzyQv2emoXF-hbULAWUIQ",
"y": "04QgbjSxnqkLJZWfyDFGaMxXRoeqQGoIMJpPXzKbY7s",
"d": "I-2DkEtyzHDkvO4HXwt4d4TeKmjCXGkpMCHu4tgOQWM"
}
This is the Holder's presentation private key used in this example in the JWK format:¶
{
"kty": "EC",
"crv": "P-256",
"x": "zpLXVfOaUCmpBABg2Kfg4efNgHZBPDiFc38wa5pNai8",
"y": "M7ehm3b-HwSxFoSYRTyJHU0E8_dI5k1lOcuWE-0ryxg",
"d": "swsKyZx4VBR-4TGGr3jbYvWNmRLCjzCKscgl0d3WM-8"
}
The JWP Protected Header declares that the data structure is a JPT and the JWP Proof Input is secured using the Single-Use ECDSA algorithm with the P-256 curve and SHA-256 digest. It also includes the ephemeral public key, the Holder's presentation public key and list of claims used for this JPT.¶
{
"alg": "SU-ES256",
"typ": "JPT",
"iss": "https://issuer.example",
"hpa": "ES256",
"claims": [
"iat",
"exp",
"family_name",
"given_name",
"email",
"address",
"age_over_21"
],
"iek": {
"kty": "EC",
"crv": "P-256",
"x": "TvODdykVxGdJGmra-PC6v8VzyQv2emoXF-hbULAWUIQ",
"y": "04QgbjSxnqkLJZWfyDFGaMxXRoeqQGoIMJpPXzKbY7s"
},
"hpk": {
"kty": "EC",
"crv": "P-256",
"x": "zpLXVfOaUCmpBABg2Kfg4efNgHZBPDiFc38wa5pNai8",
"y": "M7ehm3b-HwSxFoSYRTyJHU0E8_dI5k1lOcuWE-0ryxg"
}
}
eyJhbGciOiJTVS1FUzI1NiIsInR5cCI6IkpQVCIsImlzcyI6Imh0dHBzOi8vaXNzdWVyL mV4YW1wbGUiLCJocGEiOiJFUzI1NiIsImNsYWltcyI6WyJpYXQiLCJleHAiLCJmYW1pbH lfbmFtZSIsImdpdmVuX25hbWUiLCJlbWFpbCIsImFkZHJlc3MiLCJhZ2Vfb3Zlcl8yMSJ dLCJpZWsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsIngiOiJUdk9EZHlrVnhHZEpH bXJhLVBDNnY4Vnp5UXYyZW1vWEYtaGJVTEFXVUlRIiwieSI6IjA0UWdialN4bnFrTEpaV 2Z5REZHYU14WFJvZXFRR29JTUpwUFh6S2JZN3MifSwiaHBrIjp7Imt0eSI6IkVDIiwiY3 J2IjoiUC0yNTYiLCJ4IjoienBMWFZmT2FVQ21wQkFCZzJLZmc0ZWZOZ0haQlBEaUZjMzh 3YTVwTmFpOCIsInkiOiJNN2VobTNiLUh3U3hGb1NZUlR5SkhVMEU4X2RJNWsxbE9jdVdF LTByeXhnIn19
The Single Use algorithm utilizes multiple individual JWS Signatures.
Each signature value is generated by creating a JWS with a single
Protected Header with the associated alg value. In this example, the
fixed header used for each JWS is the serialized JSON Object
{"alg":"ES256"}. This protected header will be used to generate a
signature over each corresponding payload in the JWP. The corresponding
octet value in the proof is the octet string (base64url-decoded) value
of the signature.¶
The final proof value from the Issuer is an array with the octets of the header signature, followed by entries for each payload signature.¶
[
1714521600,
1717199999,
"Doe",
"Jay",
"jaydoe@example.org",
{
"formatted": "1234 Main St.\nAnytown, CA 12345\nUSA",
"street_address": "1234 Main St.",
"locality": "Anytown",
"region": "CA",
"postal_code": 12345,
"country": "USA"
},
true
]
The compact serialization of the same JPT is:¶
eyJhbGciOiJTVS1FUzI1NiIsInR5cCI6IkpQVCIsImlzcyI6Imh0dHBzOi8vaXNzdWVyL mV4YW1wbGUiLCJocGEiOiJFUzI1NiIsImNsYWltcyI6WyJpYXQiLCJleHAiLCJmYW1pbH lfbmFtZSIsImdpdmVuX25hbWUiLCJlbWFpbCIsImFkZHJlc3MiLCJhZ2Vfb3Zlcl8yMSJ dLCJpZWsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsIngiOiJUdk9EZHlrVnhHZEpH bXJhLVBDNnY4Vnp5UXYyZW1vWEYtaGJVTEFXVUlRIiwieSI6IjA0UWdialN4bnFrTEpaV 2Z5REZHYU14WFJvZXFRR29JTUpwUFh6S2JZN3MifSwiaHBrIjp7Imt0eSI6IkVDIiwiY3 J2IjoiUC0yNTYiLCJ4IjoienBMWFZmT2FVQ21wQkFCZzJLZmc0ZWZOZ0haQlBEaUZjMzh 3YTVwTmFpOCIsInkiOiJNN2VobTNiLUh3U3hGb1NZUlR5SkhVMEU4X2RJNWsxbE9jdVdF LTByeXhnIn19.MTcxNDUyMTYwMA~MTcxNzE5OTk5OQ~IkRvZSI~IkpheSI~ImpheWRvZU BleGFtcGxlLm9yZyI~eyJmb3JtYXR0ZWQiOiIxMjM0IE1haW4gU3QuXG5Bbnl0b3duLCB DQSAxMjM0NVxuVVNBIiwic3RyZWV0X2FkZHJlc3MiOiIxMjM0IE1haW4gU3QuIiwibG9j YWxpdHkiOiJBbnl0b3duIiwicmVnaW9uIjoiQ0EiLCJwb3N0YWxfY29kZSI6MTIzNDUsI mNvdW50cnkiOiJVU0EifQ~dHJ1ZQ.1VeYSDPoVuR4JclOHWom6qds_1EIovMyh_9AzMQd LzDUWiqEIYofPXZ5PPRT7aedj7iHepgTa3raOkl1zQMtEA~9jUlw9aiT75xLyzBa12iNh TEoZtye_nGOB1kAE3WW5fRfPL5Bahdo6wf-NLXEdESr878FWn8j6EiSan3LGUA3w~UCBf RWTqCaLybao4KD0z82yaKSnGVpBi_41w9b9_dpILDj96MhnG561o8pB7-filFnsXE3-UO fEgusAoNles8A~09NzGFXibw_1oD0dbjcFeXUNVJb4IeoJqy_B4BNT1lmWOm4Legakr6V 8vOWJ8FEg0OGUVYYVtl3cxWTPsW20oQ~_eZH-t6HLIR34qC5t8Wvfq_lkBffYM0q9-ddR oxgHXsOZuw2bOgTja98kHR5GlmpcHK8YrKPVTIpTTcy3Aum8g~GVWPBG0vnfrbeNrwlT6 N7gfLiUJlP_LtUB3pcLKrB3vNGMH6qHVkuHlKBTW_QymV3qORcj4jBw1ThgW0ROwMXA~m g8DnreZ97O8VsN6-l5k8RnvRpPuAoS8FQ-Rx0D-N_-hrOB53v_TTw4Yu0e-pLDDTJAQUb FawKHx2I4iQU5RMw~ERNHp0bFjFH2GmSRP2NCVMEe78u0j2CnpkP3hmu5TXKH-U5MlDcm mw6gGpXBctbCF8m6jGdn9HlUqqP_TfYVug
To present this JPT, we first use the following presentation header with a nonce (provided by the Verifier):¶
{
"alg": "SU-ES256",
"aud": "https://recipient.example.com",
"nonce": "8NGMvPDI5gODnW3kY5i4zE65kGghuFRBo_xQxYmwRpw"
}
eyJhbGciOiJTVS1FUzI1NiIsImF1ZCI6Imh0dHBzOi8vcmVjaXBpZW50LmV4YW1wbGUuY 29tIiwibm9uY2UiOiI4TkdNdlBESTVnT0RuVzNrWTVpNHpFNjVrR2dodUZSQm9feFF4WW 13UnB3In0
We apply selective disclosure of only the given name and age claims (family name and email hidden), and remove the proof components corresponding to these entries.¶
Using the selectively disclosed information, we generate the presentation internal representation. Using that and the selectively disclosed payloads, we get the following presented JPT in compact serialization:¶
eyJhbGciOiJTVS1FUzI1NiIsImF1ZCI6Imh0dHBzOi8vcmVjaXBpZW50LmV4YW1wbGUuY 29tIiwibm9uY2UiOiI4TkdNdlBESTVnT0RuVzNrWTVpNHpFNjVrR2dodUZSQm9feFF4WW 13UnB3In0.eyJhbGciOiJTVS1FUzI1NiIsInR5cCI6IkpQVCIsImlzcyI6Imh0dHBzOi8 vaXNzdWVyLmV4YW1wbGUiLCJocGEiOiJFUzI1NiIsImNsYWltcyI6WyJpYXQiLCJleHAi LCJmYW1pbHlfbmFtZSIsImdpdmVuX25hbWUiLCJlbWFpbCIsImFkZHJlc3MiLCJhZ2Vfb 3Zlcl8yMSJdLCJpZWsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsIngiOiJUdk9EZH lrVnhHZEpHbXJhLVBDNnY4Vnp5UXYyZW1vWEYtaGJVTEFXVUlRIiwieSI6IjA0UWdialN 4bnFrTEpaV2Z5REZHYU14WFJvZXFRR29JTUpwUFh6S2JZN3MifSwiaHBrIjp7Imt0eSI6 IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoienBMWFZmT2FVQ21wQkFCZzJLZmc0ZWZOZ0haQ lBEaUZjMzh3YTVwTmFpOCIsInkiOiJNN2VobTNiLUh3U3hGb1NZUlR5SkhVMEU4X2RJNW sxbE9jdVdFLTByeXhnIn19.MTcxNDUyMTYwMA~MTcxNzE5OTk5OQ~IkRvZSI~IkpheSI~ ImpheWRvZUBleGFtcGxlLm9yZyI~eyJmb3JtYXR0ZWQiOiIxMjM0IE1haW4gU3QuXG5Bb nl0b3duLCBDQSAxMjM0NVxuVVNBIiwic3RyZWV0X2FkZHJlc3MiOiIxMjM0IE1haW4gU3 QuIiwibG9jYWxpdHkiOiJBbnl0b3duIiwicmVnaW9uIjoiQ0EiLCJwb3N0YWxfY29kZSI 6MTIzNDUsImNvdW50cnkiOiJVU0EifQ~dHJ1ZQ~~.1VeYSDPoVuR4JclOHWom6qds_1EI ovMyh_9AzMQdLzDUWiqEIYofPXZ5PPRT7aedj7iHepgTa3raOkl1zQMtEA~9jUlw9aiT7 5xLyzBa12iNhTEoZtye_nGOB1kAE3WW5fRfPL5Bahdo6wf-NLXEdESr878FWn8j6EiSan 3LGUA3w~UCBfRWTqCaLybao4KD0z82yaKSnGVpBi_41w9b9_dpILDj96MhnG561o8pB7- filFnsXE3-UOfEgusAoNles8A~09NzGFXibw_1oD0dbjcFeXUNVJb4IeoJqy_B4BNT1lm WOm4Legakr6V8vOWJ8FEg0OGUVYYVtl3cxWTPsW20oQ~_eZH-t6HLIR34qC5t8Wvfq_lk BffYM0q9-ddRoxgHXsOZuw2bOgTja98kHR5GlmpcHK8YrKPVTIpTTcy3Aum8g~GVWPBG0 vnfrbeNrwlT6N7gfLiUJlP_LtUB3pcLKrB3vNGMH6qHVkuHlKBTW_QymV3qORcj4jBw1T hgW0ROwMXA~x8eEWCWGPxHXZQnEYh-QzBMvCc2xwripGk-OAwVNA2oyAhm7shd_e5DHtu EsCDYqEU-9fT0Pym141G9ohs9F0g¶
Figure: Presentation (SU-ES256, JSON, Compact Serialization)¶
This example is meant to mirror the prior compact serialization, using RFC8392 and claims from [I-D.maldant-spice-oidc-cwt], illustrated using [I-D.ietf-cbor-edn-literals] (EDN).¶
To simplify this example, the same information is represented as the JPT example above, including the same public and private keys.¶
{ / protected header /
1: 1, / alg: "SU-ES256" /
3: 20, / typ: "JPT" (20CPA) /
5: "https://issuer.example", / iss: "https://issuer.example" /
6: [ / claims /
6, / "iat" /
4, / "exp" /
170, / "family_name" (I-D.maldant-spice-oidc-cwt TBD1) /
171, / "given_name" (I-D.maldant-spice-oidc-cwt TBD2) /
179, / "email" (I-D.maldant-spice-oidc-cwt TBD10) /
187, / "address" (I-D.maldant-spice-oidc-cwt TBD18) /
"age_over_21"
],
8: { / iek /
1: 2, / kty : "EC2" /
-1: 1, / crv: "P-256" /
-2: h'4ef383772915c467491a6adaf8f0babfc573c90bf67a6a1717e85b50' +
h'b0165084', / x /
-3: h'd384206e34b19ea90b25959fc8314668cc574687aa406a08309a4f5f' +
h'329b63bb' / y /
},
9: { / hpk /
1: 2, / kty: "EC2" /
-1: 1, / crv: "P-256" /
-2: h'ce92d755f39a5029a9040060d8a7e0e1e7cd8076413c3885737f306b' +
h'9a4d6a2f', / x /
-3: h'33b7a19b76fe1f04b1168498453c891d4d04f3f748e64d6539cb9613' +
h'ed2bcb18' / y /
},
10: -9 / hpa: "ESP256" (I-D.ietf-jose-fully-specified-algorithms TBD-9) /
}
¶
Figure: Issuer Protected Header (SU-ES256, CBOR)¶
[ / payloads /
/ iat / 171452160,
/ exp / 171719999,
/ family_name / "Doe",
/ given_name / "Jay",
/ email / "jaydoe@example.org",
/ address / {
/ formatted / 1: "1234 Main St.\nAnytown, CA 12345\nUSA",
/ street / 2: "1234 Main St.",
/ locality / 3: "Anytown",
/ region / 4: "CA",
/ post code / 5: "90210",
/ country / 6: "USA"
},
/ age_over_21 / true
]
¶
Figure: Issuer Payloads (as CBOR array)¶
When signed and serialized, the CPT is represented by the following CBOR (in hex):¶
8358cfa701010314057668747470733a2f2f6973737565722e6578616d706c65 0687060418aa18ab18b318bb6b6167655f6f7665725f323108a4010220012158 204ef383772915c467491a6adaf8f0babfc573c90bf67a6a1717e85b50b01650 84225820d384206e34b19ea90b25959fc8314668cc574687aa406a08309a4f5f 329b63bb09a401022001215820ce92d755f39a5029a9040060d8a7e0e1e7cd80 76413c3885737f306b9a4d6a2f22582033b7a19b76fe1f04b1168498453c891d 4d04f3f748e64d6539cb9613ed2bcb180a28871a0a3827001a0a3c3d3f63446f 65634a6179726a6179646f65406578616d706c652e6f7267a601782331323334 204d61696e2053742e0a416e79746f776e2c2043412031323334350a55534102 6d31323334204d61696e2053742e0367416e79746f776e046243410565393032 31300663555341f58858407930f72483dfc54f8ddeb79ffa82d3521e09824b0e 1927618edb709b97b473c54279fd906241fe4dde95750f9aba857e13a05bf920 7760e3d8659ee7770678ed58408c54b08ac131dfe38e4f6d84f9fafba9293d46 b402bc1c4ea3bf7858373a75a2fbf01c5951d81e3358031e374f1a4c5a9e6ea6 7d0d1d2c629677bed5d7c9097258404f3021950fdfde68760fe88519e7d474b1 c1641a76f1d6e3ec912e62e692beb3cbbc92c2545cab3a445e5600fe86bf1520 59c09de29910abd8c1a9cf79e2d4415840340878e23e206dee6fdaddf8dd7518 f11846bf7a17e9dd5e9616704e587b4047dd4a830caead34509a89586983cd36 02f4e361bf44f77ab832be246ccc0fc864584030fe7fec47e25901410e92ece3 0406e22d2022d6d95271dca4af8bd7c213c43c406088f575230696680366d859 5ef27453b90de3a75d17affdb7dec07336e04058407abdec681d4d094fcb26b2 bf2a620d18cc4c65e4b644bb7445673ceb8a9eb2c5d432231afd9b9a4a02fbe5 77b28509eef9d5a4100f5f6f0a065183e3fcc8ca01584031efbe4f57c6303a1f d7a95282dd351e22bd5dacc1f4c8dedfab3a1a3cc25ed076e753757c893c1a2c 8af00e3dfb8a9147fae39fa5235a38a275044ac93b7b65584075037da26e5d56 1858073810b8c0390a81fd8e069c97414ff1971b3cbf694ff7abd4b21fc5dcc3 c989d25f1bce952a3cfd901226821c8dcc061da6ddeaadd4aa¶
Fixtures: Issued Form (SU-ES256, CBOR)¶
The presented form, similarly to the issued form above, is made with the holder conveying the same parameters and the same set of selectively disclosed payloads as the JPT above:¶
{ / protected header /
1: 1, / alg: "SU-ES256" /
6: "https://recipient.example.com", / aud /
7: h'f0d18cbcf0c8e603839d6de46398b8cc4eb9906821b85441a3fc50c589b0469c', / nonce /
}
¶
Figure: Holder Protected Header (SU-ES256, CBOR)¶
When the appropriate proof is generated, the CPT is serialized into the following CBOR (in hex):¶
845846a3010106781d68747470733a2f2f726563697069656e742e6578616d70 6c652e636f6d075820f0d18cbcf0c8e603839d6de46398b8cc4eb9906821b854 41a3fc50c589b0469c58cfa701010314057668747470733a2f2f697373756572 2e6578616d706c650687060418aa18ab18b318bb6b6167655f6f7665725f3231 08a4010220012158204ef383772915c467491a6adaf8f0babfc573c90bf67a6a 1717e85b50b0165084225820d384206e34b19ea90b25959fc8314668cc574687 aa406a08309a4f5f329b63bb09a401022001215820ce92d755f39a5029a90400 60d8a7e0e1e7cd8076413c3885737f306b9a4d6a2f22582033b7a19b76fe1f04 b1168498453c891d4d04f3f748e64d6539cb9613ed2bcb180a28891a0a382700 1a0a3c3d3f63446f65634a6179726a6179646f65406578616d706c652e6f7267 a601782331323334204d61696e2053742e0a416e79746f776e2c204341203132 3334350a555341026d31323334204d61696e2053742e0367416e79746f776e04 624341056539303231300663555341f5f6f68758407930f72483dfc54f8ddeb7 9ffa82d3521e09824b0e1927618edb709b97b473c54279fd906241fe4dde9575 0f9aba857e13a05bf9207760e3d8659ee7770678ed58408c54b08ac131dfe38e 4f6d84f9fafba9293d46b402bc1c4ea3bf7858373a75a2fbf01c5951d81e3358 031e374f1a4c5a9e6ea67d0d1d2c629677bed5d7c9097258404f3021950fdfde 68760fe88519e7d474b1c1641a76f1d6e3ec912e62e692beb3cbbc92c2545cab 3a445e5600fe86bf152059c09de29910abd8c1a9cf79e2d4415840340878e23e 206dee6fdaddf8dd7518f11846bf7a17e9dd5e9616704e587b4047dd4a830cae ad34509a89586983cd3602f4e361bf44f77ab832be246ccc0fc864584030fe7f ec47e25901410e92ece30406e22d2022d6d95271dca4af8bd7c213c43c406088 f575230696680366d8595ef27453b90de3a75d17affdb7dec07336e04058407a bdec681d4d094fcb26b2bf2a620d18cc4c65e4b644bb7445673ceb8a9eb2c5d4 32231afd9b9a4a02fbe577b28509eef9d5a4100f5f6f0a065183e3fcc8ca0158 40418f866ba722087e89d9807e5b4c372ea7ffa45cc3db3c94713e44987c3934 a1f74b47ab3a6319760a8c1010a0cb1bf4cf04e9662e869464fbd52c8d7cf6de 13¶
Figure: Presented Form (SU-ES256, CBOR)¶
The following example uses the BBS algorithm.¶
This is the Issuer's stable private key in the JWK format:¶
{
"kty": "EC2",
"alg": "BBS",
"use": "proof",
"crv": "BLS12381G2",
"x": "EFj7Eg7WbxnONkvFDHpKxuN3eQMwh2h7rE7cJVpEVi11f2v76FAu0j0CrjcJ-
v1MFcB1Lu_duo8znKBGxLJSaHYaTbqs_1fAHY8Mnk8AdFkhejEgbcq2McAGxXv
tFn1y",
"y": "CUsaSfWZAIEoqbbgQM8YYlSaFbm2KRspOCmBTXsLmfQWBq-BM5Wo_a0Inenom
AUvFYp--j8uKMprJeW3l47zBnPtUVr9VIVHhthYIW0AojmmRgHpufKKqWyFglE
GyJPd",
"d": "Wbj_TIzxCLw1YWuEchZUCa8alAQjGlwYAdcTFad832k"
}
There is no additional holder key necessary for presentation proofs.¶
For the following protected header and array of payloads:¶
{
"kid": "HjfcpyjuZQ-O8Ye2hQnNbT9RbbnrobptdnExR0DUjU8",
"alg": "BBS"
}
These components are signed using the private issuer key previously given, which is then representable in the following serialization:¶
eyJraWQiOiJIamZjcHlqdVpRLU84WWUyaFFuTmJUOVJiYm5yb2JwdGRuRXhSMERValU4I iwiYWxnIjoiQkJTIn0.MTcxNDUyMTYwMA~MTcxNzE5OTk5OQ~IkRvZSI~IkpheSI~Imph eWRvZUBleGFtcGxlLm9yZyI~eyJmb3JtYXR0ZWQiOiIxMjM0IE1haW4gU3QuXG5Bbnl0b 3duLCBDQSAxMjM0NVxuVVNBIiwic3RyZWV0X2FkZHJlc3MiOiIxMjM0IE1haW4gU3QuIi wibG9jYWxpdHkiOiJBbnl0b3duIiwicmVnaW9uIjoiQ0EiLCJwb3N0YWxfY29kZSI6MTI zNDUsImNvdW50cnkiOiJVU0EifQ~dHJ1ZQ.kv0Hnjuq5S7FAA5CubBbIHGmtywgvun2xh KCIaOAUZa1taTFYJFKlF91ruOX55aTQm4Wk0XJX2Cm3bAqqOGxkkW0o0dy17TINm1qrkQ T3Tk
For a presentation with the following presentation header:¶
{
"alg": "BBS",
"aud": "https://recipient.example.com",
"nonce": "wrmBRkKtXjQ"
}
The holder decides to share all information other than the email address, and generates a proof. That proof is represented in the following serialization:¶
eyJhbGciOiJCQlMiLCJhdWQiOiJodHRwczovL3JlY2lwaWVudC5leGFtcGxlLmNvbSIsI m5vbmNlIjoid3JtQlJrS3RYalEifQ.eyJraWQiOiJIamZjcHlqdVpRLU84WWUyaFFuTmJ UOVJiYm5yb2JwdGRuRXhSMERValU4IiwiYWxnIjoiQkJTIn0.MTcxNDUyMTYwMA~MTcxN zE5OTk5OQ~IkRvZSI~IkpheSI~~~.lLSg42sfxPAce87z1cqCw3M7m71iyPDggaDMLZl2 BF6ZLsikaMruhZ1Qg1wP3cJTi8TvYtDHME_0B9YcI1X1rY0Hed404kd4UjG5tC8lhIvB0 d2L0OOz9M6eRf7NjFewgA7x5vWwqD0DGGyOIRzzRVI-WaLB43TxARJEQ5BBDIgsJOfeqR HN_McxpkPj1X_jOdCrP4UnIdk5GGkRzVDujGO30cbH-MYNIxpM4w0d-0Mll_-biGNKreX 2f07xyW3Jcgx3UJUHME1e_LlWfvGksFqgscdCQXEcEiORkGeIGYRhiDlCBqtSDI1jOMQl MLdTK35lPI3QKD93WRZ3OwqjWHqEEFP1-y4osIC5mD0t9qgnyWfWhP3pdk3zBq37eiXJT 0oGRfQGbN-68xSOfOzZ_TQIPmyCp01KhVdtBcxHY5c4U0zDpPeLtyYUo4g1eSXtaJhola UJXuuiuohfQJRfBHJ_ZaQK0F8xZJDAipVAT4Q
The following example uses the MAC-H256 algorithm.¶
This is the Issuer's stable private key in the JWK format:¶
{
"kty": "EC",
"crv": "P-256",
"x": "w0Cp0EHZsqo6bfcVisBIh7YD63niYBR-cZtQQI9Ecjg",
"y": "c-iH_xhJvZP-XF_1dy89BSa_0txk0IQjqTqxEVz88lQ",
"d": "-rjlG05jRNS9tkl4rxQ4iv0qakc04za6LCm_af6r2_c"
}
This is the Issuer's ephemerally generated shared secret:¶
"vj2cEE3Kw5bAcQGwgq5rf2MQcFOEzVjt_WujPiqjUmI"
This is the Holder's presentation private key in the JWK format:¶
{
"kty": "EC",
"crv": "P-256",
"x": "zpLXVfOaUCmpBABg2Kfg4efNgHZBPDiFc38wa5pNai8",
"y": "M7ehm3b-HwSxFoSYRTyJHU0E8_dI5k1lOcuWE-0ryxg",
"d": "swsKyZx4VBR-4TGGr3jbYvWNmRLCjzCKscgl0d3WM-8"
}
For the following protected header and array of payloads:¶
{
"alg": "MAC-H256",
"hpa": "ES256",
"typ": "JPT",
"iss": "https://issuer.example",
"claims": [
"iat",
"exp",
"family_name",
"given_name",
"email",
"address",
"age_over_21"
],
"hpk": {
"kty": "EC",
"crv": "P-256",
"use": "sign",
"x": "zpLXVfOaUCmpBABg2Kfg4efNgHZBPDiFc38wa5pNai8",
"y": "M7ehm3b-HwSxFoSYRTyJHU0E8_dI5k1lOcuWE-0ryxg"
}
}
[
1714521600,
1717199999,
"Doe",
"Jay",
"jaydoe@example.org",
{
"formatted": "1234 Main St.\nAnytown, CA 12345\nUSA",
"street_address": "1234 Main St.",
"locality": "Anytown",
"region": "CA",
"postal_code": 12345,
"country": "USA"
},
true
]
The issuer generates an array of derived keys, one per payload slot. This is done using the shared secret as the key and a binary value based on the payload slot index (from zero) as input to the HMAC operation.¶
This results in the following set of derived keys:¶
[ "y3HmL0bVur3nTw_37cTJDNKU7FZwXAauwn2bFyTtuoE", "EoKUkvjIQKTXP_lGpcOqlmWWjqULuq0m6CriGcgExCM", "f1Ie_H8lZODf-ea__XR60e9afR-KuIhsRbE4XtxWnsw", "r_sLzWlD1nqdBjTyYW9avlgm_aJ4p-EhHJDkujVpOy0", "NOVMIzzDmlC460UvGO1xr-yTNqdTfd6Crvtsst7-uUY", "8Kd-J0qPdqDIvqKMCX6yNEK_dgQoSzGZ4qzSG-KpRVk", "prtZh3JHJVBuF9v4LjRNSMniXi6K0KtmGMHRkWRSN-w" ]
A MAC is generated for each payload using the corresponding derived payload key. This results in the following set of MAC values:¶
[ "Eld6YdiKWqnNBoSZI31cVNbh9wiLxBqqENaSrGjZ5dw", "IE43RCa-l91jozYLUBMDqBVUfTmxAmYw8k1Ef5YoJf4", "C28ql3Kd-14tRYV-n6g3AhdD3mcdkSG53IYvh_oMcXM", "PxtolC_NQBbcZ6NAUhzwR3f8hL_QsHOO7kZZphDtNdA", "bKQFxu-hcim_bonx86O6Il-WpFXOE0ivHpYf-rjjDuA", "BtZHZkP-kjnljpMhEmLBqVfYpEQjmDI-QwwaxdGKczs", "knLrZiHQBjKtmw3ZuJyjL1vDBGX_339jiiIJuKHhhEM" ]
The issuer protected header and payload MAC values are combined into a binary representation known as the Compact MAC Representation. This representation is signed with the issuer's private key.¶
The proof consists of two octet string values: the signature over the combined MAC representation, and the shared secret.¶
[ "W3KChHQd76Ix28FpCWRUX-W-oiBJxKQh_xMpLSSrRp1E3DTXU3rWsLuwHXpCA-njyK 9YsGTkhbiGw0LIhpMBMQ", "ig_aPR5heZiFKW9e_t34OoV4aoPijvBP8lrKArXdZFY" ]
The final issued JWP in compact serialization is:¶
eyJhbGciOiJNQUMtSDI1NiIsImhwYSI6IkVTMjU2IiwidHlwIjoiSlBUIiwiaXNzIjoia HR0cHM6Ly9pc3N1ZXIuZXhhbXBsZSIsImNsYWltcyI6WyJpYXQiLCJleHAiLCJmYW1pbH lfbmFtZSIsImdpdmVuX25hbWUiLCJlbWFpbCIsImFkZHJlc3MiLCJhZ2Vfb3Zlcl8yMSJ dLCJocGsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsInVzZSI6InNpZ24iLCJ4Ijoi enBMWFZmT2FVQ21wQkFCZzJLZmc0ZWZOZ0haQlBEaUZjMzh3YTVwTmFpOCIsInkiOiJNN 2VobTNiLUh3U3hGb1NZUlR5SkhVMEU4X2RJNWsxbE9jdVdFLTByeXhnIn19.MTcxNDUyM TYwMA~MTcxNzE5OTk5OQ~IkRvZSI~IkpheSI~ImpheWRvZUBleGFtcGxlLm9yZyI~eyJm b3JtYXR0ZWQiOiIxMjM0IE1haW4gU3QuXG5Bbnl0b3duLCBDQSAxMjM0NVxuVVNBIiwic 3RyZWV0X2FkZHJlc3MiOiIxMjM0IE1haW4gU3QuIiwibG9jYWxpdHkiOiJBbnl0b3duIi wicmVnaW9uIjoiQ0EiLCJwb3N0YWxfY29kZSI6MTIzNDUsImNvdW50cnkiOiJVU0EifQ~ dHJ1ZQ.W3KChHQd76Ix28FpCWRUX-W-oiBJxKQh_xMpLSSrRp1E3DTXU3rWsLuwHXpCA- njyK9YsGTkhbiGw0LIhpMBMQ~ig_aPR5heZiFKW9e_t34OoV4aoPijvBP8lrKArXdZFY
Next, we show the presentation of the JWP with selective disclosure.¶
For presentation with the following presentation protected header:¶
{
"alg": "MAC-H256",
"aud": "https://recipient.example.com",
"nonce": "8NGMvPDI5gODnW3kY5i4zE65kGghuFRBo_xQxYmwRpw"
}
The holder will take the issuer proof (including shared secret) and derive the same individual payload MAC values (above).¶
In this case, the holder has decided not to disclose the last three
claims provided by the issuer (corresponding to email, address, and
age_over_21)¶
For each payload slot, the holder will provide one of two values as part of the proof value. For a disclosed payload, the holder will provide the corresponding derived key. For a non-disclosed payload, the holder will provide the corresponding MAC value.¶
The final presented proof value is an array of octet strings. The contents are presentation header signature, followed by the issuer signature, then the value disclosed by the holder for each payload. This results in the following proof:¶
[ "W3KChHQd76Ix28FpCWRUX-W-oiBJxKQh_xMpLSSrRp1E3DTXU3rWsLuwHXpCA-njyK 9YsGTkhbiGw0LIhpMBMQ", "y3HmL0bVur3nTw_37cTJDNKU7FZwXAauwn2bFyTtuoE", "EoKUkvjIQKTXP_lGpcOqlmWWjqULuq0m6CriGcgExCM", "f1Ie_H8lZODf-ea__XR60e9afR-KuIhsRbE4XtxWnsw", "r_sLzWlD1nqdBjTyYW9avlgm_aJ4p-EhHJDkujVpOy0", "bKQFxu-hcim_bonx86O6Il-WpFXOE0ivHpYf-rjjDuA", "BtZHZkP-kjnljpMhEmLBqVfYpEQjmDI-QwwaxdGKczs", "knLrZiHQBjKtmw3ZuJyjL1vDBGX_339jiiIJuKHhhEM", "dCQZYia4Np-QDpxJaZ5ABUxiltuP8vbfuA6MOCVcjGlcxvyeV3oQcCBOGeTDePjmRR pyyGGV5Fq5QJUBR1DDxw" ]
The final presented JWP in compact serialization is:¶
eyJhbGciOiJNQUMtSDI1NiIsImF1ZCI6Imh0dHBzOi8vcmVjaXBpZW50LmV4YW1wbGUuY 29tIiwibm9uY2UiOiI4TkdNdlBESTVnT0RuVzNrWTVpNHpFNjVrR2dodUZSQm9feFF4WW 13UnB3In0.eyJhbGciOiJNQUMtSDI1NiIsImhwYSI6IkVTMjU2IiwidHlwIjoiSlBUIiw iaXNzIjoiaHR0cHM6Ly9pc3N1ZXIuZXhhbXBsZSIsImNsYWltcyI6WyJpYXQiLCJleHAi LCJmYW1pbHlfbmFtZSIsImdpdmVuX25hbWUiLCJlbWFpbCIsImFkZHJlc3MiLCJhZ2Vfb 3Zlcl8yMSJdLCJocGsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTI1NiIsInVzZSI6InNpZ2 4iLCJ4IjoienBMWFZmT2FVQ21wQkFCZzJLZmc0ZWZOZ0haQlBEaUZjMzh3YTVwTmFpOCI sInkiOiJNN2VobTNiLUh3U3hGb1NZUlR5SkhVMEU4X2RJNWsxbE9jdVdFLTByeXhnIn19 .MTcxNDUyMTYwMA~MTcxNzE5OTk5OQ~IkRvZSI~IkpheSI~~~.W3KChHQd76Ix28FpCWR UX-W-oiBJxKQh_xMpLSSrRp1E3DTXU3rWsLuwHXpCA-njyK9YsGTkhbiGw0LIhpMBMQ~y 3HmL0bVur3nTw_37cTJDNKU7FZwXAauwn2bFyTtuoE~EoKUkvjIQKTXP_lGpcOqlmWWjq ULuq0m6CriGcgExCM~f1Ie_H8lZODf-ea__XR60e9afR-KuIhsRbE4XtxWnsw~r_sLzWl D1nqdBjTyYW9avlgm_aJ4p-EhHJDkujVpOy0~bKQFxu-hcim_bonx86O6Il-WpFXOE0iv HpYf-rjjDuA~BtZHZkP-kjnljpMhEmLBqVfYpEQjmDI-QwwaxdGKczs~knLrZiHQBjKtm w3ZuJyjL1vDBGX_339jiiIJuKHhhEM~dCQZYia4Np-QDpxJaZ5ABUxiltuP8vbfuA6MOC VcjGlcxvyeV3oQcCBOGeTDePjmRRpyyGGV5Fq5QJUBR1DDxw
This work was incubated in the DIF Applied Cryptography Working Group.¶
We would like to thank Alberto Solavagione for his valuable contributions to this specification.¶
The BBS examples were generated using the library at https://github.com/mattrglobal/pairing_crypto .¶
[[ To be removed from the final specification ]]¶
-10¶
-09¶
-08¶
-07¶
proof_key and presentation_key
names¶
proof_jwk to proof_key and presentation_jwk to
presentation_key to better represent that the key may be JSON or
CBOR-formatted.¶
proof_key and presentation_key to JWP where
they are defined. Consolidated usage, purpose, and requirements from
algorithm usage under these definitions.¶
BBS-PROOF into BBS¶
-06¶
presentation_header.¶
pjwk to presentation_jwk¶
-05¶
-04¶
BBS-DRAFT-5 to BBS, and from
BBS-PROOF-DRAFT-5 to BBS-PROOF¶
BBS_BLS12381G1_XMD:SHA-256_SSWU_RO_¶
-03¶
-02¶
BBS-DRAFT-3 and BBS-PROOF-DRAFT-3 algorithms based on
draft-irtf-cfrg-bbs-signatures-03.¶
BBS-X algorithm based on a particular implementation of
earlier drafts.¶
-01¶
issuer_header and presentation_header¶
-00¶