LibreChat/packages/api/src/middleware/preAuthTenant.ts
Danny Avila 7f58e4c2ed
🧾 feat: Add Structured Logging Context (#13110)
* feat: add structured logging context

* fix: reduce cloudfront disabled logging

* fix: preserve strict reject logging context

* chore: format auth middleware test

* fix: omit system tenant from log context

* fix: type parser spec formatter info

* fix: normalize tenant guard before reject checks
2026-05-13 19:17:39 -04:00

76 lines
2.8 KiB
TypeScript

import { logger, SYSTEM_TENANT_ID } from '@librechat/data-schemas';
import type { Request, Response, NextFunction } from 'express';
import { buildTenantContext, runWithTenantContext } from './tenant';
/**
* Pre-authentication tenant context middleware for unauthenticated routes.
*
* Reads the tenant identifier from the `X-Tenant-Id` request header and wraps
* downstream handlers in `tenantStorage.run()` so that Mongoose queries and
* config resolution run within the correct tenant scope.
*
* **Where to use**: Mount on routes that must be tenant-aware before
* authentication has occurred:
* - `GET /api/config` — login page needs tenant-specific config (social logins, registration)
* - `/api/auth/*` — login, register, password reset
* - `/oauth/*` — OAuth callback flows
* - `GET /api/share/:shareId` — public shared conversation links
*
* **How the header gets set**: The deployment's reverse proxy, auth gateway,
* or OpenID strategy sets `X-Tenant-Id` based on subdomain, path, or OIDC claim.
* This middleware does NOT resolve tenants from subdomains or tokens — that is
* the responsibility of the deployment layer.
*
* **Design**: Intentionally minimal. No subdomain parsing, no OIDC claim
* extraction, no YAML-driven strategy. Multi-tenant deployments can:
* 1. Set the header in the reverse proxy / ingress (simplest),
* 2. Replace this middleware's resolver logic entirely, or
* 3. Layer additional resolution on top (e.g., OpenID `tenant` claim → header).
*
* If no header is present, downstream runs without tenant ALS context (same as
* single-tenant mode), while request logging context can still propagate.
*/
const MAX_TENANT_ID_LENGTH = 128;
const VALID_TENANT_ID = /^[-a-zA-Z0-9_.]+$/;
export function preAuthTenantMiddleware(req: Request, res: Response, next: NextFunction): void {
const raw = req.headers['x-tenant-id'];
const requestContext = buildTenantContext({ headers: req.headers });
if (!raw || typeof raw !== 'string') {
runWithTenantContext(requestContext, next);
return;
}
const tenantId = raw.trim();
if (!tenantId) {
runWithTenantContext(requestContext, next);
return;
}
if (tenantId === SYSTEM_TENANT_ID) {
runWithTenantContext(requestContext, () => {
logger.warn('[preAuthTenant] Rejected __SYSTEM__ sentinel in X-Tenant-Id header', {
ip: req.ip,
path: req.path,
});
next();
});
return;
}
if (tenantId.length > MAX_TENANT_ID_LENGTH || !VALID_TENANT_ID.test(tenantId)) {
runWithTenantContext(requestContext, () => {
logger.warn('[preAuthTenant] Rejected malformed X-Tenant-Id header', {
ip: req.ip,
length: tenantId.length,
path: req.path,
});
next();
});
return;
}
runWithTenantContext(buildTenantContext({ headers: req.headers }, tenantId), next);
}