Merge pull request #3 from stavinski/master

Major changes to original extension

Author: Hannah-PortSwigger

.gitignore

@@ -0,0 +1 @@
+*.class

BappDescription.html

@@ -1,6 +1,5 @@
-<p>This extension allows execution of a custom Python script on each HTTP 
-request and response processed by Burp.</p>
-<p>To use, type or paste a Python script into the &quot;Script&quot; tab, and use Burp in 
+<p>This exension allows execution of custom Python scripts to be used with HTTP request and responses plus handling Macro messages.</p>
+<p>To use, type or paste a Python script into the &quot;Python Scripts&quot; tab, and use Burp in 
 the normal way. The script will be executed for each HTTP request and response. 
 The following variables are defined in the context of the script:</p>
 <ul>
@@ -10,4 +9,5 @@
 	<li>toolFlag</li>
 	<li>messageIsRequest</li>
 	<li>messageInfo</li>
+	<li>macroItems</li>
 </ul>

BappManifest.bmf

@@ -2,10 +2,10 @@ Uuid: eb563ada801346e6bdb7a7d7c5c52583
 ExtensionType: 2
 Name: Python Scripter
 RepoName: python-scripter
-ScreenVersion: 1.1
+ScreenVersion: 2.0
 SerialVersion: 2
 MinPlatformVersion: 0
 ProOnly: False
-Author: Marcin Wielgoszewski
-ShortDescription: Allows execution of a custom Python script on each HTTP request and response.
-EntryPoint: burpscript.py
+Author: Marcin Wielgoszewski, Mike Cromwell
+ShortDescription: Allows execution of custom Python scripts to be used with HTTP request and responses plus handling Macro messages.
+EntryPoint: python-scripter.py

README.md

@@ -1 +1,44 @@
+# Python Scripter
+
+## Introduction
+
+This extension allows you to write custom Python to hook into both the request, response pipeline and also the Macro handling support in Burp Suite. This is useful in those times were you want some behaviour but don't want to have to go to the full extent of creating a custom extension.
+
+You can also over time build up a useful collection of utility scripts that can be used across web assessments.
+
+I would highly recommend to build off the already established framework [pyscripter-er](https://github.com/lanmaster53/pyscripter-er) that already has a lot of common functionality built-in to save you some of the leg work.
+
+## Usage
+
+Once the extension is installed you will find a `Python Scripts` tab, this allows you to add, modify or remove scripts:
+
+![Python Scripts with no scripts](images/new.png)
+
+When you add a new script it will be given a name of `New Script X` this can be changed in the same way as in the `Repeater` tabs by double clicking and pressing Enter to confirm or Esc to cancel.
+
+You can then start changing the new script or pasting a script from another location directly into the editor:
+
+![Renaming the script via the tab](images/rename.png)
+
+When your ready to compile the Python code simply click `Compile`, compile time errors these will be displayed in the `Errors` textarea:
+
+![Compile time errors](images/error.png)
+
+To test the script simply enable it and then push through a request, output should be presented in the `Output` textarea:
+
+![Script output](images/output.png)
+
+If there was a runtime exception these will also be captured in the `Errors` textarea to help diagnose the bug.
+
+__Scripts are automatically restored and saved on extension load and unload.__ 
+
+
+## FAQs
+
+__Q. Why do I see no output?__
+
+A. As long as the script is enabled this could be that there was a runtime exception raised, firstly check the `Errors` textarea, could be that the scope checking in place is incorrect if your using `callbacks.isInScope` perhaps placing a `print` before and after this is comparesd coud help track down the issue. It may also be the case that the extension has an exception in which case you should check the `Errors` textare from the extensions dialog in Burp Suite. 
+
+## Original Work
+
 Sourced from gist: https://gist.github.com/mwielgoszewski/7026954