Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change receipts 394 to a TBD with IANA Considerations #332

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions draft-ietf-scitt-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ Client applications MAY request Receipts regardless of the identity of the Issue
When a Signed Statement is registered by a Transparency Service a Receipt becomes available.
When a Receipt is included in a Signed Statement a Transparent Statement is produced.

Receipts are based on Signed Inclusion Proofs as described in COSE Receipts {{-COMETRE}} that also provides the COSE header parameter semantics for label 394.
Receipts are based on Signed Inclusion Proofs as described in COSE Receipts {{-COMETRE}} that also provides the COSE header parameter semantics for label TBD_0.

The Registration time is recorded as the timestamp when the Transparency Service added this Signed Statement to its Append-only Log.

Expand All @@ -761,14 +761,14 @@ See {{fig-signed-statement-cddl}} for the CDDL rule that defines 'COSE_Sign1' as
{: #fig-transparent-statement-cddl title="CDDL definition for a Transparent Statement"}

{{fig-transparent-statement-edn}} illustrates a Transparent Statement with a detached payload, and two Receipts in its unprotected header.
The type of label 394 `receipts` in the unprotected header is a CBOR array that can contain one or more Receipts (each entry encoded as a .cbor encoded Receipts).
The type of label TBD_0 `receipts` in the unprotected header is a CBOR array that can contain one or more Receipts (each entry encoded as a .cbor encoded Receipts).

~~~ cbor-diag
18( / COSE Sign 1 /
[
h'a4012603...6d706c65', / Protected /
{ / Unprotected /
394: [ / Receipts (2) /
TBD_0: [ / Receipts (2) /
h'd284586c...4191f9d2' / Receipt 1 /
h'c624586c...8f4af97e' / Receipt 2 /
]
Expand Down Expand Up @@ -1009,6 +1009,16 @@ It is up to the Issuer to notify Transparency Services of credential revocation

# IANA Considerations

## COSE Receipts Header Parameter

{{-COMETRE}} is requesting IANA to add the following entries to the [COSE Header Algorithm Parameters Registry](https://www.iana.org/assignments/cose/cose.xhtml).

- Name: receipts
- Label: TBD_0 (requested assignment 394)
- Value type: array (of bstr)
- Value registry: https://www.iana.org/assignments/cose/cose.xhtml#header-parameters
- Description: Priority ordered list of CBOR encoded Receipts.

Comment on lines +1012 to +1021
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the authors of that spec are requesting it for that draft, why are we doubling that request here? Do we not need to specify we want to replace the values later once that is formalized with an explanation between this section and the previous header?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a little repetitive. We must change 394, as it creates confusion for implementors. This section was copy/pasted over for completeness. Either way, when TBD_0 is assigned, this will get cleaned up, so I felt it was helpful to provide a pointer.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aj-stein, do still feel strongly? I'd like to merge to get to #341

## Media Type Registration

Pending WG discussion.
Expand Down
2 changes: 1 addition & 1 deletion signed_statement.cddl
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ CWT_Claims = {

Unprotected_Header = {
? &(x5chain: 33) => COSE_X509
? &(receipts: 394) => [+ Receipt]
? &(receipts: TBD_0) => [+ Receipt]
* int => any
}
2 changes: 1 addition & 1 deletion transparent_statement.cddl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Transparent_Statement = #6.18(COSE_Sign1)

Unprotected_Header = {
&(receipts: 394) => [+ Receipt]
&(receipts: TBD_0) => [+ Receipt]
}
Loading