Package-level declarations

Types

Link copied to clipboard
data object MediaTypes
Link copied to clipboard
@Serializable(with = StatusListSerializer::class)
data class StatusList(val compressed: ByteArray, val statusBitSize: TokenStatusBitSize, val aggregationUri: String?)

specification: https://www.ietf.org/archive/id/draft-ietf-oauth-status-list-06.html#name-status-list Status list in its compressed form.

Link copied to clipboard
@Serializable
data class StatusListAggregation(val statusLists: List<UniformResourceIdentifier>)

Status List Aggregation is an optional mechanism to retrieve a list of URIs to all Status List Tokens, allowing a Relying Party to fetch all relevant Status Lists for a specific type of Referenced Token or Issuer. This mechanism is intended to support fetching and caching mechanisms and allow offline validation of the status of a reference token for a period of time. If a Relying Party encounters an invalid Status List referenced in the response from the Status List Aggregation endpoint, it SHOULD continue processing the other valid Status Lists referenced in the response.There are two options for a Relying Party to retrieve the Status List Aggregation. An Issuer MAY support any of these mechanisms:

Link copied to clipboard
@Serializable
data class StatusListInfo(val index: ULong, val uri: UniformResourceIdentifier)

Specifies an url to retrieve a status list token, and an index specifying the position in the status list within that status list token that holds the token status of the the referenced token.

Link copied to clipboard
object StatusListSerializer : KSerializer<StatusList>
Link copied to clipboard
data class StatusListTokenPayload(val subject: UniformResourceIdentifier, val issuedAt: Instant, val expirationTime: Instant? = null, val timeToLive: PositiveDuration? = null, val statusList: StatusList)

The following content applies to the JWT Claims Set:

Link copied to clipboard
Link copied to clipboard
data class StatusListView(val uncompressed: ByteArray, val statusBitSize: TokenStatusBitSize)

Utility class to access token statuses by index from an uncompressed byte array. In theory this should improve storage size compared to a list of token statuses since ByteArray is stored more efficiently.