Merge pull request #296 from ruturaj-browserstack/PMAA-107-upload-path-traversal-fix

fix(security): validate upload paths to prevent file exfiltration (PM…

Author: gaurav-singh-9227

src/config.ts

@@ -40,6 +40,7 @@ export class Config {
     public readonly browserstackLocalOptions: Record<string, any>,
     public readonly USE_OWN_LOCAL_BINARY_PROCESS: boolean,
     public readonly REMOTE_MCP: boolean,
+    public readonly UPLOAD_BASE_DIR: string | undefined,
   ) {}
 }
 
@@ -48,6 +49,9 @@ const config = new Config(
   browserstackLocalOptions,
   process.env.USE_OWN_LOCAL_BINARY_PROCESS === "true",
   process.env.REMOTE_MCP === "true",
+  process.env.MCP_UPLOAD_BASE_DIR && process.env.MCP_UPLOAD_BASE_DIR.length > 0
+    ? process.env.MCP_UPLOAD_BASE_DIR
+    : undefined,
 );
 
 export default config;

src/lib/upload-validator.ts

@@ -0,0 +1,124 @@
+import fs from "fs";
+import path from "path";
+
+export interface UploadValidationOptions {
+  allowedExtensions: readonly string[];
+  maxSizeBytes: number;
+  allowedBaseDir?: string;
+}
+
+/**
+ * Canonicalizes and validates a user-supplied upload path. Returns the resolved
+ * absolute path that callers should stream from. Throws on any rule violation.
+ *
+ * Rules enforced:
+ *  - Path resolves (via realpath) to an existing regular file
+ *  - File size is within `maxSizeBytes`
+ *  - File extension is in `allowedExtensions` (case-insensitive)
+ *  - No path segment is a hidden dir/file (starts with `.`); blocks ~/.ssh,
+ *    ~/.aws, .env, etc. even after symlink resolution
+ *  - If `allowedBaseDir` is set, the canonical path must live inside it
+ */
+export function validateUploadPath(
+  filePath: string,
+  options: UploadValidationOptions,
+): string {
+  if (typeof filePath !== "string" || filePath.trim().length === 0) {
+    throw new Error("Upload rejected: file path is empty.");
+  }
+
+  let canonical: string;
+  try {
+    canonical = fs.realpathSync(path.resolve(filePath));
+  } catch {
+    throw new Error(`File not found at path: ${filePath}`);
+  }
+
+  let stats: fs.Stats;
+  try {
+    stats = fs.statSync(canonical);
+  } catch {
+    throw new Error(`File not found at path: ${filePath}`);
+  }
+
+  if (!stats.isFile()) {
+    throw new Error(
+      `Upload rejected: path does not point to a regular file: ${filePath}`,
+    );
+  }
+
+  if (stats.size > options.maxSizeBytes) {
+    const maxMb = Math.round(options.maxSizeBytes / (1024 * 1024));
+    throw new Error(
+      `Upload rejected: file exceeds maximum allowed size of ${maxMb} MB.`,
+    );
+  }
+
+  const segments = canonical.split(path.sep).filter((s) => s.length > 0);
+  for (const seg of segments) {
+    if (seg.startsWith(".") && seg !== "." && seg !== "..") {
+      throw new Error(
+        `Upload rejected: path traverses a hidden directory or file ("${seg}"). Move the file to a non-hidden location or set MCP_UPLOAD_BASE_DIR.`,
+      );
+    }
+  }
+
+  const ext = path.extname(canonical).toLowerCase();
+  const allowed = options.allowedExtensions.map((e) => e.toLowerCase());
+  if (!allowed.includes(ext)) {
+    throw new Error(
+      `Upload rejected: file extension "${ext || "(none)"}" is not in the allowed list (${allowed.join(", ")}).`,
+    );
+  }
+
+  if (options.allowedBaseDir) {
+    let baseCanonical: string;
+    try {
+      baseCanonical = fs.realpathSync(path.resolve(options.allowedBaseDir));
+    } catch {
+      throw new Error(
+        `Upload rejected: configured MCP_UPLOAD_BASE_DIR does not exist (${options.allowedBaseDir}).`,
+      );
+    }
+    const baseWithSep = baseCanonical.endsWith(path.sep)
+      ? baseCanonical
+      : baseCanonical + path.sep;
+    if (canonical !== baseCanonical && !canonical.startsWith(baseWithSep)) {
+      throw new Error(
+        `Upload rejected: file must be located inside ${baseCanonical}.`,
+      );
+    }
+  }
+
+  return canonical;
+}
+
+export const APP_BINARY_EXTENSIONS = [
+  ".apk",
+  ".aab",
+  ".ipa",
+  ".app",
+  ".zip",
+] as const;
+
+export const TEST_MANAGEMENT_ATTACHMENT_EXTENSIONS = [
+  ".pdf",
+  ".txt",
+  ".md",
+  ".doc",
+  ".docx",
+  ".png",
+  ".jpg",
+  ".jpeg",
+  ".gif",
+  ".csv",
+  ".xls",
+  ".xlsx",
+  ".json",
+  ".html",
+  ".zip",
+] as const;
+
+export const ONE_MB = 1024 * 1024;
+export const MAX_APP_UPLOAD_BYTES = 4 * 1024 * ONE_MB; // 4 GB — matches BrowserStack app upload limit
+export const MAX_ATTACHMENT_UPLOAD_BYTES = 100 * ONE_MB; // 100 MB

src/tools/appautomate-utils/native-execution/appautomate.ts

@@ -4,6 +4,13 @@ import { apiClient } from "../../../lib/apiClient.js";
 import { customFuzzySearch } from "../../../lib/fuzzy.js";
 import { getBrowserStackAuth } from "../../../lib/get-auth.js";
 import { BrowserStackConfig } from "../../../lib/types.js";
+import {
+  validateUploadPath,
+  UploadValidationOptions,
+  APP_BINARY_EXTENSIONS,
+  MAX_APP_UPLOAD_BYTES,
+} from "../../../lib/upload-validator.js";
+import appConfig from "../../../config.js";
 
 interface Device {
   device: string;
@@ -139,14 +146,14 @@ export async function uploadApp(
   username: string,
   password: string,
 ): Promise<string> {
-  const filePath = appPath;
-
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`File not found at path: ${filePath}`);
-  }
+  const safePath = validateUploadPath(appPath, {
+    allowedExtensions: APP_BINARY_EXTENSIONS,
+    maxSizeBytes: MAX_APP_UPLOAD_BYTES,
+    allowedBaseDir: appConfig.UPLOAD_BASE_DIR,
+  });
 
   const formData = new FormData();
-  formData.append("file", fs.createReadStream(filePath));
+  formData.append("file", fs.createReadStream(safePath));
 
   const response = await apiClient.post<UploadResponse>({
     url: "https://api-cloud.browserstack.com/app-automate/upload",
@@ -171,13 +178,16 @@ async function uploadFileToBrowserStack(
   endpoint: string,
   responseKey: string,
   config: BrowserStackConfig,
+  validation: Pick<UploadValidationOptions, "allowedExtensions">,
 ): Promise<string> {
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`File not found at path: ${filePath}`);
-  }
+  const safePath = validateUploadPath(filePath, {
+    allowedExtensions: validation.allowedExtensions,
+    maxSizeBytes: MAX_APP_UPLOAD_BYTES,
+    allowedBaseDir: appConfig.UPLOAD_BASE_DIR,
+  });
 
   const formData = new FormData();
-  formData.append("file", fs.createReadStream(filePath));
+  formData.append("file", fs.createReadStream(safePath));
 
   const authHeader =
     "Basic " +
@@ -211,6 +221,7 @@ export async function uploadEspressoApp(
     "https://api-cloud.browserstack.com/app-automate/espresso/v2/app",
     "app_url",
     config,
+    { allowedExtensions: [".apk", ".aab"] },
   );
 }
 
@@ -224,6 +235,7 @@ export async function uploadEspressoTestSuite(
     "https://api-cloud.browserstack.com/app-automate/espresso/v2/test-suite",
     "test_suite_url",
     config,
+    { allowedExtensions: [".apk"] },
   );
 }
 
@@ -237,6 +249,7 @@ export async function uploadXcuiApp(
     "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/app",
     "app_url",
     config,
+    { allowedExtensions: [".ipa"] },
   );
 }
 
@@ -250,6 +263,7 @@ export async function uploadXcuiTestSuite(
     "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite",
     "test_suite_url",
     config,
+    { allowedExtensions: [".zip"] },
   );
 }
 

src/tools/applive-utils/upload-app.ts

@@ -1,6 +1,12 @@
 import { apiClient } from "../../lib/apiClient.js";
 import FormData from "form-data";
 import fs from "fs";
+import {
+  validateUploadPath,
+  APP_BINARY_EXTENSIONS,
+  MAX_APP_UPLOAD_BYTES,
+} from "../../lib/upload-validator.js";
+import appConfig from "../../config.js";
 
 interface UploadResponse {
   app_url: string;
@@ -11,12 +17,14 @@ export async function uploadApp(
   username: string,
   password: string,
 ): Promise<UploadResponse> {
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`File not found at path: ${filePath}`);
-  }
+  const safePath = validateUploadPath(filePath, {
+    allowedExtensions: APP_BINARY_EXTENSIONS,
+    maxSizeBytes: MAX_APP_UPLOAD_BYTES,
+    allowedBaseDir: appConfig.UPLOAD_BASE_DIR,
+  });
 
   const formData = new FormData();
-  formData.append("file", fs.createReadStream(filePath));
+  formData.append("file", fs.createReadStream(safePath));
 
   try {
     const response = await apiClient.post<UploadResponse>({

src/tools/testmanagement-utils/upload-file.ts

@@ -10,6 +10,12 @@ import { signedUrlMap } from "../../lib/inmemory-store.js";
 import { projectIdentifierToId } from "./TCG-utils/api.js";
 import { BrowserStackConfig } from "../../lib/types.js";
 import { getTMBaseURL } from "../../lib/tm-base-url.js";
+import {
+  validateUploadPath,
+  TEST_MANAGEMENT_ATTACHMENT_EXTENSIONS,
+  MAX_ATTACHMENT_UPLOAD_BYTES,
+} from "../../lib/upload-validator.js";
+import appConfig from "../../config.js";
 
 /**
  * Schema for the upload file tool
@@ -35,26 +41,22 @@ export async function uploadFile(
   const { project_identifier, file_path } = args;
 
   try {
-    // Validate file exists
-    if (!fs.existsSync(file_path)) {
-      return {
-        content: [
-          {
-            type: "text",
-            text: `File ${file_path} does not exist.`,
-          },
-        ],
-        isError: true,
-      };
-    }
+    // Canonicalize path and enforce upload safety rules (extension, size,
+    // hidden-directory traversal, optional base-dir containment).
+    const safePath = validateUploadPath(file_path, {
+      allowedExtensions: TEST_MANAGEMENT_ATTACHMENT_EXTENSIONS,
+      maxSizeBytes: MAX_ATTACHMENT_UPLOAD_BYTES,
+      allowedBaseDir: appConfig.UPLOAD_BASE_DIR,
+    });
+
     // Get the project ID
     const projectIdResponse = await projectIdentifierToId(
       project_identifier,
       config,
     );
 
     const formData = new FormData();
-    formData.append("attachments[]", fs.createReadStream(file_path));
+    formData.append("attachments[]", fs.createReadStream(safePath));
 
     const tmBaseUrl = await getTMBaseURL(config);
     const uploadUrl = `${tmBaseUrl}/api/v1/projects/${projectIdResponse}/generic/attachments/ai_uploads`;