Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Uniform decompression-budget and corrupt-input handling across all permessage-* extensions

Cerrado
  • ¿Algo no está bien?
#1,986 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Ya se ha fusionado un pull request relacionado.

  • #1987 de @oberstet — fusionado

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
backend, networking

Línea de trabajo

Start with websocket/protocol.py and onFrameData(), then inspect the four decompress_message_data() implementations and their compression dependency versions. Add unit coverage for the listed budget and corrupt-input cases, plus protocol tests on Twisted and asyncio; run them on CPython and PyPy. Done means all backends enforce the output budget and map decode errors to PayloadCorruptError, with clean connection failures.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

Autobahn supports four WebSocket per-message compression extensions: permessage-deflate (RFC 7692), and the non-standard permessage-bzip2, permessage-brotli and permessage-snappy. All four implement the same internal method:

def decompress_message_data(self, data, max_output_len=None): ...

The receive path (websocket/protocol.py, onFrameData()) passes in the remaining maxMessagePayloadSize budget as max_output_len. The four backends do not handle that budget, or a decode error, the same way. This issue makes their behaviour uniform.

Current behaviour

Extension Budget passed to the library? Over budget Budget already 0 Corrupt input
deflate yes (max_length) PayloadExceededError returns 1 octet, no exception (the protocol's post-inflation check then rejects it) zlib.error
bzip2 yes (max_length) PayloadExceededError PayloadExceededError OSError
brotli no: decompresses the whole frame, then checks PayloadExceededError, after decompression PayloadExceededError brotli.error / brotlicffi.error
snappy no: decompresses the whole frame, then checks PayloadExceededError, after decompression PayloadExceededError no exception: the input is buffered and an empty message is returned

Decode errors are not caught in onFrameData(), so how a connection fails on a corrupt compressed frame depends on the backend and on the networking framework (Twisted or asyncio).

Target behaviour

For every extension, on CPython and PyPy, and on Twisted and asyncio:

  1. Budget: no backend produces more than max_output_len + 1 octets in one call. "Over budget" and "budget already 0" both raise PayloadExceededError, which is raised before the backend decompresses past the budget, not after.
    • brotli: use Decompressor.process(data, output_buffer_limit=...), and raise the floor of the compress extra to brotli>=1.2.0 (CPython) / brotlicffi>=1.2.0 (PyPy), the first versions that have this argument.
    • snappy: python-snappy's StreamDecompressor.decompress() has no output limit, so feed the input one framing chunk at a time (at most 64 KiB of output each) and stop at the budget.
    • deflate: raise PayloadExceededError once the budget is used up, instead of capping the call at 1 octet.
  2. Corrupt input: each library's decode error becomes a new autobahn.exception.PayloadCorruptError. The protocol fails the connection the same way for every backend, on Twisted and asyncio. The snappy backend rejects malformed input instead of buffering it.
  3. Remove or correct the code comments claiming that per-frame decompression is "bounded on the wire by maxFramePayloadSize".

Tests

  • Unit tests for every cell of the table above, on all four backends: over budget in one frame, over budget across two frames, exactly at budget, one octet over, budget already 0, and corrupt input. They must check both the exception type and that the output never exceeds the budget plus one octet.
  • Protocol-level tests on Twisted and asyncio: a corrupt compressed frame, and an over-budget compressed message, each fail the connection cleanly with the expected close code.
  • Run on CPython and PyPy.

Target

autobahn-python 26.10.1

Lenguaje dominante
Python
Estrellas
2.5k
Forks
767
Merge medio
1 d 1 h
PR fusionados (30 d)
23

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de crossbario/autobahn-python

Todos los issues de crossbario/autobahn-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.