JSON Proof Token

Status of This Memo

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 24 April 2025.¶

Copyright Notice

Copyright (c) 2024 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.¶

Table of Contents

1. Introduction

JSON Proof Token (JPT) is a compact claims representation format intended to be used in the same ways as a JSON Web Token (JWT), but with additional support for selective disclosure and unlinkability. JPTs encode claim values to be transmitted as payloads of a JSON Web Proof (JWP) [I-D.ietf-jose-json-web-proof]. JPTs are always represented using the JWP Compact Serialization. The corresponding claim names are not transmitted in the payloads and are stored in a separate structure that can be externalized and shared across multiple JPTs.¶

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.¶

2. Conventions and Definitions

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.¶

3. Background

JWP defines a container binding together a protected header, one or more payloads, and a cryptographic proof. It does not define how claims are organized into payloads and what formats they are in. JPTs are intended to be as close to a JWT as possible, while also supporting the selective disclosure and unlinkability of JWPs.¶

4. Design Considerations

The rationale behind the design for JSON Proof Tokens is important when considering how it is structured. These sections detail the underlying reasoning informing the JPT design.¶

5. Claim Names

It is RECOMMENDED that the claim names used with JPTs come from those in the IANA JSON Web Token Claims Registry [IANA.JWT.Claims] established by [RFC7519], when those fit the application's needs.¶

6. Claims Header Parameter

A JSON Proof Token assigns each playload a claim name. Payloads MUST each have a negotiated and understood claim name within the application context. The simplest solution to establish payload claim names is as an ordered array that aligns with the included payloads. This claims array can be conveniently included in the Claims header parameter.¶

The claims Header Parameter is an array listing the Claim Names corresponding to the JWP payloads, in the same order as the payloads. Each array value is a Claim Name, as defined in [RFC7519]. Use of this Header Parameter is OPTIONAL.¶

All payloads are claim values and MUST be the base64url encoding of the UTF-8 representation of a JSON value. That said, predicate proofs derived from payload values are not represented as claims; they are contained in the presentation proof using algorithm-specific representations.¶

The following is an example JWP Issuer Protected Header that includes a claims property:¶

{
  "kid": "HjfcpyjuZQ-O8Ye2hQnNbT9RbbnrobptdnExR0DUjU8",
  "alg": "BBS",
  "claims": [
    "iat",
    "exp",
    "family_name",
    "given_name",
    "email",
    "address",
    "age_over_21"
  ]
}

In this example, the "iat" and "exp" would be JSON-formatted numbers, "family_name", "given_name" and "email" would be JSON strings (in quotes), "address" would be a JSON object and "age_over_21" would be expected to be either true or false.¶

7. Claims ID ("cid") JWP Header Parameter

A Claims ID ("cid") value can be used as an identifier for a set of claim names without explicitly listing them.¶

The structure of the cid value is unspecified. Its value MUST be a case-sensitive string. Use of this JWP Header Parameter is OPTIONAL.¶

The cid can be used similarly to a kid in order to ensure that is it possible to externally resolve and then verify that the correct list of claim names is being used when processing the payloads containing the claim values.¶

If there is an associated JWK containing the signing key information, the claims key is also registered there as a convenient location for the claim names.¶

When the claims array is transferred as a property in the Issuer Protected Header, any variations of that array between JWP will be visible to the verifier, and can leak information about the subject or provide an additional vector for linkability. Given the privacy design considerations around linkability, it is RECOMMENDED that the claims are defined external to an individual JPT and either referenced or known by the application context.¶

The following is an example JWP Protected Header that includes a cid:¶

{
  "kid": "HjfcpyjuZQ-O8Ye2hQnNbT9RbbnrobptdnExR0DUjU8",
  "alg": "BBS",
  "cid": "guA8PAI14Gkn4273f1rR606yMbRMFg4y"
}

8. Presented Claims and Proofs

Each claim in the issued form of the JPT results in one of three things in the presented form of the JPT: 1. A disclosed JSON value. 1. An indicator that the value was not disclosed. 1. An algorithm-specific proof method.¶

9. Example JPTs

See the examples in Appendix A.1 of [I-D.ietf-jose-json-proof-algorithms].¶

10. Security Considerations

• Protected Header Minimization¶

11. IANA Considerations

Appendix A. Acknowledgements

This work was incubated in the DIF Applied Cryptography Working Group.¶

We would like to thank Brent Zundel for his valuable contributions to this specification.¶

Appendix B. Document History

[[ To be removed from the final specification ]]¶

-07¶

• Changing primary editor¶
• Move claims definition from JWP, to live beside cid¶
• Update cid registry entry to assign CBOR label¶

-06¶

• Update reference to new repository home¶
• Fixed #99: Discussed issued and presented forms of JPTs.¶

-05¶

• Define and register Claims ID JWP Header Parameter.¶

-04¶

• Refactoring figures and examples to be built from a common set across all three documents¶

-03¶

• Improvements resulting from a full proofreading.¶
• Added examples of JSON object and JSON boolean claims.¶

-02¶

• Update example to use the current BBS algorithm¶

-01¶

• Correct cross-references within group.¶

-00¶

• Created initial working group draft based on draft-jmiller-jose-json-proof-token-01¶

Authors' Addresses