multipaz-provisioning-api/org.multipaz.provisioning

Package-level declarations

Types

interface ApplicationSupport : RpcNotifiable<LandingUrlNotification>

Server-side support functionality for the wallet mobile app. This is needed even if the full-blown wallet server is not used.

Authentication

interface Authentication

A flow used to authenticate Wallet client (app + device) to the server

ClientAuthentication

data class ClientAuthentication(val attestation: DeviceAttestation?, val assertion: DeviceAssertion, val walletApplicationCapabilities: WalletApplicationCapabilities)

An data structure sent from the Wallet Application to the Wallet Server used to prove that it is the legitimate instance for clientId.

ClientChallenge

data class ClientChallenge(val nonce: ByteString, val clientId: String)

CredentialConfiguration

data class CredentialConfiguration(val challenge: ByteString, val keyAssertionRequired: Boolean, val secureAreaConfiguration: SecureAreaConfiguration)

The configuration to use when creating new credentials.

CredentialData

data class CredentialData(val secureAreaBoundKey: EcPublicKey?, val validFrom: Instant, val validUntil: Instant, val format: CredentialFormat, val data: ByteArray)

This data structure contains a data for a credential, minted by the issuer.

CredentialFormat

enum CredentialFormat : Enum<CredentialFormat>

An enumeration of Credential Formats that an issuer may support.

CredentialRequest

data class CredentialRequest(val secureAreaBoundKeyAttestation: KeyAttestation)

A request for the issuer to mint a credential

DocumentCondition

enum DocumentCondition : Enum<DocumentCondition>

An enumeration of possible conditions a document can be in, from the issuer's perspective.

DocumentConfiguration

data class DocumentConfiguration(val displayName: String, val typeDisplayName: String, val cardArt: ByteArray, val requireUserAuthenticationToViewDocument: Boolean, val mdocConfiguration: MdocDocumentConfiguration?, val sdJwtVcDocumentConfiguration: SdJwtVcDocumentConfiguration?, val directAccessConfiguration: DirectAccessDocumentConfiguration?)

The configuration data for a specific document.

DocumentState

data class DocumentState(val timestamp: Instant, val condition: DocumentCondition, val numPendingCredentials: Int, val numAvailableCredentials: Int)

The state of a document, as seen from the issuer's point of view.

IssuingAuthority

interface IssuingAuthority : RpcNotifiable<IssuingAuthorityNotification>

An interface representing an Issuing Authority.

IssuingAuthorityConfiguration

data class IssuingAuthorityConfiguration(val identifier: String, val issuingAuthorityName: String, val issuingAuthorityLogo: ByteArray, val issuingAuthorityDescription: String, val pendingDocumentInformation: DocumentConfiguration, val numberOfCredentialsToRequest: Int?, val minCredentialValidityMillis: Long?, val maxUsesPerCredentials: Int?)

Configuration data for the issuing authority.

IssuingAuthorityException

class IssuingAuthorityException(val message: String) : Exception

Represents a generic error in issuer with the human-readable message.

IssuingAuthorityNotification

data class IssuingAuthorityNotification(val documentId: String)

A data structure for capturing notification data emitted by the IssuingAuthority.

KeyPossessionChallenge

data class KeyPossessionChallenge(val messageToSign: ByteString)

KeyPossessionProof

data class KeyPossessionProof(val signature: ByteString)

LandingUrlNotification

class LandingUrlNotification(val baseUrl: String)

LandingUrlUnknownException

class LandingUrlUnknownException(val message: String) : Exception

MdocDocumentConfiguration

data class MdocDocumentConfiguration(val docType: String, val staticData: NameSpacedData)

Proofing

interface Proofing

A flow used for identifying and proofing an application.

ProvisioningBackend

interface ProvisioningBackend

ProvisioningBackendCapabilities

data class ProvisioningBackendCapabilities(val generatedAt: Instant)

Information about the capabilities of the wallet server, for the wallet application.

ProvisioningBackendSettings

class ProvisioningBackendSettings(conf: Configuration)

Wallet Server settings.

Registration

interface Registration

A flow used to create a new document.

RegistrationConfiguration

data class RegistrationConfiguration(val documentId: String)

Issuer-specified configuration used when registering a new document.

RegistrationResponse

data class RegistrationResponse(val developerModeEnabled: Boolean)

The response from the application when registering a new document.

RequestCredentials

interface RequestCredentials

A flow used to request new credentials.

SdJwtVcDocumentConfiguration

data class SdJwtVcDocumentConfiguration(val vct: String, val keyBound: Boolean?)

WalletApplicationCapabilities

data class WalletApplicationCapabilities(val generatedAt: Instant, val androidKeystoreAttestKeyAvailable: Boolean, val androidKeystoreStrongBoxAvailable: Boolean, val androidIsEmulator: Boolean, val directAccessSupported: Boolean)

Information about the capabilities of the wallet application, for the wallet server.