mirror of
https://github.com/tiennm99/ccs.git
synced 2026-10-14 20:17:03 +00:00
Gate /api/bar/* behind the localhost-when-auth-disabled guard (single DRY choke point) so native quota/tier/cost can't leak on a non-loopback bind with auth disabled; add a guard test. Delete the dishonest maxRedirections test that asserted the opposite of the production redirect hardening. Key per-account today-cost on the local day (matching analytics) instead of UTC. Stop the inner 429 retry in the Claude usage fetch so the outer cache + circuit breaker honor Retry-After. Narrow the usage-transformer map type and fix stale doc-comments; clarify the one-alert-per-reset-window quota rule; gitignore the local demo scaffolding.
188 lines
6.6 KiB
TypeScript
188 lines
6.6 KiB
TypeScript
/**
|
|
* Security gate for /api/bar/* — these endpoints expose the user's native
|
|
* quota, tier, and cost snapshot, so unlike the rest of the read API they must
|
|
* be refused for non-loopback callers when dashboard auth is disabled.
|
|
*
|
|
* The gate lives in the top-level apiRoutes middleware (one choke point), so we
|
|
* exercise it by mounting the real apiRoutes and toggling auth via env, mirroring
|
|
* api-routes-remote-write-guard.test.ts.
|
|
*/
|
|
|
|
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it } from 'bun:test';
|
|
import bcrypt from 'bcrypt';
|
|
import express from 'express';
|
|
import type { Server } from 'http';
|
|
import * as fs from 'fs';
|
|
import * as os from 'os';
|
|
import * as path from 'path';
|
|
import { apiRoutes } from '../../../src/web-server/routes';
|
|
import {
|
|
authMiddleware,
|
|
createSessionMiddleware,
|
|
} from '../../../src/web-server/middleware/auth-middleware';
|
|
|
|
const BAR_LOCAL_ACCESS_ERROR =
|
|
'CCS Bar endpoints require localhost access when dashboard auth is disabled.';
|
|
|
|
describe('api-routes /api/bar/* local-access guard', () => {
|
|
let server: Server;
|
|
let baseUrl = '';
|
|
let forcedRemoteAddress = '127.0.0.1';
|
|
let tempHome = '';
|
|
let originalDashboardAuthEnabled: string | undefined;
|
|
let originalCcsHome: string | undefined;
|
|
let originalCodexHome: string | undefined;
|
|
|
|
beforeAll(async () => {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
Object.defineProperty(req.socket, 'remoteAddress', {
|
|
value: forcedRemoteAddress,
|
|
configurable: true,
|
|
});
|
|
next();
|
|
});
|
|
app.use('/api', apiRoutes);
|
|
|
|
await new Promise<void>((resolve, reject) => {
|
|
server = app.listen(0, '127.0.0.1');
|
|
server.once('error', reject);
|
|
server.once('listening', () => resolve());
|
|
});
|
|
|
|
const address = server.address();
|
|
if (!address || typeof address === 'string') {
|
|
throw new Error('Unable to resolve test server port');
|
|
}
|
|
baseUrl = `http://127.0.0.1:${address.port}`;
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await new Promise<void>((resolve) => server.close(() => resolve()));
|
|
});
|
|
|
|
beforeEach(() => {
|
|
originalDashboardAuthEnabled = process.env.CCS_DASHBOARD_AUTH_ENABLED;
|
|
originalCcsHome = process.env.CCS_HOME;
|
|
originalCodexHome = process.env.CODEX_HOME;
|
|
tempHome = fs.mkdtempSync(path.join(os.tmpdir(), 'ccs-api-routes-bar-guard-'));
|
|
process.env.CCS_HOME = tempHome;
|
|
process.env.CODEX_HOME = path.join(tempHome, '.codex');
|
|
process.env.CCS_DASHBOARD_AUTH_ENABLED = 'false';
|
|
forcedRemoteAddress = '192.168.2.50';
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (originalDashboardAuthEnabled !== undefined) {
|
|
process.env.CCS_DASHBOARD_AUTH_ENABLED = originalDashboardAuthEnabled;
|
|
} else {
|
|
delete process.env.CCS_DASHBOARD_AUTH_ENABLED;
|
|
}
|
|
|
|
if (originalCcsHome !== undefined) {
|
|
process.env.CCS_HOME = originalCcsHome;
|
|
} else {
|
|
delete process.env.CCS_HOME;
|
|
}
|
|
|
|
if (originalCodexHome !== undefined) {
|
|
process.env.CODEX_HOME = originalCodexHome;
|
|
} else {
|
|
delete process.env.CODEX_HOME;
|
|
}
|
|
|
|
if (tempHome && fs.existsSync(tempHome)) {
|
|
fs.rmSync(tempHome, { recursive: true, force: true });
|
|
tempHome = '';
|
|
}
|
|
});
|
|
|
|
it('rejects a non-loopback GET /api/bar/summary when dashboard auth is disabled', async () => {
|
|
const response = await fetch(`${baseUrl}/api/bar/summary`);
|
|
|
|
// 403 from the gate means the bar handler never ran (no quota/cost data
|
|
// loaded) — the body is the gate error, not a summary array.
|
|
expect(response.status).toBe(403);
|
|
expect(await response.json()).toEqual({ error: BAR_LOCAL_ACCESS_ERROR });
|
|
});
|
|
|
|
it('rejects a non-loopback GET /api/bar/analytics when dashboard auth is disabled', async () => {
|
|
const response = await fetch(`${baseUrl}/api/bar/analytics`);
|
|
|
|
expect(response.status).toBe(403);
|
|
expect(await response.json()).toEqual({ error: BAR_LOCAL_ACCESS_ERROR });
|
|
});
|
|
|
|
it('allows a loopback GET /api/bar/summary when dashboard auth is disabled', async () => {
|
|
forcedRemoteAddress = '127.0.0.1';
|
|
|
|
const response = await fetch(`${baseUrl}/api/bar/summary`, {
|
|
headers: { Host: '127.0.0.1' },
|
|
});
|
|
|
|
// Loopback passes the gate; the real handler degrades gracefully against an
|
|
// empty temp CCS_HOME and returns a 200 array.
|
|
expect(response.status).toBe(200);
|
|
expect(Array.isArray(await response.json())).toBe(true);
|
|
});
|
|
|
|
it('allows a non-loopback GET /api/bar/summary when dashboard auth is ENABLED', async () => {
|
|
// With auth enabled the helper returns true regardless of peer address, so
|
|
// an authenticated remote dashboard keeps working. We log in to get a session
|
|
// cookie, then a remote (non-loopback) GET must pass.
|
|
const password = 'testpassword123';
|
|
process.env.CCS_DASHBOARD_AUTH_ENABLED = 'true';
|
|
process.env.CCS_DASHBOARD_USERNAME = 'admin';
|
|
process.env.CCS_DASHBOARD_PASSWORD_HASH = await bcrypt.hash(password, 4);
|
|
|
|
const authApp = express();
|
|
authApp.use(express.json());
|
|
authApp.use((req, _res, next) => {
|
|
Object.defineProperty(req.socket, 'remoteAddress', {
|
|
value: '203.0.113.7',
|
|
configurable: true,
|
|
});
|
|
next();
|
|
});
|
|
authApp.use(createSessionMiddleware());
|
|
authApp.use(authMiddleware);
|
|
authApp.use('/api', apiRoutes);
|
|
|
|
const authServer = await new Promise<Server>((resolve, reject) => {
|
|
const instance = authApp.listen(0, '127.0.0.1');
|
|
instance.once('error', reject);
|
|
instance.once('listening', () => resolve(instance));
|
|
});
|
|
|
|
try {
|
|
const address = authServer.address();
|
|
if (!address || typeof address === 'string') {
|
|
throw new Error('Unable to resolve auth-enabled test server port');
|
|
}
|
|
const authBaseUrl = `http://127.0.0.1:${address.port}`;
|
|
|
|
const loginResponse = await fetch(`${authBaseUrl}/api/auth/login`, {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify({ username: 'admin', password }),
|
|
});
|
|
const cookie = loginResponse.headers.get('set-cookie');
|
|
expect(loginResponse.status).toBe(200);
|
|
expect(cookie).toBeTruthy();
|
|
|
|
const response = await fetch(`${authBaseUrl}/api/bar/summary`, {
|
|
headers: { Cookie: cookie as string },
|
|
});
|
|
|
|
// Not the gate's 403 — auth-enabled bypasses the localhost requirement.
|
|
expect(response.status).toBe(200);
|
|
expect(Array.isArray(await response.json())).toBe(true);
|
|
} finally {
|
|
await new Promise<void>((resolve) => authServer.close(() => resolve()));
|
|
delete process.env.CCS_DASHBOARD_USERNAME;
|
|
delete process.env.CCS_DASHBOARD_PASSWORD_HASH;
|
|
}
|
|
}, 15000);
|
|
});
|