ADR 0033 gave Ekklesia a display host and ADR 0034 gave it a login page. Together, the only way to light a television in a foyer was to sign a human being into it and leave that session running on a screen anyone can walk up to: a person's credentials on a wall, a person's session as the thing signage depends on, and the display going dark when they are revoked or their session simply expires. A screen is not a person. Ekklesia now recognizes three principal classes — anonymous, authenticated human, and managed device — and a device is a first-class principal with its own credential and its own explicit permissions. It has no email, no password, and no row in the identity tables, and it satisfies the `authenticated` baseline never, so every route that settles for "somebody is signed in" stays closed to it. Device permissions live in their own table because ekklesia_core_grant.user_id is a non-null foreign key into the user table and making it polymorphic would rewrite the platform's central authorization record to serve one narrow case. That is a schema decision, not a second decision point: the evaluator gained one branch, so a device is allowed or denied by the same function, with the same deny-by-default, as anyone else — with no owner path it could reach and no baseline that stands in for a grant. The six-digit code is not the credential. It is printed across a screen in a public hallway, so it is treated as public: it identifies a request to an administrator and is worth nothing alone. Collecting the credential also requires a 256-bit claim secret held only in the requesting browser's HttpOnly cookie, and approving requires the restricted core.devices.manage permission. Without that split, reading a code off a wall would hand over the screen's identity. The permission a pairing asks for is read from the module's validated display declaration, never from the request, so a browser cannot ask to be granted core.devices.manage or another module's permission. Approval grants exactly that one permission. Credentials are stored only as SHA-256; the raw value exists in the Set-Cookie that issues it and the device's own cookie jar, and is never logged, returned in JSON, or placed in a URL. The cookie is HttpOnly, so the module display code running in that same page cannot read it. Revocation is a server-side column checked on every principal resolution, and re-pairing mints a new identity so an old credential can never come back. State transitions are conditional updates, so one code cannot be approved twice or claimed into two credentials under a race. /api/v1/principal still reports a device as anonymous: it is what the Dashboard uses to decide whether a person is signed in. Displays read their viewer from the descriptor instead, which already performed the authorization — so displays are descriptor-first while the Dashboard stays principal-first, and neither infers an identity by elimination. Proven end to end against real PostgreSQL and real HTTP: an unpaired screen shows a code, an owner approves it, the device opens the display descriptor and a realtime stream, and revocation closes both while the device still holds its cookie. An already-open SSE stream is bounded by realtime's existing five-minute reconnect rather than closed instantly, and that bound is documented rather than called immediate. Co-Authored-By: Claude Opus 5 <[email protected]>
178 lines
7.8 KiB
TypeScript
178 lines
7.8 KiB
TypeScript
import {
|
|
AUTHORIZATION_ALLOWED,
|
|
AUTHORIZATION_DENIED,
|
|
type AuthorizationDecision,
|
|
type AuthorizationScope,
|
|
type EkklesiaPrincipal,
|
|
isAuthenticatedPrincipal,
|
|
isDevicePrincipal,
|
|
permissionBaselineSchema,
|
|
safeParseAuthorizationScope,
|
|
safeParsePermissionId,
|
|
} from "@ekklesia/contracts";
|
|
import type {
|
|
AuthorizationDevicePort,
|
|
AuthorizationGrantPort,
|
|
AuthorizationPlatformOwnerPort,
|
|
} from "./ports.js";
|
|
|
|
export type AuthorizationEvaluationErrorCode = "AUTHORIZATION_EVALUATION_FAILED";
|
|
|
|
/** Never carries the underlying port error, database error, cause, stack, or any other internal
|
|
* detail — defense in depth on top of whatever sanitization the injected ports themselves already
|
|
* perform (`core/src/authorization/store.ts` already sanitizes), exactly like
|
|
* `core/src/identity/runtime.ts`'s `resolvePrincipal` re-sanitizes on top of Better Auth's own
|
|
* error handling rather than trusting it exclusively. */
|
|
export class AuthorizationEvaluationError extends Error {
|
|
readonly code: AuthorizationEvaluationErrorCode;
|
|
|
|
constructor() {
|
|
super("The authorization decision could not be evaluated.");
|
|
this.name = "AuthorizationEvaluationError";
|
|
this.code = "AUTHORIZATION_EVALUATION_FAILED";
|
|
this.stack = `${this.name}: ${this.message}`;
|
|
Object.freeze(this);
|
|
}
|
|
}
|
|
|
|
export interface AuthorizeRequest {
|
|
readonly principal: EkklesiaPrincipal;
|
|
/** Validated internally via the branded `PermissionId` schema *before any baseline can return an
|
|
* allowed decision* — a malformed or unrecognizable value denies rather than throwing, for
|
|
* `public` and `authenticated` baselines exactly as much as `restricted`. This is shape
|
|
* validation only: the evaluator has no registry and cannot tell a well-formed-but-unregistered
|
|
* permission from one that is actually registered. Only a trusted caller consulting a
|
|
* `PermissionRegistry` (`core/src/authorization/permissions.ts`) before calling `authorize` can
|
|
* make that distinction — see that module and `apps/api/src/authorization-middleware.ts`. */
|
|
readonly permission: unknown;
|
|
/** Validated internally against the known `public`/`authenticated`/`restricted` set; anything
|
|
* else denies rather than throwing, for the same fail-closed reason. */
|
|
readonly baseline: unknown;
|
|
/** Optional; validated internally when present. Absent means an unscoped check. */
|
|
readonly scope?: unknown;
|
|
}
|
|
|
|
export interface AuthorizationEvaluator {
|
|
authorize(request: AuthorizeRequest): Promise<AuthorizationDecision>;
|
|
}
|
|
|
|
export interface CreateAuthorizationEvaluatorOptions {
|
|
readonly grants: AuthorizationGrantPort;
|
|
readonly platformOwners: AuthorizationPlatformOwnerPort;
|
|
/** Device authority. Optional so every existing caller composes unchanged; when it is absent a
|
|
* device principal simply has no permissions and is denied, which is the correct answer for a
|
|
* deployment that has no device support wired at all. */
|
|
readonly devices?: AuthorizationDevicePort;
|
|
/** Injectable clock so expiration evaluation is deterministic and testable. Defaults to the
|
|
* real wall clock; production composition must leave this unset. */
|
|
readonly now?: () => Date;
|
|
}
|
|
|
|
/**
|
|
* Core's Hono-independent, deny-by-default authorization evaluator. It is the only place
|
|
* Ekklesia decides whether a principal may exercise a permission, and it never trusts anything
|
|
* the caller supplies beyond `principal`/`permission`/`baseline`/`scope` — there is no field for a
|
|
* caller to assert "I am the owner" or "I already have this grant." Owner and grant state are
|
|
* always re-derived from the injected ports for every call.
|
|
*
|
|
* A genuine infrastructure failure from either port (for example a database outage) is
|
|
* deliberately NOT swallowed into a `denied` decision here: it propagates to the caller as a
|
|
* thrown, sanitized `AuthorizationEvaluationError`, exactly like Core's identity
|
|
* `resolvePrincipal` never silently downgrades an outage to "anonymous." Only a genuinely
|
|
* malformed or unrecognized permission/baseline/scope — a deterministic, expected input problem,
|
|
* not an infrastructure failure — resolves to `denied` without throwing.
|
|
*/
|
|
export function createAuthorizationEvaluator(
|
|
options: CreateAuthorizationEvaluatorOptions,
|
|
): AuthorizationEvaluator {
|
|
const now = options.now ?? (() => new Date());
|
|
|
|
return Object.freeze({
|
|
authorize: async (request: AuthorizeRequest): Promise<AuthorizationDecision> => {
|
|
const parsedBaseline = permissionBaselineSchema.safeParse(request.baseline);
|
|
if (!parsedBaseline.success) {
|
|
return AUTHORIZATION_DENIED;
|
|
}
|
|
|
|
// Shape-validated before any baseline is allowed to return `allowed` — a malformed
|
|
// permission id must deny under `public` and `authenticated` exactly as much as under
|
|
// `restricted`, even though neither of the first two ever reads `parsedPermission.data`.
|
|
// This is a pure, synchronous check: it never touches the grant or platform-owner ports, so
|
|
// `public`/`authenticated` still resolve with no database lookup at all.
|
|
const parsedPermission = safeParsePermissionId(request.permission);
|
|
if (!parsedPermission.success) {
|
|
return AUTHORIZATION_DENIED;
|
|
}
|
|
|
|
if (parsedBaseline.data === "public") {
|
|
return AUTHORIZATION_ALLOWED;
|
|
}
|
|
|
|
if (parsedBaseline.data === "authenticated") {
|
|
// A device deliberately does not satisfy this. The baseline means "a person is signed in",
|
|
// and every route that settles for it — the module UI inventory, anything a human is
|
|
// expected to be looking at — would otherwise open to an unattended screen (ADR 0036).
|
|
return isAuthenticatedPrincipal(request.principal)
|
|
? AUTHORIZATION_ALLOWED
|
|
: AUTHORIZATION_DENIED;
|
|
}
|
|
|
|
let scope: AuthorizationScope | undefined;
|
|
if (request.scope !== undefined) {
|
|
const parsedScope = safeParseAuthorizationScope(request.scope);
|
|
if (!parsedScope.success) {
|
|
return AUTHORIZATION_DENIED;
|
|
}
|
|
scope = parsedScope.data;
|
|
}
|
|
|
|
// A device satisfies `restricted` only by holding that exact permission, and by no other
|
|
// route: there is no owner check here, no baseline that stands in for a grant, and no branch
|
|
// that returns `allowed` before this lookup. "Paired" is not authority — a device that was
|
|
// paired for one display has nothing else.
|
|
if (isDevicePrincipal(request.principal)) {
|
|
if (!options.devices || scope !== undefined) {
|
|
// A scoped check has no device meaning yet; denying is the honest answer rather than
|
|
// silently treating it as unscoped.
|
|
return AUTHORIZATION_DENIED;
|
|
}
|
|
try {
|
|
return (await options.devices.hasActivePermission(
|
|
request.principal.deviceId,
|
|
parsedPermission.data,
|
|
))
|
|
? AUTHORIZATION_ALLOWED
|
|
: AUTHORIZATION_DENIED;
|
|
} catch {
|
|
throw new AuthorizationEvaluationError();
|
|
}
|
|
}
|
|
|
|
// parsedBaseline.data === "restricted": requires an authenticated principal AND
|
|
// (an active matching grant OR platform-owner authority). Baseline alone never satisfies it.
|
|
if (!isAuthenticatedPrincipal(request.principal)) {
|
|
return AUTHORIZATION_DENIED;
|
|
}
|
|
|
|
const userId = request.principal.userId;
|
|
let isOwner: boolean;
|
|
let hasGrant: boolean;
|
|
try {
|
|
[isOwner, hasGrant] = await Promise.all([
|
|
options.platformOwners.isPlatformOwner(userId),
|
|
options.grants.hasActiveGrant({
|
|
now: now(),
|
|
permission: parsedPermission.data,
|
|
userId,
|
|
...(scope === undefined ? {} : { scope }),
|
|
}),
|
|
]);
|
|
} catch {
|
|
throw new AuthorizationEvaluationError();
|
|
}
|
|
|
|
return isOwner || hasGrant ? AUTHORIZATION_ALLOWED : AUTHORIZATION_DENIED;
|
|
},
|
|
});
|
|
}
|