diff --git a/.gitignore b/.gitignore
index 32858aa..3983136 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,10 @@
*.class
+# project files
+.idea
+build
+dist
+
# Mobile Tools for Java (J2ME)
.mtj.tmp/
diff --git a/README.md b/README.md
index 60e3df1..00e756b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,71 @@
# ExtendedMacro
-ExtendedMacro - BurpSuite plugin providing extended macro functionality
+ExtendedMacro is plug-in for BurpSuite proxy. It provides similar but extended functionality of BurpSuite Macro feature. The main functionality is, that you are able to trigger one or more request before every request triggered from Intruder, Repeater, Scanner, Sequencer or Spider (except tools Proxy and Extender). You can extract data from arbitrary response of the request and replace or add data to the following request (replace CSRF token, session, add new header ...).
+
+It is still in development, so please don't be angry if something getting wrong, rather let me know to fix it ;).
+
+## Features
+- create sequence of the request to be triggered before the every request call
+- extract data from arbitrary response
+- paste extracted data into arbitrary following request
+ - from the sequence
+ - into the last request (Intruder, Repeater, Scanner, Sequencer or Spider)
+- create new header
+- changing order of the requests
+
+## Advantages against the BurpSuite Macro
+- ability to replace arbitrary string in the request
+- ability to add new header into the request
+- easier configuration than macro (does not seems to be, but it is ;))
+
+## About the UI
+The plug-in adds new tab into the BurpSuite named "ExtendedMacro". It contains several tabs: "Main", "Logger" and "Settings".
+
+### Main
+In the main window you are able to configure all the magic. The left part of the view is the "Extraction message list" and the right part is the "Replace message list".
+
+#### Extraction message list
+Here you can set up what requests will be triggered and what data will be extracted from their responses. After selecting the message, you can set the extraction by the selection of the response.
+
+#### Replace message list
+Here you can set up what data from extraction will be added/replaced in the following requests. The replace string can be set by the selection of the request.
+
+## How to
+1. Select messages e,g, in the Proxy tab, do right mouse click and select "Send to ExtendedMacro"
+2. go to ExtendedMacro and click on the message in the "Extraction message list"
+3. select data from the response editor
+4. click "From selection" button
+5. set extraction name and click "Add" button
+6. click on the message in the "Replace message list"
+7. select data from the request editor and click "From selection" button
+8. set replace name and type (replace on the selected message)
+9. select the extraction
+10. click replaces "Add" button
+11. now you are done and your request will be triggered, you can see it in the "Logger" tab.
+
+## Screen-shots
+
+Main
+
+
+
+Logger
+
+
+
+Settings
+
+
+
+Video https://www.youtube.com/watch?v=IwKa0F7MmTM
+
+[](https://www.youtube.com/watch?v=IwKa0F7MmTM)
+
+# Contribution
+Feel free to create pull request or issues.
+
+# Donation
+Thank you very much and enjoy :).
+
+| PayPal | Bitcoin |
+| ------ | ------- |
+| [](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=P6JB98K7TNJNG&lc=SK&item_number=ExtendedMacro¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted) | 
19YoCcuruuovPFxDVfVWLVSBqhdPeUHtb5 |
diff --git a/build.sh b/build.sh
new file mode 100755
index 0000000..7f6daed
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd $DIR
+
+date
+[ -e build ] || mkdir -v build
+[ -e dist ] || mkdir -v dist
+cd src/
+javac -Xlint:unchecked -d ../build/ burp/BurpExtender.java
+
+cd ../build/
+jar -cf ../dist/extendedmacro.jar burp/*.class
+
+echo "Output: ${DIR}/dist/extendedmacro.jar"
diff --git a/images/donation-bitcoin.png b/images/donation-bitcoin.png
new file mode 100644
index 0000000..22b5f2a
Binary files /dev/null and b/images/donation-bitcoin.png differ
diff --git a/screenshot/logger.png b/screenshot/logger.png
new file mode 100644
index 0000000..fe78bc3
Binary files /dev/null and b/screenshot/logger.png differ
diff --git a/screenshot/main.png b/screenshot/main.png
new file mode 100644
index 0000000..85906d9
Binary files /dev/null and b/screenshot/main.png differ
diff --git a/screenshot/settings.png b/screenshot/settings.png
new file mode 100644
index 0000000..46c60f5
Binary files /dev/null and b/screenshot/settings.png differ
diff --git a/src/burp/BurpExtender.java b/src/burp/BurpExtender.java
new file mode 100644
index 0000000..52f23f9
--- /dev/null
+++ b/src/burp/BurpExtender.java
@@ -0,0 +1,783 @@
+package burp;
+
+import javax.swing.*;
+import java.awt.*;
+import java.io.PrintWriter;
+import java.util.*;
+import java.util.List;
+
+/**
+ * Created by fruh on 8/30/16.
+ */
+
+public class BurpExtender implements IBurpExtender, IHttpListener, IContextMenuFactory, ITab {
+ private static String EXTENSION_NAME = "ExtendedMacro";
+ private static String VERSION = "v0.0.1-alpha";
+ public PrintWriter stdout;
+ public PrintWriter stderr;
+ public IExtensionHelpers helpers;
+ private IBurpExtenderCallbacks callbacks;
+ private MessagesTable extMessagesTable;
+ private MessagesTable repMessagesTable;
+ private JPanel mainPanel;
+ private MessagesModel messagesModel;
+ private IMessageEditor extRequestEditor;
+ private IMessageEditor extResponseEditor;
+ private IMessageEditor repRequestEditor;
+ private IMessageEditor repResponseEditor;
+ private MessagesController extMessagesController;
+ private MessagesController repMessagesController;
+ private Set actualCallRepSet; /// what to replace in last call
+ private ExtractionModel extractionModel;
+ private ExtractionTable extractionTable;
+ private ReplaceModel replaceModel;
+ private ReplaceTable replaceTable;
+ private JButton repCreateButton;
+ private JButton repFromSelectionButton;
+ private JTabbedPane mainTabPane;
+
+ private JTextArea startStringField;
+ private JTextArea stopStringField;
+ private JTextArea extractedStringField;
+ private JTextField extractionNameStringField;
+ private JButton extCreateButton;
+ private JButton extFromSelectionButton;
+
+ private JTextArea replaceStringField;
+ private JComboBox replaceType;
+ private JTextField replaceNameStringField;
+ private int msgId = 0;
+ private int msgIdLogger = 0;
+
+ private MessagesModel loggerMessagesModel;
+
+ private JCheckBox repeater;
+ private JCheckBox intruder;
+ private JCheckBox scanner;
+ private JCheckBox sequencer;
+ private JCheckBox spider;
+
+ @Override
+ public void registerExtenderCallbacks(IBurpExtenderCallbacks iBurpExtenderCallbacks) {
+ callbacks = iBurpExtenderCallbacks;
+ helpers = callbacks.getHelpers();
+
+ actualCallRepSet = new HashSet<>();
+
+ // obtain our output stream
+ stdout = new PrintWriter(callbacks.getStdout(), true);
+ stderr = new PrintWriter(callbacks.getStderr(), true);
+
+ callbacks.setExtensionName(EXTENSION_NAME);
+
+ initGui();
+
+ // register callbacks
+ callbacks.registerHttpListener(this);
+ callbacks.registerContextMenuFactory(this);
+
+ // init gui callbacks
+ callbacks.addSuiteTab(this);
+
+ stdout.println("[*] " + EXTENSION_NAME + " " + VERSION);
+ }
+
+ public String getNextMsgId() {
+ return String.valueOf(++msgId);
+ }
+
+ public String getNextMsgIdLogger() {
+ return String.valueOf(++msgIdLogger);
+ }
+
+ private void initGui() {
+ mainTabPane = new JTabbedPane();
+
+ mainPanel = new JPanel();
+ mainPanel.setLayout(new GridLayout(3, 2));
+
+ messagesModel = new MessagesModel(this.helpers);
+
+ // extraction messages table
+ extMessagesTable = new MessagesTable(this, false);
+ extMessagesTable.setModel(messagesModel);
+ extMessagesTable.setAutoResizeMode(JTable.AUTO_RESIZE_LAST_COLUMN);
+ extMessagesTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+ extMessagesTable.getTableHeader().getColumnModel().getColumn(0).setMaxWidth(100);
+ extMessagesTable.getTableHeader().getColumnModel().getColumn(1).setPreferredWidth(200);
+ extMessagesTable.getTableHeader().getColumnModel().getColumn(2).setMaxWidth(100);
+ extMessagesTable.getTableHeader().getColumnModel().getColumn(3).setPreferredWidth(800);
+
+ messagesModel.setExtMsgTable(extMessagesTable);
+
+ // popup menu for messages
+ JPopupMenu extPopupMenu = new JPopupMenu();
+ extPopupMenu.add("Remove").addActionListener(
+ new MenuListener(this, MenuActions.A_REMOVE_MSG, extMessagesTable));
+ extPopupMenu.add("Remove all").addActionListener(
+ new MenuListener(this, MenuActions.A_REMOVE_ALL, extMessagesTable));
+ extPopupMenu.add("Move up").addActionListener(
+ new MenuListener(this, MenuActions.A_MOVE_UP_EXT, extMessagesTable));
+ extPopupMenu.add("Move down").addActionListener(
+ new MenuListener(this, MenuActions.A_MOVE_DOWN_EXT, extMessagesTable));
+
+ extMessagesTable.setComponentPopupMenu(extPopupMenu);
+
+ // create controller
+ extMessagesController = new MessagesController(extMessagesTable);
+ extRequestEditor = callbacks.createMessageEditor(extMessagesController, false);
+ extResponseEditor = callbacks.createMessageEditor(extMessagesController, false);
+
+ extMessagesTable.setReq(extRequestEditor);
+ extMessagesTable.setRes(extResponseEditor);
+ extMessagesTable.setCtrl(extMessagesController);
+
+ JTabbedPane extMessagesTabs = new JTabbedPane();
+ extMessagesTabs.addTab("Request", extRequestEditor.getComponent());
+ extMessagesTabs.addTab("Response", extResponseEditor.getComponent());
+ extMessagesTabs.setSelectedIndex(1);
+
+ JScrollPane extMsgScrollPane = new JScrollPane(extMessagesTable);
+ JTabbedPane extMessagesTab = new JTabbedPane();
+ extMessagesTab.addTab("Extraction message list", extMsgScrollPane);
+
+ mainPanel.add(extMessagesTab);
+
+ // replace messages table
+ repMessagesTable = new MessagesTable(this, false);
+ repMessagesTable.setModel(messagesModel);
+ repMessagesTable.setAutoResizeMode(JTable.AUTO_RESIZE_LAST_COLUMN);
+ repMessagesTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+ repMessagesTable.getTableHeader().getColumnModel().getColumn(0).setMaxWidth(100);
+ repMessagesTable.getTableHeader().getColumnModel().getColumn(1).setPreferredWidth(200);
+ repMessagesTable.getTableHeader().getColumnModel().getColumn(2).setMaxWidth(100);
+ repMessagesTable.getTableHeader().getColumnModel().getColumn(3).setPreferredWidth(800);
+
+ messagesModel.setRepMsgTable(repMessagesTable);
+
+ JPopupMenu repPopupMenu = new JPopupMenu();
+ repPopupMenu.add("Remove").addActionListener(new MenuListener(this, MenuActions.A_REMOVE_MSG, repMessagesTable));
+ repPopupMenu.add("Remove all").addActionListener(new MenuListener(this, MenuActions.A_REMOVE_ALL, repMessagesTable));
+ repPopupMenu.add("Move up").addActionListener(new MenuListener(this, MenuActions.A_MOVE_UP_REP, repMessagesTable));
+ repPopupMenu.add("Move down").addActionListener(new MenuListener(this, MenuActions.A_MOVE_DOWN_REP, repMessagesTable));
+
+ repMessagesTable.setComponentPopupMenu(repPopupMenu);
+
+ // create controller
+ repMessagesController = new MessagesController(repMessagesTable);
+ repRequestEditor = callbacks.createMessageEditor(repMessagesController, false);
+ repResponseEditor = callbacks.createMessageEditor(repMessagesController, false);
+// repRespEditor = callbacks.createTextEditor();
+
+ repMessagesTable.setReq(repRequestEditor);
+ repMessagesTable.setRes(repResponseEditor);
+ repMessagesTable.setCtrl(repMessagesController);
+
+
+ JTabbedPane repMessagesTabs = new JTabbedPane();
+ repMessagesTabs.addTab("Request", repRequestEditor.getComponent());
+ repMessagesTabs.addTab("Response", repResponseEditor.getComponent());
+
+ JScrollPane repMsgScrollPane = new JScrollPane(repMessagesTable);
+ JTabbedPane repMessagesTab = new JTabbedPane();
+ repMessagesTab.addTab("Replace message list", repMsgScrollPane);
+
+ mainPanel.add(repMessagesTab);
+
+ // add editor tabs
+ mainPanel.add(extMessagesTabs);
+ mainPanel.add(repMessagesTabs);
+
+ // extraction panel
+ JPanel extractionPanel = new JPanel();
+ extractionPanel.setLayout(new GridLayout(0, 2));
+ extractionModel = new ExtractionModel(this);
+ extractionTable = new ExtractionTable(this);
+ extractionTable.setModel(extractionModel);
+ extractionTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+
+ messagesModel.setExtractionTable(extractionTable);
+
+ JPopupMenu extConfPopupMenu = new JPopupMenu();
+ extConfPopupMenu.add("Remove").addActionListener(new ConfigListener(this, ConfigActions.A_DELETE_SEL_EXT));
+ extConfPopupMenu.add("Remove all").addActionListener(new ConfigListener(this, ConfigActions.A_DELETE_ALL_EXT));
+
+ extractionTable.setComponentPopupMenu(extConfPopupMenu);
+
+ JTabbedPane extTab = new JTabbedPane();
+ JScrollPane extScrollPane = new JScrollPane(extractionTable);
+ extractionPanel.add(extScrollPane);
+ extTab.addTab("Extraction configuration", extractionPanel);
+
+ JPanel extButtonsPane = new JPanel();
+ extButtonsPane.setLayout(new GridLayout(0, 2));
+
+ startStringField = new JTextArea();
+ stopStringField = new JTextArea();
+ extractedStringField = new JTextArea();
+ extractionNameStringField = new JTextField();
+
+ startStringField.getDocument().addDocumentListener(
+ new ConfigChangedListener(this, ConfigActions.A_EXT_CONFIG_CHANGED));
+ stopStringField.getDocument().addDocumentListener(
+ new ConfigChangedListener(this, ConfigActions.A_EXT_CONFIG_CHANGED));
+ extractionNameStringField.getDocument().addDocumentListener(
+ new ConfigChangedListener(this, ConfigActions.A_EXT_VALIDITY));
+ getExtractedStringField().setEditable(false);
+
+ extButtonsPane.add(new JLabel("Name:"));
+ extButtonsPane.add(extractionNameStringField);
+ extButtonsPane.add(new JLabel("Start string:"));
+ extButtonsPane.add(startStringField);
+ extButtonsPane.add(new JLabel("Stop string:"));
+ extButtonsPane.add(stopStringField);
+ extButtonsPane.add(new JLabel("Extracted string:"));
+ extButtonsPane.add(extractedStringField);
+
+ extCreateButton = new JButton("Add");
+ extCreateButton.setEnabled(false);
+ extFromSelectionButton = new JButton("From selection");
+ extFromSelectionButton.setEnabled(true);
+
+ extCreateButton.addActionListener(new ConfigListener(this, ConfigActions.A_CREATE_NEW_EXT));
+ extFromSelectionButton.addActionListener(new ConfigListener(this, ConfigActions.A_EXT_FROM_SELECTION));
+
+ extButtonsPane.add(extCreateButton);
+ extButtonsPane.add(extFromSelectionButton);
+
+ extractionPanel.add(extButtonsPane);
+ mainPanel.add(extTab);
+
+ // replace panel
+ JPanel replacePanel = new JPanel();
+ replacePanel.setLayout(new GridLayout(0, 2));
+ replaceModel = new ReplaceModel(this);
+ replaceTable = new ReplaceTable(this);
+ replaceTable.setModel(replaceModel);
+ replaceTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+
+ messagesModel.setReplaceTable(replaceTable);
+
+ JPopupMenu repConfPopupMenu = new JPopupMenu();
+ repConfPopupMenu.add("Remove").addActionListener(new ConfigListener(this, ConfigActions.A_DELETE_SEL_REP));
+ repConfPopupMenu.add("Remove all").addActionListener(new ConfigListener(this, ConfigActions.A_DELETE_ALL_REP));
+
+ replaceTable.setComponentPopupMenu(repConfPopupMenu);
+
+ JTabbedPane repTab = new JTabbedPane();
+ JScrollPane repScrollPane = new JScrollPane(replaceTable);
+ replacePanel.add(repScrollPane);
+ repTab.addTab("Replace configuration", replacePanel);
+
+ JPanel replaceButtonsPane = new JPanel();
+ replaceButtonsPane.setLayout(new GridLayout(0, 2));
+
+ replaceStringField = new JTextArea();
+ replaceType = new JComboBox<>();
+ replaceType.addItem("Replace on selected");
+ replaceType.addItem("Add new header on selected");
+ replaceType.addItem("Replace on last request");
+ replaceType.addItem("Add new header on last request");
+ replaceNameStringField = new JTextField();
+
+ replaceType.addActionListener(new ConfigChangedListener(this, ConfigActions.A_REP_CONFIG_CHANGED));
+ replaceStringField.getDocument().addDocumentListener(
+ new ConfigChangedListener(this, ConfigActions.A_REP_CONFIG_CHANGED));
+ replaceNameStringField.getDocument().addDocumentListener(
+ new ConfigChangedListener(this, ConfigActions.A_REP_CONFIG_CHANGED));
+
+ replaceButtonsPane.add(new JLabel("Name:"));
+ replaceButtonsPane.add(replaceNameStringField);
+ replaceButtonsPane.add(new JLabel("Type:"));
+ replaceButtonsPane.add(replaceType);
+ replaceButtonsPane.add(new JLabel("Replace/Header name:"));
+ replaceButtonsPane.add(replaceStringField);
+
+ repCreateButton = new JButton("Add");
+ repCreateButton.setEnabled(false);
+ repFromSelectionButton = new JButton("From selection");
+ repFromSelectionButton.setEnabled(true);
+
+ repCreateButton.addActionListener(new ConfigListener(this, ConfigActions.A_CREATE_NEW_REP));
+ repFromSelectionButton.addActionListener(new ConfigListener(this, ConfigActions.A_REP_FROM_SELECTION));
+
+ replaceButtonsPane.add(repCreateButton);
+ replaceButtonsPane.add(repFromSelectionButton);
+
+ replacePanel.add(replaceButtonsPane);
+ mainPanel.add(repTab);
+
+ mainTabPane.addTab("Main window", mainPanel);
+
+ // Logger pane
+ loggerMessagesModel = new MessagesModel(this.helpers);
+
+ // logger messages table
+ MessagesTable loggerMessagesTable = new MessagesTable(this, true);
+ loggerMessagesTable.setModel(loggerMessagesModel);
+ loggerMessagesTable.setAutoResizeMode(JTable.AUTO_RESIZE_LAST_COLUMN);
+ loggerMessagesTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+ loggerMessagesTable.getTableHeader().getColumnModel().getColumn(0).setMaxWidth(200);
+ loggerMessagesTable.getTableHeader().getColumnModel().getColumn(0).setPreferredWidth(100);
+ loggerMessagesTable.getTableHeader().getColumnModel().getColumn(1).setPreferredWidth(100);
+ loggerMessagesTable.getTableHeader().getColumnModel().getColumn(2).setMaxWidth(100);
+ loggerMessagesTable.getTableHeader().getColumnModel().getColumn(3).setPreferredWidth(800);
+
+ JScrollPane loggerMsgScrollPane = new JScrollPane(loggerMessagesTable);
+
+ // create controller
+ MessagesController loggerMessagesController = new MessagesController(loggerMessagesTable);
+ IMessageEditor loggerRequestEditor = callbacks.createMessageEditor(loggerMessagesController, false);
+ IMessageEditor loggerResponseEditor = callbacks.createMessageEditor(loggerMessagesController, false);
+
+ loggerMessagesTable.setReq(loggerRequestEditor);
+ loggerMessagesTable.setRes(loggerResponseEditor);
+ loggerMessagesTable.setCtrl(loggerMessagesController);
+
+ JPopupMenu loggerPopupMenu = new JPopupMenu();
+ loggerPopupMenu.add("Remove all").addActionListener(
+ new MenuListener(this, MenuActions.A_REMOVE_ALL, loggerMessagesTable));
+ loggerMessagesTable.setComponentPopupMenu(loggerPopupMenu);
+
+ JSplitPane logger = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
+// logger.setLayout(new GridLayout(0, 1));
+
+ JPanel loggerMessagesEditorPanel = new JPanel();
+ loggerMessagesEditorPanel.setLayout(new GridLayout(0, 2));
+
+ JTabbedPane loggerReq = new JTabbedPane();
+ loggerReq.addTab("Request", loggerRequestEditor.getComponent());
+
+ JTabbedPane loggerRes = new JTabbedPane();
+ loggerRes.add("Response", loggerResponseEditor.getComponent());
+
+ loggerMessagesEditorPanel.add(loggerReq);
+ loggerMessagesEditorPanel.add(loggerRes);
+
+ logger.add(loggerMsgScrollPane);
+ logger.add(loggerMessagesEditorPanel);
+
+ mainTabPane.addTab("Logger", logger);
+
+ // configuration tab
+ JPanel confPanel = new JPanel();
+ JLabel settingsTool = new JLabel("Select what tools are enabled:");
+ repeater = new JCheckBox("Repeater");
+ intruder = new JCheckBox("Intruder");
+ scanner = new JCheckBox("Scanner");
+ sequencer = new JCheckBox("Sequencer");
+ spider = new JCheckBox("Spider");
+ JButton enDisTool = new JButton("All/None");
+
+ repeater.setSelected(true);
+ intruder.setSelected(true);
+ scanner.setSelected(true);
+ sequencer.setSelected(true);
+ spider.setSelected(true);
+
+ enDisTool.addActionListener(new ConfigListener(this, ConfigActions.A_ENABLE_DISABLE));
+
+ confPanel.add(settingsTool);
+ confPanel.add(enDisTool);
+ confPanel.add(repeater);
+ confPanel.add(intruder);
+ confPanel.add(scanner);
+ confPanel.add(sequencer);
+ confPanel.add(spider);
+
+ mainTabPane.addTab("Settings", confPanel);
+ }
+
+ public boolean isEnabledAtLeatOne() {
+ return intruder.isSelected() ||
+ repeater.isSelected() ||
+ scanner.isSelected() ||
+ sequencer.isSelected() ||
+ spider.isSelected();
+ }
+
+ public void setAllTools(boolean enabled) {
+ repeater.setSelected(enabled);
+ intruder.setSelected(enabled);
+ scanner.setSelected(enabled);
+ sequencer.setSelected(enabled);
+ spider.setSelected(enabled);
+ }
+
+
+ public boolean isToolEnabled(int toolFlag) {
+ switch (toolFlag) {
+ case IBurpExtenderCallbacks.TOOL_INTRUDER:
+ return intruder.isSelected();
+
+ case IBurpExtenderCallbacks.TOOL_REPEATER:
+ return repeater.isSelected();
+
+ case IBurpExtenderCallbacks.TOOL_SCANNER:
+ return scanner.isSelected();
+
+ case IBurpExtenderCallbacks.TOOL_SEQUENCER:
+ return sequencer.isSelected();
+
+ case IBurpExtenderCallbacks.TOOL_SPIDER:
+ return spider.isSelected();
+ }
+ return false;
+ }
+
+ @Override
+ public void processHttpMessage(int toolFlag, boolean messageIsRequest, IHttpRequestResponse messageInfo) {
+ // ignore disabled tools and check if it is turned on
+ if (!isToolEnabled(toolFlag)) {
+ return;
+ }
+ if (messageIsRequest) {
+// stdout.println("[*] Processing request");
+
+ // get list of requests
+ List messages = messagesModel.getMessages();
+ String newRequest;
+ String extractedData;
+
+ for (Message m:messages) {
+ newRequest = new String(m.getMessageInfo().getRequest());
+
+ // there is something to replace
+ if (m.hasReplace()) {
+ for (String repId: m.getRepRefSet()) {
+ newRequest = replaceModel.getReplaceById(repId).replaceData(m.getMessageInfo(), helpers);
+ }
+ }
+ // make updated request
+ IHttpRequestResponse newMsgInfo = callbacks.makeHttpRequest(
+ m.getMessageInfo().getHttpService(), newRequest.getBytes());
+ // log message
+ loggerMessagesModel.addMessage(newMsgInfo, getNextMsgIdLogger());
+
+ // there is something to extract from received response
+ if (m.hasExtraction()) {
+ for (String extId: m.getExtRefSet()) {
+ extractedData = extractionModel.getExtractionById(extId).extractData(
+ new String(newMsgInfo.getResponse()));
+ // update replace references
+ for (String repId:extractionModel.getExtractionById(extId).getRepRefSet()) {
+ replaceModel.getReplaceById(repId).setDataToPaste(extractedData);
+ }
+ }
+ }
+ }
+ // replace data in the last request, it is not in the message list
+ for (Replace rep:replaceModel.getReplacesLast()) {
+ newRequest = rep.replaceData(messageInfo, helpers);
+ messageInfo.setRequest(newRequest.getBytes());
+ }
+ }
+ else {
+ // TODO: the sequnce is not correct in multihreaded
+ String fromTool = "UNKNOWN TOOL";
+
+ switch (toolFlag) {
+ case IBurpExtenderCallbacks.TOOL_INTRUDER:
+ fromTool = "INTRUDER";
+
+ break;
+ case IBurpExtenderCallbacks.TOOL_REPEATER:
+ fromTool = "REPEATER";
+
+ break;
+ case IBurpExtenderCallbacks.TOOL_SCANNER:
+ fromTool = "SCANNER";
+
+ break;
+ case IBurpExtenderCallbacks.TOOL_SEQUENCER:
+ fromTool = "SEQUENCER";
+
+ break;
+ case IBurpExtenderCallbacks.TOOL_SPIDER:
+ fromTool = "SPIDER";
+
+ break;
+ case IBurpExtenderCallbacks.TOOL_PROXY:
+ fromTool = "PROXY";
+
+ break;
+ }
+ // log response
+ loggerMessagesModel.addMessage(messageInfo, getNextMsgIdLogger() + " " + fromTool);
+ }
+ }
+
+ @Override
+ public List createMenuItems(IContextMenuInvocation invocation) {
+ IHttpRequestResponse[] messages = invocation.getSelectedMessages();
+ stdout.println("[*] processing menu");
+
+ if (messages.length > 0) {
+ List menu = new LinkedList<>();
+ JMenuItem sendTo = new JMenuItem("Send to " + EXTENSION_NAME);
+ sendTo.addActionListener(new MenuListener(this, messages, MenuActions.A_SEND_TO_EM, getExtMessagesTable()));
+
+ menu.add(sendTo);
+
+ return menu;
+ }
+ return null;
+ }
+
+ @Override
+ public String getTabCaption() {
+ return EXTENSION_NAME;
+ }
+
+ @Override
+ public Component getUiComponent() {
+ return mainTabPane;
+ }
+
+ public JTextArea getStartStringField() {
+ return startStringField;
+ }
+
+ public JTextArea getStopStringField() {
+ return stopStringField;
+ }
+
+ public JTextArea getExtractedStringField() {
+ return extractedStringField;
+ }
+
+ public JTextField getExtractionNameStringField() {
+ return extractionNameStringField;
+ }
+
+ public JTextArea getReplaceStringField() {
+ return replaceStringField;
+ }
+
+ public JComboBox getReplaceType() {
+ return replaceType;
+ }
+
+ public JTextField getReplaceNameStringField() {
+ return replaceNameStringField;
+ }
+
+ public MessagesTable getExtMessagesTable() {
+ return extMessagesTable;
+ }
+
+ public MessagesTable getRepMessagesTable() {
+ return repMessagesTable;
+ }
+
+ public IMessageEditor getExtResponseEditor() {
+ return extResponseEditor;
+ }
+
+ public MessagesController getExtMessagesController() {
+ return extMessagesController;
+ }
+
+ public MessagesController getRepMessagesController() {
+ return repMessagesController;
+ }
+
+ public MessagesModel getMessagesModel() {
+ return messagesModel;
+ }
+
+ public ExtractionModel getExtractionModel() {
+ return extractionModel;
+ }
+
+ public ReplaceModel getReplaceModel() {
+ return replaceModel;
+ }
+
+ public ExtractionTable getExtractionTable() {
+ return extractionTable;
+ }
+
+ public ReplaceTable getReplaceTable() {
+ return replaceTable;
+ }
+
+ public void setEnabledExtCreateButton() {
+ extCreateButton.setEnabled(isValidExtraction());
+ }
+
+ public void setEnabledRepCreateButton() {
+ repCreateButton.setEnabled(isValidReplace());
+ }
+
+ /**
+ * Check whether it is possible to create extraction point.
+ * @return
+ */
+ public boolean isValidExtraction() {
+ if (extMessagesTable.getSelectedRow() >= 0 &&
+ !extractionNameStringField.getText().isEmpty() &&
+ !startStringField.getText().isEmpty() &&
+ !stopStringField.getText().isEmpty() &&
+ !getExtractedStringField().getText().isEmpty() &&
+ !getExtractedStringField().getText().equals("EXTRACTION_ERROR")) {
+ return true;
+ }
+ else {
+ return false;
+ }
+ }
+
+ /**
+ * Check whether it is possible to create replace rule. The replace message must be selected and must be
+ * after the current extraction message. The extraction must be selected.
+ * The name (id) and the replace string must be set.
+ * @return
+ */
+ public boolean isValidReplace() {
+ int repMsgRow = repMessagesTable.getSelectedRow();
+ int extRow = extractionTable.getSelectedRow();
+ boolean ignore_rep_row = false;
+
+ if (replaceType.getSelectedItem().toString() == Replace.TYPE_ADD_LAST ||
+ replaceType.getSelectedItem().toString() == Replace.TYPE_REP_LAST) {
+ ignore_rep_row = true;
+ }
+
+ if ((repMsgRow >= 0 || ignore_rep_row) &&
+ !replaceNameStringField.getText().isEmpty() &&
+ !replaceStringField.getText().isEmpty() &&
+ extRow >= 0
+ ) {
+ int extMsgRow = ((MessagesModel)extMessagesTable.getModel()).getRowById(
+ extractionModel.getExtraction(extRow).getMsgId());
+ // replacing or adding header, must be selected only the following message
+ if ((replaceType.getSelectedItem().toString() == Replace.TYPE_ADD_SEL ||
+ replaceType.getSelectedItem().toString() == Replace.TYPE_REP_SEL) &&
+ // trying to replace in the previous or same message
+ repMsgRow <= extMsgRow) {
+ stdout.println("[-] Can not replace on previous or same message.");
+
+ return false;
+ }
+ return canBeReplacedOnSelected();
+ }
+ return false;
+ }
+
+ public boolean canBeReplacedOnSelected() {
+ if (replaceType.getSelectedItem().toString() == Replace.TYPE_REP_SEL) {
+ Message msg = repMessagesController.getSelectedMessage();
+
+ if (msg != null) {
+// ITextEditor textEditor = (ITextEditor)repRequestEditor.getComponent().getClass().getClasses();
+// repRespEditor.setSearchExpression(replaceStringField.getText());
+ // TODO: set search string
+
+ String request = new String(msg.getMessageInfo().getRequest());
+ int index = request.indexOf(replaceStringField.getText());
+
+ if (index < 0) {
+ replaceStringField.setBackground(Color.red);
+
+ return false;
+ }
+ }
+ }
+ return true;
+ }
+
+ public void setReplaceStringBackground() {
+ if (canBeReplacedOnSelected()) {
+ replaceStringField.setBackground(Color.white);
+ }
+ else {
+ replaceStringField.setBackground(Color.red);
+ }
+ }
+
+ public boolean canBeMoved(MenuActions direction) {
+ boolean ret = true;
+ Message msg;
+ int row;
+
+ switch (direction) {
+ case A_MOVE_UP_EXT:
+ msg = extMessagesController.getSelectedMessage();
+ row = extMessagesTable.getSelectedRow();
+
+ if (msg != null) {
+ for (String repId: msg.getRepRefSet()) {
+ String extMsgId = replaceModel.getReplaceById(repId).getExt().getMsgId();
+ // can not be moved up because it gets data from previous msg
+ if (row - 1 <= messagesModel.getRowById(extMsgId)) {
+ stdout.println(
+ "[-] Message can not be moved up, because of getting data from previous msg");
+ ret = false;
+ break;
+ }
+ }
+ }
+ break;
+
+ case A_MOVE_UP_REP:
+ msg = repMessagesController.getSelectedMessage();
+ row = repMessagesTable.getSelectedRow();
+
+ if (msg != null) {
+ for (String repId: msg.getRepRefSet()) {
+ String extMsgId = replaceModel.getReplaceById(repId).getExt().getMsgId();
+ // can not be moved up because it gets data from previous msg
+ if (row - 1 <= messagesModel.getRowById(extMsgId)) {
+ stdout.println(
+ "[-] Message can not be moved up, because of getting data from previous msg");
+ ret = false;
+ break;
+ }
+ }
+ }
+ break;
+
+ case A_MOVE_DOWN_EXT:
+ msg = extMessagesController.getSelectedMessage();
+ row = extMessagesTable.getSelectedRow();
+
+ if (msg != null) {
+ for (String extId: msg.getExtRefSet()) {
+ String extMsgId = extractionModel.getExtractionById(extId).getMsgId();
+ // can not be moved down, because of extracting data for following msg
+ if (row + 1 >= messagesModel.getRowById(extMsgId)) {
+ stdout.println(
+ "[-] Message can not be moved down, because of extracting data for following msg");
+ ret = false;
+ break;
+ }
+ }
+ }
+ break;
+
+ case A_MOVE_DOWN_REP:
+ msg = repMessagesController.getSelectedMessage();
+ row = repMessagesTable.getSelectedRow();
+
+ if (msg != null) {
+ for (String extId: msg.getExtRefSet()) {
+ String extMsgId = extractionModel.getExtractionById(extId).getMsgId();
+ // can not be moved down, because of extracting data for following msg
+ if (row + 1 >= messagesModel.getRowById(extMsgId)) {
+ stdout.println(
+ "[-] Message can not be moved down, because of extracting data for following msg");
+ ret = false;
+ break;
+ }
+ }
+ }
+ break;
+ }
+ return ret;
+ }
+
+ public IMessageEditor getRepRequestEditor() {
+ return repRequestEditor;
+ }
+}
diff --git a/src/burp/ConfigActions.java b/src/burp/ConfigActions.java
new file mode 100644
index 0000000..029bd92
--- /dev/null
+++ b/src/burp/ConfigActions.java
@@ -0,0 +1,22 @@
+package burp;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public enum ConfigActions {
+ A_CREATE_NEW_EXT,
+ A_DELETE_SEL_EXT,
+ A_DELETE_ALL_EXT,
+ A_CREATE_NEW_REP,
+ A_DELETE_SEL_REP,
+ A_DELETE_ALL_REP,
+ A_SEL_CHANGED_EXT,
+ A_SEL_CHANGED_REP,
+ A_START_STOP_CHANGED,
+ A_EXT_CONFIG_CHANGED,
+ A_REP_CONFIG_CHANGED,
+ A_EXT_VALIDITY,
+ A_EXT_FROM_SELECTION,
+ A_REP_FROM_SELECTION,
+ A_ENABLE_DISABLE
+}
diff --git a/src/burp/ConfigChangedListener.java b/src/burp/ConfigChangedListener.java
new file mode 100644
index 0000000..d873c85
--- /dev/null
+++ b/src/burp/ConfigChangedListener.java
@@ -0,0 +1,74 @@
+package burp;
+
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+/**
+ * Created by fruh on 9/27/16.
+ */
+public class ConfigChangedListener implements DocumentListener, ActionListener {
+ private BurpExtender extender;
+ private ConfigActions action;
+
+ public ConfigChangedListener(BurpExtender extender, ConfigActions action) {
+ this.extender = extender;
+ this.action = action;
+ }
+
+ @Override
+ public void insertUpdate(DocumentEvent documentEvent) {
+ textChanged();
+ }
+
+ @Override
+ public void removeUpdate(DocumentEvent documentEvent) {
+ textChanged();
+ }
+
+ @Override
+ public void changedUpdate(DocumentEvent documentEvent) {
+ textChanged();
+ }
+
+ public void textChanged() {
+ switch (action) {
+ case A_EXT_CONFIG_CHANGED:
+ Message msg = extender.getExtMessagesController().getSelectedMessage();
+
+ if (msg != null) {
+ String response = new String(msg.getMessageInfo().getResponse());
+ String start = extender.getStartStringField().getText();
+ String stop = extender.getStopStringField().getText();
+
+ String extracted_data = Extraction.extractData(response, start, stop);
+ extender.getExtractedStringField().setText(extracted_data);
+ }
+ extender.setEnabledExtCreateButton();
+ break;
+
+ case A_EXT_VALIDITY:
+ extender.setEnabledExtCreateButton();
+
+ break;
+
+ case A_REP_CONFIG_CHANGED:
+ extender.setEnabledRepCreateButton();
+ extender.setReplaceStringBackground();
+
+ break;
+ }
+ }
+
+ @Override
+ public void actionPerformed(ActionEvent actionEvent) {
+ switch (action) {
+ case A_REP_CONFIG_CHANGED:
+ extender.setEnabledRepCreateButton();
+ extender.setReplaceStringBackground();
+
+ break;
+ }
+ }
+}
diff --git a/src/burp/ConfigListener.java b/src/burp/ConfigListener.java
new file mode 100644
index 0000000..382303a
--- /dev/null
+++ b/src/burp/ConfigListener.java
@@ -0,0 +1,226 @@
+package burp;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.util.Map;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public class ConfigListener implements ActionListener {
+ private ConfigActions action;
+ private BurpExtender extender;
+
+ public ConfigListener(BurpExtender extender, ConfigActions action) {
+ this.extender = extender;
+ this.action = action;
+ }
+
+ public boolean isDigit(String s) {
+ try {
+ Integer.parseInt(s);
+
+ return true;
+ }
+ catch (NumberFormatException e) {
+ return false;
+ }
+ }
+
+ public String getNextExtName(String name, Map all) {
+ if (all.get(name) == null) {
+ return name;
+ }
+ int c;
+ String[] splitted = name.split(" ");
+ String first_part = splitted[0];
+
+ if (splitted.length > 1 && isDigit(splitted[1])) {
+ c = Integer.parseInt(splitted[1]);
+
+ while (all.get(name) != null) {
+ name = first_part + " " + ++c;
+ }
+ }
+ else {
+ c = 1;
+ name = first_part + " " + c;
+
+ while (all.get(name) != null) {
+ name = first_part + " " + ++c;
+ }
+ }
+ return name;
+ }
+
+ public String getNextRepName(String name, Map all) {
+ if (all.get(name) == null) {
+ return name;
+ }
+ int c;
+ String[] splitted = name.split(" ");
+ String first_part = splitted[0];
+
+ if (splitted.length > 1 && isDigit(splitted[1])) {
+ c = Integer.parseInt(splitted[1]);
+
+ while (all.get(name) != null) {
+ name = first_part + " " + ++c;
+ }
+ }
+ else {
+ c = 1;
+ name = first_part + " " + c;
+
+ while (all.get(name) != null) {
+ name = first_part + " " + ++c;
+ }
+ }
+ return name;
+ }
+
+ @Override
+ public void actionPerformed(ActionEvent actionEvent) {
+ int row;
+
+ switch (action) {
+ case A_CREATE_NEW_EXT:
+ if (extender.isValidExtraction()) {
+ extender.stdout.println("[*] Creating extraction point");
+ String name = extender.getExtractionNameStringField().getText();
+ name = getNextExtName(name, extender.getExtractionModel().getExtModelMap());
+ extender.getExtractionNameStringField().setText(name);
+
+ Extraction ext = new Extraction(extender.getStartStringField().getText(),
+ extender.getStopStringField().getText());
+ Message selectedMessage = extender.getExtMessagesController().getSelectedMessage();
+
+ selectedMessage.getExtRefSet().add(name);
+ ext.setId(name);
+ ext.setMsgId(selectedMessage.getId());
+
+ extender.getExtractionModel().addExtraction(ext);
+ extender.stdout.println("[+] Adding new extraction: " + ext);
+ }
+ break;
+
+ case A_SEL_CHANGED_EXT:
+// if (extender.getExtractComboBox().getSelectedItem() != null) {
+// Extraction extModel = extender.getExtModelMap().get(
+// extender.getExtractComboBox().getSelectedItem());
+// extender.getExtractionNameStringField().setText(extModel.getId());
+// extender.getStartStringField().setText(extModel.getStartString());
+// extender.getStopStringField().setText(extModel.getStopString());
+// extender.getExtMessagesTable().setSelectionById(extModel.getMsgId());
+// }
+ break;
+
+ case A_CREATE_NEW_REP:
+ row = extender.getRepMessagesTable().getSelectedRow();
+ if (extender.isValidReplace()) {
+ extender.stdout.println("[*] Creating replace point" + row);
+ String name = extender.getReplaceNameStringField().getText();
+ name = getNextRepName(name, extender.getReplaceModel().getRepModelMap());
+ extender.getReplaceNameStringField().setText(name);
+
+ Extraction ext = extender.getExtractionModel().getExtraction(
+ extender.getExtractionTable().getSelectedRow());
+ Replace rep = new Replace(name, extender.getReplaceStringField().getText(),
+ extender.getReplaceType().getSelectedItem().toString(), ext);
+ ext.getRepRefSet().add(name);
+
+ // set rep messageId and reference to msg
+ if (extender.getReplaceType().getSelectedItem().toString() == Replace.TYPE_ADD_SEL ||
+ extender.getReplaceType().getSelectedItem().toString() == Replace.TYPE_REP_SEL) {
+ Message selectedMsg = extender.getRepMessagesController().getSelectedMessage();
+ selectedMsg.getRepRefSet().add(rep.getId());
+ rep.setMsgId(selectedMsg.getId());
+
+ extender.getReplaceModel().addReplace(rep);
+ }
+ else {
+ extender.getReplaceModel().addReplaceLast(rep);
+ }
+ extender.stdout.println("[+] Adding new replace: " + rep);
+ }
+ break;
+
+ case A_SEL_CHANGED_REP:
+// if (extender.getReplaceComboBox().getSelectedItem() != null) {
+// Replace repModel = extender.getRepModelMap().get(
+// extender.getReplaceComboBox().getSelectedItem());
+// extender.getReplaceNameStringField().setText(repModel.getId());
+// extender.getReplaceStringField().setText(repModel.getReplaceStr());
+// extender.getRepMessagesTable().setSelectionById(repModel.getMsgId());
+// }
+ break;
+
+ case A_START_STOP_CHANGED:
+ if (!extender.getStartStringField().getText().isEmpty() &&
+ !extender.getStopStringField().getText().isEmpty() &&
+ extender.getExtMessagesTable().getSelectedRow() >= 0) {
+ extender.getExtractedStringField().setText(Extraction.extractData(
+ extender.getExtMessagesController().getSelectedMessageInfo().getResponse().toString(),
+ extender.getStartStringField().getText(),
+ extender.getStopStringField().getText()
+ ));
+ }
+ break;
+
+ case A_DELETE_SEL_EXT:
+ if (extender.getExtractionTable().getSelectedRow() >= 0) {
+ extender.getExtractionModel().removeRow(extender.getExtractionTable().getSelectedRow());
+ }
+ break;
+
+ case A_DELETE_SEL_REP:
+ if (extender.getReplaceTable().getSelectedRow() >= 0) {
+ extender.getReplaceModel().removeRow(extender.getReplaceTable().getSelectedRow());
+ }
+ break;
+
+ case A_DELETE_ALL_EXT:
+ extender.getExtractionModel().removeAll();
+ break;
+
+ case A_DELETE_ALL_REP:
+ extender.getReplaceModel().removeAll();
+ break;
+
+ case A_EXT_FROM_SELECTION:
+ String startStop[] = null;
+
+ if (extender.getExtResponseEditor().getSelectedData() != null) {
+ String selected = new String(extender.getExtResponseEditor().getSelectedData());
+ startStop = ExtStringCreator.getStartStopString(selected,
+ new String(extender.getExtResponseEditor().getMessage()));
+ }
+ if (startStop != null) {
+ extender.getStartStringField().setText(startStop[0]);
+ extender.getStopStringField().setText(startStop[1]);
+ }
+ else {
+ extender.getStartStringField().setText("");
+ extender.getStopStringField().setText("");
+ extender.getExtractedStringField().setText("");
+ }
+ break;
+
+ case A_REP_FROM_SELECTION:
+ if (extender.getRepRequestEditor().getSelectedData() != null) {
+ extender.getReplaceStringField().setText(
+ new String(extender.getRepRequestEditor().getSelectedData()));
+ }
+ else {
+ extender.getReplaceStringField().setText("");
+ }
+
+ break;
+
+ case A_ENABLE_DISABLE:
+ extender.setAllTools(!extender.isEnabledAtLeatOne());
+
+ break;
+ }
+ }
+}
diff --git a/src/burp/ExtStringCreator.java b/src/burp/ExtStringCreator.java
new file mode 100644
index 0000000..7443340
--- /dev/null
+++ b/src/burp/ExtStringCreator.java
@@ -0,0 +1,73 @@
+package burp;
+
+/**
+ * Created by fruh on 10/7/16.
+ */
+public class ExtStringCreator {
+ private static final int STEP = 8;
+
+ public static String[] getStartStopString(String selectedText, String wholeText) {
+ String[] ret = new String[2];
+ ret[0] = ret[1] = null;
+
+ if (selectedText.equals("") || selectedText == null) {
+ return null;
+ }
+ int startIndex = wholeText.indexOf(selectedText);
+ int stopIndex = startIndex + selectedText.length();
+ int sI = moveIndex(startIndex, true, wholeText.length());
+ int eI = moveIndex(stopIndex, false, wholeText.length());
+
+ int tmpsI;
+ int tmpeI;
+ boolean changed = true;
+ while (changed) {
+ ret[0] = wholeText.substring(sI, startIndex);
+ ret[1] = wholeText.substring(stopIndex, eI);
+
+ // we found what is selected
+ if (selectedText.equals(Extraction.extractData(wholeText, ret[0], ret[1]))) {
+ break;
+ }
+ else {
+ ret[0] = ret[1] = null;
+ }
+ tmpsI = sI;
+ sI = moveIndex(startIndex, true, wholeText.length());
+
+ tmpeI = eI;
+ eI = moveIndex(stopIndex, false, wholeText.length());
+
+ // if something changing or not
+ if (tmpeI == eI && tmpsI == sI) {
+ changed = false;
+ }
+ }
+ if (ret[0] == null) {
+ return null;
+ }
+ return ret;
+ }
+
+ public static int moveIndex(int index, boolean isStart, int textLen) {
+ int tmp = STEP + 1;
+
+ if (isStart) {
+ while (--tmp > 0) {
+ if (index - tmp >= 0) {
+ index -= tmp;
+ break;
+ }
+ }
+ }
+ else {
+ while (--tmp > 0) {
+ if (index + tmp < textLen) {
+ index += tmp;
+ break;
+ }
+ }
+ }
+ return index;
+ }
+}
diff --git a/src/burp/Extraction.java b/src/burp/Extraction.java
new file mode 100644
index 0000000..4e0f39e
--- /dev/null
+++ b/src/burp/Extraction.java
@@ -0,0 +1,75 @@
+package burp;
+
+import java.util.HashSet;
+import java.util.Set;
+import java.util.regex.Pattern;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public class Extraction {
+ private String startString;
+ private String stopString;
+ private String msgId;
+ private String id;
+ private Set repRefSet;
+
+ public Extraction(String startString, String stopString) {
+ this.startString = startString;
+ this.stopString = stopString;
+ repRefSet = new HashSet<>();
+ }
+
+ public String extractData(String response) {
+ return Extraction.extractData(response, startString, stopString);
+ }
+
+ public static String extractData(String response, String startString, String stopString) {
+ String ret = "EXTRACTION_ERROR";
+ int index_of_start = response.indexOf(startString);
+
+ if (index_of_start >= 0) {
+ String tmp_part = response.substring(index_of_start + startString.length());
+
+ int index_of_stop = tmp_part.indexOf(stopString);
+
+ if (index_of_stop >= 0) {
+ ret = tmp_part.substring(0, index_of_stop);
+ }
+ }
+ return ret;
+ }
+
+ public String getStartString() {
+ return startString;
+ }
+
+ public String getStopString() {
+ return stopString;
+ }
+
+ public Set getRepRefSet() {
+ return repRefSet;
+ }
+
+ public String getMsgId() {
+ return msgId;
+ }
+
+ public void setMsgId(String msgId) {
+ this.msgId = msgId;
+ }
+
+ public String getId() {
+ return id;
+ }
+
+ public void setId(String id) {
+ this.id = id;
+ }
+
+ @Override
+ public String toString() {
+ return "'" + id + "', '" + startString + "', '" + stopString + "', '" + msgId + "'";
+ }
+}
diff --git a/src/burp/ExtractionModel.java b/src/burp/ExtractionModel.java
new file mode 100644
index 0000000..df7f94c
--- /dev/null
+++ b/src/burp/ExtractionModel.java
@@ -0,0 +1,134 @@
+package burp;
+
+import javax.swing.table.AbstractTableModel;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Created by fruh on 9/8/16.
+ */
+public class ExtractionModel extends AbstractTableModel {
+ private List extractions;
+ private Map extModelMap;
+ private String[] cols = {"Name", "MsgID"};
+ private BurpExtender extender;
+
+ public ExtractionModel(BurpExtender extender) {
+ extractions = new LinkedList<>();
+ extModelMap = new HashMap<>();
+ this.extender = extender;
+ }
+
+ @Override
+ public int getRowCount() {
+ return extractions.size();
+ }
+
+ @Override
+ public int getColumnCount() {
+ return cols.length;
+ }
+
+ @Override
+ public String getColumnName(int index) {
+ if (index < cols.length) {
+ return cols[index];
+ }
+ return null;
+ }
+
+ public Extraction getExtraction(int i) {
+ if (i >= 0 && i < extractions.size()) {
+ return extractions.get(i);
+ }
+ return null;
+ }
+
+ public Extraction getExtractionById(String id) {
+ return extModelMap.get(id);
+ }
+
+ @Override
+ public Object getValueAt(int row, int col) {
+ String ret;
+
+ switch (col) {
+ case 0:
+ ret = getExtraction(row).getId();
+ break;
+
+ case 1:
+ ret = String.valueOf(getExtraction(row).getMsgId());
+ break;
+
+ default:
+ ret = null;
+ break;
+ }
+ return ret;
+ }
+
+ public void remove(String id) {
+ int row = getRowById(id);
+ removeRow(row);
+ }
+
+ public void removeRow(int row) {
+ Extraction e = extractions.get(row);
+
+ // remove extraction reference
+ extender.getMessagesModel().getMessageById(e.getMsgId()).getExtRefSet().remove(e.getId());
+
+ for (String r:e.getRepRefSet()) {
+ extender.getReplaceModel().remove(r);
+ }
+ extModelMap.remove(extractions.get(row).getId());
+ extractions.remove(row);
+;
+ fireTableRowsDeleted(row, row);
+ }
+
+ public void removeAll() {
+// for (Extraction e:extractions) {
+// for (Message m : extender.getMessagesModel().getMessages()) {
+// m.getExtRefSet().remove(e.getMsgId());
+// }
+// }
+ for (Message m : extender.getMessagesModel().getMessages()) {
+ m.getExtRefSet().clear();
+ }
+ extractions.clear();
+ extModelMap.clear();
+
+ // delete references
+ extender.getReplaceModel().removeAll();
+
+ fireTableDataChanged();
+ }
+
+ public int getRowById(String id) {
+ int row = -1;
+
+ if (extractions.size() > 0) {
+ for (row = 0; row < extractions.size(); row++) {
+ if (id == extractions.get(row).getId()) {
+ break;
+ }
+ }
+ }
+ return row;
+ }
+
+ public void addExtraction(Extraction ext) {
+ this.extractions.add(ext);
+ extModelMap.put(ext.getId(), ext);
+
+ fireTableRowsInserted(extractions.size() - 1, extractions.size() - 1);
+ }
+
+ public Map getExtModelMap() {
+ return extModelMap;
+ }
+}
diff --git a/src/burp/ExtractionTable.java b/src/burp/ExtractionTable.java
new file mode 100644
index 0000000..f040cbf
--- /dev/null
+++ b/src/burp/ExtractionTable.java
@@ -0,0 +1,37 @@
+package burp;
+
+import javax.swing.*;
+
+/**
+ * Created by fruh on 9/8/16.
+ */
+public class ExtractionTable extends JTable {
+ private BurpExtender extender;
+ private ConfigChangedListener textChangedListener;
+
+ public ExtractionTable(BurpExtender extender) {
+ this.extender = extender;
+ textChangedListener = new ConfigChangedListener(extender, ConfigActions.A_EXT_CONFIG_CHANGED);
+ }
+
+ @Override
+ public void changeSelection(int i, int i1, boolean b, boolean b1) {
+ super.changeSelection(i, i1, b, b1);
+
+ if (i >= 0) {
+ Extraction ext = ((ExtractionModel) getModel()).getExtraction(i);
+
+ extender.getExtMessagesTable().setSelectionById(ext.getMsgId());
+ extender.getExtractionNameStringField().setText(ext.getId());
+ extender.getStartStringField().setText(ext.getStartString());
+ extender.getStopStringField().setText(ext.getStopString());
+ }
+ textChangedListener.textChanged();
+ }
+
+ public void setSelectionById(String id) {
+ ExtractionModel model = (ExtractionModel) getModel();
+
+ changeSelection(model.getRowById(id), 0, false, false);
+ }
+}
\ No newline at end of file
diff --git a/src/burp/IBurpExtender.java b/src/burp/IBurpExtender.java
new file mode 100644
index 0000000..fc59f61
--- /dev/null
+++ b/src/burp/IBurpExtender.java
@@ -0,0 +1,31 @@
+package burp;
+
+/*
+ * @(#)IBurpExtender.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * All extensions must implement this interface.
+ *
+ * Implementations must be called BurpExtender, in the package burp, must be
+ * declared public, and must provide a default (public, no-argument)
+ * constructor.
+ */
+public interface IBurpExtender
+{
+ /**
+ * This method is invoked when the extension is loaded. It registers an
+ * instance of the
+ * IBurpExtenderCallbacks interface, providing methods that may
+ * be invoked by the extension to perform various actions.
+ *
+ * @param callbacks An
+ * IBurpExtenderCallbacks object.
+ */
+ void registerExtenderCallbacks(IBurpExtenderCallbacks callbacks);
+}
diff --git a/src/burp/IBurpExtenderCallbacks.java b/src/burp/IBurpExtenderCallbacks.java
new file mode 100644
index 0000000..e162a70
--- /dev/null
+++ b/src/burp/IBurpExtenderCallbacks.java
@@ -0,0 +1,1083 @@
+package burp;
+
+/*
+ * @(#)IBurpExtenderCallbacks.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.Component;
+import java.io.OutputStream;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * This interface is used by Burp Suite to pass to extensions a set of callback
+ * methods that can be used by extensions to perform various actions within
+ * Burp.
+ *
+ * When an extension is loaded, Burp invokes its
+ * registerExtenderCallbacks() method and passes an instance of the
+ * IBurpExtenderCallbacks interface. The extension may then invoke
+ * the methods of this interface as required in order to extend Burp's
+ * functionality.
+ */
+public interface IBurpExtenderCallbacks
+{
+
+ /**
+ * Flag used to identify Burp Suite as a whole.
+ */
+ static final int TOOL_SUITE = 0x00000001;
+ /**
+ * Flag used to identify the Burp Target tool.
+ */
+ static final int TOOL_TARGET = 0x00000002;
+ /**
+ * Flag used to identify the Burp Proxy tool.
+ */
+ static final int TOOL_PROXY = 0x00000004;
+ /**
+ * Flag used to identify the Burp Spider tool.
+ */
+ static final int TOOL_SPIDER = 0x00000008;
+ /**
+ * Flag used to identify the Burp Scanner tool.
+ */
+ static final int TOOL_SCANNER = 0x00000010;
+ /**
+ * Flag used to identify the Burp Intruder tool.
+ */
+ static final int TOOL_INTRUDER = 0x00000020;
+ /**
+ * Flag used to identify the Burp Repeater tool.
+ */
+ static final int TOOL_REPEATER = 0x00000040;
+ /**
+ * Flag used to identify the Burp Sequencer tool.
+ */
+ static final int TOOL_SEQUENCER = 0x00000080;
+ /**
+ * Flag used to identify the Burp Decoder tool.
+ */
+ static final int TOOL_DECODER = 0x00000100;
+ /**
+ * Flag used to identify the Burp Comparer tool.
+ */
+ static final int TOOL_COMPARER = 0x00000200;
+ /**
+ * Flag used to identify the Burp Extender tool.
+ */
+ static final int TOOL_EXTENDER = 0x00000400;
+
+ /**
+ * This method is used to set the display name for the current extension,
+ * which will be displayed within the user interface for the Extender tool.
+ *
+ * @param name The extension name.
+ */
+ void setExtensionName(String name);
+
+ /**
+ * This method is used to obtain an IExtensionHelpers object,
+ * which can be used by the extension to perform numerous useful tasks.
+ *
+ * @return An object containing numerous helper methods, for tasks such as
+ * building and analyzing HTTP requests.
+ */
+ IExtensionHelpers getHelpers();
+
+ /**
+ * This method is used to obtain the current extension's standard output
+ * stream. Extensions should write all output to this stream, allowing the
+ * Burp user to configure how that output is handled from within the UI.
+ *
+ * @return The extension's standard output stream.
+ */
+ OutputStream getStdout();
+
+ /**
+ * This method is used to obtain the current extension's standard error
+ * stream. Extensions should write all error messages to this stream,
+ * allowing the Burp user to configure how that output is handled from
+ * within the UI.
+ *
+ * @return The extension's standard error stream.
+ */
+ OutputStream getStderr();
+
+ /**
+ * This method prints a line of output to the current extension's standard
+ * output stream.
+ *
+ * @param output The message to print.
+ */
+ void printOutput(String output);
+
+ /**
+ * This method prints a line of output to the current extension's standard
+ * error stream.
+ *
+ * @param error The message to print.
+ */
+ void printError(String error);
+
+ /**
+ * This method is used to register a listener which will be notified of
+ * changes to the extension's state. Note: Any extensions that start
+ * background threads or open system resources (such as files or database
+ * connections) should register a listener and terminate threads / close
+ * resources when the extension is unloaded.
+ *
+ * @param listener An object created by the extension that implements the
+ * IExtensionStateListener interface.
+ */
+ void registerExtensionStateListener(IExtensionStateListener listener);
+
+ /**
+ * This method is used to retrieve the extension state listeners that are
+ * registered by the extension.
+ *
+ * @return A list of extension state listeners that are currently registered
+ * by this extension.
+ */
+ List getExtensionStateListeners();
+
+ /**
+ * This method is used to remove an extension state listener that has been
+ * registered by the extension.
+ *
+ * @param listener The extension state listener to be removed.
+ */
+ void removeExtensionStateListener(IExtensionStateListener listener);
+
+ /**
+ * This method is used to register a listener which will be notified of
+ * requests and responses made by any Burp tool. Extensions can perform
+ * custom analysis or modification of these messages by registering an HTTP
+ * listener.
+ *
+ * @param listener An object created by the extension that implements the
+ * IHttpListener interface.
+ */
+ void registerHttpListener(IHttpListener listener);
+
+ /**
+ * This method is used to retrieve the HTTP listeners that are registered by
+ * the extension.
+ *
+ * @return A list of HTTP listeners that are currently registered by this
+ * extension.
+ */
+ List getHttpListeners();
+
+ /**
+ * This method is used to remove an HTTP listener that has been registered
+ * by the extension.
+ *
+ * @param listener The HTTP listener to be removed.
+ */
+ void removeHttpListener(IHttpListener listener);
+
+ /**
+ * This method is used to register a listener which will be notified of
+ * requests and responses being processed by the Proxy tool. Extensions can
+ * perform custom analysis or modification of these messages, and control
+ * in-UI message interception, by registering a proxy listener.
+ *
+ * @param listener An object created by the extension that implements the
+ * IProxyListener interface.
+ */
+ void registerProxyListener(IProxyListener listener);
+
+ /**
+ * This method is used to retrieve the Proxy listeners that are registered
+ * by the extension.
+ *
+ * @return A list of Proxy listeners that are currently registered by this
+ * extension.
+ */
+ List getProxyListeners();
+
+ /**
+ * This method is used to remove a Proxy listener that has been registered
+ * by the extension.
+ *
+ * @param listener The Proxy listener to be removed.
+ */
+ void removeProxyListener(IProxyListener listener);
+
+ /**
+ * This method is used to register a listener which will be notified of new
+ * issues that are reported by the Scanner tool. Extensions can perform
+ * custom analysis or logging of Scanner issues by registering a Scanner
+ * listener.
+ *
+ * @param listener An object created by the extension that implements the
+ * IScannerListener interface.
+ */
+ void registerScannerListener(IScannerListener listener);
+
+ /**
+ * This method is used to retrieve the Scanner listeners that are registered
+ * by the extension.
+ *
+ * @return A list of Scanner listeners that are currently registered by this
+ * extension.
+ */
+ List getScannerListeners();
+
+ /**
+ * This method is used to remove a Scanner listener that has been registered
+ * by the extension.
+ *
+ * @param listener The Scanner listener to be removed.
+ */
+ void removeScannerListener(IScannerListener listener);
+
+ /**
+ * This method is used to register a listener which will be notified of
+ * changes to Burp's suite-wide target scope.
+ *
+ * @param listener An object created by the extension that implements the
+ * IScopeChangeListener interface.
+ */
+ void registerScopeChangeListener(IScopeChangeListener listener);
+
+ /**
+ * This method is used to retrieve the scope change listeners that are
+ * registered by the extension.
+ *
+ * @return A list of scope change listeners that are currently registered by
+ * this extension.
+ */
+ List getScopeChangeListeners();
+
+ /**
+ * This method is used to remove a scope change listener that has been
+ * registered by the extension.
+ *
+ * @param listener The scope change listener to be removed.
+ */
+ void removeScopeChangeListener(IScopeChangeListener listener);
+
+ /**
+ * This method is used to register a factory for custom context menu items.
+ * When the user invokes a context menu anywhere within Burp, the factory
+ * will be passed details of the invocation event, and asked to provide any
+ * custom context menu items that should be shown.
+ *
+ * @param factory An object created by the extension that implements the
+ * IContextMenuFactory interface.
+ */
+ void registerContextMenuFactory(IContextMenuFactory factory);
+
+ /**
+ * This method is used to retrieve the context menu factories that are
+ * registered by the extension.
+ *
+ * @return A list of context menu factories that are currently registered by
+ * this extension.
+ */
+ List getContextMenuFactories();
+
+ /**
+ * This method is used to remove a context menu factory that has been
+ * registered by the extension.
+ *
+ * @param factory The context menu factory to be removed.
+ */
+ void removeContextMenuFactory(IContextMenuFactory factory);
+
+ /**
+ * This method is used to register a factory for custom message editor tabs.
+ * For each message editor that already exists, or is subsequently created,
+ * within Burp, the factory will be asked to provide a new instance of an
+ * IMessageEditorTab object, which can provide custom rendering
+ * or editing of HTTP messages.
+ *
+ * @param factory An object created by the extension that implements the
+ * IMessageEditorTabFactory interface.
+ */
+ void registerMessageEditorTabFactory(IMessageEditorTabFactory factory);
+
+ /**
+ * This method is used to retrieve the message editor tab factories that are
+ * registered by the extension.
+ *
+ * @return A list of message editor tab factories that are currently
+ * registered by this extension.
+ */
+ List getMessageEditorTabFactories();
+
+ /**
+ * This method is used to remove a message editor tab factory that has been
+ * registered by the extension.
+ *
+ * @param factory The message editor tab factory to be removed.
+ */
+ void removeMessageEditorTabFactory(IMessageEditorTabFactory factory);
+
+ /**
+ * This method is used to register a provider of Scanner insertion points.
+ * For each base request that is actively scanned, Burp will ask the
+ * provider to provide any custom scanner insertion points that are
+ * appropriate for the request.
+ *
+ * @param provider An object created by the extension that implements the
+ * IScannerInsertionPointProvider interface.
+ */
+ void registerScannerInsertionPointProvider(
+ IScannerInsertionPointProvider provider);
+
+ /**
+ * This method is used to retrieve the Scanner insertion point providers
+ * that are registered by the extension.
+ *
+ * @return A list of Scanner insertion point providers that are currently
+ * registered by this extension.
+ */
+ List getScannerInsertionPointProviders();
+
+ /**
+ * This method is used to remove a Scanner insertion point provider that has
+ * been registered by the extension.
+ *
+ * @param provider The Scanner insertion point provider to be removed.
+ */
+ void removeScannerInsertionPointProvider(
+ IScannerInsertionPointProvider provider);
+
+ /**
+ * This method is used to register a custom Scanner check. When performing
+ * scanning, Burp will ask the check to perform active or passive scanning
+ * on the base request, and report any Scanner issues that are identified.
+ *
+ * @param check An object created by the extension that implements the
+ * IScannerCheck interface.
+ */
+ void registerScannerCheck(IScannerCheck check);
+
+ /**
+ * This method is used to retrieve the Scanner checks that are registered by
+ * the extension.
+ *
+ * @return A list of Scanner checks that are currently registered by this
+ * extension.
+ */
+ List getScannerChecks();
+
+ /**
+ * This method is used to remove a Scanner check that has been registered by
+ * the extension.
+ *
+ * @param check The Scanner check to be removed.
+ */
+ void removeScannerCheck(IScannerCheck check);
+
+ /**
+ * This method is used to register a factory for Intruder payloads. Each
+ * registered factory will be available within the Intruder UI for the user
+ * to select as the payload source for an attack. When this is selected, the
+ * factory will be asked to provide a new instance of an
+ * IIntruderPayloadGenerator object, which will be used to
+ * generate payloads for the attack.
+ *
+ * @param factory An object created by the extension that implements the
+ * IIntruderPayloadGeneratorFactory interface.
+ */
+ void registerIntruderPayloadGeneratorFactory(
+ IIntruderPayloadGeneratorFactory factory);
+
+ /**
+ * This method is used to retrieve the Intruder payload generator factories
+ * that are registered by the extension.
+ *
+ * @return A list of Intruder payload generator factories that are currently
+ * registered by this extension.
+ */
+ List
+ getIntruderPayloadGeneratorFactories();
+
+ /**
+ * This method is used to remove an Intruder payload generator factory that
+ * has been registered by the extension.
+ *
+ * @param factory The Intruder payload generator factory to be removed.
+ */
+ void removeIntruderPayloadGeneratorFactory(
+ IIntruderPayloadGeneratorFactory factory);
+
+ /**
+ * This method is used to register a custom Intruder payload processor. Each
+ * registered processor will be available within the Intruder UI for the
+ * user to select as the action for a payload processing rule.
+ *
+ * @param processor An object created by the extension that implements the
+ * IIntruderPayloadProcessor interface.
+ */
+ void registerIntruderPayloadProcessor(IIntruderPayloadProcessor processor);
+
+ /**
+ * This method is used to retrieve the Intruder payload processors that are
+ * registered by the extension.
+ *
+ * @return A list of Intruder payload processors that are currently
+ * registered by this extension.
+ */
+ List getIntruderPayloadProcessors();
+
+ /**
+ * This method is used to remove an Intruder payload processor that has been
+ * registered by the extension.
+ *
+ * @param processor The Intruder payload processor to be removed.
+ */
+ void removeIntruderPayloadProcessor(IIntruderPayloadProcessor processor);
+
+ /**
+ * This method is used to register a custom session handling action. Each
+ * registered action will be available within the session handling rule UI
+ * for the user to select as a rule action. Users can choose to invoke an
+ * action directly in its own right, or following execution of a macro.
+ *
+ * @param action An object created by the extension that implements the
+ * ISessionHandlingAction interface.
+ */
+ void registerSessionHandlingAction(ISessionHandlingAction action);
+
+ /**
+ * This method is used to retrieve the session handling actions that are
+ * registered by the extension.
+ *
+ * @return A list of session handling actions that are currently registered
+ * by this extension.
+ */
+ List getSessionHandlingActions();
+
+ /**
+ * This method is used to remove a session handling action that has been
+ * registered by the extension.
+ *
+ * @param action The extension session handling action to be removed.
+ */
+ void removeSessionHandlingAction(ISessionHandlingAction action);
+
+ /**
+ * This method is used to unload the extension from Burp Suite.
+ */
+ void unloadExtension();
+
+ /**
+ * This method is used to add a custom tab to the main Burp Suite window.
+ *
+ * @param tab An object created by the extension that implements the
+ * ITab interface.
+ */
+ void addSuiteTab(ITab tab);
+
+ /**
+ * This method is used to remove a previously-added tab from the main Burp
+ * Suite window.
+ *
+ * @param tab An object created by the extension that implements the
+ * ITab interface.
+ */
+ void removeSuiteTab(ITab tab);
+
+ /**
+ * This method is used to customize UI components in line with Burp's UI
+ * style, including font size, colors, table line spacing, etc. The action
+ * is performed recursively on any child components of the passed-in
+ * component.
+ *
+ * @param component The UI component to be customized.
+ */
+ void customizeUiComponent(Component component);
+
+ /**
+ * This method is used to create a new instance of Burp's HTTP message
+ * editor, for the extension to use in its own UI.
+ *
+ * @param controller An object created by the extension that implements the
+ * IMessageEditorController interface. This parameter is
+ * optional and may be null. If it is provided, then the
+ * message editor will query the controller when required to obtain details
+ * about the currently displayed message, including the
+ * IHttpService for the message, and the associated request or
+ * response message. If a controller is not provided, then the message
+ * editor will not support context menu actions, such as sending requests to
+ * other Burp tools.
+ * @param editable Indicates whether the editor created should be editable,
+ * or used only for message viewing.
+ * @return An object that implements the IMessageEditor
+ * interface, and which the extension can use in its own UI.
+ */
+ IMessageEditor createMessageEditor(IMessageEditorController controller,
+ boolean editable);
+
+ /**
+ * This method returns the command line arguments that were passed to Burp
+ * on startup.
+ *
+ * @return The command line arguments that were passed to Burp on startup.
+ */
+ String[] getCommandLineArguments();
+
+ /**
+ * This method is used to save configuration settings for the extension in a
+ * persistent way that survives reloads of the extension and of Burp Suite.
+ * Saved settings can be retrieved using the method
+ * loadExtensionSetting().
+ *
+ * @param name The name of the setting.
+ * @param value The value of the setting. If this value is null
+ * then any existing setting with the specified name will be removed.
+ */
+ void saveExtensionSetting(String name, String value);
+
+ /**
+ * This method is used to load configuration settings for the extension that
+ * were saved using the method saveExtensionSetting().
+ *
+ * @param name The name of the setting.
+ * @return The value of the setting, or null if no value is
+ * set.
+ */
+ String loadExtensionSetting(String name);
+
+ /**
+ * This method is used to create a new instance of Burp's plain text editor,
+ * for the extension to use in its own UI.
+ *
+ * @return An object that implements the ITextEditor interface,
+ * and which the extension can use in its own UI.
+ */
+ ITextEditor createTextEditor();
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Repeater
+ * tool. The request will be displayed in the user interface, but will not
+ * be issued until the user initiates this action.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @param tabCaption An optional caption which will appear on the Repeater
+ * tab containing the request. If this value is null then a
+ * default tab index will be displayed.
+ */
+ void sendToRepeater(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request,
+ String tabCaption);
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Intruder
+ * tool. The request will be displayed in the user interface, and markers
+ * for attack payloads will be placed into default locations within the
+ * request.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ */
+ void sendToIntruder(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request);
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Intruder
+ * tool. The request will be displayed in the user interface, and markers
+ * for attack payloads will be placed into the specified locations within
+ * the request.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @param payloadPositionOffsets A list of index pairs representing the
+ * payload positions to be used. Each item in the list must be an int[2]
+ * array containing the start and end offsets for the payload position.
+ */
+ void sendToIntruder(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request,
+ List payloadPositionOffsets);
+
+ /**
+ * This method can be used to send data to the Comparer tool.
+ *
+ * @param data The data to be sent to Comparer.
+ */
+ void sendToComparer(byte[] data);
+
+ /**
+ * This method can be used to send a seed URL to the Burp Spider tool. If
+ * the URL is not within the current Spider scope, the user will be asked if
+ * they wish to add the URL to the scope. If the Spider is not currently
+ * running, it will be started. The seed URL will be requested, and the
+ * Spider will process the application's response in the normal way.
+ *
+ * @param url The new seed URL to begin spidering from.
+ */
+ void sendToSpider(
+ java.net.URL url);
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Scanner tool
+ * to perform an active vulnerability scan. If the request is not within the
+ * current active scanning scope, the user will be asked if they wish to
+ * proceed with the scan.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @return The resulting scan queue item.
+ */
+ IScanQueueItem doActiveScan(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request);
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Scanner tool
+ * to perform an active vulnerability scan, based on a custom list of
+ * insertion points that are to be scanned. If the request is not within the
+ * current active scanning scope, the user will be asked if they wish to
+ * proceed with the scan.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @param insertionPointOffsets A list of index pairs representing the
+ * positions of the insertion points that should be scanned. Each item in
+ * the list must be an int[2] array containing the start and end offsets for
+ * the insertion point.
+ * @return The resulting scan queue item.
+ */
+ IScanQueueItem doActiveScan(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request,
+ List insertionPointOffsets);
+
+ /**
+ * This method can be used to send an HTTP request to the Burp Scanner tool
+ * to perform a passive vulnerability scan.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @param response The full HTTP response.
+ */
+ void doPassiveScan(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request,
+ byte[] response);
+
+ /**
+ * This method can be used to issue HTTP requests and retrieve their
+ * responses.
+ *
+ * @param httpService The HTTP service to which the request should be sent.
+ * @param request The full HTTP request.
+ * @return An object that implements the IHttpRequestResponse
+ * interface, and which the extension can query to obtain the details of the
+ * response.
+ */
+ IHttpRequestResponse makeHttpRequest(IHttpService httpService,
+ byte[] request);
+
+ /**
+ * This method can be used to issue HTTP requests and retrieve their
+ * responses.
+ *
+ * @param host The hostname of the remote HTTP server.
+ * @param port The port of the remote HTTP server.
+ * @param useHttps Flags whether the protocol is HTTPS or HTTP.
+ * @param request The full HTTP request.
+ * @return The full response retrieved from the remote server.
+ */
+ byte[] makeHttpRequest(
+ String host,
+ int port,
+ boolean useHttps,
+ byte[] request);
+
+ /**
+ * This method can be used to query whether a specified URL is within the
+ * current Suite-wide scope.
+ *
+ * @param url The URL to query.
+ * @return Returns true if the URL is within the current
+ * Suite-wide scope.
+ */
+ boolean isInScope(java.net.URL url);
+
+ /**
+ * This method can be used to include the specified URL in the Suite-wide
+ * scope.
+ *
+ * @param url The URL to include in the Suite-wide scope.
+ */
+ void includeInScope(java.net.URL url);
+
+ /**
+ * This method can be used to exclude the specified URL from the Suite-wide
+ * scope.
+ *
+ * @param url The URL to exclude from the Suite-wide scope.
+ */
+ void excludeFromScope(java.net.URL url);
+
+ /**
+ * This method can be used to display a specified message in the Burp Suite
+ * alerts tab.
+ *
+ * @param message The alert message to display.
+ */
+ void issueAlert(String message);
+
+ /**
+ * This method returns details of all items in the Proxy history.
+ *
+ * @return The contents of the Proxy history.
+ */
+ IHttpRequestResponse[] getProxyHistory();
+
+ /**
+ * This method returns details of items in the site map.
+ *
+ * @param urlPrefix This parameter can be used to specify a URL prefix, in
+ * order to extract a specific subset of the site map. The method performs a
+ * simple case-sensitive text match, returning all site map items whose URL
+ * begins with the specified prefix. If this parameter is null, the entire
+ * site map is returned.
+ *
+ * @return Details of items in the site map.
+ */
+ IHttpRequestResponse[] getSiteMap(String urlPrefix);
+
+ /**
+ * This method returns all of the current scan issues for URLs matching the
+ * specified literal prefix.
+ *
+ * @param urlPrefix This parameter can be used to specify a URL prefix, in
+ * order to extract a specific subset of scan issues. The method performs a
+ * simple case-sensitive text match, returning all scan issues whose URL
+ * begins with the specified prefix. If this parameter is null, all issues
+ * are returned.
+ * @return Details of the scan issues.
+ */
+ IScanIssue[] getScanIssues(String urlPrefix);
+
+ /**
+ * This method is used to generate a report for the specified Scanner
+ * issues. The report format can be specified. For all other reporting
+ * options, the default settings that appear in the reporting UI wizard are
+ * used.
+ *
+ * @param format The format to be used in the report. Accepted values are
+ * HTML and XML.
+ * @param issues The Scanner issues to be reported.
+ * @param file The file to which the report will be saved.
+ */
+ void generateScanReport(String format, IScanIssue[] issues,
+ java.io.File file);
+
+ /**
+ * This method is used to retrieve the contents of Burp's session handling
+ * cookie jar. Extensions that provide an
+ * ISessionHandlingAction can query and update the cookie jar
+ * in order to handle unusual session handling mechanisms.
+ *
+ * @return A list of ICookie objects representing the contents
+ * of Burp's session handling cookie jar.
+ */
+ List getCookieJarContents();
+
+ /**
+ * This method is used to update the contents of Burp's session handling
+ * cookie jar. Extensions that provide an
+ * ISessionHandlingAction can query and update the cookie jar
+ * in order to handle unusual session handling mechanisms.
+ *
+ * @param cookie An ICookie object containing details of the
+ * cookie to be updated. If the cookie jar already contains a cookie that
+ * matches the specified domain and name, then that cookie will be updated
+ * with the new value and expiration, unless the new value is
+ * null, in which case the cookie will be removed. If the
+ * cookie jar does not already contain a cookie that matches the specified
+ * domain and name, then the cookie will be added.
+ */
+ void updateCookieJar(ICookie cookie);
+
+ /**
+ * This method can be used to add an item to Burp's site map with the
+ * specified request/response details. This will overwrite the details of
+ * any existing matching item in the site map.
+ *
+ * @param item Details of the item to be added to the site map
+ */
+ void addToSiteMap(IHttpRequestResponse item);
+
+ /**
+ * This method can be used to restore Burp's state from a specified saved
+ * state file. This method blocks until the restore operation is completed,
+ * and must not be called from the event dispatch thread.
+ *
+ * @param file The file containing Burp's saved state.
+ * @deprecated State files have been replaced with Burp project files.
+ */
+ @Deprecated
+ void restoreState(java.io.File file);
+
+ /**
+ * This method can be used to save Burp's state to a specified file. This
+ * method blocks until the save operation is completed, and must not be
+ * called from the event dispatch thread.
+ *
+ * @param file The file to save Burp's state in.
+ * @deprecated State files have been replaced with Burp project files.
+ */
+ @Deprecated
+ void saveState(java.io.File file);
+
+ /**
+ * This method causes Burp to save all of its current configuration as a Map
+ * of name/value Strings.
+ *
+ * @return A Map of name/value Strings reflecting Burp's current
+ * configuration.
+ * @deprecated Use saveConfigAsJson() instead.
+ */
+ @Deprecated
+ Map saveConfig();
+
+ /**
+ * This method causes Burp to load a new configuration from the Map of
+ * name/value Strings provided. Any settings not specified in the Map will
+ * be restored to their default values. To selectively update only some
+ * settings and leave the rest unchanged, you should first call
+ * saveConfig() to obtain Burp's current configuration, modify
+ * the relevant items in the Map, and then call loadConfig()
+ * with the same Map.
+ *
+ * @param config A map of name/value Strings to use as Burp's new
+ * configuration.
+ * @deprecated Use loadConfigFromJson() instead.
+ */
+ @Deprecated
+ void loadConfig(Map config);
+
+ /**
+ * This method causes Burp to save its current project-level configuration
+ * in JSON format. This is the same format that can be saved and loaded via
+ * the Burp user interface. To include only certain sections of the
+ * configuration, you can optionally supply the path to each section that
+ * should be included, for example: "project_options.connections". If no
+ * paths are provided, then the entire configuration will be saved.
+ *
+ * @param configPaths A list of Strings representing the path to each
+ * configuration section that should be included.
+ * @return A String representing the current configuration in JSON format.
+ */
+ String saveConfigAsJson(String... configPaths);
+
+ /**
+ * This method causes Burp to load a new project-level configuration from
+ * the JSON String provided. This is the same format that can be saved and
+ * loaded via the Burp user interface. Partial configurations are
+ * acceptable, and any settings not specified will be left unmodified.
+ *
+ * Any user-level configuration options contained in the input will be
+ * ignored.
+ *
+ * @param config A JSON String containing the new configuration.
+ */
+ void loadConfigFromJson(String config);
+
+ /**
+ * This method sets the master interception mode for Burp Proxy.
+ *
+ * @param enabled Indicates whether interception of Proxy messages should be
+ * enabled.
+ */
+ void setProxyInterceptionEnabled(boolean enabled);
+
+ /**
+ * This method retrieves information about the version of Burp in which the
+ * extension is running. It can be used by extensions to dynamically adjust
+ * their behavior depending on the functionality and APIs supported by the
+ * current version.
+ *
+ * @return An array of Strings comprised of: the product name (e.g. Burp
+ * Suite Professional), the major version (e.g. 1.5), the minor version
+ * (e.g. 03)
+ */
+ String[] getBurpVersion();
+
+ /**
+ * This method retrieves the absolute path name of the file from which the
+ * current extension was loaded.
+ *
+ * @return The absolute path name of the file from which the current
+ * extension was loaded.
+ */
+ String getExtensionFilename();
+
+ /**
+ * This method determines whether the current extension was loaded as a BApp
+ * (a Burp App from the BApp Store).
+ *
+ * @return Returns true if the current extension was loaded as a BApp.
+ */
+ boolean isExtensionBapp();
+
+ /**
+ * This method can be used to shut down Burp programmatically, with an
+ * optional prompt to the user. If the method returns, the user canceled the
+ * shutdown prompt.
+ *
+ * @param promptUser Indicates whether to prompt the user to confirm the
+ * shutdown.
+ */
+ void exitSuite(boolean promptUser);
+
+ /**
+ * This method is used to create a temporary file on disk containing the
+ * provided data. Extensions can use temporary files for long-term storage
+ * of runtime data, avoiding the need to retain that data in memory.
+ *
+ * @param buffer The data to be saved to a temporary file.
+ * @return An object that implements the ITempFile interface.
+ */
+ ITempFile saveToTempFile(byte[] buffer);
+
+ /**
+ * This method is used to save the request and response of an
+ * IHttpRequestResponse object to temporary files, so that they
+ * are no longer held in memory. Extensions can used this method to convert
+ * IHttpRequestResponse objects into a form suitable for
+ * long-term storage.
+ *
+ * @param httpRequestResponse The IHttpRequestResponse object
+ * whose request and response messages are to be saved to temporary files.
+ * @return An object that implements the
+ * IHttpRequestResponsePersisted interface.
+ */
+ IHttpRequestResponsePersisted saveBuffersToTempFiles(
+ IHttpRequestResponse httpRequestResponse);
+
+ /**
+ * This method is used to apply markers to an HTTP request or response, at
+ * offsets into the message that are relevant for some particular purpose.
+ * Markers are used in various situations, such as specifying Intruder
+ * payload positions, Scanner insertion points, and highlights in Scanner
+ * issues.
+ *
+ * @param httpRequestResponse The IHttpRequestResponse object
+ * to which the markers should be applied.
+ * @param requestMarkers A list of index pairs representing the offsets of
+ * markers to be applied to the request message. Each item in the list must
+ * be an int[2] array containing the start and end offsets for the marker.
+ * The markers in the list should be in sequence and not overlapping. This
+ * parameter is optional and may be null if no request markers
+ * are required.
+ * @param responseMarkers A list of index pairs representing the offsets of
+ * markers to be applied to the response message. Each item in the list must
+ * be an int[2] array containing the start and end offsets for the marker.
+ * The markers in the list should be in sequence and not overlapping. This
+ * parameter is optional and may be null if no response markers
+ * are required.
+ * @return An object that implements the
+ * IHttpRequestResponseWithMarkers interface.
+ */
+ IHttpRequestResponseWithMarkers applyMarkers(
+ IHttpRequestResponse httpRequestResponse,
+ List requestMarkers,
+ List responseMarkers);
+
+ /**
+ * This method is used to obtain the descriptive name for the Burp tool
+ * identified by the tool flag provided.
+ *
+ * @param toolFlag A flag identifying a Burp tool ( TOOL_PROXY,
+ * TOOL_SCANNER, etc.). Tool flags are defined within this
+ * interface.
+ * @return The descriptive name for the specified tool.
+ */
+ String getToolName(int toolFlag);
+
+ /**
+ * This method is used to register a new Scanner issue. Note:
+ * Wherever possible, extensions should implement custom Scanner checks
+ * using IScannerCheck and report issues via those checks, so
+ * as to integrate with Burp's user-driven workflow, and ensure proper
+ * consolidation of duplicate reported issues. This method is only designed
+ * for tasks outside of the normal testing workflow, such as importing
+ * results from other scanning tools.
+ *
+ * @param issue An object created by the extension that implements the
+ * IScanIssue interface.
+ */
+ void addScanIssue(IScanIssue issue);
+
+ /**
+ * This method parses the specified request and returns details of each
+ * request parameter.
+ *
+ * @param request The request to be parsed.
+ * @return An array of: String[] { name, value, type }
+ * containing details of the parameters contained within the request.
+ * @deprecated Use IExtensionHelpers.analyzeRequest() instead.
+ */
+ @Deprecated
+ String[][] getParameters(byte[] request);
+
+ /**
+ * This method parses the specified request and returns details of each HTTP
+ * header.
+ *
+ * @param message The request to be parsed.
+ * @return An array of HTTP headers.
+ * @deprecated Use IExtensionHelpers.analyzeRequest() or
+ * IExtensionHelpers.analyzeResponse() instead.
+ */
+ @Deprecated
+ String[] getHeaders(byte[] message);
+
+ /**
+ * This method can be used to register a new menu item which will appear on
+ * the various context menus that are used throughout Burp Suite to handle
+ * user-driven actions.
+ *
+ * @param menuItemCaption The caption to be displayed on the menu item.
+ * @param menuItemHandler The handler to be invoked when the user clicks on
+ * the menu item.
+ * @deprecated Use registerContextMenuFactory() instead.
+ */
+ @Deprecated
+ void registerMenuItem(
+ String menuItemCaption,
+ IMenuItemHandler menuItemHandler);
+}
diff --git a/src/burp/IContextMenuFactory.java b/src/burp/IContextMenuFactory.java
new file mode 100644
index 0000000..1938e13
--- /dev/null
+++ b/src/burp/IContextMenuFactory.java
@@ -0,0 +1,39 @@
+package burp;
+
+/*
+ * @(#)IContextMenuFactory.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+
+import javax.swing.JMenuItem;
+import java.util.List;
+
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerContextMenuFactory() to register
+ * a factory for custom context menu items.
+ */
+public interface IContextMenuFactory
+{
+ /**
+ * This method will be called by Burp when the user invokes a context menu
+ * anywhere within Burp. The factory can then provide any custom context
+ * menu items that should be displayed in the context menu, based on the
+ * details of the menu invocation.
+ *
+ * @param invocation An object that implements the
+ * IMessageEditorTabFactory interface, which the extension can
+ * query to obtain details of the context menu invocation.
+ * @return A list of custom menu items (which may include sub-menus,
+ * checkbox menu items, etc.) that should be displayed. Extensions may
+ * return
+ * null from this method, to indicate that no menu items are
+ * required.
+ */
+ List createMenuItems(IContextMenuInvocation invocation);
+}
diff --git a/src/burp/IContextMenuInvocation.java b/src/burp/IContextMenuInvocation.java
new file mode 100644
index 0000000..a408870
--- /dev/null
+++ b/src/burp/IContextMenuInvocation.java
@@ -0,0 +1,156 @@
+package burp;
+
+/*
+ * @(#)IContextMenuInvocation.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.event.InputEvent;
+
+/**
+ * This interface is used when Burp calls into an extension-provided
+ * IContextMenuFactory with details of a context menu invocation.
+ * The custom context menu factory can query this interface to obtain details of
+ * the invocation event, in order to determine what menu items should be
+ * displayed.
+ */
+public interface IContextMenuInvocation
+{
+ /**
+ * Used to indicate that the context menu is being invoked in a request
+ * editor.
+ */
+ static final byte CONTEXT_MESSAGE_EDITOR_REQUEST = 0;
+ /**
+ * Used to indicate that the context menu is being invoked in a response
+ * editor.
+ */
+ static final byte CONTEXT_MESSAGE_EDITOR_RESPONSE = 1;
+ /**
+ * Used to indicate that the context menu is being invoked in a non-editable
+ * request viewer.
+ */
+ static final byte CONTEXT_MESSAGE_VIEWER_REQUEST = 2;
+ /**
+ * Used to indicate that the context menu is being invoked in a non-editable
+ * response viewer.
+ */
+ static final byte CONTEXT_MESSAGE_VIEWER_RESPONSE = 3;
+ /**
+ * Used to indicate that the context menu is being invoked in the Target
+ * site map tree.
+ */
+ static final byte CONTEXT_TARGET_SITE_MAP_TREE = 4;
+ /**
+ * Used to indicate that the context menu is being invoked in the Target
+ * site map table.
+ */
+ static final byte CONTEXT_TARGET_SITE_MAP_TABLE = 5;
+ /**
+ * Used to indicate that the context menu is being invoked in the Proxy
+ * history.
+ */
+ static final byte CONTEXT_PROXY_HISTORY = 6;
+ /**
+ * Used to indicate that the context menu is being invoked in the Scanner
+ * results.
+ */
+ static final byte CONTEXT_SCANNER_RESULTS = 7;
+ /**
+ * Used to indicate that the context menu is being invoked in the Intruder
+ * payload positions editor.
+ */
+ static final byte CONTEXT_INTRUDER_PAYLOAD_POSITIONS = 8;
+ /**
+ * Used to indicate that the context menu is being invoked in an Intruder
+ * attack results.
+ */
+ static final byte CONTEXT_INTRUDER_ATTACK_RESULTS = 9;
+ /**
+ * Used to indicate that the context menu is being invoked in a search
+ * results window.
+ */
+ static final byte CONTEXT_SEARCH_RESULTS = 10;
+
+ /**
+ * This method can be used to retrieve the native Java input event that was
+ * the trigger for the context menu invocation.
+ *
+ * @return The InputEvent that was the trigger for the context
+ * menu invocation.
+ */
+ InputEvent getInputEvent();
+
+ /**
+ * This method can be used to retrieve the Burp tool within which the
+ * context menu was invoked.
+ *
+ * @return A flag indicating the Burp tool within which the context menu was
+ * invoked. Burp tool flags are defined in the
+ * IBurpExtenderCallbacks interface.
+ */
+ int getToolFlag();
+
+ /**
+ * This method can be used to retrieve the context within which the menu was
+ * invoked.
+ *
+ * @return An index indicating the context within which the menu was
+ * invoked. The indices used are defined within this interface.
+ */
+ byte getInvocationContext();
+
+ /**
+ * This method can be used to retrieve the bounds of the user's selection
+ * into the current message, if applicable.
+ *
+ * @return An int[2] array containing the start and end offsets of the
+ * user's selection in the current message. If the user has not made any
+ * selection in the current message, both offsets indicate the position of
+ * the caret within the editor. If the menu is not being invoked from a
+ * message editor, the method returns null.
+ */
+ int[] getSelectionBounds();
+
+ /**
+ * This method can be used to retrieve details of the HTTP requests /
+ * responses that were shown or selected by the user when the context menu
+ * was invoked.
+ *
+ * Note: For performance reasons, the objects returned from this
+ * method are tied to the originating context of the messages within the
+ * Burp UI. For example, if a context menu is invoked on the Proxy intercept
+ * panel, then the
+ * IHttpRequestResponse returned by this method will reflect
+ * the current contents of the interception panel, and this will change when
+ * the current message has been forwarded or dropped. If your extension
+ * needs to store details of the message for which the context menu has been
+ * invoked, then you should query those details from the
+ * IHttpRequestResponse at the time of invocation, or you
+ * should use
+ * IBurpExtenderCallbacks.saveBuffersToTempFiles() to create a
+ * persistent read-only copy of the
+ * IHttpRequestResponse.
+ *
+ * @return An array of IHttpRequestResponse objects
+ * representing the items that were shown or selected by the user when the
+ * context menu was invoked. This method returns null if no
+ * messages are applicable to the invocation.
+ */
+ IHttpRequestResponse[] getSelectedMessages();
+
+ /**
+ * This method can be used to retrieve details of the Scanner issues that
+ * were selected by the user when the context menu was invoked.
+ *
+ * @return An array of IScanIssue objects representing the
+ * issues that were selected by the user when the context menu was invoked.
+ * This method returns null if no Scanner issues are applicable
+ * to the invocation.
+ */
+ IScanIssue[] getSelectedIssues();
+}
diff --git a/src/burp/ICookie.java b/src/burp/ICookie.java
new file mode 100644
index 0000000..45cdb41
--- /dev/null
+++ b/src/burp/ICookie.java
@@ -0,0 +1,61 @@
+package burp;
+
+/*
+ * @(#)ICookie.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.Date;
+
+/**
+ * This interface is used to hold details about an HTTP cookie.
+ */
+public interface ICookie
+{
+ /**
+ * This method is used to retrieve the domain for which the cookie is in
+ * scope.
+ *
+ * @return The domain for which the cookie is in scope. Note: For
+ * cookies that have been analyzed from responses (by calling
+ * IExtensionHelpers.analyzeResponse() and then
+ * IResponseInfo.getCookies(), the domain will be
+ * null if the response did not explicitly set a domain
+ * attribute for the cookie.
+ */
+ String getDomain();
+
+ /**
+ * This method is used to retrieve the path for which the cookie is in
+ * scope.
+ *
+ * @return The path for which the cookie is in scope or null if none is set.
+ */
+ String getPath();
+
+ /**
+ * This method is used to retrieve the expiration time for the cookie.
+ *
+ * @return The expiration time for the cookie, or
+ * null if none is set (i.e., for non-persistent session
+ * cookies).
+ */
+ Date getExpiration();
+
+ /**
+ * This method is used to retrieve the name of the cookie.
+ *
+ * @return The name of the cookie.
+ */
+ String getName();
+
+ /**
+ * This method is used to retrieve the value of the cookie.
+ * @return The value of the cookie.
+ */
+ String getValue();
+}
diff --git a/src/burp/IExtensionHelpers.java b/src/burp/IExtensionHelpers.java
new file mode 100644
index 0000000..021c160
--- /dev/null
+++ b/src/burp/IExtensionHelpers.java
@@ -0,0 +1,352 @@
+package burp;
+
+/*
+ * @(#)IExtensionHelpers.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.net.URL;
+import java.util.List;
+
+/**
+ * This interface contains a number of helper methods, which extensions can use
+ * to assist with various common tasks that arise for Burp extensions.
+ *
+ * Extensions can call
+ * IBurpExtenderCallbacks.getHelpers to obtain an instance of this
+ * interface.
+ */
+public interface IExtensionHelpers
+{
+ /**
+ * This method can be used to analyze an HTTP request, and obtain various
+ * key details about it.
+ *
+ * @param request An
+ * IHttpRequestResponse object containing the request to be
+ * analyzed.
+ * @return An
+ * IRequestInfo object that can be queried to obtain details
+ * about the request.
+ */
+ IRequestInfo analyzeRequest(IHttpRequestResponse request);
+
+ /**
+ * This method can be used to analyze an HTTP request, and obtain various
+ * key details about it.
+ *
+ * @param httpService The HTTP service associated with the request. This is
+ * optional and may be
+ * null, in which case the resulting
+ * IRequestInfo object will not include the full request URL.
+ * @param request The request to be analyzed.
+ * @return An
+ * IRequestInfo object that can be queried to obtain details
+ * about the request.
+ */
+ IRequestInfo analyzeRequest(IHttpService httpService, byte[] request);
+
+ /**
+ * This method can be used to analyze an HTTP request, and obtain various
+ * key details about it. The resulting
+ * IRequestInfo object will not include the full request URL.
+ * To obtain the full URL, use one of the other overloaded
+ * analyzeRequest() methods.
+ *
+ * @param request The request to be analyzed.
+ * @return An
+ * IRequestInfo object that can be queried to obtain details
+ * about the request.
+ */
+ IRequestInfo analyzeRequest(byte[] request);
+
+ /**
+ * This method can be used to analyze an HTTP response, and obtain various
+ * key details about it.
+ *
+ * @param response The response to be analyzed.
+ * @return An
+ * IResponseInfo object that can be queried to obtain details
+ * about the response.
+ */
+ IResponseInfo analyzeResponse(byte[] response);
+
+ /**
+ * This method can be used to retrieve details of a specified parameter
+ * within an HTTP request. Note: Use
+ * analyzeRequest() to obtain details of all parameters within
+ * the request.
+ *
+ * @param request The request to be inspected for the specified parameter.
+ * @param parameterName The name of the parameter to retrieve.
+ * @return An
+ * IParameter object that can be queried to obtain details
+ * about the parameter, or
+ * null if the parameter was not found.
+ */
+ IParameter getRequestParameter(byte[] request, String parameterName);
+
+ /**
+ * This method can be used to URL-decode the specified data.
+ *
+ * @param data The data to be decoded.
+ * @return The decoded data.
+ */
+ String urlDecode(String data);
+
+ /**
+ * This method can be used to URL-encode the specified data. Any characters
+ * that do not need to be encoded within HTTP requests are not encoded.
+ *
+ * @param data The data to be encoded.
+ * @return The encoded data.
+ */
+ String urlEncode(String data);
+
+ /**
+ * This method can be used to URL-decode the specified data.
+ *
+ * @param data The data to be decoded.
+ * @return The decoded data.
+ */
+ byte[] urlDecode(byte[] data);
+
+ /**
+ * This method can be used to URL-encode the specified data. Any characters
+ * that do not need to be encoded within HTTP requests are not encoded.
+ *
+ * @param data The data to be encoded.
+ * @return The encoded data.
+ */
+ byte[] urlEncode(byte[] data);
+
+ /**
+ * This method can be used to Base64-decode the specified data.
+ *
+ * @param data The data to be decoded.
+ * @return The decoded data.
+ */
+ byte[] base64Decode(String data);
+
+ /**
+ * This method can be used to Base64-decode the specified data.
+ *
+ * @param data The data to be decoded.
+ * @return The decoded data.
+ */
+ byte[] base64Decode(byte[] data);
+
+ /**
+ * This method can be used to Base64-encode the specified data.
+ *
+ * @param data The data to be encoded.
+ * @return The encoded data.
+ */
+ String base64Encode(String data);
+
+ /**
+ * This method can be used to Base64-encode the specified data.
+ *
+ * @param data The data to be encoded.
+ * @return The encoded data.
+ */
+ String base64Encode(byte[] data);
+
+ /**
+ * This method can be used to convert data from String form into an array of
+ * bytes. The conversion does not reflect any particular character set, and
+ * a character with the hex representation 0xWXYZ will always be converted
+ * into a byte with the representation 0xYZ. It performs the opposite
+ * conversion to the method
+ * bytesToString(), and byte-based data that is converted to a
+ * String and back again using these two methods is guaranteed to retain its
+ * integrity (which may not be the case with conversions that reflect a
+ * given character set).
+ *
+ * @param data The data to be converted.
+ * @return The converted data.
+ */
+ byte[] stringToBytes(String data);
+
+ /**
+ * This method can be used to convert data from an array of bytes into
+ * String form. The conversion does not reflect any particular character
+ * set, and a byte with the representation 0xYZ will always be converted
+ * into a character with the hex representation 0x00YZ. It performs the
+ * opposite conversion to the method
+ * stringToBytes(), and byte-based data that is converted to a
+ * String and back again using these two methods is guaranteed to retain its
+ * integrity (which may not be the case with conversions that reflect a
+ * given character set).
+ *
+ * @param data The data to be converted.
+ * @return The converted data.
+ */
+ String bytesToString(byte[] data);
+
+ /**
+ * This method searches a piece of data for the first occurrence of a
+ * specified pattern. It works on byte-based data in a way that is similar
+ * to the way the native Java method
+ * String.indexOf() works on String-based data.
+ *
+ * @param data The data to be searched.
+ * @param pattern The pattern to be searched for.
+ * @param caseSensitive Flags whether or not the search is case-sensitive.
+ * @param from The offset within
+ * data where the search should begin.
+ * @param to The offset within
+ * data where the search should end.
+ * @return The offset of the first occurrence of the pattern within the
+ * specified bounds, or -1 if no match is found.
+ */
+ int indexOf(byte[] data,
+ byte[] pattern,
+ boolean caseSensitive,
+ int from,
+ int to);
+
+ /**
+ * This method builds an HTTP message containing the specified headers and
+ * message body. If applicable, the Content-Length header will be added or
+ * updated, based on the length of the body.
+ *
+ * @param headers A list of headers to include in the message.
+ * @param body The body of the message, of
+ * null if the message has an empty body.
+ * @return The resulting full HTTP message.
+ */
+ byte[] buildHttpMessage(List headers, byte[] body);
+
+ /**
+ * This method creates a GET request to the specified URL. The headers used
+ * in the request are determined by the Request headers settings as
+ * configured in Burp Spider's options.
+ *
+ * @param url The URL to which the request should be made.
+ * @return A request to the specified URL.
+ */
+ byte[] buildHttpRequest(URL url);
+
+ /**
+ * This method adds a new parameter to an HTTP request, and if appropriate
+ * updates the Content-Length header.
+ *
+ * @param request The request to which the parameter should be added.
+ * @param parameter An
+ * IParameter object containing details of the parameter to be
+ * added. Supported parameter types are:
+ * PARAM_URL,
+ * PARAM_BODY and
+ * PARAM_COOKIE.
+ * @return A new HTTP request with the new parameter added.
+ */
+ byte[] addParameter(byte[] request, IParameter parameter);
+
+ /**
+ * This method removes a parameter from an HTTP request, and if appropriate
+ * updates the Content-Length header.
+ *
+ * @param request The request from which the parameter should be removed.
+ * @param parameter An
+ * IParameter object containing details of the parameter to be
+ * removed. Supported parameter types are:
+ * PARAM_URL,
+ * PARAM_BODY and
+ * PARAM_COOKIE.
+ * @return A new HTTP request with the parameter removed.
+ */
+ byte[] removeParameter(byte[] request, IParameter parameter);
+
+ /**
+ * This method updates the value of a parameter within an HTTP request, and
+ * if appropriate updates the Content-Length header. Note: This
+ * method can only be used to update the value of an existing parameter of a
+ * specified type. If you need to change the type of an existing parameter,
+ * you should first call
+ * removeParameter() to remove the parameter with the old type,
+ * and then call
+ * addParameter() to add a parameter with the new type.
+ *
+ * @param request The request containing the parameter to be updated.
+ * @param parameter An
+ * IParameter object containing details of the parameter to be
+ * updated. Supported parameter types are:
+ * PARAM_URL,
+ * PARAM_BODY and
+ * PARAM_COOKIE.
+ * @return A new HTTP request with the parameter updated.
+ */
+ byte[] updateParameter(byte[] request, IParameter parameter);
+
+ /**
+ * This method can be used to toggle a request's method between GET and
+ * POST. Parameters are relocated between the URL query string and message
+ * body as required, and the Content-Length header is created or removed as
+ * applicable.
+ *
+ * @param request The HTTP request whose method should be toggled.
+ * @return A new HTTP request using the toggled method.
+ */
+ byte[] toggleRequestMethod(byte[] request);
+
+ /**
+ * This method constructs an
+ * IHttpService object based on the details provided.
+ *
+ * @param host The HTTP service host.
+ * @param port The HTTP service port.
+ * @param protocol The HTTP service protocol.
+ * @return An
+ * IHttpService object based on the details provided.
+ */
+ IHttpService buildHttpService(String host, int port, String protocol);
+
+ /**
+ * This method constructs an
+ * IHttpService object based on the details provided.
+ *
+ * @param host The HTTP service host.
+ * @param port The HTTP service port.
+ * @param useHttps Flags whether the HTTP service protocol is HTTPS or HTTP.
+ * @return An
+ * IHttpService object based on the details provided.
+ */
+ IHttpService buildHttpService(String host, int port, boolean useHttps);
+
+ /**
+ * This method constructs an
+ * IParameter object based on the details provided.
+ *
+ * @param name The parameter name.
+ * @param value The parameter value.
+ * @param type The parameter type, as defined in the
+ * IParameter interface.
+ * @return An
+ * IParameter object based on the details provided.
+ */
+ IParameter buildParameter(String name, String value, byte type);
+
+ /**
+ * This method constructs an
+ * IScannerInsertionPoint object based on the details provided.
+ * It can be used to quickly create a simple insertion point based on a
+ * fixed payload location within a base request.
+ *
+ * @param insertionPointName The name of the insertion point.
+ * @param baseRequest The request from which to build scan requests.
+ * @param from The offset of the start of the payload location.
+ * @param to The offset of the end of the payload location.
+ * @return An
+ * IScannerInsertionPoint object based on the details provided.
+ */
+ IScannerInsertionPoint makeScannerInsertionPoint(
+ String insertionPointName,
+ byte[] baseRequest,
+ int from,
+ int to);
+}
diff --git a/src/burp/IExtensionStateListener.java b/src/burp/IExtensionStateListener.java
new file mode 100644
index 0000000..c958210
--- /dev/null
+++ b/src/burp/IExtensionStateListener.java
@@ -0,0 +1,27 @@
+package burp;
+
+/*
+ * @(#)IExtensionStateListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerExtensionStateListener() to
+ * register an extension state listener. The listener will be notified of
+ * changes to the extension's state. Note: Any extensions that start
+ * background threads or open system resources (such as files or database
+ * connections) should register a listener and terminate threads / close
+ * resources when the extension is unloaded.
+ */
+public interface IExtensionStateListener
+{
+ /**
+ * This method is called when the extension is unloaded.
+ */
+ void extensionUnloaded();
+}
diff --git a/src/burp/IHttpListener.java b/src/burp/IHttpListener.java
new file mode 100644
index 0000000..6fcf570
--- /dev/null
+++ b/src/burp/IHttpListener.java
@@ -0,0 +1,37 @@
+package burp;
+
+/*
+ * @(#)IHttpListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerHttpListener() to register an
+ * HTTP listener. The listener will be notified of requests and responses made
+ * by any Burp tool. Extensions can perform custom analysis or modification of
+ * these messages by registering an HTTP listener.
+ */
+public interface IHttpListener
+{
+ /**
+ * This method is invoked when an HTTP request is about to be issued, and
+ * when an HTTP response has been received.
+ *
+ * @param toolFlag A flag indicating the Burp tool that issued the request.
+ * Burp tool flags are defined in the
+ * IBurpExtenderCallbacks interface.
+ * @param messageIsRequest Flags whether the method is being invoked for a
+ * request or response.
+ * @param messageInfo Details of the request / response to be processed.
+ * Extensions can call the setter methods on this object to update the
+ * current message and so modify Burp's behavior.
+ */
+ void processHttpMessage(int toolFlag,
+ boolean messageIsRequest,
+ IHttpRequestResponse messageInfo);
+}
diff --git a/src/burp/IHttpRequestResponse.java b/src/burp/IHttpRequestResponse.java
new file mode 100644
index 0000000..6813443
--- /dev/null
+++ b/src/burp/IHttpRequestResponse.java
@@ -0,0 +1,102 @@
+package burp;
+
+/*
+ * @(#)IHttpRequestResponse.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to retrieve and update details about HTTP messages.
+ *
+ * Note: The setter methods generally can only be used before the message
+ * has been processed, and not in read-only contexts. The getter methods
+ * relating to response details can only be used after the request has been
+ * issued.
+ */
+public interface IHttpRequestResponse
+{
+ /**
+ * This method is used to retrieve the request message.
+ *
+ * @return The request message.
+ */
+ byte[] getRequest();
+
+ /**
+ * This method is used to update the request message.
+ *
+ * @param message The new request message.
+ */
+ void setRequest(byte[] message);
+
+ /**
+ * This method is used to retrieve the response message.
+ *
+ * @return The response message.
+ */
+ byte[] getResponse();
+
+ /**
+ * This method is used to update the response message.
+ *
+ * @param message The new response message.
+ */
+ void setResponse(byte[] message);
+
+ /**
+ * This method is used to retrieve the user-annotated comment for this item,
+ * if applicable.
+ *
+ * @return The user-annotated comment for this item, or null if none is set.
+ */
+ String getComment();
+
+ /**
+ * This method is used to update the user-annotated comment for this item.
+ *
+ * @param comment The comment to be assigned to this item.
+ */
+ void setComment(String comment);
+
+ /**
+ * This method is used to retrieve the user-annotated highlight for this
+ * item, if applicable.
+ *
+ * @return The user-annotated highlight for this item, or null if none is
+ * set.
+ */
+ String getHighlight();
+
+ /**
+ * This method is used to update the user-annotated highlight for this item.
+ *
+ * @param color The highlight color to be assigned to this item. Accepted
+ * values are: red, orange, yellow, green, cyan, blue, pink, magenta, gray,
+ * or a null String to clear any existing highlight.
+ */
+ void setHighlight(String color);
+
+ /**
+ * This method is used to retrieve the HTTP service for this request /
+ * response.
+ *
+ * @return An
+ * IHttpService object containing details of the HTTP service.
+ */
+ IHttpService getHttpService();
+
+ /**
+ * This method is used to update the HTTP service for this request /
+ * response.
+ *
+ * @param httpService An
+ * IHttpService object containing details of the new HTTP
+ * service.
+ */
+ void setHttpService(IHttpService httpService);
+
+}
diff --git a/src/burp/IHttpRequestResponsePersisted.java b/src/burp/IHttpRequestResponsePersisted.java
new file mode 100644
index 0000000..9069073
--- /dev/null
+++ b/src/burp/IHttpRequestResponsePersisted.java
@@ -0,0 +1,25 @@
+package burp;
+
+/*
+ * @(#)IHttpRequestResponsePersisted.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used for an
+ * IHttpRequestResponse object whose request and response messages
+ * have been saved to temporary files using
+ * IBurpExtenderCallbacks.saveBuffersToTempFiles().
+ */
+public interface IHttpRequestResponsePersisted extends IHttpRequestResponse
+{
+ /**
+ * This method is deprecated and no longer performs any action.
+ */
+ @Deprecated
+ void deleteTempFiles();
+}
diff --git a/src/burp/IHttpRequestResponseWithMarkers.java b/src/burp/IHttpRequestResponseWithMarkers.java
new file mode 100644
index 0000000..905419a
--- /dev/null
+++ b/src/burp/IHttpRequestResponseWithMarkers.java
@@ -0,0 +1,44 @@
+package burp;
+
+/*
+ * @(#)IHttpRequestResponseWithMarkers.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * This interface is used for an
+ * IHttpRequestResponse object that has had markers applied.
+ * Extensions can create instances of this interface using
+ * IBurpExtenderCallbacks.applyMarkers(), or provide their own
+ * implementation. Markers are used in various situations, such as specifying
+ * Intruder payload positions, Scanner insertion points, and highlights in
+ * Scanner issues.
+ */
+public interface IHttpRequestResponseWithMarkers extends IHttpRequestResponse
+{
+ /**
+ * This method returns the details of the request markers.
+ *
+ * @return A list of index pairs representing the offsets of markers for the
+ * request message. Each item in the list is an int[2] array containing the
+ * start and end offsets for the marker. The method may return
+ * null if no request markers are defined.
+ */
+ List getRequestMarkers();
+
+ /**
+ * This method returns the details of the response markers.
+ *
+ * @return A list of index pairs representing the offsets of markers for the
+ * response message. Each item in the list is an int[2] array containing the
+ * start and end offsets for the marker. The method may return
+ * null if no response markers are defined.
+ */
+ List getResponseMarkers();
+}
diff --git a/src/burp/IHttpService.java b/src/burp/IHttpService.java
new file mode 100644
index 0000000..82ad004
--- /dev/null
+++ b/src/burp/IHttpService.java
@@ -0,0 +1,39 @@
+package burp;
+
+/*
+ * @(#)IHttpService.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to provide details about an HTTP service, to which
+ * HTTP requests can be sent.
+ */
+public interface IHttpService
+{
+ /**
+ * This method returns the hostname or IP address for the service.
+ *
+ * @return The hostname or IP address for the service.
+ */
+ String getHost();
+
+ /**
+ * This method returns the port number for the service.
+ *
+ * @return The port number for the service.
+ */
+ int getPort();
+
+ /**
+ * This method returns the protocol for the service.
+ *
+ * @return The protocol for the service. Expected values are "http" or
+ * "https".
+ */
+ String getProtocol();
+}
diff --git a/src/burp/IInterceptedProxyMessage.java b/src/burp/IInterceptedProxyMessage.java
new file mode 100644
index 0000000..0dca538
--- /dev/null
+++ b/src/burp/IInterceptedProxyMessage.java
@@ -0,0 +1,116 @@
+package burp;
+
+/*
+ * @(#)IInterceptedProxyMessage.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.net.InetAddress;
+
+/**
+ * This interface is used to represent an HTTP message that has been intercepted
+ * by Burp Proxy. Extensions can register an
+ * IProxyListener to receive details of proxy messages using this
+ * interface. *
+ */
+public interface IInterceptedProxyMessage
+{
+ /**
+ * This action causes Burp Proxy to follow the current interception rules to
+ * determine the appropriate action to take for the message.
+ */
+ static final int ACTION_FOLLOW_RULES = 0;
+ /**
+ * This action causes Burp Proxy to present the message to the user for
+ * manual review or modification.
+ */
+ static final int ACTION_DO_INTERCEPT = 1;
+ /**
+ * This action causes Burp Proxy to forward the message to the remote server
+ * or client, without presenting it to the user.
+ */
+ static final int ACTION_DONT_INTERCEPT = 2;
+ /**
+ * This action causes Burp Proxy to drop the message.
+ */
+ static final int ACTION_DROP = 3;
+ /**
+ * This action causes Burp Proxy to follow the current interception rules to
+ * determine the appropriate action to take for the message, and then make a
+ * second call to processProxyMessage.
+ */
+ static final int ACTION_FOLLOW_RULES_AND_REHOOK = 0x10;
+ /**
+ * This action causes Burp Proxy to present the message to the user for
+ * manual review or modification, and then make a second call to
+ * processProxyMessage.
+ */
+ static final int ACTION_DO_INTERCEPT_AND_REHOOK = 0x11;
+ /**
+ * This action causes Burp Proxy to skip user interception, and then make a
+ * second call to processProxyMessage.
+ */
+ static final int ACTION_DONT_INTERCEPT_AND_REHOOK = 0x12;
+
+ /**
+ * This method retrieves a unique reference number for this
+ * request/response.
+ *
+ * @return An identifier that is unique to a single request/response pair.
+ * Extensions can use this to correlate details of requests and responses
+ * and perform processing on the response message accordingly.
+ */
+ int getMessageReference();
+
+ /**
+ * This method retrieves details of the intercepted message.
+ *
+ * @return An IHttpRequestResponse object containing details of
+ * the intercepted message.
+ */
+ IHttpRequestResponse getMessageInfo();
+
+ /**
+ * This method retrieves the currently defined interception action. The
+ * default action is
+ * ACTION_FOLLOW_RULES. If multiple proxy listeners are
+ * registered, then other listeners may already have modified the
+ * interception action before it reaches the current listener. This method
+ * can be used to determine whether this has occurred.
+ *
+ * @return The currently defined interception action. Possible values are
+ * defined within this interface.
+ */
+ int getInterceptAction();
+
+ /**
+ * This method is used to update the interception action.
+ *
+ * @param interceptAction The new interception action. Possible values are
+ * defined within this interface.
+ */
+ void setInterceptAction(int interceptAction);
+
+ /**
+ * This method retrieves the name of the Burp Proxy listener that is
+ * processing the intercepted message.
+ *
+ * @return The name of the Burp Proxy listener that is processing the
+ * intercepted message. The format is the same as that shown in the Proxy
+ * Listeners UI - for example, "127.0.0.1:8080".
+ */
+ String getListenerInterface();
+
+ /**
+ * This method retrieves the client IP address from which the request for
+ * the intercepted message was received.
+ *
+ * @return The client IP address from which the request for the intercepted
+ * message was received.
+ */
+ InetAddress getClientIpAddress();
+}
diff --git a/src/burp/IIntruderAttack.java b/src/burp/IIntruderAttack.java
new file mode 100644
index 0000000..c460f76
--- /dev/null
+++ b/src/burp/IIntruderAttack.java
@@ -0,0 +1,31 @@
+package burp;
+
+/*
+ * @(#)IIntruderAttack.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to hold details about an Intruder attack.
+ */
+public interface IIntruderAttack
+{
+ /**
+ * This method is used to retrieve the HTTP service for the attack.
+ *
+ * @return The HTTP service for the attack.
+ */
+ IHttpService getHttpService();
+
+ /**
+ * This method is used to retrieve the request template for the attack.
+ *
+ * @return The request template for the attack.
+ */
+ byte[] getRequestTemplate();
+
+}
diff --git a/src/burp/IIntruderPayloadGenerator.java b/src/burp/IIntruderPayloadGenerator.java
new file mode 100644
index 0000000..802098c
--- /dev/null
+++ b/src/burp/IIntruderPayloadGenerator.java
@@ -0,0 +1,50 @@
+package burp;
+
+/*
+ * @(#)IIntruderPayloadGenerator.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used for custom Intruder payload generators. Extensions
+ * that have registered an
+ * IIntruderPayloadGeneratorFactory must return a new instance of
+ * this interface when required as part of a new Intruder attack.
+ */
+public interface IIntruderPayloadGenerator
+{
+ /**
+ * This method is used by Burp to determine whether the payload generator is
+ * able to provide any further payloads.
+ *
+ * @return Extensions should return
+ * false when all the available payloads have been used up,
+ * otherwise
+ * true.
+ */
+ boolean hasMorePayloads();
+
+ /**
+ * This method is used by Burp to obtain the value of the next payload.
+ *
+ * @param baseValue The base value of the current payload position. This
+ * value may be
+ * null if the concept of a base value is not applicable (e.g.
+ * in a battering ram attack).
+ * @return The next payload to use in the attack.
+ */
+ byte[] getNextPayload(byte[] baseValue);
+
+ /**
+ * This method is used by Burp to reset the state of the payload generator
+ * so that the next call to
+ * getNextPayload() returns the first payload again. This
+ * method will be invoked when an attack uses the same payload generator for
+ * more than one payload position, for example in a sniper attack.
+ */
+ void reset();
+}
diff --git a/src/burp/IIntruderPayloadGeneratorFactory.java b/src/burp/IIntruderPayloadGeneratorFactory.java
new file mode 100644
index 0000000..fd38553
--- /dev/null
+++ b/src/burp/IIntruderPayloadGeneratorFactory.java
@@ -0,0 +1,40 @@
+package burp;
+
+/*
+ * @(#)IIntruderPayloadGeneratorFactory.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerIntruderPayloadGeneratorFactory()
+ * to register a factory for custom Intruder payloads.
+ */
+public interface IIntruderPayloadGeneratorFactory
+{
+ /**
+ * This method is used by Burp to obtain the name of the payload generator.
+ * This will be displayed as an option within the Intruder UI when the user
+ * selects to use extension-generated payloads.
+ *
+ * @return The name of the payload generator.
+ */
+ String getGeneratorName();
+
+ /**
+ * This method is used by Burp when the user starts an Intruder attack that
+ * uses this payload generator.
+ *
+ * @param attack An
+ * IIntruderAttack object that can be queried to obtain details
+ * about the attack in which the payload generator will be used.
+ * @return A new instance of
+ * IIntruderPayloadGenerator that will be used to generate
+ * payloads for the attack.
+ */
+ IIntruderPayloadGenerator createNewInstance(IIntruderAttack attack);
+}
diff --git a/src/burp/IIntruderPayloadProcessor.java b/src/burp/IIntruderPayloadProcessor.java
new file mode 100644
index 0000000..ccd4725
--- /dev/null
+++ b/src/burp/IIntruderPayloadProcessor.java
@@ -0,0 +1,45 @@
+package burp;
+
+/*
+ * @(#)IIntruderPayloadProcessor.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerIntruderPayloadProcessor() to
+ * register a custom Intruder payload processor.
+ */
+public interface IIntruderPayloadProcessor
+{
+ /**
+ * This method is used by Burp to obtain the name of the payload processor.
+ * This will be displayed as an option within the Intruder UI when the user
+ * selects to use an extension-provided payload processor.
+ *
+ * @return The name of the payload processor.
+ */
+ String getProcessorName();
+
+ /**
+ * This method is invoked by Burp each time the processor should be applied
+ * to an Intruder payload.
+ *
+ * @param currentPayload The value of the payload to be processed.
+ * @param originalPayload The value of the original payload prior to
+ * processing by any already-applied processing rules.
+ * @param baseValue The base value of the payload position, which will be
+ * replaced with the current payload.
+ * @return The value of the processed payload. This may be
+ * null to indicate that the current payload should be skipped,
+ * and the attack will move directly to the next payload.
+ */
+ byte[] processPayload(
+ byte[] currentPayload,
+ byte[] originalPayload,
+ byte[] baseValue);
+}
diff --git a/src/burp/IMenuItemHandler.java b/src/burp/IMenuItemHandler.java
new file mode 100644
index 0000000..dc89560
--- /dev/null
+++ b/src/burp/IMenuItemHandler.java
@@ -0,0 +1,36 @@
+package burp;
+
+/*
+ * @(#)IMenuItemHandler.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerMenuItem() to register a custom
+ * context menu item.
+ *
+ * @deprecated Use
+ * IContextMenuFactory instead.
+ */
+@Deprecated
+public interface IMenuItemHandler
+{
+ /**
+ * This method is invoked by Burp Suite when the user clicks on a custom
+ * menu item which the extension has registered with Burp.
+ *
+ * @param menuItemCaption The caption of the menu item which was clicked.
+ * This parameter enables extensions to provide a single implementation
+ * which handles multiple different menu items.
+ * @param messageInfo Details of the HTTP message(s) for which the context
+ * menu was displayed.
+ */
+ void menuItemClicked(
+ String menuItemCaption,
+ IHttpRequestResponse[] messageInfo);
+}
diff --git a/src/burp/IMessageEditor.java b/src/burp/IMessageEditor.java
new file mode 100644
index 0000000..abea96b
--- /dev/null
+++ b/src/burp/IMessageEditor.java
@@ -0,0 +1,64 @@
+package burp;
+
+/*
+ * @(#)IMessageEditor.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.Component;
+
+/**
+ * This interface is used to provide extensions with an instance of Burp's HTTP
+ * message editor, for the extension to use in its own UI. Extensions should
+ * call
+ * IBurpExtenderCallbacks.createMessageEditor() to obtain an
+ * instance of this interface.
+ */
+public interface IMessageEditor
+{
+ /**
+ * This method returns the UI component of the editor, for extensions to add
+ * to their own UI.
+ *
+ * @return The UI component of the editor.
+ */
+ Component getComponent();
+
+ /**
+ * This method is used to display an HTTP message in the editor.
+ *
+ * @param message The HTTP message to be displayed.
+ * @param isRequest Flags whether the message is an HTTP request or
+ * response.
+ */
+ void setMessage(byte[] message, boolean isRequest);
+
+ /**
+ * This method is used to retrieve the currently displayed message, which
+ * may have been modified by the user.
+ *
+ * @return The currently displayed HTTP message.
+ */
+ byte[] getMessage();
+
+ /**
+ * This method is used to determine whether the current message has been
+ * modified by the user.
+ *
+ * @return An indication of whether the current message has been modified by
+ * the user since it was first displayed.
+ */
+ boolean isMessageModified();
+
+ /**
+ * This method returns the data that is currently selected by the user.
+ *
+ * @return The data that is currently selected by the user, or
+ * null if no selection is made.
+ */
+ byte[] getSelectedData();
+}
diff --git a/src/burp/IMessageEditorController.java b/src/burp/IMessageEditorController.java
new file mode 100644
index 0000000..81ba7b1
--- /dev/null
+++ b/src/burp/IMessageEditorController.java
@@ -0,0 +1,49 @@
+package burp;
+
+/*
+ * @(#)IMessageEditorController.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used by an
+ * IMessageEditor to obtain details about the currently displayed
+ * message. Extensions that create instances of Burp's HTTP message editor can
+ * optionally provide an implementation of
+ * IMessageEditorController, which the editor will invoke when it
+ * requires further information about the current message (for example, to send
+ * it to another Burp tool). Extensions that provide custom editor tabs via an
+ * IMessageEditorTabFactory will receive a reference to an
+ * IMessageEditorController object for each tab instance they
+ * generate, which the tab can invoke if it requires further information about
+ * the current message.
+ */
+public interface IMessageEditorController
+{
+ /**
+ * This method is used to retrieve the HTTP service for the current message.
+ *
+ * @return The HTTP service for the current message.
+ */
+ IHttpService getHttpService();
+
+ /**
+ * This method is used to retrieve the HTTP request associated with the
+ * current message (which may itself be a response).
+ *
+ * @return The HTTP request associated with the current message.
+ */
+ byte[] getRequest();
+
+ /**
+ * This method is used to retrieve the HTTP response associated with the
+ * current message (which may itself be a request).
+ *
+ * @return The HTTP response associated with the current message.
+ */
+ byte[] getResponse();
+}
diff --git a/src/burp/IMessageEditorTab.java b/src/burp/IMessageEditorTab.java
new file mode 100644
index 0000000..dceb304
--- /dev/null
+++ b/src/burp/IMessageEditorTab.java
@@ -0,0 +1,103 @@
+package burp;
+
+/*
+ * @(#)IMessageEditorTab.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.Component;
+
+/**
+ * Extensions that register an
+ * IMessageEditorTabFactory must return instances of this
+ * interface, which Burp will use to create custom tabs within its HTTP message
+ * editors.
+ */
+public interface IMessageEditorTab
+{
+ /**
+ * This method returns the caption that should appear on the custom tab when
+ * it is displayed. Note: Burp invokes this method once when the tab
+ * is first generated, and the same caption will be used every time the tab
+ * is displayed.
+ *
+ * @return The caption that should appear on the custom tab when it is
+ * displayed.
+ */
+ String getTabCaption();
+
+ /**
+ * This method returns the component that should be used as the contents of
+ * the custom tab when it is displayed. Note: Burp invokes this
+ * method once when the tab is first generated, and the same component will
+ * be used every time the tab is displayed.
+ *
+ * @return The component that should be used as the contents of the custom
+ * tab when it is displayed.
+ */
+ Component getUiComponent();
+
+ /**
+ * The hosting editor will invoke this method before it displays a new HTTP
+ * message, so that the custom tab can indicate whether it should be enabled
+ * for that message.
+ *
+ * @param content The message that is about to be displayed, or a zero-length
+ * array if the existing message is to be cleared.
+ * @param isRequest Indicates whether the message is a request or a
+ * response.
+ * @return The method should return
+ * true if the custom tab is able to handle the specified
+ * message, and so will be displayed within the editor. Otherwise, the tab
+ * will be hidden while this message is displayed.
+ */
+ boolean isEnabled(byte[] content, boolean isRequest);
+
+ /**
+ * The hosting editor will invoke this method to display a new message or to
+ * clear the existing message. This method will only be called with a new
+ * message if the tab has already returned
+ * true to a call to
+ * isEnabled() with the same message details.
+ *
+ * @param content The message that is to be displayed, or
+ * null if the tab should clear its contents and disable any
+ * editable controls.
+ * @param isRequest Indicates whether the message is a request or a
+ * response.
+ */
+ void setMessage(byte[] content, boolean isRequest);
+
+ /**
+ * This method returns the currently displayed message.
+ *
+ * @return The currently displayed message.
+ */
+ byte[] getMessage();
+
+ /**
+ * This method is used to determine whether the currently displayed message
+ * has been modified by the user. The hosting editor will always call
+ * getMessage() before calling this method, so any pending
+ * edits should be completed within
+ * getMessage().
+ *
+ * @return The method should return
+ * true if the user has modified the current message since it
+ * was first displayed.
+ */
+ boolean isModified();
+
+ /**
+ * This method is used to retrieve the data that is currently selected by
+ * the user.
+ *
+ * @return The data that is currently selected by the user. This may be
+ * null if no selection is currently made.
+ */
+ byte[] getSelectedData();
+}
diff --git a/src/burp/IMessageEditorTabFactory.java b/src/burp/IMessageEditorTabFactory.java
new file mode 100644
index 0000000..8882bb5
--- /dev/null
+++ b/src/burp/IMessageEditorTabFactory.java
@@ -0,0 +1,38 @@
+package burp;
+
+/*
+ * @(#)IMessageEditorTabFactory.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerMessageEditorTabFactory() to
+ * register a factory for custom message editor tabs. This allows extensions to
+ * provide custom rendering or editing of HTTP messages, within Burp's own HTTP
+ * editor.
+ */
+public interface IMessageEditorTabFactory
+{
+ /**
+ * Burp will call this method once for each HTTP message editor, and the
+ * factory should provide a new instance of an
+ * IMessageEditorTab object.
+ *
+ * @param controller An
+ * IMessageEditorController object, which the new tab can query
+ * to retrieve details about the currently displayed message. This may be
+ * null for extension-invoked message editors where the
+ * extension has not provided an editor controller.
+ * @param editable Indicates whether the hosting editor is editable or
+ * read-only.
+ * @return A new
+ * IMessageEditorTab object for use within the message editor.
+ */
+ IMessageEditorTab createNewInstance(IMessageEditorController controller,
+ boolean editable);
+}
diff --git a/src/burp/IParameter.java b/src/burp/IParameter.java
new file mode 100644
index 0000000..c9d3e50
--- /dev/null
+++ b/src/burp/IParameter.java
@@ -0,0 +1,104 @@
+package burp;
+
+/*
+ * @(#)IParameter.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to hold details about an HTTP request parameter.
+ */
+public interface IParameter
+{
+ /**
+ * Used to indicate a parameter within the URL query string.
+ */
+ static final byte PARAM_URL = 0;
+ /**
+ * Used to indicate a parameter within the message body.
+ */
+ static final byte PARAM_BODY = 1;
+ /**
+ * Used to indicate an HTTP cookie.
+ */
+ static final byte PARAM_COOKIE = 2;
+ /**
+ * Used to indicate an item of data within an XML structure.
+ */
+ static final byte PARAM_XML = 3;
+ /**
+ * Used to indicate the value of a tag attribute within an XML structure.
+ */
+ static final byte PARAM_XML_ATTR = 4;
+ /**
+ * Used to indicate the value of a parameter attribute within a multi-part
+ * message body (such as the name of an uploaded file).
+ */
+ static final byte PARAM_MULTIPART_ATTR = 5;
+ /**
+ * Used to indicate an item of data within a JSON structure.
+ */
+ static final byte PARAM_JSON = 6;
+
+ /**
+ * This method is used to retrieve the parameter type.
+ *
+ * @return The parameter type. The available types are defined within this
+ * interface.
+ */
+ byte getType();
+
+ /**
+ * This method is used to retrieve the parameter name.
+ *
+ * @return The parameter name.
+ */
+ String getName();
+
+ /**
+ * This method is used to retrieve the parameter value.
+ *
+ * @return The parameter value.
+ */
+ String getValue();
+
+ /**
+ * This method is used to retrieve the start offset of the parameter name
+ * within the HTTP request.
+ *
+ * @return The start offset of the parameter name within the HTTP request,
+ * or -1 if the parameter is not associated with a specific request.
+ */
+ int getNameStart();
+
+ /**
+ * This method is used to retrieve the end offset of the parameter name
+ * within the HTTP request.
+ *
+ * @return The end offset of the parameter name within the HTTP request, or
+ * -1 if the parameter is not associated with a specific request.
+ */
+ int getNameEnd();
+
+ /**
+ * This method is used to retrieve the start offset of the parameter value
+ * within the HTTP request.
+ *
+ * @return The start offset of the parameter value within the HTTP request,
+ * or -1 if the parameter is not associated with a specific request.
+ */
+ int getValueStart();
+
+ /**
+ * This method is used to retrieve the end offset of the parameter value
+ * within the HTTP request.
+ *
+ * @return The end offset of the parameter value within the HTTP request, or
+ * -1 if the parameter is not associated with a specific request.
+ */
+ int getValueEnd();
+}
diff --git a/src/burp/IProxyListener.java b/src/burp/IProxyListener.java
new file mode 100644
index 0000000..50811d3
--- /dev/null
+++ b/src/burp/IProxyListener.java
@@ -0,0 +1,37 @@
+package burp;
+
+/*
+ * @(#)IProxyListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerProxyListener() to register a
+ * Proxy listener. The listener will be notified of requests and responses being
+ * processed by the Proxy tool. Extensions can perform custom analysis or
+ * modification of these messages, and control in-UI message interception, by
+ * registering a proxy listener.
+ */
+public interface IProxyListener
+{
+ /**
+ * This method is invoked when an HTTP message is being processed by the
+ * Proxy.
+ *
+ * @param messageIsRequest Indicates whether the HTTP message is a request
+ * or a response.
+ * @param message An
+ * IInterceptedProxyMessage object that extensions can use to
+ * query and update details of the message, and control whether the message
+ * should be intercepted and displayed to the user for manual review or
+ * modification.
+ */
+ void processProxyMessage(
+ boolean messageIsRequest,
+ IInterceptedProxyMessage message);
+}
diff --git a/src/burp/IRequestInfo.java b/src/burp/IRequestInfo.java
new file mode 100644
index 0000000..f10cbd9
--- /dev/null
+++ b/src/burp/IRequestInfo.java
@@ -0,0 +1,95 @@
+package burp;
+
+/*
+ * @(#)IRequestInfo.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.net.URL;
+import java.util.List;
+
+/**
+ * This interface is used to retrieve key details about an HTTP request.
+ * Extensions can obtain an
+ * IRequestInfo object for a given request by calling
+ * IExtensionHelpers.analyzeRequest().
+ */
+public interface IRequestInfo
+{
+ /**
+ * Used to indicate that there is no content.
+ */
+ static final byte CONTENT_TYPE_NONE = 0;
+ /**
+ * Used to indicate URL-encoded content.
+ */
+ static final byte CONTENT_TYPE_URL_ENCODED = 1;
+ /**
+ * Used to indicate multi-part content.
+ */
+ static final byte CONTENT_TYPE_MULTIPART = 2;
+ /**
+ * Used to indicate XML content.
+ */
+ static final byte CONTENT_TYPE_XML = 3;
+ /**
+ * Used to indicate JSON content.
+ */
+ static final byte CONTENT_TYPE_JSON = 4;
+ /**
+ * Used to indicate AMF content.
+ */
+ static final byte CONTENT_TYPE_AMF = 5;
+ /**
+ * Used to indicate unknown content.
+ */
+ static final byte CONTENT_TYPE_UNKNOWN = -1;
+
+ /**
+ * This method is used to obtain the HTTP method used in the request.
+ *
+ * @return The HTTP method used in the request.
+ */
+ String getMethod();
+
+ /**
+ * This method is used to obtain the URL in the request.
+ *
+ * @return The URL in the request.
+ */
+ URL getUrl();
+
+ /**
+ * This method is used to obtain the HTTP headers contained in the request.
+ *
+ * @return The HTTP headers contained in the request.
+ */
+ List getHeaders();
+
+ /**
+ * This method is used to obtain the parameters contained in the request.
+ *
+ * @return The parameters contained in the request.
+ */
+ List getParameters();
+
+ /**
+ * This method is used to obtain the offset within the request where the
+ * message body begins.
+ *
+ * @return The offset within the request where the message body begins.
+ */
+ int getBodyOffset();
+
+ /**
+ * This method is used to obtain the content type of the message body.
+ *
+ * @return An indication of the content type of the message body. Available
+ * types are defined within this interface.
+ */
+ byte getContentType();
+}
diff --git a/src/burp/IResponseInfo.java b/src/burp/IResponseInfo.java
new file mode 100644
index 0000000..a7a3551
--- /dev/null
+++ b/src/burp/IResponseInfo.java
@@ -0,0 +1,73 @@
+package burp;
+
+/*
+ * @(#)IResponseInfo.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * This interface is used to retrieve key details about an HTTP response.
+ * Extensions can obtain an
+ * IResponseInfo object for a given response by calling
+ * IExtensionHelpers.analyzeResponse().
+ */
+public interface IResponseInfo
+{
+ /**
+ * This method is used to obtain the HTTP headers contained in the response.
+ *
+ * @return The HTTP headers contained in the response.
+ */
+ List getHeaders();
+
+ /**
+ * This method is used to obtain the offset within the response where the
+ * message body begins.
+ *
+ * @return The offset within the response where the message body begins.
+ */
+ int getBodyOffset();
+
+ /**
+ * This method is used to obtain the HTTP status code contained in the
+ * response.
+ *
+ * @return The HTTP status code contained in the response.
+ */
+ short getStatusCode();
+
+ /**
+ * This method is used to obtain details of the HTTP cookies set in the
+ * response.
+ *
+ * @return A list of ICookie objects representing the cookies
+ * set in the response, if any.
+ */
+ List getCookies();
+
+ /**
+ * This method is used to obtain the MIME type of the response, as stated in
+ * the HTTP headers.
+ *
+ * @return A textual label for the stated MIME type, or an empty String if
+ * this is not known or recognized. The possible labels are the same as
+ * those used in the main Burp UI.
+ */
+ String getStatedMimeType();
+
+ /**
+ * This method is used to obtain the MIME type of the response, as inferred
+ * from the contents of the HTTP message body.
+ *
+ * @return A textual label for the inferred MIME type, or an empty String if
+ * this is not known or recognized. The possible labels are the same as
+ * those used in the main Burp UI.
+ */
+ String getInferredMimeType();
+}
diff --git a/src/burp/IScanIssue.java b/src/burp/IScanIssue.java
new file mode 100644
index 0000000..6348d05
--- /dev/null
+++ b/src/burp/IScanIssue.java
@@ -0,0 +1,120 @@
+package burp;
+
+/*
+ * @(#)IScanIssue.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to retrieve details of Scanner issues. Extensions can
+ * obtain details of issues by registering an
+ * IScannerListener or by calling
+ * IBurpExtenderCallbacks.getScanIssues(). Extensions can also add
+ * custom Scanner issues by registering an
+ * IScannerCheck or calling
+ * IBurpExtenderCallbacks.addScanIssue(), and providing their own
+ * implementations of this interface
+ */
+public interface IScanIssue
+{
+ /**
+ * This method returns the URL for which the issue was generated.
+ *
+ * @return The URL for which the issue was generated.
+ */
+ java.net.URL getUrl();
+
+ /**
+ * This method returns the name of the issue type.
+ *
+ * @return The name of the issue type (e.g. "SQL injection").
+ */
+ String getIssueName();
+
+ /**
+ * This method returns a numeric identifier of the issue type. See the Burp
+ * Scanner help documentation for a listing of all the issue types.
+ *
+ * @return A numeric identifier of the issue type.
+ */
+ int getIssueType();
+
+ /**
+ * This method returns the issue severity level.
+ *
+ * @return The issue severity level. Expected values are "High", "Medium",
+ * "Low", "Information" or "False positive".
+ *
+ */
+ String getSeverity();
+
+ /**
+ * This method returns the issue confidence level.
+ *
+ * @return The issue confidence level. Expected values are "Certain", "Firm"
+ * or "Tentative".
+ */
+ String getConfidence();
+
+ /**
+ * This method returns a background description for this type of issue.
+ *
+ * @return A background description for this type of issue, or
+ * null if none applies.
+ */
+ String getIssueBackground();
+
+ /**
+ * This method returns a background description of the remediation for this
+ * type of issue.
+ *
+ * @return A background description of the remediation for this type of
+ * issue, or
+ * null if none applies.
+ */
+ String getRemediationBackground();
+
+ /**
+ * This method returns detailed information about this specific instance of
+ * the issue.
+ *
+ * @return Detailed information about this specific instance of the issue,
+ * or
+ * null if none applies.
+ */
+ String getIssueDetail();
+
+ /**
+ * This method returns detailed information about the remediation for this
+ * specific instance of the issue.
+ *
+ * @return Detailed information about the remediation for this specific
+ * instance of the issue, or
+ * null if none applies.
+ */
+ String getRemediationDetail();
+
+ /**
+ * This method returns the HTTP messages on the basis of which the issue was
+ * generated.
+ *
+ * @return The HTTP messages on the basis of which the issue was generated.
+ * Note: The items in this array should be instances of
+ * IHttpRequestResponseWithMarkers if applicable, so that
+ * details of the relevant portions of the request and response messages are
+ * available.
+ */
+ IHttpRequestResponse[] getHttpMessages();
+
+ /**
+ * This method returns the HTTP service for which the issue was generated.
+ *
+ * @return The HTTP service for which the issue was generated.
+ */
+ IHttpService getHttpService();
+
+}
diff --git a/src/burp/IScanQueueItem.java b/src/burp/IScanQueueItem.java
new file mode 100644
index 0000000..e0c50d7
--- /dev/null
+++ b/src/burp/IScanQueueItem.java
@@ -0,0 +1,80 @@
+package burp;
+
+/*
+ * @(#)IScanQueueItem.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to retrieve details of items in the Burp Scanner
+ * active scan queue. Extensions can obtain references to scan queue items by
+ * calling
+ * IBurpExtenderCallbacks.doActiveScan().
+ */
+public interface IScanQueueItem
+{
+ /**
+ * This method returns a description of the status of the scan queue item.
+ *
+ * @return A description of the status of the scan queue item.
+ */
+ String getStatus();
+
+ /**
+ * This method returns an indication of the percentage completed for the
+ * scan queue item.
+ *
+ * @return An indication of the percentage completed for the scan queue
+ * item.
+ */
+ byte getPercentageComplete();
+
+ /**
+ * This method returns the number of requests that have been made for the
+ * scan queue item.
+ *
+ * @return The number of requests that have been made for the scan queue
+ * item.
+ */
+ int getNumRequests();
+
+ /**
+ * This method returns the number of network errors that have occurred for
+ * the scan queue item.
+ *
+ * @return The number of network errors that have occurred for the scan
+ * queue item.
+ */
+ int getNumErrors();
+
+ /**
+ * This method returns the number of attack insertion points being used for
+ * the scan queue item.
+ *
+ * @return The number of attack insertion points being used for the scan
+ * queue item.
+ */
+ int getNumInsertionPoints();
+
+ /**
+ * This method allows the scan queue item to be canceled.
+ */
+ void cancel();
+
+ /**
+ * This method returns details of the issues generated for the scan queue
+ * item. Note: different items within the scan queue may contain
+ * duplicated versions of the same issues - for example, if the same request
+ * has been scanned multiple times. Duplicated issues are consolidated in
+ * the main view of scan results. Extensions can register an
+ * IScannerListener to get details only of unique, newly
+ * discovered Scanner issues post-consolidation.
+ *
+ * @return Details of the issues generated for the scan queue item.
+ */
+ IScanIssue[] getIssues();
+}
diff --git a/src/burp/IScannerCheck.java b/src/burp/IScannerCheck.java
new file mode 100644
index 0000000..921eff8
--- /dev/null
+++ b/src/burp/IScannerCheck.java
@@ -0,0 +1,83 @@
+package burp;
+
+/*
+ * @(#)IScannerCheck.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerScannerCheck() to register a
+ * custom Scanner check. When performing scanning, Burp will ask the check to
+ * perform active or passive scanning on the base request, and report any
+ * Scanner issues that are identified.
+ */
+public interface IScannerCheck
+{
+
+ /**
+ * The Scanner invokes this method for each base request / response that is
+ * passively scanned. Note: Extensions should only analyze the
+ * HTTP messages provided during passive scanning, and should not make any
+ * new HTTP requests of their own.
+ *
+ * @param baseRequestResponse The base HTTP request / response that should
+ * be passively scanned.
+ * @return A list of IScanIssue objects, or null
+ * if no issues are identified.
+ */
+ List doPassiveScan(IHttpRequestResponse baseRequestResponse);
+
+ /**
+ * The Scanner invokes this method for each insertion point that is actively
+ * scanned. Extensions may issue HTTP requests as required to carry out
+ * active scanning, and should use the
+ * IScannerInsertionPoint object provided to build scan
+ * requests for particular payloads.
+ * Note:
+ * Scan checks should submit raw non-encoded payloads to insertion points,
+ * and the insertion point has responsibility for performing any data
+ * encoding that is necessary given the nature and location of the insertion
+ * point.
+ *
+ * @param baseRequestResponse The base HTTP request / response that should
+ * be actively scanned.
+ * @param insertionPoint An IScannerInsertionPoint object that
+ * can be queried to obtain details of the insertion point being tested, and
+ * can be used to build scan requests for particular payloads.
+ * @return A list of IScanIssue objects, or null
+ * if no issues are identified.
+ */
+ List doActiveScan(
+ IHttpRequestResponse baseRequestResponse,
+ IScannerInsertionPoint insertionPoint);
+
+ /**
+ * The Scanner invokes this method when the custom Scanner check has
+ * reported multiple issues for the same URL path. This can arise either
+ * because there are multiple distinct vulnerabilities, or because the same
+ * (or a similar) request has been scanned more than once. The custom check
+ * should determine whether the issues are duplicates. In most cases, where
+ * a check uses distinct issue names or descriptions for distinct issues,
+ * the consolidation process will simply be a matter of comparing these
+ * features for the two issues.
+ *
+ * @param existingIssue An issue that was previously reported by this
+ * Scanner check.
+ * @param newIssue An issue at the same URL path that has been newly
+ * reported by this Scanner check.
+ * @return An indication of which issue(s) should be reported in the main
+ * Scanner results. The method should return -1 to report the
+ * existing issue only, 0 to report both issues, and
+ * 1 to report the new issue only.
+ */
+ int consolidateDuplicateIssues(
+ IScanIssue existingIssue,
+ IScanIssue newIssue);
+}
diff --git a/src/burp/IScannerInsertionPoint.java b/src/burp/IScannerInsertionPoint.java
new file mode 100644
index 0000000..17a0b26
--- /dev/null
+++ b/src/burp/IScannerInsertionPoint.java
@@ -0,0 +1,174 @@
+package burp;
+
+/*
+ * @(#)IScannerInsertionPoint.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to define an insertion point for use by active Scanner
+ * checks. Extensions can obtain instances of this interface by registering an
+ * IScannerCheck, or can create instances for use by Burp's own
+ * scan checks by registering an
+ * IScannerInsertionPointProvider.
+ */
+public interface IScannerInsertionPoint
+{
+
+ /**
+ * Used to indicate where the payload is inserted into the value of a URL
+ * parameter.
+ */
+ static final byte INS_PARAM_URL = 0x00;
+ /**
+ * Used to indicate where the payload is inserted into the value of a body
+ * parameter.
+ */
+ static final byte INS_PARAM_BODY = 0x01;
+ /**
+ * Used to indicate where the payload is inserted into the value of an HTTP
+ * cookie.
+ */
+ static final byte INS_PARAM_COOKIE = 0x02;
+ /**
+ * Used to indicate where the payload is inserted into the value of an item
+ * of data within an XML data structure.
+ */
+ static final byte INS_PARAM_XML = 0x03;
+ /**
+ * Used to indicate where the payload is inserted into the value of a tag
+ * attribute within an XML structure.
+ */
+ static final byte INS_PARAM_XML_ATTR = 0x04;
+ /**
+ * Used to indicate where the payload is inserted into the value of a
+ * parameter attribute within a multi-part message body (such as the name of
+ * an uploaded file).
+ */
+ static final byte INS_PARAM_MULTIPART_ATTR = 0x05;
+ /**
+ * Used to indicate where the payload is inserted into the value of an item
+ * of data within a JSON structure.
+ */
+ static final byte INS_PARAM_JSON = 0x06;
+ /**
+ * Used to indicate where the payload is inserted into the value of an AMF
+ * parameter.
+ */
+ static final byte INS_PARAM_AMF = 0x07;
+ /**
+ * Used to indicate where the payload is inserted into the value of an HTTP
+ * request header.
+ */
+ static final byte INS_HEADER = 0x20;
+ /**
+ * Used to indicate where the payload is inserted into a URL path folder.
+ */
+ static final byte INS_URL_PATH_FOLDER = 0x21;
+ /**
+ * Used to indicate where the payload is inserted into a URL path folder.
+ * This is now deprecated; use INS_URL_PATH_FOLDER instead.
+ */
+ @Deprecated
+ static final byte INS_URL_PATH_REST = INS_URL_PATH_FOLDER;
+ /**
+ * Used to indicate where the payload is inserted into the name of an added
+ * URL parameter.
+ */
+ static final byte INS_PARAM_NAME_URL = 0x22;
+ /**
+ * Used to indicate where the payload is inserted into the name of an added
+ * body parameter.
+ */
+ static final byte INS_PARAM_NAME_BODY = 0x23;
+ /**
+ * Used to indicate where the payload is inserted into the body of the HTTP
+ * request.
+ */
+ static final byte INS_ENTIRE_BODY = 0x24;
+ /**
+ * Used to indicate where the payload is inserted into the URL path
+ * filename.
+ */
+ static final byte INS_URL_PATH_FILENAME = 0x25;
+ /**
+ * Used to indicate where the payload is inserted at a location manually
+ * configured by the user.
+ */
+ static final byte INS_USER_PROVIDED = 0x40;
+ /**
+ * Used to indicate where the insertion point is provided by an
+ * extension-registered
+ * IScannerInsertionPointProvider.
+ */
+ static final byte INS_EXTENSION_PROVIDED = 0x41;
+ /**
+ * Used to indicate where the payload is inserted at an unknown location
+ * within the request.
+ */
+ static final byte INS_UNKNOWN = 0x7f;
+
+ /**
+ * This method returns the name of the insertion point.
+ *
+ * @return The name of the insertion point (for example, a description of a
+ * particular request parameter).
+ */
+ String getInsertionPointName();
+
+ /**
+ * This method returns the base value for this insertion point.
+ *
+ * @return the base value that appears in this insertion point in the base
+ * request being scanned, or null if there is no value in the
+ * base request that corresponds to this insertion point.
+ */
+ String getBaseValue();
+
+ /**
+ * This method is used to build a request with the specified payload placed
+ * into the insertion point. There is no requirement for extension-provided
+ * insertion points to adjust the Content-Length header in requests if the
+ * body length has changed, although Burp-provided insertion points will
+ * always do this and will return a request with a valid Content-Length
+ * header.
+ * Note:
+ * Scan checks should submit raw non-encoded payloads to insertion points,
+ * and the insertion point has responsibility for performing any data
+ * encoding that is necessary given the nature and location of the insertion
+ * point.
+ *
+ * @param payload The payload that should be placed into the insertion
+ * point.
+ * @return The resulting request.
+ */
+ byte[] buildRequest(byte[] payload);
+
+ /**
+ * This method is used to determine the offsets of the payload value within
+ * the request, when it is placed into the insertion point. Scan checks may
+ * invoke this method when reporting issues, so as to highlight the relevant
+ * part of the request within the UI.
+ *
+ * @param payload The payload that should be placed into the insertion
+ * point.
+ * @return An int[2] array containing the start and end offsets of the
+ * payload within the request, or null if this is not applicable (for
+ * example, where the insertion point places a payload into a serialized
+ * data structure, the raw payload may not literally appear anywhere within
+ * the resulting request).
+ */
+ int[] getPayloadOffsets(byte[] payload);
+
+ /**
+ * This method returns the type of the insertion point.
+ *
+ * @return The type of the insertion point. Available types are defined in
+ * this interface.
+ */
+ byte getInsertionPointType();
+}
diff --git a/src/burp/IScannerInsertionPointProvider.java b/src/burp/IScannerInsertionPointProvider.java
new file mode 100644
index 0000000..c000fcc
--- /dev/null
+++ b/src/burp/IScannerInsertionPointProvider.java
@@ -0,0 +1,38 @@
+package burp;
+
+/*
+ * @(#)IScannerInsertionPointProvider.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerScannerInsertionPointProvider()
+ * to register a factory for custom Scanner insertion points.
+ */
+public interface IScannerInsertionPointProvider
+{
+ /**
+ * When a request is actively scanned, the Scanner will invoke this method,
+ * and the provider should provide a list of custom insertion points that
+ * will be used in the scan. Note: these insertion points are used in
+ * addition to those that are derived from Burp Scanner's configuration, and
+ * those provided by any other Burp extensions.
+ *
+ * @param baseRequestResponse The base request that will be actively
+ * scanned.
+ * @return A list of
+ * IScannerInsertionPoint objects that should be used in the
+ * scanning, or
+ * null if no custom insertion points are applicable for this
+ * request.
+ */
+ List getInsertionPoints(
+ IHttpRequestResponse baseRequestResponse);
+}
diff --git a/src/burp/IScannerListener.java b/src/burp/IScannerListener.java
new file mode 100644
index 0000000..76edc4e
--- /dev/null
+++ b/src/burp/IScannerListener.java
@@ -0,0 +1,30 @@
+package burp;
+
+/*
+ * @(#)IScannerListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerScannerListener() to register a
+ * Scanner listener. The listener will be notified of new issues that are
+ * reported by the Scanner tool. Extensions can perform custom analysis or
+ * logging of Scanner issues by registering a Scanner listener.
+ */
+public interface IScannerListener
+{
+ /**
+ * This method is invoked when a new issue is added to Burp Scanner's
+ * results.
+ *
+ * @param issue An
+ * IScanIssue object that the extension can query to obtain
+ * details about the new issue.
+ */
+ void newScanIssue(IScanIssue issue);
+}
diff --git a/src/burp/IScopeChangeListener.java b/src/burp/IScopeChangeListener.java
new file mode 100644
index 0000000..6a6d7d1
--- /dev/null
+++ b/src/burp/IScopeChangeListener.java
@@ -0,0 +1,25 @@
+package burp;
+
+/*
+ * @(#)IScopeChangeListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerScopeChangeListener() to register
+ * a scope change listener. The listener will be notified whenever a change
+ * occurs to Burp's suite-wide target scope.
+ */
+public interface IScopeChangeListener
+{
+ /**
+ * This method is invoked whenever a change occurs to Burp's suite-wide
+ * target scope.
+ */
+ void scopeChanged();
+}
diff --git a/src/burp/ISessionHandlingAction.java b/src/burp/ISessionHandlingAction.java
new file mode 100644
index 0000000..fb011cf
--- /dev/null
+++ b/src/burp/ISessionHandlingAction.java
@@ -0,0 +1,51 @@
+package burp;
+
+/*
+ * @(#)ISessionHandlingAction.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * IBurpExtenderCallbacks.registerSessionHandlingAction() to
+ * register a custom session handling action. Each registered action will be
+ * available within the session handling rule UI for the user to select as a
+ * rule action. Users can choose to invoke an action directly in its own right,
+ * or following execution of a macro.
+ */
+public interface ISessionHandlingAction
+{
+ /**
+ * This method is used by Burp to obtain the name of the session handling
+ * action. This will be displayed as an option within the session handling
+ * rule editor when the user selects to execute an extension-provided
+ * action.
+ *
+ * @return The name of the action.
+ */
+ String getActionName();
+
+ /**
+ * This method is invoked when the session handling action should be
+ * executed. This may happen as an action in its own right, or as a
+ * sub-action following execution of a macro.
+ *
+ * @param currentRequest The base request that is currently being processed.
+ * The action can query this object to obtain details about the base
+ * request. It can issue additional requests of its own if necessary, and
+ * can use the setter methods on this object to update the base request.
+ * @param macroItems If the action is invoked following execution of a
+ * macro, this parameter contains the result of executing the macro.
+ * Otherwise, it is
+ * null. Actions can use the details of the macro items to
+ * perform custom analysis of the macro to derive values of non-standard
+ * session handling tokens, etc.
+ */
+ void performAction(
+ IHttpRequestResponse currentRequest,
+ IHttpRequestResponse[] macroItems);
+}
diff --git a/src/burp/ITab.java b/src/burp/ITab.java
new file mode 100644
index 0000000..57f1680
--- /dev/null
+++ b/src/burp/ITab.java
@@ -0,0 +1,38 @@
+package burp;
+
+/*
+ * @(#)ITab.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.Component;
+
+/**
+ * This interface is used to provide Burp with details of a custom tab that will
+ * be added to Burp's UI, using a method such as
+ * IBurpExtenderCallbacks.addSuiteTab().
+ */
+public interface ITab
+{
+ /**
+ * Burp uses this method to obtain the caption that should appear on the
+ * custom tab when it is displayed.
+ *
+ * @return The caption that should appear on the custom tab when it is
+ * displayed.
+ */
+ String getTabCaption();
+
+ /**
+ * Burp uses this method to obtain the component that should be used as the
+ * contents of the custom tab when it is displayed.
+ *
+ * @return The component that should be used as the contents of the custom
+ * tab when it is displayed.
+ */
+ Component getUiComponent();
+}
diff --git a/src/burp/ITempFile.java b/src/burp/ITempFile.java
new file mode 100644
index 0000000..1bf149c
--- /dev/null
+++ b/src/burp/ITempFile.java
@@ -0,0 +1,33 @@
+package burp;
+
+/*
+ * @(#)ITempFile.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to hold details of a temporary file that has been
+ * created via a call to
+ * IBurpExtenderCallbacks.saveToTempFile().
+ *
+ */
+public interface ITempFile
+{
+ /**
+ * This method is used to retrieve the contents of the buffer that was saved
+ * in the temporary file.
+ *
+ * @return The contents of the buffer that was saved in the temporary file.
+ */
+ byte[] getBuffer();
+
+ /**
+ * This method is deprecated and no longer performs any action.
+ */
+ @Deprecated
+ void delete();
+}
diff --git a/src/burp/ITextEditor.java b/src/burp/ITextEditor.java
new file mode 100644
index 0000000..0d5f6d0
--- /dev/null
+++ b/src/burp/ITextEditor.java
@@ -0,0 +1,90 @@
+package burp;
+
+/*
+ * @(#)ITextEditor.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.awt.Component;
+
+/**
+ * This interface is used to provide extensions with an instance of Burp's raw
+ * text editor, for the extension to use in its own UI. Extensions should call
+ * IBurpExtenderCallbacks.createTextEditor() to obtain an instance
+ * of this interface.
+ */
+public interface ITextEditor
+{
+ /**
+ * This method returns the UI component of the editor, for extensions to add
+ * to their own UI.
+ *
+ * @return The UI component of the editor.
+ */
+ Component getComponent();
+
+ /**
+ * This method is used to control whether the editor is currently editable.
+ * This status can be toggled on and off as required.
+ *
+ * @param editable Indicates whether the editor should be currently
+ * editable.
+ */
+ void setEditable(boolean editable);
+
+ /**
+ * This method is used to update the currently displayed text in the editor.
+ *
+ * @param text The text to be displayed.
+ */
+ void setText(byte[] text);
+
+ /**
+ * This method is used to retrieve the currently displayed text.
+ *
+ * @return The currently displayed text.
+ */
+ byte[] getText();
+
+ /**
+ * This method is used to determine whether the user has modified the
+ * contents of the editor.
+ *
+ * @return An indication of whether the user has modified the contents of
+ * the editor since the last call to
+ * setText().
+ */
+ boolean isTextModified();
+
+ /**
+ * This method is used to obtain the currently selected text.
+ *
+ * @return The currently selected text, or
+ * null if the user has not made any selection.
+ */
+ byte[] getSelectedText();
+
+ /**
+ * This method can be used to retrieve the bounds of the user's selection
+ * into the displayed text, if applicable.
+ *
+ * @return An int[2] array containing the start and end offsets of the
+ * user's selection within the displayed text. If the user has not made any
+ * selection in the current message, both offsets indicate the position of
+ * the caret within the editor.
+ */
+ int[] getSelectionBounds();
+
+ /**
+ * This method is used to update the search expression that is shown in the
+ * search bar below the editor. The editor will automatically highlight any
+ * regions of the displayed text that match the search expression.
+ *
+ * @param expression The search expression.
+ */
+ void setSearchExpression(String expression);
+}
diff --git a/src/burp/MenuActions.java b/src/burp/MenuActions.java
new file mode 100644
index 0000000..8506275
--- /dev/null
+++ b/src/burp/MenuActions.java
@@ -0,0 +1,14 @@
+package burp;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public enum MenuActions {
+ A_SEND_TO_EM,
+ A_REMOVE_MSG,
+ A_REMOVE_ALL,
+ A_MOVE_UP_EXT,
+ A_MOVE_DOWN_EXT,
+ A_MOVE_UP_REP,
+ A_MOVE_DOWN_REP
+}
diff --git a/src/burp/MenuListener.java b/src/burp/MenuListener.java
new file mode 100644
index 0000000..2b5ecfc
--- /dev/null
+++ b/src/burp/MenuListener.java
@@ -0,0 +1,76 @@
+package burp;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+/**
+ * Created by fruh on 8/31/16.
+ */
+public class MenuListener implements ActionListener {
+ private MenuActions action;
+ private IHttpRequestResponse[] messages;
+ private BurpExtender extender;
+ private MessagesTable table;
+ private MessagesModel model;
+
+ public MenuListener(BurpExtender extender, MenuActions action, MessagesTable table) {
+ this.extender = extender;
+ this.action = action;
+ this.table = table;
+ this.model = (MessagesModel) table.getModel();
+ }
+
+ public MenuListener(BurpExtender extender, IHttpRequestResponse[] messages, MenuActions action, MessagesTable table) {
+ this.messages = messages;
+ this.action = action;
+ this.extender = extender;
+ this.table = table;
+ this.model = (MessagesModel) table.getModel();
+ }
+
+ @Override
+ public void actionPerformed(ActionEvent actionEvent) {
+ switch (action) {
+ case A_SEND_TO_EM:
+ for (IHttpRequestResponse msgInfo: messages) {
+ // add message to table model
+ model.addMessage(msgInfo, extender.getNextMsgId());
+ }
+ break;
+
+ case A_REMOVE_MSG:
+ if (table.getSelectedRow() >= 0) {
+ model.removeRow(table.getSelectedRow());
+ }
+ break;
+
+ case A_REMOVE_ALL:
+ model.removeAll();
+ break;
+
+ case A_MOVE_UP_EXT:
+ if (extender.canBeMoved(action)) {
+ model.moveUp(table.getSelectedRow(), true);
+ }
+ break;
+
+ case A_MOVE_DOWN_EXT:
+ if (extender.canBeMoved(action)) {
+ model.moveDown(table.getSelectedRow(), true);
+ }
+ break;
+
+ case A_MOVE_UP_REP:
+ if (extender.canBeMoved(action)) {
+ model.moveUp(table.getSelectedRow(), false);
+ }
+ break;
+
+ case A_MOVE_DOWN_REP:
+ if (extender.canBeMoved(action)) {
+ model.moveDown(table.getSelectedRow(), false);
+ }
+ break;
+ }
+ }
+}
diff --git a/src/burp/Message.java b/src/burp/Message.java
new file mode 100644
index 0000000..e9e8fc9
--- /dev/null
+++ b/src/burp/Message.java
@@ -0,0 +1,49 @@
+package burp;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public class Message {
+ private IHttpRequestResponse messageInfo;
+ private String id;
+ private Set repRefSet;
+ private Set extRefSet;
+
+ public Message(IHttpRequestResponse messageInfo, String id) {
+ this.messageInfo = messageInfo;
+ this.id = id;
+ repRefSet = new HashSet<>();
+ extRefSet = new HashSet<>();
+ }
+
+ public IHttpRequestResponse getMessageInfo() {
+ return messageInfo;
+ }
+
+ public void setMessageInfo(IHttpRequestResponse messageInfo) {
+ this.messageInfo = messageInfo;
+ }
+
+ public Set getRepRefSet() {
+ return repRefSet;
+ }
+
+ public Set getExtRefSet() {
+ return extRefSet;
+ }
+
+ public boolean hasExtraction() {
+ return extRefSet.size() > 0;
+ }
+
+ public boolean hasReplace() {
+ return repRefSet.size() > 0;
+ }
+
+ public String getId() {
+ return id;
+ }
+}
diff --git a/src/burp/MessagesController.java b/src/burp/MessagesController.java
new file mode 100644
index 0000000..f13098b
--- /dev/null
+++ b/src/burp/MessagesController.java
@@ -0,0 +1,45 @@
+package burp;
+
+import javax.swing.*;
+
+/**
+ * Created by fruh on 8/31/16.
+ */
+public class MessagesController implements IMessageEditorController {
+ private JTable table;
+
+ public MessagesController(JTable table) {
+ this.table = table;
+ }
+
+ public IHttpRequestResponse getSelectedMessageInfo() {
+ MessagesModel model = (MessagesModel) table.getModel();
+ return model.getMessageInfo(table.getSelectedRow());
+ }
+
+ public Message getSelectedMessage() {
+ MessagesModel model = (MessagesModel) table.getModel();
+ return model.getMessage(table.getSelectedRow());
+ }
+
+ @Override
+ public IHttpService getHttpService() {
+ IHttpRequestResponse msgInfo = getSelectedMessageInfo();
+
+ return msgInfo == null ? null : msgInfo.getHttpService();
+ }
+
+ @Override
+ public byte[] getRequest() {
+ IHttpRequestResponse msgInfo = getSelectedMessageInfo();
+
+ return msgInfo == null ? null : msgInfo.getRequest();
+ }
+
+ @Override
+ public byte[] getResponse() {
+ IHttpRequestResponse msgInfo = getSelectedMessageInfo();
+
+ return msgInfo == null ? null : msgInfo.getResponse();
+ }
+}
diff --git a/src/burp/MessagesModel.java b/src/burp/MessagesModel.java
new file mode 100644
index 0000000..bcfe578
--- /dev/null
+++ b/src/burp/MessagesModel.java
@@ -0,0 +1,224 @@
+package burp;
+
+import javax.swing.table.AbstractTableModel;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Created by fruh on 8/31/16.
+ */
+public class MessagesModel extends AbstractTableModel {
+ private List messages;
+ private Map messagesMap;
+ private IExtensionHelpers helpers;
+ private ExtractionTable extractionTable;
+ private ReplaceTable replaceTable;
+ private MessagesTable extMsgTable;
+ private MessagesTable repMsgTable;
+ private String[] cols = {"MsgID", "Host", "Method", "URL"};
+
+ public MessagesModel(IExtensionHelpers helpers) {
+ this.helpers = helpers;
+ messages = new LinkedList<>();
+ messagesMap = new HashMap<>();
+ this.extractionTable = null;
+ this.replaceTable = null;
+ this.extMsgTable = null;
+ this.repMsgTable = null;
+ }
+
+ public MessagesModel(IExtensionHelpers helpers, ExtractionTable extractionTable, ReplaceTable replaceTable,
+ MessagesTable extMsgTable, MessagesTable repMsgTable) {
+ this.helpers = helpers;
+ messages = new LinkedList<>();
+ messagesMap = new HashMap<>();
+ this.extractionTable = extractionTable;
+ this.replaceTable = replaceTable;
+ this.extMsgTable = extMsgTable;
+ this.repMsgTable = repMsgTable;
+ }
+
+ @Override
+ public int getRowCount() {
+ return messages.size();
+ }
+
+ @Override
+ public int getColumnCount() {
+ return cols.length;
+ }
+
+ @Override
+ public String getColumnName(int index) {
+ if (index < cols.length) {
+ return cols[index];
+ }
+ return null;
+ }
+
+ public IHttpRequestResponse getMessageInfo(int i) {
+ if (i >= 0 && i < messages.size()) {
+ return messages.get(i).getMessageInfo();
+ }
+ return null;
+ }
+
+ public int getRowById(String id) {
+ int row = -1;
+
+ if (messages.size() > 0) {
+ for (row = 0; row < messages.size(); row++) {
+ if (id == messages.get(row).getId()) {
+ break;
+ }
+ }
+ }
+ return row;
+ }
+
+ public Message getMessage(int i) {
+ if (i >= 0 && i < messages.size()) {
+ return messages.get(i);
+ }
+ return null;
+ }
+
+ public Message getMessageById(String id) {
+ return messagesMap.get(id);
+ }
+
+ @Override
+ public Object getValueAt(int row, int col) {
+ IRequestInfo rqInfo = helpers.analyzeRequest(messages.get(row).getMessageInfo());
+ String ret;
+
+ switch (col) {
+ case 0:
+ ret = messages.get(row).getId();
+ break;
+
+ case 1:
+ ret = messages.get(row).getMessageInfo().getHttpService().getProtocol() + "://" +
+ messages.get(row).getMessageInfo().getHttpService().getHost() + ":" +
+ messages.get(row).getMessageInfo().getHttpService().getPort();
+ break;
+
+ case 2:
+ ret = rqInfo.getMethod();
+ break;
+
+ case 3:
+ ret = rqInfo.getUrl().getPath();
+ break;
+ default:
+ ret = null;
+ break;
+ }
+ return ret;
+ }
+
+ public void removeRow(int row) {
+ Message m = messages.get(row);
+
+ if (extractionTable != null) {
+ for (String e : m.getExtRefSet()) {
+ ((ExtractionModel) (extractionTable.getModel())).remove(e);
+ }
+ }
+ if (replaceTable != null) {
+ for (String r : m.getRepRefSet()) {
+ ((ReplaceModel) (replaceTable.getModel())).remove(r);
+ }
+ }
+ messagesMap.remove(m.getId());
+ messages.remove(row);
+
+ fireTableRowsDeleted(row, row);
+ }
+
+
+ public void removeAll() {
+ messagesMap.clear();
+ messages.clear();
+
+ if (extractionTable != null) {
+ ((ExtractionModel) (extractionTable.getModel())).removeAll();
+ }
+ if (extractionTable != null) {
+ ((ReplaceModel) (replaceTable.getModel())).removeAll();
+ }
+ fireTableDataChanged();
+ }
+
+ public void addMessage(IHttpRequestResponse msgInfo, String id) {
+ Message tmp = new Message(msgInfo, id);
+ this.messages.add(tmp);
+ messagesMap.put(id, tmp);
+
+ fireTableRowsInserted(messages.size() - 1, messages.size() - 1);
+ }
+
+ public void setMessage(int row, IHttpRequestResponse msgInfo) {
+ if (row >= 0 && row < messages.size()) {
+ messages.get(row).setMessageInfo(msgInfo);
+ messagesMap.get(messages.get(row).getId()).setMessageInfo(msgInfo);
+
+ fireTableRowsUpdated(row, row);
+ }
+ }
+
+ public void moveUp(int row, boolean isExt) {
+ if (row - 1 >= 0) {
+ Message tmp = messages.get(row - 1);
+ messages.set(row - 1, messages.get(row));
+ messages.set(row, tmp);
+
+ fireTableDataChanged();
+ if (isExt) {
+ extMsgTable.setRowSelectionInterval(row - 1, row - 1);
+ }
+ else {
+ repMsgTable.setRowSelectionInterval(row - 1, row - 1);
+ }
+ }
+ }
+
+ public void moveDown(int row, boolean isExt) {
+ if (row >= 0 && row + 1 < messages.size()) {
+ Message tmp = messages.get(row + 1);
+ messages.set(row + 1, messages.get(row));
+ messages.set(row, tmp);
+
+ fireTableDataChanged();
+ fireTableDataChanged();
+ if (isExt) {
+ extMsgTable.setRowSelectionInterval(row + 1, row + 1);
+ }
+ else {
+ repMsgTable.setRowSelectionInterval(row + 1, row + 1);
+ }
+ }
+ }
+
+ public List getMessages() {
+ return messages;
+ }
+
+ public void setExtractionTable(ExtractionTable extractionTable) {
+ this.extractionTable = extractionTable;
+ }
+
+ public void setReplaceTable(ReplaceTable replaceTable) {
+ this.replaceTable = replaceTable;
+ }
+
+ public void setExtMsgTable(MessagesTable extMsgTable) {
+ this.extMsgTable = extMsgTable;
+ }
+
+ public void setRepMsgTable(MessagesTable repMsgTable) {
+ this.repMsgTable = repMsgTable;
+ }
+}
diff --git a/src/burp/MessagesTable.java b/src/burp/MessagesTable.java
new file mode 100644
index 0000000..e53321e
--- /dev/null
+++ b/src/burp/MessagesTable.java
@@ -0,0 +1,73 @@
+package burp;
+
+import javax.swing.*;
+import javax.swing.event.TableModelEvent;
+
+/**
+ * Created by fruh on 8/31/16.
+ */
+public class MessagesTable extends JTable {
+ private BurpExtender extender;
+ private boolean isLogger;
+ private ConfigChangedListener textExtChangedListener;
+ private ConfigChangedListener textRepChangedListener;
+ private IMessageEditor req;
+ private IMessageEditor res;
+ private MessagesController ctrl;
+
+ public MessagesTable(BurpExtender extender, boolean isLogger) {
+ this.extender = extender;
+ this.isLogger = isLogger;
+ if (!isLogger) {
+ textExtChangedListener = new ConfigChangedListener(extender, ConfigActions.A_EXT_CONFIG_CHANGED);
+ textRepChangedListener = new ConfigChangedListener(extender, ConfigActions.A_REP_CONFIG_CHANGED);
+ }
+ }
+
+ public void setReq(IMessageEditor req) {
+ this.req = req;
+ }
+
+ public void setRes(IMessageEditor res) {
+ this.res = res;
+ }
+
+ public void setCtrl(MessagesController ctrl) {
+ this.ctrl = ctrl;
+ }
+
+ @Override
+ public void changeSelection(int i, int i1, boolean b, boolean b1) {
+ super.changeSelection(i, i1, b, b1);
+
+ // if there is not selected message
+ if (i == -1) {
+ req.setMessage(new byte[0], true);
+ res.setMessage(new byte[0], false);
+ }
+ else {
+ req.setMessage(ctrl.getRequest() == null ? new byte[0] : ctrl.getRequest(), true);
+ res.setMessage(ctrl.getResponse() == null ? new byte[0] : ctrl.getResponse(), false);
+ }
+ if (!isLogger) {
+ textExtChangedListener.textChanged();
+ textRepChangedListener.textChanged();
+ }
+ }
+
+ @Override
+ public void tableChanged(TableModelEvent tableModelEvent) {
+ super.tableChanged(tableModelEvent);
+
+ if (req != null && res != null && getSelectedRow() == -1) {
+ req.setMessage(new byte[0], true);
+ res.setMessage(new byte[0], false);
+ }
+ }
+
+ public void setSelectionById(String id) {
+ MessagesModel model = (MessagesModel) getModel();
+
+ changeSelection(model.getRowById(id), 0, false, false);
+ }
+}
diff --git a/src/burp/Replace.java b/src/burp/Replace.java
new file mode 100644
index 0000000..1302bb5
--- /dev/null
+++ b/src/burp/Replace.java
@@ -0,0 +1,97 @@
+package burp;
+
+import java.util.List;
+
+/**
+ * Created by fruh on 9/7/16.
+ */
+public class Replace {
+ public static String TYPE_REP_SEL = "Replace on selected";
+ public static String TYPE_ADD_SEL = "Add new header on selected";
+ public static String TYPE_REP_LAST = "Replace on last request";
+ public static String TYPE_ADD_LAST = "Add new header on last request";
+
+ private String dataToPaste;
+ private String replaceStr;
+ private String id;
+ private String type;
+ private String msgId;
+ private Extraction ext;
+
+ public Replace(String id, String replaceStr, String type, Extraction ext) {
+ this.id = id;
+ this.replaceStr = replaceStr;
+ this.type = type;
+ this.ext = ext;
+ }
+
+ public String getDataToPaste() {
+ return dataToPaste;
+ }
+
+ public void setDataToPaste(String dataToPaste) {
+ this.dataToPaste = dataToPaste;
+ }
+
+ public String getReplaceStr() {
+ return replaceStr;
+ }
+
+ public void setReplaceStr(String replaceStr) {
+ this.replaceStr = replaceStr;
+ }
+
+ public String replaceData(IHttpRequestResponse messageInfo, IExtensionHelpers helpers) {
+ String request = new String(messageInfo.getRequest());
+
+ if (type == TYPE_REP_SEL || type == TYPE_REP_LAST) {
+ request = request.replace(replaceStr, dataToPaste);
+ }
+ else {
+ IRequestInfo rqInfo = helpers.analyzeRequest(messageInfo);
+ List headers = rqInfo.getHeaders();
+ headers.add(replaceStr + ": " + dataToPaste);
+
+ String msgBody = request.substring(rqInfo.getBodyOffset());
+ request = new String(helpers.buildHttpMessage(headers, msgBody.getBytes()));
+ }
+ return request;
+ }
+
+ public String getId() {
+ return id;
+ }
+
+ public void setId(String id) {
+ this.id = id;
+ }
+
+ public String getType() {
+ return type;
+ }
+
+ public void setType(String type) {
+ this.type = type;
+ }
+
+ public String getMsgId() {
+ return msgId;
+ }
+
+ public void setMsgId(String msgId) {
+ this.msgId = msgId;
+ }
+
+ public String getExtId() {
+ return ext.getId();
+ }
+
+ public Extraction getExt() {
+ return ext;
+ }
+
+ @Override
+ public String toString() {
+ return "'" + id + "', '" + type + "', '" + replaceStr + "', '" + msgId + "'";
+ }
+}
diff --git a/src/burp/ReplaceModel.java b/src/burp/ReplaceModel.java
new file mode 100644
index 0000000..1885d6a
--- /dev/null
+++ b/src/burp/ReplaceModel.java
@@ -0,0 +1,147 @@
+package burp;
+
+import javax.swing.table.AbstractTableModel;
+import java.util.*;
+
+/**
+ * Created by fruh on 9/8/16.
+ */
+public class ReplaceModel extends AbstractTableModel {
+ private List replacesLast;
+ private List replaces;
+ private Map repModelMap;
+ private BurpExtender extender;
+ private String[] cols = {"Rep. Name", "MsgID", "Ext. Name", "MsgID"};
+
+ public ReplaceModel(BurpExtender extender) {
+ this.extender = extender;
+ replaces = new LinkedList<>();
+ replacesLast = new LinkedList<>();
+ repModelMap = new HashMap<>();
+ }
+
+ @Override
+ public int getRowCount() {
+ return replaces.size();
+ }
+
+ @Override
+ public int getColumnCount() {
+ return cols.length;
+ }
+
+ @Override
+ public String getColumnName(int index) {
+ if (index < cols.length) {
+ return cols[index];
+ }
+ return null;
+ }
+
+ public int getRowById(String id) {
+ int row = -1;
+
+ if (replaces.size() > 0) {
+ for (row = 0; row < replaces.size(); row++) {
+ if (id == replaces.get(row).getId()) {
+ break;
+ }
+ }
+ }
+ return row;
+ }
+
+ public Replace getReplace(int i) {
+ if (i >= 0 && i < replaces.size()) {
+ return replaces.get(i);
+ }
+ return null;
+ }
+
+ public Replace getReplaceById(String id) {
+ return repModelMap.get(id);
+ }
+
+ @Override
+ public Object getValueAt(int row, int col) {
+ String ret;
+
+ switch (col) {
+ case 0:
+ ret = getReplace(row).getId();
+ break;
+
+ case 1:
+ ret = String.valueOf(getReplace(row).getMsgId());
+ break;
+
+ case 2:
+ ret = getReplace(row).getExtId();
+ break;
+
+ case 3:
+ ret = String.valueOf(getReplace(row).getExt().getMsgId());
+ break;
+
+ default:
+ ret = null;
+ break;
+ }
+ return ret;
+ }
+
+ public void remove(String id) {
+ int row = getRowById(id);
+ removeRow(row);
+ }
+
+ public void removeRow(int row) {
+ Replace r = replaces.get(row);
+
+ if (r.getMsgId() != null) {
+ extender.getMessagesModel().getMessageById(r.getMsgId()).getRepRefSet().remove(r.getId());
+ }
+ repModelMap.remove(r.getId());
+ if (replacesLast.contains(r)) {
+ replacesLast.remove(r);
+ }
+ replaces.remove(row);
+
+ fireTableRowsDeleted(row, row);
+ }
+
+ public void removeAll() {
+ repModelMap.clear();
+ replaces.clear();
+ replacesLast.clear();
+
+ fireTableDataChanged();
+ }
+
+ public void addReplace(Replace rep) {
+ this.replaces.add(rep);
+ repModelMap.put(rep.getId(), rep);
+
+ fireTableRowsInserted(replaces.size() - 1, replaces.size() - 1);
+ }
+
+ public void addReplaceLast(Replace rep) {
+ this.replaces.add(rep);
+ this.replacesLast.add(rep);
+ repModelMap.put(rep.getId(), rep);
+
+ fireTableRowsInserted(replaces.size() - 1, replaces.size() - 1);
+ }
+
+ public List getReplaces() {
+ return replaces;
+ }
+
+ public List getReplacesLast() {
+ return replacesLast;
+ }
+
+ public Map getRepModelMap() {
+ return repModelMap;
+ }
+}
diff --git a/src/burp/ReplaceTable.java b/src/burp/ReplaceTable.java
new file mode 100644
index 0000000..2afaeca
--- /dev/null
+++ b/src/burp/ReplaceTable.java
@@ -0,0 +1,43 @@
+package burp;
+
+import javax.swing.*;
+
+/**
+ * Created by fruh on 9/9/16.
+ */
+public class ReplaceTable extends JTable {
+ private BurpExtender extender;
+ private ConfigChangedListener configChangedListener;
+
+ public ReplaceTable(BurpExtender extender) {
+ this.extender = extender;
+ configChangedListener = new ConfigChangedListener(extender, ConfigActions.A_REP_CONFIG_CHANGED);
+ }
+
+ @Override
+ public void changeSelection(int i, int i1, boolean b, boolean b1) {
+ super.changeSelection(i, i1, b, b1);
+
+ if (i >= 0) {
+ Replace rep = ((ReplaceModel) getModel()).getReplace(i);
+
+ extender.getReplaceNameStringField().setText(rep.getId());
+ extender.getReplaceStringField().setText(rep.getReplaceStr());
+
+ int j;
+ for (j = 0; j < extender.getReplaceType().getModel().getSize(); j++) {
+ if (extender.getReplaceType().getModel().getElementAt(j).equals(rep.getType())) {
+ extender.getReplaceType().setSelectedIndex(j);
+ break;
+ }
+ }
+ }
+ configChangedListener.textChanged();
+ }
+
+ public void setSelectionById(String id) {
+ ReplaceModel model = (ReplaceModel) getModel();
+
+ changeSelection(model.getRowById(id), 0, false, false);
+ }
+}
\ No newline at end of file