fix(2fa): gate two-factor auth when the encryption key is missing

TWO_FACTOR_ENCRYPTION_KEY has no default, so instances upgrading to 3.3
without setting it hit an unhandled throw from encryptSecret: the setup
dialog only reported "Something went wrong", and where 2FA was required
the blocking dialog made the whole app unusable. The status endpoint now
reports 2FA as not required while the key is missing or invalid, and
setup initiation returns 503 with a two-factor-error-not-configured code
that the setup dialog renders as a readable message. Also documents the
variable in the README and the example compose file.

Closes #4443
This commit is contained in:
NoiceHax committed 2026-08-13 22:39:31 +05:30
1 parent de474a1da9
commit a40b418038
12 files changed
+182 -8

No files matched your search

+89
View File
@@ -0,0 +1,89 @@
import { beforeEach, expect, test, vi } from 'vitest';
import prisma from '@/lib/prisma';
import { parseRequest } from '@/lib/request';
import { GET } from './route';
const KEY = 'a'.repeat(64);
vi.mock('@/lib/request', () => ({
parseRequest: vi.fn(),
}));
vi.mock('@/lib/prisma', () => ({
default: {
client: {
twoFactorAuth: {
findUnique: vi.fn(),
},
appSetting: {
findUnique: vi.fn(),
},
user: {
findUnique: vi.fn(),
},
teamUser: {
findMany: vi.fn(),
},
team: {
findMany: vi.fn(),
},
},
},
}));
const parseRequestMock = vi.mocked(parseRequest);
const prismaMock = vi.mocked(prisma, true);
beforeEach(() => {
vi.unstubAllEnvs();
parseRequestMock.mockReset();
prismaMock.client.twoFactorAuth.findUnique.mockReset();
prismaMock.client.appSetting.findUnique.mockReset();
prismaMock.client.user.findUnique.mockReset();
prismaMock.client.teamUser.findMany.mockReset();
prismaMock.client.team.findMany.mockReset();
parseRequestMock.mockResolvedValue({
auth: {
user: {
id: 'user-1',
},
},
error: undefined,
});
prismaMock.client.twoFactorAuth.findUnique.mockResolvedValue(null as any);
prismaMock.client.appSetting.findUnique.mockResolvedValue({
key: 'twoFactorRequiredGlobal',
value: 'true',
} as any);
prismaMock.client.user.findUnique.mockResolvedValue({ twoFactorRequired: false } as any);
prismaMock.client.teamUser.findMany.mockResolvedValue([] as any);
prismaMock.client.team.findMany.mockResolvedValue([] as any);
});
test('GET requires 2FA when it is globally enabled', async () => {
vi.stubEnv('TWO_FACTOR_ENCRYPTION_KEY', KEY);
const response = await GET(new Request('http://localhost/api/2fa/status'));
await expect(response.json()).resolves.toEqual({
isEnabled: false,
isRequired: true,
requiredReason: 'global',
});
expect(response.status).toBe(200);
});
test('GET does not require 2FA when the encryption key is missing', async () => {
vi.stubEnv('TWO_FACTOR_ENCRYPTION_KEY', '');
const response = await GET(new Request('http://localhost/api/2fa/status'));
expect(prismaMock.client.appSetting.findUnique).not.toHaveBeenCalled();
await expect(response.json()).resolves.toEqual({
isEnabled: false,
isRequired: false,
requiredReason: null,
});
expect(response.status).toBe(200);
});
+6
View File
@@ -1,6 +1,7 @@
import prisma from '@/lib/prisma';
import { parseRequest } from '@/lib/request';
import { json } from '@/lib/response';
import { isTwoFactorConfigured } from '@/lib/two-factor/crypto';
export async function GET(request: Request) {
const { auth, error } = await parseRequest(request);
@@ -18,6 +19,11 @@ export async function GET(request: Request) {
const twoFactor = await prisma.client.twoFactorAuth.findUnique({ where: { userId } });
const isEnabled = twoFactor?.isEnabled ?? false;
// 2FA cannot be set up without an encryption key, so it is never required
if (!isTwoFactorConfigured()) {
return json({ isEnabled, isRequired: false, requiredReason: null });
}
// Globally required
const globalSetting = await prisma.client.appSetting.findUnique({
where: { key: 'twoFactorRequiredGlobal' },