security.test.ts 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586
  1. /**
  2. * Security Tests
  3. *
  4. * Tests for P0/P1 security fixes:
  5. * - FileLock (cross-process locking)
  6. * - Path traversal prevention
  7. * - MCP input validation
  8. * - Atomic writes
  9. */
  10. import { describe, it, expect, beforeEach, afterEach } from 'vitest';
  11. import * as fs from 'fs';
  12. import * as path from 'path';
  13. import * as os from 'os';
  14. import { FileLock } from '../src/utils';
  15. import CodeGraph from '../src/index';
  16. import { ToolHandler, tools } from '../src/mcp/tools';
  17. import { scanDirectory, isSourceFile } from '../src/extraction';
  18. import { DatabaseConnection, getDatabasePath } from '../src/db';
  19. import { QueryBuilder } from '../src/db/queries';
  20. function createTempDir(): string {
  21. return fs.mkdtempSync(path.join(os.tmpdir(), 'codegraph-security-test-'));
  22. }
  23. function cleanupTempDir(dir: string): void {
  24. if (fs.existsSync(dir)) {
  25. fs.rmSync(dir, { recursive: true, force: true });
  26. }
  27. }
  28. describe('FileLock', () => {
  29. let tempDir: string;
  30. let lockPath: string;
  31. beforeEach(() => {
  32. tempDir = createTempDir();
  33. lockPath = path.join(tempDir, 'test.lock');
  34. });
  35. afterEach(() => {
  36. cleanupTempDir(tempDir);
  37. });
  38. it('should acquire and release a lock', () => {
  39. const lock = new FileLock(lockPath);
  40. lock.acquire();
  41. expect(fs.existsSync(lockPath)).toBe(true);
  42. const content = fs.readFileSync(lockPath, 'utf-8').trim();
  43. expect(parseInt(content, 10)).toBe(process.pid);
  44. lock.release();
  45. expect(fs.existsSync(lockPath)).toBe(false);
  46. });
  47. it('should prevent double acquisition within same process', () => {
  48. const lock1 = new FileLock(lockPath);
  49. const lock2 = new FileLock(lockPath);
  50. lock1.acquire();
  51. // Second lock should fail because our PID is alive
  52. expect(() => lock2.acquire()).toThrow(/locked by another process/);
  53. lock1.release();
  54. });
  55. it('should detect and remove stale locks from dead processes', () => {
  56. // Write a lock file with a PID that doesn't exist
  57. // PID 99999999 is extremely unlikely to be a real process
  58. fs.writeFileSync(lockPath, '99999999');
  59. const lock = new FileLock(lockPath);
  60. // Should succeed because the PID is dead
  61. expect(() => lock.acquire()).not.toThrow();
  62. lock.release();
  63. });
  64. it('should execute function with withLock', () => {
  65. const lock = new FileLock(lockPath);
  66. const result = lock.withLock(() => {
  67. expect(fs.existsSync(lockPath)).toBe(true);
  68. return 42;
  69. });
  70. expect(result).toBe(42);
  71. expect(fs.existsSync(lockPath)).toBe(false);
  72. });
  73. it('should release lock even if function throws', () => {
  74. const lock = new FileLock(lockPath);
  75. expect(() => {
  76. lock.withLock(() => {
  77. throw new Error('test error');
  78. });
  79. }).toThrow('test error');
  80. expect(fs.existsSync(lockPath)).toBe(false);
  81. });
  82. it('should execute async function with withLockAsync', async () => {
  83. const lock = new FileLock(lockPath);
  84. const result = await lock.withLockAsync(async () => {
  85. expect(fs.existsSync(lockPath)).toBe(true);
  86. return 'async-result';
  87. });
  88. expect(result).toBe('async-result');
  89. expect(fs.existsSync(lockPath)).toBe(false);
  90. });
  91. it('should release lock even if async function throws', async () => {
  92. const lock = new FileLock(lockPath);
  93. await expect(
  94. lock.withLockAsync(async () => {
  95. throw new Error('async error');
  96. })
  97. ).rejects.toThrow('async error');
  98. expect(fs.existsSync(lockPath)).toBe(false);
  99. });
  100. it('release should be idempotent', () => {
  101. const lock = new FileLock(lockPath);
  102. lock.acquire();
  103. lock.release();
  104. // Second release should not throw
  105. expect(() => lock.release()).not.toThrow();
  106. });
  107. });
  108. describe('Path Traversal Prevention', () => {
  109. let testDir: string;
  110. let cg: CodeGraph;
  111. beforeEach(async () => {
  112. testDir = createTempDir();
  113. const srcDir = path.join(testDir, 'src');
  114. fs.mkdirSync(srcDir);
  115. fs.writeFileSync(
  116. path.join(srcDir, 'hello.ts'),
  117. `export function hello(): string { return "hi"; }\n`
  118. );
  119. cg = CodeGraph.initSync(testDir, {
  120. config: { include: ['**/*.ts'], exclude: [] },
  121. });
  122. await cg.indexAll();
  123. });
  124. afterEach(() => {
  125. if (cg) cg.close();
  126. cleanupTempDir(testDir);
  127. });
  128. it('should read code for valid nodes within project', async () => {
  129. const nodes = cg.getNodesByKind('function');
  130. const hello = nodes.find((n) => n.name === 'hello');
  131. expect(hello).toBeDefined();
  132. const code = await cg.getCode(hello!.id);
  133. expect(code).toContain('hello');
  134. });
  135. it('should return null for non-existent node', async () => {
  136. const code = await cg.getCode('does-not-exist');
  137. expect(code).toBeNull();
  138. });
  139. });
  140. describe('MCP Input Validation', () => {
  141. let testDir: string;
  142. let cg: CodeGraph;
  143. let handler: ToolHandler;
  144. beforeEach(async () => {
  145. testDir = createTempDir();
  146. const srcDir = path.join(testDir, 'src');
  147. fs.mkdirSync(srcDir);
  148. fs.writeFileSync(
  149. path.join(srcDir, 'example.ts'),
  150. `export function exampleFunc(): void {}\nexport class ExampleClass {}\n`
  151. );
  152. cg = CodeGraph.initSync(testDir, {
  153. config: { include: ['**/*.ts'], exclude: [] },
  154. });
  155. await cg.indexAll();
  156. handler = new ToolHandler(cg);
  157. });
  158. afterEach(() => {
  159. if (cg) cg.close();
  160. cleanupTempDir(testDir);
  161. });
  162. it('should reject non-string query in codegraph_search', async () => {
  163. const result = await handler.execute('codegraph_search', { query: null });
  164. expect(result.isError).toBe(true);
  165. expect(result.content[0].text).toContain('non-empty string');
  166. });
  167. it('should reject empty string query in codegraph_search', async () => {
  168. const result = await handler.execute('codegraph_search', { query: '' });
  169. expect(result.isError).toBe(true);
  170. expect(result.content[0].text).toContain('non-empty string');
  171. });
  172. it('should accept valid query in codegraph_search', async () => {
  173. const result = await handler.execute('codegraph_search', { query: 'example' });
  174. expect(result.isError).toBeFalsy();
  175. });
  176. it('should clamp limit to valid range in codegraph_search', async () => {
  177. // Extremely large limit should still work (clamped to 100)
  178. const result = await handler.execute('codegraph_search', { query: 'example', limit: 999999 });
  179. expect(result.isError).toBeFalsy();
  180. });
  181. it('should reject non-string symbol in codegraph_callers', async () => {
  182. const result = await handler.execute('codegraph_callers', { symbol: 123 });
  183. expect(result.isError).toBe(true);
  184. expect(result.content[0].text).toContain('non-empty string');
  185. });
  186. it('should reject non-string task in codegraph_context', async () => {
  187. const result = await handler.execute('codegraph_context', { task: undefined });
  188. expect(result.isError).toBe(true);
  189. expect(result.content[0].text).toContain('non-empty string');
  190. });
  191. it('should truncate oversized codegraph_context output', async () => {
  192. const oversizedContext = Array.from({ length: 400 }, (_, i) => `line-${i} ${'x'.repeat(80)}`).join('\n');
  193. const fakeCg = {
  194. buildContext: async () => oversizedContext,
  195. };
  196. const fakeHandler = new ToolHandler(fakeCg as unknown as CodeGraph);
  197. const result = await fakeHandler.execute('codegraph_context', { task: 'find example' });
  198. expect(result.isError).toBeFalsy();
  199. expect(result.content[0].text.length).toBeLessThan(oversizedContext.length);
  200. expect(result.content[0].text).toContain('... (output truncated)');
  201. });
  202. it('should reject non-string symbol in codegraph_impact', async () => {
  203. const result = await handler.execute('codegraph_impact', { symbol: [] });
  204. expect(result.isError).toBe(true);
  205. });
  206. it('should reject non-string symbol in codegraph_node', async () => {
  207. const result = await handler.execute('codegraph_node', { symbol: false });
  208. expect(result.isError).toBe(true);
  209. });
  210. it('should reject non-string symbol in codegraph_callees', async () => {
  211. const result = await handler.execute('codegraph_callees', { symbol: {} });
  212. expect(result.isError).toBe(true);
  213. });
  214. it('should handle NaN limit gracefully', async () => {
  215. const result = await handler.execute('codegraph_search', { query: 'example', limit: 'abc' });
  216. expect(result.isError).toBeFalsy();
  217. });
  218. it('should handle negative limit gracefully', async () => {
  219. const result = await handler.execute('codegraph_search', { query: 'example', limit: -5 });
  220. expect(result.isError).toBeFalsy();
  221. });
  222. });
  223. describe('Atomic Writes', () => {
  224. let tempDir: string;
  225. beforeEach(() => {
  226. tempDir = createTempDir();
  227. });
  228. afterEach(() => {
  229. cleanupTempDir(tempDir);
  230. });
  231. it('should not leave temp files on success', () => {
  232. // We test this indirectly through the config-writer module
  233. // by checking that no .tmp files remain after writing
  234. const configDir = path.join(tempDir, '.claude');
  235. fs.mkdirSync(configDir, { recursive: true });
  236. const testFile = path.join(configDir, 'test.json');
  237. // Simulate what atomicWriteFileSync does
  238. const tmpPath = testFile + '.tmp.' + process.pid;
  239. fs.writeFileSync(tmpPath, '{"test": true}');
  240. fs.renameSync(tmpPath, testFile);
  241. expect(fs.existsSync(testFile)).toBe(true);
  242. expect(fs.existsSync(tmpPath)).toBe(false);
  243. const content = JSON.parse(fs.readFileSync(testFile, 'utf-8'));
  244. expect(content.test).toBe(true);
  245. });
  246. });
  247. describe('Source file detection (isSourceFile)', () => {
  248. it('selects files by supported extension', () => {
  249. expect(isSourceFile('src/index.ts')).toBe(true);
  250. expect(isSourceFile('src/deep/nested/file.ts')).toBe(true);
  251. expect(isSourceFile('src/component.tsx')).toBe(true);
  252. expect(isSourceFile('lib/util.js')).toBe(true);
  253. expect(isSourceFile('src/main.py')).toBe(true);
  254. });
  255. it('rejects unsupported extensions and extensionless files', () => {
  256. expect(isSourceFile('src/component.css')).toBe(false);
  257. expect(isSourceFile('README.md')).toBe(false);
  258. expect(isSourceFile('Makefile')).toBe(false);
  259. expect(isSourceFile('.gitignore')).toBe(false);
  260. });
  261. it('matches regardless of leading dot directories', () => {
  262. expect(isSourceFile('.hidden/index.ts')).toBe(true);
  263. });
  264. });
  265. describe('JSON.parse Error Boundaries in DB', () => {
  266. let tempDir: string;
  267. beforeEach(() => {
  268. tempDir = createTempDir();
  269. });
  270. afterEach(() => {
  271. cleanupTempDir(tempDir);
  272. });
  273. it('should not crash when node has malformed JSON in decorators column', () => {
  274. const dbPath = path.join(tempDir, 'test.db');
  275. const db = DatabaseConnection.initialize(dbPath);
  276. const queries = new QueryBuilder(db.getDb());
  277. // Insert a node with malformed JSON in the decorators column
  278. db.getDb().prepare(`
  279. INSERT INTO nodes (id, kind, name, qualified_name, file_path, language, start_line, end_line, start_column, end_column, decorators, is_exported, is_async, is_static, is_abstract, updated_at)
  280. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
  281. `).run(
  282. 'test-node-1', 'function', 'myFunc', 'myFunc', 'test.ts', 'typescript',
  283. 1, 5, 0, 0,
  284. '{not valid json!!!}', // malformed decorators
  285. 0, 0, 0, 0, Date.now()
  286. );
  287. // Should not throw - should return node with undefined decorators
  288. const node = queries.getNodeById('test-node-1');
  289. expect(node).not.toBeNull();
  290. expect(node!.name).toBe('myFunc');
  291. expect(node!.decorators).toBeUndefined();
  292. db.close();
  293. });
  294. it('should not crash when edge has malformed JSON in metadata column', () => {
  295. const dbPath = path.join(tempDir, 'test.db');
  296. const db = DatabaseConnection.initialize(dbPath);
  297. const queries = new QueryBuilder(db.getDb());
  298. // Insert two nodes first
  299. const insertNode = db.getDb().prepare(`
  300. INSERT INTO nodes (id, kind, name, qualified_name, file_path, language, start_line, end_line, start_column, end_column, is_exported, is_async, is_static, is_abstract, updated_at)
  301. VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
  302. `);
  303. insertNode.run('node-a', 'function', 'funcA', 'funcA', 'a.ts', 'typescript', 1, 5, 0, 0, 0, 0, 0, 0, Date.now());
  304. insertNode.run('node-b', 'function', 'funcB', 'funcB', 'b.ts', 'typescript', 1, 5, 0, 0, 0, 0, 0, 0, Date.now());
  305. // Insert edge with malformed metadata
  306. db.getDb().prepare(`
  307. INSERT INTO edges (source, target, kind, metadata)
  308. VALUES (?, ?, ?, ?)
  309. `).run('node-a', 'node-b', 'calls', 'broken json {{{');
  310. // Should not throw - should return edge with undefined metadata
  311. const edges = queries.getOutgoingEdges('node-a');
  312. expect(edges.length).toBe(1);
  313. expect(edges[0].source).toBe('node-a');
  314. expect(edges[0].target).toBe('node-b');
  315. expect(edges[0].metadata).toBeUndefined();
  316. db.close();
  317. });
  318. it('should not crash when file record has malformed JSON in errors column', () => {
  319. const dbPath = path.join(tempDir, 'test.db');
  320. const db = DatabaseConnection.initialize(dbPath);
  321. const queries = new QueryBuilder(db.getDb());
  322. // Insert a file with malformed errors JSON
  323. db.getDb().prepare(`
  324. INSERT INTO files (path, content_hash, language, size, modified_at, indexed_at, node_count, errors)
  325. VALUES (?, ?, ?, ?, ?, ?, ?, ?)
  326. `).run('test.ts', 'abc123', 'typescript', 100, Date.now(), Date.now(), 5, 'not-an-array');
  327. // Should not throw - should return file with undefined errors
  328. const file = queries.getFileByPath('test.ts');
  329. expect(file).not.toBeNull();
  330. expect(file!.path).toBe('test.ts');
  331. expect(file!.errors).toBeUndefined();
  332. db.close();
  333. });
  334. });
  335. describe('Symlink Cycle Detection', () => {
  336. let tempDir: string;
  337. beforeEach(() => {
  338. tempDir = createTempDir();
  339. });
  340. afterEach(() => {
  341. cleanupTempDir(tempDir);
  342. });
  343. it('should handle symlink cycle without infinite loop', () => {
  344. // Create directory structure with a symlink cycle
  345. const srcDir = path.join(tempDir, 'src');
  346. fs.mkdirSync(srcDir);
  347. fs.writeFileSync(path.join(srcDir, 'index.ts'), 'export const x = 1;\n');
  348. // Create a symlink from src/loop -> tempDir (parent directory)
  349. try {
  350. fs.symlinkSync(tempDir, path.join(srcDir, 'loop'), 'dir');
  351. } catch {
  352. // Skip test if symlinks not supported (e.g., Windows without admin)
  353. return;
  354. }
  355. // This should complete without hanging
  356. const files = scanDirectory(tempDir);
  357. // Should find the real file but not loop infinitely
  358. expect(files).toContain('src/index.ts');
  359. // Should not find duplicates via the symlink path
  360. const indexFiles = files.filter(f => f.endsWith('index.ts'));
  361. expect(indexFiles.length).toBe(1);
  362. });
  363. it('should follow valid symlinks to directories', () => {
  364. // Create source directory with a file
  365. const realDir = path.join(tempDir, 'real');
  366. fs.mkdirSync(realDir);
  367. fs.writeFileSync(path.join(realDir, 'hello.ts'), 'export function hello() {}\n');
  368. // Create a symlink to realDir
  369. const srcDir = path.join(tempDir, 'src');
  370. fs.mkdirSync(srcDir);
  371. try {
  372. fs.symlinkSync(realDir, path.join(srcDir, 'linked'), 'dir');
  373. } catch {
  374. return;
  375. }
  376. const files = scanDirectory(tempDir);
  377. // Should find files from both the real dir and via the symlink
  378. // But deduplicate since they resolve to the same real path
  379. expect(files.some(f => f.includes('hello.ts'))).toBe(true);
  380. });
  381. it('should skip broken symlinks gracefully', () => {
  382. const srcDir = path.join(tempDir, 'src');
  383. fs.mkdirSync(srcDir);
  384. fs.writeFileSync(path.join(srcDir, 'valid.ts'), 'export const y = 2;\n');
  385. try {
  386. fs.symlinkSync('/nonexistent/path', path.join(srcDir, 'broken'), 'dir');
  387. } catch {
  388. return;
  389. }
  390. // Should not throw
  391. const files = scanDirectory(tempDir);
  392. expect(files).toContain('src/valid.ts');
  393. });
  394. });
  395. describe('Session marker symlink resistance', () => {
  396. // The marker write lives in src/mcp/tools.ts behind handleContext. We exercise
  397. // it end-to-end via ToolHandler.execute so the test exercises the same code
  398. // path Claude Code drives. The session id is per-test so other parallel test
  399. // runs can't collide with the marker file we plant a symlink at.
  400. const SESSION_ID = `cg-test-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2)}`;
  401. const crypto = require('crypto') as typeof import('crypto');
  402. const hash = crypto.createHash('md5').update(SESSION_ID).digest('hex').slice(0, 16);
  403. const markerPath = path.join(os.tmpdir(), `codegraph-consulted-${hash}`);
  404. let projectDir: string;
  405. let victimDir: string;
  406. let victimFile: string;
  407. beforeEach(async () => {
  408. projectDir = createTempDir();
  409. victimDir = createTempDir();
  410. victimFile = path.join(victimDir, 'private.txt');
  411. fs.writeFileSync(victimFile, 'SECRET-DO-NOT-OVERWRITE\n');
  412. if (fs.existsSync(markerPath)) fs.unlinkSync(markerPath);
  413. // A real .codegraph/ has to exist for handleContext to get past the
  414. // "not initialized" guard — index a tiny fixture so the call reaches the
  415. // marker write step rather than short-circuiting on missing project state.
  416. fs.writeFileSync(path.join(projectDir, 'a.ts'), 'export const x = 1;\n');
  417. const cg = await CodeGraph.init(projectDir);
  418. await cg.indexAll();
  419. cg.close();
  420. });
  421. afterEach(() => {
  422. if (fs.existsSync(markerPath)) fs.unlinkSync(markerPath);
  423. cleanupTempDir(projectDir);
  424. cleanupTempDir(victimDir);
  425. });
  426. it('does not follow a pre-planted symlink at the marker path', async () => {
  427. // Skip on platforms where the user can't create symlinks (Windows without
  428. // dev mode + admin). The CWE-59 risk we're guarding against doesn't apply
  429. // when symlinks aren't creatable, so the skip is correct, not a gap.
  430. try {
  431. fs.symlinkSync(victimFile, markerPath);
  432. } catch {
  433. return;
  434. }
  435. const cg = await CodeGraph.open(projectDir);
  436. const handler = new ToolHandler(cg);
  437. process.env.CLAUDE_SESSION_ID = SESSION_ID;
  438. try {
  439. await handler.execute('codegraph_context', { task: 'find x' });
  440. } finally {
  441. delete process.env.CLAUDE_SESSION_ID;
  442. cg.close();
  443. }
  444. // The victim file's contents must be untouched — the old writeFileSync
  445. // path would have followed the symlink and written an ISO timestamp here.
  446. expect(fs.readFileSync(victimFile, 'utf8')).toBe('SECRET-DO-NOT-OVERWRITE\n');
  447. // And the marker path itself must still be the symlink we planted —
  448. // no fallback path that quietly unlinked + recreated it (which would
  449. // also work, but is a behavior we don't want to silently rely on).
  450. expect(fs.lstatSync(markerPath).isSymbolicLink()).toBe(true);
  451. });
  452. it('writes the marker file with 0o600 perms on a clean path', async () => {
  453. // No symlink planted — happy path. Verifies the new openSync(mode: 0o600)
  454. // call is what actually lands on disk (regression guard for the perm
  455. // tightening that came with the O_NOFOLLOW fix).
  456. const cg = await CodeGraph.open(projectDir);
  457. const handler = new ToolHandler(cg);
  458. process.env.CLAUDE_SESSION_ID = SESSION_ID;
  459. try {
  460. await handler.execute('codegraph_context', { task: 'find x' });
  461. } finally {
  462. delete process.env.CLAUDE_SESSION_ID;
  463. cg.close();
  464. }
  465. expect(fs.existsSync(markerPath)).toBe(true);
  466. // chmod's low 9 bits — strip the file-type bits for a clean compare.
  467. // Windows can't enforce 0o600 in the POSIX sense; skip the assertion
  468. // there since the underlying OS will normalize the mode anyway.
  469. if (process.platform !== 'win32') {
  470. const mode = fs.statSync(markerPath).mode & 0o777;
  471. expect(mode).toBe(0o600);
  472. }
  473. });
  474. });