@nauth-toolkit/mfa-sms

SMS one-time code MFA provider for nauth-toolkit.

Sends verification codes via SMS for multi-factor authentication. Requires an SMS provider (@nauth-toolkit/sms-aws-sns or @nauth-toolkit/sms-console for development).

Documentation · GitHub

Part of nauth-toolkit. Requires @nauth-toolkit/core and an SMS provider.

Install

npm install @nauth-toolkit/mfa-sms @nauth-toolkit/sms-console

Enable in your auth config:

import { MFAMethod } from '@nauth-toolkit/core';

const authConfig = {
  mfa: {
    enabled: true,
    allowedMethods: [MFAMethod.SMS],
  },
};

NestJS — import the module and it auto-registers:

import { SMSMFAModule } from '@nauth-toolkit/mfa-sms/nestjs';

@Module({
  imports: [NAuthModule.forRoot(authConfig), SMSMFAModule],
})
export class AuthModule {}

Related packages

| Package | Purpose | | --- | --- | | @nauth-toolkit/sms-aws-sns | AWS SNS — production SMS delivery | | @nauth-toolkit/sms-console | Console logging — development use | | @nauth-toolkit/mfa-totp | TOTP authenticator apps | | @nauth-toolkit/mfa-email | Email verification codes |

See the full package list in the core README.

Free to use. See license.