Skip to content

Installation and Setup

WebbinRoot edited this page Mar 9, 2026 · 1 revision

Installation and Setup

Requirements

  • Burp Suite version with Montoya API support
  • Java 21+ for local builds
  • Match the release artifact to your runtime (for example, jdk21 jar for Java 21 runtime)

Install from GitHub Releases (Recommended)

  1. Download the latest OCISigner release from:
  2. Pick the jar compiled for your Burp Java runtime:
    • *-jdk[VERSION].jar for Burp running on Java VERSION
  3. In Burp, go to Extensions -> Installed -> Add.

Burp Extensions Installed tab

Figure 1. Burp Extensions tab with Add action.

4. Find the JAR downloaded from releases on the local filesystem.

Select downloaded release JAR

Figure 2. File picker selecting release JAR.

5. Set `Extension type` to `Java`, then select the downloaded release jar.

Extension load parameters

Figure 3. Extension load dialog before confirming.

6. Click `Next` and confirm the extension appears in the Installed list.

Loaded extension in Installed list

Figure 4. OCISigner loaded in Burp Extensions list.

Build Locally and Install

  1. Build:
mvn clean package
  1. In Burp: Extensions -> Installed -> Add.
  2. Set Extension type to Java.
  3. Select target/OCISigner-*-all.jar.

Post-Install Verification

  1. Confirm a new OCISigner tab appears.
  2. Create a test profile and click Save.
  3. Click Test Credentials for that profile.
  4. Set Always Sign With and send a Repeater request.
  5. Confirm request contains an Authorization signature header.

Recommended First-Time Setup

  1. Start with Config Profile (Auto) if you already use OCI CLI profiles.
  2. Set a valid Region in the profile if your auth mode requires endpoint checks.
  3. Leave Update timestamp enabled.
  4. Keep Only sign in-scope requests enabled to avoid accidental cross-host signing.

Common Issues

Extension does not load

  • Verify Java runtime compatibility with the selected jar.
  • Use a jdk[VERSION] release build if Burp runs Java [VERSION].

Test Credentials returns missing fields

  • Validate required profile fields for the selected auth type.
  • For Config Profile, verify both config path and profile name.

Proxy traffic not signed

Check all of the following:

  • Signing Enabled is on
  • Always Sign With is set
  • Only sign in-scope requests does not filter target
  • Only sign if Authorization exists is set as intended

Config profile import finds nothing

  • Auto import checks only ~/.oci/config.
  • Use File import if your config is elsewhere.