├── exceptions_fix.py ├── AlteredCustomEditorTab.py ├── README.md └── LICENSE /exceptions_fix.py: -------------------------------------------------------------------------------- 1 | ## Burp Exceptions Fix magic code 2 | import sys, functools, inspect, traceback 3 | 4 | def decorate_function(original_function): 5 | @functools.wraps(original_function) 6 | def decorated_function(*args, **kwargs): 7 | try: 8 | return original_function(*args, **kwargs) 9 | except: 10 | sys.stdout.write('\n\n*** PYTHON EXCEPTION\n') 11 | traceback.print_exc(file=sys.stdout) 12 | raise 13 | return decorated_function 14 | 15 | def FixBurpExceptionsForClass(cls): 16 | for name, method in inspect.getmembers(cls, inspect.ismethod): 17 | setattr(cls, name, decorate_function(method)) 18 | return cls 19 | 20 | def FixBurpExceptions(): 21 | for name, cls in inspect.getmembers(sys.modules['__main__'], predicate=inspect.isclass): 22 | FixBurpExceptionsForClass(cls) 23 | 24 | 25 | -------------------------------------------------------------------------------- /AlteredCustomEditorTab.py: -------------------------------------------------------------------------------- 1 | # This code is based on Burp's example CustomEditorTab 2 | # hosted at https://portswigger.net/burp/extender/examples/CustomEditorTab.zip. 3 | # Lines commented with "# ADDED LINE" need to be added to your scripts 4 | # if you want prettier stack traces. 5 | 6 | from burp import IBurpExtender 7 | from burp import IMessageEditorTabFactory 8 | from burp import IMessageEditorTab 9 | from burp import IParameter 10 | 11 | from exceptions_fix import FixBurpExceptions # ADDED LINE 12 | import sys # ADDED LINE 13 | 14 | class BurpExtender(IBurpExtender, IMessageEditorTabFactory): 15 | def registerExtenderCallbacks(self, callbacks): 16 | 17 | # keep a reference to our callbacks object 18 | self._callbacks = callbacks 19 | 20 | # obtain an extension helpers object 21 | self._helpers = callbacks.getHelpers() 22 | 23 | sys.stdout = callbacks.getStdout() # ADDED LINE 24 | 25 | # set our extension name 26 | callbacks.setExtensionName("Serialized input editor") 27 | 28 | # register ourselves as a message editor tab factory 29 | callbacks.registerMessageEditorTabFactory(self) 30 | 31 | return 32 | 33 | # 34 | # implement IMessageEditorTabFactory 35 | # 36 | 37 | def createNewInstance(self, controller, editable): 38 | 39 | # create a new instance of our custom editor tab 40 | return Base64InputTab(self, controller, editable) 41 | 42 | # 43 | # class implementing IMessageEditorTab 44 | # 45 | 46 | class Base64InputTab(IMessageEditorTab): 47 | 48 | def __init__(self, extender, controller, editable): 49 | self._extender = extender 50 | self._editable = editable 51 | 52 | # create an instance of Burp's text editor, to display our deserialized data 53 | self._txtInput = extender._callbacks.createTextEditor() 54 | self._txtInput.setEditable(editable) 55 | return 56 | 57 | # 58 | # implement IMessageEditorTab 59 | # 60 | 61 | def getTabCaption(self): 62 | return "Serialized input" 63 | 64 | def getUiComponent(self): 65 | return self._txtInput.getComponent() 66 | 67 | def isEnabled(self, content, isRequest): 68 | # enable this tab for requests containing a data parameter 69 | return isRequest and not self._extender._helpers.getRequestParameter(content, "data") is None 70 | 71 | def setMessage(self, content, isRequest): 72 | if (content is None): 73 | # clear our display 74 | self._txtInput.setText(None) 75 | self._txtInput.setEditable(False) 76 | 77 | else: 78 | # retrieve the data parameter 79 | parameter = self._extender._helpers.getRequestParameter(content, "data") 80 | 81 | # deserialize the parameter value 82 | self._txtInput.setText(self._extender._helpers.base64Decode(self._extender._helpers.urlDecode(parameter.getValue()))) 83 | self._txtInput.setEsditable(self._editable) 84 | 85 | # remember the displayed content 86 | self._currentMessage = content 87 | return 88 | 89 | def getMessage(self): 90 | # determine whether the user modified the deserialized data 91 | if (self._txtInput.isTextModified()): 92 | # reserialize the data 93 | text = self._txtInput.getText() 94 | input = self._extender._helpers.urlEncode(self._extender._helpers.base64Encode(text)) 95 | 96 | # update the request with the new parameter value 97 | return self._extender._helpers.updateParameter(self._currentMessage, self._extender._helpers.buildParameter("data", input, IParameter.PARAM_BODY)) 98 | 99 | else: 100 | return self._currentMessage 101 | 102 | def isModified(self): 103 | 104 | return self._txtInput.isTextModified() 105 | 106 | def getSelectedData(self): 107 | 108 | return self._txtInput.getSelectedText() 109 | 110 | 111 | FixBurpExceptions() # ADDED LINE 112 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # burp-exceptions 2 | Simple trick to increase readability of exceptions raised by Burp extensions written in Python. 3 | ## Rationale 4 | Have you ever written a Burp Extender extension in Python to end up with a completely unlegible exception stack trace? Something like: 5 | 6 | java.lang.RuntimeException: org.python.core.PyException 7 | at burp.fl.a(Unknown Source) 8 | at burp.edd.a(Unknown Source) 9 | at burp.e2g.a(Unknown Source) 10 | at burp.e2g.g(Unknown Source) 11 | at burp.i1c.stateChanged(Unknown Source) 12 | at javax.swing.JTabbedPane.fireStateChanged(JTabbedPane.java:416) 13 | at javax.swing.JTabbedPane$ModelListener.stateChanged(JTabbedPane.java:270) 14 | ... 15 | 16 | Would you rather see something you can actually understand? Just like: 17 | 18 | *** PYTHON EXCEPTION 19 | Traceback (most recent call last): 20 | File "/Users/mb/Desktop/burp extension/exceptions_fix.py", line 8, in decorated_function 21 | return original_function(*args, **kwargs) 22 | File "/Users/mb/Desktop/burp extension/CustomEditorTab.py", line 78, in setMessage 23 | self._txtInput.setEsditable(self._editable) 24 | AttributeError: 'burp.ul' object has no attribute 'setEsditable' 25 | 26 | I'm presenting a neat solution to the problem! 27 | 28 | ## Quick guide 29 | 30 | 1. Grab https://github.com/securityMB/burp-exceptions/blob/master/exceptions_fix.py and save it to your _Folder for loading modules_. 31 | 32 | **Hint**: If you don't know what folder it is, open your Burp and go to *Extender*→*Options*→*Python Environment*→*Folder for loading modules*. If you haven't picked any folder yet, just set it now. 33 | 34 | 2. Modify your Burp extension a bit. Firstly, add the following lines in the beginning of your Python file: 35 | 36 | ```python 37 | from exceptions_fix import FixBurpExceptions 38 | import sys 39 | ``` 40 | 41 | then find your ```registerExtenderCallbacks``` method and add one line to it: 42 | 43 | ```python 44 | sys.stdout = callbacks.getStdout() 45 | ``` 46 | 47 | and then also add one new line at the very end of the file: 48 | 49 | ```python 50 | FixBurpExceptions() 51 | ``` 52 | 53 | 3. If you're not sure about the changes you're supposed to make, grab https://github.com/securityMB/burp-exceptions/blob/master/AlteredCustomEditorTab.py and look for lines with ```# ADDED LINE``` comment. 54 | 55 | 4. Just let the magic happen. 56 | 57 | Alternatively, you might add ```@FixBurpExceptionForClass``` decorator just before the class you'd like to have exceptions fixed. 58 | 59 | ```python 60 | @FixBurpExceptionForClass 61 | class SomeClass(IMessageEditorTab): 62 | .... 63 | ``` 64 | 65 | ## How does it work? 66 | 67 | The code is a fine example of what one can achieve with metaprogramming in some programming languages. Let's start with the most outer function, namely ```FixBurpExceptions```. 68 | 69 | ```python 70 | def FixBurpExceptions(): 71 | for name, cls in inspect.getmembers(sys.modules['__main__'], predicate=inspect.isclass): 72 | FixBurpExceptionsForClass(cls) 73 | ``` 74 | 75 | We're just iterating over all classes defined in ```__main__``` module (which is just the main file of your Burp extension) and calling ```FixBurpExceptionsForClass```. 76 | 77 | ```python 78 | def FixBurpExceptionsForClass(cls): 79 | for name, method in inspect.getmembers(cls, inspect.ismethod): 80 | setattr(cls, name, decorate_function(method)) 81 | return cls 82 | ``` 83 | 84 | Here, for a change, we're iterating over all **methods** defined in a given class and overwrite them with results of ```decorate_function(method)```. So what does it do? 85 | 86 | 87 | ```python 88 | def decorate_function(original_function): 89 | @functools.wraps(original_function) 90 | def decorated_function(*args, **kwargs): 91 | try: 92 | return original_function(*args, **kwargs) 93 | except: 94 | sys.stdout.write('\n\n*** PYTHON EXCEPTION\n') 95 | traceback.print_exc(file=sys.stdout) 96 | raise 97 | return decorated_function 98 | ``` 99 | 100 | To better understand the code, you need to be familiar with [Python decorators](http://simeonfranklin.com/blog/2012/jul/1/python-decorators-in-12-steps/). At first, we use a [@functools.wraps](https://docs.python.org/2/library/functools.html#functools.wraps) decorator so that the wrapper function will look *just like* the wrapped function (```original_function```). Then, we call the original function in ```try: ... except``` block so that we're able to catch any exception that might be raised. If some exception is raised, we're just writing the stack trace to ```sys.stdout``` and re-raise the exception. 101 | 102 | ## Author 103 | Feel free to contact me via GitHub or Twitter ([@SecurityMB](https://twitter.com/securitymb)) if you have any questions or remarks. 104 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------