@dbx-tools/appkit 0.6.48 → 0.6.49

package/README.md

@@ -38,6 +38,9 @@ Use this package when the friction is around bootstrapping and reuse:
 - AppKit does not own your local CLI flags, bundle validation output, or
   `app.yaml`; `config.resolveConfigValue()` gives setup scripts one resolution
   path across those sources.
+- AppKit's `asUser(req)` throws outside `NODE_ENV=development` when a request
+  carries no OBO token; `identity` makes falling back to the service principal a
+  configured, per-request decision instead of a `NODE_ENV` side effect.
 
 ## Create An Auto-Configured App
 
@@ -231,6 +234,58 @@ Pass a second argument to report progress on your own logger. The grants are
 skipped inside a Databricks App, and any failure is logged rather than thrown so
 a degraded cache never blocks startup.
 
+## Choose The Request Identity
+
+AppKit gives a plugin two identities: the ambient service context (the app's own
+service principal) and a per-request user context entered with `asUser(req)`,
+which authenticates on-behalf-of (OBO) using the token the Databricks front door
+forwards on `x-forwarded-access-token`. When that header is absent, AppKit's
+behaviour depends entirely on `NODE_ENV`:
+
+| `NODE_ENV`    | `asUser(req)` with no `x-forwarded-access-token`       |
+| ------------- | ------------------------------------------------------ |
+| `development` | logs a warning, silently runs as the service principal |
+| anything else | throws `AuthenticationError: Missing user token`       |
+
+That throw is right for an app behind the front door, where a missing token means
+something is broken. It is fatal for an app whose traffic legitimately arrives
+without one - a public tunnel where callers authenticate by email code
+([`@dbx-tools/cli-tunnel`](../../cli/tunnel)), or a bot channel that validates its
+own inbound JWT (`POST /api/teams/messages`). Those apps must not run with
+`NODE_ENV=development` just to get the fallback, since that flag also relaxes
+secure cookies and unlocks other dev-only escape hatches.
+
+`identity` is that decision, made explicit:
+
+```ts
+import { identity } from "@dbx-tools/appkit";
+
+const mode = identity.resolveIdentityMode(config.identity, "MY_APP_IDENTITY");
+
+// One call decides whether this request enters `asUser`.
+const scoped = identity.useServicePrincipal(mode, req) ? this : this.asUser(req);
+const rows = await scoped.executeQuery(sql);
+```
+
+| Mode                | Behaviour                                                                    |
+| ------------------- | ---------------------------------------------------------------------------- |
+| `user` (default)    | Always OBO. Per-user attribution and per-user Genie / Unity Catalog filters. |
+| `service-principal` | Always the app's own identity. Needs no OBO scopes and serves any caller.    |
+| `auto`              | OBO when the request carries a usable token, service principal otherwise.    |
+
+`auto` decides per REQUEST, not per boot, because one container can serve both
+doors at once - the tunnel gate and the platform front door share a port. A
+boot-time flag would have to be wrong for one of them. An unrecognized configured
+value throws a `ConfigurationError` rather than falling back, because a typo
+(`"obo"`, `"sp"`) would otherwise keep serving the very error the option was set
+to avoid.
+
+Running as the service principal does not change WHO the request belongs to. The
+caller still arrives on `x-forwarded-user` / `x-forwarded-email` (read them with
+`identity.requestUserId()` / `requestUserEmail()`), so memory threads, cache
+namespaces, and trace attribution stay per-user - only the Databricks credential
+is shared. `@dbx-tools/appkit-mastra` exposes this as its `genieIdentity` option.
+
 ## Modules
 
 | Module             | Responsibility                                                                             |
@@ -243,6 +298,7 @@ a degraded cache never blocks startup.
 | `databricks`       | App env detection and SDK context cancellation adapters.                                   |
 | `plugin`           | Typed AppKit plugin data, instance, and required-instance lookup.                          |
 | `provision`        | Cache schema provisioning helpers.                                                         |
+| `identity`         | OBO-vs-service-principal request identity: modes, resolution, and the forwarded headers.   |
 
 The shell-facing wrapper for auto-config is
 [`@dbx-tools/cli-appkit-env`](../../cli/appkit-env). Higher-level agent composition

package/index.ts

@@ -6,6 +6,7 @@ export * as appkit from "./src/appkit.ts";
 export * as config from "./src/config.ts";
 export * as createApp from "./src/create-app.ts";
 export * as databricks from "./src/databricks.ts";
+export * as identity from "./src/identity.ts";
 export * as lakebaseResolver from "./src/lakebase-resolver.ts";
 export * as pgaddress from "./src/pgaddress.ts";
 export * as plugin from "./src/plugin.ts";
@@ -15,6 +16,8 @@ export type { BundleValidateJson, ConfigFile, ConfigSource, ConfigMapValue, Reso
 export type { AutoConfigureMode, CreateAppConfig } from "./src/create-app.ts";
 export { MAX_TCP_PORT } from "./src/databricks.ts";
 export type { ContextLike } from "./src/databricks.ts";
+export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.ts";
+export type { IdentityMode, HeaderBearing } from "./src/identity.ts";
 export type { LakebaseResolverInputs, LakebaseConnection } from "./src/lakebase-resolver.ts";
 export { SSL_MODES } from "./src/pgaddress.ts";
 export type { SslMode, LakebaseConnectionInputs, ParsedAddress } from "./src/pgaddress.ts";

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * as appkit from "./src/appkit.ts";
 export * as config from "./src/config.ts";
 export * as createApp from "./src/create-app.ts";
 export * as databricks from "./src/databricks.ts";
+export * as identity from "./src/identity.ts";
 export * as lakebaseResolver from "./src/lakebase-resolver.ts";
 export * as pgaddress from "./src/pgaddress.ts";
 export * as plugin from "./src/plugin.ts";
@@ -11,6 +12,8 @@ export type { BundleValidateJson, ConfigFile, ConfigSource, ConfigMapValue, Reso
 export type { AutoConfigureMode, CreateAppConfig } from "./src/create-app.ts";
 export { MAX_TCP_PORT } from "./src/databricks.ts";
 export type { ContextLike } from "./src/databricks.ts";
+export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.ts";
+export type { IdentityMode, HeaderBearing } from "./src/identity.ts";
 export type { LakebaseResolverInputs, LakebaseConnection } from "./src/lakebase-resolver.ts";
 export { SSL_MODES } from "./src/pgaddress.ts";
 export type { SslMode, LakebaseConnectionInputs, ParsedAddress } from "./src/pgaddress.ts";

package/lib/index.js

@@ -5,10 +5,12 @@ export * as appkit from "./src/appkit.js";
 export * as config from "./src/config.js";
 export * as createApp from "./src/create-app.js";
 export * as databricks from "./src/databricks.js";
+export * as identity from "./src/identity.js";
 export * as lakebaseResolver from "./src/lakebase-resolver.js";
 export * as pgaddress from "./src/pgaddress.js";
 export * as plugin from "./src/plugin.js";
 export * as provision from "./src/provision.js";
 export { MAX_TCP_PORT } from "./src/databricks.js";
+export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.js";
 export { SSL_MODES } from "./src/pgaddress.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLFNBQVMsTUFBTSxxQkFBcUIsQ0FBQztBQUNqRCxPQUFPLEtBQUssVUFBVSxNQUFNLHFCQUFxQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxnQkFBZ0IsTUFBTSw0QkFBNEIsQ0FBQztBQUMvRCxPQUFPLEtBQUssU0FBUyxNQUFNLG9CQUFvQixDQUFDO0FBQ2hELE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLFNBQVMsTUFBTSxvQkFBb0IsQ0FBQztBQUloRCxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFHbkQsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLG9CQUFvQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0ICogYXMgYXBwa2l0IGZyb20gXCIuL3NyYy9hcHBraXQudHNcIjtcbmV4cG9ydCAqIGFzIGNvbmZpZyBmcm9tIFwiLi9zcmMvY29uZmlnLnRzXCI7XG5leHBvcnQgKiBhcyBjcmVhdGVBcHAgZnJvbSBcIi4vc3JjL2NyZWF0ZS1hcHAudHNcIjtcbmV4cG9ydCAqIGFzIGRhdGFicmlja3MgZnJvbSBcIi4vc3JjL2RhdGFicmlja3MudHNcIjtcbmV4cG9ydCAqIGFzIGxha2ViYXNlUmVzb2x2ZXIgZnJvbSBcIi4vc3JjL2xha2ViYXNlLXJlc29sdmVyLnRzXCI7XG5leHBvcnQgKiBhcyBwZ2FkZHJlc3MgZnJvbSBcIi4vc3JjL3BnYWRkcmVzcy50c1wiO1xuZXhwb3J0ICogYXMgcGx1Z2luIGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbmV4cG9ydCAqIGFzIHByb3Zpc2lvbiBmcm9tIFwiLi9zcmMvcHJvdmlzaW9uLnRzXCI7XG5leHBvcnQgdHlwZSB7IEV4ZWN1dGlvbkNvbnRleHRMaWtlLCBXb3Jrc3BhY2VDbGllbnRMaWtlIH0gZnJvbSBcIi4vc3JjL2FwcGtpdC50c1wiO1xuZXhwb3J0IHR5cGUgeyBCdW5kbGVWYWxpZGF0ZUpzb24sIENvbmZpZ0ZpbGUsIENvbmZpZ1NvdXJjZSwgQ29uZmlnTWFwVmFsdWUsIFJlc29sdmVDb25maWdWYWx1ZU9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvY29uZmlnLnRzXCI7XG5leHBvcnQgdHlwZSB7IEF1dG9Db25maWd1cmVNb2RlLCBDcmVhdGVBcHBDb25maWcgfSBmcm9tIFwiLi9zcmMvY3JlYXRlLWFwcC50c1wiO1xuZXhwb3J0IHsgTUFYX1RDUF9QT1JUIH0gZnJvbSBcIi4vc3JjL2RhdGFicmlja3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgQ29udGV4dExpa2UgfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy50c1wiO1xuZXhwb3J0IHR5cGUgeyBMYWtlYmFzZVJlc29sdmVySW5wdXRzLCBMYWtlYmFzZUNvbm5lY3Rpb24gfSBmcm9tIFwiLi9zcmMvbGFrZWJhc2UtcmVzb2x2ZXIudHNcIjtcbmV4cG9ydCB7IFNTTF9NT0RFUyB9IGZyb20gXCIuL3NyYy9wZ2FkZHJlc3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgU3NsTW9kZSwgTGFrZWJhc2VDb25uZWN0aW9uSW5wdXRzLCBQYXJzZWRBZGRyZXNzIH0gZnJvbSBcIi4vc3JjL3BnYWRkcmVzcy50c1wiO1xuZXhwb3J0IHR5cGUgeyBQbHVnaW5Db250ZXh0TGlrZSB9IGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLFNBQVMsTUFBTSxxQkFBcUIsQ0FBQztBQUNqRCxPQUFPLEtBQUssVUFBVSxNQUFNLHFCQUFxQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxRQUFRLE1BQU0sbUJBQW1CLENBQUM7QUFDOUMsT0FBTyxLQUFLLGdCQUFnQixNQUFNLDRCQUE0QixDQUFDO0FBQy9ELE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLE1BQU0sTUFBTSxpQkFBaUIsQ0FBQztBQUMxQyxPQUFPLEtBQUssU0FBUyxNQUFNLG9CQUFvQixDQUFDO0FBSWhELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUVuRCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsY0FBYyxFQUFFLGlCQUFpQixFQUFFLGNBQWMsRUFBRSxxQkFBcUIsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBR2xJLE9BQU8sRUFBRSxTQUFTLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCAqIGFzIGFwcGtpdCBmcm9tIFwiLi9zcmMvYXBwa2l0LnRzXCI7XG5leHBvcnQgKiBhcyBjb25maWcgZnJvbSBcIi4vc3JjL2NvbmZpZy50c1wiO1xuZXhwb3J0ICogYXMgY3JlYXRlQXBwIGZyb20gXCIuL3NyYy9jcmVhdGUtYXBwLnRzXCI7XG5leHBvcnQgKiBhcyBkYXRhYnJpY2tzIGZyb20gXCIuL3NyYy9kYXRhYnJpY2tzLnRzXCI7XG5leHBvcnQgKiBhcyBpZGVudGl0eSBmcm9tIFwiLi9zcmMvaWRlbnRpdHkudHNcIjtcbmV4cG9ydCAqIGFzIGxha2ViYXNlUmVzb2x2ZXIgZnJvbSBcIi4vc3JjL2xha2ViYXNlLXJlc29sdmVyLnRzXCI7XG5leHBvcnQgKiBhcyBwZ2FkZHJlc3MgZnJvbSBcIi4vc3JjL3BnYWRkcmVzcy50c1wiO1xuZXhwb3J0ICogYXMgcGx1Z2luIGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbmV4cG9ydCAqIGFzIHByb3Zpc2lvbiBmcm9tIFwiLi9zcmMvcHJvdmlzaW9uLnRzXCI7XG5leHBvcnQgdHlwZSB7IEV4ZWN1dGlvbkNvbnRleHRMaWtlLCBXb3Jrc3BhY2VDbGllbnRMaWtlIH0gZnJvbSBcIi4vc3JjL2FwcGtpdC50c1wiO1xuZXhwb3J0IHR5cGUgeyBCdW5kbGVWYWxpZGF0ZUpzb24sIENvbmZpZ0ZpbGUsIENvbmZpZ1NvdXJjZSwgQ29uZmlnTWFwVmFsdWUsIFJlc29sdmVDb25maWdWYWx1ZU9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvY29uZmlnLnRzXCI7XG5leHBvcnQgdHlwZSB7IEF1dG9Db25maWd1cmVNb2RlLCBDcmVhdGVBcHBDb25maWcgfSBmcm9tIFwiLi9zcmMvY3JlYXRlLWFwcC50c1wiO1xuZXhwb3J0IHsgTUFYX1RDUF9QT1JUIH0gZnJvbSBcIi4vc3JjL2RhdGFicmlja3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgQ29udGV4dExpa2UgfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy50c1wiO1xuZXhwb3J0IHsgQUNDRVNTX1RPS0VOX0hFQURFUiwgVVNFUl9JRF9IRUFERVIsIFVTRVJfRU1BSUxfSEVBREVSLCBJREVOVElUWV9NT0RFUywgREVGQVVMVF9JREVOVElUWV9NT0RFIH0gZnJvbSBcIi4vc3JjL2lkZW50aXR5LnRzXCI7XG5leHBvcnQgdHlwZSB7IElkZW50aXR5TW9kZSwgSGVhZGVyQmVhcmluZyB9IGZyb20gXCIuL3NyYy9pZGVudGl0eS50c1wiO1xuZXhwb3J0IHR5cGUgeyBMYWtlYmFzZVJlc29sdmVySW5wdXRzLCBMYWtlYmFzZUNvbm5lY3Rpb24gfSBmcm9tIFwiLi9zcmMvbGFrZWJhc2UtcmVzb2x2ZXIudHNcIjtcbmV4cG9ydCB7IFNTTF9NT0RFUyB9IGZyb20gXCIuL3NyYy9wZ2FkZHJlc3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgU3NsTW9kZSwgTGFrZWJhc2VDb25uZWN0aW9uSW5wdXRzLCBQYXJzZWRBZGRyZXNzIH0gZnJvbSBcIi4vc3JjL3BnYWRkcmVzcy50c1wiO1xuZXhwb3J0IHR5cGUgeyBQbHVnaW5Db250ZXh0TGlrZSB9IGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbiJdfQ==

package/lib/src/identity.d.ts

@@ -0,0 +1,119 @@
+/**
+ * Which Databricks identity a request's workspace calls run as.
+ *
+ * AppKit gives a plugin two identities: the ambient SERVICE context (the app's
+ * own service principal) and a per-request USER context entered with
+ * `asUser(req)`, which authenticates as the caller on-behalf-of (OBO). The
+ * choice is one call, so the whole decision is "do we enter `asUser` for this
+ * request".
+ *
+ * `asUser(req)` needs the OBO token the platform front door forwards on
+ * {@link ACCESS_TOKEN_HEADER}. Measured against the installed AppKit, its
+ * behavior when that header is absent depends ENTIRELY on `NODE_ENV`:
+ *
+ * | `NODE_ENV`    | no `x-forwarded-access-token`                        |
+ * | ------------- | ---------------------------------------------------- |
+ * | `development` | logs a warning, silently runs as the service principal |
+ * | anything else | throws `AuthenticationError: Missing user token`      |
+ *
+ * That production throw is correct for an app behind the Databricks front door,
+ * where a missing token means something is wrong. It is fatal for an app whose
+ * traffic legitimately arrives WITHOUT one:
+ *
+ *   - a public tunnel (`@dbx-tools/cli-tunnel`), where callers authenticate by
+ *     email OTP and no OBO token exists to forward - the gate can prove WHO the
+ *     caller is, but it cannot mint a Databricks credential for them;
+ *   - any reverse proxy, webhook, or bot channel (`POST /api/teams/messages`)
+ *     that authenticates its own way.
+ *
+ * Such an app must not run with `NODE_ENV=development` just to get the fallback:
+ * that flag also relaxes secure cookies, AppKit's own dev affordances, and
+ * `allowUnauthenticated` escape hatches. Hence {@link IdentityMode}:
+ *
+ *   - `"user"` - always OBO. Per-user attribution and per-user Genie / Unity
+ *     Catalog row filters. Correct when every caller is a workspace member.
+ *   - `"service-principal"` - always the app's own identity. Needs no OBO
+ *     scopes and works for any caller, at the cost of per-user data scoping.
+ *   - `"auto"` - OBO when the request actually carries a usable OBO token,
+ *     the service principal otherwise. One deployment then serves BOTH doors
+ *     correctly: front-door requests keep full per-user scoping, while tunnel /
+ *     webhook requests degrade to the service principal instead of 500ing.
+ *
+ * `"auto"` decides per REQUEST, not per boot, because a single container serves
+ * both doors at once - the tunnel gate and the platform front door share a port
+ * (see `@dbx-tools/cli-tunnel`). A boot-time flag would have to be wrong for one
+ * of them.
+ *
+ * What the service principal does NOT change is WHO the request belongs to. The
+ * caller's identity still arrives on {@link USER_ID_HEADER} /
+ * {@link USER_EMAIL_HEADER}, so memory threads, cache namespaces, and trace
+ * attribution stay per-user. Only the Databricks credential is shared.
+ *
+ * @module
+ */
+import { type EnvKey } from "@dbx-tools/shared-core";
+/**
+ * Header the Databricks Apps front door forwards the caller's OBO token on.
+ * Its presence is what makes `asUser(req)` viable, so it is the signal
+ * {@link useServicePrincipal} reads in `"auto"` mode.
+ *
+ * Re-exported from `@dbx-tools/shared-core`'s `token` module (which reads the
+ * same header to decode OAuth scopes) rather than re-spelled, so the name for
+ * this wire contract exists once.
+ */
+export declare const ACCESS_TOKEN_HEADER = "x-forwarded-access-token";
+/** Header the Databricks Apps front door forwards the caller's user id on. */
+export declare const USER_ID_HEADER = "x-forwarded-user";
+/** Header the Databricks Apps front door forwards the caller's email on. */
+export declare const USER_EMAIL_HEADER = "x-forwarded-email";
+/** Identity a request's Databricks calls run as. See the module docs. */
+export type IdentityMode = "user" | "service-principal" | "auto";
+/** Every accepted {@link IdentityMode}, in the order docs and schemas list them. */
+export declare const IDENTITY_MODES: readonly IdentityMode[];
+/**
+ * Default mode. `"user"` keeps OBO the only identity unless an app opts in, so
+ * adopting this option can never silently widen an existing app's data access.
+ */
+export declare const DEFAULT_IDENTITY_MODE: IdentityMode;
+/** The subset of `express.Request` this module reads - one header lookup. */
+export interface HeaderBearing {
+    header(name: string): string | undefined;
+}
+/**
+ * Resolve a configured mode: explicit config value, then the first non-empty
+ * variable among `envKeys`, then {@link DEFAULT_IDENTITY_MODE}.
+ *
+ * An unrecognized value throws rather than falling back. Falling back would
+ * silently keep serving OBO - and the production `AuthenticationError` it
+ * produces - to exactly the callers the option was set to accommodate, and a
+ * typo (`"obo"`, `"sp"`) is the likeliest way to get one.
+ */
+export declare function resolveIdentityMode(configured: string | undefined, envKeys: EnvKey, field?: string): IdentityMode;
+/**
+ * The OBO token on `req`, or `undefined`. Read through the same trim as every
+ * other header, so a header present-but-blank (which some proxies emit for an
+ * unset upstream value) counts as absent rather than as a token that fails at
+ * the first Databricks call.
+ */
+export declare function requestAccessToken(req: HeaderBearing | undefined): string | undefined;
+/** The forwarded user id on `req`, or `undefined`. */
+export declare function requestUserId(req: HeaderBearing | undefined): string | undefined;
+/** The forwarded user email on `req`, or `undefined`. */
+export declare function requestUserEmail(req: HeaderBearing | undefined): string | undefined;
+/**
+ * Whether `req` should run its Databricks calls as the app service principal
+ * rather than OBO.
+ *
+ * - `"service-principal"` -> always `true`.
+ * - `"user"` -> always `false`, even with no token. The mode is an explicit
+ *   assertion that every caller is OBO-capable, so a missing token is a real
+ *   error and must surface as AppKit's `AuthenticationError` rather than being
+ *   quietly downgraded to shared data access.
+ * - `"auto"` -> `true` only when the request carries no usable OBO token.
+ *
+ * A request AppKit will not accept for OBO anyway (no token) can never be
+ * served by entering `asUser`, so in `"auto"` mode the token check is the whole
+ * decision: it is the same condition AppKit itself branches on, just resolved
+ * before it can throw.
+ */
+export declare function useServicePrincipal(mode: IdentityMode, req?: HeaderBearing): boolean;

package/lib/src/identity.js

@@ -0,0 +1,137 @@
+/**
+ * Which Databricks identity a request's workspace calls run as.
+ *
+ * AppKit gives a plugin two identities: the ambient SERVICE context (the app's
+ * own service principal) and a per-request USER context entered with
+ * `asUser(req)`, which authenticates as the caller on-behalf-of (OBO). The
+ * choice is one call, so the whole decision is "do we enter `asUser` for this
+ * request".
+ *
+ * `asUser(req)` needs the OBO token the platform front door forwards on
+ * {@link ACCESS_TOKEN_HEADER}. Measured against the installed AppKit, its
+ * behavior when that header is absent depends ENTIRELY on `NODE_ENV`:
+ *
+ * | `NODE_ENV`    | no `x-forwarded-access-token`                        |
+ * | ------------- | ---------------------------------------------------- |
+ * | `development` | logs a warning, silently runs as the service principal |
+ * | anything else | throws `AuthenticationError: Missing user token`      |
+ *
+ * That production throw is correct for an app behind the Databricks front door,
+ * where a missing token means something is wrong. It is fatal for an app whose
+ * traffic legitimately arrives WITHOUT one:
+ *
+ *   - a public tunnel (`@dbx-tools/cli-tunnel`), where callers authenticate by
+ *     email OTP and no OBO token exists to forward - the gate can prove WHO the
+ *     caller is, but it cannot mint a Databricks credential for them;
+ *   - any reverse proxy, webhook, or bot channel (`POST /api/teams/messages`)
+ *     that authenticates its own way.
+ *
+ * Such an app must not run with `NODE_ENV=development` just to get the fallback:
+ * that flag also relaxes secure cookies, AppKit's own dev affordances, and
+ * `allowUnauthenticated` escape hatches. Hence {@link IdentityMode}:
+ *
+ *   - `"user"` - always OBO. Per-user attribution and per-user Genie / Unity
+ *     Catalog row filters. Correct when every caller is a workspace member.
+ *   - `"service-principal"` - always the app's own identity. Needs no OBO
+ *     scopes and works for any caller, at the cost of per-user data scoping.
+ *   - `"auto"` - OBO when the request actually carries a usable OBO token,
+ *     the service principal otherwise. One deployment then serves BOTH doors
+ *     correctly: front-door requests keep full per-user scoping, while tunnel /
+ *     webhook requests degrade to the service principal instead of 500ing.
+ *
+ * `"auto"` decides per REQUEST, not per boot, because a single container serves
+ * both doors at once - the tunnel gate and the platform front door share a port
+ * (see `@dbx-tools/cli-tunnel`). A boot-time flag would have to be wrong for one
+ * of them.
+ *
+ * What the service principal does NOT change is WHO the request belongs to. The
+ * caller's identity still arrives on {@link USER_ID_HEADER} /
+ * {@link USER_EMAIL_HEADER}, so memory threads, cache namespaces, and trace
+ * attribution stay per-user. Only the Databricks credential is shared.
+ *
+ * @module
+ */
+import { ConfigurationError } from "@databricks/appkit";
+import { env, string, token } from "@dbx-tools/shared-core";
+/**
+ * Header the Databricks Apps front door forwards the caller's OBO token on.
+ * Its presence is what makes `asUser(req)` viable, so it is the signal
+ * {@link useServicePrincipal} reads in `"auto"` mode.
+ *
+ * Re-exported from `@dbx-tools/shared-core`'s `token` module (which reads the
+ * same header to decode OAuth scopes) rather than re-spelled, so the name for
+ * this wire contract exists once.
+ */
+export const ACCESS_TOKEN_HEADER = token.ACCESS_TOKEN_HEADER;
+/** Header the Databricks Apps front door forwards the caller's user id on. */
+export const USER_ID_HEADER = token.USER_ID_HEADER;
+/** Header the Databricks Apps front door forwards the caller's email on. */
+export const USER_EMAIL_HEADER = token.USER_EMAIL_HEADER;
+/** Every accepted {@link IdentityMode}, in the order docs and schemas list them. */
+export const IDENTITY_MODES = ["user", "service-principal", "auto"];
+/**
+ * Default mode. `"user"` keeps OBO the only identity unless an app opts in, so
+ * adopting this option can never silently widen an existing app's data access.
+ */
+export const DEFAULT_IDENTITY_MODE = "user";
+/**
+ * Resolve a configured mode: explicit config value, then the first non-empty
+ * variable among `envKeys`, then {@link DEFAULT_IDENTITY_MODE}.
+ *
+ * An unrecognized value throws rather than falling back. Falling back would
+ * silently keep serving OBO - and the production `AuthenticationError` it
+ * produces - to exactly the callers the option was set to accommodate, and a
+ * typo (`"obo"`, `"sp"`) is the likeliest way to get one.
+ */
+export function resolveIdentityMode(configured, envKeys, field = "identity") {
+    const raw = env.string(configured, envKeys);
+    if (raw === null)
+        return DEFAULT_IDENTITY_MODE;
+    const mode = raw.toLowerCase();
+    if (!IDENTITY_MODES.includes(mode)) {
+        const names = typeof envKeys === "string" ? envKeys : envKeys.join(" / ");
+        throw new ConfigurationError(`${field} must be one of ${IDENTITY_MODES.join(" | ")} (env: ${names})`, { context: { field, envVar: names, received: raw } });
+    }
+    return mode;
+}
+/**
+ * The OBO token on `req`, or `undefined`. Read through the same trim as every
+ * other header, so a header present-but-blank (which some proxies emit for an
+ * unset upstream value) counts as absent rather than as a token that fails at
+ * the first Databricks call.
+ */
+export function requestAccessToken(req) {
+    return string.trimToNull(req?.header(ACCESS_TOKEN_HEADER)) ?? undefined;
+}
+/** The forwarded user id on `req`, or `undefined`. */
+export function requestUserId(req) {
+    return string.trimToNull(req?.header(USER_ID_HEADER)) ?? undefined;
+}
+/** The forwarded user email on `req`, or `undefined`. */
+export function requestUserEmail(req) {
+    return string.trimToNull(req?.header(USER_EMAIL_HEADER)) ?? undefined;
+}
+/**
+ * Whether `req` should run its Databricks calls as the app service principal
+ * rather than OBO.
+ *
+ * - `"service-principal"` -> always `true`.
+ * - `"user"` -> always `false`, even with no token. The mode is an explicit
+ *   assertion that every caller is OBO-capable, so a missing token is a real
+ *   error and must surface as AppKit's `AuthenticationError` rather than being
+ *   quietly downgraded to shared data access.
+ * - `"auto"` -> `true` only when the request carries no usable OBO token.
+ *
+ * A request AppKit will not accept for OBO anyway (no token) can never be
+ * served by entering `asUser`, so in `"auto"` mode the token check is the whole
+ * decision: it is the same condition AppKit itself branches on, just resolved
+ * before it can throw.
+ */
+export function useServicePrincipal(mode, req) {
+    if (mode === "service-principal")
+        return true;
+    if (mode === "user")
+        return false;
+    return requestAccessToken(req) === undefined;
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAe,MAAM,wBAAwB,CAAC;AAEzE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;AAE7D,8EAA8E;AAC9E,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;AAEnD,4EAA4E;AAC5E,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;AAKzD,oFAAoF;AACpF,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAE7F;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAiB,MAAM,CAAC;AAO1D;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA8B,EAC9B,OAAe,EACf,KAAK,GAAG,UAAU;IAElB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5C,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,qBAAqB,CAAC;IAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,EAAkB,CAAC;IAC/C,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1E,MAAM,IAAI,kBAAkB,CAC1B,GAAG,KAAK,mBAAmB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,KAAK,GAAG,EACvE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,CACrD,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAA8B;IAC/D,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,SAAS,CAAC;AAC1E,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,aAAa,CAAC,GAA8B;IAC1D,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,SAAS,CAAC;AACrE,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,gBAAgB,CAAC,GAA8B;IAC7D,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,SAAS,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAkB,EAAE,GAAmB;IACzE,IAAI,IAAI,KAAK,mBAAmB;QAAE,OAAO,IAAI,CAAC;IAC9C,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IAClC,OAAO,kBAAkB,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AAC/C,CAAC","sourcesContent":["/**\n * Which Databricks identity a request's workspace calls run as.\n *\n * AppKit gives a plugin two identities: the ambient SERVICE context (the app's\n * own service principal) and a per-request USER context entered with\n * `asUser(req)`, which authenticates as the caller on-behalf-of (OBO). The\n * choice is one call, so the whole decision is \"do we enter `asUser` for this\n * request\".\n *\n * `asUser(req)` needs the OBO token the platform front door forwards on\n * {@link ACCESS_TOKEN_HEADER}. Measured against the installed AppKit, its\n * behavior when that header is absent depends ENTIRELY on `NODE_ENV`:\n *\n * | `NODE_ENV`    | no `x-forwarded-access-token`                        |\n * | ------------- | ---------------------------------------------------- |\n * | `development` | logs a warning, silently runs as the service principal |\n * | anything else | throws `AuthenticationError: Missing user token`      |\n *\n * That production throw is correct for an app behind the Databricks front door,\n * where a missing token means something is wrong. It is fatal for an app whose\n * traffic legitimately arrives WITHOUT one:\n *\n *   - a public tunnel (`@dbx-tools/cli-tunnel`), where callers authenticate by\n *     email OTP and no OBO token exists to forward - the gate can prove WHO the\n *     caller is, but it cannot mint a Databricks credential for them;\n *   - any reverse proxy, webhook, or bot channel (`POST /api/teams/messages`)\n *     that authenticates its own way.\n *\n * Such an app must not run with `NODE_ENV=development` just to get the fallback:\n * that flag also relaxes secure cookies, AppKit's own dev affordances, and\n * `allowUnauthenticated` escape hatches. Hence {@link IdentityMode}:\n *\n *   - `\"user\"` - always OBO. Per-user attribution and per-user Genie / Unity\n *     Catalog row filters. Correct when every caller is a workspace member.\n *   - `\"service-principal\"` - always the app's own identity. Needs no OBO\n *     scopes and works for any caller, at the cost of per-user data scoping.\n *   - `\"auto\"` - OBO when the request actually carries a usable OBO token,\n *     the service principal otherwise. One deployment then serves BOTH doors\n *     correctly: front-door requests keep full per-user scoping, while tunnel /\n *     webhook requests degrade to the service principal instead of 500ing.\n *\n * `\"auto\"` decides per REQUEST, not per boot, because a single container serves\n * both doors at once - the tunnel gate and the platform front door share a port\n * (see `@dbx-tools/cli-tunnel`). A boot-time flag would have to be wrong for one\n * of them.\n *\n * What the service principal does NOT change is WHO the request belongs to. The\n * caller's identity still arrives on {@link USER_ID_HEADER} /\n * {@link USER_EMAIL_HEADER}, so memory threads, cache namespaces, and trace\n * attribution stay per-user. Only the Databricks credential is shared.\n *\n * @module\n */\n\nimport { ConfigurationError } from \"@databricks/appkit\";\nimport { env, string, token, type EnvKey } from \"@dbx-tools/shared-core\";\n\n/**\n * Header the Databricks Apps front door forwards the caller's OBO token on.\n * Its presence is what makes `asUser(req)` viable, so it is the signal\n * {@link useServicePrincipal} reads in `\"auto\"` mode.\n *\n * Re-exported from `@dbx-tools/shared-core`'s `token` module (which reads the\n * same header to decode OAuth scopes) rather than re-spelled, so the name for\n * this wire contract exists once.\n */\nexport const ACCESS_TOKEN_HEADER = token.ACCESS_TOKEN_HEADER;\n\n/** Header the Databricks Apps front door forwards the caller's user id on. */\nexport const USER_ID_HEADER = token.USER_ID_HEADER;\n\n/** Header the Databricks Apps front door forwards the caller's email on. */\nexport const USER_EMAIL_HEADER = token.USER_EMAIL_HEADER;\n\n/** Identity a request's Databricks calls run as. See the module docs. */\nexport type IdentityMode = \"user\" | \"service-principal\" | \"auto\";\n\n/** Every accepted {@link IdentityMode}, in the order docs and schemas list them. */\nexport const IDENTITY_MODES: readonly IdentityMode[] = [\"user\", \"service-principal\", \"auto\"];\n\n/**\n * Default mode. `\"user\"` keeps OBO the only identity unless an app opts in, so\n * adopting this option can never silently widen an existing app's data access.\n */\nexport const DEFAULT_IDENTITY_MODE: IdentityMode = \"user\";\n\n/** The subset of `express.Request` this module reads - one header lookup. */\nexport interface HeaderBearing {\n  header(name: string): string | undefined;\n}\n\n/**\n * Resolve a configured mode: explicit config value, then the first non-empty\n * variable among `envKeys`, then {@link DEFAULT_IDENTITY_MODE}.\n *\n * An unrecognized value throws rather than falling back. Falling back would\n * silently keep serving OBO - and the production `AuthenticationError` it\n * produces - to exactly the callers the option was set to accommodate, and a\n * typo (`\"obo\"`, `\"sp\"`) is the likeliest way to get one.\n */\nexport function resolveIdentityMode(\n  configured: string | undefined,\n  envKeys: EnvKey,\n  field = \"identity\",\n): IdentityMode {\n  const raw = env.string(configured, envKeys);\n  if (raw === null) return DEFAULT_IDENTITY_MODE;\n  const mode = raw.toLowerCase() as IdentityMode;\n  if (!IDENTITY_MODES.includes(mode)) {\n    const names = typeof envKeys === \"string\" ? envKeys : envKeys.join(\" / \");\n    throw new ConfigurationError(\n      `${field} must be one of ${IDENTITY_MODES.join(\" | \")} (env: ${names})`,\n      { context: { field, envVar: names, received: raw } },\n    );\n  }\n  return mode;\n}\n\n/**\n * The OBO token on `req`, or `undefined`. Read through the same trim as every\n * other header, so a header present-but-blank (which some proxies emit for an\n * unset upstream value) counts as absent rather than as a token that fails at\n * the first Databricks call.\n */\nexport function requestAccessToken(req: HeaderBearing | undefined): string | undefined {\n  return string.trimToNull(req?.header(ACCESS_TOKEN_HEADER)) ?? undefined;\n}\n\n/** The forwarded user id on `req`, or `undefined`. */\nexport function requestUserId(req: HeaderBearing | undefined): string | undefined {\n  return string.trimToNull(req?.header(USER_ID_HEADER)) ?? undefined;\n}\n\n/** The forwarded user email on `req`, or `undefined`. */\nexport function requestUserEmail(req: HeaderBearing | undefined): string | undefined {\n  return string.trimToNull(req?.header(USER_EMAIL_HEADER)) ?? undefined;\n}\n\n/**\n * Whether `req` should run its Databricks calls as the app service principal\n * rather than OBO.\n *\n * - `\"service-principal\"` -> always `true`.\n * - `\"user\"` -> always `false`, even with no token. The mode is an explicit\n *   assertion that every caller is OBO-capable, so a missing token is a real\n *   error and must surface as AppKit's `AuthenticationError` rather than being\n *   quietly downgraded to shared data access.\n * - `\"auto\"` -> `true` only when the request carries no usable OBO token.\n *\n * A request AppKit will not accept for OBO anyway (no token) can never be\n * served by entering `asUser`, so in `\"auto\"` mode the token check is the whole\n * decision: it is the same condition AppKit itself branches on, just resolved\n * before it can throw.\n */\nexport function useServicePrincipal(mode: IdentityMode, req?: HeaderBearing): boolean {\n  if (mode === \"service-principal\") return true;\n  if (mode === \"user\") return false;\n  return requestAccessToken(req) === undefined;\n}\n"]}

package/lib/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/appkit.ts","../src/config.ts","../src/create-app.ts","../src/databricks.ts","../src/lakebase-resolver.ts","../src/pgaddress.ts","../src/plugin.ts","../src/provision.ts","../index.ts"],"version":"5.9.3"}
+{"root":["../src/appkit.ts","../src/config.ts","../src/create-app.ts","../src/databricks.ts","../src/identity.ts","../src/lakebase-resolver.ts","../src/pgaddress.ts","../src/plugin.ts","../src/provision.ts","../index.ts"],"version":"5.9.3"}

package/package.json

@@ -28,8 +28,8 @@
   },
   "dependencies": {
     "@databricks/sdk-experimental": "^0.17.0",
-    "@dbx-tools/core": "0.6.48",
-    "@dbx-tools/shared-core": "0.6.48",
+    "@dbx-tools/core": "0.6.49",
+    "@dbx-tools/shared-core": "0.6.49",
     "yaml": "^2.9.0",
     "zod": "4.3.6"
   },
@@ -47,7 +47,7 @@
       "./package.json": "./package.json"
     }
   },
-  "version": "0.6.48",
+  "version": "0.6.49",
   "types": "./lib/index.d.ts",
   "type": "module",
   "exports": {

package/src/identity.ts

@@ -0,0 +1,159 @@
+/**
+ * Which Databricks identity a request's workspace calls run as.
+ *
+ * AppKit gives a plugin two identities: the ambient SERVICE context (the app's
+ * own service principal) and a per-request USER context entered with
+ * `asUser(req)`, which authenticates as the caller on-behalf-of (OBO). The
+ * choice is one call, so the whole decision is "do we enter `asUser` for this
+ * request".
+ *
+ * `asUser(req)` needs the OBO token the platform front door forwards on
+ * {@link ACCESS_TOKEN_HEADER}. Measured against the installed AppKit, its
+ * behavior when that header is absent depends ENTIRELY on `NODE_ENV`:
+ *
+ * | `NODE_ENV`    | no `x-forwarded-access-token`                        |
+ * | ------------- | ---------------------------------------------------- |
+ * | `development` | logs a warning, silently runs as the service principal |
+ * | anything else | throws `AuthenticationError: Missing user token`      |
+ *
+ * That production throw is correct for an app behind the Databricks front door,
+ * where a missing token means something is wrong. It is fatal for an app whose
+ * traffic legitimately arrives WITHOUT one:
+ *
+ *   - a public tunnel (`@dbx-tools/cli-tunnel`), where callers authenticate by
+ *     email OTP and no OBO token exists to forward - the gate can prove WHO the
+ *     caller is, but it cannot mint a Databricks credential for them;
+ *   - any reverse proxy, webhook, or bot channel (`POST /api/teams/messages`)
+ *     that authenticates its own way.
+ *
+ * Such an app must not run with `NODE_ENV=development` just to get the fallback:
+ * that flag also relaxes secure cookies, AppKit's own dev affordances, and
+ * `allowUnauthenticated` escape hatches. Hence {@link IdentityMode}:
+ *
+ *   - `"user"` - always OBO. Per-user attribution and per-user Genie / Unity
+ *     Catalog row filters. Correct when every caller is a workspace member.
+ *   - `"service-principal"` - always the app's own identity. Needs no OBO
+ *     scopes and works for any caller, at the cost of per-user data scoping.
+ *   - `"auto"` - OBO when the request actually carries a usable OBO token,
+ *     the service principal otherwise. One deployment then serves BOTH doors
+ *     correctly: front-door requests keep full per-user scoping, while tunnel /
+ *     webhook requests degrade to the service principal instead of 500ing.
+ *
+ * `"auto"` decides per REQUEST, not per boot, because a single container serves
+ * both doors at once - the tunnel gate and the platform front door share a port
+ * (see `@dbx-tools/cli-tunnel`). A boot-time flag would have to be wrong for one
+ * of them.
+ *
+ * What the service principal does NOT change is WHO the request belongs to. The
+ * caller's identity still arrives on {@link USER_ID_HEADER} /
+ * {@link USER_EMAIL_HEADER}, so memory threads, cache namespaces, and trace
+ * attribution stay per-user. Only the Databricks credential is shared.
+ *
+ * @module
+ */
+
+import { ConfigurationError } from "@databricks/appkit";
+import { env, string, token, type EnvKey } from "@dbx-tools/shared-core";
+
+/**
+ * Header the Databricks Apps front door forwards the caller's OBO token on.
+ * Its presence is what makes `asUser(req)` viable, so it is the signal
+ * {@link useServicePrincipal} reads in `"auto"` mode.
+ *
+ * Re-exported from `@dbx-tools/shared-core`'s `token` module (which reads the
+ * same header to decode OAuth scopes) rather than re-spelled, so the name for
+ * this wire contract exists once.
+ */
+export const ACCESS_TOKEN_HEADER = token.ACCESS_TOKEN_HEADER;
+
+/** Header the Databricks Apps front door forwards the caller's user id on. */
+export const USER_ID_HEADER = token.USER_ID_HEADER;
+
+/** Header the Databricks Apps front door forwards the caller's email on. */
+export const USER_EMAIL_HEADER = token.USER_EMAIL_HEADER;
+
+/** Identity a request's Databricks calls run as. See the module docs. */
+export type IdentityMode = "user" | "service-principal" | "auto";
+
+/** Every accepted {@link IdentityMode}, in the order docs and schemas list them. */
+export const IDENTITY_MODES: readonly IdentityMode[] = ["user", "service-principal", "auto"];
+
+/**
+ * Default mode. `"user"` keeps OBO the only identity unless an app opts in, so
+ * adopting this option can never silently widen an existing app's data access.
+ */
+export const DEFAULT_IDENTITY_MODE: IdentityMode = "user";
+
+/** The subset of `express.Request` this module reads - one header lookup. */
+export interface HeaderBearing {
+  header(name: string): string | undefined;
+}
+
+/**
+ * Resolve a configured mode: explicit config value, then the first non-empty
+ * variable among `envKeys`, then {@link DEFAULT_IDENTITY_MODE}.
+ *
+ * An unrecognized value throws rather than falling back. Falling back would
+ * silently keep serving OBO - and the production `AuthenticationError` it
+ * produces - to exactly the callers the option was set to accommodate, and a
+ * typo (`"obo"`, `"sp"`) is the likeliest way to get one.
+ */
+export function resolveIdentityMode(
+  configured: string | undefined,
+  envKeys: EnvKey,
+  field = "identity",
+): IdentityMode {
+  const raw = env.string(configured, envKeys);
+  if (raw === null) return DEFAULT_IDENTITY_MODE;
+  const mode = raw.toLowerCase() as IdentityMode;
+  if (!IDENTITY_MODES.includes(mode)) {
+    const names = typeof envKeys === "string" ? envKeys : envKeys.join(" / ");
+    throw new ConfigurationError(
+      `${field} must be one of ${IDENTITY_MODES.join(" | ")} (env: ${names})`,
+      { context: { field, envVar: names, received: raw } },
+    );
+  }
+  return mode;
+}
+
+/**
+ * The OBO token on `req`, or `undefined`. Read through the same trim as every
+ * other header, so a header present-but-blank (which some proxies emit for an
+ * unset upstream value) counts as absent rather than as a token that fails at
+ * the first Databricks call.
+ */
+export function requestAccessToken(req: HeaderBearing | undefined): string | undefined {
+  return string.trimToNull(req?.header(ACCESS_TOKEN_HEADER)) ?? undefined;
+}
+
+/** The forwarded user id on `req`, or `undefined`. */
+export function requestUserId(req: HeaderBearing | undefined): string | undefined {
+  return string.trimToNull(req?.header(USER_ID_HEADER)) ?? undefined;
+}
+
+/** The forwarded user email on `req`, or `undefined`. */
+export function requestUserEmail(req: HeaderBearing | undefined): string | undefined {
+  return string.trimToNull(req?.header(USER_EMAIL_HEADER)) ?? undefined;
+}
+
+/**
+ * Whether `req` should run its Databricks calls as the app service principal
+ * rather than OBO.
+ *
+ * - `"service-principal"` -> always `true`.
+ * - `"user"` -> always `false`, even with no token. The mode is an explicit
+ *   assertion that every caller is OBO-capable, so a missing token is a real
+ *   error and must surface as AppKit's `AuthenticationError` rather than being
+ *   quietly downgraded to shared data access.
+ * - `"auto"` -> `true` only when the request carries no usable OBO token.
+ *
+ * A request AppKit will not accept for OBO anyway (no token) can never be
+ * served by entering `asUser`, so in `"auto"` mode the token check is the whole
+ * decision: it is the same condition AppKit itself branches on, just resolved
+ * before it can throw.
+ */
+export function useServicePrincipal(mode: IdentityMode, req?: HeaderBearing): boolean {
+  if (mode === "service-principal") return true;
+  if (mode === "user") return false;
+  return requestAccessToken(req) === undefined;
+}