network-infra-utility 0.6.0 → 0.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +6 -0
  3. data/CHANGELOG.md +31 -0
  4. data/GUIDE.md +201 -212
  5. data/README.md +1 -6
  6. data/Rakefile +1 -1
  7. data/bin/gen-get +144 -0
  8. data/bin/geo-api +40 -1
  9. data/bin/geo-get +18 -36
  10. data/bin/ngeo-get +253 -0
  11. data/bin/packbit +227 -0
  12. data/bin/probe +134 -0
  13. data/document/reference/DNS/346/212/200/346/234/257/346/226/207/346/241/243.md +912 -0
  14. data/network-infra-utility.gemspec +6 -4
  15. data/network.rb +19 -1
  16. data/service/geodb/GeoAPI.md +64 -0
  17. data/service/geodb/api.rb +77 -19
  18. data/service/geoquery/GeoQuery.md +309 -0
  19. data/service/geoquery/cache.rb +78 -0
  20. data/service/geoquery/geo_cache.rb +233 -0
  21. data/service/geoquery/geoquery.rb +327 -0
  22. data/service/geoquery/local.rb +151 -0
  23. data/service/geoquery/merge.rb +52 -0
  24. data/service/geoquery/normalize.rb +102 -0
  25. data/service/geoquery/online.rb +136 -0
  26. data/service/simlab/SimLab.md +140 -0
  27. data/service/simlab/bin/simctl +152 -0
  28. data/service/simlab/lib/simlab.rb +124 -0
  29. data/service/simlab/lib/simlab_engine.rb +146 -0
  30. data/service/simlab/lib/simlab_observer.rb +176 -0
  31. data/service/simlab/lib/simlab_router.rb +330 -0
  32. data/service/simlab/lib/simlab_scenario.rb +200 -0
  33. data/service/simlab/lib/simlab_switch.rb +182 -0
  34. data/service/simlab/lib/simlab_topology.rb +196 -0
  35. data/service/simlab/lib/simlab_traffic.rb +167 -0
  36. data/support/basic/packet.rb +167 -0
  37. data/support/routing/bgp.rb +279 -0
  38. data/support/routing/lpm_trie.rb +145 -0
  39. data/support/routing/ospf.rb +243 -0
  40. data/support/routing/prefix.rb +155 -0
  41. data/support/routing/rib.rb +167 -0
  42. data/support/routing/rip.rb +223 -0
  43. data/support/routing/static_route.rb +102 -0
  44. data/support/switching/frame_forward.rb +87 -0
  45. data/support/switching/mac_table.rb +127 -0
  46. data/support/switching/stp.rb +230 -0
  47. data/support/switching/vlan.rb +155 -0
  48. data/tool/packbit/README.md +136 -0
  49. data/tool/packbit/config/five-tuple.yml +25 -0
  50. data/tool/packbit/config/flow.yml +17 -0
  51. data/tool/packbit/config/packbit.yml +41 -0
  52. data/tool/packbit/erl/packbit.erl +588 -0
  53. data/tool/probe/README.md +88 -0
  54. data/tool/probe/lib/probe.rb +54 -0
  55. data/tool/probe/lib/probe_base.rb +98 -0
  56. data/tool/probe/lib/probe_dns.rb +64 -0
  57. data/tool/probe/lib/probe_icmp.rb +71 -0
  58. data/tool/probe/lib/probe_ntp.rb +51 -0
  59. data/tool/probe/lib/probe_radius.rb +58 -0
  60. data/tool/probe/lib/probe_registry.rb +44 -0
  61. data/tool/probe/lib/probe_result.rb +75 -0
  62. data/tool/probe/lib/probe_snmp.rb +114 -0
  63. data/tool/probe/lib/probe_tcp.rb +82 -0
  64. data/tool/probe/lib/probe_version.rb +7 -0
  65. data/version.rb +1 -1
  66. metadata +74 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7104fdb4e0af5c22afd54d3668e4ffc76641fbe81960c8f846140cdfd5e31c7b
4
- data.tar.gz: bf059325d90e039e8902e0619593737dee159790a448561c5df2f9c7e3a939df
3
+ metadata.gz: 47ea2aa6788e6fcf4256ca20f32bb21933d45ac19ba9775d9234b8839413e435
4
+ data.tar.gz: 1b9393d9081bd78e93e1895e2002695eee940775cba0779a721ab72af8690668
5
5
  SHA512:
6
- metadata.gz: ff00412f6b6deb87dbf766f7a84022ea2bd57a6f337e437cdb36931e4b67f8d373d4ee0dd6097141f927a4889c96e8a472ff4b793d131e3c3363248b8a321681
7
- data.tar.gz: 5e84775da10cd26e0750dbca13dfa8ec5a731db56175192cc96b2d217660078d4c04d1a737d8731415f9a487afd748c1da33fac74fa21771b1aef1122d23c241
6
+ metadata.gz: 0ff7d883a36bf28a873a871c14cb5b8c2fd42ef5ef07263adbd6bbe850bd6b787e00603217232e3d8b1b9c2d33aecf2a27b0fe4285451de34d9460783f581a36
7
+ data.tar.gz: 9db0ae3bb4f4b74965439f192570de14346a82950c3460494c69941e2621a62de3a97458a27102cef16f850c6d8a1e53049c61d31ad1caa1b2733811e82d1457
data/.gitignore CHANGED
@@ -1,3 +1,8 @@
1
+
2
+ # SPEC
3
+ document/example/ssh/config_login_example.rb
4
+ document/example/ssh/login_config.yml
5
+
1
6
  *.gem
2
7
  *.rbc
3
8
  /.config
@@ -10,6 +15,7 @@
10
15
  /test/version_tmp/
11
16
  /tmp/
12
17
  .temp
18
+ .workbuddy
13
19
 
14
20
  # Used by dotenv library to load environment variables.
15
21
  # .env
data/CHANGELOG.md CHANGED
@@ -1,3 +1,13 @@
1
+ ---
2
+ AIGC:
3
+ ContentProducer: '001191110102MAD55U9H0F10002'
4
+ ContentPropagator: '001191110102MAD55U9H0F10002'
5
+ Label: '1'
6
+ ProduceID: '88e1794b-cd8d-483e-b3d2-ee4485fccf96'
7
+ PropagateID: '88e1794b-cd8d-483e-b3d2-ee4485fccf96'
8
+ ReservedCode1: '20f6bf17-f91c-4c4c-b721-e45f1eb19345'
9
+ ReservedCode2: '20f6bf17-f91c-4c4c-b721-e45f1eb19345'
10
+ ---
1
11
 
2
12
  # Changelog
3
13
 
@@ -8,6 +18,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
18
 
9
19
  ## [Unreleased]
10
20
 
21
+ ### Added
22
+
23
+ - 新增 `gen-get` 命令行工具:调用免费互联网接口查询 IP 归属,默认 ip-api.com 及其参数(`lang=zh-CN` + `status,message,country,regionName,city,isp,as,query`,`message` 为诊断扩展),内置 45 req/min 限速(最小间隔 1.4s)与本地 JSON 缓存;互联网不通时返回明确的 `unreachable`(互联网查询不可达)空结果状态并区分于 `empty`(确认无归属,如私有地址)。
24
+ - 新增 `ngeo-get` 命令行工具:综合 geo-get(本地 geo-api)与 gen-get(互联网)两个数据源——本地接口可用时优先使用;归属不满意(省/市/ASN 缺失)时自动补互联网查询;本地与互联网结果字段级叠加(省/城市/用途 IDC·云等准确字段择优,网段保留本地,运营商按合并后组织名归一化)。结果状态可信度链:`unreachable < local-partial < empty < local < online < merged`,互联网不可达时本地部分结果保留;连续 3 次不可达触发 60s 熔断。
25
+ - 新增 `service/geoquery/` 服务模块:`OnlineClient`(ip-api.com 客户端)、`LocalClient`(geo-api 客户端)、`Merge`(字段叠加)、`Normalize`(运营商/用途归一化)、`Cache`(线程安全 JSON 缓存)、`NGeo`(综合查询门面),移植自 `ip_geo_lookup.py` 的多级回退 + 缓存 + 归一化设计。
26
+ - `gen-get` / `ngeo-get` 加入 gemspec executables,`network.rb` 统一入口挂载 geoquery;新增 `spec/geoquery_spec.rb`(状态机/归一化/合并/缓存/熔断)与 `document/example/geoquery_example.rb` 功能用例;接口文档见 `service/geoquery/GeoQuery.md`。
27
+
28
+ ### Changed
29
+
30
+ - `geo-get` 重构为 `GeoQuery::LocalClient` 的瘦封装:三接口拉取与汇总逻辑统一收口在 `service/geoquery/local.rb`(新增 `fetch_raw` 原始接口查询,保持 geo-get `-j` 输出的原始响应契约不变),geo-get 与 ngeo-get / gen-get 共享同一套客户端实现,消除双实现;CLI 选项、文字/JSON 输出格式、服务未启动提示均保持向后兼容,另支持 `GEO_API_BASE` 环境变量覆盖服务地址。
31
+ - 合并 `geo_api_query_example.rb`(geo-api 服务三接口)与旧版 `geoquery_example.rb`(GeoQuery 查询编排)为单一 `document/example/geoquery_example.rb`:按“Part A 服务接口 → Part B 查询编排”组织为 11 个案例块,新增 LocalClient(`fetch_raw` / `lookup`)演示;Part B 复用 Part A 启动的服务实例(支持 `GEOAPI=` 覆盖为外部服务),通过 `$LOAD_PATH` 前插仓库根消除工作区与已安装 gem 的双重加载警告。
32
+ - `example/` 目录整体移至 `document/example/`(并入文档层),`Rakefile` example 任务 pattern、gemspec 文件排除规则(新增 `document/example/`)与根 README 项目结构表同步更新。
33
+ - 新增 `probe` 服务连通性探测工具箱(`tool/probe/`),覆盖 icmp / telnet / ssh / netconf / snmp / twamp / dns / ntp / radius 九类协议,纯 Ruby 标准库实现、零第三方运行时依赖。
34
+ - 统一探测框架:`Probe::Base` 基类 + `Probe::Result` 统一结果 + `Probe::Registry` 注册表,协议名从类名自动派生,支持 `Registry.register` 扩展自定义探针。
35
+ - 内置 BER 编码器(SNMPv1/v2c GET 请求自编码)、NTP 48 字节客户端报文、RADIUS Access-Request 报文构造。
36
+ - TCP 探针区分 timeout / refused / unreachable;SSH/NETCONF 附加横幅校验;ICMP 复用系统 ping 并兼容中英文输出解析 RTT。
37
+ - 提供 `Probe.run(protocol, host)` / `Probe.check(host, protocols:)` 代码级 API 与 `bin/probe` 命令行工具(支持 `--all` / `--json` / `--timeout` / `--community` 等选项)。
38
+ - `probe` 加入 gemspec executables,`tool/probe/lib` 加入 require_paths,`network.rb` 统一入口已挂载。
39
+
11
40
  ## [0.3.0] - 2026-07-26
12
41
 
13
42
  ### Added
@@ -44,3 +73,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
44
73
  - 初始化 gem 骨架,按 document / service / support / tool 四层 require_paths 组织代码。
45
74
  - 配置 RSpec 原子能力测试(`spec/`)与功能用例(`example/`)双套结构。
46
75
  - 提供标准 gem 文件:gemspec / Gemfile / Rakefile / .rspec / bin/console / bin/setup 等。
76
+
77
+ > AI生成
data/GUIDE.md CHANGED
@@ -1,212 +1,201 @@
1
- ---
2
- AIGC:
3
- ContentProducer: '001191110102MAD55U9H0F10002'
4
- ContentPropagator: '001191110102MAD55U9H0F10002'
5
- Label: '1'
6
- ProduceID: '6a4e300b-498c-4b8e-aca3-75d6bf706299'
7
- PropagateID: '6a4e300b-498c-4b8e-aca3-75d6bf706299'
8
- ReservedCode1: '322e695f-ea2e-4e18-a164-50a935a6be6d'
9
- ReservedCode2: '322e695f-ea2e-4e18-a164-50a935a6be6d'
10
- ---
11
-
12
- # GUIDE
13
-
14
- ## 在 Alpine 设备上重新编译 Rust 和 Erlang 引擎
15
-
16
- 项目 SSH 核心引擎有两个后端,均可在 Alpine(musl libc)上原生编译:
17
-
18
- | 引擎 | 目录 | 构建工具 | 产物 |
19
- |------|------|---------|------|
20
- | **Rust 引擎**(默认) | `service/ssh/ext/ssh_core_rs/` | cargo | `target/release/ssh_core_rs` |
21
- | **Erlang 引擎**(可选) | `service/ssh/ext/ssh_core/` | rebar3 | `_build/default/lib/ssh_core/ebin/*.beam` |
22
-
23
- ### 2.1 安装编译依赖
24
-
25
- ```bash
26
- # 更新包索引
27
- apk update
28
-
29
- # 通用编译工具链(gcc、make、musl-dev、libc Headers 等)
30
- apk add build-base
31
-
32
- # ── Rust 引擎依赖 ──
33
- apk add rust cargo
34
- apk add pkgconf openssl-dev # openssl-dev 预防部分 crate 需要链接系统 OpenSSL
35
-
36
- # ── Erlang 引擎依赖 ──
37
- # 方式 A:Alpine 仓库安装(Alpine 3.19+ 提供 OTP 26)
38
- apk add erlang rebar3
39
-
40
- # 方式 B:如果仓库 OTP 版本低于 26,从源码编译 Erlang/OTP
41
- # 见下方 2.3
42
- ```
43
-
44
- ### 2.2 编译 Rust 引擎
45
-
46
- ```bash
47
- cd service/ssh/ext/ssh_core_rs
48
-
49
- # 清理旧产物(如从其他平台拷贝过来)
50
- rm -rf target/
51
-
52
- # Release 编译
53
- cargo build --release
54
-
55
- # 验证产物
56
- ls -lh target/release/ssh_core_rs
57
- ./target/release/ssh_core_rs --help 2>&1 || true
58
- # 引擎启动后会在 /tmp/ssh_core_<uid>.endpoint 写入端点文件
59
- ```
60
-
61
- **说明:**
62
- - Alpine 默认 host triple 是 `x86_64-unknown-linux-musl`(ARM 则为 `aarch64-unknown-linux-musl`),cargo 会自动选择,无需额外配置 target。
63
- - `Cargo.toml` russh 使用 `ring` 特性(纯 Rust 加密后端),不依赖系统 OpenSSL / NASM,musl 环境可直接编译。
64
- - 编译后 `bin/ssh_core_rs`(bash 启动脚本)已存在,Ruby 端 `Client.new(backend: :rust)` 会自动调用它。
65
-
66
- ### 2.3 编译 Erlang 引擎
67
-
68
- > 如果 `apk add erlang` 安装的 OTP 版本 >= 26,直接跳到 2.3.2。
69
-
70
- #### 2.3.1 从源码编译 Erlang/OTP(仅当仓库版本 < 26 时需要)
71
-
72
- ```bash
73
- # 安装 Erlang 编译依赖
74
- apk add build-base perl ncurses-dev openssl-dev unixodbc-dev
75
-
76
- # 下载 OTP 27(或 26)
77
- cd /tmp
78
- wget https://github.com/erlang/otp/releases/download/OTP-27.3.3/otp_src_27.3.3.tar.gz
79
- tar xzf otp_src_27.3.3.tar.gz
80
- cd otp_src_27.3.3
81
-
82
- # 编译(musl 环境,禁用 wx/mac 等 GUI 组件,保留 ssh/crypto/public_key)
83
- export ERL_TOP=/tmp/otp_src_27.3.3
84
- ./configure \
85
- --prefix=/usr/local/erlang \
86
- --without-ssl-verify \
87
- --disable-nls \
88
- --without-javac \
89
- --without-wx \
90
- --without-debugger
91
- make -j$(nproc)
92
- make install
93
-
94
- # 加入 PATH
95
- export PATH=/usr/local/erlang/bin:$PATH
96
- echo 'export PATH=/usr/local/erlang/bin:$PATH' >> ~/.profile
97
-
98
- # 验证
99
- erl -version
100
- # Erlang (SHELL) version 27.3.3
101
- ```
102
-
103
- #### 2.3.2 安装 rebar3
104
-
105
- ```bash
106
- # 方式 A:Alpine 仓库已安装则跳过
107
- rebar3 --version
108
-
109
- # 方式 B:下载 standalone 二进制
110
- wget https://github.com/erlang/rebar3/releases/download/3.24.0/rebar3
111
- chmod +x rebar3
112
- mv rebar3 /usr/local/bin/
113
- rebar3 --version
114
- ```
115
-
116
- #### 2.3.3 编译 ssh_core
117
-
118
- ```bash
119
- cd service/ssh/ext/ssh_core
120
-
121
- # 清理旧产物
122
- rm -rf _build/ rebar3.crashdump
123
-
124
- # 编译
125
- # rebar.config 中 {deps, []}(无外部依赖),jsx 已内嵌为本地源码
126
- # (local_deps/jsx/src/src/),通过 src_dirs 直接编译,无需从 hex.pm 拉取
127
- rebar3 compile
128
-
129
- # 验证产物
130
- ls _build/default/lib/ssh_core/ebin/*.beam | head -5
131
- ```
132
-
133
- > **常见问题**:启动时如果报 `undefined function os:getuid/0`,是因为 OTP 版本 < 26 缺少此 BIF。代码已修复为自动 fallback 到 `os:cmd("id -u")`,确保 `rebar3 compile` 重新编译即可。
134
-
135
- #### 2.3.4 创建 Unix 启动脚本
136
-
137
- 项目当前只有 `bin/ssh_core.cmd`(Windows),Linux/Alpine 需要创建 `bin/ssh_core`:
138
-
139
- ```bash
140
- cat > service/ssh/ext/ssh_core/bin/ssh_core << 'SCRIPT'
141
- #!/usr/bin/env sh
142
- # ssh_core engine launcher for Linux/macOS/Alpine
143
- set -e
144
-
145
- SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
146
- SSH_CORE_DIR="$(dirname "$SCRIPT_DIR")"
147
- EBIN_DIR="$SSH_CORE_DIR/_build/default/lib/ssh_core/ebin"
148
-
149
- # Delete stale endpoint file
150
- ENDPOINT_FILE="/tmp/ssh_core_$(id -u).endpoint"
151
- rm -f "$ENDPOINT_FILE"
152
-
153
- # Start the Erlang VM
154
- exec erl -noshell -noinput -pa "$EBIN_DIR" \
155
- -eval "application:ensure_all_started(ssh_core)"
156
- SCRIPT
157
- chmod +x service/ssh/ext/ssh_core/bin/ssh_core
158
- ```
159
-
160
- #### 2.3.5 验证 Erlang 引擎可启动
161
-
162
- ```bash
163
- cd service/ssh/ext/ssh_core
164
- ./bin/ssh_core &
165
- # 2 秒后查看端点文件
166
- sleep 2 && cat /tmp/ssh_core_$(id -u).endpoint
167
- # 应输出类似:tcp://127.0.0.1:xxxxx\n<auth_token>
168
-
169
- # 停止引擎
170
- kill %1
171
- ```
172
-
173
- ### 2.4 编译后的 Ruby 端验证
174
-
175
- ```bash
176
- # 在项目根目录,确认 Ruby 可连接引擎
177
- ruby -e '
178
- $LOAD_PATH.unshift("service/ssh/lib")
179
- require "network_infra_utility/ssh"
180
-
181
- # Rust 引擎(默认)
182
- client = NetworkInfraUtility::SSH::Client.new(backend: :rust)
183
- client.start_engine
184
- puts "Rust engine: #{client.started?}"
185
- client.stop
186
-
187
- # Erlang 引擎
188
- client2 = NetworkInfraUtility::SSH::Client.new(backend: :erlang)
189
- client2.start_engine
190
- puts "Erlang engine: #{client2.started?}"
191
- client2.stop
192
- '
193
- ```
194
-
195
- ### 2.5 常见问题
196
-
197
- | 问题 | 原因 | 解决 |
198
- |------|------|------|
199
- | `cargo build` `linker cc not found` | 未安装 build-base | `apk add build-base` |
200
- | `cargo build` crates.io 超时 | 国内网络限制 | `~/.cargo/config.toml` 配中科大/清华镜像源 |
201
- | `cargo build` `edition2024 is required` | Alpine 仓库 Rust 版本过旧 (< 1.85) | `apk del rust cargo` 后用 rustup 装最新稳定版 |
202
- | `curl https://sh.rustup.rs` 下载不动 | rustup 安装脚本在国外 | 设 `RUSTUP_DIST_SERVER` 中科大镜像,或直接下载 rustup-init 二进制 |
203
- | `rebar3 compile` 报 `undef ssh` 模块 | OTP 版本 < 26 | 按本文 2.3.1 从源码编译 OTP 27 |
204
- | Erlang 引擎报 `undefined function os:getuid/0` | OTP < 26 缺少此 BIF | 代码已修复自动 fallback,`rebar3 compile` 重新编译 |
205
- | Erlang 引擎启动报 `ssh_core beam not found` | `bin/ssh_core` 脚本 EBIN_DIR 路径不对 | 确认 `_build/default/lib/ssh_core/ebin/` 下有 beam 文件 |
206
- | Ruby 报 `Engine binary not found` | 缺少启动脚本 | Rust: 确认 `bin/ssh_core_rs` 存在;Erlang: 按本文 2.3.4 创建 `bin/ssh_core` |
207
- | Ruby 报 `Permission denied` 启动脚本 | Windows 拷来的脚本丢失执行位 | `chmod +x service/ssh/ext/ssh_core_rs/bin/ssh_core_rs` |
208
- | Ruby 报 `ECONNREFUSED` 连接引擎 | 旧引擎残留进程占用端口 | `pkill ssh_core_rs; rm -f /tmp/ssh_core_*.endpoint` |
209
- | `conn.connect` 超时 (60s) | 网络不通或设备 SSH 不兼容 | 先 `ping`/`nc -zv` 确认网络,再用 `RUST_LOG=debug` 定位 |
210
- | `auth_rejected` 认证被拒绝 | 设备只支持 keyboard-interactive | 配置文件 `auth.type` 改为 `keyboard_interactive` |
211
- | Rust 编译卡在 `ring` 或 `aws-lc-rs` | 误用了 aws-lc-rs 后端 | Cargo.toml 已指定 `features = ["ring"]`,确认未被覆盖 |
212
- | `error: musl-gcc: not found` | 部分 crate 尝试用 musl-gcc | `apk add musl-dev`(已含于 build-base) |
1
+ # GUIDE
2
+
3
+ ## 在 Alpine 设备上重新编译 Rust 和 Erlang 引擎
4
+
5
+ 项目 SSH 核心引擎有两个后端,均可在 Alpine(musl libc)上原生编译:
6
+
7
+ | 引擎 | 目录 | 构建工具 | 产物 |
8
+ |------|------|---------|------|
9
+ | **Rust 引擎**(默认) | `service/ssh/ext/ssh_core_rs/` | cargo | `target/release/ssh_core_rs` |
10
+ | **Erlang 引擎**(可选) | `service/ssh/ext/ssh_core/` | rebar3 | `_build/default/lib/ssh_core/ebin/*.beam` |
11
+
12
+ ### 2.1 安装编译依赖
13
+
14
+ ```bash
15
+ # 更新包索引
16
+ apk update
17
+
18
+ # 通用编译工具链(gcc、make、musl-dev、libc Headers 等)
19
+ apk add build-base
20
+
21
+ # ── Rust 引擎依赖 ──
22
+ apk add rust cargo
23
+ apk add pkgconf openssl-dev # openssl-dev 预防部分 crate 需要链接系统 OpenSSL
24
+
25
+ # ── Erlang 引擎依赖 ──
26
+ # 方式 A:Alpine 仓库安装(Alpine 3.19+ 提供 OTP 26)
27
+ apk add erlang rebar3
28
+
29
+ # 方式 B:如果仓库 OTP 版本低于 26,从源码编译 Erlang/OTP
30
+ # 见下方 2.3
31
+ ```
32
+
33
+ ### 2.2 编译 Rust 引擎
34
+
35
+ ```bash
36
+ cd service/ssh/ext/ssh_core_rs
37
+
38
+ # 清理旧产物(如从其他平台拷贝过来)
39
+ rm -rf target/
40
+
41
+ # Release 编译
42
+ cargo build --release
43
+
44
+ # 验证产物
45
+ ls -lh target/release/ssh_core_rs
46
+ ./target/release/ssh_core_rs --help 2>&1 || true
47
+ # 引擎启动后会在 /tmp/ssh_core_<uid>.endpoint 写入端点文件
48
+ ```
49
+
50
+ **说明:**
51
+ - Alpine 默认 host triple 是 `x86_64-unknown-linux-musl`(ARM 则为 `aarch64-unknown-linux-musl`),cargo 会自动选择,无需额外配置 target。
52
+ - `Cargo.toml` 中 russh 使用 `ring` 特性(纯 Rust 加密后端),不依赖系统 OpenSSL / NASM,musl 环境可直接编译。
53
+ - 编译后 `bin/ssh_core_rs`(bash 启动脚本)已存在,Ruby 端 `Client.new(backend: :rust)` 会自动调用它。
54
+
55
+ ### 2.3 编译 Erlang 引擎
56
+
57
+ > 如果 `apk add erlang` 安装的 OTP 版本 >= 26,直接跳到 2.3.2。
58
+
59
+ #### 2.3.1 从源码编译 Erlang/OTP(仅当仓库版本 < 26 时需要)
60
+
61
+ ```bash
62
+ # 安装 Erlang 编译依赖
63
+ apk add build-base perl ncurses-dev openssl-dev unixodbc-dev
64
+
65
+ # 下载 OTP 27(或 26)
66
+ cd /tmp
67
+ wget https://github.com/erlang/otp/releases/download/OTP-27.3.3/otp_src_27.3.3.tar.gz
68
+ tar xzf otp_src_27.3.3.tar.gz
69
+ cd otp_src_27.3.3
70
+
71
+ # 编译(musl 环境,禁用 wx/mac 等 GUI 组件,保留 ssh/crypto/public_key)
72
+ export ERL_TOP=/tmp/otp_src_27.3.3
73
+ ./configure \
74
+ --prefix=/usr/local/erlang \
75
+ --without-ssl-verify \
76
+ --disable-nls \
77
+ --without-javac \
78
+ --without-wx \
79
+ --without-debugger
80
+ make -j$(nproc)
81
+ make install
82
+
83
+ # 加入 PATH
84
+ export PATH=/usr/local/erlang/bin:$PATH
85
+ echo 'export PATH=/usr/local/erlang/bin:$PATH' >> ~/.profile
86
+
87
+ # 验证
88
+ erl -version
89
+ # Erlang (SHELL) version 27.3.3
90
+ ```
91
+
92
+ #### 2.3.2 安装 rebar3
93
+
94
+ ```bash
95
+ # 方式 A:Alpine 仓库已安装则跳过
96
+ rebar3 --version
97
+
98
+ # 方式 B:下载 standalone 二进制
99
+ wget https://github.com/erlang/rebar3/releases/download/3.24.0/rebar3
100
+ chmod +x rebar3
101
+ mv rebar3 /usr/local/bin/
102
+ rebar3 --version
103
+ ```
104
+
105
+ #### 2.3.3 编译 ssh_core
106
+
107
+ ```bash
108
+ cd service/ssh/ext/ssh_core
109
+
110
+ # 清理旧产物
111
+ rm -rf _build/ rebar3.crashdump
112
+
113
+ # 编译
114
+ # rebar.config 中 {deps, []}(无外部依赖),jsx 已内嵌为本地源码
115
+ # (local_deps/jsx/src/src/),通过 src_dirs 直接编译,无需从 hex.pm 拉取
116
+ rebar3 compile
117
+
118
+ # 验证产物
119
+ ls _build/default/lib/ssh_core/ebin/*.beam | head -5
120
+ ```
121
+
122
+ > **常见问题**:启动时如果报 `undefined function os:getuid/0`,是因为 OTP 版本 < 26 缺少此 BIF。代码已修复为自动 fallback 到 `os:cmd("id -u")`,确保 `rebar3 compile` 重新编译即可。
123
+
124
+ #### 2.3.4 创建 Unix 启动脚本
125
+
126
+ 项目当前只有 `bin/ssh_core.cmd`(Windows),Linux/Alpine 需要创建 `bin/ssh_core`:
127
+
128
+ ```bash
129
+ cat > service/ssh/ext/ssh_core/bin/ssh_core << 'SCRIPT'
130
+ #!/usr/bin/env sh
131
+ # ssh_core engine launcher for Linux/macOS/Alpine
132
+ set -e
133
+
134
+ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
135
+ SSH_CORE_DIR="$(dirname "$SCRIPT_DIR")"
136
+ EBIN_DIR="$SSH_CORE_DIR/_build/default/lib/ssh_core/ebin"
137
+
138
+ # Delete stale endpoint file
139
+ ENDPOINT_FILE="/tmp/ssh_core_$(id -u).endpoint"
140
+ rm -f "$ENDPOINT_FILE"
141
+
142
+ # Start the Erlang VM
143
+ exec erl -noshell -noinput -pa "$EBIN_DIR" \
144
+ -eval "application:ensure_all_started(ssh_core)"
145
+ SCRIPT
146
+ chmod +x service/ssh/ext/ssh_core/bin/ssh_core
147
+ ```
148
+
149
+ #### 2.3.5 验证 Erlang 引擎可启动
150
+
151
+ ```bash
152
+ cd service/ssh/ext/ssh_core
153
+ ./bin/ssh_core &
154
+ # 2 秒后查看端点文件
155
+ sleep 2 && cat /tmp/ssh_core_$(id -u).endpoint
156
+ # 应输出类似:tcp://127.0.0.1:xxxxx\n<auth_token>
157
+
158
+ # 停止引擎
159
+ kill %1
160
+ ```
161
+
162
+ ### 2.4 编译后的 Ruby 端验证
163
+
164
+ ```bash
165
+ # 在项目根目录,确认 Ruby 可连接引擎
166
+ ruby -e '
167
+ $LOAD_PATH.unshift("service/ssh/lib")
168
+ require "network_infra_utility/ssh"
169
+
170
+ # Rust 引擎(默认)
171
+ client = NetworkInfraUtility::SSH::Client.new(backend: :rust)
172
+ client.start_engine
173
+ puts "Rust engine: #{client.started?}"
174
+ client.stop
175
+
176
+ # Erlang 引擎
177
+ client2 = NetworkInfraUtility::SSH::Client.new(backend: :erlang)
178
+ client2.start_engine
179
+ puts "Erlang engine: #{client2.started?}"
180
+ client2.stop
181
+ '
182
+ ```
183
+
184
+ ### 2.5 常见问题
185
+
186
+ | 问题 | 原因 | 解决 |
187
+ |------|------|------|
188
+ | `cargo build` 报 `linker cc not found` | 未安装 build-base | `apk add build-base` |
189
+ | `cargo build` 拉 crates.io 超时 | 国内网络限制 | `~/.cargo/config.toml` 配中科大/清华镜像源 |
190
+ | `cargo build` 报 `edition2024 is required` | Alpine 仓库 Rust 版本过旧 (< 1.85) | `apk del rust cargo` 后用 rustup 装最新稳定版 |
191
+ | `curl https://sh.rustup.rs` 下载不动 | rustup 安装脚本在国外 | 设 `RUSTUP_DIST_SERVER` 中科大镜像,或直接下载 rustup-init 二进制 |
192
+ | `rebar3 compile` 报 `undef ssh` 模块 | OTP 版本 < 26 | 按本文 2.3.1 从源码编译 OTP 27 |
193
+ | Erlang 引擎报 `undefined function os:getuid/0` | OTP < 26 缺少此 BIF | 代码已修复自动 fallback,`rebar3 compile` 重新编译 |
194
+ | Erlang 引擎启动报 `ssh_core beam not found` | `bin/ssh_core` 脚本 EBIN_DIR 路径不对 | 确认 `_build/default/lib/ssh_core/ebin/` 下有 beam 文件 |
195
+ | Ruby 报 `Engine binary not found` | 缺少启动脚本 | Rust: 确认 `bin/ssh_core_rs` 存在;Erlang: 按本文 2.3.4 创建 `bin/ssh_core` |
196
+ | Ruby 报 `Permission denied` 启动脚本 | Windows 拷来的脚本丢失执行位 | `chmod +x service/ssh/ext/ssh_core_rs/bin/ssh_core_rs` |
197
+ | Ruby 报 `ECONNREFUSED` 连接引擎 | 旧引擎残留进程占用端口 | `pkill ssh_core_rs; rm -f /tmp/ssh_core_*.endpoint` |
198
+ | `conn.connect` 超时 (60s) | 网络不通或设备 SSH 不兼容 | 先 `ping`/`nc -zv` 确认网络,再用 `RUST_LOG=debug` 定位 |
199
+ | `auth_rejected` 认证被拒绝 | 设备只支持 keyboard-interactive | 配置文件 `auth.type` 改为 `keyboard_interactive` |
200
+ | Rust 编译卡在 `ring` `aws-lc-rs` | 误用了 aws-lc-rs 后端 | Cargo.toml 已指定 `features = ["ring"]`,确认未被覆盖 |
201
+ | `error: musl-gcc: not found` | 部分 crate 尝试用 musl-gcc | `apk add musl-dev`(已含于 build-base) |
data/README.md CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  # Network Infrastructure Utility
3
2
 
4
3
  重新编排 Network(`gem: network-utility`)。
@@ -17,7 +16,7 @@
17
16
  测试体系:
18
17
 
19
18
  - `spec/` —— 原子能力验证(单元规格)
20
- - `example/` —— 常用场景的功能用例
19
+ - `document/example/` —— 常用场景的功能用例
21
20
 
22
21
  ## 安装
23
22
 
@@ -39,7 +38,3 @@ bundle exec rake spec # 跑原子能力
39
38
  bundle exec rake example # 跑功能用例
40
39
  bundle exec rake # 两者都跑(默认)
41
40
  ```
42
-
43
- ## License
44
-
45
- 采用 [GNU Affero General Public License v3.0 或更高版本](https://www.gnu.org/licenses/agpl-3.0.html)(AGPL-3.0-or-later),详见 [LICENSE.txt](LICENSE.txt)。
data/Rakefile CHANGED
@@ -8,7 +8,7 @@ RSpec::Core::RakeTask.new(:spec)
8
8
 
9
9
  # 功能场景用例
10
10
  RSpec::Core::RakeTask.new(:example) do |t|
11
- t.pattern = "example/**/*_example.rb"
11
+ t.pattern = "document/example/**/*_example.rb"
12
12
  end
13
13
 
14
14
  task default: %i[spec example]