BishopFox / sj

A tool for auditing endpoints defined in exposed (Swagger/OpenAPI) definition files.

sj (Swagger Jacker)

sj is a command line tool designed to assist with auditing of exposed Swagger/OpenAPI definition files by checking the associated API endpoints for weak authentication. It also provides command templates for manual vulnerability testing.

It does this by parsing the definition file for paths, parameters, and accepted methods before using the results with one of three commands:

• automate - Crafts a series of requests and analyzes the status code of the response.
• prepare - Generates a list of commands to use for manual testing.
• endpoints - Generates a list of raw API routes. Path values will not be replaced with test data.

Build

To compile from source, ensure you have Go version >= 1.20 installed and run go build from within the repository:

$ git clone https://github.com/BishopFox/sj.git
$ cd sj/
$ go build .

Install

To install the latest version of the tool, run:

$ go install github.com/BishopFox/sj@latest

Usage

Use the automate command to send a series of requests to each defined endpoint and analyze the status code of each response.

Use the prepare command to prepare a list of curl commands for manual testing. You will likely have to modify these slightly.

Use the endpoints command to generate a list of raw endpoints from the provided definition file.

Help

A full list of commands can be found by using the --help flag: