You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# swurg
1
+
# openapi-parser
2
2
3
-
[](https://github.com/aress31/swurg/actions/workflows/gradle-build.yml)
3
+
[](https://github.com/aress31/openapi-parser/actions/workflows/gradle-build.yml)
> This extension has been updated to use the latest [Burp Montoya Java API](https://portswigger.github.io/burp-extensions-montoya-api/javadoc/burp/api/montoya/package-summary.html). The extension has undergone a complete overhaul to improve both its `UI`/`UX` and performance. These changes ensure that the extension is modern and optimised for use.
11
11
12
-
## Swurg is a `Burp Suite` extension designed for `OpenAPI`-based `API` testing
12
+
## openapi-parser is a `Burp Suite` extension designed for `OpenAPI`-based `API` testing
13
13
14
14
> The `OpenAPI` Specification (`OAS`) defines a standard, programming language-agnostic interface description for `REST``APIs`, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via `OpenAPI`, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the `OpenAPI` Specification removes guesswork in calling a service.
15
15
>
@@ -19,7 +19,7 @@
19
19
20
20
Performing security assessment of `OpenAPI`-based `APIs` can be a tedious task due to `Burp Suite` (industry standard) lacking native `OpenAPI` parsing capabilities. A solution to this situation, is to use third-party tools (e.g. `SOAP-UI`) or to implement custom scripts (often on a per engagement basis) to handle the parsing of `OpenAPI` documents and integrate/chain the results to `Burp Suite` to use its first class scanning capabilities.
21
21
22
-
Swurg is an `OpenAPI` parser that aims to streamline this entire process by allowing security professionals to use `Burp Suite` as a standalone tool for security assessment of `OpenAPI`-based `APIs`.
22
+
openapi-parser is an `OpenAPI` parser that aims to streamline this entire process by allowing security professionals to use `Burp Suite` as a standalone tool for security assessment of `OpenAPI`-based `APIs`.
23
23
24
24
## Features
25
25
@@ -45,7 +45,7 @@ Swurg is an `OpenAPI` parser that aims to streamline this entire process by allo
45
45
46
46
### 2. Build tool
47
47
48
-
- Gradle: `Version 8.5` or later (recommended). The [build.gradle](https://github.com/aress31/swurg/blob/main/lib/build.gradle) file is provided in the project repository.
48
+
- Gradle: `Version 8.5` or later (recommended). The [build.gradle](https://github.com/aress31/openapi-parser/blob/main/lib/build.gradle) file is provided in the project repository.
49
49
50
50
### 3. Environment variables
51
51
@@ -59,11 +59,11 @@ Please ensure that all system requirements, including a compatible version of `B
59
59
60
60
1. Ensure you have [Gradle](https://gradle.org/) installed and configured.
@@ -74,7 +74,7 @@ Please ensure that all system requirements, including a compatible version of `B
74
74
75
75
### 2. Loading the Extension Into `Burp Suite`
76
76
77
-
To install `swurg` in `Burp Suite`, first go to the `Extensions` tab and click on the `Add` button. Then, select the `swurg-all` jar file located in the `.\build\libs` folder to load the extension.
77
+
To install `openapi-parser` in `Burp Suite`, first go to the `Extensions` tab and click on the `Add` button. Then, select the `openapi-parser-all` jar file located in the `.\build\libs` folder to load the extension.
78
78
79
79
Alternatively, you can skip the [Compilation](#1-compilation) step entirely and download the extension directly from the [BApp Store](https://portswigger.net/bappstore/6bf7574b632847faaaa4eb5e42f1757c).
80
80
@@ -108,13 +108,13 @@ If this extension has saved you time and hassle during a security assessment, co
108
108
109
109
Did you find a bug? Well, don't just let it crawl around! Let's squash it together like a couple of bug whisperers! 🐛💪
110
110
111
-
Please report any issues on the [GitHub issues tracker](https://github.com/aress31/swurg/issues). Together, we'll make this extension as reliable as a cockroach surviving a nuclear apocalypse! 🚀
111
+
Please report any issues on the [GitHub issues tracker](https://github.com/aress31/openapi-parser/issues). Together, we'll make this extension as reliable as a cockroach surviving a nuclear apocalypse! 🚀
112
112
113
113
## Contributing
114
114
115
115
Looking to make a splash with your mad coding skills? 💻
116
116
117
-
Awesome! Contributions are welcome and greatly appreciated. Please submit all PRs on the [GitHub pull requests tracker](https://github.com/aress31/swurg/pulls). Together we can make this extension even more amazing! 🚀
117
+
Awesome! Contributions are welcome and greatly appreciated. Please submit all PRs on the [GitHub pull requests tracker](https://github.com/aress31/openapi-parser/pulls). Together we can make this extension even more amazing! 🚀
0 commit comments