Research Academy
My account Customers About Blog Careers Legal Contact Resellers

Burp Suite User Forum

Create new post

Extender callback for getting the currently active project's name

xx | Last updated: Nov 18, 2021 10:08AM UTC

Hello! Maybe I'm blind, but I can't find in the documentation a callback for getting the currently active project's name (set during project set up). I thought of parsing the output of saveConfigAsJson(), but it's not in there either. What is the canonical method of getting the active project's name?

Hannah, PortSwigger Agent | Last updated: Nov 19, 2021 05:23PM UTC

Hi There isn't a way to do this in the API documentation. However, the extension "Sharpener" has a method to override the text in the title bar of your Burp - you could check out how he got to the text in the first place by looking at the source code? You can find this here: https://github.com/PortSwigger/sharpener All BApp Store extensions have their code publicly available on GitHub here: https://github.com/PortSwigger

xx | Last updated: Nov 22, 2021 07:30AM UTC

Seems quite hacky - getting the title from UI elements and parsing the project name from there. As per your suggestion, I'll be doing that, but it seems like it could break at any moment. Is there no possibility of adding this functionality to the API? Seems relatively easy to implement. My extension pushes requests and responses to ElasticSearch, and it would be great if I could identify requests/responses by the project they're tied to.

Hannah, PortSwigger Agent | Last updated: Nov 22, 2021 11:07AM UTC

We can raise a feature request for this functionality. We'll be looking at making some changes to the Extender API in the next year.

Have you had a look at the existing BApp Store extension, Report To Elastic Search? That extension seems to use some logic to determine whether an issue has been raised by the same scan or not.

If you wanted to identify issues on a project level basis, you could store a fake item in the sitemap containing a UUID - that would mean that if the fake item is there, it's an existing project, and if it isn't then it's a new project.

An existing BApp Store author has a GitHub repo containing different utilities that he uses - I believe this particular one is found here.

xx | Last updated: Mar 22, 2022 08:40AM UTC

Hello! I was wondering whether there's been some changes regarding this issue. I'm currently getting the project title from the UI, which works but seems incredibly hacky and prone to breaking at any time. Due to how the UI is populated, I have to make my extension artificially wait on start up in order for the UI tab to be added so I can grab the title, etc. It'd be great if there was simply a callback I could use. I'm not familiar with the internals of BurpSuite, but it seems like adding this callback would take 15 minutes max.

Hannah, PortSwigger Agent | Last updated: Mar 23, 2022 09:05AM UTC

Hi This year we are working on a complete overhaul of the Extender API. Towards the end of this year, you should see a lot of added functionality. You can find our roadmap here: https://portswigger.net/burp/pro/roadmap

Mark | Last updated: Mar 23, 2023 06:48AM UTC

Hi, Anyone know if this was ever added? I checked the docs, https://portswigger.net/burp/extender/api/ and didn't see any reference to project name.

Hannah, PortSwigger Agent | Last updated: Mar 23, 2023 09:50AM UTC

We still don't have the functionality to directly retrieve the project file name. I've added your +1 to our ongoing feature request for this functionality. It is now possible with the new Montoya API to store extension settings and data on a project-level basis. You could use a generated UUID stored in the project settings to uniquely identify a project file?

You must be an existing, logged-in customer to reply to a thread. Please email us for additional support.