adafruit-circuitpython-httpserver 4.5.10__tar.gz → 4.6.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/PKG-INFO +2 -1
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/README.rst +1 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_circuitpython_httpserver.egg-info/PKG-INFO +2 -1
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_circuitpython_httpserver.egg-info/SOURCES.txt +1 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/__init__.py +1 -1
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/server.py +91 -10
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/examples.rst +40 -8
- adafruit_circuitpython_httpserver-4.6.0/examples/httpserver_https.py +30 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/pyproject.toml +1 -1
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.github/workflows/build.yml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.github/workflows/failure-help-text.yml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.github/workflows/release_gh.yml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.github/workflows/release_pypi.yml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.gitignore +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.pre-commit-config.yaml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.pylintrc +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.readthedocs.yaml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/CODE_OF_CONDUCT.md +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/LICENSE +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/LICENSES/CC-BY-4.0.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/LICENSES/MIT.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/LICENSES/Unlicense.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/README.rst.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_circuitpython_httpserver.egg-info/dependency_links.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_circuitpython_httpserver.egg-info/requires.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_circuitpython_httpserver.egg-info/top_level.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/authentication.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/exceptions.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/headers.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/interfaces.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/methods.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/mime_types.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/request.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/response.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/route.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/adafruit_httpserver/status.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/_static/favicon.ico +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/_static/favicon.ico.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/api.rst +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/api.rst.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/conf.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/examples.rst.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/index.rst +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/index.rst.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/requirements.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/starting_methods.rst +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/starting_methods.rst.license +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/directory_listing.tpl.html +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/home.html +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_authentication_handlers.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_authentication_server.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_chunked.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_cookies.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_cpu_information.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_cpython.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_form_data.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_handler_serves_file.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_mdns.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_methods.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_multiple_servers.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_neopixel.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_redirects.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_simpletest_auto_connection_manager.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_simpletest_auto_settings_toml.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_simpletest_manual_ap.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_simpletest_manual_ethernet.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_simpletest_manual_wifi.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_sse.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_start_and_poll.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_start_and_poll_asyncio.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_static_files_serving.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_templates.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_url_parameters.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_video_stream.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/httpserver_websocket.py +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/examples/settings.toml +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/optional_requirements.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/requirements.txt +0 -0
- {adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/setup.cfg +0 -0
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/PKG-INFO
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: adafruit-circuitpython-httpserver
|
|
3
|
-
Version: 4.
|
|
3
|
+
Version: 4.6.0
|
|
4
4
|
Summary: Simple HTTP Server for CircuitPython
|
|
5
5
|
Author-email: Adafruit Industries <circuitpython@adafruit.com>
|
|
6
6
|
License: MIT
|
|
@@ -51,6 +51,7 @@ HTTP Server for CircuitPython.
|
|
|
51
51
|
- Supports URL parameters and wildcard URLs.
|
|
52
52
|
- Supports HTTP Basic and Bearer Authentication on both server and route per level.
|
|
53
53
|
- Supports Websockets and Server-Sent Events.
|
|
54
|
+
- Limited support for HTTPS (only on selected microcontrollers with enough memory e.g. ESP32-S3).
|
|
54
55
|
|
|
55
56
|
|
|
56
57
|
Dependencies
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/README.rst
RENAMED
|
@@ -32,6 +32,7 @@ HTTP Server for CircuitPython.
|
|
|
32
32
|
- Supports URL parameters and wildcard URLs.
|
|
33
33
|
- Supports HTTP Basic and Bearer Authentication on both server and route per level.
|
|
34
34
|
- Supports Websockets and Server-Sent Events.
|
|
35
|
+
- Limited support for HTTPS (only on selected microcontrollers with enough memory e.g. ESP32-S3).
|
|
35
36
|
|
|
36
37
|
|
|
37
38
|
Dependencies
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: adafruit-circuitpython-httpserver
|
|
3
|
-
Version: 4.
|
|
3
|
+
Version: 4.6.0
|
|
4
4
|
Summary: Simple HTTP Server for CircuitPython
|
|
5
5
|
Author-email: Adafruit Industries <circuitpython@adafruit.com>
|
|
6
6
|
License: MIT
|
|
@@ -51,6 +51,7 @@ HTTP Server for CircuitPython.
|
|
|
51
51
|
- Supports URL parameters and wildcard URLs.
|
|
52
52
|
- Supports HTTP Basic and Bearer Authentication on both server and route per level.
|
|
53
53
|
- Supports Websockets and Server-Sent Events.
|
|
54
|
+
- Limited support for HTTPS (only on selected microcontrollers with enough memory e.g. ESP32-S3).
|
|
54
55
|
|
|
55
56
|
|
|
56
57
|
Dependencies
|
|
@@ -56,6 +56,7 @@ examples/httpserver_cpu_information.py
|
|
|
56
56
|
examples/httpserver_cpython.py
|
|
57
57
|
examples/httpserver_form_data.py
|
|
58
58
|
examples/httpserver_handler_serves_file.py
|
|
59
|
+
examples/httpserver_https.py
|
|
59
60
|
examples/httpserver_mdns.py
|
|
60
61
|
examples/httpserver_methods.py
|
|
61
62
|
examples/httpserver_multiple_servers.py
|
|
@@ -12,6 +12,7 @@ try:
|
|
|
12
12
|
except ImportError:
|
|
13
13
|
pass
|
|
14
14
|
|
|
15
|
+
from ssl import SSLContext, create_default_context
|
|
15
16
|
from errno import EAGAIN, ECONNRESET, ETIMEDOUT
|
|
16
17
|
from sys import implementation
|
|
17
18
|
from time import monotonic, sleep
|
|
@@ -33,12 +34,18 @@ from .response import Response, FileResponse
|
|
|
33
34
|
from .route import Route
|
|
34
35
|
from .status import BAD_REQUEST_400, UNAUTHORIZED_401, FORBIDDEN_403, NOT_FOUND_404
|
|
35
36
|
|
|
37
|
+
if implementation.name != "circuitpython":
|
|
38
|
+
from ssl import Purpose, CERT_NONE, SSLError # pylint: disable=ungrouped-imports
|
|
39
|
+
|
|
36
40
|
|
|
37
41
|
NO_REQUEST = "no_request"
|
|
38
42
|
CONNECTION_TIMED_OUT = "connection_timed_out"
|
|
39
43
|
REQUEST_HANDLED_NO_RESPONSE = "request_handled_no_response"
|
|
40
44
|
REQUEST_HANDLED_RESPONSE_SENT = "request_handled_response_sent"
|
|
41
45
|
|
|
46
|
+
# CircuitPython does not have these error codes
|
|
47
|
+
MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE = -30592
|
|
48
|
+
|
|
42
49
|
|
|
43
50
|
class Server: # pylint: disable=too-many-instance-attributes
|
|
44
51
|
"""A basic socket-based HTTP server."""
|
|
@@ -52,8 +59,50 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
52
59
|
root_path: str
|
|
53
60
|
"""Root directory to serve files from. ``None`` if serving files is disabled."""
|
|
54
61
|
|
|
62
|
+
@staticmethod
|
|
63
|
+
def _validate_https_cert_provided(
|
|
64
|
+
certfile: Union[str, None], keyfile: Union[str, None]
|
|
65
|
+
) -> None:
|
|
66
|
+
if certfile is None or keyfile is None:
|
|
67
|
+
raise ValueError("Both certfile and keyfile must be specified for HTTPS")
|
|
68
|
+
|
|
69
|
+
@staticmethod
|
|
70
|
+
def _create_circuitpython_ssl_context(certfile: str, keyfile: str) -> SSLContext:
|
|
71
|
+
ssl_context = create_default_context()
|
|
72
|
+
|
|
73
|
+
ssl_context.load_verify_locations(cadata="")
|
|
74
|
+
ssl_context.load_cert_chain(certfile, keyfile)
|
|
75
|
+
|
|
76
|
+
return ssl_context
|
|
77
|
+
|
|
78
|
+
@staticmethod
|
|
79
|
+
def _create_cpython_ssl_context(certfile: str, keyfile: str) -> SSLContext:
|
|
80
|
+
ssl_context = create_default_context(purpose=Purpose.CLIENT_AUTH)
|
|
81
|
+
|
|
82
|
+
ssl_context.load_cert_chain(certfile, keyfile)
|
|
83
|
+
|
|
84
|
+
ssl_context.verify_mode = CERT_NONE
|
|
85
|
+
ssl_context.check_hostname = False
|
|
86
|
+
|
|
87
|
+
return ssl_context
|
|
88
|
+
|
|
89
|
+
@classmethod
|
|
90
|
+
def _create_ssl_context(cls, certfile: str, keyfile: str) -> SSLContext:
|
|
91
|
+
return (
|
|
92
|
+
cls._create_circuitpython_ssl_context(certfile, keyfile)
|
|
93
|
+
if implementation.name == "circuitpython"
|
|
94
|
+
else cls._create_cpython_ssl_context(certfile, keyfile)
|
|
95
|
+
)
|
|
96
|
+
|
|
55
97
|
def __init__(
|
|
56
|
-
self,
|
|
98
|
+
self,
|
|
99
|
+
socket_source: _ISocketPool,
|
|
100
|
+
root_path: str = None,
|
|
101
|
+
*,
|
|
102
|
+
https: bool = False,
|
|
103
|
+
certfile: str = None,
|
|
104
|
+
keyfile: str = None,
|
|
105
|
+
debug: bool = False,
|
|
57
106
|
) -> None:
|
|
58
107
|
"""Create a server, and get it ready to run.
|
|
59
108
|
|
|
@@ -61,16 +110,30 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
61
110
|
in CircuitPython or the `socket` module in CPython.
|
|
62
111
|
:param str root_path: Root directory to serve files from
|
|
63
112
|
:param bool debug: Enables debug messages useful during development
|
|
113
|
+
:param bool https: If True, the server will use HTTPS
|
|
114
|
+
:param str certfile: Path to the certificate file, required if ``https`` is True
|
|
115
|
+
:param str keyfile: Path to the private key file, required if ``https`` is True
|
|
64
116
|
"""
|
|
65
|
-
self._auths = []
|
|
66
117
|
self._buffer = bytearray(1024)
|
|
67
118
|
self._timeout = 1
|
|
119
|
+
|
|
120
|
+
self._auths = []
|
|
68
121
|
self._routes: "List[Route]" = []
|
|
122
|
+
self.headers = Headers()
|
|
123
|
+
|
|
69
124
|
self._socket_source = socket_source
|
|
70
125
|
self._sock = None
|
|
71
|
-
|
|
126
|
+
|
|
72
127
|
self.host, self.port = None, None
|
|
73
128
|
self.root_path = root_path
|
|
129
|
+
self.https = https
|
|
130
|
+
|
|
131
|
+
if https:
|
|
132
|
+
self._validate_https_cert_provided(certfile, keyfile)
|
|
133
|
+
self._ssl_context = self._create_ssl_context(certfile, keyfile)
|
|
134
|
+
else:
|
|
135
|
+
self._ssl_context = None
|
|
136
|
+
|
|
74
137
|
if root_path in ["", "/"] and debug:
|
|
75
138
|
_debug_warning_exposed_files(root_path)
|
|
76
139
|
self.stopped = True
|
|
@@ -197,6 +260,7 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
197
260
|
@staticmethod
|
|
198
261
|
def _create_server_socket(
|
|
199
262
|
socket_source: _ISocketPool,
|
|
263
|
+
ssl_context: "SSLContext | None",
|
|
200
264
|
host: str,
|
|
201
265
|
port: int,
|
|
202
266
|
) -> _ISocket:
|
|
@@ -206,6 +270,9 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
206
270
|
if implementation.version >= (9,) or implementation.name != "circuitpython":
|
|
207
271
|
sock.setsockopt(socket_source.SOL_SOCKET, socket_source.SO_REUSEADDR, 1)
|
|
208
272
|
|
|
273
|
+
if ssl_context is not None:
|
|
274
|
+
sock = ssl_context.wrap_socket(sock, server_side=True)
|
|
275
|
+
|
|
209
276
|
sock.bind((host, port))
|
|
210
277
|
sock.listen(10)
|
|
211
278
|
sock.setblocking(False) # Non-blocking socket
|
|
@@ -225,7 +292,9 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
225
292
|
self.host, self.port = host, port
|
|
226
293
|
|
|
227
294
|
self.stopped = False
|
|
228
|
-
self._sock = self._create_server_socket(
|
|
295
|
+
self._sock = self._create_server_socket(
|
|
296
|
+
self._socket_source, self._ssl_context, host, port
|
|
297
|
+
)
|
|
229
298
|
|
|
230
299
|
if self.debug:
|
|
231
300
|
_debug_started_server(self)
|
|
@@ -386,7 +455,9 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
386
455
|
name, value
|
|
387
456
|
)
|
|
388
457
|
|
|
389
|
-
def poll(
|
|
458
|
+
def poll( # pylint: disable=too-many-branches,too-many-return-statements
|
|
459
|
+
self,
|
|
460
|
+
) -> str:
|
|
390
461
|
"""
|
|
391
462
|
Call this method inside your main loop to get the server to check for new incoming client
|
|
392
463
|
requests. When a request comes in, it will be handled by the handler function.
|
|
@@ -399,11 +470,12 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
399
470
|
|
|
400
471
|
conn = None
|
|
401
472
|
try:
|
|
473
|
+
if self.debug:
|
|
474
|
+
_debug_start_time = monotonic()
|
|
475
|
+
|
|
402
476
|
conn, client_address = self._sock.accept()
|
|
403
477
|
conn.settimeout(self._timeout)
|
|
404
478
|
|
|
405
|
-
_debug_start_time = monotonic()
|
|
406
|
-
|
|
407
479
|
# Receive the whole request
|
|
408
480
|
if (request := self._receive_request(conn, client_address)) is None:
|
|
409
481
|
conn.close()
|
|
@@ -424,9 +496,8 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
424
496
|
# Send the response
|
|
425
497
|
response._send() # pylint: disable=protected-access
|
|
426
498
|
|
|
427
|
-
_debug_end_time = monotonic()
|
|
428
|
-
|
|
429
499
|
if self.debug:
|
|
500
|
+
_debug_end_time = monotonic()
|
|
430
501
|
_debug_response_sent(response, _debug_end_time - _debug_start_time)
|
|
431
502
|
|
|
432
503
|
return REQUEST_HANDLED_RESPONSE_SENT
|
|
@@ -439,6 +510,15 @@ class Server: # pylint: disable=too-many-instance-attributes
|
|
|
439
510
|
# Connection reset by peer, try again later.
|
|
440
511
|
if error.errno == ECONNRESET:
|
|
441
512
|
return NO_REQUEST
|
|
513
|
+
# Handshake failed, try again later.
|
|
514
|
+
if error.errno == MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
|
|
515
|
+
return NO_REQUEST
|
|
516
|
+
|
|
517
|
+
# CPython specific SSL related errors
|
|
518
|
+
if implementation.name != "circuitpython" and isinstance(error, SSLError):
|
|
519
|
+
# Ignore unknown SSL certificate errors
|
|
520
|
+
if getattr(error, "reason", None) == "SSLV3_ALERT_CERTIFICATE_UNKNOWN":
|
|
521
|
+
return NO_REQUEST
|
|
442
522
|
|
|
443
523
|
if self.debug:
|
|
444
524
|
_debug_exception_in_handler(error)
|
|
@@ -547,9 +627,10 @@ def _debug_warning_exposed_files(root_path: str):
|
|
|
547
627
|
|
|
548
628
|
def _debug_started_server(server: "Server"):
|
|
549
629
|
"""Prints a message when the server starts."""
|
|
630
|
+
scheme = "https" if server.https else "http"
|
|
550
631
|
host, port = server.host, server.port
|
|
551
632
|
|
|
552
|
-
print(f"Started development server on
|
|
633
|
+
print(f"Started development server on {scheme}://{host}:{port}")
|
|
553
634
|
|
|
554
635
|
|
|
555
636
|
def _debug_response_sent(response: "Response", time_elapsed: float):
|
|
@@ -196,7 +196,7 @@ It is important to use correct ``enctype``, depending on the type of data you wa
|
|
|
196
196
|
- ``application/x-www-form-urlencoded`` - For sending simple text data without any special characters including spaces.
|
|
197
197
|
If you use it, values will be automatically parsed as strings, but special characters will be URL encoded
|
|
198
198
|
e.g. ``"Hello World! ^-$%"`` will be saved as ``"Hello+World%21+%5E-%24%25"``
|
|
199
|
-
- ``multipart/form-data`` - For sending
|
|
199
|
+
- ``multipart/form-data`` - For sending text with special characters and files
|
|
200
200
|
When used, non-file values will be automatically parsed as strings and non plain text files will be saved as ``bytes``.
|
|
201
201
|
e.g. ``"Hello World! ^-$%"`` will be saved as ``'Hello World! ^-$%'``, and e.g. a PNG file will be saved as ``b'\x89PNG\r\n\x1a\n\x00\...``.
|
|
202
202
|
- ``text/plain`` - For sending text data with special characters.
|
|
@@ -322,8 +322,10 @@ This can be overcomed by periodically polling the server, but it is not an elega
|
|
|
322
322
|
Response is initialized on ``return``, events can be sent using ``.send_event()`` method. Due to the nature of SSE, it is necessary to store the
|
|
323
323
|
response object somewhere, so that it can be accessed later.
|
|
324
324
|
|
|
325
|
-
|
|
326
|
-
|
|
325
|
+
|
|
326
|
+
.. warning::
|
|
327
|
+
Because of the limited number of concurrently open sockets, it is **not possible to process more than one SSE response at the same time**.
|
|
328
|
+
This might change in the future, but for now, it is recommended to use SSE **only with one client at a time**.
|
|
327
329
|
|
|
328
330
|
.. literalinclude:: ../examples/httpserver_sse.py
|
|
329
331
|
:caption: examples/httpserver_sse.py
|
|
@@ -344,8 +346,9 @@ This is anologous to calling ``.poll()`` on the ``Server`` object.
|
|
|
344
346
|
The following example uses ``asyncio``, which has to be installed separately. It is not necessary to use ``asyncio`` to use Websockets,
|
|
345
347
|
but it is recommended as it makes it easier to handle multiple tasks. It can be used in any of the examples, but here it is particularly useful.
|
|
346
348
|
|
|
347
|
-
|
|
348
|
-
|
|
349
|
+
.. warning::
|
|
350
|
+
Because of the limited number of concurrently open sockets, it is **not possible to process more than one Websocket response at the same time**.
|
|
351
|
+
This might change in the future, but for now, it is recommended to use Websocket **only with one client at a time**.
|
|
349
352
|
|
|
350
353
|
.. literalinclude:: ../examples/httpserver_websocket.py
|
|
351
354
|
:caption: examples/httpserver_websocket.py
|
|
@@ -369,6 +372,35 @@ video to multiple clients while simultaneously handling other requests.
|
|
|
369
372
|
:emphasize-lines: 31-77,92
|
|
370
373
|
:linenos:
|
|
371
374
|
|
|
375
|
+
HTTPS
|
|
376
|
+
-----
|
|
377
|
+
|
|
378
|
+
.. warning::
|
|
379
|
+
HTTPS on CircuitPython **works only on boards with enough memory e.g. ESP32-S3**.
|
|
380
|
+
|
|
381
|
+
When you want to expose your server to the internet or an untrusted network, it is recommended to use HTTPS.
|
|
382
|
+
Together with authentication, it provides a relatively secure way to communicate with the server.
|
|
383
|
+
|
|
384
|
+
.. note::
|
|
385
|
+
Using HTTPS slows down the server, because of additional work with encryption and decryption.
|
|
386
|
+
|
|
387
|
+
Enabling HTTPS is straightforward and comes down to passing the path to the certificate and key files to the ``Server`` constructor
|
|
388
|
+
and setting ``https=True``.
|
|
389
|
+
|
|
390
|
+
.. literalinclude:: ../examples/httpserver_https.py
|
|
391
|
+
:caption: examples/httpserver_https.py
|
|
392
|
+
:emphasize-lines: 15-17
|
|
393
|
+
:linenos:
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
To create your own certificate, you can use the following command:
|
|
397
|
+
|
|
398
|
+
.. code-block:: bash
|
|
399
|
+
|
|
400
|
+
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout key.pem -out cert.pem
|
|
401
|
+
|
|
402
|
+
You might have to change permissions of the files, so that the server can read them.
|
|
403
|
+
|
|
372
404
|
Multiple servers
|
|
373
405
|
----------------
|
|
374
406
|
|
|
@@ -378,7 +410,7 @@ Using ``.serve_forever()`` for this is not possible because of it's blocking beh
|
|
|
378
410
|
|
|
379
411
|
Each server **must have a different port number**.
|
|
380
412
|
|
|
381
|
-
|
|
413
|
+
To distinguish between responses from different servers a 'X-Server' header is added to each response.
|
|
382
414
|
**This is an optional step**, both servers will work without it.
|
|
383
415
|
|
|
384
416
|
In combination with separate authentication and diffrent ``root_path`` this allows creating moderately complex setups.
|
|
@@ -421,5 +453,5 @@ This is the default format of the logs::
|
|
|
421
453
|
If you need more information about the server or request, or you want it in a different format you can modify
|
|
422
454
|
functions at the bottom of ``adafruit_httpserver/server.py`` that start with ``_debug_...``.
|
|
423
455
|
|
|
424
|
-
|
|
425
|
-
|
|
456
|
+
.. note::
|
|
457
|
+
This is an advanced usage that might change in the future. It is not recommended to modify other parts of the code.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2024 Michał Pokusa
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Unlicense
|
|
4
|
+
|
|
5
|
+
import socketpool
|
|
6
|
+
import wifi
|
|
7
|
+
|
|
8
|
+
from adafruit_httpserver import Server, Request, Response
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
pool = socketpool.SocketPool(wifi.radio)
|
|
12
|
+
server = Server(
|
|
13
|
+
pool,
|
|
14
|
+
root_path="/static",
|
|
15
|
+
https=True,
|
|
16
|
+
certfile="cert.pem",
|
|
17
|
+
keyfile="key.pem",
|
|
18
|
+
debug=True,
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
@server.route("/")
|
|
23
|
+
def base(request: Request):
|
|
24
|
+
"""
|
|
25
|
+
Serve a default static plain text message.
|
|
26
|
+
"""
|
|
27
|
+
return Response(request, "Hello from the CircuitPython HTTPS Server!")
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
server.serve_forever(str(wifi.radio.ipv4_address), 443)
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/pyproject.toml
RENAMED
|
@@ -12,7 +12,7 @@ requires = [
|
|
|
12
12
|
[project]
|
|
13
13
|
name = "adafruit-circuitpython-httpserver"
|
|
14
14
|
description = "Simple HTTP Server for CircuitPython"
|
|
15
|
-
version = "4.
|
|
15
|
+
version = "4.6.0"
|
|
16
16
|
readme = "README.rst"
|
|
17
17
|
authors = [
|
|
18
18
|
{name = "Adafruit Industries", email = "circuitpython@adafruit.com"}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.gitignore
RENAMED
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/.pylintrc
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/LICENSE
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/api.rst
RENAMED
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/conf.py
RENAMED
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/docs/index.rst
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{adafruit_circuitpython_httpserver-4.5.10 → adafruit_circuitpython_httpserver-4.6.0}/setup.cfg
RENAMED
|
File without changes
|