Passkey Provider

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

npm

npm install @nauth-toolkit/mfa-passkey

Yarn

yarn add @nauth-toolkit/mfa-passkey

pnpm

pnpm add @nauth-toolkit/mfa-passkey

Bun

bun add @nauth-toolkit/mfa-passkey

Exports

Export	Type	Entry
PasskeyMFAProviderService	Service	Default
PasskeyService	Service	Default
PasskeyMFAModule	NestJS Module	/nestjs

Configuration

Option	Type	Description
rpName	string	Relying party display name
rpId	string	Relying party ID (domain)
origin	string[]	Allowed origins
timeout	number	Timeout in milliseconds
userVerification	string	'preferred' | 'required' | 'discouraged'
authenticatorAttachment	string	'platform' | 'cross-platform' — restrict to built-in (FaceID/TouchID) or roaming (security key) authenticators

Usage

NestJS

import { PasskeyMFAModule } from '@nauth-toolkit/mfa-passkey/nestjs';

@Module({
  imports: [
    AuthModule.forRoot({
      mfa: {
        enabled: true,
        allowedMethods: [MFAMethod.PASSKEY],
        passkey: {
          rpName: 'My App',
          rpId: 'myapp.com',
          origin: ['https://myapp.com'],
          timeout: 60000,
          userVerification: 'preferred',
        },
      },
    }),
    PasskeyMFAModule,
  ],
})
export class AppModule {}

Express

const nauth = await NAuth.create({
  config: {
    mfa: {
      enabled: true,
      allowedMethods: [MFAMethod.PASSKEY],
      passkey: {
        rpName: 'My App',
        rpId: 'myapp.com',
        origin: ['https://myapp.com'],
        timeout: 60000,
        userVerification: 'preferred',
      },
    },
  },
  dataSource,
  adapter: new ExpressAdapter(),
});

Fastify

const nauth = await NAuth.create({
  config: {
    mfa: {
      enabled: true,
      allowedMethods: [MFAMethod.PASSKEY],
      passkey: {
        rpName: 'My App',
        rpId: 'myapp.com',
        origin: ['https://myapp.com'],
        timeout: 60000,
        userVerification: 'preferred',
      },
    },
  },
  dataSource,
  adapter: new FastifyAdapter(),
});

Setup Flow

1. Call mfaService.setupDevice(userId, 'passkey')
2. Returns WebAuthn registration options
3. Browser creates credential
4. Submit attestation to complete setup

Related

• MFAService
• MFA