multipaz/org.multipaz.securearea

Package-level declarations

Types

AndroidKeystoreCreateKeySettings

class AndroidKeystoreCreateKeySettings : CreateKeySettings

Class for holding Android Keystore-specific settings related to key creation.

AndroidKeystoreKeyInfo

class AndroidKeystoreKeyInfo : KeyInfo

Android Keystore specific class for information about a key.

AndroidKeystoreKeyUnlockData

class AndroidKeystoreKeyUnlockData(val secureArea: AndroidKeystoreSecureArea, val alias: String) : KeyUnlockData

A class that can be used to provide information used for unlocking a key.

AndroidKeystoreSecureArea

class AndroidKeystoreSecureArea : SecureArea

An implementation of SecureArea using Android Keystore.

BatchCreateKeyResult

data class BatchCreateKeyResult(val keyInfos: List<KeyInfo>, val openid4vciKeyAttestationJws: String?)

Result of a SecureArea.batchCreateKey call.

CreateKeySettings

open class CreateKeySettings(val algorithm: Algorithm = Algorithm.ESP256, val nonce: ByteString = ByteString(), val userAuthenticationRequired: Boolean = false)

Base class for key creation settings.

KeyAttestation

data class KeyAttestation(val publicKey: EcPublicKey, val certChain: X509CertChain?)

Class for key attestations.

KeyInfo

open class KeyInfo

Class with information about a key.

KeyInvalidatedException

class KeyInvalidatedException : Exception

Exception thrown when trying to use a key which has been invalidated.

KeyLockedException

open class KeyLockedException : Exception

Exception thrown when trying to use a key which hasn't been unlocked.

KeyUnlockData

interface KeyUnlockData

Abstract type with information used when operating on a key that has been unlocked.

KeyUnlockInteractive

class KeyUnlockInteractive(val title: String? = null, val subtitle: String? = null, val requireConfirmation: Boolean = false) : KeyUnlockData

A KeyUnlockData which will automatically show dialogs to interact with the user.

PassphraseConstraints

data class PassphraseConstraints(val minLength: Int, val maxLength: Int, val requireNumerical: Boolean)

Enumeration used to convey constraints on passphrases and PINs.

ScreenLockRequiredException

class ScreenLockRequiredException : Exception

Exception thrown when trying to create a key with user authentication but no screen lock has been set up.

SecureArea

interface SecureArea

An interface to a Secure Area.

SecureAreaProvider

class SecureAreaProvider<out T : SecureArea>(context: CoroutineContext = Dispatchers.Main, provider: suspend CoroutineScope.() -> T)

Lazily creates a SecureArea.

SecureAreaRepository

class SecureAreaRepository

A repository of SecureArea implementations.

SecureEnclaveCreateKeySettings

class SecureEnclaveCreateKeySettings

Class for holding Secure Enclave settings related to key creation.

SecureEnclaveKeyInfo

class SecureEnclaveKeyInfo

Secure Enclave specific class for information about a key.

SecureEnclaveKeyUnlockData

class SecureEnclaveKeyUnlockData(val authenticationContext: LAContext)

Class used to provide policy when unlocking a key.

SecureEnclaveSecureArea

class SecureEnclaveSecureArea

An implementation of SecureArea using the Apple Secure Enclave.

SecureEnclaveUserAuthType

enum SecureEnclaveUserAuthType : Enum<SecureEnclaveUserAuthType>

An enumeration for different user authentication types when using keys in the Secure Enclave.

UserAuthenticationType

enum UserAuthenticationType : Enum<UserAuthenticationType>

An enumeration for different user authentication types.

Properties

secureEnclaveUserAuthType

val Long.secureEnclaveUserAuthType: Set<SecureEnclaveUserAuthType>

Decodes the number into a set of UserAuthenticationType

userAuthenticationTypeSet

val Long.userAuthenticationTypeSet: Set<UserAuthenticationType>

Decodes the number into a set of UserAuthenticationType