Registry / security / burp-rpc

burp-rpc

JSON →
library1.0.6jsnpmunverified

Control Burp Suite programmatically from Node.js over gRPC — proxy history, repeater, site map, and more. v1.0.6 (stable, monthly releases), full TypeScript types, requires Burp extension, uses gRPC (port 50051). Differentiator: native gRPC vs REST alternatives, low-latency control.

npm install burp-rpc
INSTALL
IMPORT
SIG · BURP-RPC
B
burp-rpc
securityjavascriptv1.0.6
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

BurpClient
import { BurpClient } from 'burp-rpc'
const BurpClient = require('burp-rpc').BurpClient
ESM only (node >=18); CommonJS require works but destructure properly.
decodeBase64Body
import { decodeBase64Body } from 'burp-rpc'
import decodeBase64Body from 'burp-rpc'
This is a named export, not default.
BurpProxy
import { BurpProxy } from 'burp-rpc'
import { BurpProxy } from 'burp-rpc/proxy'
All types are exported from the main package entry.

Connect to Burp Suite gRPC service, fetch last 5 proxy history entries, send to Repeater, fire raw request, and query site map.

import { BurpClient, decodeBase64Body } from 'burp-rpc'; const burp = new BurpClient({ host: process.env.BURP_RPC_HOST ?? 'localhost', port: 50051 }); const recent = await burp.proxy.getLastN(5); for (const entry of recent) { console.log(decodeBase64Body(entry.request.rawBytesBase64)); } await burp.repeater.sendFromHistory(recent[0], 'My Tab'); const res = await burp.http.sendRawRequest( 'example.com', 443, true, 'GET / HTTP/1.1\r\nHost: example.com\r\n\r\n' ); console.log('Status:', res.hasResponse); const sites = await burp.siteMap.getEntries(); burp.close();
Debug
Known issues
gotchaMust have Burp extension running; otherwise gRPC connection fails silently.
fix
Load burp-rpc extension in Burp before running Node.js scripts.
affects: >=1.0.0
gotchaburp.close() must be called to allow process exit; otherwise Node.js hangs.
fix
Always call burp.close() after operations, or use process.on('exit').
affects: >=1.0.0
gotchaProxy history entries may be empty if Burp proxy is not intercepting traffic.
fix
Configure Burp proxy to capture HTTP traffic.
affects: >=1.0.0
Errors
Common errors & fixes
Error: 14 UNAVAILABLE: failed to connect to all addresses
Burp gRPC extension not running or wrong host/port.
fix
Ensure Burp extension is loaded and listening on 0.0.0.0:50051.
TypeError: burp.proxy is undefined
Using default import (BurpClient) without new keyword or incorrect instantiation.
fix
Use new BurpClient() correctly.
Error: Cannot find module 'burp-rpc'
Package not installed or wrong import path.
fix
Run 'npm install burp-rpc' and ensure import path is correct.
Upgrade
Version history
1.0.6latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
32 hits · last 30 days
node
28
OpenAI (training)
1
Resources
burp-rpc — npm install burp-rpc · libregistry