Git Product home page Git Product logo

socket-sleuth's Introduction

https://snyk.io/test/github/snyk/socketsleuth/badge.svg

SocketSleuth: Burp Suite Extension for websocket testing

Overview

SocketSleuth aims to enhance Burp Suite's websocket testing capabilities and make testing websocket based applications easier. This extension is currently in beta release but contains some powerful features such as a new websocket focused history tab, match and replace rules for websockets, an intruder like utility, and a message autorepeater for authorization testing.

Build Instructions

Requirements

  • Burp Suite Professional / Community version 2022.9.5 or later
  • Maven

Steps

  1. Clone the repository
    git clone https://github.com/snyk/socketsleuth.git
    
  2. Navigate to the project directory
    cd socketsleuth
    
  3. Build the project using Maven
    mvn clean package
    
  4. Load the generated JAR file (SocketSleuth/target/SocketSleuth-[VERSION]-jar-with-dependencies.jar) into Burp Suite via Extensions -> Installed -> Add.

Features

The current features for the beta version are minimal, but should be quite powerful.

  • Websocket history
  • Websocket intruder
    • JSONRPC method discovery
    • Sniper
      • Simple List
      • Numeric
  • Websocket AutoRepater
    • Similar to AutoRepeater and Autoize but for websocket. Allows the contents of a source websocket to automatically be replayed in a target socket. When setup with two unique sessions, this allows for automated AuthZ testing.
  • Interception Rules
  • Match & Replace Rules
    • Basic string
    • Hex encoded string (useful when working with non string payloads)
    • Regex

Issues

For updated list of bugs and issues see the project issues. However at launch for beta release, there is some known problems.

  • Currently only supports text based websockets. Binary based messages need some refactoring and we intend to address this soon.
  • Regular Expression Match & Replace rules can be flakey and doesn't work all the time. Will be fixed soon.
  • Table sorting does not work.

Contributing

Contributions are welcome. See CONTRIBUTING.md for details.

License

SocketSleuth is under the Apache 2.0 License. See LICENSE for more information.

socket-sleuth's People

Contributors

mowzk avatar alpgul avatar dragos-cojocari avatar joe-bollen-snyk avatar portswiggersupport avatar whifyh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.