@twinsearth/dsh-2xray 0.0.0-stage → 0.1.1

package/examples/config.downgrade.json

@@ -0,0 +1,20 @@
+{
+  "enabled": true,
+  "server": {
+    "address": "example.com",
+    "port": 443,
+    "uuid": "11111111-2222-4333-8444-555555555555",
+    "flow": "",
+    "serverName": "",
+    "network": "tcp",
+    "security": "none"
+  },
+  "inbound": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 20808
+  },
+  "functionalProbe": {
+    "enabled": false
+  }
+}

package/examples/config.example.json

@@ -0,0 +1,22 @@
+{
+  "enabled": true,
+  "server": {
+    "address": "example.com",
+    "port": 443,
+    "uuid": "00000000-0000-0000-0000-000000000000",
+    "flow": "xtls-rprx-vision",
+    "serverName": "www.example.com",
+    "password": "REPLACE_WITH_43_CHAR_BASE64URL_X25519_PUBLIC_KEY",
+    "shortId": "",
+    "fingerprint": "chrome",
+    "spiderX": "/",
+    "network": "raw",
+    "security": "reality"
+  },
+  "inbound": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 20808
+  },
+  "takeover": "auto"
+}

package/examples/config.multi.downgrade.json

@@ -0,0 +1,39 @@
+{
+  "enabled": true,
+  "nodes": [
+    {
+      "id": "hk-01",
+      "address": "hk.example.com",
+      "port": 443,
+      "uuid": "11111111-2222-4333-8444-555555555555",
+      "flow": "",
+      "network": "tcp",
+      "security": "none"
+    },
+    {
+      "id": "jp-01",
+      "address": "jp.example.com",
+      "port": 443,
+      "uuid": "11111111-2222-4333-8444-555555555555",
+      "flow": "",
+      "network": "tcp",
+      "security": "none"
+    }
+  ],
+  "activeNode": "hk-01",
+  "inbound": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 20808
+  },
+  "control": {
+    "enabled": true,
+    "host": "127.0.0.1",
+    "port": 10085,
+    "stats": true
+  },
+  "functionalProbe": {
+    "enabled": false
+  },
+  "takeover": "off"
+}

package/examples/config.multi.json

@@ -0,0 +1,46 @@
+{
+  "enabled": true,
+  "nodes": [
+    {
+      "id": "hk-01",
+      "address": "hk.example.com",
+      "port": 443,
+      "uuid": "11111111-2222-4333-8444-555555555555",
+      "flow": "xtls-rprx-vision",
+      "serverName": "www.example.com",
+      "password": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+      "shortId": "ab12",
+      "fingerprint": "chrome",
+      "spiderX": "/",
+      "network": "raw",
+      "security": "reality"
+    },
+    {
+      "id": "jp-01",
+      "address": "jp.example.com",
+      "port": 443,
+      "uuid": "11111111-2222-4333-8444-555555555555",
+      "flow": "xtls-rprx-vision",
+      "serverName": "www.example.com",
+      "password": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+      "shortId": "ab12",
+      "fingerprint": "chrome",
+      "spiderX": "/",
+      "network": "raw",
+      "security": "reality"
+    }
+  ],
+  "activeNode": "hk-01",
+  "inbound": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 20808
+  },
+  "control": {
+    "enabled": true,
+    "host": "127.0.0.1",
+    "port": 10085,
+    "stats": true
+  },
+  "takeover": "auto"
+}

package/icon.svg

@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64" role="img" aria-label="Xray Proxy">
+  <rect width="64" height="64" rx="14" fill="#0f172a"/>
+  <circle cx="20" cy="32" r="7" fill="none" stroke="#38bdf8" stroke-width="3"/>
+  <circle cx="44" cy="32" r="7" fill="none" stroke="#a78bfa" stroke-width="3"/>
+  <path d="M27 32h10" stroke="#e2e8f0" stroke-width="3" stroke-linecap="round"/>
+  <path d="M43 32l-6-4v8l6-4z" fill="#e2e8f0"/>
+  <path d="M20 25v-7M20 46v-7" stroke="#38bdf8" stroke-width="2.5" stroke-linecap="round"/>
+  <path d="M44 25v-7M44 46v-7" stroke="#a78bfa" stroke-width="2.5" stroke-linecap="round"/>
+</svg>

package/index.js

@@ -0,0 +1,89 @@
+import { normalizeConfig } from './lib/config.js'
+import { createLazyLauncher } from './lib/process.js'
+import { RouteManager } from './lib/route.js'
+import { Supervisor } from './lib/supervisor.js'
+import { createLogger } from './lib/log.js'
+import { resolveDataDir } from './lib/paths.js'
+import { ControlClient } from './lib/control/client.js'
+import { installTools } from './lib/tools.js'
+
+export const name = 'dsh-2xray'
+
+/**
+ * Host half of dsh-2xray: it supervises one xray-core child process and
+ * points the harness' process-global proxy policy at the local inbound.
+ *
+ * The entry point never throws for a bad configuration, a missing binary, or
+ * an unreachable upstream: those become a `failed(...)` state with a reason
+ * chain in the log and `status.json`. That keeps the patch row active, so the
+ * user can fix the config instead of losing the plugin entirely.
+ *
+ * `apply` returns the cleanup registered through `ctx.effect`. Cordis has no
+ * `ctx.on('dispose')` event (checked against 0.2.1-rc.3): `ctx.effect` and the
+ * disposer returned from `apply` are the lifecycle seam.
+ */
+export function apply(ctx, rawConfig) {
+  const logger = createLogger(ctx)
+  const { config, errors, warnings } = normalizeConfig(rawConfig)
+
+  for (const warning of warnings) logger.warn(`配置警告：${warning}`)
+
+  let dataDir
+  try {
+    dataDir = resolveDataDir(config)
+  } catch (error) {
+    errors.push({ field: 'binary.dataDir', message: `无法创建数据目录：${String(error)}` })
+  }
+
+  if (config.enabled && !errors.length) {
+    logger.info(
+      `启动 xray：nodes=${config.nodes.length} active=${config.activeNode} ` +
+        `flow=${config.nodes[0].flow || '(none)'} inbound=${config.inbound.protocol}://${config.inbound.host}:${config.inbound.port} ` +
+        `takeover=${config.takeover} control=${config.control.enabled ? `127.0.0.1:${config.control.port}` : 'off'} ` +
+        `dataDir=${dataDir ?? '(unavailable)'}`,
+    )
+    if (config.inbound.protocol === 'socks') {
+      logger.warn('inbound.protocol=socks 时 DSH 的代理策略不覆盖 web_fetch；除非确有非 Node 客户端需要 SOCKS，建议改回 http')
+    }
+    if (!config.server.password && config.server.publicKey) {
+      logger.info('使用旧字段 publicKey 配置 REALITY；xray 会同时读取 password，两者都写可兼容新旧版本')
+    }  }
+
+  const launcher = createLazyLauncher(ctx, { logger })
+  const route = new RouteManager({ logger })
+  const control =
+    config.control.enabled
+      ? new ControlClient({
+          host: config.control.host,
+          port: config.control.port,
+          timeoutMs: config.control.timeoutMs,
+          balancerTag: config.control.balancerTag,
+          logger,
+        })
+      : undefined
+  const supervisor = new Supervisor({
+    config,
+    errors,
+    warnings,
+    launcher,
+    route,
+    control,
+    logger,
+    dataDir,
+  })
+
+  const dispose = ctx.effect(
+    () => async () => {
+      await supervisor.stop()
+    },
+    'dsh-2xray/xray-supervisor',
+  )
+
+  // Detached by design: activation must not block the harness boot on xray
+  // startup. Every rejection is caught — an unhandled one would dispose the
+  // whole application.
+  supervisor.start().catch((error) => logger.error(`xray 监督器异常：${String(error)}`))
+  installTools({ ctx, supervisor, logger }).catch((error) => logger.warn(`安装 xray_* 工具失败：${String(error)}`))
+
+  return dispose
+}

package/lib/binary.js

@@ -0,0 +1,133 @@
+import { accessSync, constants, existsSync } from 'node:fs'
+import { delimiter, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+/** Package root, so a bundle that ships its own `bin/xray(.exe)` is found first. */
+export const PACKAGE_ROOT = fileURLToPath(new URL('../', import.meta.url))
+
+function raceTimeout(promise, ms, timeoutValue) {
+  let timer
+  return Promise.race([
+    promise,
+    new Promise((resolve) => {
+      timer = setTimeout(() => resolve(timeoutValue), ms)
+      timer.unref?.()
+    }),
+  ]).finally(() => clearTimeout(timer))
+}
+
+export class BinaryError extends Error {
+  constructor(message, code = 'binary-missing', candidates = []) {
+    super(message)
+    this.name = 'BinaryError'
+    this.code = code
+    this.candidates = candidates
+  }
+}
+
+function executableName() {
+  return process.platform === 'win32' ? 'xray.exe' : 'xray'
+}
+
+function isExecutable(file) {
+  try {
+    accessSync(file, constants.X_OK)
+    return true
+  } catch {
+    // Windows has no execute bit; X_OK approximates "readable and present".
+    return existsSync(file) && process.platform === 'win32'
+  }
+}
+
+/**
+ * Resolve the xray executable without downloading anything (v1 never fetches).
+ *
+ * Order: explicit `binary.path`, `DSH_XRAY_BIN`, the plugin's own `bin/` (a
+ * bundle may ship the binary), the managed data directory's `bin/`, then PATH
+ * (through `ctx.subprocess.resolveExecutable` when available).
+ *
+ * @returns {Promise<{ path: string, source: 'config'|'env'|'bundled'|'managed'|'path' }>}
+ */
+export async function resolveBinary({
+  config,
+  dataDir,
+  launcher,
+  exists = isExecutable,
+  packageRoot = PACKAGE_ROOT,
+}) {
+  const candidates = []
+  const explicit = config.binary.path?.trim()
+  if (explicit) candidates.push({ path: explicit, source: 'config' })
+  const fromEnv = process.env.DSH_XRAY_BIN?.trim()
+  if (fromEnv) candidates.push({ path: fromEnv, source: 'env' })
+  candidates.push({ path: join(packageRoot, 'bin', executableName()), source: 'bundled' })
+  candidates.push({ path: join(packageRoot, 'bin', 'xray'), source: 'bundled' })
+  candidates.push({ path: join(dataDir, 'bin', executableName()), source: 'managed' })
+  candidates.push({ path: join(dataDir, 'bin', 'xray'), source: 'managed' })
+
+  for (const candidate of candidates) {
+    if (exists(candidate.path)) return { path: candidate.path, source: candidate.source }
+  }
+
+  // PATH lookup, honouring PATHEXT on Windows.
+  if (launcher?.resolveExecutable) {
+    try {
+      const resolved = await launcher.resolveExecutable('xray')
+      if (typeof resolved === 'string' && resolved) {
+        return { path: resolved, source: 'path' }
+      }
+    } catch {
+      // fall through to the manual scan below
+    }
+  }
+
+  const names = process.platform === 'win32' ? ['xray.exe', 'xray'] : ['xray']
+  const pathEntries = (process.env.PATH ?? '').split(delimiter).filter(Boolean)
+  for (const entry of pathEntries) {
+    for (const name of names) {
+      const candidate = join(entry, name)
+      if (exists(candidate)) return { path: candidate, source: 'path' }
+    }
+  }
+
+  throw new BinaryError(
+    `找不到 xray-core 可执行文件。已尝试：${candidates.map((candidate) => candidate.path).join(', ') || '(无显式路径)'}，以及 PATH 中的 ${pathEntries.join(delimiter)}。` +
+      '请把 xray 放进插件自己的 bin/、数据目录的 bin/，或设置 config.binary.path。',
+    'binary-missing',
+    candidates.map((candidate) => candidate.path),
+  )
+}
+
+/**
+ * Run `xray version` and parse the version line. A failed probe (missing
+ * dynamic library, wrong architecture, antivirus block) is a startup failure,
+ * so it is reported rather than ignored; only an unparsable version is a
+ * warning.
+ */
+export async function probeVersion({ launcher, binaryPath, timeoutMs = 5000 }) {
+  const handle = launcher.spawn({
+    argv: [binaryPath, 'version'],
+    cwd: process.cwd(),
+    graceMs: Math.max(500, timeoutMs),
+    env: {},
+  })
+  const outcome = await raceTimeout(handle.done, timeoutMs, { timedOut: true })
+  if (outcome?.timedOut) {
+    await handle.terminate()
+    return { ok: false, version: undefined, detail: 'xray version 探测超时' }
+  }
+  if (outcome?.error) {
+    return { ok: false, version: undefined, detail: String(outcome.error) }
+  }
+  const text = `${handle.stdoutTail?.() ?? ''}\n${handle.stderrTail?.() ?? ''}`
+  if (outcome.exitCode !== 0) {
+    return { ok: false, version: undefined, detail: tail(text) || `xray version 退出码 ${outcome.exitCode}` }
+  }
+  const version = /Xray\s+([0-9][^\s(]*)/i.exec(text)?.[1]
+  return { ok: true, version, detail: version ? `xray ${version}` : tail(text) }
+}
+
+export function tail(text, limit = 1200) {
+  const trimmed = String(text ?? '').trim()
+  return trimmed.length > limit ? `…${trimmed.slice(-limit)}` : trimmed
+}