CreateKeysConfig class

Configuration for key creation (all platforms).

Fields are documented with which platform(s) they apply to. Windows ignores most fields as it only supports RSA with mandatory Windows Hello authentication.

Constructors

CreateKeysConfig({SignatureType? signatureType, bool? enforceBiometric, bool? setInvalidatedByBiometricEnrollment, bool? useDeviceCredentials, bool? enableDecryption, String? promptSubtitle, String? promptDescription, String? cancelButtonText, bool? failIfExists, List<BiometricFallbackOption?>? fallbackOptions})

Properties

cancelButtonText ↔ String?
Android Text for the cancel button in the biometric prompt.
getter/setter pair
enableDecryption ↔ bool?
Android Whether to enable decryption capability for the key. On iOS/macOS, decryption is always available with EC keys.
getter/setter pair
enforceBiometric ↔ bool?
Android/iOS/macOS Whether to require biometric authentication during key creation. Windows always authenticates via Windows Hello.
getter/setter pair
failIfExists ↔ bool?
All platforms When true, key creation will fail with BiometricError.keyAlreadyExists if a key with the specified alias (or the default alias) already exists.
getter/setter pair
fallbackOptions ↔ List<BiometricFallbackOption?>?
Android 15+ Custom fallback buttons shown on the biometric prompt. When provided, these replace the default cancel button. If the user taps a fallback option, the result will have code == BiometricError.fallbackSelected with the selected option's index and text. On other platforms, this field is ignored.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
promptDescription ↔ String?
Android Description text for the biometric prompt.
getter/setter pair
promptSubtitle ↔ String?
Android Subtitle text for the biometric prompt.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setInvalidatedByBiometricEnrollment ↔ bool?
Android/iOS/macOS Whether to invalidate the key when new biometrics are enrolled. Not supported on Windows.
getter/setter pair
signatureType ↔ SignatureType?
Android/iOS/macOS The cryptographic algorithm to use. Windows only supports RSA and ignores this field.
getter/setter pair
useDeviceCredentials ↔ bool?
Android/iOS/macOS Whether to allow device credentials (PIN/pattern/passcode) as fallback for biometric authentication. Not supported on Windows.
getter/setter pair

Methods

encode() → Object
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

decode(Object result) → CreateKeysConfig