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(io.vertx.ext.auth.webauthn.WebAuthn delegate) |
| Modifier and Type | Method and Description |
|---|---|
void |
authenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo)
Authenticate a user.
|
void |
authenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo,
Handler<AsyncResult<User>> handler)
Authenticate a user.
|
static WebAuthn |
create(Vertx vertx,
CredentialStore store)
Create a WebAuthN auth provider
|
static WebAuthn |
create(Vertx vertx,
io.vertx.ext.auth.webauthn.WebAuthnOptions options,
CredentialStore store)
Create a WebAuthN auth provider
|
WebAuthn |
createCredentialsOptions(JsonObject user)
Generates makeCredentials request
|
WebAuthn |
createCredentialsOptions(JsonObject user,
Handler<AsyncResult<JsonObject>> handler)
Generates makeCredentials request
|
boolean |
equals(Object o) |
WebAuthn |
getCredentialsOptions(String username)
Generates getAssertion request.
|
WebAuthn |
getCredentialsOptions(String username,
Handler<AsyncResult<JsonObject>> handler)
Generates getAssertion request.
|
io.vertx.ext.auth.webauthn.WebAuthn |
getDelegate() |
int |
hashCode() |
static WebAuthn |
newInstance(io.vertx.ext.auth.webauthn.WebAuthn arg) |
Single<User> |
rxAuthenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo)
Authenticate a user.
|
Single<JsonObject> |
rxCreateCredentialsOptions(JsonObject user)
Generates makeCredentials request
|
Single<JsonObject> |
rxGetCredentialsOptions(String username)
Generates getAssertion request.
|
String |
toString() |
newInstancepublic static final io.vertx.lang.rx.TypeArg<WebAuthn> __TYPE_ARG
public String toString()
toString in class AuthenticationProviderpublic boolean equals(Object o)
equals in class AuthenticationProviderpublic int hashCode()
hashCode in class AuthenticationProviderpublic io.vertx.ext.auth.webauthn.WebAuthn getDelegate()
getDelegate in class AuthenticationProviderpublic static WebAuthn create(Vertx vertx, CredentialStore store)
vertx - the Vertx instance.store - the user store used to load credentials.public static WebAuthn create(Vertx vertx, io.vertx.ext.auth.webauthn.WebAuthnOptions options, CredentialStore store)
vertx - the Vertx instance.options - the custom options to the provider.store - the user store used to load credentials.public WebAuthn createCredentialsOptions(JsonObject user, Handler<AsyncResult<JsonObject>> handler)
user - - the user object with username, displayNamehandler - server encoded make credentials requestpublic WebAuthn createCredentialsOptions(JsonObject user)
user - - the user object with username, displayNamepublic Single<JsonObject> rxCreateCredentialsOptions(JsonObject user)
user - - the user object with username, displayNamepublic WebAuthn getCredentialsOptions(String username, Handler<AsyncResult<JsonObject>> handler)
RequireResidentKey and
the username is null then the generated assertion will be a RK assertion (Usernameless).username - the unique user identifiedhandler - server encoded get assertion requestpublic WebAuthn getCredentialsOptions(String username)
RequireResidentKey and
the username is null then the generated assertion will be a RK assertion (Usernameless).username - the unique user identifiedpublic Single<JsonObject> rxGetCredentialsOptions(String username)
RequireResidentKey and
the username is null then the generated assertion will be a RK assertion (Usernameless).username - the unique user identifiedpublic void authenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo,
Handler<AsyncResult<User>> handler)
AuthenticationProviderThe first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:
{
"username": "tim",
"password": "mypassword"
}
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.
authenticate in class AuthenticationProviderauthInfo - The credentialshandler - The result handlerpublic void authenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo)
AuthenticationProviderThe first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:
{
"username": "tim",
"password": "mypassword"
}
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.
authenticate in class AuthenticationProviderauthInfo - The credentialspublic Single<User> rxAuthenticate(io.vertx.ext.auth.webauthn.WebAuthnCredentials authInfo)
AuthenticationProviderThe first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:
{
"username": "tim",
"password": "mypassword"
}
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
If the user is successfully authenticated a object is passed to the handler in an . The user object can then be used for authorisation.
rxAuthenticate in class AuthenticationProviderauthInfo - The credentialspublic static WebAuthn newInstance(io.vertx.ext.auth.webauthn.WebAuthn arg)
Copyright © 2020 Eclipse. All rights reserved.