ksecuremessage-storage-rotation-core/dev.kreienbuehl.ksecuremessage.storage.rotation/StorageKeyRotationPhase

StorageKeyRotationPhase

enum StorageKeyRotationPhase : Enum<StorageKeyRotationPhase>

Phase of a storage key rotation (docs/storage-key-rotation.md). Storage key rotation replaces the key that encrypts client storage records; it is unrelated to signed prekey rotation.

Entries

STABLE

One key: every record uses the current key.

PREPARING

A new key ID is allocated, but the provider key may not exist yet and the current key is unchanged. Only the current key is needed to open.

MIGRATING

The new key is current and seals every new record; records of the retiring key are re-encrypted in batches. Both keys are needed to open.

RETIRING

No record uses the retiring key any more (proven by a full scan); its provider key is being removed. Only the current key is needed to open.

Properties

entries

val entries: EnumEntries<StorageKeyRotationPhase>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): StorageKeyRotationPhase

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<StorageKeyRotationPhase>

Returns an array containing the constants of this enum type, in the order they're declared.