kjwt-hardware-backed-processor/co.touchlab.kjwt.hardware.model/SecureHardwarePreference

SecureHardwarePreference

enum SecureHardwarePreference : Enum<SecureHardwarePreference> (source)

Controls whether keys generated by the hardware-backed key factories are backed by a dedicated secure hardware element.

This preference is interpreted platform-specifically:

Android: controls use of StrongBox (a dedicated secure element separate from the default Trusted Execution Environment). Requires API 28+.
Apple (iOS/macOS): controls use of the Secure Enclave for ES256 (P-256) keys. Keys stored in the Secure Enclave never leave the secure element even during signing operations.

Entries

None

Do not request dedicated secure-hardware key storage. Default behaviour.

Preferred

Use secure hardware when available, falling back silently to the default storage otherwise.

Required

Require dedicated secure-hardware key storage; throw if unavailable.

Properties

entries

val entries: EnumEntries<SecureHardwarePreference>

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): SecureHardwarePreference

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<SecureHardwarePreference>

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