multipaz/org.multipaz.securearea.software/SoftwareSecureArea

SoftwareSecureArea

An implementation of SecureArea that creates and uses software keys.

This implementation supports all the curves and algorithms defined by SecureArea and also supports passphrase-protected keys. Key material is stored using the Storage abstraction and passphrase-protected keys are encrypted using AES-GCM with 256-bit keys with the key derived from the passphrase using HKDF.

On JVM and Android this is using Crypto and the algorithms and curves it implements.

Use SoftwareSecureArea.create to create an instance of SoftwareSecureArea.

Types

Companion

object Companion

DefaultKeyUnlockDataProvider

object DefaultKeyUnlockDataProvider : KeyUnlockDataProvider

Properties

displayName

open override val displayName: String

The name of the Secure Area, suitable for displaying to the end user.

identifier

open override val identifier: String

A stable identifier for the Secure Area.

supportedAlgorithms

open override val supportedAlgorithms: List<Algorithm>

The list of algorithms the Secure Area supports.

Functions

batchCreateKey

open suspend fun batchCreateKey(numKeys: Int, createKeySettings: CreateKeySettings): BatchCreateKeyResult

Creates a batch of new keys.

createKey

open suspend override fun createKey(alias: String?, createKeySettings: CreateKeySettings): SoftwareKeyInfo

Creates a new key.

deleteKey

open suspend override fun deleteKey(alias: String)

Deletes a previously created key.

getKeyInfo

open suspend override fun getKeyInfo(alias: String): SoftwareKeyInfo

Gets information about a key.

getKeyInvalidated

open suspend override fun getKeyInvalidated(alias: String): Boolean

Checks whether the key has been invalidated.

getPrivateKey

suspend fun getPrivateKey(alias: String, keyUnlockData: KeyUnlockData?): PrivateKey

Gets the underlying private key.

kemDecapsulate

open suspend override fun kemDecapsulate(alias: String, ciphertext: ByteArray, unlockReason: Reason): SecureByteString

Performs Key Decapsulation.

keyAgreement

open suspend override fun keyAgreement(alias: String, otherKey: EcPublicKey, unlockReason: Reason): SecureByteString

Performs Key Agreement.

sign

open suspend override fun sign(alias: String, dataToSign: ByteArray, unlockReason: Reason): Signature

Signs data with a key.

unlockKey

open suspend override fun unlockKey(alias: String, unlockReason: Reason): List<KeyUnlockData>

Unlocks a key requiring user authentication.