xray 项目使用教程
xray 一款完善的安全评估工具,支持常见 web 安全问题扫描和自定义 poc | 使用之前务必先阅读文档 项目地址: https://gitcode.com/gh_mirrors/xra/xray
1. 项目目录结构及介绍
xray 项目的目录结构如下:
xray/
├── docs/
├── fingerprints/
├── pocs/
├── reports/
├── tests/
├── webhook/
├── .gitattributes
├── .gitignore
├── DISCLAIMER.md
├── LICENSE.md
├── README.md
├── README_EN.md
目录介绍:
- docs/:存放项目的文档文件,包括使用手册、API 文档等。
- fingerprints/:存放用于指纹识别的脚本和配置文件。
- pocs/:存放自定义的 PoC(Proof of Concept)脚本,用于漏洞扫描。
- reports/:存放生成的漏洞扫描报告。
- tests/:存放项目的测试脚本和测试数据。
- webhook/:存放与 Webhook 相关的配置和脚本。
- .gitattributes:Git 属性配置文件。
- .gitignore:Git 忽略文件配置。
- DISCLAIMER.md:免责声明文件。
- LICENSE.md:项目许可证文件。
- README.md:项目的主 README 文件,包含项目的基本介绍和使用说明。
- README_EN.md:英文版本的 README 文件。
2. 项目启动文件介绍
xray 项目的启动文件主要是通过命令行工具来执行的。以下是一些常用的启动命令示例:
使用基础爬虫进行漏洞扫描
xray webscan --basic-crawler http://example.com --html-output vuln.html
使用 HTTP 代理进行被动扫描
xray webscan --listen 127.0.0.1:7777 --html-output proxy.html
只扫描单个 URL
xray webscan --url http://example.com/?a=b --html-output single-url.html
手动指定本次运行的插件
xray webscan --plugins cmd-injection,sqldet --url http://example.com
3. 项目配置文件介绍
xray 项目的配置文件主要包括以下几个部分:
3.1 配置文件路径
xray 的配置文件通常位于项目的根目录下,文件名为 config.yaml
。
3.2 配置文件内容
配置文件的内容示例如下:
# 基础配置
base:
log_level: info
output_dir: ./reports
# 扫描配置
scan:
target: http://example.com
plugins:
- cmd-injection
- sqldet
# 代理配置
proxy:
listen: 127.0.0.1:7777
3.3 配置项说明
-
base: 基础配置项,包括日志级别和输出目录。
log_level
: 日志级别,可选值为debug
,info
,warn
,error
。output_dir
: 扫描结果输出目录。
-
scan: 扫描配置项,包括目标 URL 和启用的插件。
target
: 扫描的目标 URL。plugins
: 启用的插件列表。
-
proxy: 代理配置项,包括代理监听地址和端口。
listen
: 代理监听地址和端口。
通过以上配置文件,可以灵活地调整 xray 的扫描行为和输出结果。
以上是 xray 项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助!
xray 一款完善的安全评估工具,支持常见 web 安全问题扫描和自定义 poc | 使用之前务必先阅读文档 项目地址: https://gitcode.com/gh_mirrors/xra/xray