feat(portal-bff): extract Entra roles claim onto AuthenticatedUser
#126
@@ -30,6 +30,7 @@ const USER: AuthenticatedUser = {
|
||||
username: 'jane.doe@apf.example',
|
||||
displayName: 'Jane Doe',
|
||||
amr: ['pwd', 'mfa'],
|
||||
roles: [],
|
||||
};
|
||||
|
||||
function makeResStub() {
|
||||
|
||||
@@ -35,20 +35,29 @@ function makeService(overrides?: { acquireTokenByCode?: jest.Mock }): ServiceFix
|
||||
function makeAuthResult(
|
||||
claims: Partial<{
|
||||
amr: string[];
|
||||
roles: unknown;
|
||||
oid: string;
|
||||
tid: string;
|
||||
name: string;
|
||||
preferred_username: string;
|
||||
}>,
|
||||
): AuthenticationResult {
|
||||
return {
|
||||
idTokenClaims: {
|
||||
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;
|
||||
}
|
||||
@@ -111,6 +120,7 @@ describe('AuthService.completeAuthCodeFlow', () => {
|
||||
username: 'jane.doe@apf.example',
|
||||
displayName: 'Jane Doe',
|
||||
amr: ['pwd', 'mfa'],
|
||||
roles: [],
|
||||
});
|
||||
});
|
||||
|
||||
@@ -144,6 +154,58 @@ describe('AuthService.completeAuthCodeFlow', () => {
|
||||
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 });
|
||||
|
||||
@@ -37,6 +37,12 @@ export interface AuthCodeFlowStart {
|
||||
* - `amr`: authentication methods reference — the array used by
|
||||
* the BFF's MFA sanity-check (ADR-0011) and by `@RequireMfa`
|
||||
* freshness checks once the session lands.
|
||||
* - `roles`: Entra app roles assigned to this user on the BFF's
|
||||
* app registration. Surfaced for the future `@RequireAdmin` /
|
||||
* `@RequireRole(...)` guards (ADR-0020 admin module). Always
|
||||
* present in the shape — an empty array means the user has no
|
||||
* app role on this app registration, not that the claim was
|
||||
* unparseable.
|
||||
*/
|
||||
export interface AuthenticatedUser {
|
||||
readonly oid: string;
|
||||
@@ -44,6 +50,7 @@ export interface AuthenticatedUser {
|
||||
readonly username: string;
|
||||
readonly displayName: string;
|
||||
readonly amr: readonly string[];
|
||||
readonly roles: readonly string[];
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -186,6 +193,19 @@ export class AuthService {
|
||||
? (claims['amr'] as unknown[]).filter((v): v is string => typeof v === 'string')
|
||||
: [];
|
||||
|
||||
// `roles` is an optional claim. Entra includes it when the user
|
||||
// has at least one app role assigned on the BFF's app
|
||||
// registration. The value is an array of the role `value`
|
||||
// strings declared in the registration manifest (e.g. `admin`).
|
||||
// No role assignment → claim is omitted entirely; we normalise
|
||||
// to an empty array so consumers can call `.includes('admin')`
|
||||
// unconditionally. Per ADR-0020, role-based authorisation is the
|
||||
// single source of authority for admin access; the AdminRoleGuard
|
||||
// will read this field on every `/api/admin/*` request.
|
||||
const roles = Array.isArray(claims['roles'])
|
||||
? (claims['roles'] as unknown[]).filter((v): v is string => typeof v === 'string')
|
||||
: [];
|
||||
|
||||
return {
|
||||
oid: requireString(claims['oid'], 'oid'),
|
||||
tid: requireString(claims['tid'], 'tid'),
|
||||
@@ -198,6 +218,7 @@ export class AuthService {
|
||||
? (claims['name'] as string)
|
||||
: (result.account?.name ?? ''),
|
||||
amr,
|
||||
roles,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,6 +68,7 @@ const USER = {
|
||||
username: 'jane@apf.example',
|
||||
displayName: 'Jane Doe',
|
||||
amr: ['pwd', 'mfa'],
|
||||
roles: [],
|
||||
};
|
||||
|
||||
describe('absoluteTimeout middleware', () => {
|
||||
|
||||
Reference in New Issue
Block a user