@blamejs/core 0.7.4 → 0.7.18

package/lib/middleware/db-role-for.js

@@ -1,264 +1,264 @@
-"use strict";
-/**
- * dbRoleFor middleware — binds a request-time DB role.
- *
- * Operators using the search_path-views compliance recipe (see
- * b.db.declareView and the Compliance Patterns wiki page) declare two
- * Postgres roles: app_user (full source) and analytics_user (redacted
- * view). Each role gets its own externalDb backend — same SQL,
- * different connection pool. dbRoleFor picks the role for the current
- * request and pushes it into the shared db-role-context AsyncLocalStorage
- * scope so b.externalDb.query / read / write / transaction auto-route
- * to the matching backend without any operator threading of the role
- * through their handler signature.
- *
- *   var perms = b.permissions.create({
- *     roles: {
- *       admin:    { extends: ["app"],   permissions: ["*:*"] },
- *       app:      { permissions: ["sessions:*"], dbRole: "app_user" },
- *       analyst:  { permissions: ["sessions:read"], dbRole: "analytics_user" },
- *     },
- *   });
- *
- *   router.use(b.middleware.attachUser(...));
- *   router.use(b.middleware.dbRoleFor({
- *     permissions: perms,                 // resolves dbRole from req.user.roles
- *     defaultRole: "app_user",
- *   }));
- *
- *   router.get("/sessions", function (req, res) {
- *     // No `{ backend: ... }` opt — the framework picked it from req.dbRole.
- *     b.externalDb.read.query("SELECT * FROM sessions WHERE _id = $1", [sid])
- *       .then(...);
- *   });
- *
- * Resolution order:
- *   1. opts.resolve(req)           — operator-supplied custom resolver
- *   2. opts.permissions.dbRoleFor  — RBAC mapping (when permissions provided)
- *   3. opts.defaultRole            — fallback string
- *   4. null                        — no binding (externalDb falls back to default backend)
- *
- * Validation at create() time — bad shape throws here, not at the first
- * request:
- *   - opts shape (validateOpts allow-list)
- *   - resolve / responder must be functions if provided
- *   - permissions must expose dbRoleFor (the b.permissions shape)
- *   - defaultRole, when provided, must be a SQL-identifier-shaped string
- *   - missingRoleStatus must be a 100-599 integer
- *
- * Runtime validation on resolver output:
- *   - resolver returns must be string | null | undefined
- *   - non-empty string return MUST match safeSql.validateIdentifier; a
- *     malformed identifier from a resolver is a wiring bug (the operator
- *     plugged in a resolver that returns garbage). Routed through
- *     next(err) so the request surfaces a clear error instead of silently
- *     routing to the default backend.
- *
- * Failure modes:
- *   - resolver throws            → 500 propagated via next(err)
- *   - role required but absent   → respond with missingRoleStatus (default 401)
- *   - role identifier malformed  → respond with 500 (resolver bug — not a runtime user error)
- *
- * Observability event: db.role.bound { value: 1, labels: { role, source } }
- *   source ∈ "resolver" | "permissions" | "default"
- *
- * Audit emission: db.role.switched is recorded once per request when a
- * role binds. The audit row carries the actor 5 W's via
- * requestHelpers.extractActorContext and metadata { previousRole,
- * newRole, source }. Defaults align with the framework's "the
- * authorization decision IS the audit-worthy event" stance — both
- * auditFailures and auditSuccess default true. The audit sink can be
- * pinned via opts.audit (any object exposing safeEmit), defaults to
- * the framework's b.audit.
- */
-var dbRoleContext = require("../db-role-context");
-var lazyRequire = require("../lazy-require");
-var requestHelpers = require("../request-helpers");
-var safeSql = require("../safe-sql");
-var validateOpts = require("../validate-opts");
-var { defineClass } = require("../framework-error");
-
-var audit        = lazyRequire(function () { return require("../audit"); });
-var observability = lazyRequire(function () { return require("../observability"); });
-
-var DbRoleForError = defineClass("DbRoleForError", { alwaysPermanent: true });
-var _err = function (code, message) { return new DbRoleForError(code, message); };
-
-var ALLOWED_OPTS = [
-  "resolve", "permissions", "defaultRole",
-  "requireRole", "missingRoleStatus", "responder",
-  "audit", "auditFailures", "auditSuccess",
-];
-
-function _emitEvent(n, v, l) { observability().safeEvent(n, v, l || {}); }
-
-function _validateRoleIdentifier(role, where) {
-  try {
-    safeSql.validateIdentifier(role, { allowReserved: false });
-  } catch (e) {
-    throw _err("db-role-for/bad-role",
-      where + ": role '" + role + "' is not a valid SQL identifier: " +
-      ((e && e.message) || String(e)));
-  }
-}
-
-function _defaultResponder(req, res, status, info) {
-  res.writeHead(status, { "Content-Type": "application/json; charset=utf-8" });
-  res.end(JSON.stringify(info));
-}
-
-function create(opts) {
-  opts = opts || {};
-  validateOpts(opts, ALLOWED_OPTS, "middleware.dbRoleFor");
-
-  validateOpts.optionalFunction(opts.resolve, "middleware.dbRoleFor: resolve", DbRoleForError, "db-role-for/bad-opt");
-  validateOpts.optionalFunction(opts.responder, "middleware.dbRoleFor: responder", DbRoleForError, "db-role-for/bad-opt");
-  validateOpts.optionalObjectWithMethod(opts.permissions, "dbRoleFor",
-    "middleware.dbRoleFor: permissions", DbRoleForError, "db-role-for/bad-opt",
-    "must be a b.permissions instance (missing dbRoleFor method)");
-  if (opts.defaultRole !== undefined && opts.defaultRole !== null) {
-    if (typeof opts.defaultRole !== "string" || opts.defaultRole.length === 0) {
-      throw _err("db-role-for/bad-opt",
-        "middleware.dbRoleFor: defaultRole must be a non-empty string");
-    }
-    _validateRoleIdentifier(opts.defaultRole, "middleware.dbRoleFor: defaultRole");
-  }
-  validateOpts.optionalBoolean(opts.requireRole, "middleware.dbRoleFor: requireRole", DbRoleForError, "db-role-for/bad-opt");
-  if (opts.missingRoleStatus !== undefined) {
-    if (typeof opts.missingRoleStatus !== "number" ||
-        !isFinite(opts.missingRoleStatus) ||
-        opts.missingRoleStatus < 100 || opts.missingRoleStatus > 599) {
-      throw _err("db-role-for/bad-opt",
-        "middleware.dbRoleFor: missingRoleStatus must be an HTTP status code (100-599)");
-    }
-  }
-  validateOpts.auditShape(opts.audit, "middleware.dbRoleFor", DbRoleForError, "db-role-for/bad-opt");
-  validateOpts.optionalBoolean(opts.auditFailures, "middleware.dbRoleFor: auditFailures", DbRoleForError, "db-role-for/bad-opt");
-  validateOpts.optionalBoolean(opts.auditSuccess, "middleware.dbRoleFor: auditSuccess", DbRoleForError, "db-role-for/bad-opt");
-
-  var resolveFn         = opts.resolve || null;
-  var perms             = opts.permissions || null;
-  var defaultRole       = opts.defaultRole || null;
-  var requireRole       = !!opts.requireRole;
-  var missingRoleStatus = opts.missingRoleStatus || 401;
-  var responder         = opts.responder || _defaultResponder;
-  // Audit defaults match permissions: the role-binding decision IS the
-  // audit-worthy act. Operators with extreme volume opt out via
-  // auditSuccess: false; failures stay on regardless. The audit sink
-  // defaults to the framework's b.audit; operators with multiple audit
-  // chains pass their own (matches captureAudit's shape).
-  var auditSink         = opts.audit || null;
-  var auditFailures     = (opts.auditFailures === undefined) ? true : opts.auditFailures;
-  var auditSuccess      = (opts.auditSuccess  === undefined) ? true : opts.auditSuccess;
-
-  return function dbRoleForMiddleware(req, res, next) {
-    var role = null;
-    var source = null;
-
-    if (resolveFn) {
-      var resolved;
-      try { resolved = resolveFn(req); }
-      catch (e) { return next(e); }
-      if (resolved !== undefined && resolved !== null && resolved !== "") {
-        role = resolved;
-        source = "resolver";
-      }
-    }
-
-    if (!role && perms) {
-      // permissions.dbRoleFor walks req.user.roles / req.apiKey.scopes via
-      // the configured resolver and returns the first declared dbRole.
-      var fromPerms;
-      try { fromPerms = perms.dbRoleFor(req); }
-      catch (e) { return next(e); }
-      if (fromPerms) {
-        role = fromPerms;
-        source = "permissions";
-      }
-    }
-
-    if (!role && defaultRole) {
-      role = defaultRole;
-      source = "default";
-    }
-
-    if (!role) {
-      if (requireRole) {
-        _emitEvent("db.role.missing", 1, {});
-        if (auditFailures) {
-          _auditSwitch(auditSink, req, {
-            previousRole: dbRoleContext.getRole(),
-            newRole:      null,
-            source:       "middleware",
-            outcome:      "failure",
-            reason:       "no-role",
-          });
-        }
-        return responder(req, res, missingRoleStatus, {
-          error:  "missing_db_role",
-          status: missingRoleStatus,
-        });
-      }
-      // No binding — let externalDb fall back to its default backend.
-      req.dbRole = null;
-      return next();
-    }
-
-    if (typeof role !== "string") {
-      return next(_err("db-role-for/bad-resolver-return",
-        "middleware.dbRoleFor: resolver returned non-string role: " + typeof role));
-    }
-    // Validate the resolver-supplied identifier at request time — a
-    // malformed identifier is a wiring bug, not a request-shape concern.
-    // Route the throw through next(err) so an operator's errorHandler
-    // reaches it instead of the request hanging.
-    try {
-      _validateRoleIdentifier(role, "middleware.dbRoleFor: resolver/" + source);
-    } catch (e) {
-      return next(e);
-    }
-
-    var previousRole = dbRoleContext.getRole();
-    req.dbRole = role;
-    _emitEvent("db.role.bound", 1, { role: role, source: source });
-    if (auditSuccess) {
-      _auditSwitch(auditSink, req, {
-        previousRole: previousRole,
-        newRole:      role,
-        source:       "middleware",
-        outcome:      "success",
-      });
-    }
-    dbRoleContext.runWithRole(role, function () { next(); });
-  };
-}
-
-// Emit the db.role.switched audit row. Fire-and-forget — the audit
-// handler's own try/catch keeps a momentary outage from breaking the
-// request. The actor 5 W's come from extractActorContext (req-driven);
-// metadata carries the previous + new role + binding source so a
-// forensic walker can reconstruct "which role read which row when."
-// The sink defaults to the framework's b.audit when the operator
-// didn't pass an explicit instance.
-function _auditSwitch(sink, req, info) {
-  try {
-    var emitter = sink || audit();
-    emitter.safeEmit({
-      action:   "db.role.switched",
-      actor:    requestHelpers.extractActorContext(req),
-      resource: { kind: "db.role", id: info.newRole || "(none)" },
-      outcome:  info.outcome || "success",
-      reason:   info.reason || null,
-      metadata: {
-        previousRole: info.previousRole || null,
-        newRole:      info.newRole || null,
-        source:       info.source,
-      },
-    });
-  } catch (_e) { /* audit best-effort */ }
-}
-
-module.exports = {
-  create:           create,
-  DbRoleForError:   DbRoleForError,
-};
+"use strict";
+/**
+ * dbRoleFor middleware — binds a request-time DB role.
+ *
+ * Operators using the search_path-views compliance recipe (see
+ * b.db.declareView and the Compliance Patterns wiki page) declare two
+ * Postgres roles: app_user (full source) and analytics_user (redacted
+ * view). Each role gets its own externalDb backend — same SQL,
+ * different connection pool. dbRoleFor picks the role for the current
+ * request and pushes it into the shared db-role-context AsyncLocalStorage
+ * scope so b.externalDb.query / read / write / transaction auto-route
+ * to the matching backend without any operator threading of the role
+ * through their handler signature.
+ *
+ *   var perms = b.permissions.create({
+ *     roles: {
+ *       admin:    { extends: ["app"],   permissions: ["*:*"] },
+ *       app:      { permissions: ["sessions:*"], dbRole: "app_user" },
+ *       analyst:  { permissions: ["sessions:read"], dbRole: "analytics_user" },
+ *     },
+ *   });
+ *
+ *   router.use(b.middleware.attachUser(...));
+ *   router.use(b.middleware.dbRoleFor({
+ *     permissions: perms,                 // resolves dbRole from req.user.roles
+ *     defaultRole: "app_user",
+ *   }));
+ *
+ *   router.get("/sessions", function (req, res) {
+ *     // No `{ backend: ... }` opt — the framework picked it from req.dbRole.
+ *     b.externalDb.read.query("SELECT * FROM sessions WHERE _id = $1", [sid])
+ *       .then(...);
+ *   });
+ *
+ * Resolution order:
+ *   1. opts.resolve(req)           — operator-supplied custom resolver
+ *   2. opts.permissions.dbRoleFor  — RBAC mapping (when permissions provided)
+ *   3. opts.defaultRole            — fallback string
+ *   4. null                        — no binding (externalDb falls back to default backend)
+ *
+ * Validation at create() time — bad shape throws here, not at the first
+ * request:
+ *   - opts shape (validateOpts allow-list)
+ *   - resolve / responder must be functions if provided
+ *   - permissions must expose dbRoleFor (the b.permissions shape)
+ *   - defaultRole, when provided, must be a SQL-identifier-shaped string
+ *   - missingRoleStatus must be a 100-599 integer
+ *
+ * Runtime validation on resolver output:
+ *   - resolver returns must be string | null | undefined
+ *   - non-empty string return MUST match safeSql.validateIdentifier; a
+ *     malformed identifier from a resolver is a wiring bug (the operator
+ *     plugged in a resolver that returns garbage). Routed through
+ *     next(err) so the request surfaces a clear error instead of silently
+ *     routing to the default backend.
+ *
+ * Failure modes:
+ *   - resolver throws            → 500 propagated via next(err)
+ *   - role required but absent   → respond with missingRoleStatus (default 401)
+ *   - role identifier malformed  → respond with 500 (resolver bug — not a runtime user error)
+ *
+ * Observability event: db.role.bound { value: 1, labels: { role, source } }
+ *   source ∈ "resolver" | "permissions" | "default"
+ *
+ * Audit emission: db.role.switched is recorded once per request when a
+ * role binds. The audit row carries the actor 5 W's via
+ * requestHelpers.extractActorContext and metadata { previousRole,
+ * newRole, source }. Defaults align with the framework's "the
+ * authorization decision IS the audit-worthy event" stance — both
+ * auditFailures and auditSuccess default true. The audit sink can be
+ * pinned via opts.audit (any object exposing safeEmit), defaults to
+ * the framework's b.audit.
+ */
+var dbRoleContext = require("../db-role-context");
+var lazyRequire = require("../lazy-require");
+var requestHelpers = require("../request-helpers");
+var safeSql = require("../safe-sql");
+var validateOpts = require("../validate-opts");
+var { defineClass } = require("../framework-error");
+
+var audit        = lazyRequire(function () { return require("../audit"); });
+var observability = lazyRequire(function () { return require("../observability"); });
+
+var DbRoleForError = defineClass("DbRoleForError", { alwaysPermanent: true });
+var _err = function (code, message) { return new DbRoleForError(code, message); };
+
+var ALLOWED_OPTS = [
+  "resolve", "permissions", "defaultRole",
+  "requireRole", "missingRoleStatus", "responder",
+  "audit", "auditFailures", "auditSuccess",
+];
+
+function _emitEvent(n, v, l) { observability().safeEvent(n, v, l || {}); }
+
+function _validateRoleIdentifier(role, where) {
+  try {
+    safeSql.validateIdentifier(role, { allowReserved: false });
+  } catch (e) {
+    throw _err("db-role-for/bad-role",
+      where + ": role '" + role + "' is not a valid SQL identifier: " +
+      ((e && e.message) || String(e)));
+  }
+}
+
+function _defaultResponder(req, res, status, info) {
+  res.writeHead(status, { "Content-Type": "application/json; charset=utf-8" });
+  res.end(JSON.stringify(info));
+}
+
+function create(opts) {
+  opts = opts || {};
+  validateOpts(opts, ALLOWED_OPTS, "middleware.dbRoleFor");
+
+  validateOpts.optionalFunction(opts.resolve, "middleware.dbRoleFor: resolve", DbRoleForError, "db-role-for/bad-opt");
+  validateOpts.optionalFunction(opts.responder, "middleware.dbRoleFor: responder", DbRoleForError, "db-role-for/bad-opt");
+  validateOpts.optionalObjectWithMethod(opts.permissions, "dbRoleFor",
+    "middleware.dbRoleFor: permissions", DbRoleForError, "db-role-for/bad-opt",
+    "must be a b.permissions instance (missing dbRoleFor method)");
+  if (opts.defaultRole !== undefined && opts.defaultRole !== null) {
+    if (typeof opts.defaultRole !== "string" || opts.defaultRole.length === 0) {
+      throw _err("db-role-for/bad-opt",
+        "middleware.dbRoleFor: defaultRole must be a non-empty string");
+    }
+    _validateRoleIdentifier(opts.defaultRole, "middleware.dbRoleFor: defaultRole");
+  }
+  validateOpts.optionalBoolean(opts.requireRole, "middleware.dbRoleFor: requireRole", DbRoleForError, "db-role-for/bad-opt");
+  if (opts.missingRoleStatus !== undefined) {
+    if (typeof opts.missingRoleStatus !== "number" ||
+        !isFinite(opts.missingRoleStatus) ||
+        opts.missingRoleStatus < 100 || opts.missingRoleStatus > 599) {
+      throw _err("db-role-for/bad-opt",
+        "middleware.dbRoleFor: missingRoleStatus must be an HTTP status code (100-599)");
+    }
+  }
+  validateOpts.auditShape(opts.audit, "middleware.dbRoleFor", DbRoleForError, "db-role-for/bad-opt");
+  validateOpts.optionalBoolean(opts.auditFailures, "middleware.dbRoleFor: auditFailures", DbRoleForError, "db-role-for/bad-opt");
+  validateOpts.optionalBoolean(opts.auditSuccess, "middleware.dbRoleFor: auditSuccess", DbRoleForError, "db-role-for/bad-opt");
+
+  var resolveFn         = opts.resolve || null;
+  var perms             = opts.permissions || null;
+  var defaultRole       = opts.defaultRole || null;
+  var requireRole       = !!opts.requireRole;
+  var missingRoleStatus = opts.missingRoleStatus || 401;
+  var responder         = opts.responder || _defaultResponder;
+  // Audit defaults match permissions: the role-binding decision IS the
+  // audit-worthy act. Operators with extreme volume opt out via
+  // auditSuccess: false; failures stay on regardless. The audit sink
+  // defaults to the framework's b.audit; operators with multiple audit
+  // chains pass their own (matches captureAudit's shape).
+  var auditSink         = opts.audit || null;
+  var auditFailures     = (opts.auditFailures === undefined) ? true : opts.auditFailures;
+  var auditSuccess      = (opts.auditSuccess  === undefined) ? true : opts.auditSuccess;
+
+  return function dbRoleForMiddleware(req, res, next) {
+    var role = null;
+    var source = null;
+
+    if (resolveFn) {
+      var resolved;
+      try { resolved = resolveFn(req); }
+      catch (e) { return next(e); }
+      if (resolved !== undefined && resolved !== null && resolved !== "") {
+        role = resolved;
+        source = "resolver";
+      }
+    }
+
+    if (!role && perms) {
+      // permissions.dbRoleFor walks req.user.roles / req.apiKey.scopes via
+      // the configured resolver and returns the first declared dbRole.
+      var fromPerms;
+      try { fromPerms = perms.dbRoleFor(req); }
+      catch (e) { return next(e); }
+      if (fromPerms) {
+        role = fromPerms;
+        source = "permissions";
+      }
+    }
+
+    if (!role && defaultRole) {
+      role = defaultRole;
+      source = "default";
+    }
+
+    if (!role) {
+      if (requireRole) {
+        _emitEvent("db.role.missing", 1, {});
+        if (auditFailures) {
+          _auditSwitch(auditSink, req, {
+            previousRole: dbRoleContext.getRole(),
+            newRole:      null,
+            source:       "middleware",
+            outcome:      "failure",
+            reason:       "no-role",
+          });
+        }
+        return responder(req, res, missingRoleStatus, {
+          error:  "missing_db_role",
+          status: missingRoleStatus,
+        });
+      }
+      // No binding — let externalDb fall back to its default backend.
+      req.dbRole = null;
+      return next();
+    }
+
+    if (typeof role !== "string") {
+      return next(_err("db-role-for/bad-resolver-return",
+        "middleware.dbRoleFor: resolver returned non-string role: " + typeof role));
+    }
+    // Validate the resolver-supplied identifier at request time — a
+    // malformed identifier is a wiring bug, not a request-shape concern.
+    // Route the throw through next(err) so an operator's errorHandler
+    // reaches it instead of the request hanging.
+    try {
+      _validateRoleIdentifier(role, "middleware.dbRoleFor: resolver/" + source);
+    } catch (e) {
+      return next(e);
+    }
+
+    var previousRole = dbRoleContext.getRole();
+    req.dbRole = role;
+    _emitEvent("db.role.bound", 1, { role: role, source: source });
+    if (auditSuccess) {
+      _auditSwitch(auditSink, req, {
+        previousRole: previousRole,
+        newRole:      role,
+        source:       "middleware",
+        outcome:      "success",
+      });
+    }
+    dbRoleContext.runWithRole(role, function () { next(); });
+  };
+}
+
+// Emit the db.role.switched audit row. Fire-and-forget — the audit
+// handler's own try/catch keeps a momentary outage from breaking the
+// request. The actor 5 W's come from extractActorContext (req-driven);
+// metadata carries the previous + new role + binding source so a
+// forensic walker can reconstruct "which role read which row when."
+// The sink defaults to the framework's b.audit when the operator
+// didn't pass an explicit instance.
+function _auditSwitch(sink, req, info) {
+  try {
+    var emitter = sink || audit();
+    emitter.safeEmit({
+      action:   "db.role.switched",
+      actor:    requestHelpers.extractActorContext(req),
+      resource: { kind: "db.role", id: info.newRole || "(none)" },
+      outcome:  info.outcome || "success",
+      reason:   info.reason || null,
+      metadata: {
+        previousRole: info.previousRole || null,
+        newRole:      info.newRole || null,
+        source:       info.source,
+      },
+    });
+  } catch (_e) { /* audit best-effort */ }
+}
+
+module.exports = {
+  create:           create,
+  DbRoleForError:   DbRoleForError,
+};