windscout 0.5.8 → 0.6.1

package/dist/windscribe.js

@@ -1,6 +1,7 @@
 // The Windscribe desktop app, driven through the windscribe-cli it ships with.
-import { spawn } from "node:child_process";
-import { existsSync } from "node:fs";
+import { execFileSync, spawn } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { homedir } from "node:os";
 import { join } from "node:path";
 import { sleep } from "./time.js";
 export const CLI = "windscribe-cli";
@@ -69,6 +70,51 @@ export async function waitForLogin() {
             + `\nDon't have it? ${DOWNLOAD_URL}`);
     return status;
 }
+// The app's settings (Qt's, as Windscribe/Windscribe2): this INI file on Linux, the user's defaults on macOS, the registry on Windows
+export const SETTINGS = join(process.env.XDG_CONFIG_HOME || join(homedir(), ".config"), "Windscribe", "Windscribe2.conf");
+/** A top-level value in the text of the INI file: Qt puts those under [General] */
+export function iniValue(ini, key) {
+    let general = false;
+    for (const line of ini.split(/\r?\n/)) {
+        if (line.startsWith("["))
+            general = line.trim() === "[General]";
+        else if (general && line.startsWith(`${key}=`))
+            return line.slice(key.length + 1);
+    }
+}
+/** The INI file's text with the app logging in with this session when it starts. Settings another account left start over:
+ * the WireGuard keys in them are registered with that account */
+export function withSession(ini, { userId, authHash }) {
+    if (userId && iniValue(ini, "userId") !== userId)
+        ini = "";
+    let general = false;
+    const lines = ini.split("\n").filter((line) => {
+        if (line.startsWith("["))
+            general = line.trim() === "[General]";
+        return !(general && line.startsWith("authHash="));
+    });
+    const at = lines.findIndex((line) => line.trim() === "[General]");
+    lines.splice(at + 1, 0, ...(at < 0 ? ["[General]"] : []), `authHash=${authHash}`);
+    return lines.join("\n");
+}
+/** One of the app's top-level settings on this computer; "" when it isn't there, or doesn't look like an ID or a token */
+function setting(key) {
+    const run = (cmd, args) => execFileSync(cmd, args, { encoding: "utf8", stdio: ["ignore", "pipe", "ignore"], timeout: 10_000 });
+    try {
+        const value = process.platform === "darwin" ? run("defaults", ["read", "com.windscribe.Windscribe2", key])
+            : process.platform === "win32" ? run("reg", ["query", "HKCU\\Software\\Windscribe\\Windscribe2", "/v", key]).match(/REG_SZ\s+(.*)/)?.[1]
+                : iniValue(readFileSync(SETTINGS, "utf8"), key);
+        return value?.trim().match(/^[\w:.+/=-]+$/)?.[0] ?? "";
+    }
+    catch {
+        return ""; // no such setting, or no settings
+    }
+}
+/** The session this computer's app is logged in with; null when its settings don't have one */
+export function session() {
+    const authHash = setting("authHash");
+    return authHash ? { userId: setting("userId"), authHash } : null;
+}
 export const isFirewallOn = (status) => /^Firewall state: On/m.test(status);
 let firewallChanged = false; // blockInternet() turned the firewall on, so restoreFirewall() turns it back off
 /** Turns on the app's firewall, so nothing goes online outside the VPN. False if it was on already (it then stays on) */

package/dist/worker.js

@@ -0,0 +1,75 @@
+// windscout --worker: runs in a parallel scan's docker container (docker.ts), beside the container's own Windscribe app.
+// Takes the host's messages from stdin and answers on stdout, a JSON object per line.
+import { spawn } from "node:child_process";
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname } from "node:path";
+import { createInterface } from "node:readline";
+import { probe } from "./probe.js";
+import { now, sleep } from "./time.js";
+import { SETTINGS, windscribe, withSession } from "./windscribe.js";
+const APP = "/opt/windscribe/Windscribe"; // as the image installs it
+const send = (m) => process.stdout.write(JSON.stringify(m) + "\n");
+export async function worker() {
+    const inbox = [];
+    let wake = () => { }, closed = false, stop = false;
+    createInterface({ input: process.stdin })
+        .on("line", (l) => {
+        const m = JSON.parse(l);
+        if (m.stop)
+            stop = true; // the scan is stopping: give up connecting
+        else
+            inbox.push(m), wake();
+    })
+        .on("close", () => ((closed = true), wake()));
+    /** The host's next message; null once it closed stdin: the scan is over */
+    const next = async () => {
+        while (!inbox.length && !closed)
+            await new Promise((resolve) => (wake = resolve));
+        return inbox.shift() ?? null;
+    };
+    // The app logs in with this computer's session, which goes in its settings before it starts: no login of its own, since
+    // Windscribe locks an account that logs in many times at once. Never log out here: that would end this computer's session too
+    const session = (await next())?.session;
+    if (!session)
+        return;
+    let ini = "";
+    try {
+        ini = readFileSync(SETTINGS, "utf8");
+    }
+    catch { } // a new volume: no settings yet
+    mkdirSync(dirname(SETTINGS), { recursive: true });
+    writeFileSync(SETTINGS, withSession(ini, session));
+    // no systemd in a container: start the app like its unit would, as this user (its CLI refuses root)
+    spawn(APP, { stdio: "ignore" }).on("error", () => { }); // not there: its CLI never answers below
+    // its CLI answers once it's up, and says logged in once Windscribe accepts the session, or the error it got instead
+    let status = "";
+    for (const t = now(); now() - t < 120 && !/Login state: (Logged in|Error)/.test(status = await windscribe("status"));)
+        await sleep(1000);
+    if (!status.includes("Logged in")) {
+        const state = status.match(/^Login state: (.*)$/m)?.[1].trim();
+        return void console.error(state ? `Windscribe's app didn't log in with this computer's session (${state})` : "Windscribe's app didn't start in the container");
+    }
+    send({ ready: true, wireguard: process.env.WS_WIREGUARD !== "0" }); // the image's CMD checked the kernel
+    for (let m; (m = await next());) {
+        if (!m.probe)
+            continue;
+        stop = false;
+        const { query, protocol, timeout, speedTest } = m.probe;
+        const result = await probe(query, protocol, {
+            timeout, speedTest,
+            stopped: () => stop,
+            onStep: (step) => send({ step }),
+            measure: async (fn) => {
+                send({ measure: true });
+                await next(); // go
+                try {
+                    await fn();
+                }
+                finally {
+                    send({ measured: true });
+                }
+            },
+        });
+        send({ result });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windscout",
-  "version": "0.5.8",
+  "version": "0.6.1",
   "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {
@@ -11,7 +11,8 @@
   ],
   "scripts": {
     "build": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\" && tsc && node -e \"fs.chmodSync('dist/cli.js', 0o755)\"",
-    "prepack": "npm run build"
+    "prepack": "npm run build",
+    "test": "npm run build && node --test test/"
   },
   "engines": {
     "node": ">=20"
@@ -32,7 +33,8 @@
     "firewall",
     "unblock",
     "vpn-speed-test",
-    "server-finder"
+    "server-finder",
+    "docker"
   ],
   "author": "Dier Cohen <i.am.dier.cohen@gmail.com>",
   "license": "MIT",