aleff-github/vuln-report-kit
GitHub: aleff-github/vuln-report-kit
一款本地优先的 Obsidian 插件,为漏洞研究人员提供从案例创建、笔记记录、模板报告生成到机密扫描与脱敏导出的完整工作流。
Stars: 0 | Forks: 0
# Vuln Report Kit
**Vuln Report Kit** 是一款本地优先的 Obsidian 插件,用于漏洞研究笔记、披露报告、机密审查、脱敏处理、模板、仪表板、时间线和便携导出。
版本:**1.0.1**
## 它是什么
Vuln Report Kit 可将 Obsidian 仓库转化为用于漏洞研究文档的结构化工作区。它专为负责任的披露笔记、漏洞赏金报告、CVE 研究笔记、公开文章草稿和脱敏报告准备而设计。
该插件特意设计得非常简单:它处理您仓库内的 Markdown 文件,不需要任何服务器、账户、云数据库、API 密钥、外部 AI 服务或许可证服务器。
## 核心工作流
1. 创建漏洞案例。
2. 记录目标、复现步骤、影响、证据、修复建议和时间线。
3. 使用本地仪表板跟踪案例。
4. 使用入门或专业模板。
5. 生成最终的 Markdown 报告。
6. 在本地扫描可能的机密信息。
7. 创建脱敏的公开副本。
8. 导出归档包、可共享文件夹、索引和模板备份。
## 主要命令
```
Vuln Report Kit: Create vulnerability case
Vuln Report Kit: Open quick start guide
Vuln Report Kit: Create demo vulnerability case
Vuln Report Kit: Run local health check
Vuln Report Kit: Open vulnerability dashboard
Vuln Report Kit: Update current case status
Vuln Report Kit: Open templates folder
Vuln Report Kit: Install starter template pack
Vuln Report Kit: Import template pack from vault folder
Vuln Report Kit: Create note from template
Vuln Report Kit: Insert template into current note
Vuln Report Kit: Insert report section
Vuln Report Kit: Generate final Markdown report for current case
Vuln Report Kit: Scan current case for secrets
Vuln Report Kit: Create sanitized public copy
Vuln Report Kit: Open exports folder
Vuln Report Kit: Export current case bundle
Vuln Report Kit: Create shareable case archive
Vuln Report Kit: Export all cases index
Vuln Report Kit: Backup templates
```
## 生成的案例结构
新案例会在配置的根文件夹下创建,默认为:
```
Vulnerability Research/
└── 2026-07-02-example-vulnerability/
├── 00-overview.md
├── 01-target.md
├── 02-reproduction.md
├── 03-impact.md
├── 04-evidence.md
├── 05-remediation.md
├── 06-timeline.md
├── 08-article-draft.md
└── attachments/
```
生成的输出包括:
```
99-final-report.md
99-public-report.md
secret-scan-report.md
```
## 模板包
该插件包含一个入门模板包,并支持将本地模板包导入至:
```
Vulnerability Research/_templates/
```
支持的模板变量包括:
```
{{title}}
{{target}}
{{vendor}}
{{category}}
{{severity}}
{{status}}
{{cwe}}
{{cvss}}
{{disclosure}}
{{created}}
{{last_updated}}
{{today}}
{{case_folder}}
```
## 机密扫描器和脱敏工具
扫描器是基于正则表达式的本地工具。它可以标记出可能的:
```
private keys
Authorization headers
Bearer tokens
JWTs
AWS keys
GitHub tokens
Google API keys
Slack tokens
Stripe secret keys
generic API keys / client secrets / access tokens
cookies
session IDs
password-like assignments
emails
private IPs
localhost URLs
basic-auth URLs
```
脱敏工具会创建一个公开副本,并使用占位符,例如:
```
```
## 纯本地设计
该插件不需要:
- 服务器;
- 账户;
- 登录;
- 云数据库;
- API 密钥;
- 外部 AI 服务;
- 许可证服务器。
所有内容都作为本地文件存储在 Obsidian 仓库内。
## 重要安全提示
机密扫描和脱敏只是辅助功能,不能保证报告发布出去是安全的。在发送或发布公开报告和可共享归档包之前,请务必手动检查。
## 推荐的首次测试
使用一个干净的测试仓库并运行:
```
Vuln Report Kit: Create demo vulnerability case
Vuln Report Kit: Open vulnerability dashboard
Vuln Report Kit: Generate final Markdown report for current case
Vuln Report Kit: Scan current case for secrets
Vuln Report Kit: Create sanitized public copy
Vuln Report Kit: Export all cases index
```
标签:Obsidian插件, 情报收集, 本地工具, 漏洞披露, 漏洞研究, 笔记管理, 自定义脚本, 防御加固