1. 项目概述为什么需要自己动手开发BurpSuite扩展如果你是一名渗透测试工程师或者安全研究员那么BurpSuite对你来说可能就像瑞士军刀一样不可或缺。它拦截、重放、扫描、爆破功能强大。但用久了你会发现总有那么一些场景BurpSuite自带的工具链显得有点“笨拙”或者“不够用”。比如你需要批量处理某个特定格式的请求、自动化一个复杂的测试流程、或者与一个内部的自研安全平台进行深度联动。这时候官方插件商店里的那些通用插件可能就满足不了你的定制化需求了。这就是学习BurpSuite扩展开发的意义所在。它让你从一个工具的使用者转变为工具的“改造者”和“赋能者”。你可以根据自己的工作流打造出独一无二的“趁手兵器”。而Python凭借其简洁的语法、丰富的库生态以及在安全领域的广泛应用成为了开发BurpSuite扩展的首选语言之一。它不像Java那样需要复杂的编译和打包过程对于快速原型开发和脚本化任务来说Python的灵活性和开发效率是巨大的优势。这个项目就是带你从最纯净的环境开始一步步搭建起一个专为BurpSuite扩展开发服务的Python环境并最终完成一个具有实际功能的扩展将其部署到BurpSuite中运行。整个过程我会把我踩过的坑、调试时的心得、以及那些官方文档里不会写的细节毫无保留地分享给你。无论你是刚接触安全工具开发的新手还是想将Python自动化能力与BurpSuite结合的老手这篇指南都能给你提供一条清晰的路径。2. 环境搭建打造专属的Python开发沙箱很多人一上来就用自己的系统Python或者随便装个Anaconda就开始写代码这其实埋下了很多隐患。不同项目依赖冲突、系统环境被污染、打包时出现各种诡异问题都是这么来的。为BurpSuite扩展开发专门创建一个隔离、纯净的Python环境是保证项目顺利进行的第一步。2.1 Python解释器的选择与安装首先你需要一个Python解释器。我强烈建议直接从Python官网下载安装包而不是通过系统包管理器如apt或yum。官网版本更新而且能让你完全掌控安装路径和过程。版本选择BurpSuite的Java环境对Python版本有一定兼容性要求。经过大量实践Python 3.8 到 Python 3.11是兼容性最广、最稳定的选择。Python 3.12及以上版本有时会因为某些底层库的更新导致与JythonBurpSuite内置的Python解释器环境的交互出现兼容性问题。因此我建议你选择Python 3.9或Python 3.10作为你的开发版本它们在功能、性能和兼容性上取得了很好的平衡。安装要点下载Windows安装程序.exe或macOS/Linux的安装包。安装时务必勾选“Add Python to PATH”Windows或将Python执行路径添加到系统环境变量中。这能让你在命令行中直接使用python和pip命令省去后续手动配置的麻烦。安装完成后打开终端Windows用CMD或PowerShellmacOS/Linux用Terminal输入python --version或python3 --version来验证安装是否成功并确认版本号。注意在macOS和部分Linux发行版上系统可能预装了Python 2.7或另一个版本的Python 3。命令python可能指向旧版本。因此我们后续统一使用python3和pip3命令来明确指定使用我们新安装的版本。在Windows上如果只安装了一个Python 3则python命令通常就是可用的。2.2 虚拟环境管理使用venv隔离项目依赖系统级的Python环境是“公共场所”所有项目都共用一套库。当项目A需要requests 2.25而项目B需要requests 3.0时冲突就发生了。虚拟环境Virtual Environment就是为每个项目创建的“私人房间”房间内的家具第三方库互不干扰。Python 3.3以后官方内置了venv模块轻量且无需额外安装是我们的首选。创建虚拟环境 假设我们的项目目录叫burp_ext_dev我们在其中创建虚拟环境。# 切换到你的项目目录 cd /path/to/your/workspace mkdir burp_ext_dev cd burp_ext_dev # 创建虚拟环境环境文件夹命名为 venv (这是一个通用命名) python3 -m venv venv执行成功后当前目录下会生成一个名为venv的文件夹里面包含了一个独立的Python解释器副本和pip工具。激活虚拟环境 创建后需要“进入”这个环境这样后续的所有pip安装和python运行都会局限在这个环境内。Windows (CMD/PowerShell):# 在CMD中 venv\Scripts\activate.bat # 在PowerShell中 venv\Scripts\Activate.ps1macOS / Linux (bash/zsh):source venv/bin/activate激活后你的命令行提示符通常会发生变化前面会多出一个(venv)标识表示你正处在这个虚拟环境中。验证与退出 在激活状态下运行python --version和pip --version确认它们指向的是venv目录下的版本。 当你完成工作需要离开这个环境时只需在命令行输入deactivate即可。2.3 集成开发环境IDE配置VSCode的高效设置一个好用的IDE能极大提升开发效率。Visual Studio Code (VSCode) 因其轻量、免费和强大的扩展生态成为了很多开发者的选择。下面是如何为我们的BurpSuite扩展项目配置VSCode。安装VSCode从官网下载并安装。安装Python扩展在VSCode的扩展市场CtrlShiftX中搜索并安装官方发布的“Python”扩展由Microsoft发布。这个扩展提供了代码智能提示、调试、linting等核心功能。打开项目文件夹用VSCode打开我们刚才创建的burp_ext_dev文件夹。选择Python解释器按下CtrlShiftP或CmdShiftPon Mac打开命令面板输入“Python: Select Interpreter”然后选择列表中指向./venv/Scripts/python.exe(Windows) 或./venv/bin/python(macOS/Linux) 的那一项。这确保了VSCode使用我们虚拟环境中的Python来运行和调试代码。推荐安装的扩展Python Docstring Generator自动生成规范的函数/类注释文档。Code Spell Checker检查代码中的英文拼写错误。Rainbow CSV如果你需要处理CSV格式的数据这个扩展能让各列以不同颜色高亮非常直观。实操心得在VSCode中你可以为这个项目单独配置工作区设置。在项目根目录创建一个.vscode文件夹里面放一个settings.json文件。你可以在这里设置项目特定的Python路径、代码格式化规则如使用autopep8或black、以及linter如pylint或flake8。这样当你把项目分享给队友时他们用VSCode打开就能获得一致的开发体验。3. 核心依赖解析理解BurpSuite扩展的骨架一个BurpSuite扩展本质上是一个遵循了特定接口规范的Java类。但是通过Jython一个用Java实现的Python解释器我们可以用Python来编写这个Java类。要让我们的Python代码能与BurpSuite的Java API对话就需要一个关键的桥梁——burp模块。同时为了高效开发我们还需要一些辅助工具。3.1 核心依赖burp-api与Jythonburp模块这不是一个可以通过pip安装的第三方库。它是由BurpSuite在运行时动态注入到Jython环境中的。你的Python扩展代码中需要import burp然后通过它来访问IBurpExtender、IHttpListener、IScannerCheck等核心接口。因此在开发环境的requirements.txt里你不需要也无法列出它。但是为了获得代码自动补全和类型提示我们需要一个“存根”stub文件。获取API存根文件你可以从BurpSuite的官方文档或GitHub上的一些开源扩展项目中找到一个名为burp的目录里面包含__init__.py等文件。将这个目录复制到你的项目根目录下或者放到虚拟环境的site-packages目录中。这样VSCode的Python扩展就能识别burp模块为你提供API方法的智能提示这能节省大量查阅文档的时间。Jython这是BurpSuite内置的Python解释器。我们本地用CPython我们安装的Python开发调试但最终代码需要在Jython环境中运行。Jython目前稳定版本是2.7.x它兼容的是Python 2.7的语法和大部分标准库。这就是为什么我们选择Python 3.8进行开发但在编写代码时需要特别注意兼容性问题。好消息是对于扩展开发中常用的核心逻辑字符串处理、网络请求、数据结构Python 2.7和3.x的差异在可接受的范围内主要注意print语句和字符串编码strvsunicode即可。BurpSuite的Java API处理字符串时通常使用Java的String类型Jython会自动进行转换。3.2 辅助工具库提升开发效率虽然核心逻辑依赖burpAPI但一些辅助性的工作我们可以用强大的Python库来完成让代码更简洁。requests虽然BurpSuite提供了IHttpRequestResponse接口来处理HTTP流量但在扩展初始化时或者需要与外部REST API通信例如从内部漏洞库拉取数据、向团队协作平台发送通知时requests库比手动构造Java的HTTP客户端要方便得多。注意在扩展处理实时流量时应优先使用BurpSuite自身的API以保证性能和兼容性。Jinja2如果你的扩展需要生成复杂的报告、HTML页面或者自定义的GUI界面通过ITab接口Jinja2模板引擎能帮你清晰地分离逻辑和展示层。colorama在控制台输出日志时使用颜色可以快速区分信息、警告和错误。colorama库解决了Windows下终端颜色转义的问题让彩色输出跨平台。six这是一个用于兼容Python 2和Python 3的轻量级库。如果你希望你的扩展在更多环境下具备更好的兼容性或者你使用了某些同时支持2和3的第三方库six可以帮助你处理一些常见的兼容性痛点如urllib、basestring类型等。依赖管理在项目根目录创建一个requirements.txt文件列出这些辅助库。requests2.25.1 Jinja23.0.0 colorama0.4.4 six1.16.0然后在激活的虚拟环境中运行pip install -r requirements.txt来一键安装。4. 第一个扩展实战开发一个自定义的HTTP流量标记器理论讲得再多不如动手写一个。我们来开发一个实用的扩展“敏感路径扫描标记器”。它的功能是自动检查经过BurpSuite代理的所有HTTP请求如果请求的URL路径中包含诸如/admin/api/v1/user/config/backup等预定义的敏感关键词就在BurpSuite的Proxy history或Target站点地图中给这个请求打上一个高亮的标记并添加注释提醒测试人员重点关注。4.1 项目结构与入口文件一个典型的BurpSuite Python扩展项目结构如下burp_ext_dev/ ├── venv/ # 虚拟环境目录.gitignore忽略 ├── burp/ # Burp API存根文件可选用于代码提示 ├── src/ │ └── sensitive_path_marker.py # 我们的主扩展代码 ├── resources/ # 存放图标、模板等资源文件 ├── requirements.txt # Python依赖列表 └── README.md # 项目说明现在我们在src目录下创建主文件sensitive_path_marker.py。扩展入口类每个BurpSuite扩展都必须有一个实现了IBurpExtender接口的类。这是扩展的入口点。# -*- coding: utf-8 -*- from burp import IBurpExtender, IHttpListener, ITab import re class BurpExtender(IBurpExtender, IHttpListener): 这是扩展的主类必须命名为 BurpExtender。 它实现了 IBurpExtender 和 IHttpListener 接口。 IBurpExtender 是必须的用于注册扩展。 IHttpListener 允许我们监听和处理所有的HTTP请求和响应。 def registerExtenderCallbacks(self, callbacks): 这是扩展的初始化方法BurpSuite在加载扩展时会自动调用。 callbacks 对象是我们与BurpSuite交互的核心它提供了所有API。 # 保存callbacks对象和helpers对象后续会频繁使用 self._callbacks callbacks self._helpers callbacks.getHelpers() # 设置扩展名称这会在Extender标签页中显示 callbacks.setExtensionName(Sensitive Path Marker) # 将自己这个类实例注册为一个HTTP监听器 # 这样每当有HTTP流量经过Burp时processHttpMessage方法就会被调用 callbacks.registerHttpListener(self) # 初始化敏感路径关键词列表 # 这里使用正则表达式进行匹配更灵活 self.sensitive_patterns [ r(?i)/admin, # 不区分大小写的admin目录 r(?i)/api/v\d/user, # 用户相关API接口 r(?i)/config, # 配置文件 r(?i)/backup, # 备份文件或目录 r(?i)/\.git, # Git仓库泄露 r(?i)/\.env, # 环境配置文件 r(?i)/phpinfo, # PHP信息泄露 r(?i)/debug, # 调试接口 ] self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] # 输出启动日志到Burp的Alerts或Output标签页 callbacks.printOutput(Sensitive Path Marker extension loaded successfully.) callbacks.printOutput(Monitoring for sensitive paths: , .join(self.sensitive_patterns))代码解读from burp import ...导入必要的接口。IHttpListener让我们能监听HTTP流量。class BurpExtender(...)类名必须是BurpExtender。它继承了IBurpExtender和IHttpListener。registerExtenderCallbacks(self, callbacks)这是生命周期的起点。我们在这里保存callbacks和helpers对象备用。用setExtensionName设置扩展显示名。用registerHttpListener(self)注册为监听器。初始化我们的业务逻辑这里是敏感路径模式列表。打印加载成功的日志。4.2 实现流量处理逻辑IHttpListener接口注册为监听器后我们需要实现IHttpListener接口定义的processHttpMessage方法。这个方法会在每个HTTP请求和响应经过BurpSuite时被调用。def processHttpMessage(self, toolFlag, messageIsRequest, messageInfo): 处理HTTP消息的核心方法。 参数: toolFlag: 一个整数标识消息来自哪个Burp工具如Proxy, Scanner, Repeater。 messageIsRequest: 布尔值True表示当前是请求消息False是响应消息。 messageInfo: IHttpRequestResponse对象包含了完整的请求和响应信息及元数据。 # 我们只关心HTTP请求并且只处理来自Proxy工具ID 0x04或Scanner等核心工具的流量。 # 这样可以避免对Repeater中手动修改的请求进行重复标记。 if not messageIsRequest: return # 检查工具来源这里我们处理Proxy(4), Spider(8), Scanner(16)的流量 # 工具ID定义可以在IBurpExtenderCallbacks接口文档中找到 if toolFlag not in (0x04, 0x08, 0x10): return # 从messageInfo中获取HTTP请求的字节流和URL对象 request_bytes messageInfo.getRequest() analyzed_request self._helpers.analyzeRequest(request_bytes) url analyzed_request.getUrl() # 将URL对象转换为字符串并提取路径部分 url_str self._helpers.bytesToString(url.toString()) # 注意url.toString() 返回的是完整的URL包括协议、主机、端口、路径和查询参数。 # 我们主要关心路径部分。 from java.net import URL as JavaURL if isinstance(url, JavaURL): path url.getPath() query url.getQuery() full_path path (? query if query else ) else: # 备用方案使用字符串解析 import urllib.parse parsed_url urllib.parse.urlparse(url_str) full_path parsed_url.path (? parsed_url.query if parsed_url.query else ) # 检查路径是否匹配任何敏感模式 found_sensitive False matched_pattern for pattern in self.compiled_patterns: if pattern.search(full_path): found_sensitive True matched_pattern pattern.pattern break # 如果发现敏感路径则进行标记 if found_sensitive: # 1. 添加高亮颜色 (这里使用橙色) # BurpSuite支持的颜色常量定义在IContextMenuInvocation接口中如 # 0:红, 1:橙, 2:黄, 3:绿, 4:青, 5:蓝, 6:粉, 7:灰 highlight_color 1 # 橙色 messageInfo.setHighlight(highlight_color) # 2. 添加注释说明匹配到的敏感模式 current_comment messageInfo.getComment() new_comment [Sensitive Path: {}].format(matched_pattern) if current_comment: # 如果已有注释则追加 new_comment current_comment ; new_comment messageInfo.setComment(new_comment) # 可选在Output标签页打印一条日志便于调试 self._callbacks.printOutput(Marked sensitive path: {} in tool {}.format(full_path, toolFlag))代码解读与避坑指南工具过滤toolFlag参数非常重要。BurpSuite有很多工具Proxy, Scanner, Intruder, Repeater, Spider等。如果不加过滤你在Repeater里每发送一次请求扩展都会处理并可能重复标记。通常我们只标记来自Proxy实时流量、Spider爬虫或Scanner主动扫描的请求。0x04,0x08,0x10是这些工具的十六进制标识符。URL处理messageInfo.getUrl()返回的是一个java.net.URL对象。在Jython环境中我们可以直接使用Java类。url.getPath()能直接获取路径部分这是最可靠的方式。备用方案使用了Python的urllib.parse但要注意Jython 2.7环境下可能需要进行一些兼容性处理。字符串编码self._helpers.bytesToString()是将字节数组转换为字符串的安全方法。在BurpSuite的API中HTTP消息通常以字节数组byte[]形式传递使用helpers对象进行转换能避免编码问题。设置高亮和注释setHighlight()和setComment()是IHttpRequestResponse接口的方法它们会直接修改BurpSuite界面中对应请求的显示状态。这是一个非常直观的交互方式。性能考虑processHttpMessage会被频繁调用因此里面的逻辑应尽可能高效。我们预编译了正则表达式self.compiled_patterns避免在每次调用时重复编译。对于更复杂的匹配逻辑可以考虑使用前缀树Trie等数据结构。4.3 扩展功能添加图形界面ITab接口让用户能动态管理敏感关键词列表而不是硬编码在代码里会实用得多。我们可以为扩展添加一个简单的GUI标签页。首先需要安装一个用于创建GUI的库。由于BurpSuite基于Java Swing我们可以使用javax.swing包但用纯Java代码写Swing比较繁琐。我们可以使用Jython环境下可用的wxPython如果BurpSuite环境配置了或者更简单地利用BurpSuite提供的IBurpExtenderCallbacks.createTextEditor()方法来创建一个文本编辑器组件用于编辑关键词列表。这里我们采用一个折中且兼容性更好的方案在扩展中实现ITab接口创建一个包含JTextArea的简单Swing面板。# 在文件顶部添加Swing导入 from javax.swing import JPanel, JTextArea, JScrollPane, JButton, JLabel, BorderFactory from java.awt import BorderLayout, Dimension import java # 修改类定义实现ITab接口 class BurpExtender(IBurpExtender, IHttpListener, ITab): def registerExtenderCallbacks(self, callbacks): # ... 之前的初始化代码保持不变 ... # 初始化GUI组件 self._init_ui() # 注册自己为一个标签页 callbacks.addSuiteTab(self) # ... 其余代码 ... def _init_ui(self): 初始化用户界面 # 创建主面板 self._main_panel JPanel(BorderLayout()) # 创建文本区域用于显示和编辑敏感路径列表 self._patterns_text_area JTextArea() # 将列表初始化为文本每行一个模式 initial_text \n.join(self.sensitive_patterns) self._patterns_text_area.setText(initial_text) self._patterns_text_area.setLineWrap(True) self._patterns_text_area.setWrapStyleWord(True) # 将文本区域放入滚动面板 scroll_pane JScrollPane(self._patterns_text_area) scroll_pane.setPreferredSize(Dimension(400, 300)) # 创建按钮用于保存更新 save_button JButton(Update Patterns, actionPerformedself._update_patterns) # 创建说明标签 info_label JLabel(Enter one sensitive path pattern per line (regex supported).) # 布局 top_panel JPanel(BorderLayout()) top_panel.add(info_label, BorderLayout.NORTH) top_panel.add(scroll_pane, BorderLayout.CENTER) self._main_panel.add(top_panel, BorderLayout.CENTER) self._main_panel.add(save_button, BorderLayout.SOUTH) # 设置边框 self._main_panel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10)) def _update_patterns(self, event): 按钮事件处理更新敏感模式列表 text self._patterns_text_area.getText() lines [line.strip() for line in text.split(\n) if line.strip()] # 简单的验证非空行 if not lines: self._callbacks.printError(Pattern list cannot be empty!) return # 更新内存中的模式列表 self.sensitive_patterns lines try: self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] self._callbacks.printOutput(Sensitive patterns updated successfully.) self._callbacks.printOutput(New patterns: , .join(self.sensitive_patterns)) except re.error as e: self._callbacks.printError(Invalid regular expression: str(e)) # --- ITab 接口方法实现 --- def getTabCaption(self): 返回标签页的标题 return Sensitive Paths def getUiComponent(self): 返回标签页的UI组件 return self._main_panelGUI实现要点导入Swingfrom javax.swing import ...和from java.awt import ...。这是在Jython环境中使用Java Swing的方式。实现ITab接口类需要实现getTabCaption()返回标签页名和getUiComponent()返回主面板两个方法。注册标签页在registerExtenderCallbacks中通过callbacks.addSuiteTab(self)将扩展添加到BurpSuite主界面的标签栏。事件处理JButton(actionPerformedself._update_patterns)将按钮点击事件绑定到我们的处理方法上。在_update_patterns方法中我们从文本区域读取内容更新内存中的正则表达式列表并重新编译。错误处理对用户输入的正则表达式进行编译尝试如果编译失败通过callbacks.printError()在BurpSuite的Alerts标签页显示错误信息避免扩展崩溃。5. 调试、打包与部署让扩展在BurpSuite中跑起来代码写好了但怎么让它变成BurpSuite里一个可加载的扩展呢5.1 本地调试与测试在将扩展打包之前最好先在开发环境中进行调试。使用VSCode调试在VSCode中你可以配置调试器。在项目根目录创建.vscode/launch.json文件配置一个Python调试任务。但由于我们的扩展最终运行在Jython/BurpSuite环境中直接调试Python代码可能无法调用Burp API。更实用的方法是模拟测试脚本创建一个独立的测试脚本例如test_patterns.py导入你的核心逻辑类但不是BurpExtender用本地文件或模拟的HTTP请求数据来测试你的正则匹配逻辑、路径解析函数等。这能确保核心算法正确。利用BurpSuite的Extender进行实时调试将你的src/sensitive_path_marker.py文件直接复制到一个临时位置。在BurpSuite中转到Extender-Extensions-Add。Extension Type选择Python。在Extension file中选择你复制出来的那个.py文件。点击NextBurpSuite会加载它。如果代码有语法错误会在Output标签页显示。加载成功后切换到Proxy-HTTP history访问一个包含/admin的网址。你应该能看到对应的请求被高亮为橙色并且注释栏出现了我们设置的标记。这是最重要的调试环节你可以在代码中插入大量的self._callbacks.printOutput(“Debug: ” some_var)语句输出变量值到BurpSuite的Output标签页观察程序执行流程。实操心得BurpSuite的Python环境Jython有时在错误提示上不够友好。一个常见的错误是ImportError可能是因为你的代码依赖了虚拟环境中的第三方库如requests而BurpSuite的Jython环境里没有。对于扩展核心功能应尽量只使用Python标准库和Burp API。如果必须用第三方库需要将其打包这会在下一节讲到。另外所有print语句在Jython中默认不会显示必须使用callbacks.printOutput()或callbacks.printError()。5.2 打包为JAR文件可选但推荐虽然可以直接加载.py文件但将其打包成一个包含所有依赖的JAR文件是更专业、更便于分发的做法。这样用户只需加载一个JAR无需关心Python环境。我们需要用到jython-standalone和shiv或setuptools的bdist_egg命令但过程稍复杂。这里介绍一个相对简单的手动打包方法适用于依赖不多的扩展。原理创建一个JAR文件其内部包含一个Lib文件夹里面是你的Python代码和所有依赖的第三方库.py文件或.pyc文件。一个__run__.py文件作为JAR包的入口点。一个META-INF/MANIFEST.MF文件指定主类一个特殊的Java类用于启动Jython。步骤简化版使用工具 对于新手我推荐使用社区工具burp-exporter或参考python-burp-extension模板项目。这些工具自动化了打包过程。以手动理解流程为例准备依赖在虚拟环境中将你的项目依赖安装到某个本地目录。pip install --target ./package_lib requests colorama six将你的src/sensitive_path_marker.py也复制到./package_lib目录下。创建入口文件在./package_lib目录下创建__run__.py。# __run__.py import sensitive_path_marker # BurpSuite会寻找并执行名为BurpExtender的类 # 由于我们导入了整个模块而模块中的主类就是BurpExtender这就可以了。 # 更明确的写法是 # from sensitive_path_marker import BurpExtender创建JAR使用jar命令需要安装JDK打包。cd package_lib jar cf ../SensitivePathMarker.jar .添加Jython运行时这不是必须的因为BurpSuite自带Jython。但如果你用了特定版本的库可能需要。更常见的做法是在扩展描述中注明“需要提前在BurpSuite中配置好Jython环境”。更可靠的方法直接使用BurpSuite的“Python扩展”类型加载你的.py主文件并确保BurpSuite的Python环境在Extender-Options中设置的PYTHONPATH包含了你的项目目录和虚拟环境的site-packages目录。这对于开发阶段是最方便的。5.3 在BurpSuite中加载与配置配置Jython环境首次需要打开BurpSuite进入Extender-Options。在Python Environment部分点击Select file指向你本地安装的Jython 2.7.x 的 JAR 文件如jython-standalone-2.7.3.jar。你可以从Jython官网下载。设置好后BurpSuite就具备了运行Python扩展的能力。加载扩展进入Extender-Extensions-Add。Extension Type选择Python。Extension file选择你打包好的SensitivePathMarker.jar文件或者直接选择你的sensitive_path_marker.py主文件。点击Next如果Output窗口没有报错且Extensions列表中出现“Sensitive Path Marker”并显示“Loaded”状态说明加载成功。使用与验证打开Proxy-Intercept确保拦截已关闭。用浏览器配置代理访问一个测试网站或者直接在BurpSuite的Repeater中发送一个请求到包含/admin的URL。转到Proxy-HTTP history或Target-Site map你应该能看到对应的请求行被高亮显示橙色并且鼠标悬停时能看到我们添加的注释。6. 进阶技巧与避坑指南掌握了基础开发流程后下面这些经验能帮你写出更健壮、更强大的扩展。6.1 性能优化与线程安全processHttpMessage是性能关键路径这个方法在高速代理流量下会被疯狂调用。务必避免在其中进行复杂的计算、网络IO或文件操作。使用缓存。例如将编译好的正则表达式、解析的配置信息保存在实例变量中。快速返回。如果经过判断不需要处理当前消息尽早使用return退出方法。线程安全BurpSuite的API调用可能发生在多个线程中。虽然大部分callbacks和helpers的方法被认为是线程安全的但如果你在自己的扩展中维护了共享状态比如一个存储统计信息的字典并且从多个事件处理方法如processHttpMessage和某个按钮的点击事件中访问它就需要考虑加锁。Python的threading模块提供了Lock。import threading class BurpExtender(...): def __init__(self): self._lock threading.Lock() self._request_count 0 def processHttpMessage(self, ...): with self._lock: self._request_count 1Swing GUI线程所有Swing UI的更新都必须在事件分发线程EDT上执行。在按钮事件处理器如_update_patterns中直接更新UI是安全的因为Swing就在EDT中调用这些处理器。但如果你在另一个线程比如处理完一个耗时任务后需要更新UI必须使用SwingUtilities.invokeLater。from javax.swing import SwingUtilities def some_background_task(self): # ... 耗时操作 ... result Done # 错误直接在其他线程更新UI可能导致界面冻结或崩溃 # self._label.setText(result) # 正确使用invokeLater def update_ui(): self._label.setText(result) SwingUtilities.invokeLater(update_ui)6.2 错误处理与日志记录全面捕获异常在processHttpMessage、按钮回调等所有入口方法中用try...except包裹核心逻辑。def processHttpMessage(self, ...): try: # 你的核心逻辑 except Exception as e: # 记录详细的错误信息包括堆栈跟踪 import traceback error_msg Error in processHttpMessage: {}\n{}.format(e, traceback.format_exc()) self._callbacks.printError(error_msg) # 可以选择是否重新抛出异常通常不抛出避免影响BurpSuite主程序分级日志利用callbacks.printOutput()信息、callbacks.printError()错误、callbacks.issueAlert()严重警告进行分级日志输出。在开发时可以设置一个调试开关。self._debug True def _debug_log(self, msg): if self._debug: self._callbacks.printOutput([DEBUG] msg)6.3 扩展的持久化配置我们的GUI允许用户修改关键词列表但BurpSuite重启后这些设置就丢失了。为了实现配置持久化可以使用BurpSuite提供的IExtensionStateListener接口和callbacks.saveExtensionSetting()/callbacks.loadExtensionSetting()方法。实现IExtensionStateListener接口这个接口有两个方法extensionUnloaded()扩展被卸载时调用和extensionUnloaded()其实应该是extensionUnloaded文档有时有误主要用extensionUnloaded。我们主要在扩展被卸载时保存配置。保存和加载使用callbacks.saveExtensionSetting(key, value)和callbacks.loadExtensionSetting(key)。value是字符串所以对于列表我们需要序列化如用json.dumps。代码示例from burp import IExtensionStateListener import json class BurpExtender(IBurpExtender, IHttpListener, ITab, IExtensionStateListener): def registerExtenderCallbacks(self, callbacks): # ... 其他初始化 ... # 注册状态监听器 callbacks.registerExtensionStateListener(self) # 加载保存的配置 self._load_settings() def _load_settings(self): 从BurpSuite加载保存的配置 saved_json self._callbacks.loadExtensionSetting(sensitive_patterns) if saved_json: try: self.sensitive_patterns json.loads(saved_json) self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] # 更新GUI中的文本区域 if hasattr(self, _patterns_text_area): SwingUtilities.invokeLater(lambda: self._patterns_text_area.setText(\n.join(self.sensitive_patterns))) self._callbacks.printOutput(Loaded saved patterns.) except Exception as e: self._callbacks.printError(Failed to load settings: str(e)) def _save_settings(self): 将当前配置保存到BurpSuite try: json_str json.dumps(self.sensitive_patterns) self._callbacks.saveExtensionSetting(sensitive_patterns, json_str) self._callbacks.printOutput(Settings saved.) except Exception as e: self._callbacks.printError(Failed to save settings: str(e)) # 在更新模式的按钮事件中调用保存 def _update_patterns(self, event): # ... 更新self.sensitive_patterns ... self._save_settings() # 保存新配置 # IExtensionStateListener 方法 def extensionUnloaded(self): 扩展被卸载时调用这里是保存配置的好时机 self._callbacks.printOutput(Extension is being unloaded, saving settings...) self._save_settings()这样用户设置的关键词列表就会在BurpSuite会话之间持久化了。6.4 与其他Burp工具深度集成我们的例子只用了IHttpListener和ITab。BurpSuite的API非常强大你可以让你的扩展与更多核心工具交互IScannerCheck创建自定义的主动扫描检查项。你可以定义扫描器在请求中插入哪些Payload如何分析响应以及如何报告漏洞。这是编写漏洞扫描插件的核心接口。IIntruderPayloadGenerator为Intruder工具生成自定义的Payload。例如从一个外部字典文件或API动态生成攻击载荷。IContextMenuFactory在BurpSuite界面的右键菜单中添加自定义项。比如选中一个请求右键可以直接发送到你的扩展进行特殊处理或调用外部工具。IMessageEditorTabFactory在HTTP消息编辑器Request/Response view中创建自定义的标签页用于以特定格式如JSON美化、XML解析、自定义协议解析展示或编辑数据。学习这些接口的最佳方式是阅读BurpSuite官方文档中的Extender API部分并参考GitHub上优秀的开源扩展项目如AuthMatrix、Autorize、Burp Bounty等看它们是如何利用这些接口实现复杂功能的。开发BurpSuite扩展是一个将你的安全想法快速工程化的过程。从简单的流量标记开始逐步尝试更复杂的交互和集成你会发现自己对BurpSuite的理解和掌控力大大加深。最重要的是你创造的工具将完美契合你自己的测试习惯和需求这才是效率提升的真正源泉。
Python开发BurpSuite扩展实战：从环境搭建到敏感路径标记器
1. 项目概述为什么需要自己动手开发BurpSuite扩展如果你是一名渗透测试工程师或者安全研究员那么BurpSuite对你来说可能就像瑞士军刀一样不可或缺。它拦截、重放、扫描、爆破功能强大。但用久了你会发现总有那么一些场景BurpSuite自带的工具链显得有点“笨拙”或者“不够用”。比如你需要批量处理某个特定格式的请求、自动化一个复杂的测试流程、或者与一个内部的自研安全平台进行深度联动。这时候官方插件商店里的那些通用插件可能就满足不了你的定制化需求了。这就是学习BurpSuite扩展开发的意义所在。它让你从一个工具的使用者转变为工具的“改造者”和“赋能者”。你可以根据自己的工作流打造出独一无二的“趁手兵器”。而Python凭借其简洁的语法、丰富的库生态以及在安全领域的广泛应用成为了开发BurpSuite扩展的首选语言之一。它不像Java那样需要复杂的编译和打包过程对于快速原型开发和脚本化任务来说Python的灵活性和开发效率是巨大的优势。这个项目就是带你从最纯净的环境开始一步步搭建起一个专为BurpSuite扩展开发服务的Python环境并最终完成一个具有实际功能的扩展将其部署到BurpSuite中运行。整个过程我会把我踩过的坑、调试时的心得、以及那些官方文档里不会写的细节毫无保留地分享给你。无论你是刚接触安全工具开发的新手还是想将Python自动化能力与BurpSuite结合的老手这篇指南都能给你提供一条清晰的路径。2. 环境搭建打造专属的Python开发沙箱很多人一上来就用自己的系统Python或者随便装个Anaconda就开始写代码这其实埋下了很多隐患。不同项目依赖冲突、系统环境被污染、打包时出现各种诡异问题都是这么来的。为BurpSuite扩展开发专门创建一个隔离、纯净的Python环境是保证项目顺利进行的第一步。2.1 Python解释器的选择与安装首先你需要一个Python解释器。我强烈建议直接从Python官网下载安装包而不是通过系统包管理器如apt或yum。官网版本更新而且能让你完全掌控安装路径和过程。版本选择BurpSuite的Java环境对Python版本有一定兼容性要求。经过大量实践Python 3.8 到 Python 3.11是兼容性最广、最稳定的选择。Python 3.12及以上版本有时会因为某些底层库的更新导致与JythonBurpSuite内置的Python解释器环境的交互出现兼容性问题。因此我建议你选择Python 3.9或Python 3.10作为你的开发版本它们在功能、性能和兼容性上取得了很好的平衡。安装要点下载Windows安装程序.exe或macOS/Linux的安装包。安装时务必勾选“Add Python to PATH”Windows或将Python执行路径添加到系统环境变量中。这能让你在命令行中直接使用python和pip命令省去后续手动配置的麻烦。安装完成后打开终端Windows用CMD或PowerShellmacOS/Linux用Terminal输入python --version或python3 --version来验证安装是否成功并确认版本号。注意在macOS和部分Linux发行版上系统可能预装了Python 2.7或另一个版本的Python 3。命令python可能指向旧版本。因此我们后续统一使用python3和pip3命令来明确指定使用我们新安装的版本。在Windows上如果只安装了一个Python 3则python命令通常就是可用的。2.2 虚拟环境管理使用venv隔离项目依赖系统级的Python环境是“公共场所”所有项目都共用一套库。当项目A需要requests 2.25而项目B需要requests 3.0时冲突就发生了。虚拟环境Virtual Environment就是为每个项目创建的“私人房间”房间内的家具第三方库互不干扰。Python 3.3以后官方内置了venv模块轻量且无需额外安装是我们的首选。创建虚拟环境 假设我们的项目目录叫burp_ext_dev我们在其中创建虚拟环境。# 切换到你的项目目录 cd /path/to/your/workspace mkdir burp_ext_dev cd burp_ext_dev # 创建虚拟环境环境文件夹命名为 venv (这是一个通用命名) python3 -m venv venv执行成功后当前目录下会生成一个名为venv的文件夹里面包含了一个独立的Python解释器副本和pip工具。激活虚拟环境 创建后需要“进入”这个环境这样后续的所有pip安装和python运行都会局限在这个环境内。Windows (CMD/PowerShell):# 在CMD中 venv\Scripts\activate.bat # 在PowerShell中 venv\Scripts\Activate.ps1macOS / Linux (bash/zsh):source venv/bin/activate激活后你的命令行提示符通常会发生变化前面会多出一个(venv)标识表示你正处在这个虚拟环境中。验证与退出 在激活状态下运行python --version和pip --version确认它们指向的是venv目录下的版本。 当你完成工作需要离开这个环境时只需在命令行输入deactivate即可。2.3 集成开发环境IDE配置VSCode的高效设置一个好用的IDE能极大提升开发效率。Visual Studio Code (VSCode) 因其轻量、免费和强大的扩展生态成为了很多开发者的选择。下面是如何为我们的BurpSuite扩展项目配置VSCode。安装VSCode从官网下载并安装。安装Python扩展在VSCode的扩展市场CtrlShiftX中搜索并安装官方发布的“Python”扩展由Microsoft发布。这个扩展提供了代码智能提示、调试、linting等核心功能。打开项目文件夹用VSCode打开我们刚才创建的burp_ext_dev文件夹。选择Python解释器按下CtrlShiftP或CmdShiftPon Mac打开命令面板输入“Python: Select Interpreter”然后选择列表中指向./venv/Scripts/python.exe(Windows) 或./venv/bin/python(macOS/Linux) 的那一项。这确保了VSCode使用我们虚拟环境中的Python来运行和调试代码。推荐安装的扩展Python Docstring Generator自动生成规范的函数/类注释文档。Code Spell Checker检查代码中的英文拼写错误。Rainbow CSV如果你需要处理CSV格式的数据这个扩展能让各列以不同颜色高亮非常直观。实操心得在VSCode中你可以为这个项目单独配置工作区设置。在项目根目录创建一个.vscode文件夹里面放一个settings.json文件。你可以在这里设置项目特定的Python路径、代码格式化规则如使用autopep8或black、以及linter如pylint或flake8。这样当你把项目分享给队友时他们用VSCode打开就能获得一致的开发体验。3. 核心依赖解析理解BurpSuite扩展的骨架一个BurpSuite扩展本质上是一个遵循了特定接口规范的Java类。但是通过Jython一个用Java实现的Python解释器我们可以用Python来编写这个Java类。要让我们的Python代码能与BurpSuite的Java API对话就需要一个关键的桥梁——burp模块。同时为了高效开发我们还需要一些辅助工具。3.1 核心依赖burp-api与Jythonburp模块这不是一个可以通过pip安装的第三方库。它是由BurpSuite在运行时动态注入到Jython环境中的。你的Python扩展代码中需要import burp然后通过它来访问IBurpExtender、IHttpListener、IScannerCheck等核心接口。因此在开发环境的requirements.txt里你不需要也无法列出它。但是为了获得代码自动补全和类型提示我们需要一个“存根”stub文件。获取API存根文件你可以从BurpSuite的官方文档或GitHub上的一些开源扩展项目中找到一个名为burp的目录里面包含__init__.py等文件。将这个目录复制到你的项目根目录下或者放到虚拟环境的site-packages目录中。这样VSCode的Python扩展就能识别burp模块为你提供API方法的智能提示这能节省大量查阅文档的时间。Jython这是BurpSuite内置的Python解释器。我们本地用CPython我们安装的Python开发调试但最终代码需要在Jython环境中运行。Jython目前稳定版本是2.7.x它兼容的是Python 2.7的语法和大部分标准库。这就是为什么我们选择Python 3.8进行开发但在编写代码时需要特别注意兼容性问题。好消息是对于扩展开发中常用的核心逻辑字符串处理、网络请求、数据结构Python 2.7和3.x的差异在可接受的范围内主要注意print语句和字符串编码strvsunicode即可。BurpSuite的Java API处理字符串时通常使用Java的String类型Jython会自动进行转换。3.2 辅助工具库提升开发效率虽然核心逻辑依赖burpAPI但一些辅助性的工作我们可以用强大的Python库来完成让代码更简洁。requests虽然BurpSuite提供了IHttpRequestResponse接口来处理HTTP流量但在扩展初始化时或者需要与外部REST API通信例如从内部漏洞库拉取数据、向团队协作平台发送通知时requests库比手动构造Java的HTTP客户端要方便得多。注意在扩展处理实时流量时应优先使用BurpSuite自身的API以保证性能和兼容性。Jinja2如果你的扩展需要生成复杂的报告、HTML页面或者自定义的GUI界面通过ITab接口Jinja2模板引擎能帮你清晰地分离逻辑和展示层。colorama在控制台输出日志时使用颜色可以快速区分信息、警告和错误。colorama库解决了Windows下终端颜色转义的问题让彩色输出跨平台。six这是一个用于兼容Python 2和Python 3的轻量级库。如果你希望你的扩展在更多环境下具备更好的兼容性或者你使用了某些同时支持2和3的第三方库six可以帮助你处理一些常见的兼容性痛点如urllib、basestring类型等。依赖管理在项目根目录创建一个requirements.txt文件列出这些辅助库。requests2.25.1 Jinja23.0.0 colorama0.4.4 six1.16.0然后在激活的虚拟环境中运行pip install -r requirements.txt来一键安装。4. 第一个扩展实战开发一个自定义的HTTP流量标记器理论讲得再多不如动手写一个。我们来开发一个实用的扩展“敏感路径扫描标记器”。它的功能是自动检查经过BurpSuite代理的所有HTTP请求如果请求的URL路径中包含诸如/admin/api/v1/user/config/backup等预定义的敏感关键词就在BurpSuite的Proxy history或Target站点地图中给这个请求打上一个高亮的标记并添加注释提醒测试人员重点关注。4.1 项目结构与入口文件一个典型的BurpSuite Python扩展项目结构如下burp_ext_dev/ ├── venv/ # 虚拟环境目录.gitignore忽略 ├── burp/ # Burp API存根文件可选用于代码提示 ├── src/ │ └── sensitive_path_marker.py # 我们的主扩展代码 ├── resources/ # 存放图标、模板等资源文件 ├── requirements.txt # Python依赖列表 └── README.md # 项目说明现在我们在src目录下创建主文件sensitive_path_marker.py。扩展入口类每个BurpSuite扩展都必须有一个实现了IBurpExtender接口的类。这是扩展的入口点。# -*- coding: utf-8 -*- from burp import IBurpExtender, IHttpListener, ITab import re class BurpExtender(IBurpExtender, IHttpListener): 这是扩展的主类必须命名为 BurpExtender。 它实现了 IBurpExtender 和 IHttpListener 接口。 IBurpExtender 是必须的用于注册扩展。 IHttpListener 允许我们监听和处理所有的HTTP请求和响应。 def registerExtenderCallbacks(self, callbacks): 这是扩展的初始化方法BurpSuite在加载扩展时会自动调用。 callbacks 对象是我们与BurpSuite交互的核心它提供了所有API。 # 保存callbacks对象和helpers对象后续会频繁使用 self._callbacks callbacks self._helpers callbacks.getHelpers() # 设置扩展名称这会在Extender标签页中显示 callbacks.setExtensionName(Sensitive Path Marker) # 将自己这个类实例注册为一个HTTP监听器 # 这样每当有HTTP流量经过Burp时processHttpMessage方法就会被调用 callbacks.registerHttpListener(self) # 初始化敏感路径关键词列表 # 这里使用正则表达式进行匹配更灵活 self.sensitive_patterns [ r(?i)/admin, # 不区分大小写的admin目录 r(?i)/api/v\d/user, # 用户相关API接口 r(?i)/config, # 配置文件 r(?i)/backup, # 备份文件或目录 r(?i)/\.git, # Git仓库泄露 r(?i)/\.env, # 环境配置文件 r(?i)/phpinfo, # PHP信息泄露 r(?i)/debug, # 调试接口 ] self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] # 输出启动日志到Burp的Alerts或Output标签页 callbacks.printOutput(Sensitive Path Marker extension loaded successfully.) callbacks.printOutput(Monitoring for sensitive paths: , .join(self.sensitive_patterns))代码解读from burp import ...导入必要的接口。IHttpListener让我们能监听HTTP流量。class BurpExtender(...)类名必须是BurpExtender。它继承了IBurpExtender和IHttpListener。registerExtenderCallbacks(self, callbacks)这是生命周期的起点。我们在这里保存callbacks和helpers对象备用。用setExtensionName设置扩展显示名。用registerHttpListener(self)注册为监听器。初始化我们的业务逻辑这里是敏感路径模式列表。打印加载成功的日志。4.2 实现流量处理逻辑IHttpListener接口注册为监听器后我们需要实现IHttpListener接口定义的processHttpMessage方法。这个方法会在每个HTTP请求和响应经过BurpSuite时被调用。def processHttpMessage(self, toolFlag, messageIsRequest, messageInfo): 处理HTTP消息的核心方法。 参数: toolFlag: 一个整数标识消息来自哪个Burp工具如Proxy, Scanner, Repeater。 messageIsRequest: 布尔值True表示当前是请求消息False是响应消息。 messageInfo: IHttpRequestResponse对象包含了完整的请求和响应信息及元数据。 # 我们只关心HTTP请求并且只处理来自Proxy工具ID 0x04或Scanner等核心工具的流量。 # 这样可以避免对Repeater中手动修改的请求进行重复标记。 if not messageIsRequest: return # 检查工具来源这里我们处理Proxy(4), Spider(8), Scanner(16)的流量 # 工具ID定义可以在IBurpExtenderCallbacks接口文档中找到 if toolFlag not in (0x04, 0x08, 0x10): return # 从messageInfo中获取HTTP请求的字节流和URL对象 request_bytes messageInfo.getRequest() analyzed_request self._helpers.analyzeRequest(request_bytes) url analyzed_request.getUrl() # 将URL对象转换为字符串并提取路径部分 url_str self._helpers.bytesToString(url.toString()) # 注意url.toString() 返回的是完整的URL包括协议、主机、端口、路径和查询参数。 # 我们主要关心路径部分。 from java.net import URL as JavaURL if isinstance(url, JavaURL): path url.getPath() query url.getQuery() full_path path (? query if query else ) else: # 备用方案使用字符串解析 import urllib.parse parsed_url urllib.parse.urlparse(url_str) full_path parsed_url.path (? parsed_url.query if parsed_url.query else ) # 检查路径是否匹配任何敏感模式 found_sensitive False matched_pattern for pattern in self.compiled_patterns: if pattern.search(full_path): found_sensitive True matched_pattern pattern.pattern break # 如果发现敏感路径则进行标记 if found_sensitive: # 1. 添加高亮颜色 (这里使用橙色) # BurpSuite支持的颜色常量定义在IContextMenuInvocation接口中如 # 0:红, 1:橙, 2:黄, 3:绿, 4:青, 5:蓝, 6:粉, 7:灰 highlight_color 1 # 橙色 messageInfo.setHighlight(highlight_color) # 2. 添加注释说明匹配到的敏感模式 current_comment messageInfo.getComment() new_comment [Sensitive Path: {}].format(matched_pattern) if current_comment: # 如果已有注释则追加 new_comment current_comment ; new_comment messageInfo.setComment(new_comment) # 可选在Output标签页打印一条日志便于调试 self._callbacks.printOutput(Marked sensitive path: {} in tool {}.format(full_path, toolFlag))代码解读与避坑指南工具过滤toolFlag参数非常重要。BurpSuite有很多工具Proxy, Scanner, Intruder, Repeater, Spider等。如果不加过滤你在Repeater里每发送一次请求扩展都会处理并可能重复标记。通常我们只标记来自Proxy实时流量、Spider爬虫或Scanner主动扫描的请求。0x04,0x08,0x10是这些工具的十六进制标识符。URL处理messageInfo.getUrl()返回的是一个java.net.URL对象。在Jython环境中我们可以直接使用Java类。url.getPath()能直接获取路径部分这是最可靠的方式。备用方案使用了Python的urllib.parse但要注意Jython 2.7环境下可能需要进行一些兼容性处理。字符串编码self._helpers.bytesToString()是将字节数组转换为字符串的安全方法。在BurpSuite的API中HTTP消息通常以字节数组byte[]形式传递使用helpers对象进行转换能避免编码问题。设置高亮和注释setHighlight()和setComment()是IHttpRequestResponse接口的方法它们会直接修改BurpSuite界面中对应请求的显示状态。这是一个非常直观的交互方式。性能考虑processHttpMessage会被频繁调用因此里面的逻辑应尽可能高效。我们预编译了正则表达式self.compiled_patterns避免在每次调用时重复编译。对于更复杂的匹配逻辑可以考虑使用前缀树Trie等数据结构。4.3 扩展功能添加图形界面ITab接口让用户能动态管理敏感关键词列表而不是硬编码在代码里会实用得多。我们可以为扩展添加一个简单的GUI标签页。首先需要安装一个用于创建GUI的库。由于BurpSuite基于Java Swing我们可以使用javax.swing包但用纯Java代码写Swing比较繁琐。我们可以使用Jython环境下可用的wxPython如果BurpSuite环境配置了或者更简单地利用BurpSuite提供的IBurpExtenderCallbacks.createTextEditor()方法来创建一个文本编辑器组件用于编辑关键词列表。这里我们采用一个折中且兼容性更好的方案在扩展中实现ITab接口创建一个包含JTextArea的简单Swing面板。# 在文件顶部添加Swing导入 from javax.swing import JPanel, JTextArea, JScrollPane, JButton, JLabel, BorderFactory from java.awt import BorderLayout, Dimension import java # 修改类定义实现ITab接口 class BurpExtender(IBurpExtender, IHttpListener, ITab): def registerExtenderCallbacks(self, callbacks): # ... 之前的初始化代码保持不变 ... # 初始化GUI组件 self._init_ui() # 注册自己为一个标签页 callbacks.addSuiteTab(self) # ... 其余代码 ... def _init_ui(self): 初始化用户界面 # 创建主面板 self._main_panel JPanel(BorderLayout()) # 创建文本区域用于显示和编辑敏感路径列表 self._patterns_text_area JTextArea() # 将列表初始化为文本每行一个模式 initial_text \n.join(self.sensitive_patterns) self._patterns_text_area.setText(initial_text) self._patterns_text_area.setLineWrap(True) self._patterns_text_area.setWrapStyleWord(True) # 将文本区域放入滚动面板 scroll_pane JScrollPane(self._patterns_text_area) scroll_pane.setPreferredSize(Dimension(400, 300)) # 创建按钮用于保存更新 save_button JButton(Update Patterns, actionPerformedself._update_patterns) # 创建说明标签 info_label JLabel(Enter one sensitive path pattern per line (regex supported).) # 布局 top_panel JPanel(BorderLayout()) top_panel.add(info_label, BorderLayout.NORTH) top_panel.add(scroll_pane, BorderLayout.CENTER) self._main_panel.add(top_panel, BorderLayout.CENTER) self._main_panel.add(save_button, BorderLayout.SOUTH) # 设置边框 self._main_panel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10)) def _update_patterns(self, event): 按钮事件处理更新敏感模式列表 text self._patterns_text_area.getText() lines [line.strip() for line in text.split(\n) if line.strip()] # 简单的验证非空行 if not lines: self._callbacks.printError(Pattern list cannot be empty!) return # 更新内存中的模式列表 self.sensitive_patterns lines try: self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] self._callbacks.printOutput(Sensitive patterns updated successfully.) self._callbacks.printOutput(New patterns: , .join(self.sensitive_patterns)) except re.error as e: self._callbacks.printError(Invalid regular expression: str(e)) # --- ITab 接口方法实现 --- def getTabCaption(self): 返回标签页的标题 return Sensitive Paths def getUiComponent(self): 返回标签页的UI组件 return self._main_panelGUI实现要点导入Swingfrom javax.swing import ...和from java.awt import ...。这是在Jython环境中使用Java Swing的方式。实现ITab接口类需要实现getTabCaption()返回标签页名和getUiComponent()返回主面板两个方法。注册标签页在registerExtenderCallbacks中通过callbacks.addSuiteTab(self)将扩展添加到BurpSuite主界面的标签栏。事件处理JButton(actionPerformedself._update_patterns)将按钮点击事件绑定到我们的处理方法上。在_update_patterns方法中我们从文本区域读取内容更新内存中的正则表达式列表并重新编译。错误处理对用户输入的正则表达式进行编译尝试如果编译失败通过callbacks.printError()在BurpSuite的Alerts标签页显示错误信息避免扩展崩溃。5. 调试、打包与部署让扩展在BurpSuite中跑起来代码写好了但怎么让它变成BurpSuite里一个可加载的扩展呢5.1 本地调试与测试在将扩展打包之前最好先在开发环境中进行调试。使用VSCode调试在VSCode中你可以配置调试器。在项目根目录创建.vscode/launch.json文件配置一个Python调试任务。但由于我们的扩展最终运行在Jython/BurpSuite环境中直接调试Python代码可能无法调用Burp API。更实用的方法是模拟测试脚本创建一个独立的测试脚本例如test_patterns.py导入你的核心逻辑类但不是BurpExtender用本地文件或模拟的HTTP请求数据来测试你的正则匹配逻辑、路径解析函数等。这能确保核心算法正确。利用BurpSuite的Extender进行实时调试将你的src/sensitive_path_marker.py文件直接复制到一个临时位置。在BurpSuite中转到Extender-Extensions-Add。Extension Type选择Python。在Extension file中选择你复制出来的那个.py文件。点击NextBurpSuite会加载它。如果代码有语法错误会在Output标签页显示。加载成功后切换到Proxy-HTTP history访问一个包含/admin的网址。你应该能看到对应的请求被高亮为橙色并且注释栏出现了我们设置的标记。这是最重要的调试环节你可以在代码中插入大量的self._callbacks.printOutput(“Debug: ” some_var)语句输出变量值到BurpSuite的Output标签页观察程序执行流程。实操心得BurpSuite的Python环境Jython有时在错误提示上不够友好。一个常见的错误是ImportError可能是因为你的代码依赖了虚拟环境中的第三方库如requests而BurpSuite的Jython环境里没有。对于扩展核心功能应尽量只使用Python标准库和Burp API。如果必须用第三方库需要将其打包这会在下一节讲到。另外所有print语句在Jython中默认不会显示必须使用callbacks.printOutput()或callbacks.printError()。5.2 打包为JAR文件可选但推荐虽然可以直接加载.py文件但将其打包成一个包含所有依赖的JAR文件是更专业、更便于分发的做法。这样用户只需加载一个JAR无需关心Python环境。我们需要用到jython-standalone和shiv或setuptools的bdist_egg命令但过程稍复杂。这里介绍一个相对简单的手动打包方法适用于依赖不多的扩展。原理创建一个JAR文件其内部包含一个Lib文件夹里面是你的Python代码和所有依赖的第三方库.py文件或.pyc文件。一个__run__.py文件作为JAR包的入口点。一个META-INF/MANIFEST.MF文件指定主类一个特殊的Java类用于启动Jython。步骤简化版使用工具 对于新手我推荐使用社区工具burp-exporter或参考python-burp-extension模板项目。这些工具自动化了打包过程。以手动理解流程为例准备依赖在虚拟环境中将你的项目依赖安装到某个本地目录。pip install --target ./package_lib requests colorama six将你的src/sensitive_path_marker.py也复制到./package_lib目录下。创建入口文件在./package_lib目录下创建__run__.py。# __run__.py import sensitive_path_marker # BurpSuite会寻找并执行名为BurpExtender的类 # 由于我们导入了整个模块而模块中的主类就是BurpExtender这就可以了。 # 更明确的写法是 # from sensitive_path_marker import BurpExtender创建JAR使用jar命令需要安装JDK打包。cd package_lib jar cf ../SensitivePathMarker.jar .添加Jython运行时这不是必须的因为BurpSuite自带Jython。但如果你用了特定版本的库可能需要。更常见的做法是在扩展描述中注明“需要提前在BurpSuite中配置好Jython环境”。更可靠的方法直接使用BurpSuite的“Python扩展”类型加载你的.py主文件并确保BurpSuite的Python环境在Extender-Options中设置的PYTHONPATH包含了你的项目目录和虚拟环境的site-packages目录。这对于开发阶段是最方便的。5.3 在BurpSuite中加载与配置配置Jython环境首次需要打开BurpSuite进入Extender-Options。在Python Environment部分点击Select file指向你本地安装的Jython 2.7.x 的 JAR 文件如jython-standalone-2.7.3.jar。你可以从Jython官网下载。设置好后BurpSuite就具备了运行Python扩展的能力。加载扩展进入Extender-Extensions-Add。Extension Type选择Python。Extension file选择你打包好的SensitivePathMarker.jar文件或者直接选择你的sensitive_path_marker.py主文件。点击Next如果Output窗口没有报错且Extensions列表中出现“Sensitive Path Marker”并显示“Loaded”状态说明加载成功。使用与验证打开Proxy-Intercept确保拦截已关闭。用浏览器配置代理访问一个测试网站或者直接在BurpSuite的Repeater中发送一个请求到包含/admin的URL。转到Proxy-HTTP history或Target-Site map你应该能看到对应的请求行被高亮显示橙色并且鼠标悬停时能看到我们添加的注释。6. 进阶技巧与避坑指南掌握了基础开发流程后下面这些经验能帮你写出更健壮、更强大的扩展。6.1 性能优化与线程安全processHttpMessage是性能关键路径这个方法在高速代理流量下会被疯狂调用。务必避免在其中进行复杂的计算、网络IO或文件操作。使用缓存。例如将编译好的正则表达式、解析的配置信息保存在实例变量中。快速返回。如果经过判断不需要处理当前消息尽早使用return退出方法。线程安全BurpSuite的API调用可能发生在多个线程中。虽然大部分callbacks和helpers的方法被认为是线程安全的但如果你在自己的扩展中维护了共享状态比如一个存储统计信息的字典并且从多个事件处理方法如processHttpMessage和某个按钮的点击事件中访问它就需要考虑加锁。Python的threading模块提供了Lock。import threading class BurpExtender(...): def __init__(self): self._lock threading.Lock() self._request_count 0 def processHttpMessage(self, ...): with self._lock: self._request_count 1Swing GUI线程所有Swing UI的更新都必须在事件分发线程EDT上执行。在按钮事件处理器如_update_patterns中直接更新UI是安全的因为Swing就在EDT中调用这些处理器。但如果你在另一个线程比如处理完一个耗时任务后需要更新UI必须使用SwingUtilities.invokeLater。from javax.swing import SwingUtilities def some_background_task(self): # ... 耗时操作 ... result Done # 错误直接在其他线程更新UI可能导致界面冻结或崩溃 # self._label.setText(result) # 正确使用invokeLater def update_ui(): self._label.setText(result) SwingUtilities.invokeLater(update_ui)6.2 错误处理与日志记录全面捕获异常在processHttpMessage、按钮回调等所有入口方法中用try...except包裹核心逻辑。def processHttpMessage(self, ...): try: # 你的核心逻辑 except Exception as e: # 记录详细的错误信息包括堆栈跟踪 import traceback error_msg Error in processHttpMessage: {}\n{}.format(e, traceback.format_exc()) self._callbacks.printError(error_msg) # 可以选择是否重新抛出异常通常不抛出避免影响BurpSuite主程序分级日志利用callbacks.printOutput()信息、callbacks.printError()错误、callbacks.issueAlert()严重警告进行分级日志输出。在开发时可以设置一个调试开关。self._debug True def _debug_log(self, msg): if self._debug: self._callbacks.printOutput([DEBUG] msg)6.3 扩展的持久化配置我们的GUI允许用户修改关键词列表但BurpSuite重启后这些设置就丢失了。为了实现配置持久化可以使用BurpSuite提供的IExtensionStateListener接口和callbacks.saveExtensionSetting()/callbacks.loadExtensionSetting()方法。实现IExtensionStateListener接口这个接口有两个方法extensionUnloaded()扩展被卸载时调用和extensionUnloaded()其实应该是extensionUnloaded文档有时有误主要用extensionUnloaded。我们主要在扩展被卸载时保存配置。保存和加载使用callbacks.saveExtensionSetting(key, value)和callbacks.loadExtensionSetting(key)。value是字符串所以对于列表我们需要序列化如用json.dumps。代码示例from burp import IExtensionStateListener import json class BurpExtender(IBurpExtender, IHttpListener, ITab, IExtensionStateListener): def registerExtenderCallbacks(self, callbacks): # ... 其他初始化 ... # 注册状态监听器 callbacks.registerExtensionStateListener(self) # 加载保存的配置 self._load_settings() def _load_settings(self): 从BurpSuite加载保存的配置 saved_json self._callbacks.loadExtensionSetting(sensitive_patterns) if saved_json: try: self.sensitive_patterns json.loads(saved_json) self.compiled_patterns [re.compile(p) for p in self.sensitive_patterns] # 更新GUI中的文本区域 if hasattr(self, _patterns_text_area): SwingUtilities.invokeLater(lambda: self._patterns_text_area.setText(\n.join(self.sensitive_patterns))) self._callbacks.printOutput(Loaded saved patterns.) except Exception as e: self._callbacks.printError(Failed to load settings: str(e)) def _save_settings(self): 将当前配置保存到BurpSuite try: json_str json.dumps(self.sensitive_patterns) self._callbacks.saveExtensionSetting(sensitive_patterns, json_str) self._callbacks.printOutput(Settings saved.) except Exception as e: self._callbacks.printError(Failed to save settings: str(e)) # 在更新模式的按钮事件中调用保存 def _update_patterns(self, event): # ... 更新self.sensitive_patterns ... self._save_settings() # 保存新配置 # IExtensionStateListener 方法 def extensionUnloaded(self): 扩展被卸载时调用这里是保存配置的好时机 self._callbacks.printOutput(Extension is being unloaded, saving settings...) self._save_settings()这样用户设置的关键词列表就会在BurpSuite会话之间持久化了。6.4 与其他Burp工具深度集成我们的例子只用了IHttpListener和ITab。BurpSuite的API非常强大你可以让你的扩展与更多核心工具交互IScannerCheck创建自定义的主动扫描检查项。你可以定义扫描器在请求中插入哪些Payload如何分析响应以及如何报告漏洞。这是编写漏洞扫描插件的核心接口。IIntruderPayloadGenerator为Intruder工具生成自定义的Payload。例如从一个外部字典文件或API动态生成攻击载荷。IContextMenuFactory在BurpSuite界面的右键菜单中添加自定义项。比如选中一个请求右键可以直接发送到你的扩展进行特殊处理或调用外部工具。IMessageEditorTabFactory在HTTP消息编辑器Request/Response view中创建自定义的标签页用于以特定格式如JSON美化、XML解析、自定义协议解析展示或编辑数据。学习这些接口的最佳方式是阅读BurpSuite官方文档中的Extender API部分并参考GitHub上优秀的开源扩展项目如AuthMatrix、Autorize、Burp Bounty等看它们是如何利用这些接口实现复杂功能的。开发BurpSuite扩展是一个将你的安全想法快速工程化的过程。从简单的流量标记开始逐步尝试更复杂的交互和集成你会发现自己对BurpSuite的理解和掌控力大大加深。最重要的是你创造的工具将完美契合你自己的测试习惯和需求这才是效率提升的真正源泉。
