@wwkit/sshproxy 1.0.1

package/src/ProxyManager.js

@@ -0,0 +1,435 @@
+import fs from 'node:fs'
+import net from 'node:net'
+import path from 'node:path'
+import { spawn, spawnSync } from 'node:child_process'
+
+import { execCapture, getChromePath, getSocksProxyStatus, killProcess, setSocksProxy, unsetSocksProxy, which } from './OSystem.js'
+import { clientAddr, getProxyConfig, getResolvedStaticConfig, sshAlias } from './config.js'
+import { initClient } from './init.js'
+
+const _chromePidFile = () => getResolvedStaticConfig().paths.chromePidFile
+const _webPidFile = () => getResolvedStaticConfig().paths.webPidFile
+const _pidFile = () => getResolvedStaticConfig().paths.pidFile
+const _sshDir = () => getResolvedStaticConfig().paths.sshDir
+const _sshConfigFile = () => getResolvedStaticConfig().paths.sshConfigFile
+const _keyCandidates = () => getResolvedStaticConfig().ssh.keyCandidates
+const _autosshArgs = () => getResolvedStaticConfig().tunnel.autosshArgs
+const _curlUrl = () => getResolvedStaticConfig().debug.curlUrl
+const _curlTimeoutMs = () => getResolvedStaticConfig().debug.curlTimeoutMs
+
+const _lock = (() => {
+  let chain = Promise.resolve()
+  return {
+    async run(fn) {
+      let release
+      const gate = new Promise((resolve) => { release = resolve })
+      const prev = chain
+      chain = chain.then(() => gate)
+      await prev
+      try {
+        return await fn()
+      } finally {
+        release()
+      }
+    },
+  }
+})()
+
+export class ProxyManager {
+  config() {
+    const cfg = getProxyConfig()
+    const [host, port] = clientAddr(cfg)
+    return { host, port }
+  }
+
+  getStatus() {
+    const cfg = this.config()
+    const pid = this._readPid()
+    const tunnel = { running: pid != null && this._isAlive(pid), pid }
+    const sys = getSocksProxyStatus()
+    return {
+      host: cfg.host,
+      port: cfg.port,
+      tunnel,
+      system_proxy: { enabled: sys.enabled, detail: sys.detail },
+      chrome: this.chromeStatus(),
+      web: this.webStatus(),
+    }
+  }
+
+  async tunnelStart() {
+    return _lock.run(() => this._doTunnelStart())
+  }
+
+  async tunnelStop() {
+    return _lock.run(() => this._doTunnelStop())
+  }
+
+  async proxyOn() {
+    return _lock.run(() => this._doProxyOn())
+  }
+
+  async proxyOff() {
+    return _lock.run(() => this._doProxyOff())
+  }
+
+  async start() {
+    return _lock.run(async () => {
+      const tunnel = await this._doTunnelStart()
+      if (!tunnel.ok) return tunnel
+      const proxy = await this._doProxyOn()
+      if (!proxy.ok) return proxy
+      return { ok: true, message: '代理已全部开启（隧道 + 系统代理）' }
+    })
+  }
+
+  async stop() {
+    return _lock.run(() => {
+      const result = { ok: true, message: '' }
+      const tunnel = this._doTunnelStop()
+      if (tunnel.message) result.message += tunnel.message + ' '
+      const sys = getSocksProxyStatus()
+      if (sys.enabled) {
+        unsetSocksProxy()
+        result.message += '系统代理已关闭 '
+      }
+      const chromeMsg = this._stopChrome().message
+      if (chromeMsg) result.message += chromeMsg
+      if (!result.message.trim()) result.message = '代理未在运行'
+      return result
+    })
+  }
+
+  // ---------- 原子内部实现（不含锁，供组合命令复用） ----------
+
+  async _doTunnelStart() {
+    const cfg = this.config()
+    const ok = await this._startTunnel(cfg.host, cfg.port)
+    if (!ok) return { ok: false, message: '隧道启动失败' }
+    return { ok: true, message: `隧道已启动 (SOCKS5 ${cfg.host}:${cfg.port})` }
+  }
+
+  _doTunnelStop() {
+    const result = { ok: true, message: '' }
+    const pid = this._readPid()
+    if (pid && this._isAlive(pid)) {
+      try {
+        process.kill(pid, 'SIGTERM')
+        result.message = `隧道已停止 (PID=${pid})`
+      } catch {
+        result.message = '隧道停止失败'
+      }
+    }
+    this._cleanupPid()
+    if (!result.message) result.message = '隧道未在运行'
+    return result
+  }
+
+  async _doProxyOn() {
+    const cfg = this.config()
+    if (!this._isProxyRunning()) {
+      const ok = await this._startTunnel(cfg.host, cfg.port)
+      if (!ok) return { ok: false, message: '隧道未运行，代理未开启' }
+    }
+    setSocksProxy(cfg.host, cfg.port)
+    return { ok: true, message: `系统代理已开启 (${cfg.host}:${cfg.port})` }
+  }
+
+  _doProxyOff() {
+    const sys = getSocksProxyStatus()
+    if (!sys.enabled) return { ok: false, message: '系统代理未开启' }
+    unsetSocksProxy()
+    return { ok: true, message: '系统代理已关闭' }
+  }
+
+  async debug() {
+    const cfg = this.config()
+    const host = cfg.host
+    const port = cfg.port
+    const alias = sshAlias(port)
+    const checks = [
+      { name: 'autossh 已安装', fn: () => this._checkAutossh() },
+      { name: `SSH config 有 ${alias}`, fn: () => this._checkSshConfig(alias) },
+      { name: 'SSH 密钥存在', fn: () => this._checkSshKey() },
+      { name: '代理进程在运行', fn: () => this._checkProxyRunning() },
+      { name: `${port} 端口在监听`, fn: () => this._checkPort(port) },
+      { name: '网络连通性测试', fn: () => this._checkConnectivity(host, port) },
+    ]
+    const results = []
+    let criticalOk = true
+    for (const { name, fn } of checks) {
+      if (!criticalOk && name === '网络连通性测试') {
+        results.push({ name, ok: null, detail: '前置检查未通过，跳过连通性测试' })
+        continue
+      }
+      const [ok, detail] = await fn()
+      results.push({ name, ok: Boolean(ok), detail })
+      if (!ok) criticalOk = false
+    }
+    return results
+  }
+
+  chromeStatus() {
+    const pid = this._readPid(_chromePidFile())
+    if (pid && this._isAlive(pid)) {
+      return { running: true, pid }
+    }
+    const { host, port } = this.config()
+    const pids = this._findPgrepPids(`chrome.*--proxy-server=socks5://${host}:${port}`)
+    if (pids.length > 0) {
+      return { running: true, pid: pids[0] }
+    }
+    this._cleanupPid(_chromePidFile())
+    return { running: false, pid: null }
+  }
+
+  async chromeStart() {
+    return _lock.run(async () => {
+      const cfg = this.config()
+      if (!this._isProxyRunning()) {
+        const ok = await this._startTunnel(cfg.host, cfg.port)
+        if (!ok) {
+          return { ok: false, message: '代理隧道启动失败' }
+        }
+      }
+      const chromePath = getChromePath()
+      if (!chromePath) {
+        return { ok: false, message: '未找到 Chrome，请确认安装路径' }
+      }
+      killProcess('Google Chrome')
+      const cmd = [
+        chromePath,
+        `--proxy-server=socks5://${cfg.host}:${cfg.port}`,
+        '--disable-features=SecureDns',
+      ]
+      const proc = this._spawnDetached(cmd[0], cmd.slice(1))
+      this._writePid(proc.pid ?? 0, _chromePidFile())
+      return { ok: true, message: 'Chrome 已以代理模式启动', pid: proc.pid }
+    })
+  }
+
+  _spawnDetached(command, args) {
+    const proc = spawn(command, args, {
+      stdio: 'ignore',
+      detached: true,
+    })
+    proc.unref()
+    return proc
+  }
+
+  async chromeStop() {
+    return _lock.run(() => this._stopChrome())
+  }
+
+  _stopChrome() {
+    const result = { ok: true, message: '' }
+    const pid = this._readPid(_chromePidFile())
+    let killed = false
+    if (pid && this._isAlive(pid)) {
+      try {
+        process.kill(pid, 'SIGTERM')
+        killed = true
+      } catch {
+        /* ignore */
+      }
+    }
+    const { host, port } = this.config()
+    for (const p of this._findPgrepPids(`chrome.*--proxy-server=socks5://${host}:${port}`)) {
+      if (p === pid) continue
+      try {
+        process.kill(p, 'SIGTERM')
+        killed = true
+      } catch {
+        /* ignore */
+      }
+    }
+    this._cleanupPid(_chromePidFile())
+    result.message = killed ? '代理 Chrome 已关闭' : '代理 Chrome 未在运行'
+    return result
+  }
+
+  // ---------- Web 管理页 ----------
+
+  _webServerPath() {
+    return path.join(path.dirname(new URL(import.meta.url).pathname), 'web', 'server.js')
+  }
+
+  async webStart() {
+    return _lock.run(() => {
+      const pid = this._readPid(_webPidFile())
+      if (pid && this._isAlive(pid)) {
+        return { ok: false, message: 'Web 管理页已在运行' }
+      }
+      const proc = spawn(process.execPath, [this._webServerPath()], {
+        stdio: 'ignore',
+        detached: true,
+        env: { ...process.env },
+      })
+      proc.unref()
+      this._writePid(proc.pid ?? 0, _webPidFile())
+      return { ok: true, message: 'Web 管理页已启动（后台）', pid: proc.pid }
+    })
+  }
+
+  async webStop() {
+    return _lock.run(() => {
+      const result = { ok: true, message: '' }
+      const pid = this._readPid(_webPidFile())
+      if (pid && this._isAlive(pid)) {
+        try {
+          process.kill(pid, 'SIGTERM')
+          result.message = 'Web 管理页已关闭'
+        } catch {
+          result.message = 'Web 管理页关闭失败'
+        }
+      }
+      this._cleanupPid(_webPidFile())
+      if (!result.message) result.message = 'Web 管理页未在运行'
+      return result
+    })
+  }
+
+  webStatus() {
+    const pid = this._readPid(_webPidFile())
+    if (pid && this._isAlive(pid)) {
+      return { running: true, pid }
+    }
+    this._cleanupPid(_webPidFile())
+    return { running: false, pid: null }
+  }
+
+  // ---------- 隧道 ----------
+
+  async _startTunnel(host, port) {
+    const pid = this._readPid()
+    if (pid && this._isAlive(pid)) return true
+    if (await this._isPortBusy(port)) return false
+    const initLines = await initClient()
+    if (initLines.some((l) => l.includes('✗'))) return false
+    const alias = sshAlias(port)
+    const proc = spawn('autossh', [..._autosshArgs(), alias], {
+      stdio: ['ignore', 'ignore', 'pipe'],
+    })
+    const stderr = []
+    proc.stderr.on('data', (chunk) => stderr.push(String(chunk)))
+    const code = await new Promise((resolve) => {
+      proc.on('error', () => resolve(1))
+      proc.on('exit', (c) => resolve(c ?? 1))
+    })
+    if (code !== 0) return false
+    const proxyPid = this._findProxyPid(port)
+    if (!proxyPid) return false
+    this._writePid(proxyPid)
+    return true
+  }
+
+  _isProxyRunning() {
+    const pid = this._readPid()
+    return pid != null && this._isAlive(pid)
+  }
+
+  // ---------- 检查原语 ----------
+
+  _checkAutossh() {
+    const autossh = which('autossh')
+    if (autossh) {
+      return [true, autossh]
+    }
+    return [false, '未安装，请执行: brew install autossh']
+  }
+
+  _checkSshConfig(alias) {
+    const configPath = _sshConfigFile()
+    if (!fs.existsSync(configPath)) return [false, `${configPath} 不存在`]
+    const content = fs.readFileSync(configPath, 'utf-8')
+    if (!content.includes(`Host ${alias}`)) {
+      return [false, `缺少 ${alias} 配置，请执行 sshproxy tunnel on`]
+    }
+    return [true, '']
+  }
+
+  _checkSshKey() {
+    const sshDir = _sshDir()
+    for (const name of _keyCandidates()) {
+      if (fs.existsSync(path.join(sshDir, name))) return [true, '']
+    }
+    return [false, `${sshDir}/ 下无密钥文件，请执行: ssh-keygen -t ed25519`]
+  }
+
+  _checkProxyRunning() {
+    const pid = this._readPid()
+    if (pid && this._isAlive(pid)) return [true, `PID=${pid}`]
+    return [false, '代理未运行，请执行: sshproxy tunnel on']
+  }
+
+  async _checkPort(port) {
+    if (await this._isPortBusy(port)) return [true, `127.0.0.1:${port}`]
+    return [false, `${port} 端口未监听，代理可能未正确启动`]
+  }
+
+  async _checkConnectivity(host, port) {
+    const result = await execCapture('curl', ['--socks5-hostname', `${host}:${port}`, _curlUrl(), '-I'], { timeout: _curlTimeoutMs() })
+    if (result.code === 0) return [true, '']
+    return [false, `请求失败 (exit=${result.code})`]
+  }
+
+  // ---------- PID 文件 ----------
+
+  _readPid(filePath = _pidFile()) {
+    try {
+      return parseInt(fs.readFileSync(filePath, 'utf-8').trim(), 10)
+    } catch {
+      return null
+    }
+  }
+
+  _writePid(pid, filePath = _pidFile()) {
+    fs.mkdirSync(path.dirname(filePath), { recursive: true })
+    fs.writeFileSync(filePath, String(pid))
+  }
+
+  _cleanupPid(filePath = _pidFile()) {
+    try {
+      fs.unlinkSync(filePath)
+    } catch {
+      /* ignore */
+    }
+  }
+
+  _isAlive(pid) {
+    try {
+      process.kill(pid, 0)
+      return true
+    } catch {
+      return false
+    }
+  }
+
+  _isPortBusy(port) {
+    return new Promise((resolve) => {
+      const s = net.createServer()
+      s.once('error', () => resolve(true))
+      s.once('listening', () => s.close(() => resolve(false)))
+      s.listen(port, '127.0.0.1')
+    })
+  }
+
+  _findProxyPid(port = null) {
+    const alias = port ? sshAlias(port) : 'client-proxy'
+    let pids = this._findPgrepPids(`autossh.*-N.*-f.*${alias}`)
+    if (pids.length === 0) pids = this._findPgrepPids(`ssh.*-N.*${alias}`)
+    return pids.length > 0 ? pids[0] : null
+  }
+
+  _findPgrepPids(pattern) {
+    const result = spawnSync('pgrep', ['-f', pattern])
+    if (result.status !== 0) return []
+    const pids = []
+    for (const line of String(result.stdout).trim().split('\n')) {
+      const pid = parseInt(line.trim(), 10)
+      if (Number.isNaN(pid)) continue
+      if (pid !== process.pid) pids.push(pid)
+    }
+    return pids
+  }
+}

package/src/SshClient.js

@@ -0,0 +1,132 @@
+import { Client } from 'ssh2'
+import path from 'node:path'
+
+import { loadConfig } from './config.js'
+
+export class SshClient {
+  constructor() {
+    const cfg = loadConfig()
+    this.host = cfg.host ?? ''
+    this.port = Number(cfg.port ?? 22)
+    this.user = cfg.user ?? ''
+    this.password = cfg.password ?? ''
+    this.timeout = Number(cfg.timeout ?? 30)
+  }
+
+  connect() {
+    return new Promise((resolve, reject) => {
+      const client = new Client()
+      const conn = {
+        host: this.host,
+        port: this.port,
+        username: this.user,
+        timeout: this.timeout * 1000,
+        readyTimeout: this.timeout * 1000,
+      }
+      if (this.password) conn.password = this.password
+      client.on('ready', () => resolve(client))
+      client.on('error', (err) => reject(err))
+      client.connect(conn)
+    })
+  }
+
+  async checkConnection() {
+    try {
+      const client = await this.connect()
+      try {
+        await this.execOnClient(client, 'echo ok')
+        return true
+      } finally {
+        client.end()
+      }
+    } catch {
+      return false
+    }
+  }
+
+  async execute(command) {
+    let client
+    try {
+      client = await this.connect()
+      const result = await this.execOnClient(client, command)
+      return [result.code, result.stdout, result.stderr]
+    } catch (err) {
+      return [1, '', String(err)]
+    } finally {
+      if (client) client.end()
+    }
+  }
+
+  execOnClient(client, command) {
+    return new Promise((resolve, reject) => {
+      client.exec(command, (err, stream) => {
+        if (err) return reject(err)
+        let stdout = ''
+        let stderr = ''
+        stream.on('data', (chunk) => { stdout += String(chunk) })
+        stream.stderr.on('data', (chunk) => { stderr += String(chunk) })
+        stream.on('close', (code) => {
+          resolve({ code: code ?? 0, stdout, stderr })
+        })
+      })
+    })
+  }
+
+  async upload(localPath, remotePath) {
+    let client
+    try {
+      client = await this.connect()
+      const sftp = await new Promise((resolve, reject) => {
+        client.sftp((err, sftp) => (err ? reject(err) : resolve(sftp)))
+      })
+      await this.mkdirs(sftp, path.posix.dirname(remotePath))
+      await new Promise((resolve, reject) => {
+        sftp.fastPut(localPath, remotePath, (err) => (err ? reject(err) : resolve()))
+      })
+      return true
+    } catch {
+      return false
+    } finally {
+      if (client) client.end()
+    }
+  }
+
+  async download(remotePath, localPath) {
+    let client
+    try {
+      client = await this.connect()
+      const sftp = await new Promise((resolve, reject) => {
+        client.sftp((err, sftp) => (err ? reject(err) : resolve(sftp)))
+      })
+      await new Promise((resolve, reject) => {
+        sftp.fastGet(remotePath, localPath, (err) => (err ? reject(err) : resolve()))
+      })
+      return true
+    } catch {
+      return false
+    } finally {
+      if (client) client.end()
+    }
+  }
+
+  mkdirs(sftp, remoteDir) {
+    const dirs = remoteDir.split('/').filter(Boolean)
+    let p = ''
+    return dirs.reduce((chain, d) => {
+      p += `/${d}`
+      return chain.then(() => this.statOrMkdir(sftp, p))
+    }, Promise.resolve())
+  }
+
+  statOrMkdir(sftp, dirPath) {
+    return new Promise((resolve) => {
+      sftp.stat(dirPath, (err) => {
+        if (err) {
+          sftp.mkdir(dirPath, (mkdirErr) => resolve(mkdirErr ? Promise.reject(mkdirErr) : resolve()))
+        } else {
+          resolve()
+        }
+      })
+    })
+  }
+}

package/src/config.js

@@ -0,0 +1,104 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import JSON5 from 'json5'
+import dotenv from 'dotenv'
+import { createConfigLoader, getXdgConfigDir } from '@wwkit/shared'
+
+// ============================================================
+// 业务配置（用户可调整；默认值存于 src/config.json5）
+// ============================================================
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+dotenv.config({ path: path.join(__dirname, '..', '.env'), quiet: true })
+const DEFAULT_CONFIG_PATH = path.join(__dirname, 'config.json5')
+
+export function defaultConfig() {
+  const raw = fs.readFileSync(DEFAULT_CONFIG_PATH, 'utf-8')
+  return JSON5.parse(raw)
+}
+
+export function getConfigDir() {
+  const envDir = process.env.SSHPROXY_CONFIG_DIR
+  if (envDir) return envDir
+  return getXdgConfigDir('sshproxy')
+}
+
+export function getConfigPath() {
+  return path.join(getConfigDir(), 'config.json5')
+}
+
+const _loader = createConfigLoader({
+  builtinConfigPath: DEFAULT_CONFIG_PATH,
+  userConfigDir: getConfigDir(),
+  envContentVar: 'SSHPROXY_CONFIG_CONTENT',
+  envDirVar: 'SSHPROXY_CONFIG_DIR',
+})
+
+export function loadConfig() {
+  return _loader.getConfig()
+}
+
+// ============================================================
+// 静态配置（系统内置常量，存于 src/contains.json5，用户不可改）
+// ============================================================
+
+const DEFAULT_STATIC_PATH = path.join(__dirname, 'contains.json5')
+
+export function defaultStaticConfig() {
+  const raw = fs.readFileSync(DEFAULT_STATIC_PATH, 'utf-8')
+  return JSON5.parse(raw)
+}
+
+export function getStaticConfig() {
+  return defaultStaticConfig()
+}
+
+// ============================================================
+// 通用（由 @wwkit/shared 提供）
+// ============================================================
+
+export { deepMerge, resolveEnvVars } from '@wwkit/shared'
+
+export function getProxyConfig() {
+  const cfg = loadConfig()
+  return cfg.proxy ?? cfg
+}
+
+export function clientAddr(cfg = getProxyConfig()) {
+  const c = cfg.socks5 ?? {}
+  return [c.host ?? '127.0.0.1', c.port ?? 1080]
+}
+
+export function sshAlias(port) {
+  const s = getStaticConfig()
+  return `${s.ssh.aliasPrefix}-${port}`
+}
+
+// ============================================================
+// 静态配置派生（封装默认值与路径展开）
+// ============================================================
+
+function expandHome(p) {
+  return p.startsWith('~/') ? path.join(os.homedir(), p.slice(2)) : p
+}
+
+export function getResolvedStaticConfig() {
+  const s = getStaticConfig()
+  return {
+    paths: {
+      stateDir: expandHome(s.paths.stateDir),
+      pidFile: path.join(expandHome(s.paths.stateDir), s.paths.pidFile),
+      chromePidFile: path.join(expandHome(s.paths.stateDir), s.paths.chromePidFile),
+      webPidFile: path.join(expandHome(s.paths.stateDir), s.paths.webPidFile),
+      sshDir: expandHome(s.paths.sshDir),
+      sshConfigFile: path.join(expandHome(s.paths.sshDir), s.paths.sshConfigFile),
+    },
+    ssh: { ...s.ssh },
+    tunnel: { ...s.tunnel },
+    os: { ...s.os },
+    debug: { ...s.debug },
+    web: { ...s.web },
+  }
+}

package/src/config.json5

@@ -0,0 +1,15 @@
+{
+  socks5: {
+    host: '127.0.0.1',
+    port: 1080,
+  },
+  host: '{env:SSH_HOST}',
+  port: 22,
+  user: '{env:SSH_USER}',
+  password: '{env:SSH_PASSWORD}',
+  timeout: 30,
+  web: {
+    host: '127.0.0.1',
+    port: 1081,
+  },
+}