multipaz/org.multipaz.revocation

Package-level declarations

Types

CachingRevocationChecker

class CachingRevocationChecker(storage: Storage, httpClient: HttpClient = HttpClient(), httpTimeout: Duration = 10.seconds, cachingDuration: Duration = 60.days, useETag: Boolean = true, useLastModified: Boolean = true) : RevocationChecker

Storage-backed implementation of RevocationChecker that caches downloaded data (status and identifier lists) in a StorageTable.

CompressedStatusList

class CompressedStatusList(val bitsPerItem: Int, compressedStatusList: ByteString, val creationTime: Instant = Clock.System.now(), val expirationTime: Instant = creationTime + 20.minutes) : RevocationData

Status list as defined in OAuth Status List in the compressed form.

class IdentifierList(identifiers: Set<ByteString>, val creationTime: Instant = Clock.System.now(), val expirationTime: Instant = creationTime + 20.minutes) : RevocationData

Revocation list as defined in ISO/IEC 18013-5 Section 12.3.6.4 "Identifier list details"

RevocationChecker

interface RevocationChecker

Interface for checking and managing the revocation status of digital credentials.

RevocationCheckResult

data class RevocationCheckResult(val state: RevocationCheckState, val isTrusted: Boolean, val error: Throwable? = null)

Result of checking a document's revocation status.

RevocationCheckState

enum RevocationCheckState : Enum<RevocationCheckState>

Represents the state of a document revocation check.

sealed class RevocationData

Abstract class that represents some kind of revocation data

data class RevocationInfo(val revocationStatus: RevocationStatus, val certificate: X509Cert?)

Information needed to perform a revocation check for a credential or a credential presentation.

RevocationStatus

sealed class RevocationStatus

Data that describes how validity/revocation status of a credential can be obtained.

class StatusList(val bitsPerItem: Int, statusList: ByteArray)

Status list as defined in OAuth Status List in the uncompressed form.

Properties

val CompressedStatusList.Companion.cborSchemaId: ByteString

val IdentifierList.Companion.cborSchemaId: ByteString

val RevocationData.Companion.cborSchemaId: ByteString

CompressedStatusList_cborSchemaId

val CompressedStatusList_cborSchemaId: ByteString

IdentifierList_cborSchemaId

val IdentifierList_cborSchemaId: ByteString

RevocationData_cborSchemaId

val RevocationData_cborSchemaId: ByteString

Functions

suspend fun RevocationChecker.check(credential: Credential, trustManager: TrustManagerInterface, onlyTrusted: Boolean = true, atTime: Instant = Clock.System.now(), bypassCache: Boolean = false, preferJwt: Boolean = false): RevocationCheckResult

Convenience extension to check the revocation state for a given Credential.

fun CompressedStatusList.Companion.fromCbor(data: ByteArray): CompressedStatusList

fun IdentifierList.Companion.fromCbor(data: ByteArray): IdentifierList

fun RevocationData.Companion.fromCbor(data: ByteArray): RevocationData

fun CompressedStatusList.Companion.fromDataItem(dataItem: DataItem): CompressedStatusList

fun IdentifierList.Companion.fromDataItem(dataItem: DataItem): IdentifierList

fun RevocationData.Companion.fromDataItem(dataItem: DataItem): RevocationData

getRevocationInfo

suspend fun Credential.getRevocationInfo(trustManager: TrustManagerInterface): RevocationInfo?

Convenience method to extract RevocationInfo from a Credential.

fun CompressedStatusList.toCbor(): ByteArray

fun IdentifierList.toCbor(): ByteArray

fun RevocationData.toCbor(): ByteArray

fun CompressedStatusList.toDataItem(): DataItem

fun IdentifierList.toDataItem(): DataItem

fun RevocationData.toDataItem(): DataItem