Compare commits

...

3 Commits

Author SHA1 Message Date
0xmrpeter
a846911d72 fix(api-server): address PR #189 review — security, encapsulation, error handling
- Revert SessionIdParamSchema regex that was a breaking change for all session routes
- Add path traversal protection in HistoryStore.filePath() using path.basename()
- Remove decodeURIComponent bypass risk in history route
- Add ServiceUnavailableError class for consistent 503 error handling
- Refactor: route history access through ContextManager.getHistory() instead of
  exposing internal HistoryStore as standalone service
- Add path traversal and ContextManager.getHistory() tests

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 11:22:20 +07:00
lngdao
b94761552e fix(api-server): address PR #189 review — session check, path traversal, 503 status
- Add session existence check before querying history store
- Add regex constraint to SessionIdParamSchema to prevent path traversal
- Return 503 instead of 404 when history store is unavailable
2026-04-02 10:18:43 +07:00
lngdao
1ca57cd621 feat(api-server): add session history endpoint
GET /api/v1/sessions/:sessionId/history returns the full conversation
history for a session from the context plugin's HistoryStore.
2026-04-02 02:52:42 +07:00
9 changed files with 159 additions and 2 deletions

View File

@ -6,6 +6,7 @@ import type { OpenACPPlugin, InstallContext } from '../../core/plugin/types.js'
import type { OpenACPCore } from '../../core/core.js'
import type { TopicManager } from '../telegram/topic-manager.js'
import type { CommandRegistry } from '../../core/command-registry.js'
import type { ContextManager } from '../context/context-manager.js'
import type { ApiServerInstance } from './server.js'
import type { RouteDeps } from './routes/types.js'
import { createChildLogger } from '../../core/utils/log.js'
@ -229,6 +230,7 @@ function createApiServerPlugin(): OpenACPPlugin {
// Resolve optional services for route deps
const topicManager = ctx.getService<TopicManager>('topic-manager')
const commandRegistry = ctx.getService<CommandRegistry>('command-registry')
const contextManager = ctx.getService<ContextManager>('context')
// Build auth pre-handler for route-level auth on unauthenticated route groups
const routeAuthPreHandler = createAuthPreHandler(() => secret, () => jwtSecret, tokenStore)
@ -240,6 +242,7 @@ function createApiServerPlugin(): OpenACPPlugin {
getVersion,
commandRegistry,
authPreHandler: routeAuthPreHandler,
contextManager,
}
// Register all route plugins under /api/v1/

View File

@ -30,6 +30,16 @@ export class BadRequestError extends Error {
}
}
export class ServiceUnavailableError extends Error {
constructor(
public code: string,
message: string,
) {
super(message);
this.name = 'ServiceUnavailableError';
}
}
export class AuthError extends Error {
constructor(
public code: string,
@ -80,6 +90,17 @@ export function globalErrorHandler(
return;
}
if (error instanceof ServiceUnavailableError) {
reply.status(503).send({
error: {
code: error.code,
message: error.message,
statusCode: 503,
},
});
return;
}
if (error instanceof AuthError) {
reply.status(error.statusCode).send({
error: {

View File

@ -1,6 +1,6 @@
import type { FastifyInstance } from 'fastify';
import type { RouteDeps } from './types.js';
import { NotFoundError } from '../middleware/error-handler.js';
import { NotFoundError, ServiceUnavailableError } from '../middleware/error-handler.js';
import { requireScopes } from '../middleware/auth.js';
import { createChildLogger } from '../../../core/utils/log.js';
import {
@ -459,6 +459,33 @@ export async function sessionRoutes(
},
);
// GET /sessions/:sessionId/history — get full conversation history
app.get<{ Params: { sessionId: string } }>(
'/:sessionId/history',
{ preHandler: requireScopes('sessions:read') },
async (request, reply) => {
const { sessionId } = SessionIdParamSchema.parse(request.params);
const session = deps.core.sessionManager.getSession(sessionId);
if (!session) {
throw new NotFoundError(
'SESSION_NOT_FOUND',
`Session "${sessionId}" not found`,
);
}
if (!deps.contextManager) {
throw new ServiceUnavailableError(
'HISTORY_UNAVAILABLE',
'History store not available',
);
}
const history = await deps.contextManager.getHistory(sessionId);
if (!history) {
throw new NotFoundError('HISTORY_NOT_FOUND', `No history for session "${sessionId}"`);
}
return { history };
},
);
// DELETE /sessions/:sessionId — cancel a session
app.delete<{ Params: { sessionId: string } }>(
'/:sessionId',

View File

@ -2,6 +2,7 @@ import type { preHandlerHookHandler } from 'fastify';
import type { OpenACPCore } from '../../../core/core.js';
import type { TopicManager } from '../../telegram/topic-manager.js';
import type { CommandRegistry } from '../../../core/command-registry.js';
import type { ContextManager } from '../../context/context-manager.js';
/**
* Dependencies injected into Fastify route plugins.
@ -15,4 +16,6 @@ export interface RouteDeps {
commandRegistry?: CommandRegistry;
/** Auth pre-handler for routes registered without global auth (e.g. system routes). */
authPreHandler?: preHandlerHookHandler;
/** Context manager for reading session conversation history. */
contextManager?: ContextManager;
}

View File

@ -0,0 +1,58 @@
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, beforeEach, describe, expect, it } from "vitest";
import { ContextManager } from "../context-manager.js";
import { HistoryStore } from "../history/history-store.js";
import type { SessionHistory } from "../history/types.js";
function makeHistory(sessionId: string): SessionHistory {
return {
version: 1,
sessionId,
turns: [
{
index: 0,
role: "user",
timestamp: "2026-01-01T00:00:00.000Z",
content: "Hello",
},
],
};
}
describe("ContextManager.getHistory", () => {
let tmpDir: string;
let store: HistoryStore;
let manager: ContextManager;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "ctx-mgr-history-test-"));
store = new HistoryStore(path.join(tmpDir, "history"));
manager = new ContextManager(path.join(tmpDir, "cache"));
});
afterEach(() => {
fs.rmSync(tmpDir, { recursive: true, force: true });
});
it("returns null when no history store is set", async () => {
const result = await manager.getHistory("session-1");
expect(result).toBeNull();
});
it("returns history when store is set and session exists", async () => {
const history = makeHistory("session-1");
await store.write(history);
manager.setHistoryStore(store);
const result = await manager.getHistory("session-1");
expect(result).toEqual(history);
});
it("returns null when session has no history", async () => {
manager.setHistoryStore(store);
const result = await manager.getHistory("nonexistent");
expect(result).toBeNull();
});
});

View File

@ -1,16 +1,28 @@
import * as os from "node:os";
import * as path from "node:path";
import type { ContextProvider, ContextQuery, ContextOptions, ContextResult, SessionListResult } from "./context-provider.js";
import type { HistoryStore } from "./history/history-store.js";
import type { SessionHistory } from "./history/types.js";
import { ContextCache } from "./context-cache.js";
export class ContextManager {
private providers: ContextProvider[] = [];
private cache: ContextCache;
private historyStore?: HistoryStore;
constructor(cachePath?: string) {
this.cache = new ContextCache(cachePath ?? path.join(os.homedir(), ".openacp", "cache", "entire"));
}
setHistoryStore(store: HistoryStore): void {
this.historyStore = store;
}
async getHistory(sessionId: string): Promise<SessionHistory | null> {
if (!this.historyStore) return null;
return this.historyStore.read(sessionId);
}
register(provider: ContextProvider): void {
this.providers.push(provider);
}

View File

@ -151,6 +151,33 @@ describe("HistoryStore", () => {
});
});
describe("path traversal protection", () => {
it("strips directory components from session ID on read", async () => {
await store.write(makeHistory("legit-session"));
const result = await store.read("../../../etc/passwd");
expect(result).toBeNull();
});
it("strips directory components from session ID on exists", async () => {
const result = await store.exists("../../etc/passwd");
expect(result).toBe(false);
});
it("uses only basename when session ID contains path separators", async () => {
await store.write(makeHistory("safe-id"));
// path.basename("foo/bar/safe-id") => "safe-id", so reading with traversal won't reach it
const result = await store.read("../other-dir/safe-id");
// Should read basename "safe-id" from the store dir, which exists
expect(result?.sessionId).toBe("safe-id");
});
it("rejects session ID that resolves outside store directory", async () => {
// path.basename strips traversal, but double-check the resolved path stays within dir
const result = await store.read("..%2F..%2Fetc%2Fpasswd");
expect(result).toBeNull();
});
});
describe("corrupt JSON handling", () => {
it("returns null when the file contains invalid JSON", async () => {
const corruptPath = path.join(tmpDir, "corrupt-session.json");

View File

@ -50,6 +50,11 @@ export class HistoryStore {
}
private filePath(sessionId: string): string {
return path.join(this.dir, `${sessionId}.json`);
const basename = path.basename(sessionId);
const resolved = path.join(this.dir, `${basename}.json`);
if (!resolved.startsWith(this.dir)) {
throw new Error(`Invalid session ID: ${sessionId}`);
}
return resolved;
}
}

View File

@ -59,6 +59,7 @@ const contextPlugin: OpenACPPlugin = {
const manager = new ContextManager(cachePath)
manager.register(new HistoryProvider(store, getRecords))
manager.register(new EntireProvider())
manager.setHistoryStore(store)
ctx.registerService('context', manager)
// Middleware: capture user prompts