Package burp.api.montoya.proxy

Interface ProxyWebSocketHandler

  • public interface ProxyWebSocketHandler
    This interface allows an extension to be notified when messages are sent or received via the proxy WebSocket, or it has been closed.

    • Method Detail

      • handleTextMessageReceived

        ProxyWebSocketInitialInterceptTextMessage handleTextMessageReceived​(java.lang.String textMessage,
                                                                    Direction direction)
        Invoked when a text message is received from either the client or server. This gives the extension the ability to modify the message before it is processed by Burp.
        Parameters:
        textMessage - Intercepted text-based WebSocket message.
        direction - The direction of the message.
        Returns:
        The message.

      • handleTextMessageToBeIssued

        ProxyWebSocketFinalInterceptTextMessage handleTextMessageToBeIssued​(java.lang.String textMessage,
                                                                    Direction direction)
        Invoked when a text message is about to be sent to either the client or server. This gives the extension the ability to modify the message before it is issued.
        Parameters:
        textMessage - Intercepted text-based WebSocket message.
        direction - The direction of the message.
        Returns:
        The message.

      • handleBinaryMessageReceived

        ProxyWebSocketInitialInterceptBinaryMessage handleBinaryMessageReceived​(ByteArray binaryMessage,
                                                                        Direction direction)
        Invoked when a binary message is received from either the client or server. This gives the extension the ability to modify the message before it is processed by Burp.
        Parameters:
        binaryMessage - Intercepted binary WebSocket message.
        direction - The direction of the message.
        Returns:
        The message.

      • handleBinaryMessageToBeIssued

        ProxyWebSocketFinalInterceptBinaryMessage handleBinaryMessageToBeIssued​(ByteArray binaryMessage,
                                                                        Direction direction)
        Invoked when a binary message is about to be sent to either the client or server. This gives the extension the ability to modify the message before it is issued.
        Parameters:
        binaryMessage - Intercepted binary WebSocket message.
        direction - The direction of the message.
        Returns:
        The message.

      • onClose

        default void onClose()
        Invoked when the WebSocket is closed.