Skip to content

Submitting a Report ​

To report a bug or receive support, please contact a member of the Caido team by submitting a contact form or send us a message on Discord and be prepared to provide the following resources/information.

TIP

Your issue may already be known, resolved, or a feature request has been made! Search for it here:

Setup Information ​

We will typically need the following information for every case. Please provide us with your:

  • Operating system.
  • Version number/name.
  • Caido client in use (CLI/desktop application/web application).
  • The version of Caido in use.
  • Both log files that include the issue.

EXAMPLE

I am using:

  • OS: Mac OS
  • OS Version: 12 (Monterey)
  • Caido Client: Caido Desktop
  • Caido Version: 0.33.0

Log Files ​

As Caido utilizes a client/server architecture, both frontend and backend logs are produced.

DANGER

As log files can contain sensitive information, only send them in private conversations with a verified member of the Caido team. If you are contacting us on Discord, we will open a private channel before asking for logs.

NOTE

Ensure to enable debug mode to assist with troubleshooting.

Backend Logs ​

To obtain the backend log files of your instance, navigate to the /logs subdirectory of the data storage directory. The default location of this directory is dependent on your operating system:

OSLocation
Linux~/.local/share/caido
MacOS~/Library/Application\ Support/io.caido.Caido/
Windows%APPDATA%\caido\Caido\data

Frontend Logs ​

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.

  • Click on the Logs button at the bottom of the Caido user-interface, record your activity, and then click on the 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.

The Caido frontend logs interface.

Steps to Reproduce ​

In order to assist you, it is critical that you provide a detailed timeline of the exact steps you took leading up to the bug. This ensures we are able to reproduce the issue in an accurate and timely manner.

EXAMPLE

To reproduce the bug, follow these steps:

  1. In the Intercept interface, click on the Response button.
  2. Begin intercepting responses, by clicking on the Forwarding button to toggle it to Queuing.
  3. In a terminal, execute curl -x 127.0.0.1:8080 https://example.com.
  4. Modify status code of the intercepted response.
  5. Click the Forward button.
  6. Confirm in terminal that the response was not modified.

Submit a Github Issue ​

DANGER

Ensure to remove/redact any sensitive information in submissions.

Feel free to create a new issue on Github. For simplicity, a template is provided with sections to provide all the necessary information.