ksecuremessage-core-protocol/dev.kreienbuehl.ksecuremessage.protocol/ServerApiPaths

ServerApiPaths

Canonical paths of the device-scoped HTTP API v1. The client builds its request URLs from them; the server rebuilds them from the decoded route parameters. Signatures cover these paths, never a raw request URI.

Each address component is one path segment, percent-encoded as in RFC 3986: the unreserved characters A-Z a-z 0-9 - . _ ~ stay as they are, every other UTF-8 byte becomes %XX with upper-case hex digits.

Properties

LAST_DEVICE_RECOVERY

const val LAST_DEVICE_RECOVERY: String

Last-device recovery (docs/last-device-recovery.md). Not a ServerAuth-signed endpoint.

LAST_DEVICE_RECOVERY_CHALLENGE

const val LAST_DEVICE_RECOVERY_CHALLENGE: String

Issues a last-device recovery challenge. Public, not ServerAuth-signed.

LAST_DEVICE_RECOVERY_KEY

const val LAST_DEVICE_RECOVERY_KEY: String

Registers the user's last-device recovery key. ServerAuth-signed.

LAST_DEVICE_RECOVERY_KEY_RESET

const val LAST_DEVICE_RECOVERY_KEY_RESET: String

Requests (PUT) or reads (GET) the user's delayed recovery key reset (docs/recovery-key-reset.md). ServerAuth-signed.

LAST_DEVICE_RECOVERY_KEY_RESET_CANCELLATION

const val LAST_DEVICE_RECOVERY_KEY_RESET_CANCELLATION: String

Cancels a pending recovery key reset. Device-scoped: ServerAuth-signed. User-scoped (user): public, the body carries the current recovery key's signature.

LAST_DEVICE_RECOVERY_KEY_RESET_COMPLETION

const val LAST_DEVICE_RECOVERY_KEY_RESET_COMPLETION: String

Completes a pending recovery key reset. ServerAuth-signed; the body carries the new key's proof of possession.

LAST_DEVICE_RECOVERY_KEY_RESET_STATUS

const val LAST_DEVICE_RECOVERY_KEY_RESET_STATUS: String

User-scoped recovery key reset status query (user). Public, not ServerAuth-signed: the body carries the current recovery key's signature.

LAST_DEVICE_RECOVERY_KEY_REVOCATION

const val LAST_DEVICE_RECOVERY_KEY_REVOCATION: String

Revokes the user's last-device recovery key (docs/recovery-key-lifecycle.md). ServerAuth-signed; the body carries the current recovery key's signature.

LAST_DEVICE_RECOVERY_KEY_ROTATION

const val LAST_DEVICE_RECOVERY_KEY_ROTATION: String

Rotates the user's last-device recovery key (docs/recovery-key-lifecycle.md). ServerAuth-signed; the body carries the current recovery key's signature.

MESSAGES

const val MESSAGES: String

PRE_KEY_BUNDLE

const val PRE_KEY_BUNDLE: String

PRE_KEYS

const val PRE_KEYS: String

REGISTRATION

const val REGISTRATION: String

REGISTRATION_RECOVERY

const val REGISTRATION_RECOVERY: String

Device recovery (docs/device-recovery.md). Not a ServerAuth-signed endpoint.

REGISTRATION_ROTATION

const val REGISTRATION_ROTATION: String

Routine device authentication key rotation (docs/device-authentication-rotation.md). Not a ServerAuth-signed endpoint.

SUBMIT_MESSAGE

const val SUBMIT_MESSAGE: String

POST /v1/messages: envelope submission, ServerAuth-signed by the sending device since S1 (docs/server-authentication.md). An absolute path, not device-scoped: the device is the signed request's address.

Functions

decodeDevice

fun decodeDevice(value: String): DeviceAddress?

The inverse of encodeDevice, or null unless value is exactly the canonical encoding of an address: two segments, only unreserved characters and upper-case %XX escapes of other bytes, valid UTF-8.

device

fun device(address: DeviceAddress, endpoint: String): String

/v1/devices/{user}/{device}/{endpoint}.

encodeDevice

fun encodeDevice(address: DeviceAddress): String

{user}/{device}, each component encoded with encodeSegment: the submitting device of POST /v1/messages, carried in a request header (S1, docs/server-authentication.md).

encodeSegment

fun encodeSegment(value: String): String

user

fun user(userId: UserId, endpoint: String): String

/v1/users/{user}/{endpoint}: the routes an offline recovery key holder uses without any device (docs/recovery-key-reset.md). Never ServerAuth-signed.