加上 HTTP 接口层和令牌认证

接口分三类:配置读写走保护链路,内核状态和只读透传,静态字段表。
透传用白名单而不是黑名单——写操作属于运行时面板,等做到那步再单独开,
现在不留一个什么都能转发的口子。

令牌即便在只监听本机时也强制校验:同一台机器上跑着容器和别的服务,
「只监听 127.0.0.1」不等于「只有你能访问」。比较用常数时间,避免靠响应耗时猜。

scripts/api-smoke.ts 对着真服务和真内核跑 17 项检查,端到端确认过
改配置之后内核会重载、新端口真的被监听起来。
This commit is contained in:
im0o
2026-08-10 03:37:49 +08:00
parent 71b35d5a24
commit ada547adf7
4 changed files with 316 additions and 0 deletions
+52
View File
@@ -0,0 +1,52 @@
/**
* 访问令牌。
*
* Patchbay 默认只监听 127.0.0.1,远程访问走 SSH 隧道。即便如此仍然要认证——
* 同一台机器上跑着别的服务(比如容器里的进程)时,「只监听本机」并不等于「只有你能访问」。
*
* 令牌可以用环境变量 PATCHBAY_TOKEN 指定;没指定就在首次启动时生成一个,
* 存到配置文件旁边的 .patchbay-token 里,并打印在控制台上。
*/
import { chmod, readFile, writeFile } from 'node:fs/promises'
import { dirname, join } from 'node:path'
import type { Env } from './env.ts'
export async function resolveToken(env: Env): Promise<{ token: string; source: string }> {
const fromEnv = Bun.env.PATCHBAY_TOKEN
if (fromEnv) return { token: fromEnv, source: '环境变量 PATCHBAY_TOKEN' }
const path = join(dirname(env.configPath), '.patchbay-token')
try {
const saved = (await readFile(path, 'utf8')).trim()
if (saved) return { token: saved, source: path }
} catch {
// 文件不存在,往下走去生成一个
}
const token = crypto.randomUUID().replaceAll('-', '')
await writeFile(path, `${token}\n`, 'utf8')
// 令牌等同于密码,不该让同机器上的其他用户读到。Windows 上 chmod 基本无效,失败就算了。
await chmod(path, 0o600).catch(() => {})
return { token, source: `${path}(新生成)` }
}
/**
* 常数时间比较,避免通过响应耗时逐字节猜出令牌。
*
* 长度不同直接返回 false 会泄漏长度,但令牌长度本来就是固定且公开的,无所谓。
*/
export function tokenMatches(expected: string, given: string | null): boolean {
if (!given || given.length !== expected.length) return false
let diff = 0
for (let i = 0; i < expected.length; i += 1) {
diff |= expected.charCodeAt(i) ^ given.charCodeAt(i)
}
return diff === 0
}
/** 从请求里取令牌,支持 Authorization 头和查询参数(后者给 WebSocket 用)。 */
export function tokenFromRequest(req: Request): string | null {
const header = req.headers.get('Authorization')
if (header?.startsWith('Bearer ')) return header.slice(7)
return new URL(req.url).searchParams.get('token')
}
+54
View File
@@ -0,0 +1,54 @@
/**
* 启动入口。
*
* 启动时把该报的问题一次报清楚:环境变量缺没缺、配置文件读不读得到、内核在不在线。
* 配置类工具最糟糕的失败方式是界面能打开、点了保存才发现根本连不上。
*/
import { readEnv } from './env.ts'
import { resolveToken } from './auth.ts'
import { createRouter } from './routes.ts'
import { readConfig } from './config-store.ts'
import { kernelVersion } from './kernel.ts'
const env = readEnv()
const { token, source } = await resolveToken(env)
// 先确认配置文件读得到、解析得动。读不到就没必要往下走了。
try {
const snapshot = await readConfig(env)
const errors = snapshot.diagnostics.filter((d) => d.severity === 'error')
console.log(`配置文件 ${env.configPath}`)
if (errors.length > 0) {
console.log(` 解析出 ${String(errors.length)} 个问题,界面上会标出来:`)
for (const e of errors) console.log(` ${e.path.join('.')}:${e.message}`)
}
} catch (error) {
console.error(`读不到配置文件 ${env.configPath}`)
console.error(String(error))
console.error('检查 .env 里的 PATCHBAY_CONFIG 指对了没有,以及这个进程有没有读权限。')
process.exit(1)
}
const kernel = await kernelVersion(env)
console.log(
kernel.online
? `内核 在线 ${kernel.version ?? ''}(${env.mihomoApi})`
: `内核 连不上 ${env.mihomoApi}——界面仍然能编辑配置,但看不到订阅里的线路,也无法重载`,
)
const handle = createRouter(env, token)
const server = Bun.serve({
hostname: env.host,
port: env.port,
fetch: handle,
})
console.log(`令牌 ${token}`)
console.log(` 来自 ${source}`)
console.log(`Patchbay http://${server.hostname}:${String(server.port)}`)
if (env.host === '127.0.0.1') {
console.log(` 只监听本机。从别的机器访问请开隧道:`)
console.log(` ssh -N -L ${String(env.port)}:127.0.0.1:${String(env.port)} 用户名@这台机器`)
} else {
console.log(` ⚠ 监听在 ${env.host},本机之外也能访问。确认这是你要的。`)
}
+106
View File
@@ -0,0 +1,106 @@
/**
* HTTP 接口。
*
* 分成三类:
* /api/config* 配置文件的读写,走 config-store 那条保护链路
* /api/kernel/* 内核状态,以及对管理接口的只读透传
* /api/meta/* 静态数据,比如入站类型的字段表
*
* 透传只开放 GET。写操作(切换节点、关连接)属于运行时面板的功能,等做到那一步再单独开,
* 现在不留一个「什么都能转发」的口子。
*/
import listenerFields from '../shared/listener-fields.json' with { type: 'json' }
import { applyConfig, listBackups, readConfig, restoreBackup } from './config-store.ts'
import { kernelVersion, proxyGet } from './kernel.ts'
import { tokenFromRequest, tokenMatches } from './auth.ts'
import type { ConfigObject } from '../vendor/config-editor/index.ts'
import type { Env } from './env.ts'
/** 允许透传的管理接口路径。白名单而不是黑名单——多开一个口子要有意为之。 */
const READABLE_KERNEL_PATHS = new Set([
'/version',
'/configs',
'/proxies',
'/providers/proxies',
'/rules',
'/providers/rules',
'/connections',
'/memory',
])
function json(body: unknown, status = 200): Response {
return new Response(JSON.stringify(body), {
status,
headers: { 'Content-Type': 'application/json; charset=utf-8' },
})
}
/** 把落盘失败的结果翻译成 HTTP 响应。状态码按「谁的问题」分。 */
function applyFailureStatus(stage: string): number {
if (stage === 'stale') return 409 // 冲突,客户端该刷新重来
if (stage === 'self-check' || stage === 'kernel-check') return 422 // 内容不合法
return 500 // write / reload:服务端或内核的问题
}
export function createRouter(env: Env, token: string) {
return async function handle(req: Request): Promise<Response> {
const url = new URL(req.url)
const path = url.pathname
if (!path.startsWith('/api/')) return json({ error: '没有这个接口' }, 404)
if (!tokenMatches(token, tokenFromRequest(req))) {
return json({ error: '令牌不对。它在配置文件旁边的 .patchbay-token 里。' }, 401)
}
// ── 配置 ────────────────────────────────────────────
if (path === '/api/config' && req.method === 'GET') {
const snapshot = await readConfig(env)
return json(snapshot)
}
if (path === '/api/config' && req.method === 'PUT') {
const body = (await req.json()) as { data?: ConfigObject; baseRevision?: string }
if (!body.data || typeof body.data !== 'object') {
return json({ error: '请求里没有 data 字段' }, 400)
}
const result = await applyConfig(env, body.data, body.baseRevision)
return result.ok ? json(result) : json(result, applyFailureStatus(result.stage))
}
if (path === '/api/config/backups' && req.method === 'GET') {
return json({ backups: await listBackups(env) })
}
const restoreMatch = /^\/api\/config\/backups\/([^/]+)\/restore$/.exec(path)
if (restoreMatch && req.method === 'POST') {
const name = decodeURIComponent(restoreMatch[1]!)
const result = await restoreBackup(env, name)
return result.ok ? json(result) : json(result, applyFailureStatus(result.stage))
}
// ── 内核 ────────────────────────────────────────────
if (path === '/api/kernel' && req.method === 'GET') {
return json(await kernelVersion(env))
}
if (path.startsWith('/api/kernel/') && req.method === 'GET') {
const target = path.slice('/api/kernel'.length)
if (!READABLE_KERNEL_PATHS.has(target)) {
return json({ error: `不允许透传这个路径:${target}` }, 403)
}
const upstream = await proxyGet(env, target + url.search)
return new Response(upstream.body, {
status: upstream.status,
headers: { 'Content-Type': upstream.headers.get('Content-Type') ?? 'application/json' },
})
}
// ── 静态数据 ────────────────────────────────────────
if (path === '/api/meta/listener-fields' && req.method === 'GET') {
return json(listenerFields)
}
return json({ error: '没有这个接口' }, 404)
}
}