mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-23 23:46:35 +00:00
00cbc5aae3
tests/setup.ts mocks src/config once with tests/helpers/test-config.ts. A suite that needs other values calls overrideTestConfig(), and the setup file restores the defaults after every case. The 191 per-file factories are gone; config.test.ts takes the real module through vi.unmock, and the few suites that signed tokens with their own literal secret read it from TEST_CONFIG.
184 lines
9.2 KiB
TypeScript
184 lines
9.2 KiB
TypeScript
/**
|
|
* Unit tests for SessionRenewalInterceptor (#1927) — sliding renewal of the
|
|
* trek_session cookie once a cookie-authenticated token is past half of its
|
|
* lifetime. Covers the renew path (fresh token + cookie semantics per the
|
|
* `remember` claim) and every skip condition: young token, bearer-only request,
|
|
* unauthenticated request, purpose token, id mismatch, malformed claims,
|
|
* headers already sent, non-http context.
|
|
*/
|
|
import { describe, it, expect, vi } from 'vitest';
|
|
import type { CallHandler, ExecutionContext } from '@nestjs/common';
|
|
import { of, lastValueFrom } from 'rxjs';
|
|
import jwt from 'jsonwebtoken';
|
|
|
|
import { SessionRenewalInterceptor } from '../../../src/nest/auth/session-renewal.interceptor';
|
|
import type { SessionsService } from '../../../src/nest/sessions/sessions.service';
|
|
|
|
const SECRET = 'test-jwt-secret-for-trek-testing-only';
|
|
|
|
/** Sign a session token whose lifetime is `lifetime` seconds, `consumed` of which have already passed. */
|
|
function token(payload: Record<string, unknown>, lifetime: number, consumed: number): string {
|
|
const iat = Math.floor(Date.now() / 1000) - consumed;
|
|
// jsonwebtoken computes exp = iat + expiresIn when iat is supplied in the payload.
|
|
return jwt.sign({ ...payload, iat }, SECRET, { expiresIn: lifetime, algorithm: 'HS256' });
|
|
}
|
|
|
|
function makeRes(headersSent = false) {
|
|
return { headersSent, cookie: vi.fn() };
|
|
}
|
|
|
|
type ReqShape = { cookies?: Record<string, string>; user?: { id: number }; headers?: Record<string, string>; secure?: boolean };
|
|
|
|
function ctx(req: ReqShape, res: ReturnType<typeof makeRes>, type = 'http'): ExecutionContext {
|
|
return {
|
|
getType: () => type,
|
|
// Express always hands over a headers object; the shapes below leave it out.
|
|
switchToHttp: () => ({ getRequest: () => ({ headers: {}, ...req }), getResponse: () => res }),
|
|
} as unknown as ExecutionContext;
|
|
}
|
|
|
|
function handler(): CallHandler & { handle: ReturnType<typeof vi.fn> } {
|
|
return { handle: vi.fn(() => of('ok')) };
|
|
}
|
|
|
|
function makeInterceptor(renewed: string | null = 'renewed.jwt') {
|
|
const renew = vi.fn().mockResolvedValue(renewed);
|
|
const interceptor = new SessionRenewalInterceptor({ renew } as unknown as SessionsService);
|
|
return { interceptor, renew };
|
|
}
|
|
|
|
async function run(interceptor: SessionRenewalInterceptor, req: ReqShape, res: ReturnType<typeof makeRes>, type = 'http') {
|
|
const h = handler();
|
|
const out = await lastValueFrom(await interceptor.intercept(ctx(req, res, type), h));
|
|
expect(out).toBe('ok');
|
|
expect(h.handle).toHaveBeenCalled();
|
|
}
|
|
|
|
describe('SessionRenewalInterceptor', () => {
|
|
it('SES-RENEW-001: does not renew a token under half of its lifetime', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0 }, 86400, 1000); // ~1% consumed
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).not.toHaveBeenCalled();
|
|
expect(res.cookie).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-002: renews a token past half of its lifetime, copying pv from the old token', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 3 }, 86400, 60000); // ~70% consumed
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).toHaveBeenCalledWith({ id: 1, pv: 3, remember: undefined, jti: undefined, token: t }, { userAgent: null });
|
|
expect(res.cookie).toHaveBeenCalledWith('trek_session', 'renewed.jwt', expect.objectContaining({ maxAge: 86400000, httpOnly: true }));
|
|
});
|
|
|
|
it('SES-RENEW-003: a remember:true claim renews with the long persistent cookie', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0, remember: true }, 2592000, 1600000); // ~62% consumed
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).toHaveBeenCalledWith({ id: 1, pv: 0, remember: true, jti: undefined, token: t }, { userAgent: null });
|
|
expect(res.cookie).toHaveBeenCalledWith('trek_session', 'renewed.jwt', expect.objectContaining({ maxAge: 2592000000 }));
|
|
});
|
|
|
|
it('SES-RENEW-004: a remember:false claim renews as a browser-session cookie (no maxAge)', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0, remember: false }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).toHaveBeenCalledWith({ id: 1, pv: 0, remember: false, jti: undefined, token: t }, { userAgent: null });
|
|
const options = res.cookie.mock.calls[0][2];
|
|
expect(options).not.toHaveProperty('maxAge');
|
|
});
|
|
|
|
it('SES-RENEW-005: a claimless legacy token renews with the historical default cookie', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).toHaveBeenCalledWith({ id: 1, pv: 0, remember: undefined, jti: undefined, token: t }, { userAgent: null });
|
|
expect(res.cookie).toHaveBeenCalledWith('trek_session', 'renewed.jwt', expect.objectContaining({ maxAge: 86400000 }));
|
|
});
|
|
|
|
it('SES-RENEW-006: never renews a Bearer-only request (no session cookie)', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
await run(interceptor, { headers: { authorization: 'Bearer x' }, user: { id: 1 } }, res);
|
|
expect(renew).not.toHaveBeenCalled();
|
|
expect(res.cookie).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-007: never renews an unauthenticated (public-route) request', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t } }, res);
|
|
expect(renew).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-008: never renews a purpose-scoped token or a cookie whose id differs from req.user', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const purposeRes = makeRes();
|
|
const purposeToken = token({ id: 1, pv: 0, purpose: 'mfa_login' }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: purposeToken }, user: { id: 1 } }, purposeRes);
|
|
|
|
const mismatchRes = makeRes();
|
|
const otherUsers = token({ id: 2, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: otherUsers }, user: { id: 1 } }, mismatchRes);
|
|
|
|
expect(renew).not.toHaveBeenCalled();
|
|
expect(purposeRes.cookie).not.toHaveBeenCalled();
|
|
expect(mismatchRes.cookie).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-009: skips when headers were already sent or the cookie is not a JWT', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const sentRes = makeRes(true);
|
|
const t = token({ id: 1, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, sentRes);
|
|
|
|
const garbageRes = makeRes();
|
|
await run(interceptor, { cookies: { trek_session: 'not-a-jwt' }, user: { id: 1 } }, garbageRes);
|
|
|
|
expect(renew).not.toHaveBeenCalled();
|
|
expect(sentRes.cookie).not.toHaveBeenCalled();
|
|
expect(garbageRes.cookie).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-010: skips tokens with missing or inverted iat/exp claims', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
// Hand-built token without exp (noTimestamp keeps iat but expiresIn omitted).
|
|
const noExp = jwt.sign({ id: 1, pv: 0 }, SECRET, { algorithm: 'HS256' });
|
|
await run(interceptor, { cookies: { trek_session: noExp }, user: { id: 1 } }, res);
|
|
expect(renew).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-011: ignores non-http execution contexts', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res, 'ws');
|
|
expect(renew).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('SES-RENEW-012: a tracked token renews under its own session id, with the device', async () => {
|
|
const { interceptor, renew } = makeInterceptor();
|
|
const res = makeRes();
|
|
const t = jwt.sign({ id: 1, pv: 0, iat: Math.floor(Date.now() / 1000) - 60000 }, SECRET, { expiresIn: 86400, algorithm: 'HS256', jwtid: 'sid-1' });
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 }, headers: { 'user-agent': 'Firefox/130' } }, res);
|
|
expect(renew).toHaveBeenCalledWith({ id: 1, pv: 0, remember: undefined, jti: 'sid-1', token: t }, { userAgent: 'Firefox/130' });
|
|
expect(res.cookie).toHaveBeenCalledWith('trek_session', 'renewed.jwt', expect.objectContaining({ maxAge: 86400000 }));
|
|
});
|
|
|
|
it('SES-RENEW-013: sets no cookie when the session ended before it could be renewed', async () => {
|
|
const { interceptor, renew } = makeInterceptor(null);
|
|
const res = makeRes();
|
|
const t = token({ id: 1, pv: 0 }, 86400, 60000);
|
|
await run(interceptor, { cookies: { trek_session: t }, user: { id: 1 } }, res);
|
|
expect(renew).toHaveBeenCalled();
|
|
expect(res.cookie).not.toHaveBeenCalled();
|
|
});
|
|
});
|