Skip to content

sam8k/urLLM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyRIT ↔ Burp Suite Integration

A comprehensive integration framework that enables Microsoft PyRIT (Python Red Team Intelligence Toolkit) orchestrations to run directly from Burp Suite via a FastAPI server. This project provides a seamless bridge between Burp Suite's web application security testing capabilities and PyRIT's AI-powered red teaming automation.

🚀 Features

  • Burp Suite Extension: Custom Java extension that integrates with Burp Suite's Montoya API
  • FastAPI Server: RESTful API server that handles PyRIT orchestration requests
  • Real-time Integration: Execute PyRIT operations directly from Burp Suite interface
  • Modular Architecture: Clean separation between Burp extension and PyRIT server components
  • Configurable Workflows: Support for custom PyRIT orchestration scenarios

📁 Project Structure

pyrit-burp-integration/
├── burp-extension/          # Burp Suite Java extension
│   ├── src/main/java/
│   │   └── com/pyrit/burp/
│   │       ├── PyritExtension.java
│   │       └── PyritTab.java
│   ├── build.gradle
│   └── settings.gradle
├── server/                  # FastAPI server
│   ├── adapters/
│   │   ├── pyrit_adapter.py
│   │   └── run_store.py
│   ├── models/
│   │   └── schemas.py
│   ├── app.py
│   └── requirements.txt
├── examples/               # Configuration examples
│   └── config.env.example
└── scripts/               # Utility scripts
    └── run_server.sh

🛠️ Prerequisites

  • Java 11+ (for Burp Suite extension)
  • Python 3.8+ (for FastAPI server)
  • Burp Suite Professional (with Montoya API support)
  • PyRIT installed and configured

📦 Installation

1. Clone the Repository

git clone https://github.com/sam8k/urLLM.git
cd urLLM

2. Setup FastAPI Server

cd server
pip install -r requirements.txt

3. Build Burp Extension

cd burp-extension
./gradlew build

🚀 Quick Start

1. Start the FastAPI Server

cd server
python app.py

The server will start on http://localhost:8000

2. Load Burp Extension

  1. Open Burp Suite Professional
  2. Go to ExtensionsInstalled
  3. Click Add and select the built JAR file from burp-extension/build/libs/
  4. The PyRIT tab will appear in Burp Suite

3. Configure Environment

Copy the example configuration:

cp examples/config.env.example server/.env

Edit the .env file with your PyRIT configuration.

🔧 Configuration

Environment Variables

Create a .env file in the server/ directory:

# PyRIT Configuration
PYRIT_API_KEY=your_pyrit_api_key
PYRIT_BASE_URL=https://your-pyrit-instance.com

# Server Configuration
HOST=0.0.0.0
PORT=8000
DEBUG=true

# Burp Suite Integration
BURP_API_KEY=your_burp_api_key

📚 API Endpoints

The FastAPI server provides the following endpoints:

  • GET /health - Server health check
  • POST /orchestrate - Execute PyRIT orchestration
  • GET /runs - List previous orchestration runs
  • GET /runs/{run_id} - Get specific run details

🔌 Burp Extension Features

The Burp Suite extension provides:

  • PyRIT Tab: Dedicated interface for PyRIT operations
  • Request Integration: Send Burp requests to PyRIT for analysis
  • Response Processing: Handle PyRIT orchestration results
  • Configuration Management: Manage PyRIT settings within Burp

🧪 Usage Examples

Basic Orchestration

  1. Capture a request in Burp Suite
  2. Right-click and select "Send to PyRIT"
  3. Choose orchestration type
  4. View results in the PyRIT tab

Custom Workflows

  1. Configure custom PyRIT orchestrations
  2. Use the API endpoints for programmatic access
  3. Integrate with existing security testing workflows

🔒 Security Considerations

  • Store API keys securely
  • Use HTTPS in production
  • Implement proper authentication
  • Validate all inputs
  • Monitor API usage

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Microsoft PyRIT team for the excellent red teaming framework
  • PortSwigger for Burp Suite and the Montoya API
  • FastAPI community for the robust web framework

📞 Support

For issues and questions:

  • Create an issue on GitHub
  • Check the documentation in each component
  • Review the example configurations

Note: This integration requires Burp Suite Professional and a valid PyRIT installation. Ensure compliance with your organization's security policies before deployment.

About

Universal Red Teaming Framework for Large Language Models

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors