Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Return redacted API key in settings API responses (#178)

Srajan Asthanadf343cc110b1
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index a4dc2a388..9401f0c92 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -1807,7 +1807,7 @@
"minLength": 1,
"type": "string"
},
- "description": "HTTP headers sent on each request to this MCP server.",
+ "description": "Request headers for this MCP server. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored secret for that header name.",
"type": "object"
},
"type": {
@@ -2285,7 +2285,7 @@
"description": "Provider authentication credentials.",
"properties": {
"api_key": {
- "description": "API key used to authenticate with the provider.",
+ "description": "Provider API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.",
"minLength": 1,
"type": "string"
}
@@ -6072,7 +6072,7 @@
},
"/api/v1/settings/mcp-servers": {
"get": {
- "description": "All MCP servers with nested auth_status (settings / admin projection).",
+ "description": "All MCP servers with nested auth_status (settings / admin projection). Header auth values are redacted.",
"responses": {
"200": {
"content": {
@@ -6082,7 +6082,7 @@
}
}
},
- "description": "All MCP servers."
+ "description": "All MCP servers"
},
"401": {
"content": {
@@ -6116,7 +6116,7 @@
"x-fern-sdk-method-name": "list"
},
"put": {
- "description": "Full upsert keyed by `name`: creates the server or replaces its manifest. Does not start DCR or modify stored oauth_server / oauth_client columns.",
+ "description": "Create or replace by `name`. Does not start DCR or change oauth client columns. Header secrets: real value sets/rotates; redacted keeps existing (400 if none).",
"requestBody": {
"content": {
"application/json": {
@@ -6136,7 +6136,7 @@
}
}
},
- "description": "The saved MCP server with stub auth_status."
+ "description": "The saved MCP server with auth_status"
},
"400": {
"content": {
@@ -6146,7 +6146,7 @@
}
}
},
- "description": "Invalid request body."
+ "description": "Invalid request body, or redacted header secret with no stored value to keep."
},
"422": {
"content": {
@@ -6218,7 +6218,7 @@
},
"/api/v1/settings/mcp-servers/{name}": {
"get": {
- "description": "A single MCP server by name, with nested auth_status (settings / admin projection).",
+ "description": "A single MCP server by name, with nested auth_status (settings / admin projection). Header auth values are redacted.",
"parameters": [
{
"description": "MCP server name.",
@@ -6241,7 +6241,7 @@
}
}
},
- "description": "The MCP server."
+ "description": "The MCP server"
},
"404": {
"content": {
@@ -6356,7 +6356,7 @@
}
}
},
- "description": "All configured model providers."
+ "description": "All configured model providers"
},
"401": {
"content": {
@@ -6390,7 +6390,7 @@
"x-fern-sdk-method-name": "list"
},
"put": {
- "description": "Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.",
+ "description": "Create or replace a provider (models included). Well-known types use `type` as `name` (one each); `custom` is named by the caller. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).",
"requestBody": {
"content": {
"application/json": {
@@ -6410,7 +6410,7 @@
}
}
},
- "description": "The saved provider."
+ "description": "The saved provider"
},
"400": {
"content": {
@@ -6420,7 +6420,7 @@
}
}
},
- "description": "Invalid request body."
+ "description": "Invalid request body, or redacted API key with no stored secret to keep."
}
},
"summary": "Create or replace a model provider",
diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.json
index 1af572d6e..377669d7e 100644
--- a/packages/sdk/.fern/metadata.json
+++ b/packages/sdk/.fern/metadata.json
@@ -28,7 +28,7 @@
"streamType": "web",
"useDefaultRequestParameterValues": true
},
- "originGitCommit": "18ec0e4a4e67a22a5a72579a893cd0b9eef06533",
+ "originGitCommit": "1b85847acb5099742cb53678d3c608af90930147",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
diff --git a/packages/sdk/pnpm-lock.yaml b/packages/sdk/pnpm-lock.yaml
index acb2abc49..010f9c47d 100644
--- a/packages/sdk/pnpm-lock.yaml
+++ b/packages/sdk/pnpm-lock.yaml
@@ -449,8 +449,8 @@ packages:
resolution: {integrity: sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==}
engines: {node: '>=8'}
- resolution: {integrity: sha512-MQsYmdaLzvaCX5j+ZZBr5Fm6uCCnPQcRtlvmvRlWqrXy+BH2O4ffXIAScF+JQznQWB9brWp4lSD9Z4yNmaf2BA==}
+ resolution: {integrity: sha512-3WJtd7/lVq2Jnuz6wed1l9+1ZD2u2Tet1/1NBc4Iedkmgbu+I7YuAqdAQ8T+VZtnwysMsAf3IqSq9D1gyZjA2g==}
resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==}
@@ -1319,7 +1319,7 @@ snapshots:
dependencies:
baseline-browser-mapping: 2.11.13
caniuse-lite: 1.0.30001809
- electron-to-chromium: 1.5.403
+ electron-to-chromium: 1.5.404
node-releases: 2.0.53
update-browserslist-db: 1.3.1([email protected])
@@ -1358,7 +1358,7 @@ snapshots:
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index 831956ca6..239bc4d31 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -1813,7 +1813,7 @@ await client.skills.list();
<dl>
<dd>
-All MCP servers with nested auth_status (settings / admin projection).
+All MCP servers with nested auth_status (settings / admin projection). Header auth values are redacted.
</dd>
</dl>
</dd>
@@ -1868,7 +1868,7 @@ await client.settings.mcpServers.list();
<dl>
<dd>
-Full upsert keyed by `name`: creates the server or replaces its manifest. Does not start DCR or modify stored oauth_server / oauth_client columns.
+Create or replace by `name`. Does not start DCR or change oauth client columns. Header secrets: real value sets/rotates; redacted keeps existing (400 if none).
</dd>
</dl>
</dd>
@@ -1989,7 +1989,7 @@ await client.settings.mcpServers.catalog();
<dl>
<dd>
-A single MCP server by name, with nested auth_status (settings / admin projection).
+A single MCP server by name, with nested auth_status (settings / admin projection). Header auth values are redacted.
</dd>
</dl>
</dd>
@@ -2171,7 +2171,7 @@ await client.settings.modelProviders.list();
<dl>
<dd>
-Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.
+Create or replace a provider (models included). Well-known types use `type` as `name` (one each); `custom` is named by the caller. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
</dd>
</dl>
</dd>
diff --git a/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts b/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
index de8af6ed6..7171cf2ce 100644
--- a/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
+++ b/packages/sdk/src/api/resources/settings/resources/mcpServers/client/Client.ts
@@ -24,7 +24,7 @@ export class McpServersClient {
}
/**
- * All MCP servers with nested auth_status (settings / admin projection).
+ * All MCP servers with nested auth_status (settings / admin projection). Header auth values are redacted.
*
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
*
@@ -116,7 +116,7 @@ export class McpServersClient {
}
/**
- * Full upsert keyed by `name`: creates the server or replaces its manifest. Does not start DCR or modify stored oauth_server / oauth_client columns.
+ * Create or replace by `name`. Does not start DCR or change oauth client columns. Header secrets: real value sets/rotates; redacted keeps existing (400 if none).
*
* @param {TrueForge.settings.McpServerManifest} request
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -325,7 +325,7 @@ export class McpServersClient {
}
/**
- * A single MCP server by name, with nested auth_status (settings / admin projection).
+ * A single MCP server by name, with nested auth_status (settings / admin projection). Header auth values are redacted.
*
* @param {string} name - MCP server name.
* @param {McpServersClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
index 4b059c24c..d0763185d 100644
--- a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
+++ b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
@@ -121,7 +121,7 @@ export class ModelProvidersClient {
}
/**
- * Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.
+ * Create or replace a provider (models included). Well-known types use `type` as `name` (one each); `custom` is named by the caller. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).
*
* @param {TrueForge.ModelProvider} request
* @param {ModelProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/packages/sdk/src/api/types/McpServerHeaderAuth.ts b/packages/sdk/src/api/types/McpServerHeaderAuth.ts
index 87ed3510e..6e4e0b35c 100644
--- a/packages/sdk/src/api/types/McpServerHeaderAuth.ts
+++ b/packages/sdk/src/api/types/McpServerHeaderAuth.ts
@@ -1,7 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
export interface McpServerHeaderAuth {
- /** HTTP headers sent on each request to this MCP server. */
+ /** Request headers for this MCP server. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored secret for that header name. */
headers: Record<string, string>;
type: "header";
}
diff --git a/packages/sdk/src/api/types/ModelProviderAuth.ts b/packages/sdk/src/api/types/ModelProviderAuth.ts
index 3d69b7dda..2d576233e 100644
--- a/packages/sdk/src/api/types/ModelProviderAuth.ts
+++ b/packages/sdk/src/api/types/ModelProviderAuth.ts
@@ -4,6 +4,6 @@
* Provider authentication credentials.
*/
export interface ModelProviderAuth {
- /** API key used to authenticate with the provider. */
+ /** Provider API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key. */
apiKey: string;
}
diff --git a/packages/server/src/apis/mcpServers.ts b/packages/server/src/apis/mcpServers.ts
index e7cec804f..cfa47e697 100644
--- a/packages/server/src/apis/mcpServers.ts
+++ b/packages/server/src/apis/mcpServers.ts
@@ -22,6 +22,7 @@ import {
import { getMcpConnection } from '../runtime/sessionResources';
import type { ConfiguredMcpServer, McpAuthStatus, McpServerManifest, McpServerReadEntry } from '../schemas/mcpServer';
import { resolveMcpAuthStatus } from '../schemas/mcpServer';
+import { MissingStoredSecretError, resolveStoredSecretValue, toRedactedSecretValue } from '../utils/secretRedaction';
import { TENANT_ID } from './sessions';
export interface SettingsMcpServersRouterDeps<TTransaction> {
@@ -52,6 +53,50 @@ function omitUndefinedEntries(obj: Record<string, unknown>): Record<string, unkn
return out;
}
+/** Settings wire view: redact header secrets; leave DCR / no-auth manifests unchanged. */
+function redactMcpServerManifest(manifest: McpServerManifest): McpServerManifest {
+ if (manifest.auth?.type !== 'header') {
+ return manifest;
+ }
+ const headers: Record<string, string> = {};
+ for (const [name, value] of Object.entries(manifest.auth.headers)) {
+ headers[name] = toRedactedSecretValue(value);
+ }
+ return {
+ ...manifest,
+ auth: { type: 'header', headers },
+ };
+}
+
+/**
+ * Strict PUT merge for `auth.type === 'header'`: each header value is always required;
+ * redacted values keep the stored secret for the same header name.
+ * @throws {MissingStoredSecretError} when keep is requested without a stored header value
+ */
+function resolveMcpServerManifestForWrite({
+ incoming,
+ existing,
+}: {
+ incoming: McpServerManifest;
+ existing: McpServerManifest | undefined;
+}): McpServerManifest {
+ if (incoming.auth?.type !== 'header') {
+ return incoming;
+ }
+ const existingHeaders = existing?.auth?.type === 'header' ? existing.auth.headers : undefined;
+ const headers: Record<string, string> = {};
+ for (const [name, value] of Object.entries(incoming.auth.headers)) {
+ headers[name] = resolveStoredSecretValue({
+ incoming: value,
+ existing: existingHeaders?.[name],
+ });
+ }
+ return {
+ ...incoming,
+ auth: { type: 'header', headers },
+ };
+}
+
/**
* `token` is the calling user's DCR access token for this server (keyed by `record.id` +
* `userRef`), or undefined for header/no-auth servers and DCR servers that have never
@@ -65,7 +110,7 @@ function toConfiguredMcpServer({
token: OAuthToken | undefined;
}): ConfiguredMcpServer {
return {
- ...record.manifest,
+ ...redactMcpServerManifest(record.manifest),
auth_status: resolveMcpAuthStatus({
manifest: record.manifest,
...(token !== undefined ? { token } : {}),
@@ -126,32 +171,34 @@ export function createSettingsMcpServersRouter<TTransaction>(deps: SettingsMcpSe
const putHandler: RouteHandler<typeof putMcpServerRoute> = async c => {
const userRef = deps.resolveUserContext(c).userRef;
- const manifest: McpServerManifest = c.req.valid('json');
+ const incomingManifest: McpServerManifest = c.req.valid('json');
+ // Unlocked snapshot only for pre-txn DCR HTTP (remote I/O cannot run inside withTransaction).
+ // Header secret keep/rotate is re-resolved under getServerForUpdate inside the txn below.
+ const prior = await deps.mcpServerStore.getServer({ tenant_id: TENANT_ID, name: incomingManifest.name });
// DCR HTTP must finish before the txn so a failed registration never leaves a half-written row
// (txn cannot roll back the AS, and AGENTS forbids remote I/O inside withTransaction).
// Per-request OAuth timeouts live on mcpOAuthFetch (MCP_OAUTH_HTTP_TIMEOUT_MS) — no outer
// withTimeout, so hung AS failures surface as TimeoutError with the intended message.
let dcrClientToSave: OAuthClientRecord | undefined;
- if (manifest.auth?.type === 'dcr') {
- const prior = await deps.mcpServerStore.getServer({ tenant_id: TENANT_ID, name: manifest.name });
+ if (incomingManifest.auth?.type === 'dcr') {
const existingClient = prior !== undefined ? await deps.mcpServerStore.getClient({ id: prior.id }) : undefined;
// Register when: brand-new server, client was cleared (e.g. invalid_client), or MCP URL changed
// (resource/AS may differ; reuse would keep stale oauth_server/client for the old AS).
// TODO: make manifest URL immutable after create so re-DCR / stale OAuth tokens are not possible via PUT.
- const urlChanged = prior !== undefined && prior.manifest.url !== manifest.url;
+ const urlChanged = prior !== undefined && prior.manifest.url !== incomingManifest.url;
const needsDcr = existingClient === undefined || urlChanged;
if (needsDcr) {
try {
dcrClientToSave = await createMcpOAuthClient({
- mcpServerUrl: manifest.url,
- mcpServerName: manifest.name,
+ mcpServerUrl: incomingManifest.url,
+ mcpServerName: incomingManifest.name,
redirectUri: mcpOAuthCallbackUrl(),
clientName: configuration.MCP_DCR_OAUTH_CLIENT_NAME,
});
} catch (error) {
deps.logger.error(
- `DCR client registration failed for "${manifest.name}"; rejecting upsert`,
+ `DCR client registration failed for "${incomingManifest.name}"; rejecting upsert`,
extractErrorLogFields(error),
);
const message =
@@ -161,28 +208,45 @@ export function createSettingsMcpServersRouter<TTransaction>(deps: SettingsMcpSe
}
}
- const record = await deps.withTransaction(async transaction => {
- const saved = await deps.mcpServerStore.upsertServer(
- {
- tenant_id: TENANT_ID,
- name: manifest.name,
- manifest,
- },
- transaction,
- );
- if (dcrClientToSave !== undefined) {
- // New DCR registration (create, missing client, or URL change): replace the shared client only.
- // Existing per-user tokens are left in place; resolve/refresh fails them if they no longer
- // match the new resource/AS, and users re-authorize from there.
- await deps.mcpServerStore.saveClient({ id: saved.id, record: dcrClientToSave }, transaction);
- }
- return saved;
- });
+ try {
+ // Lock → resolve secrets from that snapshot → upsert, all in one txn so concurrent keep
+ // cannot re-write a secret over a rotate that committed in between.
+ const record = await deps.withTransaction(async transaction => {
+ const existing = await deps.mcpServerStore.getServerForUpdate(
+ { tenant_id: TENANT_ID, name: incomingManifest.name },
+ transaction,
+ );
+ const manifest = resolveMcpServerManifestForWrite({
+ incoming: incomingManifest,
+ existing: existing?.manifest,
+ });
+ const saved = await deps.mcpServerStore.upsertServer(
+ {
+ tenant_id: TENANT_ID,
+ name: manifest.name,
+ manifest,
+ },
+ transaction,
+ );
+ if (dcrClientToSave !== undefined) {
+ // New DCR registration (create, missing client, or URL change): replace the shared client only.
+ // Existing per-user tokens are left in place; resolve/refresh fails them if they no longer
+ // match the new resource/AS, and users re-authorize from there.
+ await deps.mcpServerStore.saveClient({ id: saved.id, record: dcrClientToSave }, transaction);
+ }
+ return saved;
+ });
- // A re-upsert preserves `id`, so a DCR server may already carry a token from a prior authorize.
- const token =
- record.manifest.auth?.type === 'dcr' ? await deps.tokenStore.getToken({ id: record.id, userRef }) : undefined;
- return c.json({ data: toConfiguredMcpServer({ record, token }) }, 200);
+ // A re-upsert preserves `id`, so a DCR server may already carry a token from a prior authorize.
+ const token =
+ record.manifest.auth?.type === 'dcr' ? await deps.tokenStore.getToken({ id: record.id, userRef }) : undefined;
+ return c.json({ data: toConfiguredMcpServer({ record, token }) }, 200);
+ } catch (error) {
+ if (error instanceof MissingStoredSecretError) {
+ return c.json({ error: { message: 'Header secret is required' } }, 400);
+ }
+ throw error;
+ }
};
const listToolsHandler: RouteHandler<typeof listMcpServerToolsRoute> = async c => {
diff --git a/packages/server/src/apis/modelProviders.ts b/packages/server/src/apis/modelProviders.ts
index a31c7d2fb..19a4903ae 100644
--- a/packages/server/src/apis/modelProviders.ts
+++ b/packages/server/src/apis/modelProviders.ts
@@ -9,7 +9,8 @@ import {
putModelProviderRoute,
} from '../routes/modelProviderRoutes';
import type { CatalogModelProvider } from '../schemas/modelCatalog';
-import { modelProviderName } from '../schemas/modelProvider';
+import { modelProviderName, type ModelProvider } from '../schemas/modelProvider';
+import { MissingStoredSecretError, resolveStoredSecretValue, toRedactedSecretValue } from '../utils/secretRedaction';
import { TENANT_ID } from './sessions';
export interface ModelProvidersRouterDeps<TTransaction> {
@@ -18,6 +19,13 @@ export interface ModelProvidersRouterDeps<TTransaction> {
withTransaction: WithTransaction<TTransaction>;
}
+function redactModelProvider(manifest: ModelProvider): ModelProvider {
+ return {
+ ...manifest,
+ auth: { api_key: toRedactedSecretValue(manifest.auth.api_key) },
+ };
+}
+
export function createModelProvidersRouter<TTransaction>(deps: ModelProvidersRouterDeps<TTransaction>) {
const catalogHandler: RouteHandler<typeof getModelProviderCatalogRoute> = c => {
const loadedProvidersCatalog = deps.modelCatalog.list();
@@ -32,17 +40,38 @@ export function createModelProvidersRouter<TTransaction>(deps: ModelProvidersRou
const listHandler: RouteHandler<typeof listModelProvidersRoute> = async c => {
const records = await deps.modelProviderStore.listProviders(TENANT_ID);
- return c.json({ data: records.map(record => record.manifest) }, 200);
+ return c.json({ data: records.map(record => redactModelProvider(record.manifest)) }, 200);
};
const putHandler: RouteHandler<typeof putModelProviderRoute> = async c => {
const provider = c.req.valid('json');
- const record = await deps.modelProviderStore.upsertProvider({
- tenant_id: TENANT_ID,
- name: modelProviderName(provider),
- manifest: provider,
- });
- return c.json({ data: record.manifest }, 200);
+ const name = modelProviderName(provider);
+ try {
+ // Lock → resolve secret from that snapshot → upsert, all in one txn so concurrent keep
+ // cannot re-write a secret over a rotate that committed in between.
+ const record = await deps.withTransaction(async transaction => {
+ const existing = await deps.modelProviderStore.getProviderForUpdate(
+ { tenant_id: TENANT_ID, name },
+ transaction,
+ );
+ const manifest: ModelProvider = {
+ ...provider,
+ auth: {
+ api_key: resolveStoredSecretValue({
+ incoming: provider.auth.api_key,
+ existing: existing?.manifest.auth.api_key,
+ }),
+ },
+ };
+ return deps.modelProviderStore.upsertProvider({ tenant_id: TENANT_ID, name, manifest }, transaction);
+ });
+ return c.json({ data: redactModelProvider(record.manifest) }, 200);
+ } catch (error) {
+ if (error instanceof MissingStoredSecretError) {
+ return c.json({ error: { message: 'API key is required' } }, 400);
+ }
+ throw error;
+ }
};
const router = new OpenAPIHono();
diff --git a/packages/server/src/db/mcpServerStore.ts b/packages/server/src/db/mcpServerStore.ts
index ba5315bfd..3337698a4 100644
--- a/packages/server/src/db/mcpServerStore.ts
+++ b/packages/server/src/db/mcpServerStore.ts
@@ -49,6 +49,12 @@ export interface UpsertMcpServerInput {
export interface IMcpServerStore<TTransaction = never> extends IOAuthClientStore<TTransaction> {
listServers(input: ListMcpServersInput, transaction?: TTransaction): Promise<McpServerRecord[]>;
getServer(input: GetMcpServerInput, transaction?: TTransaction): Promise<McpServerRecord | undefined>;
+ /**
+ * Load one server while holding a row lock for the lifetime of `transaction`.
+ * Postgres: `SELECT … FOR UPDATE`. SQLite: plain read under a write txn (BEGIN IMMEDIATE).
+ * Required before read-modify-write of header secrets so concurrent keep/rotate cannot interleave.
+ */
+ getServerForUpdate(input: GetMcpServerInput, transaction: TTransaction): Promise<McpServerRecord | undefined>;
/**
* Creates the server or replaces `manifest` (+ `updated_at`) only.
* Never overwrites `id`, `oauth_server`, or `oauth_client`.
diff --git a/packages/server/src/db/modelProviderStore.ts b/packages/server/src/db/modelProviderStore.ts
index 192faacc3..39dd1b6c0 100644
--- a/packages/server/src/db/modelProviderStore.ts
+++ b/packages/server/src/db/modelProviderStore.ts
@@ -31,6 +31,12 @@ export interface UpsertProviderInput {
export interface IModelProviderStore<TTransaction = never> {
listProviders(tenantId: string, transaction?: TTransaction): Promise<ModelProviderRecord[]>;
getProvider(input: GetProviderInput, transaction?: TTransaction): Promise<ModelProviderRecord | undefined>;
+ /**
+ * Load one provider while holding a row lock for the lifetime of `transaction`.
+ * Postgres: `SELECT … FOR UPDATE`. SQLite: plain read under a write txn (BEGIN IMMEDIATE).
+ * Required before read-modify-write of secrets so concurrent keep/rotate cannot interleave.
+ */
+ getProviderForUpdate(input: GetProviderInput, transaction: TTransaction): Promise<ModelProviderRecord | undefined>;
/** Single-row write: creates the provider or replaces the whole manifest (models included). */
upsertProvider(input: UpsertProviderInput, transaction?: TTransaction): Promise<ModelProviderRecord>;
/** Flattens manifests into the FQN read view for GET /models. */
diff --git a/packages/server/src/db/postgres/mcp-server-store/PostgresMcpServerStore.ts b/packages/server/src/db/postgres/mcp-server-store/PostgresMcpServerStore.ts
index 0479bad9d..5a367b59e 100644
--- a/packages/server/src/db/postgres/mcp-server-store/PostgresMcpServerStore.ts
+++ b/packages/server/src/db/postgres/mcp-server-store/PostgresMcpServerStore.ts
@@ -55,6 +55,20 @@ export class PostgresMcpServerStore implements IMcpServerStore<Transaction<Datab
return row === undefined ? undefined : toRecord(row);
}
+ async getServerForUpdate(
+ input: GetMcpServerInput,
+ transaction: Transaction<Database>,
+ ): Promise<McpServerRecord | undefined> {
+ const row = await transaction
+ .selectFrom('mcp_server')
+ .selectAll()
+ .where('tenant_id', '=', input.tenant_id)
+ .where('name', '=', input.name)
+ .forUpdate()
+ .executeTakeFirst();
+ return row ? toRecord(row) : undefined;
+ }
+
async upsertServer(input: UpsertMcpServerInput, transaction?: Transaction<Database>): Promise<McpServerRecord> {
const db = transaction ?? this.#db;
const row = await db
diff --git a/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts b/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
index d398a7086..68865d248 100644
--- a/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
+++ b/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
@@ -52,6 +52,20 @@ export class PostgresModelProviderStore implements IModelProviderStore<Transacti
return row === undefined ? undefined : toRecord(row);
}
+ async getProviderForUpdate(
+ input: GetProviderInput,
+ transaction: Transaction<Database>,
+ ): Promise<ModelProviderRecord | undefined> {
+ const row = await transaction
+ .selectFrom('model_provider')
+ .selectAll()
+ .where('tenant_id', '=', input.tenant_id)
+ .where('name', '=', input.name)
+ .forUpdate()
+ .executeTakeFirst();
+ return row ? toRecord(row) : undefined;
+ }
+
async upsertProvider(input: UpsertProviderInput, transaction?: Transaction<Database>): Promise<ModelProviderRecord> {
const db = transaction ?? this.#db;
const row = await db
diff --git a/packages/server/src/db/sqlite/mcp-server-store/SqliteMcpServerStore.ts b/packages/server/src/db/sqlite/mcp-server-store/SqliteMcpServerStore.ts
index 7ddb99448..4db327ec4 100644
--- a/packages/server/src/db/sqlite/mcp-server-store/SqliteMcpServerStore.ts
+++ b/packages/server/src/db/sqlite/mcp-server-store/SqliteMcpServerStore.ts
@@ -57,6 +57,22 @@ export class SqliteMcpServerStore implements IMcpServerStore<Transaction<Databas
.executeTakeFirst();
}
+ /**
+ * SQLite has no row-level FOR UPDATE; the required write transaction (BEGIN IMMEDIATE)
+ * serializes concurrent writers so RMW of header secrets stays consistent.
+ */
+ async getServerForUpdate(
+ input: GetMcpServerInput,
+ transaction: Transaction<Database>,
+ ): Promise<McpServerRecord | undefined> {
+ return await transaction
+ .selectFrom('mcp_server')
+ .select(recordColumns)
+ .where('tenant_id', '=', input.tenant_id)
+ .where('name', '=', input.name)
+ .executeTakeFirst();
+ }
+
async upsertServer(input: UpsertMcpServerInput, transaction?: Transaction<Database>): Promise<McpServerRecord> {
const db = transaction ?? this.#db;
const timestamp = nowIso();
diff --git a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
index acb6041ba..1862aed9e 100644
--- a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
+++ b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
@@ -51,6 +51,22 @@ export class SqliteModelProviderStore implements IModelProviderStore<Transaction
.executeTakeFirst();
}
+ /**
+ * SQLite has no row-level FOR UPDATE; the required write transaction (BEGIN IMMEDIATE)
+ * serializes concurrent writers so RMW of secrets stays consistent.
+ */
+ async getProviderForUpdate(
+ input: GetProviderInput,
+ transaction: Transaction<Database>,
+ ): Promise<ModelProviderRecord | undefined> {
+ return await transaction
+ .selectFrom('model_provider')
+ .select(recordColumns)
+ .where('tenant_id', '=', input.tenant_id)
+ .where('name', '=', input.name)
+ .executeTakeFirst();
+ }
+
async upsertProvider(input: UpsertProviderInput, transaction?: Transaction<Database>): Promise<ModelProviderRecord> {
const db = transaction ?? this.#db;
const timestamp = nowIso();
diff --git a/packages/server/src/routes/mcpServerRoutes.ts b/packages/server/src/routes/mcpServerRoutes.ts
index 3bde1f7d2..ec9889b26 100644
--- a/packages/server/src/routes/mcpServerRoutes.ts
+++ b/packages/server/src/routes/mcpServerRoutes.ts
@@ -69,13 +69,14 @@ export const listMcpServersRoute = createRoute({
path: '/',
tags: [MCP_SERVERS_TAG],
summary: 'List MCP servers',
- description: 'All MCP servers with nested auth_status (settings / admin projection).',
+ description:
+ 'All MCP servers with nested auth_status (settings / admin projection). Header auth values are redacted.',
'x-fern-sdk-group-name': ['settings', 'mcpServers'],
'x-fern-sdk-method-name': 'list',
responses: {
200: {
content: { 'application/json': { schema: ListMcpServersResponseSchema } },
- description: 'All MCP servers.',
+ description: 'All MCP servers',
},
401: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
@@ -97,7 +98,8 @@ export const getMcpServerRoute = createRoute({
path: '/{name}',
tags: [MCP_SERVERS_TAG],
summary: 'Get a single MCP server by name',
- description: 'A single MCP server by name, with nested auth_status (settings / admin projection).',
+ description:
+ 'A single MCP server by name, with nested auth_status (settings / admin projection). Header auth values are redacted.',
'x-fern-sdk-group-name': ['settings', 'mcpServers'],
'x-fern-sdk-method-name': 'get',
request: {
@@ -106,7 +108,7 @@ export const getMcpServerRoute = createRoute({
responses: {
200: {
content: { 'application/json': { schema: GetMcpServerResponseSchema } },
- description: 'The MCP server.',
+ description: 'The MCP server',
},
404: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
@@ -121,8 +123,8 @@ export const putMcpServerRoute = createRoute({
tags: [MCP_SERVERS_TAG],
summary: 'Create or replace an MCP server',
description:
- 'Full upsert keyed by `name`: creates the server or replaces its manifest. Does not start DCR or ' +
- 'modify stored oauth_server / oauth_client columns.',
+ 'Create or replace by `name`. Does not start DCR or change oauth client columns. ' +
+ 'Header secrets: real value sets/rotates; redacted keeps existing (400 if none).',
'x-fern-sdk-group-name': ['settings', 'mcpServers'],
'x-fern-sdk-method-name': 'upsert',
request: {
@@ -134,11 +136,11 @@ export const putMcpServerRoute = createRoute({
responses: {
200: {
content: { 'application/json': { schema: PutMcpServerResponseSchema } },
- description: 'The saved MCP server with stub auth_status.',
+ description: 'The saved MCP server with auth_status',
},
400: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
- description: 'Invalid request body.',
+ description: 'Invalid request body, or redacted header secret with no stored value to keep.',
},
422: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
diff --git a/packages/server/src/routes/modelProviderRoutes.ts b/packages/server/src/routes/modelProviderRoutes.ts
index 7a3801b28..a8ec26775 100644
--- a/packages/server/src/routes/modelProviderRoutes.ts
+++ b/packages/server/src/routes/modelProviderRoutes.ts
@@ -51,7 +51,7 @@ export const listModelProvidersRoute = createRoute({
responses: {
200: {
content: { 'application/json': { schema: ListModelProvidersResponseSchema } },
- description: 'All configured model providers.',
+ description: 'All configured model providers',
},
401: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
@@ -70,9 +70,8 @@ export const putModelProviderRoute = createRoute({
tags: [MODEL_PROVIDERS_TAG],
summary: 'Create or replace a model provider',
description:
- 'Full upsert: creates the provider or replaces its entire configuration (models included). The key is the ' +
- 'returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one ' +
- 'configured provider and a repeat call replaces it; only `custom` providers are named by the caller.',
+ 'Create or replace a provider (models included). Well-known types use `type` as `name` (one each); ' +
+ '`custom` is named by the caller. `auth.api_key`: real value sets/rotates; redacted keeps existing (400 if none).',
'x-fern-sdk-group-name': ['settings', 'modelProviders'],
'x-fern-sdk-method-name': 'upsert',
request: {
@@ -84,11 +83,11 @@ export const putModelProviderRoute = createRoute({
responses: {
200: {
content: { 'application/json': { schema: PutModelProviderResponseSchema } },
- description: 'The saved provider.',
+ description: 'The saved provider',
},
400: {
content: { 'application/json': { schema: RequestErrorResponseSchema } },
- description: 'Invalid request body.',
+ description: 'Invalid request body, or redacted API key with no stored secret to keep.',
},
},
});
diff --git a/packages/server/src/schemas/mcpServer.ts b/packages/server/src/schemas/mcpServer.ts
index c054951e1..cbf80a6ee 100644
--- a/packages/server/src/schemas/mcpServer.ts
+++ b/packages/server/src/schemas/mcpServer.ts
@@ -21,7 +21,9 @@ const McpServerHeaderAuthSchema = z
.refine(headers => Object.keys(headers).length > 0, {
message: 'must include at least one header',
})
- .describe('HTTP headers sent on each request to this MCP server.'),
+ .describe(
+ 'Request headers for this MCP server. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored secret for that header name.',
+ ),
})
.strict()
.openapi('McpServerHeaderAuth');
diff --git a/packages/server/src/schemas/modelProvider.ts b/packages/server/src/schemas/modelProvider.ts
index 9034bcd70..e6b4dd4d0 100644
--- a/packages/server/src/schemas/modelProvider.ts
+++ b/packages/server/src/schemas/modelProvider.ts
@@ -1,7 +1,7 @@
/**
* Model-provider domain + wire schemas: configured provider manifests (DB /
- * PUT body) and OpenAPI request/response shapes. Catalog file schemas live on
- * ModelCatalog.
+ * PUT body / response) and OpenAPI request/response shapes. Catalog file schemas
+ * live on ModelCatalog.
*/
import { z } from '@hono/zod-openapi';
import { SUPPORTED_REASONING_EFFORTS, VERCEL_AI_PROVIDER_NAMES } from '@truefoundry/utils-core/core';
@@ -56,7 +56,12 @@ export function refineUniqueModels(models: { model_id: string; name: string }[],
const ModelProviderAuthSchema = z
.object({
- api_key: z.string().min(1).describe('API key used to authenticate with the provider.'),
+ api_key: z
+ .string()
+ .min(1)
+ .describe(
+ 'Provider API key. Responses are redacted; on PUT, a real value sets/rotates and a redacted value keeps the stored key.',
+ ),
})
.strict()
.openapi('ModelProviderAuth');
diff --git a/packages/server/src/utils/secretRedaction.ts b/packages/server/src/utils/secretRedaction.ts
new file mode 100644
index 000000000..348ad0609
--- /dev/null
+++ b/packages/server/src/utils/secretRedaction.ts
@@ -0,0 +1,55 @@
+/**
+ * Redact secret strings for settings API responses and detect/merge
+ * redacted writebacks so clients can keep stored secrets without resending them.
+ */
+
+export const SECRET_REDACTION = '***REDACTED***';
+const MIN_LENGTH_FOR_PREFIX_SUFFIX = 10;
+
+/** Response mask: prefix/suffix for longer secrets; full mask when too short to hide. */
+export function toRedactedSecretValue(secret: string): string {
+ if (secret.length < MIN_LENGTH_FOR_PREFIX_SUFFIX) {
+ return SECRET_REDACTION;
+ }
+ return `${secret.slice(0, 3)}-${SECRET_REDACTION}-${secret.slice(-3)}`;
+}
+
+/**
+ * True when the client sent a redacted stand-in from a prior GET.
+ */
+export function isRedactedSecretValue(value: string): boolean {
+ return value.includes(SECRET_REDACTION);
+}
+
+/**
+ * Thrown when a redacted keep is requested but no stored secret exists
+ * (create with redacted stand-in, or keep for a missing field/header).
+ * Callers map this to a domain-specific 400 message.
+ */
+export class MissingStoredSecretError extends Error {
+ constructor() {
+ super('Missing stored secret');
+ this.name = 'MissingStoredSecretError';
+ }
+}
+
+/**
+ * Resolve the secret to persist for a strict PUT field (always a non-empty string).
+ * Real secrets are stored as-is; redacted stand-ins keep `existing` when present.
+ * @throws {MissingStoredSecretError} when keep is requested with no stored secret
+ */
+export function resolveStoredSecretValue({
+ incoming,
+ existing,
+}: {
+ incoming: string;
+ existing: string | undefined;
+}): string {
+ if (!isRedactedSecretValue(incoming)) {
+ return incoming;
+ }
+ if (existing) {
+ return existing;
+ }
+ throw new MissingStoredSecretError();
+}
diff --git a/packages/server/tests/unit/apis/mcpServers.test.ts b/packages/server/tests/unit/apis/mcpServers.test.ts
index 1e70e2ceb..ca91d9926 100644
--- a/packages/server/tests/unit/apis/mcpServers.test.ts
+++ b/packages/server/tests/unit/apis/mcpServers.test.ts
@@ -22,13 +22,25 @@ const putBodyWithDcr = {
auth: { type: 'dcr' as const },
};
+const HEADER_TOKEN = 'Bearer test-token';
+/** Wire form of HEADER_TOKEN for length ≥ 10: first 3 + SECRET_REDACTION + last 3. */
+const HEADER_TOKEN_REDACTED = 'Bea-***REDACTED***-ken';
+
const putBodyWithHeaderAuth = {
type: 'remote' as const,
name: 'private-mcp',
url: 'https://mcp.example.com/mcp',
auth: {
type: 'header' as const,
- headers: { Authorization: 'Bearer test-token' },
+ headers: { Authorization: HEADER_TOKEN },
+ },
+};
+
+const putBodyWithHeaderAuthWire = {
+ ...putBodyWithHeaderAuth,
+ auth: {
+ type: 'header' as const,
+ headers: { Authorization: HEADER_TOKEN_REDACTED },
},
};
@@ -333,12 +345,123 @@ describe('mcp-servers routers', () => {
}
});
- it('PUT with header auth stores headers and reports authenticated', async () => {
+ it('PUT with header auth stores plaintext and returns redacted headers', async () => {
const response = await settingsRouter.request('/', putInit(putBodyWithHeaderAuth));
expect(response.status).toBe(200);
expect(await response.json()).toEqual({
- data: { ...putBodyWithHeaderAuth, auth_status: { status: 'authenticated' } },
+ data: { ...putBodyWithHeaderAuthWire, auth_status: { status: 'authenticated' } },
});
+
+ const stored = await mcpServerStore.getServer({ tenant_id: TENANT_ID, name: putBodyWithHeaderAuth.name });
+ expect(stored?.manifest.auth).toEqual(putBodyWithHeaderAuth.auth);
+ });
+
+ it('PUT create with a redacted header value returns 400', async () => {
+ const redactedOnly = {
+ ...putBodyWithHeaderAuth,
+ name: 'redacted-only-mcp',
+ auth: {
+ type: 'header' as const,
+ headers: { Authorization: HEADER_TOKEN_REDACTED },
+ },
+ };
+ const response = await settingsRouter.request('/', putInit(redactedOnly));
+ expect(response.status).toBe(400);
+ expect(await response.json()).toEqual({ error: { message: 'Header secret is required' } });
+ });
+
+ it('PUT with a redacted header value keeps the stored secret', async () => {
+ await settingsRouter.request('/', putInit(putBodyWithHeaderAuth));
+
+ const keep = {
+ ...putBodyWithHeaderAuth,
+ url: 'https://mcp.example.com/v2/mcp',
+ auth: {
+ type: 'header' as const,
+ headers: { Authorization: HEADER_TOKEN_REDACTED },
+ },
+ };
+ const response = await settingsRouter.request('/', putInit(keep));
+ expect(response.status).toBe(200);
+ expect(await response.json()).toEqual({
+ data: {
+ ...keep,
+ auth: {
+ type: 'header',
+ headers: { Authorization: HEADER_TOKEN_REDACTED },
+ },
+ auth_status: { status: 'authenticated' },
+ },
+ });
+
+ const stored = await mcpServerStore.getServer({ tenant_id: TENANT_ID, name: putBodyWithHeaderAuth.name });
+ expect(stored?.manifest).toEqual({
+ ...putBodyWithHeaderAuth,
+ url: keep.url,
+ auth: putBodyWithHeaderAuth.auth,
+ });
+ });
+
+ it('PUT with a different redacted header value still keeps the stored secret', async () => {
+ await settingsRouter.request('/', putInit(putBodyWithHeaderAuth));
+
+ // Any value containing ***REDACTED*** is treated as keep, not only the exact GET mask.
+ const keep = {
+ ...putBodyWithHeaderAuth,
+ url: 'https://mcp.example.com/v3/mcp',
+ auth: {
+ type: 'header' as const,
+ headers: { Authorization: 'oth-***REDACTED***-xxx' },
+ },
+ };
+ const response = await settingsRouter.request('/', putInit(keep));
+ expect(response.status).toBe(200);
+ expect(await response.json()).toEqual({
+ data: {
+ ...keep,
+ auth: {
+ type: 'header',
+ headers: { Authorization: HEADER_TOKEN_REDACTED },
+ },
+ auth_status: { status: 'authenticated' },
+ },
+ });
+
+ const stored = await mcpServerStore.getServer({ tenant_id: TENANT_ID, name: putBodyWithHeaderAuth.name });
+ expect(stored?.manifest).toEqual({
+ ...putBodyWithHeaderAuth,
+ url: keep.url,
+ auth: putBodyWithHeaderAuth.auth,
+ });
+ });
+
+ it('PUT with a real header value rotates the stored secret', async () => {
+ await settingsRouter.request('/', putInit(putBodyWithHeaderAuth));
+
+ const rotatedToken = 'Bearer rotated-token';
+ const rotatedTokenRedacted = 'Bea-***REDACTED***-ken';
+ const rotated = {
+ ...putBodyWithHeaderAuth,
+ auth: {
+ type: 'header' as const,
+ headers: { Authorization: rotatedToken },
+ },
+ };
+ const response = await settingsRouter.request('/', putInit(rotated));
+ expect(response.status).toBe(200);
+ expect(await response.json()).toEqual({
+ data: {
+ ...rotated,
+ auth: {
+ type: 'header',
+ headers: { Authorization: rotatedTokenRedacted },
+ },
+ auth_status: { status: 'authenticated' },
+ },
+ });
+
+ const stored = await mcpServerStore.getServer({ tenant_id: TENANT_ID, name: putBodyWithHeaderAuth.name });
+ expect(stored?.manifest.auth).toEqual(rotated.auth);
});
it('GET / on the chat router returns per-user auth_status and public auth type', async () => {
@@ -626,10 +749,12 @@ describe('mcp-servers routers', () => {
data: { ...putBody, auth_status: { status: 'not_required' } },
});
+ // Ensure header-auth fixture is present with a known secret (later tests may have rotated it).
+ await settingsRouter.request('/', putInit(putBodyWithHeaderAuth));
const headerAuth = await mcpServersRouter.request('/private-mcp/authorize', { method: 'DELETE' });
expect(headerAuth.status).toBe(200);
expect(await headerAuth.json()).toEqual({
- data: { ...putBodyWithHeaderAuth, auth_status: { status: 'authenticated' } },
+ data: { ...putBodyWithHeaderAuthWire, auth_status: { status: 'authenticated' } },
});
const missing = await mcpServersRouter.request('/missing/authorize', { method: 'DELETE' });
diff --git a/packages/server/tests/unit/apis/modelProviders.test.ts b/packages/server/tests/unit/apis/modelProviders.test.ts
index 43f3e3cb7..80ada9b28 100644
--- a/packages/server/tests/unit/apis/modelProviders.test.ts
+++ b/packages/server/tests/unit/apis/modelProviders.test.ts
@@ -1,5 +1,6 @@
import winston from 'winston';
import { createModelsRouter } from '../../../src/apis/models';
+import { TENANT_ID } from '../../../src/apis/sessions';
import { createSettingsRouter } from '../../../src/apis/settings';
import { LOCAL_USER_CONTEXT } from '../../../src/auth/identity';
import { McpCatalog } from '../../../src/catalog/McpCatalog';
@@ -7,12 +8,14 @@ import { ModelCatalog } from '../../../src/catalog/ModelCatalog';
import { SandboxCatalog } from '../../../src/catalog/SandboxCatalog';
import { SkillCatalog } from '../../../src/catalog/SkillCatalog';
import { migrateSqliteToLatest } from '../../../src/db/migrateSqlite';
+import type { IModelProviderStore } from '../../../src/db/modelProviderStore';
import { createSqliteDb } from '../../../src/db/sqlite/client';
import { SqliteMcpServerStore } from '../../../src/db/sqlite/mcp-server-store/SqliteMcpServerStore';
import { SqliteModelProviderStore } from '../../../src/db/sqlite/model-provider-store/SqliteModelProviderStore';
import { SqliteSandboxProviderStore } from '../../../src/db/sqlite/sandbox-provider-store/SqliteSandboxProviderStore';
import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkillStore';
import { SqliteOAuthTokenStore } from '../../../src/db/sqlite/token-store/SqliteOAuthTokenStore';
+import { toRedactedSecretValue } from '../../../src/utils/secretRedaction';
const model = {
model_id: 'claude-sonnet-4-6',
@@ -26,9 +29,15 @@ const anthropicBody = {
models: [model],
};
-/** What the body above is stored and echoed as: no name of its own, endpoint from its schema. */
+/** What the body above is stored as: no name of its own, endpoint from its schema. */
const anthropicProvider = { ...anthropicBody, base_url: 'https://api.anthropic.com/v1' };
+/** Wire view of anthropicProvider (secrets redacted). */
+const anthropicProviderWire = {
+ ...anthropicProvider,
+ auth: { api_key: toRedactedSecretValue(anthropicProvider.auth.api_key) },
+};
+
const customBody = {
type: 'custom' as const,
name: 'internal',
@@ -37,6 +46,11 @@ const customBody = {
models: [model],
};
+const customBodyWire = {
+ ...customBody,
+ auth: { api_key: toRedactedSecretValue(customBody.auth.api_key) },
+};
+
function putInit(body: unknown): RequestInit {
return {
method: 'PUT',
@@ -45,9 +59,17 @@ function putInit(body: unknown): RequestInit {
};
}
+function withRedactedApiKey<T extends { auth: { api_key: string } }>(provider: T): T {
+ return {
+ ...provider,
+ auth: { api_key: toRedactedSecretValue(provider.auth.api_key) },
+ };
+}
+
async function createRouters(): Promise<{
settingsRouter: ReturnType<typeof createSettingsRouter>;
modelsRouter: ReturnType<typeof createModelsRouter>;
+ modelProviderStore: IModelProviderStore;
}> {
const db = createSqliteDb(':memory:');
await migrateSqliteToLatest(db);
@@ -71,6 +93,7 @@ async function createRouters(): Promise<{
modelProviderStore,
withTransaction: callback => db.transaction().execute(callback),
}),
+ modelProviderStore,
};
}
@@ -96,14 +119,14 @@ describe('settings model-providers and models routers', () => {
});
});
- it('PUT upserts a well-known provider without base_url and echoes the stored auth', async () => {
+ it('PUT upserts a well-known provider without base_url and returns redacted auth', async () => {
const response = await settingsRouter.request('/model-providers', putInit(anthropicBody));
expect(response.status).toBe(200);
- expect(await response.json()).toEqual({ data: anthropicProvider });
+ expect(await response.json()).toEqual({ data: anthropicProviderWire });
const list = await settingsRouter.request('/model-providers');
expect(list.status).toBe(200);
- expect(await list.json()).toEqual({ data: [anthropicProvider] });
+ expect(await list.json()).toEqual({ data: [anthropicProviderWire] });
});
it('PUT requires base_url for custom providers', async () => {
@@ -113,7 +136,7 @@ describe('settings model-providers and models routers', () => {
const created = await settingsRouter.request('/model-providers', putInit(customBody));
expect(created.status).toBe(200);
- expect(await created.json()).toEqual({ data: customBody });
+ expect(await created.json()).toEqual({ data: customBodyWire });
});
it('PUT rejects invalid bodies at the Zod layer', async () => {
@@ -149,10 +172,14 @@ describe('well-known types are limited to one provider', () => {
const rotated = { ...anthropicBody, auth: { api_key: 'sk-ant-rotated' } };
const update = await settingsRouter.request('/model-providers', putInit(rotated));
expect(update.status).toBe(200);
- expect(await update.json()).toEqual({ data: { ...anthropicProvider, auth: rotated.auth } });
+ expect(await update.json()).toEqual({
+ data: withRedactedApiKey({ ...anthropicProvider, auth: rotated.auth }),
+ });
const list = await settingsRouter.request('/model-providers');
- expect(await list.json()).toEqual({ data: [{ ...anthropicProvider, auth: rotated.auth }] });
+ expect(await list.json()).toEqual({
+ data: [withRedactedApiKey({ ...anthropicProvider, auth: rotated.auth })],
+ });
const models = await modelsRouter.request('/');
expect(((await models.json()) as { data: { name: string }[] }).data.map(entry => entry.name)).toEqual([
'anthropic/claude-sonnet-4-6',
@@ -178,7 +205,9 @@ describe('well-known types are limited to one provider', () => {
const proxied = { ...anthropicBody, base_url: 'https://gateway.internal.example.com/v1' };
const response = await settingsRouter.request('/model-providers', putInit(proxied));
expect(response.status).toBe(200);
- expect(await response.json()).toEqual({ data: { ...anthropicProvider, base_url: proxied.base_url } });
+ expect(await response.json()).toEqual({
+ data: withRedactedApiKey({ ...anthropicProvider, base_url: proxied.base_url }),
+ });
});
it('PUT allows several caller-supplied providers, which each name their own endpoint', async () => {
@@ -188,7 +217,74 @@ describe('well-known types are limited to one provider', () => {
expect((await settingsRouter.request('/model-providers', putInit(second))).status).toBe(200);
const list = await settingsRouter.request('/model-providers');
- expect(await list.json()).toEqual({ data: [customBody, second] });
+ expect(await list.json()).toEqual({
+ data: [customBodyWire, withRedactedApiKey(second)],
+ });
+ });
+});
+
+describe('model-provider secret redaction and strict PUT', () => {
+ it('PUT create with a redacted api_key returns 400', async () => {
+ const { settingsRouter } = await createRouters();
+ const response = await settingsRouter.request(
+ '/model-providers',
+ putInit({
+ ...anthropicBody,
+ auth: { api_key: toRedactedSecretValue('sk-ant-secret') },
+ }),
+ );
+ expect(response.status).toBe(400);
+ expect(await response.json()).toEqual({ error: { message: 'API key is required' } });
+ });
+
+ it('PUT rejects a missing api_key at the Zod layer', async () => {
+ const { settingsRouter } = await createRouters();
+ const response = await settingsRouter.request('/model-providers', putInit({ ...anthropicBody, auth: {} }));
+ expect(response.status).toBe(400);
+ });
+
+ it('PUT with a redacted api_key keeps the stored secret', async () => {
+ const { settingsRouter, modelProviderStore } = await createRouters();
+ expect((await settingsRouter.request('/model-providers', putInit(anthropicBody))).status).toBe(200);
+
+ const redactedKeep = {
+ ...anthropicBody,
+ auth: { api_key: toRedactedSecretValue(anthropicBody.auth.api_key) },
+ models: [
+ model,
+ {
+ model_id: 'claude-opus-4',
+ name: 'claude-opus-4',
+ properties: model.properties,
+ },
+ ],
+ };
+ const update = await settingsRouter.request('/model-providers', putInit(redactedKeep));
+ expect(update.status).toBe(200);
+ const updateBody = (await update.json()) as {
+ data: { auth: { api_key: string }; models: unknown[] };
+ };
+ expect(updateBody.data.auth.api_key).toBe(toRedactedSecretValue(anthropicBody.auth.api_key));
+ expect(updateBody.data.models).toHaveLength(2);
+
+ const stored = await modelProviderStore.getProvider({ tenant_id: TENANT_ID, name: 'anthropic' });
+ expect(stored?.manifest.auth.api_key).toBe('sk-ant-secret');
+ });
+
+ it('PUT with a real api_key rotates the stored secret', async () => {
+ const { settingsRouter, modelProviderStore } = await createRouters();
+ expect((await settingsRouter.request('/model-providers', putInit(anthropicBody))).status).toBe(200);
+
+ const rotatedKey = 'sk-ant-rotated-key';
+ const rotated = { ...anthropicBody, auth: { api_key: rotatedKey } };
+ const update = await settingsRouter.request('/model-providers', putInit(rotated));
+ expect(update.status).toBe(200);
+ expect((await update.json()) as { data: { auth: { api_key: string } } }).toEqual({
+ data: withRedactedApiKey({ ...anthropicProvider, auth: { api_key: rotatedKey } }),
+ });
+
+ const stored = await modelProviderStore.getProvider({ tenant_id: TENANT_ID, name: 'anthropic' });
+ expect(stored?.manifest.auth.api_key).toBe(rotatedKey);
});
});
@@ -207,5 +303,7 @@ describe('catalog presets are configurable', () => {
expect(logo === undefined || typeof logo === 'string').toBe(true);
const response = await settingsRouter.request('/model-providers', putInit(body));
expect(response.status).toBe(200);
+ const json = (await response.json()) as { data: { auth: { api_key: string } } };
+ expect(json.data.auth.api_key).toBe(toRedactedSecretValue(`sk-${preset.type}`));
});
});