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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
from __future__ import annotations
import importlib
import importlib.util
import logging
import os
import socket
import stat
import sys
import types
import warnings
from dataclasses import dataclass
from ssl import (
create_default_context,
OP_NO_COMPRESSION,
Purpose,
SSLContext,
TLSVersion,
VerifyFlags,
VerifyMode,
)
from time import time
from typing import Any, AnyStr, Dict, List, Mapping, Optional, Tuple, Type, Union
from wsgiref.handlers import format_date_time
if sys.version_info >= (3, 11):
import tomllib
else:
import tomli as tomllib
from .logging import Logger
BYTES = 1
OCTETS = 1
SECONDS = 1.0
FilePath = Union[AnyStr, os.PathLike]
SocketKind = Union[int, socket.SocketKind]
@dataclass
class Sockets:
secure_sockets: List[socket.socket]
insecure_sockets: List[socket.socket]
quic_sockets: List[socket.socket]
class SocketTypeError(Exception):
def __init__(self, expected: SocketKind, actual: SocketKind) -> None:
super().__init__(
f'Unexpected socket type, wanted "{socket.SocketKind(expected)}" got '
f'"{socket.SocketKind(actual)}"'
)
class Config:
_bind = ["127.0.0.1:8000"]
_insecure_bind: List[str] = []
_quic_bind: List[str] = []
_quic_addresses: List[Tuple] = []
_log: Optional[Logger] = None
_root_path: str = ""
access_log_format = '%(h)s %(l)s %(l)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"'
accesslog: Union[logging.Logger, str, None] = None
alpn_protocols = ["h2", "http/1.1"]
alt_svc_headers: List[str] = []
application_path: str
backlog = 100
ca_certs: Optional[str] = None
certfile: Optional[str] = None
ciphers: str = "ECDHE+AESGCM"
debug = False
dogstatsd_tags = ""
errorlog: Union[logging.Logger, str, None] = "-"
graceful_timeout: float = 3 * SECONDS
read_timeout: Optional[int] = None
group: Optional[int] = None
h11_max_incomplete_size = 16 * 1024 * BYTES
h11_pass_raw_headers = False
h2_max_concurrent_streams = 100
h2_max_header_list_size = 2**16
h2_max_inbound_frame_size = 2**14 * OCTETS
include_date_header = True
include_server_header = True
keep_alive_timeout = 5 * SECONDS
keyfile: Optional[str] = None
keyfile_password: Optional[str] = None
logconfig: Optional[str] = None
logconfig_dict: Optional[dict] = None
logger_class = Logger
loglevel: str = "INFO"
max_app_queue_size: int = 10
pid_path: Optional[str] = None
server_names: List[str] = []
shutdown_timeout = 60 * SECONDS
ssl_handshake_timeout = 60 * SECONDS
startup_timeout = 60 * SECONDS
statsd_host: Optional[str] = None
statsd_prefix = ""
umask: Optional[int] = None
use_reloader = False
user: Optional[int] = None
verify_flags: Optional[VerifyFlags] = None
verify_mode: Optional[VerifyMode] = None
websocket_max_message_size = 16 * 1024 * 1024 * BYTES
websocket_ping_interval: Optional[float] = None
worker_class = "asyncio"
workers = 1
wsgi_max_body_size = 16 * 1024 * 1024 * BYTES
def set_cert_reqs(self, value: int) -> None:
warnings.warn("Please use verify_mode instead", Warning)
self.verify_mode = VerifyMode(value)
cert_reqs = property(None, set_cert_reqs)
@property
def log(self) -> Logger:
if self._log is None:
self._log = self.logger_class(self)
return self._log
@property
def bind(self) -> List[str]:
return self._bind
@bind.setter
def bind(self, value: Union[List[str], str]) -> None:
if isinstance(value, str):
self._bind = [value]
else:
self._bind = value
@property
def insecure_bind(self) -> List[str]:
return self._insecure_bind
@insecure_bind.setter
def insecure_bind(self, value: Union[List[str], str]) -> None:
if isinstance(value, str):
self._insecure_bind = [value]
else:
self._insecure_bind = value
@property
def quic_bind(self) -> List[str]:
return self._quic_bind
@quic_bind.setter
def quic_bind(self, value: Union[List[str], str]) -> None:
if isinstance(value, str):
self._quic_bind = [value]
else:
self._quic_bind = value
@property
def root_path(self) -> str:
return self._root_path
@root_path.setter
def root_path(self, value: str) -> None:
self._root_path = value.rstrip("/")
def create_ssl_context(self) -> Optional[SSLContext]:
if not self.ssl_enabled:
return None
context = create_default_context(Purpose.CLIENT_AUTH)
context.set_ciphers(self.ciphers)
context.minimum_version = TLSVersion.TLSv1_2 # RFC 7540 Section 9.2: MUST be TLS >=1.2
context.options = OP_NO_COMPRESSION # RFC 7540 Section 9.2.1: MUST disable compression
context.set_alpn_protocols(self.alpn_protocols)
if self.certfile is not None and self.keyfile is not None:
context.load_cert_chain(
certfile=self.certfile,
keyfile=self.keyfile,
password=self.keyfile_password,
)
if self.ca_certs is not None:
context.load_verify_locations(self.ca_certs)
if self.verify_mode is not None:
context.verify_mode = self.verify_mode
if self.verify_flags is not None:
context.verify_flags = self.verify_flags
return context
@property
def ssl_enabled(self) -> bool:
return self.certfile is not None and self.keyfile is not None
def create_sockets(self) -> Sockets:
if self.ssl_enabled:
secure_sockets = self._create_sockets(self.bind)
insecure_sockets = self._create_sockets(self.insecure_bind)
quic_sockets = self._create_sockets(self.quic_bind, socket.SOCK_DGRAM)
self._set_quic_addresses(quic_sockets)
else:
secure_sockets = []
insecure_sockets = self._create_sockets(self.bind)
quic_sockets = []
return Sockets(secure_sockets, insecure_sockets, quic_sockets)
def _set_quic_addresses(self, sockets: List[socket.socket]) -> None:
self._quic_addresses = []
for sock in sockets:
name = sock.getsockname()
if type(name) is not str and len(name) >= 2:
self._quic_addresses.append(name)
else:
warnings.warn(
f'Cannot create a alt-svc header for the QUIC socket with address "{name}"',
Warning,
)
def _create_sockets(
self, binds: List[str], type_: int = socket.SOCK_STREAM
) -> List[socket.socket]:
sockets: List[socket.socket] = []
for bind in binds:
binding: Any = None
if bind.startswith("unix:"):
sock = socket.socket(socket.AF_UNIX, type_)
binding = bind[5:]
try:
if stat.S_ISSOCK(os.stat(binding).st_mode):
os.remove(binding)
except FileNotFoundError:
pass
elif bind.startswith("fd://"):
sock = socket.socket(fileno=int(bind[5:]))
actual_type = sock.getsockopt(socket.SOL_SOCKET, socket.SO_TYPE)
if actual_type != type_:
raise SocketTypeError(type_, actual_type)
else:
bind = bind.replace("[", "").replace("]", "")
try:
value = bind.rsplit(":", 1)
host, port = value[0], int(value[1])
except (ValueError, IndexError):
host, port = bind, 8000
sock = socket.socket(socket.AF_INET6 if ":" in host else socket.AF_INET, type_)
if self.workers > 1:
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
except AttributeError:
pass
binding = (host, port)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
if bind.startswith("unix:"):
if self.umask is not None:
current_umask = os.umask(self.umask)
sock.bind(binding)
if self.user is not None and self.group is not None:
os.chown(binding, self.user, self.group)
if self.umask is not None:
os.umask(current_umask)
elif bind.startswith("fd://"):
pass
else:
sock.bind(binding)
sock.setblocking(False)
try:
sock.set_inheritable(True)
except AttributeError:
pass
sockets.append(sock)
return sockets
def response_headers(self, protocol: str) -> List[Tuple[bytes, bytes]]:
headers = []
if self.include_date_header:
headers.append((b"date", format_date_time(time()).encode("ascii")))
if self.include_server_header:
headers.append((b"server", f"hypercorn-{protocol}".encode("ascii")))
for alt_svc_header in self.alt_svc_headers:
headers.append((b"alt-svc", alt_svc_header.encode()))
if len(self.alt_svc_headers) == 0 and self._quic_addresses:
from aioquic.h3.connection import H3_ALPN
for version in H3_ALPN:
for addr in self._quic_addresses:
port = addr[1]
headers.append((b"alt-svc", b'%s=":%d"; ma=3600' % (version.encode(), port)))
return headers
def set_statsd_logger_class(self, statsd_logger: Type[Logger]) -> None:
if self.logger_class == Logger and self.statsd_host is not None:
self.logger_class = statsd_logger
@classmethod
def from_mapping(
cls: Type["Config"], mapping: Optional[Mapping[str, Any]] = None, **kwargs: Any
) -> "Config":
"""Create a configuration from a mapping.
This allows either a mapping to be directly passed or as
keyword arguments, for example,
.. code-block:: python
config = {'keep_alive_timeout': 10}
Config.from_mapping(config)
Config.from_mapping(keep_alive_timeout=10)
Arguments:
mapping: Optionally a mapping object.
kwargs: Optionally a collection of keyword arguments to
form a mapping.
"""
mappings: Dict[str, Any] = {}
if mapping is not None:
mappings.update(mapping)
mappings.update(kwargs)
config = cls()
for key, value in mappings.items():
try:
setattr(config, key, value)
except AttributeError:
pass
return config
@classmethod
def from_pyfile(cls: Type["Config"], filename: FilePath) -> "Config":
"""Create a configuration from a Python file.
.. code-block:: python
Config.from_pyfile('hypercorn_config.py')
Arguments:
filename: The filename which gives the path to the file.
"""
file_path = os.fspath(filename)
spec = importlib.util.spec_from_file_location("module.name", file_path)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return cls.from_object(module)
@classmethod
def from_toml(cls: Type["Config"], filename: FilePath) -> "Config":
"""Load the configuration values from a TOML formatted file.
This allows configuration to be loaded as so
.. code-block:: python
Config.from_toml('config.toml')
Arguments:
filename: The filename which gives the path to the file.
"""
file_path = os.fspath(filename)
with open(file_path, "rb") as file_:
data = tomllib.load(file_)
return cls.from_mapping(data)
@classmethod
def from_object(cls: Type["Config"], instance: Union[object, str]) -> "Config":
"""Create a configuration from a Python object.
This can be used to reference modules or objects within
modules for example,
.. code-block:: python
Config.from_object('module')
Config.from_object('module.instance')
from module import instance
Config.from_object(instance)
are valid.
Arguments:
instance: Either a str referencing a python object or the
object itself.
"""
if isinstance(instance, str):
try:
instance = importlib.import_module(instance)
except ImportError:
path, config = instance.rsplit(".", 1)
module = importlib.import_module(path)
instance = getattr(module, config)
mapping = {
key: getattr(instance, key)
for key in dir(instance)
if not isinstance(getattr(instance, key), types.ModuleType) and not key.startswith("__")
}
return cls.from_mapping(mapping)
|