wisp-python 0.4.2__tar.gz → 0.5.0__tar.gz

{wisp_python-0.4.2 → wisp_python-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wisp-python
-Version: 0.4.2
+Version: 0.5.0
 Summary: An implementation of a Wisp proxy server in Python
 Author: ading2210
 Project-URL: Homepage, https://github.com/MercuryWorkshop/wisp-server-python
@@ -38,8 +38,9 @@ pip3 install wisp-python
 To start the server, run `python3 -m wisp.server`. The program accepts the following arguments:
 ```
 usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private]
+                          [--log-level LOG_LEVEL]
 
-A Wisp server implementation, written in Python (v0.4.1)
+A Wisp server implementation, written in Python (v0.5.0)
 
 options:
   -h, --help            show this help message and exit
@@ -54,6 +55,8 @@ options:
   --window WINDOW       Fixed window length for rate limits, in seconds.
   --allow-loopback      Allow connections to loopback IP addresses.
   --allow-private       Allow connections to private IP addresses.
+  --log-level LOG_LEVEL
+                        The log level (either debug, info, warning, error, or critical).
 ```
 
 ## Roadmap:

{wisp_python-0.4.2 → wisp_python-0.5.0}/README.md

@@ -21,8 +21,9 @@ pip3 install wisp-python
 To start the server, run `python3 -m wisp.server`. The program accepts the following arguments:
 ```
 usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private]
+                          [--log-level LOG_LEVEL]
 
-A Wisp server implementation, written in Python (v0.4.1)
+A Wisp server implementation, written in Python (v0.5.0)
 
 options:
   -h, --help            show this help message and exit
@@ -37,6 +38,8 @@ options:
   --window WINDOW       Fixed window length for rate limits, in seconds.
   --allow-loopback      Allow connections to loopback IP addresses.
   --allow-private       Allow connections to private IP addresses.
+  --log-level LOG_LEVEL
+                        The log level (either debug, info, warning, error, or critical).
 ```
 
 ## Roadmap:

{wisp_python-0.4.2 → wisp_python-0.5.0}/pyproject.toml

@@ -11,7 +11,7 @@ package-dir = {"" = "src"}
 
 [project]
 name = "wisp-python"
-version = "0.4.2"
+version = "0.5.0"
 authors = [
   {name="ading2210"},
 ]

{wisp_python-0.4.2 → wisp_python-0.5.0}/src/wisp/__init__.py

@@ -1,3 +1,2 @@
 from wisp import server
-
-version = "0.4.2"
+version = "0.5.0"

{wisp_python-0.4.2 → wisp_python-0.5.0}/src/wisp/server/__main__.py

@@ -1,5 +1,7 @@
 import argparse
 import asyncio
+import logging
+
 try:
   import uvloop
   use_uvloop = True
@@ -24,10 +26,17 @@ if __name__ == "__main__":
   parser.add_argument("--window", default=60, help="Fixed window length for rate limits, in seconds.")
   parser.add_argument("--allow-loopback", action="store_true",help="Allow connections to loopback IP addresses.")
   parser.add_argument("--allow-private", action="store_true", help="Allow connections to private IP addresses.")
+  parser.add_argument("--log-level", default="info", help="The log level (either debug, info, warning, error, or critical).")
   args = parser.parse_args()
 
+  logging.basicConfig(
+    format="[%(asctime)s] %(levelname)-8s %(message)s",
+    level=getattr(logging, args.log_level.upper()),
+    datefmt="%Y/%m/%d - %H:%M:%S"
+  )
+
   if use_uvloop:
     uvloop.run(wisp.server.http.main(args))
   else:
-    print("Warning: Importing uvloop failed. Falling back to asyncio, which is slower.")
+    logging.error("Importing uvloop failed. Falling back to asyncio, which is slower.")
     asyncio.run(wisp.server.http.main(args))

{wisp_python-0.4.2 → wisp_python-0.5.0}/src/wisp/server/connection.py

@@ -1,6 +1,7 @@
 import asyncio
 import struct
 import os
+import logging
 
 from websockets.exceptions import ConnectionClosed
 
@@ -32,7 +33,7 @@ class WSProxyConnection:
       self.conn = net.TCPConnection(self.tcp_host, self.tcp_port)
       await self.conn.connect()
     except Exception as e:
-      print(f"Creating a WSProxy stream to {self.tcp_host}:{self.tcp_port} failed: {e}")
+      logging.info(f"Creating a WSProxy stream to {self.tcp_host}:{self.tcp_port} failed: {e}")
       await self.ws.close()
 
   async def handle_ws(self):
@@ -59,11 +60,12 @@ class WSProxyConnection:
     await self.ws.close()
 
 class WispConnection:
-  def __init__(self, ws, path, client_ip):
+  def __init__(self, ws, path, client_ip, id=None):
     self.ws = ws
     self.path = path
     self.active_streams = {}
     self.client_ip = client_ip
+    self.id = id
   
   #send the initial CONTINUE packet
   async def setup(self):
@@ -74,6 +76,7 @@ class WispConnection:
   async def new_stream(self, stream_id, payload):
     stream_type, destination_port = struct.unpack(connect_format, payload[:3])
     hostname = payload[3:].decode()
+    logging.debug(f"({self.id}) Creating a new stream to {hostname}:{destination_port}")
 
     #rate limited
     stream_count = ratelimit.get_client_attr(self.client_ip, "streams")
@@ -94,7 +97,7 @@ class WispConnection:
       await connection.connect()
         
     except Exception as e:
-      print(f"Creating a new stream to {hostname}:{destination_port} failed: {e}")
+      logging.warn(f"({self.id}) Creating a new stream to {hostname}:{destination_port} failed: {e}")
       await self.send_close_packet(stream_id, 0x42)
       self.close_stream(stream_id)
       return
@@ -112,7 +115,7 @@ class WispConnection:
       await target_func(*args, **kwargs)
     except asyncio.CancelledError as e:
       raise e
-  
+        
   async def stream_ws_to_tcp(self, stream_id):
     #this infinite loop should get killed by the task.cancel call later on
     while True: 
@@ -137,7 +140,7 @@ class WispConnection:
       try:
         data = await stream["conn"].recv()
       except Exception as e:
-        print(f"Receiving data from stream failed: {e}")
+        logging.warn(f"({self.id}) Receiving data from stream failed: {e}")
         await self.send_close_packet(stream_id, 0x03)
         self.close_stream(stream_id)
         return
@@ -163,7 +166,8 @@ class WispConnection:
     if not stream_id in self.active_streams:
       return #stream already closed
     stream = self.active_streams[stream_id]
-    stream["conn"].close()
+    if stream["conn"]:
+      stream["conn"].close()
 
     #kill the running tasks associated with this stream
     if not stream["connect_task"].done():
@@ -181,6 +185,12 @@ class WispConnection:
         data = await self.ws.recv()
       except ConnectionClosed:
         break
+      except Exception as e:
+        logging.warn(f"({self.id}) Receiving data from websocket failed: {e}")
+        break
+
+      if not isinstance(data, bytes): 
+        continue #ignore non binary frames
       
       #implement bandwidth limits
       await ratelimit.limit_client_bandwidth(self.client_ip, len(data), "ws")

{wisp_python-0.4.2 → wisp_python-0.5.0}/src/wisp/server/http.py

@@ -1,6 +1,8 @@
 import asyncio
 import pathlib
 import mimetypes
+import logging
+import random
 
 from websockets.server import serve
 
@@ -14,11 +16,12 @@ async def connection_handler(websocket, path):
   if client_ip == "127.0.0.1" and "X-Real-IP" in websocket.request_headers:
     client_ip = websocket.request_headers["X-Real-IP"]
 
-  print(f"incoming connection on {path} from {client_ip}")
+  conn_id = "".join(random.choices("1234567890abcdef", k=8))
+  logging.info(f"({conn_id}) incoming connection on {path} from {client_ip}")
   ratelimit.inc_client_attr(client_ip, "streams")
 
   if path.endswith("/"):
-    wisp_conn = connection.WispConnection(websocket, path, client_ip)
+    wisp_conn = connection.WispConnection(websocket, path, client_ip, conn_id)
     await wisp_conn.setup()
     ws_handler = asyncio.create_task(wisp_conn.handle_ws()) 
     await asyncio.gather(ws_handler)
@@ -57,18 +60,18 @@ async def static_handler(path, request_headers):
 
 async def main(args):
   global static_path
-  print(f"running wisp-server-python v{wisp.version}")
+  logging.info(f"running wisp-server-python v{wisp.version}")
 
   if args.static:
     static_path = pathlib.Path(args.static).resolve()
     request_handler = static_handler
     mimetypes.init()
-    print(f"serving static files from {static_path}")
+    logging.info(f"serving static files from {static_path}")
   else:
     request_handler = None
   
   if args.limits:
-    print("enabled rate limits")
+    logging.info("enabled rate limits")
     ratelimit.enabled = True
     ratelimit.connections_limit = int(args.connections)
     ratelimit.bandwidth_limit = float(args.bandwidth)
@@ -78,6 +81,10 @@ async def main(args):
   net.block_private = not args.allow_private
       
   limit_task = asyncio.create_task(ratelimit.reset_limits_timer())
-  print(f"listening on {args.host}:{args.port}")
+  logging.info(f"listening on {args.host}:{args.port}")
+
+  ws_logger = logging.getLogger("websockets")
+  ws_logger.setLevel(logging.WARN)
+
   async with serve(connection_handler, args.host, int(args.port), process_request=request_handler, compression=None):
     await asyncio.Future()

{wisp_python-0.4.2 → wisp_python-0.5.0}/src/wisp_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wisp-python
-Version: 0.4.2
+Version: 0.5.0
 Summary: An implementation of a Wisp proxy server in Python
 Author: ading2210
 Project-URL: Homepage, https://github.com/MercuryWorkshop/wisp-server-python
@@ -38,8 +38,9 @@ pip3 install wisp-python
 To start the server, run `python3 -m wisp.server`. The program accepts the following arguments:
 ```
 usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private]
+                          [--log-level LOG_LEVEL]
 
-A Wisp server implementation, written in Python (v0.4.1)
+A Wisp server implementation, written in Python (v0.5.0)
 
 options:
   -h, --help            show this help message and exit
@@ -54,6 +55,8 @@ options:
   --window WINDOW       Fixed window length for rate limits, in seconds.
   --allow-loopback      Allow connections to loopback IP addresses.
   --allow-private       Allow connections to private IP addresses.
+  --log-level LOG_LEVEL
+                        The log level (either debug, info, warning, error, or critical).
 ```
 
 ## Roadmap: