Keypass class abstract interface

Immutable configuration for verified passkey-derived encryption material. Construction accesses no provider or device. Each call owns its backend; this client needs no disposal.

Constructors

Keypass.hardware({required String rpId, String? displayName, HardwarePinPrompt? requestPin, HardwareConnectionPicker? selectConnection, void onEvent(HardwareEvent)?})
Direct physical FIDO2 access, without a Keypass-operated service. RP ID scopes credentials; it does not authenticate the local executable. Handlers are configuration, never cached PINs or selected connections.
factory
Keypass.system({required String rpId, String? displayName})
Use the OS passkey provider and UI. Requires consumer app/domain setup.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

check({PasskeyCancellation? cancellation}) → Future<PasskeyReadiness>
Optional, prompt-free readiness to attempt access; not proof of PRF support. Does not reserve access. An overlapping operation can fail with busy. Cancellation waits for discovery to drain before releasing the backend.
create({required String label, PasskeyCancellation? cancellation}) → Future<PasskeyResult>
Create a credential and verify two matching secret evaluations. Generates the user handle, challenges and original PRF input. Failure after registration can leave a credential in the provider. Dispose the returned result in finally, including on persistence failure. Do not abandon the Future or use Future.timeout as cancellation: cancel the token and await settlement, disposing any successful result.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
unlock(PasskeyRecord record, {PasskeyCancellation? cancellation}) → Future<PasskeyResult>
Recover exactly this record's secret, with no enrollment or fallback. Rejects RP/route mismatches before any backend or UI is accessed. Persist the returned record's updated verification state transactionally. Do not abandon the Future or use Future.timeout as cancellation: cancel the token and await settlement, disposing any successful result.

Operators

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