multipaz/org.multipaz.provisioning

Package-level declarations

Types

AbstractDocumentProvisioningHandler

interface AbstractDocumentProvisioningHandler

Interface to manage Document and Credential instances during provisioning.

AuthorizationChallenge

sealed class AuthorizationChallenge

Describes a particular way to authorize the user to provision a credential.

AuthorizationException

class AuthorizationException(val code: String, val description: String?) : Exception

Thrown when authorization failed permanently.

AuthorizationResponse

sealed class AuthorizationResponse

Describes a result of a particular way to authorize the user.

CredentialCertification

data class CredentialCertification(val credentialId: String, val issuerData: ByteString)

Data necessary to certify a credential during provisioning.

CredentialFormat

sealed class CredentialFormat

Describes a format of a credential.

CredentialKeyAttestation

class CredentialKeyAttestation(val credentialId: String, val keyAttestation: KeyAttestation)

Public key id and its attestation.

CredentialMetadata

data class CredentialMetadata(val display: Display, val format: CredentialFormat, val keyBindingType: KeyBindingType, val maxBatchSize: Int)

Metadata for a particular type of credential that an issuer can provision.

Credentials

data class Credentials(val certifications: List<CredentialCertification>, val display: Display?)

Provisioned credentials and optional credential metadata.

Display

class Display(val text: String, val logo: ByteString?)

Describes something in the user-facing manner.

DocumentProvisioningHandler

class DocumentProvisioningHandler(val secureArea: SecureArea, val documentStore: DocumentStore, val mdocCredentialDomain: String = "mdoc_user_auth", val sdJwtCredentialDomain: String = "sdjwt_user_auth", val keylessCredentialDomain: String = "sdjwt_keyless", val batchSize: Int = 3, val metadataHandler: DocumentProvisioningHandler.AbstractDocumentMetadataHandler? = null) : AbstractDocumentProvisioningHandler

Implementation of AbstractDocumentMetadataHandler suitable for most uses.

KeyBindingInfo

sealed class KeyBindingInfo

Provides keys to which credentials are to be bound and key proofing information.

KeyBindingType

sealed class KeyBindingType

Type of KeyBindingInfo that credential issuer expects in ProvisioningClient.obtainCredentials call.

ProofOfPossessionUnlockReason

object ProofOfPossessionUnlockReason : Reason

Indicates that a key in SecureArea should be unlocked to generate proof-of-possession in a provisioning workflow.

Provisioning

object Provisioning

Object that dispatches general provisioning-related operations to correct protocol handlers (for Multipaz-implemented protocols).

ProvisioningClient

interface ProvisioningClient

Interface to provision credentials, typically from a server (such as OpenId4Vci server).

ProvisioningMetadata

data class ProvisioningMetadata(val display: Display, val credentials: Map<String, CredentialMetadata>)

Credential issuer metadata.

ProvisioningModel

class ProvisioningModel(documentProvisioningHandler: AbstractDocumentProvisioningHandler, httpClient: HttpClient, promptModel: PromptModel, authorizationSecureArea: SecureArea)

This model supports UX/UI flow for provisioning of credentials.

SecretCodeRequest

data class SecretCodeRequest(val description: String, val isNumeric: Boolean, val length: Int?)

Describes secret text that user needs to enter.

Properties

cborSchemaId

val CredentialCertification.Companion.cborSchemaId: ByteString

val CredentialFormat.Companion.cborSchemaId: ByteString

val CredentialKeyAttestation.Companion.cborSchemaId: ByteString

CredentialCertification_cborSchemaId

val CredentialCertification_cborSchemaId: ByteString

CredentialFormat_cborSchemaId

val CredentialFormat_cborSchemaId: ByteString

CredentialKeyAttestation_cborSchemaId

val CredentialKeyAttestation_cborSchemaId: ByteString

Mdoc_cborSchemaId

val Mdoc_cborSchemaId: ByteString

SdJwt_cborSchemaId

val SdJwt_cborSchemaId: ByteString

SecretCodeRequest_cborSchemaId

val SecretCodeRequest_cborSchemaId: ByteString

Functions

fromCbor

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

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

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

fromDataItem

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

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

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

Mdoc_fromDataItem

fun Mdoc_fromDataItem(dataItem: DataItem): CredentialFormat.Mdoc

SdJwt_fromDataItem

fun SdJwt_fromDataItem(dataItem: DataItem): CredentialFormat.SdJwt

SecretCodeRequest_fromDataItem

fun SecretCodeRequest_fromDataItem(dataItem: DataItem): SecretCodeRequest

toCbor

fun CredentialCertification.toCbor(): ByteArray

fun CredentialFormat.toCbor(): ByteArray

fun CredentialFormat.Mdoc.toCbor(): ByteArray

fun CredentialFormat.SdJwt.toCbor(): ByteArray

fun CredentialKeyAttestation.toCbor(): ByteArray

fun SecretCodeRequest.toCbor(): ByteArray

toDataItem

fun CredentialCertification.toDataItem(): DataItem

fun CredentialFormat.toDataItem(): DataItem

fun CredentialFormat.Mdoc.toDataItem(): DataItem

fun CredentialFormat.SdJwt.toDataItem(): DataItem

fun CredentialKeyAttestation.toDataItem(): DataItem

fun SecretCodeRequest.toDataItem(): DataItem