network-infra-utility 0.8.3 → 1.0.0

data/tool/webssh/cli.bat

@@ -0,0 +1,17 @@
+@echo off
+cd /d "%~dp0"
+
+REM ---- CLI SSH terminal, independent from the web UI ----
+REM Direct mode   : own paramiko connection (no web / worker involved)
+REM Attach mode   : attach to an existing worker session
+REM
+REM Usage:
+REM   cli.bat                auto-detect port, direct connect
+REM   cli.bat --port 4983    direct connect to a specific port
+REM   cli.bat --list         list live worker sessions
+REM   cli.bat --attach SID   attach to a worker session
+
+set PY=C:\Python314\python.exe
+if not exist "%PY%" set PY=python
+
+"%PY%" ssh_cli.py %*

data/tool/webssh/config.yml.template

@@ -0,0 +1,84 @@
+# ===================================================================
+#                       WebSSH Configuration                        #
+# ===================================================================
+
+ssh:
+  # SSH login username
+  username: "your_name"
+  # SSH login password
+  password: "your_password"
+  # SSH target host
+  host: 127.0.0.1
+
+  # Auto-detect: find listening port from process name(s).
+  # Supports a single name (string) or a list of names.
+  # Leave empty or [] to use manual port below.
+  process_name: bh_am_pfe_tunnel
+  # Example for multiple processes:
+  # process_name:
+  #   - windterm
+  #   - plink
+
+  # Manual port (used when process_name is empty or detection fails)
+  # Set to null for auto-detect only
+  port: null
+
+  # SSH keepalive interval in seconds (0 = disable, passive mode).
+  keepalive_interval: 0
+
+web:
+  # Web server listen address (127.0.0.1 = localhost only)
+  host: 127.0.0.1
+  # Web server port
+  port: 9999
+
+terminal:
+  # Scrollback buffer size in rows (number of lines kept in memory
+  # for scrolling back). Set to 0 for unlimited (uses more memory
+  # during long sessions).
+  scrollback: 65535
+
+logs:
+  # Session log directory (relative to app.py)
+  dir: logs
+  # Auto-save session log when disconnected
+  auto_save: true
+  # Per-step interaction log written by the worker process itself
+  # (connect lifecycle, every input/output with escapes visible,
+  # resize, detach/attach, disconnect reason).
+  # Written to logs/interactive_<ts>_<sid>.log
+  interactive: true
+  # Verbose paramiko debug trace (kex/cipher negotiation, channel
+  # events). Written to logs/paramiko_<sid>.log. Set false to disable.
+  trace: true
+
+# -------------------------------------------------------------------
+# Toolbar groups: quick-send commands to the active terminal session.
+# Each group is a tree node; each tool is a button under the group.
+# Clicking a tool sends its script to the current session.
+# -------------------------------------------------------------------
+toolbar:
+  # Delay between sending each line of a multi-line script (seconds).
+  # 0 = send all lines at once (may overwhelm slow devices).
+  line_delay: 0.05
+  #
+  groups:
+    - name: 性能
+      tools:
+        - name: 资源实占
+          command: top
+  
+    - name: 诊断
+      tools:
+        - name: 查进程
+          command: ps -ef
+        - name: 查网络
+          command: netstat -tlnp
+        - name: 查内存
+          command: free -h
+        - name: 查硬盘
+          command: df -h
+#
+# OR
+#
+# toolbar: {}

data/tool/webssh/extension//350/256/276/345/244/207/350/257/212/346/226/255.md

@@ -0,0 +1,103 @@
+# 设备诊断工具集
+
+常用网络设备诊断命令集合，点击按钮直接发送到当前终端会话。
+
+## 辅助功能
+
+### 全量显示
+
+批量命令时不设分页，完全显示所有命令
+
+```shell
+screen-length 0 temporary
+```
+
+## 基础查看
+
+### 查看版本
+
+查看设备软件版本信息
+
+```shell
+display version
+```
+
+### 查看当前配置
+
+显示当前运行的完整配置
+
+```shell
+display current-configuration
+```
+
+### 查看接口状态
+
+```shell
+display interface brief
+```
+
+## 网络诊断
+
+### Ping 测试
+
+向目标地址发送 5 个 ICMP 包
+
+```shell
+ping -c 5 192.168.1.1
+```
+
+### 查看路由表
+
+```shell
+display ip routing-table
+```
+
+### 查看ARP表
+
+```shell
+display arp
+```
+
+## 性能监控
+
+### CPU 使用率
+
+查看设备 CPU 使用情况
+
+```shell
+display cpu-usage
+```
+
+### 内存使用
+
+```shell
+display memory
+```
+
+### 接口流量统计
+
+```shell
+display interface counters rate
+```
+
+## 系统管理
+
+### 查看告警
+
+```shell
+display alarm active
+```
+
+### 保存配置
+
+```shell
+save force
+```
+
+### 查看日志
+
+显示最近的系统日志信息
+
+```shell
+display logbuffer
+```

data/tool/webssh/requirements.txt

@@ -0,0 +1,7 @@
+flask>=3.0
+flask-sock>=0.6
+# paramiko must stay <4.0: v4+ removed legacy SHA-1 kex & ssh-rsa,
+# which embedded SSH servers (e.g. bh_am_pfe_tunnel) require.
+paramiko>=3.4,<4.0
+PyYAML>=6.0
+psutil>=5.9

data/tool/webssh/ssh_cli.py

@@ -0,0 +1,449 @@
+#!/usr/bin/env python3
+"""
+ssh_cli.py - Command-line SSH client, independent from the web UI.
+
+Two access modes:
+
+  direct (default)   opens its OWN paramiko SSH connection - no Flask,
+                     no worker process, no browser involved. Use this to
+                     compare against the web terminal and tell whether a
+                     problem lives in the SSH layer or the web display
+                     layer.
+
+  attach             attaches to an EXISTING detached worker session
+                     (same sessions the web page shows). Use this to test
+                     the worker<->client path without the browser.
+
+Usage:
+  python ssh_cli.py                     auto-detect port, direct connect
+  python ssh_cli.py --port 4983         direct connect to a specific port
+  python ssh_cli.py --list              list live worker sessions
+  python ssh_cli.py --attach <sid>      attach to a worker session
+
+Keys:
+  Ctrl+Q    quit locally (session unaffected in attach mode)
+  Ctrl+C    forwarded to the remote shell as SIGINT, like real ssh
+  Ctrl+D    forwarded to the remote shell (EOF)
+
+Interaction logging (same format as the worker, logs/interactive_*.log):
+  every connect step, every keystroke sent, every output chunk received
+  (escape sequences visible, e.g. the busybox DSR query shows as \\x1b[6n).
+"""
+
+import argparse
+import json
+import os
+import shutil
+import sys
+import threading
+import time
+from pathlib import Path
+
+BASE_DIR = Path(__file__).parent.resolve()
+if str(BASE_DIR) not in sys.path:
+    sys.path.insert(0, str(BASE_DIR))
+
+import paramiko
+
+from ssh_worker import (
+    InteractionLog,
+    load_logs_config,
+    load_ssh_config,
+    make_transport_factory,
+)
+
+# reuse the exact same detection / session helpers as the web app
+from app import detect_process_port, send_ctrl, worker_connect, worker_contexts
+
+# ------------------------------------------------------------------ #
+#  Console setup (Windows VT sequences + UTF-8 output)
+# ------------------------------------------------------------------ #
+IS_WINDOWS = os.name == "nt"
+if IS_WINDOWS:
+    import ctypes
+    import msvcrt
+
+    def enable_vt():
+        """Enable ANSI/VT escape processing in the Windows console."""
+        try:
+            kernel32 = ctypes.windll.kernel32
+            h = kernel32.GetStdHandle(-11)  # STD_OUTPUT_HANDLE
+            mode = ctypes.c_uint32()
+            if kernel32.GetConsoleMode(h, ctypes.byref(mode)):
+                kernel32.SetConsoleMode(h, mode.value | 0x0004)
+        except Exception:
+            pass
+
+else:
+    import termios
+    import tty
+
+    def enable_vt():
+        pass  # POSIX terminals handle VT natively
+
+
+def setup_stdout():
+    enable_vt()
+    try:
+        sys.stdout.reconfigure(encoding="utf-8", errors="replace")
+    except Exception:
+        pass
+
+
+# ------------------------------------------------------------------ #
+#  Keyboard input (non-blocking, Windows msvcrt / POSIX raw tty)
+# ------------------------------------------------------------------ #
+# Windows console extended key codes -> terminal escape sequences
+WIN_EXT_KEYS = {
+    "H": "\x1b[A",  # Up
+    "P": "\x1b[B",  # Down
+    "K": "\x1b[D",  # Left
+    "M": "\x1b[C",  # Right
+    "G": "\x1b[H",  # Home
+    "O": "\x1b[F",  # End
+    "I": "\x1b[5~",  # PageUp
+    "Q": "\x1b[6~",  # PageDown
+    "R": "\x1b[2~",  # Insert
+    "S": "\x1b[3~",  # Delete
+}
+
+QUIT_KEY = "\x11"  # Ctrl+Q
+
+
+def read_key():
+    """Return the next key as a terminal-ready string, or None."""
+    if IS_WINDOWS:
+        if msvcrt.kbhit():
+            c = msvcrt.getwch()
+            if c in ("\x00", "\xe0"):
+                c2 = msvcrt.getwch()
+                return WIN_EXT_KEYS.get(c2, "")
+            return c
+        return None
+    else:
+        import select
+
+        r, _, _ = select.select([sys.stdin], [], [], 0)
+        if r:
+            return os.read(sys.stdin.fileno(), 1).decode("utf-8", errors="replace")
+        return None
+
+
+# ------------------------------------------------------------------ #
+#  Shared helpers
+# ------------------------------------------------------------------ #
+def write_out(text):
+    try:
+        sys.stdout.write(text)
+        sys.stdout.flush()
+    except Exception:
+        pass
+
+
+def console_size():
+    size = shutil.get_terminal_size(fallback=(80, 24))
+    return size.columns, size.lines
+
+
+def pick_port():
+    """Auto-detect the SSH port using the same logic as the web app.
+    Supports multiple process names (string or list in config)."""
+    cfg = load_ssh_config()
+    raw = cfg.get("process_name", "")
+    if isinstance(raw, list):
+        names = [str(n) for n in raw if n]
+    elif raw:
+        names = [str(raw)]
+    else:
+        names = []
+
+    ports = []
+    for name in names:
+        results = detect_process_port(name)
+        for proc in results:
+            ports.extend(p["port"] for p in proc.get("ports", []))
+    if not ports:
+        return None
+    if len(ports) > 1:
+        write_out(
+            f"\r\n*** 检测到多个端口: {', '.join(str(p) for p in ports)}"
+            f"（使用第一个，或用 --port 指定） ***\r\n"
+        )
+    return ports[0]
+
+
+# ------------------------------------------------------------------ #
+#  Mode 1: direct connection (fully independent from web/worker)
+# ------------------------------------------------------------------ #
+def run_direct(port):
+    logs_cfg = load_logs_config()
+    ilog = InteractionLog(f"cli_{port}", enabled=logs_cfg.get("interactive", True))
+    if logs_cfg.get("trace"):
+        try:
+            paramiko.util.log_to_file(
+                str(BASE_DIR / "logs" / f"paramiko_cli_{port}.log"), level="DEBUG"
+            )
+        except Exception:
+            pass
+
+    cfg = load_ssh_config()
+    write_out(f"\r\n*** 直连模式: {cfg.get('host')}:{port} (用户 {cfg.get('username')}) ***\r\n")
+
+    ilog.log("CONNECT-START", f"mode=direct port={port} pid={os.getpid()}")
+    client = paramiko.SSHClient()
+    client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+    try:
+        client.connect(
+            hostname=cfg.get("host", "127.0.0.1"),
+            port=port,
+            username=cfg.get("username", ""),
+            password=cfg.get("password", ""),
+            look_for_keys=False,
+            allow_agent=False,
+            timeout=10,
+            transport_factory=make_transport_factory(),
+        )
+    except Exception as e:
+        ilog.log("CONNECT-FAILED", repr(e))
+        write_out(f"\r\n*** 连接失败: {e} ***\r\n\r\n按任意键退出...")
+        read_key()
+        ilog.close()
+        return
+
+    transport = client.get_transport()
+    keepalive = float(cfg.get("keepalive_interval", 0))
+    if transport is not None and keepalive > 0:
+        transport.set_keepalive(keepalive)
+
+    channel = client.invoke_shell(term="xterm-256color")
+    try:
+        cols, rows = console_size()
+        channel.resize_pty(width=cols, height=rows)
+    except Exception:
+        pass
+
+    try:
+        ver = transport.remote_version if transport else "?"
+    except Exception:
+        ver = "?"
+    ilog.log("CONNECTED", f"server={ver}")
+    if ilog.path:
+        write_out(f"*** 交互日志: {ilog.path.name} ***\r\n")
+    write_out("*** 已连接。Ctrl+Q 本地退出；Ctrl+C 发送到远端 ***\r\n\r\n")
+
+    closed = threading.Event()
+    why = [""]
+
+    def reader():
+        try:
+            while not closed.is_set():
+                if channel.recv_ready():
+                    data = channel.recv(4096).decode("utf-8", errors="replace")
+                    if not data:
+                        break
+                    ilog.log("OUT", repr(data))
+                    write_out(data)
+                elif channel.exit_status_ready() and not channel.recv_ready():
+                    time.sleep(0.2)
+                    if not channel.recv_ready():
+                        why[0] = "远端 shell 已退出"
+                        break
+                elif transport is None or not transport.is_active():
+                    why[0] = "SSH 连接已关闭"
+                    break
+                else:
+                    time.sleep(0.02)
+        except Exception as e:
+            why[0] = f"读取错误: {e!r}"
+        finally:
+            closed.set()
+
+    t = threading.Thread(target=reader, daemon=True)
+    t.start()
+
+    last_size = console_size()
+    try:
+        while not closed.is_set():
+            key = read_key()
+            if key:
+                if key == QUIT_KEY:
+                    why[0] = "本地退出 (Ctrl+Q)"
+                    break
+                ilog.log("IN", repr(key))
+                try:
+                    channel.send(key)
+                except Exception as e:
+                    why[0] = f"发送失败: {e!r}"
+                    break
+            # follow console resizes
+            size = console_size()
+            if size != last_size:
+                last_size = size
+                ilog.log("RESIZE", f"{size[0]}x{size[1]}")
+                try:
+                    channel.resize_pty(width=size[0], height=size[1])
+                except Exception:
+                    pass
+            time.sleep(0.01)
+    finally:
+        closed.set()
+        t.join(timeout=1)
+        try:
+            channel.close()
+        except Exception:
+            pass
+        try:
+            client.close()
+        except Exception:
+            pass
+        ilog.log("DISCONNECTED", f"why={why[0] or 'exit'}")
+        ilog.close()
+        write_out(f"\r\n\r\n*** 会话结束: {why[0] or 'exit'} ***\r\n")
+
+
+# ------------------------------------------------------------------ #
+#  Mode 2: attach to an existing worker session
+# ------------------------------------------------------------------ #
+def run_attach(sid):
+    s = worker_connect(sid)
+    if s is None:
+        write_out(f"\r\n*** 无法接入会话 {sid}: worker 不在线 ***\r\n")
+        return
+    # long-lived proxy socket must not time out during quiet periods
+    try:
+        s.settimeout(None)
+    except Exception:
+        pass
+
+    write_out(f"\r\n*** 接入模式: 会话 {sid} (worker 后端保持不变) ***\r\n")
+    write_out("*** Ctrl+Q 返回本地（会话继续运行）；Ctrl+C 发送到远端 ***\r\n\r\n")
+
+    closed = threading.Event()
+
+    def reader():
+        buf = b""
+        try:
+            while not closed.is_set():
+                chunk = s.recv(4096)
+                if not chunk:
+                    break
+                buf += chunk
+                while b"\n" in buf:
+                    line, buf = buf.split(b"\n", 1)
+                    line = line.strip()
+                    if not line:
+                        continue
+                    try:
+                        ev = json.loads(line)
+                    except (json.JSONDecodeError, ValueError):
+                        continue
+                    if ev.get("ev") == "hello":
+                        # replay scrollback first
+                        for item in ev.get("scrollback", []):
+                            write_out(item.get("data", ""))
+                        write_out(
+                            f"\r\n*** 已接入 (state={ev.get('state')}, "
+                            f"{len(ev.get('scrollback', []))} 条历史) ***\r\n"
+                        )
+                    elif ev.get("ev") == "output":
+                        write_out(ev.get("data", ""))
+                    elif ev.get("ev") == "state":
+                        write_out(f"\r\n*** 状态: {ev.get('state')} {ev.get('why', '')} ***\r\n")
+                    elif ev.get("ev") == "bye":
+                        write_out("\r\n*** worker 会话已结束 ***\r\n")
+                        closed.set()
+                        return
+        except Exception:
+            pass
+        finally:
+            closed.set()
+
+    t = threading.Thread(target=reader, daemon=True)
+    t.start()
+
+    last_size = console_size()
+    try:
+        while not closed.is_set():
+            key = read_key()
+            if key:
+                if key == QUIT_KEY:
+                    break
+                send_ctrl(s, {"op": "input", "data": key})
+            size = console_size()
+            if size != last_size:
+                last_size = size
+                send_ctrl(s, {"op": "resize", "cols": size[0], "rows": size[1]})
+            time.sleep(0.01)
+    finally:
+        closed.set()
+        send_ctrl(s, {"op": "detach"})
+        t.join(timeout=1)
+        try:
+            s.close()
+        except Exception:
+            pass
+        write_out("\r\n\r\n*** 已退出接入（worker 会话继续运行） ***\r\n")
+
+
+# ------------------------------------------------------------------ #
+#  Mode 3: list worker sessions
+# ------------------------------------------------------------------ #
+def run_list():
+    sessions = worker_contexts()
+    if not sessions:
+        write_out("暂无存活的 worker 会话\r\n")
+        return
+    write_out(f"{'会话ID':<14} {'状态':<13} {'SSH端口':<8} {'PID':<8} 创建时间\r\n")
+    for s in sessions:
+        write_out(
+            f"{s.get('sid', ''):<14} {s.get('state', ''):<13} "
+            f"{s.get('ssh_port', ''):<8} {s.get('pid', ''):<8} {s.get('created', '')}\r\n"
+        )
+    write_out("\r\n接入: python ssh_cli.py --attach <会话ID>\r\n")
+
+
+# ------------------------------------------------------------------ #
+#  Entry
+# ------------------------------------------------------------------ #
+def main():
+    ap = argparse.ArgumentParser(
+        description="命令行 SSH 终端（与 web 界面独立，直连或接入 worker 会话）"
+    )
+    ap.add_argument("--port", type=int, help="直连指定 SSH 端口")
+    ap.add_argument("--attach", metavar="SID", help="接入已存在的 worker 会话")
+    ap.add_argument("--list", action="store_true", help="列出存活的 worker 会话")
+    args = ap.parse_args()
+
+    setup_stdout()
+
+    if args.list:
+        run_list()
+        return
+    if args.attach:
+        run_attach(args.attach)
+        return
+
+    port = args.port
+    if port is None:
+        port = pick_port()
+    if not port:
+        write_out(
+            "\r\n*** 未检测到可用端口。请确认隧道进程在运行，"
+            "或用 --port <端口> 手动指定 ***\r\n"
+        )
+        sys.exit(1)
+
+    if not IS_WINDOWS:
+        # POSIX: switch the tty to raw mode so keys go through unfiltered
+        old = termios.tcgetattr(sys.stdin)
+        tty.setraw(sys.stdin.fileno())
+        try:
+            run_direct(port)
+        finally:
+            termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old)
+    else:
+        run_direct(port)
+
+
+if __name__ == "__main__":
+    main()