@wwkit/sshproxy 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bluesliu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# sshproxy
+
+SOCKS5 代理管理器（CLI + 本地 Web 管理页）。通过本地 SSH 隧道（autossh）提供 SOCKS5 代理，全局命令为 `sshproxy`。
+
+## 安装
+
+```bash
+pnpm add -g @wwkit/sshproxy
+# 或
+npm i -g @wwkit/sshproxy
+```
+
+## 配置
+
+全局配置：`~/.config/sshproxy/config.json5`。安装时（postinstall 钩子）自动把默认模板复制到该位置，用户可直接编辑；未复制到也可首次运行时自动生成。
+
+```json5
+{
+  socks5: { host: "127.0.0.1", port: 1080 },
+  host: "", port: 22, user: "", password: "", timeout: 30,
+  web: { host: "127.0.0.1", port: 1081 }
+}
+```
+
+支持 `{env:XXX}` 占位符与环境变量覆盖（`SSHPROXY_CONFIG_DIR` 指定配置目录、`SSHPROXY_CONFIG_CONTENT` 直接提供配置内容）。
+
+配置加载由 `@wwkit/shared` 的多层加载器实现：**内置默认 → `SSHPROXY_CONFIG_CONTENT` 注入 → 用户 `config.json5`** 三层深合并（用户优先），并对结果统一解析 `{env:XXX}` 占位符。
+
+### 系统内置常量（contains.json5）
+
+路径/SSH 密钥/autossh 参数/系统代理/调试/Web 轮询等**内部常量**内置于 `src/contains.json5`（随包发布，系统级、用户不可改）。运行时始终使用内置值，不与用户配置合并。
+
+## 命令
+
+命令按功能模块划分。
+
+### 隧道（SOCKS5 服务）
+
+```bash
+sshproxy tunnel on       # 启动 SSH 隧道（SOCKS5，默认 127.0.0.1:1080）
+sshproxy tunnel off      # 停止隧道
+```
+
+`tunnel on` 已运行不会重复启动；首次运行会自动完成初始化（SSH 密钥/公钥/ssh config/autossh）。
+
+### 系统全局代理
+
+```bash
+sshproxy proxy on        # 开启系统全局代理（隧道未运行则先启动）
+sshproxy proxy off       # 关闭系统全局代理
+```
+
+### 代理 Chrome
+
+```bash
+sshproxy chrome on       # 以代理模式启动 Chrome（隧道未运行则先启动）
+sshproxy chrome off      # 关闭代理 Chrome
+```
+
+### 组合命令
+
+```bash
+sshproxy start           # 隧道 + 系统代理，一键全开
+sshproxy stop            # 隧道 + 系统代理 + Chrome，一键全关
+sshproxy status          # 查看全部状态（隧道/系统代理/Chrome/Web）
+```
+
+### Web 管理页
+
+```bash
+sshproxy web on           # 启动 Web 管理页（后台，默认 http://127.0.0.1:1081）
+sshproxy web off          # 关闭 Web 管理页
+```
+
+### 信息与检查
+
+```bash
+sshproxy debug           # 全链路检查（验证代理是否可用）
+sshproxy help            # 显示帮助
+```
+
+## 本地开发调用示例
+
+在 monorepo 根目录或 `packages/sshproxy` 内均可运行。若未全局安装 `sshproxy`，用以下方式调用：
+
+```bash
+# 在 packages/sshproxy 目录内，直接跑源码入口
+node ./bin tunnel on
+node ./bin proxy on
+node ./bin status
+
+# 或从 monorepo 根目录，通过 pnpm 过滤到子包
+pnpm --filter @wwkit/sshproxy exec sshproxy status
+```
+
+本地开发时配置走默认路径 `~/.config/sshproxy/config.json5`；也可用环境变量临时指到测试配置，避免影响真实配置：
+
+```bash
+# 用临时配置目录跑（首次会自动初始化）
+SSHPROXY_CONFIG_DIR=/tmp/sshproxy-dev node ./bin tunnel on
+
+# 或直接注入配置内容
+SSHPROXY_CONFIG_CONTENT='{ host: "example.com", user: "root", password: "***" }' \
+  node ./bin tunnel on
+```
+
+## Web 管理页
+
+`sshproxy web on` 在后台启动 HTTP 服务（`web off` 关闭），提供 REST API 与静态 `index.html`：
+
+- `GET /api/status` — 代理状态
+- `GET /api/config` — 系统内置常量
+- `POST /api/tunnel` `{action:"on"|"off"}` — 隧道启停
+- `POST /api/proxy` `{action:"on"|"off"}` — 系统代理开关
+- `POST /api/chrome` `{action:"on"|"off"}` — Chrome 启停
+- `POST /api/start` / `POST /api/stop` — 一键全开/全关
+- `POST /api/debug` — 全链路检查
+
+## 前置条件
+
+- `autossh`（macOS 可用 `brew install autossh`）
+- 系统代理：macOS 使用 `networksetup`；Linux 使用 `ALL_PROXY` 环境变量
+- 代理 Chrome：本机安装 Google Chrome

package/bin/index.js

@@ -0,0 +1,171 @@
+#!/usr/bin/env node
+
+import { ProxyManager } from '../src/ProxyManager.js'
+import { clientAddr, loadConfig } from '../src/config.js'
+
+const args = process.argv.slice(2)
+const cmd = args[0] ?? 'help'
+const sub = args[1] ?? ''
+
+async function main() {
+  switch (cmd) {
+    case 'tunnel':
+      return handleTunnel(sub)
+    case 'proxy':
+      return handleProxy(sub)
+    case 'chrome':
+      return handleChrome(sub)
+    case 'start':
+      return handleStart()
+    case 'stop':
+      return handleStop()
+    case 'status':
+      return handleStatus()
+    case 'debug':
+      return handleDebug()
+    case 'web':
+      return handleWeb(sub)
+    case 'help':
+    default:
+      printHelp()
+  }
+}
+
+function printResult(result) {
+  if (!result) return
+  if (result.message) console.log(result.message)
+  if (result.ok === false) process.exitCode = 1
+}
+
+async function handleTunnel(sub) {
+  const manager = new ProxyManager()
+  if (sub === 'off') return printResult(await manager.tunnelStop())
+  return printResult(await manager.tunnelStart())
+}
+
+async function handleProxy(sub) {
+  const manager = new ProxyManager()
+  if (sub === 'off') return printResult(await manager.proxyOff())
+  return printResult(await manager.proxyOn())
+}
+
+async function handleChrome(sub) {
+  const manager = new ProxyManager()
+  if (sub === 'off') return printResult(await manager.chromeStop())
+  return printResult(await manager.chromeStart())
+}
+
+async function handleStart() {
+  const manager = new ProxyManager()
+  const result = await manager.start()
+  if (result.ok) {
+    const [host, port] = clientAddr()
+    console.log(`代理地址: SOCKS5 ${host}:${port}`)
+  }
+  printResult(result)
+}
+
+async function handleStop() {
+  const manager = new ProxyManager()
+  printResult(await manager.stop())
+}
+
+function handleStatus() {
+  const manager = new ProxyManager()
+  const status = manager.getStatus()
+  const tunnel = status.tunnel
+  if (tunnel && tunnel.running) {
+    console.log(`隧道: 运行中 (PID=${tunnel.pid})`)
+  } else {
+    console.log('隧道: 未运行')
+  }
+  console.log(`代理地址: SOCKS5 ${status.host}:${status.port}`)
+  console.log(`系统代理: ${status.system_proxy.enabled ? '已开启' : '已关闭'}`)
+  const chrome = status.chrome
+  console.log(`代理 Chrome: ${chrome.running ? `运行中 (PID=${chrome.pid})` : '未运行'}`)
+  const web = status.web
+  if (web.running) {
+    const webCfg = loadConfig().web ?? {}
+    console.log(`Web 管理页: 运行中 (PID=${web.pid})`)
+    console.log(`  管理页地址: http://${webCfg.host ?? '127.0.0.1'}:${webCfg.port ?? 1081}`)
+  } else {
+    console.log('Web 管理页: 未运行')
+  }
+}
+
+async function handleDebug() {
+  const manager = new ProxyManager()
+  const checks = await manager.debug()
+  for (const check of checks) {
+    const name = check.name
+    const detail = check.detail
+    const ok = check.ok
+    if (ok === null) {
+      console.log(`  - ${name}`)
+    } else {
+      const mark = ok ? '✓' : '✗'
+      console.log(`  ${mark} ${name}`)
+    }
+    if (detail) {
+      console.log(`    ${detail}`)
+    }
+    if (ok === false) {
+      console.log('')
+      console.log(`检查中止于: ${name}`)
+      return
+    }
+  }
+  console.log('')
+  console.log('全部通过，代理可用')
+}
+
+async function handleWeb(sub) {
+  const manager = new ProxyManager()
+  if (sub === 'off') {
+    const result = await manager.webStop()
+    console.log(result.message)
+    return
+  }
+  const result = await manager.webStart()
+  console.log(result.message)
+  if (result.ok) {
+    const cfg = loadConfig().web ?? {}
+    console.log(`  管理页: http://${cfg.host ?? '127.0.0.1'}:${cfg.port ?? 1081}`)
+  }
+}
+
+function printHelp() {
+  console.log(`sshproxy - SSH 代理命令
+
+隧道（SOCKS5 服务）:
+  sshproxy tunnel            启动 SSH 隧道（= tunnel on）
+  sshproxy tunnel on         启动 SSH 隧道
+  sshproxy tunnel off        停止隧道
+
+系统全局代理:
+  sshproxy proxy             开启系统全局代理（隧道未运行则先启动）
+  sshproxy proxy on          开启系统全局代理
+  sshproxy proxy off         关闭系统全局代理
+
+代理 Chrome:
+  sshproxy chrome            以代理模式启动 Chrome（隧道未运行则先启动）
+  sshproxy chrome on         以代理模式启动 Chrome
+  sshproxy chrome off        关闭代理 Chrome
+
+一键:
+  sshproxy start             隧道 + 系统代理，一键全开
+  sshproxy stop              隧道 + 系统代理 + Chrome，一键全关
+
+状态与工具:
+  sshproxy status            查看全部状态
+  sshproxy debug             全链路检查（验证代理是否可用）
+  sshproxy web               启动 Web 管理页（后台，默认 http://127.0.0.1:1081）
+  sshproxy web on            启动 Web 管理页
+  sshproxy web off           关闭 Web 管理页
+  sshproxy help              显示本帮助
+
+配置: ~/.config/sshproxy/config.json5
+`)
+}
+
+main()

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@wwkit/sshproxy",
+  "version": "1.0.1",
+  "author": "bluesliu <langcai163@163.com>",
+  "description": "SOCKS5 proxy manager (client SSH tunnel / server remote), CLI + web UI",
+  "type": "module",
+  "main": "src/index.js",
+  "bin": {
+    "sshproxy": "./bin/index.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "scripts",
+    "README.md",
+    "LICENSE"
+  ],
+  "jest": {
+    "transform": {},
+    "testMatch": [
+      "**/tests/unit/**/*.test.js"
+    ]
+  },
+  "keywords": [
+    "socks5",
+    "proxy",
+    "ssh",
+    "autossh",
+    "chrome"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "json5": "^2.2.3",
+    "ssh2": "^1.16.0",
+    "@wwkit/shared": "1.0.1"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  },
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --no-cache tests/unit",
+    "test:all": "node --experimental-vm-modules node_modules/jest/bin/jest.js --no-cache tests/unit",
+    "release": "pnpm version patch && pnpm publish"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { createConfigLoader, getXdgConfigDir } from '@wwkit/shared'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const src = path.join(__dirname, '..', 'src', 'config.json5')
+
+const loader = createConfigLoader({
+  builtinConfigPath: src,
+  userConfigDir: getXdgConfigDir('sshproxy'),
+  envDirVar: 'SSHPROXY_CONFIG_DIR',
+})
+
+if (loader.copyBuiltinConfig()) {
+  console.log(`sshproxy: wrote default config to ${loader.userConfigPath}`)
+}

package/src/OSystem.js

@@ -0,0 +1,131 @@
+import { execFileSync, execFile, spawnSync } from 'node:child_process'
+import path from 'node:path'
+import fs from 'node:fs'
+
+import { getResolvedStaticConfig } from './config.js'
+
+export function getOsType() {
+  if (process.platform === 'win32') return 'windows'
+  if (process.platform === 'linux') return 'linux'
+  if (process.platform === 'darwin') return 'mac'
+  return 'unknown'
+}
+
+export function getChromePath() {
+  const type = getOsType()
+  if (type === 'mac') {
+    const p = '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
+    return fs.existsSync(p) ? p : null
+  }
+  if (type === 'linux') {
+    return which('google-chrome') ?? which('google-chrome-stable')
+  }
+  if (type === 'windows') {
+    for (const base of [process.env.PROGRAMFILES, process.env['PROGRAMFILES(X86)']]) {
+      if (!base) continue
+      const candidate = path.join(base, 'Google', 'Chrome', 'Application', 'chrome.exe')
+      if (fs.existsSync(candidate)) return candidate
+    }
+    return null
+  }
+  return null
+}
+
+export function which(cmd) {
+  try {
+    const out = execFileSync('which', [cmd], { encoding: 'utf-8' }).trim()
+    return out || null
+  } catch {
+    return null
+  }
+}
+
+export function killProcess(name) {
+  const type = getOsType()
+  if (type === 'mac') {
+    spawnSync('killall', ['-m', name])
+    return true
+  }
+  if (type === 'linux') {
+    spawnSync('pkill', ['-f', name])
+    return true
+  }
+  if (type === 'windows') {
+    spawnSync('taskkill', ['/F', '/IM', `${name}.exe`])
+    return true
+  }
+  return false
+}
+
+function getMacNetworkService() {
+  const services = getResolvedStaticConfig().os.macNetworkServices
+  const fallback = getResolvedStaticConfig().os.macNetworkDefault
+  const result = execFileSync('networksetup', ['-listnetworkserviceorder'], { encoding: 'utf-8' })
+  for (const line of result.split('\n')) {
+    if (services.some((s) => line.includes(s))) {
+      const parts = line.split(')')
+      if (parts.length >= 2) return parts[1].trim()
+    }
+  }
+  return fallback
+}
+
+export function setSocksProxy(host, port) {
+  const type = getOsType()
+  if (type === 'mac') {
+    const service = getMacNetworkService()
+    execFileSync('networksetup', ['-setsocksfirewallproxy', service, host, String(port)])
+    execFileSync('networksetup', ['-setsocksfirewallproxystate', service, 'on'])
+    return true
+  }
+  if (type === 'linux') {
+    process.env.ALL_PROXY = `socks5://${host}:${port}`
+    return true
+  }
+  return false
+}
+
+export function unsetSocksProxy() {
+  const type = getOsType()
+  if (type === 'mac') {
+    const service = getMacNetworkService()
+    execFileSync('networksetup', ['-setsocksfirewallproxystate', service, 'off'])
+    return true
+  }
+  if (type === 'linux') {
+    delete process.env.ALL_PROXY
+    return true
+  }
+  return false
+}
+
+export function getSocksProxyStatus() {
+  const type = getOsType()
+  if (type === 'mac') {
+    const service = getMacNetworkService()
+    try {
+      const out = execFileSync('networksetup', ['-getsocksfirewallproxy', service], { encoding: 'utf-8' })
+      const enabled = out.includes('Enabled: Yes')
+      return { enabled, detail: out.trim() }
+    } catch {
+      return { enabled: false, detail: '' }
+    }
+  }
+  if (type === 'linux') {
+    const proxy = process.env.ALL_PROXY ?? ''
+    return { enabled: Boolean(proxy), detail: proxy ? `ALL_PROXY=${proxy}` : '未设置' }
+  }
+  return { enabled: false, detail: '不支持当前系统' }
+}
+
+export function execCapture(cmd, args, { timeout = 15000 } = {}) {
+  return new Promise((resolve) => {
+    execFile(cmd, args, { timeout }, (err, stdout, stderr) => {
+      if (err) {
+        resolve({ code: err.code ?? 1, stdout: String(stdout ?? ''), stderr: String(stderr ?? '') })
+      } else {
+        resolve({ code: 0, stdout: String(stdout ?? ''), stderr: String(stderr ?? '') })
+      }
+    })
+  })
+}