Chrome DevTools for coding agents
fix: validate extension-enforced output paths (#2269)
Trung Huynh Chia9228141ae2c
diff --git a/src/McpContext.ts b/src/McpContext.tsindex 4beef629..46a59560 100644--- a/src/McpContext.ts+++ b/src/McpContext.ts@@ -54,11 +54,7 @@ import type {GeolocationOptions,ExtensionServiceWorker,} from './types.js';-import {- ensureExtension,- getTempFilePath,- resolveCanonicalPath,-} from './utils/files.js';+import {getTempFilePath, resolveCanonicalPath} from './utils/files.js';import {getNetworkMultiplierFromString} from './WaitForHelper.js';interface McpContextOptions {@@ -258,6 +254,20 @@ export class McpContext implements Context {}}+ async ensureExtension<Extension extends `.${string}`>(+ filePath: string,+ extension: Extension,+ ): Promise<`${string}${Extension}`> {+ const resolvedPath = path.resolve(filePath);+ const currentExtension = path.extname(resolvedPath);+ const outputPath: `${string}${Extension}` = `${resolvedPath.slice(+ 0,+ resolvedPath.length - currentExtension.length,+ )}${extension}`;+ await this.validatePath(outputPath);+ return outputPath;+ }+resolveCdpRequestId(page: McpPage, cdpRequestId: string): number | undefined {if (!cdpRequestId) {this.logger?.('no network request');@@ -800,12 +810,11 @@ export class McpContext implements Context {clientProvidedFilePath: string,extension: SupportedExtensions,): Promise<{filename: string}> {- await this.validatePath(clientProvidedFilePath);+ const filePath = await this.ensureExtension(+ clientProvidedFilePath,+ extension,+ );try {- const filePath = ensureExtension(- path.resolve(clientProvidedFilePath),- extension,- );await fs.mkdir(path.dirname(filePath), {recursive: true});await fs.writeFile(filePath, data);return {filename: filePath};diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.tsindex c19be154..27569c54 100644--- a/src/tools/ToolDefinition.ts+++ b/src/tools/ToolDefinition.ts@@ -187,6 +187,10 @@ export type SupportedExtensions =*/export type Context = Readonly<{validatePath(filePath?: string): Promise<void>;+ ensureExtension<Extension extends `.${string}`>(+ filePath: string,+ extension: Extension,+ ): Promise<`${string}${Extension}`>;isRunningPerformanceTrace(): boolean;setIsRunningPerformanceTrace(x: boolean): void;isCruxEnabled(): boolean;diff --git a/src/tools/memory.ts b/src/tools/memory.tsindex d8d6cf4e..219b355b 100644--- a/src/tools/memory.ts+++ b/src/tools/memory.ts@@ -5,7 +5,6 @@*/import {zod} from '../third_party/index.js';-import {ensureExtension} from '../utils/files.js';import {ToolCategory} from './categories.js';import {definePageTool, defineTool} from './ToolDefinition.js';@@ -24,16 +23,18 @@ export const takeHeapSnapshot = definePageTool({},blockedByDialog: true,verifyFilesSchema: ['filePath'],- handler: async (request, response) => {+ handler: async (request, response, context) => {const page = request.page;+ const snapshotPath = await context.ensureExtension(+ request.params.filePath,+ '.heapsnapshot',+ );await page.pptrPage.captureHeapSnapshot({- path: ensureExtension(request.params.filePath, '.heapsnapshot'),+ path: snapshotPath,});- response.appendResponseLine(- `Heap snapshot saved to ${request.params.filePath}`,- );+ response.appendResponseLine(`Heap snapshot saved to ${snapshotPath}`);},});diff --git a/src/tools/screencast.ts b/src/tools/screencast.tsindex 2e611146..7a649ab0 100644--- a/src/tools/screencast.ts+++ b/src/tools/screencast.ts@@ -10,7 +10,6 @@ import path from 'node:path';import {zod} from '../third_party/index.js';import type {ScreenRecorder, VideoFormat} from '../third_party/index.js';-import {ensureExtension} from '../utils/files.js';import {ToolCategory} from './categories.js';import {definePageTool} from './ToolDefinition.js';@@ -20,7 +19,9 @@ async function generateTempFilePath(): Promise<string> {return path.join(dir, `screencast.mp4`);}-const supportedExtensions: Array<`.${string}`> = ['.webm', '.mp4'];+type SupportedVideoExtension = '.webm' | '.mp4';++const supportedExtensions: SupportedVideoExtension[] = ['.webm', '.mp4'];export const startScreencast = definePageTool(args => ({name: 'screencast_start',@@ -68,14 +69,15 @@ export const startScreencast = definePageTool(args => ({`Supported formats: ${supportedExtensions.join(', ')} (case-insensitive).`,);}- const enforcedExtension: `.${string}` = matchedExtension ?? '.mp4';+ const enforcedExtension: SupportedVideoExtension =+ matchedExtension ?? '.mp4';const format: VideoFormat = (matchedExtension?.substring(1) ??'mp4') as VideoFormat;- const resolvedPath = ensureExtension(- path.resolve(filePath),+ const resolvedPath = await context.ensureExtension(+ filePath,enforcedExtension,- ) as `${string}.webm`;+ );const page = request.page;diff --git a/src/utils/files.ts b/src/utils/files.tsindex 66b3d5d1..74b371d2 100644--- a/src/utils/files.ts+++ b/src/utils/files.ts@@ -15,14 +15,6 @@ export async function getTempFilePath(filename: string) {return filepath;}-export function ensureExtension(- filepath: string,- extension: `.${string}`,-): string {- const ext = path.extname(filepath);- return filepath.slice(0, filepath.length - ext.length) + extension;-}-export async function resolveCanonicalPath(filePath: string): Promise<string> {const absolutePath = path.resolve(filePath);try {diff --git a/tests/roots.test.ts b/tests/roots.test.tsindex 403e3649..3321d108 100644--- a/tests/roots.test.ts+++ b/tests/roots.test.ts@@ -54,4 +54,86 @@ describe('McpContext Roots', () => {}});});++ it('should enforce extensions and validate the output path', async () => {+ await withMcpContext(async (_response, context) => {+ const workspacePath = await fs.mkdtemp(+ path.join(os.tmpdir(), 'workspace-root-'),+ );+ try {+ context.setRoots([+ {uri: pathToFileURL(workspacePath).href, name: 'workspace'},+ ]);++ const testCases: Array<{+ filePath: string;+ extension: '.json' | '.txt' | '.png' | '.zip';+ expected: string;+ }> = [+ {+ filePath: 'result',+ extension: '.json',+ expected: 'result.json',+ },+ {+ filePath: 'result.jpg',+ extension: '.txt',+ expected: 'result.txt',+ },+ {+ filePath: 'nested/result.jpg',+ extension: '.png',+ expected: 'nested/result.png',+ },+ {+ filePath: '.bashrc',+ extension: '.txt',+ expected: '.bashrc.txt',+ },+ {+ filePath: 'file.tar.gz',+ extension: '.zip',+ expected: 'file.tar.zip',+ },+ ];++ for (const testCase of testCases) {+ const resolvedPath = await context.ensureExtension(+ path.join(workspacePath, testCase.filePath),+ testCase.extension,+ );++ assert.strictEqual(+ resolvedPath,+ path.join(workspacePath, testCase.expected),+ );+ }+ } finally {+ await fs.rm(workspacePath, {recursive: true, force: true});+ }+ });+ });++ it('should deny extension-enforced paths outside roots', async () => {+ await withMcpContext(async (_response, context) => {+ const workspacePath = await fs.mkdtemp(+ path.join(os.tmpdir(), 'workspace-root-'),+ );+ try {+ context.setRoots([+ {uri: pathToFileURL(workspacePath).href, name: 'workspace'},+ ]);++ await assert.rejects(+ context.ensureExtension(+ path.join(os.homedir(), 'outside-root-result'),+ '.json',+ ),+ /Access denied/,+ );+ } finally {+ await fs.rm(workspacePath, {recursive: true, force: true});+ }+ });+ });});diff --git a/tests/utils/files.test.ts b/tests/utils/files.test.tsindex 6e2d2354..2cfc5e40 100644--- a/tests/utils/files.test.ts+++ b/tests/utils/files.test.ts@@ -10,40 +10,7 @@ import os from 'node:os';import path from 'node:path';import {describe, it} from 'node:test';-import {ensureExtension, resolveCanonicalPath} from '../../src/utils/files.js';--describe('ensureExtension', () => {- it('should add an extension to a filename without one', () => {- assert.strictEqual(ensureExtension('filename', '.txt'), 'filename.txt');- });-- it('should replace an existing extension', () => {- assert.strictEqual(ensureExtension('filename.jpg', '.txt'), 'filename.txt');- });-- it('should handle extension without a leading dot', () => {- assert.strictEqual(ensureExtension('filename', '.txt'), 'filename.txt');- });-- it('should not add a second dot if already present', () => {- assert.strictEqual(ensureExtension('filename.txt', '.txt'), 'filename.txt');- });-- it('should handle paths with directories', () => {- assert.strictEqual(- ensureExtension('/path/to/file.jpg', '.png'),- '/path/to/file.png',- );- });-- it('should handle hidden files (starting with dot)', () => {- assert.strictEqual(ensureExtension('.bashrc', '.txt'), '.bashrc.txt');- });-- it('should handle complex extensions (like .tar.gz) - path.extname only gets the last one', () => {- assert.strictEqual(ensureExtension('file.tar.gz', '.zip'), 'file.tar.zip');- });-});+import {resolveCanonicalPath} from '../../src/utils/files.js';describe('resolveCanonicalPath', () => {it('should resolve an existing standard file path', async () => {