René's URL Explorer Experiment

Title: Plugin Development Guide - Faraday

Description: Faraday

Generator: mkdocs-1.6.1, mkdocs-material-9.7.6

author

Faradaysec

Links:

Skip to content	https://docs.faradaysec.com/Basic-plugin-development/#plugin-development-guide
	https://docs.faradaysec.com/
infobyte/faraday	https://github.com/infobyte/faraday
	https://docs.faradaysec.com/
infobyte/faraday	https://github.com/infobyte/faraday
Home	https://docs.faradaysec.com/
First Steps	https://docs.faradaysec.com/First-Steps/
Getting Started	https://docs.faradaysec.com/Getting-started/
Users and Roles	https://docs.faradaysec.com/Users/
Workspaces	https://docs.faradaysec.com/Workspaces/
Activity Dashboard	https://docs.faradaysec.com/Activity-Dashboard/
Vulnerability Management	https://docs.faradaysec.com/Vulns/
Vulnerability Grouping	https://docs.faradaysec.com/Grouping/
Vulnerability KB	https://docs.faradaysec.com/Vulnerability-Templates-KB/
Assets and Services	https://docs.faradaysec.com/Assets-and-Services-v4/
What is Report	https://docs.faradaysec.com/Report-v4/
How to Build Your Own Template	https://docs.faradaysec.com/How-to-build-your-template/
Jinja2 Context	https://docs.faradaysec.com/Jinja2-context/
Importing	https://docs.faradaysec.com/import/
Dashboard	https://docs.faradaysec.com/Dashboard-v4/
Custom Attributes	https://docs.faradaysec.com/Custom-Fields-v4/
Notifications Settings	https://docs.faradaysec.com/Notifications/
Configure Slack Notifications	https://docs.faradaysec.com/Notifications-Slack/
Advanced Notifications	https://docs.faradaysec.com/Notifications-Advanced/
Planner	https://docs.faradaysec.com/Planner/
GitLab	https://docs.faradaysec.com/integration-gitlab/
Jira	https://docs.faradaysec.com/integration-jira/
SolarWinds	https://docs.faradaysec.com/integration-solarwinds/
ServiceNow	https://docs.faradaysec.com/integration-servicenow/
ServiceDesk	https://docs.faradaysec.com/integration-servicedesk/
Server	https://docs.faradaysec.com/faraday-server-settings/
LDAP	https://docs.faradaysec.com/LDAP/
LDAP with OKTA	https://docs.faradaysec.com/LDAP-OKTA/
Faraday configuration	https://docs.faradaysec.com/SAML/
Auth0 integration	https://docs.faradaysec.com/SAML-Auth0/
Google integration	https://docs.faradaysec.com/SAML-Google/
Okta integration	https://docs.faradaysec.com/SAML-Okta/
Azure integration	https://docs.faradaysec.com/SAML-Azure/
2nd Factor	https://docs.faradaysec.com/2-Factor-Authentication/
Arch	https://docs.faradaysec.com/Architecture/
Openapi	https://docs.faradaysec.com/api-swagger/
API Server	https://docs.faradaysec.com/API-Server/
API Token	https://docs.faradaysec.com/API-Token/
Faraday Manage	https://docs.faradaysec.com/Faraday-Manage/
Faraday Manage Settings	https://docs.faradaysec.com/Faraday-Manage-Settings-v4/
Deduplicated Assets	https://docs.faradaysec.com/Deduplicated-Assets/
Burp	https://docs.faradaysec.com/Burp-proxy-extender/
Beef	https://docs.faradaysec.com/beef/
About Agents	https://docs.faradaysec.com/agents-v4/
AppScan	https://docs.faradaysec.com/executors/executor-appscan/
Arachni	https://docs.faradaysec.com/executors/executor-arachni/
Burp Suite	https://docs.faradaysec.com/executors/executor-burp/
Cyber Vision	https://docs.faradaysec.com/executors/executor-cybervision/
Code QL	https://docs.faradaysec.com/executors/executor-codeql/
CrackMapExec	https://docs.faradaysec.com/executors/executor-crackmapexec/
Dependabot	https://docs.faradaysec.com/executors/executor-dependabot/
Github Secrets	https://docs.faradaysec.com/executors/executor-gitgub-secrets/
GVM OpenVAS	https://docs.faradaysec.com/executors/executor-gvm-openvas/
InsightVM	https://docs.faradaysec.com/executors/executor-insightvm/
Nessus	https://docs.faradaysec.com/executors/executor-nessus/
Nikto 2	https://docs.faradaysec.com/executors/executor-nikto2/
NMap	https://docs.faradaysec.com/executors/executor-nmap/
Nuclei	https://docs.faradaysec.com/executors/executor-nuclei/
OpenVAS Legacy	https://docs.faradaysec.com/executors/executor-openvas-legacy/
Qualys	https://docs.faradaysec.com/executors/executor-qualys/
Report Processor	https://docs.faradaysec.com/executors/executor-report-processor/
Shodan 2	https://docs.faradaysec.com/executors/executor-shodan2/
SonarQube	https://docs.faradaysec.com/executors/executor-sonarqube/
Sublist3r	https://docs.faradaysec.com/executors/executor-sublist3r/
TenableIO	https://docs.faradaysec.com/executors/executor-tenableio/
TenableSC	https://docs.faradaysec.com/executors/executor-tenablesc/
W3af	https://docs.faradaysec.com/executors/executor-w3af/
WPScan	https://docs.faradaysec.com/executors/executor-wpscan/
WPScan Legacy	https://docs.faradaysec.com/executors/executor-wpscan-legacy/
Zap	https://docs.faradaysec.com/executors/executor-zap/
Scheduler, Pipelines and Jobs	https://docs.faradaysec.com/Scheduling/
Linux	https://docs.faradaysec.com/Install-guide-Linux/
RedHat 8/Centos	https://docs.faradaysec.com/Install-guide-Redhat-8/
Docker	https://docs.faradaysec.com/Install-guide-Docker/
Community	https://docs.faradaysec.com/Install-guide-community/
Update	https://docs.faradaysec.com/Update/
Advanced Install	https://docs.faradaysec.com/Install-guide-Advanced/
Remote PostgreSQL	https://docs.faradaysec.com/Remote-PostgreSQL/
NGINX (SSL Config)	https://docs.faradaysec.com/NGINX-Setup/
Troubleshooting	https://docs.faradaysec.com/Install-guide-Troubleshooting/
Backup	https://docs.faradaysec.com/Backup-v4/
Faraday	https://docs.faradaysec.com/RELEASE/
Faraday MCP	https://docs.faradaysec.com/Faraday-MCP/
Faraday Cli	https://docs.faradaysec.com/faraday-cli/
Settings	https://docs.faradaysec.com/Settings-v4/
Faraday Developer Guide	https://docs.faradaysec.com/Development-setup/
Plugin Development	https://docs.faradaysec.com/Basic-plugin-development/
Overview	https://docs.faradaysec.com/Basic-plugin-development/#overview
1 — Prerequisites	https://docs.faradaysec.com/Basic-plugin-development/#1-prerequisites
2 — Configure Custom Plugins	https://docs.faradaysec.com/Basic-plugin-development/#2-configure-custom-plugins
In Faraday Server	https://docs.faradaysec.com/Basic-plugin-development/#in-faraday-server
Standalone (no server required)	https://docs.faradaysec.com/Basic-plugin-development/#standalone-no-server-required
3 — Plugin File Structure	https://docs.faradaysec.com/Basic-plugin-development/#3-plugin-file-structure
4 — Plugin Class Hierarchy	https://docs.faradaysec.com/Basic-plugin-development/#4-plugin-class-hierarchy
5 — The createPlugin Factory Function	https://docs.faradaysec.com/Basic-plugin-development/#5-the-createplugin-factory-function
6 — File / Report Plugins	https://docs.faradaysec.com/Basic-plugin-development/#6-file-report-plugins
6.1 — PluginXMLFormat	https://docs.faradaysec.com/Basic-plugin-development/#61-pluginxmlformat
6.2 — PluginJsonFormat	https://docs.faradaysec.com/Basic-plugin-development/#62-pluginjsonformat
6.3 — PluginMultiLineJsonFormat	https://docs.faradaysec.com/Basic-plugin-development/#63-pluginmultilinejsonformat
6.4 — PluginCSVFormat	https://docs.faradaysec.com/Basic-plugin-development/#64-plugincsvformat
6.5 — PluginZipFormat	https://docs.faradaysec.com/Basic-plugin-development/#65-pluginzipformat
7 — Command Plugins	https://docs.faradaysec.com/Basic-plugin-development/#7-command-plugins
7.1 — Basic Command Plugin	https://docs.faradaysec.com/Basic-plugin-development/#71-basic-command-plugin
7.2 — Commands That Produce Output Files	https://docs.faradaysec.com/Basic-plugin-development/#72-commands-that-produce-output-files
8 — Data Model API	https://docs.faradaysec.com/Basic-plugin-development/#8-data-model-api
8.1 — createAndAddHost	https://docs.faradaysec.com/Basic-plugin-development/#81-createandaddhost
8.2 — createAndAddServiceToHost	https://docs.faradaysec.com/Basic-plugin-development/#82-createandaddservicetohost
8.3 — createAndAddVulnToHost	https://docs.faradaysec.com/Basic-plugin-development/#83-createandaddvulntohost
8.4 — createAndAddVulnToService	https://docs.faradaysec.com/Basic-plugin-development/#84-createandaddvulntoservice
8.5 — createAndAddVulnWebToService	https://docs.faradaysec.com/Basic-plugin-development/#85-createandaddvulnwebtoservice
8.6 — createAndAddCredToService	https://docs.faradaysec.com/Basic-plugin-development/#86-createandaddcredtoservice
8.7 — Severity Normalization	https://docs.faradaysec.com/Basic-plugin-development/#87-severity-normalization
8.8 — CVE / CWE Validation	https://docs.faradaysec.com/Basic-plugin-development/#88-cve-cwe-validation
9 — Report Detection Mechanism	https://docs.faradaysec.com/Basic-plugin-development/#9-report-detection-mechanism
9.1 — By Filename Convention	https://docs.faradaysec.com/Basic-plugin-development/#91-by-filename-convention
9.2 — By File Content	https://docs.faradaysec.com/Basic-plugin-development/#92-by-file-content
10 — Real-World Plugin Examples	https://docs.faradaysec.com/Basic-plugin-development/#10-real-world-plugin-examples
10.1 — Command Plugin: Ping	https://docs.faradaysec.com/Basic-plugin-development/#101-command-plugin-ping
10.2 — Report Plugin: Dirsearch (JSON)	https://docs.faradaysec.com/Basic-plugin-development/#102-report-plugin-dirsearch-json
10.3 — Advanced Plugin: Nuclei (Multi-Line JSON with Version Detection)	https://docs.faradaysec.com/Basic-plugin-development/#103-advanced-plugin-nuclei-multi-line-json-with-version-detection
11 — Testing and Debugging	https://docs.faradaysec.com/Basic-plugin-development/#11-testing-and-debugging
11.1 — CLI Commands	https://docs.faradaysec.com/Basic-plugin-development/#111-cli-commands
11.2 — Step-by-Step Testing	https://docs.faradaysec.com/Basic-plugin-development/#112-step-by-step-testing
11.3 — Debug Mode	https://docs.faradaysec.com/Basic-plugin-development/#113-debug-mode
11.4 — Plugin Logger	https://docs.faradaysec.com/Basic-plugin-development/#114-plugin-logger
11.5 — Writing Automated Tests	https://docs.faradaysec.com/Basic-plugin-development/#115-writing-automated-tests
12 — Submitting Your Plugin	https://docs.faradaysec.com/Basic-plugin-development/#12-submitting-your-plugin
Contributing to the Official Repository	https://docs.faradaysec.com/Basic-plugin-development/#contributing-to-the-official-repository
Using as a Custom Plugin	https://docs.faradaysec.com/Basic-plugin-development/#using-as-a-custom-plugin
13 — Quick Reference	https://docs.faradaysec.com/Basic-plugin-development/#13-quick-reference
Plugin Checklist	https://docs.faradaysec.com/Basic-plugin-development/#plugin-checklist
Common Patterns	https://docs.faradaysec.com/Basic-plugin-development/#common-patterns
Severity Mapping	https://docs.faradaysec.com/Basic-plugin-development/#severity-mapping
Contact Us	https://docs.faradaysec.com/Contact-us/
FAQs	https://docs.faradaysec.com/FAQ/
Supported-Plugins	https://docs.faradaysec.com/Plugin-List-v4/
Troubleshooting	https://docs.faradaysec.com/Troubleshooting/
Overview	https://docs.faradaysec.com/Basic-plugin-development/#overview
1 — Prerequisites	https://docs.faradaysec.com/Basic-plugin-development/#1-prerequisites
2 — Configure Custom Plugins	https://docs.faradaysec.com/Basic-plugin-development/#2-configure-custom-plugins
In Faraday Server	https://docs.faradaysec.com/Basic-plugin-development/#in-faraday-server
Standalone (no server required)	https://docs.faradaysec.com/Basic-plugin-development/#standalone-no-server-required
3 — Plugin File Structure	https://docs.faradaysec.com/Basic-plugin-development/#3-plugin-file-structure
4 — Plugin Class Hierarchy	https://docs.faradaysec.com/Basic-plugin-development/#4-plugin-class-hierarchy
5 — The createPlugin Factory Function	https://docs.faradaysec.com/Basic-plugin-development/#5-the-createplugin-factory-function
6 — File / Report Plugins	https://docs.faradaysec.com/Basic-plugin-development/#6-file-report-plugins
6.1 — PluginXMLFormat	https://docs.faradaysec.com/Basic-plugin-development/#61-pluginxmlformat
6.2 — PluginJsonFormat	https://docs.faradaysec.com/Basic-plugin-development/#62-pluginjsonformat
6.3 — PluginMultiLineJsonFormat	https://docs.faradaysec.com/Basic-plugin-development/#63-pluginmultilinejsonformat
6.4 — PluginCSVFormat	https://docs.faradaysec.com/Basic-plugin-development/#64-plugincsvformat
6.5 — PluginZipFormat	https://docs.faradaysec.com/Basic-plugin-development/#65-pluginzipformat
7 — Command Plugins	https://docs.faradaysec.com/Basic-plugin-development/#7-command-plugins
7.1 — Basic Command Plugin	https://docs.faradaysec.com/Basic-plugin-development/#71-basic-command-plugin
7.2 — Commands That Produce Output Files	https://docs.faradaysec.com/Basic-plugin-development/#72-commands-that-produce-output-files
8 — Data Model API	https://docs.faradaysec.com/Basic-plugin-development/#8-data-model-api
8.1 — createAndAddHost	https://docs.faradaysec.com/Basic-plugin-development/#81-createandaddhost
8.2 — createAndAddServiceToHost	https://docs.faradaysec.com/Basic-plugin-development/#82-createandaddservicetohost
8.3 — createAndAddVulnToHost	https://docs.faradaysec.com/Basic-plugin-development/#83-createandaddvulntohost
8.4 — createAndAddVulnToService	https://docs.faradaysec.com/Basic-plugin-development/#84-createandaddvulntoservice
8.5 — createAndAddVulnWebToService	https://docs.faradaysec.com/Basic-plugin-development/#85-createandaddvulnwebtoservice
8.6 — createAndAddCredToService	https://docs.faradaysec.com/Basic-plugin-development/#86-createandaddcredtoservice
8.7 — Severity Normalization	https://docs.faradaysec.com/Basic-plugin-development/#87-severity-normalization
8.8 — CVE / CWE Validation	https://docs.faradaysec.com/Basic-plugin-development/#88-cve-cwe-validation
9 — Report Detection Mechanism	https://docs.faradaysec.com/Basic-plugin-development/#9-report-detection-mechanism
9.1 — By Filename Convention	https://docs.faradaysec.com/Basic-plugin-development/#91-by-filename-convention
9.2 — By File Content	https://docs.faradaysec.com/Basic-plugin-development/#92-by-file-content
10 — Real-World Plugin Examples	https://docs.faradaysec.com/Basic-plugin-development/#10-real-world-plugin-examples
10.1 — Command Plugin: Ping	https://docs.faradaysec.com/Basic-plugin-development/#101-command-plugin-ping
10.2 — Report Plugin: Dirsearch (JSON)	https://docs.faradaysec.com/Basic-plugin-development/#102-report-plugin-dirsearch-json
10.3 — Advanced Plugin: Nuclei (Multi-Line JSON with Version Detection)	https://docs.faradaysec.com/Basic-plugin-development/#103-advanced-plugin-nuclei-multi-line-json-with-version-detection
11 — Testing and Debugging	https://docs.faradaysec.com/Basic-plugin-development/#11-testing-and-debugging
11.1 — CLI Commands	https://docs.faradaysec.com/Basic-plugin-development/#111-cli-commands
11.2 — Step-by-Step Testing	https://docs.faradaysec.com/Basic-plugin-development/#112-step-by-step-testing
11.3 — Debug Mode	https://docs.faradaysec.com/Basic-plugin-development/#113-debug-mode
11.4 — Plugin Logger	https://docs.faradaysec.com/Basic-plugin-development/#114-plugin-logger
11.5 — Writing Automated Tests	https://docs.faradaysec.com/Basic-plugin-development/#115-writing-automated-tests
12 — Submitting Your Plugin	https://docs.faradaysec.com/Basic-plugin-development/#12-submitting-your-plugin
Contributing to the Official Repository	https://docs.faradaysec.com/Basic-plugin-development/#contributing-to-the-official-repository
Using as a Custom Plugin	https://docs.faradaysec.com/Basic-plugin-development/#using-as-a-custom-plugin
13 — Quick Reference	https://docs.faradaysec.com/Basic-plugin-development/#13-quick-reference
Plugin Checklist	https://docs.faradaysec.com/Basic-plugin-development/#plugin-checklist
Common Patterns	https://docs.faradaysec.com/Basic-plugin-development/#common-patterns
Severity Mapping	https://docs.faradaysec.com/Basic-plugin-development/#severity-mapping
¶	https://docs.faradaysec.com/Basic-plugin-development/#plugin-development-guide
¶	https://docs.faradaysec.com/Basic-plugin-development/#overview
¶	https://docs.faradaysec.com/Basic-plugin-development/#1-prerequisites
¶	https://docs.faradaysec.com/Basic-plugin-development/#2-configure-custom-plugins
¶	https://docs.faradaysec.com/Basic-plugin-development/#in-faraday-server
¶	https://docs.faradaysec.com/Basic-plugin-development/#standalone-no-server-required
¶	https://docs.faradaysec.com/Basic-plugin-development/#3-plugin-file-structure
¶	https://docs.faradaysec.com/Basic-plugin-development/#4-plugin-class-hierarchy
¶	https://docs.faradaysec.com/Basic-plugin-development/#5-the-createplugin-factory-function
¶	https://docs.faradaysec.com/Basic-plugin-development/#6-file-report-plugins
¶	https://docs.faradaysec.com/Basic-plugin-development/#61-pluginxmlformat
¶	https://docs.faradaysec.com/Basic-plugin-development/#62-pluginjsonformat
¶	https://docs.faradaysec.com/Basic-plugin-development/#63-pluginmultilinejsonformat
¶	https://docs.faradaysec.com/Basic-plugin-development/#64-plugincsvformat
¶	https://docs.faradaysec.com/Basic-plugin-development/#65-pluginzipformat
¶	https://docs.faradaysec.com/Basic-plugin-development/#7-command-plugins
¶	https://docs.faradaysec.com/Basic-plugin-development/#71-basic-command-plugin
¶	https://docs.faradaysec.com/Basic-plugin-development/#72-commands-that-produce-output-files
¶	https://docs.faradaysec.com/Basic-plugin-development/#8-data-model-api
¶	https://docs.faradaysec.com/Basic-plugin-development/#81-createandaddhost
¶	https://docs.faradaysec.com/Basic-plugin-development/#82-createandaddservicetohost
¶	https://docs.faradaysec.com/Basic-plugin-development/#83-createandaddvulntohost
¶	https://docs.faradaysec.com/Basic-plugin-development/#84-createandaddvulntoservice
¶	https://docs.faradaysec.com/Basic-plugin-development/#85-createandaddvulnwebtoservice
¶	https://docs.faradaysec.com/Basic-plugin-development/#86-createandaddcredtoservice
¶	https://docs.faradaysec.com/Basic-plugin-development/#87-severity-normalization
¶	https://docs.faradaysec.com/Basic-plugin-development/#88-cve-cwe-validation
¶	https://docs.faradaysec.com/Basic-plugin-development/#9-report-detection-mechanism
¶	https://docs.faradaysec.com/Basic-plugin-development/#91-by-filename-convention
¶	https://docs.faradaysec.com/Basic-plugin-development/#92-by-file-content
¶	https://docs.faradaysec.com/Basic-plugin-development/#10-real-world-plugin-examples
¶	https://docs.faradaysec.com/Basic-plugin-development/#101-command-plugin-ping
¶	https://docs.faradaysec.com/Basic-plugin-development/#102-report-plugin-dirsearch-json
¶	https://docs.faradaysec.com/Basic-plugin-development/#103-advanced-plugin-nuclei-multi-line-json-with-version-detection
¶	https://docs.faradaysec.com/Basic-plugin-development/#11-testing-and-debugging
¶	https://docs.faradaysec.com/Basic-plugin-development/#111-cli-commands
¶	https://docs.faradaysec.com/Basic-plugin-development/#112-step-by-step-testing
¶	https://docs.faradaysec.com/Basic-plugin-development/#113-debug-mode
¶	https://docs.faradaysec.com/Basic-plugin-development/#114-plugin-logger
¶	https://docs.faradaysec.com/Basic-plugin-development/#115-writing-automated-tests
¶	https://docs.faradaysec.com/Basic-plugin-development/#12-submitting-your-plugin
¶	https://docs.faradaysec.com/Basic-plugin-development/#contributing-to-the-official-repository
faraday-plugins	https://github.com/infobyte/faraday_plugins
infobyte/faraday_plugins	https://github.com/infobyte/faraday_plugins
¶	https://docs.faradaysec.com/Basic-plugin-development/#using-as-a-custom-plugin
¶	https://docs.faradaysec.com/Basic-plugin-development/#13-quick-reference
¶	https://docs.faradaysec.com/Basic-plugin-development/#plugin-checklist
¶	https://docs.faradaysec.com/Basic-plugin-development/#common-patterns
¶	https://docs.faradaysec.com/Basic-plugin-development/#severity-mapping
Material for MkDocs	https://squidfunk.github.io/mkdocs-material/
	https://github.com/infobyte/faraday/
	https://twitter.com/faradaysec
	https://www.linkedin.com/company/faradaysec/
	https://instagram.com/faradaysec

Viewport: width=device-width,initial-scale=1

URLs of crawlers that visited me.