multipaz/org.multipaz.provisioning/DocumentProvisioningSettings

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.

This is used by DocumentProvisioningHandler.

Parameters

minValidTime

replace a credential if it's going to be valid for less than this amount of time.

keyBoundCredentialMaxUses

replace a key-bound credential if its use-count is greater or equal than this number.

keyBoundCredentialNumPerDomain

number of key-bound credentials to maintain, per domain.

keylessCredentialMaxUses

replace a keyless credential if its use-count is greater or equal than this number.

keylessCredentialNumPerDomain

number of keyless credentials to maintain, per domain.

userAuthTimeout

the timeout to use for newly created keys, or 0 for authentication for every use.

requestUserAuth

if true, will request keyBoundCredentialNumPerDomain credentials for user auth, in the domains given by mdocUserAuthDomain and sdJwtUserAuthDomain.

requestNoUserAuth

if true, will request keyBoundCredentialNumPerDomain credentials without user auth, in the domains given by mdocNoUserAuthDomain and sdJwtNoUserAuthDomain.

mdocUserAuthDomain

the domain to use when requesting ISO mdoc credentials with user auth required.

mdocNoUserAuthDomain

the domain to use when requesting ISO mdoc credentials without user auth required.

sdJwtUserAuthDomain

the domain to use when requesting key-bound IETF SD-JWT VC credentials with user auth required.

sdJwtNoUserAuthDomain

the domain to use when requesting key-bound IETF SD-JWT VC credentials without user auth required.

sdJwtKeylessDomain

the domain to use when requesting non-key-bound IETF SD-JWT VC credentials

Constructors

DocumentProvisioningSettings

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