f9f0151717
## Summary
First step in the `portal-admin` audit-log-viewer workstream (per [ADR-0020](docs/decisions/0020-portal-admin-app.md)). The BFF's `AdminRoleGuard` (next PR) needs to read `session.user.roles` to enforce admin-only access to `/api/admin/*`. Today the session carries `{ oid, tid, username, displayName, amr }` — the `roles` claim is dropped on the floor when the ID token comes back from Entra.
This PR closes that gap:
- Adds `roles: readonly string[]` to [AuthenticatedUser](apps/portal-bff/src/auth/auth.service.ts) and threads it through `toAuthenticatedUser()`.
- The field flows onto `req.session.user` automatically via the existing module-augmentation chain in [session.types.ts](apps/portal-bff/src/session/session.types.ts) — no extra wiring.
## Defensive parsing
Mirrors the existing `amr` extraction pattern:
| Input claim shape | Result |
| --- | --- |
| `["admin", "editor"]` | `["admin", "editor"]` |
| Claim absent | `[]` |
| Non-array (e.g. `"admin"`) | `[]` |
| Mixed types (e.g. `["admin", 42, null, "editor"]`) | `["admin", "editor"]` |
Empty array means **"user has no app role assigned"**, not **"claim was unparseable"** — both collapse to the same value because both are equally non-authoritative for the admin guard.
## Why this is its own PR
The `AdminRoleGuard` + `@RequireAdmin()` decorator + first `/api/admin/me` self-test endpoint will follow in the next PR. Splitting the claim extraction out makes both diffs trivial to read and lets the second PR focus on guard semantics + audit emission without the mechanical fixture updates that came with adding a new `AuthenticatedUser` field.
## Surface impact — none yet
- `PublicUser` (the SPA-facing shape returned by `GET /api/auth/me`) is **deliberately unchanged**. Exposing `roles` to the SPA happens in the next PR alongside the conditional admin-link rendering — without a consumer in this PR it would be dead code.
- Audit pipeline unchanged. `SignInActor` carries `{ oid, amr }` only; the audit log doesn't need `roles` and won't get it.
- No new env vars, no new dependencies.
## Test plan
- [x] `pnpm nx test portal-bff` — **203 specs pass** (was 199; +4 new specs covering the four parsing cases above).
- [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] Existing fixtures in [auth.controller.spec.ts](apps/portal-bff/src/auth/auth.controller.spec.ts), [auth.service.spec.ts](apps/portal-bff/src/auth/auth.service.spec.ts), [absolute-timeout.middleware.spec.ts](apps/portal-bff/src/session/absolute-timeout.middleware.spec.ts) updated with `roles: []`.
- [ ] e2e — would require the `admin` app role to be declared on the Entra registration and assigned to a test user. Out of scope for this PR; will be validated when the `AdminRoleGuard` lands and there is a 403 to observe.
---------
Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr>
Reviewed-on: #126
260 lines
9.9 KiB
TypeScript
260 lines
9.9 KiB
TypeScript
import type { AuthenticationResult, ConfidentialClientApplication } from '@azure/msal-node';
|
|
import { PRE_AUTH_COOKIE_TTL_MS } from './auth.cookie';
|
|
import { AuthCodeFlowException } from './auth.errors';
|
|
import { AuthService, type PreAuthPayload } from './auth.service';
|
|
import type { EntraConfig } from './entra-config.token';
|
|
|
|
const ENTRA: EntraConfig = {
|
|
instanceUrl: 'https://login.microsoftonline.com/',
|
|
tenantId: 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
clientId: '11111111-2222-3333-4444-555555555555',
|
|
clientSecret: 's3cret',
|
|
redirectUri: 'http://localhost:3000/api/auth/callback',
|
|
postLogoutRedirectUri: 'http://localhost:4200/',
|
|
authority: 'https://login.microsoftonline.com/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
};
|
|
|
|
interface ServiceFixture {
|
|
service: AuthService;
|
|
getAuthCodeUrl: jest.Mock;
|
|
acquireTokenByCode: jest.Mock;
|
|
}
|
|
|
|
function makeService(overrides?: { acquireTokenByCode?: jest.Mock }): ServiceFixture {
|
|
const getAuthCodeUrl = jest.fn().mockResolvedValue('https://entra.example/authorize?…');
|
|
const acquireTokenByCode =
|
|
overrides?.acquireTokenByCode ??
|
|
jest.fn().mockResolvedValue(makeAuthResult({ amr: ['pwd', 'mfa'] }));
|
|
const msalStub = {
|
|
getAuthCodeUrl,
|
|
acquireTokenByCode,
|
|
} as unknown as ConfidentialClientApplication;
|
|
return { service: new AuthService(msalStub, ENTRA), getAuthCodeUrl, acquireTokenByCode };
|
|
}
|
|
|
|
function makeAuthResult(
|
|
claims: Partial<{
|
|
amr: string[];
|
|
roles: unknown;
|
|
oid: string;
|
|
tid: string;
|
|
name: string;
|
|
preferred_username: string;
|
|
}>,
|
|
): AuthenticationResult {
|
|
const idTokenClaims: Record<string, unknown> = {
|
|
oid: claims.oid ?? 'user-oid',
|
|
tid: claims.tid ?? ENTRA.tenantId,
|
|
name: claims.name ?? 'Jane Doe',
|
|
preferred_username: claims.preferred_username ?? 'jane.doe@apf.example',
|
|
amr: claims.amr ?? ['pwd', 'mfa'],
|
|
};
|
|
// `roles` is optional in Entra ID tokens — only present when the
|
|
// user has at least one app role assigned. The fixture omits it
|
|
// unless the caller explicitly opts in (including with falsy
|
|
// values to exercise the empty-array fallback).
|
|
if (Object.prototype.hasOwnProperty.call(claims, 'roles')) {
|
|
idTokenClaims['roles'] = claims.roles;
|
|
}
|
|
return {
|
|
idTokenClaims,
|
|
account: { username: 'jane.doe@apf.example', name: 'Jane Doe' },
|
|
} as unknown as AuthenticationResult;
|
|
}
|
|
|
|
const PRE_AUTH_OK: PreAuthPayload = {
|
|
state: 'state-nonce',
|
|
codeVerifier: 'verifier-secret',
|
|
createdAt: 1_000_000,
|
|
};
|
|
|
|
describe('AuthService.beginAuthCodeFlow', () => {
|
|
it('builds the auth URL with the configured redirect, OIDC scopes, S256 challenge', async () => {
|
|
const { service, getAuthCodeUrl } = makeService();
|
|
await service.beginAuthCodeFlow();
|
|
expect(getAuthCodeUrl).toHaveBeenCalledTimes(1);
|
|
const arg = getAuthCodeUrl.mock.calls[0]?.[0] as Record<string, unknown>;
|
|
expect(arg['redirectUri']).toBe(ENTRA.redirectUri);
|
|
expect(arg['scopes']).toEqual(['openid', 'profile', 'email']);
|
|
expect(arg['codeChallengeMethod']).toBe('S256');
|
|
expect(typeof arg['codeChallenge']).toBe('string');
|
|
expect(typeof arg['state']).toBe('string');
|
|
});
|
|
|
|
it('returns the pre-auth payload with state + codeVerifier matching what MSAL was called with', async () => {
|
|
const { service, getAuthCodeUrl } = makeService();
|
|
const { preAuthPayload } = await service.beginAuthCodeFlow();
|
|
const arg = getAuthCodeUrl.mock.calls[0]?.[0] as Record<string, unknown>;
|
|
expect(preAuthPayload.state).toBe(arg['state']);
|
|
expect(preAuthPayload.codeVerifier).not.toBe(arg['codeChallenge']);
|
|
expect(preAuthPayload.createdAt).toBeLessThanOrEqual(Date.now());
|
|
});
|
|
|
|
it('generates a fresh state + verifier on every call', async () => {
|
|
const { service } = makeService();
|
|
const a = await service.beginAuthCodeFlow();
|
|
const b = await service.beginAuthCodeFlow();
|
|
expect(a.preAuthPayload.state).not.toBe(b.preAuthPayload.state);
|
|
expect(a.preAuthPayload.codeVerifier).not.toBe(b.preAuthPayload.codeVerifier);
|
|
});
|
|
});
|
|
|
|
describe('AuthService.completeAuthCodeFlow', () => {
|
|
it('returns the authenticated user on the happy path', async () => {
|
|
const { service, acquireTokenByCode } = makeService();
|
|
const user = await service.completeAuthCodeFlow(
|
|
'auth-code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt + 1_000,
|
|
);
|
|
expect(acquireTokenByCode).toHaveBeenCalledWith({
|
|
code: 'auth-code',
|
|
codeVerifier: PRE_AUTH_OK.codeVerifier,
|
|
redirectUri: ENTRA.redirectUri,
|
|
scopes: ['openid', 'profile', 'email'],
|
|
});
|
|
expect(user).toEqual({
|
|
oid: 'user-oid',
|
|
tid: ENTRA.tenantId,
|
|
username: 'jane.doe@apf.example',
|
|
displayName: 'Jane Doe',
|
|
amr: ['pwd', 'mfa'],
|
|
roles: [],
|
|
});
|
|
});
|
|
|
|
it('throws state-mismatch when the query state differs from the cookie state', async () => {
|
|
const { service } = makeService();
|
|
await expect(
|
|
service.completeAuthCodeFlow('code', 'other-state', PRE_AUTH_OK, PRE_AUTH_OK.createdAt),
|
|
).rejects.toMatchObject({ failure: { kind: 'state-mismatch' } });
|
|
});
|
|
|
|
it('throws flow-expired when the cookie is older than the TTL', async () => {
|
|
const { service } = makeService();
|
|
const now = PRE_AUTH_OK.createdAt + PRE_AUTH_COOKIE_TTL_MS + 1;
|
|
await expect(
|
|
service.completeAuthCodeFlow('code', PRE_AUTH_OK.state, PRE_AUTH_OK, now),
|
|
).rejects.toMatchObject({ failure: { kind: 'flow-expired' } });
|
|
});
|
|
|
|
it('returns the user even when the ID token has no `amr` claim (Entra optional)', async () => {
|
|
const acquireTokenByCode = jest.fn().mockResolvedValue(makeAuthResult({ amr: [] }));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
const user = await service.completeAuthCodeFlow(
|
|
'code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt,
|
|
);
|
|
// `amr` flows through as an empty array; MFA enforcement is
|
|
// Conditional Access's job per ADR-0011, not this code path.
|
|
expect(user.amr).toEqual([]);
|
|
expect(user.oid).toBe('user-oid');
|
|
});
|
|
|
|
it('surfaces the `roles` claim when Entra includes it (app-role-assigned user)', async () => {
|
|
const acquireTokenByCode = jest
|
|
.fn()
|
|
.mockResolvedValue(makeAuthResult({ roles: ['admin', 'editor'] }));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
const user = await service.completeAuthCodeFlow(
|
|
'code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt,
|
|
);
|
|
expect(user.roles).toEqual(['admin', 'editor']);
|
|
});
|
|
|
|
it('returns an empty `roles` array when the claim is absent (no app role assigned)', async () => {
|
|
const acquireTokenByCode = jest.fn().mockResolvedValue(makeAuthResult({}));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
const user = await service.completeAuthCodeFlow(
|
|
'code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt,
|
|
);
|
|
expect(user.roles).toEqual([]);
|
|
});
|
|
|
|
it('returns an empty `roles` array when the claim is non-array (defensive)', async () => {
|
|
const acquireTokenByCode = jest.fn().mockResolvedValue(makeAuthResult({ roles: 'admin' }));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
const user = await service.completeAuthCodeFlow(
|
|
'code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt,
|
|
);
|
|
expect(user.roles).toEqual([]);
|
|
});
|
|
|
|
it('drops non-string entries from `roles` (defensive against unexpected claim shapes)', async () => {
|
|
const acquireTokenByCode = jest
|
|
.fn()
|
|
.mockResolvedValue(makeAuthResult({ roles: ['admin', 42, null, 'editor'] }));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
const user = await service.completeAuthCodeFlow(
|
|
'code',
|
|
PRE_AUTH_OK.state,
|
|
PRE_AUTH_OK,
|
|
PRE_AUTH_OK.createdAt,
|
|
);
|
|
expect(user.roles).toEqual(['admin', 'editor']);
|
|
});
|
|
|
|
it('throws token-exchange-failed when MSAL throws', async () => {
|
|
const acquireTokenByCode = jest.fn().mockRejectedValue(new Error('AADSTS70008'));
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
await expect(
|
|
service.completeAuthCodeFlow('code', PRE_AUTH_OK.state, PRE_AUTH_OK, PRE_AUTH_OK.createdAt),
|
|
).rejects.toMatchObject({
|
|
failure: { kind: 'token-exchange-failed', cause: 'AADSTS70008' },
|
|
});
|
|
});
|
|
|
|
it('throws token-exchange-failed when MSAL returns null', async () => {
|
|
const acquireTokenByCode = jest.fn().mockResolvedValue(null);
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
await expect(
|
|
service.completeAuthCodeFlow('code', PRE_AUTH_OK.state, PRE_AUTH_OK, PRE_AUTH_OK.createdAt),
|
|
).rejects.toBeInstanceOf(AuthCodeFlowException);
|
|
});
|
|
|
|
it('throws token-exchange-failed when oid claim is missing', async () => {
|
|
const acquireTokenByCode = jest.fn().mockResolvedValue({
|
|
idTokenClaims: { tid: ENTRA.tenantId, amr: ['mfa'] },
|
|
account: { username: '', name: '' },
|
|
} as unknown as AuthenticationResult);
|
|
const { service } = makeService({ acquireTokenByCode });
|
|
await expect(
|
|
service.completeAuthCodeFlow('code', PRE_AUTH_OK.state, PRE_AUTH_OK, PRE_AUTH_OK.createdAt),
|
|
).rejects.toMatchObject({
|
|
failure: { kind: 'token-exchange-failed', cause: /oid/ },
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('AuthService.buildLogoutUrl', () => {
|
|
it('targets the v2.0 logout endpoint on the configured authority', () => {
|
|
const { service } = makeService();
|
|
const url = new URL(service.buildLogoutUrl());
|
|
expect(url.origin + url.pathname).toBe(`${ENTRA.authority}/oauth2/v2.0/logout`);
|
|
});
|
|
|
|
it('includes the post_logout_redirect_uri query param', () => {
|
|
const { service } = makeService();
|
|
const url = new URL(service.buildLogoutUrl());
|
|
expect(url.searchParams.get('post_logout_redirect_uri')).toBe(ENTRA.postLogoutRedirectUri);
|
|
});
|
|
|
|
it('does not pass id_token_hint (v1 does not persist the id_token yet)', () => {
|
|
const { service } = makeService();
|
|
const url = new URL(service.buildLogoutUrl());
|
|
expect(url.searchParams.has('id_token_hint')).toBe(false);
|
|
});
|
|
});
|