Module websocket

Module websocket 

Source
Expand description

WebSocket frame handling for frame-level inspection.

This module provides WebSocket frame parsing and encoding per RFC 6455, enabling agents to inspect individual WebSocket frames for security purposes.

§Architecture

After a WebSocket upgrade (101 response), Sentinel can optionally intercept the bidirectional byte stream and parse it into frames for inspection:

Client <-> [Frame Parser] <-> Sentinel <-> [Frame Parser] <-> Upstream
                |                                |
                v                                v
         WebSocketFrame                   WebSocketFrame
                         \               /
                          v             v
                       Agent Inspector
                    (Allow/Drop/Close)

§Features

  • RFC 6455 compliant frame parsing
  • Masking/unmasking support (client frames are masked)
  • Configurable maximum frame size
  • Frame-level agent inspection

Re-exports§

pub use codec::Opcode;
pub use codec::WebSocketCodec;
pub use codec::WebSocketFrame;
pub use inspector::InspectionResult;
pub use inspector::WebSocketInspector;
pub use proxy::CloseReason;
pub use proxy::FrameInspector;
pub use proxy::ProcessResult;
pub use proxy::WebSocketHandler;

Modules§

codec
WebSocket frame codec implementing RFC 6455.
inspector
WebSocket frame inspector for agent integration.
proxy
WebSocket proxy handler for frame-level inspection.