multipaz/org.multipaz.securearea.cloud/CloudSecureArea

CloudSecureArea

open class CloudSecureArea : SecureArea

An implementation of SecureArea using a Secure Area managed by an external server.

Types

object Companion

Properties

open override val displayName: String

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

override val identifier: String

A stable identifier for the Secure Area.

val isRegistered: Boolean

platformSecureArea

lateinit var platformSecureArea: SecureArea

val serverUrl: String

supportedAlgorithms

open override val supportedAlgorithms: List<Algorithm>

The list of algorithms the Secure Area supports.

Functions

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

Creates a batch of new keys.

communicateLowlevel

open suspend fun communicateLowlevel(endpointUri: String, requestData: ByteArray): Pair<Int, ByteArray>

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

Creates a new key.

open suspend override fun deleteKey(alias: String)

Deletes a previously created key.

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

Gets information about a key.

getKeyInvalidated

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

Checks whether the key has been invalidated.

getPassphraseConstraints

suspend fun getPassphraseConstraints(): PassphraseConstraints

The PassphraseConstraints configured at registration time.

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

Performs Key Decapsulation.

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

Performs Key Agreement.

suspend fun register(passphrase: String, passphraseConstraints: PassphraseConstraints, onAuthorizeRootOfTrust: (cloudSecureAreaRootOfTrust: X509Cert) -> Boolean)

Registers with the cloud secure area.

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

Signs data with a key.

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

Unlocks a key requiring user authentication.

suspend fun unregister()