aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/security.py
blob: f4841a4c2d6c1413b20f14eeae58d3b95cd86cdf (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
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

"""Validate persistent signing keys and administrator passwords."""

MIN_PASSWORD_LENGTH = 8
MIN_SECRET_KEY_LENGTH = 32


def validate_secret_key(value: object) -> None:
    """Require a non-placeholder, sufficiently long deployment signing key."""
    if not isinstance(value, (str, bytes)):
        raise TypeError(
            "Configure a persistent SECRET_KEY of at least 32 random bytes "
            "before starting."
        )

    # Flask accepts either text or bytes as its signing key. Reject common
    # example/development values even when their lengths look sufficient.
    key = value.encode("utf-8") if isinstance(value, str) else value
    if len(key) < MIN_SECRET_KEY_LENGTH or not key.strip():
        raise RuntimeError(
            "Configure a persistent SECRET_KEY of at least 32 random bytes "
            "before starting."
        )

    normalized = key.strip().lower()
    if normalized.startswith(
        (b"replace_with", b"changeme", b"change_me", b"your_", b"insecure_")
    ):
        raise RuntimeError(
            "SECRET_KEY is an example/development placeholder; "
            "generate and configure a real random key."
        )


def validate_password(password: str) -> None:
    """Validate newly chosen passwords without arbitrary composition rules.

    Allow Unicode, whitespace-only passwords, and arbitrarily long passphrases,
    but reject empty passwords and control characters.
    """
    if not password:
        raise ValueError("Password must not be empty.")
    if len(password) < MIN_PASSWORD_LENGTH:
        raise ValueError(
            f"Password must be at least {MIN_PASSWORD_LENGTH} characters long."
        )
    if any(ord(char) < 32 or ord(char) == 127 for char in password):
        raise ValueError("Password must not contain control characters.")