@ebowwa/terminal 0.2.1 → 0.3.0

package/src/files.js

@@ -1,521 +0,0 @@
-"use strict";
-/**
- * Remote file operations via SSH
- */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathTraversalError = void 0;
-exports.getSecurityEvents = getSecurityEvents;
-exports.clearSecurityEvents = clearSecurityEvents;
-exports.sanitizePath = sanitizePath;
-exports.listFiles = listFiles;
-exports.previewFile = previewFile;
-var client_js_1 = require("./client.js");
-var error_js_1 = require("./error.js");
-/**
- * Path traversal security error
- */
-var PathTraversalError = /** @class */ (function (_super) {
-    __extends(PathTraversalError, _super);
-    function PathTraversalError(message, attemptedPath, reason) {
-        var _this = _super.call(this, message) || this;
-        _this.attemptedPath = attemptedPath;
-        _this.reason = reason;
-        _this.name = "PathTraversalError";
-        return _this;
-    }
-    return PathTraversalError;
-}(error_js_1.SSHError));
-exports.PathTraversalError = PathTraversalError;
-var securityEvents = [];
-var MAX_SECURITY_EVENTS = 1000;
-/**
- * Log a security event
- */
-function logSecurityEvent(attemptedPath, reason, severity) {
-    var event = {
-        timestamp: new Date().toISOString(),
-        attemptedPath: attemptedPath,
-        reason: reason,
-        severity: severity,
-    };
-    securityEvents.push(event);
-    // Keep only recent events
-    if (securityEvents.length > MAX_SECURITY_EVENTS) {
-        securityEvents.shift();
-    }
-    // Log to console with appropriate severity
-    var logPrefix = {
-        blocked: "[SECURITY BLOCKED]",
-        suspicious: "[SECURITY SUSPICIOUS]",
-        warning: "[SECURITY WARNING]",
-    }[severity];
-    console.error("".concat(logPrefix, " Path traversal attempt detected:"), JSON.stringify(event));
-}
-/**
- * Get recent security events for monitoring
- */
-function getSecurityEvents(limit) {
-    if (limit === void 0) { limit = 50; }
-    return securityEvents.slice(-limit);
-}
-/**
- * Clear old security events (for maintenance)
- */
-function clearSecurityEvents(olderThanMs) {
-    if (olderThanMs === void 0) { olderThanMs = 24 * 60 * 60 * 1000; }
-    var cutoff = Date.now() - olderThanMs;
-    var initialLength = securityEvents.length;
-    for (var i = securityEvents.length - 1; i >= 0; i--) {
-        var eventTime = new Date(securityEvents[i].timestamp).getTime();
-        if (eventTime < cutoff) {
-            securityEvents.splice(i, 1);
-        }
-    }
-    return initialLength - securityEvents.length;
-}
-/**
- * Normalize a path by resolving . and removing redundant slashes
- * Does NOT resolve .. (those are checked separately)
- */
-function normalizePath(path) {
-    // Remove redundant slashes
-    var normalized = path.replace(/\/+/g, "/");
-    // Remove trailing slash (unless it's just "/")
-    if (normalized.length > 1 && normalized.endsWith("/")) {
-        normalized = normalized.slice(0, -1);
-    }
-    // Resolve single dots (current directory)
-    normalized = normalized.replace(/\/\.\//g, "/").replace(/\/\.$/, "");
-    return normalized;
-}
-/**
- * Check if a path contains parent directory references
- */
-function hasParentDirReference(path) {
-    // Check for .. in path components
-    var parts = path.split("/");
-    return parts.some(function (part) { return part === ".." || part.includes("\\.."); });
-}
-/**
- * Check if path attempts to escape using null bytes
- */
-function hasNullByte(path) {
-    return path.includes("\0");
-}
-/**
- * Calculate path depth (number of directories)
- */
-function calculatePathDepth(path) {
-    return path.split("/").filter(function (p) { return p.length > 0; }).length;
-}
-/**
- * Validate that a resolved path stays within allowed base directories
- */
-function validatePathInAllowedDirs(resolvedPath, allowedDirs) {
-    // Normalize all paths for comparison
-    var normalizedResolved = normalizePath(resolvedPath);
-    var normalizedAllowed = allowedDirs.map(normalizePath);
-    // Check if resolved path starts with any allowed directory
-    return normalizedAllowed.some(function (allowedDir) {
-        // Ensure allowed directory ends with / for proper prefix matching
-        var prefix = allowedDir.endsWith("/") ? allowedDir : allowedDir + "/";
-        return (normalizedResolved === allowedDir || normalizedResolved.startsWith(prefix));
-    });
-}
-/**
- * Resolve a path relative to a base directory
- * Throws if the result would escape the base directory
- */
-function resolveRelativePath(baseDir, inputPath) {
-    var normalizedBase = normalizePath(baseDir);
-    var normalizedInput = normalizePath(inputPath);
-    // If input is absolute, reject (unless allowed by options)
-    if (normalizedInput.startsWith("/")) {
-        throw new Error("Absolute paths are not allowed");
-    }
-    // Build full path
-    var fullPath = normalizedBase + "/" + normalizedInput;
-    fullPath = normalizePath(fullPath);
-    // Check for parent directory references in the full path
-    if (hasParentDirReference(fullPath)) {
-        throw new Error("Path contains parent directory references");
-    }
-    // Verify the path is still within base directory
-    if (!fullPath.startsWith(normalizedBase + "/") && fullPath !== normalizedBase) {
-        throw new Error("Path escapes allowed directory");
-    }
-    return fullPath;
-}
-/**
- * Sanitize and validate a file path for security
- *
- * This function prevents path traversal attacks by:
- * 1. Rejecting paths with .. components
- * 2. Validating against allowed base directories
- * 3. Normalizing paths to remove . and redundant /
- * 4. Checking for null bytes and other escape sequences
- * 5. Limiting path depth to prevent deep traversal
- *
- * @param inputPath - The user-provided path to sanitize
- * @param options - Sanitization options
- * @returns Sanitized absolute path
- * @throws PathTraversalError if path is suspicious or invalid
- *
- * @example
- * ```ts
- * // Safe: within /root
- * sanitizePath("project/file.txt", { user: "root" })
- * // Returns: "/root/project/file.txt"
- *
- * // BLOCKED: attempts to escape
- * sanitizePath("../../../etc/passwd", { user: "root" })
- * // Throws: PathTraversalError
- *
- * // BLOCKED: null byte injection
- * sanitizePath("file.txt\0../../../etc/passwd", { user: "root" })
- * // Throws: PathTraversalError
- * ```
- */
-function sanitizePath(inputPath, options) {
-    if (options === void 0) { options = {}; }
-    var allowedBaseDirs = options.allowedBaseDirs, _a = options.user, user = _a === void 0 ? "root" : _a, _b = options.allowAbsolutePaths, allowAbsolutePaths = _b === void 0 ? false : _b, _c = options.maxDepth, maxDepth = _c === void 0 ? 20 : _c, _d = options.logSuspicious, logSuspicious = _d === void 0 ? true : _d;
-    // Determine default allowed base directories based on user
-    var defaultAllowedDirs = user === "root"
-        ? ["/root"]
-        : ["/home/".concat(user), "/tmp"];
-    var finalAllowedDirs = allowedBaseDirs || defaultAllowedDirs;
-    // ===== SECURITY CHECKS =====
-    // 1. Check for null byte injection (CWE-158)
-    if (hasNullByte(inputPath)) {
-        var error = "Path contains null byte (possible injection attempt)";
-        if (logSuspicious) {
-            logSecurityEvent(inputPath, "Null byte injection detected", "blocked");
-        }
-        throw new PathTraversalError("Invalid path: contains null byte", inputPath, error);
-    }
-    // 2. Check for parent directory references (CWE-22)
-    if (hasParentDirReference(inputPath)) {
-        var error = "Path contains parent directory reference (..)";
-        if (logSuspicious) {
-            logSecurityEvent(inputPath, "Path traversal attempt detected", "blocked");
-        }
-        throw new PathTraversalError("Path traversal blocked: parent directory references not allowed", inputPath, error);
-    }
-    // 3. Check for backslashes (Windows path separator, potential escape)
-    if (inputPath.includes("\\")) {
-        var error = "Path contains backslashes";
-        if (logSuspicious) {
-            logSecurityEvent(inputPath, "Backslash in path detected", "suspicious");
-        }
-        throw new PathTraversalError("Invalid path: backslashes not allowed", inputPath, error);
-    }
-    // 4. Check for URL-encoded characters (possible bypass attempt)
-    if (/%2e|%2f|%5c/i.test(inputPath)) {
-        var error = "Path contains URL-encoded characters";
-        if (logSuspicious) {
-            logSecurityEvent(inputPath, "URL encoding detected in path", "suspicious");
-        }
-        throw new PathTraversalError("Invalid path: URL-encoded characters not allowed", inputPath, error);
-    }
-    // 5. Check path depth
-    var pathDepth = calculatePathDepth(inputPath);
-    if (pathDepth > maxDepth) {
-        var error = "Path depth ".concat(pathDepth, " exceeds maximum ").concat(maxDepth);
-        if (logSuspicious) {
-            logSecurityEvent(inputPath, error, "suspicious");
-        }
-        throw new PathTraversalError("Path too deep: possible traversal attempt", inputPath, error);
-    }
-    // 6. Check for suspicious patterns
-    var suspiciousPatterns = [
-        /\.\.[\/\\]/, // ../ or ..\
-        /\/\.\./, // /..
-        /\.\.$/, // ends with ..
-        /^\.\./, // starts with ..
-    ];
-    for (var _i = 0, suspiciousPatterns_1 = suspiciousPatterns; _i < suspiciousPatterns_1.length; _i++) {
-        var pattern = suspiciousPatterns_1[_i];
-        if (pattern.test(inputPath)) {
-            var error = "Path matches suspicious pattern: ".concat(pattern);
-            if (logSuspicious) {
-                logSecurityEvent(inputPath, error, "blocked");
-            }
-            throw new PathTraversalError("Path blocked: matches suspicious pattern", inputPath, error);
-        }
-    }
-    // ===== PATH RESOLUTION =====
-    var sanitizedPath;
-    if (inputPath.startsWith("/")) {
-        // Handle absolute paths
-        if (!allowAbsolutePaths) {
-            var error = "Absolute paths are not allowed";
-            if (logSuspicious) {
-                logSecurityEvent(inputPath, error, "blocked");
-            }
-            throw new PathTraversalError(error + ": use relative paths only", inputPath, error);
-        }
-        // Normalize the absolute path
-        sanitizedPath = normalizePath(inputPath);
-        // Validate against allowed directories
-        if (!validatePathInAllowedDirs(sanitizedPath, finalAllowedDirs)) {
-            var error = "Absolute path not within allowed directories: ".concat(finalAllowedDirs.join(", "));
-            if (logSuspicious) {
-                logSecurityEvent(inputPath, error, "blocked");
-            }
-            throw new PathTraversalError("Access denied: path outside allowed directories", inputPath, error);
-        }
-    }
-    else {
-        // Handle relative paths - resolve against each allowed base directory
-        // Use the first valid resolution
-        var resolved = false;
-        for (var _e = 0, finalAllowedDirs_1 = finalAllowedDirs; _e < finalAllowedDirs_1.length; _e++) {
-            var baseDir = finalAllowedDirs_1[_e];
-            try {
-                sanitizedPath = resolveRelativePath(baseDir, inputPath);
-                resolved = true;
-                break;
-            }
-            catch (_f) {
-                // Try next base directory
-                continue;
-            }
-        }
-        if (!resolved) {
-            var error = "Path cannot be resolved within allowed directories: ".concat(finalAllowedDirs.join(", "));
-            if (logSuspicious) {
-                logSecurityEvent(inputPath, error, "blocked");
-            }
-            throw new PathTraversalError("Access denied: path outside allowed directories", inputPath, error);
-        }
-    }
-    // Final validation
-    if (!sanitizedPath || sanitizedPath.length === 0) {
-        throw new PathTraversalError("Invalid path: resulted in empty path", inputPath, "Empty path after sanitization");
-    }
-    return sanitizedPath;
-}
-/**
- * List files in a directory on remote server
- * @param path - Directory path to list (default: .)
- * @param options - SSH connection options
- * @returns List of files with metadata
- * @throws PathTraversalError if path attempts to escape allowed directories
- * @throws SSHError if SSH command fails
- */
-function listFiles() {
-    return __awaiter(this, arguments, void 0, function (path, options) {
-        var host, _a, user, _b, timeout, sanitizedPath, command, output, lines, files, _i, lines_1, line, parts, permissions, isDir, fileName, filePath, error_1;
-        var _c, _d;
-        if (path === void 0) { path = "."; }
-        return __generator(this, function (_e) {
-            switch (_e.label) {
-                case 0:
-                    host = options.host, _a = options.user, user = _a === void 0 ? "root" : _a, _b = options.timeout, timeout = _b === void 0 ? 5 : _b;
-                    try {
-                        sanitizedPath = sanitizePath(path, {
-                            user: user,
-                            allowAbsolutePaths: false,
-                            logSuspicious: true,
-                        });
-                    }
-                    catch (error) {
-                        if (error instanceof PathTraversalError) {
-                            // Re-throw path traversal errors with security context
-                            throw error;
-                        }
-                        throw new error_js_1.SSHError("Failed to sanitize path: ".concat(path), error);
-                    }
-                    _e.label = 1;
-                case 1:
-                    _e.trys.push([1, 3, , 4]);
-                    command = "ls -la \"".concat(sanitizedPath, "\" 2>/dev/null || echo \"FAILED\"");
-                    return [4 /*yield*/, (0, client_js_1.execSSH)(command, { host: host, user: user, timeout: timeout })];
-                case 2:
-                    output = _e.sent();
-                    if (output === "FAILED" || output === "0") {
-                        throw new error_js_1.SSHError("Failed to list directory: ".concat(sanitizedPath, " (original: ").concat(path, ")"));
-                    }
-                    lines = output.split("\n").slice(1);
-                    files = [];
-                    for (_i = 0, lines_1 = lines; _i < lines_1.length; _i++) {
-                        line = lines_1[_i];
-                        if (!line.trim())
-                            continue;
-                        parts = line.split(/\s+/);
-                        if (parts.length < 8)
-                            continue;
-                        permissions = parts[0];
-                        isDir = permissions.startsWith("d");
-                        fileName = ((_c = parts[8]) === null || _c === void 0 ? void 0 : _c.split(" ->")[0]) || parts[8];
-                        filePath = "".concat(sanitizedPath, "/").concat(fileName).replace(/\/\//g, "/");
-                        files.push({
-                            name: fileName,
-                            path: filePath,
-                            size: isDir ? "-" : parts[4],
-                            modified: parts[5] +
-                                " " +
-                                parts[6] +
-                                " " +
-                                ((_d = parts[7]) === null || _d === void 0 ? void 0 : _d.split(".").slice(0, 2).join(":")) || "",
-                            type: isDir ? "directory" : "file",
-                        });
-                    }
-                    return [2 /*return*/, files];
-                case 3:
-                    error_1 = _e.sent();
-                    throw new error_js_1.SSHError("Failed to list files: ".concat(path), error_1);
-                case 4: return [2 /*return*/];
-            }
-        });
-    });
-}
-/**
- * Preview a file's content from remote server
- * @param filePath - Path to the file to preview
- * @param options - SSH connection options
- * @returns File content for preview
- * @throws PathTraversalError if path attempts to escape allowed directories
- * @throws SSHError if SSH command fails
- */
-function previewFile(filePath, options) {
-    return __awaiter(this, void 0, void 0, function () {
-        var host, _a, user, _b, timeout, absolutePath, checkCmd, checkOutput, readCmd, content, hasNullBytes, nonPrintableCount, isLikelyBinary, imageExtensions, isImage, maxPreviewSize, trimmedContent, error_2;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    host = options.host, _a = options.user, user = _a === void 0 ? "root" : _a, _b = options.timeout, timeout = _b === void 0 ? 10 : _b;
-                    try {
-                        absolutePath = sanitizePath(filePath, {
-                            user: user,
-                            allowAbsolutePaths: false,
-                            logSuspicious: true,
-                        });
-                    }
-                    catch (error) {
-                        if (error instanceof PathTraversalError) {
-                            // Re-throw path traversal errors with security context
-                            return [2 /*return*/, {
-                                    type: "error",
-                                    error: "Access denied: path outside allowed directories",
-                                }];
-                        }
-                        return [2 /*return*/, { type: "error", error: "Failed to validate file path" }];
-                    }
-                    _c.label = 1;
-                case 1:
-                    _c.trys.push([1, 4, , 5]);
-                    checkCmd = "test -f \"".concat(absolutePath, "\" && echo \"EXISTS\" || echo \"NOFILE\"");
-                    return [4 /*yield*/, (0, client_js_1.execSSH)(checkCmd, { host: host, user: user, timeout: timeout })];
-                case 2:
-                    checkOutput = _c.sent();
-                    if (checkOutput !== "EXISTS") {
-                        return [2 /*return*/, { type: "error", error: "File not found" }];
-                    }
-                    readCmd = "cat \"".concat(absolutePath, "\" 2>/dev/null || echo \"READFAIL\"");
-                    return [4 /*yield*/, (0, client_js_1.execSSH)(readCmd, { host: host, user: user, timeout: 15 })];
-                case 3:
-                    content = _c.sent();
-                    if (content === "READFAIL" || content === "0") {
-                        return [2 /*return*/, { type: "error", error: "Failed to read file content" }];
-                    }
-                    hasNullBytes = content.includes("\u0000");
-                    nonPrintableCount = (content.match(/[\x00-\x08\x0E-\x1F]/g) || [])
-                        .length;
-                    isLikelyBinary = hasNullBytes ||
-                        (content.length > 0 && nonPrintableCount / content.length > 0.3);
-                    imageExtensions = [
-                        ".png",
-                        ".jpg",
-                        ".jpeg",
-                        ".gif",
-                        ".bmp",
-                        ".svg",
-                        ".webp",
-                        ".ico",
-                    ];
-                    isImage = imageExtensions.some(function (ext) {
-                        return absolutePath.toLowerCase().endsWith(ext);
-                    });
-                    if (isImage) {
-                        return [2 /*return*/, { type: "image", content: "[Image file - download to view]" }];
-                    }
-                    else if (isLikelyBinary) {
-                        return [2 /*return*/, { type: "binary", content: "[Binary file - download to view]" }];
-                    }
-                    else {
-                        maxPreviewSize = 10000;
-                        trimmedContent = content.length > maxPreviewSize
-                            ? content.slice(0, maxPreviewSize) + "\n\n... (truncated)"
-                            : content;
-                        return [2 /*return*/, {
-                                type: "text",
-                                content: trimmedContent,
-                            }];
-                    }
-                    return [3 /*break*/, 5];
-                case 4:
-                    error_2 = _c.sent();
-                    // Log the error for security auditing
-                    console.error("[File Preview Error] path=\"".concat(filePath, "\", sanitized=\"").concat(absolutePath, "\", error=").concat(error_2));
-                    // Return error without exposing internal details
-                    if (error_2 instanceof error_js_1.SSHError || error_2 instanceof PathTraversalError) {
-                        return [2 /*return*/, { type: "error", error: "Access denied" }];
-                    }
-                    return [2 /*return*/, { type: "error", error: "Failed to preview file" }];
-                case 5: return [2 /*return*/];
-            }
-        });
-    });
-}