typescript-virtual-container 1.1.0 → 1.1.1-c

package/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "files.exclude": {
+        "**/.git": true,
+        "**/.hg": true,
+        "**/.svn": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "**/node_modules": true,
+
+        ".ssh-mimic": true,
+        ".vfs": true,
+        
+        "LICENSE": true,
+        "*.md": true,
+        "biome.json": true,
+        "tsconfig.tsbuildinfo": true
+    }
+}

package/README.md

@@ -83,7 +83,7 @@ bun add typescript-virtual-container
 ### From source (development)
 
 ```bash
-git clone <repo-url>
+git clone https://github.com/itsrealfortune/typescript-virtual-container/
 cd virtual-env-js
 bun install
 bun format  # Format code per Biome
@@ -745,6 +745,46 @@ Revokes sudo privileges. Cannot remove root.
 await users.removeSudoer("charlie");
 ```
 
+##### `async setQuotaBytes(username: string, maxBytes: number): Promise<void>`
+
+Sets an optional per-user quota (bytes) for writes under `/home/<username>`.
+
+```typescript
+await users.setQuotaBytes("alice", 5 * 1024 * 1024); // 5 MB
+```
+
+##### `async clearQuota(username: string): Promise<void>`
+
+Removes quota limit for a user.
+
+```typescript
+await users.clearQuota("alice");
+```
+
+##### `getQuotaBytes(username: string): number | null`
+
+Returns configured quota in bytes, or `null` if unlimited.
+
+```typescript
+console.log(users.getQuotaBytes("alice"));
+```
+
+##### `getUsageBytes(username: string): number`
+
+Returns current stored usage in bytes under `/home/<username>`.
+
+```typescript
+console.log(users.getUsageBytes("alice"));
+```
+
+##### `assertWriteWithinQuota(username: string, targetPath: string, nextContent: string | Buffer): void`
+
+Validates a write operation against quota rules; throws when projected usage exceeds quota.
+
+```typescript
+users.assertWriteWithinQuota("alice", "/home/alice/data.txt", "payload");
+```
+
 ##### `registerSession(username: string, remoteAddress: string): VirtualActiveSession`
 
 Creates active session (called on SSH auth). Returns session descriptor with UUID, tty, start time.
@@ -1358,9 +1398,9 @@ MIT License. See LICENSE file for details.
 
 ## Roadmap
 
-- [ ] Custom command plugin API
-- [ ] Optional per-user quotas for virtual filesystem usage
-- [ ] Improved shell compatibility for complex piping and redirection
+- [x] Custom command plugin API
+- [x] Optional per-user quotas for virtual filesystem usage
+- [x] Improved shell compatibility for complex piping and redirection
 - [ ] Snapshot diff tooling for test assertions
-- [ ] Structured event hooks (session open/close, file write, sudo challenge)
+- [x] Structured event hooks (session open/close, file write, sudo challenge)
 - [ ] WebSocket-based remote shell client (experimental)

package/dist/SSHClient/index.d.ts

@@ -0,0 +1,138 @@
+import type { CommandResult } from "../types/commands";
+import type { VirtualShell } from "../VirtualShell";
+/**
+ * Programmatic client for executing shell commands against a virtual shell.
+ *
+ * Maintains working-directory state across invocations and runs commands as a
+ * single authenticated user without SSH transport overhead.
+ *
+ * @example
+ * ```ts
+ * const shell = new VirtualShell("typescript-vm");
+ * const client = new SshClient(shell, "alice");
+ * const result = await client.cd("/tmp");
+ * const list = await client.ls();
+ * ```
+ */
+export declare class SshClient {
+    private shell;
+    private username;
+    private currentCwd;
+    /**
+     * Creates a programmatic client bound to a virtual shell and user.
+     *
+     * @param shell Parent virtual shell instance.
+     * @param username Login user for all commands.
+     */
+    constructor(shell: VirtualShell, username: string);
+    /**
+     * Executes raw shell command.
+     *
+     * @param command Unparsed command line.
+     * @returns Command result with stdout/stderr/exitCode.
+     */
+    exec(command: string): Promise<CommandResult>;
+    /**
+     * Lists directory contents.
+     *
+     * @param path Target directory, defaults to cwd.
+     * @returns Result with directory listing in stdout.
+     */
+    ls(path?: string): Promise<CommandResult>;
+    /**
+     * Prints current working directory.
+     *
+     * @returns Result with cwd path in stdout.
+     */
+    pwd(): Promise<CommandResult>;
+    /**
+     * Changes working directory.
+     *
+     * @param path Target directory path.
+     * @returns Result; updates internal cwd on success.
+     */
+    cd(path: string): Promise<CommandResult>;
+    /**
+     * Reads file content.
+     *
+     * @param path File path.
+     * @returns Result with file content in stdout.
+     */
+    cat(path: string): Promise<CommandResult>;
+    /**
+     * Creates directory.
+     *
+     * @param path Directory path.
+     * @param recursive When true, create parents.
+     * @returns Result from mkdir command.
+     */
+    mkdir(path: string, recursive?: boolean): Promise<CommandResult>;
+    /**
+     * Creates file (empty).
+     *
+     * @param path File path.
+     * @returns Result from touch command.
+     */
+    touch(path: string): Promise<CommandResult>;
+    /**
+     * Removes file or directory.
+     *
+     * @param path Target path.
+     * @param recursive When true, delete directory tree.
+     * @returns Result from rm command.
+     */
+    rm(path: string, recursive?: boolean): Promise<CommandResult>;
+    /**
+     * Writes file content.
+     *
+     * @param path Target file path.
+     * @param content Text to write.
+     * @returns Result from touch/write simulation.
+     */
+    writeFile(path: string, content: string): Promise<CommandResult>;
+    /**
+     * Reads file content programmatically.
+     *
+     * @param path Target file path.
+     * @returns File content as string or error in result.
+     */
+    readFile(path: string): Promise<CommandResult>;
+    /**
+     * Gets current working directory.
+     *
+     * @returns Normalized cwd path.
+     */
+    getCwd(): string;
+    /**
+     * Gets logged-in username.
+     *
+     * @returns Associated username.
+     */
+    getUsername(): string;
+    /**
+     * Renders tree view of directory.
+     *
+     * @param path Target directory, defaults to cwd.
+     * @returns Result with ASCII tree in stdout.
+     */
+    tree(path?: string): Promise<CommandResult>;
+    /**
+     * Shows current user.
+     *
+     * @returns Result from whoami command.
+     */
+    whoami(): Promise<CommandResult>;
+    /**
+     * Shows hostname.
+     *
+     * @returns Result from hostname command.
+     */
+    hostname(): Promise<CommandResult>;
+    /**
+     * Lists active users/sessions.
+     *
+     * @returns Result from who command.
+     */
+    who(): Promise<CommandResult>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/SSHClient/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;;;;;;;;;;;GAaG;AACH,qBAAa,SAAS;IAUpB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,QAAQ;IAVjB,OAAO,CAAC,UAAU,CAAO;IAEzB;;;;;OAKG;gBAEM,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,MAAM;IAGzB;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA0BnD;;;;;OAKG;IACG,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAK/C;;;;OAIG;IACG,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC;IAInC;;;;;OAKG;IACG,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ9C;;;;;OAKG;IACG,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAI/C;;;;;;OAMG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAKpE;;;;;OAKG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjD;;;;;;OAMG;IACG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAKjE;;;;;;OAMG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBtE;;;;;OAKG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBpD;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;OAKG;IACG,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKjD;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAItC;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC;IAIxC;;;;OAIG;IACG,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC;CAGnC"}

package/dist/SSHClient/index.js

@@ -0,0 +1,216 @@
+import { runCommand } from "../commands";
+/**
+ * Programmatic client for executing shell commands against a virtual shell.
+ *
+ * Maintains working-directory state across invocations and runs commands as a
+ * single authenticated user without SSH transport overhead.
+ *
+ * @example
+ * ```ts
+ * const shell = new VirtualShell("typescript-vm");
+ * const client = new SshClient(shell, "alice");
+ * const result = await client.cd("/tmp");
+ * const list = await client.ls();
+ * ```
+ */
+export class SshClient {
+    shell;
+    username;
+    currentCwd = "/";
+    /**
+     * Creates a programmatic client bound to a virtual shell and user.
+     *
+     * @param shell Parent virtual shell instance.
+     * @param username Login user for all commands.
+     */
+    constructor(shell, username) {
+        this.shell = shell;
+        this.username = username;
+    }
+    /**
+     * Executes raw shell command.
+     *
+     * @param command Unparsed command line.
+     * @returns Command result with stdout/stderr/exitCode.
+     */
+    async exec(command) {
+        const vfs = this.shell.getVfs();
+        const users = this.shell.getUsers();
+        const hostname = this.shell.getHostname();
+        if (!vfs || !users) {
+            throw new Error("SSH client not started");
+        }
+        const result = runCommand(command, this.username, hostname, "exec", this.currentCwd, this.shell);
+        // Handle async results
+        if (result instanceof Promise) {
+            return await result;
+        }
+        return result;
+    }
+    /**
+     * Lists directory contents.
+     *
+     * @param path Target directory, defaults to cwd.
+     * @returns Result with directory listing in stdout.
+     */
+    async ls(path) {
+        const target = path ?? ".";
+        return this.exec(`ls ${target}`);
+    }
+    /**
+     * Prints current working directory.
+     *
+     * @returns Result with cwd path in stdout.
+     */
+    async pwd() {
+        return this.exec("pwd");
+    }
+    /**
+     * Changes working directory.
+     *
+     * @param path Target directory path.
+     * @returns Result; updates internal cwd on success.
+     */
+    async cd(path) {
+        const result = await this.exec(`cd ${path}`);
+        if (result.nextCwd && result.exitCode !== 1) {
+            this.currentCwd = result.nextCwd;
+        }
+        return result;
+    }
+    /**
+     * Reads file content.
+     *
+     * @param path File path.
+     * @returns Result with file content in stdout.
+     */
+    async cat(path) {
+        return this.exec(`cat ${path}`);
+    }
+    /**
+     * Creates directory.
+     *
+     * @param path Directory path.
+     * @param recursive When true, create parents.
+     * @returns Result from mkdir command.
+     */
+    async mkdir(path, recursive = false) {
+        const flag = recursive ? "-p " : "";
+        return this.exec(`mkdir ${flag}${path}`);
+    }
+    /**
+     * Creates file (empty).
+     *
+     * @param path File path.
+     * @returns Result from touch command.
+     */
+    async touch(path) {
+        return this.exec(`touch ${path}`);
+    }
+    /**
+     * Removes file or directory.
+     *
+     * @param path Target path.
+     * @param recursive When true, delete directory tree.
+     * @returns Result from rm command.
+     */
+    async rm(path, recursive = false) {
+        const flag = recursive ? "-r " : "";
+        return this.exec(`rm ${flag}${path}`);
+    }
+    /**
+     * Writes file content.
+     *
+     * @param path Target file path.
+     * @param content Text to write.
+     * @returns Result from touch/write simulation.
+     */
+    async writeFile(path, content) {
+        const vfs = this.shell.getVfs();
+        if (!vfs) {
+            throw new Error("SSH client not started");
+        }
+        try {
+            this.shell.writeFileAsUser(this.username, path, content);
+            return { stdout: `File '${path}' written`, exitCode: 0 };
+        }
+        catch (error) {
+            return {
+                stderr: `Failed to write '${path}': ${error instanceof Error ? error.message : String(error)}`,
+                exitCode: 1,
+            };
+        }
+    }
+    /**
+     * Reads file content programmatically.
+     *
+     * @param path Target file path.
+     * @returns File content as string or error in result.
+     */
+    async readFile(path) {
+        const vfs = this.shell.getVfs();
+        if (!vfs) {
+            throw new Error("SSH client not started");
+        }
+        try {
+            const content = vfs.readFile(path);
+            return { stdout: content, exitCode: 0 };
+        }
+        catch (error) {
+            return {
+                stderr: `Failed to read '${path}': ${error instanceof Error ? error.message : String(error)}`,
+                exitCode: 1,
+            };
+        }
+    }
+    /**
+     * Gets current working directory.
+     *
+     * @returns Normalized cwd path.
+     */
+    getCwd() {
+        return this.currentCwd;
+    }
+    /**
+     * Gets logged-in username.
+     *
+     * @returns Associated username.
+     */
+    getUsername() {
+        return this.username;
+    }
+    /**
+     * Renders tree view of directory.
+     *
+     * @param path Target directory, defaults to cwd.
+     * @returns Result with ASCII tree in stdout.
+     */
+    async tree(path) {
+        const target = path ?? ".";
+        return this.exec(`tree ${target}`);
+    }
+    /**
+     * Shows current user.
+     *
+     * @returns Result from whoami command.
+     */
+    async whoami() {
+        return this.exec("whoami");
+    }
+    /**
+     * Shows hostname.
+     *
+     * @returns Result from hostname command.
+     */
+    async hostname() {
+        return this.exec("hostname");
+    }
+    /**
+     * Lists active users/sessions.
+     *
+     * @returns Result from who command.
+     */
+    async who() {
+        return this.exec("who");
+    }
+}

package/dist/SSHMimic/exec.d.ts

@@ -0,0 +1,4 @@
+import type { ExecStream } from "../types/streams";
+import type { VirtualShell } from "../VirtualShell";
+export declare function runExec(stream: ExecStream, cmd: string, authUser: string, hostname: string, shell: VirtualShell): void;
+//# sourceMappingURL=exec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exec.d.ts","sourceRoot":"","sources":["../../src/SSHMimic/exec.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AASpD,wBAAgB,OAAO,CACtB,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,YAAY,GACjB,IAAI,CAiBN"}

package/dist/SSHMimic/exec.js

@@ -0,0 +1,21 @@
+import { runCommand } from "../commands";
+function toTtyLines(text) {
+    return text
+        .replace(/\r\n/g, "\n")
+        .replace(/\r/g, "\n")
+        .replace(/\n/g, "\r\n");
+}
+export function runExec(stream, cmd, authUser, hostname, shell) {
+    Promise.resolve(runCommand(cmd, authUser, hostname, "exec", `/home/${authUser}`, shell)).then((result) => {
+        if (result.stdout) {
+            stream.write(`${toTtyLines(result.stdout)}\r\n`);
+        }
+        if (result.stderr) {
+            stream.stderr.write(`${toTtyLines(result.stderr)}\r\n`);
+        }
+        stream.exit(result.exitCode ?? 0);
+        console.log(shell.vfs);
+        void shell.vfs.flushMirror();
+        stream.end();
+    });
+}

package/dist/SSHMimic/executor.d.ts

@@ -0,0 +1,9 @@
+import type { CommandMode, CommandResult } from "../types/commands";
+import type { Pipeline } from "../types/pipeline";
+import type { VirtualShell } from "../VirtualShell";
+/**
+ * Execute a parsed pipeline, chaining commands and handling redirections.
+ * Manages stdout/stderr flow between commands and file I/O.
+ */
+export declare function executePipeline(pipeline: Pipeline, authUser: string, hostname: string, mode: CommandMode, cwd: string, shell: VirtualShell): Promise<CommandResult>;
+//# sourceMappingURL=executor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../src/SSHMimic/executor.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAmB,MAAM,mBAAmB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;GAGG;AACH,wBAAsB,eAAe,CACpC,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,YAAY,GACjB,OAAO,CAAC,aAAa,CAAC,CA0BxB"}

package/dist/SSHMimic/executor.js

@@ -0,0 +1,131 @@
+import { runCommand as runSingleCommand } from "../commands";
+import { resolvePath } from "../commands/helpers";
+/**
+ * Execute a parsed pipeline, chaining commands and handling redirections.
+ * Manages stdout/stderr flow between commands and file I/O.
+ */
+export async function executePipeline(pipeline, authUser, hostname, mode, cwd, shell) {
+    if (pipeline.commands.length === 0) {
+        return { exitCode: 0 };
+    }
+    if (pipeline.commands.length === 1) {
+        // Single command with possible redirections
+        return executeSingleCommandWithRedirections(pipeline.commands[0], authUser, hostname, mode, cwd, shell);
+    }
+    // Multiple commands in a pipeline
+    return executePipelineChain(pipeline.commands, authUser, hostname, mode, cwd, shell);
+}
+/**
+ * Execute a single command with input/output redirections
+ */
+async function executeSingleCommandWithRedirections(cmd, authUser, hostname, mode, cwd, shell) {
+    // Prepare input if input file specified
+    let stdin;
+    if (cmd.inputFile) {
+        const inputPath = resolvePath(cwd, cmd.inputFile);
+        try {
+            stdin = shell.vfs.readFile(inputPath);
+        }
+        catch {
+            return {
+                stderr: `cat: ${cmd.inputFile}: No such file or directory`,
+                exitCode: 1,
+            };
+        }
+    }
+    // Build raw input for the command
+    const rawInput = [cmd.name, ...cmd.args].join(" ");
+    // Run the command with potential input
+    const result = await runSingleCommand(rawInput, authUser, hostname, mode, cwd, shell, stdin);
+    // Handle output redirection
+    if (cmd.outputFile) {
+        const outputPath = resolvePath(cwd, cmd.outputFile);
+        const output = result.stdout || "";
+        try {
+            if (cmd.appendOutput) {
+                try {
+                    const existing = shell.vfs.readFile(outputPath);
+                    shell.writeFileAsUser(authUser, outputPath, existing + output);
+                }
+                catch {
+                    shell.writeFileAsUser(authUser, outputPath, output);
+                }
+            }
+            else {
+                shell.writeFileAsUser(authUser, outputPath, output);
+            }
+            return { ...result, stdout: "" };
+        }
+        catch {
+            return {
+                ...result,
+                stderr: `Failed to write to ${cmd.outputFile}`,
+                exitCode: 1,
+            };
+        }
+    }
+    return result;
+}
+/**
+ * Execute a chain of commands connected by pipes
+ */
+async function executePipelineChain(commands, authUser, hostname, mode, cwd, shell) {
+    let currentOutput = "";
+    let exitCode = 0;
+    for (let i = 0; i < commands.length; i++) {
+        const cmd = commands[i];
+        // Handle input file for first command
+        if (i === 0 && cmd.inputFile) {
+            const inputPath = resolvePath(cwd, cmd.inputFile);
+            try {
+                currentOutput = shell.vfs.readFile(inputPath);
+            }
+            catch {
+                return {
+                    stderr: `cat: ${cmd.inputFile}: No such file or directory`,
+                    exitCode: 1,
+                };
+            }
+        }
+        // Build raw input
+        const rawInput = [cmd.name, ...cmd.args].join(" ");
+        // Create a modified context that might accept stdin
+        // For now, we'll append input as an additional arg for commands that support it
+        const result = await runSingleCommand(rawInput, authUser, hostname, mode, cwd, shell, currentOutput);
+        exitCode = result.exitCode ?? 0;
+        // Handle output redirection (only for last command)
+        if (i === commands.length - 1 && cmd.outputFile) {
+            const outputPath = resolvePath(cwd, cmd.outputFile);
+            const output = result.stdout || "";
+            try {
+                if (cmd.appendOutput) {
+                    try {
+                        const existing = shell.vfs.readFile(outputPath);
+                        shell.writeFileAsUser(authUser, outputPath, existing + output);
+                    }
+                    catch {
+                        shell.writeFileAsUser(authUser, outputPath, output);
+                    }
+                }
+                else {
+                    shell.writeFileAsUser(authUser, outputPath, output);
+                }
+                currentOutput = "";
+            }
+            catch {
+                return {
+                    stderr: `Failed to write to ${cmd.outputFile}`,
+                    exitCode: 1,
+                };
+            }
+        }
+        else {
+            // Pass output to next command
+            currentOutput = result.stdout || "";
+        }
+        if (result.stderr && exitCode !== 0) {
+            return { stderr: result.stderr, exitCode };
+        }
+    }
+    return { stdout: currentOutput, exitCode };
+}

package/dist/SSHMimic/hostKey.d.ts

@@ -0,0 +1,2 @@
+export declare function loadOrCreateHostKey(baseDir?: string): string;
+//# sourceMappingURL=hostKey.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hostKey.d.ts","sourceRoot":"","sources":["../../src/SSHMimic/hostKey.ts"],"names":[],"mappings":"AAIA,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,MAAsB,GAAG,MAAM,CAgB3E"}

package/dist/SSHMimic/hostKey.js

@@ -0,0 +1,17 @@
+import { generateKeyPairSync } from "node:crypto";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+export function loadOrCreateHostKey(baseDir = process.cwd()) {
+    const hostKeyPath = resolve(baseDir, ".ssh-mimic", "host_rsa");
+    if (existsSync(hostKeyPath)) {
+        return readFileSync(hostKeyPath, "utf8");
+    }
+    const privateKey = generateKeyPairSync("rsa", {
+        modulusLength: 2048,
+        privateKeyEncoding: { type: "pkcs1", format: "pem" },
+        publicKeyEncoding: { type: "pkcs1", format: "pem" },
+    }).privateKey;
+    mkdirSync(dirname(hostKeyPath), { recursive: true });
+    writeFileSync(hostKeyPath, privateKey, { mode: 0o600 });
+    return privateKey;
+}

package/dist/SSHMimic/index.d.ts

@@ -0,0 +1,39 @@
+import { Server as SshServer } from "ssh2";
+import { VirtualShell } from "../VirtualShell";
+/**
+ * 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.
+ */
+declare class SshMimic {
+    port: number;
+    server: SshServer | null;
+    private shell;
+    private 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, shell, }: {
+        port: number;
+        hostname?: string;
+        shell?: VirtualShell;
+    });
+    /**
+     * Starts server and initializes virtual filesystem, users, and handlers.
+     *
+     * @returns Promise resolved with bound listening port.
+     */
+    start(): Promise<number>;
+    /**
+     * Stops server if running.
+     */
+    stop(): void;
+}
+export { SshMimic };
+//# sourceMappingURL=index.d.ts.map