Class TotpAuth

java.lang.Object
io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider
io.vertx.rxjava3.ext.auth.otp.totp.TotpAuth
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class TotpAuth extends AuthenticationProvider implements io.vertx.lang.rx.RxDelegate
An extension of AuthProvider which uses the one time passwords based on time to perform authentication.

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

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<TotpAuth> __TYPE_ARG

  • Constructor Details

    • TotpAuth

      public TotpAuth(TotpAuth delegate)

    • TotpAuth

      public TotpAuth(Object delegate)

  • Method Details

    • 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

    • getDelegate

      public TotpAuth getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Overrides:
      getDelegate in class AuthenticationProvider

    • authenticatorFetcher

      public TotpAuth authenticatorFetcher(Function<String, Single<Authenticator>> fetcher)
      Provide a that can fetch s from a backend given an identifier argument.

      The function signature is as follows:

      (id) -> Future

      • id the identifier to lookup.
      • async result with a authenticator.
      Parameters:
      fetcher - fetcher function.
      Returns:
      fluent self.

    • authenticatorUpdater

      public TotpAuth authenticatorUpdater(Function<Authenticator, Completable> updater)
      Provide a that can update or insert a . The function should store a given authenticator to a persistence storage.

      When an authenticator is already present, this method must at least update , 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

      • the authenticator data to update.
      • async result of the operation.
      Parameters:
      updater - updater function.
      Returns:
      fluent self.

    • createAuthenticator

      public Single<Authenticator> createAuthenticator(String id, OtpKey otpKey)
      Creating authenticator from user id and key.
      Parameters:
      id - id user.
      otpKey - key of user used for auth.
      Returns:
      an object containing all the necessary information to authenticate a user.

    • rxCreateAuthenticator

      public Single<Authenticator> rxCreateAuthenticator(String id, OtpKey otpKey)
      Creating authenticator from user id and key.
      Parameters:
      id - id user.
      otpKey - key of user used for auth.
      Returns:
      an object containing all the necessary information to authenticate a user.

    • generateUri

      public String generateUri(OtpKey otpKey, String issuer, String user, String label)
      Creating URI for register in key in user device.
      Parameters:
      otpKey - user key.
      issuer - issuer of key.
      user - display name of user account.
      label - the label to identify which account a key is associated with.
      Returns:
      uri containing the key.

    • generateUri

      public String generateUri(OtpKey otpKey, String issuer, String user)
      Creating URI for register in key in user device.
      Parameters:
      otpKey - user key.
      issuer - issuer of key.
      user - display name of user account.
      Returns:
      uri containing the key.

    • generateUri

      public String generateUri(OtpKey otpKey, String label)
      Creating URI for register in key in user device.
      Parameters:
      otpKey - user key.
      label - the label to identify which account a key is associated with.
      Returns:
      uri containing the key.

    • create

      public static TotpAuth create()
      Creates an instance of TotpAuth.
      Returns:
      the created instance of TotpAuth.

    • create

      public static TotpAuth create(TotpAuthOptions totpAuthOptions)
      Creates an instance of TotpAuth.
      Parameters:
      totpAuthOptions - the config.
      Returns:
      the created instance of TotpAuth.

    • newInstance

      public static TotpAuth newInstance(TotpAuth arg)