diff options
| author | 2024-03-20 21:48:45 +0100 | |
|---|---|---|
| committer | 2024-03-20 21:48:45 +0100 | |
| commit | 486087cdb349dbc07b479d2286a02bdca310ea38 (patch) | |
| tree | 43f7baed542a1bc819884ddeebc6e15dfcbd42b0 /ttun_server | |
| parent | 53a8f300859a50d9f99f1821c35bca999fced6d8 (diff) | |
| download | server-486087cdb349dbc07b479d2286a02bdca310ea38.tar.gz server-486087cdb349dbc07b479d2286a02bdca310ea38.tar.bz2 server-486087cdb349dbc07b479d2286a02bdca310ea38.zip | |
Added websocket support
Diffstat (limited to 'ttun_server')
| -rw-r--r-- | ttun_server/__init__.py | 4 | ||||
| -rw-r--r-- | ttun_server/endpoints.py | 75 | ||||
| -rw-r--r-- | ttun_server/proxy_queue.py | 1 | ||||
| -rw-r--r-- | ttun_server/redis.py | 7 | ||||
| -rw-r--r-- | ttun_server/types.py | 51 | ||||
| -rw-r--r-- | ttun_server/websockets.py | 179 |
6 files changed, 236 insertions, 81 deletions
diff --git a/ttun_server/__init__.py b/ttun_server/__init__.py index 81f8cd4..2f8fed0 100644 --- a/ttun_server/__init__.py +++ b/ttun_server/__init__.py | |||
| @@ -4,7 +4,8 @@ import os | |||
| 4 | from starlette.applications import Starlette | 4 | from starlette.applications import Starlette |
| 5 | from starlette.routing import Route, WebSocketRoute, Host, Router | 5 | from starlette.routing import Route, WebSocketRoute, Host, Router |
| 6 | 6 | ||
| 7 | from ttun_server.endpoints import Proxy, Tunnel, Health | 7 | from ttun_server.endpoints import Proxy, Health |
| 8 | from .websockets import WebsocketProxy, Tunnel | ||
| 8 | 9 | ||
| 9 | logging.basicConfig(level=getattr(logging, os.environ.get('LOG_LEVEL', 'INFO'))) | 10 | logging.basicConfig(level=getattr(logging, os.environ.get('LOG_LEVEL', 'INFO'))) |
| 10 | 11 | ||
| @@ -18,6 +19,7 @@ server = Starlette( | |||
| 18 | routes=[ | 19 | routes=[ |
| 19 | Host(os.environ['TUNNEL_DOMAIN'], base_router, 'base'), | 20 | Host(os.environ['TUNNEL_DOMAIN'], base_router, 'base'), |
| 20 | Route('/{path:path}', Proxy), | 21 | Route('/{path:path}', Proxy), |
| 22 | WebSocketRoute('/{path:path}', WebsocketProxy) | ||
| 21 | ] | 23 | ] |
| 22 | ) | 24 | ) |
| 23 | 25 | ||
diff --git a/ttun_server/endpoints.py b/ttun_server/endpoints.py index 3e263da..eae0ebe 100644 --- a/ttun_server/endpoints.py +++ b/ttun_server/endpoints.py | |||
| @@ -1,20 +1,13 @@ | |||
| 1 | import asyncio | ||
| 2 | import logging | 1 | import logging |
| 3 | import os | ||
| 4 | from asyncio import create_task | ||
| 5 | from base64 import b64decode, b64encode | 2 | from base64 import b64decode, b64encode |
| 6 | from typing import Optional, Any | ||
| 7 | from uuid import uuid4 | 3 | from uuid import uuid4 |
| 8 | 4 | ||
| 9 | from starlette.endpoints import HTTPEndpoint, WebSocketEndpoint | 5 | from starlette.endpoints import HTTPEndpoint |
| 10 | from starlette.requests import Request | 6 | from starlette.requests import Request |
| 11 | from starlette.responses import Response | 7 | from starlette.responses import Response |
| 12 | from starlette.types import Scope, Receive, Send | ||
| 13 | from starlette.websockets import WebSocket | ||
| 14 | 8 | ||
| 15 | import ttun_server | ||
| 16 | from ttun_server.proxy_queue import ProxyQueue | 9 | from ttun_server.proxy_queue import ProxyQueue |
| 17 | from ttun_server.types import RequestData, Config, Message, MessageType | 10 | from ttun_server.types import HttpRequestData, Message, HttpMessageType, HttpMessage |
| 18 | 11 | ||
| 19 | logger = logging.getLogger(__name__) | 12 | logger = logging.getLogger(__name__) |
| 20 | 13 | ||
| @@ -44,11 +37,11 @@ class Proxy(HTTPEndpoint): | |||
| 44 | 37 | ||
| 45 | logger.debug('PROXY %s%s ', subdomain, request.url) | 38 | logger.debug('PROXY %s%s ', subdomain, request.url) |
| 46 | await request_queue.enqueue( | 39 | await request_queue.enqueue( |
| 47 | Message( | 40 | HttpMessage( |
| 48 | type=MessageType.request.value, | 41 | type=HttpMessageType.request.value, |
| 49 | identifier=identifier, | 42 | identifier=identifier, |
| 50 | payload= | 43 | payload= |
| 51 | RequestData( | 44 | HttpRequestData( |
| 52 | method=request.method, | 45 | method=request.method, |
| 53 | path=str(request.url).replace(str(request.base_url), '/'), | 46 | path=str(request.url).replace(str(request.base_url), '/'), |
| 54 | headers=list(request.headers.items()), | 47 | headers=list(request.headers.items()), |
| @@ -78,61 +71,3 @@ class Health(HTTPEndpoint): | |||
| 78 | await response(self.scope, self.receive, self.send) | 71 | await response(self.scope, self.receive, self.send) |
| 79 | 72 | ||
| 80 | 73 | ||
| 81 | class Tunnel(WebSocketEndpoint): | ||
| 82 | encoding = 'json' | ||
| 83 | |||
| 84 | def __init__(self, scope: Scope, receive: Receive, send: Send): | ||
| 85 | super().__init__(scope, receive, send) | ||
| 86 | self.request_task = None | ||
| 87 | self.config: Optional[Config] = None | ||
| 88 | |||
| 89 | async def handle_requests(self, websocket: WebSocket): | ||
| 90 | while request := await self.proxy_queue.dequeue(): | ||
| 91 | create_task(websocket.send_json(request)) | ||
| 92 | |||
| 93 | async def on_connect(self, websocket: WebSocket) -> None: | ||
| 94 | await websocket.accept() | ||
| 95 | self.config = await websocket.receive_json() | ||
| 96 | |||
| 97 | client_version = self.config.get('version', '1.0.0') | ||
| 98 | logger.debug('client_version %s', client_version) | ||
| 99 | |||
| 100 | if 'git' not in client_version and ttun_server.__version__ != 'development': | ||
| 101 | [client_major, *_] = [int(i) for i in client_version.split('.')[:3]] | ||
| 102 | [server_major, *_] = [int(i) for i in ttun_server.__version__.split('.')] | ||
| 103 | |||
| 104 | if client_major < server_major: | ||
| 105 | await websocket.close(4000, 'Your client is too old') | ||
| 106 | |||
| 107 | if client_major > server_major: | ||
| 108 | await websocket.close(4001, 'Your client is too new') | ||
| 109 | |||
| 110 | |||
| 111 | if self.config['subdomain'] is None \ | ||
| 112 | or await ProxyQueue.has_connection(self.config['subdomain']): | ||
| 113 | self.config['subdomain'] = uuid4().hex | ||
| 114 | |||
| 115 | |||
| 116 | self.proxy_queue = await ProxyQueue.create_for_identifier(self.config['subdomain']) | ||
| 117 | |||
| 118 | hostname = os.environ.get("TUNNEL_DOMAIN") | ||
| 119 | protocol = "https" if os.environ.get("SECURE", False) else "http" | ||
| 120 | |||
| 121 | await websocket.send_json({ | ||
| 122 | 'url': f'{protocol}://{self.config["subdomain"]}.{hostname}' | ||
| 123 | }) | ||
| 124 | |||
| 125 | self.request_task = asyncio.create_task(self.handle_requests(websocket)) | ||
| 126 | |||
| 127 | async def on_receive(self, websocket: WebSocket, data: Message): | ||
| 128 | try: | ||
| 129 | response_queue = await ProxyQueue.get_for_identifier(f"{self.config['subdomain']}_{data['identifier']}") | ||
| 130 | await response_queue.enqueue(data) | ||
| 131 | except AssertionError: | ||
| 132 | pass | ||
| 133 | |||
| 134 | async def on_disconnect(self, websocket: WebSocket, close_code: int): | ||
| 135 | await self.proxy_queue.delete() | ||
| 136 | |||
| 137 | if self.request_task is not None: | ||
| 138 | self.request_task.cancel() | ||
diff --git a/ttun_server/proxy_queue.py b/ttun_server/proxy_queue.py index e521886..c6c8067 100644 --- a/ttun_server/proxy_queue.py +++ b/ttun_server/proxy_queue.py | |||
| @@ -2,6 +2,7 @@ import asyncio | |||
| 2 | import json | 2 | import json |
| 3 | import logging | 3 | import logging |
| 4 | import os | 4 | import os |
| 5 | import traceback | ||
| 5 | from typing import Type | 6 | from typing import Type |
| 6 | 7 | ||
| 7 | from ttun_server.redis import RedisConnectionPool | 8 | from ttun_server.redis import RedisConnectionPool |
diff --git a/ttun_server/redis.py b/ttun_server/redis.py index 3065dec..18fbca2 100644 --- a/ttun_server/redis.py +++ b/ttun_server/redis.py | |||
| @@ -1,6 +1,8 @@ | |||
| 1 | import asyncio | ||
| 1 | import os | 2 | import os |
| 3 | from asyncio import get_running_loop | ||
| 2 | 4 | ||
| 3 | from aioredis import ConnectionPool, Redis | 5 | from redis.asyncio import ConnectionPool, Redis |
| 4 | 6 | ||
| 5 | 7 | ||
| 6 | class RedisConnectionPool: | 8 | class RedisConnectionPool: |
| @@ -9,9 +11,6 @@ class RedisConnectionPool: | |||
| 9 | def __init__(self): | 11 | def __init__(self): |
| 10 | self.pool = ConnectionPool.from_url(os.environ.get('REDIS_URL')) | 12 | self.pool = ConnectionPool.from_url(os.environ.get('REDIS_URL')) |
| 11 | 13 | ||
| 12 | def __del__(self): | ||
| 13 | self.pool.disconnect() | ||
| 14 | |||
| 15 | @classmethod | 14 | @classmethod |
| 16 | def get_connection(cls) -> Redis: | 15 | def get_connection(cls) -> Redis: |
| 17 | if cls.instance is None: | 16 | if cls.instance is None: |
diff --git a/ttun_server/types.py b/ttun_server/types.py index 8a4d929..8591e7d 100644 --- a/ttun_server/types.py +++ b/ttun_server/types.py | |||
| @@ -3,7 +3,7 @@ from enum import Enum | |||
| 3 | from typing import TypedDict, Optional | 3 | from typing import TypedDict, Optional |
| 4 | 4 | ||
| 5 | 5 | ||
| 6 | class MessageType(Enum): | 6 | class HttpMessageType(Enum): |
| 7 | request = 'request' | 7 | request = 'request' |
| 8 | response = 'response' | 8 | response = 'response' |
| 9 | 9 | ||
| @@ -13,23 +13,62 @@ class Config(TypedDict): | |||
| 13 | client_version: str | 13 | client_version: str |
| 14 | 14 | ||
| 15 | 15 | ||
| 16 | class RequestData(TypedDict): | 16 | class HttpRequestData(TypedDict): |
| 17 | method: str | 17 | method: str |
| 18 | path: str | 18 | path: str |
| 19 | headers: list[tuple[str, str]] | 19 | headers: list[tuple[str, str]] |
| 20 | body: Optional[str] | 20 | body: Optional[str] |
| 21 | 21 | ||
| 22 | 22 | ||
| 23 | class ResponseData(TypedDict): | 23 | class HttpResponseData(TypedDict): |
| 24 | status: int | 24 | status: int |
| 25 | headers: list[tuple[str, str]] | 25 | headers: list[tuple[str, str]] |
| 26 | body: Optional[str] | 26 | body: Optional[str] |
| 27 | 27 | ||
| 28 | 28 | ||
| 29 | class Message(TypedDict): | 29 | class HttpMessage(TypedDict): |
| 30 | type: MessageType | 30 | type: HttpMessageType |
| 31 | identifier: str | 31 | identifier: str |
| 32 | payload: Config | RequestData | ResponseData | 32 | payload: Config | HttpRequestData | HttpResponseData |
| 33 | |||
| 34 | |||
| 35 | class WebsocketMessageType(Enum): | ||
| 36 | connect = 'connect' | ||
| 37 | disconnect = 'disconnect' | ||
| 38 | message = 'message' | ||
| 39 | ack = 'ack' | ||
| 40 | |||
| 41 | |||
| 42 | class WebsocketConnectData(TypedDict): | ||
| 43 | path: str | ||
| 44 | headers: list[tuple[str, str]] | ||
| 45 | |||
| 46 | |||
| 47 | class WebsocketDisconnectData(TypedDict): | ||
| 48 | close_code: int | ||
| 49 | |||
| 50 | |||
| 51 | class WebsocketMessageData(TypedDict): | ||
| 52 | body: Optional[str] | ||
| 53 | |||
| 54 | |||
| 55 | class WebsocketMessage(TypedDict): | ||
| 56 | type: WebsocketMessageType | ||
| 57 | identifier: str | ||
| 58 | payload: WebsocketConnectData | WebsocketDisconnectData | WebsocketMessageData | ||
| 59 | |||
| 60 | |||
| 61 | class MessageType(Enum): | ||
| 62 | request = 'request' | ||
| 63 | response = 'response' | ||
| 64 | |||
| 65 | ws_connect = 'connect' | ||
| 66 | ws_disconnect = 'disconnect' | ||
| 67 | ws_message = 'message' | ||
| 68 | ws_ack = 'ack' | ||
| 69 | |||
| 70 | |||
| 71 | Message = HttpMessage | WebsocketMessage | ||
| 33 | 72 | ||
| 34 | 73 | ||
| 35 | class MemoryConnection(TypedDict): | 74 | class MemoryConnection(TypedDict): |
diff --git a/ttun_server/websockets.py b/ttun_server/websockets.py new file mode 100644 index 0000000..0800cbc --- /dev/null +++ b/ttun_server/websockets.py | |||
| @@ -0,0 +1,179 @@ | |||
| 1 | import asyncio | ||
| 2 | import json | ||
| 3 | import logging | ||
| 4 | import os | ||
| 5 | import typing | ||
| 6 | from asyncio import create_task | ||
| 7 | from base64 import b64encode, b64decode | ||
| 8 | from contextlib import asynccontextmanager | ||
| 9 | from typing import Optional | ||
| 10 | from uuid import uuid4 | ||
| 11 | |||
| 12 | from starlette.endpoints import WebSocketEndpoint | ||
| 13 | from starlette.types import Scope, Receive, Send | ||
| 14 | from starlette.websockets import WebSocket | ||
| 15 | |||
| 16 | import ttun_server | ||
| 17 | from ttun_server.proxy_queue import ProxyQueue | ||
| 18 | from ttun_server.types import Config, Message, WebsocketMessageType, \ | ||
| 19 | WebsocketConnectData, WebsocketMessage, WebsocketMessageData, WebsocketDisconnectData, MessageType | ||
| 20 | |||
| 21 | logger = logging.getLogger(__name__) | ||
| 22 | logger.setLevel('DEBUG') | ||
| 23 | |||
| 24 | class WebsocketProxy(WebSocketEndpoint): | ||
| 25 | encoding = 'json' | ||
| 26 | websocket_listen_task = None | ||
| 27 | |||
| 28 | def __init__(self, *args, **kwargs): | ||
| 29 | super().__init__(*args, **kwargs) | ||
| 30 | self.id = str(uuid4()) | ||
| 31 | |||
| 32 | @asynccontextmanager | ||
| 33 | async def proxy(self, websocket: WebSocket, message: WebsocketMessage): | ||
| 34 | [subdomain, *_] = websocket.url.hostname.split('.') | ||
| 35 | |||
| 36 | expect_ack = WebsocketMessageType(message['type']) == WebsocketMessageType.connect | ||
| 37 | |||
| 38 | try: | ||
| 39 | request_queue = await ProxyQueue.get_for_identifier(subdomain) | ||
| 40 | await request_queue.enqueue(message) | ||
| 41 | |||
| 42 | if expect_ack: | ||
| 43 | response_queue = await ProxyQueue.create_for_identifier(f'{subdomain}_{message["identifier"]}') | ||
| 44 | yield await response_queue.dequeue() | ||
| 45 | await response_queue.delete() | ||
| 46 | else: | ||
| 47 | yield | ||
| 48 | except AssertionError: | ||
| 49 | pass | ||
| 50 | |||
| 51 | async def listen_for_messages(self, websocket: WebSocket): | ||
| 52 | [subdomain, *_] = websocket.url.hostname.split('.') | ||
| 53 | |||
| 54 | print('listen', self.id) | ||
| 55 | response_queue = await ProxyQueue.create_for_identifier(f'{subdomain}_{self.id}') | ||
| 56 | |||
| 57 | while True: | ||
| 58 | message: WebsocketMessage = await response_queue.dequeue() | ||
| 59 | logger.debug(message) | ||
| 60 | await websocket.send_text(b64decode(message['payload']['body'].encode()).decode()) | ||
| 61 | |||
| 62 | async def on_connect(self, websocket: WebSocket) -> None: | ||
| 63 | message = WebsocketMessage( | ||
| 64 | type=WebsocketMessageType.connect.value, | ||
| 65 | identifier=self.id, | ||
| 66 | payload=WebsocketConnectData( | ||
| 67 | path=websocket.path_params['path'], | ||
| 68 | headers=[ | ||
| 69 | (k.decode(), v.decode()) | ||
| 70 | for k, v | ||
| 71 | in websocket.scope['headers'] | ||
| 72 | ], | ||
| 73 | ) | ||
| 74 | ) | ||
| 75 | |||
| 76 | async with self.proxy(websocket, message) as m: | ||
| 77 | type = WebsocketMessageType(m['type']) | ||
| 78 | |||
| 79 | if type == WebsocketMessageType.ack: | ||
| 80 | await super().on_connect(websocket) | ||
| 81 | |||
| 82 | self.websocket_listen_task = asyncio.create_task(self.listen_for_messages(websocket)) | ||
| 83 | |||
| 84 | def callback(*args, **kwargs): | ||
| 85 | self.websocket_listen_task = None | ||
| 86 | |||
| 87 | self.websocket_listen_task.add_done_callback(callback) | ||
| 88 | |||
| 89 | async def on_receive(self, websocket: WebSocket, data: typing.Any) -> None: | ||
| 90 | match data: | ||
| 91 | case dict(): | ||
| 92 | data_bytes = json.dumps(data).encode() | ||
| 93 | case bytes(): | ||
| 94 | data_bytes = data | ||
| 95 | case _: | ||
| 96 | data_bytes = data.encode() | ||
| 97 | |||
| 98 | message = WebsocketMessage( | ||
| 99 | type=WebsocketMessageType.message.value, | ||
| 100 | identifier=self.id, | ||
| 101 | payload=WebsocketMessageData( | ||
| 102 | body=b64encode(data_bytes).decode(), | ||
| 103 | ) | ||
| 104 | ) | ||
| 105 | |||
| 106 | async with self.proxy(websocket, message): | ||
| 107 | pass | ||
| 108 | |||
| 109 | async def on_disconnect(self, websocket: WebSocket, close_code: int) -> None: | ||
| 110 | message = WebsocketMessage( | ||
| 111 | type=WebsocketMessageType.disconnect.value, | ||
| 112 | identifier=self.id, | ||
| 113 | payload=WebsocketDisconnectData( | ||
| 114 | close_code=close_code, | ||
| 115 | ) | ||
| 116 | ) | ||
| 117 | |||
| 118 | async with self.proxy(websocket, message): | ||
| 119 | if self.websocket_listen_task is not None: | ||
| 120 | self.websocket_listen_task.cancel() | ||
| 121 | |||
| 122 | class Tunnel(WebSocketEndpoint): | ||
| 123 | encoding = 'json' | ||
| 124 | |||
| 125 | def __init__(self, scope: Scope, receive: Receive, send: Send): | ||
| 126 | super().__init__(scope, receive, send) | ||
| 127 | self.request_task = None | ||
| 128 | self.config: Optional[Config] = None | ||
| 129 | |||
| 130 | async def handle_requests(self, websocket: WebSocket): | ||
| 131 | while request := await self.proxy_queue.dequeue(): | ||
| 132 | create_task(websocket.send_json(request)) | ||
| 133 | |||
| 134 | async def on_connect(self, websocket: WebSocket) -> None: | ||
| 135 | await websocket.accept() | ||
| 136 | self.config = await websocket.receive_json() | ||
| 137 | |||
| 138 | client_version = self.config.get('version', '1.0.0') | ||
| 139 | logger.debug('client_version %s', client_version) | ||
| 140 | |||
| 141 | if 'git' not in client_version and ttun_server.__version__ != 'development': | ||
| 142 | [client_major, *_] = [int(i) for i in client_version.split('.')[:3]] | ||
| 143 | [server_major, *_] = [int(i) for i in ttun_server.__version__.split('.')] | ||
| 144 | |||
| 145 | if client_major < server_major: | ||
| 146 | await websocket.close(4000, 'Your client is too old') | ||
| 147 | |||
| 148 | if client_major > server_major: | ||
| 149 | await websocket.close(4001, 'Your client is too new') | ||
| 150 | |||
| 151 | |||
| 152 | if self.config['subdomain'] is None \ | ||
| 153 | or await ProxyQueue.has_connection(self.config['subdomain']): | ||
| 154 | self.config['subdomain'] = uuid4().hex | ||
| 155 | |||
| 156 | |||
| 157 | self.proxy_queue = await ProxyQueue.create_for_identifier(self.config['subdomain']) | ||
| 158 | |||
| 159 | hostname = os.environ.get("TUNNEL_DOMAIN") | ||
| 160 | protocol = "https" if os.environ.get("SECURE", False) else "http" | ||
| 161 | |||
| 162 | await websocket.send_json({ | ||
| 163 | 'url': f'{protocol}://{self.config["subdomain"]}.{hostname}' | ||
| 164 | }) | ||
| 165 | |||
| 166 | self.request_task = asyncio.create_task(self.handle_requests(websocket)) | ||
| 167 | |||
| 168 | async def on_receive(self, websocket: WebSocket, data: Message): | ||
| 169 | try: | ||
| 170 | response_queue = await ProxyQueue.get_for_identifier(f"{self.config['subdomain']}_{data['identifier']}") | ||
| 171 | await response_queue.enqueue(data) | ||
| 172 | except AssertionError: | ||
| 173 | pass | ||
| 174 | |||
| 175 | async def on_disconnect(self, websocket: WebSocket, close_code: int): | ||
| 176 | await self.proxy_queue.delete() | ||
| 177 | |||
| 178 | if self.request_task is not None: | ||
| 179 | self.request_task.cancel() | ||
