8000 Issues: #178, #179, #180 by ninjeeter · Pull Request #181 · caido/documentation · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Issues: #178, #179, #180 #181

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 4 commits into from
May 27, 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
8 changes: 8 additions & 0 deletions .vitepress/sidebars/guides.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
},
],
},
{
text: "Guest Mode",
link: "/guides/guest_mode",
},
],
},
{
Expand All @@ -42,6 +46,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
{
text: "Network",
items: [
{
text: "Domain Allowlist",
link: "/guides/domain_allowlist",
},
{
text: "Proxying Local Traffic",
link: "/guides/proxy_local",
Expand Down
4 changes: 4 additions & 0 deletions .vitepress/sidebars/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ - 10000 8,6 +8,10 @@ export const referenceSidebar: DefaultTheme.SidebarItem[] = [
text: "Introduction",
link: "/reference/",
},
{
text: "CLI Options",
link: "/reference/cli",
},
{
text: "Environment",
link: "/reference/environment",
Expand Down
Binary file added src/_images/guest_mode_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/guest_mode_setting.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/instance_settings_allowed_domains.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/plugin_component_config.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/unallowed_domain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions src/guides/domain_allowlist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Domain Allowlist

For security, only defined domains can access the Caido API and interface.

<img alt="Desktop Allowed Domains setting." src="/_images/unallowed_domain.png" center/>

For instance, when utilizing a domain that resolves to `127.0.0.1` for [proxying local traffic](/guides/proxy_local.md), the domain must be added to the `Allowed Domains` list.

## Desktop Application

In the Caido desktop application, this list can be found within your Instance settings.

<img alt="Desktop Allowed Domains setting." src="/_images/instance_settings_allowed_domains.png" center/>

## CLI

When using the Caido CLI, to add a domain to the allowlist, use `--ui-domain=` to specify the addition:

```
--ui-domain=example.com
```

## Docker

To add a domain to the allowlist when running the Caido Docker image, you need to override the default command with:

```
docker run caido/caido caido-cli --no-renderer-sandbox --no-open --listen 0.0.0.0:8080 --ui-domain=example.com
```

Or you can override the Docker Compose:

```
services:
caido:
image: caido/caido
command: ["caido-cli", "--no-renderer-sandbox", "--no-open", "--listen", "0.0.0.0:8080", "--ui-domain", "example.com"]
```
34 changes: 34 additions & 0 deletions src/guides/guest_mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Guest Mode

::: warning
In Guest mode, anybody can access your instance without authentication. This means that binding to 0.0.0.0 would, for example, allow anybody on the same network as you to use it and have full RCE on your machine.
:::

Caido can be used without an account in Guest Mode by selecting the `Continue as guest` option in the authentication prompt.

<img alt="Guest Mode selection." src="/_images/guest_mode_selection.png" center/>

Guest Mode is enabled by default in the desktop application via the `Allow guests` option within the `Advanced` dropdown selection in your Instance settings.

<img alt="Guest Mode setting." src="/_images/guest_mode_setting.png" center/>

Guest Mode is disabled by default in the Caido CLI, and must be explicitly enabled with the use of the `--allow-guests` option.

## Guest Mode Limitations

When using Caido in Guest Mode, there are certain limitations compared to an authenticated session:

- No [Projects](/guides/projects.md) are saved.
- All user settings are shared between all guests such as: Custom Developer Settings, [HTTPQL](/reference/httpql.md) queries, and [layout customization](/concepts/essentials/layout.md).

::: info
Shared Guest Mode settings are not shared with your account. This includes plugin component configurations. For instance, you will have to manually enable/disable the frontend/backend components.

<img alt="Guest Mode plugin configuration." src="/_images/plugin_component_config.png" center/>
:::

- You are limited to a single plugin.

::: tip
[Register an account](https://dashboard.caido.io/signup) and use an authenticated session to gain the ability to save two Projects and utilize up to three plugins.
:::
24 changes: 24 additions & 0 deletions src/reference/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# CLI Options

To view the options available to the Caido CLI, use `-h` or `--help`.

``` txt
Options:
-l, --listen <ADDR:PORT> Listening address
--invisible Enable invisible mode for all listeners
--proxy-listen <ADDR:PORT> Proxy listening addresses
--ui-listen <ADDR:PORT> UI listening addresses
--ui-domain <UI_DOMAIN> Allowed domains for UI
--no-open Do not open the UI a browser tab
--debug Record and display debug logs
--reset-cache Reset the instance cache of cloud data
--reset-credentials Reset the instance credentials (DANGEROUS)
--data-path <DATA_PATH> Directory to store data
--no-logging Disable file logging
--no-renderer-sandbox Disable sandboxing for the renderer
--import-ca-cert <IMPORT_CA_CERT> Import CA certificate
--import-ca-cert-pass <IMPORT_CA_CERT_PASS> Import CA certificate password
--allow-guests Allow login as guest
-h, --help Print help (see more with '--help')
-V, --version Print version
```
Loading
0