yeswehack/ywh2bugtracker
GitHub: yeswehack/ywh2bugtracker
一款将YesWeHack漏洞众测平台的报告与企业内部缺陷跟踪系统(Jira/GitHub/GitLab/ServiceNow)进行双向同步的自动化工具。
Stars: 22 | Forks: 7
# ywh2bt
ywh2bt 将您的漏洞报告从 [Yes We Hack 平台][YesWeHack-Platform] 与您的 bug tracker(缺陷跟踪器)中的 issue(问题)进行同步。它会自动检索您想要复制到 bug tracker 中的报告,创建相关的 issue,并在 issue 和报告之间同步后续更新。
它附带了一个便捷的 GUI 来设置和测试集成,同时完全控制您允许从双方同步的信息。

## 目录
- [用户指南](#user-guide)
- [架构](#architecture)
- [系统要求](#requirements)
- [安装](#installation)
- [支持的跟踪器](#supported-trackers)
- [更新日志](#changelog)
- [本地开发](#local-development)
- [系统要求](#requirements-1)
- [安装](#installation-1)
- [用法](#usage-1)
- [更新用户指南](#updating-user-guide)
## 用户指南
用户指南提供 [PDF][User-Guide-pdf] 和 [HTML][User-Guide-html] 格式。
## 架构
YWH2BT 嵌入了用于设置集成的 GUI,以及需要在您的服务器上调度以定期轮询和同步新报告的应用程序。
您可以选择在一台机器上同时运行两者,或者在一台计算机上(使用 GUI)准备配置文件,然后将其传输到服务器并通过计划命令使用它。
由于数据是从 YWH 平台拉取到您的服务器,因此您的服务器上只需要授权常规的出站 Web 连接。
## 系统要求
- `python` >=3.8,<=3.13
- [`pip`](https://pip.pypa.io/en/stable/installing/)
## 支持的跟踪器
- github
- gitlab
- jira / jiracloud
- servicenow
## 更新日志
- v2.15:
- 自动管理 program slugs
- 链接到同一 program 的报告
- 显示 KEY trackers 的警告消息
- 修复 Gitlab 版本解析错误
- v2.14:
- 修复 git.clacos.ninja 上跟踪 issue 中报告和评论图片显示不正确的问题
- v2.13:
- 修复 GET YesWeHack API 调用方法带有 body 的问题
- v2.12:
- 添加对新的 triage workflow 的支持
- v2.11:
- 添加对新的 impact 和 cve 字段的支持
- v2.10:
- 添加对新的 ask for fix 流程的支持
- 添加对报告传输日志的支持
- v2.9:
- 防止因 tracker 文件上传失败导致 issue 同步失败
- v2.8:
- 改进 Python 版本支持(>=3.8 到 <=3.12)
- 从默认安装中移除 GUI(使用 `pip install 'ywh2bt[gui]'` 以包含 GUI)
- 修复当 issue 标题超过 255 个字符时 github 的问题
- 修复当多个附加图片具有相同名称时 jira 图片预览的问题
- 修复当报告/评论没有附件且描述包含无效 URL 时的问题
- v2.7:
- 添加当选中“Upload status updates”时“fix verification”日志的同步
- 修复当 scope 包含特殊 markdown 字符时 jira 的问题
- 修复当激活“Download bug trackers comments”反馈选项且 bug tracker 附件不符合平台附件要求(不可接受的 mime-type,超过最大允许大小)时的问题
- 修复当 issue 标题超过 255 个字符时 jira 的问题
- v2.6:
- 添加针对 bug trackers 允许的 issue/comment 文本最大大小的变通方法(必要时将内容放入 Markdown 文件附件中)
- v2.5:
- 添加 Personal Access Token (PAT) 认证
- 移除 OAuth 认证
- v2.4:
- 添加选项以防止重新创建由先前同步创建但不再在 bug tracker 中找到的 issue
- v2.3:
- 添加对 ServiceNow 的支持
- v2.2:
- 添加 GitLab confidential issues 选项
- v2.1:
- 添加反馈功能(从 bug tracker 同步到报告)
- 添加 [docker image yeswehack/ywh2bugtracker](https://hub.docker.com/r/yeswehack/ywh2bugtracker)
- 添加用户指南 [PDF][User-Guide-pdf] 和 [HTML][User-Guide-html]
- v0.* 到 v2.0.0:
- 行为变更:
- 报告日志可以选择性地与 trackers 同步:
- 公开评论
- 私有评论
- 报告详情更改
- 报告状态更改
- 奖励
- 一个 program 现在只能与 1 个 tracker 同步
- 添加对 JSON 配置文件的支持
- 移除 `ywh-bugtracker` 命令(使用 `ywh2bt synchronize`)
- 添加 `ywh2bt` 命令:
- 添加 `ywh2bt synchronize`:
- 注意:`ywh2bt synchronize --config-file FILE --config-format FORMAT` 等同于 v0.* 中的 `ywh-bugtracker -n -f FILE`
- 添加 `ywh2bt validate`
- 添加 `ywh2bt test`
- 添加 `ywh2bt convert`
- 添加 `ywh2bt schema`
- 移除命令行交互模式
- 通过 `ywh2bt-gui` 命令添加 GUI
## 本地开发
### 系统要求
- [`poetry`](https://python-poetry.org/)(`pip install poetry`)
### 安装
- `make install`(或 `poetry install`):创建一个 virtualenv 并安装依赖项
- `make install-with-gui`(或 `poetry install --extras=gui`):创建一个 virtualenv 并安装依赖项,包括 gui
### 用法
代替 `ywh2bt [command]`,使用 `poetry run ywh2bt [command]` 运行命令。
`ywh2bt-gui` 同理,改为运行 `poetry run ywh2bt-gui`。
### 更新用户指南
用户指南的 [PDF][User-Guide-pdf] 和 [HTML][User-Guide-html] 版本通过 Pandoc 生成,使用 [docs/User-Guide.md][User-Guide-md] 作为输入文件。
对 [docs/User-Guide.md][User-Guide-md] 所做的任何更改**必须随后**执行命令 `make user-guide` 以重新生成 PDF 和 HTML 文件,**否则 CI 将失败**。
标签:API集成, BugBounty, DevSecOps, GitHub集成, GitLab集成, GPT, GUI工具, Jira集成, Python, ServiceNow, YesWeHack, 上游代理, 可观测性, 报告同步, 持续监控, 无后门, 服务器轮询, 漏洞报告, 漏洞管理, 缺陷跟踪, 自动化同步, 请求拦截, 跨平台集成, 逆向工具