dsh-git-push 2.9.1 → 2.9.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.
- package/README.md +6 -2
- package/assets/preview.html +1 -1
- package/lib/app/command-registry.js +1 -0
- package/lib/app/tool-call.js +35 -7
- package/lib/ast/fs-hotspots.js +154 -0
- package/lib/ast/perf.js +26 -10
- package/lib/audit/collector.js +4 -0
- package/lib/audit/orchestrate.js +3 -1
- package/lib/audit-rules/audit-rules-cpp.yml +106 -14
- package/lib/audit-rules/audit-rules-go.yml +95 -14
- package/lib/audit-rules/audit-rules-performance.yml +32 -6
- package/lib/audit-rules/audit-rules-php.yml +93 -14
- package/lib/audit-rules/audit-rules-rust.yml +101 -14
- package/lib/audit-rules/audit-rules-swift.yml +91 -14
- package/lib/checks/fs-scanner.js +57 -0
- package/lib/checks/index.js +1 -0
- package/lib/core/workspace-paths.js +13 -5
- package/lib/fs/edit-after-read.js +39 -0
- package/lib/rule/compilers/numeric-kinds.js +7 -0
- package/lib/self/index.js +1 -1
- package/package.json +1 -1
- package/scripts/doc-version.mjs +19 -90
- package/scripts/readme-gen.mjs +72 -22
- package/scripts/scan-fs-hotspots.mjs +107 -0
- package/skills/dev/dsh-git-push.md +18 -1
|
@@ -1,22 +1,103 @@
|
|
|
1
1
|
# ============================================================
|
|
2
|
-
# Go
|
|
3
|
-
# 版本:0.
|
|
2
|
+
# Go 代码审计规则集(首版 · 语言专项)
|
|
3
|
+
# 版本:0.2.0
|
|
4
4
|
# 适用:Go 项目
|
|
5
|
-
#
|
|
6
|
-
#
|
|
7
|
-
#
|
|
8
|
-
#
|
|
9
|
-
#
|
|
10
|
-
# (func 关键字 + 花括号配对);② 本槽位按 python/java 先例写 min_length/
|
|
11
|
-
# max_depth/max_lines/max_complexity/magic-number 规则,exts: ["go"]。
|
|
5
|
+
# 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
|
|
6
|
+
# 规则依据:对真实 Go 仓(spf13/cobra 等样本仓)实测各候选模式的出现次数后选型——
|
|
7
|
+
# 只收「高信号 + 可判事实」的形态,避免静态扫 Go 时满屏噪音。
|
|
8
|
+
# (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.go)
|
|
9
|
+
# 口径:exts 只认 .go;测试与示例目录用 exclude_paths 排除(测试里 panic/exit 是常态)。
|
|
12
10
|
# ============================================================
|
|
13
11
|
|
|
14
12
|
metadata:
|
|
15
|
-
name: "Go
|
|
16
|
-
version: "0.
|
|
13
|
+
name: "Go 审计规则集(首版 · 语言专项)"
|
|
14
|
+
version: "0.2.0"
|
|
17
15
|
language: "go"
|
|
18
16
|
author: "DeepSeek"
|
|
19
|
-
description: "Go
|
|
20
|
-
last_updated: "2026-10-
|
|
17
|
+
description: "Go 项目语言专用规则(pattern 层首版:panic/os.Exit/fmt.Print/context.TODO/unsafe)"
|
|
18
|
+
last_updated: "2026-10-16"
|
|
21
19
|
|
|
22
|
-
rules:
|
|
20
|
+
rules:
|
|
21
|
+
# ----- 1. 健壮性 -----
|
|
22
|
+
|
|
23
|
+
- id: go/panic-outside-init
|
|
24
|
+
name: "Go 避免在库代码里 panic"
|
|
25
|
+
category: "robustness"
|
|
26
|
+
severity: "warning"
|
|
27
|
+
description: "库代码 panic 会把调用方进程直接带走;应由调用方决定错误处置(返回 error 或 os.Exit 在 main 里做)"
|
|
28
|
+
# 负向环视避免命中 `x.panic(` 这类方法调用;测试/示例目录排除(测试里 panic 是断言手段)
|
|
29
|
+
patterns:
|
|
30
|
+
- "(?<![\\w$.])panic\\s*\\("
|
|
31
|
+
# 注:exclude_paths 是**路径前缀**匹配 ⇒ 无法表达 "_test.go" 这类后缀;
|
|
32
|
+
# 同目录的测试文件仍会命中(报告里给了目录级豁免提示)。此前这里写过一条
|
|
33
|
+
# "_test.go" 是**死条目**(永不生效 ✗),2026-10-16 已删。
|
|
34
|
+
exts: ["go"]
|
|
35
|
+
exclude_paths:
|
|
36
|
+
- "test/"
|
|
37
|
+
- "tests/"
|
|
38
|
+
- "testdata/"
|
|
39
|
+
- "example/"
|
|
40
|
+
- "examples/"
|
|
41
|
+
fixable: false
|
|
42
|
+
|
|
43
|
+
- id: go/os-exit-in-library
|
|
44
|
+
name: "Go 库代码避免 os.Exit"
|
|
45
|
+
category: "robustness"
|
|
46
|
+
severity: "warning"
|
|
47
|
+
description: "os.Exit 跳过 defer 清理(文件/锁/连接不会释放),且让调用方无法拦截;只在 main 或 CLI 入口使用"
|
|
48
|
+
patterns:
|
|
49
|
+
- "(?<![\\w$.])os\\.Exit\\s*\\("
|
|
50
|
+
exts: ["go"]
|
|
51
|
+
exclude_paths:
|
|
52
|
+
- "test/"
|
|
53
|
+
- "tests/"
|
|
54
|
+
- "example/"
|
|
55
|
+
- "examples/"
|
|
56
|
+
- "cmd/"
|
|
57
|
+
fixable: false
|
|
58
|
+
|
|
59
|
+
# ----- 2. 可维护性 -----
|
|
60
|
+
|
|
61
|
+
- id: go/fmt-print-debug
|
|
62
|
+
name: "Go 避免用 fmt.Print* 输出日志"
|
|
63
|
+
category: "maintainability"
|
|
64
|
+
severity: "notice"
|
|
65
|
+
description: "fmt.Print/Printf/Println 输出到 stdout 且无级别/时间戳,生产环境应走 log/slog 或项目日志器"
|
|
66
|
+
patterns:
|
|
67
|
+
- "(?<![\\w$.])fmt\\.Print(?:f|ln)\\s*\\("
|
|
68
|
+
- "(?<![\\w$.])fmt\\.Print\\s*\\("
|
|
69
|
+
exts: ["go"]
|
|
70
|
+
exclude_paths:
|
|
71
|
+
- "test/"
|
|
72
|
+
- "tests/"
|
|
73
|
+
- "example/"
|
|
74
|
+
- "examples/"
|
|
75
|
+
fixable: false
|
|
76
|
+
|
|
77
|
+
- id: go/context-todo
|
|
78
|
+
name: "Go 生产代码避免 context.TODO()"
|
|
79
|
+
category: "maintainability"
|
|
80
|
+
severity: "notice"
|
|
81
|
+
description: "context.TODO() 表示「还没想好」——生产路径应传调用方 context(可取消/带超时),否则请求链路无法取消"
|
|
82
|
+
patterns:
|
|
83
|
+
- "context\\.TODO\\s*\\(\\s*\\)"
|
|
84
|
+
exts: ["go"]
|
|
85
|
+
exclude_paths:
|
|
86
|
+
- "test/"
|
|
87
|
+
- "tests/"
|
|
88
|
+
- "example/"
|
|
89
|
+
- "examples/"
|
|
90
|
+
fixable: false
|
|
91
|
+
|
|
92
|
+
# ----- 3. 安全 -----
|
|
93
|
+
|
|
94
|
+
- id: go/unsafe-pointer
|
|
95
|
+
name: "Go 慎用 unsafe.Pointer"
|
|
96
|
+
category: "security"
|
|
97
|
+
severity: "error"
|
|
98
|
+
description: "unsafe 绕过 Go 类型安全与 GC 保证,跨版本/跨架构易出内存错误;确需使用时必须注释清楚不变量"
|
|
99
|
+
patterns:
|
|
100
|
+
- "unsafe\\.Pointer"
|
|
101
|
+
- "(?<![\\w$.])unsafe\\.(?:Sizeof|Offsetof|Alignof)\\s*\\("
|
|
102
|
+
exts: ["go"]
|
|
103
|
+
fixable: false
|
|
@@ -79,19 +79,21 @@ rules:
|
|
|
79
79
|
|
|
80
80
|
# ── 循环内重复调用同一函数(可记忆化 / 提前计算)──
|
|
81
81
|
- id: performance/repeat-identical-call
|
|
82
|
-
name: "
|
|
82
|
+
name: "同一循环体或同一函数体内重复调用同一函数(实参完全相同)"
|
|
83
83
|
category: "performance"
|
|
84
84
|
severity: "warning"
|
|
85
|
-
description: "
|
|
85
|
+
description: "同一循环体或同一函数体内 ≥2 次实参完全相同的调用:纯函数应记忆化、fs 属性调用(stat/readdir 等)应合并成一次(真实案例:路径解析函数在解析循环内被调 8762 次、占全量扫描 89%,加记忆化后 4581ms→344ms)"
|
|
86
86
|
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
87
|
-
#
|
|
87
|
+
# 纯正则无法表达「在不在循环体/函数体内 / 实参是否相同」——由 AST 精筛(allow 语义)
|
|
88
88
|
astConfirmKind: "repeat-identical-call"
|
|
89
|
+
# 第三方/构建产物里的重复是上游代码的形态(实测 vendors 的 emscripten 胶水层一个文件就 37 处)⇒ 不报
|
|
90
|
+
exclude_paths: ["assets/", "vendor/", "third_party/", "dist/", "build/"]
|
|
89
91
|
patterns:
|
|
90
92
|
- id: repeated-call
|
|
91
93
|
pattern: "[A-Za-z_$][\\w.$]*\\s*\\([^()]*\\)"
|
|
92
|
-
message: "
|
|
94
|
+
message: "循环体/函数体内重复调用(实参相同):若为纯函数可记忆化,fs 属性调用可直接合并"
|
|
93
95
|
fixable: false
|
|
94
|
-
mitigation: "加一层 Map
|
|
96
|
+
mitigation: "加一层 Map 记忆化(键=入参组合)或把结果提到循环外/合并成一次;有副作用的调用(写文件/网络/日志)不适用"
|
|
95
97
|
|
|
96
98
|
# ── 写死 User-Agent(2026-10-12 从 gbmd 实战沉淀)──
|
|
97
99
|
# 教训:GameBanana 等平台的会话与「换取 cookie 时的浏览器 UA」绑定;下载路径写死 Chrome UA
|
|
@@ -216,4 +218,28 @@ rules:
|
|
|
216
218
|
pattern: "\\b(for|while)\\s*\\("
|
|
217
219
|
message: "长同步循环无让出点:每 N 轮 await setImmediate/延时一次(总耗时不变,服务保持可响应)"
|
|
218
220
|
fixable: false
|
|
219
|
-
mitigation: "循环内每 N 次迭代 `await new Promise((r) => setImmediate(r))`;或把同步 I/O 换成异步 API"
|
|
221
|
+
mitigation: "循环内每 N 次迭代 `await new Promise((r) => setImmediate(r))`;或把同步 I/O 换成异步 API"
|
|
222
|
+
|
|
223
|
+
# ── 逐文件扫描实现(仓库级;2026-10-16 由 bench-template 的 scan-fs-hotspots 交接而来)──
|
|
224
|
+
# 判据:同一函数体内**同时**出现 readdir 与 stat ⇒ 一个「逐文件取属性」的扫描实现。
|
|
225
|
+
# 仓库内这类实现数 > min_occurrences(默认 3)⇒ notice:同一件事是否被独立实现了多遍,交人工判断。
|
|
226
|
+
# 为什么只报一处:这是**整个仓库**的属性(与 duplicate-code 同性质);逐文件报会在 N 个文件上
|
|
227
|
+
# 产出 N 条同义提示 ⇒ 由 lib/audit/orchestrate.js 在文件循环后统一聚合,其余实现列进 message。
|
|
228
|
+
# ⚠️ **不排除 test/**:交接文档 §四.1 的教训——看不到测试目录就会漏判(实测某仓
|
|
229
|
+
# recursiveScanAll 只被 test/ 调用过,跳过 test/ 时被误判成「无调用者」)。测试文件里的
|
|
230
|
+
# 扫描实现同样计入,正是为了让人看到全貌 ✓
|
|
231
|
+
- id: performance/multi-file-scanners
|
|
232
|
+
name: "仓库内「readdir + stat」逐文件扫描实现过多(同一职责可能实现了多遍)"
|
|
233
|
+
category: "performance"
|
|
234
|
+
severity: "notice"
|
|
235
|
+
description: "全仓「同一函数体内既有 readdir 又有 stat」的扫描实现超过 min_occurrences(默认 3):提示人工判断是否同一职责被各处独立实现(实测某仓 48 文件里 9 处各自遍历;合并成一层索引/遍历可省掉重复 readdir 与重复 stat)"
|
|
236
|
+
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
237
|
+
kind: "multi-file-scanners"
|
|
238
|
+
min_occurrences: 3
|
|
239
|
+
# L1 锚点:只让「确有 readdir/stat 调用」的文件进入本规则的候选集(仓库级聚合也因此有据可依)
|
|
240
|
+
patterns:
|
|
241
|
+
- id: fs-walk
|
|
242
|
+
pattern: "(readdirSync|readdir|statSync|stat|lstatSync|lstat)\\s*\\("
|
|
243
|
+
message: "目录遍历 + 逐文件取属性:全仓这类实现过多时应合并成一层索引/遍历"
|
|
244
|
+
fixable: false
|
|
245
|
+
mitigation: "合并成单一「目录遍历 + 一次取属性」的索引层,各处复用其输出,而不是每处各遍历一次"
|
|
@@ -1,22 +1,101 @@
|
|
|
1
1
|
# ============================================================
|
|
2
|
-
# PHP
|
|
3
|
-
# 版本:0.
|
|
2
|
+
# PHP 代码审计规则集(首版 · 语言专项)
|
|
3
|
+
# 版本:0.2.0
|
|
4
4
|
# 适用:PHP 项目
|
|
5
|
-
#
|
|
6
|
-
#
|
|
7
|
-
#
|
|
8
|
-
#
|
|
9
|
-
#
|
|
10
|
-
# (function 关键字 + 花括号配对,与 JS 同构);② 本槽位按 python/java 先例
|
|
11
|
-
# 写规则,exts: ["php"]。
|
|
5
|
+
# 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
|
|
6
|
+
# 规则依据:对真实 PHP 仓(php-fig/log、brick/math 等样本仓)实测各候选模式的出现次数后选型——
|
|
7
|
+
# 例:`@` 形态裸查有 1183 次(大量命中 phpDoc 注解 ✗)⇒ 本槽位细化为「@$变量」与「@函数(」
|
|
8
|
+
# 两种真正的错误抑制写法,避免把文档注释当违规。
|
|
9
|
+
# (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.php)
|
|
12
10
|
# ============================================================
|
|
13
11
|
|
|
14
12
|
metadata:
|
|
15
|
-
name: "PHP
|
|
16
|
-
version: "0.
|
|
13
|
+
name: "PHP 审计规则集(首版 · 语言专项)"
|
|
14
|
+
version: "0.2.0"
|
|
17
15
|
language: "php"
|
|
18
16
|
author: "DeepSeek"
|
|
19
|
-
description: "PHP
|
|
20
|
-
last_updated: "2026-10-
|
|
17
|
+
description: "PHP 项目语言专用规则(pattern 层首版:eval/extract/调试输出/错误抑制/md5 口令/die-exit)"
|
|
18
|
+
last_updated: "2026-10-16"
|
|
21
19
|
|
|
22
|
-
rules:
|
|
20
|
+
rules:
|
|
21
|
+
# ----- 1. 安全 -----
|
|
22
|
+
|
|
23
|
+
- id: php/eval
|
|
24
|
+
name: "禁止使用 eval 执行代码"
|
|
25
|
+
category: "security"
|
|
26
|
+
severity: "error"
|
|
27
|
+
description: "eval 执行任意字符串代码,一旦拼接了外部输入即为 RCE;确需动态求值应用白名单映射或回调表"
|
|
28
|
+
patterns:
|
|
29
|
+
- "(?<![\\w$>])eval\\s*\\("
|
|
30
|
+
exts: ["php", "phtml"]
|
|
31
|
+
fixable: false
|
|
32
|
+
|
|
33
|
+
- id: php/extract
|
|
34
|
+
name: "避免 extract() 批量导入变量"
|
|
35
|
+
category: "security"
|
|
36
|
+
severity: "error"
|
|
37
|
+
description: "extract 把数组键变成当前作用域变量,可覆盖已有变量(含请求参数),是经典的变量覆盖漏洞入口"
|
|
38
|
+
patterns:
|
|
39
|
+
- "(?<![\\w$>])extract\\s*\\("
|
|
40
|
+
exts: ["php", "phtml"]
|
|
41
|
+
fixable: false
|
|
42
|
+
|
|
43
|
+
- id: php/md5-sha1-hash
|
|
44
|
+
name: "口令场景禁用 md5/sha1"
|
|
45
|
+
category: "security"
|
|
46
|
+
severity: "warning"
|
|
47
|
+
description: "md5/sha1 已可高速碰撞与暴力破解,用于口令/令牌/签名时高危;口令应 password_hash(bcrypt/argon2)。非安全用途(缓存键、内容校验)可保留但需注释说明"
|
|
48
|
+
patterns:
|
|
49
|
+
- "(?<![\\w$>])(?:md5|sha1|md5_file|sha1_file)\\s*\\("
|
|
50
|
+
exts: ["php", "phtml"]
|
|
51
|
+
fixable: false
|
|
52
|
+
|
|
53
|
+
- id: php/error-suppression
|
|
54
|
+
name: "避免用 @ 抑制错误"
|
|
55
|
+
category: "robustness"
|
|
56
|
+
severity: "warning"
|
|
57
|
+
description: "@ 把错误静默吞掉,真出问题时现场信息全无;应显式判断前置条件或捕获异常。本规则只匹配真正的抑制写法(@$变量 / @函数(),不误伤 phpDoc 注解"
|
|
58
|
+
# 只匹配**紧贴**写法 `@func(` / `@$var`:`@param (callable(…))` 这类 phpDoc 注解
|
|
59
|
+
# 带空格 ⇒ 实测(brick/math)被 `@func\s*(` 误伤过 ✗ ⇒ 去掉 \s* + 加行级代码判定双保险
|
|
60
|
+
astConfirm: true
|
|
61
|
+
patterns:
|
|
62
|
+
- "@\\$[A-Za-z_][A-Za-z0-9_]*"
|
|
63
|
+
- "@[A-Za-z_][A-Za-z0-9_]*\\("
|
|
64
|
+
exts: ["php", "phtml"]
|
|
65
|
+
exclude_paths:
|
|
66
|
+
- "vendor/"
|
|
67
|
+
- "tests/"
|
|
68
|
+
- "test/"
|
|
69
|
+
fixable: false
|
|
70
|
+
|
|
71
|
+
# ----- 2. 可维护性 -----
|
|
72
|
+
|
|
73
|
+
- id: php/var-dump-debug
|
|
74
|
+
name: "PHP 避免遗留 var_dump/print_r 调试输出"
|
|
75
|
+
category: "maintainability"
|
|
76
|
+
severity: "notice"
|
|
77
|
+
description: "var_dump/print_r/var_export 直出到响应体,既泄漏内部结构又破坏输出格式;应走日志器或调试器"
|
|
78
|
+
patterns:
|
|
79
|
+
- "(?<![\\w$>])(?:var_dump|print_r|var_export)\\s*\\("
|
|
80
|
+
exts: ["php", "phtml"]
|
|
81
|
+
exclude_paths:
|
|
82
|
+
- "tests/"
|
|
83
|
+
- "test/"
|
|
84
|
+
- "vendor/"
|
|
85
|
+
fixable: false
|
|
86
|
+
|
|
87
|
+
- id: php/die-exit
|
|
88
|
+
name: "PHP 库代码避免 die/exit 直接终止"
|
|
89
|
+
category: "robustness"
|
|
90
|
+
severity: "notice"
|
|
91
|
+
description: "die/exit 直接结束进程,跳过框架的响应收尾与错误处理;库代码应抛异常,由入口层决定输出与状态码"
|
|
92
|
+
patterns:
|
|
93
|
+
- "(?<![\\w$>])(?:die|exit)\\s*\\("
|
|
94
|
+
exts: ["php", "phtml"]
|
|
95
|
+
exclude_paths:
|
|
96
|
+
- "tests/"
|
|
97
|
+
- "test/"
|
|
98
|
+
- "vendor/"
|
|
99
|
+
- "bin/"
|
|
100
|
+
- "public/"
|
|
101
|
+
fixable: false
|
|
@@ -1,22 +1,109 @@
|
|
|
1
1
|
# ============================================================
|
|
2
|
-
# Rust
|
|
3
|
-
# 版本:0.
|
|
2
|
+
# Rust 代码审计规则集(首版 · 语言专项)
|
|
3
|
+
# 版本:0.2.0
|
|
4
4
|
# 适用:Rust 项目
|
|
5
|
-
#
|
|
6
|
-
#
|
|
7
|
-
#
|
|
8
|
-
#
|
|
9
|
-
# 待办(补规则时):① AST 层 lang.js 的 LANG_FUNC_RANGES.rust 实现函数范围收集
|
|
10
|
-
# (fn 关键字 + 花括号配对,pub fn / impl 块内 fn);② 本槽位按 python/java 先例
|
|
11
|
-
# 写 min_length/max_depth/max_lines/max_complexity/magic-number 规则,exts: ["rs"]。
|
|
5
|
+
# 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
|
|
6
|
+
# 规则依据:对真实 Rust 仓(dtolnay/anyhow 等样本仓)实测各候选模式的出现次数后选型。
|
|
7
|
+
# (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.rust)
|
|
8
|
+
# 口径:exts 只认 .rs;测试目录排除(测试里 unwrap/println 是惯用写法)。
|
|
12
9
|
# ============================================================
|
|
13
10
|
|
|
14
11
|
metadata:
|
|
15
|
-
name: "Rust
|
|
16
|
-
version: "0.
|
|
12
|
+
name: "Rust 审计规则集(首版 · 语言专项)"
|
|
13
|
+
version: "0.2.0"
|
|
17
14
|
language: "rust"
|
|
18
15
|
author: "DeepSeek"
|
|
19
|
-
description: "Rust
|
|
20
|
-
last_updated: "2026-10-
|
|
16
|
+
description: "Rust 项目语言专用规则(pattern 层首版:unwrap/unimplemented!/panic!/println!/unsafe)"
|
|
17
|
+
last_updated: "2026-10-16"
|
|
21
18
|
|
|
22
|
-
rules:
|
|
19
|
+
rules:
|
|
20
|
+
# ----- 1. 健壮性 -----
|
|
21
|
+
|
|
22
|
+
- id: rust/unwrap-in-production
|
|
23
|
+
name: "Rust 生产代码避免裸 unwrap()"
|
|
24
|
+
category: "robustness"
|
|
25
|
+
severity: "warning"
|
|
26
|
+
description: "裸 unwrap() 在 None/Err 时直接 panic(等于崩溃);生产路径应用 ? / unwrap_or / match 显式处置"
|
|
27
|
+
# 只匹配无参 unwrap()(unwrap_or/unwrap_or_else 等带参形态不在此列 ✓)
|
|
28
|
+
patterns:
|
|
29
|
+
- "\\.unwrap\\s*\\(\\s*\\)"
|
|
30
|
+
exts: ["rs"]
|
|
31
|
+
exclude_paths:
|
|
32
|
+
- "tests/"
|
|
33
|
+
- "test/"
|
|
34
|
+
- "benches/"
|
|
35
|
+
- "benchmarks/"
|
|
36
|
+
- "examples/"
|
|
37
|
+
- "example/"
|
|
38
|
+
fixable: false
|
|
39
|
+
|
|
40
|
+
- id: rust/unimplemented-macro
|
|
41
|
+
name: "Rust 禁止遗留 unimplemented!/todo!"
|
|
42
|
+
category: "robustness"
|
|
43
|
+
severity: "error"
|
|
44
|
+
description: "unimplemented!/todo! 是明确的「未实现」占位,运行到即 panic;合入主干前必须补齐实现"
|
|
45
|
+
# astConfirm:行级「是否代码行」判定——实测 anyhow 的 16 条命中里 **14 条落在文档注释**
|
|
46
|
+
# (`/// # unimplemented!()` 这类用法示例 ✗)⇒ 不加这层会把文档当违规
|
|
47
|
+
astConfirm: true
|
|
48
|
+
patterns:
|
|
49
|
+
- "(?<![\\w!])(?:unimplemented|todo)\\s*!"
|
|
50
|
+
exts: ["rs"]
|
|
51
|
+
exclude_paths:
|
|
52
|
+
- "tests/"
|
|
53
|
+
- "test/"
|
|
54
|
+
- "examples/"
|
|
55
|
+
- "example/"
|
|
56
|
+
fixable: false
|
|
57
|
+
|
|
58
|
+
- id: rust/panic-macro
|
|
59
|
+
name: "Rust 慎用 panic!"
|
|
60
|
+
category: "robustness"
|
|
61
|
+
severity: "warning"
|
|
62
|
+
description: "panic! 用于不可恢复错误;库代码应返回 Result,把处置权交给调用方"
|
|
63
|
+
# 同 unimplemented-macro:文档注释里常出现 panic! 示例 ⇒ 行级代码判定
|
|
64
|
+
astConfirm: true
|
|
65
|
+
patterns:
|
|
66
|
+
- "(?<![\\w!])panic\\s*!"
|
|
67
|
+
exts: ["rs"]
|
|
68
|
+
exclude_paths:
|
|
69
|
+
- "tests/"
|
|
70
|
+
- "test/"
|
|
71
|
+
- "examples/"
|
|
72
|
+
- "example/"
|
|
73
|
+
fixable: false
|
|
74
|
+
|
|
75
|
+
# ----- 2. 可维护性 -----
|
|
76
|
+
|
|
77
|
+
- id: rust/println-debug
|
|
78
|
+
name: "Rust 避免用 println! 输出运行期信息"
|
|
79
|
+
category: "maintainability"
|
|
80
|
+
severity: "notice"
|
|
81
|
+
description: "println! 直写 stdout 且无级别/目标控制;库与服务代码应走 log/tracing"
|
|
82
|
+
astConfirm: true
|
|
83
|
+
patterns:
|
|
84
|
+
- "(?<![\\w!])println\\s*!"
|
|
85
|
+
- "(?<![\\w!])print\\s*!"
|
|
86
|
+
exts: ["rs"]
|
|
87
|
+
exclude_paths:
|
|
88
|
+
- "tests/"
|
|
89
|
+
- "test/"
|
|
90
|
+
- "benches/"
|
|
91
|
+
- "examples/"
|
|
92
|
+
- "example/"
|
|
93
|
+
# build.rs 是构建脚本:编译期进度/诊断打印是常态(实测 anyhow 的 13 条里有 8 条在 build.rs)
|
|
94
|
+
- "build.rs"
|
|
95
|
+
fixable: false
|
|
96
|
+
|
|
97
|
+
# ----- 3. 安全 -----
|
|
98
|
+
|
|
99
|
+
- id: rust/unsafe-block
|
|
100
|
+
name: "Rust unsafe 块需显式评审"
|
|
101
|
+
category: "security"
|
|
102
|
+
severity: "error"
|
|
103
|
+
description: "unsafe 关闭借用检查等保证,内存安全需自行论证;每处 unsafe 都应附安全前提注释,且尽量收敛到最小块"
|
|
104
|
+
astConfirm: true
|
|
105
|
+
patterns:
|
|
106
|
+
- "(?<![\\w:.])unsafe\\s*\\{"
|
|
107
|
+
- "(?<![\\w:.])unsafe\\s+fn\\b"
|
|
108
|
+
exts: ["rs"]
|
|
109
|
+
fixable: false
|
|
@@ -1,22 +1,99 @@
|
|
|
1
1
|
# ============================================================
|
|
2
|
-
# Swift
|
|
3
|
-
# 版本:0.
|
|
2
|
+
# Swift 代码审计规则集(首版 · 语言专项)
|
|
3
|
+
# 版本:0.2.0
|
|
4
4
|
# 适用:Swift 项目(iOS/macOS)
|
|
5
|
-
#
|
|
6
|
-
#
|
|
7
|
-
#
|
|
8
|
-
#
|
|
9
|
-
#
|
|
10
|
-
# (func 关键字 + 花括号配对,含 `func name()` 与 `func name() async throws`);
|
|
11
|
-
# ② 本槽位按 python/java 先例写规则,exts: ["swift"]。
|
|
5
|
+
# 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
|
|
6
|
+
# 规则依据:对真实 Swift 仓(SnapKit/SnapKit 等样本仓)实测各候选模式的出现次数后选型——
|
|
7
|
+
# 例:`as!` 17 次、`fatalError(` 16 次(都是真实存在的强制形态 ✓),而 `try!` 0 次
|
|
8
|
+
# (仍是高价值规则 ✓:一旦出现就是崩溃点)。
|
|
9
|
+
# (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.swift)
|
|
12
10
|
# ============================================================
|
|
13
11
|
|
|
14
12
|
metadata:
|
|
15
|
-
name: "Swift
|
|
16
|
-
version: "0.
|
|
13
|
+
name: "Swift 审计规则集(首版 · 语言专项)"
|
|
14
|
+
version: "0.2.0"
|
|
17
15
|
language: "swift"
|
|
18
16
|
author: "DeepSeek"
|
|
19
|
-
description: "Swift
|
|
20
|
-
last_updated: "2026-10-
|
|
17
|
+
description: "Swift 项目语言专用规则(pattern 层首版:try!/as!/fatalError/print 调试/隐式解包属性)"
|
|
18
|
+
last_updated: "2026-10-16"
|
|
21
19
|
|
|
22
|
-
rules:
|
|
20
|
+
rules:
|
|
21
|
+
# ----- 1. 健壮性 -----
|
|
22
|
+
|
|
23
|
+
- id: swift/force-try
|
|
24
|
+
name: "Swift 避免 try! 强制抛错"
|
|
25
|
+
category: "robustness"
|
|
26
|
+
severity: "error"
|
|
27
|
+
description: "try! 在抛错时直接崩溃;应 try? 兜底或 do/catch 显式处置(能被测试覆盖的分支才算处理过)"
|
|
28
|
+
patterns:
|
|
29
|
+
- "(?<![\\w.])try\\s*!"
|
|
30
|
+
exts: ["swift"]
|
|
31
|
+
exclude_paths:
|
|
32
|
+
- "Tests/"
|
|
33
|
+
- "tests/"
|
|
34
|
+
- "Examples/"
|
|
35
|
+
- "examples/"
|
|
36
|
+
fixable: false
|
|
37
|
+
|
|
38
|
+
- id: swift/force-cast
|
|
39
|
+
name: "Swift 避免 as! 强制类型转换"
|
|
40
|
+
category: "robustness"
|
|
41
|
+
severity: "warning"
|
|
42
|
+
description: "as! 类型不符即崩溃;应 as? + guard/if let 分支处理,或改用协议/泛型在编译期约束类型"
|
|
43
|
+
patterns:
|
|
44
|
+
- "(?<![\\w.])as\\s*!"
|
|
45
|
+
exts: ["swift"]
|
|
46
|
+
exclude_paths:
|
|
47
|
+
- "Tests/"
|
|
48
|
+
- "tests/"
|
|
49
|
+
- "Examples/"
|
|
50
|
+
- "examples/"
|
|
51
|
+
fixable: false
|
|
52
|
+
|
|
53
|
+
- id: swift/fatal-error
|
|
54
|
+
name: "Swift fatalError 需限定在不可恢复处"
|
|
55
|
+
category: "robustness"
|
|
56
|
+
severity: "warning"
|
|
57
|
+
description: "fatalError 直接终止进程;只应用于「程序性不可能到达」的断言式场景(如接口误用),业务错误应抛错或返回 Result"
|
|
58
|
+
patterns:
|
|
59
|
+
- "(?<![\\w.])fatalError\\s*\\("
|
|
60
|
+
exts: ["swift"]
|
|
61
|
+
exclude_paths:
|
|
62
|
+
- "Tests/"
|
|
63
|
+
- "tests/"
|
|
64
|
+
- "Examples/"
|
|
65
|
+
- "examples/"
|
|
66
|
+
fixable: false
|
|
67
|
+
|
|
68
|
+
# ----- 2. 可维护性 -----
|
|
69
|
+
|
|
70
|
+
- id: swift/print-debug
|
|
71
|
+
name: "Swift 避免用 print 输出运行期信息"
|
|
72
|
+
category: "maintainability"
|
|
73
|
+
severity: "notice"
|
|
74
|
+
description: "print 无级别/无目标控制且在生产会直写控制台;应走 os.Logger 等项目日志设施"
|
|
75
|
+
patterns:
|
|
76
|
+
- "(?<![\\w.])print\\s*\\("
|
|
77
|
+
exts: ["swift"]
|
|
78
|
+
exclude_paths:
|
|
79
|
+
- "Tests/"
|
|
80
|
+
- "tests/"
|
|
81
|
+
- "Examples/"
|
|
82
|
+
- "examples/"
|
|
83
|
+
fixable: false
|
|
84
|
+
|
|
85
|
+
- id: swift/iuo-property
|
|
86
|
+
name: "Swift 慎用隐式解包可选类型(IUO)"
|
|
87
|
+
category: "robustness"
|
|
88
|
+
severity: "warning"
|
|
89
|
+
description: "`var x: T!` 把解包风险推迟到运行期(未赋值即崩溃);应显式 Optional + 可选绑定,仅在生命周期确实保证时使用并注释理由"
|
|
90
|
+
# 负向环视排除 `!=`(不等号):`:` 后类型以 `!` 结尾且其后不是 `=`
|
|
91
|
+
patterns:
|
|
92
|
+
- ":\\s*[A-Za-z_][\\w.\\[\\]<>]*\\s*!(?!=)"
|
|
93
|
+
exts: ["swift"]
|
|
94
|
+
exclude_paths:
|
|
95
|
+
- "Tests/"
|
|
96
|
+
- "tests/"
|
|
97
|
+
- "Examples/"
|
|
98
|
+
- "examples/"
|
|
99
|
+
fixable: false
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 仓库级检查:逐文件扫描实现过多(`kind: multi-file-scanners`)
|
|
3
|
+
*
|
|
4
|
+
* 【判据】同一函数体内**同时**出现 `readdir` 与 `stat` ⇒ 一个「逐文件取属性」的扫描实现。
|
|
5
|
+
* 全仓这类实现数 > `min_occurrences`(规则字段,默认 3)⇒ 报 **一条** notice:
|
|
6
|
+
* 「同一职责是否被各处独立实现了一遍」交人工判断(不是「你有 N 个 bug」✗)。
|
|
7
|
+
*
|
|
8
|
+
* 【为什么只报一处】这是**整个仓库**的属性(与 duplicate-code 同性质)。逐文件报会在 N 个
|
|
9
|
+
* 文件上产出 N 条同义提示,把真实问题淹掉 ⇒ 只在代表文件上报一次,其余实现列进 message ✓
|
|
10
|
+
* (代表文件 = 路径字典序最小者,由 orchestrate 的 pickRepoLevelAnchorFile 决定语义)。
|
|
11
|
+
*
|
|
12
|
+
* 【口径单一】判据实现只在 `lib/ast/fs-hotspots.js` 一份 —— 独立 CLI
|
|
13
|
+
* `scripts/scan-fs-hotspots.mjs` 用的是同一个函数,不存在「规则一套、脚本一套」的漂移 ✗
|
|
14
|
+
*
|
|
15
|
+
* @param {Array<{path:string,text:string}>} fileTexts 全仓代码文件文本
|
|
16
|
+
* @param {Array} rules 该 kind 下的规则(取第一条;阈值读 min_occurrences / extra.minOccurrences)
|
|
17
|
+
* @returns {Array} findings
|
|
18
|
+
*/
|
|
19
|
+
import { scanFsHotspots } from '../ast/fs-hotspots.js';
|
|
20
|
+
|
|
21
|
+
export function checkMultiFileScanners(fileTexts = [], rules = null) {
|
|
22
|
+
const findings = [];
|
|
23
|
+
if (!Array.isArray(fileTexts) || fileTexts.length < 2) return findings; // 单文件谈不上「多实现」
|
|
24
|
+
const rule = Array.isArray(rules) && rules.length ? rules[0] : null;
|
|
25
|
+
if (!rule) return findings;
|
|
26
|
+
|
|
27
|
+
const threshold = Number(rule?.extra?.minOccurrences ?? rule?.minOccurrences ?? 3) || 3;
|
|
28
|
+
const severity = 'notice'; // 恒 notice:这是启发式提示(不同用途的扫描器是合法的)⇒ 只提示不警告
|
|
29
|
+
|
|
30
|
+
let agg;
|
|
31
|
+
try {
|
|
32
|
+
agg = scanFsHotspots(fileTexts);
|
|
33
|
+
} catch {
|
|
34
|
+
return findings; // 单个异常不影响整轮审计
|
|
35
|
+
}
|
|
36
|
+
const scanners = agg.scanners || [];
|
|
37
|
+
if (scanners.length <= threshold) return findings;
|
|
38
|
+
|
|
39
|
+
// 代表文件 = 路径字典序最小者(与 repo-level 语义一致,保证同一仓库每次报同一处)
|
|
40
|
+
const sorted = [...scanners].sort((a, b) => String(a.file).localeCompare(String(b.file)));
|
|
41
|
+
const first = sorted[0];
|
|
42
|
+
const rest = sorted.slice(1);
|
|
43
|
+
const list = rest.map((s) => `${s.file}::${s.fn}()`).join('、');
|
|
44
|
+
findings.push({
|
|
45
|
+
rule: rule.id,
|
|
46
|
+
severity,
|
|
47
|
+
file: first.file,
|
|
48
|
+
line: first.line,
|
|
49
|
+
message: `仓库内「同一函数里既 readdir 又 stat」的逐文件扫描实现共 ${scanners.length} 个`
|
|
50
|
+
+ `(阈值 ${threshold}):${first.file}::${first.fn}()`
|
|
51
|
+
+ (list ? ` 等 —— 其余:${list}` : '')
|
|
52
|
+
+ '。提示:同一职责被各处独立实现时,合并成一层遍历/索引可省掉重复 readdir 与重复 stat'
|
|
53
|
+
+ '(不同用途的扫描器属正常,需人工判断)',
|
|
54
|
+
dimensions: rule?.dimensions,
|
|
55
|
+
});
|
|
56
|
+
return findings;
|
|
57
|
+
}
|
package/lib/checks/index.js
CHANGED
|
@@ -43,4 +43,5 @@ export { checkMagicNumberSmart } from './magic-number.js';
|
|
|
43
43
|
export { checkFileHealth } from './file-health.js';
|
|
44
44
|
export { checkDataflow } from './dataflow.js';
|
|
45
45
|
export { checkDuplicateCode } from './dup-code.js';
|
|
46
|
+
export { checkMultiFileScanners } from './fs-scanner.js';
|
|
46
47
|
export { checkDuplicateConst, findConstDefs } from './dup-const.js';
|
|
@@ -83,8 +83,11 @@ export function saveWorkspacePaths(paths, { by = 'ai' } = {}) {
|
|
|
83
83
|
/**
|
|
84
84
|
* 生成注入用的「AI 自设工作区」文本块(无自设时返回 '')。
|
|
85
85
|
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* 措辞要点(缺一不可):
|
|
87
|
+
* ① 明确这是 **AI 自己维护**的位置清单(不是宿主探测)——**维护责任在 AI**:
|
|
88
|
+
* 工作区挪了/改名了/开始处理另一个目录,AI 自己要更新,否则下一轮看到的还是旧清单 ✗
|
|
89
|
+
* ② 给出修改入口(同一个 API)与读回方式,让下一轮的自己知道怎么改 ✓
|
|
90
|
+
* ③ 说明优先级:高于会话 cwd(会话 header 本身可能是陈旧路径)
|
|
88
91
|
* @param {string} [sep] 行分隔符(默认换行)
|
|
89
92
|
* @returns {string} 多行文本;无自设 ⇒ ''
|
|
90
93
|
*/
|
|
@@ -93,8 +96,13 @@ export function workspacePathsInjectionText(sep = '\n') {
|
|
|
93
96
|
if (!paths.length) return '';
|
|
94
97
|
const L = [`【AI 自设工作区(${paths.length} 个 · 由 ${updatedBy || 'ai'} 于 ${String(updatedAt).slice(0, 16) || '未知时间'} 登记)】`];
|
|
95
98
|
paths.forEach((p, i) => L.push(`- ${i + 1}. ${p}`));
|
|
96
|
-
L.push('
|
|
97
|
-
+
|
|
98
|
-
+ '
|
|
99
|
+
L.push('⚠️ 这是**由你(AI)自己维护**的工作区位置清单——不是宿主探测出来的:'
|
|
100
|
+
+ '工作区被移动/改名、或你开始处理另一个目录时,**你要主动更新它**,'
|
|
101
|
+
+ '否则下一轮你看到的仍是这份旧清单(下方会话 cwd 可能本身就是陈旧路径 ✗)。');
|
|
102
|
+
L.push('维护方式(同一端点按方法分发):'
|
|
103
|
+
+ "改/加/删 —— git_api({path:'workspace-paths', method:'POST', body:'{\"paths\":[\"<绝对路径>\", …]}'})"
|
|
104
|
+
+ '(可选 "mode":"add"|"remove";{"clear":true} 清空);'
|
|
105
|
+
+ "读回 —— git_api({path:'workspace-paths'})"
|
|
106
|
+
+ '。只收绝对路径、必须存在且是目录,上限 20 条。');
|
|
99
107
|
return L.join(sep);
|
|
100
108
|
}
|