Skip to content
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
4 changes: 4 additions & 0 deletions .vitepress/sidebars/app/tutorials.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ export const tutorialsSidebar: DefaultTheme.SidebarItem[] = [
text: "Autorize",
link: "/app/tutorials/autorize",
},
{
text: "Drop",
link: "/app/tutorials/drop",
},
{
text: "Scanner",
link: "/app/tutorials/scanner",
Expand Down
Binary file added src/_images/drop_friend_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_images/drop_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_images/drop_notification_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_images/drop_received_messages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/app/guides/data_location.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ All the data Caido creates is stored in a single directory. The default location
| Windows | `%APPDATA%\Caido\Caido\data` |

::: warning NOTE
Caido does not currently support storing projects outside of the this directory. However, you can change the location of the directory if needed. Before changing the location, ensure to copy the existing data before restarting your instance. Otherwise the instance will restart as if you were on a new device.
Caido does not currently support storing projects outside of this directory. However, you can change the location of the directory if needed. Before changing the location, ensure to copy the existing data before restarting your instance. Otherwise the instance will restart as if you were on a new device.
:::

## Caido CLI
Expand Down
4 changes: 3 additions & 1 deletion src/app/troubleshooting/report_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ To obtain the frontend logs, either:

- Access the DevTools interface by pressing the `F12` key, using the keybinding `CTRL` + `SHIFT` + `I`, or selecting `Inspect` from the **right-click** context menu. Within the `Console` **right-click** and select `Save as...`/`Save all Messages to File`/etc. to export the messages as a `.log` file.

- Or, **click** on the <code><Icon icon="fas fa-file-lines" /> Logs</code> button at the bottom of the Caido user-interface, record your activity, and then **click** on the <code><Icon icon="fas fa-download" /></code> button to export the messages as a `.log` file.
- **Click** on the <code><Icon icon="fas fa-file-lines" /> Logs</code> button at the bottom of the Caido user-interface, record your activity, and then **click** on the <code><Icon icon="fas fa-download" /></code> button to export the messages as a `.log` file.

- Press the `ALT` key to open the menu bar, **click** on `View`, and select `Toggle Developer Tools`.

<img alt="The Caido frontend logs interface." src="/_images/frontend_logs.png" center/>

Expand Down
48 changes: 48 additions & 0 deletions src/app/tutorials/drop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Drop

The [Drop](https://github.com/caido-community/drop) plugin gives you the ability to share project data, over an end-to-end encrypted channel, with other Caido users, including:

- [Replay Sessions](/app/quickstart/replay.md)
- [Match & Replace Rules](/app/quickstart/match_replace.md)
- [Scope Presets](/app/quickstart/scopes.md)
- [Filter Presets](/app/quickstart/filters.md)

::: info
Support for sharing [workflows](/app/quickstart/workflows.md), [files](/app/quickstart/files.md), [findings](/app/quickstart/findings.md), and [HTTPQL](/app/reference/httpql.md) query statements is planned for upcoming releases.
:::

In this tutorial you will learn how to collaborate with other Caido users as well as how to self-host the plugin's backend server.

::: info
Drop is available for [installation](/app/guides/plugins_installing.md) in the `Community` tab of the Plugin interface.
:::

<img alt="The Drop plugin listed in the Community tab." src="/_images/drop_install.png" center />

## Collaboration

To ensure data is shared securely, Drop users are identified by **Share Codes** that are associated with their [Pretty Good Privacy (PGP)](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) public encryption key.

To collaborate with another Caido user, paste their **Share Code** in the input field in the `Friends` section of the `Settings` tab. Or, send your code to them to do the same.

Once a user has been added to your friends list, data can be sent to them via messages by selecting their alias from the <code>Drop to...<Icon icon="fas fa-angle-down" /></code> drop-down menu that is available in certain Caido interfaces.

<img alt="Selecting a friend to share data with." src="/_images/drop_friend_selection.png" center />

To accept a message from another user, **click** on <code><Icon icon="fas fa-check" /> Claim</code> button in either the notification banner or the `Received Messages` tab of the Drop interface.

<img alt="Drop notification banner." src="/_images/drop_notification_banner.png" center />

---

<img alt="The Received Messages interface." src="/_images/drop_received_messages.png" center />

::: warning NOTE
Drop is not a storage mechanism, as all messages will be stored on the server for a maximum of 7 days. Due to this temporary lifespan, all messages should be assumed to be ephemeral.
:::

## Self-Hosting

As Drop requires a centralized server, Caido provides the default message broker service at `drop.cai.do`. All messages sent via Drop are encrypted using the public key of the recipient before they reach the server.

However, for users with privacy concerns or organizations that must be in compliance with regulations, it is possible to [host your own Drop API server](https://github.com/caido-community/drop/blob/main/packages/server/README.md).
2 changes: 1 addition & 1 deletion src/app/tutorials/litellm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In this tutorial, you will learn how to configure LiteLLM, Caido, and [Shift](/a

## LiteLLM Configuration

The following Docker compose file runs two services: LiteLLM and a PostgreSQL database for chat history persistence.
The following Docker Compose file runs two services: LiteLLM and a PostgreSQL database for chat history persistence.

1. Save the following `docker-compose.yml` file and navigate to its directory:

Expand Down