Faraday Agents Dispatcher helps user develop integrations with
[Faraday][faraday] written in any language. <!-- For more information, check [this
blogpost][blogpost] or continue reading. -->
[faraday]: https://github.com/infobyte/faraday/
[plugins]: https://github.com/infobyte/faraday_plugins
[blogpost]: https://medium.com/faraday
# Installation
Just run `pip3 install faraday_agent_dispatcher` and you should see the
`faraday-dispatcher` command in your system.
To setup a development environment (this is, to change code of the dispatcher
itself, not to write your own integrations), you should clone this repo and run
`pip install -e .`.
# Running Faraday Agent Dispatcher for first time
1. Generate a configuration file running `faraday-dispatcher
config-wizard`.
2. Run the agent with `faraday-dispatcher run` command. The config file
that it creates will be located in `~/.faraday/config/dispatcher.ini`
if you do not pass a custom path.
You should complete the agent configuration with your registration
token, located at http://localhost:5985/#/admin/agents. Check that the
server section has the correct information about your Faraday
Server instance. Then, complete the agent section with the desired name
of your agent. Finally, [add the executors](#configuring-a-executor)
# Executors
## Creating your own executors
An executor is a script that prints out **single-line** JSON data to
stdout. Remember that if you print any other data to stdout, the
dispatcher will trigger an error. If you want to print debugging or
logging information you should use stderr for that.
Every line written to stdout by the executor will be decoded by the
dispatcher and sent to Faraday using the Bulk Create endpoint.
Therefore, the JSON you print must have the schema that the endpoint
requires (this schema is detailed [below](#bulk-create-json-format)).
Otherwise, the dispatcher will complain because you supplied invalid
data to it.
If you want to debug your executor, the simplest way to do it is by
running it directly instead of running with the Dispatcher. Since the executor
just prints JSON data to stdout, you will be able to see all
information it wants to send to Faraday, but without actually sending
it.
## Configuring a executor
After writing your executor, you have to add it with the
`faraday-dispatcher config-wizard` within the executor section, adding
its name, command to execute and the max size of the JSON to send to
Faraday Server. Additionally, you can configure the Environment
variables and Arguments in their proper section.
## Running a executor
To run an executor use the `faraday-dispatcher config-wizard` command,
and play it from the Faraday Server. The executor will use the
environment variables set and ask for the arguments.
# Bulk Create JSON format
The data published to [faraday][faraday] must correspond to the
`bulk_create` endpoint of the [Faraday's REST API][API]
# Running multiple dispatchers
If you want to have more than one dispatcher, each one runninng its own
executors, the preferred of doing this is to create different
configuration files for each one (for example,
`~/.faraday/config/dispatcher-1.ini` and
`~/.faraday/config/dispatcher-2.ini`). Then, you can run two different
Dispatcher instances with `faraday-dispatcher --config-file
PATH_TO_A_CONFIG_FILE`.
# Executors
Inside the [executors][executors] directory you can find the already
created executors.
## Official
The [official executors][official_executors] are the collection of ready-to-go
executors (with minimum configuration with the wizard). They have a manifest
JSON file, which gives details about the uses of the executor and helps with
the configuration of them.
The current official executors are:
* [Arachni][arachni]
* [Burp][burp]
* [CrackMapExec][crackmap]
* [Nessus][nessus]
* [Nikto][nikto]
* [Nmap][nmap]
* [Nuclei][nuclei]
* [Openvas][openvas]
* Report processor: Consumes a local report where the dispatcher is with the [faraday plugins][plugins]
* [QualysGuard] [qualys]
* [Sonar Qube API][sonarqubeapi]
* [Sublist3r][sublist3r]
* [W3af][w3af]
* [Wpscan][wpscan]
* [Zap][zap]
## Development
The [development executors][dev_executors] are the collection of executors we
do **not** fully maintain, we have examples of use, conceptual, and in
development executors. The most important of them are:
* `basic_example.py`: The Hello World of Faraday executors. It will
create a host with an associeted vulnerability to it
* `heroku_discovery_agent.py`: Load host and service information from
your Heroku account
* `prowlerSample.py`: Run the [**prowler**][prowler] command and send
its output to Faraday
* `brainfuck.sh`: A proof-of-concept to demonstrate you can create
an executor in any programming language, including [Brainfuck][brainfuck]!
[executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors
[official_executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors/official
[dev_executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors/dev
[brainfuck]: https://en.wikipedia.org/wiki/Brainfuck
[prowler]: https://github.com/toniblyx/prowler
[nessus]: https://www.nessus.org
[nikto]: https://cirt.net/Nikto2
[nmap]: https://nmap.org
[nuclei]: https://github.com/projectdiscovery/nuclei
[qualys]: https://www.qualys.com/
[sonarqubeapi]: https://www.sonarqube.org/
[sublist3r]: https://github.com/aboul3la/Sublist3r
[w3af]: http://w3af.org/
[wpscan]: https://wpscan.org/
[arachni]: https://www.arachni-scanner.com/
[openvas]: https://www.openvas.org/
[zap]: https://www.zaproxy.org/
[burp]: https://www.portswigger.net/burp
[crackmap]: https://github.com/byt3bl33d3r/CrackMapExec
# Roadmap
We are currently working on new executors, apart from improving the
experience using the agents.
We would like to give some agents read access to their workspace,
so they can benefit of the existing data in order to find more valuable
information.
# Documentation
For more info you can check our [documentation][doc]
[doc]: https://docs.agents.faradaysec.com
[API]: https://api.faradaysec.com/
3.3.0 [Mar 12th, 2024]:
---
* [ADD] Add hotspots option to SonarQube. #197
* [ADD] New GitHub CodeQL agent. #208
* [ADD] Added new agent for GitHub Secrets Scanning. #209
* [MOD] Now Nessus executor tries to login again after a 401 response from the Nessus's server. #203
* [MOD] Change Dependabot agent to work with the new manifest of parameter types. #210
* [FIX] We were not verifying the configuration value `ignore_ssl` at the moment of `socketio` connection. #212
3.2.0 [Feb 8th, 2024]:
---
* [ADD] Add dependabot agent. #206
3.0.1 [Dec 22th, 2023]:
---
* [FIX] Fix on_diconnect method and limit python-socketio to 5.8.0 #199
3.0.0 [Dec 13th, 2023]:
---
* [MOD] Now faraday-dispatcher works with socketio. #195
2.6.3 [Aug 24th, 2023]:
---
* [FIX] Check the code response for burp executor #194
2.6.2 [Aug 3rd, 2023]:
---
* [MOD] Now you can download a existing report in tenableio #192
2.6.1 [July 20th, 2023]:
---
* [FIX] Now nuclei executor use -j flag instead of -json. #187
2.6.0 [July 7th, 2023]:
---
* [ADD] Add HCL Appscan executer #186
2.5.1 [Jan 3rd, 2023]:
---
* [DEL] Now nuclei doesn't check if the target is an ip
* [MOD] Add a fixes for bandit vuln:
- Replace assert return code with a if
- Remove default x_token in nessus executor
2.5.0 [Nov 30th, 2022]:
---
* [ADD] Add new Sonar Qube executor
* [ADD] Add tenableio executor
* [FIX] Make gvm executor compatible with new version of python-gvm
* [FIX] Now if a venv is int or float it will convert to string
2.4.0 [Oct 26th. 2022]:
---
* Add Qualys executor
* [MOD] Change pgrep for psutil in zap executor
2.3.0 [Sep 5th, 2022]:
---
* Now InsighVM's executer will executa a scan if a site_id is provided
* Add tags for plugins
* Add installation in docker file for nmap script: vulners
* Now the api-key from zap is a enviroment variable
* [FIX] Change AGENT_CONFIG_HOSTNAME_RESOLUTION por AGENT_CONFIG_RESOLVE_HOSTNAME
* Update docs
2.2.0 [Jul 25th, 2022]:
---
* Add timeout parameter to arachni's executor
* Add python2.7, w3af and its dependencies to docker image
* Add ignore_info and hostname_resolution options for most executors.
* Nessus now list in the logs the available templates and uses posixpath.join instead of concat strings.
Nikto now uses only requieres TARGET_URL argument.
* Fix logs and change .format to fstrings
* Remove ws from dispatcher.yaml.
* Now faraday-dispatcher send the parameters of the executors when it
connects to faraday server. Also it checks if there are new enviroment
variables defined in the manifest file and warn the user.
2.1.3 [Dec 13th, 2021]:
---
* Add --api-token --random-user-agent to wpscan
* Move shodan executor to official and change logic to work with plugins
2.1.2 [Oct 19th, 2021]:
---
* ADD script to nmap logic
2.1.1 [Aug 18th, 2021]:
---
* ADD option via configuration YAML file to ignore ssl errors
* MOD Wizard connection ports defaults vary if SSL value has changed in the previous configuration
* [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2
2.1.0 [Aug 9th, 2021]:
---
* ADD Reminder message to run --token command after wizard
* FIX `start_date` and `end_date` to be sent as UTC
* FIX Receiving API error when faraday license is expired
* ADD Executor for insightvm
* REMOVE Host and api from burp executor parameters
* [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2
2.0.0 [Jun 29th, 2021]:
---
* ADD Executor parameter typing
* ADD versioning for manifests from typing package
* FIX typo in wizard
* [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2
1.5.1 [May 6th, 2021]:
---
* FIX Burp executor parse the IP
* [Faraday][faraday] versions: 3.14.3, 3.15.0, 3.15.1
1.5.0 [Mar 30th, 2021]:
---
* ADD having at least a executor is mandatory, if not it will not save the configuration
* UPD executor pagination, now each executor have a "unique" id
* MOD Update all reference to [faraday][faraday] to [API v3][api]
* MOD Connectivity endpoint is now `/_api/v3/info`
* MOD Now registration token is needed within the run command. Only needed the first time
* MOD setting host in the wizard now accepts full urls, such as `https://my.server.com:12345`
* ADD new plugin to support newer OpenVas/gvm versions (gvm_openvas). The old openvas executor was renamed to
"openvas_legacy"
* [Faraday][faraday] versions: 3.14.3, 3.15.0, 3.15.1
1.4.2 [Feb 26th, 2021]:
---
* MOD Update faraday-plugins version, improving nessus plugin process
* [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2
1.4.1 [Feb 17th, 2021]:
---
* MOD Various UX improves in wizard:
* ADD special character control in name executor
* ADD More verbose info
* It is possible to exit wizard if its misconfigurated (will not be saved)
* FIX Not choosing executor (Using Q) generates correct config file
* MOD max data sent to server option is a manual edit configuration
* MOD more extensive default list of official executors
* MOD change color for options "next page" "don't choose"
* ADD new WPScan executor that does not need docker anymore
* FIX in nuclei_exclude parameter for nuclei executor
* [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2
1.4.0 [Dec 23rd, 2020]:
---
* A base_route can be added before the root of the server (e.g:
https://my.company.com/faraday/ as / of faraday)
* Add duration to bulk_create to be set correctly
* The new official executors are:
* [nuclei](https://github.com/projectdiscovery/nuclei)
* reports: local report consumed by faraday-plugins
* Add new flags for nmap executor: `-sC`,`-sV`,`-Pn`,`--script-timeout`,`--host-timeout`,`--top-ports`
* Fix bug nmap and nessus executors to execute with the dispatcher environment
* Fix nmap executor when http(s) scheme passed as target
* [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2
1.3.1 [Sep 7th, 2020]:
---
* Add proxy setup by HTTP_PROXY or HTTPS_PROXY environment variables
* Fix default report name with the nessus executor
* [Faraday][faraday] versions: 3.12.0
1.3.0 [Sep 3rd, 2020]:
---
* An Agent can post data to multiples workspaces
* The `run` command tries to migrate the configuration to the latest version from
others as the `config-wizard` does
* Improve agent signal management and server disconnection, affecting the exit code
* The wizard page size can be customized (See:
`faraday-dispatcher config-wizard --help` )
* The new official executors are:
* burp
* crackmapexec
* Arachni executor generates reports in /tmp now
* Nmap executor updates use of nmap plugin (byte-string to string response)
* [Faraday][faraday] versions: 3.12.0
1.2.1 [Jun 22nd, 2020]:
---
* Now the dispatcher runs the check commands before running an executor
* Fix error when connects with faraday fails when trying to access with SSL to not SSL server
* Fix error when connects with faraday fails when server does not respond
* Fix error when connects with faraday fails when SSL verification fails
* Fix error attempting to create an executor with a comma in the name
* Now the wizard ask if you want use the default SSL behavior
* Started the process of [documentation][doc]
* The new official executors are:
* arachni
* openvas
* zap
* Nmap executor now acepted multi target
* Fix W3af executor now uses python2
* Escape user-controlled executor parameters in order to prevent OS argument injection (not command injection)
* [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2
1.2 [May 27th, 2020]:
---
* Now we have official executors, packaged with the dispatcher
* Fix error when killed by signal
* Fix error when server close connection
* Fix error when ssl certificate does not exists
* Fix error when folder `~/.faraday` does not exists, creating it
* The new official executors are:
* nessus
* nikto
* nmap
* sublist3r
* wpscan
* w3af
* [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2
1.1 [Apr 22th, 2020]:
---
* The dispatcher now runs with a `faraday-dispatcher run` command
* `faraday-dispatcher wizard` command added which generates configuration .ini file
* Manage execution_id within WS and API communication
* The route of [Faraday][faraday] ws comunication change from / to /websockets
* Better error management, now shows error and exceptions depending on log levels
* Better management of invalid token errors
* Add ssl support
* [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2
1.0 [Dec 17th, 2019]:
---
* You can add fixed parameters than shouldn't came by the web (e.g. passwords) are set in the dispatcher.ini
* Now its possible to manage multiple executors within one agent
* Now is possible to receive params from the [Faraday][faraday] server
* [Faraday][faraday] versions: 3.10, 3.10.1, 3.10.2
0.1 [Oct 31th, 2019]:
---
* First beta version published
* Basic structure implemented, with executor with fixed values
* [Faraday][faraday] versions: 3.9.2, 3.9.3
[faraday]: https://github.com/infobyte/faraday
[doc]: https://docs.agents.faradaysec.com
[api]: https://api.faradaysec.com
Raw data
{
"_id": null,
"home_page": "https://github.com/infobyte/faraday_agent_dispatcher",
"name": "faraday-agent-dispatcher",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "faraday integration",
"author": "Faraday Development Team",
"author_email": "devel@infobytesec.com",
"download_url": "https://files.pythonhosted.org/packages/1c/a2/a3eed443304f36442e0e87daaeb22e79c81024befee9588466b120a53f86/faraday_agent_dispatcher-3.3.0.tar.gz",
"platform": null,
"description": "Faraday Agents Dispatcher helps user develop integrations with\n[Faraday][faraday] written in any language. <!-- For more information, check [this\nblogpost][blogpost] or continue reading. -->\n\n[faraday]: https://github.com/infobyte/faraday/\n[plugins]: https://github.com/infobyte/faraday_plugins\n[blogpost]: https://medium.com/faraday\n\n# Installation\n\nJust run `pip3 install faraday_agent_dispatcher` and you should see the\n`faraday-dispatcher` command in your system.\n\nTo setup a development environment (this is, to change code of the dispatcher\nitself, not to write your own integrations), you should clone this repo and run\n`pip install -e .`.\n\n# Running Faraday Agent Dispatcher for first time\n\n1. Generate a configuration file running `faraday-dispatcher\nconfig-wizard`.\n\n2. Run the agent with `faraday-dispatcher run` command. The config file\nthat it creates will be located in `~/.faraday/config/dispatcher.ini`\nif you do not pass a custom path.\n\nYou should complete the agent configuration with your registration\ntoken, located at http://localhost:5985/#/admin/agents. Check that the\nserver section has the correct information about your Faraday\nServer instance. Then, complete the agent section with the desired name\nof your agent. Finally, [add the executors](#configuring-a-executor)\n\n# Executors\n\n## Creating your own executors\n\nAn executor is a script that prints out **single-line** JSON data to\nstdout. Remember that if you print any other data to stdout, the\ndispatcher will trigger an error. If you want to print debugging or\nlogging information you should use stderr for that.\n\nEvery line written to stdout by the executor will be decoded by the\ndispatcher and sent to Faraday using the Bulk Create endpoint.\nTherefore, the JSON you print must have the schema that the endpoint\nrequires (this schema is detailed [below](#bulk-create-json-format)).\nOtherwise, the dispatcher will complain because you supplied invalid\ndata to it.\n\nIf you want to debug your executor, the simplest way to do it is by\nrunning it directly instead of running with the Dispatcher. Since the executor\njust prints JSON data to stdout, you will be able to see all\ninformation it wants to send to Faraday, but without actually sending\nit.\n\n## Configuring a executor\n\nAfter writing your executor, you have to add it with the\n`faraday-dispatcher config-wizard` within the executor section, adding\nits name, command to execute and the max size of the JSON to send to\nFaraday Server. Additionally, you can configure the Environment\nvariables and Arguments in their proper section.\n\n## Running a executor\n\nTo run an executor use the `faraday-dispatcher config-wizard` command,\nand play it from the Faraday Server. The executor will use the\nenvironment variables set and ask for the arguments.\n\n# Bulk Create JSON format\n\nThe data published to [faraday][faraday] must correspond to the\n`bulk_create` endpoint of the [Faraday's REST API][API]\n\n# Running multiple dispatchers\n\nIf you want to have more than one dispatcher, each one runninng its own\nexecutors, the preferred of doing this is to create different\nconfiguration files for each one (for example,\n`~/.faraday/config/dispatcher-1.ini` and\n`~/.faraday/config/dispatcher-2.ini`). Then, you can run two different\nDispatcher instances with `faraday-dispatcher --config-file\nPATH_TO_A_CONFIG_FILE`.\n\n# Executors\n\nInside the [executors][executors] directory you can find the already\ncreated executors.\n\n## Official\n\nThe [official executors][official_executors] are the collection of ready-to-go\nexecutors (with minimum configuration with the wizard). They have a manifest\nJSON file, which gives details about the uses of the executor and helps with\nthe configuration of them.\n\nThe current official executors are:\n\n* [Arachni][arachni]\n* [Burp][burp]\n* [CrackMapExec][crackmap]\n* [Nessus][nessus]\n* [Nikto][nikto]\n* [Nmap][nmap]\n* [Nuclei][nuclei]\n* [Openvas][openvas]\n* Report processor: Consumes a local report where the dispatcher is with the [faraday plugins][plugins]\n* [QualysGuard] [qualys]\n* [Sonar Qube API][sonarqubeapi]\n* [Sublist3r][sublist3r]\n* [W3af][w3af]\n* [Wpscan][wpscan]\n* [Zap][zap]\n\n## Development\n\nThe [development executors][dev_executors] are the collection of executors we\ndo **not** fully maintain, we have examples of use, conceptual, and in\ndevelopment executors. The most important of them are:\n\n* `basic_example.py`: The Hello World of Faraday executors. It will\n create a host with an associeted vulnerability to it\n* `heroku_discovery_agent.py`: Load host and service information from\n your Heroku account\n* `prowlerSample.py`: Run the [**prowler**][prowler] command and send\n its output to Faraday\n* `brainfuck.sh`: A proof-of-concept to demonstrate you can create\n an executor in any programming language, including [Brainfuck][brainfuck]!\n\n[executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors\n[official_executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors/official\n[dev_executors]: https://github.com/infobyte/faraday_agent_dispatcher/tree/master/faraday_agent_dispatcher/static/executors/dev\n[brainfuck]: https://en.wikipedia.org/wiki/Brainfuck\n[prowler]: https://github.com/toniblyx/prowler\n[nessus]: https://www.nessus.org\n[nikto]: https://cirt.net/Nikto2\n[nmap]: https://nmap.org\n[nuclei]: https://github.com/projectdiscovery/nuclei\n[qualys]: https://www.qualys.com/\n[sonarqubeapi]: https://www.sonarqube.org/\n[sublist3r]: https://github.com/aboul3la/Sublist3r\n[w3af]: http://w3af.org/\n[wpscan]: https://wpscan.org/\n[arachni]: https://www.arachni-scanner.com/\n[openvas]: https://www.openvas.org/\n[zap]: https://www.zaproxy.org/\n[burp]: https://www.portswigger.net/burp\n[crackmap]: https://github.com/byt3bl33d3r/CrackMapExec\n\n# Roadmap\n\nWe are currently working on new executors, apart from improving the\nexperience using the agents.\n\nWe would like to give some agents read access to their workspace,\nso they can benefit of the existing data in order to find more valuable\ninformation.\n\n# Documentation\n\nFor more info you can check our [documentation][doc]\n\n[doc]: https://docs.agents.faradaysec.com\n[API]: https://api.faradaysec.com/\n\n\n3.3.0 [Mar 12th, 2024]:\n---\n * [ADD] Add hotspots option to SonarQube. #197\n * [ADD] New GitHub CodeQL agent. #208\n * [ADD] Added new agent for GitHub Secrets Scanning. #209\n * [MOD] Now Nessus executor tries to login again after a 401 response from the Nessus's server. #203\n * [MOD] Change Dependabot agent to work with the new manifest of parameter types. #210\n * [FIX] We were not verifying the configuration value `ignore_ssl` at the moment of `socketio` connection. #212\n\n3.2.0 [Feb 8th, 2024]:\n---\n * [ADD] Add dependabot agent. #206\n\n3.0.1 [Dec 22th, 2023]:\n---\n * [FIX] Fix on_diconnect method and limit python-socketio to 5.8.0 #199\n\n3.0.0 [Dec 13th, 2023]:\n---\n * [MOD] Now faraday-dispatcher works with socketio. #195\n\n2.6.3 [Aug 24th, 2023]:\n---\n * [FIX] Check the code response for burp executor #194\n\n2.6.2 [Aug 3rd, 2023]:\n---\n * [MOD] Now you can download a existing report in tenableio #192\n\n2.6.1 [July 20th, 2023]:\n---\n * [FIX] Now nuclei executor use -j flag instead of -json. #187\n\n2.6.0 [July 7th, 2023]:\n---\n * [ADD] Add HCL Appscan executer #186\n\n2.5.1 [Jan 3rd, 2023]:\n---\n * [DEL] Now nuclei doesn't check if the target is an ip\n * [MOD] Add a fixes for bandit vuln:\n - Replace assert return code with a if\n - Remove default x_token in nessus executor\n\n2.5.0 [Nov 30th, 2022]:\n---\n * [ADD] Add new Sonar Qube executor\n * [ADD] Add tenableio executor\n * [FIX] Make gvm executor compatible with new version of python-gvm\n * [FIX] Now if a venv is int or float it will convert to string\n\n2.4.0 [Oct 26th. 2022]:\n---\n * Add Qualys executor\n * [MOD] Change pgrep for psutil in zap executor\n\n2.3.0 [Sep 5th, 2022]:\n---\n * Now InsighVM's executer will executa a scan if a site_id is provided\n * Add tags for plugins\n * Add installation in docker file for nmap script: vulners\n * Now the api-key from zap is a enviroment variable\n * [FIX] Change AGENT_CONFIG_HOSTNAME_RESOLUTION por AGENT_CONFIG_RESOLVE_HOSTNAME\n * Update docs\n\n2.2.0 [Jul 25th, 2022]:\n---\n * Add timeout parameter to arachni's executor\n * Add python2.7, w3af and its dependencies to docker image\n * Add ignore_info and hostname_resolution options for most executors.\n * Nessus now list in the logs the available templates and uses posixpath.join instead of concat strings.\nNikto now uses only requieres TARGET_URL argument.\n * Fix logs and change .format to fstrings\n * Remove ws from dispatcher.yaml.\n * Now faraday-dispatcher send the parameters of the executors when it\nconnects to faraday server. Also it checks if there are new enviroment\nvariables defined in the manifest file and warn the user.\n\n2.1.3 [Dec 13th, 2021]:\n---\n * Add --api-token --random-user-agent to wpscan\n * Move shodan executor to official and change logic to work with plugins\n\n2.1.2 [Oct 19th, 2021]:\n---\n * ADD script to nmap logic\n\n2.1.1 [Aug 18th, 2021]:\n---\n * ADD option via configuration YAML file to ignore ssl errors\n * MOD Wizard connection ports defaults vary if SSL value has changed in the previous configuration\n * [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2\n\n2.1.0 [Aug 9th, 2021]:\n---\n * ADD Reminder message to run --token command after wizard\n * FIX `start_date` and `end_date` to be sent as UTC\n * FIX Receiving API error when faraday license is expired\n * ADD Executor for insightvm\n * REMOVE Host and api from burp executor parameters\n * [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2\n\n2.0.0 [Jun 29th, 2021]:\n---\n * ADD Executor parameter typing\n * ADD versioning for manifests from typing package\n * FIX typo in wizard\n * [Faraday][faraday] versions: 3.16.0, 3.16.1, 3.16.2, 3.17.0, 3.17.1, 3.17.2\n\n1.5.1 [May 6th, 2021]:\n---\n * FIX Burp executor parse the IP\n * [Faraday][faraday] versions: 3.14.3, 3.15.0, 3.15.1\n\n1.5.0 [Mar 30th, 2021]:\n---\n * ADD having at least a executor is mandatory, if not it will not save the configuration\n * UPD executor pagination, now each executor have a \"unique\" id\n * MOD Update all reference to [faraday][faraday] to [API v3][api]\n * MOD Connectivity endpoint is now `/_api/v3/info`\n * MOD Now registration token is needed within the run command. Only needed the first time\n * MOD setting host in the wizard now accepts full urls, such as `https://my.server.com:12345`\n * ADD new plugin to support newer OpenVas/gvm versions (gvm_openvas). The old openvas executor was renamed to\n \"openvas_legacy\"\n * [Faraday][faraday] versions: 3.14.3, 3.15.0, 3.15.1\n\n1.4.2 [Feb 26th, 2021]:\n---\n * MOD Update faraday-plugins version, improving nessus plugin process\n * [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2\n\n1.4.1 [Feb 17th, 2021]:\n---\n * MOD Various UX improves in wizard:\n * ADD special character control in name executor\n * ADD More verbose info\n * It is possible to exit wizard if its misconfigurated (will not be saved)\n * FIX Not choosing executor (Using Q) generates correct config file\n * MOD max data sent to server option is a manual edit configuration\n * MOD more extensive default list of official executors\n * MOD change color for options \"next page\" \"don't choose\"\n * ADD new WPScan executor that does not need docker anymore\n * FIX in nuclei_exclude parameter for nuclei executor\n * [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2\n\n1.4.0 [Dec 23rd, 2020]:\n---\n * A base_route can be added before the root of the server (e.g:\nhttps://my.company.com/faraday/ as / of faraday)\n * Add duration to bulk_create to be set correctly\n * The new official executors are:\n * [nuclei](https://github.com/projectdiscovery/nuclei)\n * reports: local report consumed by faraday-plugins\n * Add new flags for nmap executor: `-sC`,`-sV`,`-Pn`,`--script-timeout`,`--host-timeout`,`--top-ports`\n * Fix bug nmap and nessus executors to execute with the dispatcher environment\n * Fix nmap executor when http(s) scheme passed as target\n * [Faraday][faraday] versions: 3.14.0, 3.14.1, 3.14.2\n\n1.3.1 [Sep 7th, 2020]:\n---\n * Add proxy setup by HTTP_PROXY or HTTPS_PROXY environment variables\n * Fix default report name with the nessus executor\n * [Faraday][faraday] versions: 3.12.0\n\n1.3.0 [Sep 3rd, 2020]:\n---\n * An Agent can post data to multiples workspaces\n * The `run` command tries to migrate the configuration to the latest version from\n others as the `config-wizard` does\n * Improve agent signal management and server disconnection, affecting the exit code\n * The wizard page size can be customized (See:\n`faraday-dispatcher config-wizard --help` )\n * The new official executors are:\n * burp\n * crackmapexec\n * Arachni executor generates reports in /tmp now\n * Nmap executor updates use of nmap plugin (byte-string to string response)\n * [Faraday][faraday] versions: 3.12.0\n\n1.2.1 [Jun 22nd, 2020]:\n---\n * Now the dispatcher runs the check commands before running an executor\n * Fix error when connects with faraday fails when trying to access with SSL to not SSL server\n * Fix error when connects with faraday fails when server does not respond\n * Fix error when connects with faraday fails when SSL verification fails\n * Fix error attempting to create an executor with a comma in the name\n * Now the wizard ask if you want use the default SSL behavior\n * Started the process of [documentation][doc]\n * The new official executors are: \n * arachni\n * openvas\n * zap\n * Nmap executor now acepted multi target\n * Fix W3af executor now uses python2\n * Escape user-controlled executor parameters in order to prevent OS argument injection (not command injection)\n * [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2\n\n1.2 [May 27th, 2020]:\n---\n * Now we have official executors, packaged with the dispatcher\n * Fix error when killed by signal\n * Fix error when server close connection\n * Fix error when ssl certificate does not exists\n * Fix error when folder `~/.faraday` does not exists, creating it\n * The new official executors are: \n * nessus\n * nikto\n * nmap\n * sublist3r\n * wpscan\n * w3af\n * [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2\n\n1.1 [Apr 22th, 2020]:\n---\n * The dispatcher now runs with a `faraday-dispatcher run` command\n * `faraday-dispatcher wizard` command added which generates configuration .ini file\n * Manage execution_id within WS and API communication\n * The route of [Faraday][faraday] ws comunication change from / to /websockets\n * Better error management, now shows error and exceptions depending on log levels\n * Better management of invalid token errors\n * Add ssl support\n * [Faraday][faraday] versions: 3.11, 3.11.1, 3.11.2\n\n1.0 [Dec 17th, 2019]:\n---\n * You can add fixed parameters than shouldn't came by the web (e.g. passwords) are set in the dispatcher.ini\n * Now its possible to manage multiple executors within one agent\n * Now is possible to receive params from the [Faraday][faraday] server\n * [Faraday][faraday] versions: 3.10, 3.10.1, 3.10.2\n\n0.1 [Oct 31th, 2019]:\n---\n * First beta version published\n * Basic structure implemented, with executor with fixed values\n * [Faraday][faraday] versions: 3.9.2, 3.9.3\n\n[faraday]: https://github.com/infobyte/faraday\n[doc]: https://docs.agents.faradaysec.com\n[api]: https://api.faradaysec.com\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Faraday agent dispatcher to communicate an agent to faraday",
"version": "3.3.0",
"project_urls": {
"Homepage": "https://github.com/infobyte/faraday_agent_dispatcher"
},
"split_keywords": [
"faraday",
"integration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "176e6e4dc345070e3ef2790adeee9b06f512e0912ff8935dd624d0b6a3672268",
"md5": "e78ff75cfcf09e79deb8451650fac670",
"sha256": "c3993e8fb963eefd53cb05e5b21816fc74cddb50d7780ac9147f415316aa7c0d"
},
"downloads": -1,
"filename": "faraday_agent_dispatcher-3.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e78ff75cfcf09e79deb8451650fac670",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 94366,
"upload_time": "2024-03-12T18:13:16",
"upload_time_iso_8601": "2024-03-12T18:13:16.557299Z",
"url": "https://files.pythonhosted.org/packages/17/6e/6e4dc345070e3ef2790adeee9b06f512e0912ff8935dd624d0b6a3672268/faraday_agent_dispatcher-3.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ca2a3eed443304f36442e0e87daaeb22e79c81024befee9588466b120a53f86",
"md5": "170b4fac762698b35700b36ef993cb29",
"sha256": "a41e75671fdbabda7c07be1a9c8be83c7dd169d71dba3a52109fcdcb286b6a08"
},
"downloads": -1,
"filename": "faraday_agent_dispatcher-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "170b4fac762698b35700b36ef993cb29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 839606,
"upload_time": "2024-03-12T18:13:18",
"upload_time_iso_8601": "2024-03-12T18:13:18.794448Z",
"url": "https://files.pythonhosted.org/packages/1c/a2/a3eed443304f36442e0e87daaeb22e79c81024befee9588466b120a53f86/faraday_agent_dispatcher-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 18:13:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "infobyte",
"github_project": "faraday_agent_dispatcher",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "faraday-agent-dispatcher"
}
JSON
