Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

fix(relay): preserve nginx default HTTP listeners

MagicLizia09053b3fcf5
diff --git a/docs/self-hosted-relay-plan.md b/docs/self-hosted-relay-plan.md
index b4fffc3ea5..cc533e37d9 100644
--- a/docs/self-hosted-relay-plan.md
+++ b/docs/self-hosted-relay-plan.md
@@ -561,12 +561,13 @@ App 内不加扫码组件:加一个会改变原生指纹,需要冷更。
- 访问地址已有可信 HTTPS 时沿用原证书管理,中转仅在回环地址提供 HTTP;否则中转在回环地址申请、续期证书,Nginx 转发 HTTP-01 验证并提供公网 HTTPS。
- 自动探测空闲回环端口,代理 REST、WebSocket 与媒体流;按访问地址及域名解析结果匹配实际监听 socket,保留无关 IP、原默认网站与域名证书。常见 ACME webroot 的其他验证文件在中转验证服务返回 404 或掉线时均可回退访问。
- 公网 IP 经 NAT 映射、目标端口尚无同族监听时使用通配地址;不把公网地址直接当作本机网卡地址绑定。原站点跨多个 socket 或同时提供 HTTP 时保留其名字,由前置托管站点接管目标 TLS。
+ - root Nginx 的省略 `listen` 与只写 IPv4/括号 IPv6 地址的配置,统一按默认 80 端口识别并在原站点接入验证,不新增 HTTP 站点抢走原默认页面。
- 两种 Nginx 后端均启用代理模式,Nginx 覆盖客户端来源头;中转仅对回环代理传来的单个合法 IP 按来源限流。API 单独关闭访问与错误日志,并隔离原站点的自定义/递归错误页,避免后端掉线时将签名媒体地址写入原网站日志;原网站的错误页和日志照常保留。
- 配置、备份与导出的证书仅存在服务器的 `/etc/cindy-relay/nginx` 私有目录;`nginx -t` 通过后平滑重载。证书按代写入私有目录,systemd timer 每 5 分钟检查并原子切换引用。
- 验证成功才提交事务;每次配置或服务单元写入前记录前后指纹,失败或任意写入点中断后,重新部署或卸载可恢复未完成事务。恢复检测到管理员并发修改时保留备份并停止,不能覆盖新修改。卸载撤销本次补丁,不停止 Nginx。
- 不支持安全解析的配置(例如没有精确地址的正则站点名、复杂的自定义 ACME 处理器或多个 master)明确失败,不猜测、不覆盖。
- 实现:`packages/device-link-relay/src/nginx.ts`;回归:同目录 `__tests__/nginx.test.ts` 与 Desktop `selfHostedRelayDeploy.test.ts`;真实 Nginx 验证:`pnpm --filter @cindy/device-link-relay run interop:nginx`(Docker 内运行,不访问用户服务器)。
- - 已验证:中转内核 41 例、Desktop 部署与运行时 22 例及两包类型检查通过。真实 Nginx 容器覆盖仅 HTTP、仅 HTTPS、NAT 公网 DNS、具体 IP 监听、域名的隐式默认网站、共享块的其他 IP/HTTP 名字、无关 IP 网站保留、其他 ACME 客户端(含中转掉线)、REST、WebSocket、大于 1 MB 的上传、伪造来源头与限流隔离、正常及后端掉线时的签名地址日志保护、证书轮换、升级回滚、已有 HTTPS 复用和卸载恢复。两轮新增回归分别在修复前复现 8 例、6 例失败,修复后全部通过。测试使用容器内临时证书,生产 CA 签发和真实云服务器部署仍未验证。
+ - 已验证:中转内核 44 例、Desktop 部署与运行时 22 例及两包类型检查通过。真实 Nginx 容器覆盖仅 HTTP、仅 HTTPS、默认 HTTP 监听、NAT 公网 DNS、具体 IP 监听、域名的隐式默认网站、共享块的其他 IP/HTTP 名字、无关 IP 网站保留、其他 ACME 客户端(含中转掉线)、REST、WebSocket、大于 1 MB 的上传、伪造来源头与限流隔离、正常及后端掉线时的签名地址日志保护、证书轮换、升级回滚、已有 HTTPS 复用和卸载恢复。缺陷回归已先复现后修复;默认监听的真实 Nginx 回归复现原站从 200 变为 404,修复后保留原页面。测试使用容器内临时证书,生产 CA 签发和真实云服务器部署仍未验证。
- 服务器上已有不属于这台电脑的中转时停下(`RELAY_MISMATCH`),由用户选择清掉重新部署。
**远程管理**(设置 → 远程连接 → 中转服务):
diff --git a/packages/device-link-relay/scripts/nginx-interop.ts b/packages/device-link-relay/scripts/nginx-interop.ts
index d5bea39e3d..d02ae20682 100644
--- a/packages/device-link-relay/scripts/nginx-interop.ts
+++ b/packages/device-link-relay/scripts/nginx-interop.ts
@@ -104,6 +104,11 @@ async function inside() {
await new Promise<void>((resolve) => { nginx.once('exit', () => resolve()); nginx.kill('SIGQUIT'); });
nginx = startNginx();
};
+ const trackReload = (label: string) => {
+ const master = fs.readFileSync('/tmp/nginx.pid', 'utf8').trim();
+ const oldWorkers = fs.readFileSync(`/proc/${master}/task/${master}/children`, 'utf8').trim().split(/\s+/).filter(Boolean);
+ return () => retry(async () => oldWorkers.every((pid) => !fs.existsSync(`/proc/${pid}`)), Boolean, label);
+ };
await retry(
() => fetch('http://127.0.0.1').then((r) => r.text()),
(value) => value === 'website-home',
@@ -216,11 +221,10 @@ async function inside() {
publicUrl: 'https://127.0.0.1',
trustProxyHeaders: true,
});
- const master = fs.readFileSync('/tmp/nginx.pid', 'utf8').trim();
- const oldWorkers = fs.readFileSync(`/proc/${master}/task/${master}/children`, 'utf8').trim().split(/\s+/).filter(Boolean);
+ const initialReloaded = trackReload('initial TLS workers replaced');
cli('activate');
// 首个新 worker 能响应时,旧 worker 可能尚在退出;后续写请求须等旧证书监听停止接收。
- await retry(async () => oldWorkers.every((pid) => !fs.existsSync(`/proc/${pid}`)), Boolean, 'initial TLS workers replaced');
+ await initialReloaded();
await retry(
() => get('/api/device-link/relay/info'),
(value) => value.status === 200,
@@ -308,7 +312,9 @@ async function inside() {
fs.writeFileSync('/tmp/website-tls/cert.pem', material.cert);
fs.writeFileSync('/tmp/website-tls/key.pem', material.key);
command('nginx', ['-t']);
- process.kill(nginx.pid!, 'SIGHUP');
+ await restartFixture();
+ await retry(() => get('/'), (value) => value.body.toString() === 'website-home', 'existing HTTPS initial website');
+ const existingReloaded = trackReload('existing HTTPS workers replaced');
const existing = prepare(true);
assert.equal(existing.existingCertificate, true);
relay = await startRelayServer({
@@ -320,6 +326,7 @@ async function inside() {
});
cli('activate');
cli('commit');
+ await existingReloaded();
await retry(
() => get('/api/device-link/relay/info'),
(value) => value.status === 200,
@@ -341,11 +348,16 @@ async function inside() {
}
cli('remove');
assert.equal(fs.readFileSync(site, 'utf8'), initialSite);
- const httpOnlySite = initialSite.slice(0, initialSite.indexOf('server { listen 443'));
+ const httpOnlySite = initialSite.slice(0, initialSite.indexOf('server { listen 443'))
+ .replace('listen 80 default_server;', '').replace('server_name website.example.test;', 'server_name _;');
fs.writeFileSync(site, httpOnlySite);
command('nginx', ['-t']);
await restartFixture();
+ await retry(() => fetch('http://127.0.0.1').then((res) => res.text()), (value) => value === 'website-home', 'implicit HTTP initial website');
+ const implicitReloaded = trackReload('implicit HTTP workers replaced');
const httpOnly = prepare();
+ await implicitReloaded();
+ assert.equal(await fetch('http://127.0.0.1').then((res) => res.text()), 'website-home');
relay = await startRelayServer({ dataDir, host: '127.0.0.1', port: httpOnly.port, tls: material, publicUrl: 'https://127.0.0.1' });
cli('activate');
cli('commit');
diff --git a/packages/device-link-relay/src/__tests__/nginx.test.ts b/packages/device-link-relay/src/__tests__/nginx.test.ts
index ff83075c5f..f8d5b46340 100644
--- a/packages/device-link-relay/src/__tests__/nginx.test.ts
+++ b/packages/device-link-relay/src/__tests__/nginx.test.ts
@@ -5,7 +5,7 @@
* - 现有覆盖缺口:Desktop SSH fake 只覆盖调度,未执行远端配置事务。
* - 最小输入:带默认网站的 80/443 配置、同一个块监听两端口/多个 IP、NAT 公网地址、校验失败及中途断开。
* - tier:unit。文件系统/进程为内存适配,独立 CLI 的真实 Nginx 验证另在 Docker 执行。
- * - 实测耗时:见 PR 描述(19 例,2026-10-29)。
+ * - 实测耗时:单独运行本文件 0.398 秒(22 例,2026-10-29)。
*/
import { afterEach, beforeEach, expect, it, vi } from 'vitest';
@@ -303,6 +303,24 @@ it('keeps the implicit TLS default when adding a domain relay', () => {
expect(h.files.get(site)).toBe(implicit);
});
+// PR #7776:Nginx 的省略 listen、只写地址两种语法仍占用 HTTP 80,不能新增站点抢走默认网页。
+it.each([
+ ['', '203.0.113.10'],
+ ['listen 203.0.113.10;', '203.0.113.10'],
+ ['listen [2001:db8::10];', '2001:db8::10'],
+])('preserves the HTTP website with a default listen port (%s)', (listen, resolved) => {
+ const implicit = originalSite.replace('listen 80 default_server;', listen);
+ h.files.set(site, implicit);
+ manageNginx('prepare', { address: 'relay.example.test', resolvedAddresses: [resolved] });
+ expect(h.files.get(site)).toContain('proxy_pass http://127.0.0.1:47822;');
+ expect(h.files.get(`${root}/http.conf`)).not.toContain('proxy_pass http://127.0.0.1:47822;');
+ material('key-one');
+ manageNginx('activate');
+ manageNginx('commit');
+ manageNginx('remove');
+ expect(h.files.get(site)).toBe(implicit);
+});
+
it('uses the matching specific socket and leaves other IP defaults and HTTP sites intact', () => {
const unrelated =
'server { listen 203.0.113.11:80; server_name _; return 200 other-http; }\nserver { listen 203.0.113.11:443 ssl; server_name a.example.test; }\nserver { listen 203.0.113.11:443 ssl default_server; server_name _; }';
diff --git a/packages/device-link-relay/src/nginx.ts b/packages/device-link-relay/src/nginx.ts
index 43123297ec..182a15a82e 100644
--- a/packages/device-link-relay/src/nginx.ts
+++ b/packages/device-link-relay/src/nginx.ts
@@ -151,9 +151,13 @@ function children(nodes: Directive[], files: Map<string, string>, main: string,
}
function listens(node: Directive, port: number, files: Map<string, string>, main: string): boolean {
- return children(node.children ?? [], files, main).some(
- (d) => d.name === 'listen' && (d.args[0] === String(port) || d.args[0]?.endsWith(`:${port}`)) && !d.args.includes('quic'),
- );
+ return serverListeners(node, files, main).some((d) => endpoint(d, port) !== null);
+}
+
+function serverListeners(node: Directive, files: Map<string, string>, main: string): Directive[] {
+ const declared = children(node.children ?? [], files, main).filter((d) => d.name === 'listen');
+ // 本适配器管理 root Nginx;没有 listen 的 server 原本就隐式监听 *:80。
+ return declared.length ? declared : [{ ...node, name: 'listen', args: ['80'] }];
}
interface ListenGroup {
@@ -166,6 +170,11 @@ function endpoint(listen: Directive, port: number): string | null {
if (listen.name !== 'listen' || listen.args.includes('quic')) return null;
const value = listen.args[0];
if (value === String(port) || value === `*:${port}`) return `0.0.0.0:${port}`;
+ if (port === 80) {
+ if (value === '*') return '0.0.0.0:80';
+ if (isIP(value) === 4) return `${value}:80`;
+ if (value?.startsWith('[') && value.endsWith(']') && isIP(value.slice(1, -1)) === 6) return `${value}:80`;
+ }
if (value?.endsWith(`:${port}`) && (value.startsWith('[') || isIP(value.slice(0, value.lastIndexOf(':'))))) return value;
return null;
}
@@ -173,7 +182,7 @@ function endpoint(listen: Directive, port: number): string | null {
function destinations(servers: Directive[], port: number, addresses: string[], files: Map<string, string>, main: string): ListenGroup[] {
const groups = new Map<string, ListenGroup>();
for (const server of servers)
- for (const listen of children(server.children ?? [], files, main)) {
+ for (const listen of serverListeners(server, files, main)) {
const socket = endpoint(listen, port);
if (!socket) continue;
const group = groups.get(socket) ?? { endpoint: socket, entries: [] };