Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | /** * Path Validator - HIGH-2 Remediation * * Fixes path traversal vulnerabilities by: * - Validating all file paths against allowed prefixes * - Using path.resolve() for canonicalization * - Blocking traversal patterns (../, etc.) * - Enforcing path length limits * * Security Properties: * - Path canonicalization * - Prefix validation * - Symlink resolution (optional) * - Traversal pattern detection * * @module v3/security/path-validator */ import * as path from 'path'; import * as fs from 'fs/promises'; export interface PathValidatorConfig { /** * Allowed directory prefixes. * Paths must start with one of these after resolution. */ allowedPrefixes: string[]; /** * Blocked file extensions. * Files with these extensions are rejected. */ blockedExtensions?: string[]; /** * Blocked file names. * Files matching these names are rejected. */ blockedNames?: string[]; /** * Maximum path length. * Default: 4096 characters */ maxPathLength?: number; /** * Whether to resolve symlinks. * Default: true */ resolveSymlinks?: boolean; /** * Whether to allow paths that don't exist. * Default: true (for write operations) */ allowNonExistent?: boolean; /** * Whether to allow hidden files/directories. * Default: false */ allowHidden?: boolean; } export interface PathValidationResult { isValid: boolean; resolvedPath: string; relativePath: string; matchedPrefix: string; errors: string[]; } export class PathValidatorError extends Error { constructor( message: string, public readonly code: string, public readonly path?: string, ) { super(message); this.name = 'PathValidatorError'; } } /** * Dangerous path patterns that indicate traversal attempts. */ const TRAVERSAL_PATTERNS = [ /\.\.\//, // ../ /\.\.\\/, // ..\ /\.\./, // .. anywhere /%2e%2e/i, // URL-encoded .. /%252e%252e/i, // Double URL-encoded .. /\.%2e/i, // Mixed encoding /%2e\./i, // Mixed encoding /\0/, // Null byte /%00/, // URL-encoded null ]; /** * Default blocked file extensions (sensitive files). */ const DEFAULT_BLOCKED_EXTENSIONS = [ '.env', '.pem', '.key', '.crt', '.pfx', '.p12', '.jks', '.keystore', '.secret', '.credentials', ]; /** * Default blocked file names (sensitive files). */ const DEFAULT_BLOCKED_NAMES = [ 'id_rsa', 'id_dsa', 'id_ecdsa', 'id_ed25519', '.htpasswd', '.htaccess', 'shadow', 'passwd', 'authorized_keys', 'known_hosts', '.git', '.gitconfig', '.npmrc', '.docker', ]; /** * Path validator that prevents traversal attacks. * * This class validates file paths to ensure they stay within * allowed directories and don't access sensitive files. * * @example * ```typescript * const validator = new PathValidator({ * allowedPrefixes: ['/workspaces/project'] * }); * * const result = await validator.validate('/workspaces/project/src/file.ts'); * if (result.isValid) { * // Safe to use result.resolvedPath * } * ``` */ export class PathValidator { private readonly config: Required<PathValidatorConfig>; private readonly resolvedPrefixes: string[]; constructor(config: PathValidatorConfig) { this.config = { allowedPrefixes: config.allowedPrefixes, blockedExtensions: config.blockedExtensions ?? DEFAULT_BLOCKED_EXTENSIONS, blockedNames: config.blockedNames ?? DEFAULT_BLOCKED_NAMES, maxPathLength: config.maxPathLength ?? 4096, resolveSymlinks: config.resolveSymlinks ?? true, allowNonExistent: config.allowNonExistent ?? true, allowHidden: config.allowHidden ?? false, }; if (this.config.allowedPrefixes.length === 0) { throw new PathValidatorError( 'At least one allowed prefix must be specified', 'EMPTY_PREFIXES' ); } // Pre-resolve all prefixes this.resolvedPrefixes = this.config.allowedPrefixes.map(p => path.resolve(p) ); } /** * Validates a path against security rules. * * @param inputPath - The path to validate * @returns Validation result with resolved path */ async validate(inputPath: string): Promise<PathValidationResult> { const errors: string[] = []; // Check for empty path if (!inputPath || inputPath.trim() === '') { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: ['Path is empty'], }; } // Check path length if (inputPath.length > this.config.maxPathLength) { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: [`Path exceeds maximum length of ${this.config.maxPathLength}`], }; } // Check for traversal patterns for (const pattern of TRAVERSAL_PATTERNS) { if (pattern.test(inputPath)) { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: ['Path traversal pattern detected'], }; } } // Resolve the path let resolvedPath: string; try { resolvedPath = path.resolve(inputPath); // Optionally resolve symlinks if (this.config.resolveSymlinks) { try { resolvedPath = await fs.realpath(resolvedPath); } catch (error: any) { // Path doesn't exist yet - use resolved path if (error.code !== 'ENOENT' || !this.config.allowNonExistent) { if (error.code === 'ENOENT') { errors.push('Path does not exist'); } else { errors.push(`Failed to resolve path: ${error.message}`); } } } } } catch (error: any) { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: [`Invalid path: ${error.message}`], }; } // Check against allowed prefixes let matchedPrefix = ''; let relativePath = ''; let prefixMatched = false; for (const prefix of this.resolvedPrefixes) { if (resolvedPath === prefix || resolvedPath.startsWith(prefix + path.sep)) { prefixMatched = true; matchedPrefix = prefix; relativePath = resolvedPath.slice(prefix.length); if (relativePath.startsWith(path.sep)) { relativePath = relativePath.slice(1); } break; } } if (!prefixMatched) { return { isValid: false, resolvedPath, relativePath: '', matchedPrefix: '', errors: ['Path is outside allowed directories'], }; } // Check for hidden files const pathParts = resolvedPath.split(path.sep); if (!this.config.allowHidden) { for (const part of pathParts) { if (part.startsWith('.') && part !== '.' && part !== '..') { errors.push('Hidden files/directories are not allowed'); break; } } } // Check blocked file names const basename = path.basename(resolvedPath); if (this.config.blockedNames.includes(basename)) { errors.push(`File name "${basename}" is blocked`); } // Check blocked extensions const ext = path.extname(resolvedPath).toLowerCase(); if (this.config.blockedExtensions.includes(ext)) { errors.push(`File extension "${ext}" is blocked`); } // Also check for double extensions (e.g., .tar.gz, .config.json) const fullname = basename.toLowerCase(); for (const blockedExt of this.config.blockedExtensions) { if (fullname.endsWith(blockedExt)) { errors.push(`File extension "${blockedExt}" is blocked`); break; } } return { isValid: errors.length === 0, resolvedPath, relativePath, matchedPrefix, errors, }; } /** * Validates and returns resolved path, throwing on failure. * * @param inputPath - The path to validate * @returns Resolved path if valid * @throws PathValidatorError if validation fails */ async validateOrThrow(inputPath: string): Promise<string> { const result = await this.validate(inputPath); if (!result.isValid) { throw new PathValidatorError( result.errors.join('; '), 'VALIDATION_FAILED', inputPath ); } return result.resolvedPath; } /** * Synchronous validation (without symlink resolution). * * @param inputPath - The path to validate * @returns Validation result */ validateSync(inputPath: string): PathValidationResult { const errors: string[] = []; if (!inputPath || inputPath.trim() === '') { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: ['Path is empty'], }; } if (inputPath.length > this.config.maxPathLength) { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: [`Path exceeds maximum length of ${this.config.maxPathLength}`], }; } for (const pattern of TRAVERSAL_PATTERNS) { if (pattern.test(inputPath)) { return { isValid: false, resolvedPath: '', relativePath: '', matchedPrefix: '', errors: ['Path traversal pattern detected'], }; } } const resolvedPath = path.resolve(inputPath); let matchedPrefix = ''; let relativePath = ''; let prefixMatched = false; for (const prefix of this.resolvedPrefixes) { if (resolvedPath === prefix || resolvedPath.startsWith(prefix + path.sep)) { prefixMatched = true; matchedPrefix = prefix; relativePath = resolvedPath.slice(prefix.length); if (relativePath.startsWith(path.sep)) { relativePath = relativePath.slice(1); } break; } } if (!prefixMatched) { return { isValid: false, resolvedPath, relativePath: '', matchedPrefix: '', errors: ['Path is outside allowed directories'], }; } const pathParts = resolvedPath.split(path.sep); if (!this.config.allowHidden) { for (const part of pathParts) { if (part.startsWith('.') && part !== '.' && part !== '..') { errors.push('Hidden files/directories are not allowed'); break; } } } const basename = path.basename(resolvedPath); if (this.config.blockedNames.includes(basename)) { errors.push(`File name "${basename}" is blocked`); } const ext = path.extname(resolvedPath).toLowerCase(); if (this.config.blockedExtensions.includes(ext)) { errors.push(`File extension "${ext}" is blocked`); } return { isValid: errors.length === 0, resolvedPath, relativePath, matchedPrefix, errors, }; } /** * Securely joins path segments within allowed directories. * * @param prefix - Base directory (must be in allowedPrefixes) * @param segments - Path segments to join * @returns Validated resolved path */ async securePath(prefix: string, ...segments: string[]): Promise<string> { // Join the segments const joined = path.join(prefix, ...segments); // Validate the result return this.validateOrThrow(joined); } /** * Adds a prefix to the allowed list at runtime. * * @param prefix - Prefix to add */ addPrefix(prefix: string): void { const resolved = path.resolve(prefix); if (!this.resolvedPrefixes.includes(resolved)) { this.config.allowedPrefixes.push(prefix); this.resolvedPrefixes.push(resolved); } } /** * Returns the current allowed prefixes. */ getAllowedPrefixes(): readonly string[] { return [...this.resolvedPrefixes]; } /** * Checks if a path is within allowed prefixes (quick check). */ isWithinAllowed(inputPath: string): boolean { try { const resolved = path.resolve(inputPath); return this.resolvedPrefixes.some( prefix => resolved === prefix || resolved.startsWith(prefix + path.sep) ); } catch { return false; } } } /** * Factory function to create a path validator for a project directory. * * @param projectRoot - Root directory of the project * @returns Configured PathValidator */ export function createProjectPathValidator(projectRoot: string): PathValidator { const srcDir = path.join(projectRoot, 'src'); const testDir = path.join(projectRoot, 'tests'); const docsDir = path.join(projectRoot, 'docs'); return new PathValidator({ allowedPrefixes: [srcDir, testDir, docsDir], allowHidden: false, }); } /** * Factory function to create a path validator for the entire project. * * @param projectRoot - Root directory of the project * @returns Configured PathValidator */ export function createFullProjectPathValidator(projectRoot: string): PathValidator { return new PathValidator({ allowedPrefixes: [projectRoot], allowHidden: true, // Allow .gitignore, etc. blockedNames: [ ...DEFAULT_BLOCKED_NAMES, 'node_modules', // Block access to node_modules ], }); } |