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
|
"""SniTun reference implementation."""
from __future__ import annotations
import asyncio
from collections.abc import Coroutine, Iterator
from contextlib import suppress
from dataclasses import dataclass
from itertools import cycle
import logging
from multiprocessing import cpu_count
import os
import select
import signal
import socket
from threading import Thread
from typing import Any
from ..exceptions import ParseSNIIncompleteError
from ..metrics import MetricsCollector, MetricsFactory, create_noop_metrics_collector
from ..utils.asyncio import asyncio_timeout
from ..utils.server import MAX_BUFFER_SIZE, MAX_READ_SIZE
from .listener_peer import PeerListener
from .listener_sni import SNIProxy
from .peer_manager import PeerManager
from .sni import ParseSNIError, parse_tls_sni
from .worker import ServerWorker
_LOGGER = logging.getLogger(__name__)
WORKER_STALE_MAX = 30
class SniTunServer:
"""SniTunServer helper class for Dual port Asyncio."""
def __init__(
self,
fernet_keys: list[str],
sni_port: int | None = None,
sni_host: str | None = None,
peer_port: int | None = None,
peer_host: str | None = None,
throttling: int | None = None,
) -> None:
"""Initialize SniTun Server."""
self._peers: PeerManager = PeerManager(fernet_keys, throttling=throttling)
self._list_sni: SNIProxy = SNIProxy(self._peers, host=sni_host, port=sni_port)
self._list_peer: PeerListener = PeerListener(
self._peers,
host=peer_host,
port=peer_port,
)
@property
def peers(self) -> PeerManager:
"""Return peer manager."""
return self._peers
def start(
self,
) -> Coroutine[Any, Any, tuple[set[asyncio.Task[None]], set[asyncio.Task[None]]]]:
"""Run server.
Return coroutine.
"""
return asyncio.wait(
[
asyncio.create_task(self._list_peer.start()),
asyncio.create_task(self._list_sni.start()),
],
)
def stop(
self,
) -> Coroutine[Any, Any, tuple[set[asyncio.Task[None]], set[asyncio.Task[None]]]]:
"""Stop server.
Return coroutine.
"""
return asyncio.wait(
[
asyncio.create_task(self._list_peer.stop()),
asyncio.create_task(self._list_sni.stop()),
],
)
class SniTunServerSingle:
"""SniTunServer helper class for Single port Asnycio."""
def __init__(
self,
fernet_keys: list[str],
host: str | None = None,
port: int | None = None,
throttling: int | None = None,
) -> None:
"""Initialize SniTun Server."""
self._loop: asyncio.AbstractEventLoop = asyncio.get_event_loop()
self._server: asyncio.AbstractServer | None = None
self._peers: PeerManager = PeerManager(fernet_keys, throttling=throttling)
self._list_sni: SNIProxy = SNIProxy(self._peers)
self._list_peer: PeerListener = PeerListener(self._peers)
self._host: str = host or "0.0.0.0"
self._port: int = port or 443
@property
def peers(self) -> PeerManager:
"""Return peer manager."""
return self._peers
async def start(self) -> None:
"""Run server."""
self._server = await asyncio.start_server(
self._handler,
host=self._host,
port=self._port,
)
async def stop(self) -> None:
"""Stop server."""
assert self._server is not None, "Server not started"
self._server.close()
await self._server.wait_closed()
async def _handler(
self,
reader: asyncio.StreamReader,
writer: asyncio.StreamWriter,
) -> None:
"""Handle incoming connection."""
try:
async with asyncio_timeout.timeout(10):
data = await reader.read(2048)
except TimeoutError:
_LOGGER.warning("Abort connection initializing")
writer.close()
return
except OSError:
return
# Connection closed / healty check
if not data:
writer.close()
return
# Select the correct handler for process data
if data[0] == 0x16:
self._loop.create_task(
self._list_sni.handle_connection(reader, writer, data=data),
)
elif data.startswith(b"gA"):
self._loop.create_task(
self._list_peer.handle_connection(reader, writer, data=data),
)
else:
_LOGGER.warning("No valid ClientHello found: %s", data)
writer.close()
return
@dataclass(slots=True)
class Connection:
"""Connection data class."""
sock: socket.socket
epoll: select.epoll
buffer: bytes = b""
stale: int = 0
close: bool = False
@property
def fileno(self) -> int:
"""Return filehanle ID."""
return self.sock.fileno()
def soft_close(self) -> None:
"""Socket got handled over."""
self.close = True
self.epoll.unregister(self.fileno)
def close_socket(self, shutdown: bool = True) -> None:
"""Gracefull shutdown a socket or free the handle."""
self.soft_close()
with suppress(OSError):
if shutdown:
self.sock.shutdown(socket.SHUT_RDWR)
self.sock.close()
class SniTunServerWorker(Thread):
"""SniTunServer helper class for Worker."""
def __init__(
self,
fernet_keys: list[str],
host: str | None = None,
port: int | None = None,
worker_size: int | None = None,
throttling: int | None = None,
metrics_factory: MetricsFactory | None = None,
metrics_interval: int = 60,
) -> None:
"""Initialize SniTun Server."""
super().__init__()
self._host: str = host or "0.0.0.0"
self._port: int = port or 443
self._fernet_keys: list[str] = fernet_keys
self._throttling: int | None = throttling
self._worker_size: int = worker_size or (cpu_count() * 2)
self._workers: list[ServerWorker] = []
self._running: bool = False
self._metrics_factory = metrics_factory or create_noop_metrics_collector
self._metrics_interval = metrics_interval
self._metrics: MetricsCollector | None = None
# TCP server
self._server: socket.socket | None = None
self._poller: select.epoll | None = None
@property
def peer_counter(self) -> int:
"""Return number of active peer connections."""
return sum(worker.peer_size for worker in self._workers)
def start(self) -> None:
"""Run server."""
self._metrics = self._metrics_factory()
# Init first all worker, we don't want the epoll on the childs
_LOGGER.info("Run SniTun with %d worker", self._worker_size)
for _ in range(self._worker_size):
worker = ServerWorker(
self._fernet_keys,
throttling=self._throttling,
metrics_factory=self._metrics_factory,
metrics_interval=self._metrics_interval,
)
worker.start()
self._workers.append(worker)
self._server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self._server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self._server.bind((self._host, self._port))
self._server.setblocking(False)
self._server.listen(80 * 1000)
self._running = True
self._poller = select.epoll()
self._poller.register(self._server.fileno(), select.EPOLLIN)
super().start()
def stop(self) -> None:
"""Stop server."""
self._running = False
self.join()
# Shutdown all workers
for worker in self._workers:
worker.shutdown()
worker.close()
self._workers.clear()
assert self._server is not None, "Server not started"
self._server.close()
assert self._poller is not None, "Poller not started"
self._poller.close()
def run(self) -> None:
"""Handle incoming connection."""
assert self._server is not None, "Server not started"
fd_server = self._server.fileno()
connections: dict[int, Connection] = {}
worker_lb = cycle(self._workers)
_LOGGER.info("Server started, fd: %s", fd_server)
assert self._poller is not None, "Poller not started"
while self._running:
events = self._poller.poll(1)
for fileno, event in events:
# New Connection
if fileno == fd_server:
con, _ = self._server.accept()
con.setblocking(False)
self._poller.register(
con.fileno(),
select.EPOLLIN | select.EPOLLHUP | select.EPOLLERR,
)
connections[con.fileno()] = Connection(con, self._poller)
# Read hello & forward to worker
elif event & select.EPOLLIN:
client = connections[fileno]
client.stale = 0 # reset stale count
# Process connection
self._process(client, worker_lb)
# Partial read
if not client.close:
continue
connections.pop(fileno)
# Close
else:
client = connections.pop(fileno)
client.close_socket(shutdown=False)
# cleanup stale connection
for client_id in tuple(connections.keys()):
client = connections[client_id]
if client.stale >= WORKER_STALE_MAX:
connections.pop(client.fileno)
client.close_socket()
else:
client.stale += 1
# Check if worker are running
for worker in self._workers:
if worker.is_alive():
continue
_LOGGER.critical("Worker '%s' crashed!", worker.name)
os.kill(os.getpid(), signal.SIGINT)
def _process(
self,
client: Connection,
workers_lb: Iterator[ServerWorker],
) -> None:
"""Process connection & helo."""
try:
data = client.sock.recv(MAX_READ_SIZE)
except OSError as err:
_LOGGER.warning("Receive fails: %s", err)
client.close_socket(shutdown=False)
return
# No data received
if not data:
client.close_socket()
return
client.buffer += data
# Peer connection
if client.buffer.startswith(b"gA"):
client.soft_close()
next(workers_lb).handover_connection(client.sock, client.buffer)
_LOGGER.debug("Handover new peer connection: %s", client.buffer)
return
# TLS/SSL connection
if client.buffer[0] != 0x16:
_LOGGER.warning("No valid ClientHello found: %s", client.buffer)
client.close_socket()
return
# Get Hostname
try:
hostname = parse_tls_sni(client.buffer)
except ParseSNIIncompleteError:
# Check Buffer Size
if len(client.buffer) >= MAX_BUFFER_SIZE:
_LOGGER.warning("Connection %d exceed buffer size", client.fileno)
client.close_socket()
return
except ParseSNIError:
_LOGGER.warning("Receive invalid ClientHello on public Interface")
client.close_socket()
return
# Distribute to child worker
for worker in self._workers:
if not worker.is_responsible_peer(hostname):
continue
client.soft_close()
worker.handover_connection(client.sock, client.buffer, sni=hostname)
_LOGGER.debug("Handover %s to %s", hostname, worker.name)
return
_LOGGER.debug("No responsible worker for %s", hostname)
client.close_socket()
return
|