@camstack/server 1.2.78 → 1.2.79

package/dist/api/trpc/device-config-secret-redaction.js

@@ -0,0 +1,191 @@
+"use strict";
+/**
+ * Device-config secret redaction for NON-ADMIN principals.
+ *
+ * A device's `config` blob is the driver's connection record — host, port,
+ * username and, for every IP camera in the deployment, the camera's
+ * `password` in plaintext. It rides the wire on every device-manager read:
+ * `getDevice`, `listAll`, `getChildren`, and the three settings surfaces that
+ * project the same values into form fields.
+ *
+ * Those methods are declared `auth: 'protected'` (the default in
+ * `capability-definition.ts`), which is NOT admin — it is "authenticated, and
+ * scope-matched". Measured against the live hub: a `cst_*` scoped token
+ * carrying nothing but `category:system` + `view` — a READ-ONLY grant, the one
+ * the deploy runbook mints for CI — read `deviceManager.getDevice` and received
+ * `config.password` verbatim, and `deviceManager.listAll` answered with a
+ * populated password for every camera at once. Read-only access to a device
+ * list is not consent to hand over the credentials that open those cameras.
+ *
+ * WHY HERE, and not at the provider. `toDeviceInfo()` builds one `config` for
+ * everybody, and its in-process consumers need the real thing: the pipeline
+ * orchestrator's per-camera `getDevice`, dispatch routing, the drivers that
+ * actually connect. Those callers arrive through `ctx.api` / UDS and never
+ * touch this middleware, so redacting here withholds the secret from the WIRE
+ * without blinding the system to its own credentials. The transport boundary
+ * is also the only layer that knows the principal.
+ *
+ * WHY ADMINS ARE UNTOUCHED. The settings form renders the current value into a
+ * password field, and `updateConfig` is `auth: 'admin'`, so a redacted value
+ * can never be written back by a caller who received one. Making the field
+ * write-only for admins too is a bigger, UI-side change; it is not needed to
+ * close this hole and would regress the form.
+ *
+ * Share-view (`csv_*`) principals never reach this code — they are gated
+ * earlier by the fail-closed allowlist in `share-view-access.ts`, which does
+ * not expose `getDevice` at all and projects `listAll` down to seven presentation
+ * fields. This module is the gate for the tier BETWEEN a share link and an admin.
+ *
+ * Pure module — no tRPC machinery — so the spec exercises it directly (same
+ * pattern as `scope-access.ts` and `share-view-access.ts`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NON_ADMIN_CONFIG_REDACTED_METHODS = exports.REDACTED_SECRET = void 0;
+exports.isSecretConfigKey = isSecretConfigKey;
+exports.redactDeviceInfoSecrets = redactDeviceInfoSecrets;
+exports.redactSettingsSections = redactSettingsSections;
+exports.redactSettingsAggregate = redactSettingsAggregate;
+exports.redactConfigEntries = redactConfigEntries;
+/** What a non-admin sees instead of the value. Matches the `***` convention
+ *  `maskUrlCredentials` already uses for credentials in log output, so one
+ *  redaction marker means one thing across the system. */
+exports.REDACTED_SECRET = '***';
+/**
+ * Config keys whose VALUE is a credential.
+ *
+ * Deliberately the same rule the settings UI uses to decide that a field
+ * renders as a password input (`zodEntriesToConfigUI` in
+ * `packages/types/src/device/zod-to-config-ui.ts`). The two are pinned
+ * together by an assertion in `device-config-secret-redaction.spec.ts`: a
+ * keyword added to one and forgotten in the other fails the suite instead of
+ * leaking. It is duplicated rather than imported because `@camstack/types` is
+ * a framework package on the publish train, and a redaction fix must not have
+ * to wait for one.
+ */
+const SECRET_KEY_SUBSTRINGS = [
+    'password',
+    'secret',
+    'token',
+    'apikey',
+    'api_key',
+];
+/** True when a config key names a credential. Case-insensitive substring match. */
+function isSecretConfigKey(key) {
+    const lower = key.toLowerCase();
+    return SECRET_KEY_SUBSTRINGS.some((needle) => lower.includes(needle));
+}
+/** Non-null, non-array plain object. */
+function isRecord(x) {
+    return x !== null && typeof x === 'object' && !Array.isArray(x);
+}
+/**
+ * Replace the value of every credential-named key with {@link REDACTED_SECRET}.
+ *
+ * An EMPTY value stays empty: "not configured" and "configured, withheld" are
+ * different facts, and flattening them would make a broken camera look set up.
+ * A non-string value is left alone — a numeric `maxTokens` is not a secret, and
+ * the only credentials this repo persists are strings.
+ */
+function redactRecord(config) {
+    const out = {};
+    for (const [key, value] of Object.entries(config)) {
+        out[key] =
+            isSecretConfigKey(key) && typeof value === 'string' && value.length > 0
+                ? exports.REDACTED_SECRET
+                : value;
+    }
+    return out;
+}
+/**
+ * Project a `DeviceInfo` (or an array of them) with its `config` redacted.
+ * Anything that is not a device row passes through untouched — a route that
+ * errored upstream must not be rewritten into a plausible-looking shape.
+ */
+function redactDeviceInfoSecrets(data) {
+    if (Array.isArray(data))
+        return data.map((row) => redactDeviceInfoSecrets(row));
+    if (!isRecord(data))
+        return data;
+    const config = data['config'];
+    if (!isRecord(config))
+        return data;
+    return { ...data, config: redactRecord(config) };
+}
+/** One settings field as the aggregate emits it: `{ key, value, … }`. */
+function redactField(field) {
+    if (!isRecord(field))
+        return field;
+    const key = field['key'];
+    if (typeof key !== 'string' || !isSecretConfigKey(key))
+        return field;
+    const value = field['value'];
+    if (typeof value !== 'string' || value.length === 0)
+        return field;
+    return { ...field, value: exports.REDACTED_SECRET };
+}
+/**
+ * Project a `SettingsSchemaWithValues` (`{ sections: [{ fields: [...] }] }`).
+ * Used by `getDeviceSettingsAggregate` and `getSettingsSchema`.
+ */
+function redactSettingsSections(data) {
+    if (!isRecord(data))
+        return data;
+    const sections = data['sections'];
+    if (!Array.isArray(sections))
+        return data;
+    return {
+        ...data,
+        sections: sections.map((section) => {
+            if (!isRecord(section))
+                return section;
+            const fields = section['fields'];
+            if (!Array.isArray(fields))
+                return section;
+            return { ...section, fields: fields.map(redactField) };
+        }),
+    };
+}
+/**
+ * Project the combined aggregate, whose settings live one level down under
+ * `settings`. The live half carries no config blob.
+ */
+function redactSettingsAggregate(data) {
+    if (!isRecord(data))
+        return data;
+    const settings = data['settings'];
+    if (!isRecord(settings))
+        return data;
+    return { ...data, settings: redactSettingsSections(settings) };
+}
+/** Project a flat `ConfigEntry[]` — `getConfigSchema`'s `{ key, value }` rows. */
+function redactConfigEntries(data) {
+    if (!Array.isArray(data))
+        return data;
+    return data.map(redactField);
+}
+/**
+ * Every device-manager read whose response carries a device `config` blob, and
+ * the projection that cuts it.
+ *
+ * ENUMERATED rather than applied blanket-wise on purpose: a structural
+ * "redact anything credential-named" pass over every non-admin response would
+ * also strip `turnProvider.getTurnServers().credential` (the browser needs it),
+ * `auth.listShareTokens().tokenPrefix`, and a notification rule's
+ * `conditions.eventTypeTokens` — breaking live surfaces to fix a leak that
+ * lives in one cap.
+ *
+ * `deviceManager.listPersistedByAddon` is absent by inspection, not omission:
+ * `SavedDeviceRowSchema` has no `config` field, confirmed against the live hub.
+ * A new device-manager method returning `DeviceInfoSchema` must be added here —
+ * `device-config-secret-redaction.spec.ts` pins the list so the addition is a
+ * failing test rather than a silent leak.
+ */
+exports.NON_ADMIN_CONFIG_REDACTED_METHODS = new Map([
+    ['deviceManager.getDevice', redactDeviceInfoSecrets],
+    ['deviceManager.listAll', redactDeviceInfoSecrets],
+    ['deviceManager.getChildren', redactDeviceInfoSecrets],
+    ['deviceManager.getDeviceSettingsAggregate', redactSettingsSections],
+    ['deviceManager.getSettingsSchema', redactSettingsSections],
+    ['deviceManager.getDeviceAggregate', redactSettingsAggregate],
+    ['deviceManager.getConfigSchema', redactConfigEntries],
+]);

package/dist/api/trpc/trpc.middleware.js

@@ -10,6 +10,7 @@ const system_1 = require("@camstack/system");
 const server_1 = require("@trpc/server");
 const superjson_1 = __importDefault(require("superjson"));
 const cap_route_error_formatter_js_1 = require("./cap-route-error-formatter.js");
+const device_config_secret_redaction_js_1 = require("./device-config-secret-redaction.js");
 const scope_access_js_1 = require("./scope-access.js");
 const share_view_access_js_1 = require("./share-view-access.js");
 const t = server_1.initTRPC.context().create({
@@ -136,23 +137,37 @@ exports.protectedProcedure = t.procedure.use(async ({ ctx, next, path, getRawInp
     if (ctx.user.isAdmin) {
         return next({ ctx: { ...ctx, user: ctx.user } });
     }
-    // Hand-written core route — no cap entry. Authentication has already
-    // passed; defer further gating to any explicit `adminProcedure`
-    // chained on top of this one.
-    if (!(path in system_1.METHOD_ACCESS_MAP)) {
-        return next({ ctx: { ...ctx, user: ctx.user } });
+    // Everything below this line is a NON-ADMIN principal.
+    //
+    // A hand-written core route has no cap entry. Authentication has
+    // already passed; defer further gating to any explicit
+    // `adminProcedure` chained on top of this one. A cap route is
+    // scope-matched first.
+    if (path in system_1.METHOD_ACCESS_MAP) {
+        // Device-scope caps may be gated by a `device:N` scope. Resolve the
+        // raw input once so the matcher can read `input.deviceId` without
+        // re-doing the Zod parse (tRPC caches the parsed input downstream).
+        // The `getDeviceAncestors` hook lets the matcher walk parent → child
+        // accessory inheritance (grant on Reolink also covers its siren / PIR).
+        const rawInput = await getRawInput();
+        const result = (0, scope_access_js_1.checkScopeAccess)(ctx.user.scopes ?? [], path, rawInput, ctx.getDeviceAncestors);
+        if (!result.ok) {
+            throw new server_1.TRPCError({ code: 'FORBIDDEN', message: result.reason });
+        }
     }
-    // Device-scope caps may be gated by a `device:N` scope. Resolve the
-    // raw input once so the matcher can read `input.deviceId` without
-    // re-doing the Zod parse (tRPC caches the parsed input downstream).
-    // The `getDeviceAncestors` hook lets the matcher walk parent → child
-    // accessory inheritance (grant on Reolink also covers its siren / PIR).
-    const rawInput = await getRawInput();
-    const result = (0, scope_access_js_1.checkScopeAccess)(ctx.user.scopes ?? [], path, rawInput, ctx.getDeviceAncestors);
-    if (!result.ok) {
-        throw new server_1.TRPCError({ code: 'FORBIDDEN', message: result.reason });
+    // A non-admin who is allowed to READ a device is not thereby allowed to
+    // read the credential that opens it. `deviceManager.getDevice` &co. are
+    // `auth: 'protected'`, so a read-only `category:system` grant reaches
+    // them — and the raw row carries `config.password` in plaintext for
+    // every camera in the deployment. The value is withheld HERE, at the
+    // transport boundary, so in-process callers (`ctx.api`, the pipeline
+    // orchestrator, the drivers that must actually connect) are unaffected.
+    const redactConfigSecrets = device_config_secret_redaction_js_1.NON_ADMIN_CONFIG_REDACTED_METHODS.get(path);
+    const out = await next({ ctx: { ...ctx, user: ctx.user } });
+    if (redactConfigSecrets && out.ok) {
+        return { ...out, data: redactConfigSecrets(out.data) };
     }
-    return next({ ctx: { ...ctx, user: ctx.user } });
+    return out;
 });
 /**
  * Destructive-ops gate. Adds an explicit admin check on top of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/server",
-  "version": "1.2.78",
+  "version": "1.2.79",
   "private": false,
   "files": [
     "dist",
@@ -33,19 +33,19 @@
     ]
   },
   "dependencies": {
-    "@camstack/addon-admin-ui": "1.2.38",
+    "@camstack/addon-admin-ui": "1.2.39",
     "@camstack/addon-agent-ui": "1.2.10",
     "@camstack/addon-auth": "1.2.11",
     "@camstack/addon-decoder-nodeav": "1.2.9",
     "@camstack/addon-notifiers": "1.2.13",
-    "@camstack/addon-pipeline": "1.2.49",
-    "@camstack/addon-pipeline-orchestrator": "1.2.32",
+    "@camstack/addon-pipeline": "1.2.51",
+    "@camstack/addon-pipeline-orchestrator": "1.2.33",
     "@camstack/addon-post-analysis": "1.2.54",
     "@camstack/sdk": "1.2.10",
     "@camstack/shm-ring": "1.1.9",
-    "@camstack/system": "1.2.64",
-    "@camstack/types": "1.2.48",
-    "@camstack/ui-library": "1.2.35",
+    "@camstack/system": "1.2.66",
+    "@camstack/types": "1.2.50",
+    "@camstack/ui-library": "1.2.36",
     "@fastify/compress": "^9.0.0",
     "@fastify/cookie": "^11.0.2",
     "@fastify/cors": "^11.2.0",