8000 #171, #175, #182, #185, #187 by ninjeeter · Pull Request #194 · caido/documentation · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

#171, #175, #182, #185, #187 #194

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
Sytten merged 3 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .vitepress/sidebars/guides.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,25 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
{
text: "Other",
items: [
{
text: "Creating Shortcuts",
link: "/guides/shortcuts",
},
{
text: "Configuring the Data Directory",
link: "/guides/data_location",
},
{
text: "Debugging",
link: "/guides/debugging",
},
{
text: "Deleting Data",
link: "/guides/deleting_data",
},
{
text: "Creating Shortcuts",
link: "/guides/shortcuts",
text: "Guest Mode",
link: "/guides/guest_mode",
},
],
},
Expand Down
4 changes: 4 additions & 0 deletions .vitepress/sidebars/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ export const referenceSidebar: DefaultTheme.SidebarItem[] = [
text: "CLI Options",
link: "/reference/cli",
},
{
text: "Command Shortcuts",
link: "/reference/command_shortcuts",
},
{
text: "Environment",
link: "/reference/environment",
Expand Down
File renamed without changes
Binary file added src/_images/debug_logging.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions src/guides/automate.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Automate

The `Automate` tab allows you to send requests in bulk. This feature provides a flexible way to initiate bruteforce/fuzzing campaigns to rapidly modify certain parameters of requests using wordlists.
The `Automate` interface allows you to send requests in bulk. This feature provides a flexible way to initiate bruteforce/fuzzing campaigns to rapidly modify certain parameters of requests using wordlists.

Advanced setting options ensure your campaign can account for events such as failed requests or rate-limiting. You can transfer requests to the Automate interface from many other Caido interfaces.

You can create a request from scratch from a blank template, or start from any existing request inside the application.

<img alt="Automate tab." src="/_images/automate_tab.png" center/>
<img alt="Automate interface." src="/_images/automate_interface.png" center/>

1. Select the `Automate` tab from the left-hand menu within the Caido window.
2. Select the [Attack Strategy](#attack-strategies).
Expand Down
4 changes: 2 additions & 2 deletions src/guides/backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Backups allow you to share your security audits with others - making sure you ar
## Creating a Backup

<ProContainer>
You create backups directly from the Projects tab of your Workspace by clicking ⋮ located to the far-right of the desired Project row.
You create backups directly from the Projects interface of your Workspace by clicking ⋮ located to the far-right of the desired Project row.
</ProContainer>

::: tip
Expand All @@ -20,7 +20,7 @@ It is possible to backup any Project including the currently selected one.

## Downloading a Backup

Once the backup file creation is complete, it will be available in the `Backups` tab. If your Instance is remote, you can `Download` the backup to your local machine. Otherwise, you can click on the `⋮` to get the path on disk if you wish to copy it directly.
Once the backup file creation is complete, it will be available in the `Backups` tab interface. If your Instance is remote, you can `Download` the backup to your local machine. Otherwise, you can click on the `⋮` to get the path on disk if you wish to copy it directly.

<img alt="Backup import." src="/_images/backup_download.png" center/>

Expand Down
21 changes: 21 additions & 0 deletions src/guides/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Debugging

To assist with troubleshooting, Caido can be configured to include debug entries in the generated log files.

## CLI

This can be enabled with the inclusion of the `--debug` command-line argument when using the Caido CLI.

## Desktop

To enable this feature in Caido's desktop application:

1. In the launcher window, click on the `⋮` icon and select `Edit`.
2. Click the `Advanced` settings drop down menu to expand it.
3. Select the `Debug logging` radio button and click the `Save` button.

<img alt="Debug logging." src="/_images/debug_logging.png" center/>

::: warning NOTE
Debug information is required when [reporting bugs](/report_bug.md) to the Caido team.
:::
17 changes: 13 additions & 4 deletions src/guides/distributions/parrot_os.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

---

<img alt="Athena OS Banner" src="/_images/caido_parrot.png" />
<img alt="ParrotOS Banner" src="/_images/caido_parrot.png" />

::: info
The [Parrot OS](https://parrotsec.org/) is a versatile, security-focused Linux distribution designed for penetration testing, security research, and privacy protection. With a rich suite of security tools, it's an ideal operating system for ethical hackers, security professionals, and privacy-conscious users.
[ParrotOS](https://parrotsec.org/) is a versatile, security-focused Linux distribution designed for penetration testing, security research, and privacy protection. With a rich suite of security tools, it's an ideal operating system for ethical hackers, security professionals, and privacy-conscious users.
[Parrot OS](https://parrotsec.org/) is a versatile, security-focused Linux distribution designed for penetration testing, security research, and privacy protection. With a rich suite of security tools, it's an ideal operating system for ethical hackers, security professionals, and privacy-conscious users.

Known for its intuitive interface, regular updates, and strong commitment to open-source principles, Parrot OS stands out as an exceptional option in the security space.
Known for its intuitive interface, regular updates, and strong commitment to open-source principles, ParrotOS stands out as an exceptional option in the security space.
:::

[Here at Caido, we are thrilled to maintain a partnership with the Parrot team.](https://parrotsec.org/blog/2025-01-11-parrot-caido/)
Expand All @@ -31,4 +32,12 @@ Or, enter the following terminal command from any directory:
caido
```

<img alt="Athena OS Banner" src="/_images/parrot.png" no-shadow/>
<img alt="Parrot desktop." src="/_images/parrot.png" no-shadow/>

## ParrotOS WSL

Caido is also included in [ParrotOS WSL](https://parrotsec.org/docs/installation/install-with-wsl/)!

## Rocket

Caido can also be ran as a Docker container with [Rocket](https://gitlab.com/parrotsec/project/rocket)!
4 changes: 2 additions & 2 deletions src/guides/exports.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Exports

The `Exports` tab allows you to export data from the HTTP History and Search pages and use data collected by Caido in other tools.
The `Exports` interface allows you to export data from the HTTP History and Search pages and use data collected by Caido in other tools.

This feature can also be used for archival purposes or audit purposes sometimes required by clients.

Expand Down Expand Up @@ -44,6 +44,6 @@ For the CSV format, each request/response pair will be exported on a row. Since

Once the Export is completed, it will be available on the Exports page.

<img alt="Exports tab." src="/_images/exports_tab.png">
<img alt="Exports interface." src="/_images/exports_tab.png">

From here you can download/rename/delete the Export.
6 changes: 3 additions & 3 deletions src/guides/files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Files

The `Files` tab allows users to upload files to the Caido Instance for future use in other features. This feature is particularly useful when you need to use the same file in different parts of the application.
The `Files` interface allows users to upload files to the Caido Instance for future use in other features. This feature is particularly useful when you need to use the same file in different parts of the application.

::: info
Currently, files uploaded in this page are only available for use in the Automate page.
Expand All @@ -10,11 +10,11 @@ Currently, files uploaded in this page are only available for use in the Automat

`Automate` allows you to brute-force/fuzz designated elements of a request.

- In order to utilize the [Hosted File Payload Type](/guides/automate.md#payload-types) in Automate - you must first upload payload files/wordlists in the `Files` tab within Caido.
- In order to utilize the [Hosted File Payload Type](/guides/automate.md#payload-types) in Automate - you must first upload payload files/wordlists in the `Files` interface within Caido.

## Files

<img alt="Files tab." src="/_images/upload_wordlist_tab.png" center/>
<img alt="Files interface." src="/_images/upload_wordlist_interface.png" center/>

1. Select the `Files` tab from the left-hand menu within the Caido window.
2. Drag and drop the files you wish to upload into this box or click `Browse` to navigate/select the file within your device's file system.
Expand Down
2 changes: 1 addition & 1 deletion src/guides/filters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Filters

**Filter Presets**, created via the `Filters` tab allows you to fine-tune which proxied resources/objects are displayed/excluded. Utilizing the intuitive query syntax of HTTPQL for their `Expressions` - these custom filtering rules ensure your work is streamlined by reducing the time it takes to find that specific request you are looking for.
**Filter Presets**, created via the `Filters` interface allows you to fine-tune which proxied resources/objects are displayed/excluded. Utilizing the intuitive query syntax of HTTPQL for their `Expressions` - these custom filtering rules ensure your work is streamlined by reducing the time it takes to find that specific request you are looking for.

Caido's Filter Preset feature makes it easy to evaluate a large amount of data as you delve into your testing engagement.

Expand Down
2 changes: 1 addition & 1 deletion src/guides/findings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Findings

The `Findings` tab allows you to view the discoveries made by Workflows or tools using the SDK. This tab provides a convenient interface of aggregated Findings so you can examine them efficiently.
The `Findings` interface allows you to view the discoveries made by Workflows or tools using the SDK. This interface provides a convenient interface of aggregated Findings so you can examine them efficiently.

## Findings Layout

Expand Down
6 changes: 5 additions & 1 deletion src/guides/http_history.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# HTTP History

The `HTTP History` tab allows you to view requests and responses as they pass through the proxy. The HTTP History tab shows a table of all requests that have been proxied through Caido.
The `HTTP History` interface allows you to view requests and responses as they pass through the proxy. The HTTP History interface shows a table of all requests that have been proxied through Caido.

The table format allows for easy examination of the traffic flow by offering categories of sortable properties. These properties include details such as the intended host of the request, the request method used, pathing and extension information - as well as details of the associated response such as status code, response length and response time.

Advanced filtering and data exportation capabilities are also integrated into the HTTP History interface.

::: tip
Requests generated by Workflows, Plugins, Replay, and Automate can be viewed in the [Search](/guides/search.md) interface table.
:::

## HTTP History Layout

To familiarize yourself with the HTTP History interface, continue below:
Expand Down
2 changes: 1 addition & 1 deletion src/guides/intercept.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Intercept

The `Intercept` tab allows you to manually control the flow of proxied traffic between your client and the server. With the ability to pause and resume the flow - you can gain a clear understanding of what is occuring.
The `Intercept` interface allows you to manually control the flow of proxied traffic between your client and the server. With the ability to pause and resume the flow - you can gain a clear understanding of what is occuring.

When forwarding is paused, Caido will list all of the requests and responses awaiting forwarding in a queue list. Select any request or response within this list to view its contents. From here - you can make modifications, transfer the request to another Caido feature, forward the request/response or drop the request/response completely.

Expand Down
2 changes: 1 addition & 1 deletion src/guides/plugins.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Plugins

The `Plugins` tab allows you to install and manage plugin packages in Caido.
The `Plugins` interface allows you to install and manage plugin packages in Caido.

These packages expand Caido's functionality, offering a means to futher customize your Instance.

Expand Down
4 changes: 2 additions & 2 deletions src/guides/projects.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Projects

Caido utilizes a client-server architecture model. An **Instance** of Caido is essentially an installation. Click [here](/concepts/essentials/instances.md) for more information on Instances.
Caido utilizes a client-server architecture model. An [Instance](/concepts/essentials/instances.md) of Caido is essentially an installation.

Think of `Projects` as separate directories for your audits. Projects allow you to stay organized when testing against multiple targets within the same Caido instance.

## Creating a New Project

<img alt="Projects tab." src="/_images/projects_tab.png">
<img alt="Projects interface." src="/_images/projects_interface.png">

1. Select the `Workspace` tab from the left-hand menu within the Caido window.
2. Ensure the `Projects` tab in the top-left area of the Caido window is selected.
Expand Down
4 changes: 2 additions & 2 deletions src/guides/replay.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Replay

The `Replay` tab allows you to edit and replay requests individually. This feature provides a quick way to test your web applications by forwarding certain requests repeatedly with different modifications.
The `Replay` interface allows you to edit and replay requests individually. This feature provides a quick way to test your web applications by forwarding certain requests repeatedly with different modifications.

Requests can easily be sent to Replay from other interfaces within Caido - enabling further investigation of requests that seem interesting from a testing perspective.

Expand All @@ -10,7 +10,7 @@ You can create requests from scratch from a blank template, or start from any ex

To familiarize yourself with the Replay interface, continue below:

<img alt="Intercept tab." src="/_images/replay_tab.png" center/>
<img alt="Replay interface." src="/_images/replay_interface.png" center/>

1. Select the `Replay` tab from the left-hand menu within the Caido window.
2. These numerically named tabs are the requests that have been sent to `Replay` in the order they were sent. To select a request, simply click on the desired tab. You can arbitrarily rename a tab by right-clicking it and selecting `Rename`.
Expand Down
2 changes: 1 addition & 1 deletion src/guides/scope.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scopes

Scopes are defined through the creation of **Scope Presets** within the `Scopes` tab interface. Your **Scope Presets** will match requests throughout the application by using a supplied list of `Hosts` that are designated either `In Scope` or `Out of Scope`. Scoping improves the efficiency of your testing process by quickly filtering the display of targets that are relevant/irrelevant to your engagement.
Scopes are defined through the creation of **Scope Presets** within the `Scopes` interface. Your **Scope Presets** will match requests throughout the application by using a supplied list of `Hosts` that are designated either `In Scope` or `Out of Scope`. Scoping improves the efficiency of your testing process by quickly filtering the display of targets that are relevant/irrelevant to your engagement.

Caido offers the ability to switch between your Scope Presets with ease throughout the application.

Expand Down
6 changes: 3 additions & 3 deletions src/guides/search.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Search

The `Search` tab provides a comprehensive view of all the requests that have been generated by tools, such as the Replay and Automate features, in addition to requests that are proxied through Caido via Intercept.
The `Search` interface provides a comprehensive view of all the requests that have been generated by Caido, including requests from [Workflows](/guides/workflows.md), [Plugins](/guides/plugins.md), [Replay](/guides/replay.md), and [Automate](/guides/automate.md), in addition to requests that are proxied through Caido via [Intercept](/guides/intercept.md).

Search differs from other tools in Caido in that way - as the other tabs do not list any request generated by Automate and Replay.
Search differs from other tables in Caido in that way - as the other tabs do not list any request generated by Automate and Replay.

This extra inclusion allows you to sort through the results of all your testing using other Caido features in a single location.

<img alt="Search overview." src="/_images/search_tab.png" center/>
<img alt="Search overview." src="/_images/search_interface.png" center/>
<br>

<ProContainer>
Expand Down
8 changes: 6 additions & 2 deletions src/guides/shortcuts.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Creating Shortcuts

If you click on your account icon in the upper-rightmost corner of the Caido window and select `Settings`, you can set, unset, or change keybindings to commands in the `Shortcuts` tab.
If you click on your account icon in the upper-rightmost corner of the Caido window and select `Settings`, you can set, unset, or change keybindings to commands in the `Shortcuts` interface.

<img alt="Shortcuts tab." src="/_images/shortcuts.png" center/>
<img alt="Shortcuts interface." src="/_images/shortcuts.png" center/>

::: info
[View all of the available command shortcuts.](/reference/command_shortcuts.md)
:::

## Set or Change a Shortcut:

Expand Down
2 changes: 1 addition & 1 deletion src/guides/sitemap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sitemap

The `Sitemap` tab allows you to visualize the structure of any website that is proxied through Caido.
The `Sitemap` interface allows you to visualize the structure of any website that is proxied through Caido.

It keeps track of domains, folders, and requests, as well as any variations in query parameters and POST bodies. The Sitemap page provides a clear, hierarchical view of the website's structure, making it easy to identify and explore different parts of the site.

Expand Down
2 changes: 1 addition & 1 deletion src/guides/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Each Caido instance generates its own CA certificate to be able to negotiate TLS handshakes and intercept HTTPS traffic.

If you click on your account icon in the upper-rightmost corner of the Caido window and select `Settings`, the following options are available in the `TLS` tab:
If you click on your account icon in the upper-rightmost corner of the Caido window and select `Settings`, the following options are available in the `Certificate` interface:

- `Export`: Save the CA certificate so it can be used in another instance.
- `Import`: Import a previously saved CA certificate.
Expand Down
2 changes: 1 addition & 1 deletion src/guides/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Multi-step processes that, before, needed to be performed manually can be saved

## Workflows Layout

<img alt="Workflows tab." src="/_images/workflows_tab_layout.png">
<img alt="Workflows interface." src="/_images/workflows_interface_layout.png">

1. Select the `Workflows` tab from the left-hand menu within the Caido window.
2. The three types of Workflows (`Passive`/`Active`/`Convert`) are listed horizontally here as tabs. Click to toggle between them.
Expand Down
6 changes: 3 additions & 3 deletions src/guides/ws_history.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# WS History

The `WS History` tab allows you to view data exchanged between the client and the server passing through the proxy over a WebSocket connection.
The `WS History` interface allows you to view data exchanged between the client and the server passing through the proxy over a WebSocket connection.

This tab provides you with information such as when the connection was established, where the messages are being sent, the direction of the messages between the client and server, the length of the messages and the contents of each message exchanged.
This interface provides you with information such as when the connection was established, where the messages are being sent, the direction of the messages between the client and server, the length of the messages and the contents of each message exchanged.

## WS History Layout

To familiarize yourself with the WS History interface, continue below:

<img alt="WS History tab." src="/_images/ws_history_tab.png" center/>
<img alt="WS History interface." src="/_images/ws_histo B6E9 ry_interface.png" center/>

1. Select the `WS History` tab from the left-hand menu within the Caido window.
2. All the proxied WebSocket streams will appear in this pane. Select them arbitrarily.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
To send a request to `Automate`, either right-click inside the request pane of `Intercept` or `HTTP History` or focus the request pane and use `CTRL+M`.
:::

<img alt="Automate tab." src="/_images/automate_tab.png" center/>
<img alt="Automate tab." src="/_images/automate_interface.png" center/>

1. Select the `Automate` tab from the left-hand menu within the Caido window.
2. Select the [Attack Strategy](#attack-strategies).
Expand Down
Loading
0