Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
225b13a7e3 | ||
|
|
c186668208 | ||
|
|
5f95afd0a3 | ||
|
|
132cbe9b20 |
+1
-1
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "stapler"
|
||||
version = "1.4.2"
|
||||
version = "1.5.1"
|
||||
description = "Static pages as simple as a gzip file"
|
||||
requires-python = ">=3.14"
|
||||
dependencies = [
|
||||
|
||||
+17
-1
@@ -5,6 +5,8 @@ import ssl
|
||||
import subprocess
|
||||
import typing
|
||||
|
||||
import requests
|
||||
|
||||
from stapler.strings import valid_host
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
@@ -49,6 +51,18 @@ class CertManager:
|
||||
def exists(self, host: str) -> bool:
|
||||
return self.__exists_certbot(host) or self.__exists_self_signed(host)
|
||||
|
||||
def valid_host(self, host: str) -> bool:
|
||||
try:
|
||||
response = requests.head(
|
||||
url=f"http://{host}/.well-known/stapler",
|
||||
allow_redirects=True,
|
||||
timeout=5,
|
||||
stream=False,
|
||||
)
|
||||
return type(response.status_code) is int and response.status_code < 400
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
def init_cert(self, host: str) -> bool:
|
||||
if not self.exists(host):
|
||||
return self.__create_self_signed(host)
|
||||
@@ -196,7 +210,9 @@ class CertManager:
|
||||
if host is None or not valid_host(host):
|
||||
return None
|
||||
self.logger.debug("servername callback: %s", host)
|
||||
if not self.exists(host) and not self.create_or_update(host):
|
||||
if not self.exists(host) and (
|
||||
not self.valid_host(host) or not self.create_or_update(host)
|
||||
):
|
||||
return None
|
||||
cert_file = self.get_cert(host)
|
||||
key_file = self.get_key(host)
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import abc
|
||||
import contextlib
|
||||
import datetime
|
||||
import http
|
||||
import http.cookiejar
|
||||
import http.server
|
||||
@@ -300,6 +301,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
|
||||
REDIRECT_HEADER = "X-Redirect"
|
||||
PROXY_HEADER = "X-Proxy"
|
||||
SPA_HEADER = "X-SPA"
|
||||
RATE_LIMIT = datetime.timedelta(seconds=1)
|
||||
|
||||
@typing.override
|
||||
def __init__(
|
||||
@@ -323,6 +325,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
|
||||
self.__target_redirect: str | None = None
|
||||
self.__target_proxy: str | None = None
|
||||
self.__target_spa: str | None = None
|
||||
self.rate_limits: dict[str, datetime.datetime] = {}
|
||||
try:
|
||||
super().__init__(*args, directory=params.data_dir, **kwargs, params=params) # ty:ignore[unknown-argument]
|
||||
except (BrokenPipeError, ConnectionResetError) as e:
|
||||
@@ -608,7 +611,20 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
|
||||
path = f"/{page.path}/{page.spa}"
|
||||
return super().translate_path(path)
|
||||
|
||||
def __check_rate_limit(self) -> bool:
|
||||
now = datetime.datetime.now(tz=datetime.UTC)
|
||||
address = self.address_string()
|
||||
last_atempt = self.rate_limits.get(address, None)
|
||||
self.rate_limits[address] = now
|
||||
return last_atempt is None or now - last_atempt > self.RATE_LIMIT
|
||||
|
||||
def __clear_rate_limit(self) -> None:
|
||||
del self.rate_limits[self.address_string()]
|
||||
|
||||
def __check_update_request(self) -> str | None:
|
||||
if not self.__check_rate_limit():
|
||||
self.send_error(http.HTTPStatus.TOO_MANY_REQUESTS, "Rate limit exceeded")
|
||||
return None
|
||||
if not self._has_header(self.TOKEN_HEADER):
|
||||
self.send_error(
|
||||
http.HTTPStatus.BAD_REQUEST, f"No {self.TOKEN_HEADER} header in request"
|
||||
@@ -617,6 +633,7 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
|
||||
if not self.token_manager.is_valid(self.token):
|
||||
self.send_error(http.HTTPStatus.UNAUTHORIZED, "Invalid token")
|
||||
return None
|
||||
self.__clear_rate_limit()
|
||||
if (sub_path := self.__get_path(self.path, self.UPDATE_PATH_REGEX)) is None:
|
||||
self.send_error(http.HTTPStatus.BAD_REQUEST, "Invalid path")
|
||||
return None
|
||||
|
||||
@@ -4,6 +4,8 @@ import subprocess
|
||||
import typing
|
||||
import unittest.mock
|
||||
|
||||
import requests
|
||||
|
||||
from stapler.cert_manager import CertManager, CertManagerError
|
||||
from stapler.params import Parameters
|
||||
|
||||
@@ -170,10 +172,24 @@ class TestRegistry(BaseTestCase):
|
||||
self.socket_mock, None, self.context_mock
|
||||
)
|
||||
|
||||
def test_servername_callback_fail(self) -> None:
|
||||
def test_servername_callback_fail_no_valid_host(self) -> None:
|
||||
self._make_self_signed("example.com")
|
||||
with (
|
||||
self.patch("requests.head") as request_mock,
|
||||
self.patch("ssl.create_default_context", count=0),
|
||||
):
|
||||
request_mock.side_effect = Exception()
|
||||
self.cert_manager.servername_callback(
|
||||
self.socket_mock, "example.fr", self.context_mock
|
||||
)
|
||||
|
||||
def test_servername_callback_fail_no_binaries(self) -> None:
|
||||
self._make_self_signed("example.com")
|
||||
response = requests.Response()
|
||||
response.status_code = 200
|
||||
with (
|
||||
self.patch("shutil.which", count=3),
|
||||
self.patch("requests.head", response),
|
||||
self.patch("ssl.create_default_context", count=0),
|
||||
):
|
||||
self.cert_manager.servername_callback(
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import abc
|
||||
import collections
|
||||
import contextlib
|
||||
import datetime
|
||||
import http
|
||||
import http.server
|
||||
import io
|
||||
@@ -275,6 +276,7 @@ class TestRequestHandler(BaseHandlerTestCase):
|
||||
self.seal_mocks(),
|
||||
):
|
||||
handler.do_PUT()
|
||||
assert "127.0.0.1" in handler.rate_limits
|
||||
|
||||
def test_do_post_is_do_put(self) -> None:
|
||||
handler = self._get_handler("/path")
|
||||
@@ -306,6 +308,18 @@ class TestRequestHandler(BaseHandlerTestCase):
|
||||
self.seal_mocks(),
|
||||
):
|
||||
handler.do_PUT()
|
||||
assert "127.0.0.1" in handler.rate_limits
|
||||
|
||||
def test_do_put_rate_limit(self) -> None:
|
||||
handler = self._get_handler("/path", {"X-Token": "secret"})
|
||||
handler.rate_limits["127.0.0.1"] = datetime.datetime.now(tz=datetime.UTC)
|
||||
with (
|
||||
self.expects_error(
|
||||
handler, http.HTTPStatus.TOO_MANY_REQUESTS, "Rate limit exceeded"
|
||||
),
|
||||
self.seal_mocks(),
|
||||
):
|
||||
handler.do_PUT()
|
||||
|
||||
def test_do_put_invalid_path(self) -> None:
|
||||
handler = self._get_handler("/pa.th", {"X-Token": "secret"})
|
||||
@@ -792,6 +806,7 @@ class TestRequestHandler(BaseHandlerTestCase):
|
||||
self.seal_mocks(),
|
||||
):
|
||||
handler.do_DELETE()
|
||||
assert "127.0.0.1" in handler.rate_limits
|
||||
|
||||
def test_do_delete_invalid_token(self) -> None:
|
||||
handler = self._get_handler("/path", {"X-Token": "secret"})
|
||||
@@ -801,6 +816,7 @@ class TestRequestHandler(BaseHandlerTestCase):
|
||||
self.seal_mocks(),
|
||||
):
|
||||
handler.do_DELETE()
|
||||
assert "127.0.0.1" in handler.rate_limits
|
||||
|
||||
def test_do_delete_invalid_path(self) -> None:
|
||||
handler = self._get_handler("/pa.th", {"X-Token": "secret"})
|
||||
|
||||
Reference in New Issue
Block a user