fix: centralize error message sanitization in createApiError

.changeset/fix-error-sanitization.md

@@ -0,0 +1,5 @@
+---
+"@inkeep/agents-core": patch
+---
+
+Fix error message sanitization bypass in createApiError for 500-level errors

agents-api/src/__tests__/manage/routes/crud/credentialStores.test.ts

@@ -284,7 +284,7 @@ describe('Credential Stores - CRUD Operations', () => {
       expect(response.status).toBe(500);
       const data = await response.json();
       expect(data.error.message).toContain(
-        "Credential store 'unavailable-store' is not available: Store is offline"
+        "[REDACTED] store 'unavailable-store' is not available: Store is offline"
       );
     });
 
@@ -310,7 +310,7 @@ describe('Credential Stores - CRUD Operations', () => {
       // Assert
       expect(response.status).toBe(500);
       const data = await response.json();
-      expect(data.error.message).toBe('Failed to store credential: Storage failed');
+      expect(data.error.message).toBe('Failed to store [REDACTED]: Storage failed');
     });
 
     it('should validate request body schema', async () => {

agents-api/src/__tests__/manage/routes/invitations.test.ts

@@ -60,7 +60,7 @@ describe('Invitations Route', () => {
 
       expect(res.status).toBe(500);
       const body = await res.json();
-      expect(body.error.message).toContain('Auth not configured');
+      expect(body.error.message).toContain('[REDACTED] not configured');
     });
 
     describe('with auth configured', () => {

agents-api/src/__tests__/manage/routes/passwordResetLinks.test.ts

@@ -293,7 +293,7 @@ describe('Password Reset Links Route', () => {
 
         expect(res.status).toBe(500);
         const body = await res.json();
-        expect(body.error.message).toContain('Auth not configured');
+        expect(body.error.message).toContain('[REDACTED] not configured');
       });
     });
 

packages/agents-core/src/utils/__tests__/error.test.ts

@@ -1,5 +1,119 @@
 import { describe, expect, it } from 'vitest';
-import { isUniqueConstraintError, throwIfUniqueConstraintError } from '../error';
+import { createApiError, isUniqueConstraintError, throwIfUniqueConstraintError } from '../error';
+
+describe('sanitizeErrorMessage (via createApiError)', () => {
+  async function getResponseBody(
+    message: string,
+    code: 'internal_server_error' | 'bad_request' = 'internal_server_error'
+  ) {
+    const exception = createApiError({ code, message });
+    return JSON.parse(await exception.getResponse().text());
+  }
+
+  it('redacts IPv4 addresses with port', async () => {
+    const body = await getResponseBody('connect ECONNREFUSED 10.0.0.5:5432');
+    expect(body.detail).toBe('connect ECONNREFUSED [REDACTED_HOST]');
+    expect(body.detail).not.toContain('10.0.0.5');
+  });
+
+  it('redacts IPv4 addresses without port', async () => {
+    const body = await getResponseBody('could not connect to 192.168.1.1');
+    expect(body.detail).not.toContain('192.168.1.1');
+    expect(body.detail).toContain('[REDACTED_HOST]');
+  });
+
+  it('redacts PostgreSQL connection strings', async () => {
+    const body = await getResponseBody('postgresql://appuser:pass@host:5432/db failed');
+    expect(body.detail).toBe('[REDACTED_CONNECTION] failed');
+    expect(body.detail).not.toContain('appuser');
+  });
+
+  it('redacts connection string containing IP without leaking credentials', async () => {
+    const body = await getResponseBody(
+      'postgresql://admin:s3cret@10.0.0.5:5432/mydb connection failed'
+    );
+    expect(body.detail).toBe('[REDACTED_CONNECTION] connection failed');
+    expect(body.detail).not.toContain('admin');
+    expect(body.detail).not.toContain('s3cret');
+    expect(body.detail).not.toContain('10.0.0.5');
+  });
+
+  it('redacts other database connection schemes', async () => {
+    const mysql = await getResponseBody('mysql://root:pass@db:3306/app failed');
+    expect(mysql.detail).toBe('[REDACTED_CONNECTION] failed');
+
+    const redis = await getResponseBody('redis://default:pass@cache:6379 timeout');
+    expect(redis.detail).toBe('[REDACTED_CONNECTION] timeout');
+
+    const mongo = await getResponseBody('mongodb+srv://user:pass@cluster.example.com/db error');
+    expect(mongo.detail).toBe('[REDACTED_CONNECTION] error');
+  });
+
+  it('redacts server file paths', async () => {
+    const body = await getResponseBody('Error at /var/task/packages/agents-core/dist/index.js:42');
+    expect(body.detail).not.toContain('/var/task');
+    expect(body.detail).toContain('[REDACTED_PATH]');
+  });
+
+  it('redacts /tmp paths', async () => {
+    const body = await getResponseBody('Cannot read /tmp/secrets.json');
+    expect(body.detail).not.toContain('/tmp/secrets.json');
+    expect(body.detail).toContain('[REDACTED_PATH]');
+  });
+
+  it('redacts sensitive keywords', async () => {
+    const body = await getResponseBody('Invalid auth token');
+    expect(body.detail).toBe('Invalid [REDACTED] [REDACTED]');
+  });
+
+  it('redacts credential keyword', async () => {
+    const body = await getResponseBody('Failed to fetch credential');
+    expect(body.detail).toBe('Failed to fetch [REDACTED]');
+  });
+
+  it('preserves safe messages unchanged', async () => {
+    const body = await getResponseBody('Failed to retrieve project');
+    expect(body.detail).toBe('Failed to retrieve project');
+  });
+
+  it('handles multiple patterns in one message', async () => {
+    const body = await getResponseBody(
+      'connect to 10.0.0.5:5432 at /var/log/app.log with password'
+    );
+    expect(body.detail).not.toContain('10.0.0.5');
+    expect(body.detail).not.toContain('/var/log');
+    expect(body.detail).not.toContain('password');
+  });
+});
+
+describe('createApiError sanitization integration', () => {
+  it('sanitizes 500 response body', async () => {
+    const exception = createApiError({
+      code: 'internal_server_error',
+      message: 'connect ECONNREFUSED 10.0.0.5:5432',
+    });
+    const body = JSON.parse(await exception.getResponse().text());
+    expect(body.detail).not.toContain('10.0.0.5');
+    expect(body.error.message).not.toContain('10.0.0.5');
+    expect(body.status).toBe(500);
+  });
+
+  it('preserves 400 response body unchanged', async () => {
+    const message = 'Missing required header: x-api-key with auth token';
+    const exception = createApiError({ code: 'bad_request', message });
+    const body = JSON.parse(await exception.getResponse().text());
+    expect(body.detail).toBe(message);
+    expect(body.error.message).toBe(message);
+    expect(body.status).toBe(400);
+  });
+
+  it('preserves 404 response body unchanged', async () => {
+    const message = 'Agent not found at /var/task/agents';
+    const exception = createApiError({ code: 'not_found', message });
+    const body = JSON.parse(await exception.getResponse().text());
+    expect(body.detail).toBe(message);
+  });
+});
 
 describe('isUniqueConstraintError', () => {
   describe('PostgreSQL unique violation (23505)', () => {

packages/agents-core/src/utils/error.ts

@@ -77,6 +77,17 @@ export const errorResponseSchema = z
 
 export type ErrorResponse = z.infer<typeof errorResponseSchema>;
 
+function sanitizeErrorMessage(message: string): string {
+  return message
+    .replace(
+      /(?:postgresql|postgres|mysql|mongodb(?:\+srv)?|redis|rediss|amqp):\/\/[^\s,)]+/gi,
+      '[REDACTED_CONNECTION]'
+    )
+    .replace(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(:\d+)?\b/g, '[REDACTED_HOST]')
+    .replace(/\/(?:var|tmp|home|usr|etc|opt)\/\S+/g, '[REDACTED_PATH]')
+    .replace(/\b(password|token|key|secret|auth|credential)\b/gi, '[REDACTED]');
+}
+
 export function createApiError({
   code,
   message,
@@ -94,16 +105,19 @@ export function createApiError({
   const title = getTitleFromCode(code);
   const _type = `${ERROR_DOCS_BASE_URL}#${code}`;
 
+  const sanitizedMessage = status >= 500 ? sanitizeErrorMessage(message) : message;
+
   const problemDetails: ProblemDetails = {
     title,
     status,
-    detail: message,
+    detail: sanitizedMessage,
     code,
     ...(instance && { instance }),
     ...(requestId && { requestId }),
   };
 
-  const errorMessage = message.length > 100 ? `${message.substring(0, 97)}...` : message;
+  const errorMessage =
+    sanitizedMessage.length > 100 ? `${sanitizedMessage.substring(0, 97)}...` : sanitizedMessage;
 
   const responseBody = {
     ...problemDetails,
@@ -122,7 +136,7 @@ export function createApiError({
 
   // @ts-expect-error - The HTTPException constructor expects a ContentfulStatusCode, but we're using a number
   // This is safe because we're only using valid HTTP status codes
-  return new HTTPException(status, { message, res });
+  return new HTTPException(status, { message: sanitizedMessage, res });
 }
 
 export async function handleApiError(
@@ -195,9 +209,7 @@ export async function handleApiError(
   );
 
   const sanitizedErrorMessage =
-    error instanceof Error
-      ? error.message.replace(/\b(password|token|key|secret|auth)\b/gi, '[REDACTED]')
-      : 'Unknown error';
+    error instanceof Error ? sanitizeErrorMessage(error.message) : 'Unknown error';
 
   const problemDetails: ProblemDetails & { error: { code: ErrorCodes; message: string } } = {
     // type: `${ERROR_DOCS_BASE_URL}#internal_server_error`,