Package io.vertx.mutiny.ext.auth.webauthn

Class WebAuthn

java.lang.Object
io.vertx.mutiny.ext.auth.authentication.AuthenticationProvider
io.vertx.mutiny.ext.auth.webauthn.WebAuthn
All Implemented Interfaces:
MutinyDelegate
public class WebAuthn extends AuthenticationProvider implements MutinyDelegate
Factory interface for creating WebAuthN based AuthenticationProvider instances.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • WebAuthn

      public WebAuthn(io.vertx.ext.auth.webauthn.WebAuthn delegate)

    • WebAuthn

      public WebAuthn(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.webauthn.WebAuthn getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Overrides:
      getDelegate in class AuthenticationProvider
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class AuthenticationProvider

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AuthenticationProvider

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AuthenticationProvider

    • create

      public static WebAuthn create(Vertx vertx)
      Parameters:
      vertx - the Vertx instance.
      Returns:
      the auth provider.

    • create

      public static WebAuthn create(Vertx vertx, io.vertx.ext.auth.webauthn.WebAuthnOptions options)
      Parameters:
      vertx - the Vertx instance.
      options - the custom options to the provider.
      Returns:
      the auth provider.

    • createCredentialsOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonObject> createCredentialsOptions(io.vertx.core.json.JsonObject user)
      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

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      user - - the user object with name and optionally displayName and icon
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • createCredentialsOptionsAndAwait

      public io.vertx.core.json.JsonObject createCredentialsOptionsAndAwait(io.vertx.core.json.JsonObject user)
      Blocking variant of createCredentialsOptions(JsonObject).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      user - - the user object with name and optionally displayName and icon
      Returns:
      the JsonObject instance produced by the operation.

    • createCredentialsOptionsAndForget

      public WebAuthn createCredentialsOptionsAndForget(io.vertx.core.json.JsonObject user)
      Variant of createCredentialsOptions(JsonObject) that ignores the result of the operation.

      This method subscribes on the result of createCredentialsOptions(JsonObject), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createCredentialsOptions(JsonObject) but you don't need to compose it with other operations.

      Parameters:
      user - - the user object with name and optionally displayName and icon
      Returns:
      the instance of WebAuthn to chain method calls.

    • getCredentialsOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonObject> getCredentialsOptions(String name)
      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

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      name - the unique user identified
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • getCredentialsOptionsAndAwait

      public io.vertx.core.json.JsonObject getCredentialsOptionsAndAwait(String name)
      Blocking variant of getCredentialsOptions(String).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      name - the unique user identified
      Returns:
      the JsonObject instance produced by the operation.

    • getCredentialsOptionsAndForget

      public WebAuthn getCredentialsOptionsAndForget(String name)
      Variant of getCredentialsOptions(String) that ignores the result of the operation.

      This method subscribes on the result of getCredentialsOptions(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from getCredentialsOptions(String) but you don't need to compose it with other operations.

      Parameters:
      name - the unique user identified
      Returns:
      the instance of WebAuthn to chain method calls.

    • authenticatorFetcher

      public WebAuthn authenticatorFetcher(Function<io.vertx.ext.auth.webauthn.Authenticator,io.smallrye.mutiny.Uni<List<io.vertx.ext.auth.webauthn.Authenticator>>> fetcher)
      Parameters:
      fetcher - fetcher function.
      Returns:
      fluent self.

    • authenticatorUpdater

      public WebAuthn authenticatorUpdater(Function<io.vertx.ext.auth.webauthn.Authenticator,io.smallrye.mutiny.Uni<Void>> updater)
      Parameters:
      updater - updater function.
      Returns:
      fluent self.

    • metaDataService

      public MetaDataService metaDataService()
      Returns:
      the MDS instance.

    • newInstance

      public static WebAuthn newInstance(io.vertx.ext.auth.webauthn.WebAuthn arg)