stuartw1 / swurg

Parse OpenAPI documents into Burp Suite for automating OpenAPI-based APIs security assessments (approved by PortSwigger for inclusion in their official BApp Store).

Swurg is a Burp Suite extension designed for OpenAPI testing.

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.

Use cases for machine-readable API definition documents include, but are not limited to: interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an API's services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.

- OpenAPI Initiative

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.

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.

Supported Features

• Parse OpenAPI documents, formerly known as the Swagger specification, fully compliant with OpenAPI 2.0/3.0 Specifications (OAS). Supports both JSON and YAML formats.
• OpenAPI documents can be parsed either from a supplied file or URL. The extension can fetch OpenAPI documents directly from a URL using the Send to Swagger Parser feature under the Target -> Site map context menu.
• Requests can be sent to the Comparer, Intruder, Repeater, Scanner and Site map Burp tools.

Installation

Compilation

Windows & Linux

1. Install gradle (https://gradle.org/)
2. Download the repository.

$ git clone https://github.com/AresS31/swurg
$ cd .\swurg\

3. Create the swurg jarfile:

$ gradle fatJar

Burp Suite settings

In Burp Suite, under the Extender/Options tab, click on the Add button and load the swurg-all jarfile.

Possible Improvements

• Beautify the graphical user interface.
• Enable cells editing to change API calls directly from the GUI.
• Further optimise the source code.
• Implement support for authenticated testing (via user-supplied API-keys).
• Improve the Param column by adding the type of parameters (e.g. inquery, inbody, etc.).
• Increase the extension verbosity (via the bottom panel).

Dependencies

Third-party libraries

Swagger Parser:

The Swagger Parser library is required and automatically imported in this project.

Project information

In July 2016, after posting a request for improvement on the PortSwigger support forum, I decided to take the initiative and to implement a solution myself.

The extension is still in development, feedback, comments and contributions are therefore much appreciated.

One-time donation

• Donate via Bitcoin : 15aFaQaW9cxa4tRocax349JJ7RKyj7YV1p
• Donate via Bitcoin Cash : qqez5ed5wjpwq9znyuhd2hdg86nquqpjcgkm3t8mg3
• Donate via Ether : 0x70bC178EC44500C17B554E62BC31EA2B6251f64B

License

Copyright (C) 2016 - 2018 Alexandre Teyar

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.