feat(portal-bff): session middleware with AES-256-GCM at rest per ADR-0010 (#110)
## Summary
Mounts `express-session` + `connect-redis` at bootstrap on top of the shared `ioredis` client, with **AES-256-GCM applied to the full JSON payload before it lands in Redis** (per ADR-0010). The configured middleware is exposed as a NestJS provider (`SESSION_MIDDLEWARE`) and `main.ts` mounts it through `app.get(...)` so it sits on the same Redis connection the rest of the BFF uses — no second client at the bootstrap layer.
Envelope is versioned (`v1.<iv>.<tag>.<ciphertext>`, all base64url) so the algorithm / key derivation can rotate without a flag-day re-encryption. Tamper / wrong-key / unknown-version all raise `SessionDecryptError`; for now the failure is logged via Pino with `event: session.decrypt_failed` — the first-class audit event lands with ADR-0013.
Scope is intentionally **infrastructure only**:
- middleware mounted on every request, `req.session` available downstream
- session id = `crypto.randomBytes(32).toString('base64url')` (256 bits per ADR-0010)
- cookie name: `__Host-portal_session` in production, `portal_session` in dev (the `__Host-` prefix mandates `Secure`, which dev HTTP can't satisfy)
- `httpOnly + sameSite=lax + path=/`; `resave:false`, `saveUninitialized:false`, `rolling:true`
- cookie `maxAge` follows `SESSION_IDLE_TIMEOUT_SECONDS` (default 1800)
- encryption-at-rest active end-to-end
Out of scope, landing in follow-ups: `/auth/callback` populating `req.session.user`, `/me`, `/auth/logout`, the absolute-timeout interceptor, and the `user_sessions:{userId}` secondary index.
## Notable shape choices (ADR-0010 amended in the same commit)
**Full-payload encryption vs. just the `tokens` field.** The first draft of ADR-0010 scoped at-rest encryption to a `tokens` sub-field. The session also carries claims (`oid`, `tid`, `preferred_username`, …) that qualify as PII under GDPR — for an APF-Handicap portal handling health-adjacent data this matters. Encrypting the envelope is strictly stronger and removes the need to classify fields one by one. The ADR text is updated to match.
**`ioredis` + adapter vs. switching the BFF to `node-redis`.** `connect-redis` v9 was rewritten for `node-redis` v4 and no longer accepts `ioredis` directly. Two reasonable paths:
1. **Adapter (chosen)** — keep the shared `ioredis` client; shim the six commands `connect-redis` actually calls (`get`, `set` with `{expiration:{type:'EX',value}}`, `expire`, `del`, `mGet`, `scanIterator`) to the node-redis shape. Smallest blast radius — RedisModule, OBO cache (ADR-0014), future pub/sub all stay on a single Redis library.
2. **Switch RedisModule to `node-redis`** — clean alignment with `connect-redis`'s expectations, but touches every Redis consumer and would itself require an ADR amendment.
The adapter is reversible: if we ever decide to standardise on `node-redis`, deleting one file removes it. Happy to switch if you'd rather take that path.
## Env vars
- `SESSION_ENCRYPTION_KEY` — **mandatory**, AES-256-GCM key (32 bytes after base64url decode). New `assertSessionEncryptionKey()` validator wired in `main.ts` alongside the other pre-flight checks.
- `SESSION_IDLE_TIMEOUT_SECONDS` — optional, default `1800`.
- `SESSION_ABSOLUTE_TIMEOUT_SECONDS` — optional, default `43200` (consumed by the absolute-timeout interceptor in a follow-up).
`.env.example` updated; the three variables are promoted from the "future vars" block to the active section.
## Test plan
- [x] `pnpm nx test portal-bff` — **99/99 pass** (was 62 before this PR; +37 new specs across the 5 new files).
- [x] `pnpm nx build portal-bff` — clean webpack build.
- [x] `pnpm nx lint portal-bff` — clean.
- [x] Prettier-clean for all PR source files.
- [ ] Local smoke test once the next PR wires `/auth/callback` → `req.session.user`; this PR has no user-visible behaviour to exercise on its own.
---------
Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr>
Reviewed-on: #110
This commit was merged in pull request #110.
This commit is contained in:
@@ -0,0 +1,88 @@
|
||||
import { randomBytes } from 'node:crypto';
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { LoggerModule } from 'nestjs-pino';
|
||||
import { SessionModule } from './session.module';
|
||||
import { SESSION_MIDDLEWARE, type RequestHandler } from './session.token';
|
||||
|
||||
const STRONG_KEY = randomBytes(32).toString('base64url');
|
||||
const STRONG_SECRET = randomBytes(32).toString('base64url');
|
||||
|
||||
interface OriginalEnv {
|
||||
REDIS_URL: string | undefined;
|
||||
SESSION_SECRET: string | undefined;
|
||||
SESSION_ENCRYPTION_KEY: string | undefined;
|
||||
NODE_ENV: string | undefined;
|
||||
}
|
||||
|
||||
async function compile() {
|
||||
return Test.createTestingModule({
|
||||
imports: [LoggerModule.forRoot({ pinoHttp: { level: 'silent' } }), SessionModule],
|
||||
}).compile();
|
||||
}
|
||||
|
||||
describe('SessionModule', () => {
|
||||
const original: OriginalEnv = {
|
||||
REDIS_URL: process.env['REDIS_URL'],
|
||||
SESSION_SECRET: process.env['SESSION_SECRET'],
|
||||
SESSION_ENCRYPTION_KEY: process.env['SESSION_ENCRYPTION_KEY'],
|
||||
NODE_ENV: process.env['NODE_ENV'],
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
// Well-formed but unreachable URL — `ioredis` opens its socket
|
||||
// lazily so the module compiles without any network access.
|
||||
process.env['REDIS_URL'] = 'redis://default:test-pass@127.0.0.1:65535/0';
|
||||
process.env['SESSION_SECRET'] = STRONG_SECRET;
|
||||
process.env['SESSION_ENCRYPTION_KEY'] = STRONG_KEY;
|
||||
process.env['NODE_ENV'] = 'development';
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
restore('REDIS_URL', original.REDIS_URL);
|
||||
restore('SESSION_SECRET', original.SESSION_SECRET);
|
||||
restore('SESSION_ENCRYPTION_KEY', original.SESSION_ENCRYPTION_KEY);
|
||||
restore('NODE_ENV', original.NODE_ENV);
|
||||
});
|
||||
|
||||
it('provides a request handler via SESSION_MIDDLEWARE', async () => {
|
||||
const ref = await compile();
|
||||
try {
|
||||
const middleware = ref.get<RequestHandler>(SESSION_MIDDLEWARE);
|
||||
expect(typeof middleware).toBe('function');
|
||||
// Express request handlers always declare 3 named params
|
||||
// (req, res, next) — useful smoke check that the factory
|
||||
// returned the expected shape rather than a `Store` or
|
||||
// a configured options object.
|
||||
expect(middleware.length).toBe(3);
|
||||
} finally {
|
||||
await disposeRedis(ref);
|
||||
await ref.close();
|
||||
}
|
||||
});
|
||||
|
||||
it('fails to compile when SESSION_ENCRYPTION_KEY is missing', async () => {
|
||||
delete process.env['SESSION_ENCRYPTION_KEY'];
|
||||
await expect(compile()).rejects.toThrow(/SESSION_ENCRYPTION_KEY is not set/);
|
||||
});
|
||||
|
||||
it('fails to compile when SESSION_SECRET is missing', async () => {
|
||||
delete process.env['SESSION_SECRET'];
|
||||
await expect(compile()).rejects.toThrow(/SESSION_SECRET is not set/);
|
||||
});
|
||||
});
|
||||
|
||||
function restore(name: string, value: string | undefined): void {
|
||||
if (value === undefined) {
|
||||
delete process.env[name];
|
||||
} else {
|
||||
process.env[name] = value;
|
||||
}
|
||||
}
|
||||
|
||||
async function disposeRedis(ref: Awaited<ReturnType<typeof compile>>): Promise<void> {
|
||||
// `RedisModule` keeps an `ioredis` client open; explicitly
|
||||
// disconnect so Jest doesn't hang on its reconnect timer.
|
||||
const redisToken = 'REDIS_CLIENT';
|
||||
const client = ref.get<{ disconnect: () => void }>(redisToken);
|
||||
client.disconnect();
|
||||
}
|
||||
Reference in New Issue
Block a user