AccessControlProfile.Builder

Builder(accessControlProfileId: AccessControlProfileId)

Each access control profile has numeric identifier that must be unique within the context of a Credential and may be used to reference the profile.

By default, the resulting AccessControlProfile will require user authentication with a timeout of zero, thus requiring the holder to authenticate for every presentation where data elements using this access control profile is used.

fun build(): AccessControlProfile

Creates a new AccessControlProfile from the data supplied to the builder.

fun setReaderCertificate(readerCertificate: X509Certificate): AccessControlProfile.Builder

Sets the reader certificate to use when checking access control.

If set, this is checked against the certificate chain presented by reader. The access check is fulfilled only if the public key from one of the certificates in the chain, matches the public key in the certificate set by this method.

The default behavior of a AccessControlProfile created from a builder is to not use reader authentication.

fun setUserAuthenticationRequired(userAuthenticationRequired: Boolean): AccessControlProfile.Builder

Set whether user authentication is required.

This should be used sparingly since disabling user authentication on just a single data element can easily create a Relay Attack if the device on which the credential is stored is compromised.

The default behavior of a AccessControlProfile created from a builder is to require user authentication.

fun setUserAuthenticationTimeout(userAuthenticationTimeoutMillis: Long): AccessControlProfile.Builder

Sets the authentication timeout to use.

The authentication timeout specifies the amount of time, in milliseconds, for which a user authentication is valid, if user authentication is required (see setUserAuthenticationRequired).

If the timeout is zero, then authentication is always required for each reader session.

The default behavior of a AccessControlProfile created from a builder is to use a timeout of 0.