Skip to content

Commit c37e9c9

Browse files
authored
Merge pull request #104 from aress31/main
Update README.md
2 parents ea79986 + 69e0539 commit c37e9c9

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# swurg
1+
# openapi-parser
22

3-
[![Java CI with Gradle](https://github.com/aress31/swurg/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/aress31/swurg/actions/workflows/gradle-build.yml)
3+
[![Java CI with Gradle](https://github.com/aress31/openapi-parser/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/aress31/openapi-parser/actions/workflows/gradle-build.yml)
44
<a href="https://portswigger.net/bappstore/6bf7574b632847faaaa4eb5e42f1757c"><img alt="bapp store" src="https://img.shields.io/badge/BApp-Published-orange.svg"></a>
55
<a href="https://www.java.com"><img alt="lang" src="https://img.shields.io/badge/Lang-Java-blue.svg"></a>
66
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="license" src="https://img.shields.io/badge/License-Apache%202.0-red.svg"></a>
@@ -9,7 +9,7 @@
99
> [!UPDATE]
1010
> 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.
1111
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
1313

1414
> 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.
1515
>
@@ -19,7 +19,7 @@
1919
2020
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.
2121

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`.
2323

2424
## Features
2525

@@ -45,7 +45,7 @@ Swurg is an `OpenAPI` parser that aims to streamline this entire process by allo
4545
4646
### 2. Build tool
4747

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.
4949

5050
### 3. Environment variables
5151

@@ -59,11 +59,11 @@ Please ensure that all system requirements, including a compatible version of `B
5959

6060
1. Ensure you have [Gradle](https://gradle.org/) installed and configured.
6161

62-
2. Download the `swurg` repository:
62+
2. Download the `openapi-parser` repository:
6363

6464
```bash
65-
git clone https://github.com/aress31/swurg
66-
cd .\swurg\
65+
git clone https://github.com/aress31/openapi-parser
66+
cd .\openapi-parser\
6767
```
6868

6969
3. Build the standalone `jar`:
@@ -74,7 +74,7 @@ Please ensure that all system requirements, including a compatible version of `B
7474

7575
### 2. Loading the Extension Into `Burp Suite`
7676

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.
7878

7979
Alternatively, you can skip the [Compilation](#1-compilation) step entirely and download the extension directly from the [BApp Store](https://portswigger.net/bappstore/6bf7574b632847faaaa4eb5e42f1757c).
8080

@@ -108,13 +108,13 @@ If this extension has saved you time and hassle during a security assessment, co
108108

109109
Did you find a bug? Well, don't just let it crawl around! Let's squash it together like a couple of bug whisperers! 🐛💪
110110

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! 🚀
112112

113113
## Contributing
114114

115115
Looking to make a splash with your mad coding skills? 💻
116116

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! 🚀
118118

119119
## License
120120

0 commit comments

Comments
 (0)