From 33f96a145ef09ca6a43b4e555eb273e64a87be23 Mon Sep 17 00:00:00 2001 From: Hiroshi Ogawa Date: Wed, 1 Jul 2026 15:08:48 +0900 Subject: [PATCH] fix(browser): check fs access in builtin commands (#10674) Co-authored-by: Hiroshi Ogawa <4232207+hi-ogawa@users.noreply.github.com> Co-authored-by: OpenCode (claude-opus-4-8) --- .../src/commands/screenshot.ts | 5 +- .../browser-playwright/src/commands/trace.ts | 9 ++++ .../browser-playwright/src/commands/upload.ts | 5 +- packages/browser/src/node/commands/fs.ts | 34 ++++--------- .../node/commands/screenshotMatcher/index.ts | 13 +++-- packages/browser/src/node/index.ts | 2 +- packages/browser/src/node/rpc.ts | 15 +++++- packages/browser/src/node/utils.ts | 21 ++++++++ .../screenshot-denied.test.ts | 7 +++ .../vitest.config.ts | 21 ++++++++ .../screenshot-write.test.ts | 6 +++ .../vitest.config.ts | 24 ++++++++++ .../my-secret.txt | 1 + .../upload-denied.test.ts | 10 ++++ .../vitest.config.ts | 21 ++++++++ test/browser/specs/errors.test.ts | 48 +++++++++++++++++++ test/test-utils/index.ts | 3 ++ 17 files changed, 212 insertions(+), 33 deletions(-) create mode 100644 test/browser/fixtures/command-permissions-screenshot-denied/screenshot-denied.test.ts create mode 100644 test/browser/fixtures/command-permissions-screenshot-denied/vitest.config.ts create mode 100644 test/browser/fixtures/command-permissions-screenshot-no-write/screenshot-write.test.ts create mode 100644 test/browser/fixtures/command-permissions-screenshot-no-write/vitest.config.ts create mode 100644 test/browser/fixtures/command-permissions-upload-denied/my-secret.txt create mode 100644 test/browser/fixtures/command-permissions-upload-denied/upload-denied.test.ts create mode 100644 test/browser/fixtures/command-permissions-upload-denied/vitest.config.ts diff --git a/packages/browser-playwright/src/commands/screenshot.ts b/packages/browser-playwright/src/commands/screenshot.ts index f852632ec..457fa43cf 100644 --- a/packages/browser-playwright/src/commands/screenshot.ts +++ b/packages/browser-playwright/src/commands/screenshot.ts @@ -2,7 +2,7 @@ import type { SerializedLocator } from '@vitest/browser' import type { ScreenshotOptions } from 'vitest/browser' import type { BrowserCommandContext } from 'vitest/node' import { mkdir } from 'node:fs/promises' -import { resolveScreenshotPath } from '@vitest/browser' +import { assertBrowserApiWrite, assertBrowserFileAccess, resolveScreenshotPath } from '@vitest/browser' import { dirname, normalize } from 'pathe' import { getDescribedLocator } from './utils' @@ -51,6 +51,9 @@ export async function takeScreenshot( if (options.save) { savePath = normalize(path) + assertBrowserApiWrite(context.project, savePath) + assertBrowserFileAccess(context.project, savePath) + await mkdir(dirname(savePath), { recursive: true }) } diff --git a/packages/browser-playwright/src/commands/trace.ts b/packages/browser-playwright/src/commands/trace.ts index f92563a36..2feafd31c 100644 --- a/packages/browser-playwright/src/commands/trace.ts +++ b/packages/browser-playwright/src/commands/trace.ts @@ -3,6 +3,7 @@ import type { ParsedStack } from 'vitest' import type { BrowserCommand, BrowserCommandContext, BrowserProvider } from 'vitest/node' import type { PlaywrightBrowserProvider } from '../playwright' import { unlink } from 'node:fs/promises' +import { assertBrowserApiWrite, assertBrowserFileAccess } from '@vitest/browser' import { basename, dirname, relative, resolve } from 'pathe' import { getDescribedLocator } from './utils' @@ -52,6 +53,8 @@ export const stopChunkTrace: BrowserCommand<[{ name: string }]> = async ( ) => { if (isPlaywrightProvider(context.provider)) { const path = resolveTracesPath(context, name) + assertBrowserApiWrite(context.project, path) + assertBrowserFileAccess(context.project, path) context.provider.pendingTraces.delete(path) await context.context.tracing.stopChunk({ path }) return { tracePath: path } @@ -163,6 +166,10 @@ export const deleteTracing: BrowserCommand<[{ traces: string[] }]> = async ( throw new Error(`stopChunkTrace cannot be called outside of the test file.`) } if (isPlaywrightProvider(context.provider)) { + for (const trace of traces) { + assertBrowserApiWrite(context.project, trace) + assertBrowserFileAccess(context.project, trace) + } return Promise.all( traces.map(trace => unlink(trace).catch((err) => { if (err.code === 'ENOENT') { @@ -184,6 +191,8 @@ export const annotateTraces: BrowserCommand<[{ traces: string[]; testId: string ) => { const vitest = project.vitest await Promise.all(traces.map((trace) => { + assertBrowserApiWrite(project, trace) + assertBrowserFileAccess(project, trace) const entity = vitest.state.getReportedEntityById(testId) const location = entity?.location ? { diff --git a/packages/browser-playwright/src/commands/upload.ts b/packages/browser-playwright/src/commands/upload.ts index 26760ffdc..6b8e265de 100644 --- a/packages/browser-playwright/src/commands/upload.ts +++ b/packages/browser-playwright/src/commands/upload.ts @@ -1,6 +1,7 @@ import type { SerializedLocator } from '@vitest/browser' import type { UserEventUploadOptions } from 'vitest/browser' import type { UserEventCommand } from './utils' +import { assertBrowserFileAccess } from '@vitest/browser' import { resolve } from 'pathe' import { getDescribedLocator } from './utils' @@ -22,7 +23,9 @@ export const upload: UserEventCommand<(element: SerializedLocator, files: Array< const playwrightFiles = files.map((file) => { if (typeof file === 'string') { - return resolve(root, file) + const filepath = resolve(root, file) + assertBrowserFileAccess(context.project, filepath) + return filepath } return { name: file.name, diff --git a/packages/browser/src/node/commands/fs.ts b/packages/browser/src/node/commands/fs.ts index d921f3b11..4707d22cf 100644 --- a/packages/browser/src/node/commands/fs.ts +++ b/packages/browser/src/node/commands/fs.ts @@ -1,33 +1,15 @@ import type { BrowserCommands } from 'vitest/browser' -import type { BrowserCommand, TestProject } from 'vitest/node' +import type { BrowserCommand } from 'vitest/node' import fs, { promises as fsp } from 'node:fs' import { basename, dirname, resolve } from 'node:path' import mime from 'mime/lite' -import { isFileLoadingAllowed } from 'vitest/node' -import { slash } from '../utils' - -function assertFileAccess(path: string, project: TestProject) { - if ( - !isFileLoadingAllowed(project.vite.config, path) - && !isFileLoadingAllowed(project.vitest.vite.config, path) - ) { - throw new Error( - `Access denied to "${path}". See Vite config documentation for "server.fs": https://vitejs.dev/config/server-options.html#server-fs-strict.`, - ) - } -} - -function assertWrite(path: string, project: TestProject) { - if (!project.config.browser.api.allowWrite || !project.vitest.config.api.allowWrite) { - throw new Error(`Cannot modify file "${path}". File writing is disabled because server is exposed to the internet, see https://vitest.dev/config/browser/api.`) - } -} +import { assertBrowserApiWrite, assertBrowserFileAccess } from '../utils' export const readFile: BrowserCommand< Parameters > = async ({ project }, path, options = {}) => { const filepath = resolve(project.config.root, path) - assertFileAccess(slash(filepath), project) + assertBrowserFileAccess(project, filepath) // never return a Buffer if (typeof options === 'object' && !options.encoding) { options.encoding = 'utf-8' @@ -38,9 +20,9 @@ export const readFile: BrowserCommand< export const writeFile: BrowserCommand< Parameters > = async ({ project }, path, data, options) => { - assertWrite(path, project) + assertBrowserApiWrite(project, path) const filepath = resolve(project.config.root, path) - assertFileAccess(slash(filepath), project) + assertBrowserFileAccess(project, filepath) const dir = dirname(filepath) if (!fs.existsSync(dir)) { await fsp.mkdir(dir, { recursive: true }) @@ -51,15 +33,15 @@ export const writeFile: BrowserCommand< export const removeFile: BrowserCommand< Parameters > = async ({ project }, path) => { - assertWrite(path, project) + assertBrowserApiWrite(project, path) const filepath = resolve(project.config.root, path) - assertFileAccess(slash(filepath), project) + assertBrowserFileAccess(project, filepath) await fsp.rm(filepath) } export const _fileInfo: BrowserCommand<[path: string, encoding: BufferEncoding]> = async ({ project }, path, encoding) => { const filepath = resolve(project.config.root, path) - assertFileAccess(slash(filepath), project) + assertBrowserFileAccess(project, filepath) const content = await fsp.readFile(filepath, encoding || 'base64') return { content, diff --git a/packages/browser/src/node/commands/screenshotMatcher/index.ts b/packages/browser/src/node/commands/screenshotMatcher/index.ts index e94a688bc..d83c8ed7f 100644 --- a/packages/browser/src/node/commands/screenshotMatcher/index.ts +++ b/packages/browser/src/node/commands/screenshotMatcher/index.ts @@ -1,7 +1,7 @@ import type { SerializedLocator } from '@vitest/browser' import type { SnapshotUpdateState } from 'vitest' import type { ScreenshotMatcherOptions } from 'vitest/browser' -import type { BrowserCommand, BrowserCommandContext } from 'vitest/node' +import type { BrowserCommand, BrowserCommandContext, TestProject } from 'vitest/node' import type { ScreenshotMatcherArguments, ScreenshotMatcherOutput } from '../../../shared/screenshotMatcher/types' import type { AnyCodec } from './codecs' import type { AnyComparator } from './comparators' @@ -9,6 +9,7 @@ import type { TypedArray } from './types' import type { ResolvedOptions } from './utils' import { mkdir, readFile, writeFile } from 'node:fs/promises' import { basename, dirname } from 'pathe' +import { assertBrowserApiWrite, assertBrowserFileAccess } from '../../utils' import { asyncTimeout, resolveOptions, takeDecodedScreenshot, takeScreenshotBuffer } from './utils' /** Decoded image data with dimensions metadata. */ @@ -148,7 +149,7 @@ export const screenshotMatcher: BrowserCommand = asy comparatorOptions, }) - await performSideEffects(outcome, codec) + await performSideEffects(outcome, codec, context.project) return buildOutput(outcome, timeout) } @@ -276,6 +277,7 @@ async function determineOutcome( async function performSideEffects( outcome: MatchOutcome, codec: AnyCodec, + project: TestProject, ): Promise { switch (outcome.type) { case 'missing-reference': @@ -283,6 +285,7 @@ async function performSideEffects( await writeScreenshot( outcome.reference.path, await encodeScreenshot(outcome.reference, codec), + project, ) break @@ -292,12 +295,14 @@ async function performSideEffects( await writeScreenshot( outcome.actual.path, await encodeScreenshot(outcome.actual, codec), + project, ) if (outcome.diff) { await writeScreenshot( outcome.diff.path, await codec.encode(outcome.diff.image, {}), + project, ) } @@ -555,8 +560,10 @@ async function takeScreenshotData({ } /** Writes encoded images to disk, creating parent directories as needed. */ -async function writeScreenshot(path: string, image: TypedArray) { +async function writeScreenshot(path: string, image: TypedArray, project: TestProject) { try { + assertBrowserApiWrite(project, path) + assertBrowserFileAccess(project, path) await mkdir(dirname(path), { recursive: true }) await writeFile(path, image) } diff --git a/packages/browser/src/node/index.ts b/packages/browser/src/node/index.ts index 68eaf1eaa..c704a5490 100644 --- a/packages/browser/src/node/index.ts +++ b/packages/browser/src/node/index.ts @@ -23,7 +23,7 @@ export function defineBrowserCommand( } // export type { ProjectBrowser } from './project' -export { parseKeyDef, resolveScreenshotPath } from './utils' +export { assertBrowserApiWrite, assertBrowserFileAccess, parseKeyDef, resolveScreenshotPath } from './utils' export const createBrowserServer: BrowserServerFactory = async (options) => { const project = options.project diff --git a/packages/browser/src/node/rpc.ts b/packages/browser/src/node/rpc.ts index 02c3c064b..c86fbea77 100644 --- a/packages/browser/src/node/rpc.ts +++ b/packages/browser/src/node/rpc.ts @@ -12,7 +12,7 @@ import { ServerMockResolver } from '@vitest/mocker/node' import { extractSourcemapFromFile } from '@vitest/utils/source-map/node' import { createBirpc } from 'birpc' import { parse, stringify } from 'flatted' -import { dirname, join } from 'pathe' +import { dirname, join, resolve } from 'pathe' import { createDebugger, isFileLoadingAllowed, isValidApiRequest } from 'vitest/node' import { WebSocketServer } from 'ws' @@ -211,6 +211,19 @@ export function setupBrowserRpc(globalServer: ParentBrowserProject, defaultMocke ) } } + else { + // attachment files are copied into `attachmentsDir`, so confine + // client-supplied paths to Vite's `server.fs` boundary + const attachments = artifact.type === 'internal:annotation' + ? (artifact.annotation.attachment ? [artifact.annotation.attachment] : []) + : (artifact.attachments ?? []) + for (const attachment of attachments) { + const path = attachment.path + if (path && !path.startsWith('http://') && !path.startsWith('https://')) { + checkFileAccess(resolve(project.config.root, path)) + } + } + } return vitest._testRun.recordArtifact(id, artifact) }, diff --git a/packages/browser/src/node/utils.ts b/packages/browser/src/node/utils.ts index 131c640f1..a5d400fe6 100644 --- a/packages/browser/src/node/utils.ts +++ b/packages/browser/src/node/utils.ts @@ -8,6 +8,7 @@ import type { import { defaultKeyMap } from '@testing-library/user-event/dist/esm/keyboard/keyMap.js' import { parseKeyDef as tlParse } from '@testing-library/user-event/dist/esm/keyboard/parseKeyDef.js' import { basename, dirname, relative, resolve } from 'pathe' +import { isFileLoadingAllowed } from 'vitest/node' declare enum DOM_KEY_LOCATION { STANDARD = 0, @@ -95,3 +96,23 @@ export async function getBrowserProvider( export function slash(path: string): string { return path.replace(/\\/g, '/').replace(/\/+/g, '/') } + +export function assertBrowserFileAccess(project: TestProject, path: string): void { + const normalized = slash(path) + if ( + !isFileLoadingAllowed(project.vite.config, normalized) + && !isFileLoadingAllowed(project.vitest.vite.config, normalized) + ) { + throw new Error( + `Access denied to "${path}". See Vite config documentation for "server.fs": https://vitejs.dev/config/server-options.html#server-fs-strict.`, + ) + } +} + +export function assertBrowserApiWrite(project: TestProject, path: string): void { + if (!project.config.browser.api.allowWrite || !project.vitest.config.api.allowWrite) { + throw new Error( + `Cannot modify file "${path}". File writing is disabled because the server is exposed to the internet, see https://vitest.dev/config/browser/api.`, + ) + } +} diff --git a/test/browser/fixtures/command-permissions-screenshot-denied/screenshot-denied.test.ts b/test/browser/fixtures/command-permissions-screenshot-denied/screenshot-denied.test.ts new file mode 100644 index 000000000..3a54e514e --- /dev/null +++ b/test/browser/fixtures/command-permissions-screenshot-denied/screenshot-denied.test.ts @@ -0,0 +1,7 @@ +import { test } from 'vitest' +import { page } from 'vitest/browser' + +test('screenshot denied path', async () => { + // write is allowed, but the target is denied via `server.fs.deny` + await page.screenshot({ path: 'my-secret.png' }) +}) diff --git a/test/browser/fixtures/command-permissions-screenshot-denied/vitest.config.ts b/test/browser/fixtures/command-permissions-screenshot-denied/vitest.config.ts new file mode 100644 index 000000000..8438afcbe --- /dev/null +++ b/test/browser/fixtures/command-permissions-screenshot-denied/vitest.config.ts @@ -0,0 +1,21 @@ +import { fileURLToPath } from 'node:url' +import { defineConfig } from 'vitest/config' +import { instances, provider } from '../../settings' + +export default defineConfig({ + cacheDir: fileURLToPath(new URL('./node_modules/.vite', import.meta.url)), + server: { + fs: { + deny: ['my-secret.png'], + }, + }, + test: { + browser: { + enabled: true, + provider, + instances, + headless: true, + screenshotFailures: false, + }, + }, +}) diff --git a/test/browser/fixtures/command-permissions-screenshot-no-write/screenshot-write.test.ts b/test/browser/fixtures/command-permissions-screenshot-no-write/screenshot-write.test.ts new file mode 100644 index 000000000..07a59cebe --- /dev/null +++ b/test/browser/fixtures/command-permissions-screenshot-no-write/screenshot-write.test.ts @@ -0,0 +1,6 @@ +import { test } from 'vitest' +import { page } from 'vitest/browser' + +test('screenshot blocked', async () => { + await page.screenshot({ path: 'out.png' }) +}) diff --git a/test/browser/fixtures/command-permissions-screenshot-no-write/vitest.config.ts b/test/browser/fixtures/command-permissions-screenshot-no-write/vitest.config.ts new file mode 100644 index 000000000..c46f40c52 --- /dev/null +++ b/test/browser/fixtures/command-permissions-screenshot-no-write/vitest.config.ts @@ -0,0 +1,24 @@ +import { fileURLToPath } from 'node:url' +import { defineConfig } from 'vitest/config' +import { instances, provider } from '../../settings' + +export default defineConfig({ + cacheDir: fileURLToPath(new URL('./node_modules/.vite', import.meta.url)), + test: { + api: { + allowExec: false, + allowWrite: false, + }, + browser: { + enabled: true, + provider, + instances, + headless: true, + screenshotFailures: false, + api: { + allowExec: false, + allowWrite: false, + }, + }, + }, +}) diff --git a/test/browser/fixtures/command-permissions-upload-denied/my-secret.txt b/test/browser/fixtures/command-permissions-upload-denied/my-secret.txt new file mode 100644 index 000000000..4e7e76d9f --- /dev/null +++ b/test/browser/fixtures/command-permissions-upload-denied/my-secret.txt @@ -0,0 +1 @@ +secret content diff --git a/test/browser/fixtures/command-permissions-upload-denied/upload-denied.test.ts b/test/browser/fixtures/command-permissions-upload-denied/upload-denied.test.ts new file mode 100644 index 000000000..9f3f2492b --- /dev/null +++ b/test/browser/fixtures/command-permissions-upload-denied/upload-denied.test.ts @@ -0,0 +1,10 @@ +import { test } from 'vitest' +import { userEvent } from 'vitest/browser' + +test('upload denied path', async () => { + const input = document.createElement('input') + input.type = 'file' + document.body.append(input) + // the file exists in the project, but is denied via `server.fs.deny` + await userEvent.upload(input, 'my-secret.txt') +}) diff --git a/test/browser/fixtures/command-permissions-upload-denied/vitest.config.ts b/test/browser/fixtures/command-permissions-upload-denied/vitest.config.ts new file mode 100644 index 000000000..1f2cc49b4 --- /dev/null +++ b/test/browser/fixtures/command-permissions-upload-denied/vitest.config.ts @@ -0,0 +1,21 @@ +import { fileURLToPath } from 'node:url' +import { defineConfig } from 'vitest/config' +import { instances, provider } from '../../settings' + +export default defineConfig({ + cacheDir: fileURLToPath(new URL('./node_modules/.vite', import.meta.url)), + server: { + fs: { + deny: ['my-secret.txt'], + }, + }, + test: { + browser: { + enabled: true, + provider, + instances, + headless: true, + screenshotFailures: false, + }, + }, +}) diff --git a/test/browser/specs/errors.test.ts b/test/browser/specs/errors.test.ts index 379edcaae..9fb777389 100644 --- a/test/browser/specs/errors.test.ts +++ b/test/browser/specs/errors.test.ts @@ -251,3 +251,51 @@ test.runIf(provider.name === 'playwright')('cannot use cdp if write or exec is d } `) }) + +test('upload is blocked for files denied by server.fs.deny', async () => { + const result = await runBrowserTests({ + root: './fixtures/command-permissions-upload-denied', + project: [instances[0].browser], + }) + expect(result.errorTree()).toMatchInlineSnapshot(` + { + "upload-denied.test.ts": { + "upload denied path": [ + "Access denied to "/my-secret.txt". See Vite config documentation for "server.fs": https://vitejs.dev/config/server-options.html#server-fs-strict.", + ], + }, + } + `) +}) + +test('takeScreenshot is blocked for files denied by server.fs.deny', async () => { + const result = await runBrowserTests({ + root: './fixtures/command-permissions-screenshot-denied', + project: [instances[0].browser], + }) + expect(result.errorTree()).toMatchInlineSnapshot(` + { + "screenshot-denied.test.ts": { + "screenshot denied path": [ + "Access denied to "/my-secret.png". See Vite config documentation for "server.fs": https://vitejs.dev/config/server-options.html#server-fs-strict.", + ], + }, + } + `) +}) + +test('takeScreenshot is blocked when write is disabled', async () => { + const result = await runBrowserTests({ + root: './fixtures/command-permissions-screenshot-no-write', + project: [instances[0].browser], + }) + expect(result.errorTree()).toMatchInlineSnapshot(` + { + "screenshot-write.test.ts": { + "screenshot blocked": [ + "Cannot modify file "/out.png". File writing is disabled because the server is exposed to the internet, see https://vitest.dev/config/browser/api.", + ], + }, + } + `) +}) diff --git a/test/test-utils/index.ts b/test/test-utils/index.ts index fbb2927e8..6d920eeea 100644 --- a/test/test-utils/index.ts +++ b/test/test-utils/index.ts @@ -577,6 +577,9 @@ export function buildErrorTree(testModules: TestModule[], options?: BuildErrorTr function mapError(e: { message: string; diff?: string; stacks?: ParsedStack[] }) { let message = stripVTControlCharacters(e.message) + if (root) { + message = replaceRoot(message, root) + } if (options?.diff && e.diff) { message = [message, stripVTControlCharacters(e.diff)].join('\n') } -- knotmirror 0.0.1