Skip to content
This repository was archived by the owner on May 2, 2025. It is now read-only.

Commit 1474ed3

Browse files
authored
Update README.md
1 parent a4cbd71 commit 1474ed3

File tree

1 file changed

+2
-180
lines changed

1 file changed

+2
-180
lines changed

README.md

Lines changed: 2 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -1,180 +1,2 @@
1-
> [!NOTE]
2-
> A migration to the [Montoya](https://github.com/PortSwigger/burp-extensions-montoya-api) model of extension was kindly performed by [@dominiqueroux](https://github.com/dominiqueroux) 🧡.
3-
4-
[![NightBuild](https://github.com/righettod/log-requests-to-sqlite/workflows/NightBuild/badge.svg)](https://github.com/righettod/log-requests-to-sqlite/actions)
5-
[![Known Vulnerabilities](https://snyk.io/test/github/righettod/log-requests-to-sqlite/badge.svg?targetFile=build.gradle)](https://snyk.io/test/github/righettod/log-requests-to-sqlite?targetFile=build.gradle)
6-
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
7-
[![BAppStore Version](https://img.shields.io/badge/BApp%20Store-v2.0.0-orange.svg)](https://portswigger.net/bappstore/d916d94506734f3490e49391595d8747)
8-
9-
# Log Requests to SQLite
10-
11-
This extension has a single objective:
12-
13-
*Keep a trace of every HTTP request that has been sent via BURP.*
14-
15-
Why?
16-
17-
When I perform an assessment of a web application, it is often spread on several days/weeks and during this assessment, I use the different tools proposed by BURP (Proxy, Repeater, Intruder, Spider, Scanner...) to send many HTTP request to the target application.
18-
19-
Since a few months, I have met a situation that happens more and more with the time: Some time after the closure of the assessment (mission is finished and report has been delivered), the client ask this kind of question:
20-
* Do you have evaluated this service or this URL?
21-
* Is it you that have sent this "big request" to this service/URL on this date?
22-
* How many requests do you have sent to the application or to this service?
23-
* And so on...
24-
25-
Most of the time, I answer to the client in this way: "This is the IP used for the assessment (the IP is also in the report by the way), check the logs of your web server, web app server, WAF..." because it's up to the client to have the capacity to backtrack a stream from a specific IP address.
26-
27-
In the same time, I cannot give the BURP session file to the client because:
28-
* I cannot ask to a client to buy a BURP licence just to see the session content.
29-
* I cannot ask to a client to learn what is BURP and how to use BURP.
30-
* Requests send via Intruder/Repeater/Spider/Scanner are not kept in the session log.
31-
32-
So, I have decided to write this extension in order to keep the information of any HTTP request sends in a SQLIte database that I can give to the client along the report and let him dig into the DB via SQL query to answer his questions and, in the same time, have a proof/history of all requests send to the target application...
33-
34-
Once loaded, the extension ask the user to choose the target database file (location and name) to use for the SQLite database or to continue using the current defined file in the previous session.
35-
36-
Regarding the file name to use, there no constraint applied on it but I recommend to use a file with the `.db` extension to facilitate the usage with a SQLite client for exploration operations.
37-
38-
After, the extension silently records every HTTP request send during the BURP session.
39-
40-
![Extension Log](example1.png)
41-
42-
![DB Content](example2.png)
43-
44-
# Options
45-
46-
## Scope
47-
48-
There is an option to restrict the logging to the requests that are included into the defined target scope (BURP tab **Target** > **Scope**):
49-
50-
![Scope Option Menu](example3.png)
51-
52-
## Images
53-
54-
There is an option to exclude the logging of the requests that target images (check is not case sensitive):
55-
56-
![Image Option Menu](example4.png)
57-
58-
The list of supported file extensions is [here](resources/settings.properties).
59-
60-
## Include the responses content
61-
62-
There is an option to log also the response content, in raw, associated to a request. By default, this option is disabled.
63-
64-
![Logging of the responses Option Menu](example8.png)
65-
66-
## Pause the logging
67-
68-
There is an option to pause the logging (re-click on the menu to resume the logging):
69-
70-
![Pause Option Menu](example6a.png)
71-
72-
When the logging is paused then when Burp is restarted, it keep in mind that the logging was previously paused and then reflect the state in the menu:
73-
74-
![Pause Option Menu](example6c.png)
75-
76-
Otherwise, when Burp is started and logging was not previously paused then the following options are proposed:
77-
78-
![Pause Option Menu](example6b.png)
79-
80-
## Change the DB file
81-
82-
:warning: This option require that the logging was paused.
83-
84-
There is an option to change the DB file during a Burp working session:
85-
86-
![ChangeDB Option Menu](example7.png)
87-
88-
## Statistics
89-
90-
There is an option to obtain statistics about the information logged in the database:
91-
92-
![Image Stats Menu 1](example5a.png)
93-
94-
![Image Stats Menu 2](example5b.png)
95-
96-
# Build the extension JAR file
97-
98-
Use the following command and the JAR file **LogRequestsToSQLite.jar** will be located in folder **target**:
99-
100-
```
101-
$ mvn clean package
102-
```
103-
104-
# Night build
105-
106-
See the [Actions](https://github.com/righettod/log-requests-to-sqlite/actions) section.
107-
108-
# BApp Store
109-
110-
The extension is referenced [here](https://portswigger.net/bappstore/d916d94506734f3490e49391595d8747).
111-
112-
# BApp Store update procedure
113-
114-
Procedure kindly provided by the PortSwigger support:
115-
116-
1. BApp Author commits fixes/updates to the master repository.
117-
2. Once BApp Author is happy that updates need to be pushed to the BApp store, the Author creates a pull request so changes can be merged into the forked repository: `righettod wants to merge xx commits into PortSwigger:master from righettod:master`
118-
3. BApp Author notifies PortSwigger support that changes need to be merged, support staff reviews changes and then accepts pull request so the changes are merged.
119-
4. BApp is then compiled from the forked repository version and then pushed to the BApp store.
120-
121-
# Change log
122-
123-
**2.0.0**
124-
125-
* [Task list](/../../issues/47) to complete it.
126-
* Update all dependencies.
127-
* Add logging of the HTTP response.
128-
* Huge thanks to [@seckek](https://github.com/seckek) for his PR :medal_sports:.
129-
130-
**1.0.9**
131-
132-
* Upgrade `sqlite-jdbc` library to the latest available.
133-
* Fix a bug during extension loading preventing it to crash if the stored DB file do not exist anymore.
134-
135-
**1.0.8**
136-
137-
* Add the capacity to pause the logging during a Burp working session - Issue [#9](/../../issues/9).
138-
* Add the capacity to change the DB file during a Burp working session - Issue [#10](/../../issues/10).
139-
140-
**1.0.7**
141-
142-
* Upgrade the version of the third party library used to handle the work with the SQLite DB in order to fix exposure to [CVE-2018-20505](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20505).
143-
144-
**1.0.6**
145-
146-
* Upgrade the version of the third party library used to handle the work with the SQLite DB in order to fix exposure to [CVE-2018-20346](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20346).
147-
148-
**1.0.5**
149-
150-
* Add new stats and update display:
151-
* Add the size of the biggest request sent.
152-
* Add the maximal number of requests sent by second.
153-
* Review stats display to dynamically adapt data amount in KB, MB or GB.
154-
155-
**1.0.4**
156-
157-
* Fix the bug described in issue [#5](/../../issues/5).
158-
* Add statistics about the DB content.
159-
* Allow the user to select the DB location and file name.
160-
161-
**1.0.3**
162-
163-
* Fix the bug described in issue [#4](/../../issues/4).
164-
165-
**1.0.2**
166-
167-
* Add option to exclude image from logging.
168-
* Prepare and finalize publishing of the extension to the BAppStore.
169-
170-
**1.0.1**
171-
172-
* Add the option to restrict the logging to the requests that are included into the defined target scope.
173-
174-
**1.0.0**
175-
176-
* Creation of the extension and initial release.
177-
178-
# SQLite client
179-
180-
Cross-platform: https://github.com/sqlitebrowser/sqlitebrowser
1+
> [!IMPORTANT]
2+
> The ownership was transfered to the company **Redguard** and the project is now hosted [here](https://github.com/Redguard/log-requests-to-sqlite).

0 commit comments

Comments
 (0)