-
-
Notifications
You must be signed in to change notification settings - Fork 503
Add Caido integration documentation and workflow images #781
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| --- | ||
| title: Caido Active Workflow | ||
| redirect_from: /docs/caido/ | ||
| parent: Running | ||
| nav_order: 7 | ||
| toc: true | ||
| layout: page | ||
| --- | ||
|
|
||
| # Dalfox Caido Integration | ||
| {: .d-inline-block } | ||
|
|
||
| New (v2.12.0) | ||
| {: .label .label-blue } | ||
|
|
||
| ## Overview | ||
|
|
||
| Dalfox now supports direct integration with [Caido](https://caido.io/), enabling powerful, automated XSS scanning as part of your Caido active workflows. This integration streamlines web security testing by allowing you to invoke Dalfox’s advanced XSS detection on HTTP requests intercepted or crafted within Caido, and view actionable results right in your workflow. | ||
|
|
||
| ## What is Caido? | ||
|
|
||
| Caido is a modern web security toolkit for penetration testers and bug bounty hunters. It provides an intuitive interface for intercepting, modifying, and replaying HTTP requests, and supports extensibility through active workflows and external tool integrations. | ||
|
|
||
| By integrating Dalfox with Caido, you can: | ||
|
|
||
| - Automatically scan HTTP requests for XSS vulnerabilities | ||
| - Receive structured, actionable scan results within Caido | ||
| - Enhance your security testing workflow with minimal manual effort | ||
|
|
||
| ## Setting Up Dalfox with Caido | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - **Dalfox v2.12.0 or later** installed on your system | ||
| - **Caido** installed and running | ||
| - **jq** installed on your system | ||
|
|
||
| ### Installation | ||
|
|
||
| If you haven’t installed Dalfox yet, use one of the following methods: | ||
|
|
||
| ```bash | ||
| # From source | ||
| go install github.com/hahwul/dalfox/v2@latest | ||
|
|
||
| # Homebrew | ||
| brew install dalfox | ||
|
|
||
| # Snapcraft | ||
| snap install dalfox | ||
| ``` | ||
|
|
||
| *[Installation](/page/installation/)* | ||
|
|
||
| ## Configuring the Active Workflow | ||
|
|
||
| To use Dalfox as an active workflow in Caido: | ||
|
|
||
| 1. **Set your Dalfox binary path** | ||
| Update the workflow script with the path to your Dalfox executable (you can find it with `which dalfox`): | ||
|
|
||
| ```bash | ||
| DALFOX_PATH="/path/to/your/dalfox" | ||
| ``` | ||
|
|
||
| 2. **Configure the Caido workflow** | ||
| Use the following shell script in your Caido active workflow configuration: | ||
| ```bash | ||
| cat - | jq -r .request | $DALFOX_PATH pipe --rawdata --silence --report --report-format=md | ||
| ``` | ||
| This script takes the intercepted HTTP request from Caido, pipes it to Dalfox, and outputs the results in Markdown format. | ||
|
|
||
| 3. **Save and activate the workflow** | ||
| Ensure your workflow is enabled in Caido’s interface. | ||
|
|
||
| #### Example Workflow Configuration | ||
|
|
||
|  | ||
|
|
||
| ```bash | ||
| # Set your dalfox path | ||
| DALFOX_PATH="/Users/hahwul/Projects/dalfox/dalfox" | ||
|
|
||
| # Run dalfox | ||
| cat - | jq -r .request | $DALFOX_PATH pipe --rawdata --silence --report --report-format=md | ||
| ``` | ||
|
|
||
| ## Using Dalfox in Caido | ||
|
|
||
| Once configured, you can trigger Dalfox scans directly from Caido’s UI. When you send a request through Caido, the active workflow will automatically invoke Dalfox and display the scan results. | ||
|
|
||
| #### Running from the Context Menu | ||
|
|
||
| You can also run the Dalfox workflow directly from Caido’s context menu. Simply right-click on a request, select `Run workflow`, and choose `XSS Scan`. | ||
|
|
||
|  | ||
|
|
||
| #### Example Scan Result in Caido | ||
|
|
||
|  | ||
|
|
||
| ## Advanced Usage | ||
|
|
||
| You can customize Dalfox’s behavior by modifying the workflow script to include additional flags, such as custom headers, cookies, or Blind XSS callbacks. For example: | ||
|
|
||
| ```bash | ||
| cat - | jq -r .request | $DALFOX_PATH pipe --rawdata --silence --report --report-format=md --header "Authorization: Bearer <token>" -b your-callback.com | ||
| ``` | ||
|
|
||
| ## Best Practices | ||
|
|
||
| 1. **Keep Dalfox Updated**: Use the latest version for improved detection and features. | ||
| 2. **Validate Results**: Manually verify critical findings for accuracy. | ||
| 3. **Respect Target Systems**: Avoid scanning production systems without permission. | ||
| 4. **Leverage Caido Context**: Use Caido’s request manipulation features to test various scenarios before scanning. | ||
| 5. **Secure Sensitive Data**: Be mindful of sensitive information in scan results. | ||
|
|
||
| --- | ||
|
|
||
| By integrating Dalfox with Caido, you can supercharge your web security assessments with automated, reliable XSS detection—right where you need it most. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.