coderemote 0.1.0 → 0.1.2

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/Tranthanh98/vscoderemote/main/apps/ios/Design/AppIcon/Icon-Default-1024x1024@1x.png" width="96" height="96" alt="Code Remote icon">
+  <img src="https://raw.githubusercontent.com/Tranthanh98/coderemote/main/apps/ios/Design/AppIcon/Icon-Default-1024x1024@1x.png" width="96" height="96" alt="Code Remote icon">
 </p>
 
 <h1 align="center">coderemote</h1>
@@ -12,7 +12,7 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/coderemote"><img src="https://img.shields.io/npm/v/coderemote" alt="npm version"></a>
-  <a href="https://github.com/Tranthanh98/vscoderemote/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/coderemote" alt="license: AGPL-3.0-or-later"></a>
+  <a href="https://github.com/Tranthanh98/coderemote/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/coderemote" alt="license: AGPL-3.0-or-later"></a>
   <img src="https://img.shields.io/node/v/coderemote" alt="node version">
 </p>
 
@@ -33,21 +33,20 @@ in your pocket:
 
 ```sh
 npm install -g coderemote
-brew install --cask devtunnel     # Microsoft Dev Tunnels CLI (Linux: see below)
-devtunnel user login -g           # once, sign in with GitHub (-d for a Microsoft account)
-
-cd ~/projects/my-app
-coderemote up
+cd ~/projects/my-app && coderemote up
 ```
 
-`coderemote up` prints a QR code. Scan it with the iPhone Camera (or the **+** button in the
-app) to pair. Done.
+Scan the QR code it prints with your iPhone Camera (or the **+** button in the app). Done.
+
+The first run sets itself up: it downloads Microsoft's Dev Tunnels CLI (once, verified) and
+opens your browser to sign in with GitHub. Prefer a Microsoft account? Run
+`coderemote login --microsoft` first.
 
 ## How it works
 
-```
-iPhone app ──HTTPS / WSS──► Microsoft Dev Tunnels relay ◄── coderemote (your computer)
-```
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Tranthanh98/coderemote/main/docs/images/how-it-works.png" width="760" alt="How it works: the Code Remote app on the iPhone connects over HTTPS/WSS to the Microsoft Dev Tunnels relay; coderemote on your computer (127.0.0.1:31580) connects outbound to the same relay and serves files, git and terminals from the shared folder. Security at each hop: token in the iPhone Keychain, only your account through the relay, token check and one folder on the computer.">
+</p>
 
 `coderemote` starts a small agent that listens on `127.0.0.1` only, and publishes it through
 a [Microsoft Dev Tunnel](https://learn.microsoft.com/azure/developer/dev-tunnels/overview).
@@ -70,7 +69,7 @@ Remote shell access is serious, so access is locked down by default:
 
 `coderemote up --allow-anonymous` skips the account sign-in when you want the pairing token
 alone. Found a vulnerability? See the
-[security policy](https://github.com/Tranthanh98/vscoderemote/blob/main/SECURITY.md).
+[security policy](https://github.com/Tranthanh98/coderemote/blob/main/SECURITY.md).
 
 ## Commands
 
@@ -83,6 +82,7 @@ coderemote kill --all            # end every session
 coderemote stop                  # stop the agent for this folder (--all: every agent)
 coderemote serve                 # share on 127.0.0.1 only, no tunnel (local testing)
 coderemote rotate-token          # revoke every paired device
+coderemote login                 # sign in again (--microsoft, or --device-code without a browser)
 coderemote help                  # all options
 ```
 
@@ -92,15 +92,14 @@ Options: `--root DIR` shares another folder; `--port N` picks the local port (de
 ## Requirements
 
 - **Node.js 20** or newer on **macOS** (Linux is expected to work but not yet tested)
-- The **devtunnel CLI**:
-  - macOS: `brew install --cask devtunnel`
-  - Linux: `curl -sL https://aka.ms/DevTunnelCliInstall | bash`
-  - more options in [Microsoft's guide](https://learn.microsoft.com/azure/developer/dev-tunnels/get-started)
-- A GitHub or Microsoft account for `devtunnel user login`
-- On Linux, `node-pty` compiles on install: have `python3`, `make` and a C++ compiler
-  (`build-essential` on Debian/Ubuntu)
+- A **GitHub or Microsoft account** to sign in to Dev Tunnels
+- The **Dev Tunnels CLI** is downloaded on first run into `~/.coderemote/bin` (the macOS build
+  must carry Microsoft's code signature). A `devtunnel` already on your `PATH` is used instead,
+  or point `CODEREMOTE_DEVTUNNEL` at one.
+- On Linux, `node-pty` compiles on install (`python3`, `make`, a C++ compiler:
+  `build-essential` on Debian/Ubuntu), and signing in needs `libsecret` (`libsecret-1-0`)
 - The **Code Remote** iOS app on your iPhone (App Store release coming; meanwhile build it
-  from [source](https://github.com/Tranthanh98/vscoderemote#build-the-ios-app))
+  from [source](https://github.com/Tranthanh98/coderemote#build-the-ios-app))
 
 ## FAQ
 
@@ -121,6 +120,6 @@ repository inside it.
 
 ## License
 
-[AGPL-3.0-or-later](https://github.com/Tranthanh98/vscoderemote/blob/main/LICENSE).
+[AGPL-3.0-or-later](https://github.com/Tranthanh98/coderemote/blob/main/LICENSE).
 "Code Remote" and its icon are trademarks of the project; see
-[TRADEMARKS.md](https://github.com/Tranthanh98/vscoderemote/blob/main/TRADEMARKS.md).
+[TRADEMARKS.md](https://github.com/Tranthanh98/coderemote/blob/main/TRADEMARKS.md).

package/dist/coderemote.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
 // bin/coderemote.js
-import { execFile as execFile2, spawn } from "node:child_process";
+import { execFile as execFile3, spawn } from "node:child_process";
 import { randomBytes } from "node:crypto";
-import fs5 from "node:fs";
+import fs6 from "node:fs";
 import os3 from "node:os";
-import path5 from "node:path";
-import { promisify } from "node:util";
+import path6 from "node:path";
+import { promisify as promisify2 } from "node:util";
 import qrcode from "qrcode-terminal";
 
 // ../../packages/agent-core/src/server.js
@@ -713,20 +713,129 @@ function createAgentServer({ token, root: root2, tunnelToken = async () => null
   return server;
 }
 
-// src/registry.js
+// src/devtunnel.js
+import { execFile as execFile2 } from "node:child_process";
+import { createHash } from "node:crypto";
 import fs4 from "node:fs";
 import path4 from "node:path";
+import { promisify } from "node:util";
+var run = promisify(execFile2);
+var DOWNLOAD_BASE = "https://tunnelsassetsprod.blob.core.windows.net/cli";
+var BUILDS = {
+  "darwin-arm64": "osx-arm64-devtunnel",
+  "darwin-x64": "osx-x64-devtunnel",
+  "linux-arm64": "linux-arm64-devtunnel",
+  "linux-x64": "linux-x64-devtunnel"
+};
+var MICROSOFT_TEAM_ID = "UBF8T346G9";
+var REFRESH_INTERVAL_MS = 24 * 36e5;
+function executable(file) {
+  try {
+    fs4.accessSync(file, fs4.constants.X_OK);
+    return fs4.statSync(file).isFile();
+  } catch {
+    return false;
+  }
+}
+function onPath(name) {
+  for (const dir of (process.env.PATH || "").split(path4.delimiter)) {
+    if (dir && executable(path4.join(dir, name))) return path4.join(dir, name);
+  }
+  return null;
+}
+async function ensureDevtunnel({ dir, progress }) {
+  const override = process.env.CODEREMOTE_DEVTUNNEL;
+  if (override) {
+    if (executable(override)) return override;
+    throw new Error(`CODEREMOTE_DEVTUNNEL=${override} isn't an executable file.`);
+  }
+  const fromPath = onPath("devtunnel");
+  if (fromPath) return fromPath;
+  const build = BUILDS[`${process.platform}-${process.arch}`];
+  if (!build) {
+    throw new Error(
+      `No devtunnel build for ${process.platform}-${process.arch}. Install it yourself: https://learn.microsoft.com/azure/developer/dev-tunnels/get-started`
+    );
+  }
+  const bin = path4.join(dir, "devtunnel");
+  const metaFile = path4.join(dir, "devtunnel.json");
+  let meta = {};
+  try {
+    meta = JSON.parse(fs4.readFileSync(metaFile, "utf8"));
+  } catch {
+  }
+  const installed = executable(bin);
+  if (installed && Date.now() - (meta.checkedAt ?? 0) < REFRESH_INTERVAL_MS) return bin;
+  const url = `${DOWNLOAD_BASE}/${build}`;
+  if (installed) {
+    try {
+      const head = await fetch(url, { method: "HEAD", signal: AbortSignal.timeout(3e3) });
+      const lastModified = head.headers.get("last-modified");
+      if (head.ok && lastModified && lastModified === meta.lastModified) {
+        fs4.writeFileSync(metaFile, JSON.stringify({ ...meta, checkedAt: Date.now() }));
+        return bin;
+      }
+    } catch {
+      return bin;
+    }
+  }
+  await download(url, bin, metaFile, progress);
+  return bin;
+}
+async function download(url, bin, metaFile, progress) {
+  fs4.mkdirSync(path4.dirname(bin), { recursive: true, mode: 448 });
+  const res = await fetch(url, { signal: AbortSignal.timeout(12e4) });
+  if (!res.ok || !res.body) throw new Error(`Downloading devtunnel failed: HTTP ${res.status} from ${url}`);
+  const total = Number(res.headers.get("content-length")) || 0;
+  const tmp = `${bin}.${process.pid}.download`;
+  const out = fs4.createWriteStream(tmp, { mode: 493 });
+  const md5 = createHash("md5");
+  let received = 0;
+  try {
+    for await (const chunk of res.body) {
+      md5.update(chunk);
+      received += chunk.length;
+      if (!out.write(chunk)) await new Promise((r) => out.once("drain", r));
+      if (total) progress(`${Math.floor(received / total * 100)}%`);
+    }
+    await new Promise((resolve, reject) => out.end((e) => e ? reject(e) : resolve()));
+    if (total && received !== total) throw new Error(`devtunnel download was cut short (${received} of ${total} bytes)`);
+    await verify(tmp, md5.digest("base64"), res.headers.get("content-md5"));
+    fs4.chmodSync(tmp, 493);
+    fs4.renameSync(tmp, bin);
+  } catch (e) {
+    out.destroy();
+    fs4.rmSync(tmp, { force: true });
+    throw e;
+  }
+  fs4.writeFileSync(metaFile, JSON.stringify({ lastModified: res.headers.get("last-modified"), checkedAt: Date.now() }));
+}
+async function verify(file, md5, expectedMd5) {
+  if (expectedMd5 && md5 !== expectedMd5) throw new Error("devtunnel download is corrupt (MD5 mismatch)");
+  if (process.platform !== "darwin") return;
+  try {
+    await run("codesign", ["--verify", "--strict", file]);
+    const { stderr } = await run("codesign", ["-dv", file]);
+    if (!stderr.includes(`TeamIdentifier=${MICROSOFT_TEAM_ID}`)) throw new Error("not signed by Microsoft");
+  } catch (e) {
+    throw new Error(`devtunnel download failed its signature check: ${e.message}`);
+  }
+}
+
+// src/registry.js
+import fs5 from "node:fs";
+import path5 from "node:path";
 var AgentRegistry = class {
   constructor(dir) {
     this.dir = dir;
   }
   register({ port: port2, root: root2, url }) {
-    fs4.mkdirSync(this.dir, { recursive: true, mode: 448 });
+    fs5.mkdirSync(this.dir, { recursive: true, mode: 448 });
     const file = this.#file(port2);
-    fs4.writeFileSync(file, JSON.stringify({ pid: process.pid, port: port2, root: root2, url, startedAt: Date.now() }), { mode: 384 });
+    fs5.writeFileSync(file, JSON.stringify({ pid: process.pid, port: port2, root: root2, url, startedAt: Date.now() }), { mode: 384 });
     const cleanup = () => {
       try {
-        if (JSON.parse(fs4.readFileSync(file, "utf8")).pid === process.pid) fs4.rmSync(file);
+        if (JSON.parse(fs5.readFileSync(file, "utf8")).pid === process.pid) fs5.rmSync(file);
       } catch {
       }
     };
@@ -737,25 +846,25 @@ var AgentRegistry = class {
   list() {
     let names = [];
     try {
-      names = fs4.readdirSync(this.dir).filter((n) => n.endsWith(".json"));
+      names = fs5.readdirSync(this.dir).filter((n) => n.endsWith(".json"));
     } catch {
       return [];
     }
     const agents = [];
     for (const name of names) {
-      const file = path4.join(this.dir, name);
+      const file = path5.join(this.dir, name);
       try {
-        const agent = JSON.parse(fs4.readFileSync(file, "utf8"));
+        const agent = JSON.parse(fs5.readFileSync(file, "utf8"));
         process.kill(agent.pid, 0);
         agents.push(agent);
       } catch {
-        fs4.rmSync(file, { force: true });
+        fs5.rmSync(file, { force: true });
       }
     }
     return agents.sort((a, b) => a.port - b.port);
   }
   #file(port2) {
-    return path4.join(this.dir, `${port2}.json`);
+    return path5.join(this.dir, `${port2}.json`);
   }
 };
 
@@ -775,6 +884,7 @@ var Spinner = class {
   start(text) {
     this.stop();
     this.text = text;
+    this.detail = "";
     this.startedAt = Date.now();
     if (!this.tty) {
       this.stream.write(`  ${text}...
@@ -791,6 +901,10 @@ var Spinner = class {
     this.render(FRAMES[0]);
     this.timer = setInterval(() => this.render(FRAMES[++frame % FRAMES.length]), 80);
   }
+  /** Extra status shown after the step's text while it runs, e.g. a download percentage. */
+  update(detail) {
+    this.detail = detail;
+  }
   succeed() {
     this.finish(green("\u2714"));
   }
@@ -807,7 +921,8 @@ var Spinner = class {
     this.text = null;
   }
   render(frame) {
-    this.stream.write(`\r\x1B[2K  ${cyan(frame)} ${this.text} ${dim(this.elapsed())}`);
+    const detail = this.detail ? ` ${this.detail}` : "";
+    this.stream.write(`\r\x1B[2K  ${cyan(frame)} ${this.text}${detail} ${dim(this.elapsed())}`);
   }
   finish(mark) {
     if (!this.text) return;
@@ -823,17 +938,17 @@ var Spinner = class {
 };
 
 // bin/coderemote.js
-var run = promisify(execFile2);
-var CONFIG_DIR = path5.join(os3.homedir(), ".coderemote");
-var LEGACY_CONFIG_DIR = path5.join(os3.homedir(), ".vsremote");
-if (!fs5.existsSync(CONFIG_DIR) && fs5.existsSync(LEGACY_CONFIG_DIR)) fs5.renameSync(LEGACY_CONFIG_DIR, CONFIG_DIR);
-var CONFIG_FILE = path5.join(CONFIG_DIR, "config.json");
+var run2 = promisify2(execFile3);
+var CONFIG_DIR = path6.join(os3.homedir(), ".coderemote");
+var LEGACY_CONFIG_DIR = path6.join(os3.homedir(), ".vsremote");
+if (!fs6.existsSync(CONFIG_DIR) && fs6.existsSync(LEGACY_CONFIG_DIR)) fs6.renameSync(LEGACY_CONFIG_DIR, CONFIG_DIR);
+var CONFIG_FILE = path6.join(CONFIG_DIR, "config.json");
 var DEFAULT_PORT = 31580;
 var spinner = new Spinner();
 function loadConfig() {
   let cfg2 = {};
   try {
-    cfg2 = JSON.parse(fs5.readFileSync(CONFIG_FILE, "utf8"));
+    cfg2 = JSON.parse(fs6.readFileSync(CONFIG_FILE, "utf8"));
   } catch {
   }
   if (!cfg2.token) {
@@ -843,8 +958,8 @@ function loadConfig() {
   return cfg2;
 }
 function saveConfig(cfg2) {
-  fs5.mkdirSync(CONFIG_DIR, { recursive: true, mode: 448 });
-  fs5.writeFileSync(CONFIG_FILE, JSON.stringify(cfg2, null, 2), { mode: 384 });
+  fs6.mkdirSync(CONFIG_DIR, { recursive: true, mode: 448 });
+  fs6.writeFileSync(CONFIG_FILE, JSON.stringify(cfg2, null, 2), { mode: 384 });
 }
 function listen(token, port2, root2, tunnelToken) {
   const server = createAgentServer({ token, root: root2, tunnelToken });
@@ -853,33 +968,51 @@ function listen(token, port2, root2, tunnelToken) {
     server.listen(port2, "127.0.0.1", () => resolve(server));
   });
 }
+var DEVTUNNEL = "devtunnel";
+async function resolveDevtunnel() {
+  let installing = false;
+  DEVTUNNEL = await ensureDevtunnel({
+    dir: path6.join(CONFIG_DIR, "bin"),
+    progress: (detail) => {
+      if (!installing) {
+        installing = true;
+        spinner.start("Installing devtunnel (Microsoft Dev Tunnels CLI, one time)");
+      }
+      spinner.update(detail);
+    }
+  });
+  if (installing) spinner.succeed();
+}
 async function devtunnel(...args) {
   try {
-    const { stdout } = await run("devtunnel", args);
+    const { stdout } = await run2(DEVTUNNEL, args);
     return { ok: true, out: stdout };
   } catch (e) {
-    if (e.code === "ENOENT") {
-      spinner.stop();
-      console.error("devtunnel CLI not found. Install it: brew install --cask devtunnel");
-      process.exit(1);
-    }
-    return { ok: false, out: `${e.stdout || ""}${e.stderr || ""}` };
+    return { ok: false, out: `${e.stdout || ""}${e.stderr || ""}` || e.message };
   }
 }
+function loginArgs(opts = rest) {
+  const args = ["user", "login"];
+  if (!opts.includes("--microsoft")) args.push("-g");
+  if (opts.includes("--device-code")) args.push("-d");
+  return args;
+}
+function interactiveLogin(args) {
+  return new Promise((resolve) => {
+    spawn(DEVTUNNEL, args, { stdio: "inherit" }).on("exit", resolve);
+  });
+}
 var LOGIN_NEEDED = /not logged in|login token expired|login required|please log ?in/i;
 async function login(reason) {
   spinner.stop();
   console.error(`Dev tunnels: ${reason.trim()}`);
   if (!process.stdin.isTTY) {
-    console.error("Run: devtunnel user login -g   (or -d for a Microsoft account), then try again.");
+    console.error("Run `coderemote login` (--microsoft for a Microsoft account), then try again.");
     process.exit(1);
   }
-  console.error("Signing in again with GitHub (devtunnel user login -g)...\n");
-  const code = await new Promise((resolve) => {
-    spawn("devtunnel", ["user", "login", "-g"], { stdio: "inherit" }).on("exit", resolve);
-  });
-  if (code !== 0) {
-    console.error("\nLogin failed. Run `devtunnel user login -g` (or -d) yourself, then try again.");
+  console.error("Signing in with GitHub (use `coderemote login --microsoft` for a Microsoft account)...\n");
+  if (await interactiveLogin(loginArgs([])) !== 0) {
+    console.error("\nLogin failed. Run `coderemote login` (--microsoft, --device-code), then try again.");
     process.exit(1);
   }
 }
@@ -935,7 +1068,7 @@ ${res.out}`);
 }
 function hostTunnel(tunnelId, port2) {
   return new Promise((resolve, reject) => {
-    const child = spawn("devtunnel", ["host", tunnelId], { stdio: ["ignore", "pipe", "pipe"] });
+    const child = spawn(DEVTUNNEL, ["host", tunnelId], { stdio: ["ignore", "pipe", "pipe"] });
     let log2 = "";
     const onData = (d) => {
       log2 += d;
@@ -971,6 +1104,8 @@ var USAGE = `Usage: coderemote <command> [options]
   kill <id>... | --all kill terminal sessions (an id prefix is enough)
   stop [--all]         stop the agent for this folder (or every agent)
   rotate-token         revoke every paired device
+  login                sign in to Microsoft Dev Tunnels with GitHub (up does this when needed);
+                       --microsoft for a Microsoft account, --device-code without a browser
 
 Options:
   --root DIR           folder to share (default: current folder)
@@ -986,9 +1121,9 @@ var flag = (name) => {
 };
 var anonymous = rest.includes("--allow-anonymous") || rest.includes("--no-auth");
 var port = flag("--port") ? parseInt(flag("--port"), 10) : DEFAULT_PORT;
-var root = path5.resolve(flag("--root") ?? process.cwd());
+var root = path6.resolve(flag("--root") ?? process.cwd());
 var cfg = loadConfig();
-var registry = new AgentRegistry(path5.join(CONFIG_DIR, "agents"));
+var registry = new AgentRegistry(path6.join(CONFIG_DIR, "agents"));
 async function start({ tunnel }) {
   const running = registry.list().find((a) => a.port === port);
   if (running) {
@@ -1015,6 +1150,7 @@ async function start({ tunnel }) {
   let url = `http://127.0.0.1:${port}`;
   if (tunnel) {
     spinner.succeed();
+    await resolveDevtunnel();
     spinner.start("Checking dev tunnels sign-in");
     const user = await tunnelUser();
     spinner.succeed();
@@ -1042,6 +1178,8 @@ async function start({ tunnel }) {
   };
   process.on("SIGINT", shutdown);
   process.on("SIGTERM", shutdown);
+  process.on("SIGHUP", shutdown);
+  process.on("exit", () => child?.kill());
   return { url, access };
 }
 async function agentApi(agent, method, route, query = {}) {
@@ -1151,6 +1289,10 @@ Token: ${cfg.token}`);
     console.log("Token rotated. Re-pair your devices, and restart running agents.");
     break;
   }
+  case "login": {
+    await resolveDevtunnel();
+    process.exit(await interactiveLogin(loginArgs()));
+  }
   case "help":
     console.log(USAGE);
     break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coderemote",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Use your computer from your iPhone: files, git and a real terminal over a secure Microsoft Dev Tunnel. No SSH, no port forwarding, no VPN.",
   "keywords": [
     "remote",
@@ -21,13 +21,13 @@
     "vscode",
     "code-remote"
   ],
-  "homepage": "https://github.com/Tranthanh98/vscoderemote#readme",
+  "homepage": "https://github.com/Tranthanh98/coderemote#readme",
   "bugs": {
-    "url": "https://github.com/Tranthanh98/vscoderemote/issues"
+    "url": "https://github.com/Tranthanh98/coderemote/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Tranthanh98/vscoderemote.git",
+    "url": "git+https://github.com/Tranthanh98/coderemote.git",
     "directory": "apps/agent"
   },
   "license": "AGPL-3.0-or-later",