PasskeyAuth<Request, Response> class
Enables passkey based registration and authentication. Entrypoint of the Flutter passkeys package.
Generic type Request indicates the type that has to be provided to
get registration and authentication going.
Generic type Response indicates the type that will be returned after
successful registration or authentication.
Both types depend on how RelyingPartyServer works.
PasskeyAuth connects PasskeyAuthenticator (WebAuthn Authenticator) and RelyingPartyServer (WebAuthn relying party server)
The PasskeyAuthenticator depends on the platform (e.g. iOS, Android, web). Currently this package contains implementations for iOS and Android.
The RelyingPartyServer implementation depends on the relying party server. This package comes with an implementation that enables usage of the Corbado backend as a relying party server. Additional backends can be setup easily though by implementing RelyingPartyServer.
Constructors
-
PasskeyAuth(RelyingPartyServer<
Request, Response> _backend) - Constructor
Properties
- authenticator → PasskeyAuthenticator
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
authenticateWithAutocompletion(
{required Request request, required Future< void> callback(Response)}) → Future<SignInHandler> - Sign in an existing user using a passkey. While authenticateWithEmail can also be used to do this authenticateWithAutocompletion is the better way and should be used by default because it is more convenient for the user.
-
authenticateWithEmail(
Request request) → Future< Response?> - Sign in an existing user using a passkey.
-
isSupported(
) → Future< bool> - Determines if passkeys are supported on the current platform by checking if an authenticator is available.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerWithEmail(
Request request) → Future< Response?> - Implements the registration flow.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited