MdocCredential

interface MdocCredential

An ISO/IEC 18013-5 mdoc credential (either key-bound via KeyBoundMdocCredential or non-key-bound via KeylessMdocCredential).

An object that implements this interface must also be a Credential.

The issuerProvidedData for an MdocCredential must be the bytes of IssuerSigned according to ISO/IEC 18013-5:

IssuerSigned = {
? "nameSpaces" : IssuerNameSpaces,
"issuerAuth" : IssuerAuth
}

Inheritors

Properties

Link copied to clipboard
abstract val docType: String

The docType of the credential as defined in ISO/IEC 18013-5.

Link copied to clipboard
abstract val issuerAuth: CoseSign1

The IssuerAuth part of the issuer-provided data.

Link copied to clipboard

Convenience property for accessing the X.509 certificate chain for the issuer signature from issuerAuth.

Link copied to clipboard

The issuer-signed data elements part of the issuer-provided data.

Link copied to clipboard
abstract val issuerProvidedData: ByteString

The issuer-provided data associated with the credential, see Credential.issuerProvidedData.

Link copied to clipboard
abstract val issuerSigned: DataItem

The IssuerSigned data according to ISO/IEC 18013-5.

Link copied to clipboard

Convenience property for accessing the MobileSecurityObject from issuerAuth.

Functions

Link copied to clipboard
open suspend fun getClaimsImpl(documentTypeRepository: DocumentTypeRepository?, locales: List<String> = emptyList()): List<MdocClaim>

Gets the claims in the credential, see Credential.getClaims.

Link copied to clipboard
suspend fun MdocCredential.validate(now: Instant? = Clock.System.now()): ValidationResult

Validates this certified mdoc credential against its current issuer-provided data.

suspend fun MdocCredential.validate(issuerProvidedAuthenticationData: ByteString, now: Instant? = Clock.System.now()): ValidationResult

Validates candidate issuer-provided static authentication data against this mdoc credential.