XSS Hunter 使用教程

XSS Hunter 使用教程

xsshunter 项目地址: https://gitcode.com/gh_mirrors/xssh/xsshunter

1. 项目目录结构及介绍

XSS Hunter 是一个用于测试和发现盲点跨站脚本（XSS）漏洞的工具。以下是项目的目录结构及其简要介绍：

xsshunter/
├── .github/             # GitHub 工作流和配置文件
├── db/                  # 数据库相关文件
├── front-end/           # 前端代码目录
├── images/              # 存储截图的目录
├── payload-fire-images/ # 存储payload触发截图的目录
├── templates/           # 模板文件目录
├── .gitignore           # Git 忽略文件
├── CODEOWNERS           # 代码所有者文件
├── Dockerfile           # Docker构建文件
├── LICENSE              # 项目许可证文件
├── Makefile             # Makefile文件
├── README.md            # 项目自述文件
├── api.js               # API接口文件
├── app.js               # 主应用文件
├── constants.js         # 常量定义文件
├── database.js          # 数据库连接文件
├── docker-compose.yml   # Docker组合文件
├── docker-entrypoint.sh # Docker启动脚本
├── notification.js      # 通知服务文件
├── notification.test.js # 通知服务测试文件
├── package-lock.json    # 包锁定文件
├── package.json         # 项目包文件
├── probe.js             # 探针脚本文件
├── server.js            # 服务器启动文件
├── utils.js             # 工具库文件

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置和启动服务。以下是主要的启动步骤：

• 首先，确保已经安装了 docker 和 docker-compose。
• 使用 docker-compose up -d postgresdb 命令来在后台启动 PostgreSQL 数据库服务。
• 接着，使用 docker-compose up xsshunterexpress 命令来启动 XSS Hunter 服务。

启动后，你会在屏幕上看到管理员密码，使用这个密码可以登录到 Web 控制面板。

3. 项目的配置文件介绍

项目的配置主要通过修改 docker-compose.yml 文件进行。以下是一些需要配置的字段：

• HOSTNAME: 设置用于访问 Web 控制面板和接收 payloads 的主机名。
• SSL_CONTACT_EMAIL: 为了自动设置和续订 TLS/SSL 证书，需要提供一个电子邮件地址。
• EMAIL_NOTIFICATIONS_ENABLED: 如果想接收电子邮件通知，请保持启用状态。
• SENDGRID_API_KEY 和 SENDGRID_UNSUBSRIBE_GROUP_ID: 如果使用 SendGrid 发送电子邮件通知，需要提供 API 密钥和退订组 ID。
• CONTROL_PANEL_ENABLED: 如果想要最小化攻击面，可以禁用 Web 控制面板。

完成配置后，可以使用上述命令启动服务。

xsshunter 项目地址: https://gitcode.com/gh_mirrors/xssh/xsshunter