public interface OtpAuthHandler extends AuthenticationHandler
Modifier and Type | Method and Description |
---|---|
static OtpAuthHandler |
create(HotpAuth hotpAuth)
Create a new instance of this handler using a hash based one time password authentication provider.
|
static OtpAuthHandler |
create(TotpAuth totpAuth)
Create a new instance of this handler using a time based one time password authentication provider.
|
OtpAuthHandler |
issuer(String issuer)
Configure the
issuer value to be shown in the authenticator URL. |
OtpAuthHandler |
label(String label)
Configure the
label value to be shown in the authenticator URL. |
OtpAuthHandler |
setupCallback(Route route)
Setup the required route where authenticators to submit the challenge response.
|
OtpAuthHandler |
setupRegisterCallback(Route route)
Setup the optional route where authenticators are allowed to register.
|
OtpAuthHandler |
verifyUrl(String url)
Specify the URL where requests are to be redirected when a user is already known in the request.
|
static OtpAuthHandler create(TotpAuth totpAuth)
totpAuth
- the time based OTP provider.static OtpAuthHandler create(HotpAuth hotpAuth)
hotpAuth
- the hash based OTP provider.OtpAuthHandler verifyUrl(String url)
RoutingContext.user()
is not null
.
If no redirect is provided, requests are terminated immediately with status code 401
.url
- the location where users are to be asked for the OTP code.OtpAuthHandler setupRegisterCallback(Route route)
RoutingContext.user()
is not null
.route
- the location where users are to register new authenticator devices/apps.OtpAuthHandler setupCallback(Route route)
RoutingContext.user()
is not null
.route
- the location where users are to submit challenge responses from authenticator devices/apps.OtpAuthHandler issuer(String issuer)
issuer
value to be shown in the authenticator URL.issuer
- a String
for example Vert.x OTP
OtpAuthHandler label(String label)
label
value to be shown in the authenticator URL. When this value is provided it will
overwrite the default label which is composed of the issuer
and the current user
id.label
- a String
for example Vert.x OTP
Copyright © 2023 Eclipse. All rights reserved.