feat(portal-bff): admin module + role guard + /api/admin/me self-test (#127)
## Summary
Lays the foundation for the `/api/admin/*` surface per [ADR-0020](docs/decisions/0020-portal-admin-app.md). This PR ships the role guard, the `@RequireAdmin()` decorator, and a self-test endpoint — no business routes yet. The next consumer (audit log viewer) lands in a later PR once the distinct admin session is in place.
## What ships
- **[AdminRoleGuard](apps/portal-bff/src/admin/admin-role.guard.ts)** — three branches:
- No session at all → **401**. No audit; unauthenticated probes are normal traffic, not a privilege-escalation signal.
- Session but `roles` lacks `admin` → **403** + `admin.access_denied` audit row with actor hash, attempted route (`${METHOD} ${originalUrl}`), and the roles the user did hold.
- Session with `admin` role → pass through.
- Audit-write failures propagate (no audit ⇒ no action, consistent with the existing call sites in [AuthController](apps/portal-bff/src/auth/auth.controller.ts)).
- **[`@RequireAdmin()`](apps/portal-bff/src/admin/require-admin.decorator.ts)** — semantic sugar for `@UseGuards(AdminRoleGuard)` built with `applyDecorators` so future composition (e.g. with the upcoming `@RequireMfa({ freshness })` for the admin entry route) is mechanical.
- **`GET /api/admin/me`** — self-test endpoint named in ADR-0020 §"Confirmation" step 3. Returns the public user payload + `roles` so ops can `curl` the gate with three sessions (no cookie / non-admin cookie / admin cookie) and observe `401` / `403` + audit / `200` respectively.
- **[`AuditWriter.adminAccessDenied()`](apps/portal-bff/src/audit/audit.service.ts)** — new typed method using the pre-existing `denied` outcome enum value. Keeps the salt inside the audit module, matches the pattern of `signIn` / `signOut` / `sessionExpired`.
## Why the shared portal-shell session (for now)
ADR-0020 mandates a distinct `__Host-portal_admin_session` cookie + Redis namespace `session:admin:*` for the admin app. **That is not in this PR.** The chantier sequence splits it out: this PR proves the guard semantics + audit integration on the existing session; the next PR introduces the distinct session middleware + admin-specific auth flow.
Rationale: the guard logic is independent of the session implementation — `session.user.roles` is the only field it reads. Landing it first means a smaller diff to review, a faster opportunity to validate the audit emission on a real Postgres, and a clean baseline to layer the session split onto.
## Notes for the reviewer
- The non-null assertion on `req.session.user!` in [admin.controller.ts:27](apps/portal-bff/src/admin/admin.controller.ts#L27) is explicitly disabled with an inline comment pointing at the guard's contract. The alternative (a defensive runtime check) duplicates the guard's logic without adding safety. The spec for the guard covers every branch including the absent-user path.
- `AdminController` does not depend on `AuthService`'s `toPublicUser` projection — that helper is private to the auth module and pulls `displayName` / `username` with extra account-object fallbacks specific to the OIDC callback. The admin response is built from the already-populated session, so a duplicated projection here is the simpler shape.
## Open questions (out of scope)
- The Entra app role `admin` must be **declared on the app registration manifest** and **assigned to at least one test user** before this gate can be exercised end-to-end. That's an Entra Admin Center operation, not code. The guard's behaviour under all three branches is covered by unit tests; e2e validation waits until the role is assigned.
## Test plan
- [x] `pnpm nx test portal-bff` — **214 specs pass** (was 203; +11 covering guard branches, controller projection, audit method).
- [x] `pnpm exec nx affected -t format:check lint test build --base=origin/main` — clean (the pre-existing `_res` / `_next` warnings in `rate-limit.middleware.ts` are unrelated).
- [x] Audit row schema verified — `admin.access_denied` events use `outcome=denied`, store the route in `subject`, and persist `{ rolesHeld: [...] }` in the JSONB payload.
- [ ] e2e — pending Entra role declaration + assignment. Will be covered by manual ops curl checks once the role exists.
---------
Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr>
Reviewed-on: #127
This commit was merged in pull request #127.
This commit is contained in:
@@ -0,0 +1,178 @@
|
||||
import { ExecutionContext, ForbiddenException, UnauthorizedException } from '@nestjs/common';
|
||||
import type { Request } from 'express';
|
||||
import { AuditWriter } from '../audit/audit.service';
|
||||
import { ADMIN_ROLE, AdminRoleGuard } from './admin-role.guard';
|
||||
|
||||
interface SessionStub {
|
||||
user?: {
|
||||
oid: string;
|
||||
tid: string;
|
||||
username: string;
|
||||
displayName: string;
|
||||
amr: readonly string[];
|
||||
roles: readonly string[];
|
||||
};
|
||||
}
|
||||
|
||||
function makeRequest(opts: {
|
||||
session?: SessionStub;
|
||||
method?: string;
|
||||
originalUrl?: string;
|
||||
}): Request {
|
||||
return {
|
||||
session: opts.session,
|
||||
method: opts.method ?? 'GET',
|
||||
originalUrl: opts.originalUrl ?? '/api/admin/me',
|
||||
} as unknown as Request;
|
||||
}
|
||||
|
||||
function makeContext(req: Request): ExecutionContext {
|
||||
return {
|
||||
switchToHttp: () => ({ getRequest: <T>() => req as T }),
|
||||
} as unknown as ExecutionContext;
|
||||
}
|
||||
|
||||
function makeAuditStub(): jest.Mocked<Pick<AuditWriter, 'adminAccessDenied'>> {
|
||||
return {
|
||||
adminAccessDenied: jest.fn().mockResolvedValue(undefined),
|
||||
};
|
||||
}
|
||||
|
||||
describe('AdminRoleGuard', () => {
|
||||
it('throws 401 when the request has no session at all', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(makeRequest({ session: undefined }));
|
||||
await expect(guard.canActivate(ctx)).rejects.toBeInstanceOf(UnauthorizedException);
|
||||
expect(audit.adminAccessDenied).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('throws 401 when the session exists but no user is bound to it', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(makeRequest({ session: {} }));
|
||||
await expect(guard.canActivate(ctx)).rejects.toBeInstanceOf(UnauthorizedException);
|
||||
expect(audit.adminAccessDenied).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('throws 403 + records admin.access_denied when the user has no roles at all', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(
|
||||
makeRequest({
|
||||
session: {
|
||||
user: {
|
||||
oid: 'user-oid',
|
||||
tid: 't',
|
||||
username: 'jane@example',
|
||||
displayName: 'Jane',
|
||||
amr: ['pwd'],
|
||||
roles: [],
|
||||
},
|
||||
},
|
||||
method: 'GET',
|
||||
originalUrl: '/api/admin/me',
|
||||
}),
|
||||
);
|
||||
await expect(guard.canActivate(ctx)).rejects.toBeInstanceOf(ForbiddenException);
|
||||
expect(audit.adminAccessDenied).toHaveBeenCalledWith({
|
||||
actor: { oid: 'user-oid' },
|
||||
attemptedRoute: 'GET /api/admin/me',
|
||||
rolesHeld: [],
|
||||
});
|
||||
});
|
||||
|
||||
it('throws 403 + records admin.access_denied when the user has unrelated roles only', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(
|
||||
makeRequest({
|
||||
session: {
|
||||
user: {
|
||||
oid: 'user-oid',
|
||||
tid: 't',
|
||||
username: 'jane@example',
|
||||
displayName: 'Jane',
|
||||
amr: ['pwd'],
|
||||
roles: ['editor', 'auditor'],
|
||||
},
|
||||
},
|
||||
method: 'POST',
|
||||
originalUrl: '/api/admin/cms/pages',
|
||||
}),
|
||||
);
|
||||
await expect(guard.canActivate(ctx)).rejects.toBeInstanceOf(ForbiddenException);
|
||||
expect(audit.adminAccessDenied).toHaveBeenCalledWith({
|
||||
actor: { oid: 'user-oid' },
|
||||
attemptedRoute: 'POST /api/admin/cms/pages',
|
||||
rolesHeld: ['editor', 'auditor'],
|
||||
});
|
||||
});
|
||||
|
||||
it('returns true and does not audit when the user has the admin role', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(
|
||||
makeRequest({
|
||||
session: {
|
||||
user: {
|
||||
oid: 'user-oid',
|
||||
tid: 't',
|
||||
username: 'jane@example',
|
||||
displayName: 'Jane',
|
||||
amr: ['pwd', 'mfa'],
|
||||
roles: [ADMIN_ROLE],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
await expect(guard.canActivate(ctx)).resolves.toBe(true);
|
||||
expect(audit.adminAccessDenied).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('returns true when admin is one of several roles', async () => {
|
||||
const audit = makeAuditStub();
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(
|
||||
makeRequest({
|
||||
session: {
|
||||
user: {
|
||||
oid: 'user-oid',
|
||||
tid: 't',
|
||||
username: 'jane@example',
|
||||
displayName: 'Jane',
|
||||
amr: ['pwd', 'mfa'],
|
||||
roles: ['editor', ADMIN_ROLE, 'auditor'],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
await expect(guard.canActivate(ctx)).resolves.toBe(true);
|
||||
});
|
||||
|
||||
it('propagates audit write failures (no audit ⇒ no action, per ADR-0013)', async () => {
|
||||
const audit = {
|
||||
adminAccessDenied: jest.fn().mockRejectedValue(new Error('audit_writer denied')),
|
||||
};
|
||||
const guard = new AdminRoleGuard(audit as unknown as AuditWriter);
|
||||
const ctx = makeContext(
|
||||
makeRequest({
|
||||
session: {
|
||||
user: {
|
||||
oid: 'user-oid',
|
||||
tid: 't',
|
||||
username: 'jane@example',
|
||||
displayName: 'Jane',
|
||||
amr: ['pwd'],
|
||||
roles: [],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
// The 403 path goes through audit first; if audit throws, the
|
||||
// guard surfaces the underlying error rather than the
|
||||
// ForbiddenException — the caller sees a 500 and the audit
|
||||
// invariant is preserved.
|
||||
await expect(guard.canActivate(ctx)).rejects.toThrow('audit_writer denied');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user