LocalBiometric class

A robust, efficient, and performant local biometric identity plugin for Flutter.

This plugin provides secure biometric authentication with support for cryptographic signatures (RSA/ECDSA) using the Secure Enclave (iOS) and Keystore (Android).

Constructors

LocalBiometric()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onIdentityChanged → Stream<IdentityStatus>

Stream of identity status changes.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acknowledgeIdentityChange() → Future<void>

Acknowledges an identity status change reported by onIdentityChanged.

checkAvailability() → Future<IdentityAvailability>

Checks if the device supports biometric authentication and if biometrics are enrolled.

decryptPayload({required String payload, String? keyAlias, IdentityPayloadFormat payloadFormat = IdentityPayloadFormat.base64, IdentityDecryptConfig? config, String? promptMessage}) → Future<IdentityDecryptResult>

Decrypts a payload that was encrypted using the public key of an enrolled identity.

enrollIdentity({String? keyAlias, IdentityEnrollmentConfig? config, IdentityKeyFormat keyFormat = IdentityKeyFormat.base64, String? promptMessage}) → Future<IdentityEnrollmentResult>

Enrolls a new secure identity protected by biometrics.

getIdentityStatus({String? keyAlias, bool checkValidity = false, IdentityKeyFormat keyFormat = IdentityKeyFormat.base64}) → Future<IdentityInfo>

Returns the current status and metadata of an enrolled identity.

isDeviceSecure() → Future<bool>

Returns true if the device has a secure lock (passcode, pattern, or biometrics) enabled.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

revokeAllIdentities() → Future<bool>

Revokes (deletes) all enrolled identities created by this plugin.

revokeIdentity({String? keyAlias}) → Future<bool>

Revokes (deletes) a specific enrolled identity.

signPayload({required String payload, String? keyAlias, IdentitySignatureConfig? config, IdentitySignatureFormat signatureFormat = IdentitySignatureFormat.base64, IdentityKeyFormat keyFormat = IdentityKeyFormat.base64, String? promptMessage}) → Future<IdentitySignatureResult>

Signs a string payload using an enrolled identity.

signPayloadBytes({required Uint8List payload, String? keyAlias, IdentitySignatureConfig? config, IdentitySignatureFormat signatureFormat = IdentitySignatureFormat.base64, IdentityKeyFormat keyFormat = IdentityKeyFormat.base64, String? promptMessage}) → Future<IdentitySignatureResult>

Signs raw bytes using an enrolled identity.

toString() → String

A string representation of this object.

inherited

verifyPresence({required String promptMessage, PresencePromptConfig? config}) → Future<PresencePromptResult>

Performs a simple biometric presence check without using cryptographic keys.

Operators

operator ==(Object other) → bool

The equality operator.

inherited