authorize.ts had none, and its own header is what says why that mattered: every deny path in the platform ends there, and the failure mode of a permissive default is not a bug report, it is someone else's session. It had none for a structural reason rather than an oversight. Every path needed two database calls, and the only file here that mocks officerdb leaks its stub into whatever runs after it — so the obvious approach would have traded one untested file for a flaky suite. So the decisions are split from the fetching. resolveEffectivePermissions, decideApiRequest and decideWsProvider are pure functions of their arguments; the async wrappers keep the role cache, the fail-closed catches and the shape callers use. No behaviour change, and the live gate still answers 401 on file-browser, users and tasks. REAL registry keys throughout, deliberately: a suite built on invented permissions keeps passing after a rename, which is the failure an authorization table can least afford. If a key here disappears this file goes red. Pinned beyond the happy paths — the owner carries no grants to consult; core is write unconditionally; a confined grant is dropped without a Linux user and all three drop together; execution and admin grants in the table are ignored even though no CHECK stops the row existing; an unknown key is ignored without disturbing what is legitimately held; self-service is exact in method AND path; a socket needs no level; an unauthenticated caller is refused every door. Two gaps are stated in the file rather than left to be found: ownerOnly has no declaring permission yet, so testing it would test the fixtures; and the grant cache's contract is a claim about call sites, not logic. Found while writing them: readOnlyWrites paths are relative to the permission's api prefix, and getting that wrong fails as "no permission covers this path" rather than as a level error — a misleading message for a misleading path, now commented at the test that hit it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
216 lines
10 KiB
TypeScript
216 lines
10 KiB
TypeScript
import { getUserById, getRoleGrants } from 'officerdb';
|
|
import type { UserRole } from 'officerdb';
|
|
import {
|
|
PERMISSION_BY_KEY,
|
|
CORE_PERMISSIONS,
|
|
permissionForApiPath,
|
|
permissionForWsProvider,
|
|
isRequestAllowedAtLevel,
|
|
isOwnerOnlyRoute,
|
|
isSelfServiceRoute,
|
|
type PermissionLevel,
|
|
} from './registry';
|
|
|
|
// Resolving "may this account do this". Every deny path in the platform ends up here.
|
|
//
|
|
// Two rules run the whole file:
|
|
//
|
|
// 1. The owner bypasses everything. isSuperAdmin is the single question asked first, and a Super Admin
|
|
// never consults the grants table — which is why the schema refuses to store a row for that role.
|
|
// 2. Everyone else gets core permissions plus whatever their ROLE has been granted, and nothing else.
|
|
// An unrecognised permission, a missing row, a database error, a user who no longer exists: all deny.
|
|
//
|
|
// Fail-closed is not decoration here. This function is what stands between a Member and a shell, and the
|
|
// failure mode of a permissive default is not a bug report — it is someone else's session. Every catch in
|
|
// this file returns "no", and none of them log-and-continue.
|
|
|
|
export type EffectivePermissions = {
|
|
isOwner: boolean;
|
|
/** Permission key → level. Empty for an account with nothing granted; the owner's is never consulted. */
|
|
grants: Map<string, PermissionLevel>;
|
|
};
|
|
|
|
// ── Grant cache ───────────────────────────────────────────────────────────────────────────────────
|
|
//
|
|
// Keyed on ROLE, not user, so it holds at most one entry per role and a new account needs no warm-up.
|
|
//
|
|
// super-admin.ts deliberately does NOT cache, and says why: a cache with no invalidation contract is a
|
|
// staleness bug waiting for whoever builds the role UI. This one has a contract — the only writer is the
|
|
// grants API in api/users, which calls invalidateRoleGrants on every mutation, in this same process. That
|
|
// is the entire set of writers; if a second one ever appears it has to call this too, which is why the
|
|
// cache and its invalidator live in the same file as the reader that depends on them.
|
|
const grantCache = new Map<UserRole, Map<string, PermissionLevel>>();
|
|
|
|
/** Called by every path that writes a grant. Clears one role, or all of them. */
|
|
export function invalidateRoleGrants(role?: UserRole): void {
|
|
if (role) grantCache.delete(role);
|
|
else grantCache.clear();
|
|
}
|
|
|
|
async function grantsForRole(role: UserRole): Promise<Map<string, PermissionLevel>> {
|
|
const cached = grantCache.get(role);
|
|
if (cached) return cached;
|
|
const grants = (await getRoleGrants(role)) as Map<string, PermissionLevel>;
|
|
grantCache.set(role, grants);
|
|
return grants;
|
|
}
|
|
|
|
/**
|
|
* What this account may reach, resolved from its role.
|
|
*
|
|
* Core permissions come in at `write` unconditionally: they are the caller's own profile, dock and bug
|
|
* reports, and a read-only version of "change your own password" is not a coherent thing to offer.
|
|
*
|
|
* `execution` and `admin` permissions are dropped even if a row somehow grants them. The API refuses to
|
|
* write such a row, but this is the layer that has to hold if one ever exists — a constraint the database
|
|
* does not enforce is a constraint the reader must.
|
|
*/
|
|
/**
|
|
* The resolution itself, with no database in it.
|
|
*
|
|
* Split out on 2026-08-22 so it can be tested. `authorize.ts` is described in its own header as the file
|
|
* standing between a Member and a shell, and it had no automated tests at all — because every path through
|
|
* it needed two database calls, and the only file in this repository that mocks `officerdb` has a stub that
|
|
* leaks into whatever runs after it. Pulling the decision away from the fetching removes the need for a
|
|
* mock rather than working around one: everything below this line is a pure function of two arguments.
|
|
*
|
|
* The async wrapper keeps the caching, the error handling and the single-question shape callers rely on.
|
|
*/
|
|
export function resolveEffectivePermissions(
|
|
user: { role: UserRole; osUser: string | null },
|
|
roleGrants: Map<string, PermissionLevel>,
|
|
): EffectivePermissions {
|
|
if (user.role === 'Super Admin') return { isOwner: true, grants: new Map() };
|
|
|
|
const grants = new Map<string, PermissionLevel>();
|
|
for (const permission of CORE_PERMISSIONS) grants.set(permission.key, 'write');
|
|
|
|
// Whether the kernel can enforce a boundary for this account. `confined` permissions are dropped
|
|
// without it — see below.
|
|
const hasOsAccount = !!user.osUser;
|
|
|
|
for (const [key, level] of roleGrants) {
|
|
const permission = PERMISSION_BY_KEY.get(key);
|
|
// Unknown key: a permission that was renamed or removed while a grant survived. Ignore it — the
|
|
// alternative is honouring a name nothing defines.
|
|
if (!permission) continue;
|
|
|
|
// A confined permission touches the filesystem or runs a process, and is safe only because the
|
|
// account has its own Linux user to be confined to. Without one there is no boundary, so the grant
|
|
// resolves to nothing rather than to the owner's home — which is what it WOULD resolve to, since
|
|
// `getOwnerHomeDir` ignores the email it is passed, always.
|
|
//
|
|
// Dropped here rather than refused per-router so that one rule covers the HTTP routes, the
|
|
// websocket doors and the dock all at once. A member with `files` granted but no OS account sees no
|
|
// Files icon, gets a 403 from /api/file-browser, and cannot open the terminal socket — from this.
|
|
if (permission.kind === 'confined') {
|
|
if (!hasOsAccount) continue;
|
|
grants.set(key, level);
|
|
continue;
|
|
}
|
|
|
|
if (permission.kind !== 'app') continue;
|
|
grants.set(key, level);
|
|
}
|
|
|
|
return { isOwner: false, grants };
|
|
}
|
|
|
|
export async function getEffectivePermissions(userId: number | undefined): Promise<EffectivePermissions> {
|
|
const empty: EffectivePermissions = { isOwner: false, grants: new Map() };
|
|
if (!userId) return empty;
|
|
|
|
try {
|
|
const user = await getUserById(userId);
|
|
if (!user) return empty;
|
|
if (user.role === 'Super Admin') return { isOwner: true, grants: new Map() };
|
|
return resolveEffectivePermissions(user, await grantsForRole(user.role));
|
|
} catch {
|
|
// A transient database error must never grant anything. Deny, and let the next request retry.
|
|
return empty;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* May this account make this HTTP request?
|
|
*
|
|
* `path` is the full request path. Paths outside `/api` are not this function's business — the DAV sync
|
|
* door authenticates with its own app password and never carries a platform account.
|
|
*/
|
|
export async function isApiRequestAllowed(
|
|
userId: number | undefined,
|
|
method: string,
|
|
path: string,
|
|
): Promise<{ allowed: boolean; reason?: string }> {
|
|
return decideApiRequest(await getEffectivePermissions(userId), method, path);
|
|
}
|
|
|
|
/** The decision, given an already-resolved account. Pure, and where every rule below actually lives. */
|
|
export function decideApiRequest(
|
|
effective: EffectivePermissions,
|
|
method: string,
|
|
path: string,
|
|
): { allowed: boolean; reason?: string } {
|
|
const { isOwner, grants } = effective;
|
|
if (isOwner) return { allowed: true };
|
|
|
|
const permission = permissionForApiPath(path);
|
|
// Totality guarantees every mounted, non-exempt prefix maps to a permission, so reaching this branch
|
|
// means either an exempt prefix (which the caller checks before us) or a path nothing serves. Deny:
|
|
// a 403 on a route that does not exist is not a leak, and a permissive default here would be.
|
|
if (!permission) return { allowed: false, reason: 'no permission covers this path' };
|
|
|
|
// BEFORE self-service, and before kind. A permission can be fully granted and still have an
|
|
// administrative corner — a plugin's settings, holding the credential the rest of it runs on. The owner
|
|
// already returned above, so reaching here at all means this is not them.
|
|
if (isOwnerOnlyRoute(permission, path)) {
|
|
return { allowed: false, reason: `that part of ${permission.label} is restricted to the server owner` };
|
|
}
|
|
|
|
// Checked before kind, because a self-service route acts on the caller and is therefore not the thing
|
|
// the permission around it restricts. Exact method and path only — see the field's comment.
|
|
if (isSelfServiceRoute(permission, method, path)) return { allowed: true };
|
|
|
|
if (permission.kind === 'execution') {
|
|
return { allowed: false, reason: `${permission.label} runs as the server owner and cannot be shared` };
|
|
}
|
|
if (permission.kind === 'admin') {
|
|
return { allowed: false, reason: `${permission.label} is restricted to the server owner` };
|
|
}
|
|
|
|
const level = grants.get(permission.key);
|
|
if (!level) return { allowed: false, reason: `your role does not have access to ${permission.label}` };
|
|
|
|
if (!isRequestAllowedAtLevel(permission, level, method, path)) {
|
|
return { allowed: false, reason: `you have read-only access to ${permission.label}` };
|
|
}
|
|
return { allowed: true };
|
|
}
|
|
|
|
/**
|
|
* May this account open this WebSocket provider?
|
|
*
|
|
* There is no method to reason about, so a socket needs the permission at any level.
|
|
*
|
|
* That rule was written for cliamp and cliamp-audio — the music app's playback transport, and the only
|
|
* grantable sockets there have ever been. Both left on 2026-08-15 with `plugins/music/cliamp/`, so every
|
|
* provider reaching here today belongs to an `execution` permission and is refused above, structurally,
|
|
* rather than by being left off a list. The rule stays because the first plugin to own a socket needs it.
|
|
*/
|
|
export async function isWsProviderAllowed(userId: number | undefined, provider: string): Promise<boolean> {
|
|
return decideWsProvider(await getEffectivePermissions(userId), provider);
|
|
}
|
|
|
|
/** The decision, given an already-resolved account. See `isWsProviderAllowed` for why level is not read. */
|
|
export function decideWsProvider(effective: EffectivePermissions, provider: string): boolean {
|
|
const { isOwner, grants } = effective;
|
|
if (isOwner) return true;
|
|
|
|
const permission = permissionForWsProvider(provider);
|
|
// `confined` is admissible here as well as `app`: getEffectivePermissions has already dropped confined
|
|
// grants for an account with no Linux user, so reaching this line with one in `grants` means the boundary
|
|
// exists. Anything still `execution` is refused structurally, by not being in the map at all.
|
|
if (!permission || (permission.kind !== 'app' && permission.kind !== 'confined')) return false;
|
|
return grants.has(permission.key);
|
|
}
|