Class Server

adafruit_httpserver/server.py:57–621

A basic socket-based HTTP server.

class Server:
    """A basic socket-based HTTP server."""

    host: str
    """Host name or IP address the server is listening on. ``None`` if server is stopped."""

    port: int
    """Port the server is listening on. ``None`` if server is stopped."""

    root_path: str
    """Root directory to serve files from. ``None`` if serving files is disabled."""

    @staticmethod
    def _validate_https_cert_provided(
        certfile: Union[str, None], keyfile: Union[str, None]
    ) -> None:
        if certfile is None or keyfile is None:
            raise ValueError("Both certfile and keyfile must be specified for HTTPS")

    @staticmethod
    def _create_circuitpython_ssl_context(certfile: str, keyfile: str) -> SSLContext:
        ssl_context = create_default_context()

        ssl_context.load_verify_locations(cadata="")
        ssl_context.load_cert_chain(certfile, keyfile)

        return ssl_context

    @staticmethod
    def _create_cpython_ssl_context(certfile: str, keyfile: str) -> SSLContext:
        ssl_context = create_default_context(purpose=Purpose.CLIENT_AUTH)

        ssl_context.load_cert_chain(certfile, keyfile)

        ssl_context.verify_mode = CERT_NONE
        ssl_context.check_hostname = False

        return ssl_context

    @classmethod
    def _create_ssl_context(cls, certfile: str, keyfile: str) -> SSLContext:
        return (
            cls._create_circuitpython_ssl_context(certfile, keyfile)
            if implementation.name == "circuitpython"
            else cls._create_cpython_ssl_context(certfile, keyfile)
        )

    def __init__(
        self,
        socket_source: _ISocketPool,
        root_path: str = None,
        *,
        https: bool = False,
        certfile: str = None,
        keyfile: str = None,
        debug: bool = False,
    ) -> None:
        """Create a server, and get it ready to run.