Skip to main content

Faraday plugins package

Project description

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/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faraday_plugins-1.24.1.tar.gz (186.9 kB view details)

Uploaded Source

Built Distribution

faraday_plugins-1.24.1-py3-none-any.whl (295.2 kB view details)

Uploaded Python 3

File details

Details for the file faraday_plugins-1.24.1.tar.gz.

File metadata

  • Download URL: faraday_plugins-1.24.1.tar.gz
  • Upload date:
  • Size: 186.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for faraday_plugins-1.24.1.tar.gz
Algorithm Hash digest
SHA256 fde64c55c71b3cc4e3b05d00d8b2e7675d7aa914955bcee7c35f3876d01452fe
MD5 3088dd5eb6df769ffc1a626ebd8d4aa4
BLAKE2b-256 55c88571f58b1cf858d73d73170080f02bf5190a2a2c9bbeaa1edd5f11f6f4f4

See more details on using hashes here.

File details

Details for the file faraday_plugins-1.24.1-py3-none-any.whl.

File metadata

File hashes

Hashes for faraday_plugins-1.24.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3aadf6e50875b1a0e7f42229b08fce3292440d006a8cbbd8351d5352d26384c
MD5 a182e673bf92152fbae2530aa77617de
BLAKE2b-256 5dd25b8ed4f5c1196e1888bb6cf15872a921286fbe79372f707e610e1847a138

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page