Email MFA Provider

Package: @nauth-toolkit/mfa-email Type: MFA Provider

npm

npm install @nauth-toolkit/mfa-email

Yarn

yarn add @nauth-toolkit/mfa-email

pnpm

pnpm add @nauth-toolkit/mfa-email

Bun

bun add @nauth-toolkit/mfa-email

Exports

Export	Type	Entry
EmailMFAProviderService	Service	Default
EmailMFAModule	NestJS Module	/nestjs

Requirements

Requires an email provider configured:

• @nauth-toolkit/email-nodemailer

Usage

NestJS

import { EmailMFAModule } from '@nauth-toolkit/mfa-email/nestjs';
import { NodemailerEmailProvider } from '@nauth-toolkit/email-nodemailer';

@Module({
  imports: [
    AuthModule.forRoot({
      mfa: {
        enabled: true,
        allowedMethods: [MFAMethod.EMAIL],
      },
      emailProvider: new NodemailerEmailProvider({ ... }),
    }),
    EmailMFAModule,
  ],
})
export class AppModule {}

Express

import { NodemailerEmailProvider } from '@nauth-toolkit/email-nodemailer';

const nauth = await NAuth.create({
  config: {
    mfa: {
      enabled: true,
      allowedMethods: [MFAMethod.EMAIL],
    },
    emailProvider: new NodemailerEmailProvider({
      transport: { host: 'smtp.example.com', port: 587, auth: { user, pass } },
    }),
  },
  dataSource,
  adapter: new ExpressAdapter(),
});

Fastify

import { NodemailerEmailProvider } from '@nauth-toolkit/email-nodemailer';

const nauth = await NAuth.create({
  config: {
    mfa: {
      enabled: true,
      allowedMethods: [MFAMethod.EMAIL],
    },
    emailProvider: new NodemailerEmailProvider({
      transport: { host: 'smtp.example.com', port: 587, auth: { user, pass } },
    }),
  },
  dataSource,
  adapter: new FastifyAdapter(),
});

Setup Flow

1. User must have verified email
2. Call mfaService.setupDevice(userId, 'email')
3. Code sent to email
4. User submits code to verify

Related

• MFAService
• Email
• MFA