Class HotpAuth
- java.lang.Object
-
- io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider
-
- io.vertx.rxjava3.ext.auth.otp.hotp.HotpAuth
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class HotpAuth extends AuthenticationProvider implements io.vertx.lang.rx.RxDelegate
An extension of AuthProvider which uses the one time passwords based on counter to perform authentication.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HotpAuth>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HotpAuthauthenticatorFetcher(Function<String,Single<Authenticator>> fetcher)Provide a that can fetch s from a backend given anidentifierargument.HotpAuthauthenticatorUpdater(Function<Authenticator,Completable> updater)Provide a that can update or insert a .static HotpAuthcreate()Creates an instance of HotpAuth.static HotpAuthcreate(HotpAuthOptions hotpAuthOptions)Creates an instance of HotpAuth.Single<Authenticator>createAuthenticator(String id, OtpKey otpKey)Creating authenticator from user id and key.booleanequals(Object o)StringgenerateUri(OtpKey otpKey, String label)Creating URI for register in key in user device.StringgenerateUri(OtpKey otpKey, String issuer, String user)Creating URI for register in key in user device.StringgenerateUri(OtpKey otpKey, String issuer, String user, String label)Creating URI for register in key in user device.HotpAuthgetDelegate()inthashCode()static HotpAuthnewInstance(HotpAuth arg)Single<Authenticator>rxCreateAuthenticator(String id, OtpKey otpKey)Creating authenticator from user id and key.StringtoString()-
Methods inherited from class io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider
authenticate, newInstance, rxAuthenticate
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HotpAuth> __TYPE_ARG
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toStringin classAuthenticationProvider
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classAuthenticationProvider
-
hashCode
public int hashCode()
- Overrides:
hashCodein classAuthenticationProvider
-
getDelegate
public HotpAuth getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Overrides:
getDelegatein classAuthenticationProvider
-
authenticatorFetcher
public HotpAuth authenticatorFetcher(Function<String,Single<Authenticator>> fetcher)
Provide a that can fetch s from a backend given anidentifierargument.The function signature is as follows:
(id) -> Futureidthe identifier to lookup.- async result with a authenticator.
- Parameters:
fetcher- fetcher function.- Returns:
- fluent self.
-
authenticatorUpdater
public HotpAuth 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 HotpAuth create()
Creates an instance of HotpAuth.- Returns:
- the created instance of
HotpAuth.
-
create
public static HotpAuth create(HotpAuthOptions hotpAuthOptions)
Creates an instance of HotpAuth.- Parameters:
hotpAuthOptions- the config.- Returns:
- the created instance of
HotpAuth.
-
-