Install
pip install faraday-plugins
Commands
List Plugins
List all plugins and if its compatible with command or/and report
Optional params:
- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that path
faraday-plugins list-plugins
Test autodetect plugin from command
faraday-plugins detect-command "ping -c 4 www.google.com"
Faraday Plugin: ping
Test process command with plugin
Optional params:
- --plugin_id PLUGIN_ID: Dont detect the plugin, use this one
- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that path
- -dr / --dont-run: Dont run, just show the generated command
- -o / --output-file PATH: send json outout to file instead of stdout
- -sh / --show-output: show the output of the 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"
}
}
Test autodetect plugin from report
faraday-plugins detect-report /path/to/report.xml
Faraday Plugin: Nmap
Test report with plugin
Optional params:
- --plugin_id PLUGIN_ID: Dont detect the plugin, use this one
- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that 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"
}
}
Plugin Logger
To use it you must call 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]
...
More documentation here https://docs.faradaysec.com/Basic-plugin-development/
1 maintainer
Metadata
1 maintainer
Release files for faraday-plugins 1.31.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| faraday_plugins-1.31.0.tar.gz | 214.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| faraday_plugins-1.31.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 525.2 kB
Release files / faraday_plugins-1.31.0.tar.gz
| Download URL | faraday_plugins-1.31.0.tar.gz |
|---|---|
| Size | 214.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
14c429b3538b35ad8e08d3e4cb3a8a880758a3beafc7faa2794926d3df14f232
|
|
BLAKE2b-256 checksum How to use checksums |
64084e25f13b942207960009b5b09de73ccc46a1e329724aeed2e96ad8ef3905
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
Release files / faraday_plugins-1.31.0-py3-none-any.whl
| Download URL | faraday_plugins-1.31.0-py3-none-any.whl |
|---|---|
| Size | 310.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bec13c10f2c652ab15202f05ce2a756a0ab5cfef60603d9fbffeb1f4afaa1cde
|
|
BLAKE2b-256 checksum How to use checksums |
b44d163b7b1e6bbe638230cc0c0b3b7d7e1a932104a173c7624514829939cef5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
