{"id":19236443,"url":"https://github.com/infobyte/faraday_plugins","last_synced_at":"2025-12-11T22:12:33.953Z","repository":{"id":39211456,"uuid":"218869365","full_name":"infobyte/faraday_plugins","owner":"infobyte","description":"Security tools report parsers for Faradaysec.com","archived":false,"fork":false,"pushed_at":"2025-03-25T17:14:53.000Z","size":2967,"stargazers_count":53,"open_issues_count":10,"forks_count":20,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-30T21:08:57.654Z","etag":null,"topics":["dast","devsecops","faradaysec","pentesting","security-automation","security-testing","security-tools","security-vulnerability","vulnerability-scanners"],"latest_commit_sha":null,"homepage":"https://www.faradaysec.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infobyte.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG/1.10.0/293.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-31T22:06:51.000Z","updated_at":"2025-03-13T15:46:32.000Z","dependencies_parsed_at":"2023-11-23T15:27:09.193Z","dependency_job_id":"1b95c0dc-5168-431b-970a-92154f0bc86c","html_url":"https://github.com/infobyte/faraday_plugins","commit_stats":{"total_commits":1478,"total_committers":66,"mean_commits":"22.393939393939394","dds":0.8315290933694182,"last_synced_commit":"5a3ff94b262fb04e24e4ade3ad54af57efc052d3"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday_plugins","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday_plugins/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday_plugins/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday_plugins/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infobyte","download_url":"https://codeload.github.com/infobyte/faraday_plugins/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247557767,"owners_count":20958047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dast","devsecops","faradaysec","pentesting","security-automation","security-testing","security-tools","security-vulnerability","vulnerability-scanners"],"created_at":"2024-11-09T16:20:36.040Z","updated_at":"2025-12-11T22:12:33.883Z","avatar_url":"https://github.com/infobyte.png","language":"Python","readme":"## Install\n\n```shell script\npip install faraday-plugins\n```\n\n## Commands\n\n### List Plugins\n\nList all plugins and if its compatible with command or/and report\n\nOptional params:\n\n- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that path\n\n```shell script\nfaraday-plugins list-plugins\n```\n\n### Test autodetect plugin from command\n\n```shell script\nfaraday-plugins detect-command \"ping -c 4 www.google.com\"\n\nFaraday Plugin: ping\n```\n\n### Test process command with plugin\n\nOptional params:\n\n- --plugin_id PLUGIN_ID: Dont detect the plugin, use this one\n- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that path\n- -dr / --dont-run: Dont run, just show the generated command\n- -o / --output-file PATH: send json outout to file instead of stdout\n- -sh / --show-output: show the output of the command\n\n```shell script\nfaraday-plugins process-command \"ping -c4 www.google.com\"\n{\n    \"hosts\": [\n        {\n            \"ip\": \"216.58.202.36\",\n            \"os\": \"unknown\",\n            \"hostnames\": [\n                \"www.google.com\"\n            ],\n            \"description\": \"\",\n            \"mac\": null,\n            \"credentials\": [],\n            \"services\": [],\n            \"vulnerabilities\": [],\n            \"tags\": []\n        }\n    ],\n    \"command\": {\n        \"tool\": \"ping\",\n        \"command\": \"ping\",\n        \"params\": \"-c4 www.google.com\",\n        \"user\": \"user\",\n        \"hostname\": \"\",\n        \"start_date\": \"2020-06-19T17:02:37.982293\",\n        \"duration\": 39309,\n        \"import_source\": \"shell\"\n    }\n}\n```\n\n### Test autodetect plugin from report\n\n```shell script\nfaraday-plugins detect-report /path/to/report.xml\n\nFaraday Plugin: Nmap\n```\n\n### Test report with plugin\n\nOptional params:\n\n- --plugin_id PLUGIN_ID: Dont detect the plugin, use this one\n- -cpf / --custom-plugins-folder PATH: If given will also look for custom plugins on that path\n\n```shell script\nfaraday-plugins process-report /path/to/nmap_report.xml\n\n{\n    \"hosts\": [\n        {\n            \"ip\": \"192.168.66.1\",\n            \"os\": \"unknown\",\n            \"hostnames\": [],\n            \"description\": \"\",\n            \"mac\": \"00:00:00:00:00:00\",\n            \"credentials\": [],\n            \"services\": [\n                {\n                    \"name\": \"domain\",\n                    \"protocol\": \"tcp\",\n                    \"port\": 53,\n                    \"status\": \"open\",\n                    \"version\": \"\",\n                    \"description\": \"domain\",\n                    \"credentials\": [],\n                    \"vulnerabilities\": [],\n                    \"tags\": []\n                },\n                {\n                    \"name\": \"netbios-ssn\",\n                    \"protocol\": \"tcp\",\n                    \"port\": 139,\n                    \"status\": \"open\",\n                    \"version\": \"\",\n                    \"description\": \"netbios-ssn\",\n                    \"credentials\": [],\n                    \"vulnerabilities\": [],\n                    \"tags\": []\n                }\n            ],\n            \"vulnerabilities\": [],\n            \"tags\": []\n        }\n    ],\n    \"command\": {\n        \"tool\": \"Nmap\",\n        \"command\": \"Nmap\",\n        \"params\": \"/path/to/nmap_report.xml\",\n        \"user\": \"user\",\n        \"hostname\": \"\",\n        \"start_date\": \"2020-06-19T17:22:11.608134\",\n        \"duration\": 1233,\n        \"import_source\": \"report\"\n    }\n}\n```\n\n## Plugin Logger\n\nTo use it you must call `self.logger.debug(\"some message\")`\n\n```shell script\nexport PLUGIN_DEBUG=1\nfaraday-plugins proces-report /path/to/report.xml\n2019-11-15 20:37:03,355 - faraday.faraday_plugins.plugins.manager - INFO [manager.py:113 - _load_plugins()]  Loading Native Plugins...\n2019-11-15 20:37:03,465 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [acunetix]\n2019-11-15 20:37:03,495 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [amap]\n2019-11-15 20:37:03,549 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [appscan]\n2019-11-15 20:37:03,580 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [arachni]\n2019-11-15 20:37:03,613 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [arp_scan]\n2019-11-15 20:37:03,684 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [beef]\n2019-11-15 20:37:03,714 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [brutexss]\n2019-11-15 20:37:03,917 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [burp]\n2019-11-15 20:37:03,940 - faraday.faraday_plugins.plugins.manager - DEBUG [manager.py:123 - _load_plugins()]  Load Plugin [dig]\n...\n```\n\nMore documentation here https://docs.faradaysec.com/Basic-plugin-development/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfobyte%2Ffaraday_plugins","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfobyte%2Ffaraday_plugins","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfobyte%2Ffaraday_plugins/lists"}