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

open class DocumentProvisioningHandler(val secureArea: SecureArea, val documentStore: DocumentStore, val metadataHandler: DocumentProvisioningHandler.AbstractDocumentMetadataHandler? = null, val defaultDocumentProvisioningSettings: DocumentProvisioningSettings = DocumentProvisioningSettings()) : AbstractDocumentProvisioningHandler

Implementation of AbstractDocumentMetadataHandler suitable for most uses.

DocumentProvisioningSettings

data class DocumentProvisioningSettings(val minValidTime: Duration = 5.days, val keyBoundCredentialMaxUses: Int = 1, val keyBoundCredentialNumPerDomain: Int = 5, val keylessCredentialMaxUses: Int = Int.MAX_VALUE, val keylessCredentialNumPerDomain: Int = 1, val userAuthTimeout: Duration = 0.seconds, val requestUserAuth: Boolean = true, val requestNoUserAuth: Boolean = true, val mdocUserAuthDomain: String = "mdoc_user_auth", val mdocNoUserAuthDomain: String = "mdoc_no_user_auth", val sdJwtUserAuthDomain: String = "sdjwt_user_auth", val sdJwtNoUserAuthDomain: String = "sdjwt_no_user_auth", val sdJwtKeylessDomain: String = "sdjwt_keyless")

Settings for controlling provisioning of org.multipaz.credential.Credentials in a org.multipaz.document.Document.

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.