multipaz/org.multipaz.sdjwt.credential/KeyBoundSdJwtVcCredential

KeyBoundSdJwtVcCredential

class KeyBoundSdJwtVcCredential : SecureAreaBoundCredential, SdJwtVcCredential

A SD-JWT VC credential, according to draft-ietf-oauth-sd-jwt-vc-03 (https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/) that is bound to a key stored in a SecureArea.

Constructors

Link copied to clipboard
constructor(document: Document)

Constructs a Credential from serialized data.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
lateinit var alias: String

The alias for the authentication key associated with this credential.

Link copied to clipboard
open override val credentialType: String

Identifies credential type.

Link copied to clipboard
val document: Document

The Document that the credential belongs to.

Link copied to clipboard
lateinit var domain: String

The domain of the credential.

Link copied to clipboard
Link copied to clipboard
val isCertified: Boolean

Indicates whether the credential has been certified yet.

Link copied to clipboard
val issuerProvidedData: ByteString

The issuer-provided data associated with the credential.

Link copied to clipboard
Link copied to clipboard
lateinit var secureArea: SecureArea

The secure area for the authentication key associated with this credential.

Link copied to clipboard
val tags: Tags

A Tags for storing application-specific data.

Link copied to clipboard
@Volatile
var usageCount: Int

How many times the credential has been used in an identity presentation.

Link copied to clipboard
val validFrom: Instant

The point in time the issuer-provided data is valid from.

Link copied to clipboard
val validUntil: Instant

The point in time the issuer-provided data is valid until.

Link copied to clipboard
open lateinit override var vct: String

The Verifiable Credential Type - or vct - as defined in section 3.2.2.1.1 of draft-ietf-oauth-sd-jwt-vc-03 (https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/)

Functions

Link copied to clipboard
open override fun addSerializedData(builder: MapBuilder<CborBuilder>)

Method which can be overridden by Credential subclasses to add any additional information when serializing a credential.

Link copied to clipboard
suspend fun addToDocument()
Link copied to clipboard
open suspend fun certify(issuerProvidedAuthenticationData: ByteString)

Certifies the credential.

Link copied to clipboard
open suspend override fun deserialize(dataItem: DataItem)

Initialize this object using serialized data.

Link copied to clipboard
open suspend override fun exportToMpzPass(keyUnlockData: KeyUnlockData?): MpzPass

Exports the credential as a MpzPass which can be shared with other applications.

Link copied to clipboard
open suspend fun extractValidityFromIssuerDataImpl(): Pair<Instant, Instant>

Extracts validity from the credential

Link copied to clipboard
suspend fun getAttestation(): KeyAttestation

The attestation for the SecureArea key associated with this credential.

Link copied to clipboard
open suspend override fun getClaims(documentTypeRepository: DocumentTypeRepository?): List<JsonClaim>

Gets the claims in the credential.

Link copied to clipboard
open suspend fun getClaimsImpl(documentTypeRepository: DocumentTypeRepository?): List<JsonClaim>
Link copied to clipboard
open suspend fun getIssuerCertChain(): X509CertChain?

The X.509 certificate chain for the issuer signature from the SD-JWT VC header (x5c), if present.

Link copied to clipboard
suspend fun Credential.getRevocationInfo(trustManager: TrustManagerInterface): RevocationInfo?

Convenience method to extract RevocationInfo from a Credential.

Link copied to clipboard
suspend fun increaseUsageCount()

Increases usage count of the credential.

Link copied to clipboard
open suspend override fun isInvalidated(): Boolean

Indicates whether the credential has been invalidated.

Generated by Dokka
© 2026 Copyright