Limit maximum number of monitoring sessions in parallel

dormant-user · dormant-user · commit e75e6635e7c8 · 2024-09-07T14:46:32.000-05:00
diff --git a/README.md b/README.md
@@ -61,6 +61,7 @@ pyninja start
 - **MONITOR_USERNAME** - Username to authenticate the monitoring page.
 - **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
 - **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
 - **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
diff --git a/docs/README.html b/docs/README.html
@@ -98,6 +98,7 @@ <h2>Environment Variables<a class="headerlink" href="#environment-variables" tit
 <li><p><strong>MONITOR_USERNAME</strong> - Username to authenticate the monitoring page.</p></li>
 <li><p><strong>MONITOR_PASSWORD</strong> - Password to authenticate the monitoring page.</p></li>
 <li><p><strong>MONITOR_SESSION</strong> - Session timeout for the monitoring page.</p></li>
+<li><p><strong>MAX_CONNECTIONS</strong> - Maximum number of monitoring sessions allowed in parallel.</p></li>
 <li><p><strong>SERVICE_MANAGER</strong> - Service manager filepath to handle the service status requests.</p></li>
 <li><p><strong>DATABASE</strong> - FilePath to store the auth database that handles the authentication errors.</p></li>
 <li><p><strong>RATE_LIMIT</strong> - List of dictionaries with <code class="docutils literal notranslate"><span class="pre">max_requests</span></code> and <code class="docutils literal notranslate"><span class="pre">seconds</span></code> to apply as rate limit.</p></li>
diff --git a/docs/README.md b/docs/README.md
@@ -61,6 +61,7 @@ pyninja start
 - **MONITOR_USERNAME** - Username to authenticate the monitoring page.
 - **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
 - **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
 - **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -61,6 +61,7 @@ pyninja start
 - **MONITOR_USERNAME** - Username to authenticate the monitoring page.
 - **MONITOR_PASSWORD** - Password to authenticate the monitoring page.
 - **MONITOR_SESSION** - Session timeout for the monitoring page.
+- **MAX_CONNECTIONS** - Maximum number of monitoring sessions allowed in parallel.
 - **SERVICE_MANAGER** - Service manager filepath to handle the service status requests.
 - **DATABASE** - FilePath to store the auth database that handles the authentication errors.
 - **RATE_LIMIT** - List of dictionaries with `max_requests` and `seconds` to apply as rate limit.
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -300,6 +300,8 @@ <h2 id="L">L</h2>
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#pyninja.models.EnvConfig.max_connections">max_connections (pyninja.models.EnvConfig attribute)</a>
+</li>
       <li><a href="index.html#pyninja.models.RateLimit.max_requests">max_requests (pyninja.models.RateLimit attribute)</a>
 </li>
       <li><a href="index.html#pyninja.models.WSSession.model_computed_fields">model_computed_fields (pyninja.models.WSSession attribute)</a>
diff --git a/docs/index.html b/docs/index.html
@@ -931,6 +931,11 @@ <h1>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <span class="sig-name descname"><span class="pre">monitor_session</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#pyninja.models.EnvConfig.monitor_session" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.models.EnvConfig.max_connections">
+<span class="sig-name descname"><span class="pre">max_connections</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#pyninja.models.EnvConfig.max_connections" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyninja.models.EnvConfig.service_manager">
 <span class="sig-name descname"><span class="pre">service_manager</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#pyninja.models.ServiceManager" title="pyninja.models.ServiceManager"><span class="pre">ServiceManager</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyninja.models.EnvConfig.service_manager" title="Permalink to this definition">¶</a></dt>
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/pyninja/models.py b/pyninja/models.py
@@ -193,6 +193,7 @@ class EnvConfig(BaseSettings):
     monitor_username: str | None = None
     monitor_password: str | None = None
     monitor_session: PositiveInt = 3_600
+    max_connections: PositiveInt = 3
     service_manager: FilePath | ServiceManager = get_service_manager()
     database: str = Field("auth.db", pattern=".*.db$")
     rate_limit: RateLimit | List[RateLimit] = []
diff --git a/pyninja/monitor/routes.py b/pyninja/monitor/routes.py
@@ -97,6 +97,13 @@ async def monitor_endpoint(request: Request, session_token: str = Cookie(None)):
         HTMLResponse:
         Returns an HTML response templated using Jinja2.
     """
+    # todo: use reverse-proxy to test this from multiple devices
+    # Remove the first hostname from client_auth quietly
+    if len(models.ws_session.client_auth) > models.env.max_connections:
+        first_key = next(iter(models.ws_session.client_auth))
+        # Remove the key-value pair associated with the first authenticated user
+        LOGGER.info("Maximum parallel connections limit reached. Dropping %s", first_key)
+        models.ws_session.client_auth.pop(first_key, None)
     if session_token:
         try:
             await monitor.authenticator.validate_session(
diff --git a/release_notes.rst b/release_notes.rst
@@ -1,6 +1,12 @@
 Release Notes
 =============
 
+v0.0.5 (09/07/2024)
+-------------------
+- Packs an entirely new UI and authentication mechanism for monitoring tool
+- Includes speed, stability and security improvements for monitoring feature
+- Adds night mode option for monitoring UI
+
 v0.0.4 (09/06/2024)
 -------------------
 - Includes an option to monitor system resources via `WebSockets`
