Interface WebAuthn

    • Method Detail

      • create

        static WebAuthn create​(Vertx vertx)
        Create a WebAuthN auth provider
        Parameters:
        vertx - the Vertx instance.
        Returns:
        the auth provider.
      • create

        static WebAuthn create​(Vertx vertx,
                               WebAuthnOptions options)
        Create a WebAuthN auth provider
        Parameters:
        vertx - the Vertx instance.
        options - the custom options to the provider.
        Returns:
        the auth provider.
      • getCredentialsOptions

        Future<JsonObject> getCredentialsOptions​(String username)
        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

        Parameters:
        username - the unique user identified
        Returns:
        a future notified with the server encoded get assertion request
      • authenticatorFetcher

        WebAuthn authenticatorFetcher​(java.util.function.Function<Authenticator,​Future<List<Authenticator>>> fetcher)
        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:

        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.
        Parameters:
        fetcher - fetcher function.
        Returns:
        fluent self.
      • authenticatorUpdater

        WebAuthn authenticatorUpdater​(java.util.function.Function<Authenticator,​Future<Void>> updater)
        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>

        Parameters:
        updater - updater function.
        Returns:
        fluent self.
      • metaDataService

        MetaDataService metaDataService()
        Getter to the instance FIDO2 Meta Data Service.
        Returns:
        the MDS instance.