aboutsummaryrefslogtreecommitdiff
path: root/tests/test_configuration_hardening.py
blob: 753f4ca137ef0be90e9e59887b7acc0d337bdee4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

"""Regression tests for configuration loading and endpoint hostname policy."""

from pathlib import Path

import pytest
from wtforms import Field, ValidationError
from wtforms.form import BaseForm

from webmentions_ssg import create_app
from webmentions_ssg.config import (
    DefaultConfig,
    DevelopmentConfig,
    ProductionConfig,
    TestingConfig,
)
from webmentions_ssg.forms.validators import AllowedHostname


def test_missing_production_configuration_is_fatal(tmp_path: Path) -> None:
    class MissingProductionConfig(ProductionConfig):
        CONFIG_FILE = str(tmp_path / "missing.cfg")

    with pytest.raises(FileNotFoundError, match="missing.cfg"):
        create_app(MissingProductionConfig)


def test_missing_development_configuration_is_optional(tmp_path: Path) -> None:
    class LocalDevelopmentConfig(DevelopmentConfig):
        CONFIG_FILE = str(tmp_path / "missing.cfg")
        LOG_FILE = str(tmp_path / "development.log")

    app = create_app(LocalDevelopmentConfig)
    assert app.config["ALLOWED_HOSTNAMES"] == set()


def test_endpoint_limits_are_inherited_from_defaults() -> None:
    for config in (DefaultConfig, DevelopmentConfig, ProductionConfig, TestingConfig):
        assert config.MAX_REDIRECTS == 20
        assert config.MAX_SOURCE_BYTES == 1_000_000
        assert config.REQUEST_TIMEOUT == 5.0

    assert DefaultConfig.ALLOWED_HOSTNAMES == set()


def test_allowed_hostnames_are_normalized_at_startup(tmp_path: Path) -> None:
    class MixedCaseConfig(TestingConfig):
        LOG_FILE = str(tmp_path / "test.log")
        ALLOWED_HOSTNAMES = [" DennisFink.Me ", "EXAMPLE.COM", "dennisfink.me"]

    app = create_app(MixedCaseConfig)
    assert app.config["ALLOWED_HOSTNAMES"] == {"dennisfink.me", "example.com"}
    assert isinstance(app.config["ALLOWED_HOSTNAMES"], set)

    # The form validator must compare complete hostnames, never substrings.
    target = Field()
    validator = AllowedHostname(message="Hostname not allowed")
    form = BaseForm({})
    with app.app_context():
        for url in ("https://dennisfink.me/post", "https://EXAMPLE.com/post"):
            target.data = url
            validator(form, target)

        for url in ("https://fink/post", "https://evil-dennisfink.me/post"):
            target.data = url
            with pytest.raises(ValidationError, match="Hostname not allowed"):
                validator(form, target)


@pytest.mark.parametrize(
    "hostnames,expected_exception",
    [
        ("dennisfink.me", TypeError),
        (None, TypeError),
        ({"dennisfink.me": True}, TypeError),
        (123, TypeError),
        (["example.com", None], ValueError),
        (["example.com", ""], ValueError),
        (["example.com", "   "], ValueError),
    ],
)
def test_invalid_allowed_hostnames_fail_at_startup(
    tmp_path: Path, hostnames: object, expected_exception: type[Exception]
) -> None:
    class InvalidHostnameConfig(TestingConfig):
        LOG_FILE = str(tmp_path / "test.log")
        ALLOWED_HOSTNAMES = hostnames

    with pytest.raises(expected_exception, match="ALLOWED_HOSTNAMES"):
        create_app(InvalidHostnameConfig)


def test_production_requires_nonempty_allowed_hostnames(tmp_path: Path) -> None:
    config_path = tmp_path / "production.cfg"
    config_path.write_text('RATELIMIT_STORAGE_URI = "redis://localhost:6379"\n')

    class EmptyHostnamesConfig(ProductionConfig):
        CONFIG_FILE = str(config_path)

    with pytest.raises(RuntimeError, match="ALLOWED_HOSTNAMES"):
        create_app(EmptyHostnamesConfig)


def test_environment_allowed_hostnames_override_config_file(
    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
    config_path = tmp_path / "development.cfg"
    config_path.write_text('ALLOWED_HOSTNAMES = ["first.example"]\n')
    monkeypatch.setenv("WEBMENTIONS_SSG_ALLOWED_HOSTNAMES", '["SECOND.EXAMPLE"]')

    class LocalDevelopmentConfig(DevelopmentConfig):
        CONFIG_FILE = str(config_path)
        LOG_FILE = str(tmp_path / "development.log")

    app = create_app(LocalDevelopmentConfig)
    assert app.config["ALLOWED_HOSTNAMES"] == {"second.example"}