CloudSecureAreaProtocol

Multipaz CBOR-RPC protocol interface between a CloudSecureArea client and server.

All methods on this interface are authenticated using org.multipaz.device.DeviceAssertion via org.multipaz.rpc.handler.RpcDispatcherAuth and org.multipaz.rpc.handler.RpcAuthIssuerAssertion after client registration via org.multipaz.rpc.auth.ClientRegistration.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun batchCreateKey0(keyConfiguration: CloudKeyConfiguration): ByteString

Initiates batch creation of keys on the Cloud Secure Area server.

Link copied to clipboard
abstract suspend fun batchCreateKey1(localKeyAttestations: List<KeyAttestation>): CloudBatchCreatedKeys

Completes batch creation of keys on the Cloud Secure Area server.

Link copied to clipboard
abstract suspend fun checkPassphrase(passphrase: String)

Checks if the given passphrase matches the registered passphrase.

Link copied to clipboard
abstract suspend fun createKey0(keyConfiguration: CloudKeyConfiguration): ByteString

Initiates creation of a single key on the Cloud Secure Area server.

Link copied to clipboard
abstract suspend fun createKey1(localKeyAttestation: KeyAttestation): CloudCreatedKey

Completes creation of a single key on the Cloud Secure Area server.

Link copied to clipboard
abstract suspend fun kemDecapsulate0(ciphertext: ByteString, keyContext: ByteString): ByteString

Initiates decapsulating a shared secret with a KEM cloud key.

Link copied to clipboard
abstract suspend fun kemDecapsulate1(signature: EcSignature, passphrase: String?): ByteString

Completes decapsulating a shared secret with a KEM cloud key.

Link copied to clipboard
abstract suspend fun keyAgreement0(otherPublicKey: EcPublicKey, keyContext: ByteString): ByteString

Initiates key agreement (ECDH) with a cloud key.

Link copied to clipboard
abstract suspend fun keyAgreement1(signature: EcSignature, passphrase: String?): ByteString

Completes key agreement (ECDH) with a cloud key.

Link copied to clipboard
abstract suspend fun register(passphrase: String): X509CertChain

Completes registration with the Cloud Secure Area server and sets the user's passphrase.

Link copied to clipboard
abstract suspend fun sign0(dataToSign: ByteString, keyContext: ByteString): ByteString

Initiates signing data with a cloud key.

Link copied to clipboard
abstract suspend fun sign1(signature: EcSignature, passphrase: String?): Signature

Completes signing data with a cloud key.