@adminforth/two-factors-auth 4.5.0 → 4.6.0

package/tests/mfaRequestContext.test.mjs

@@ -0,0 +1,79 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import { MfaRequestContext } from '../dist/services/mfaRequestContext.js';
+const user = { pk: 'user-1' };
+
+test('without external context normal browser verification is unaffected', async () => {
+  const context = new MfaRequestContext();
+  assert.equal(await context.verify(user, undefined, () => assert.fail('verification must not run')), undefined);
+});
+
+test('missing verification stops a CRUD hook before it can strip the error code', async () => {
+  const context = new MfaRequestContext();
+  let written = false;
+  const result = await context.run(undefined, {}, async () => {
+    await context.verify(user, undefined, async () => ({ error: 'Required', code: 'TWO_FACTOR_REQUIRED' }));
+    written = true;
+    return { ok: true };
+  });
+  assert.equal(written, false);
+  assert.equal(result.code, 'TWO_FACTOR_REQUIRED');
+});
+
+test('a failed verification carries the action description for the confirmation page', async () => {
+  const context = new MfaRequestContext();
+  const result = await context.run(undefined, {}, async () => {
+    await context.verify(user, 'Approve $100,000 bonus', async () => ({ error: 'Required', code: 'TWO_FACTOR_REQUIRED' }));
+  });
+  assert.deepEqual(result, { error: 'Required', code: 'TWO_FACTOR_REQUIRED', actionDescription: 'Approve $100,000 bonus' });
+});
+
+test('invalid TOTP or passkey cannot reach the mutation', async () => {
+  for (const mode of ['totp', 'passkey']) {
+    const context = new MfaRequestContext();
+    const result = await context.run({ mode, result: 'invalid' }, {}, async () => {
+      await context.verify(user, undefined, async () => ({ error: 'Invalid', code: 'TWO_FACTOR_INVALID' }));
+      assert.fail('mutation must not execute');
+    });
+    assert.equal(result.code, 'TWO_FACTOR_INVALID');
+  }
+});
+
+test('valid verification is reused only within the same request and user', async () => {
+  const context = new MfaRequestContext();
+  const token = { mode: 'totp', result: '123456' };
+  const extra = { cookies: [{ key: 'session', value: 'browser' }] };
+  let checks = 0;
+  const verify = async (result, passedExtra) => { checks++; assert.equal(result, token); assert.equal(passedExtra, extra); return { ok: true }; };
+  const run = () => context.run(token, extra, async () => {
+    await context.verify(user, undefined, verify);
+    await context.verify(user, undefined, verify);
+    await context.verify({ pk: 'other-user' }, undefined, verify);
+    return { ok: true };
+  });
+  await run();
+  assert.equal(checks, 2);
+  await run();
+  assert.equal(checks, 4);
+});
+
+test('concurrent requests do not share verification or cookies', async () => {
+  const context = new MfaRequestContext();
+  const run = (token, cookie, code) => context.run(token, { cookie }, async () => {
+    await context.verify(user, undefined, async (received, extra) => {
+      await new Promise(resolve => setTimeout(resolve, 1));
+      assert.equal(received, token);
+      assert.equal(extra.cookie, cookie);
+      return code ? { error: 'Required', code } : { ok: true };
+    });
+    return { ok: true };
+  });
+  const [accepted, rejected] = await Promise.all([run('valid', 'a'), run(undefined, 'b', 'TWO_FACTOR_REQUIRED')]);
+  assert.equal(accepted.ok, true);
+  assert.equal(rejected.code, 'TWO_FACTOR_REQUIRED');
+});
+
+test('unrelated execution errors propagate to MCP', async () => {
+  const context = new MfaRequestContext();
+  await assert.rejects(context.run(undefined, {}, async () => { throw new Error('DB error'); }), /DB error/);
+});

package/tests/totpService.test.mjs

@@ -0,0 +1,38 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import twofactor from 'node-2fa';
+import { TotpService } from '../dist/services/totpService.js';
+import { TwoFactorErrorCode } from '../dist/utils/errors.js';
+
+const SECRET = 'JBSWY3DPEHPK3PXP';
+const userRepository = { getAuthUser: async (pk) => ({ pk }), getSecret: () => SECRET, getUserPk: (adminUser) => adminUser.pk };
+
+function createService() {
+  const jwts = new Map();
+  const auth = {
+    issueJWT: (payload, type) => {
+      const token = `jwt-${jwts.size}`;
+      jwts.set(token, { ...payload, type });
+      return token;
+    },
+    verify: async (token, type) => (jwts.get(token)?.type === type ? jwts.get(token) : null),
+  };
+  return new TotpService({ timeStepWindow: 1 }, userRepository, auth);
+}
+
+test('limits code attempts of each user to stop brute force of a stolen session', async () => {
+  const service = createService();
+  for (let attempt = 0; attempt < 30; attempt++) {
+    assert.equal((await service.verifyUserCode('user-1', 'wrong')).code, TwoFactorErrorCode.INVALID);
+  }
+  assert.equal((await service.verifyUserCode('user-1', 'wrong')).code, TwoFactorErrorCode.RATE_LIMITED);
+  assert.equal((await service.verifyUserCode('user-2', 'wrong')).code, TwoFactorErrorCode.INVALID);
+});
+
+test('a correct code gives a token that confirms the code only for its user', async () => {
+  const service = createService();
+  const { verifiedCodeToken } = await service.verifyAdminUserCode({ pk: 'user-1' }, twofactor.generateToken(SECRET).token);
+  assert.equal(await service.isVerifiedCodeToken(verifiedCodeToken, 'user-1'), true);
+  assert.equal(await service.isVerifiedCodeToken(verifiedCodeToken, 'user-2'), false);
+  assert.equal(await service.isVerifiedCodeToken('forged', 'user-1'), false);
+});

package/utils/errors.ts

@@ -9,6 +9,20 @@ export enum HttpStatus {
   INTERNAL_SERVER_ERROR = 500,
 }
 
+export enum TwoFactorErrorCode {
+  REQUIRED = 'TWO_FACTOR_REQUIRED',
+  INVALID = 'TWO_FACTOR_INVALID',
+  RATE_LIMITED = 'TWO_FACTOR_RATE_LIMITED',
+  NOT_SET_UP = 'TWO_FACTOR_NOT_SET_UP',
+  USER_NOT_FOUND = 'USER_NOT_FOUND',
+  UNSUPPORTED_MODE = 'UNSUPPORTED_CONFIRMATION_MODE',
+  BROWSER_CONTEXT_REQUIRED = 'BROWSER_CONTEXT_REQUIRED',
+  CANCELLED = 'VERIFICATION_CANCELLED',
+  TIMEOUT = 'VERIFICATION_TIMEOUT',
+  INVALID_SESSION = 'INVALID_VERIFICATION_SESSION',
+  INTERNAL_ERROR = 'INTERNAL_ERROR',
+}
+
 export function respondWithStatus<T>(body: T, response: IAdminForthHttpResponse, status: HttpStatus): T {
   response.setStatus(status);
   return body;

package/utils/types.ts

@@ -1,4 +1,5 @@
 import type { HttpExtra } from "adminforth";
+import type { TwoFactorErrorCode } from "./errors.js";
 
 export type AnyRecord = Record<string, any>;
 export type CookieList = HttpExtra["cookies"];
@@ -15,3 +16,6 @@ export type OkResponse<T extends AnyRecord = AnyRecord> = {
 } & T;
 
 export type PluginResponse<T extends AnyRecord = AnyRecord> = OkResponse<T> | ErrorResponse;
+
+export type VerificationFailure = { error: string; code: TwoFactorErrorCode };
+export type VerificationResult = { ok: true } | VerificationFailure;