ksecuremessage-client-ktor/dev.kreienbuehl.ksecuremessage.client.ktor/KtorSecureMessageTransport

KtorSecureMessageTransport

class KtorSecureMessageTransport(baseUrl: String, client: HttpClient = HttpClient { install(ContentNegotiation) { json() } }) : SecureMessageTransport

SecureMessageTransport over the KSecureMessage HTTP API v1. client must have ContentNegotiation with JSON installed. Routes and bodies are described in docs/prekey-publication.md, authentication in docs/server-authentication.md.

Authenticated requests are built from their exact body bytes: the JSON is encoded here, signed together with the method and canonical path, and sent unchanged, so the server hashes what was signed. Each attempt is signed anew (fresh timestamp and nonce).

Constructors

constructor(baseUrl: String, client: HttpClient = HttpClient { install(ContentNegotiation) { json() } })

Functions

cancelLastDeviceRecoveryKeyReset

open suspend override fun cancelLastDeviceRecoveryKeyReset(address: DeviceAddress, resetId: RecoveryKeyResetId, signer: ServerRequestSigner)

cancelLastDeviceRecoveryKeyResetByRecoveryKey

open suspend override fun cancelLastDeviceRecoveryKeyResetByRecoveryKey(authorization: RecoveryKeyResetCancellationAuthorization)

completeLastDeviceRecoveryKeyReset

open suspend override fun completeLastDeviceRecoveryKeyReset(authorization: RecoveryKeyResetCompletionAuthorization, signer: ServerRequestSigner)

fetchPreKeyBundle

open suspend override fun fetchPreKeyBundle(address: DeviceAddress): PreKeyBundle

The returned bundle's address is always address; the server's response carries none. The bundle is not trusted here: the protocol engine verifies it before X3DH.

lastDeviceRecoveryChallenge

open suspend override fun lastDeviceRecoveryChallenge(target: DeviceAddress): LastDeviceRecoveryChallenge

lastDeviceRecoveryKeyResetStatus

open suspend override fun lastDeviceRecoveryKeyResetStatus(address: DeviceAddress, signer: ServerRequestSigner): RecoveryKeyResetStatus

lastDeviceRecoveryKeyResetStatusByRecoveryKey

open suspend override fun lastDeviceRecoveryKeyResetStatusByRecoveryKey(query: RecoveryKeyResetStatusQuery): RecoveryKeyResetStatus

lastDeviceRecoveryKeyStatus

open suspend override fun lastDeviceRecoveryKeyStatus(address: DeviceAddress, signer: ServerRequestSigner): LastDeviceRecoveryKeyStatus

publishPreKeys

open suspend override fun publishPreKeys(publication: PreKeyPublication, signer: ServerRequestSigner)

receive

open suspend override fun receive(address: DeviceAddress, signer: ServerRequestSigner): List<EncryptedEnvelope>

recoverDevice

open suspend override fun recoverDevice(authorization: DeviceRecoveryAuthorization)

recoverLastDevice

open suspend override fun recoverLastDevice(authorization: LastDeviceRecoveryAuthorization)

registerDevice

open suspend override fun registerDevice(registration: DeviceRegistration, signer: ServerRequestSigner)

registerLastDeviceRecoveryKey

open suspend override fun registerLastDeviceRecoveryKey(address: DeviceAddress, registration: LastDeviceRecoveryKeyRegistration, signer: ServerRequestSigner)

registrationStatus

open suspend override fun registrationStatus(address: DeviceAddress, signer: ServerRequestSigner): DeviceAuthenticationRegistrationStatus

requestLastDeviceRecoveryKeyReset

open suspend override fun requestLastDeviceRecoveryKeyReset(address: DeviceAddress, signer: ServerRequestSigner): RecoveryKeyResetStatus.Pending

revokeLastDeviceRecoveryKey

open suspend override fun revokeLastDeviceRecoveryKey(authorization: RecoveryKeyRevocationAuthorization, signer: ServerRequestSigner)

rotateDeviceAuthenticationKey

open suspend override fun rotateDeviceAuthenticationKey(authorization: DeviceAuthenticationRotationAuthorization)

rotateLastDeviceRecoveryKey

open suspend override fun rotateLastDeviceRecoveryKey(authorization: RecoveryKeyRotationAuthorization, signer: ServerRequestSigner)

send

open suspend override fun send(envelope: EncryptedEnvelope, signer: ServerRequestSigner)

POST /v1/messages, ServerAuth-signed as the envelope's sender, which the device header names (S1, docs/server-authentication.md).