typescript-virtual-container 1.4.4 → 1.4.5

package/src/VirtualShell/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAQ3C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAGjD,OAAO,iBAAiB,EAAE,EAAE,KAAK,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAG3D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAe;IAC/B,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IACnC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAClE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IACrC,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IACpC,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,CAAC;IACvC,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACnC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACpE,KAAK,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,OAAO,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,aAAa,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5C;AAED,MAAM,WAAW,sBAAsB;IACtC,WAAW,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAkDD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAM,YAAa,SAAQ,YAAY;IACtC,mEAAmE;IACnE,GAAG,EAAE,iBAAiB,CAAC;IACvB,0EAA0E;IAC1E,KAAK,EAAE,kBAAkB,CAAC;IAC1B,wEAAwE;IACxE,cAAc,EAAE,qBAAqB,CAAC;IACtC,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,UAAU,EAAE,eAAe,CAAC;IAC5B,iFAAiF;IACjF,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,WAAW,CAAgB;IAEnC;;;;;;OAMG;gBAEF,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,eAAe,EAC5B,oBAAoB,CAAC,EAAE,UAAU,GAAG,mBAAmB,GAAG,sBAAsB;IAsCjF;;;OAGG;IACU,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/C;;;;;;OAMG;IACH,UAAU,CACT,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EAAE,EAChB,QAAQ,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,GACvE,IAAI;IASP;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAMrE;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CACtB,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAC1C,IAAI;IAkBP;;;;;;;;;OASG;IACI,aAAa,IAAI,IAAI;IAU5B;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CACX,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,GAClC,IAAI;IAIP,kDAAkD;IAC3C,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAInC,8BAA8B;IACvB,SAAS,IAAI,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAIjF;;;;OAIG;IACI,mBAAmB,IAAI,IAAI;IAUlC;;;;;;;OAOG;IACI,UAAU,IAAI,IAAI;IAIzB;;;;OAIG;IACI,MAAM,IAAI,iBAAiB,GAAG,IAAI;IAIzC;;;;OAIG;IACI,QAAQ,IAAI,kBAAkB,GAAG,IAAI;IAI5C;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;;;;OAMG;IACI,eAAe,CACrB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,MAAM,GACtB,IAAI;CAKP;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/src/VirtualShell/index.js

@@ -1,284 +0,0 @@
-import { EventEmitter } from "node:events";
-import { createCustomCommand, registerCommand } from "../commands/registry";
-import { runCommand } from "../commands/runtime";
-import { bootstrapLinuxRootfs, refreshProc, syncEtcPasswd, } from "../modules/linuxRootfs";
-import { createPerfLogger } from "../utils/perfLogger";
-import VirtualFileSystem, {} from "../VirtualFileSystem";
-import { VirtualPackageManager } from "../VirtualPackageManager";
-import { VirtualUserManager } from "../VirtualUserManager";
-import { startShell } from "./shell";
-function hasVfsInstance(obj) {
-    return (typeof obj === "object" &&
-        obj !== null &&
-        "vfsInstance" in obj &&
-        isVirtualShellVfsLike(obj.vfsInstance));
-}
-function isVirtualShellVfsLike(value) {
-    if (typeof value !== "object" || value === null) {
-        return false;
-    }
-    const candidate = value;
-    return (typeof candidate.restoreMirror === "function" &&
-        typeof candidate.flushMirror === "function" &&
-        typeof candidate.writeFile === "function" &&
-        typeof candidate.readFile === "function" &&
-        typeof candidate.mkdir === "function" &&
-        typeof candidate.exists === "function" &&
-        typeof candidate.stat === "function" &&
-        typeof candidate.list === "function" &&
-        typeof candidate.remove === "function" &&
-        typeof candidate.copy === "function" &&
-        typeof candidate.move === "function" &&
-        typeof candidate.touch === "function");
-}
-const defaultShellProperties = {
-    kernel: "1.0.0+itsrealfortune+1-amd64",
-    os: "Fortune GNU/Linux x64",
-    arch: "x86_64",
-};
-const perf = createPerfLogger("VirtualShell");
-function resolveAutoSudoForNewUsers() {
-    const configured = process.env.SSH_MIMIC_AUTO_SUDO_NEW_USERS;
-    if (!configured) {
-        return true;
-    }
-    return !["0", "false", "no", "off"].includes(configured.toLowerCase());
-}
-/**
- * Coordinates the virtual filesystem, user manager, package manager, and
- * command runtime for a single isolated shell environment.
- *
- * Each instance owns its own VFS tree, user database, package registry, and
- * session state — multiple instances are fully independent.
- *
- * Instances are consumed both by the SSH/SFTP server facades and directly via
- * the programmatic `SshClient` API.
- *
- * @example
- * ```ts
- * const shell = new VirtualShell("my-vm");
- * await shell.ensureInitialized();
- * const client = new SshClient(shell, "root");
- * const result = await client.exec("uname -a");
- * ```
- *
- * @fires VirtualShell#initialized  Emitted once the VFS and users are ready.
- * @fires VirtualShell#command       Emitted after every command execution.
- * @fires VirtualShell#session:start Emitted when an interactive session opens.
- */
-class VirtualShell extends EventEmitter {
-    /** Backing virtual filesystem — use for direct path operations. */
-    vfs;
-    /** Virtual user database — use for auth, quotas, and session tracking. */
-    users;
-    /** APT/dpkg package manager backed by the built-in package registry. */
-    packageManager;
-    /** Hostname shown in the shell prompt and SSH ident string. */
-    hostname;
-    /** Distro identity strings surfaced by `uname`, `neofetch`, etc. */
-    properties;
-    /** Unix ms timestamp of shell creation — used by `uptime` and `/proc/uptime`. */
-    startTime;
-    initialized;
-    /**
-     * Creates a new virtual shell instance.
-     *
-     * @param hostname Virtual hostname used for prompts and idents.
-     * @param properties Customizable properties shown in `uname -a` and similar commands.
-     * @param vfsOptions Optional VFS persistence options (mode, snapshotPath).
-     */
-    constructor(hostname, properties, vfsOptionsOrInstance) {
-        super();
-        perf.mark("constructor");
-        this.hostname = hostname;
-        this.properties = properties || defaultShellProperties;
-        this.startTime = Date.now();
-        if (isVirtualShellVfsLike(vfsOptionsOrInstance)) {
-            this.vfs = vfsOptionsOrInstance;
-        }
-        else if (hasVfsInstance(vfsOptionsOrInstance)) {
-            this.vfs = vfsOptionsOrInstance.vfsInstance;
-        }
-        else {
-            this.vfs = new VirtualFileSystem(vfsOptionsOrInstance ?? {});
-        }
-        this.users = new VirtualUserManager(this.vfs, resolveAutoSudoForNewUsers());
-        this.packageManager = new VirtualPackageManager(this.vfs, this.users);
-        // Store references to avoid TypeScript "used before assigned" errors
-        const vfs = this.vfs;
-        const users = this.users;
-        const pm = this.packageManager;
-        const shellProps = this.properties;
-        const shellHostname = this.hostname;
-        const startTime = this.startTime;
-        // Initialize both VFS mirror and users, ensuring all is ready before auth
-        this.initialized = (async () => {
-            await vfs.restoreMirror();
-            await users.initialize();
-            // Bootstrap Linux rootfs (idempotent)
-            bootstrapLinuxRootfs(vfs, users, shellHostname, shellProps, startTime);
-            // Load installed packages from dpkg status
-            pm.load();
-            this.emit("initialized");
-        })();
-    }
-    /**
-     * Ensures initialization is complete before allowing operations.
-     * Call this before any authentication or command execution.
-     */
-    async ensureInitialized() {
-        perf.mark("ensureInitialized");
-        await this.initialized;
-    }
-    /**
-     * Registers a new command in the shell runtime.
-     *
-     * @param name Case-insensitive command name (no spaces).
-     * @param params List of parameter names for help text (no validation).
-     * @param callback Function invoked with command context on execution.
-     */
-    addCommand(name, params, callback) {
-        const normalized = name.trim().toLowerCase();
-        if (normalized.length === 0 || /\s/.test(normalized)) {
-            throw new Error("Command name must be non-empty and contain no spaces");
-        }
-        registerCommand(createCustomCommand(normalized, params, callback));
-    }
-    /**
-     * Executes a raw command line string programmatically.
-     *
-     * Supports the full shell operator set (`&&`, `||`, `;`, `|`, `>`, `<`,
-     * `$(cmd)`) and alias expansion. The result is emitted via the
-     * `"command"` event but not returned — use `SshClient.exec()` for a
-     * result-returning wrapper.
-     *
-     * @param rawInput Unparsed command line (e.g. `"ls -la /tmp"`).
-     * @param authUser Username to run the command as.
-     * @param cwd      Current working directory for path resolution.
-     */
-    executeCommand(rawInput, authUser, cwd) {
-        perf.mark("executeCommand");
-        runCommand(rawInput, authUser, this.hostname, "shell", cwd, this);
-        this.emit("command", { command: rawInput, user: authUser, cwd });
-    }
-    /**
-     * Attaches an interactive PTY session to this shell instance.
-     *
-     * Called internally by `SshMimic` when a client opens a shell channel.
-     * The session reads from `stream` (user keystrokes) and writes back ANSI
-     * output. History, `.bashrc` sourcing, and Ctrl+W/Ctrl+U line editing are
-     * handled automatically.
-     *
-     * @param stream        Bidirectional SSH channel stream.
-     * @param authUser      Authenticated username bound to this session.
-     * @param sessionId     Stable session UUID (used for `who` output), or `null`.
-     * @param remoteAddress IP or hostname of the connecting client.
-     * @param terminalSize  Initial terminal dimensions in columns and rows.
-     */
-    startInteractiveSession(stream, authUser, sessionId, remoteAddress, terminalSize) {
-        perf.mark("startInteractiveSession");
-        // Interactive shell logic
-        this.emit("session:start", { user: authUser, sessionId, remoteAddress });
-        startShell(this.properties, stream, authUser, this.hostname, sessionId, remoteAddress, terminalSize, this);
-        // Refresh /proc/<pid> and /proc/self after session is registered
-        this.refreshProcSessions();
-    }
-    /**
-     * Refreshes the `/proc` virtual filesystem with current system state.
-     *
-     * Updates `/proc/uptime`, `/proc/meminfo`, `/proc/cpuinfo`,
-     * `/proc/version`, `/proc/loadavg`, `/proc/self`, and per-session
-     * `/proc/<pid>` entries from live session and host data.
-     *
-     * Called automatically during `bootstrapLinuxRootfs`. Call again before
-     * reading `/proc` files for up-to-date values.
-     */
-    refreshProcFs() {
-        refreshProc(this.vfs, this.properties, this.hostname, this.startTime, this.users.listActiveSessions());
-    }
-    /**
-     * Mount a host directory into the VFS at `vPath`.
-     *
-     * Delegates file operations inside `vPath` to the host filesystem via
-     * `node:fs`. Silently ignored in browser environments.
-     *
-     * @param vPath    Absolute path inside the VM (e.g. `"/app"`).
-     * @param hostPath Path on the host — relative paths are resolved from `process.cwd()`.
-     * @param options  `{ readOnly?: boolean }` — default `true`.
-     *
-     * @example
-     * ```ts
-     * const shell = new VirtualShell("dev-vm");
-     * await shell.ensureInitialized();
-     * shell.mount("/workspace", "./my-project");
-     * // shell commands can now read ./my-project files via /workspace
-     * ```
-     */
-    mount(vPath, hostPath, options = {}) {
-        this.vfs.mount(vPath, hostPath, options);
-    }
-    /** Remove a previously mounted host directory. */
-    unmount(vPath) {
-        this.vfs.unmount(vPath);
-    }
-    /** List all active mounts. */
-    getMounts() {
-        return this.vfs.getMounts();
-    }
-    /**
-     * Updates only the session-dependent `/proc` entries (`/proc/<pid>`,
-     * `/proc/self`). Cheaper than a full `refreshProcFs()` — call this
-     * whenever a session is registered or unregistered.
-     */
-    refreshProcSessions() {
-        refreshProc(this.vfs, this.properties, this.hostname, this.startTime, this.users.listActiveSessions());
-    }
-    /**
-     * Syncs `/etc/passwd`, `/etc/group`, and `/etc/shadow` from the current
-     * `VirtualUserManager` state.
-     *
-     * Called automatically during `bootstrapLinuxRootfs`. Call again after
-     * `users.addUser()`, `users.deleteUser()`, or `users.addSudoer()` to keep
-     * the classic Unix credential files in sync with the user manager.
-     */
-    syncPasswd() {
-        syncEtcPasswd(this.vfs, this.users);
-    }
-    /**
-     * Returns virtual filesystem instance after server started.
-     *
-     * @returns VirtualFileSystem or null when not started.
-     */
-    getVfs() {
-        return this?.vfs ?? null;
-    }
-    /**
-     * Returns user manager instance after server started.
-     *
-     * @returns VirtualUserManager or null when not started.
-     */
-    getUsers() {
-        return this?.users ?? null;
-    }
-    /**
-     * Returns hostname shown in prompts and idents.
-     *
-     * @returns Configured hostname label.
-     */
-    getHostname() {
-        return this?.hostname;
-    }
-    /**
-     * Writes a file on behalf of a user with quota enforcement.
-     *
-     * @param authUser User performing the write.
-     * @param targetPath Destination path.
-     * @param content File content.
-     */
-    writeFileAsUser(authUser, targetPath, content) {
-        perf.mark("writeFileAsUser");
-        this.users.assertWriteWithinQuota(authUser, targetPath, content);
-        this.vfs.writeFile(targetPath, content);
-    }
-}
-export { VirtualShell };

package/src/VirtualShell/shell.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shell.d.ts","sourceRoot":"","sources":["shell.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AAMvD,OAAO,EAGN,KAAK,YAAY,EAEjB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAwBpD,wBAAgB,UAAU,CACzB,UAAU,EAAE,eAAe,EAC3B,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,aAAa,oBAAY,EACzB,YAAY,EAAE,YAAY,YAAyB,EACnD,KAAK,EAAE,YAAY,GACjB,IAAI,CA0nBN"}