Skip to content

Commit

Permalink
Add example
Browse files Browse the repository at this point in the history
  • Loading branch information
danielfett committed Aug 15, 2024
1 parent 0a26a60 commit 9e3c3e5
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 14 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,8 @@ report.xml
!requirements.txt

# Ignore output of examples except for specification.yml
examples/*/*
!examples/*/specification.yml
examples/*/kb_jwt_*
examples/*/sd_jwt_*
examples/*/user_claims.json
examples/*/verified_contents.json
examples/*/disclosures.md
37 changes: 25 additions & 12 deletions draft-ietf-oauth-sd-jwt-vc.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,8 @@ retrieved from the URL
}
```

This example is shortened for presentation, a full Type Metadata example can be found in (#ExampleTypeMetadata).

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`.
Expand All @@ -551,6 +553,8 @@ defined:
* `claims`: An object containing claim information for the type, as described in
(#claim-metadata). This property is OPTIONAL.

An example of a Type Metadata document is shown in (#ExampleTypeMetadata).

## Extending Type Metadata {#extending-type-metadata}

A type can extend another type. The extended type is identified by the URI in
Expand Down Expand Up @@ -639,12 +643,14 @@ integrity of the retrieved document as defined in Section 3.3.5 of [@!W3C.SRI].

# Display Metadata {#display-metadata}

The `display` property is an object containing display information for the type.
The object MUST contain a property for each language that is supported by the
type. The property name MUST be a language tag as defined in Section 2 of
[@!RFC5646]. The property value MUST be an object containing the following
properties:
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 MUST 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 OPTIONAL.
- `description`: A human-readable description for the type, intended for end
Expand Down Expand Up @@ -803,14 +809,14 @@ able to identify the claim which is being addressed.

## Claim Display Metadata {#claim-display-metadata}

The `display` property is an object containing display information for the
claim. The object MUST contain a property for each language that is supported by
the type. The property name MUST be a language tag as defined in Section 2 of
[@!RFC5646]. The consuming application MUST use the language tag it considers most
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 property value MUST be an object containing the following properties:
The objects in the array MUST have the following properties:

- `lang`: A language tag as defined in Section 2 of [@!RFC5646]. This property is REQUIRED.
- `label`: A human-readable label for the claim, intended for end users. This
property is OPTIONAL.
- `description`: A human-readable description for the claim, intended for end
Expand Down Expand Up @@ -1202,6 +1208,10 @@ After the validation, the Verifier will have the following data for further proc

<{{examples/03-pid/verified_contents.json}}

## Example 2: Type Metadata {#ExampleTypeMetadata}

<{{examples/typemetadata/example.json}}

# Acknowledgements {#Acknowledgements}

We would like to thank
Expand All @@ -1221,11 +1231,14 @@ for their contributions (some of which substantial) to this draft and to the ini

# Document History

-04
-05

* update reference to IETF Status List
* Include Type Metadata
* Include display and claim type metadata

-04

* update reference to IETF Status List
* Editorial changes
* Updated terminology to clarify digital signatures are one way to secure VCs and presentations

Expand Down

0 comments on commit 9e3c3e5

Please sign in to comment.