public class WebAuthn extends AuthenticationProvider
AuthenticationProvider
instances.
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<WebAuthn> |
__TYPE_ARG |
Constructor and Description |
---|
WebAuthn(Object delegate) |
WebAuthn(WebAuthn delegate) |
Modifier and Type | Method and Description |
---|---|
WebAuthn |
authenticatorFetcher(java.util.function.Function<Authenticator,Future<List<Authenticator>>> fetcher)
Provide a that can fetch
Authenticator s from a backend given the incomplete
Authenticator argument. |
WebAuthn |
authenticatorFetcher(Function<Authenticator,Single<List<Authenticator>>> fetcher)
Provide a that can fetch
Authenticator s from a backend given the incomplete
Authenticator argument. |
WebAuthn |
authenticatorUpdater(Function<Authenticator,Completable> updater)
Provide a that can update or insert a
Authenticator . |
WebAuthn |
authenticatorUpdater(java.util.function.Function<Authenticator,Future<Void>> updater)
Provide a that can update or insert a
Authenticator . |
static WebAuthn |
create(Vertx vertx)
Create a WebAuthN auth provider
|
static WebAuthn |
create(Vertx vertx,
WebAuthnOptions options)
Create a WebAuthN auth provider
|
WebAuthn |
createCredentialsOptions(JsonObject user)
Gets a challenge and any other parameters for the
navigator.credentials.create() call. |
WebAuthn |
createCredentialsOptions(JsonObject user,
Handler<AsyncResult<JsonObject>> handler)
Gets a challenge and any other parameters for the
navigator.credentials.create() call. |
boolean |
equals(Object o) |
WebAuthn |
getCredentialsOptions(String name)
Creates an assertion challenge and any other parameters for the
navigator.credentials.get() call. |
WebAuthn |
getCredentialsOptions(String name,
Handler<AsyncResult<JsonObject>> handler)
Creates an assertion challenge and any other parameters for the
navigator.credentials.get() call. |
WebAuthn |
getDelegate() |
int |
hashCode() |
MetaDataService |
metaDataService()
Getter to the instance FIDO2 Meta Data Service.
|
static WebAuthn |
newInstance(WebAuthn arg) |
Single<JsonObject> |
rxCreateCredentialsOptions(JsonObject user)
Gets a challenge and any other parameters for the
navigator.credentials.create() call. |
Single<JsonObject> |
rxGetCredentialsOptions(String name)
Creates an assertion challenge and any other parameters for the
navigator.credentials.get() call. |
String |
toString() |
authenticate, authenticate, authenticate, authenticate, newInstance, rxAuthenticate, rxAuthenticate
public static final io.vertx.lang.rx.TypeArg<WebAuthn> __TYPE_ARG
public WebAuthn(WebAuthn delegate)
public WebAuthn(Object delegate)
public String toString()
toString
in class AuthenticationProvider
public boolean equals(Object o)
equals
in class AuthenticationProvider
public int hashCode()
hashCode
in class AuthenticationProvider
public WebAuthn getDelegate()
getDelegate
in class AuthenticationProvider
public static WebAuthn create(Vertx vertx)
vertx
- the Vertx instance.public static WebAuthn create(Vertx vertx, WebAuthnOptions options)
vertx
- the Vertx instance.options
- the custom options to the provider.public WebAuthn createCredentialsOptions(JsonObject user, Handler<AsyncResult<JsonObject>> handler)
navigator.credentials.create()
call.
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsuser
- - the user object with name and optionally displayName and iconhandler
- server encoded make credentials requestpublic WebAuthn createCredentialsOptions(JsonObject user)
navigator.credentials.create()
call.
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsuser
- - the user object with name and optionally displayName and iconpublic Single<JsonObject> rxCreateCredentialsOptions(JsonObject user)
navigator.credentials.create()
call.
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsuser
- - the user object with name and optionally displayName and iconpublic WebAuthn getCredentialsOptions(String name, Handler<AsyncResult<JsonObject>> handler)
navigator.credentials.get()
call.
If the auth provider is configured with RequireResidentKey
and the username is null then the
generated assertion will be a RK assertion (Usernameless).
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsname
- the unique user identifiedhandler
- server encoded get assertion requestpublic WebAuthn getCredentialsOptions(String name)
navigator.credentials.get()
call.
If the auth provider is configured with RequireResidentKey
and the username is null then the
generated assertion will be a RK assertion (Usernameless).
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsname
- the unique user identifiedpublic Single<JsonObject> rxGetCredentialsOptions(String name)
navigator.credentials.get()
call.
If the auth provider is configured with RequireResidentKey
and the username is null then the
generated assertion will be a RK assertion (Usernameless).
The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsname
- the unique user identifiedpublic WebAuthn authenticatorFetcher(java.util.function.Function<Authenticator,Future<List<Authenticator>>> fetcher)
Authenticator
s from a backend given the incomplete
Authenticator
argument.
The implementation must consider the following fields exclusively, while performing the lookup:
It may return more than 1 result, for example when a user can be identified using different modalities.
To signal that a user is not allowed/present on the system, a failure should be returned, not null
.
The function signature is as follows:
(Authenticator) -> Future>>
Authenticator
the incomplete authenticator data to lookup.fetcher
- fetcher function.public WebAuthn authenticatorFetcher(Function<Authenticator,Single<List<Authenticator>>> fetcher)
Authenticator
s from a backend given the incomplete
Authenticator
argument.
The implementation must consider the following fields exclusively, while performing the lookup:
It may return more than 1 result, for example when a user can be identified using different modalities.
To signal that a user is not allowed/present on the system, a failure should be returned, not null
.
The function signature is as follows:
(Authenticator) -> Future>>
Authenticator
the incomplete authenticator data to lookup.fetcher
- fetcher function.public WebAuthn authenticatorUpdater(java.util.function.Function<Authenticator,Future<Void>> updater)
Authenticator
.
The function should store a given authenticator to a persistence storage.
When an authenticator is already present, this method must at least update
Authenticator
, and is not required to perform any other update.
For new authenticators, the whole object data must be persisted.
The function signature is as follows:
(Authenticator) -> Future
Authenticator
the authenticator data to update.updater
- updater function.public WebAuthn authenticatorUpdater(Function<Authenticator,Completable> updater)
Authenticator
.
The function should store a given authenticator to a persistence storage.
When an authenticator is already present, this method must at least update
Authenticator
, and is not required to perform any other update.
For new authenticators, the whole object data must be persisted.
The function signature is as follows:
(Authenticator) -> Future
Authenticator
the authenticator data to update.updater
- updater function.public MetaDataService metaDataService()
Copyright © 2023 Eclipse. All rights reserved.