io.vertx.ext.auth.webauthn.impl

Class WebAuthnImpl

java.lang.Object

io.vertx.ext.auth.webauthn.impl.WebAuthnImpl

All Implemented Interfaces:

AuthenticationProvider, WebAuthn

public class WebAuthnImpl
extends Object
implements WebAuthn

Constructor Summary

Constructors

Constructor and Description
WebAuthnImpl(Vertx vertx, WebAuthnOptions options)

Method Summary

Modifier and Type	Method and Description
void	authenticate(Credentials credentials, Handler<AsyncResult<User>> handler) Authenticate a user.
void	authenticate(JsonObject authInfo, Handler<AsyncResult<User>> handler) Authenticate a user.
WebAuthn	authenticatorFetcher(Function<Authenticator,Future<List<Authenticator>>> fetcher) Provide a Function that can fetch Authenticators from a backend given the incomplete Authenticator argument.
WebAuthn	authenticatorUpdater(Function<Authenticator,Future<Void>> updater) Provide a Function that can update or insert a Authenticator.
WebAuthn	createCredentialsOptions(JsonObject user, Handler<AsyncResult<JsonObject>> handler) Gets a challenge and any other parameters for the navigator.credentials.create() call.
WebAuthn	getCredentialsOptions(String name, Handler<AsyncResult<JsonObject>> handler) Creates an assertion challenge and any other parameters for the navigator.credentials.get() call.
MetaDataService	metaDataService() Internal API not fully ready for prime time

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.ext.auth.webauthn.WebAuthn

create, create, createCredentialsOptions, getCredentialsOptions

Methods inherited from interface io.vertx.ext.auth.authentication.AuthenticationProvider

authenticate, authenticate

Constructor Detail

WebAuthnImpl

public WebAuthnImpl(Vertx vertx,
                    WebAuthnOptions options)

Method Detail

authenticatorFetcher

public WebAuthn authenticatorFetcher(Function<Authenticator,Future<List<Authenticator>>> fetcher)

Description copied from interface: WebAuthn

Provide a Function that can fetch Authenticators from a backend given the incomplete Authenticator argument. The implementation must consider the following fields exclusively, while performing the lookup:

• Authenticator.getUserName()
• Authenticator.getCredID() ()}

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<List<Authenticator>>>

• Authenticator the incomplete authenticator data to lookup.
• Futureasync result with a list of authenticators.

Specified by:

authenticatorFetcher in interface WebAuthn

Parameters:

fetcher - fetcher function.

Returns:

fluent self.

authenticatorUpdater

public WebAuthn authenticatorUpdater(Function<Authenticator,Future<Void>> updater)

Description copied from interface: WebAuthn

Provide a Function that can update or insert a 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.getCounter(), 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<Void>

• Authenticator the authenticator data to update.
• Futureasync result of the operation.

Specified by:

authenticatorUpdater in interface WebAuthn

Parameters:

updater - updater function.

Returns:

fluent self.

createCredentialsOptions

public WebAuthn createCredentialsOptions(JsonObject user,
                                         Handler<AsyncResult<JsonObject>> handler)

Description copied from interface: WebAuthn

Gets a challenge and any other parameters for the navigator.credentials.create() call. The object being returned is described here https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptions

Specified by:

createCredentialsOptions in interface WebAuthn

Parameters:

user - - the user object with name and optionally displayName and icon

handler - server encoded make credentials request

Returns:

fluent self

getCredentialsOptions

public WebAuthn getCredentialsOptions(String name,
                                      Handler<AsyncResult<JsonObject>> handler)

Description copied from interface: WebAuthn

Creates an assertion challenge and any other parameters for the 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-publickeycredentialcreationoptions

Specified by:

getCredentialsOptions in interface WebAuthn

Parameters:

name - the unique user identified

handler - server encoded get assertion request

Returns:

fluent self.

authenticate

public void authenticate(JsonObject authInfo,
                         Handler<AsyncResult<User>> handler)

Description copied from interface: AuthenticationProvider

Authenticate a user.

The 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 User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authInfo - The credentials

handler - The result handler

authenticate

public void authenticate(Credentials credentials,
                         Handler<AsyncResult<User>> handler)

Description copied from interface: AuthenticationProvider

Authenticate a user.

The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation. If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation.

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

credentials - The credentials

handler - The result handler

metaDataService

public MetaDataService metaDataService()

Internal API not fully ready for prime time

Specified by:

metaDataService in interface WebAuthn

Returns:

the MDS instance.