OpenID4VC High Assurance Interoperability Profile - draft 01

Table of Contents

1. Introduction

This document defines a set of requirements for the existing specifications to enable interoperability among Issuers, Wallets and Verifiers of Credentials where a high level of security and privacy is required. This document is an interoperability profile that can be used by implementations in various contexts, be it a certain industry or a certain regulatory environment.¶

This document is not a specification, but a profile. It refers to the specifications required for implementations to interoperate among each other and for the optionalities mentioned in the referenced specifications, defines the set of features to be mandatory to implement.¶

The profile uses OpenID for Verifiable Credential Issuance [OIDF.OID4VCI] and OpenID for Verifiable Presentations [OIDF.OID4VP] as the base protocols for issuance and presentation of Credentials, respectively. The credential formats used are IETF SD-JWT VC as specified in [I-D.ietf-oauth-sd-jwt-vc] and ISO mdoc [ISO.18013-5]. Additionally, considerations are given on how the issuance of Credentials in both IETF SD-JWT VC [I-D.ietf-oauth-sd-jwt-vc] and ISO mdoc [ISO.18013-5] formats can be performed in the same transaction.¶

A full list of the open standards used in this profile can be found in Overview of the Open Standards Requirements (reference).¶

2. Terminology

This specification uses the terms "Holder", "Issuer", "Verifier", and "Verifiable Credential" as defined in [I-D.ietf-oauth-sd-jwt-vc].¶

3. Scope

The following aspects are in scope of this interoperability profile:¶

• Profile of OpenID4VCI to issue IETF SD-JWT VCs, including¶

  • Wallet Attestation¶
• Profile of OpenID4VP to present IETF SD-JWT VCs¶

• Profile of OpenID4VP over the W3C Digital Credentials API [w3c.digital_credentials_api] to present¶

  • IETF SD-JWT VCs¶
  • ISO mdocs¶
• Protocol for User Authentication by the Wallet at a Verifier (SIOP v2)¶

• Profile of IETF SD-JWT VC that includes the following aspects¶

  • Status management of the Credentials, including revocation¶
  • Cryptographic Key Binding¶
  • Issuer key resolution¶
  • Issuer identification (as prerequisite for trust management)¶
• Crypto Suites¶

Note that when OpenID4VP is used, the Wallet and the Verifier can either be remote or in-person.¶

Assumptions made are the following:¶

• The issuers and verifiers cannot pre-discover wallet's capability¶
• The issuer is talking to the wallet supporting the features defined in this profile (via wallet invocation mechanism)¶
• There are mechanisms in place for the verifiers and issuers to discover each other's capability¶

4. OpenID for Verifiable Credential Issuance

Both the Wallet and the Credential Issuer:¶

• MUST support both pre-authorized code flow and authorization code flow.¶
• MUST support protocol extensions for the SD-JWT VC credential format profile as defined in Section 8.2.¶
• MUST support sender-constrained tokens using the mechanism defined in [RFC9449].¶
• MUST support [RFC7636] with S256 as the code challenge method.¶

Both Wallet initiated and Issuer initiated issuance is supported.¶

{
  "typ": "wallet-attestation+jwt",
  "alg": "ES256",
  "kid": "1"
}
.
{
  "iss": "<identifier of the issuer of this wallet attestation>",
  "sub": "<`client_id` of the OAuth client>",
  "iat": 1516247022,
  "exp": 1541493724,
  "aal" : "https://trust-list.eu/aal/high",
  "cnf": {
    "jwk": {
      "kty": "EC",
      "crv": "P-256",
      "x": "TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc",
      "y": "ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ"
    },
    "key_type": "strong_box",
    "user_authentication": "system_pin",
  }
}

5. OpenID for Verifiable Presentations profile for IETF SD-JWT VC

Requirements for both the Wallet and the Verifier:¶

• As a way to invoke the Wallet, at least a custom URL scheme haip:// MUST be supported. Implementations MAY support other ways to invoke the wallets as agreed by trust frameworks/ecosystems/jurisdictions, not limited to using other custom URL schemes.¶
• Response type MUST be vp_token.¶
• Response mode MUST be direct_post.jwt. The Verifier MUST return redirect_uri in response to the HTTP POST request from the Wallet, where the Wallet redirects the User to, as defined in Section 7.2 of [OIDF.OID4VP]. Implementation considerations for the response mode direct_post.jwt are given in Section 12.4 of [OIDF.OID4VP].¶
• Authorization Request MUST be sent using the request_uri parameter as defined in JWT-Secured Authorization Request (JAR) [RFC9101].¶
• The Client Identifier Scheme as introduced in Section 5.10 of [OIDF.OID4VP] MUST be either x509_san_dns or verifier_attestation. The Wallet MUST support both. The Verifier MUST support at least one.¶
• To obtain the issuer's public key for verification, verifiers MUST support Web-based key resolution, as defined in Section 5 of [I-D.ietf-oauth-sd-jwt-vc]. The JOSE header kid MUST be used to identify the respective key.¶
• Presentation Definition JSON object MUST be sent using a presentation_definition parameter.¶

• The following features from the DIF Presentation Exchange v2.0.0 MUST be supported. A JSON schema for the supported features is in Appendix B:¶

  • In the presentation_definition object, id, input_descriptors and submission_requirements properties MUST be supported.¶
  • In the input-descriptors object, id, name, purpose, group, format, and constraints properties MUST be supported. In the constraints object, limit_disclosure, and fields properties MUST be supported. In the fields object, path and filter properties MUST be supported. A path MUST contain exactly one entry with a static path to a certain claim. A filter MUST only contain type elements of value string and const elements.¶
  • In the submission_requirements object, name, rule (pickonly), count, from properties MUST be supported.¶

6. OpenID for Verifiable Presentations over W3C Digital Credentials API

The following requirements apply for both, the Wallet and the Verifier, unless specified otherwise:¶

• MUST support Annex A in [OIDF.OID4VP] that defines how to use OpenID4VP over the W3C Digital Credentials API.¶

  • The Wallet MUST support both signed and unsigned requests as defined in Annex A.3.1 and A.3.2 of [OIDF.OID4VP]. The Verifier MAY support signed requests, unsigned requests, or both.¶
• Wallet Invocation is done via the W3C Digital Credentials API or an equivalent platform API. Any other mechanism, including Custom URL schemes, MUST NOT be used.¶
• Response Mode MUST be dc_api.jwt. The response MUST be encrypted.¶
• Specific requirements for the response encryption are tbd (https://github.com/openid/oid4vc-haip/issues/131).¶

• The DCQL query and response as defined in Section 6 of [OIDF.OID4VP] MUST be used. Presentation Exchange as defined in Sections 5.4 and 5.5 of [OIDF.OID4VP] MUST NOT be used. Below is the list of features in the DCQL query and response that MUST be supported:¶

  • tbd (https://github.com/openid/oid4vc-haip/issues/142)¶

SessionTranscript = [
  null,
  null,
  Handover
]

Handover = OID4VPDCAPIHandover
OID4VPDCAPIHandover = [
  "OID4VPDCAPIHandover"
  clientId
  origin
  nonce
]

clientId = tstr ; using UTF-8
origin = tstr ; using UTF-8
nonce = tstr ; using UTF-8

* The Credential Format identifier MUST be `dc+sd-jwt`.

7. Self-Issued OP v2

To authenticate the user, subject identifier in a Self-Issued ID Token MUST be used as defined in [OIDF.SIOPv2].¶

• As a way to invoke the Wallet, at least a custom URL scheme haip:// MUST be supported. Implementations MAY support other ways to invoke the wallets as agreed by trust frameworks/ecosystems/jurisdictions, not limited to using other custom URL schemes.¶
• subject_syntax_types_supported value MUST be urn:ietf:params:oauth:jwk-thumbprint¶

8. SD-JWT VCs

This profile defines the following additional requirements for IETF SD-JWT VCs as defined in [I-D.ietf-oauth-sd-jwt-vc].¶

• Compact serialization MUST be supported as defined in [I-D.ietf-oauth-selective-disclosure-jwt]. JSON serialization MAY be supported.¶
• The following JWT Claims MUST be supported Content (differentiate issuance & presentation)¶

• The Issuer MUST NOT make any of the JWT Claims in the table above to be selectively disclosable, so that they are always present in the SD-JWT-VC presented by the Holder.¶
• It is at the discretion of the Issuer whether to use exp claim and/or a status claim to express the validity period of an SD-JWT-VC. The wallet and the verifier MUST support both mechanisms.¶
• The iss claim MUST be an HTTPS URL. The iss value is used to obtain Issuer's signing key as defined in Section 8.1.¶
• The vct JWT claim as defined in [I-D.ietf-oauth-sd-jwt-vc].¶
• The cnf claim [RFC7800] MUST conform to the definition given in [I-D.ietf-oauth-sd-jwt-vc]. Implementations conforming to this profile MUST include the JSON Web Key [RFC7517] in the jwk sub claim.¶

Note: Currently this profile only supports presentation of credentials with cryptographic Holder Binding: the holder's signature is required to proof the credential is presented by the holder it was issued to. This profile might support claim-based and biometrics-based holder binding once OpenID for Verifiable Credentials adds support for other forms of Holder Binding. See https://bitbucket.org/openid/connect/issues/1537/presenting-vc-without-a-vp-using-openid4vp¶

Note: Re-using the same Credential across Verifiers, or re-using the same JWK value across multiple Credentials gives colluding Verifiers a mechanism to correlate the User. There are currently two known ways to address this with SD-JWT VCs. First is to issue multiple instances of the same credentials with different JWK values, so that if each instance of the credential is used at only one Verifier, it can be reused multiple times. Another is to use each credential only once (ephemeral credentials). It is RECOMMENDED to adopt one of these mechanisms.¶

Note: If there is a requirement to communicate information about the verification status and identity assurance data of the claims about the subject, the syntax defined by [OIDF.ekyc-ida] SHOULD be used. It is up to each jurisdiction and ecosystem, whether to require it to the implementers of this profile.¶

Note: If there is a requirement to provide the Subject’s identifier assigned and maintained by the Issuer, the sub claim MAY be used. There is no requirement for a binding to exist between the sub and cnf claims. See the Implementation Considerations section in [I-D.ietf-oauth-sd-jwt-vc].¶

Note: In some credential types, it is not desirable to include an expiration date (eg: diploma attestation). Therefore, this profile leaves its inclusion to the Issuer, or the body defining the respective credential type.¶

9. Crypto Suites

Issuers, holders and verifiers MUST support P-256 (secp256r1) as a key type with ES256 JWT algorithm for signing and signature validation whenever this profiles requires to do so:¶

• SD-JWT-VC¶
• Wallet Instance Attestation¶
• DPoP¶
• HB JWT¶
• Authorization request during presentation¶

SHA256 MUST be supported by all the entities as the hash algorithm to generate and validate the digests in the SD-JWT VC.¶

Note: When using this profile with other cryptosuites, it is recommended to be explicit about which entity is required to support which curve for signing and/or signature validation¶

10. Implementations Considerations

Appendix A. Combined Issuance of SD-JWT VC and mdocs

• If combined issuance is required, the Batch Credential Endpoint MUST be supported.¶

Appendix B. JSON Schema for the supported Presentation Definition properties

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Presentation Definition for a High Assurance Profile",
    "type": "object",
    "properties": {
      "presentation_definition": {
        "$ref": "#/definitions/presentation_definition"
      }
    },
    "definitions": {
      "presentation_definition": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "input_descriptors": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/input_descriptor"
            }
          },
          "submission_requirements": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/submission_requirement"
            }
          }
        },
        "required": [
          "id",
          "input_descriptors"
        ],
        "additionalProperties": false
      },
      "input_descriptor": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "purpose": {
            "type": "string"
          },
          "format": {
            "$ref": "http://identity.foundation/claim-format-registry/schemas/presentation-definition-claim-format-designations.json"
          },
          "group": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "constraints": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "limit_disclosure": {
                "type": "string",
                "enum": [
                  "required",
                  "preferred"
                ]
              },
              "fields": {
                "type": "array",
                "items": {
                  "path": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "filter": {
                    "$ref": "http://json-schema.org/draft-07/schema#"
                  }
                }
              }
            }
          }
        },
        "required": [
          "id",
          "constraints"
        ]
      },
      "submission_requirement": {
        "type": "object",
        "oneOf": [
          {
            "properties": {
              "name": {
                "type": "string"
              },
              "rule": {
                "type": "string",
                "enum": [
                  "pick"
                ]
              },
              "count": {
                "type": "integer",
                "minimum": 1
              },
              "from": {
                "type": "string"
              }
            },
            "required": [
              "rule",
              "from"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  }

Appendix C. Acknowledgements

We would like to thank Paul Bastian, Christian Bormann, Mike Jones, Oliver Terbu, Daniel Fett, and Giuseppe De Marco for their valuable feedback and contributions to this specification.¶

Appendix D. Notices

Copyright (c) 2023 The OpenID Foundation.¶

The OpenID Foundation (OIDF) grants to any Contributor, developer, implementer, or other interested party a non-exclusive, royalty free, worldwide copyright license to reproduce, prepare derivative works from, distribute, perform and display, this Implementers Draft or Final Specification solely for the purposes of (i) developing specifications, and (ii) implementing Implementers Drafts and Final Specifications based on such documents, provided that attribution be made to the OIDF as the source of the material, but that such attribution does not indicate an endorsement by the OIDF.¶

The technology described in this specification was made available from contributions from various sources, including members of the OpenID Foundation and others. Although the OpenID Foundation has taken steps to help ensure that the technology is available for distribution, it takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this specification or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any independent effort to identify any such rights. The OpenID Foundation and the contributors to this specification make no (and hereby expressly disclaim any) warranties (express, implied, or otherwise), including implied warranties of merchantability, non-infringement, fitness for a particular purpose, or title, related to this specification, and the entire risk as to implementing this specification is assumed by the implementer. The OpenID Intellectual Property Rights policy requires contributors to offer a patent promise not to assert certain patent claims against other contributors and against implementers. The OpenID Foundation invites any interested party to bring to its attention any copyrights, patents, patent applications, or other proprietary rights that MAY cover technology that MAY be required to practice this specification.¶

Appendix E. Document History

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

-01¶

• Rename specification to enable non-SD-JWT credential formats to be included¶
• Require encrypted responses¶
• Remove reference to client_id_scheme parameter that no longer exists in OpenID4VP¶
• Refresh tokens are now optional¶

-00¶

• initial revision¶

Authors' Addresses