howler-api 4.0.0.dev1084__tar.gz → 4.0.0.dev1088__tar.gz

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1088}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.0.0.dev1084
+Version: 4.0.0.dev1088
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1088}/howler/api/socket.py

@@ -82,6 +82,7 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
     Result Example:
     A continuous websocket connection
     """
+    logger.info("%s: WS connect handler started", ws_id)
     outstanding_actions: list[tuple[str, str, bool]] = []
 
     def send_hit(data: dict[str, Any]):
@@ -105,6 +106,10 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
         ws.send(ws_response("viewers_update", data))
 
     try:
+        logger.debug(
+            "%s: Registering comms listeners: hits, broadcast, action, cases, viewers_update",
+            ws_id,
+        )
         comms_service.on("hits", send_hit)
         comms_service.on("broadcast", send_broadcast)
         comms_service.on("action", send_action)
@@ -114,6 +119,7 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
             data = ws.receive(10)
             if data:
                 obj = json.loads(data)
+                logger.debug("%s: Received message: keys=%s", ws_id, list(obj.keys()))
 
                 if "id" not in obj or "action" not in obj or "broadcast" not in obj:
                     ws.close(
@@ -125,19 +131,22 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
                             message="Sent data is invalid.",
                         ),
                     )
+                    logger.warning("%s: Closed due to invalid payload: %s", ws_id, obj)
                     return
 
                 outstanding_actions = check_action(
                     obj["id"], obj["action"], obj["broadcast"], outstanding_actions=outstanding_actions, **kwargs
                 )
+                logger.debug("%s: Outstanding actions count=%s", ws_id, len(outstanding_actions))
             else:
-                logger.debug(ws_id + " listening")
+                logger.debug("%s listening", ws_id)
     except Exception as e:
         if isinstance(e, ConnectionClosed):
             raise
         else:
-            logger.exception("Exception on connect.")
+            logger.exception("%s: Exception in connect loop", ws_id)
     finally:
+        logger.debug("%s: Deregistering comms listeners", ws_id)
         comms_service.off("hits", send_hit)
         comms_service.off("broadcast", send_broadcast)
         comms_service.off("action", send_action)
@@ -146,3 +155,4 @@ def connect(ws: Server, *args: Any, ws_id: str, **kwargs):  # noqa: C901
 
         for id, action, broadcast in outstanding_actions:
             outstanding_actions = check_action(id, action, broadcast, outstanding_actions=outstanding_actions, **kwargs)
+        logger.info("%s: WS connect handler finished", ws_id)

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1088}/howler/security/socket.py

@@ -1,7 +1,7 @@
 import functools
 import json
 import uuid
-from typing import Optional, cast
+from typing import Any, Optional, cast
 
 from flask import request
 from jwt import InvalidTokenError
@@ -41,9 +41,32 @@ def websocket_auth(required_type: Optional[list[str]] = None, required_priv: Opt
             ws_id = str(uuid.uuid4())
             ws = None
             try:
+                logger.info("%s: Incoming websocket request", ws_id)
+                handshake_ctx: dict[str, Any] = {
+                    "remote_addr": request.environ.get("REMOTE_ADDR"),
+                    "remote_port": request.environ.get("REMOTE_PORT"),
+                    "x_forwarded_for": request.environ.get("HTTP_X_FORWARDED_FOR"),
+                    "x_forwarded_proto": request.environ.get("HTTP_X_FORWARDED_PROTO"),
+                    "host": request.environ.get("HTTP_HOST"),
+                    "connection": request.environ.get("HTTP_CONNECTION"),
+                    "upgrade": request.environ.get("HTTP_UPGRADE"),
+                    "sec_websocket_key": request.environ.get("HTTP_SEC_WEBSOCKET_KEY"),
+                    "sec_websocket_version": request.environ.get("HTTP_SEC_WEBSOCKET_VERSION"),
+                    "sec_websocket_protocol": request.environ.get("HTTP_SEC_WEBSOCKET_PROTOCOL"),
+                    "path_info": request.environ.get("PATH_INFO"),
+                    "request_id": request.environ.get("HTTP_X_REQUEST_ID"),
+                }
+                logger.debug("%s: Websocket request context: %s", ws_id, handshake_ctx)
                 ws = Server(request.environ, ping_interval=5)
+                logger.info("%s: Websocket upgrade established", ws_id)
 
                 auth_header = cast(str, ws.receive())
+                logger.debug(
+                    "%s: Received auth header; bearer_prefix=%s; length=%s",
+                    ws_id,
+                    bool(auth_header and auth_header.strip().lower().startswith("bearer ")),
+                    len(auth_header) if auth_header is not None else 0,
+                )
 
                 user, privs = auth_service.bearer_auth(auth_header)
 
@@ -74,6 +97,7 @@ def websocket_auth(required_type: Optional[list[str]] = None, required_priv: Opt
                         },
                     )
                 )
+                logger.debug("%s: Privileges: %s", ws_id, privs)
 
                 f(ws, *args, ws_id=ws_id, username=user["uname"], privs=privs, **kwargs)
             except ConnectionClosed:
@@ -101,10 +125,11 @@ def websocket_auth(required_type: Optional[list[str]] = None, required_priv: Opt
                     try:
                         ws.close()
                     except Exception as e:
-                        logger.debug("Exception on WS close: %s", str(e))
+                        logger.debug("%s: Exception on WS close: %s", ws_id, str(e))
                     finally:
                         ws.connected = False
 
+                logger.info("%s: Websocket request finished", ws_id)
                 return ok()
 
         return auth

{howler_api-4.0.0.dev1084 → howler_api-4.0.0.dev1088}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "4.0.0.dev1084"
+version = "4.0.0.dev1088"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",