Skip to content

Commit

Permalink
Merge branch 'main' into pb/minor1
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbastian authored Aug 28, 2024
2 parents 204dd9e + 5da26d6 commit 6bbcebe
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions draft-ietf-oauth-status-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ Status List Token:
Referenced Token:
: A cryptographically secured data structure which contains a reference to a Status List or Status List Token. It is RECOMMENDED to use JSON {{RFC8259}} or CBOR {{RFC8949}} for representation of the token and secure it using JSON Object Signing as defined in {{RFC7515}} or CBOR Object Signing and Encryption as defined in {{RFC9052}}. The information from the contained Status List may give a Relying Party additional information about up-to-date status of the Referenced Token.

base64url:
: Denotes the URL-safe base64 encoding without padding as defined in Section 2 of {{RFC7515}} as "Base64url Encoding".

# Status List {#status-list}

A Status List is a byte array that contains the statuses of many Referenced Tokens represented by one or multiple bits. A common representation of a Status List is composed by the following algorithm:
Expand Down Expand Up @@ -204,7 +207,7 @@ This section defines the structure for a JSON-encoded Status List:

* `status_list`: REQUIRED. JSON Object that contains a Status List. It MUST contain at least the following claims:
* `bits`: REQUIRED. JSON Integer specifying the number of bits per Referenced Token in the Status List (`lst`). The allowed values for `bits` are 1,2,4 and 8.
* `lst`: REQUIRED. JSON String that contains the status values for all the Referenced Tokens it conveys statuses for. The value MUST be the base64url-encoded (as defined in Section 2 of {{RFC7515}}) Status List as specified in [](#status-list).
* `lst`: REQUIRED. JSON String that contains the status values for all the Referenced Tokens it conveys statuses for. The value MUST be the base64url-encoded Status List as specified in [](#status-list).
* `aggregation_uri`: OPTIONAL. JSON String that contains a URI to retrieve the Status List Aggregation for this type of Referenced Token. See section [](#batch-fetching) for further detail.

The following example illustrates the JSON representation of the Status List:
Expand Down Expand Up @@ -288,7 +291,7 @@ The following content applies to the CWT Claims Set:
* `6` (issued at): REQUIRED. Same definition as `iat` claim in [](#status-list-token-jwt).
* `4` (expiration time): OPTIONAL. Same definition as `exp` claim in [](#status-list-token-jwt).
* `65534` (time to live): OPTIONAL. Same definition as `ttl` claim in [](#status-list-token-jwt).
* `65535` (status list): REQUIRED. The status list claim MUST specify the Status List conforming to the rules outlined in [](#status-list-cbor).
* `65533` (status list): REQUIRED. The status list claim MUST specify the Status List conforming to the rules outlined in [](#status-list-cbor).

The following additional rules apply:

Expand Down Expand Up @@ -552,7 +555,7 @@ index 3 2 1 0 7 6 5 4 11 10 9 8

~~~

Resulting in the byte array and compressed/base64url encoded status list:
Resulting in the byte array and compressed/base64url-encoded status list:

~~~~~~~~~~
{::include ./examples/status_list_encoding2_json}
Expand Down Expand Up @@ -702,6 +705,7 @@ IANA "CBOR Web Token (CWT) Claims" registry {{IANA.CWT}} established by {{RFC839
<br/>

* Claim Name: `status_list`
* Claim Key: TBD (requested assignment 65533)
* Claim Description: A status list containing up-to-date status information on multiple other CWTs encoded as a bitarray.
* Change Controller: IETF
* Specification Document(s): [](#status-list-token-cwt) of this specification
Expand Down Expand Up @@ -865,6 +869,8 @@ for their valuable contributions, discussions and feedback to this specification
-04

* fix reference of Status List in CBOR format
* added status_list CWT claim key assigned
* move base64url definition to terminology

-03

Expand Down

0 comments on commit 6bbcebe

Please sign in to comment.