@pwddd/skills-scanner 1.0.0-beta.21 → 1.0.0-beta.22

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 CHANGED
@@ -1,213 +1,4 @@
1
- # Skills Scanner Plugin
2
-
3
- OpenClaw Skills 安全扫描插件,用于检测 Skills 中的潜在安全威胁。
4
-
5
- ## 功能特性
6
-
7
- - 🔍 **手动扫描**: 支持扫描指定路径的 Skill
8
- - 🛡️ **安装前拦截**: 使用 before_install hook 在安装前强制拦截不安全的 Skills
9
- - 🌐 **ClawHub 扫描**: 直接扫描 ClawHub 上的 Skill,无需手动下载
10
- - 🛡️ **多种策略**: 支持 strict/balanced/permissive 三种扫描策略
11
- - 🤖 **LLM 分析**: 可选的 LLM 语义分析
12
- - 🔒 **自动隔离**: 检测到不安全的 Skill 自动隔离或删除
13
-
14
- ## 安装
15
-
16
- ```bash
17
- # 从本地安装(开发)
18
- openclaw plugins install ./skills-scanner
19
-
20
- # 从 npm 安装(发布后)
21
- openclaw plugins install @pwddd/skills-scanner
22
- ```
23
-
24
- ## 配置
25
-
26
- 在 `~/.openclaw/openclaw.json` 或工作区配置中添加:
27
-
28
- ```json
29
- {
30
- "plugins": {
31
- "entries": {
32
- "skills-scanner": {
33
- "enabled": true,
34
- "config": {
35
- "apiUrl": "https://110.vemic.com/skills-scanner",
36
- "behavioral": false,
37
- "useLLM": false,
38
- "policy": "balanced",
39
- "onUnsafe": "warn",
40
- "enableBeforeInstallHook": true
41
- }
42
- }
43
- }
44
- }
45
- }
46
- ```
47
-
48
- ### 配置说明
49
-
50
- - `apiUrl`: 扫描 API 服务地址
51
- - `behavioral`: 是否启用行为分析(深度扫描,较慢)
52
- - `useLLM`: 是否使用 LLM 进行语义分析
53
- - `policy`: 扫描策略
54
- - `strict`: 严格模式,发现任何可疑行为都标记为不安全
55
- - `balanced`: 平衡模式(推荐)
56
- - `permissive`: 宽松模式,只标记明确的威胁
57
- - `onUnsafe`: 发现不安全 Skill 的处理方式
58
- - `warn`: 仅警告,不处理(推荐)
59
- - `quarantine`: 移入隔离目录
60
- - `delete`: 直接删除
61
- - `enableBeforeInstallHook`: 是否启用 before_install hook(安装前拦截)
62
- - `true`: 启用(强烈推荐)
63
- - `false`: 禁用
64
- - `scanTimeoutMs`: 扫描超时时间(毫秒),默认 180000 (3分钟)
65
- - `reportDir`: 自定义报告目录
66
- - `quarantineDir`: 自定义隔离目录
67
-
68
- ### 高级功能
69
-
70
- #### 配置热重载
71
-
72
- 插件支持配置热重载,修改配置后无需重启 Gateway:
73
-
74
- ```bash
75
- # 修改配置文件
76
- vim ~/.openclaw/config.json
77
-
78
- # 重载配置
79
- openclaw config reload
80
- ```
81
-
82
- 配置变更会自动:
83
- - 更新 API URL
84
- - 应用新的扫描策略
85
-
86
- #### 调试模式
87
-
88
- 启用调试模式可以查看详细的运行日志:
89
-
90
- ```bash
91
- # 启用调试模式
92
- export SKILLS_SCANNER_DEBUG=1
93
- openclaw gateway start
94
-
95
- # 或者一次性启用
96
- SKILLS_SCANNER_DEBUG=1 openclaw gateway start
97
- ```
98
-
99
- 调试模式会输出:
100
- - 完整的配置信息
101
- - 详细的扫描过程
102
- - API 请求和响应
103
-
104
- #### 健康检查端点
105
-
106
- 插件提供 HTTP 健康检查端点:
107
-
108
- ```bash
109
- # 通过 HTTP 访问
110
- curl http://localhost:3000/health/skills-scanner
111
-
112
- # 返回示例
113
- {
114
- "status": "healthy",
115
- "plugin": {
116
- "version": "1.0.0",
117
- "id": "skills-scanner",
118
- "name": "Skills Scanner"
119
- },
120
- "api": {
121
- "url": "https://110.vemic.com/skills-scanner",
122
- "status": "available"
123
- },
124
- "metrics": {
125
- "totalScans": 42,
126
- "successRate": "95.24%",
127
- "averageDurationMs": 1234
128
- }
129
- }
130
- ```
131
-
132
- ## 使用方法
133
-
134
- ### 聊天命令
135
-
136
- ```
137
- /skills-scanner scan <路径> [选项] # 扫描 Skill
138
- /skills-scanner scan clawhub <URL> [选项] # 扫描 ClawHub Skill
139
- /skills-scanner health # 健康检查
140
- /skills-scanner config [操作] # 配置管理
141
- /skills-scanner help # 帮助信息
142
- ```
143
-
144
- #### 扫描选项
145
-
146
- - `--detailed`: 显示详细的安全发现
147
- - `--behavioral`: 启用行为分析
148
- - `--recursive`: 递归扫描子目录
149
-
150
- #### 示例
151
-
152
- ```
153
- /skills-scanner scan ~/.openclaw/skills/my-skill
154
- /skills-scanner scan ~/.openclaw/skills --recursive
155
- /skills-scanner scan clawhub https://clawhub.ai/username/project
156
- /skills-scanner scan clawhub https://clawhub.ai/Asleep123/caldav-calendar --detailed
157
- /skills-scanner health
158
- ```
159
-
160
- ### CLI 命令
161
-
162
- ```bash
163
- # 扫描单个 Skill
164
- openclaw skills-scanner scan <path> [--detailed] [--behavioral]
165
-
166
- # 扫描 ClawHub Skill
167
- openclaw skills-scanner clawhub <url> [--detailed] [--behavioral]
168
-
169
- # 批量扫描目录
170
- openclaw skills-scanner batch <directory> [--recursive] [--detailed]
171
-
172
- # 检查 API 服务健康状态
173
- openclaw skills-scanner health
174
- ```
175
-
176
- ## 工作流程
177
-
178
- 1. **插件启动**: 自动初始化并连接 API 服务
179
- 2. **手动扫描**: 使用命令扫描指定的 Skill 或目录
180
- 3. **结果处理**: 根据配置隔离/删除/警告不安全的 Skill
181
-
182
- ## 故障排除
183
-
184
- ### API 服务连接失败
185
-
186
- 1. 确保 API 服务地址配置正确
187
- 2. 运行健康检查:`/skills-scanner health`
188
- 3. 检查网络连接
189
-
190
- ## 开发
191
-
192
- ### 目录结构
193
-
194
- ```
195
- extensions/skills-scanner/
196
- ├── package.json # npm 包配置
197
- ├── openclaw.plugin.json # 插件元数据
198
- ├── README.md # 文档
199
- ├── index.ts # 插件入口
200
- ├── src/ # 源代码
201
- │ ├── api-client.ts # HTTP API 客户端
202
- │ ├── config.ts # 配置管理
203
- │ ├── scanner.ts # 扫描逻辑
204
- │ ├── commands.ts # 命令处理
205
- │ └── types.ts # 类型定义
206
- └── skills/
207
- └── skills-scanner/
208
- └── SKILL.md # Skill 文档
209
- ```
210
-
211
- ## 许可证
212
-
213
- MIT
1
+ # deprecated
2
+
3
+ # 废弃
4
+ 该插件已被弃用,建议使用其他插件替代
@@ -2,7 +2,7 @@
2
2
  "id": "skills-scanner",
3
3
  "name": "Skills Scanner",
4
4
  "description": "Security scanner for OpenClaw Skills to detect potential threats",
5
- "version": "1.0.0-beta.21",
5
+ "version": "1.0.0-beta.22",
6
6
  "author": "pwddd",
7
7
  "skills": ["./skills"],
8
8
  "uiHints": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pwddd/skills-scanner",
3
- "version": "1.0.0-beta.21",
3
+ "version": "1.0.0-beta.22",
4
4
  "description": "OpenClaw Skills security scanner plugin - detect malicious code, data exfiltration, and prompt injection",
5
5
  "type": "module",
6
6
  "main": "./index.ts",
@@ -16,13 +16,13 @@
16
16
  ],
17
17
  "repository": {
18
18
  "type": "git",
19
- "url": "https://github.com/openclaw/openclaw.git",
19
+ "url": "https://github.com/pwddd/test.git",
20
20
  "directory": "extensions/skills-scanner"
21
21
  },
22
22
  "bugs": {
23
- "url": "https://github.com/openclaw/openclaw/issues"
23
+ "url": "https://github.com/pwddd/test/issues"
24
24
  },
25
- "homepage": "https://github.com/openclaw/openclaw/tree/main/extensions/skills-scanner#readme",
25
+ "homepage": "https://github.com/pwddd/test/tree/main/extensions/skills-scanner#readme",
26
26
  "files": [
27
27
  "index.ts",
28
28
  "openclaw.plugin.json",