Files
unshackle/unshackle/core/api/compression.py
T
imSp4rky afaff8e070 feat(api): tag each error with a ref and count errors by service
Every structured error carries a short ref, appended to its message and logged with the request; /api/dashboard/status gains per-service error counts. Gzip now compresses in place.
2026-10-21 14:39:37 -06:00

55 lines
1.8 KiB
Python

"""aiohttp middleware for gzip transport compression."""
from __future__ import annotations
import gzip
import zlib
from aiohttp import web
# Cap the inflated size of a peer-supplied compressed blob (cookies, session cache,
# serialized manifests) so a tiny payload cannot expand without bound (zip-bomb DoS).
MAX_INFLATE_BYTES = 64 * 1024 * 1024 # 64 MiB
def safe_inflate(data: bytes, max_size: int = MAX_INFLATE_BYTES) -> bytes:
"""zlib-decompress *data*, raising ValueError if the result would exceed *max_size*."""
decompressor = zlib.decompressobj()
out = decompressor.decompress(data, max_size + 1)
if len(out) > max_size or decompressor.unconsumed_tail:
raise ValueError("compressed payload expands beyond allowed size")
out += decompressor.flush()
if len(out) > max_size:
raise ValueError("compressed payload expands beyond allowed size")
return out
@web.middleware
async def compression_middleware(request: web.Request, handler) -> web.StreamResponse:
"""Compress JSON responses with gzip when the client supports it."""
response = await handler(request)
if not isinstance(response, web.Response):
return response
accept_encoding = request.headers.get("Accept-Encoding", "")
if "gzip" not in accept_encoding:
return response
if response.content_type and "json" not in response.content_type:
return response
body = response.body
if not isinstance(body, (bytes, bytearray)) or len(body) < 256:
return response
from unshackle.core.config import config
level = config.serve.get("compression_level", 1)
if not level:
return response
response.body = gzip.compress(body, compresslevel=level)
response.headers["Content-Encoding"] = "gzip"
return response