multipaz/org.multipaz.provisioning/ProvisioningModel

ProvisioningModel

class ProvisioningModel(documentStore: DocumentStore, secureArea: SecureArea, httpClient: HttpClient, promptModel: PromptModel, metadataHandler: ProvisioningModel.AbstractDocumentMetadataHandler = DocumentMetadataHandler())

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

Only a single provisioning session per model object can be active at any time.

Parameters

documentStore

new Document will be created in this DocumentStore

secureArea

Credential objects will be bound to this SecureArea

httpClient

HTTP client used to communicate to the provisioning server, it MUST NOT handle redirects automatically

promptModel

PromptModel that is used to show prompts to generate proof-of-possession for credential keys

metadataHandler

interface that initializes and updates document metadata; it must be provided if DocumentStore uses custom implementation for AbstractDocumentMetadata (i.e. not DocumentMetadata).

Constructors

ProvisioningModel

constructor(documentStore: DocumentStore, secureArea: SecureArea, httpClient: HttpClient, promptModel: PromptModel, metadataHandler: ProvisioningModel.AbstractDocumentMetadataHandler = DocumentMetadataHandler())

Types

AbstractDocumentMetadataHandler

interface AbstractDocumentMetadataHandler

Manager document metadata when the document is created and when the metadata is updated from the server.

Authorized

data object Authorized : ProvisioningModel.State

User was successfully authorized

Authorizing

data class Authorizing(val authorizationChallenges: List<AuthorizationChallenge>) : ProvisioningModel.State

Authorizing the user.

Companion

object Companion

Connected

data object Connected : ProvisioningModel.State

Connected to the provisioning server

CredentialsIssued

data object CredentialsIssued : ProvisioningModel.State

Credentials are issued, provisioning has stopped

DocumentMetadataHandler

class DocumentMetadataHandler(defaultCardArtLoader: suspend () -> ByteString = { defaultCardArt }) : ProvisioningModel.AbstractDocumentMetadataHandler

AbstractDocumentMetadataHandler implementation that handles the case when default implementation (DocumentMetadata) is used to represent document metadata.

Error

data class Error(val err: Throwable) : ProvisioningModel.State

Error occurred when provisioning, provisioning has stopped

Idle

data object Idle : ProvisioningModel.State

Provisioning is not active

Initial

data object Initial : ProvisioningModel.State

Provisioning is about to start

ProcessingAuthorization

data object ProcessingAuthorization : ProvisioningModel.State

Authorization response is being processed

RequestingCredentials

data object RequestingCredentials : ProvisioningModel.State

Credentials are being requested from the provisioning server

State

sealed class State

Represents model's state

Properties

isActive

val isActive: Boolean

state

val state: StateFlow<ProvisioningModel.State>

State of the model

Functions

cancel

fun cancel()

Cancel currently-running provisioning session (if any) and sets the state to Idle.

launch

fun launch(coroutineContext: CoroutineContext, provisioningClientFactory: suspend () -> ProvisioningClient): Deferred<Document>

Launch provisioning session to provision credentials to a new Document using given ProvisioningClient factory.

launchOpenID4VCIProvisioning

fun launchOpenID4VCIProvisioning(offerUri: String, clientPreferences: OpenID4VCIClientPreferences, backend: OpenID4VCIBackend): Deferred<Document>

Launch provisioning session to provision credentials to a new Document using OpenID4VCI protocol.

provideAuthorizationResponse

suspend fun provideAuthorizationResponse(response: AuthorizationResponse)

Provide AuthorizationResponse for one of the challenges in Authorizing.authorizationChallenges.