Module status_list 

Available on crate feature status-list only.

The IETF Token Status List (draft-ietf-oauth-status-list-21): the status claim of a referenced token, the status list and the status list token.

Section numbers below are those of draft 21. The module implements its JSON and JWT formats. It does not implement the CBOR and CWT formats (§4.3, §5.2, §6.3), historical resolution (§8.4), following an aggregation_uri (§9, though StatusList carries one), caching by ttl (§13.7, though StatusListToken carries it) or the X.509 extended key usage (§10).

The draft defines the status claim for any JWT (§6.1), so the module serves every credential format of the crate: SD-JWT VCs and VCDM 2.0 credentials secured with SD-JWT (sd_jwt_vc, feature sd-jwt) as much as JWT credentials of either profile (vc). The validators of both hand the claim to a StatusCheck as CredentialStatus::StatusClaim.

• Status is the claim, StatusListRef its status_list mechanism and StatusMechanism one mechanism of it.
• StatusList is the list (§4): one StatusType of 1, 2, 4 or 8 bits per referenced token, ZLIB-compressed in its lst member.
• StatusListToken is the signed list (§5.1), issued with sign and read with status_of.
• StatusListCheck (feature did-web as well) is the StatusCheck that fetches the token a reference names over an HttpClient and verifies it (§8).

Structs

Status

The status claim of a referenced token: at least one status mechanism, status_list being the one this crate implements.

StatusList

A status list (Token Status List §4): one status of bits bits per referenced token, packed into a byte array from the least significant bit up, ZLIB-compressed and base64url-encoded as lst in JSON.

StatusListCheckdid-web

A StatusCheck for the Token Status List: for the status claim of an SD-JWT credential or of a JWT credential (CredentialStatus::StatusClaim), fetches the status list token from the referenced URI with an HttpClient, verifies it was signed by the key its header names (KeyReference::from_jws with the token’s iss), resolved for KeyRole::Issuer, and reads the status at the referenced index (Token Status List §8).

StatusListRef

A reference to a status list token (status.status_list): the token’s URI and the index of the referenced token in its list.

StatusListToken

The claims of a status list token in JWT format (Token Status List §5.1).

StatusType

A status type value (Token Status List §7): a number in 0..=255, with the registered meanings as constants.

Enums

StatusListError

Why a status list or status list token could not be used.

StatusMechanism

One mechanism of a Status claim.