Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
|
search
Plugin Hub
github-edit-pageEdit this page
report-issueReport an issue
header icon

WebSocket Size Limit

By Kong Inc.

Looking for the plugin's configuration parameters? You can find them in the WebSocket Size Limit configuration reference doc.

Allows operators to specify a maximum size for incoming WebSocket messages.

Separate limits can be applied to clients and upstreams.

When an incoming message exceeds the limit:

  1. A close frame with status code 1009 is sent to the sender
  2. A close frame with status code 1001 is sent to the peer
  3. Both sides of the connection are closed

Usage

Limits can be applied to client messages, upstream messages, or both.

Limit client messages to 4 KiB

Use a request like this:

curl -i -X POST http://HOSTNAME:8001/services/SERVICE/plugins \
  --data "name=websocket-size-limit" \
  --data "config.client_max_payload=4096"

Add the following entry to the plugins: section in the declarative configuration file:

plugins:
- name: websocket-size-limit
  service: SERVICE
  config:
    client_max_payload: 4096

Limit upstream messages to 1 MiB

Use a request like this:

curl -i -X POST http://HOSTNAME:8001/services/SERVICE/plugins \
  --data "name=websocket-size-limit" \
  --data "config.upstream_max_payload=1048576"

Add the following entry to the plugins: section in the declarative configuration file:

plugins:
- name: websocket-size-limit
  service: SERVICE
  config:
    upstream_max_payload: 1048576

Limit both client and upstream messages

Use a request like this:

curl -i -X POST http://HOSTNAME:8001/services/SERVICE/plugins \
  --data "name=websocket-size-limit" \
  --data "config.client_max_payload=4096" \
  --data "config.upstream_max_payload=1048576"

Add the following entry to the plugins: section in the declarative configuration file:

plugins:
- name: websocket-size-limit
  service: SERVICE
  config:
    client_max_payload: 4096
    upstream_max_payload: 1048576

Raising the default limits

Kong Gateway applies the following default limits to incoming messages for all WebSocket services:

Sender Default Limit
client 1048576 (1MiB)
upstream 16777216 (16MiB)

This plugin can be used to increase the limit beyond the default. This example increases the client limit to 2 MiB, up from the default of 1 MiB:

Use a request like this:

curl -i -X POST http://HOSTNAME:8001/services/SERVICE/plugins \
  --data "name=websocket-size-limit" \
  --data "config.client_max_payload=2097152"

Add the following entry to the plugins: section in the declarative configuration file:

plugins:
- name: websocket-size-limit
  service: SERVICE
  config:
    client_max_payload: 2097152

The default client limit is smaller than the default upstream limit because proxying client-originated messages is much more computationally expensive than upstream messages. This is due to the client-to-server masking required by the WebSocket specification, so in general it is wise to maintain a lower limit for client messages.

How the plugin works

How limits are applied

Note: Limits are evaluated based on the message payload length and not the entire length of the WebSocket frame (header and payload).

Standalone data frames (text and binary)

For limits of 125 bytes or less, the message length is checked after reading and decoding the entire message into memory.

For limits of 125 bytes or more, the message length is checked from the frame header before the entire message is read from the socket buffer, allowing Kong Gateway to close the connection without having to read, and potentially unmask, the entire message into memory.

Continuation data frames

Kong Gateway aggregates continuation frames, buffering them in-memory before forwarding them to their final destination. In addition to evaluating limits on an individual frame basis, like singular text and binary frames, Kong Gateway also tracks the running size of all the frames that are buffered for aggregation. If an incoming continuation frame causes the total buffer size to exceed the limit, the message is rejected, and the connection is closed.

For example, assuming client_max_payload = 1024:

 .------.                                       .----.
 |Client|                                       |Kong|
 '------'                                       '----'
    |                                             |
    |     text(fin=false, len=500, msg=[...])     |
    |>------------------------------------------->| # buffer += 500 (500)
    |                                             |
    |                                             |
    |   continue(fin=false, len=500, msg=[...])   |
    |>------------------------------------------->| # buffer += 500 (1000)
    |                                             |
    |                                             |
    |   continue(fin=false, len=500, msg=[...])   |
    |>------------------------------------------->| # buffer += 500 (1500)
    |                                             | # buffer >= 1024 (limit exceeded!)
    |                                             |
    | close(status=1009, msg="Payload Too Large") |
    |<-------------------------------------------<|
 .------.                                       .----.
 |Client|                                       |Kong|
 '------'                                       '----'

For control frames

All control frames (ping, pong, and close) have a max payload size of 125 bytes, as per the WebSocket specification. Kong Gateway does not enforce any limits on control frames, even when they’re set to a value lower than 125.

See also