Internet-Draft | SD-JWT VC | September 2024 |
Terbu, et al. | Expires 22 March 2025 | [Page] |
This specification describes data formats as well as validation and processing rules to express Verifiable Credentials with JSON payloads with and without selective disclosure based on the SD-JWT [I-D.ietf-oauth-selective-disclosure-jwt] format.¶
This note is to be removed before publishing as an RFC.¶
Discussion of this document takes place on the Web Authorization Protocol Working Group mailing list (oauth@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/oauth/.¶
Source for this draft and an issue tracker can be found at https://github.com/oauth-wg/oauth-sd-jwt-vc.¶
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 22 March 2025.¶
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.¶
In the so-called Issuer-Holder-Verifier Model, Issuers issue so-called Verifiable Credentials to a Holder, who can then present the Verifiable Credentials to Verifiers. Verifiable Credentials are cryptographically secured statements about a Subject, typically the Holder.¶
Verifiers can check the authenticity of the data in the Verifiable Credentials and optionally enforce Key Binding, i.e., ask the Holder to prove that they are the intended holder of the Verifiable Credential, for example, by proving possession of a cryptographic key referenced in the credential. This process is further described in [I-D.ietf-oauth-selective-disclosure-jwt].¶
To support revocation of Verifiable Credentials, revocation information can optionally be retrieved from a Status Provider. The role of a Status Provider can be fulfilled by either a fourth party or by the Issuer.¶
JSON Web Tokens (JWTs) [RFC7519] can in principle be used to express Verifiable Credentials in a way that is easy to understand and process as it builds upon established web primitives.¶
Selective Disclosure JWT (SD-JWT) [I-D.ietf-oauth-selective-disclosure-jwt] is a specification that introduces conventions to support selective disclosure for JWTs: For an SD-JWT document, a Holder can decide which claims to release (within bounds defined by the Issuer).¶
SD-JWT is a superset of JWT as it can also be used when there are no selectively disclosable claims and also supports JWS JSON serialization, which is useful for long term archiving and multi signatures. However, SD-JWT itself does not define the claims that must be used within the payload or their semantics.¶
This specification uses SD-JWT and the well-established JWT content rules and extensibility model as basis for representing Verifiable Credentials with JSON payloads. These Verifiable Credentials are called SD-JWT VCs. The use of selective disclosure in SD-JWT VCs is OPTIONAL.¶
SD-JWTs VC can contain claims that are registered in "JSON Web Token Claims" registry as defined in [RFC7519], as well as public and private claims.¶
Note: This specification does not utilize the W3C's Verifiable Credentials Data Model v1.0, v1.1, or v2.0.¶
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 RFC 2119 [RFC2119].¶
This specification uses the terms "Holder", "Issuer", "Verifier", "Key Binding", and "Key Binding JWT" defined by [I-D.ietf-oauth-selective-disclosure-jwt].¶
This section defines encoding, validation and processing rules for SD-JWT VCs.¶
SD-JWT VCs compliant with this specification MUST use the media type
application/vc+sd-jwt
as defined in Appendix A.2.1.¶
SD-JWT VCs MUST be encoded using the SD-JWT format defined in Section 5 of [I-D.ietf-oauth-selective-disclosure-jwt]. A presentation of an SD-JWT VC MAY contain a Key Binding JWT.¶
Note that in some cases, an SD-JWT VC MAY have no selectively disclosable claims, and therefore the encoded SD-JWT will not contain any Disclosures.¶
This section defines JWT header parameters for the SD-JWT component of the SD-JWT VC.¶
The typ
header parameter of the SD-JWT MUST be present. The typ
value MUST
use vc+sd-jwt
. This indicates that the payload of the SD-JWT contains plain
JSON and follows the rules as defined in this specification. It further
indicates that the SD-JWT is a SD-JWT component of a SD-JWT VC.¶
The following is a non-normative example of a decoded SD-JWT header:¶
{ "alg": "ES256", "typ": "vc+sd-jwt" }¶
This section defines the claims that can be included in the payload of SD-JWT VCs.¶
vct
Claim
This specification defines the JWT claim vct
(for verifiable credential type). The vct
value MUST be a
case-sensitive StringOrURI
(see [RFC7519]) value serving as an identifier
for the type of the SD-JWT VC. The vct
value MUST be a Collision-Resistant
Name as defined in Section 2 of [RFC7515].¶
A type is associated with rules defining which claims may or must appear in the
Unsecured Payload of the SD-JWT VC and whether they may, must, or must not be
selectively disclosable. This specification does not define any vct
values; instead
it is expected that ecosystems using SD-JWT VCs define such values including
the semantics of the respective claims and associated rules (e.g., policies for issuing and
validating credentials beyond what is defined in this specification).¶
The following is a non-normative example of how vct
is used to express
a type:¶
{ "vct": "https://credentials.example.com/identity_credential" }¶
For example, a value of https://credentials.example.com/identity_credential
can be associated with rules that define that at least the registered JWT claims given_name
, family_name
, birthdate
, and address
must appear in the Unsecured Payload. Additionally, the registered JWT claims email
and phone_number
, and the private claims is_over_18
, is_over_21
, and is_over_65
may be used. The type might also indicate that any of the aforementioned claims can be selectively disclosable.¶
SD-JWT VCs MAY use any claim registered in the "JSON Web Token Claims" registry as defined in [RFC7519].¶
If present, the following registered JWT claims MUST be included in the SD-JWT and MUST NOT be included in the Disclosures, i.e. cannot be selectively disclosed:¶
iss
¶
nbf
¶
exp
¶
cnf
¶
vct
¶
https://credentials.example.com/identity_credential
, as defined in Section 3.2.2.1.1.¶
status
¶
The following registered JWT claims MAY be contained in the SD-JWT or in the Disclosures and MAY be selectively disclosed:¶
Additional public claims MAY be used in SD-JWT VCs depending on the application.¶
An SD-JWT VC MAY have no selectively disclosable claims.
In that case, the SD-JWT VC MUST NOT contain the _sd
claim in the JWT body. It also
MUST NOT have any Disclosures.¶
The following is a non-normative example of the user data of an unsecured payload of an SD-JWT VC.¶
{ "vct": "https://credentials.example.com/identity_credential", "given_name": "John", "family_name": "Doe", "email": "johndoe@example.com", "phone_number": "+1-202-555-0101", "address": { "street_address": "123 Main St", "locality": "Anytown", "region": "Anystate", "country": "US" }, "birthdate": "1940-01-01", "is_over_18": true, "is_over_21": true, "is_over_65": true }¶
The following is a non-normative example of how the unsecured payload of the SD-JWT VC above can be used in an SD-JWT where the resulting SD-JWT VC contains only claims about the Subject that are selectively disclosable:¶
{ "_sd": [ "09vKrJMOlyTWM0sjpu_pdOBVBQ2M1y3KhpH515nXkpY", "2rsjGbaC0ky8mT0pJrPioWTq0_daw1sX76poUlgCwbI", "EkO8dhW0dHEJbvUHlE_VCeuC9uRELOieLZhh7XbUTtA", "IlDzIKeiZdDwpqpK6ZfbyphFvz5FgnWa-sN6wqQXCiw", "JzYjH4svliH0R3PyEMfeZu6Jt69u5qehZo7F7EPYlSE", "PorFbpKuVu6xymJagvkFsFXAbRoc2JGlAUA2BA4o7cI", "TGf4oLbgwd5JQaHyKVQZU9UdGE0w5rtDsrZzfUaomLo", "jdrTE8YcbY4EifugihiAe_BPekxJQZICeiUQwY9QqxI", "jsu9yVulwQQlhFlM_3JlzMaSFzglhQG0DpfayQwLUK4" ], "iss": "https://example.com/issuer", "iat": 1683000000, "exp": 1883000000, "vct": "https://credentials.example.com/identity_credential", "_sd_alg": "sha-256", "cnf": { "jwk": { "kty": "EC", "crv": "P-256", "x": "TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc", "y": "ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ" } } }¶
Note that a cnf
claim has been added to the SD-JWT payload to express the
confirmation method of the Key Binding.¶
The following are the Disclosures belonging to the SD-JWT payload above:¶
Claim given_name
:¶
jsu9yVulwQQlhFlM_3JlzMaSFzglhQG0DpfayQwLUK4
¶
WyIyR0xDNDJzS1F2ZUNmR2ZyeU5STjl3IiwgImdpdmVuX25hbWUiLCAiSm9o
biJd
¶
["2GLC42sKQveCfGfryNRN9w", "given_name", "John"]
¶
Claim family_name
:¶
TGf4oLbgwd5JQaHyKVQZU9UdGE0w5rtDsrZzfUaomLo
¶
WyJlbHVWNU9nM2dTTklJOEVZbnN4QV9BIiwgImZhbWlseV9uYW1lIiwgIkRv
ZSJd
¶
["eluV5Og3gSNII8EYnsxA_A", "family_name", "Doe"]
¶
Claim email
:¶
JzYjH4svliH0R3PyEMfeZu6Jt69u5qehZo7F7EPYlSE
¶
WyI2SWo3dE0tYTVpVlBHYm9TNXRtdlZBIiwgImVtYWlsIiwgImpvaG5kb2VA
ZXhhbXBsZS5jb20iXQ
¶
["6Ij7tM-a5iVPGboS5tmvVA", "email", "johndoe@example.com"]
¶
Claim phone_number
:¶
PorFbpKuVu6xymJagvkFsFXAbRoc2JGlAUA2BA4o7cI
¶
WyJlSThaV205UW5LUHBOUGVOZW5IZGhRIiwgInBob25lX251bWJlciIsICIr
MS0yMDItNTU1LTAxMDEiXQ
¶
["eI8ZWm9QnKPpNPeNenHdhQ", "phone_number",
"+1-202-555-0101"]
¶
Claim address
:¶
IlDzIKeiZdDwpqpK6ZfbyphFvz5FgnWa-sN6wqQXCiw
¶
WyJRZ19PNjR6cUF4ZTQxMmExMDhpcm9BIiwgImFkZHJlc3MiLCB7InN0cmVl
dF9hZGRyZXNzIjogIjEyMyBNYWluIFN0IiwgImxvY2FsaXR5IjogIkFueXRv
d24iLCAicmVnaW9uIjogIkFueXN0YXRlIiwgImNvdW50cnkiOiAiVVMifV0
¶
["Qg_O64zqAxe412a108iroA", "address", {"street_address":
"123 Main St", "locality": "Anytown", "region": "Anystate",
"country": "US"}]
¶
Claim birthdate
:¶
jdrTE8YcbY4EifugihiAe_BPekxJQZICeiUQwY9QqxI
¶
WyJBSngtMDk1VlBycFR0TjRRTU9xUk9BIiwgImJpcnRoZGF0ZSIsICIxOTQw
LTAxLTAxIl0
¶
["AJx-095VPrpTtN4QMOqROA", "birthdate", "1940-01-01"]
¶
Claim is_over_18
:¶
09vKrJMOlyTWM0sjpu_pdOBVBQ2M1y3KhpH515nXkpY
¶
WyJQYzMzSk0yTGNoY1VfbEhnZ3ZfdWZRIiwgImlzX292ZXJfMTgiLCB0cnVl
XQ
¶
["Pc33JM2LchcU_lHggv_ufQ", "is_over_18", true]
¶
Claim is_over_21
:¶
2rsjGbaC0ky8mT0pJrPioWTq0_daw1sX76poUlgCwbI
¶
WyJHMDJOU3JRZmpGWFE3SW8wOXN5YWpBIiwgImlzX292ZXJfMjEiLCB0cnVl
XQ
¶
["G02NSrQfjFXQ7Io09syajA", "is_over_21", true]
¶
Claim is_over_65
:¶
EkO8dhW0dHEJbvUHlE_VCeuC9uRELOieLZhh7XbUTtA
¶
WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgImlzX292ZXJfNjUiLCB0cnVl
XQ
¶
["lklxF5jMYlGTPUovMNIvCA", "is_over_65", true]
¶
The SD-JWT and the Disclosures would then be serialized by the Issuer into the following format for issuance to the Holder:¶
eyJhbGciOiAiRVMyNTYiLCAidHlwIjogInZjK3NkLWp3dCIsICJraWQiOiAiZG9jLXNp Z25lci0wNS0yNS0yMDIyIn0.eyJfc2QiOiBbIjA5dktySk1PbHlUV00wc2pwdV9wZE9C VkJRMk0xeTNLaHBINTE1blhrcFkiLCAiMnJzakdiYUMwa3k4bVQwcEpyUGlvV1RxMF9k YXcxc1g3NnBvVWxnQ3diSSIsICJFa084ZGhXMGRIRUpidlVIbEVfVkNldUM5dVJFTE9p ZUxaaGg3WGJVVHRBIiwgIklsRHpJS2VpWmREd3BxcEs2WmZieXBoRnZ6NUZnbldhLXNO NndxUVhDaXciLCAiSnpZakg0c3ZsaUgwUjNQeUVNZmVadTZKdDY5dTVxZWhabzdGN0VQ WWxTRSIsICJQb3JGYnBLdVZ1Nnh5bUphZ3ZrRnNGWEFiUm9jMkpHbEFVQTJCQTRvN2NJ IiwgIlRHZjRvTGJnd2Q1SlFhSHlLVlFaVTlVZEdFMHc1cnREc3JaemZVYW9tTG8iLCAi amRyVEU4WWNiWTRFaWZ1Z2loaUFlX0JQZWt4SlFaSUNlaVVRd1k5UXF4SSIsICJqc3U5 eVZ1bHdRUWxoRmxNXzNKbHpNYVNGemdsaFFHMERwZmF5UXdMVUs0Il0sICJpc3MiOiAi aHR0cHM6Ly9leGFtcGxlLmNvbS9pc3N1ZXIiLCAiaWF0IjogMTY4MzAwMDAwMCwgImV4 cCI6IDE4ODMwMDAwMDAsICJ2Y3QiOiAiaHR0cHM6Ly9jcmVkZW50aWFscy5leGFtcGxl LmNvbS9pZGVudGl0eV9jcmVkZW50aWFsIiwgIl9zZF9hbGciOiAic2hhLTI1NiIsICJj bmYiOiB7Imp3ayI6IHsia3R5IjogIkVDIiwgImNydiI6ICJQLTI1NiIsICJ4IjogIlRD QUVSMTladnUzT0hGNGo0VzR2ZlNWb0hJUDFJTGlsRGxzN3ZDZUdlbWMiLCAieSI6ICJa eGppV1diWk1RR0hWV0tWUTRoYlNJaXJzVmZ1ZWNDRTZ0NGpUOUYySFpRIn19fQ.gC0bk 6D_NcGPiZ4rWOi0RVxQrleaGYgKY59xR_I6UhgJ7SpSAPlrijOsujXlv35mNkTKqcrOv KLVYZn3rj_tsA~WyIyR0xDNDJzS1F2ZUNmR2ZyeU5STjl3IiwgImdpdmVuX25hbWUiLC AiSm9obiJd~WyJlbHVWNU9nM2dTTklJOEVZbnN4QV9BIiwgImZhbWlseV9uYW1lIiwgI kRvZSJd~WyI2SWo3dE0tYTVpVlBHYm9TNXRtdlZBIiwgImVtYWlsIiwgImpvaG5kb2VA ZXhhbXBsZS5jb20iXQ~WyJlSThaV205UW5LUHBOUGVOZW5IZGhRIiwgInBob25lX251b WJlciIsICIrMS0yMDItNTU1LTAxMDEiXQ~WyJRZ19PNjR6cUF4ZTQxMmExMDhpcm9BIi wgImFkZHJlc3MiLCB7InN0cmVldF9hZGRyZXNzIjogIjEyMyBNYWluIFN0IiwgImxvY2 FsaXR5IjogIkFueXRvd24iLCAicmVnaW9uIjogIkFueXN0YXRlIiwgImNvdW50cnkiOi AiVVMifV0~WyJBSngtMDk1VlBycFR0TjRRTU9xUk9BIiwgImJpcnRoZGF0ZSIsICIxOT QwLTAxLTAxIl0~WyJQYzMzSk0yTGNoY1VfbEhnZ3ZfdWZRIiwgImlzX292ZXJfMTgiLC B0cnVlXQ~WyJHMDJOU3JRZmpGWFE3SW8wOXN5YWpBIiwgImlzX292ZXJfMjEiLCB0cnV lXQ~WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgImlzX292ZXJfNjUiLCB0cnVlXQ~¶
Examples of what presentations of SD-JWT VCs might look like are provided in Section 4.2.¶
The recipient (Holder or Verifier) of an SD-JWT VC MUST process and verify an SD-JWT VC as described in Section 8 of [I-D.ietf-oauth-selective-disclosure-jwt].¶
If Key Binding is required (refer to the security considerations in Section 11.6 of [I-D.ietf-oauth-selective-disclosure-jwt]), the Verifier MUST verify the Key Binding JWT
according to Section 8 of [I-D.ietf-oauth-selective-disclosure-jwt]. To verify
the Key Binding JWT, the cnf
claim of the SD-JWT MUST be used.¶
Furthermore, the recipient of the SD-JWT VC MUST validate the public verification key for the Issuer-signed JWT as defined in Section 3.5.¶
If a schema is provided in the Type Metadata, a recipient MUST validate the schema as defined in Section 6.5.¶
If there are no selectively disclosable claims, there is no need to process the
_sd
claim nor any Disclosures.¶
If status
is present in the verified payload of the SD-JWT, the status SHOULD
be checked. It depends on the Verifier policy to reject or accept a presentation
of a SD-JWT VC based on the status of the Verifiable Credential.¶
Any claims used that are not understood MUST be ignored.¶
Additional validation rules MAY apply, but their use is out of the scope of this specification.¶
A recipient of an SD-JWT VC MUST apply the following rules to validate that the public
verification key for the Issuer-signed JWT corresponds to the iss
value:¶
iss
value contains an HTTPS URI, the recipient MUST
obtain the public key using JWT VC Issuer Metadata as defined in Section 5.¶
X.509 Certificates: If the recipient supports X.509 Certificates and the iss
value contains an HTTPS URI, the recipient MUST¶
x5c
header parameter of the Issuer-signed JWT and validate the X.509 certificate chain accordingly, and¶
iss
value matches a uniformResourceIdentifier
SAN entry of the end-entity certificate or that the domain name in the iss
value matches the dNSName
SAN entry of the end-entity certificate.¶
iss
value contains a DID [W3C.DID], the recipient MUST retrieve the public key from the DID Document resolved from the DID in the iss
value. In this case, if the kid
JWT header parameter is present, the kid
MUST be a relative or absolute DID URL of the DID in the iss
value, identifying the public key.¶
Separate specifications or ecosystem regulations MAY define rules complementing the rules defined above, but such rules are out of scope of this specification. See Section 10.2 for security considerations.¶
If a recipient cannot validate that the public verification key corresponds to the iss
value of the Issuer-signed JWT, the SD-JWT VC MUST be rejected.¶
This section defines encoding, validation and processing rules for presentations of SD-JWT VCs.¶
If the presentation of the SD-JWT VC includes a Key Binding JWT, the Key Binding JWT MUST adhere to the rules defined in Section 5.3 of [I-D.ietf-oauth-selective-disclosure-jwt].¶
The Key Binding JWT MAY include additional claims which, when not understood, MUST be ignored by the Verifier.¶
The following is a non-normative example of a presentation of the SD-JWT shown in Section 3.3 including a Key Binding JWT.
In this presentation, the Holder provides only the Disclosures for the address
and is_over_65
claims.
Other claims are not disclosed to the Verifier.¶
eyJhbGciOiAiRVMyNTYiLCAidHlwIjogInZjK3NkLWp3dCIsICJraWQiOiAiZG9jLXNp Z25lci0wNS0yNS0yMDIyIn0.eyJfc2QiOiBbIjA5dktySk1PbHlUV00wc2pwdV9wZE9C VkJRMk0xeTNLaHBINTE1blhrcFkiLCAiMnJzakdiYUMwa3k4bVQwcEpyUGlvV1RxMF9k YXcxc1g3NnBvVWxnQ3diSSIsICJFa084ZGhXMGRIRUpidlVIbEVfVkNldUM5dVJFTE9p ZUxaaGg3WGJVVHRBIiwgIklsRHpJS2VpWmREd3BxcEs2WmZieXBoRnZ6NUZnbldhLXNO NndxUVhDaXciLCAiSnpZakg0c3ZsaUgwUjNQeUVNZmVadTZKdDY5dTVxZWhabzdGN0VQ WWxTRSIsICJQb3JGYnBLdVZ1Nnh5bUphZ3ZrRnNGWEFiUm9jMkpHbEFVQTJCQTRvN2NJ IiwgIlRHZjRvTGJnd2Q1SlFhSHlLVlFaVTlVZEdFMHc1cnREc3JaemZVYW9tTG8iLCAi amRyVEU4WWNiWTRFaWZ1Z2loaUFlX0JQZWt4SlFaSUNlaVVRd1k5UXF4SSIsICJqc3U5 eVZ1bHdRUWxoRmxNXzNKbHpNYVNGemdsaFFHMERwZmF5UXdMVUs0Il0sICJpc3MiOiAi aHR0cHM6Ly9leGFtcGxlLmNvbS9pc3N1ZXIiLCAiaWF0IjogMTY4MzAwMDAwMCwgImV4 cCI6IDE4ODMwMDAwMDAsICJ2Y3QiOiAiaHR0cHM6Ly9jcmVkZW50aWFscy5leGFtcGxl LmNvbS9pZGVudGl0eV9jcmVkZW50aWFsIiwgIl9zZF9hbGciOiAic2hhLTI1NiIsICJj bmYiOiB7Imp3ayI6IHsia3R5IjogIkVDIiwgImNydiI6ICJQLTI1NiIsICJ4IjogIlRD QUVSMTladnUzT0hGNGo0VzR2ZlNWb0hJUDFJTGlsRGxzN3ZDZUdlbWMiLCAieSI6ICJa eGppV1diWk1RR0hWV0tWUTRoYlNJaXJzVmZ1ZWNDRTZ0NGpUOUYySFpRIn19fQ.gC0bk 6D_NcGPiZ4rWOi0RVxQrleaGYgKY59xR_I6UhgJ7SpSAPlrijOsujXlv35mNkTKqcrOv KLVYZn3rj_tsA~WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgImlzX292ZXJfNjUiLC B0cnVlXQ~WyJRZ19PNjR6cUF4ZTQxMmExMDhpcm9BIiwgImFkZHJlc3MiLCB7InN0cmV ldF9hZGRyZXNzIjogIjEyMyBNYWluIFN0IiwgImxvY2FsaXR5IjogIkFueXRvd24iLCA icmVnaW9uIjogIkFueXN0YXRlIiwgImNvdW50cnkiOiAiVVMifV0~eyJhbGciOiAiRVM yNTYiLCAidHlwIjogImtiK2p3dCJ9.eyJub25jZSI6ICIxMjM0NTY3ODkwIiwgImF1ZC I6ICJodHRwczovL2V4YW1wbGUuY29tL3ZlcmlmaWVyIiwgImlhdCI6IDE3MjY2ODU5MT gsICJzZF9oYXNoIjogIjUtdjc5cjBjcFozdm9la3FCM1duN0tydjY4azFQTHVWbzNrTF NCdjBNU0EifQ.p4Y2n_j3k2rc4dkctq_4l1Q6opU7RekZkrdMwVJ5BO92K9KeAP5QXRi rd2gwa4tTbMny7grYTxZ7imxfnPz3Tw¶
After validation, the Verifier will have the following processed SD-JWT payload available for further handling:¶
{ "iss": "https://example.com/issuer", "iat": 1683000000, "exp": 1883000000, "vct": "https://credentials.example.com/identity_credential", "cnf": { "jwk": { "kty": "EC", "crv": "P-256", "x": "TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc", "y": "ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ" } }, "is_over_65": true, "address": { "street_address": "123 Main St", "locality": "Anytown", "region": "Anystate", "country": "US" } }¶
The following example shows a presentation of a (similar but different) SD-JWT without a Key Binding JWT:¶
eyJhbGciOiAiRVMyNTYiLCAidHlwIjogInZjK3NkLWp3dCJ9.eyJfc2QiOiBbIjA5dkt ySk1PbHlUV00wc2pwdV9wZE9CVkJRMk0xeTNLaHBINTE1blhrcFkiLCAiMnJzakdiYUM wa3k4bVQwcEpyUGlvV1RxMF9kYXcxc1g3NnBvVWxnQ3diSSIsICJFa084ZGhXMGRIRUp idlVIbEVfVkNldUM5dVJFTE9pZUxaaGg3WGJVVHRBIiwgIklsRHpJS2VpWmREd3BxcEs 2WmZieXBoRnZ6NUZnbldhLXNONndxUVhDaXciLCAiSnpZakg0c3ZsaUgwUjNQeUVNZmV adTZKdDY5dTVxZWhabzdGN0VQWWxTRSIsICJQb3JGYnBLdVZ1Nnh5bUphZ3ZrRnNGWEF iUm9jMkpHbEFVQTJCQTRvN2NJIiwgIlRHZjRvTGJnd2Q1SlFhSHlLVlFaVTlVZEdFMHc 1cnREc3JaemZVYW9tTG8iLCAiamRyVEU4WWNiWTRFaWZ1Z2loaUFlX0JQZWt4SlFaSUN laVVRd1k5UXF4SSIsICJqc3U5eVZ1bHdRUWxoRmxNXzNKbHpNYVNGemdsaFFHMERwZmF 5UXdMVUs0Il0sICJpc3MiOiAiaHR0cHM6Ly9leGFtcGxlLmNvbS9pc3N1ZXIiLCAiaWF 0IjogMTY4MzAwMDAwMCwgImV4cCI6IDE4ODMwMDAwMDAsICJ2Y3QiOiAiaHR0cHM6Ly9 jcmVkZW50aWFscy5leGFtcGxlLmNvbS9pZGVudGl0eV9jcmVkZW50aWFsIiwgIl9zZF9 hbGciOiAic2hhLTI1NiJ9.Euo9Rb7DAKYdcAQ1cLlLipK3kek4mfaOdMBRIBH6gdnUJP kzBP4_vCBkwXsN4MZLyPdSqHXCSoNi4aE6284IWQ~WyJsa2x4RjVqTVlsR1RQVW92TU5 JdkNBIiwgImlzX292ZXJfNjUiLCB0cnVlXQ~WyJRZ19PNjR6cUF4ZTQxMmExMDhpcm9B IiwgImFkZHJlc3MiLCB7InN0cmVldF9hZGRyZXNzIjogIjEyMyBNYWluIFN0IiwgImxv Y2FsaXR5IjogIkFueXRvd24iLCAicmVnaW9uIjogIkFueXN0YXRlIiwgImNvdW50cnki OiAiVVMifV0~¶
The Verifier will have the following processed SD-JWT payload after validation:¶
{ "iss": "https://example.com/issuer", "iat": 1683000000, "exp": 1883000000, "vct": "https://credentials.example.com/identity_credential", "is_over_65": true, "address": { "street_address": "123 Main St", "locality": "Anytown", "region": "Anystate", "country": "US" } }¶
This specification defines the JWT VC Issuer Metadata to retrieve the JWT VC
Issuer Metadata configuration of the Issuer of the SD-JWT VC. The Issuer
is identified by the iss
claim in the JWT. Use of the JWT VC Issuer Metadata
is OPTIONAL.¶
Issuers publishing JWT VC Issuer Metadata MUST make a JWT VC Issuer Metadata
configuration available at the location formed by inserting the well-known string
/.well-known/jwt-vc-issuer
between the host component and the path
component (if any) of the iss
claim value in the JWT. The iss
MUST
be a case-sensitive URL using the HTTPS scheme that contains scheme, host and,
optionally, port number and path components, but no query or fragment
components.¶
A JWT VC Issuer Metadata configuration MUST be queried using an HTTP GET
request
at the path defined in Section 5.¶
The following is a non-normative example of an HTTP request for the JWT VC Issuer
Metadata configuration when iss
is set to https://example.com
:¶
GET /.well-known/jwt-vc-issuer HTTP/1.1 Host: example.com¶
If the iss
value contains a path component, any terminating /
MUST be
removed before inserting /.well-known/
and the well-known URI suffix
between the host component and the path component.¶
The following is a non-normative example of a HTTP request for the JWT VC Issuer
Metadata configuration when iss
is set to https://example.com/tenant/1234
:¶
GET /.well-known/jwt-vc-issuer/tenant/1234 HTTP/1.1 Host: example.com¶
A successful response MUST use the 200 OK HTTP
and return the JWT VC Issuer
Metadata configuration using the application/json
content type.¶
An error response uses the applicable HTTP status code value.¶
This specification defines the following JWT VC Issuer Metadata configuration parameters:¶
issuer
¶
iss
value in the JWT.¶
jwks_uri
¶
jwks
¶
JWT VC Issuer Metadata MUST include either jwks_uri
or jwks
in their JWT VC
Issuer Metadata, but not both.¶
It is RECOMMENDED that the JWT contains a kid
JWT header parameter that can
be used to look up the public key in the JWK Set included by value or referenced
in the JWT VC Issuer Metadata.¶
The following is a non-normative example of a JWT VC Issuer Metadata configuration
including jwks
:¶
{ "issuer":"https://example.com", "jwks":{ "keys":[ { "kid":"doc-signer-05-25-2022", "e":"AQAB", "n":"nj3YJwsLUFl9BmpAbkOswCNVx17Eh9wMO-_AReZwBqfaWFcfG HrZXsIV2VMCNVNU8Tpb4obUaSXcRcQ-VMsfQPJm9IzgtRdAY8NN8Xb7PEcYyk lBjvTtuPbpzIaqyiUepzUXNDFuAOOkrIol3WmflPUUgMKULBN0EUd1fpOD70p RM0rlp_gg_WNUKoW1V-3keYUJoXH9NztEDm_D2MQXj9eGOJJ8yPgGL8PAZMLe 2R7jb9TxOCPDED7tY_TU4nFPlxptw59A42mldEmViXsKQt60s1SLboazxFKve qXC_jpLUt22OC6GUG63p-REw-ZOr3r845z50wMuzifQrMI9bQ", "kty":"RSA" } ] } }¶
The following is a non-normative example of a JWT VC Issuer Metadata
configuration including jwks_uri
:¶
{ "issuer":"https://example.com", "jwks_uri":"https://jwt-vc-issuer.example.org/my_public_keys.jwks" }¶
Additional JWT VC Issuer Metadata configuration parameters MAY also be used.¶
The issuer
value returned MUST be identical to the iss
value of the
JWT. If these values are not identical, the data contained in the response
MUST NOT be used.¶
An SD-JWT VC type, i.e., the vct
value, is associated with Type Metadata defining, for example, information about the type or a schema defining (see Section 6.5.1) which claims MAY or MUST appear in the SD-JWT VC, and how credentials are displayed.¶
This section defines Type Metadata that can be associated with a type of a SD-JWT VC, as well as a method for retrieving the Type Metadata and processing rules. This Type Metadata is intended to be used, among other things, for the following purposes:¶
Type Metadata can be retrieved as described in Section 6.3.¶
All examples in this section are non-normative.¶
The following is an example of an SD-JWT VC payload, containing a vct
claim
with the value https://betelgeuse.example.com/education_credential
:¶
{ "vct": "https://betelgeuse.example.com/education_credential", "vct#integrity": "sha256-WRL5ca_xGgX3c1VLmXfh-9cLlJNXN-TsMk-PmKjZ5t0", ... }¶
Type Metadata for the type https://betelgeuse.example.com/education_credential
can be retrieved using various mechanisms as described in
Section 6.3. For this example, the well-known URL as defined in
Section 6.3.1 is used and the following Type Metadata Document is
retrieved from the URL
https://betelgeuse.example.com/.well-known/vct/education_credential
:¶
{ "vct":"https://betelgeuse.example.com/education_credential", "name":"Betelgeuse Education Credential - Preliminary Version", "description":"This is our development version of the education credential. Don't panic.", "extends":"https://galaxy.example.com/galactic-education-credential-0.9", "extends#integrity":"sha256-9cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1VLmXfh-WRL5", "schema_uri":"https://exampleuniversity.com/public/credential-schema-0.9", "schema_uri#integrity":"sha256-o984vn819a48ui1llkwPmKjZ5t0WRL5ca_xGgX3c1VLmXfh" }¶
This example is shortened for presentation, a full Type Metadata example can be found in Appendix B.2.¶
Note: The hash of the Type Metadata document shown in the second example must be equal
to the one in the vct#integrity
claim in the SD-JWT VC payload,
WRL5ca_xGgX3c1VLmXfh-9cLlJNXN-TsMk-PmKjZ5t0
.¶
The Type Metadata document MUST be a JSON object. The following properties are defined:¶
name
¶
description
¶
extends
¶
display
: An object containing display information for the type, as described
in Section 8. This property is OPTIONAL.¶
claims
: An object containing claim information for the type, as described in
Section 9. This property is OPTIONAL.¶
schema
¶
schema
MUST NOT be used
if schema_uri
is present.¶
schema_uri
¶
schema_uri
MUST NOT
be used if schema
is present.¶
An example of a Type Metadata document is shown in Appendix B.2.¶
vct
Claim
A URI in the vct
claim can be used to express a type. If the
type is a URL using the HTTPS scheme, Type Metadata can be retrieved from the URL
https://<authority>/.well-known/vct/<type>
, i.e., by inserting
/.well-known/vct
after the authority part of the URL.¶
The Type Metadata is retrieved using the HTTP GET method. The response MUST be a JSON object as defined in Section 6.2.¶
If the claim vct#integrity
is present in the SD-JWT VC, its value
vct#integrity
MUST be an "integrity metadata" string as defined in Section Section 7.¶
A Consumer MAY use a registry to retrieve Type Metadata for a SD-JWT VC type, e.g., if the type is not a HTTPS URL or if the Consumer does not have access to the URL. The registry MUST be a trusted registry, i.e., the Consumer MUST trust the registry to provide correct Type Metadata for the type.¶
The registry MUST provide the Type Metadata in the same format as described in Section 6.2.¶
Ecosystems MAY define additional methods for retrieving Type Metadata. For example, a
standardization body or a community MAY define a service which has to be used to
retrieve Type Metadata based on a URN in the vct
claim.¶
A Consumer MAY cache Type Metadata for a SD-JWT VC type. If a hash for integrity
protection is present in the Type Metadata as defined in Section 7, the Consumer MAY assume that the Type Metadata is static and can be cached
indefinitely. Otherwise, the Consumer MUST use the Cache-Control
header of the HTTP response to determine how long the metadata can be cached.¶
Credentials MAY encode Type Metadata directly, providing it as "glue information" to the Consumer.¶
For JSON-serialized JWS-based credentials, such Type Metadata documents MAY be
included in the unprotected header of the JWS. In this case, the key vctm
MUST
be used in the unprotected header and its value MUST be an array of
base64url-encoded Type Metadata documents as defined in this specification.
Multiple documents MAY be included for providing a whole chain of types to the
Consumer (see Section 6.4).¶
A Consumer of a credential MAY use the documents in the vctm
array instead of retrieving the respective Type Metadata elsewhere as follows:¶
vct
in a credential, the Consumer MUST ensure
that the vct
claim in the credential matches the one in the Type Metadata
document, and it MUST verify the integrity of the Type Metadata document as
defined in Section 7. The Consumer MUST NOT use the Type Metadata if no hash for integrity protection was provided in vct#integrity
.¶
extends
property in a Type Metadata document, the Consumer MUST ensure that the value of the extends
property in the
Type Metadata document matches that of the vct
in the Type Metadata document, and it MUST verify the integrity of the Type Metadata document as defined in
Section 7. The Consumer MUST NOT use the Type Metadata if no hash for integrity protection was provided.¶
An SD-JWT VC type can extend another type. The extended type is identified by the URI in
the extends
property. Consumers MUST retrieve and process
Type Metadata for the extended type before processing the Type Metadata for the extending
type.¶
The extended type MAY itself extend another type. This can be used to create a chain or hierarchy of types. The security considerations described in Section 10.3 apply in order to avoid problems with circular dependencies.¶
Schemas for Verifiable Credentials are contained in the schema
or retrieved via the schema_uri
Type Metadata parameters (as defined in Section 6.2).
A schema MUST be represented by a JSON Schema document according to draft version 2020-12 [JSON.SCHEMA.2020-12] or above.¶
The schema of a Verifiable Credential MUST include all properties that are required by this specification and MUST NOT override their cardinality, JSON data type, or semantic intent.¶
The following is a non-normative example of a JSON Schema document for the example in Section 3.3 requiring the presence of the cnf
claim in an SD-JWT VC presentation:¶
{ "$schema":"https://json-schema.org/draft/2020-12/schema", "type":"object", "properties":{ "vct":{ "type":"string" }, "iss":{ "type":"string" }, "nbf":{ "type":"number" }, "exp":{ "type":"number" }, "cnf":{ "type":"object" }, "status":{ "type":"object" }, "given_name":{ "type":"string" }, "family_name":{ "type":"string" }, "email":{ "type":"string" }, "phone_number":{ "type":"string" }, "address":{ "type":"object", "properties":{ "street_address":{ "type":"string" }, "locality":{ "type":"string" }, "region":{ "type":"string" }, "country":{ "type":"string" } } }, "birthdate":{ "type":"string" }, "is_over_18":{ "type":"boolean" }, "is_over_21":{ "type":"boolean" }, "is_over_65":{ "type":"boolean" } }, "required":[ "iss", "vct", "cnf" ] }¶
Note that iss
and vct
are always required by this specification.¶
If a schema
or schema_uri
property is present, a Consumer MUST validate the JSON document resulting from the SD-JWT verification algorithm
(as defined in Section 8 of [I-D.ietf-oauth-selective-disclosure-jwt]) against the JSON Schema document provided by the schema
or schema_uri
property.¶
If an extends
property is present, the schema of the extended type MUST also be validated in the same manner. This process includes
validating all subsequent extended types recursively until a type is encountered that does not contain an extends
property in its Type Metadata.
Each schema in this chain MUST be evaluated for a specific Verifiable Credential.¶
If the schema validation fails for any of the types in the chain, the Consumer MUST reject the Verifiable Credential.¶
The following is a non-normative example of a result JSON document after executing the SD-JWT verification algorithm that is validated against the JSON Schema document in the example provided in Section 6.5.1:¶
{ "vct":"https://credentials.example.com/identity_credential", "iss":"https://example.com/issuer", "iat":1683000000, "exp":1883000000, "sub":"6c5c0a49-b589-431d-bae7-219122a9ec2c", "address":{ "country":"DE" }, "cnf":{ "jwk":{ "kty":"EC", "crv":"P-256", "x":"TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc", "y":"ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ" } } }¶
Note, the example above does not contain any _sd_alg
, _sd
, or ...
claims.¶
Both the vct
claim in the SD-JWT VC and the various URIs in the Type Metadata MAY be accompanied by a respective claim suffixed with #integrity
, in particular:¶
vct
as defined in Section 3.2.2.2,¶
extends
as defined in Section 6.4¶
uri
as used in two places in Section 8.1¶
schema_uri
as defined in Section 6.5¶
The value MUST be an "integrity metadata" string as defined in Section 3 of [W3C.SRI]. A Consumer of the respective documents MUST verify the integrity of the retrieved document as defined in Section 3.3.5 of [W3C.SRI].¶
The display
property is an array containing display information for the type.
The array MUST contain an object for each language that is supported by the
type. The consuming application MUST use the language tag it considers most
appropriate for the user.¶
The objects in the array have the following properties:¶
lang
: A language tag as defined in Section 2 of [RFC5646]. This property is REQUIRED.¶
name
: A human-readable name for the type, intended for end users. This
property is REQUIRED.¶
description
: A human-readable description for the type, intended for end
users. This property is OPTIONAL.¶
rendering
: An object containing rendering information for the type, as
described in Section 8.1. This property is OPTIONAL.¶
The rendering
property is an object containing rendering information for the
type. The object MUST contain a property for each rendering method that is
supported by the type. The property name MUST be a rendering method identifier
and the property value MUST be an object containing the properties defined for
the rendering method.¶
The simple
rendering method is intended for use in applications that do not
support SVG rendering. The object contains the following properties:¶
logo
: An object containing information about the logo to be displayed for
the type, as described in Section 8.1.1.1. This property is OPTIONAL.¶
background_color
: An RGB color value as defined in [W3C.CSS-COLOR] for the background of the credential.
This property is OPTIONAL.¶
text_color
: An RGB color value as defined in [W3C.CSS-COLOR] value for the text of the credential. This property
is OPTIONAL.¶
The logo
property is an object containing information about the logo to be
displayed for the type. The object contains the following properties:¶
The svg_template
rendering method is intended for use in applications that
support SVG rendering. The object MUST contain an array of objects containing
information about the SVG templates available for the type. Each object contains
the following properties:¶
uri
: A URI pointing to the SVG template. This property is REQUIRED.¶
uri#integrity
: An "integrity metadata" string as described in
Section 7. This property is OPTIONAL.¶
properties
: An object containing properties for the SVG template, as
described in Section 8.1.2.1. This property is REQUIRED if more than
one SVG template is present, otherwise it is OPTIONAL.¶
The properties
property is an object containing properties for the SVG
template. Consuming applications MUST use these properties to find the best SVG
template available for display to the user based on the display properties
(landscape/portrait) and user preferences (color scheme, contrast). The object
MUST contain at least one of the following properties:¶
orientation
: The orientation for which the SVG template is optimized, with
valid values being portrait
and landscape
. This property is OPTIONAL.¶
color_scheme
: The color scheme for which the SVG template is optimized, with
valid values being light
and dark
. This property is OPTIONAL.¶
contrast
: The contrast for which the SVG template is optimized, with valid
values being normal
and high
. This property is OPTIONAL.¶
Consuming application MUST preprocess the SVG template by replacing placeholders
in the SVG template with properly escaped values of the claims in the credential. The
placeholders MUST be defined in the SVG template using the syntax
{{svg_id}}
, where svg_id
is an identifier defined in the claim metadata as
described in Section 9.¶
Placeholders MUST only be used in the text content of the SVG template and MUST NOT be used in any other part of the SVG template, e.g., in attributes or comments.¶
A consuming application MUST ensure that all special characters in the claim values are properly escaped before inserting them into the SVG template. At least the following characters MUST be escaped:¶
If the svg_id
is not present in the claim metadata, the consuming application
SHOULD reject not render the SVG template. If the svg_id
is present in the
claim metadata, but the claim is not present in the credential, the placeholder
MUST be replaced with an empty string or a string appropriate to indicate that
the value is absent.¶
The following non-normative example shows a minimal SVG with one placeholder
using the svg_id
value address_street_address
which is defined in the
example in Appendix B.2:¶
<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"> <text x="10" y="20">Street address: {{address_street_address}}</text> </svg>¶
When rendering the SVG template, the consuming application MUST ensure that malicious schema providers or issuers cannot inject executable code into the SVG template and thereby compromise the security of the consuming application. The consuming application MUST NOT execute any code in the SVG template. If code execution cannot be prevented reliably, the SVG display MUST be sandboxed.¶
The claims
property is an array of objects containing information about
particular claims for displaying and validating the claims.¶
The array MAY contain an object for each claim that is supported by the type. Each object contains the following properties:¶
path
: An array indicating the claim or claims that are being addressed, as
described below. This property is REQUIRED.¶
display
: An object containing display information for the claim, as
described in Section 9.2. This property is OPTIONAL.¶
sd
: A string indicating whether the claim is selectively disclosable, as
described in Section 9.3. This property is OPTIONAL.¶
svg_id
: A string defining the ID of the claim for reference in the SVG
template, as described in Section 8.1.2.2. The ID MUST be unique within the
type metadata. It MUST consist of only alphanumeric characters and underscores
and MUST NOT start with a digit. This property is OPTIONAL.¶
The path
property MUST be a non-empty array of strings, null
values, or
non-negative integers. It is used to select a particular claim in the credential
or a set of claims. A string indicates that the respective key is to be
selected, a null
value indicates that all elements of the currently selected
array(s) are to be selected, and a non-negative integer indicates that the
respective index in an array is to be selected.¶
The following shows a non-normative, reduced example of a credential:¶
{ "vct": "https://betelgeuse.example.com/education_credential", "name": "Arthur Dent", "address": { "street_address": "42 Market Street", "city": "Milliways", "postal_code": "12345" }, "degrees": [ { "type": "Bachelor of Science", "university": "University of Betelgeuse" }, { "type": "Master of Science", "university": "University of Betelgeuse" } ], "nationalities": ["British", "Betelgeusian"] }¶
The following shows examples of path
values and the respective selected
claims in the credential above:¶
["name"]
: The claim name
with the value Arthur Dent
is selected.¶
["address"]
: The claim address
with its sub-claims as the value is selected.¶
["address", "street_address"]
: The claim street_address
with the value
42 Market Street
is selected.¶
["degrees", null, "type"]
: All type
claims in the degrees
array are
selected.¶
In detail, the array is processed from left to right as follows:¶
Process the path
components from left to right:¶
path
component is a string, select the element in the respective
key in the currently selected element(s). If any of the currently
selected element(s) is not an object, abort processing and return an
error. If the key does not exist in any element currently selected,
remove that element from the selection.¶
path
component is null
, select all elements of the currently
selected array(s). If any of the currently selected element(s) is not an
array, abort processing and return an error.¶
path
component is a non-negative integer, select the element at
the respective index in the currently selected array(s). If any of the
currently selected element(s) is not an array, abort processing and
return an error. If the index does not exist in a selected array, remove
that array from the selection.¶
The result of the processing is the set of elements to which the respective claim metadata applies.¶
The path
property MUST point to the respective claim as if all
selectively disclosable claims were disclosed to a Verifier. That means that a
consuming application which does not have access to all disclosures may not be
able to identify the claim which is being addressed.¶
The display
property is an array containing display information for the
claim. The array MUST contain an object for each language that is supported by
the type. The consuming application MUST use the language tag it considers most
appropriate for the user.¶
The objects in the array have the following properties:¶
The sd
property is a string indicating whether the claim is selectively
disclosable. The following values are defined:¶
always
: The Issuer MUST make the claim selectively disclosable.¶
allowed
: The Issuer MAY make the claim selectively disclosable.¶
never
: The Issuer MUST NOT make the claim selectively disclosable.¶
If omitted, the default value is allowed
.¶
The Security Considerations in the SD-JWT specification [I-D.ietf-oauth-selective-disclosure-jwt] apply to this specification. Additionally, the following security considerations need to be taken into account when using SD-JWT VCs:¶
The JWT VC Issuer Metadata configuration is retrieved from the JWT VC Issuer by the Holder or Verifier. Similar to other metadata endpoints, the URL for the retrieval MUST be considered an untrusted value and could be a vector for Server-Side Request Forgery (SSRF) attacks.¶
Before making a request to the JWT VC Issuer Metadata endpoint, the Holder or Verifier MUST validate the URL to ensure that it is a valid HTTPS URL and that it does not point to internal resources. This requires, in particular, ensuring that the host part of the URL does not address an internal service (by IP address or an internal host name) and that, if an external DNS name is used, the resolved DNS name does not point to an internal IPv4 or IPv6 address.¶
When retrieving the metadata, the Holder or Verifier MUST ensure that the request is made in a time-bound and size-bound manner to prevent denial of service attacks. The Holder or Verifier MUST also ensure that the response is a valid JWT VC Issuer Metadata configuration document before processing it.¶
Additional considerations can be found in [OWASP_SSRF].¶
When defining ecosystem-specific rules for the verification of the public key,
as outlined in Section 3.5, it is critical
that those rules maintain the integrity of the relationship between the iss
value
within the Issuer-signed JWT and the public keys of the Issuer.¶
It MUST be ensured that for any given iss
value, an attacker cannot influence
the type of verification process used. Otherwise, an attacker could attempt to make
the Verifier use a verification process not intended by the Issuer, allowing the
attacker to potentially manipulate the verification result to their advantage.¶
A type MUST NOT extend another type that extends (either directly or with steps in-between) the first type. This would result in a circular dependency that could lead to infinite recursion when retrieving and processing the metadata.¶
Consumers MUST detect such circular dependencies and reject the credential.¶
In Section 6.3, various methods for distributing and retrieving metadata are described. Methods relying on a network connection may fail due to network issues or unavailability of a network connection due to offline usage of credentials, temporary server outages, or denial of service attacks on the metadata server.¶
Consumers SHOULD therefore implement a local cache as described in Section 6.3.4 if possible. Such a cache MAY be populated with metadata before the credential is used.¶
Issuers MAY provide glue documents as described in Section 6.3.5 to provide metadata directly with the credential and avoid the need for network requests.¶
These measures allow the Consumers to continue to function even if the metadata server is temporarily unavailable and avoid privacy issues as described in Section 12.1.¶
The Privacy Considerations in the SD-JWT specification [I-D.ietf-oauth-selective-disclosure-jwt] apply to this specification. Additionally, the following privacy considerations need to be taken into account when using SD-JWT VCs.¶
The Privacy Considerations in Section 12.5 of [I-D.ietf-oauth-selective-disclosure-jwt]
apply especially to the cnf
claim.¶
Issuers and Holders have to be aware that while this specification supports selective
disclosure of claims of a given SD-JWT VC, the vct
claim is not selectively disclosable.
In certain situations this could lead to unwanted leakage of additional context information.¶
In general, Issuers are advised to choose vct
values following data minimization principles.
For example, government Issuers issuing an SD-JWT VC to their citizens to enable them to prove their age,
might consider using a vct
value that does not allow third-parties to infer additional personal information
about the Holder, e.g., country of residency or citizenship.¶
Additionally, Holders have to be informed that, besides the actual requested claims, the
vct
information is shared with the Verifier.¶
A malicious Issuer can choose the Issuer identifier of the SD-JWT VC to enable tracking the usage behavior of the Holder if the Issuer identifier is Holder-specific and if the resolution of the key material to verify the Issuer-signed JWT requires the Verifier to phone home to the Issuer.¶
For example, a malicious Issuer could generate a unique value for the Issuer identifier
per Holder, e.g., https://example.com/issuer/holder-1234
and host the JWT VC Issuer Metadata.
The Verifier would create a HTTPS GET request to the Holder-specific well-known URI
when the SD-JWT VC is verified. This would allow the malicious Issuer to keep track where
and how often the SD-JWT VC was used.¶
Verifiers are advised to establish trust in an SD-JWT VC by pinning specific Issuer identifiers and should monitor suspicious behaviour such as frequently rotating Issuer identifiers. If such behaviour was detected, Verifiers are advised to reject SD-JWT VCs issued by such Issuers.¶
Holders are advised to reject SD-JWT VCs if they contain easily correlatable information in the Issuer identifier.¶
This specification defines validation and processing rules for verifiable credentials using JSON payloads and secured by SD-JWT [I-D.ietf-oauth-selective-disclosure-jwt]. Other specifications exist that define their own verifiable credential formats; for example, W3C Verifiable Credential Data Model (VCDM) 2.0 [W3C.VCDM] defines a data model for verifiable credentials encoded as JSON-LD, and ISO/IEC 18013-5:2021 [ISO.18013-5] defines a representation of verifiable credentials in the mobile document (mdoc) format encoded as CBOR and secured using COSE.¶
In Section 6.3, various methods for distributing and retrieving Type Metadata are described. For methods which rely on a network connection to a URL (e.g., provided by an Issuer), third parties (like the Issuer) may be able to track the usage of a credential by observing requests to the Type Metadata URL.¶
Consumers SHOULD prefer methods for retrieving Type Metadata that do not leak information about the usage of a credential to third parties. The recommendations in Section 10.4 apply.¶
Specification Document(s): [[ Section 3.2.2.1.1 of this of this specification ]]¶
Claim Name: "vct#integrity"¶
Claim Description: SD-JWT VC vct claim "integrity metadata" value¶
Change Controller: IETF¶
Specification Document(s): [[ Section 7 of this of this specification ]]¶
The Internet media type for a SD-JWT VC is application/vc+sd-jwt
.¶
application
¶
vc+sd-jwt
¶
Additional information:¶
This specification requests the well-known URI defined in Section 5 in the IANA "Well-Known URIs" registry [IANA.well-known] established by [RFC5785].¶
Important: The following examples are not normative and provided for illustrative purposes only. In particular, neither the structure of the claims nor the selection of selectively disclosable claims are normative.¶
Line breaks have been added for readability.¶
This example shows how the artifacts defined in this specification could be used to represent the concept of a Person Identification Data (PID) [EUDIW.ARF] using the data of a German citizen.¶
Key Binding is applied
using the Holder's public key passed in a cnf
claim in the SD-JWT.¶
The following data about the citizen comprises the input JWT Claims Set used by the Issuer:¶
{ "vct": "https://bmi.bund.example/credential/pid/1.0", "given_name": "Erika", "family_name": "Mustermann", "birthdate": "1963-08-12", "source_document_type": "id_card", "address": { "street_address": "Heidestraße 17", "locality": "Köln", "postal_code": "51147", "country": "DE" }, "nationalities": [ "DE" ], "gender": "female", "birth_family_name": "Gabler", "place_of_birth": { "locality": "Berlin", "country": "DE" }, "also_known_as": "Schwester Agnes", "age_equal_or_over": { "12": true, "14": true, "16": true, "18": true, "21": true, "65": false } }¶
The following is the issued SD-JWT:¶
eyJhbGciOiAiRVMyNTYiLCAidHlwIjogInZjK3NkLWp3dCJ9.eyJfc2QiOiBbIjBIWm1 uU0lQejMzN2tTV2U3QzM0bC0tODhnekppLWVCSjJWel9ISndBVGciLCAiOVpicGxDN1R kRVc3cWFsNkJCWmxNdHFKZG1lRU9pWGV2ZEpsb1hWSmRSUSIsICJJMDBmY0ZVb0RYQ3V jcDV5eTJ1anFQc3NEVkdhV05pVWxpTnpfYXdEMGdjIiwgIklFQllTSkdOaFhJbHJRbzU 4eWtYbTJaeDN5bGw5WmxUdFRvUG8xN1FRaVkiLCAiTGFpNklVNmQ3R1FhZ1hSN0F2R1R yblhnU2xkM3o4RUlnX2Z2M2ZPWjFXZyIsICJodkRYaHdtR2NKUXNCQ0EyT3RqdUxBY3d BTXBEc2FVMG5rb3ZjS09xV05FIiwgImlrdXVyOFE0azhxM1ZjeUE3ZEMtbU5qWkJrUmV EVFUtQ0c0bmlURTdPVFUiLCAicXZ6TkxqMnZoOW80U0VYT2ZNaVlEdXZUeWtkc1dDTmc wd1RkbHIwQUVJTSIsICJ3elcxNWJoQ2t2a3N4VnZ1SjhSRjN4aThpNjRsbjFqb183NkJ DMm9hMXVnIiwgInpPZUJYaHh2SVM0WnptUWNMbHhLdUVBT0dHQnlqT3FhMXoySW9WeF9 ZRFEiXSwgImlzcyI6ICJodHRwczovL2V4YW1wbGUuY29tL2lzc3VlciIsICJpYXQiOiA xNjgzMDAwMDAwLCAiZXhwIjogMTg4MzAwMDAwMCwgInZjdCI6ICJodHRwczovL2JtaS5 idW5kLmV4YW1wbGUvY3JlZGVudGlhbC9waWQvMS4wIiwgImFnZV9lcXVhbF9vcl9vdmV yIjogeyJfc2QiOiBbIkZjOElfMDdMT2NnUHdyREpLUXlJR085N3dWc09wbE1Makh2UkM 0UjQtV2ciLCAiWEx0TGphZFVXYzl6Tl85aE1KUm9xeTQ2VXNDS2IxSXNoWnV1cVVGS1N DQSIsICJhb0NDenNDN3A0cWhaSUFoX2lkUkNTQ2E2NDF1eWNuYzh6UGZOV3o4bngwIiw gImYxLVAwQTJkS1dhdnYxdUZuTVgyQTctRVh4dmhveHY1YUhodUVJTi1XNjQiLCAiazV oeTJyMDE4dnJzSmpvLVZqZDZnNnl0N0Fhb25Lb25uaXVKOXplbDNqbyIsICJxcDdaX0t 5MVlpcDBzWWdETzN6VnVnMk1GdVBOakh4a3NCRG5KWjRhSS1jIl19LCAiX3NkX2FsZyI 6ICJzaGEtMjU2IiwgImNuZiI6IHsiandrIjogeyJrdHkiOiAiRUMiLCAiY3J2IjogIlA tMjU2IiwgIngiOiAiVENBRVIxOVp2dTNPSEY0ajRXNHZmU1ZvSElQMUlMaWxEbHM3dkN lR2VtYyIsICJ5IjogIlp4amlXV2JaTVFHSFZXS1ZRNGhiU0lpcnNWZnVlY0NFNnQ0alQ 5RjJIWlEifX19.CO1phudqUhCbKHxuP75OY_alKo0pPhQDhOH341wWfvZCC57ogCjrM9 qzEFslr8p_28u9LGoYP2umoYy4vldOhg~WyIyR0xDNDJzS1F2ZUNmR2ZyeU5STjl3Iiw gImdpdmVuX25hbWUiLCAiRXJpa2EiXQ~WyJlbHVWNU9nM2dTTklJOEVZbnN4QV9BIiwg ImZhbWlseV9uYW1lIiwgIk11c3Rlcm1hbm4iXQ~WyI2SWo3dE0tYTVpVlBHYm9TNXRtd lZBIiwgImJpcnRoZGF0ZSIsICIxOTYzLTA4LTEyIl0~WyJlSThaV205UW5LUHBOUGVOZ W5IZGhRIiwgInNvdXJjZV9kb2N1bWVudF90eXBlIiwgImlkX2NhcmQiXQ~WyJRZ19PNj R6cUF4ZTQxMmExMDhpcm9BIiwgInN0cmVldF9hZGRyZXNzIiwgIkhlaWRlc3RyYVx1MD BkZmUgMTciXQ~WyJBSngtMDk1VlBycFR0TjRRTU9xUk9BIiwgImxvY2FsaXR5IiwgIkt cdTAwZjZsbiJd~WyJQYzMzSk0yTGNoY1VfbEhnZ3ZfdWZRIiwgInBvc3RhbF9jb2RlIi wgIjUxMTQ3Il0~WyJHMDJOU3JRZmpGWFE3SW8wOXN5YWpBIiwgImNvdW50cnkiLCAiRE UiXQ~WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgImFkZHJlc3MiLCB7Il9zZCI6IFs iWEZjN3pYUG03enpWZE15d20yRXVCZmxrYTVISHF2ZjhVcF9zek5HcXZpZyIsICJiZDF FVnpnTm9wVWs0RVczX2VRMm4zX05VNGl1WE9IdjlYYkdITjNnMVRFIiwgImZfRlFZZ3Z RV3Z5VnFObklYc0FSbE55ZTdZR3A4RTc3Z1JBamFxLXd2bnciLCAidjRra2JfcFAxamx 2VWJTanR5YzVicWNXeUEtaThYTHZoVllZN1pUMHRiMCJdfV0~WyJuUHVvUW5rUkZxM0J JZUFtN0FuWEZBIiwgIm5hdGlvbmFsaXRpZXMiLCBbIkRFIl1d~WyI1YlBzMUlxdVpOYT Boa2FGenp6Wk53IiwgImdlbmRlciIsICJmZW1hbGUiXQ~WyI1YTJXMF9OcmxFWnpmcW1 rXzdQcS13IiwgImJpcnRoX2ZhbWlseV9uYW1lIiwgIkdhYmxlciJd~WyJ5MXNWVTV3ZG ZKYWhWZGd3UGdTN1JRIiwgImxvY2FsaXR5IiwgIkJlcmxpbiJd~WyJIYlE0WDhzclZXM 1FEeG5JSmRxeU9BIiwgInBsYWNlX29mX2JpcnRoIiwgeyJfc2QiOiBbIldwaEhvSUR5b 1diQXBEQzR6YnV3UjQweGwweExoRENfY3Y0dHNTNzFyRUEiXSwgImNvdW50cnkiOiAiR EUifV0~WyJDOUdTb3VqdmlKcXVFZ1lmb2pDYjFBIiwgImFsc29fa25vd25fYXMiLCAiU 2Nod2VzdGVyIEFnbmVzIl0~WyJreDVrRjE3Vi14MEptd1V4OXZndnR3IiwgIjEyIiwgd HJ1ZV0~WyJIM28xdXN3UDc2MEZpMnllR2RWQ0VRIiwgIjE0IiwgdHJ1ZV0~WyJPQktsV FZsdkxnLUFkd3FZR2JQOFpBIiwgIjE2IiwgdHJ1ZV0~WyJNMEpiNTd0NDF1YnJrU3V5c kRUM3hBIiwgIjE4IiwgdHJ1ZV0~WyJEc210S05ncFY0ZEFIcGpyY2Fvc0F3IiwgIjIxI iwgdHJ1ZV0~WyJlSzVvNXBIZmd1cFBwbHRqMXFoQUp3IiwgIjY1IiwgZmFsc2Vd~¶
This is the payload of that SD-JWT:¶
{ "_sd": [ "0HZmnSIPz337kSWe7C34l--88gzJi-eBJ2Vz_HJwATg", "9ZbplC7TdEW7qal6BBZlMtqJdmeEOiXevdJloXVJdRQ", "I00fcFUoDXCucp5yy2ujqPssDVGaWNiUliNz_awD0gc", "IEBYSJGNhXIlrQo58ykXm2Zx3yll9ZlTtToPo17QQiY", "Lai6IU6d7GQagXR7AvGTrnXgSld3z8EIg_fv3fOZ1Wg", "hvDXhwmGcJQsBCA2OtjuLAcwAMpDsaU0nkovcKOqWNE", "ikuur8Q4k8q3VcyA7dC-mNjZBkReDTU-CG4niTE7OTU", "qvzNLj2vh9o4SEXOfMiYDuvTykdsWCNg0wTdlr0AEIM", "wzW15bhCkvksxVvuJ8RF3xi8i64ln1jo_76BC2oa1ug", "zOeBXhxvIS4ZzmQcLlxKuEAOGGByjOqa1z2IoVx_YDQ" ], "iss": "https://example.com/issuer", "iat": 1683000000, "exp": 1883000000, "vct": "https://bmi.bund.example/credential/pid/1.0", "age_equal_or_over": { "_sd": [ "Fc8I_07LOcgPwrDJKQyIGO97wVsOplMLjHvRC4R4-Wg", "XLtLjadUWc9zN_9hMJRoqy46UsCKb1IshZuuqUFKSCA", "aoCCzsC7p4qhZIAh_idRCSCa641uycnc8zPfNWz8nx0", "f1-P0A2dKWavv1uFnMX2A7-EXxvhoxv5aHhuEIN-W64", "k5hy2r018vrsJjo-Vjd6g6yt7AaonKonniuJ9zel3jo", "qp7Z_Ky1Yip0sYgDO3zVug2MFuPNjHxksBDnJZ4aI-c" ] }, "_sd_alg": "sha-256", "cnf": { "jwk": { "kty": "EC", "crv": "P-256", "x": "TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc", "y": "ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ" } } }¶
The digests in the SD-JWT payload reference the following Disclosures:¶
Claim given_name
:¶
0HZmnSIPz337kSWe7C34l--88gzJi-eBJ2Vz_HJwATg
¶
WyIyR0xDNDJzS1F2ZUNmR2ZyeU5STjl3IiwgImdpdmVuX25hbWUiLCAiRXJp
a2EiXQ
¶
["2GLC42sKQveCfGfryNRN9w", "given_name", "Erika"]
¶
Claim family_name
:¶
I00fcFUoDXCucp5yy2ujqPssDVGaWNiUliNz_awD0gc
¶
WyJlbHVWNU9nM2dTTklJOEVZbnN4QV9BIiwgImZhbWlseV9uYW1lIiwgIk11
c3Rlcm1hbm4iXQ
¶
["eluV5Og3gSNII8EYnsxA_A", "family_name", "Mustermann"]
¶
Claim birthdate
:¶
Lai6IU6d7GQagXR7AvGTrnXgSld3z8EIg_fv3fOZ1Wg
¶
WyI2SWo3dE0tYTVpVlBHYm9TNXRtdlZBIiwgImJpcnRoZGF0ZSIsICIxOTYz
LTA4LTEyIl0
¶
["6Ij7tM-a5iVPGboS5tmvVA", "birthdate", "1963-08-12"]
¶
Claim source_document_type
:¶
qvzNLj2vh9o4SEXOfMiYDuvTykdsWCNg0wTdlr0AEIM
¶
WyJlSThaV205UW5LUHBOUGVOZW5IZGhRIiwgInNvdXJjZV9kb2N1bWVudF90
eXBlIiwgImlkX2NhcmQiXQ
¶
["eI8ZWm9QnKPpNPeNenHdhQ", "source_document_type",
"id_card"]
¶
Claim street_address
:¶
bd1EVzgNopUk4EW3_eQ2n3_NU4iuXOHv9XbGHN3g1TE
¶
WyJRZ19PNjR6cUF4ZTQxMmExMDhpcm9BIiwgInN0cmVldF9hZGRyZXNzIiwg
IkhlaWRlc3RyYVx1MDBkZmUgMTciXQ
¶
["Qg_O64zqAxe412a108iroA", "street_address",
"Heidestra\u00dfe 17"]
¶
Claim locality
:¶
f_FQYgvQWvyVqNnIXsARlNye7YGp8E77gRAjaq-wvnw
¶
WyJBSngtMDk1VlBycFR0TjRRTU9xUk9BIiwgImxvY2FsaXR5IiwgIktcdTAw
ZjZsbiJd
¶
["AJx-095VPrpTtN4QMOqROA", "locality", "K\u00f6ln"]
¶
Claim postal_code
:¶
XFc7zXPm7zzVdMywm2EuBflka5HHqvf8Up_szNGqvig
¶
WyJQYzMzSk0yTGNoY1VfbEhnZ3ZfdWZRIiwgInBvc3RhbF9jb2RlIiwgIjUx
MTQ3Il0
¶
["Pc33JM2LchcU_lHggv_ufQ", "postal_code", "51147"]
¶
Claim country
:¶
v4kkb_pP1jlvUbSjtyc5bqcWyA-i8XLvhVYY7ZT0tb0
¶
WyJHMDJOU3JRZmpGWFE3SW8wOXN5YWpBIiwgImNvdW50cnkiLCAiREUiXQ
¶
["G02NSrQfjFXQ7Io09syajA", "country", "DE"]
¶
Claim address
:¶
zOeBXhxvIS4ZzmQcLlxKuEAOGGByjOqa1z2IoVx_YDQ
¶
WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgImFkZHJlc3MiLCB7Il9zZCI6
IFsiWEZjN3pYUG03enpWZE15d20yRXVCZmxrYTVISHF2ZjhVcF9zek5HcXZp
ZyIsICJiZDFFVnpnTm9wVWs0RVczX2VRMm4zX05VNGl1WE9IdjlYYkdITjNn
MVRFIiwgImZfRlFZZ3ZRV3Z5VnFObklYc0FSbE55ZTdZR3A4RTc3Z1JBamFx
LXd2bnciLCAidjRra2JfcFAxamx2VWJTanR5YzVicWNXeUEtaThYTHZoVllZ
N1pUMHRiMCJdfV0
¶
["lklxF5jMYlGTPUovMNIvCA", "address", {"_sd":
["XFc7zXPm7zzVdMywm2EuBflka5HHqvf8Up_szNGqvig",
"bd1EVzgNopUk4EW3_eQ2n3_NU4iuXOHv9XbGHN3g1TE",
"f_FQYgvQWvyVqNnIXsARlNye7YGp8E77gRAjaq-wvnw",
"v4kkb_pP1jlvUbSjtyc5bqcWyA-i8XLvhVYY7ZT0tb0"]}]
¶
Claim nationalities
:¶
hvDXhwmGcJQsBCA2OtjuLAcwAMpDsaU0nkovcKOqWNE
¶
WyJuUHVvUW5rUkZxM0JJZUFtN0FuWEZBIiwgIm5hdGlvbmFsaXRpZXMiLCBb
IkRFIl1d
¶
["nPuoQnkRFq3BIeAm7AnXFA", "nationalities", ["DE"]]
¶
Claim gender
:¶
IEBYSJGNhXIlrQo58ykXm2Zx3yll9ZlTtToPo17QQiY
¶
WyI1YlBzMUlxdVpOYTBoa2FGenp6Wk53IiwgImdlbmRlciIsICJmZW1hbGUi
XQ
¶
["5bPs1IquZNa0hkaFzzzZNw", "gender", "female"]
¶
Claim birth_family_name
:¶
ikuur8Q4k8q3VcyA7dC-mNjZBkReDTU-CG4niTE7OTU
¶
WyI1YTJXMF9OcmxFWnpmcW1rXzdQcS13IiwgImJpcnRoX2ZhbWlseV9uYW1l
IiwgIkdhYmxlciJd
¶
["5a2W0_NrlEZzfqmk_7Pq-w", "birth_family_name", "Gabler"]
¶
Claim locality
:¶
WphHoIDyoWbApDC4zbuwR40xl0xLhDC_cv4tsS71rEA
¶
WyJ5MXNWVTV3ZGZKYWhWZGd3UGdTN1JRIiwgImxvY2FsaXR5IiwgIkJlcmxp
biJd
¶
["y1sVU5wdfJahVdgwPgS7RQ", "locality", "Berlin"]
¶
Claim place_of_birth
:¶
wzW15bhCkvksxVvuJ8RF3xi8i64ln1jo_76BC2oa1ug
¶
WyJIYlE0WDhzclZXM1FEeG5JSmRxeU9BIiwgInBsYWNlX29mX2JpcnRoIiwg
eyJfc2QiOiBbIldwaEhvSUR5b1diQXBEQzR6YnV3UjQweGwweExoRENfY3Y0
dHNTNzFyRUEiXSwgImNvdW50cnkiOiAiREUifV0
¶
["HbQ4X8srVW3QDxnIJdqyOA", "place_of_birth", {"_sd":
["WphHoIDyoWbApDC4zbuwR40xl0xLhDC_cv4tsS71rEA"], "country":
"DE"}]
¶
Claim also_known_as
:¶
9ZbplC7TdEW7qal6BBZlMtqJdmeEOiXevdJloXVJdRQ
¶
WyJDOUdTb3VqdmlKcXVFZ1lmb2pDYjFBIiwgImFsc29fa25vd25fYXMiLCAi
U2Nod2VzdGVyIEFnbmVzIl0
¶
["C9GSoujviJquEgYfojCb1A", "also_known_as", "Schwester
Agnes"]
¶
Claim 12
:¶
Fc8I_07LOcgPwrDJKQyIGO97wVsOplMLjHvRC4R4-Wg
¶
WyJreDVrRjE3Vi14MEptd1V4OXZndnR3IiwgIjEyIiwgdHJ1ZV0
¶
["kx5kF17V-x0JmwUx9vgvtw", "12", true]
¶
Claim 14
:¶
f1-P0A2dKWavv1uFnMX2A7-EXxvhoxv5aHhuEIN-W64
¶
WyJIM28xdXN3UDc2MEZpMnllR2RWQ0VRIiwgIjE0IiwgdHJ1ZV0
¶
["H3o1uswP760Fi2yeGdVCEQ", "14", true]
¶
Claim 16
:¶
k5hy2r018vrsJjo-Vjd6g6yt7AaonKonniuJ9zel3jo
¶
WyJPQktsVFZsdkxnLUFkd3FZR2JQOFpBIiwgIjE2IiwgdHJ1ZV0
¶
["OBKlTVlvLg-AdwqYGbP8ZA", "16", true]
¶
Claim 18
:¶
qp7Z_Ky1Yip0sYgDO3zVug2MFuPNjHxksBDnJZ4aI-c
¶
WyJNMEpiNTd0NDF1YnJrU3V5ckRUM3hBIiwgIjE4IiwgdHJ1ZV0
¶
["M0Jb57t41ubrkSuyrDT3xA", "18", true]
¶
Claim 21
:¶
aoCCzsC7p4qhZIAh_idRCSCa641uycnc8zPfNWz8nx0
¶
WyJEc210S05ncFY0ZEFIcGpyY2Fvc0F3IiwgIjIxIiwgdHJ1ZV0
¶
["DsmtKNgpV4dAHpjrcaosAw", "21", true]
¶
Claim 65
:¶
XLtLjadUWc9zN_9hMJRoqy46UsCKb1IshZuuqUFKSCA
¶
WyJlSzVvNXBIZmd1cFBwbHRqMXFoQUp3IiwgIjY1IiwgZmFsc2Vd
¶
["eK5o5pHfgupPpltj1qhAJw", "65", false]
¶
This shows a presentation of the SD-JWT with a Key Binding JWT that discloses only nationality and the fact that the person is over 18 years old:¶
eyJhbGciOiAiRVMyNTYiLCAidHlwIjogInZjK3NkLWp3dCJ9.eyJfc2QiOiBbIjBIWm1 uU0lQejMzN2tTV2U3QzM0bC0tODhnekppLWVCSjJWel9ISndBVGciLCAiOVpicGxDN1R kRVc3cWFsNkJCWmxNdHFKZG1lRU9pWGV2ZEpsb1hWSmRSUSIsICJJMDBmY0ZVb0RYQ3V jcDV5eTJ1anFQc3NEVkdhV05pVWxpTnpfYXdEMGdjIiwgIklFQllTSkdOaFhJbHJRbzU 4eWtYbTJaeDN5bGw5WmxUdFRvUG8xN1FRaVkiLCAiTGFpNklVNmQ3R1FhZ1hSN0F2R1R yblhnU2xkM3o4RUlnX2Z2M2ZPWjFXZyIsICJodkRYaHdtR2NKUXNCQ0EyT3RqdUxBY3d BTXBEc2FVMG5rb3ZjS09xV05FIiwgImlrdXVyOFE0azhxM1ZjeUE3ZEMtbU5qWkJrUmV EVFUtQ0c0bmlURTdPVFUiLCAicXZ6TkxqMnZoOW80U0VYT2ZNaVlEdXZUeWtkc1dDTmc wd1RkbHIwQUVJTSIsICJ3elcxNWJoQ2t2a3N4VnZ1SjhSRjN4aThpNjRsbjFqb183NkJ DMm9hMXVnIiwgInpPZUJYaHh2SVM0WnptUWNMbHhLdUVBT0dHQnlqT3FhMXoySW9WeF9 ZRFEiXSwgImlzcyI6ICJodHRwczovL2V4YW1wbGUuY29tL2lzc3VlciIsICJpYXQiOiA xNjgzMDAwMDAwLCAiZXhwIjogMTg4MzAwMDAwMCwgInZjdCI6ICJodHRwczovL2JtaS5 idW5kLmV4YW1wbGUvY3JlZGVudGlhbC9waWQvMS4wIiwgImFnZV9lcXVhbF9vcl9vdmV yIjogeyJfc2QiOiBbIkZjOElfMDdMT2NnUHdyREpLUXlJR085N3dWc09wbE1Makh2UkM 0UjQtV2ciLCAiWEx0TGphZFVXYzl6Tl85aE1KUm9xeTQ2VXNDS2IxSXNoWnV1cVVGS1N DQSIsICJhb0NDenNDN3A0cWhaSUFoX2lkUkNTQ2E2NDF1eWNuYzh6UGZOV3o4bngwIiw gImYxLVAwQTJkS1dhdnYxdUZuTVgyQTctRVh4dmhveHY1YUhodUVJTi1XNjQiLCAiazV oeTJyMDE4dnJzSmpvLVZqZDZnNnl0N0Fhb25Lb25uaXVKOXplbDNqbyIsICJxcDdaX0t 5MVlpcDBzWWdETzN6VnVnMk1GdVBOakh4a3NCRG5KWjRhSS1jIl19LCAiX3NkX2FsZyI 6ICJzaGEtMjU2IiwgImNuZiI6IHsiandrIjogeyJrdHkiOiAiRUMiLCAiY3J2IjogIlA tMjU2IiwgIngiOiAiVENBRVIxOVp2dTNPSEY0ajRXNHZmU1ZvSElQMUlMaWxEbHM3dkN lR2VtYyIsICJ5IjogIlp4amlXV2JaTVFHSFZXS1ZRNGhiU0lpcnNWZnVlY0NFNnQ0alQ 5RjJIWlEifX19.CO1phudqUhCbKHxuP75OY_alKo0pPhQDhOH341wWfvZCC57ogCjrM9 qzEFslr8p_28u9LGoYP2umoYy4vldOhg~WyJuUHVvUW5rUkZxM0JJZUFtN0FuWEZBIiw gIm5hdGlvbmFsaXRpZXMiLCBbIkRFIl1d~WyJNMEpiNTd0NDF1YnJrU3V5ckRUM3hBIi wgIjE4IiwgdHJ1ZV0~eyJhbGciOiAiRVMyNTYiLCAidHlwIjogImtiK2p3dCJ9.eyJub 25jZSI6ICIxMjM0NTY3ODkwIiwgImF1ZCI6ICJodHRwczovL2V4YW1wbGUuY29tL3Zlc mlmaWVyIiwgImlhdCI6IDE3MjY2ODU5MTcsICJzZF9oYXNoIjogIk5OZlFBeTBJWTg0Z GtSZUloaTlEdGRFQkNnTUpiQXk4TVM0a2RjSXdZa3cifQ.ePQyvGaJ_bN3wBn_AJmnMt eKHrNNkkTxHvJ2tyS24MVfeMvrtuEdr7PdeF7L0EH-u7Qf3XYTGV-UlKgI9DEvhg¶
The following is the payload of a corresponding Key Binding JWT:¶
{ "nonce": "1234567890", "aud": "https://example.com/verifier", "iat": 1726685917, "sd_hash": "NNfQAy0IY84dkReIhi9DtdEBCgMJbAy8MS4kdcIwYkw" }¶
After validation, the Verifier will have the following processed SD-JWT payload available for further handling:¶
{ "iss": "https://example.com/issuer", "iat": 1683000000, "exp": 1883000000, "vct": "https://bmi.bund.example/credential/pid/1.0", "age_equal_or_over": { "18": true }, "cnf": { "jwk": { "kty": "EC", "crv": "P-256", "x": "TCAER19Zvu3OHF4j4W4vfSVoHIP1ILilDls7vCeGemc", "y": "ZxjiWWbZMQGHVWKVQ4hbSIirsVfuecCE6t4jT9F2HZQ" } }, "nationalities": [ "DE" ] }¶
{ "vct": "https://betelgeuse.example.com/education_credential", "name": "Betelgeuse Education Credential - Preliminary Version", "description": "This is our development version of the education credential. Don't panic.", "extends": "https://galaxy.example.com/galactic-education-credential-0.9", "extends#integrity": "sha256-9cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1VLmXfh-WRL5", "display": [ { "lang": "en-US", "name": "Betelgeuse Education Credential", "description": "An education credential for all carbon-based life forms on Betelgeusians", "rendering": { "simple": { "logo": { "uri": "https://betelgeuse.example.com/public/education-logo.png", "uri#integrity": "sha256-LmXfh-9cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1V", "alt_text": "Betelgeuse Ministry of Education logo" }, "background_color": "#12107c", "text_color": "#FFFFFF" }, "svg_templates": [ { "uri": "https://betelgeuse.example.com/public/credential-english.svg", "uri#integrity": "sha256-8cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1VLmXfh-9c", "properties": { "orientation": "landscape", "color_scheme": "light", "contrast": "high" } } ] } }, { "lang": "de-DE", "name": "Betelgeuse-Bildungsnachweis", "rendering": { "simple": { "logo": { "uri": "https://betelgeuse.example.com/public/education-logo-de.png", "uri#integrity": "sha256-LmXfh-9cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1V", "alt_text": "Logo des Betelgeusischen Bildungsministeriums" }, "background_color": "#12107c", "text_color": "#FFFFFF" }, "svg_templates": [ { "uri": "https://betelgeuse.example.com/public/credential-german.svg", "uri#integrity": "sha256-8cLlJNXN-TsMk-PmKjZ5t0WRL5ca_xGgX3c1VLmXfh-9c", "properties": { "orientation": "landscape", "color_scheme": "light", "contrast": "high" } } ] } } ], "claims": [ { "path": ["name"], "display": [ { "lang": "de-DE", "label": "Vor- und Nachname", "description": "Der Name des Studenten" }, { "lang": "en-US", "label": "Name", "description": "The name of the student" } ], "sd": "allowed" }, { "path": ["address"], "display": [ { "lang": "de-DE", "label": "Adresse", "description": "Adresse zum Zeitpunkt des Abschlusses" }, { "lang": "en-US", "label": "Address", "description": "Address at the time of graduation" } ], "sd": "always" }, { "path": ["address", "street_address"], "display": [ { "lang": "de-DE", "label": "Straße" }, { "lang": "en-US", "label": "Street Address" } ], "sd": "always", "svg_id": "address_street_address" }, { "path": ["degrees", null], "display": [ { "lang": "de-DE", "label": "Abschluss", "description": "Der Abschluss des Studenten" }, { "lang": "en-US", "label": "Degree", "description": "Degree earned by the student" } ], "sd": "allowed" } ], "schema_url": "https://exampleuniversity.com/public/credential-schema-0.9", "schema_url#integrity": "sha256-o984vn819a48ui1llkwPmKjZ5t0WRL5ca_xGgX3c1VLmXfh" }¶
We would like to thank Alen Horvat, Andres Uribe, Christian Bormann, Giuseppe De Marco, Lukas J Han, Michael Jones, Mike Prorock, Orie Steele, Paul Bastian, Torsten Lodderstedt, Tobias Looker, and Kristina Yasuda for their contributions (some of which substantial) to this draft and to the initial set of implementations.¶
-05¶
-04¶
-03¶
-02¶
cnf
claim¶
-01¶
type
to vct
¶
-00¶
[[ pre Working Group Adoption: ]]¶
-00¶