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,662 +0,0 @@
|
|
|
1
|
-
# ============================================================
|
|
2
|
-
# Node.js 后端代码审计规则集
|
|
3
|
-
# 作者:DeepSeek
|
|
4
|
-
# 版本:1.0.0
|
|
5
|
-
# 适用:Node.js / JavaScript / TypeScript 后端项目
|
|
6
|
-
# 描述:基于优秀代码评估标准转换的自动化审计规则
|
|
7
|
-
# 最后更新:2026-09-08
|
|
8
|
-
# ============================================================
|
|
9
|
-
|
|
10
|
-
metadata:
|
|
11
|
-
name: "Node.js 后端审计规则集"
|
|
12
|
-
version: "1.0.0"
|
|
13
|
-
language: "javascript"
|
|
14
|
-
author: "DeepSeek"
|
|
15
|
-
description: "覆盖命名规范、代码结构、安全性、健壮性、性能、测试、依赖等维度"
|
|
16
|
-
last_updated: "2026-09-08"
|
|
17
|
-
|
|
18
|
-
rules:
|
|
19
|
-
# ----- 1. 可读性 -----
|
|
20
|
-
# exts 说明(2026-09-13):代码结构类规则(命名/嵌套/长度)只对**代码文件**生效。
|
|
21
|
-
# 不声明 exts 时会对 md/json/yml 也生效——markdown 文档里的示例代码块
|
|
22
|
-
# (如 python 块里的 `PY`、JSON 结构里的缩进)会被当成代码误报。
|
|
23
|
-
# 本质:这类规则的判定对象是「代码」,文档不是代码(文档里的示例是文本内容)。
|
|
24
|
-
- id: readability/function-name-camelcase
|
|
25
|
-
name: "函数名使用 camelCase"
|
|
26
|
-
category: "readability"
|
|
27
|
-
severity: "warning"
|
|
28
|
-
description: "函数名应使用 camelCase 命名规范"
|
|
29
|
-
pattern: "^[a-z][a-zA-Z0-9]*$"
|
|
30
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
31
|
-
fixable: false
|
|
32
|
-
examples:
|
|
33
|
-
bad: "function get_user_by_id() {}"
|
|
34
|
-
good: "function getUserById() {}"
|
|
35
|
-
|
|
36
|
-
- id: readability/variable-name-camelcase
|
|
37
|
-
name: "变量名使用 camelCase"
|
|
38
|
-
category: "readability"
|
|
39
|
-
severity: "warning"
|
|
40
|
-
description: "变量名应使用 camelCase,避免使用缩写或拼音"
|
|
41
|
-
pattern: "^[a-z][a-zA-Z0-9]*$"
|
|
42
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
43
|
-
fixable: false
|
|
44
|
-
|
|
45
|
-
- id: readability/variable-min-length
|
|
46
|
-
external: variable-min-length # 2026-10-05:external 字段 = 具体标识(归属的 audit-ext 扩展脚本名;布尔 true 不合法)——内置停跑,由该 ext 脚本经统一动态入口执行
|
|
47
|
-
name: "变量名长度不少于 2 个字符"
|
|
48
|
-
category: "readability"
|
|
49
|
-
severity: "warning"
|
|
50
|
-
description: "过短的变量名(如 a, b, x)降低代码可读性"
|
|
51
|
-
min_length: 2
|
|
52
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
53
|
-
exceptions: ["i", "j", "k", "n", "e", "cb"]
|
|
54
|
-
# token 级判定层的惯用短名按层豁免:lib/ast/* 与 lib/checks/* 是 token/行级扫描代码,
|
|
55
|
-
# m(正则匹配)、c/d(token)、q(query)等单字母名作用域极小且是该层通行写法,
|
|
56
|
-
# 改名是高 churn 且易改错 ⇒ 归为误报(自审实测命中 8 条),不按缺陷计
|
|
57
|
-
exclude_paths: ["lib/ast", "lib/checks"]
|
|
58
|
-
fixable: false
|
|
59
|
-
|
|
60
|
-
# 坏命名检出增强(bad-naming 样本实测补全)——函数名缩写/万能词/通用词/魔数/嵌套深度
|
|
61
|
-
- id: readability/function-name-too-short
|
|
62
|
-
name: "函数名过短(缩写,无法猜出含义)"
|
|
63
|
-
category: "readability"
|
|
64
|
-
severity: "warning"
|
|
65
|
-
description: "函数名 ≤2 字符是缩写(如 gU),无法从名字猜出含义"
|
|
66
|
-
patterns:
|
|
67
|
-
- "\\bfunction\\s+[a-zA-Z_$][a-zA-Z0-9_$]{0,1}\\s*\\("
|
|
68
|
-
# 方法定义行(class A { gh() {} } / const o = { ef() {} })不含 function 关键字,
|
|
69
|
-
# 第一条 pattern 结构上不可能命中它们 ⇒ 候选行都进不来,树化后照样漏报(实测踩过:
|
|
70
|
-
# allow 精筛前必须先过初筛)。这里只做**粗筛**(行首短标识符 + 左括号),
|
|
71
|
-
# 是否真是「定义」由 short-func-name 精筛(语法树 method_definition 节点)判定——
|
|
72
|
-
# 因此 ` ab(1);` 这类调用行虽进候选,也不会被报。
|
|
73
|
-
- "^\\s*[a-zA-Z_$][a-zA-Z0-9_$]{0,1}\\s*\\("
|
|
74
|
-
# 2026-09-13 误报修复(正则初筛 → AST 精筛):i18n 领域标准缩写(tr/t/L 等翻译、
|
|
75
|
-
# 字典函数名)长度 ≤2 但含义公认,纯正则命中即报会把它们当「无法猜出含义」报掉。
|
|
76
|
-
# astConfirmKind: short-func-name → token 级判定(checkShortFunctionNameAst):
|
|
77
|
-
# 长度 ≤2 且不在公认缩写白名单(tr/t/L/i18n/db/fs/...)里才报。
|
|
78
|
-
astConfirm: true
|
|
79
|
-
astConfirmKind: short-func-name
|
|
80
|
-
fixable: false
|
|
81
|
-
mitigation: "函数名用有含义的完整单词:getUser / sumArray / buildReport"
|
|
82
|
-
|
|
83
|
-
- id: readability/vague-function-name
|
|
84
|
-
name: "函数名万能词(doIt/handle/process 等)"
|
|
85
|
-
category: "readability"
|
|
86
|
-
severity: "warning"
|
|
87
|
-
description: "doIt/handle/process/run/do/exec/doEverything 等万能动词函数名无法表达具体职责,应从名字看出做什么"
|
|
88
|
-
pattern: "\\bfunction\\s+(doIt|doItAll|doEverything|handle|process|run|do|exec|deal|make|thing)\\b\\s*\\("
|
|
89
|
-
fixable: false
|
|
90
|
-
mitigation: "换成具体动作:doIt→submitOrder、handle→handleOrderCancellation、process→parsePayload"
|
|
91
|
-
|
|
92
|
-
- id: readability/vague-variable-name
|
|
93
|
-
name: "变量名通用词(data/obj/flag/tmp 等)"
|
|
94
|
-
category: "readability"
|
|
95
|
-
severity: "warning"
|
|
96
|
-
description: "data/obj/flag/tmp/temp/val/value/item/thing 等通用词变量名信息量低,看不出具体内容"
|
|
97
|
-
# 2026-09-27:词表剔除 res——HTTP/git 操作的「Response」标准缩写(res.json / await fetch 的
|
|
98
|
-
# const res = await ...),语义从上下文清晰,不属 vague。保留 result(信息量确实低)。
|
|
99
|
-
pattern: "\\b(?:const|let|var)\\s+(data|obj|object|flag|tmp|temp|val|value|item|thing|stuff|result)\\b"
|
|
100
|
-
fixable: false
|
|
101
|
-
mitigation: "用内容命名:data→userList、flag→isAdmin、tmp→tempFile"
|
|
102
|
-
|
|
103
|
-
# 2026-09-16 合并:readability/magic-number(regex 通道)已并入 readability/magic-number-smart——
|
|
104
|
-
# smart(AST token 级)覆盖全部数字字面量形态(含运算 `base * 0.2`、比较 `score > 1.5` 里的数字),
|
|
105
|
-
# regex 通道双报且豁免弱(此前靠 astConfirm 复用 smart 判定),删除避免同一魔数报两条。
|
|
106
|
-
# 命名常量判定已放宽(lib/ast/magic-number.js isNamedConstantValue):dshgp_*/DEFAULT_*/MAX_* 前缀
|
|
107
|
-
# 常量与含 timeout/limit/size/ms 等语义词尾的常量名不再误报。
|
|
108
|
-
|
|
109
|
-
- id: readability/magic-number-smart
|
|
110
|
-
name: "硬编码魔数检测(版本号豁免版)"
|
|
111
|
-
kind: "magic-number-smart"
|
|
112
|
-
category: "readability"
|
|
113
|
-
severity: "warning"
|
|
114
|
-
description: "检测硬编码魔数(\\b\\d{2,}\\b / \\b0x[0-9a-fA-F]+\\b / \\b\\d+\\.\\d+\\b),但自动豁免:版本号(v1.2.3/1.2.3/VERSION 常量)、日期时间(2026-09-12/时间戳/时间)、HTTP 状态码(100-504 清单)、常见合法常量(0/1/-1/60/100/1000/1024/3600/86400 等)、状态枚举(pending/completed 等字符串);上下文关键字分流——magic_number_hints(timeout/retry/max/min/limit/size/count/port/interval/delay/duration/threshold/buffer/chunk)内的数字报魔数,legitimate_hints(version/date/year/month/day/hour/minute/second/http/status)内的数字豁免;同一数字文件内出现 ≥3 次强制标记"
|
|
115
|
-
magic_number_hints: ["timeout", "retry", "max", "min", "limit", "size", "count", "port", "interval", "delay", "duration", "threshold", "buffer", "chunk"]
|
|
116
|
-
legitimate_hints: ["version", "date", "year", "month", "day", "hour", "minute", "second", "http", "status"]
|
|
117
|
-
force_count: 3
|
|
118
|
-
# 2026-09-13 误报修复:只对代码文件生效(README 版本表 / CSS 尺寸 / config.json 端口不报)
|
|
119
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
120
|
-
fixable: true
|
|
121
|
-
mitigation: "提取命名常量并注释含义:const MAX_RETRY = 3; const API_TIMEOUT_MS = 30000; 版本号/日期/HTTP 状态码/常见常量/状态枚举自动豁免"
|
|
122
|
-
|
|
123
|
-
- id: readability/max-nesting-depth
|
|
124
|
-
name: "嵌套过深(缩进层级 > 3)"
|
|
125
|
-
category: "readability"
|
|
126
|
-
severity: "warning"
|
|
127
|
-
description: "代码缩进嵌套超过 3 层(如 for→for→if→if),可读性灾难,应提前 return 或抽函数"
|
|
128
|
-
max_depth: 4
|
|
129
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
130
|
-
fixable: false
|
|
131
|
-
|
|
132
|
-
- id: readability/max-function-length
|
|
133
|
-
name: "函数长度不超过 50 行"
|
|
134
|
-
category: "readability"
|
|
135
|
-
severity: "warning"
|
|
136
|
-
description: "过长的函数难以理解和维护"
|
|
137
|
-
max_lines: 50
|
|
138
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
139
|
-
# 2026-09-23 作用域(P1):启动路径初始化函数(apply/init/main/bootstrap/setup 等)豁免
|
|
140
|
-
# 2026-10-05 作用域(评审规则③):序列化/反序列化职责函数(serialize/to_json/from_json/
|
|
141
|
-
# dumps/loads/parse 等)——意义明确、变量生命周期仅当前会话时代码常超百行,过度拆分反而
|
|
142
|
-
# 复杂化数据传递与生命周期处理(得不偿失),豁免函数长度(classifyFunctionPath 返回
|
|
143
|
-
# serialization 路径)。
|
|
144
|
-
scope_rules:
|
|
145
|
-
- scope: "startup"
|
|
146
|
-
action: "exempt"
|
|
147
|
-
reason: "启动路径初始化函数(一次性执行),阈值不适用"
|
|
148
|
-
- scope: "serialization"
|
|
149
|
-
action: "exempt"
|
|
150
|
-
reason: "序列化/反序列化职责函数:意义明确且变量生命周期仅当前会话,超百行是职责自然形态,过度拆分得不偿失"
|
|
151
|
-
fixable: true
|
|
152
|
-
|
|
153
|
-
- id: readability/max-file-length
|
|
154
|
-
name: "文件代码行数不超过 400 行"
|
|
155
|
-
category: "readability"
|
|
156
|
-
severity: "warning"
|
|
157
|
-
description: "单文件代码行超过 400 行时应拆分模块(存量超大文件为已知债务,仅提醒不拦截;D1 重构已拆分核心文件)。代码行口径见 lib/ast/line-count.js(总行 − 纯注释行 − 空行)"
|
|
158
|
-
max_lines: 400
|
|
159
|
-
# 2026-09-23:只对**代码文件**生效——md/yml/json 文档天然长(README/docs 详解/规则包),
|
|
160
|
-
# 文件行数拆分规则针对代码模块;此前无 exts 导致 README 1058 行/docs 详解被误报。
|
|
161
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
162
|
-
# 平台约束降级(DSH 插件专属):DSH 要求插件的**运行态客户端**是单文件
|
|
163
|
-
# (dsh.client + exports["./client"] 指向同一文件)——那是**产物**,不是源码形态:
|
|
164
|
-
# 源码可以按分片维护 + 构建拼接(本仓库 lib/client-parts/** → lib/client.js)。
|
|
165
|
-
# 故按两档作用域分别降级(仍出现在报告里,降为 info 且不扣分;
|
|
166
|
-
# 不用 exempt——静默排除会让这个事实从报告里消失):
|
|
167
|
-
# · dsh-client-entry :那份**产物**本身(运行态单文件,行数天然超长)
|
|
168
|
-
# · dsh-client-fragment :**分片源码**(片段:单文件语法不成立,独立看行数超阈值不代表可拆分)
|
|
169
|
-
# 作用域值由 lib/audit/client-entry.js 推导(读 package.json,非写死文件名)。
|
|
170
|
-
# 注意:必须声明在**规则原槽位**——loader 是拼接而非覆盖,写到别的槽位不会生效。
|
|
171
|
-
scope_rules:
|
|
172
|
-
- scope: "dsh-client-entry"
|
|
173
|
-
action: "downgrade"
|
|
174
|
-
reason: "运行态客户端产物本身就是单文件(源码已分片维护 + 构建拼接,见 lib/client-parts/)——降级为提示,仍报不排除"
|
|
175
|
-
- scope: "dsh-client-fragment"
|
|
176
|
-
action: "downgrade"
|
|
177
|
-
reason: "客户端分片是构建片段(拼接后才是完整文件)——单看行数超阈值不构成可拆分问题,降级为提示、仍报不排除"
|
|
178
|
-
fixable: false
|
|
179
|
-
|
|
180
|
-
- id: readability/comment-density
|
|
181
|
-
name: "行注释密度过高(注释复述代码)"
|
|
182
|
-
category: "readability"
|
|
183
|
-
severity: "warning"
|
|
184
|
-
description: "变量即注释——语义明确的代码里变量名已表达内容,额外的行注释不加深理解;只保留具有隐性约束、复杂设计、外部契约、非显然决策的块注释,注释应解释「为什么」而非复述「做了什么」"
|
|
185
|
-
threshold: 0.4
|
|
186
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
187
|
-
fixable: false
|
|
188
|
-
|
|
189
|
-
# ----- 2. 可维护性 -----
|
|
190
|
-
# 2026-10-05:激活原「死规则」——此前无 kind/检查器,从未执行。
|
|
191
|
-
# 现在由 lib/checks/dup-code.js 消费:跨文件 AST 归一化哈希找「同一函数结构 ≥3 处」。
|
|
192
|
-
# 判定标准(评审确立,量化版):重复 ≥3 处 + 函数体 ≥5 行 即报;排除参数>5 /
|
|
193
|
-
# 布尔 flag 参数 / test 夹具 / 纯语法糖。severity 恒 warning(只提示不拦截)。
|
|
194
|
-
- id: maintainability/no-duplicate-code
|
|
195
|
-
name: "检测重复代码块(该抽公共函数)"
|
|
196
|
-
category: "maintainability"
|
|
197
|
-
severity: "warning"
|
|
198
|
-
description: "同一逻辑结构在多处重复(≥3 处 + ≥5 行),应抽取公共函数"
|
|
199
|
-
kind: "duplicate-code"
|
|
200
|
-
min_lines: 5
|
|
201
|
-
min_occurrences: 3
|
|
202
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
203
|
-
fixable: true
|
|
204
|
-
|
|
205
|
-
# 2026-10-02:同名常量跨文件重复定义(DRY——阈值/长度/窗口等魔数散落多处难维护)。
|
|
206
|
-
# 场景实测:MAX_MSG_PREVIEW=80 在 audit-api/tool-call/commit-push 三处各自定义,
|
|
207
|
-
# 改一处漏三处。规则跨文件聚合 `const NAME = <值>`(同名校同值 ≥2 文件)→ 提示统一单一来源。
|
|
208
|
-
- id: maintainability/duplicate-constant-def
|
|
209
|
-
name: "同名常量跨文件重复定义(应统一单一来源)"
|
|
210
|
-
category: "maintainability"
|
|
211
|
-
severity: "warning"
|
|
212
|
-
description: "同一命名常量(const NAME = 值)在多个文件重复定义——阈值/长度/窗口等魔数散落多处难维护、改一处漏多处;应统一到公共常量模块或配置文件单处定义(DRY)"
|
|
213
|
-
kind: "duplicate-const"
|
|
214
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "py", "java", "kt", "go", "rs", "swift", "php", "rb"]
|
|
215
|
-
fixable: false
|
|
216
|
-
mitigation: "把重复定义提到公共常量模块(如 lib/app/constants.js)导出,各文件 import 复用"
|
|
217
|
-
|
|
218
|
-
- id: maintainability/max-cyclomatic-complexity
|
|
219
|
-
name: "圈复杂度不超过 10(50 以上 blocker)"
|
|
220
|
-
category: "maintainability"
|
|
221
|
-
severity: "blocker"
|
|
222
|
-
description: "圈复杂度评级(2026-10-02 用户口径):1~10 良好、11~20 中等(warning)、21~50 高风险(warning,应拆分)、50+ 极难维护(blocker 拦提交)——分支点:if/else if 每分支、for/while/do-while、case 每分支、catch、&&/||/??、三元 ?、带标签 break/continue"
|
|
223
|
-
max_complexity: 10
|
|
224
|
-
block_complexity: 50
|
|
225
|
-
# 2026-09-23 作用域(P1):启动路径初始化函数豁免圈复杂度
|
|
226
|
-
scope_rules:
|
|
227
|
-
- scope: "startup"
|
|
228
|
-
action: "exempt"
|
|
229
|
-
reason: "启动路径初始化函数(一次性执行),阈值不适用"
|
|
230
|
-
fixable: false
|
|
231
|
-
|
|
232
|
-
# ----- 3. 健壮性 -----
|
|
233
|
-
# 2026-09-17:由 quality/sync-fs 升级为分级版 io-risk。
|
|
234
|
-
# 旧检查只判「异步函数内的同步 IO」;本检查是其超集,另覆盖:
|
|
235
|
-
# 循环内 I/O(逐次阻塞)、请求处理路径、启动路径,
|
|
236
|
-
# 并区分读/写/删/改名(写删类加权)。两者并存会对同一处重复报,故旧规则已移除。
|
|
237
|
-
# L1 正则初筛只负责「哪些文件可能含 fs 调用」,定级由 lib/ast/io-risk.js 完成。
|
|
238
|
-
# 展示口径(2026-09-18):high/medium → warning 且计分(2/1);low/safe → info 且不计分。
|
|
239
|
-
# 低风险是「启动路径上的一次性同步 I/O」这类提示,不影响并发、不随数据量放大;
|
|
240
|
-
# 按 warning 展示会把 161 条提示与真实高危(仅 12 条)混在一起,淹没重点。
|
|
241
|
-
# 规则级 severity 仍为 warning,具体降级由 lib/checks/regex.js 按 AST 定级覆盖。
|
|
242
|
-
- id: robustness/io-risk
|
|
243
|
-
name: "I/O 风险分级(同步阻塞 / 循环内 / 关键路径)"
|
|
244
|
-
category: "robustness"
|
|
245
|
-
severity: "warning"
|
|
246
|
-
description: "按上下文与操作类别对文件 I/O 分级:异步路径中的同步 I/O、循环内 I/O 为高风险;写/删/改名类加权一档"
|
|
247
|
-
# 维度归属:I/O 风险是性能与健壮性问题,**不是可读性**。
|
|
248
|
-
# 不声明会落到 regex 编译器的默认 [可读性](实测 190 条全记在可读性上,
|
|
249
|
-
# 把可读性维度从 10 拖到 2.7——而真正的性能/健壮性维度却显示满分,评分失真)。
|
|
250
|
-
dimensions: ["性能", "健壮性"]
|
|
251
|
-
# 2026-09-27:仅代码文件(md 文档的代码块示例是讲解文本,不是运行代码——
|
|
252
|
-
# README 版本表 / docs 方案文的 fs.readFileSync 示例曾被当真实代码报 io-risk 误报)
|
|
253
|
-
# 2026-10-05:exts 移除 py——io-risk 的 AST 检查器是 JS/Node fs 语法特定
|
|
254
|
-
# (scanIoRiskAst 只认 fs.xxx / require('node:fs')),Python 的 open/with 不识别;
|
|
255
|
-
# 声明 py 是误导(对 py 文件永不命中)。Python 文件 I/O 由语言规则集另行覆盖。
|
|
256
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
257
|
-
# 三段式:正则初筛(哪些文件可能含 fs 调用)→ AST 精筛(注释/字符串里的示例剔除)
|
|
258
|
-
# → 分级由 lib/ast/io-risk.js 完成,finding 由 lib/checks/io.js 产出
|
|
259
|
-
astConfirm: true
|
|
260
|
-
astConfirmKind: "io-risk"
|
|
261
|
-
patterns:
|
|
262
|
-
# ① 带 fs. 前缀:fs.readFileSync(...)、fsp.readFile(...)
|
|
263
|
-
- "(fs|fsp|fsPromises)\\.(promises\\.)?(readFile|writeFile|appendFile|stat|lstat|readdir|mkdir|rmdir|rm|unlink|rename|copyFile|chmod|open|close|read|write|truncate|realpath|createReadStream|createWriteStream)(Sync)?\\s*\\("
|
|
264
|
-
# ② 裸调用(具名导入后直调):import { mkdirSync } from 'node:fs' → mkdirSync(...)
|
|
265
|
-
# 这是最常见写法,此前 patterns 只覆盖带前缀形态,导致大量真实 I/O 漏初筛
|
|
266
|
-
- "(?<![\\w$.])(readFileSync|writeFileSync|appendFileSync|existsSync|statSync|lstatSync|readdirSync|mkdirSync|rmdirSync|rmSync|unlinkSync|renameSync|copyFileSync|chmodSync|openSync|closeSync|readSync|writeSync|truncateSync|realpathSync)\\s*\\("
|
|
267
|
-
# ③ fs 模块导入语句(兜底:文件级信号,具体行由 AST 精筛定位)
|
|
268
|
-
- "(require\\([\"']node:fs[\"']?\\)|from\\s+[\"']node:fs(/promises)?[\"'])"
|
|
269
|
-
fixable: true
|
|
270
|
-
mitigation: "🔴 高风险改用 fs.promises.xxx + await,循环内改为 Promise.all 并发;🟡 启动路径的一次性读取可豁免"
|
|
271
|
-
|
|
272
|
-
# 【已撤销】robustness/no-empty-catch —— 与内置 AST 检查器重复报同一批位置。
|
|
273
|
-
# 原规则:pattern "catch\s*\([^)]*\)\s*\{\s*\}",kind=regex,warning。
|
|
274
|
-
# 撤销理由(实测):在 archify(641 文件)上,本规则报 1902 条、内置 quality/empty-catch
|
|
275
|
-
# (lib/checks/structural.js 的 checkEmptyCatchAst,kind=empty-catch)报 1926 条,
|
|
276
|
-
# 两者 (file:line) 交集 1899 条 ⇒ 同一批空 catch 被两条规则各报一遍(合计占总量 24.6%)。
|
|
277
|
-
# 按架构(yml 只声明、判定落 lib/ast)保留**AST 版**:它能识别注释占位/换行/嵌套形态,
|
|
278
|
-
# 正则版只匹配「catch(...){ }」同行闭合,既漏报又重复计数。
|
|
279
|
-
# 如需恢复:把下面三行取消注释即可(保留原字段)。
|
|
280
|
-
# name: "禁止空的 catch 块" | severity: warning | description: "空的 catch 块会静默吞掉错误"
|
|
281
|
-
# pattern: "catch\\s*\\([^)]*\\)\\s*\\{\\s*\\}" | mitigation: "至少添加 console.error(e)"
|
|
282
|
-
|
|
283
|
-
- id: robustness/input-validation-required
|
|
284
|
-
name: "外部输入必须验证"
|
|
285
|
-
category: "robustness"
|
|
286
|
-
severity: "warning"
|
|
287
|
-
description: "用户输入可能包含恶意数据"
|
|
288
|
-
patterns:
|
|
289
|
-
- "req\\.(params|query|body)"
|
|
290
|
-
- "ctx\\.(params|query|body)"
|
|
291
|
-
fixable: false
|
|
292
|
-
|
|
293
|
-
- id: robustness/timeout-on-external-api
|
|
294
|
-
name: "外部 API 调用必须设置超时"
|
|
295
|
-
category: "robustness"
|
|
296
|
-
severity: "warning"
|
|
297
|
-
description: "外部请求无超时设置会导致请求永久挂起"
|
|
298
|
-
# 2026-10-02:限定 js 系代码文件——fetch/axios 是 Node/前端运行时 API,
|
|
299
|
-
# md/json 等文档/配置里的「外部请求」字样与代码示例不应被扫(Pawchive docs md 实测误报)
|
|
300
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx"]
|
|
301
|
-
# 负向后瞻排除自定义封装名(apiFetch/githubFetch 等)——"fetch(" 子串会把
|
|
302
|
-
# 封装调用误报成无超时裸 fetch;封装内部的超时由 file-context.js
|
|
303
|
-
# hasExternalCallTimeout 语义豁免(行内/行前/行后 12 行含 signal/timeout 即豁免)
|
|
304
|
-
patterns:
|
|
305
|
-
- "(?<![\\w$])(fetch|axios\\.|got\\.|request\\.)\\s*\\("
|
|
306
|
-
fixable: false
|
|
307
|
-
mitigation: "设置 timeout 或 AbortController"
|
|
308
|
-
|
|
309
|
-
# ----- 4. 安全性 -----
|
|
310
|
-
# 重复硬编码字符串(repeated-string 类型)——字符串字面量在同文件出现 ≥3 次且不在白名单 → 建议配置化
|
|
311
|
-
- id: security/no-repeated-hardcoded-literals
|
|
312
|
-
name: "检测重复出现的硬编码文本"
|
|
313
|
-
category: "security"
|
|
314
|
-
severity: "warning"
|
|
315
|
-
description: "如果一个字符串(路径、域名、用户名、token、端口、URL 等)在代码中重复出现 3 次或以上,建议提取为常量或配置变量"
|
|
316
|
-
fixable: true
|
|
317
|
-
min_occurrences: 3
|
|
318
|
-
ignore_patterns:
|
|
319
|
-
- "^\\d+$"
|
|
320
|
-
- "^(true|false|null|undefined)$"
|
|
321
|
-
- "^[{}[\\]]$"
|
|
322
|
-
- "^[+\\-*/=]$"
|
|
323
|
-
- "^['\"`]$"
|
|
324
|
-
- "^\\s*$"
|
|
325
|
-
- "^\\\\n$"
|
|
326
|
-
- "^\\d+\\.\\d+$"
|
|
327
|
-
- "^\\.(json|txt|log|md|yaml|yml|html|css|js|mjs|ts|png|jpg|jpeg|gif|svg)$"
|
|
328
|
-
- "^utf-?8$"
|
|
329
|
-
- "^utf-?16le?$"
|
|
330
|
-
ignore_values:
|
|
331
|
-
- "0"
|
|
332
|
-
- "1"
|
|
333
|
-
- "-1"
|
|
334
|
-
- "true"
|
|
335
|
-
- "false"
|
|
336
|
-
- "null"
|
|
337
|
-
- "undefined"
|
|
338
|
-
- "''"
|
|
339
|
-
- '""'
|
|
340
|
-
mitigation: "提取为常量(UPPER_SNAKE_CASE)放入 config/constant.js 或通过环境变量注入"
|
|
341
|
-
|
|
342
|
-
- id: security/no-hardcoded-credentials
|
|
343
|
-
name: "禁止硬编码凭据"
|
|
344
|
-
category: "security"
|
|
345
|
-
severity: "error"
|
|
346
|
-
description: "凭据不应硬编码在源代码中"
|
|
347
|
-
# astConfirmKind: credential-value → 正则初筛后由 token 级精筛(checkCredentialRefAst)确认,
|
|
348
|
-
# 只报「凭据标识符右侧直接是有效字符串字面量」的行。豁免:类型/存在性检查
|
|
349
|
-
# (typeof cfg.githubToken === 'string')、字段透传(cfg.token = init.token)、
|
|
350
|
-
# 取环境变量/配置(process.env.KEY / options.token)、占位符与空串。
|
|
351
|
-
# 2026-09-21 误报修复(start-preview.mjs 反代服务器场景):
|
|
352
|
-
# · 正则加 `(?<![?&/])` 负向断言——排除 `?token=` / `&token=` / `/token=` 这类
|
|
353
|
-
# **URL 参数名**(如 '/?token=' + encodeURIComponent(token)),URL 带凭据名是
|
|
354
|
-
# 泄露风险但**不是硬编码**,单列 security/no-credential-in-url(warning)覆盖;
|
|
355
|
-
# · 引号内内容收紧为 `[^'"\s]{8,}`——真实凭据较长,短占位/空串不参与初筛
|
|
356
|
-
# (AST 精筛仍按 isMeaningfulCredentialValue 判占位符,双层不矛盾)。
|
|
357
|
-
astConfirmKind: credential-value
|
|
358
|
-
# 初筛在 `=`/`:` 与引号之间允许 ≤2 字符的**字符串前缀**(Python b"…"/rb'…'、f"…"):
|
|
359
|
-
# 原写法 `=\s*['\"]` 在 `SECRET_KEY = b"…"` 上因夹着 b 直接断链,bytes 真凭据
|
|
360
|
-
# 连候选行都进不来(外部仓库实测漏报)。放宽只影响初筛覆盖面,是否真报仍由
|
|
361
|
-
# credential-value 精筛(树/ token)判语义与值形状决定,不会新增误报形态。
|
|
362
|
-
# 凭据词后允许词尾段(`(?![A-Za-z])\\w*`):`SECRET_KEY =` / `API_KEY_ID =` 这类
|
|
363
|
-
# 下划线复合标识符此前因「凭据词后不直接接等号」而漏出候选(外部仓库实测
|
|
364
|
-
# APP_UPDATE_TOKEN_SECRET = b"…" 整行不报);`(?![A-Za-z])` 保证 tokenizer /
|
|
365
|
-
# cookieMonster 这类「凭据词只是单词前缀」的情况仍不进候选。
|
|
366
|
-
patterns:
|
|
367
|
-
- "(?<![?&/])password(?![A-Za-z])\\w*\\s*[=:]+\\s*[a-zA-Z]{0,2}\\s*['\"][^'\"\\s]{8,}['\"]"
|
|
368
|
-
- "(?<![?&/])secret(?![A-Za-z])\\w*\\s*[=:]+\\s*[a-zA-Z]{0,2}\\s*['\"][^'\"\\s]{8,}['\"]"
|
|
369
|
-
- "(?<![?&/])api[_-]?key(?![A-Za-z])\\w*\\s*[=:]+\\s*[a-zA-Z]{0,2}\\s*['\"][^'\"\\s]{8,}['\"]"
|
|
370
|
-
- "(?<![?&/])token(?![A-Za-z])\\w*\\s*[=:]+\\s*[a-zA-Z]{0,2}\\s*['\"][^'\"\\s]{8,}['\"]"
|
|
371
|
-
- "(?<![?&/])cookie(?![A-Za-z])\\w*\\s*[=:]+\\s*[a-zA-Z]{0,2}\\s*['\"][^'\"\\s]{8,}['\"]"
|
|
372
|
-
# 2026-09-13 误报修复:正则把「凭据字段引用/API 名/字符串字面量」误判为「凭据值硬编码」。
|
|
373
|
-
# 白名单行豁免——命中以下任一模子的行不报:
|
|
374
|
-
# · GM_cookie(油猴 GM_cookie API 名,非硬编码值)
|
|
375
|
-
# · gbCookie / userAgent 等请求字段名(对象字段引用,非值)
|
|
376
|
-
# · .cookie(对象属性访问 o.cookie / c.cookie,非赋值)
|
|
377
|
-
# · "Cookie=" 字符串字面量(解析 cookie 头的分隔符,非值)
|
|
378
|
-
# 真凭据(cookie = "sess=..." 赋值)仍正常报出。
|
|
379
|
-
whitelist_patterns:
|
|
380
|
-
- "\\bGM_cookie\\b"
|
|
381
|
-
- "\\bgbCookie\\b"
|
|
382
|
-
- "\\bcookie\\s*[=:]+\\s*(?:[a-zA-Z_$][\\w$]*\\.)?[a-zA-Z_$][\\w$]*\\s*(?:[);,]|$)" # cookie: o.cookie 属性引用
|
|
383
|
-
- "\\.[a-zA-Z_$][\\w$]*\\.cookie\\b"
|
|
384
|
-
- "\\b[a-zA-Z_$][\\w$]*\\.cookie\\b"
|
|
385
|
-
- "\"Cookie=\""
|
|
386
|
-
- "['\"]Cookie=['\"]"
|
|
387
|
-
- "cookieChars|cookieItems|cookieCount"
|
|
388
|
-
- "mock 密码用变量承载"
|
|
389
|
-
- "完整 Cookie"
|
|
390
|
-
fixable: false
|
|
391
|
-
mitigation: "使用环境变量 process.env.XXX"
|
|
392
|
-
|
|
393
|
-
- id: security/no-credential-in-url
|
|
394
|
-
name: "URL 中不应携带凭据参数名"
|
|
395
|
-
category: "security"
|
|
396
|
-
severity: "warning"
|
|
397
|
-
description: "URL 参数/路径中含 token/secret/password 等敏感字段名——凭据可能被浏览器历史/代理日志/Referer 头泄露;非硬编码(硬编码凭据由 no-hardcoded-credentials 管),仅提示"
|
|
398
|
-
# 2026-09-21:从 no-hardcoded-credentials 拆出——`?token=` / `&key=` 这类 URL 参数名
|
|
399
|
-
# 此前被硬编码凭据正则误报(如 '/?token=' + encodeURIComponent(token),反代服务器认证路径);
|
|
400
|
-
# URL 带凭据名本身有泄露风险(日志/历史/Referer),但**不是硬编码**,单列 warning 提示,
|
|
401
|
-
# 与「右值是否为字符串字面量」的硬编码判据彻底分开(见 lib/ast/credential.js scanCredentialTokens)。
|
|
402
|
-
patterns:
|
|
403
|
-
- "[?&](?:token|key|secret|password|passwd|api[_-]?key|cookie|credential|access[_-]?key)=[^&\\s'\"]*"
|
|
404
|
-
fixable: false
|
|
405
|
-
mitigation: "改用 Authorization 头或 POST body 传递凭据,避免出现在 URL(防日志/历史/Referer 泄露)"
|
|
406
|
-
|
|
407
|
-
# security/no-path-traversal 已于 2026-10-11 **迁移到 lib/audit-rules/audit-rules-paths.yml**
|
|
408
|
-
# (路径类规则集中一处;规则 id 与语义未变,此处不再保留副本)。
|
|
409
|
-
# credref-legacy-path 同样迁移至该槽位(见下方原位置指针)。
|
|
410
|
-
|
|
411
|
-
# ----- 凭据入库门禁 -----
|
|
412
|
-
# 提交门禁安全底线:新增行命中即拦截提交;severity=error → blocker
|
|
413
|
-
- id: secret-github-pat
|
|
414
|
-
# 占位符精筛:剥掉 ghp_/sk-/AKIA 前缀后再判是否为演示/占位值
|
|
415
|
-
# (文档里写「测试用占位符 ghp_testtokenplaceholder123」、演示页假数据不应报泄漏)
|
|
416
|
-
astConfirmKind: "placeholder-credential"
|
|
417
|
-
name: "疑似 GitHub PAT 硬编码"
|
|
418
|
-
category: "security"
|
|
419
|
-
severity: "error"
|
|
420
|
-
description: "疑似 GitHub Personal Access Token 硬编码,请确认是否真实凭据"
|
|
421
|
-
pattern: "\\bghp_[A-Za-z0-9]{20,}\\b"
|
|
422
|
-
fixable: false
|
|
423
|
-
- id: secret-openai-key
|
|
424
|
-
# 占位符精筛:剥掉 ghp_/sk-/AKIA 前缀后再判是否为演示/占位值
|
|
425
|
-
# (文档里写「测试用占位符 ghp_testtokenplaceholder123」、演示页假数据不应报泄漏)
|
|
426
|
-
astConfirmKind: "placeholder-credential"
|
|
427
|
-
name: "疑似 API key 硬编码"
|
|
428
|
-
category: "security"
|
|
429
|
-
severity: "error"
|
|
430
|
-
description: "疑似 OpenAI/API key 硬编码,请确认是否真实凭据"
|
|
431
|
-
pattern: "\\bsk-(proj-)?[A-Za-z0-9-]{16,}\\b"
|
|
432
|
-
fixable: false
|
|
433
|
-
- id: secret-keyvalue
|
|
434
|
-
name: "疑似敏感信息键值对"
|
|
435
|
-
category: "security"
|
|
436
|
-
severity: "error"
|
|
437
|
-
description: "疑似敏感信息(键值对)硬编码,请确认(值捕获组供占位符/假值豁免)"
|
|
438
|
-
pattern: "\\b(api[_-]?key|api[_-]?secret|secret|password|passwd|client[_-]?secret|access[_-]?token|auth[_-]?token|private[_-]?key|bearer|cookie|session[_-]?key)\\b\\s*[:=]\\s*[\"']([^\"'\\s]{8,})[\"']"
|
|
439
|
-
fixable: false
|
|
440
|
-
mitigation: "使用环境变量 process.env.XXX"
|
|
441
|
-
- id: secret-email
|
|
442
|
-
name: "真实邮箱入库(隐私泄漏)"
|
|
443
|
-
category: "security"
|
|
444
|
-
severity: "error"
|
|
445
|
-
description: "疑似真实个人邮箱硬编码/入库(隐私信息),请确认——示例域(example.com)、GitHub 匿名邮箱(users.noreply.github.com)、SSH 地址(git@github.com / git@ssh.github.com)、GitHub token 前缀用户名(ghp_/gho_/ghu_/ghs_/ghr_/github_pat_ 开头的用户名 + github.com 域;token 本体由 secret-github-pat 规则拦截)、本地虚拟域(.local/.lan/.internal/.test)豁免;真实邮箱(如 QQ 号@qq.com 等)一旦进公开仓库可被爬取,招致营销骚扰/社工;确需提交(公开联系方式/测试夹具/版权声明等)时可临时关闭审计再推送(插件设置 →「提交前审计」auditEnabled=false)"
|
|
446
|
-
pattern: "\\b(?!git@(?:ssh\\.)?github\\.com\\b|(?:gh[opsur]_|github_pat_)[A-Za-z0-9_]+@github\\.com\\b)[A-Za-z0-9._%+-]+@(?!example\\.com\\b|users\\.noreply\\.github\\.com\\b|[A-Za-z0-9-]+\\.(?:local|lan|internal|test|invalid|localhost)\\b|[A-Za-z0-9-]+\\.(?:png|jpe?g|gif|webp|svg|avif|ico|bmp|js|mjs|cjs|ts|tsx|jsx|css|scss|less|html?|json|ya?ml|md|markdown|txt|zip|gz|tgz|mp[34]|webm|pdf|woff2?|ttf|eot)\\b)[A-Za-z0-9-]+\\.[A-Za-z]{2,}\\b"
|
|
447
|
-
fixable: false
|
|
448
|
-
mitigation: "真实邮箱不写进代码/文档;示例一律用 your-name@example.com 占位;GitHub 匿名邮箱 users.noreply.github.com 豁免(git 提交默认 author);已入库的用 git filter 清历史"
|
|
449
|
-
- id: credfile-common
|
|
450
|
-
name: "凭据/密钥文件入库"
|
|
451
|
-
category: "security"
|
|
452
|
-
severity: "error"
|
|
453
|
-
description: "凭据/密钥文件出现在变更中,禁止提交"
|
|
454
|
-
path_pattern: "(^|[\\\\/])(\\.credentials[^\\\\/]*|\\.env|\\.env\\.[a-z]+|github-token|data[\\\\/]sensitive[\\\\/][^\\\\/]*|\\.dsh[\\\\/]git-push[\\\\/])"
|
|
455
|
-
fixable: false
|
|
456
|
-
- id: credfile-token-private
|
|
457
|
-
name: "敏感目录入库"
|
|
458
|
-
category: "security"
|
|
459
|
-
severity: "error"
|
|
460
|
-
description: "敏感配置/私钥目录入库,禁止提交"
|
|
461
|
-
path_pattern: "(^|[\\\\/])(data[\\\\/]sensitive[\\\\/]|dsh-private-configs[\\\\/]|\\.ssh[\\\\/]|private)[\\\\/][^\\\\/]*"
|
|
462
|
-
fixable: false
|
|
463
|
-
# credref-legacy-path 已于 2026-10-11 **迁移到 lib/audit-rules/audit-rules-paths.yml**
|
|
464
|
-
# (路径类规则集中一处;规则 id 与语义未变,此处不再保留副本)。
|
|
465
|
-
- id: credref-plain-secret
|
|
466
|
-
name: "文档疑似凭据明文"
|
|
467
|
-
category: "security"
|
|
468
|
-
severity: "warning"
|
|
469
|
-
description: "文档疑似含凭据明文:凭据统一存插件配置目录,不在文档写明文"
|
|
470
|
-
# 2026-09-14 误报修复:pattern 只做「正则初筛」,命中后必须经 AST 精筛确认(astConfirmKind)。
|
|
471
|
-
# 旧写法只有 pattern、没有精筛,导致下列**非凭据明文**场景全被报出(实测 5/5 误报):
|
|
472
|
-
# - 类型/存在性检查:`typeof cfg.githubToken === 'string'`——旧 pattern 的 `[::=]`
|
|
473
|
-
# 会命中 `===` 的第 3 个 `=`,再把被比较的字符串字面量 `'string'` 当成明文凭据;
|
|
474
|
-
# 又因 safeRe 默认带 i 标志,`githubToken` 的大写 T 也照样命中。
|
|
475
|
-
# - 字段透传/引用:`cfg.githubToken = next.githubToken`(右侧是变量,不是字面量)
|
|
476
|
-
# - 类型注解:JSDoc `@returns {{token: string}}`、`{ token: string }`
|
|
477
|
-
# credential-value 精筛(lib/ast/credential.js 的 checkCredentialRefAst)在 token 级
|
|
478
|
-
# 只认「凭据语义标识符 + 严格 `=` 或对象字段 `:` + 右侧**字符串字面量** + 非占位符」,
|
|
479
|
-
# 上面三类天然落空;真明文(`password: "hunter2xyz"`)照报。
|
|
480
|
-
# 判据只有一份:同一函数也被 no-hardcoded-credentials 使用,不会出现两规则自相矛盾。
|
|
481
|
-
pattern: "(密码|password|passwd|token|cookie|账号)\\s*[::=]\\s*['\"]?[A-Za-z0-9_@.\\-]{6,}['\"]?"
|
|
482
|
-
astConfirm: true
|
|
483
|
-
astConfirmKind: "credential-value"
|
|
484
|
-
fixable: false
|
|
485
|
-
|
|
486
|
-
- id: security/cookie-secure-flag
|
|
487
|
-
name: "Cookie 必须包含 Secure 和 HttpOnly"
|
|
488
|
-
category: "security"
|
|
489
|
-
severity: "error"
|
|
490
|
-
description: "生产环境 Cookie 必须带 Secure 和 HttpOnly"
|
|
491
|
-
patterns:
|
|
492
|
-
- "Set-Cookie:(?!.*Secure)"
|
|
493
|
-
- "Set-Cookie:(?!.*HttpOnly)"
|
|
494
|
-
# 2026-09-13 误报修复:客户端/油猴脚本里 Set-Cookie: 出现在正则字面量
|
|
495
|
-
# (match(/Set-Cookie:.../) 读取响应头)或字符串样例,不是服务端写 cookie——
|
|
496
|
-
# 只有「实际设置 cookie 的调用」(setHeader('Set-Cookie' 等)才需要带 Secure/HttpOnly。
|
|
497
|
-
#
|
|
498
|
-
# 2026-09-18 两处修正(误报 + 漏报各一):
|
|
499
|
-
# ① 误报:Python/Go 等**读取响应头**的写法没被覆盖,实测
|
|
500
|
-
# `line.lower().startswith("set-cookie:")` 会报 blocker(真实误报,已在
|
|
501
|
-
# scripts/migrate-session/lib/follow.py 遇到)。补 startswith/in/headers.get。
|
|
502
|
-
# ② 漏报(更严重):原白名单 `['"]Set-Cookie['"]` 只认「字符串里出现 Set-Cookie」,
|
|
503
|
-
# 而**设置**与**读取**都用字符串,于是把真风险 `setHeader("Set-Cookie", ...)`
|
|
504
|
-
# 一并豁免了——与规则本意(只有设置 cookie 才要求 Secure/HttpOnly)正好相反。
|
|
505
|
-
# 改为只豁免「读取语境」:动词为 get/read/startswith/in/match/parse 等。
|
|
506
|
-
# 注意 JS 的 `.get("Set-Cookie")` 与 Node 的 `res.setHeader(...)` 靠动词区分。
|
|
507
|
-
whitelist_patterns:
|
|
508
|
-
# JS:正则字面量读取响应头
|
|
509
|
-
- "match\\s*\\(\\s*/Set-Cookie"
|
|
510
|
-
# 字符串里的转义形态(样例/日志文案)
|
|
511
|
-
- "Set-Cookie:\\\\s"
|
|
512
|
-
# 读取语境(跨语言):动词在前、Set-Cookie 在后。
|
|
513
|
-
# 注意:白名单**不带 i 标志**(lib/checks/regex.js 用 new RegExp(w) 编译),
|
|
514
|
-
# 而规则 pattern 走 safeRe **带 i**。因此这里用字符类 [Ss] 显式兼容两种大小写,
|
|
515
|
-
# 否则 `startswith("Set-Cookie:")` 会漏网(实测踩到)。
|
|
516
|
-
- "startswith\\s*\\(\\s*['\"][Ss]et-[Cc]ookie"
|
|
517
|
-
- "headers?\\s*\\.\\s*get\\s*\\(\\s*['\"][Ss]et-[Cc]ookie"
|
|
518
|
-
- "\\.\\s*get\\s*\\(\\s*['\"][Ss]et-[Cc]ookie"
|
|
519
|
-
- "getheader\\s*\\(\\s*['\"][Ss]et-[Cc]ookie"
|
|
520
|
-
- "\\.\\s*getall\\s*\\(\\s*['\"][Ss]et-[Cc]ookie"
|
|
521
|
-
# 集合成员判定 / 字典取值(读取响应头)
|
|
522
|
-
- "['\"][Ss]et-[Cc]ookie['\"]\\s+in\\s"
|
|
523
|
-
- "in\\s+\\w+\\.\\s*headers"
|
|
524
|
-
# 解析/日志文案语境(动词为 parse/split/console/log)
|
|
525
|
-
- "(?:parse|[Ss]plit|console|log|print|echo|debug)\\w*\\s*\\([^)]*['\"][Ss]et-[Cc]ookie"
|
|
526
|
-
fixable: true
|
|
527
|
-
|
|
528
|
-
- id: security/no-eval
|
|
529
|
-
name: "禁止使用 eval"
|
|
530
|
-
category: "security"
|
|
531
|
-
severity: "error"
|
|
532
|
-
description: "eval 执行任意代码,存在严重安全风险"
|
|
533
|
-
patterns:
|
|
534
|
-
- "(?<![\\w$.])eval\\s*\\("
|
|
535
|
-
- "new Function\\s*\\("
|
|
536
|
-
fixable: false
|
|
537
|
-
|
|
538
|
-
# ----- 5. 性能 -----
|
|
539
|
-
- id: performance/no-o-n-squared
|
|
540
|
-
name: "避免 O(n²) 循环嵌套"
|
|
541
|
-
category: "performance"
|
|
542
|
-
severity: "warning"
|
|
543
|
-
description: "嵌套循环可能导致性能问题"
|
|
544
|
-
# astConfirm: true → 正则初筛后由 token 级精筛剔除注释/字符串行。
|
|
545
|
-
# 正则只看字符:注释里写「两种形态:for (...) { ... for (」这类说明会被命中
|
|
546
|
-
# (实测 lib/ast/io-risk.js 的文档注释被报 O(n²)),精筛按 token 判定修正。
|
|
547
|
-
astConfirm: true
|
|
548
|
-
patterns:
|
|
549
|
-
- "for\\s*\\([^)]*\\)\\s*{[^}]*for\\s*\\("
|
|
550
|
-
fixable: false
|
|
551
|
-
|
|
552
|
-
- id: performance/no-json-full-save
|
|
553
|
-
name: "禁止频繁全量 JSON 写盘"
|
|
554
|
-
category: "performance"
|
|
555
|
-
severity: "info"
|
|
556
|
-
description: "大对象频繁 JSON.stringify 消耗 CPU 和磁盘 IO"
|
|
557
|
-
patterns:
|
|
558
|
-
- "JSON\\.stringify\\s*\\([^)]+\\)\\s*,\\s*['\"]?.*\\.json['\"]?"
|
|
559
|
-
fixable: false
|
|
560
|
-
mitigation: "使用增量写入或内存缓存"
|
|
561
|
-
|
|
562
|
-
- id: performance/config-cache-needed
|
|
563
|
-
name: "配置文件应使用内存缓存"
|
|
564
|
-
category: "performance"
|
|
565
|
-
severity: "info"
|
|
566
|
-
description: "频繁 readFileSync 读取 config 影响性能"
|
|
567
|
-
patterns:
|
|
568
|
-
- "readFileSync\\s*\\(\\s*['\"].*config.*\\.json['\"]"
|
|
569
|
-
fixable: false
|
|
570
|
-
mitigation: "添加 TTL 缓存,如 5 秒刷新"
|
|
571
|
-
|
|
572
|
-
# ----- 6. 测试 -----
|
|
573
|
-
- id: testing/test-file-exists
|
|
574
|
-
name: "核心文件应有对应测试"
|
|
575
|
-
category: "testing"
|
|
576
|
-
severity: "warning"
|
|
577
|
-
description: "关键模块应有 .test.js 文件"
|
|
578
|
-
fixable: false
|
|
579
|
-
|
|
580
|
-
# ----- 7. 依赖 -----
|
|
581
|
-
- id: dependency/known-vulnerability
|
|
582
|
-
name: "无已知漏洞依赖"
|
|
583
|
-
category: "dependency"
|
|
584
|
-
severity: "error"
|
|
585
|
-
description: "npm audit 不应有 critical/high 漏洞"
|
|
586
|
-
fixable: false
|
|
587
|
-
|
|
588
|
-
# ----- 严重级别映射 -----
|
|
589
|
-
|
|
590
|
-
# ── v2 独有能力(1.0.3 合并自原 v2 示范槽位,防旧包覆盖丢失)──
|
|
591
|
-
- id: secret-aws-access-key
|
|
592
|
-
# 占位符精筛:剥掉 ghp_/sk-/AKIA 前缀后再判是否为演示/占位值
|
|
593
|
-
# (文档里写「测试用占位符 ghp_testtokenplaceholder123」、演示页假数据不应报泄漏)
|
|
594
|
-
astConfirmKind: "placeholder-credential"
|
|
595
|
-
name: "AWS Access Key 疑似泄露"
|
|
596
|
-
category: "security"
|
|
597
|
-
severity: "error"
|
|
598
|
-
description: "检测 AWS 访问密钥格式(AKIA 开头 16-20 位)"
|
|
599
|
-
pattern: "AKIA[0-9A-Z]{16}"
|
|
600
|
-
|
|
601
|
-
- id: secret-generic-token
|
|
602
|
-
name: "通用令牌疑似泄露"
|
|
603
|
-
category: "security"
|
|
604
|
-
severity: "error"
|
|
605
|
-
description: "检测常见 token 赋值的硬编码"
|
|
606
|
-
# astConfirmKind: credential-value → 正则初筛后由 token 级精筛确认,只报
|
|
607
|
-
# 「凭据标识符右侧直接是有效字符串字面量」的行。与 security/no-hardcoded-credentials
|
|
608
|
-
# 同用一套判据(lib/ast/credential.js),避免两规则宽严不一。
|
|
609
|
-
# 正则只看字符:注释里举例的 `TOKEN="$(read_token)"`、规则描述文本都会被命中,
|
|
610
|
-
# 精筛按 token 判定并豁免运行时求值形态($(cmd)/${VAR}/$VAR),误报在此修正。
|
|
611
|
-
astConfirmKind: credential-value
|
|
612
|
-
patterns:
|
|
613
|
-
- "\\btoken\\s*=\\s*['\"][^'\"]{12,}['\"]"
|
|
614
|
-
- "\\bapi[_-]?key\\s*=\\s*['\"][^'\"]{12,}['\"]"
|
|
615
|
-
|
|
616
|
-
# ── 三层审计 L2:数据流检查(2026-09-14)──
|
|
617
|
-
# L1 由 filterRulesByFileText 消费 file_patterns:文件文本含「清空/重置动作」或
|
|
618
|
-
# 「访问动作」才进 L2 AST 精查;两者都没有的文件连 tokenize 都不跑(成本极低)。
|
|
619
|
-
- id: dataflow/clear-then-access
|
|
620
|
-
kind: "dataflow"
|
|
621
|
-
name: "清空后访问(同函数数据流)"
|
|
622
|
-
category: "robustness"
|
|
623
|
-
severity: "warning"
|
|
624
|
-
description: "同一函数内对象先被清空(clear()/reset()/splice(0)/=[]/=null/length=0)后被访问(.get()/[下标]/.length)——可能读到已清空对象(undefined/空值)"
|
|
625
|
-
# L1 文件级初筛:命中任一即候选文件(纯正则,非 token 级,成本极低)
|
|
626
|
-
file_patterns:
|
|
627
|
-
- "\\b(?:clear|reset|flush|purge|splice)\\(0?\\s*\\)"
|
|
628
|
-
- "\\b\\w+\\s*=\\s*(?:\\[\\]|null|undefined)"
|
|
629
|
-
- "\\b\\w+\\.length\\s*=\\s*0"
|
|
630
|
-
- "\\b(?:get|at|first|last|peek|head)\\(0?"
|
|
631
|
-
severity_map:
|
|
632
|
-
error: "error"
|
|
633
|
-
warning: "warning"
|
|
634
|
-
info: "info"
|
|
635
|
-
|
|
636
|
-
# ----- 阈值 -----
|
|
637
|
-
thresholds:
|
|
638
|
-
max_warnings: 20
|
|
639
|
-
max_errors: 0
|
|
640
|
-
max_info: 50
|
|
641
|
-
|
|
642
|
-
# ----- 忽略规则 -----
|
|
643
|
-
ignore:
|
|
644
|
-
- pattern: "**/*.{test,spec}.{js,ts}"
|
|
645
|
-
rules: ["*"]
|
|
646
|
-
# 第三方内置代码(vendor)——构建产物、非本项目编写,不参与风格/规模类审计。
|
|
647
|
-
# js/mjs/cjs 全覆盖:此前只写 *.js,导致内置的 js-yaml.mjs 被
|
|
648
|
-
# readability/max-function-length 报 3 个 blocker(1370 行的 parser 函数)。
|
|
649
|
-
- pattern: "**/vendor/**/*.{js,mjs,cjs}"
|
|
650
|
-
rules: ["*"]
|
|
651
|
-
- pattern: "**/vendor/**"
|
|
652
|
-
rules: ["*"]
|
|
653
|
-
- pattern: "**/dist/**/*.js"
|
|
654
|
-
rules: ["*"]
|
|
655
|
-
- pattern: "**/legacy/**/*.js"
|
|
656
|
-
rules: ["readability/*", "maintainability/*"]
|
|
657
|
-
|
|
658
|
-
# ----- 输出 -----
|
|
659
|
-
output:
|
|
660
|
-
format: "json"
|
|
661
|
-
include_suggestions: true
|
|
662
|
-
include_fix_instructions: true
|