Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
fix(server): add path traversal checks to static file serving routes (#40715)
Sebastien Tardif7d3bea08a439
diff --git a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts b/packages/playwright-core/src/server/trace/viewer/traceViewer.tsindex cd27f9b4cc..d8060209f9 100644--- a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts+++ b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts@@ -89,7 +89,7 @@ function validateTraceUrlOrPath(traceFileOrUrl: string | undefined): string | un}export async function startTraceViewerServer(options?: TraceViewerServerOptions): Promise<HttpServer> {- const server = new HttpServer();+ const server = new HttpServer(libPath('vite', 'traceViewer'));const allowedRoots = (options?.allowedFileRoots ?? [process.cwd()]).map(r => path.resolve(r));const isAllowed = (filePath: string) => allowedRoots.some(root => isPathInside(root, filePath));@@ -105,7 +105,7 @@ export async function startTraceViewerServer(options?: TraceViewerServerOptions)return true;}if (fs.existsSync(filePath))- return server.serveFile(request, response, filePath);+ return server.serveFile(request, response, filePath, undefined, { skipRootCheck: true });// If .json is requested, we'll synthesize it for zip-less operation.if (filePath.endsWith('.json')) {diff --git a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts b/packages/playwright-core/src/tools/dashboard/dashboardApp.tsindex b0fd0143ff..b0cec86fee 100644--- a/packages/playwright-core/src/tools/dashboard/dashboardApp.ts+++ b/packages/playwright-core/src/tools/dashboard/dashboardApp.ts@@ -48,8 +48,8 @@ type DashboardServer = {};async function startDashboardServer(provider: SessionProvider, options: DashboardOptions): Promise<DashboardServer> {- const httpServer = new HttpServer();const dashboardDir = libPath('vite', 'dashboard');+ const httpServer = new HttpServer(dashboardDir);const connections = new Set<DashboardConnection>();let currentReveal: DashboardOptions = options;@@ -151,8 +151,6 @@ function attachDashboardStaticServer(httpServer: HttpServer, dashboardDir: strinconst pathname = new URL(request.url!, `http://${request.headers.host}`).pathname;const filePath = pathname === '/' ? 'index.html' : pathname.substring(1);const resolved = path.join(dashboardDir, filePath);- if (!resolved.startsWith(dashboardDir))- return false;return httpServer.serveFile(request, response, resolved);});}diff --git a/packages/playwright/src/reporters/html.ts b/packages/playwright/src/reporters/html.tsindex 654bf23522..6f9e05d844 100644--- a/packages/playwright/src/reporters/html.ts+++ b/packages/playwright/src/reporters/html.ts@@ -289,7 +289,7 @@ export async function showHTMLReport(reportFolder: string | undefined, host: str// the generated index.html; we extract it and splice it into Vite's// transformed HTML so the client still finds it at runtime.async function serveHtmlReportWithHMR(folder: string): Promise<HttpServer> {- const server = new HttpServer();+ const server = new HttpServer(folder);const reporterRoot = path.resolve(__dirname, '..', '..', '..', 'html-reporter');const devServer = await server.createViteDevServer({ root: reporterRoot });const generatedIndex = await fs.promises.readFile(path.join(folder, 'index.html'), 'utf-8');@@ -314,7 +314,7 @@ async function serveHtmlReportWithHMR(folder: string): Promise<HttpServer> {// Serve attachments and the bundled trace-viewer copy from the generated// output folder first, falling through to Vite for source modules.const absolutePath = path.join(folder, ...url.pathname.split('/'));- if (absolutePath.startsWith(folder) && server.serveFile(request, response, absolutePath))+ if (server.serveFile(request, response, absolutePath))return true;devServer.middlewares(request, response, HttpServer.notFoundFallback(response));return true;diff --git a/packages/utils/httpServer.ts b/packages/utils/httpServer.tsindex 020dcfc597..4e36467248 100644--- a/packages/utils/httpServer.ts+++ b/packages/utils/httpServer.ts@@ -54,9 +54,11 @@ export class HttpServer {private _wsGuid: string | undefined;// Allowed Host headers; null disables the check (host bound to a public address).private _allowedHosts: Set<string> | null = null;+ private _staticRoot: string | undefined;- constructor() {+ constructor(staticRoot?: string) {this._server = createHttpServer(this._onRequest.bind(this));+ this._staticRoot = staticRoot ? path.resolve(staticRoot) : undefined;}server() {@@ -183,7 +185,12 @@ export class HttpServer {return purpose === 'human-readable' ? this._urlPrefixHumanReadable : this._urlPrefixPrecise;}- serveFile(request: http.IncomingMessage, response: http.ServerResponse, absoluteFilePath: string, headers?: { [name: string]: string }): boolean {+ serveFile(request: http.IncomingMessage, response: http.ServerResponse, absoluteFilePath: string, headers?: { [name: string]: string }, options?: { skipRootCheck?: boolean }): boolean {+ if (this._staticRoot && !options?.skipRootCheck && !isPathInside(this._staticRoot, absoluteFilePath)) {+ response.statusCode = 403;+ response.end();+ return true;+ }try {for (const [name, value] of Object.entries(headers || {}))response.setHeader(name, value);@@ -317,8 +324,7 @@ export function hostnameFromHostHeader(host: string): string {}export function serveFolder(folder: string): HttpServer {- const server = new HttpServer();- const folderRoot = path.resolve(folder);+ const server = new HttpServer(folder);server.routePrefix('/', (request, response) => {let relativePath = new URL('http://localhost' + request.url).pathname;if (relativePath.startsWith('/trace/file')) {@@ -327,11 +333,6 @@ export function serveFolder(folder: string): HttpServer {if (!requested)return false;const resolved = path.resolve(requested);- if (!isPathInside(folderRoot, resolved)) {- response.statusCode = 403;- response.end();- return true;- }try {return server.serveFile(request, response, resolved);} catch (e) {