Caido

How to make plugin

Create a new repository using the Caido’s starterkit-plugin GitHub template feature. Then, you can install dependencies and build it using the following command.

# Install dependencies
pnpm install

# Build, you can find script.js in dist directory
pnpm build

Now, you’re ready to start coding and create features. You can easily add UI components using predefined functions and objects.

// src/index.ts

import { Caido } from "@caido/sdk-frontend";
import { helper } from "./helper";

Caido.commands.register("my-sample-command", {
  name: "My Sample Command",
  run: () => {
    helper();
  },
});

Caido.commandPalette.register("my-sample-command");

// Make myapp page
Caido.navigation.addPage("myapp", "")

// Add myapp to sidebar
Caido.sidebar.registerItem("Open App", "/myapp", "")

Workflows

Types

  • Passive Workflow
  • Active Workflow
  • Convert Workflow

Javascript codes

// $active_start.request
// $active_start.response

request.getBody()
request.getHeader()
request.getHeaders()
request.getHost()
request.getId()
request.getMethod()
request.getPort()
request.getQuery()
request.getTls()


response.getBody()
response.getCode()
response.getHeader()
response.getHeaders()
response.getId()

My articles