typescript-virtual-container 0.1.0

package/src/SSHMimic/index.ts

@@ -0,0 +1,203 @@
+import { Server as SshServer } from "ssh2";
+import VirtualFileSystem from "../VirtualFileSystem";
+import { runExec } from "./exec";
+import { loadOrCreateHostKey } from "./hostKey";
+import { startShell } from "./shell";
+import { VirtualUserManager } from "./users";
+
+/**
+ * SSH server wrapper that exposes virtual shell and exec sessions.
+ *
+ * Create an instance, call {@link SshMimic.start}, and stop it with
+ * {@link SshMimic.stop} when your process exits.
+ */
+class SshMimic {
+	private port: number;
+	private hostname: string;
+	private server: SshServer | null;
+	private vfs: VirtualFileSystem | null = null;
+	private users: VirtualUserManager | null = null;
+	private basePath: string = ".";
+
+	/**
+	 * Creates a new SSH mimic server instance.
+	 *
+	 * @param port TCP port to bind on localhost.
+	 * @param hostname SSH ident hostname suffix and virtual host label.
+	 * @param basePath Optional base path for virtual filesystem (default: current directory).
+	 */
+	constructor({
+		port,
+		hostname = "typescript-vm",
+		basePath = ".",
+	}: {
+		port: number;
+		hostname?: string;
+		basePath?: string;
+	}) {
+		this.port = port;
+		this.hostname = hostname;
+		this.basePath = basePath;
+		this.server = null;
+	}
+
+	/**
+	 * Starts server and initializes virtual filesystem, users, and handlers.
+	 *
+	 * @returns Promise resolved with bound listening port.
+	 */
+	public async start(): Promise<number> {
+		const privateKey = loadOrCreateHostKey();
+		this.vfs = new VirtualFileSystem(this.basePath);
+		await this.vfs.restoreMirror();
+		this.users = new VirtualUserManager(
+			this.vfs,
+			process.env.SSH_MIMIC_ROOT_PASSWORD ?? "root",
+		);
+		await this.users.initialize();
+
+		this.server = new SshServer(
+			{
+				hostKeys: [privateKey],
+				ident: `SSH-2.0-${this.hostname}`,
+			},
+			(client) => {
+				let authUser = "root";
+				let remoteAddress = "unknown";
+				let sessionId: string | null = null;
+
+				client.on("authentication", (ctx) => {
+					if (ctx.method === "password") {
+						const candidateUser = ctx.username || "root";
+						remoteAddress = (ctx as { ip?: string }).ip ?? remoteAddress;
+
+						if (
+							!this.users!.verifyPassword(candidateUser, ctx.password ?? "")
+						) {
+							ctx.reject();
+							return;
+						}
+
+						authUser = candidateUser;
+						sessionId = this.users!.registerSession(authUser, remoteAddress).id;
+
+						const homePath = `/home/${authUser}`;
+						if (!this.vfs!.exists(homePath)) {
+							this.vfs!.mkdir(homePath, 0o755);
+							this.vfs!.writeFile(
+								`${homePath}/README.txt`,
+								`Welcome to ${this.hostname}`,
+							);
+							void this.vfs!.flushMirror();
+						}
+
+						ctx.accept();
+						return;
+					}
+
+					ctx.reject();
+				});
+
+				client.on("close", () => {
+					this.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();
+							startShell(
+								stream,
+								authUser,
+								this.vfs!,
+								this.hostname,
+								this.users!,
+								sessionId,
+								remoteAddress,
+								terminalSize,
+							);
+						});
+
+						session.on("exec", (acceptExec, _rejectExec, info) => {
+							const stream = acceptExec();
+							runExec(
+								stream,
+								info.command.trim(),
+								authUser,
+								this.hostname,
+								this.users!,
+								this.vfs!,
+							);
+						});
+					});
+				});
+			},
+		);
+
+		return new Promise<number>((resolve, reject) => {
+			this.server?.once("error", (err: unknown) => 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.
+	 */
+	public stop(): void {
+		if (this.server) {
+			this.server.close(() => {
+				console.log("SSH Mimic stopped");
+			});
+		}
+	}
+
+	/**
+	 * Returns virtual filesystem instance after server started.
+	 *
+	 * @returns VirtualFileSystem or null when not started.
+	 */
+	public getVfs(): VirtualFileSystem | null {
+		return this.vfs;
+	}
+
+	/**
+	 * Returns user manager instance after server started.
+	 *
+	 * @returns VirtualUserManager or null when not started.
+	 */
+	public getUsers(): VirtualUserManager | null {
+		return this.users;
+	}
+
+	/**
+	 * Returns hostname shown in prompts and idents.
+	 *
+	 * @returns Configured hostname label.
+	 */
+	public getHostname(): string {
+		return this.hostname;
+	}
+}
+
+export { SshMimic };

package/src/SSHMimic/loginFormat.ts

@@ -0,0 +1,10 @@
+export function formatLoginDate(date: Date): string {
+	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/src/SSHMimic/prompt.ts

@@ -0,0 +1,14 @@
+export function buildPrompt(
+	user: string,
+	host: string,
+	cwdName: string,
+): string {
+	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} `;
+}