Class TwoFactorAuthService

constructor

• new TwoFactorAuthService(authSecrets, dependencies, config): TwoFactorAuthService

• Parameters

  • authSecrets: AuthSecrets

  • dependencies: {
        mailService: MailService;
        onetimeTokenService: OnetimeTokenService;
    }

    • mailService: MailService

    • onetimeTokenService: OnetimeTokenService

  • config: {
        codeConfig?: {
            expireTime?: string | number;
            length?: number;
        };
        emailConfig: {
            bodyTemplate: string;
            sender: string;
            subject: string;
        };
    }

    • Optional codeConfig?: {
          expireTime?: string | number;
          length?: number;
      }

      • Optional expireTime?: string | number

      • Optional length?: number

    • emailConfig: {
          bodyTemplate: string;
          sender: string;
          subject: string;
      }

      • bodyTemplate: string

      • sender: string

      • subject: string

  Returns TwoFactorAuthService

generateCode

• generateCode(tokenVerification, loginInfo): Promise<{
      code: string;
      token: string;
  }>

• Parameters

  • tokenVerification: TokenVerification

  • loginInfo: {
        fingerprint: string;
        userId: string;
    }

    • fingerprint: string

    • userId: string

  Returns Promise<{
      code: string;
      token: string;
  }>

regenerateToken

• regenerateToken(twoFactorAuthService, authSecrets, token, tokenVerification): Promise<{
      tokenData: {
          code: string;
          loginInfo: {
              fingerprint: string;
              userId: string;
          };
      };
      twoFactorAuth: {
          code: string;
          token: string;
      };
  }>

• Parameters

  • twoFactorAuthService: TwoFactorAuthService

  • authSecrets: AuthSecrets

  • token: string

  • tokenVerification: Partial<TokenVerification>

  Returns Promise<{
      tokenData: {
          code: string;
          loginInfo: {
              fingerprint: string;
              userId: string;
          };
      };
      twoFactorAuth: {
          code: string;
          token: string;
      };
  }>

sendMail

• sendMail(email, code): Promise<void>

• Parameters

  • email: string

  • code: string

  Returns Promise<void>

verifyCode

• verifyCode(__namedParameters): Promise<{
      fingerprint: string;
      userId: string;
  }>

• Parameters

  • __namedParameters: {
        code: string;
        token: string;
    }

    • code: string

    • token: string

  Returns Promise<{
      fingerprint: string;
      userId: string;
  }>

dependencies