Class TwoFactorService

Default implementation of the two factor service.

Implements

TwoFactorServiceInterface

Index

Constructors

Properties

twoFactorMethods

Methods

confirmRegisterTwoFactorMethodForUser has2fa init requestRegisterTwoFactorMethodForUser unregisterTwoFactorMethodForUser

Constructors

constructor

new TwoFactorService(): TwoFactorService
Returns TwoFactorService
- Defined in src/auth/2fa/two-factor.service.ts:24

Properties

`Readonly`twoFactorMethods

twoFactorMethods: TwoFactorMethods = []

The different two factor methods provided.

Methods

confirmRegisterTwoFactorMethodForUser

confirmRegisterTwoFactorMethodForUser<
    Role extends string,
    UserType extends BaseUser<Role>,
    TwoFactorRequestRegisterData,
    TwoFactorConfirmRegisterData,
>(
    user: UserType,
    method: TwoFactorMethod<
        TwoFactorRequestRegisterData,
        TwoFactorConfirmRegisterData,
    >,
    data: TwoFactorConfirmRegisterData,
): Promise<void>
Confirms the registration of the given two factor method for the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
- TwoFactorRequestRegisterData
- TwoFactorConfirmRegisterData
Parameters
- user: UserType
- method: TwoFactorMethod<TwoFactorRequestRegisterData, TwoFactorConfirmRegisterData>
- data: TwoFactorConfirmRegisterData
Returns Promise<void>
Implementation of TwoFactorServiceInterface.confirmRegisterTwoFactorMethodForUser
- Defined in src/auth/2fa/two-factor.service.ts:60

has2fa

has2fa(
    user: BaseUser<string>,
    request: HttpRequest | WebsocketRequest,
    allowedMethods?: TwoFactorMethods,
): Promise<boolean>
Checks if the incoming request has some second factor.
Parameters
- user: BaseUser<string>
- request: HttpRequest | WebsocketRequest
- allowedMethods: TwoFactorMethods = ...
Returns Promise<boolean>
Implementation of TwoFactorServiceInterface.has2fa
- Defined in src/auth/2fa/two-factor.service.ts:87

init

init(twoFactorMethods: TwoFactorMethods): Promise<void>
Initializes the service.
Parameters
- twoFactorMethods: TwoFactorMethods
Returns Promise<void>
Implementation of TwoFactorServiceInterface.init
- Defined in src/auth/2fa/two-factor.service.ts:29

requestRegisterTwoFactorMethodForUser

requestRegisterTwoFactorMethodForUser<
    Role extends string,
    UserType extends BaseUser<Role>,
    TwoFactorRequestRegisterData,
    TwoFactorConfirmRegisterData,
>(
    user: UserType,
    method: TwoFactorMethod<
        TwoFactorRequestRegisterData,
        TwoFactorConfirmRegisterData,
    >,
    data: TwoFactorRequestRegisterData,
): Promise<void>
Requests the registration of the given two factor method for the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
- TwoFactorRequestRegisterData
- TwoFactorConfirmRegisterData
Parameters
- user: UserType
- method: TwoFactorMethod<TwoFactorRequestRegisterData, TwoFactorConfirmRegisterData>
- data: TwoFactorRequestRegisterData
Returns Promise<void>
Implementation of TwoFactorServiceInterface.requestRegisterTwoFactorMethodForUser
- Defined in src/auth/2fa/two-factor.service.ts:46

unregisterTwoFactorMethodForUser

unregisterTwoFactorMethodForUser<
    Role extends string,
    UserType extends BaseUser<Role>,
    TwoFactorRequestRegisterData,
    TwoFactorConfirmRegisterData,
>(
    user: UserType,
    method: TwoFactorMethod<
        TwoFactorRequestRegisterData,
        TwoFactorConfirmRegisterData,
    >,
): Promise<void>
Removes the given two factor method from the given user.
Type Parameters
- Role extends string
- UserType extends BaseUser<Role>
- TwoFactorRequestRegisterData
- TwoFactorConfirmRegisterData
Parameters
- user: UserType
- method: TwoFactorMethod<TwoFactorRequestRegisterData, TwoFactorConfirmRegisterData>
Returns Promise<void>
Implementation of TwoFactorServiceInterface.unregisterTwoFactorMethodForUser
- Defined in src/auth/2fa/two-factor.service.ts:74