Skip to content

Commit bf7ebe9

Browse files
fix(cli): local servers never bind a port Chromium refuses to load from (heygen-com#6620)
1 parent 310488b commit bf7ebe9

7 files changed

Lines changed: 133 additions & 34 deletions

File tree

‎packages/cli/src/capture/captureProxy.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {
88
openUpstreamTunnel,
99
type UpstreamProxy,
1010
} from "./upstreamProxy.js";
11+
import { listenOnBrowserSafePort } from "@hyperframes/engine";
1112

1213
const CONNECTION_TIMEOUT_MS = 15_000;
1314
const HOP_HEADERS = new Set([
@@ -189,10 +190,7 @@ export async function startCaptureProxy(): Promise<{ url: string; close(): Promi
189190
server.headersTimeout = CONNECTION_TIMEOUT_MS;
190191
server.requestTimeout = 30_000;
191192
server.keepAliveTimeout = 1_000;
192-
await new Promise<void>((resolve, reject) => {
193-
server.once("error", reject);
194-
server.listen(0, "127.0.0.1", resolve);
195-
});
193+
await listenOnBrowserSafePort(server, "127.0.0.1");
196194
const address = server.address();
197195
if (!address || typeof address === "string") throw new Error("Capture proxy did not bind");
198196
let closing: Promise<void> | undefined;

‎packages/cli/src/capture/localPage.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import type { Socket } from "node:net";
1313
import { basename, dirname, extname, isAbsolute, join, relative, resolve, sep } from "node:path";
1414
import { Readable } from "node:stream";
1515
import { fileURLToPath, pathToFileURL } from "node:url";
16+
import { listenOnBrowserSafePort } from "@hyperframes/engine";
1617

1718
export interface LocalCaptureTarget {
1819
/** Real path of the directory the page may read from. */
@@ -165,10 +166,7 @@ export async function startLocalPageServer(target: LocalCaptureTarget): Promise<
165166
sockets.add(socket);
166167
socket.once("close", () => sockets.delete(socket));
167168
});
168-
await new Promise<void>((resolveListen, reject) => {
169-
server.once("error", reject);
170-
server.listen(0, "127.0.0.1", resolveListen);
171-
});
169+
await listenOnBrowserSafePort(server, "127.0.0.1");
172170
const address = server.address();
173171
if (!address || typeof address === "string") throw new Error("Local page server did not bind");
174172
const origin = `http://127.0.0.1:${address.port}`;

‎packages/cli/src/utils/staticProjectServer.ts‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import {
2727
PROXY_VARIANT_CONFIG,
2828
type ProxyVariantRequest,
2929
} from "@hyperframes/studio-server/media-codec-map";
30+
import { listenOnBrowserSafePort } from "@hyperframes/engine";
3031

3132
export interface StaticProjectServer {
3233
url: string;
@@ -343,21 +344,15 @@ export async function serveStaticProjectHtml(
343344
res.end();
344345
});
345346

346-
const port = await new Promise<number>((resolvePort, rejectPort) => {
347-
server.on("error", rejectPort);
348-
// Bind loopback only (SECURITY F-001): a bare listen(0) binds 0.0.0.0/::,
349-
// which an IDE's port auto-forward surfaces as a transient "preview". The
350-
// snapshot browser is co-located (url below is already 127.0.0.1).
351-
server.listen(0, "127.0.0.1", () => {
352-
const addr = server.address();
353-
const resolvedPort = typeof addr === "object" && addr ? addr.port : 0;
354-
if (!resolvedPort) rejectPort(new Error(bindErrorMessage));
355-
else resolvePort(resolvedPort);
347+
// Bind loopback only (SECURITY F-001): a bare listen(0) binds 0.0.0.0/::,
348+
// which an IDE's port auto-forward surfaces as a transient "preview". The
349+
// snapshot browser is co-located (url below is already 127.0.0.1).
350+
const port = await listenOnBrowserSafePort(server, "127.0.0.1")
351+
.then((bound) => bound || Promise.reject(new Error(bindErrorMessage)))
352+
.catch((error: unknown) => {
353+
if (REFUSED_LISTEN.has((error as NodeJS.ErrnoException).code ?? "")) return 0;
354+
throw error;
356355
});
357-
}).catch((error: unknown) => {
358-
if (REFUSED_LISTEN.has((error as NodeJS.ErrnoException).code ?? "")) return 0;
359-
throw error;
360-
});
361356

362357
if (port === 0) {
363358
server.removeAllListeners("error");

‎packages/engine/src/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,12 @@ export {
337337
BROWSER_GPU_NOT_SOFTWARE,
338338
} from "./utils/assertSwiftShader.js";
339339

340+
export {
341+
isBrowserSafePort,
342+
listenOnBrowserSafePort,
343+
settleOnBrowserSafePort,
344+
} from "./utils/browserSafePort.js";
345+
340346
export { readWebGlVendorInfoFromCanvas } from "./utils/readWebGlVendorInfoFromCanvas.js";
341347

342348
export {
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import { EventEmitter } from "node:events";
2+
import { createServer } from "node:net";
3+
import { describe, expect, it } from "vitest";
4+
import { isBrowserSafePort, listenOnBrowserSafePort } from "./browserSafePort.js";
5+
6+
class OfferedPorts extends EventEmitter {
7+
bound = 0;
8+
closed = 0;
9+
constructor(private offers: number[]) {
10+
super();
11+
}
12+
listen(_port: number, _host: string, done: () => void) {
13+
this.bound = this.offers.shift() as number;
14+
queueMicrotask(done);
15+
return this;
16+
}
17+
address() {
18+
return { port: this.bound };
19+
}
20+
close(done: () => void) {
21+
this.closed++;
22+
queueMicrotask(done);
23+
return this;
24+
}
25+
}
26+
27+
describe("listenOnBrowserSafePort", () => {
28+
it("rebinds past a port Chromium blocks", async () => {
29+
const server = new OfferedPorts([4045, 6000, 40000]);
30+
const port = await listenOnBrowserSafePort(server as never, "127.0.0.1");
31+
expect(port).toBe(40000);
32+
expect(server.closed).toBe(2);
33+
});
34+
35+
it("gives up when the OS only offers blocked ports", async () => {
36+
const server = new OfferedPorts(Array(40).fill(4045));
37+
await expect(listenOnBrowserSafePort(server as never, "127.0.0.1")).rejects.toThrow(
38+
/restricted/,
39+
);
40+
});
41+
42+
it("binds a real server on a safe port", async () => {
43+
const server = createServer();
44+
const port = await listenOnBrowserSafePort(server, "127.0.0.1");
45+
expect(isBrowserSafePort(port)).toBe(true);
46+
await new Promise((resolve) => server.close(resolve));
47+
});
48+
});
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import type { AddressInfo, Server } from "node:net";
2+
3+
// Chromium refuses to load from these ports (net::ERR_UNSAFE_PORT); net/base/port_util.cc kRestrictedPorts.
4+
const RESTRICTED_PORTS = new Set([
5+
1, 7, 9, 11, 13, 15, 17, 19, 20, 21, 22, 23, 25, 37, 42, 43, 53, 69, 77, 79, 87, 95, 101, 102,
6+
103, 104, 109, 110, 111, 113, 115, 117, 119, 123, 135, 137, 139, 143, 161, 179, 389, 427, 465,
7+
512, 513, 514, 515, 526, 530, 531, 532, 540, 548, 554, 556, 563, 587, 601, 636, 989, 990, 993,
8+
995, 1719, 1720, 1723, 2049, 3659, 4045, 5060, 5061, 6000, 6566, 6665, 6666, 6667, 6668, 6669,
9+
6697, 10080,
10+
]);
11+
12+
const MAX_ATTEMPTS = 32;
13+
14+
export const isBrowserSafePort = (port: number): boolean => !RESTRICTED_PORTS.has(port);
15+
16+
type Bindable = Pick<Server, "address" | "close" | "listen" | "once" | "off">;
17+
18+
function listenOnce(server: Bindable, host: string): Promise<number> {
19+
return new Promise((resolve, reject) => {
20+
server.once("error", reject);
21+
server.listen(0, host, () => {
22+
server.off("error", reject);
23+
resolve((server.address() as AddressInfo).port);
24+
});
25+
});
26+
}
27+
28+
function closeServer(server: Bindable): Promise<void> {
29+
return new Promise((resolve) => server.close(() => resolve()));
30+
}
31+
32+
/** Rebinds an already-listening server until the OS hands it a port a browser will load from. */
33+
export async function settleOnBrowserSafePort(server: Bindable, host: string): Promise<number> {
34+
let port = (server.address() as AddressInfo).port;
35+
for (let attempt = 1; !isBrowserSafePort(port); attempt++) {
36+
if (attempt >= MAX_ATTEMPTS)
37+
throw new Error(`The OS kept offering browser-restricted ports (last: ${port}).`);
38+
await closeServer(server);
39+
port = await listenOnce(server, host);
40+
}
41+
return port;
42+
}
43+
44+
/** `server.listen(0, host)` that never lands on a port Chromium blocks; resolves to the bound port. */
45+
export async function listenOnBrowserSafePort(server: Bindable, host: string): Promise<number> {
46+
await listenOnce(server, host);
47+
return settleOnBrowserSafePort(server, host);
48+
}

‎packages/producer/src/services/fileServer.ts‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
import { Hono } from "hono";
1212
import { serve } from "@hono/node-server";
13+
import { settleOnBrowserSafePort } from "@hyperframes/engine";
1314
import type { IncomingMessage } from "node:http";
1415
import {
1516
existsSync,
@@ -929,18 +930,23 @@ export function createFileServer(options: FileServerOptions): Promise<FileServer
929930
// it must not listen on 0.0.0.0 where an IDE's port auto-forward surfaces
930931
// it as a transient, breakage-prone "preview".
931932
const server = serve({ fetch: app.fetch, port, hostname: "127.0.0.1" }, (info) => {
932-
resolve({
933-
url: `http://localhost:${info.port}`,
934-
port: info.port,
935-
addPreHeadScript: (script: string) => {
936-
preHeadScripts.push(script);
937-
},
938-
close: () => {
939-
for (const socket of connections) socket.destroy();
940-
connections.clear();
941-
server.close();
942-
},
943-
});
933+
// An OS-picked port (0) must be one Chromium will load from; a caller-chosen one is theirs.
934+
const bound =
935+
port === 0 ? settleOnBrowserSafePort(server, "127.0.0.1") : Promise.resolve(info.port);
936+
bound.then((boundPort) => {
937+
resolve({
938+
url: `http://localhost:${boundPort}`,
939+
port: boundPort,
940+
addPreHeadScript: (script: string) => {
941+
preHeadScripts.push(script);
942+
},
943+
close: () => {
944+
for (const socket of connections) socket.destroy();
945+
connections.clear();
946+
server.close();
947+
},
948+
});
949+
}, reject);
944950
});
945951

946952
server.on("connection", (socket: IncomingMessage["socket"]) => {

0 commit comments

Comments
 (0)