Skip to main content

Interface: MFAServiceConfig

Defined in: src/auth/mfa/mfa-service.ts:33

MFA service configuration.

Properties​

backupCodeCount?​

readonly optional backupCodeCount: number

Defined in: src/auth/mfa/mfa-service.ts:46

Number of backup codes to generate.

Default Value​

10

enrollmentExpirationSeconds?​

readonly optional enrollmentExpirationSeconds: number

Defined in: src/auth/mfa/mfa-service.ts:74

Enrollment expiration in seconds.

Default Value​

600 (10 minutes)

issuer?​

readonly optional issuer: string

Defined in: src/auth/mfa/mfa-service.ts:39

TOTP issuer name.

Default Value​

'Chive'

keyPrefix?​

readonly optional keyPrefix: string

Defined in: src/auth/mfa/mfa-service.ts:53

Redis key prefix.

Default Value​

'chive:mfa:'

lockoutDurationSeconds?​

readonly optional lockoutDurationSeconds: number

Defined in: src/auth/mfa/mfa-service.ts:67

Lockout duration in seconds.

Default Value​

900 (15 minutes)

maxAttempts?​

readonly optional maxAttempts: number

Defined in: src/auth/mfa/mfa-service.ts:60

Maximum verification attempts before lockout.

Default Value​

5

mfaRequiredRoles?​

readonly optional mfaRequiredRoles: readonly string[]

Defined in: src/auth/mfa/mfa-service.ts:79

Roles that require MFA.