Modules

Class EmailTwoFactorAuthStrategy

Two factor authentication strategy which sends token to user via email.
Generated token is stored in the AuthenticationSession.twoFactorAuthenticationToken property and is valid until AuthenticationSession expires or token is send by client and validated.

Hierarchy

EmailTwoFactorAuthStrategy

Implements

TwoFactorAuthStrategy<AccountModel>

Constructors

constructor

Methods

Constructors

constructor

new EmailTwoFactorAuthStrategy(options: EmailTwoFactorAuthStrategyOptions): EmailTwoFactorAuthStrategy

Parameters
- options: EmailTwoFactorAuthStrategyOptions
Returns EmailTwoFactorAuthStrategy

Methods

isAuthenticationTokenValid

isAuthenticationTokenValid(_account: AccountModel, authenticationContext: AuthenticationContext, authenticationSessionRepositoryHolder: AuthenticationSessionRepositoryHolder): Promise<boolean>

Implementation of TwoFactorAuthStrategy.isAuthenticationTokenValid

Verify 2FA authentication token.

Parameters
- _account: AccountModel
  
  User account.
- authenticationContext: AuthenticationContext
  
  Authentication context.
- authenticationSessionRepositoryHolder: AuthenticationSessionRepositoryHolder
  
  Authentication session repository holder.
Returns Promise<boolean>

onTwoFactorAuthEnabled

onTwoFactorAuthEnabled(): Promise<null>

Implementation of TwoFactorAuthStrategy.onTwoFactorAuthEnabled

Hook used by strategy in order to attach metadata to account when multi factor auth is enabled.

Returns Promise<null>

sendAuthenticationToken

sendAuthenticationToken(account: AccountModel, _authenticationContext: AuthenticationContext, authenticationSessionRepositoryHolder: AuthenticationSessionRepositoryHolder): Promise<void>

Implementation of TwoFactorAuthStrategy.sendAuthenticationToken

Send authentication token via side channel.

Parameters
- account: AccountModel
  
  User account.
- _authenticationContext: AuthenticationContext
  
  Authentication context.
- authenticationSessionRepositoryHolder: AuthenticationSessionRepositoryHolder
  
  Authentication session repository holder.
Returns Promise<void>