12 Commits

Author SHA1 Message Date
klemek e7abe7924f chore: release 1.2.7
Python Lint CI / ruff (push) Successful in 1m27s
Python Lint CI / ruff-format-check (push) Successful in 1m19s
Docker CI / docker-build (push) Successful in 1m43s
Python Lint CI / ty (push) Successful in 4m22s
Python Test CI / coverage (push) Successful in 4m1s
2026-05-06 10:50:01 +02:00
klemek 8f7e4c8a91 fix: add debug request count
Docker CI / docker-build (push) Has been cancelled
Python Lint CI / ruff (push) Has been cancelled
Python Lint CI / ruff-format-check (push) Has been cancelled
Python Lint CI / ty (push) Has been cancelled
Python Test CI / coverage (push) Has been cancelled
2026-05-06 10:49:42 +02:00
klemek ab6879d54f chore: release 1.2.6
Python Lint CI / ruff (push) Successful in 3m52s
Python Lint CI / ruff-format-check (push) Successful in 1m41s
Docker CI / docker-build (push) Successful in 4m7s
Python Lint CI / ty (push) Successful in 2m11s
Python Test CI / coverage (push) Successful in 2m13s
2026-05-06 09:36:47 +02:00
klemek 8c93b9a015 fix: dont log BrokenPipeError and ConnectionResetError 2026-05-06 09:36:31 +02:00
klemek f77e826490 chore: release 1.2.5
Python Lint CI / ruff (push) Successful in 2m59s
Python Lint CI / ruff-format-check (push) Successful in 1m27s
Docker CI / docker-build (push) Successful in 3m44s
Python Lint CI / ty (push) Successful in 1m21s
Python Test CI / coverage (push) Successful in 1m34s
2026-05-05 15:31:13 +02:00
klemek fec5857995 tests: more coverage
Python Lint CI / ruff (push) Has been cancelled
Python Lint CI / ruff-format-check (push) Has been cancelled
Python Lint CI / ty (push) Has been cancelled
Python Test CI / coverage (push) Has been cancelled
2026-05-05 15:30:51 +02:00
klemek b1ef00b437 fix: add request timeout 2026-05-05 15:09:54 +02:00
klemek 09ea29d6af fix: better string sanitizing 2026-05-05 15:09:39 +02:00
klemek 8855fd0b01 fix: force connection close 2026-05-05 15:09:20 +02:00
klemek 8854cb393c fix: send connection: close each request 2026-05-05 15:09:08 +02:00
klemek 5e5147251f chore: release 1.2.4
Python Lint CI / ruff (push) Successful in 1m8s
Docker CI / docker-build (push) Successful in 2m2s
Python Lint CI / ruff-format-check (push) Successful in 1m40s
Python Lint CI / ty (push) Successful in 1m44s
Python Test CI / coverage (push) Successful in 2m2s
2026-05-04 23:02:32 +02:00
klemek 3fe33cb348 fix: sanitize requestline
Docker CI / docker-build (push) Has been cancelled
Python Lint CI / ruff (push) Has been cancelled
Python Lint CI / ruff-format-check (push) Has been cancelled
Python Test CI / coverage (push) Has been cancelled
Python Lint CI / ty (push) Successful in 55s
2026-05-04 23:02:15 +02:00
5 changed files with 53 additions and 17 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "stapler"
version = "1.2.3"
version = "1.2.7"
description = "Static pages as simple as a gzip file"
requires-python = ">=3.14"
dependencies = [
+36 -11
View File
@@ -25,6 +25,10 @@ if typing.TYPE_CHECKING:
class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
SANITIZE_REGEX = re.compile(r"[^\x20-\x7F]+")
timeout = 10
REQUEST_COUNT = 0
@typing.override
def __init__(
self,
@@ -38,7 +42,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.__host: str | None = None
self.__in_size: int | None = None
self.https: bool = params.https
self.__class__.REQUEST_COUNT += 1
super().__init__(*args, **kwargs)
with contextlib.suppress(Exception):
self.connection.close()
@typing.override
def send_error(
@@ -75,7 +82,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
@typing.override
def address_string(self) -> str: # pragma: no cover
return re.sub(r"[^\x00-\x7F]+", "", super().address_string())
return self.SANITIZE_REGEX.sub("?", super().address_string())
@typing.override
def log_message(self, format: str, *args: typing.Any) -> None: # pragma: no cover
@@ -87,6 +94,20 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
fmt = "%s - " + format
self.logger.error(fmt, self.address_string(), *args)
def _pre_log_request(self) -> None: # pragma: no cover
args = (
"...",
self.address_string(),
self.host,
format(self.__class__.REQUEST_COUNT, "07_d"),
self.SANITIZE_REGEX.sub("?", self.requestline),
)
fmt = "%s - %s - %s - %s - %s"
if self.in_size > 0:
args = (*args, self.in_size)
fmt += " - %s"
self.logger.debug(fmt, *args)
@typing.override
def log_request(self, code: str = "?", size: str = "-") -> None: # ty:ignore[invalid-method-override] # pragma: no cover
if isinstance(code, http.HTTPStatus):
@@ -102,8 +123,14 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
code = color + str(code.value) + logs.TermColor.RESET
if size == "" and self.out_size > 0:
size = str(self.out_size)
args = (code, self.address_string(), self.host, self.requestline)
fmt = "%s - %s - %s - %s"
args = (
code,
self.address_string(),
self.host,
format(self.__class__.REQUEST_COUNT, "07_d"),
self.SANITIZE_REGEX.sub("?", self.requestline),
)
fmt = "%s - %s - %s - %s - %s"
if size != "":
args = (*args, size)
fmt += " - %s"
@@ -121,6 +148,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
self.send_response(code, message)
self.send_header("Content-Type", f"{content_type}; charset=UTF-8")
self.send_header("Content-Length", str(len(encoded)))
self.send_header("Connection", "close")
self.end_headers()
self.wfile.write(encoded)
self.close_connection = True
@@ -135,6 +163,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
headers = {}
self.send_response(code, message)
self.send_header("Content-Length", "0")
self.send_header("Connection", "close")
for header, value in headers.items():
self.send_header(header, value)
self.end_headers()
@@ -183,9 +212,11 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
"transfer-encoding",
"server",
"date",
"connection",
]:
self.send_header(header, value.replace(target_host, self.host))
self.send_header("Content-Length", str(out_size := len(response.content)))
self.send_header("Connection", "close")
self.end_headers()
if out_size > 0:
self.wfile.write(response.content)
@@ -222,14 +253,6 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
and len(self.headers[key]) > 0
)
def _pre_log_request(self) -> None: # pragma: no cover
args = ("...", self.address_string(), self.host, self.requestline)
fmt = "%s - %s - %s - %s"
if self.in_size > 0:
args = (*args, self.in_size)
fmt += " - %s"
self.logger.debug(fmt, *args)
def server_signature(self) -> str:
return self.server_version + "\n\n" + STAPLER_ASCII + "\n"
@@ -281,6 +304,8 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
self.__target_spa: str | None = None
try:
super().__init__(*args, directory=params.data_dir, **kwargs, params=params) # ty:ignore[unknown-argument]
except (BrokenPipeError, ConnectionResetError) as e:
self.logger.error("Connection lost: %s", str(e)) # noqa: TRY400
except:
self.logger.exception("Could not handle request")
-4
View File
@@ -59,10 +59,6 @@ class TestDataDir(BaseTestCase):
self.__create_path("test_1")
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
def test_get_file_cannot_read(self) -> None:
self.__create_path("test_1", {".value/.value": "value"})
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
def test_get_file_invalid_path(self) -> None:
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
+15
View File
@@ -177,6 +177,21 @@ class TestRequestHandler(BaseHandlerTestCase):
token_manager=self.token_manager,
)
def test_handle_disconnect_silently(self) -> None:
with self.patch("http.server.BaseHTTPRequestHandler.__init__") as mock:
mock.side_effect = BrokenPipeError
logging.basicConfig(level=logging.CRITICAL)
RequestHandler(
unittest.mock.MagicMock(),
"127.0.0.1",
unittest.mock.MagicMock(),
params=Parameters(
data_dir=self.get_tmp_dir(), certbot_www=str(self.certbot_www)
),
registry=self.registry,
token_manager=self.token_manager,
)
def test_do_head_forward(self) -> None:
handler = self._get_handler()
with (
Generated
+1 -1
View File
@@ -203,7 +203,7 @@ wheels = [
[[package]]
name = "stapler"
version = "1.2.3"
version = "1.2.7"
source = { editable = "." }
dependencies = [
{ name = "requests" },