Internet-Draft | json-proof-algorithms | July 2023 |
Miller, et al. | Expires 11 January 2024 | [Page] |
The JSON Proof Algorithms (JPA) specification registers cryptographic algorithms and identifiers to be used with the JSON Web Proof and JSON Web Key (JWK) specifications. It defines several 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 11 January 2024.¶
Copyright (c) 2023 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 welcome at https://github.com/json-web-proofs/json-web-proofs.¶
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 Verifiable Credentials Data Model v1.1. The term "presentation" is also used as defined by this source, but the term "credential" is avoided in this specification in order 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 the JWP draft.¶
These terms are defined by this specification:¶
Stable Key An asymmetric key-pair used by an issuer that is also shared via an out-of-band mechanism to a verifier in order to validate the signature.¶
Ephemeral Key An asymmetric key-pair that is generated for one-time use by an issuer and never stored or used again outside of the creation of a single JWP.¶
Presentation Key An asymmetric key-pair that is generated by a holder and used to ensure that a presentation is not able to be replayed by any other party.¶
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](#issue)
, [confirm](#confirm)
, [present](#present)
, and [verify](#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 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.¶
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.¶
Editor's Note: This algorithm is going to be renamed and slightly refactored; the new name is still TBD.¶
The Single Use (SU) algorithm is based on composing multiple traditional JWS values into a single JWP proof value. 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 is based on using multiple JWS values, all of which are generated with the same JSON Web Algorithm (JWA) for signing. This JWA identifier is included as part of the Single Use identifier for JWP.¶
The chosen JWA MUST be an asymmetric signing algorithm so that each signature can be verified without sharing any private values between the parties. This ensures that the verifier cannot brute force any non-disclosed payloads based only on their disclosed individual signatures.¶
In order to support the protection of a presentation by a holder to a verifier, the holder MUST use a Presentation Key during the issuance and the presentation of every Single Use JWP. This Presentation Key MUST be generated and used for only one JWP.¶
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 easily accomplished by the holder using this key to generate a JWS that signs a value the issuer can verify as unique.¶
To create a Single Use JWP the issuer first generates a unique Ephemeral Key using the selected JWS algorithm. This key-pair will be used to sign each of the payloads of a single JWP and then discarded.¶
JSON Web Signatures are used to create all of the signature values used by the SU algorithm. This allows an implementation to use an existing JWS library directly for all necessary cryptographic operations without requiring any additional primitives.¶
Each individual JWS uses a fixed protected header containing only the minimum required alg
value. Since this JWS protected header itself is the same for every JWS, it SHOULD be a static value in the form of {"alg":"***"}
where ***
is the JWA asymmetric signing key algorithm identifier being used. This value is recreated by a verifier using the correct JWA algorithm value included in the SU algorithm identifier.¶
If an implementation uses an alternative JWS protected header than this fixed value, a base64url encoded serialized form of the alternate fixed header MUST be included using the jws_header
claim in the issuer protected header.¶
The JWK of the issuer's Ephemeral Key MUST be included in the issuer protected header with the property name of proof_jwk
and contain only the REQUIRED values to represent the public key.¶
The holder's Presentation Key JWK MUST be included in issuer protected header using the presentation_jwk
claim.¶
The final issuer protected header is then used directly as the body of a JWS and signed using the issuer's Stable Key. The resulting JWS signature value unencoded octet string is the first value in the JWP proof.¶
In various examples in this specification the octet string serialized issuer header is referenced as issuer_header
.¶
Each JWP payload is processed in order and signed as a JWS body using the issuer's Ephemeral Key. The resulting JWS signature value unencoded octet string is appended to the JWP proof.¶
The proof value as an octet string will have a total length that is the sum of the fixed length of the issuer protected header signature plus the fixed length of each of the payload Ephemeral Key signatures. For example, the signature for the ES256 algorithm is 64 octets and for a JWP with five payloads the total proof value length would be 64 * (1 + 5) = 384
octets).¶
In order 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 claim that both the holder and verifier trust as being unique and non-replayable.¶
This specification registers a nonce
claim 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 claims that are either provided by the verifier or by the holder. These presentation claims SHOULD NOT contain values that are common across multiple presentations and SHOULD be unique to a single presentation and verifier.¶
In various examples in this specification the octet string serialized presentation header is referenced as presentation_header
.¶
Editor's Note: The current definition here is incomplete, the holder's signature needs to also incorporate the presented proof.¶
The holder derives a new proof value when presenting it to a verifier. The presented proof value will always contain the issuer's Stable Key signature for the issuer protected header as the first element.¶
The second element of the presented proof value is always the holder's Presentation Key signature of the presentation protected header, constructed identically to the issuer protected header by using the serialized JSON value octet string as the JWS body. Signing only the presentation header with the Presentation Key is sufficient to protect the entire presentation since that key is private to the holder and only the contents of the presentation header are used for replay prevention.¶
The two header signatures are then followed by only the issuer's Ephemeral Key signatures for each payload that is disclosed. The order of the payload signatures is preserved and MUST be in the same order as the included disclosed payloads in the presented JWP. Non-disclosed payloads will NOT have a signature value included. For example, if the second and fifth payloads are hidden then the holder's derived proof value would be of the length 64 * (1 + 1 + the 1st, 2nd, and 4th payload signatures) = 320 octets
.¶
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.¶
The verifier MUST verify the issuer protected header against the first matching JWS signature part in the proof value using the issuer's Stable Key. It MUST also verify the presentation protected header against the second JWS signature part in the proof value using the holder's Presentation Key as provided in the presentation_jwk
claim in the issuer protected header.¶
With the headers verified, the issuer's Ephemeral Key as given in the issuer protected header proof_jwk
claim can then be used to verify each of the disclosed payload signatures.¶
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".¶
The BBS Signature Scheme [I-D.irtf-cfrg-bbs-signatures] is under active development within the CRFG. Prior to this effort work was done under the DIF Applied Cryptography Working Group, an effort to clarify and bring best practices to early prototypes leveraged by multiple early stage decentralized identity projects.¶
This JSON Proof Algorithm definition for BBS is based on the already released implementation and relies on the provided software API. A future definition with a different alg
value will be created to succeed this version as the BBS standardization effort progresses.¶
This algorithm supports both selective disclosure and unlinkability, enabling the holder to generate multiple presentations from one issued JWP without any verifier being able to correlate those presentations together.¶
The pairing friendly elliptic curve used for the BBS software implementation is part of the BLS family with an embedding degree of 12 over a 381-bit prime field. For this JPA, only the group G2 is used.¶
In the implementation the method used to generate the key pairs is generateBls12381G2KeyPair()
.¶
BBS is a multi-message scheme and operates on an array of individual messages for signing and proof generation. Each message is a single binary octet string. The BBS implementation uses a hash-to-curve method to map each message to a point.¶
The UTF-8 octet string of the issuer protected header is the first message in the input array at index 0.¶
The octet strings of each payload are placed into the BBS message array following the issuer protected header message. For example, the first payload is at index 1 of the array and the last payload is always the last message in the array.¶
In future versions of this algorithm, there will be additional methods defined for transforming a payload into a point such that additional Zero-Knowledge Proof types can be supported by the holder such as range and membership predicates.¶
The issuer's BLS12-381 G2 Stable Key is used to sign the completed message array input containing the octet strings of the issuer protected header and every payload. The result is a signature octet string that is used as the initial JWP proof value.¶
In the implementation, the method used to perform the signing is blsSign({keyPair, [header, payload1, payload2, ...]})
and returns a binary signature value.¶
The holder must decode the issuer protected header and payload values in order to generate the identical message array that the issuer used.¶
To generate a presented JWP for a verifier, the holder must use a cryptographic nonce that is provided by that verifier as input. This nonce MUST be a 32-byte octet string that the verifier generated by a secure RNG. How this nonce value is communicated to the holder is out of scope of this presentation. The nonce
claim in the presentation protected header is used to store the verifier's given nonce value.¶
The holder also applies selective disclosure preferences by creating an array of indices of which messages in the input array are to be revealed to the verifier. The revealed indices MUST include the value 0
so that the issuer protected header message is always revealed to the verifier.¶
The result of creating a proof is an octet string that is used as the presented JWP proof value.¶
In the implementation, the method used to generate the proof is blsCreateProof({signedProof, publicKey, [issuer_header, payload1, payload2, ...], presentation_header, [0, 2, ...])
.¶
The verifier decodes the JWP issuer protected header and payload values into a messages array, skipping any non-revealed payloads. The current BBS implementation embeds the revealed indices into the output proof value, so the verification messages array only needs to include the disclosed messages.¶
In the implementation, the method used to verify the proof is blsVerifyProof({verifyProof, publicKey, [issuer_header, payload2, ...], presentation_header)
.¶
Proposed JWP alg
value for BBS based on the software implementation is "BBS-X".¶
The following example uses the given BLS12-384 key-pair:¶
Public:¶
Private:¶
The protected header used is:¶
The first payload is the string "Doe"
with the octet sequence of [ 34, 68, 111, 101, 34 ]
and base64url-encoded as IkRvZSI
.¶
The second payload is the string "Jay"
with the octet sequence of [ 34, 74, 97, 121, 34 ]
and base64url-encoded as IkpheSI
.¶
The third payload is the string "jaydoe@example.org"
with the octet sequence of [ 34, 106, 97, 121, 100, 111, 101, 64, 101, 120, 97, 109, 112, 108, 101, 46, 111, 114, 103, 34 ]
and base64url-encoded as ImpheWRvZUBleGFtcGxlLm9yZyI
.¶
The fourth payload is the string 42
with the octet sequence of [ 52, 50 ]
and base64url-encoded as NDI
.¶
The message array used as an input to the BLS implementation is:¶
Using the above inputs, the output of the blsSign()
call is the octet string:¶
The resulting signed JWP in JSON serialization is:¶
The same JWP in compact serialization:¶
For verification, a nonce is needed:¶
To generate a proof, the blsCreateProof()
method is used with a revealed indexes array argument of [ 0, 2, 4 ]
and results in the octet string:¶
The resulting verifiable JWP in JSON serialization is:¶
The same JWP in compact serialization:¶
The Message Authentication Code (MAC) JPA uses a MAC to both generate ephemeral keys and compute authentication codes to protect the issuer header and each payload individually.¶
Like the JWS-based JPA, 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.¶
Prior to the issuer creating a new JWP it must have presentation binding information provided by the holder. This enables the holder to perform replay prevention while presenting the JWP.¶
The presentation key used by the holder must be transferred to the issuer and verified, likely through a challenge and self-signing mechanism. If the holder requires unlinkability it must also generate a new key that is verified and bound to each new JWP.¶
How these holder presentation keys are transferred and verified is out of scope of this specification, protocols such as OpenID Connect can be used to accomplish this. What is required by this definition is that the holder's presentation key MUST be included in the issuer's protected header using the pjwk
claim with a JWK as the value.¶
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 to 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 holder's presentation key JWK MUST be included in the issuer protected header using the pjwk
claim. The issuer MUST validate that the holder has possession of this key through a trusted mechanism such as verifying the signature of a unique nonce value from the holder.¶
For consistency, the issuer header is also protected by a MAC by using the fixed value "issuer_header" as the input key. The issuer header JSON is serialized using UTF-8 and encoded with base64url into an octet array. The final issuer header MAC is generated from the octet array and the fixed key, and the resulting value becomes the first input into the larger octet array that will be signed by the issuer.¶
A unique key is generated for each payload using the MAC with the Shared Secret as the key and the values "payload_X" where "X" is replaced by the zero-based array index of the payload, for example "payload_0", "payload_1", etc.¶
Each payload is serialized using UTF-8 and encoded with base64url into an octet array. The generated key for that payload based on its index is used to generate the MAC for the payload's encoded octet array. The resulting value is appended to the larger octet array that will be signed by the issuer.¶
The issuer proof consists of two items appended together, the issuer's signature of the appended array of MACs, and the Shared Secret used to generate the set of payload keys.¶
To generate the signature, the array containing the final MAC of the issuer protected header followed by all of the payload MACs appended in order is used as the input to a new JWS.¶
jws_payload = [issuer_header_mac, payload_mac_1, ... payload_mac_n]¶
The issuer signs the JWS using its stable public key and a fixed header containing the alg
associated with MAC algorithm in use.¶
jws_header = '{"alg":"ES256"}'
¶
The resulting signature is decoded and used as the first item in the issuer proof value. The octet array of the Shared Secret is appended, resulting in the final issuer proof value.¶
issuer_proof = [jws_signature, shared_secret]
¶
See the JWS Presentation Protected Header section.¶
Editor's Note: The current definition here is incomplete, the holder's signature needs to also incorporate the presented proof.¶
The presentation proof is constructed as a large octet array containing multiple appended items similar to the issuer proof value. The first item is the JWS decoded signature value generated when the holder uses the presentation key to sign the presentation header. The second item is the issuer signature from the issuer's proof value.¶
These two signatures are then followed by a MAC value for each payload. The MAC values used will depend on if that payload has been disclosed or is hidden. Disclosed payloads will include the MAC key input, and hidden payloads will include only their final MAC value.¶
presentation_proof = [presentation_signature, issuer_signature, disclosed_key_0, hidden_mac_1, hidden_mac_2, ... disclosed_key_n]¶
The size of this value will depend on the underlying cryptographic algorithms. For example, MAC-H256
uses the ES256
JWS with a decoded signature of 64 octets, and for a JWP with five payloads using HMAC-SHA256
the total presentation proof value length would be 64 + 64 + (5 * 32) = 288
octets.¶
In order to verify that the presentation was protected from replay attacks, the verifier must be able to validate the presentation protected header. This involves the following steps:¶
nonce
claim¶
pjwk
claim¶
alg
value and the presentation header as the body¶
presentation_signature
from the beginning of the presentation_proof
octet array¶
pjwk
claim and the presentation_signature
value¶
Next, the verifier must validate all of the disclosed payloads using the following steps:¶
kid
using a trusted mechanism to obtain the correct issuer JWK¶
issuer_signature
from the beginning of the remaining presentation_proof
octet array (after the presentation_signature
was removed)¶
issuer_header
value using the "issuer_header" value as the input key¶
jws_payload
octet array¶
Iterate on each presented payload (disclosed or hidden)¶
presentation_proof
octet array¶
jws_payload
octet array¶
jws_payload
octet array¶
alg
parameter along with the generated jws_payload
value as the payload¶
issuer_signature
value¶
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¶
The following example uses the MAC-H256
algorithm.¶
This is the Signer's stable private key in the JWK format:¶
This is the Signer's generated Shared Secret:¶
This is the Holder's presentation private key in the JWK format:¶
The first MAC is generated using the key issuer_header
and the base64url-encoded issuer protected header, resulting in this octet array:¶
The issuer generates an array of derived keys with one for each payload by using the shared secret as the key and the index of the payload as the input:¶
The first payload is the string "Doe"
with the octet sequence of [ 34, 68, 111, 101, 34 ]
and base64url-encoded as IkRvZSI
.¶
The second payload is the string "Jay"
with the octet sequence of [ 34, 74, 97, 121, 34 ]
and base64url-encoded as IkpheSI
.¶
The third payload is the string "jaydoe@example.org"
with the octet sequence of [ 34, 106, 97, 121, 100, 111, 101, 64, 101, 120, 97, 109, 112, 108, 101, 46, 111, 114, 103, 34 ]
and base64url-encoded as ImpheWRvZUBleGFtcGxlLm9yZyI
.¶
The fourth payload is the string 42
with the octet sequence of [ 52, 50 ]
and base64url-encoded as NDI
.¶
A MAC is generated for each payload using the generated key for its given index, resulting in an array of MACs:¶
Concatenating the issuer protected header MAC with the array of payload MACs produces a single octet array that is signed using the issuer's stable key, resulting in the following signature:¶
The original shared secret octet string is then concatenated to the end of the issuer signature octet string and the result is base64url-encoded as the issuer's proof value.¶
The final issued JWP in JSON serialization is:¶
The same JWP in compact serialization:¶
Next, we show the presentation of the JWP with selective disclosure.¶
We start with this presentation header using a nonce provided by the Verifier:¶
When signed with the holder's presentation key, the resulting signature octets are:¶
Then by applying selective disclosure of only the given name and age claims (family name and email hidden, payload array indexes 0 and 2), the holder builds a mixed array of either the payload key (if disclosed) or MAC (if hidden):¶
The final presented proof value is generated by concatenating first the presentation header signature octet string, followed by the issuer signature octet string, then followed by the mixed array of keys and MACs:¶
The resulting presented JWP in JSON serialization is:¶
The same JWP in compact serialization:¶
Editor's Note: This will follow once the algorithms defined here have become more stable.¶
This section establishes the IANA JWP Algorithms Registry. It also registers the following algorithms.¶
TBD¶
[[ To be removed from the final specification ]]¶
-00¶