infobyte/faraday_plugins
GitHub: infobyte/faraday_plugins
为 FaradaySec 安全平台提供多种安全工具报告的解析插件，将异构扫描结果统一转换为标准化的结构化数据。
Stars: 61 | Forks: 22
## 安装
```
pip install faraday-plugins
```
## 命令
### 列出插件
列出所有插件，以及它们是否与 command 或/和 report 兼容
可选参数：
- -cpf / --custom-plugins-folder PATH：如果提供，也会在该路径下查找自定义插件
```
faraday-plugins list-plugins
```
### 测试从 command 自动检测插件
```
faraday-plugins detect-command "ping -c 4 www.google.com"
Faraday Plugin: ping
```
### 测试使用插件处理 command
可选参数：
- --plugin_id PLUGIN_ID：不自动检测插件，使用此插件
- -cpf / --custom-plugins-folder PATH：如果提供，也会在该路径下查找自定义插件
- -dr / --dont-run：不运行，仅显示生成的 command
- -o / --output-file PATH：将 json 输出发送到文件而不是 stdout
- -sh / --show-output：显示 command 的输出
```
faraday-plugins process-command "ping -c4 www.google.com"
{
"hosts": [
{
"ip": "216.58.202.36",
"os": "unknown",
"hostnames": [
"www.google.com"
],
"description": "",
"mac": null,
"credentials": [],
"services": [],
"vulnerabilities": [],
"tags": []
}
],
"command": {
"tool": "ping",
"command": "ping",
"params": "-c4 www.google.com",
"user": "user",
"hostname": "",
"start_date": "2020-06-19T17:02:37.982293",
"duration": 39309,
"import_source": "shell"
}
}
```
### 测试从 report 自动检测插件
```
faraday-plugins detect-report /path/to/report.xml
Faraday Plugin: Nmap
```
### 测试使用插件处理 report
可选参数：
- --plugin_id PLUGIN_ID：不自动检测插件，使用此插件
- -cpf / --custom-plugins-folder PATH：如果提供，也会在该路径下查找自定义插件
```
faraday-plugins process-report /path/to/nmap_report.xml
{
"hosts": [
{
"ip": "192.168.66.1",
"os": "unknown",
"hostnames": [],
"description": "",
"mac": "00:00:00:00:00:00",
"credentials": [],
"services": [
{
"name": "domain",
"protocol": "tcp",
"port": 53,
"status": "open",
"version": "",
"description": "domain",
"credentials": [],
"vulnerabilities": [],
"tags": []
},
{
"name": "netbios-ssn",
"protocol": "tcp",
"port": 139,
"status": "open",
"version": "",
"description": "netbios-ssn",
"credentials": [],
"vulnerabilities": [],
"tags": []
}
],
"vulnerabilities": [],
"tags": []
}
],
"command": {
"tool": "Nmap",
"command": "Nmap",
"params": "/path/to/nmap_report.xml",
"user": "user",
"hostname": "",
"start_date": "2020-06-19T17:22:11.608134",
"duration": 1233,
"import_source": "report"
}
}
```
## 插件 Logger
要使用它，你必须调用 `self.logger.debug("some message")`
```
export PLUGIN_DEBUG=1
faraday-plugins proces-report /path/to/report.xml
2019-11-15 20:37:03,355 - faraday.faraday_plugins.plugins.manager - INFO [manager.py:113 - _load_plugins()] Loading Native Plugins...
2019-11-15 20:37:03,465 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [acunetix]
2019-11-15 20:37:03,495 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [amap]
2019-11-15 20:37:03,549 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [appscan]
2019-11-15 20:37:03,580 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [arachni]
2019-11-15 20:37:03,613 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [arp_scan]
2019-11-15 20:37:03,684 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [beef]
2019-11-15 20:37:03,714 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [brutexss]
2019-11-15 20:37:03,917 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [burp]
2019-11-15 20:37:03,940 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()] Load Plugin [dig]
...
```
更多文档请访问 https://docs.faradaysec.com/Basic-plugin-development/
标签：Faraday, GPT, Homebrew安装, Python, 报告解析, 文档结构分析, 无后门, 漏洞管理, 逆向工具