typescript-virtual-container 1.1.1 → 1.1.2

package/dist/SSHMimic/index.js

@@ -0,0 +1,113 @@
+import { Server as SshServer } from "ssh2";
+import { VirtualShell } from "../VirtualShell";
+import { loadOrCreateHostKey } from "./hostKey";
+/**
+ * SSH server facade that wires the virtual shell runtime into ssh2 sessions.
+ *
+ * This class is exported as `VirtualSshServer` for public API compatibility.
+ * Create an instance, call {@link SshMimic.start}, and stop it with
+ * {@link SshMimic.stop} when your process exits.
+ */
+class SshMimic {
+    port;
+    server;
+    shell;
+    shellHostname;
+    /**
+     * Creates a new SSH mimic server instance.
+     *
+     * @param port TCP port to bind on localhost.
+     * @param hostname Virtual hostname used for the SSH ident and default shell label.
+     * @param shell Optional preconfigured virtual shell instance to reuse.
+     */
+    constructor({ port, hostname = "typescript-vm", shell = new VirtualShell(hostname), }) {
+        this.port = port;
+        this.shellHostname = hostname;
+        this.server = null;
+        this.shell = shell;
+    }
+    /**
+     * Starts server and initializes virtual filesystem, users, and handlers.
+     *
+     * @returns Promise resolved with bound listening port.
+     */
+    async start() {
+        const shell = this.shell;
+        const privateKey = loadOrCreateHostKey();
+        this.server = new SshServer({
+            hostKeys: [privateKey],
+            ident: `SSH-2.0-${shell.hostname}`,
+        }, (client) => {
+            let authUser = "root";
+            let remoteAddress = "unknown";
+            let sessionId = null;
+            client.on("authentication", (ctx) => {
+                shell;
+                if (ctx.method === "password") {
+                    const candidateUser = ctx.username || "root";
+                    remoteAddress = ctx.ip ?? remoteAddress;
+                    if (!shell.users.verifyPassword(candidateUser, ctx.password ?? "")) {
+                        ctx.reject();
+                        return;
+                    }
+                    authUser = candidateUser;
+                    sessionId = shell.users.registerSession(authUser, remoteAddress).id;
+                    const homePath = `/home/${authUser}`;
+                    if (!shell.vfs.exists(homePath)) {
+                        shell.vfs.mkdir(homePath, 0o755);
+                        shell.vfs.writeFile(`${homePath}/README.txt`, `Welcome to ${shell?.hostname ?? this.shellHostname}`);
+                        void shell.vfs.flushMirror();
+                    }
+                    ctx.accept();
+                    return;
+                }
+                ctx.reject();
+            });
+            client.on("close", () => {
+                shell.users.unregisterSession(sessionId);
+                sessionId = null;
+            });
+            client.on("ready", () => {
+                client.on("session", (accept) => {
+                    const session = accept();
+                    const terminalSize = { cols: 80, rows: 24 };
+                    session.on("pty", (acceptPty, _rejectPty, info) => {
+                        terminalSize.cols = info?.cols ?? terminalSize.cols;
+                        terminalSize.rows = info?.rows ?? terminalSize.rows;
+                        acceptPty();
+                    });
+                    session.on("window-change", (_acceptChange, _rejectChange, info) => {
+                        terminalSize.cols = info?.cols ?? terminalSize.cols;
+                        terminalSize.rows = info?.rows ?? terminalSize.rows;
+                    });
+                    session.on("shell", (acceptShell) => {
+                        const stream = acceptShell();
+                        shell?.startInteractiveSession(stream, authUser, sessionId, remoteAddress, terminalSize);
+                    });
+                    session.on("exec", (acceptExec, _rejectExec, info) => {
+                        const _stream = acceptExec();
+                        shell?.executeCommand(info.command.trim(), authUser, `/home/${authUser}`);
+                    });
+                });
+            });
+        });
+        return new Promise((resolve, reject) => {
+            this.server?.once("error", (err) => reject(err));
+            this.server?.listen(this.port, "127.0.0.1", () => {
+                console.log(`SSH Mimic listening on port ${this.port}`);
+                resolve(this.port);
+            });
+        });
+    }
+    /**
+     * Stops server if running.
+     */
+    stop() {
+        if (this.server) {
+            this.server.close(() => {
+                console.log("SSH Mimic stopped");
+            });
+        }
+    }
+}
+export { SshMimic };

package/dist/SSHMimic/loginFormat.d.ts

@@ -0,0 +1,2 @@
+export declare function formatLoginDate(date: Date): string;
+//# sourceMappingURL=loginFormat.d.ts.map

package/dist/SSHMimic/loginFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loginFormat.d.ts","sourceRoot":"","sources":["../../src/SSHMimic/loginFormat.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CASlD"}

package/dist/SSHMimic/loginFormat.js

@@ -0,0 +1,10 @@
+export function formatLoginDate(date) {
+    const weekday = date.toLocaleString("en-US", { weekday: "short" });
+    const month = date.toLocaleString("en-US", { month: "short" });
+    const day = date.getDate().toString().padStart(2, "0");
+    const hh = date.getHours().toString().padStart(2, "0");
+    const mm = date.getMinutes().toString().padStart(2, "0");
+    const ss = date.getSeconds().toString().padStart(2, "0");
+    const year = date.getFullYear();
+    return `${weekday} ${month} ${day} ${hh}:${mm}:${ss} ${year}`;
+}

package/dist/SSHMimic/prompt.d.ts

@@ -0,0 +1,2 @@
+export declare function buildPrompt(user: string, host: string, cwdName: string): string;
+//# sourceMappingURL=prompt.d.ts.map

package/dist/SSHMimic/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../src/SSHMimic/prompt.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAC1B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACb,MAAM,CASR"}

package/dist/SSHMimic/prompt.js

@@ -0,0 +1,9 @@
+export function buildPrompt(user, host, cwdName) {
+    const isRoot = user === "root";
+    const colorUser = isRoot ? "\u001b[31;1m" : "\u001b[35;1m";
+    const colorWhite = "\u001b[37;1m";
+    const colorBlue = "\u001b[34;1m";
+    const colorReset = "\u001b[0m";
+    const symbol = isRoot ? "#" : "$";
+    return `${colorWhite}[${colorUser}${user}${colorWhite}@${colorBlue}${host}${colorReset} ${cwdName}${colorWhite}]${colorReset}${symbol} `;
+}

package/dist/VirtualFileSystem/archive.d.ts

@@ -0,0 +1,5 @@
+import type { VfsSnapshot } from "../types/vfs";
+export declare function archiveExists(archivePath: string): Promise<boolean>;
+export declare function createTarBuffer(snapshotJson: string): Promise<Buffer>;
+export declare function readSnapshotFromTar(tarBuffer: Buffer): Promise<VfsSnapshot>;
+//# sourceMappingURL=archive.d.ts.map

package/dist/VirtualFileSystem/archive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["../../src/VirtualFileSystem/archive.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOzE;AAED,wBAAsB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAuB3E;AAED,wBAAsB,mBAAmB,CACxC,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC,CAiCtB"}

package/dist/VirtualFileSystem/archive.js

@@ -0,0 +1,56 @@
+import { promises as fs } from "node:fs";
+import * as tarStream from "tar-stream";
+export async function archiveExists(archivePath) {
+    try {
+        await fs.access(archivePath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+export async function createTarBuffer(snapshotJson) {
+    const pack = tarStream.pack();
+    const chunks = [];
+    const finished = new Promise((resolve, reject) => {
+        pack.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
+        pack.on("error", reject);
+        pack.on("end", () => resolve(Buffer.concat(chunks)));
+    });
+    pack.entry({ name: "snapshot.json", mode: 0o600 }, snapshotJson, (error) => {
+        if (error) {
+            return;
+        }
+        pack.finalize();
+    });
+    return finished;
+}
+export async function readSnapshotFromTar(tarBuffer) {
+    return new Promise((resolve, reject) => {
+        const extract = tarStream.extract();
+        let snapshotText = "";
+        let found = false;
+        extract.on("entry", (header, stream, next) => {
+            if (header.name === "snapshot.json") {
+                found = true;
+                stream.on("data", (chunk) => {
+                    snapshotText += chunk.toString("utf8");
+                });
+                stream.on("end", next);
+                stream.resume();
+                return;
+            }
+            stream.resume();
+            stream.on("end", next);
+        });
+        extract.on("finish", () => {
+            if (!found) {
+                reject(new Error("snapshot.json missing from archive"));
+                return;
+            }
+            resolve(JSON.parse(snapshotText));
+        });
+        extract.on("error", reject);
+        extract.end(tarBuffer);
+    });
+}

package/dist/VirtualFileSystem/index.d.ts

@@ -0,0 +1,131 @@
+import type { RemoveOptions, VfsNodeStats, WriteFileOptions } from "../types/vfs";
+/**
+ * In-memory virtual filesystem with tar.gz mirror persistence.
+ *
+ * Paths are normalized to POSIX-like absolute paths. Use
+ * {@link VirtualFileSystem.restoreMirror} on startup and
+ * {@link VirtualFileSystem.flushMirror} to persist pending changes.
+ */
+declare class VirtualFileSystem {
+    private readonly root;
+    private readonly archivePath;
+    private dirty;
+    private computeNodeUsageBytes;
+    /**
+     * Creates a virtual filesystem instance.
+     *
+     * @param baseDir Base directory used to resolve mirror archive location.
+     */
+    constructor(baseDir?: string);
+    /**
+     * Restores filesystem state from mirror archive.
+     *
+     * If archive does not exist or cannot be read, creates fresh mirror file.
+     */
+    restoreMirror(): Promise<void>;
+    /**
+     * Persists current filesystem state to mirror archive.
+     *
+     * No-op when nothing changed and archive already exists.
+     */
+    flushMirror(): Promise<void>;
+    /**
+     * Creates directory and any missing parent directories.
+     *
+     * @param targetPath Absolute or relative path to directory.
+     * @param mode POSIX-like mode bits for new directories.
+     */
+    mkdir(targetPath: string, mode?: number): void;
+    /**
+     * Writes UTF-8 text or binary content into file.
+     *
+     * Parent directories are created when missing.
+     *
+     * @param targetPath Destination file path.
+     * @param content File content as string or Buffer.
+     * @param options Optional write behavior (mode, compression).
+     */
+    writeFile(targetPath: string, content: string | Buffer, options?: WriteFileOptions): void;
+    /**
+     * Reads file content as UTF-8 text.
+     *
+     * Compressed files are transparently decompressed.
+     *
+     * @param targetPath Path to file.
+     * @returns UTF-8 string content.
+     */
+    readFile(targetPath: string): string;
+    /**
+     * Checks whether node exists at path.
+     *
+     * @param targetPath Node path.
+     * @returns True when file or directory exists.
+     */
+    exists(targetPath: string): boolean;
+    /**
+     * Updates mode bits for file or directory.
+     *
+     * @param targetPath Node path.
+     * @param mode New POSIX-like mode.
+     */
+    chmod(targetPath: string, mode: number): void;
+    /**
+     * Returns metadata for file or directory.
+     *
+     * @param targetPath Node path.
+     * @returns Typed stat object based on node type.
+     */
+    stat(targetPath: string): VfsNodeStats;
+    /**
+     * Lists direct children names of directory.
+     *
+     * @param dirPath Directory path, defaults to root.
+     * @returns Sorted child names.
+     */
+    list(dirPath?: string): string[];
+    /**
+     * Renders ASCII tree view of directory hierarchy.
+     *
+     * @param dirPath Directory path, defaults to root.
+     * @returns Multi-line tree string.
+     */
+    tree(dirPath?: string): string;
+    /**
+     * Computes total stored file bytes under a path.
+     *
+     * File usage is based on in-memory stored bytes, including compressed
+     * payload size when files are marked as compressed.
+     *
+     * @param targetPath File or directory path to measure, defaults to root.
+     * @returns Total byte usage for file content under target path.
+     */
+    getUsageBytes(targetPath?: string): number;
+    /**
+     * Compresses file content with gzip and flags node as compressed.
+     *
+     * @param targetPath Path to file.
+     */
+    compressFile(targetPath: string): void;
+    /**
+     * Decompresses gzip-compressed file content.
+     *
+     * @param targetPath Path to file.
+     */
+    decompressFile(targetPath: string): void;
+    /**
+     * Removes file or directory node.
+     *
+     * @param targetPath Path to remove.
+     * @param options Removal options, including recursive delete.
+     */
+    remove(targetPath: string, options?: RemoveOptions): void;
+    /**
+     * Moves or renames node to destination path.
+     *
+     * @param fromPath Existing source path.
+     * @param toPath Destination path.
+     */
+    move(fromPath: string, toPath: string): void;
+}
+export default VirtualFileSystem;
+//# sourceMappingURL=index.d.ts.map

package/dist/VirtualFileSystem/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/VirtualFileSystem/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACX,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,MAAM,cAAc,CAAC;AAOtB;;;;;;GAMG;AACH,cAAM,iBAAiB;IACtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwB;IAC7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,KAAK,CAAS;IAEtB,OAAO,CAAC,qBAAqB;IAY7B;;;;OAIG;gBACS,OAAO,GAAE,MAAsB;IAa3C;;;;OAIG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB3C;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAazC;;;;;OAKG;IACI,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,GAAE,MAAc,GAAG,IAAI;IAiC5D;;;;;;;;OAQG;IACI,SAAS,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,OAAO,GAAE,gBAAqB,GAC5B,IAAI;IAyCP;;;;;;;OAOG;IACI,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAU3C;;;;;OAKG;IACI,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAS1C;;;;;OAKG;IACI,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAOpD;;;;;OAKG;IACI,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY;IA4B7C;;;;;OAKG;IACI,IAAI,CAAC,OAAO,GAAE,MAAY,GAAG,MAAM,EAAE;IAS5C;;;;;OAKG;IACI,IAAI,CAAC,OAAO,GAAE,MAAY,GAAG,MAAM;IAW1C;;;;;;;;OAQG;IACI,aAAa,CAAC,UAAU,GAAE,MAAY,GAAG,MAAM;IAKtD;;;;OAIG;IACI,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAc7C;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAc/C;;;;;OAKG;IACI,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,IAAI;IAiCpE;;;;;OAKG;IACI,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAsCnD;AAED,eAAe,iBAAiB,CAAC"}