Package burp.api.montoya.proxy.websocket

Interface ProxyMessageHandler

public interface ProxyMessageHandler

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

Method Summary

Modifier and Type	Method	Description
BinaryMessageReceivedAction	handleBinaryMessageReceived(InterceptedBinaryMessage interceptedBinaryMessage)	Invoked when a binary message is received from either the client or server.
BinaryMessageToBeSentAction	handleBinaryMessageToBeSent(InterceptedBinaryMessage interceptedBinaryMessage)	Invoked when a binary message is about to be sent to either the client or server.
TextMessageReceivedAction	handleTextMessageReceived(InterceptedTextMessage interceptedTextMessage)	Invoked when a text message is received from either the client or server.
TextMessageToBeSentAction	handleTextMessageToBeSent(InterceptedTextMessage interceptedTextMessage)	Invoked when a text message is about to be sent to either the client or server.
default void	onClose()	Invoked when the WebSocket is closed.

Method Details

handleTextMessageReceived

TextMessageReceivedAction handleTextMessageReceived(InterceptedTextMessage interceptedTextMessage)

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:

interceptedTextMessage - Intercepted text WebSocket message.

Returns:

The TextMessageReceivedAction containing the required action and text message to be passed through.

handleTextMessageToBeSent

TextMessageToBeSentAction handleTextMessageToBeSent(InterceptedTextMessage interceptedTextMessage)

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 sent.

Parameters:

interceptedTextMessage - Intercepted text WebSocket message.

Returns:

The TextMessageReceivedAction containing the required action and text message to be passed through.

handleBinaryMessageReceived

BinaryMessageReceivedAction handleBinaryMessageReceived(InterceptedBinaryMessage interceptedBinaryMessage)

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:

interceptedBinaryMessage - Intercepted binary WebSocket message.

Returns:

The BinaryMessageReceivedAction containing the required action and binary message to be passed through.

handleBinaryMessageToBeSent

BinaryMessageToBeSentAction handleBinaryMessageToBeSent(InterceptedBinaryMessage interceptedBinaryMessage)

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 sent.

Parameters:

interceptedBinaryMessage - Intercepted binary WebSocket message.

Returns:

The BinaryMessageReceivedAction containing the required action and binary message to be passed through.

onClose

default void onClose()

Invoked when the WebSocket is closed.