Class OtpTwoFactorMethod

One Time Password Two Factor Method.

Implements

TwoFactorMethod<never, OtpConfirmRegisterData>

Index

Constructors

Methods

confirmRegisterForUser init requestRegisterForUser unregisterForUser validate

Constructors

constructor

new OtpTwoFactorMethod(
otpHeader: KnownHeader,
otpLength: number,
): OtpTwoFactorMethod
Parameters
- otpHeader: KnownHeader
- otpLength: number
Returns OtpTwoFactorMethod
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:34

Methods

confirmRegisterForUser

confirmRegisterForUser<Role extends string, UserType extends BaseUser<Role>>(
user: UserType,
data: OtpConfirmRegisterData,
): Promise<void>
Confirms the registration of the two factor method for the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
Parameters
- user: UserType
- data: OtpConfirmRegisterData
Returns Promise<void>
Implementation of TwoFactorMethod.confirmRegisterForUser
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:63

init

init(): void
Initializes the two factor method.

Returns void
Implementation of TwoFactorMethod.init
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:42

requestRegisterForUser

requestRegisterForUser<Role extends string, UserType extends BaseUser<Role>>(
user: UserType,
): Promise<void>
Requests to register the two factor method for the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
Parameters
- user: UserType
Returns Promise<void>
Implementation of TwoFactorMethod.requestRegisterForUser
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:54

unregisterForUser

unregisterForUser<Role extends string, UserType extends BaseUser<Role>>(
user: UserType,
): Promise<void>
Removes the two factor method from the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
Parameters
- user: UserType
Returns Promise<void>
Implementation of TwoFactorMethod.unregisterForUser
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:79

validate

validate<Role extends string, UserType extends BaseUser<Role>>(
user: UserType,
request: HttpRequest | WebsocketRequest,
): Promise<void>
Validates that the given request has a valid second factor.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
Parameters
- user: UserType
- request: HttpRequest | WebsocketRequest
Returns Promise<void>
Implementation of TwoFactorMethod.validate
- Defined in src/auth/2fa/methods/otp/otp.two-factor-method.ts:84