Home

Awesome

WSSiP: A WebSocket Manipulation Proxy

Travis-CI Appveyor npm version npm github github release dependency outdated

Short for "WebSocket/Socket.io Proxy", this tool, written in Node.js, provides a user interface to capture, intercept, send custom messages and view all WebSocket and Socket.IO communications between the client and server.

Upstream proxy support also means you can forward HTTP/HTTPS traffic to an intercepting proxy of your choice (e.g. Burp Suite or Pappy Proxy) but view WebSocket traffic in WSSiP. More information can be found on the blog post.

There is an outward bridge via HTTP to write a fuzzer in any language you choose to debug and fuzz for security vulnerabilities. See Fuzzing for more details.

Written and maintained by Samantha Chalker (@thekettu). Icon for WSSiP release provided by @dragonfoxing.

Installation

From Packaged Application

See Releases.

From npx via npm (for CLI commands)

Run the following in your command line:

npx wssip

From Source

Using a command line:

# Clone repository locally
git clone https://github.com/nccgroup/wssip

# Change to the directory
cd wssip

# If you are developing for WSSiP:
# npm i

# If not... (as to minimize disk space):
npm i electron
npm i --production

# Yarn version:
# yarn add electron
# yarn install --production

# Start application:
npm start
# or yarn:
# yarn start

Usage

  1. Open the WSSiP application.
  2. WSSiP will start listening automatically. This will default to localhost on port 8080.
  3. Optionally, use Tools > Use Upstream Proxy to use another intercepting proxy to view web traffic.
  4. Configure the browser to point to http://localhost:8080/ as the HTTP Proxy.
  5. Navigate to a page using WebSockets. A good example is the WS Echo Demonstration.
  6. ???
  7. Potato.

Fuzzing

WSSiP provides an HTTP bridge via the man-in-the-middle proxy for custom applications to help fuzz a connection. These are accessed over the proxy server.

A few of the simple CA certificate downloads are:

Get WebSocket Connection Info

Returns whether the WebSocket id is connected to a web server, and if so, return information.

Send WebSocket Data

Send WebSocket data.

Development

Pull requests are welcomed and encouraged. WSSiP supports the debug npm package, and setting the environment variable DEBUG=wssip:* will output debug information to console.

There are two commands depending on how you want to compile the Webpack bundle: for development, that is npm run compile:dev and for production is npm run compile. React will also log errors depending on whether development or production is specified.

Currently working on:

For information on using the mitmengine class, see: npm, yarn, or mitmengine/README.md