[Init] Initial commit - NetMesh terminal manager

scripts/fetch-et-binaries.cjs

@@ -0,0 +1,349 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+//
+// Download platform-specific EternalTerminal `et` client binaries built by
+// the `build-et-binaries` GitHub Actions workflow into resources/et/, so
+// electron-builder can bundle them via `extraResources`. Designed to be
+// idempotent and safe to skip in dev / CI matrix legs that don't ship et
+// (e.g. when ET_BIN_RELEASE is unset).
+//
+// Usage:
+//   node scripts/fetch-et-binaries.cjs                # all platforms
+//   node scripts/fetch-et-binaries.cjs --platform=darwin --arch=universal
+//   node scripts/fetch-et-binaries.cjs --host --resolve-release
+//
+// Env knobs:
+//   ET_BIN_RELEASE  — release tag in ${ET_BIN_OWNER}/${ET_BIN_REPO}.
+//                     Skip the whole step if unset (printed as a notice so
+//                     the build doesn't silently miss the bundling).
+//   ET_BIN_OWNER    — defaults to the GITHUB_REPOSITORY owner, or 'binaricat'
+//   ET_BIN_REPO     — default 'Netcatty-et-bin' (a dedicated binary
+//                     repository so the client repo stays source-only).
+//   ET_BIN_BASE_URL — full override (e.g. for staging / local mirror).
+//   ET_BIN_RES_DIR  — override output dir for tests.
+//   ET_BIN_ALLOW_UNVERIFIED=true — explicit local escape hatch for mirrors
+//                     without SHA256SUMS. Never use for release builds.
+
+const fs = require("node:fs");
+const path = require("node:path");
+const http = require("node:http");
+const https = require("node:https");
+const os = require("node:os");
+const crypto = require("node:crypto");
+const { execFileSync } = require("node:child_process");
+const { main: resolveEtBinRelease } = require("./resolve-et-bin-release.cjs");
+
+const ROOT = path.resolve(__dirname, "..");
+const DEFAULT_RES_DIR = path.join(ROOT, "resources", "et");
+
+// (file basename in the release -> platform-arch subdir under resources/et/)
+// Using flat names in the release for SHA256SUMS readability, then fanning
+// out into platform-arch subdirs locally. Every target is a tar.gz bundle
+// containing the single `et` (or `et.exe`) client binary. `et` is a pure
+// network-transport client, so — unlike mosh-client — there is no terminfo
+// to bundle.
+const TARGETS = [
+  { platform: "linux", arch: "x64", file: "et-linux-x64.tar.gz", localDir: "linux-x64", extract: "tar.gz" },
+  { platform: "linux", arch: "arm64", file: "et-linux-arm64.tar.gz", localDir: "linux-arm64", extract: "tar.gz" },
+  { platform: "darwin", arch: "universal", file: "et-darwin-universal.tar.gz", localDir: "darwin-universal", extract: "tar.gz" },
+  { platform: "win32", arch: "x64", file: "et-win32-x64.tar.gz", localDir: "win32-x64", extract: "tar.gz" },
+];
+
+function log(msg) { console.log(`[fetch-et-binaries] ${msg}`); }
+function warn(msg) { console.warn(`[fetch-et-binaries] WARN ${msg}`); }
+
+function transferFor(url) {
+  const protocol = new URL(url).protocol;
+  if (protocol === "https:") return https;
+  if (protocol === "http:") return http;
+  throw new Error(`unsupported protocol for ${url}`);
+}
+
+function follow(url, depth = 0) {
+  return new Promise((resolve, reject) => {
+    if (depth > 5) return reject(new Error("too many redirects"));
+    transferFor(url).get(url, (res) => {
+      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+        res.resume();
+        resolve(follow(new URL(res.headers.location, url).toString(), depth + 1));
+        return;
+      }
+      if (res.statusCode !== 200) {
+        res.resume();
+        reject(new Error(`HTTP ${res.statusCode} for ${url}`));
+        return;
+      }
+      const chunks = [];
+      res.on("data", (c) => chunks.push(c));
+      res.on("end", () => resolve(Buffer.concat(chunks)));
+      res.on("error", reject);
+    }).on("error", reject);
+  });
+}
+
+function parseSums(text) {
+  const map = new Map();
+  for (const line of text.split(/\r?\n/)) {
+    const m = line.match(/^([0-9a-f]{64})\s+\*?\s*(\S+)\s*$/i);
+    if (m) map.set(m[2], m[1].toLowerCase());
+  }
+  return map;
+}
+
+async function fetchSums(baseUrl, { allowUnverified = false } = {}) {
+  try {
+    const buf = await follow(`${baseUrl}/SHA256SUMS`);
+    return parseSums(buf.toString("utf8"));
+  } catch (err) {
+    if (allowUnverified) {
+      warn(`could not fetch SHA256SUMS from ${baseUrl} (${err.message})`);
+      return new Map();
+    }
+    throw new Error(`could not fetch SHA256SUMS from ${baseUrl} (${err.message})`);
+  }
+}
+
+function assertSafeTarEntry(entry) {
+  const name = entry.trim();
+  if (!name) throw new Error("tarball contains an empty entry name");
+  if (name.startsWith("/") || name.startsWith("\\") || /^[A-Za-z]:/.test(name)) {
+    throw new Error(`tarball contains an absolute path: ${name}`);
+  }
+  if (name.includes("\\")) {
+    throw new Error(`tarball contains a Windows-style path: ${name}`);
+  }
+  const parts = name.split("/");
+  if (parts.includes("..")) {
+    throw new Error(`tarball contains a parent-directory path: ${name}`);
+  }
+}
+
+function resolveTarArchiveInvocation(archivePath, platform = process.platform) {
+  const pathApi = platform === "win32" ? path.win32 : path;
+  return {
+    cwd: pathApi.dirname(archivePath),
+    archive: pathApi.basename(archivePath),
+  };
+}
+
+function listTarEntries(archivePath) {
+  const { cwd, archive } = resolveTarArchiveInvocation(archivePath);
+  const out = execFileSync("tar", ["-tzf", archive], { cwd, encoding: "utf8" });
+  return out.split(/\r?\n/).filter(Boolean);
+}
+
+function validateTarEntries(entries) {
+  if (entries.length === 0) throw new Error("tarball is empty");
+  for (const entry of entries) assertSafeTarEntry(entry);
+}
+
+function chmodExecutable(filePath) {
+  if (process.platform !== "win32" && fs.existsSync(filePath) && !fs.lstatSync(filePath).isSymbolicLink()) {
+    try { fs.chmodSync(filePath, 0o755); } catch { /* ignore */ }
+  }
+}
+
+function parseEtBinRepository(env) {
+  const githubOwner = (env.GITHUB_REPOSITORY || "").split("/")[0];
+  return {
+    owner: env.ET_BIN_OWNER || githubOwner || "binaricat",
+    repo: env.ET_BIN_REPO || "Netcatty-et-bin",
+  };
+}
+
+function resolveHostTarget(opts = {}) {
+  const platform = opts.platform || process.platform;
+  const arch = opts.arch || process.arch;
+  if (platform === "darwin") return { platform: "darwin", arch: "universal" };
+  if (platform === "linux" && (arch === "x64" || arch === "arm64")) return { platform, arch };
+  if (platform === "win32" && arch === "x64") return { platform, arch };
+  throw new Error(`No bundled et target for ${platform}-${arch}`);
+}
+
+function assertExtractedTreeSafe(root) {
+  const stack = [root];
+  while (stack.length > 0) {
+    const dir = stack.pop();
+    for (const name of fs.readdirSync(dir)) {
+      const file = path.join(dir, name);
+      const stat = fs.lstatSync(file);
+      if (stat.isSymbolicLink()) {
+        throw new Error(`tarball contains a symbolic link: ${path.relative(root, file)}`);
+      }
+      if (stat.isDirectory()) {
+        stack.push(file);
+        continue;
+      }
+      if (!stat.isFile()) {
+        throw new Error(`tarball contains an unsupported file type: ${path.relative(root, file)}`);
+      }
+    }
+  }
+}
+
+function normalizeWindowsBundle(extractDir, target) {
+  const genericExe = path.join(extractDir, "et.exe");
+  const legacyExe = path.join(extractDir, `et-${target.platform}-${target.arch}.exe`);
+  if (!fs.existsSync(genericExe) && fs.existsSync(legacyExe)) {
+    fs.renameSync(legacyExe, genericExe);
+  }
+  if (!fs.existsSync(genericExe) || !fs.lstatSync(genericExe).isFile()) {
+    throw new Error(`${target.file} did not contain et.exe`);
+  }
+  // A statically-linked MSVC build ships no DLLs; the DLL directory is
+  // optional and only present for dynamically-linked builds.
+  chmodExecutable(genericExe);
+}
+
+function normalizePosixBundle(extractDir, target) {
+  const binary = path.join(extractDir, "et");
+  const legacyBinary = path.join(extractDir, `et-${target.platform}-${target.arch}`);
+  if (!fs.existsSync(binary) && fs.existsSync(legacyBinary)) {
+    fs.renameSync(legacyBinary, binary);
+  }
+  if (!fs.existsSync(binary) || !fs.lstatSync(binary).isFile()) {
+    throw new Error(`${target.file} did not contain et`);
+  }
+  chmodExecutable(binary);
+}
+
+function normalizeBundle(extractDir, target) {
+  if (target.platform === "win32") return normalizeWindowsBundle(extractDir, target);
+  return normalizePosixBundle(extractDir, target);
+}
+
+function replaceDir(srcDir, destDir) {
+  fs.rmSync(destDir, { recursive: true, force: true });
+  fs.mkdirSync(path.dirname(destDir), { recursive: true });
+  try {
+    fs.renameSync(srcDir, destDir);
+  } catch (err) {
+    if (!err || err.code !== "EXDEV") throw err;
+    fs.cpSync(srcDir, destDir, { recursive: true });
+    fs.rmSync(srcDir, { recursive: true, force: true });
+  }
+}
+
+function unpackTarGz(buf, target, { resDir }) {
+  const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), "netcatty-et-"));
+  const archive = path.join(tmpRoot, "bundle.tar.gz");
+  const extractDir = path.join(tmpRoot, "extract");
+  const destDir = path.join(resDir, target.localDir);
+  fs.mkdirSync(extractDir, { recursive: true });
+  try {
+    fs.writeFileSync(archive, buf);
+    validateTarEntries(listTarEntries(archive));
+    const archiveInvocation = resolveTarArchiveInvocation(archive);
+    execFileSync("tar", ["-xzf", archiveInvocation.archive, "-C", path.basename(extractDir)], {
+      cwd: archiveInvocation.cwd,
+      stdio: "inherit",
+    });
+    assertExtractedTreeSafe(extractDir);
+    normalizeBundle(extractDir, target);
+    replaceDir(extractDir, destDir);
+  } finally {
+    fs.rmSync(tmpRoot, { recursive: true, force: true });
+  }
+  return destDir;
+}
+
+async function fetchOne(target, sums, opts) {
+  const { baseUrl, resDir, allowUnverified = false } = opts;
+  const url = `${baseUrl}/${target.file}`;
+  let buf;
+  try {
+    buf = await follow(url);
+  } catch (err) {
+    throw new Error(`download failed for ${target.file}: ${err.message}`);
+  }
+
+  const expected = sums.get(target.file);
+  const actual = crypto.createHash("sha256").update(buf).digest("hex");
+  if (expected && expected !== actual) {
+    throw new Error(`SHA256 mismatch for ${target.file}: expected ${expected}, got ${actual}`);
+  }
+  if (!expected) {
+    if (!allowUnverified) {
+      throw new Error(`no SHA256 entry for ${target.file}`);
+    }
+    warn(`no SHA256 entry for ${target.file} - accepting actual ${actual}`);
+  }
+
+  const destDir = unpackTarGz(buf, target, { resDir });
+  log(`unpacked ${target.file} into ${path.relative(ROOT, destDir)}/ (sha256=${actual})`);
+  return true;
+}
+
+async function main(argv = process.argv.slice(2), env = process.env) {
+  const platformArg = (argv.find((a) => a.startsWith("--platform=")) || "").split("=")[1];
+  const archArg = (argv.find((a) => a.startsWith("--arch=")) || "").split("=")[1];
+  let hostTarget = null;
+  if (argv.includes("--host")) {
+    try {
+      hostTarget = resolveHostTarget({ platform: platformArg || process.platform, arch: archArg || process.arch });
+    } catch (err) {
+      warn(`${err.message} - skipping host et fetch.`);
+      return 0;
+    }
+  }
+
+  let release = env.ET_BIN_RELEASE;
+  if (!release && argv.includes("--resolve-release")) {
+    try {
+      release = await resolveEtBinRelease(env);
+    } catch (err) {
+      if (argv.includes("--host")) {
+        warn(`could not resolve an et binary release (${err.message}) - skipping host et fetch.`);
+        return 0;
+      }
+      throw err;
+    }
+  }
+  if (!release) {
+    log("ET_BIN_RELEASE is unset - skipping. Set it (e.g. et-bin-6.2.10-1) to bundle et into the package.");
+    return 0;
+  }
+
+  const { owner, repo } = parseEtBinRepository(env);
+  const baseUrl = env.ET_BIN_BASE_URL ||
+    `https://github.com/${owner}/${repo}/releases/download/${encodeURIComponent(release)}`;
+  const resDir = path.resolve(env.ET_BIN_RES_DIR || DEFAULT_RES_DIR);
+  const allowUnverified = env.ET_BIN_ALLOW_UNVERIFIED === "true";
+  const platformFilter = hostTarget?.platform || platformArg;
+  const archFilter = hostTarget?.arch || archArg;
+
+  log(`release=${release} owner=${owner} repo=${repo}`);
+  const sums = await fetchSums(baseUrl, { allowUnverified });
+  let ok = 0;
+  let total = 0;
+  for (const target of TARGETS) {
+    if (platformFilter && target.platform !== platformFilter) continue;
+    if (archFilter && target.arch !== archFilter) continue;
+    total += 1;
+    if (await fetchOne(target, sums, { baseUrl, resDir, allowUnverified })) ok += 1;
+  }
+  log(`done - ${ok}/${total} binaries written`);
+  if (ok < total) throw new Error(`only wrote ${ok}/${total} requested binaries`);
+  return 0;
+}
+
+if (require.main === module) {
+  main().catch((err) => {
+    console.error(`[fetch-et-binaries] FATAL ${err.message}`);
+    process.exit(1);
+  });
+}
+
+module.exports = {
+  TARGETS,
+  parseEtBinRepository,
+  replaceDir,
+  resolveHostTarget,
+  resolveTarArchiveInvocation,
+  parseSums,
+  validateTarEntries,
+  assertExtractedTreeSafe,
+  unpackTarGz,
+  normalizeBundle,
+  main,
+};