dsh-git-push 2.20.19 → 3.0.0
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 +3 -2
- package/cli-tool.mjs +2 -4
- package/cli.mjs +7 -1
- package/lib/app/apply.js +4 -4
- package/lib/app/command-registry.js +22 -17
- package/lib/app/handlers/meta.js +2 -2
- package/lib/app/handlers/preprocess.js +107 -0
- package/lib/app/handlers/repo-actions.js +2 -2
- package/lib/app/http-handlers.js +13 -42
- package/lib/app/index.js +2 -1
- package/lib/app/inject-text.js +3 -3
- package/lib/app/preprocess-client.js +136 -0
- package/lib/app/repo-ownership.js +1 -1
- package/lib/app/schema.js +3 -3
- package/lib/app/severity.js +14 -0
- package/lib/app/slash-commands.js +5 -164
- package/lib/app/tool-call.js +73 -144
- package/lib/cli/commands-preprocess.mjs +74 -0
- package/lib/cli/commands-tool.mjs +3 -2
- package/lib/cli/commands-vcs.mjs +4 -4
- package/lib/cli/shared.mjs +35 -9
- package/lib/commit-push/pre-commit-engine.js +57 -10
- package/lib/commit-push.js +71 -27
- package/lib/{exempt/index.js → git/exempt-markers.js} +8 -1
- package/lib/git/ignore.js +1 -1
- package/lib/git/repos.js +2 -2
- package/lib/git/sensitive.js +1 -1
- package/lib/npm/publish.js +20 -5
- package/lib/plugin/auto-push.js +2 -2
- package/lib/preprocess/providers.js +191 -0
- package/lib/self/index.js +1 -1
- package/lib/skip-dirs.js +14 -55
- package/package.json +29 -37
- package/scripts/build-client.mjs +2 -0
- package/scripts/check.mjs +4 -2
- package/scripts/local-registry.mjs +2 -1
- package/cli-audit.mjs +0 -141
- package/lib/app/audit-api.js +0 -173
- package/lib/app/handlers/audit.js +0 -150
- package/lib/app/host-doc-checks.js +0 -25
- package/lib/app/scope-check.js +0 -69
- package/lib/ast/brace.js +0 -120
- package/lib/ast/callgraph.js +0 -135
- package/lib/ast/code-lines.js +0 -175
- package/lib/ast/consts.js +0 -12
- package/lib/ast/control-flow.js +0 -470
- package/lib/ast/credential.js +0 -315
- package/lib/ast/dataflow.js +0 -391
- package/lib/ast/dup-code.js +0 -165
- package/lib/ast/fs-hotspots.js +0 -154
- package/lib/ast/index.js +0 -38
- package/lib/ast/io-risk-const.js +0 -95
- package/lib/ast/io-risk-fn.js +0 -208
- package/lib/ast/io-risk-loop.js +0 -308
- package/lib/ast/io-risk.js +0 -314
- package/lib/ast/lang.js +0 -156
- package/lib/ast/line-count.js +0 -52
- package/lib/ast/magic-number.js +0 -272
- package/lib/ast/naming.js +0 -292
- package/lib/ast/perf.js +0 -488
- package/lib/ast/scope-collisions.js +0 -228
- package/lib/ast/scope.js +0 -241
- package/lib/ast/shell.js +0 -131
- package/lib/ast/size.js +0 -448
- package/lib/ast/symbol-index.js +0 -399
- package/lib/ast/tokenizer.js +0 -421
- package/lib/ast/treesitter.js +0 -413
- package/lib/audit/analysis-coverage.js +0 -98
- package/lib/audit/audit-file.js +0 -205
- package/lib/audit/auditignore-rules.js +0 -148
- package/lib/audit/checks.js +0 -17
- package/lib/audit/client-entry.js +0 -93
- package/lib/audit/collector.js +0 -610
- package/lib/audit/ext-runner.js +0 -80
- package/lib/audit/file-context.js +0 -391
- package/lib/audit/finding.js +0 -101
- package/lib/audit/gitignore-match.js +0 -113
- package/lib/audit/glob.js +0 -63
- package/lib/audit/history-report.js +0 -100
- package/lib/audit/history.js +0 -126
- package/lib/audit/ignore-blind.js +0 -102
- package/lib/audit/index.js +0 -33
- package/lib/audit/orchestrate.js +0 -672
- package/lib/audit/public.js +0 -24
- package/lib/audit/repo-level.js +0 -30
- package/lib/audit/report-yaml.js +0 -90
- package/lib/audit/scope-policy.js +0 -110
- package/lib/audit/slot.js +0 -66
- package/lib/audit-rules/audit-rules-comment.yml +0 -199
- package/lib/audit-rules/audit-rules-cpp.yml +0 -114
- package/lib/audit-rules/audit-rules-csharp.yml +0 -82
- package/lib/audit-rules/audit-rules-docs.yml +0 -32
- package/lib/audit-rules/audit-rules-dsh.yml +0 -177
- package/lib/audit-rules/audit-rules-filehealth.yml +0 -42
- package/lib/audit-rules/audit-rules-folder.yml +0 -99
- package/lib/audit-rules/audit-rules-frontend.yml +0 -335
- package/lib/audit-rules/audit-rules-go.yml +0 -103
- package/lib/audit-rules/audit-rules-i18n.yml +0 -45
- package/lib/audit-rules/audit-rules-java.yml +0 -105
- package/lib/audit-rules/audit-rules-nodejs.yml +0 -662
- package/lib/audit-rules/audit-rules-npm.yml +0 -187
- package/lib/audit-rules/audit-rules-paths.yml +0 -98
- package/lib/audit-rules/audit-rules-performance.yml +0 -245
- package/lib/audit-rules/audit-rules-php.yml +0 -101
- package/lib/audit-rules/audit-rules-private.yml +0 -24
- package/lib/audit-rules/audit-rules-python.yml +0 -106
- package/lib/audit-rules/audit-rules-robustness.yml +0 -31
- package/lib/audit-rules/audit-rules-rust.yml +0 -109
- package/lib/audit-rules/audit-rules-structure.yml +0 -158
- package/lib/audit-rules/audit-rules-swift.yml +0 -99
- package/lib/audit-rules/audit-rules-template.yml +0 -108
- package/lib/audit-ui-sdk/contract.js +0 -117
- package/lib/audit-ui-sdk/index.js +0 -17
- package/lib/checks/button-bind.js +0 -347
- package/lib/checks/common.js +0 -170
- package/lib/checks/credential-file.js +0 -43
- package/lib/checks/dataflow.js +0 -40
- package/lib/checks/dispatch.js +0 -117
- package/lib/checks/dup-code.js +0 -69
- package/lib/checks/dup-const.js +0 -232
- package/lib/checks/file-health.js +0 -150
- package/lib/checks/filter.js +0 -137
- package/lib/checks/folder.js +0 -173
- package/lib/checks/fs-scanner.js +0 -57
- package/lib/checks/hardcoded-path.js +0 -98
- package/lib/checks/index.js +0 -49
- package/lib/checks/io.js +0 -66
- package/lib/checks/magic-number.js +0 -42
- package/lib/checks/npm-json.js +0 -273
- package/lib/checks/private.js +0 -64
- package/lib/checks/regex.js +0 -298
- package/lib/checks/scope-collision.js +0 -68
- package/lib/checks/semantic.js +0 -134
- package/lib/checks/structural.js +0 -281
- package/lib/cli/commands-audit.mjs +0 -142
- package/lib/cli/commands-doc.mjs +0 -127
- package/lib/client-parts/audit/audit.js +0 -301
- package/lib/exempt/tool.js +0 -198
- package/lib/git/module-splitter.js +0 -47
- package/lib/link-check/index.js +0 -187
- package/lib/lint-adapter/detect.js +0 -161
- package/lib/lint-adapter/index.js +0 -50
- package/lib/lint-adapter/runner.js +0 -133
- package/lib/preprocess/audit.js +0 -98
- package/lib/preprocess/index.js +0 -78
- package/lib/rule/compilers/credential.js +0 -62
- package/lib/rule/compilers/dataflow.js +0 -38
- package/lib/rule/compilers/file-health.js +0 -75
- package/lib/rule/compilers/frontend.js +0 -86
- package/lib/rule/compilers/func.js +0 -35
- package/lib/rule/compilers/helpers.js +0 -71
- package/lib/rule/compilers/index.js +0 -29
- package/lib/rule/compilers/link-semantic.js +0 -45
- package/lib/rule/compilers/list-kinds.js +0 -12
- package/lib/rule/compilers/numeric-kinds.js +0 -73
- package/lib/rule/compilers/regex.js +0 -78
- package/lib/rule/compilers/structure.js +0 -107
- package/lib/rule/compilers.js +0 -17
- package/lib/rule/homoglyph.js +0 -45
- package/lib/rule/loader.js +0 -274
- package/lib/rule/registry.js +0 -122
- package/lib/rule/scope.js +0 -67
- package/lib/score/docs-score.js +0 -166
- package/lib/score/index.js +0 -234
- package/scripts/__pycache__/module-splitter.cpython-38.pyc +0 -0
- package/scripts/audit-ext/_example-readme-present.mjs +0 -34
- package/scripts/audit-ext/dsh-inject-declarations.mjs +0 -209
- package/scripts/audit-ext/variable-min-length.mjs +0 -102
- package/scripts/audit-gate.mjs +0 -235
- package/scripts/audit-runner.mjs +0 -35
- package/scripts/audit-runtime-check.mjs +0 -129
- package/scripts/browser-page-probe.mjs +0 -271
- package/scripts/check-js-scope.mjs +0 -87
- package/scripts/clean-date-comments.py +0 -102
- package/scripts/cpu-sample.mjs +0 -188
- package/scripts/doc-drift.mjs +0 -200
- package/scripts/hot-path-probe-cjs.cjs +0 -71
- package/scripts/hot-path-probe-fs-shim.mjs +0 -28
- package/scripts/hot-path-probe-fsp-shim.mjs +0 -31
- package/scripts/hot-path-probe.mjs +0 -153
- package/scripts/module-splitter.py +0 -800
- package/scripts/picker-repro.mjs +0 -115
- package/scripts/platform-scan.mjs +0 -168
- package/scripts/probe-recheck.mjs +0 -47
- package/scripts/rename-locator.mjs +0 -97
- package/scripts/rule-switch.mjs +0 -97
- package/scripts/rules-solo-audit.mjs +0 -173
- package/scripts/scan-file-io.mjs +0 -717
- package/scripts/scan-fs-hotspots.mjs +0 -107
- package/scripts/symbol-index.mjs +0 -85
- package/scripts/verify-prestep.mjs +0 -100
- package/skills/dev/audit-rule-authoring.md +0 -58
- package/skills/guide/guide-audit.md +0 -270
- /package/lib/{audit → app}/ownership.js +0 -0
- /package/lib/app/{schema-audit.js → schema-preprocess.js} +0 -0
- /package/lib/{audit-defaults.js → git/defaults.js} +0 -0
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
# npm 插件发布审计规则(默认加载槽位)
|
|
2
|
-
# 依据:npm 官方 best practices(npm pack 内容判定 / package.json 字段契约)+ 本机 dsh 插件发布经验。
|
|
3
|
-
# 目标文件:package.json / .npmrc —— 通过 exts 字段显式放行(json/npmrc 默认不在 styleCode,
|
|
4
|
-
# styleRules regex 支持 per-rule exts,npm 规则只扫这两个类型,不误伤代码文件)。
|
|
5
|
-
# 语义:全部正则可执行;「缺某个字段」类检查(如缺 license/repository)正则无法表达,
|
|
6
|
-
# 走缺失检测兜底(附 npm doctor / npm publish --dry-run 建议),或由人工在发布前核查。
|
|
7
|
-
metadata:
|
|
8
|
-
name: "npm 插件发布审计规则集"
|
|
9
|
-
author: "EIGHTfs"
|
|
10
|
-
version: "1.0.0"
|
|
11
|
-
description: "针对要发布到 npm 的 dsh 插件:发布清单/依赖声明/凭据防泄漏/publishConfig 语义审计(只扫 package.json + .npmrc)"
|
|
12
|
-
|
|
13
|
-
rules:
|
|
14
|
-
# ── ① package.json 发布清单(files 白名单)──
|
|
15
|
-
- id: npm/files-suspicious-entry
|
|
16
|
-
name: "files 白名单含可疑条目(应核对实际打包路径)"
|
|
17
|
-
category: "npm"
|
|
18
|
-
severity: "warning"
|
|
19
|
-
description: "files 白名单决定 npm pack 打进包的内容;**条目指向不存在的路径**会让包缺运行时文件(如写 audit-rules 而实际是 lib/audit-rules)。引擎结构化判定:逐条核对 files 数组里的路径在仓库中是否存在"
|
|
20
|
-
kind: "npm-json"
|
|
21
|
-
exts: ["json"]
|
|
22
|
-
fixable: false
|
|
23
|
-
mitigation: "npm pack --dry-run 看实际打进包的文件清单;规则目录写完整相对路径(lib/audit-rules)"
|
|
24
|
-
- id: npm/files-missing-lib
|
|
25
|
-
name: "files 白名单可能漏掉 lib(主代码目录)"
|
|
26
|
-
category: "npm"
|
|
27
|
-
severity: "error"
|
|
28
|
-
description: "main/exports 指向 lib/ 下的入口,若 files 未包含 lib 目录,npm pack 包内没有入口文件 → 安装后 import 即失败"
|
|
29
|
-
kind: "npm-json"
|
|
30
|
-
exts: ["json"]
|
|
31
|
-
fixable: false
|
|
32
|
-
mitigation: "files 数组包含 \"lib\"(或列出实际入口文件);npm pack --dry-run 验证"
|
|
33
|
-
- id: npm/exports-without-client
|
|
34
|
-
name: "exports 缺 ./client 子路径(双半插件)"
|
|
35
|
-
category: "npm"
|
|
36
|
-
severity: "warning"
|
|
37
|
-
description: "dsh 双半插件(host+client)应 exports[\"./client\"] 指向 client 入口,宿主才能按子路径解析浏览器半部"
|
|
38
|
-
exts: ["json"]
|
|
39
|
-
patterns:
|
|
40
|
-
- "\"dsh\"\\s*:\\s*\\{[^}]*\"client\""
|
|
41
|
-
fixable: false
|
|
42
|
-
mitigation: "package.json 增加 exports[\"./client\"];与官方 client 插件清单对齐"
|
|
43
|
-
|
|
44
|
-
# ── ② 依赖声明 ──
|
|
45
|
-
- id: npm/dependency-star-range
|
|
46
|
-
name: "依赖版本用 * 通配(未锁定)"
|
|
47
|
-
category: "npm"
|
|
48
|
-
severity: "error"
|
|
49
|
-
description: "dependencies/peerDependencies 用 \"*\" 或 ^0.x 让安装解析到不可控版本;发布插件应锁定可复现的范围(^x.y.z),peer 用符合实际装载的版本"
|
|
50
|
-
# kind: npm-json → 结构化判定(真实解析 package.json,不靠正则命中):
|
|
51
|
-
# ① 只查会随包发布的字段(dependencies/peerDependencies/optionalDependencies),
|
|
52
|
-
# devDependencies 不发布、不在管辖内;
|
|
53
|
-
# ② **private: true 的本地私有插件整体豁免**——私有包不发布、依赖由宿主提供,
|
|
54
|
-
# peer 写 "*" 恰是「由宿主装载」的正确声明;写死版本反而与宿主实际装载版本冲突。
|
|
55
|
-
# 公开包仍严格报 * / x / latest / ^0.x。实现见 checks.js starRangeDeps。
|
|
56
|
-
kind: "npm-json"
|
|
57
|
-
fixable: true
|
|
58
|
-
mitigation: "改为精确范围(如 ^4.1.0);对照实际安装版本(npm ls js-yaml);私有本地插件无需改(本规则已豁免)"
|
|
59
|
-
- id: npm/undeclared-js-yaml
|
|
60
|
-
name: "import 了 js-yaml 但未声明依赖"
|
|
61
|
-
category: "npm"
|
|
62
|
-
severity: "error"
|
|
63
|
-
description: "lib 代码 import 'js-yaml' 且 package.json dependencies 无此项:纯净安装后 Cannot find module 'js-yaml'。npm 依赖必须声明,发布前 npm ls 全绿"
|
|
64
|
-
kind: "npm-json"
|
|
65
|
-
exts: ["json"]
|
|
66
|
-
fixable: true
|
|
67
|
-
mitigation: "package.json dependencies 增加 \"js-yaml\": \"^4.1.0\";npm ls 验证"
|
|
68
|
-
|
|
69
|
-
# ── ③ 凭据防泄漏(.npmrc / package.json)──
|
|
70
|
-
- id: npm/npmrc-authtoken
|
|
71
|
-
name: ".npmrc 含认证 token(禁止入库)"
|
|
72
|
-
category: "npm"
|
|
73
|
-
severity: "error"
|
|
74
|
-
description: ".npmrc 里 _authToken / //registry.npmjs.org/:_authToken 是 npm 发布凭据,进 git 即泄露;发布 token 应只在本机 ~/.npmrc,绝不进仓库"
|
|
75
|
-
exts: ["json", "npmrc"]
|
|
76
|
-
patterns:
|
|
77
|
-
- "_authToken"
|
|
78
|
-
- "//registry\\.npmjs\\.org/:_authToken"
|
|
79
|
-
- "always-auth\\s*=\\s*true"
|
|
80
|
-
fixable: false
|
|
81
|
-
mitigation: "从 .npmrc 删除 token 并加 .gitignore;令牌在 npmjs.com 撤销重发"
|
|
82
|
-
- id: npm/package-auth-props
|
|
83
|
-
name: "package.json 含发布凭据字段"
|
|
84
|
-
category: "npm"
|
|
85
|
-
severity: "error"
|
|
86
|
-
description: "package.json 不应含 publishConfig._authToken / //registry 凭据行;发布凭据只在本机环境"
|
|
87
|
-
exts: ["json"]
|
|
88
|
-
patterns:
|
|
89
|
-
- "\"publishConfig\"\\s*:\\s*\\{[^}]*_auth"
|
|
90
|
-
- "authToken"
|
|
91
|
-
fixable: false
|
|
92
|
-
mitigation: "删除 publishConfig 凭据字段;用环境变量 NODE_AUTH_TOKEN"
|
|
93
|
-
|
|
94
|
-
# ── ④ 发布语义 ──
|
|
95
|
-
- id: npm/private-true-conflict
|
|
96
|
-
name: "\"private\": true 与发布矛盾"
|
|
97
|
-
category: "npm"
|
|
98
|
-
severity: "warning"
|
|
99
|
-
description: "package.json 标记 private: true 时 npm publish 会被 npm 拒绝(除非 --access=restricted 私有包);要发布公开插件应去掉 private 或明确私有包意图"
|
|
100
|
-
exts: ["json"]
|
|
101
|
-
patterns:
|
|
102
|
-
- "\"private\"\\s*:\\s*true"
|
|
103
|
-
fixable: true
|
|
104
|
-
mitigation: "去掉 private 或按私有包发布;核对 npm registry 可见性预期"
|
|
105
|
-
- id: npm/license-field-check
|
|
106
|
-
name: "license 字段核对(缺失则 npm pack 告警)"
|
|
107
|
-
category: "npm"
|
|
108
|
-
severity: "warning"
|
|
109
|
-
description: "npm 要求 package.json 有 license 字段(可 SPDX 表达式);缺失时 npm publish 拒绝(npm 8+ 默认无 license 不可发布公共包)。引擎结构化判定:license 字段**缺失**才报(已声明则不报)"
|
|
110
|
-
kind: "npm-json"
|
|
111
|
-
exts: ["json"]
|
|
112
|
-
fixable: false
|
|
113
|
-
mitigation: "增加 \"license\": \"MIT\"(或项目实际 SPDX 值)+ LICENSE 文件;npm publish --dry-run 验证"
|
|
114
|
-
- id: npm/license-unlicensed
|
|
115
|
-
name: "license 声明为 UNLICENSED(别人无法合法使用/分发)"
|
|
116
|
-
category: "npm"
|
|
117
|
-
severity: "warning"
|
|
118
|
-
description: "UNLICENSED / PROPRIETARY 只表示「未授权」——公开包的使用者无法合法使用与再分发,npm 页面也会标红。与 npm/license-field-check(缺字段)互补,本规则只判「有字段但值等于未授权」。依据:npm-publish-checklist 清单第 2 项"
|
|
119
|
-
kind: "npm-json"
|
|
120
|
-
fixable: true
|
|
121
|
-
mitigation: "改为明确 SPDX(如 \"license\": \"MIT\" / \"Apache-2.0\"),并把 LICENSE 文件纳入 files 白名单"
|
|
122
|
-
- id: npm/files-risky-entry
|
|
123
|
-
name: "files 白名单含敏感内容或体积产物(会随包发布)"
|
|
124
|
-
category: "npm"
|
|
125
|
-
severity: "warning"
|
|
126
|
-
description: "逐条核对 files 数组:出现 node_modules / .env / secret|credential|token / *.key|*.pem ⇒ 判为 blocker(凭据随包发布不可逆);出现 *.tgz / music|audio / *.mp3|*.wav / 字体 ⇒ 按规则严重度报(体积白涨)。依据:npm-publish-checklist 清单第 3、9、12 项"
|
|
127
|
-
kind: "npm-json"
|
|
128
|
-
fixable: true
|
|
129
|
-
mitigation: "从 files 删除这些条目;凭据类同时轮换令牌;用 npm pack --dry-run --json 复核实际打进包的文件清单"
|
|
130
|
-
- id: npm/meta-incomplete
|
|
131
|
-
name: "包元信息不全(author / keywords / bugs / homepage)"
|
|
132
|
-
category: "npm"
|
|
133
|
-
severity: "info"
|
|
134
|
-
description: "缺 author/keywords/bugs/homepage 会让 npm 包页面没有作者与仓库入口、也搜不到;规则逐个列出缺失项,便于一次补齐。依据:npm-publish-checklist 清单第 7 项"
|
|
135
|
-
kind: "npm-json"
|
|
136
|
-
fixable: false
|
|
137
|
-
mitigation: "补齐 author、若干 keywords、bugs/homepage(地址需实测存在)"
|
|
138
|
-
- id: npm/prepack-script-present
|
|
139
|
-
name: "存在 prepack/prepare/publishOnly 脚本(发布时会自动执行)"
|
|
140
|
-
category: "npm"
|
|
141
|
-
severity: "info"
|
|
142
|
-
description: "npm publish 前会自动执行 prepack / prepare / publishOnly / prepublishOnly;脚本跑不通发布会直接失败。命中即提示发布前本地先跑一次,并确认其产物已被 files 覆盖。依据:npm-publish-checklist 清单第 8 项"
|
|
143
|
-
kind: "npm-json"
|
|
144
|
-
fixable: false
|
|
145
|
-
mitigation: "发布前本地执行同名脚本确认可跑通;产物路径与 files 白名单保持一致"
|
|
146
|
-
- id: npm/peer-range-unbounded
|
|
147
|
-
name: "peerDependencies 未写显式上界(宿主兼容范围不明确)"
|
|
148
|
-
category: "npm"
|
|
149
|
-
severity: "info"
|
|
150
|
-
description: "peer 是「由宿主提供」的依赖,^ / ~ 的隐式上界常与实际宿主版本错位;建议写显式区间(如 \">=0.1.6-0 <0.3.0-0\")。不含 '<' 的条目才提示;写 '*' 的交由 npm/dependency-star-range 管辖、私有包整体跳过。依据:npm-publish-checklist 清单第 4 项"
|
|
151
|
-
kind: "npm-json"
|
|
152
|
-
fixable: false
|
|
153
|
-
mitigation: "peerDependencies 写显式区间,上界对齐宿主实际兼容版本"
|
|
154
|
-
- id: npm/repository-field-check
|
|
155
|
-
name: "repository 字段核对(npm 包元数据)"
|
|
156
|
-
category: "npm"
|
|
157
|
-
severity: "info"
|
|
158
|
-
description: "建议声明 repository({type,url})便于 npm 页面与依赖审计溯源。引擎结构化判定:repository 字段**缺失**才报(已声明则不报)"
|
|
159
|
-
kind: "npm-json"
|
|
160
|
-
exts: ["json"]
|
|
161
|
-
fixable: false
|
|
162
|
-
mitigation: "增加 \"repository\": { \"type\": \"git\", \"url\": \"https://github.com/<owner>/<repo>.git\" }"
|
|
163
|
-
|
|
164
|
-
# ── 版本字段(npm 包版本语义;从 version 槽位迁入——这是 npm 通用约定,不是自家纪律)──
|
|
165
|
-
# 作用域:格式类只认 package.json(filePatterns)。原实现 exts:["json"] 会扫所有 json,
|
|
166
|
-
# 第三方资源仓库里成千上万个带 "version" 字段的 json 被逐条判 error(实测 1435 条误报)。
|
|
167
|
-
- id: npm/version-format-triple
|
|
168
|
-
name: "package.json version 非 X.Y.Z 三段格式"
|
|
169
|
-
category: "npm"
|
|
170
|
-
severity: "error"
|
|
171
|
-
description: "npm 包 version 必须 SemVer 三段 X.Y.Z(两段 1.0 / 四段 1.0.0.1 / 带前缀均不合规);X 可为 0(0.x = 开发初始阶段,SemVer §4)。只对 package.json 生效"
|
|
172
|
-
include_paths: ["package.json"]
|
|
173
|
-
exts: ["json"]
|
|
174
|
-
patterns:
|
|
175
|
-
- "\"version\"\\s*:\\s*\"(?![0-9]+\\.[0-9]+\\.[0-9]+\")"
|
|
176
|
-
fixable: true
|
|
177
|
-
mitigation: "改为 X.Y.Z(如 1.2.0 或 0.3.0——0.x 合法开发期)"
|
|
178
|
-
- id: npm/version-commit-mismatch
|
|
179
|
-
name: "提交信息里的版本号需与 package.json 一致"
|
|
180
|
-
category: "npm"
|
|
181
|
-
severity: "info"
|
|
182
|
-
description: "提交信息含版本号时,应与 package.json 的 version 一致(提交即存档新版本);引擎为单文件正则、无法跨文件比对,命中即提示人工核对"
|
|
183
|
-
exts: ["md"]
|
|
184
|
-
patterns:
|
|
185
|
-
- "版本\\s*[::]?\\s*v?[0-9]+\\.[0-9]+\\.[0-9]+"
|
|
186
|
-
fixable: false
|
|
187
|
-
mitigation: "提交前核对 package.json version = 提交信息里的版本号"
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
# dsh-git-push 审计规则(paths 槽位,1.0.0)
|
|
2
|
-
#
|
|
3
|
-
# 路径类审计规则**集中一处**:硬编码绝对路径 / 路径穿越 / cd 兜底 / 写入被忽略目录 / 文档旧凭据路径。
|
|
4
|
-
#
|
|
5
|
-
# 为什么独立成槽位:
|
|
6
|
-
# · 这些规则**与语言无关**(nodejs / python / java 项目都可能踩),与「按语言分组」的槽位语义不同;
|
|
7
|
-
# · 原先散落在 nodejs 与 folder 两个槽位里(同一个"路径"主题两处维护)⇒ 集中后消除分裂;
|
|
8
|
-
# · 引擎的槽位是**动态**的:本文件放进 lib/audit-rules/ 即自动成为槽位(无需改代码)。
|
|
9
|
-
#
|
|
10
|
-
# 三段式写法(本槽位统一遵循):
|
|
11
|
-
# ① patterns 正则初筛 → ② astConfirm/astConfirmKind 精筛(实现在 lib/checks/,可拿到文件路径与
|
|
12
|
-
# 仓库上下文)→ ③ exceptions 说明豁免边界(最终由人判断,正则只是线索不是判决)。
|
|
13
|
-
metadata:
|
|
14
|
-
name: "路径类审计规则(硬编码绝对路径 / 路径穿越 / cd 兜底 / 写入忽略目录 / 旧凭据路径)"
|
|
15
|
-
version: "1.0.0"
|
|
16
|
-
|
|
17
|
-
rules:
|
|
18
|
-
# ----- 规则 1:硬编码绝对路径(2026-10-11 新增)-----
|
|
19
|
-
# 正则初筛(跨系统字面量)→ 精筛 astConfirmKind: hardcoded-abs-path
|
|
20
|
-
# (lib/checks/common.js 的 hardcodedAbsPathLines:fs.existsSync 判断"本机可访问"并换算相对路径;
|
|
21
|
-
# 基准 = 该文件所在目录(用户确认的选择);可访问 ⇒ 警告并附相对路径;不可访问 ⇒ 仅警告)
|
|
22
|
-
- id: paths/hardcoded-absolute-path
|
|
23
|
-
name: "硬编码绝对路径(换机即失效)"
|
|
24
|
-
category: "paths"
|
|
25
|
-
# blocker:写死本机数据/资源目录会直接导致换机、换挂载点后功能失效(真实故障形态)。
|
|
26
|
-
# 为不误伤正确写法,精筛排除了两类(见 lib/checks/hardcoded-path.js::isReasonableAbsolutePath):
|
|
27
|
-
# ① 临时目录 /tmp /var/tmp /dev/shm(跨机语义一致)
|
|
28
|
-
# ② 系统工具目录 /usr/bin /usr/local/bin /var/packages…(多候选探测是 tool-self-detection
|
|
29
|
-
# 要求的正确做法,把它当硬编码拦等于逼项目只能依赖 PATH)
|
|
30
|
-
# 文档类文件仍降级为 warning(示例路径属说明内容,见 lib/checks/regex.js 的文档降级)。
|
|
31
|
-
severity: "blocker"
|
|
32
|
-
description: "字符串里写死本机绝对路径(/volume1、/home、/Users、C:\\、\\\\server\\share、file://),换机/迁移/换挂载点后失效;应改为相对路径(基准 = 文件所在目录)、path.join 或配置项传入"
|
|
33
|
-
patterns:
|
|
34
|
-
- "/(volume[0-9]+|home|Users|var|usr|opt|tmp|mnt|srv|etc|root|Applications|Volumes)/[^\\s\"'`),;]+"
|
|
35
|
-
- "[A-Za-z]:[\\\\/][^\\s\"'`),;]+"
|
|
36
|
-
# UNC(\\\\server\\share\\...):初筛必须写,否则这类行进不了精筛通道
|
|
37
|
-
# (实测:漏了这条 ⇒ 夹具里 UNC 那行永远不报,而精筛明明有 UNC 判定)
|
|
38
|
-
- "\\\\\\\\[A-Za-z0-9_.-]+\\\\[^\\s\"'`),;]+"
|
|
39
|
-
- "file:///[^\\s\"'`),;]+"
|
|
40
|
-
astConfirm: true
|
|
41
|
-
astConfirmKind: "hardcoded-abs-path"
|
|
42
|
-
exceptions:
|
|
43
|
-
- "注释里的举例说明(仅提示,不阻断)"
|
|
44
|
-
- "已用 path.join / os.tmpdir() / 相对路径的写法"
|
|
45
|
-
- "测试夹具里刻意构造的样例路径(属测试数据)"
|
|
46
|
-
- "文档中带日期的历史实测记录(说明当时在哪台机器上跑的)"
|
|
47
|
-
|
|
48
|
-
# ----- 规则 2(迁移自 nodejs 槽位):路径穿越防护 -----
|
|
49
|
-
- id: security/no-path-traversal
|
|
50
|
-
name: "路径穿越防护"
|
|
51
|
-
category: "security"
|
|
52
|
-
severity: "error"
|
|
53
|
-
description: "人工核查提示:请核对本仓库是否存在「用户输入直接拼进文件路径」的目录遍历风险(本规则是**人工核查占位**,不指向具体行;命中行号仅作锚点)"
|
|
54
|
-
fixable: false
|
|
55
|
-
mitigation: "使用 path.resolve + startsWith 白名单校验"
|
|
56
|
-
|
|
57
|
-
# ----- 规则 3(迁移自 nodejs 槽位):文档引用旧凭据位置 -----
|
|
58
|
-
- id: credref-legacy-path
|
|
59
|
-
name: "文档引用旧凭据位置"
|
|
60
|
-
category: "security"
|
|
61
|
-
severity: "warning"
|
|
62
|
-
description: "文档含旧凭据位置引用:凭据统一存插件配置目录(DSH_HOME/git-push/,0600 权限)"
|
|
63
|
-
pattern: "(\\.ssh[\\\\/]credentials|data[\\\\/]sensitive[\\\\/]|credentials\\.md|sudo-key|git-rescue[\\\\/]token)"
|
|
64
|
-
fixable: false
|
|
65
|
-
|
|
66
|
-
# ----- 规则 4(迁移自 folder 槽位):cd 到可能不存在的目录 -----
|
|
67
|
-
# 三段式:正则初筛(cd 命令)→ token 精筛 astConfirm → 精筛集合 shell-cd-dynamic
|
|
68
|
-
# (lib/ast/shell.js:目标含 $、排除自我定位 dirname/BASH_SOURCE、同行无 ||、非 && 链)。
|
|
69
|
-
- id: folder/cd-to-maybe-missing
|
|
70
|
-
name: "cd 到可能不存在的目录(动态路径无兜底)"
|
|
71
|
-
category: "paths"
|
|
72
|
-
severity: "warning"
|
|
73
|
-
description: "cd 到变量/命令替换路径时目标目录可能不存在,cd 失败后脚本仍会继续执行;应加 || exit/return/echo 兜底或先确认目录存在"
|
|
74
|
-
patterns:
|
|
75
|
-
- "\\bcd\\s+\\S+"
|
|
76
|
-
astConfirm: true
|
|
77
|
-
astConfirmKind: "shell-cd-dynamic"
|
|
78
|
-
exceptions:
|
|
79
|
-
- "脚本自我定位(cd $(dirname $0) / ${BASH_SOURCE[0]%/*},目录必然存在)"
|
|
80
|
-
- "同行已有 || 兜底或 && 链"
|
|
81
|
-
|
|
82
|
-
# ----- 规则 5(迁移自 folder 槽位):写文件/目录到可能不存在的 gitignore 目录 -----
|
|
83
|
-
# 三段式:正则初筛(写操作字面量目标)→ token 精筛 astConfirm → 精筛集合
|
|
84
|
-
# write-into-gitignored(lib/ast/shell.js:读仓库 .gitignore 判定目标被忽略;无
|
|
85
|
-
# 仓库上下文 repoPath 时不报——不臆测)。
|
|
86
|
-
- id: folder/write-into-gitignored-dir
|
|
87
|
-
name: "写文件/目录到可能不存在的 gitignore 目录"
|
|
88
|
-
category: "paths"
|
|
89
|
-
severity: "warning"
|
|
90
|
-
description: "写操作的目标目录被 .gitignore 忽略且可能在仓库中不存在;产物不可见,运行时可能失败,应先 mkdir -p 或调整忽略"
|
|
91
|
-
patterns:
|
|
92
|
-
- "(writeFile|writeFileSync|appendFile|appendFileSync|createWriteStream|mkdir|mkdirSync)\\s*\\(\\s*['\"][^'\"]+['\"]"
|
|
93
|
-
astConfirm: true
|
|
94
|
-
astConfirmKind: "write-into-gitignored"
|
|
95
|
-
exceptions:
|
|
96
|
-
- "目标为 node_modules 内写入(安装产物)"
|
|
97
|
-
- "目标为 /tmp 临时目录"
|
|
98
|
-
- ".gitignore 中以 ! 取反的路径"
|
|
@@ -1,245 +0,0 @@
|
|
|
1
|
-
# dsh-skip-sensitive: 规则定义文件含符号示范文本(fs.readFileSync / push / while 等)
|
|
2
|
-
# dsh-skip-residue: 规则定义文件含 console/while(true) 模式串示范(规则定义本身)
|
|
3
|
-
# dsh-git-push 审计规则(performance 槽位,1.0.4 beta)
|
|
4
|
-
# 性能审计:内存爆炸 / 无界增长等高成本代码模式(子模式规则示范,文档 §13)。
|
|
5
|
-
# 规则类型由编译函数按字段自动指派;patterns 条目支持对象子模式(id/pattern/message)。
|
|
6
|
-
# dimensions:10 维度绑定,支持一字段多维度。
|
|
7
|
-
metadata:
|
|
8
|
-
name: "性能审计规则(memory-bomb 示范落地)"
|
|
9
|
-
version: "1.0.4"
|
|
10
|
-
|
|
11
|
-
rules:
|
|
12
|
-
# ── 内存爆炸检测(文档 §13 示例规则落地:子模式 + per-pattern message)──
|
|
13
|
-
- id: performance/memory-bomb
|
|
14
|
-
# astConfirm: 正则只做初筛,命中行必须再经 token 级确认「真在代码里」——
|
|
15
|
-
# 已消除**注释行**里的示例文本误报(如讲解「while(true) 占死线程」的注释 ✗)。
|
|
16
|
-
# 已知边界(2026-10-15 已修):匹配落在**字符串字面量内**时也曾误报 ——
|
|
17
|
-
# astConfirmSpan(**按规则 opt-in**)在行级确认之上再做**列级**确认:
|
|
18
|
-
# 命中位置落在字符串/模板串/注释区间内 ⇒ 不算真实代码。本规则开启它 ✓
|
|
19
|
-
# ⚠️ 不可无条件对所有 astConfirm 规则开启:硬编码路径/凭据等规则的命中**本来就该在字符串里**。
|
|
20
|
-
astConfirm: true
|
|
21
|
-
astConfirmSpan: true
|
|
22
|
-
name: "检测可能导致内存爆炸的代码"
|
|
23
|
-
category: "performance"
|
|
24
|
-
severity: "warning"
|
|
25
|
-
description: "短时间内占用大量内存的代码模式(受控的本地小 JSON/配置文件读取不算)"
|
|
26
|
-
# 2026-09-27:仅代码文件——docs 方案文的「全量读入文件」示例是讲解文本,不是运行代码
|
|
27
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "py"]
|
|
28
|
-
# 2026-09-13:子模式精筛——full-file-read 命中后由引擎确认「读的是否受控小文件」
|
|
29
|
-
astConfirmKind: "small-file-read"
|
|
30
|
-
patterns:
|
|
31
|
-
- id: full-file-read
|
|
32
|
-
pattern: "fs\\.(readFileSync|readFile)\\s*\\("
|
|
33
|
-
# 2026-09-13 误报修复(正则初筛 → AST 精筛):本规则针对「大文件全量读入」,
|
|
34
|
-
# 读**受控的本地小 JSON 数据/配置文件**(记分数据、标题缓存等,紧跟
|
|
35
|
-
# JSON.parse 或路径变量含 data/cache/config/locale)不构成内存爆炸风险——
|
|
36
|
-
# 旧实现命中即报,对任何读 JSON 的项目恒定误报。精筛条件见 astConfirmKind。
|
|
37
|
-
message: "全量读入文件可能占用大量内存,建议用流式处理"
|
|
38
|
-
- id: unbounded-push
|
|
39
|
-
pattern: "(for|while)\\s*\\([^)]*\\)\\s*\\{[^}]*\\.push\\s*\\([^)]*\\)"
|
|
40
|
-
message: "循环内 push 无界累积(可能内存增长失控),检查是否有清理机制或上限"
|
|
41
|
-
- id: chained-push
|
|
42
|
-
pattern: "\\.push\\s*\\([^)]*\\)\\s*\\.push"
|
|
43
|
-
message: "链式 push 连续追加(警惕无界累积),确认有上限控制"
|
|
44
|
-
- id: array-spread
|
|
45
|
-
pattern: "\\[\\s*\\.\\.\\.\\w+\\s*,\\s*\\.\\.\\.\\w+\\s*\\]"
|
|
46
|
-
message: "展开多个大数组会一次性创建新数组"
|
|
47
|
-
- id: infinite-loop
|
|
48
|
-
pattern: "while\\s*\\(\\s*true\\s*\\)"
|
|
49
|
-
message: "无限循环需确认有 break 条件和内存控制"
|
|
50
|
-
- id: exec-sync
|
|
51
|
-
pattern: "execSync\\s*\\("
|
|
52
|
-
message: "execSync 输出全部进内存,建议用 spawn + 流"
|
|
53
|
-
- id: json-stringify-large
|
|
54
|
-
pattern: "JSON\\.stringify\\s*\\([^)]{50,}\\)"
|
|
55
|
-
message: "大对象序列化会瞬间产生等量字符串"
|
|
56
|
-
fixable: false
|
|
57
|
-
mitigation: |
|
|
58
|
-
- 大文件用 fs.createReadStream 流式处理
|
|
59
|
-
- 数组累积加 maxLength 上限,超出时丢弃旧数据
|
|
60
|
-
- 缓存加 TTL 或 LRU 淘汰机制
|
|
61
|
-
- 递归加深度限制
|
|
62
|
-
- 子进程用 spawn + 流式读取
|
|
63
|
-
|
|
64
|
-
# ── 循环内全量集合物化(二次增长;真实样本见 lib/ast/perf.js 注释)──
|
|
65
|
-
- id: performance/loop-full-collection
|
|
66
|
-
name: "禁止在循环体内做全量集合物化"
|
|
67
|
-
category: "performance"
|
|
68
|
-
severity: "warning"
|
|
69
|
-
description: "循环体内 Array.from(x.values()/keys()/entries()) 会把整个集合物化一遍:成本≈循环次数×集合大小,随数据量二次增长(应先建索引、循环内 O(1) 查)"
|
|
70
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
71
|
-
# 纯正则无法表达「在不在循环体内」——由 AST 精筛(allow 语义:只报循环体内的命中)
|
|
72
|
-
astConfirmKind: "loop-full-collection"
|
|
73
|
-
patterns:
|
|
74
|
-
- id: array-from-values
|
|
75
|
-
pattern: "Array\\.from\\s*\\(\\s*[A-Za-z_$][\\w.$]*\\.(values|keys|entries)\\s*\\(\\s*\\)\\s*\\)"
|
|
76
|
-
message: "循环体内全量物化集合:改为循环外建一次索引(Map/Set),循环内 O(1) 查"
|
|
77
|
-
fixable: false
|
|
78
|
-
mitigation: "循环外建 Map/Set 索引(如 name→nodeId),循环内用 .get()/.has() 查;确需快照时提到循环外"
|
|
79
|
-
|
|
80
|
-
# ── 循环内重复调用同一函数(可记忆化 / 提前计算)──
|
|
81
|
-
- id: performance/repeat-identical-call
|
|
82
|
-
name: "同一循环体或同一函数体内重复调用同一函数(实参完全相同)"
|
|
83
|
-
category: "performance"
|
|
84
|
-
severity: "warning"
|
|
85
|
-
description: "同一循环体或同一函数体内 ≥2 次实参完全相同的调用:纯函数应记忆化、fs 属性调用(stat/readdir 等)应合并成一次(真实案例:路径解析函数在解析循环内被调 8762 次、占全量扫描 89%,加记忆化后 4581ms→344ms)"
|
|
86
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
87
|
-
# 纯正则无法表达「在不在循环体/函数体内 / 实参是否相同」——由 AST 精筛(allow 语义)
|
|
88
|
-
astConfirmKind: "repeat-identical-call"
|
|
89
|
-
# 第三方/构建产物里的重复是上游代码的形态(实测 vendors 的 emscripten 胶水层一个文件就 37 处)⇒ 不报
|
|
90
|
-
exclude_paths: ["assets/", "vendor/", "third_party/", "dist/", "build/"]
|
|
91
|
-
patterns:
|
|
92
|
-
- id: repeated-call
|
|
93
|
-
pattern: "[A-Za-z_$][\\w.$]*\\s*\\([^()]*\\)"
|
|
94
|
-
message: "循环体/函数体内重复调用(实参相同):若为纯函数可记忆化,fs 属性调用可直接合并"
|
|
95
|
-
fixable: false
|
|
96
|
-
mitigation: "加一层 Map 记忆化(键=入参组合)或把结果提到循环外/合并成一次;有副作用的调用(写文件/网络/日志)不适用"
|
|
97
|
-
|
|
98
|
-
# ── 写死 User-Agent(2026-10-12 从 gbmd 实战沉淀)──
|
|
99
|
-
# 教训:GameBanana 等平台的会话与「换取 cookie 时的浏览器 UA」绑定;下载路径写死 Chrome UA
|
|
100
|
-
# ⇒ 服务端判定未登录 ⇒ 全量 403。UA 必须来自配置/调用方,兜底常量要显式命名。
|
|
101
|
-
- id: performance/hardcoded-user-agent
|
|
102
|
-
name: "对象字面量里写死 User-Agent"
|
|
103
|
-
category: "performance"
|
|
104
|
-
severity: "blocker"
|
|
105
|
-
description: "请求头里直接写死浏览器 UA(而非读配置/调用方传入):会话类站点会因 UA 与 cookie 不匹配判未登录(实战:下载全 403)"
|
|
106
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "py"]
|
|
107
|
-
patterns:
|
|
108
|
-
- id: literal-ua
|
|
109
|
-
pattern: "[\"']User-Agent[\"']\\s*:\\s*[\"']Mozilla[^\"']*[\"']"
|
|
110
|
-
message: "写死 User-Agent:改为读配置(如 cfg.gbUserAgent)或调用方传入;确需兜底请用命名常量(DEFAULT_UA)"
|
|
111
|
-
fixable: false
|
|
112
|
-
mitigation: "UA 与 cookie 同源:从配置/调用方取;兜底值提成命名常量并在注释里说明用途"
|
|
113
|
-
|
|
114
|
-
# ── 手写资源版本号(2026-10-12 从 gbmd 实战沉淀)──
|
|
115
|
-
# 教训:href 手写 ?v=4.4.1,而脚本元数据已 @version 4.5.0 ⇒ 必然漂移;serve 端 no-store 时
|
|
116
|
-
# 版本参数本身也多余(浏览器每次都会拉最新)。
|
|
117
|
-
- id: performance/handwritten-asset-version
|
|
118
|
-
name: "href 手写 ?v= 版本号(必然漂移)"
|
|
119
|
-
category: "performance"
|
|
120
|
-
severity: "warning"
|
|
121
|
-
description: "静态资源/脚本链接手写 ?v=:与真实版本(如油猴 @version)必然漂移,且服务端已 no-store 时属多余参数"
|
|
122
|
-
exts: ["html", "htm", "js", "mjs", "cjs", "ts", "tsx", "jsx", "vue", "svelte"]
|
|
123
|
-
patterns:
|
|
124
|
-
- id: userscript-v
|
|
125
|
-
pattern: "\\.user\\.js\\?v=[0-9]"
|
|
126
|
-
message: "油猴脚本链接手写 ?v=:与脚本 @version 必然漂移;服务端路由已 no-store 时请直接去掉版本参数"
|
|
127
|
-
fixable: false
|
|
128
|
-
mitigation: "去掉手写版本号;需要防缓存就用构建期 hash 或服务端 no-store"
|
|
129
|
-
|
|
130
|
-
# ── 接口回整个状态对象(2026-10-12 从 gbmd 实战沉淀)──
|
|
131
|
-
# 教训:/api/task 单次回 34.3MB、写接口把 38MB 完整任务塞进响应 ⇒ 每 2 秒轮询 ≈17MB/s,
|
|
132
|
-
# 页面卡死、服务端序列化被拖垮。列表类接口应回摘要 + 分页。
|
|
133
|
-
- id: performance/endpoint-returns-whole-state
|
|
134
|
-
name: "接口直接回整个状态对象(裸变量)"
|
|
135
|
-
category: "performance"
|
|
136
|
-
severity: "warning"
|
|
137
|
-
description: "响应体里直接塞一个裸变量(可能是完整状态对象):大对象序列化 + 传输成本随数据量线性增长(实战:34.3MB/次 × 每 2 秒)"
|
|
138
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
139
|
-
patterns:
|
|
140
|
-
- id: bare-task-var
|
|
141
|
-
pattern: "\\btask\\s*:\\s*[A-Za-z_$][\\w$]*\\s*[,}]"
|
|
142
|
-
message: "响应里回裸变量 task: X:确认 X 是否为完整状态对象;列表类接口应回摘要/分页"
|
|
143
|
-
fixable: false
|
|
144
|
-
mitigation: "改为回摘要(状态/统计/计数)+ 分页接口;完整对象只在显式导出接口返回"
|
|
145
|
-
|
|
146
|
-
# ── 无界循环 / 高 CPU 轮询(性能补充)──
|
|
147
|
-
- id: performance/busy-wait-loop
|
|
148
|
-
# 同上:注释里的 while(true) 已不再误报 ✓;
|
|
149
|
-
# 并开启 astConfirmSpan ⇒ 字符串字面量里的 'while (true) {}'(测试用)也不再误报 ✓
|
|
150
|
-
astConfirm: true
|
|
151
|
-
astConfirmSpan: true
|
|
152
|
-
name: "忙等待循环(高 CPU 空转)"
|
|
153
|
-
category: "performance"
|
|
154
|
-
severity: "warning"
|
|
155
|
-
description: "while 空循环 / 同步轮询会占满 CPU 核心,建议用 setTimeout/async 等待"
|
|
156
|
-
patterns:
|
|
157
|
-
- "while\\s*\\(\\s*[^)]*true[^)]*\\s*\\)\\s*\\{\\s*\\}"
|
|
158
|
-
- "for\\s*\\([^)]*;[^)]*;[^)]*\\)\\s*\\{\\s*\\}"
|
|
159
|
-
fixable: false
|
|
160
|
-
mitigation: "等待用 setTimeout / async sleep,轮询加间隔与超时"
|
|
161
|
-
|
|
162
|
-
# ── 2026-10-12 实战沉淀:4 条需 AST 精筛的性能/健壮性规则 ──
|
|
163
|
-
# 共性:正则只能看出「写了某个调用/循环」,看不出它在不在循环里、循环规模多大、函数会不会返回 undefined。
|
|
164
|
-
# 每条都在真实修复提交上验证过:修复前命中、修复后不报(语料见 gbmd 项目 test/perf-antipatterns.test.cjs)。
|
|
165
|
-
|
|
166
|
-
- id: performance/loop-no-fallback-return
|
|
167
|
-
name: "循环后缺兜底 return(函数可能返回 undefined)"
|
|
168
|
-
category: "performance"
|
|
169
|
-
severity: "blocker"
|
|
170
|
-
description: "函数顶层循环里有值 return,循环之后既无 return 也无 throw ⇒ 某些分支会「走完循环直接掉出函数」返回 undefined;调用方解构/取值即崩(实战:fetchJsonHeaders 因 maxAttempts(6) > 循环上界 retries(1) 而返回 undefined,面板报 Cannot destructure property 'json' …)"
|
|
171
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
172
|
-
# 正则只做「循环行」初筛,是否真会掉出函数由 AST 判定(allow 语义)
|
|
173
|
-
astConfirmKind: "loop-no-fallback-return"
|
|
174
|
-
patterns:
|
|
175
|
-
- id: loop-line
|
|
176
|
-
pattern: "\\b(for|while)\\s*\\("
|
|
177
|
-
message: "循环之后没有兜底 return/throw:确认所有分支都会返回值或抛错(否则调用方拿到 undefined)"
|
|
178
|
-
fixable: false
|
|
179
|
-
mitigation: "循环结束后补 `throw lastErr` 或 `return 默认值`;重试循环的 maxAttempts 必须与循环上界一致"
|
|
180
|
-
|
|
181
|
-
- id: performance/loop-full-rewrite-call
|
|
182
|
-
name: "循环内调用「整份重写文件」的函数"
|
|
183
|
-
category: "performance"
|
|
184
|
-
severity: "warning"
|
|
185
|
-
description: "循环体里调用会 writeFileSync + JSON.stringify 整份文件的函数 ⇒ 每轮重写整份;单份几十 MB 时写盘量 = 轮数 × 文件大小(实战:收尾逐目录重写 15–26MB 游戏索引,数千轮 = 几十 GB、收尾 634 秒、接口堵死 74 秒)。**循环规模静态不可知**(13 个游戏 vs 4,598 个目录代码同形),故只作 warning,判真伪需运行期计数"
|
|
186
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
187
|
-
astConfirmKind: "loop-full-rewrite-call"
|
|
188
|
-
patterns:
|
|
189
|
-
- id: rewrite-like-call
|
|
190
|
-
pattern: "\\b\\w*(save|write|persist|flush|rewrite)\\w*\\s*\\("
|
|
191
|
-
message: "循环内整份重写文件:改为批量期间只更新内存、循环结束后统一落盘(或加 deferSave/防抖)"
|
|
192
|
-
fixable: false
|
|
193
|
-
mitigation: "批量收集改动 → 循环外每个目标文件只写一次;确需逐轮写就加节流窗口或改增量写"
|
|
194
|
-
|
|
195
|
-
- id: performance/nested-linear-scan
|
|
196
|
-
name: "成员判定回调里套循环做 === 比较(O(n×m))"
|
|
197
|
-
category: "performance"
|
|
198
|
-
severity: "warning"
|
|
199
|
-
description: "filter/find/some/every 的回调里再套 for 循环逐条 === 比较 ⇒ 复杂度 O(n×m)(实战:2,544 × 40,394 ≈ 1.03 亿次比较,纯 CPU 阻塞 12,784ms;改成先建 Set 再判定 ⇒ 14ms,913×)"
|
|
200
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
201
|
-
astConfirmKind: "nested-linear-scan"
|
|
202
|
-
patterns:
|
|
203
|
-
- id: membership-callback
|
|
204
|
-
pattern: "\\.(filter|find|some|every)\\s*\\("
|
|
205
|
-
message: "成员判定回调里套循环逐条比较:先把一侧收进 Set/Map 再判定(O(n+m))"
|
|
206
|
-
fixable: false
|
|
207
|
-
mitigation: "循环外建 Set/Map 索引,回调内 O(1) 查;键要选稳定唯一值(如 modId)"
|
|
208
|
-
|
|
209
|
-
- id: performance/long-sync-loop
|
|
210
|
-
name: "async 函数内长同步循环无让出点"
|
|
211
|
-
category: "performance"
|
|
212
|
-
severity: "warning"
|
|
213
|
-
description: "async 函数里的循环体含 ≥2 个同步调用且整段无 await ⇒ 长任务占满事件循环,期间接口全部超时(实战:收尾逐目录同步 stat/read/write 把 /api/* 堵死 74 秒)"
|
|
214
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
215
|
-
astConfirmKind: "long-sync-loop"
|
|
216
|
-
patterns:
|
|
217
|
-
- id: loop-line
|
|
218
|
-
pattern: "\\b(for|while)\\s*\\("
|
|
219
|
-
message: "长同步循环无让出点:每 N 轮 await setImmediate/延时一次(总耗时不变,服务保持可响应)"
|
|
220
|
-
fixable: false
|
|
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,101 +0,0 @@
|
|
|
1
|
-
# ============================================================
|
|
2
|
-
# PHP 代码审计规则集(首版 · 语言专项)
|
|
3
|
-
# 版本:0.2.0
|
|
4
|
-
# 适用: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)
|
|
10
|
-
# ============================================================
|
|
11
|
-
|
|
12
|
-
metadata:
|
|
13
|
-
name: "PHP 审计规则集(首版 · 语言专项)"
|
|
14
|
-
version: "0.2.0"
|
|
15
|
-
language: "php"
|
|
16
|
-
author: "DeepSeek"
|
|
17
|
-
description: "PHP 项目语言专用规则(pattern 层首版:eval/extract/调试输出/错误抑制/md5 口令/die-exit)"
|
|
18
|
-
last_updated: "2026-10-16"
|
|
19
|
-
|
|
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
|