ksecuremessage-server-core/dev.kreienbuehl.ksecuremessage.server

Package-level declarations

Types

Proof that a request for endpoint on behalf of address passed authentication and claimed its nonce. Only DeviceAuthenticator creates one, so a protected operation cannot run without it. registrationState is the registration whose key verified the request: an operation that must still hold when it commits (a recovery key rotation or revocation) compares against it.

DeviceAuthenticationException

sealed class DeviceAuthenticationException : Exception

A request that failed authentication. Nothing was changed except, for none of these, a nonce.

DeviceAuthenticationRotationException

sealed class DeviceAuthenticationRotationException : Exception

A rejected routine rotation. Nothing was changed. Messages never contain key material.

DeviceAuthenticationRotationOutcome

enum DeviceAuthenticationRotationOutcome : Enum<DeviceAuthenticationRotationOutcome>

A successful routine rotation.

DeviceAuthenticator

class DeviceAuthenticator(devices: DeviceRegistrationRepository, nonces: AuthenticationNonceRepository, clock: Clock = Clock.System)

Verifies device-authenticated requests (docs/server-authentication.md).

DeviceRecoveryException

sealed class DeviceRecoveryException : Exception

A rejected device recovery. Nothing was changed. Messages never contain key material.

DeviceRecoveryOutcome

enum DeviceRecoveryOutcome : Enum<DeviceRecoveryOutcome>

A successful device recovery.

DeviceRegistrationAuthorizationFailedException

class DeviceRegistrationAuthorizationFailedException(cause: Throwable) : Exception

The host's DeviceRegistrationAuthorizer threw instead of deciding. Nothing was registered. The message is fixed; the host's exception is the cause, for the host's own diagnostics only: the HTTP adapter answers 500 internal_error and logs neither its message nor the context.

DeviceRegistrationAuthorizationRequest

class DeviceRegistrationAuthorizationRequest(val address: DeviceAddress, proposedAuthenticationPublicKey: ByteArray)

A registration that passed authentication and awaits the host's decision. address is the device address being claimed and proposedAuthenticationPublicKey the Ed25519 device authentication public key (32 bytes, a copy) whose possession the request proved. Carries no secrets and no server storage objects.

DeviceRegistrationAuthorizationResult

sealed class DeviceRegistrationAuthorizationResult

The host's decision on a DeviceRegistrationAuthorizationRequest.

DeviceRegistrationAuthorizer

fun interface DeviceRegistrationAuthorizer<in C : Any>

The host application's decision whether the caller of a registration may add a device to a user (docs/server-authentication.md, "Registration authorization"). KSecureMessage has no account system: it cannot know who owns a dev.kreienbuehl.ksecuremessage.model.UserId. Every first registration of a device address, including the first device of a user, needs this authorizer's DeviceRegistrationAuthorizationResult.Authorized in addition to the proof that the registrant holds the device authentication key.

EnvelopeSenderMismatchException

class EnvelopeSenderMismatchException : Exception

A submitted envelope names a sender other than the device that authenticated the submission. Nothing was queued.

LastDeviceRecoveryException

sealed class LastDeviceRecoveryException : Exception

A rejected last-device recovery or recovery key registration. Nothing was changed. Messages never contain key material.

LastDeviceRecoveryOutcome

enum LastDeviceRecoveryOutcome : Enum<LastDeviceRecoveryOutcome>

A successful last-device recovery.

PreKeyService

class PreKeyService(repository: PreKeyRepository)

Publication and handout of public prekeys. Treats every publication as untrusted input: its format is checked before the repository sees it. Conflict checks and atomicity belong to the repository.

ProtectedEndpoint

enum ProtectedEndpoint : Enum<ProtectedEndpoint>

Device-scoped operations that require the registered device's authentication. Each one fixes the HTTP method and the canonical path the signature must cover (docs/server-authentication.md).

RecoveryKeyLifecycleException

sealed class RecoveryKeyLifecycleException : Exception

A rejected recovery key rotation or revocation. Nothing was changed. Messages never contain key material.

RecoveryKeyResetCompletionOutcome

enum RecoveryKeyResetCompletionOutcome : Enum<RecoveryKeyResetCompletionOutcome>

A successful reset completion.

RecoveryKeyResetException

sealed class RecoveryKeyResetException : Exception

A rejected recovery key reset operation. Nothing was changed. Messages never contain key material.

RecoveryKeyResetPolicy

data class RecoveryKeyResetPolicy(val delay: Duration)

The host's policy for delayed recovery key resets (docs/recovery-key-reset.md): a reset requested at server time t can be completed from t + delay on (rounded up to whole milliseconds). The delay is the time every device of the user, and the holder of the current recovery key, has to notice and cancel a reset; choose it for how often the application checks. There is no default: a server without a policy refuses reset requests.

RecoveryKeyResetRequestOutcome

class RecoveryKeyResetRequestOutcome(val reset: RecoveryKeyResetStatus.Pending, val created: Boolean)

A reset request: the pending reset, created by this request or an existing one returned unchanged.

RecoveryKeyRevocationOutcome

enum RecoveryKeyRevocationOutcome : Enum<RecoveryKeyRevocationOutcome>

A successful recovery key revocation.

RecoveryKeyRotationOutcome

enum RecoveryKeyRotationOutcome : Enum<RecoveryKeyRotationOutcome>

A successful recovery key rotation.

SecureMessageServer

class SecureMessageServer<C : Any>(storage: ServerStorage, clock: Clock, deviceRegistrationAuthorizer: DeviceRegistrationAuthorizer<C>, recoveryKeyResetPolicy: RecoveryKeyResetPolicy? = null)

Blind relay: stores public prekeys and queues opaque envelopes. Never decrypts payloads and never holds client secrets.