diff options
| author | Dennis Fink | 2026-10-30 20:41:25 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-10-30 20:41:25 +0100 |
| commit | 53370723df05193938ce3c2d55a8e12f2a87b17b (patch) | |
| tree | e67ec12d3635d141bdc670fbfc5fa6bfb87cd69c /tests/tasks/test_json_serializer.py | |
| parent | 13a9d9ddce09230017699bc34ac3bf08ed2f84ed (diff) | |
| download | webmentions-ssg-53370723df05193938ce3c2d55a8e12f2a87b17b.tar.gz webmentions-ssg-53370723df05193938ce3c2d55a8e12f2a87b17b.zip | |
fix(core): replace Huey pickle serialization with JSON
Prevent broker-controlled task and result payloads from deserializing
arbitrary Python objects by using a restricted JSON serializer with an
explicit type allowlist.
Fail closed on serializer overrides and document broker isolation and
migration requirements for existing pickle-backed deployments.
Diffstat (limited to 'tests/tasks/test_json_serializer.py')
| -rw-r--r-- | tests/tasks/test_json_serializer.py | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/tests/tasks/test_json_serializer.py b/tests/tasks/test_json_serializer.py new file mode 100644 index 0000000..108e8a6 --- /dev/null +++ b/tests/tasks/test_json_serializer.py @@ -0,0 +1,99 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +"""Ensure broker-controlled data is never deserialized using pickle.""" + +import pickle +import uuid +from datetime import UTC, datetime, timedelta + +import pytest +from flask import Flask +from huey.utils import Error, SKIPPED + +from webmentions_ssg.tasks.extension import Huey +from webmentions_ssg.tasks.json_serializer import JSONSerializer + + +def test_json_is_default_even_for_production_style_broker(app: Flask) -> None: + app.config["HUEY"] = {"immediate": False} + huey = Huey(app) + + assert isinstance(huey.huey.serializer, JSONSerializer) + assert huey.huey.serializer.serialize("hello") == b'"hello"' + + +def test_uuid_and_retry_message_survive_enqueue_dequeue(app: Flask) -> None: + app.config["HUEY"] = {"immediate": False} + huey = Huey(app) + identifier = uuid.uuid4() + + @huey.task(retries=2, retry_delay=50) + def check(webmention_uuid: uuid.UUID) -> str: + return str(webmention_uuid) + + task = check.s(identifier) + task.eta = datetime.now(UTC) + timedelta(minutes=5) + raw = huey.huey.serialize_task(task) + assert raw.startswith(b'{"type":"message"') + assert b"pickle" not in raw + + restored = huey.huey.deserialize_task(raw) + assert restored.args == (identifier,) + assert restored.eta == task.eta + assert restored.retries == 2 + assert restored.retry_delay == 50 + + huey.huey.enqueue(task) + from_queue = huey.huey.dequeue() + assert from_queue.args == (identifier,) + + +def test_result_and_error_data_roundtrip() -> None: + serializer = JSONSerializer() + identifier = uuid.uuid4() + payload = { + "ids": [identifier], + "nested": ("str", None, 3), + "error": Error({"error": "failed", "retries": 0}), + "skipped": SKIPPED, + "tag_collision": {"type": "uuid", "value": "not a UUID"}, + } + assert serializer.deserialize(serializer.serialize(payload)) == payload + + +def test_rejects_pickle_payload() -> None: + serializer = JSONSerializer() + with pytest.raises((ValueError, UnicodeDecodeError)): + serializer.deserialize(pickle.dumps({"untrusted": True})) + + +def test_rejects_unknown_and_malformed_types() -> None: + serializer = JSONSerializer() + with pytest.raises(ValueError, match="Unsupported Huey JSON type"): + serializer.deserialize(b'{"type":"arbitrary.class","value":{}}') + with pytest.raises(ValueError, match="Invalid Huey JSON data"): + serializer.deserialize(b'{"type":"uuid","value":"x","extra":1}') + with pytest.raises(ValueError, match="Invalid Huey JSON message field count"): + serializer.deserialize(b'{"type":"message","value":[]}') + with pytest.raises(ValueError, match="Invalid non-finite JSON value"): + serializer.deserialize(b"NaN") + with pytest.raises(TypeError, match="Unsupported Huey JSON value"): + serializer.serialize(object()) + + +def test_refuses_unsafe_serializer_configuration(app: Flask) -> None: + app.config["HUEY"] = {"serializer": None} + with pytest.raises(RuntimeError, match="JSON is required"): + Huey(app) + + +def test_compression_with_json(app: Flask) -> None: + app.config["HUEY"] = {"compression": True, "immediate": False} + huey = Huey(app) + payload = {"id": uuid.uuid4()} + + raw = huey.huey.serializer.serialize(payload) + assert raw.startswith(b"\x1f\x8b") + assert huey.huey.serializer.deserialize(raw) == payload |
