Add logo, fix ruff findings.

double16 · double16 · commit 6259b8b9db71 · 2025-08-23T07:02:18.000-05:00
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # shyhurricane
 
+<img src="shyhurricane/assets/shyhurricane.png" alt="Hurricane picking padlock logo" width="150" style="float: left; margin-right:10px;" />
+
 ShyHurricane is an MCP server to assist AI in offensive security testing. It aims to solve a few problems observed with
 AI using a single tool to execute commands:
 
diff --git a/shyhurricane/assets/favicon.ico b/shyhurricane/assets/favicon.ico
diff --git a/shyhurricane/assets/shyhurricane.jpg b/shyhurricane/assets/shyhurricane.jpg
diff --git a/shyhurricane/assets/shyhurricane.png b/shyhurricane/assets/shyhurricane.png
diff --git a/shyhurricane/cleaners.py b/shyhurricane/cleaners.py
@@ -1,8 +1,9 @@
 import json
 import logging
+import re
 
 from lxml import etree
-import re, html
+import html
 from bs4 import BeautifulSoup, Doctype
 from collections import OrderedDict
 import json5
diff --git a/shyhurricane/http_csv.py b/shyhurricane/http_csv.py
@@ -77,7 +77,7 @@ def http_csv_generator(iterable) -> Generator[IngestableRequestResponse, None, N
                     pass
                 continue
 
-            if url is None and '://' in column and not '\n' in column:
+            if url is None and '://' in column and '\n' not in column:
                 try:
                     urlparse_ext(column)
                     url = column.strip()
diff --git a/shyhurricane/mcp_server/__init__.py b/shyhurricane/mcp_server/__init__.py
@@ -16,7 +16,6 @@
 from mcp.types import INVALID_REQUEST, Tool
 from pydantic import ValidationError, Field
 
-import shyhurricane.mcp_server.server_context
 from shyhurricane.mcp_server.app_context import AppContext
 from shyhurricane.server_config import get_server_config
 from shyhurricane.mcp_server.server_context import get_server_context, ServerContext
@@ -124,7 +123,7 @@ async def list_tools(self) -> list[Tool]:
         if not self.open_world:
             logger.info("Filtering tools for open_world = False")
             tools = list(
-                filter(lambda tool: tool.annotations is not None and tool.annotations.openWorldHint == False, tools))
+                filter(lambda tool: tool.annotations is not None and tool.annotations.openWorldHint == False, tools))  # noqa: E712
         return tools
 
 
@@ -167,7 +166,7 @@ def get_additional_hosts(ctx: Context, additional_hosts: Dict[str, str] = None)
     validated: Dict[str, str] = {}
     for host, ip in (additional_hosts or {}).items():
         try:
-            if validators.domain(host) == True and ipaddress.ip_address(ip):
+            if validators.domain(host) == True and ipaddress.ip_address(ip):  # noqa: E712
                 validated[host] = ip
                 cached_get_additional_hosts[host] = ip
         except (ValueError, ValidationError):
diff --git a/shyhurricane/mcp_server/encoder_decoder_impl.py b/shyhurricane/mcp_server/encoder_decoder_impl.py
@@ -1,4 +1,3 @@
-import re
 from typing import List
 
 from base64 import b64encode, b64decode
diff --git a/shyhurricane/mcp_server/tools/encoder_decoder.py b/shyhurricane/mcp_server/tools/encoder_decoder.py
@@ -3,7 +3,7 @@
 from pydantic import BaseModel, Field
 from mcp.server.fastmcp import Context
 from mcp.types import ToolAnnotations
-from shyhurricane.mcp_server import mcp_instance, log_tool_history, get_server_context
+from shyhurricane.mcp_server import mcp_instance, log_tool_history
 from shyhurricane.mcp_server.encoder_decoder_impl import do_encode_decode
 
 
diff --git a/shyhurricane/mcp_server/tools/find_web_resources.py b/shyhurricane/mcp_server/tools/find_web_resources.py
@@ -331,7 +331,7 @@ async def determine_targets(target_query: str):
             logger.info("Asking user for URL(s)")
             assert_elicitation(server_ctx)
             target_elicit_result = await ctx.elicit(
-                message=f"What URL(s) should we look for?", schema=RequestTargetUrl
+                message="What URL(s) should we look for?", schema=RequestTargetUrl
             )
             match target_elicit_result:
                 case AcceptedElicitation(data=data):
@@ -407,7 +407,7 @@ async def determine_targets(target_query: str):
                         http_methods=http_methods,
                         limit=limit,
                     )
-        except McpError as e:
+        except McpError:
             await ctx.info(f"Spidering {missing_targets_str}")
             logger.warning("elicit not supported, starting spider")
             for target in missing_targets:
diff --git a/shyhurricane/mcp_server/tools/indexers.py b/shyhurricane/mcp_server/tools/indexers.py
@@ -1,7 +1,7 @@
 import json
 import logging
 from datetime import datetime
-from typing import Optional, Dict, Annotated
+from typing import Optional, Annotated
 
 import httpx
 import persistqueue
diff --git a/shyhurricane/mcp_server/tools/prompt_chooser.py b/shyhurricane/mcp_server/tools/prompt_chooser.py
@@ -153,7 +153,7 @@ async def prompt_chooser(ctx: Context, query: str) -> str:
         targets = filter_targets_query(query)
 
     if not targets:
-        return f"At least one target is required. Specify as a host name, IP address, IP subnet, or URL."
+        return "At least one target is required. Specify as a host name, IP address, IP subnet, or URL."
 
     await log_tool_history(ctx, "prompt_chooser: result", query=query, prompt_title=prompt_title, targets=targets)
 
diff --git a/shyhurricane/mcp_server/tools/run_unix_command.py b/shyhurricane/mcp_server/tools/run_unix_command.py
@@ -101,7 +101,7 @@ async def run_unix_command(
                 result.error += "\nThe available commands are: " + ", ".join(server_ctx.commands)
 
         return result
-    except Exception as e:
+    except Exception:
         exc_type, exc_value, exc_tb = sys.exc_info()
         return RunUnixCommand(
             command=command,
@@ -138,7 +138,7 @@ async def _run_unix_command(ctx: Context, command: str, additional_hosts: Option
                 return None
             case CancelledElicitation():
                 return None
-    except McpError as e:
+    except McpError:
         logger.warning("elicit not supported, continuing")
 
     async with aiofiles.tempfile.TemporaryFile(mode="w+b") as stdout_file:
diff --git a/shyhurricane/mcp_server/tools/status.py b/shyhurricane/mcp_server/tools/status.py
@@ -1,4 +1,5 @@
 import json
+import os
 from typing import Dict
 
 import chromadb
@@ -62,3 +63,13 @@ async def status(request: Request) -> Response:
             "type_specific_index_active": doc_type_queue.active_size(),
         })
     )
+
+
+@mcp_instance.custom_route('/favicon.ico', methods=['GET'])
+async def favicon(request: Request) -> Response:
+    with open(os.path.join(os.path.dirname(__file__), "../../assets/favicon.ico"), "rb") as f:
+        return Response(
+            status_code=200,
+            media_type="image/x-icon",
+            content=f.read(),
+        )
diff --git a/shyhurricane/oast/interactsh.py b/shyhurricane/oast/interactsh.py
@@ -1,4 +1,8 @@
-import base64, json, os, random, string
+import base64
+import json
+import os
+import random
+import string
 import logging
 from typing import Any, Dict, List
 
@@ -83,7 +87,8 @@ async def init(self) -> Endpoints:
         public_pem = key.publickey().export_key("PEM")
 
         headers = {"Accept": "application/json"}
-        if token: headers["Authorization"] = f"Bearer {token}"
+        if token:
+            headers["Authorization"] = f"Bearer {token}"
         async with httpx.AsyncClient() as client:
             r = await client.post(f"{self._server_url(server)}/register", headers=headers, json={
                 "public-key": b64(public_pem),
@@ -158,4 +163,4 @@ async def deregister(self) -> None:
             url = f"{self._server_url(self.server)}/deregister"
             params = {"correlation_id": self.correlation_id, "secret": self.secret}
             logger.info("Deregistering %s with params %s and headers %s", url, params, headers)
-            r = await client.post(url, params=params, headers=headers, timeout=20)
+            await client.post(url, params=params, headers=headers, timeout=20)
diff --git a/shyhurricane/oast/webhook_site.py b/shyhurricane/oast/webhook_site.py
@@ -75,8 +75,10 @@ async def poll_new(self) -> PollOutput:
         seen: set[str] = self.seen_ids
         for it in items:
             uid = it.get("uuid")
-            if uid and uid in seen: continue
-            if uid: seen.add(uid)
+            if uid and uid in seen:
+                continue
+            if uid:
+                seen.add(uid)
             out.append(it)
         self.seen_ids = seen
         return PollOutput(interactions=out)
diff --git a/shyhurricane/prompts.py b/shyhurricane/prompts.py
@@ -204,7 +204,7 @@
 Begin immediately. Do not ask for instructions unless scope clarification is required.
 """
 
-production_safety_rules = f"""
+production_safety_rules = """
 
 ---
 
diff --git a/shyhurricane/proxy_server/proxy_server.py b/shyhurricane/proxy_server/proxy_server.py
@@ -5,11 +5,12 @@
 # - HTTP/1.1 (inside TLS): handles GET/HEAD/POST/PUT (reads/ignores body)
 # - Per-host leaf certs minted from an in-memory CA (cryptography)
 #
-import asyncio, base64, json, os, ssl
+import asyncio
+import base64
+import json
+import ssl
 import contextlib
 import logging
-import sys
-import traceback
 from asyncio import Server
 from http import HTTPStatus
 from os import PathLike
@@ -217,8 +218,10 @@ def mint_ctx_for_host(self, host: str) -> ssl.SSLContext:
         import datetime
         cert_path = Path(self.cert_dir, f"{host}.pem")
         key_path = Path(self.cert_dir, f"{host}.key")
-        with open(self.ca_key, "rb") as f: ca_key = load_pem_private_key(f.read(), password=None)
-        with open(self.ca_cert, "rb") as f: ca_cert = x509.load_pem_x509_certificate(f.read())
+        with open(self.ca_key, "rb") as f:
+            ca_key = load_pem_private_key(f.read(), password=None)
+        with open(self.ca_cert, "rb") as f:
+            ca_cert = x509.load_pem_x509_certificate(f.read())
 
         key = rsa.generate_private_key(public_exponent=65537, key_size=2048)
         now = datetime.datetime.now(datetime.UTC)
@@ -557,13 +560,16 @@ async def write_http11_response(url: str, method: str, writer: asyncio.StreamWri
         sent = set()
         for k, v in hdrs.items():
             lk = k.lower()
-            if lk in HOP or lk in "content-encoding": continue
-            if lk == "content-type": sent.add(lk)
+            if lk in HOP or lk in "content-encoding":
+                continue
+            if lk == "content-type":
+                sent.add(lk)
             writer.write(f"{k}: {v}\r\n".encode("iso-8859-1"))
         if "content-type" not in sent:
             writer.write(b"Content-Type: application/octet-stream\r\n")
         writer.write(f"Content-Length: {len(body)}\r\nConnection: close\r\n\r\n".encode("ascii"))
-        if body: writer.write(body)
+        if body:
+            writer.write(body)
         await ReplayProxy.drain_with_timeout(writer)
         writer.close()
         await writer.wait_closed()
diff --git a/shyhurricane/retrieval_pipeline.py b/shyhurricane/retrieval_pipeline.py
@@ -79,16 +79,16 @@ def __init__(self, file: str | os.PathLike[str] = "trace_documents.md") -> None:
     def run(self, query: str, expanded_queries: List[str], documents: List[Document]):
         with open(self.file, "a", encoding="utf-8") as f:
             f.write(f"# Q: {query}\n\n")
-            f.write(f"## Q expanded:\n")
+            f.write("## Q expanded:\n")
             for eq in expanded_queries:
                 f.write(f"- {eq}\n")
             f.write("\n")
             for doc in documents:
                 f.write(f"## {doc.meta["url"]}\n")
                 f.write(f"Score: {doc.score}\n\n")
                 f.write(doc.content[0:1024])
-                f.write(f"\n\n")
-            f.write(f"\n\n---\n\n")
+                f.write("\n\n")
+            f.write("\n\n---\n\n")
         return {}
 
 
@@ -459,7 +459,7 @@ class ChatMessageLogger:
     @component.output_types()
     def run(self, messages: List[ChatMessage]):
         if not messages:
-            logger.debug(f"No messages received")
+            logger.debug("No messages received")
         for message in messages:
             logger.debug(f"Message: {message.role}: {message.texts}")
         return {}
diff --git a/shyhurricane/streaming_chunk_writer.py b/shyhurricane/streaming_chunk_writer.py
@@ -31,13 +31,13 @@ def key(self):
     def function_call(self) -> str:
         result = f"{self.tool_name}({self.arguments})"
         if self.state == ToolProcessState.PENDING:
-            result = f"🕰 " + result
+            result = "🕰 " + result
         elif self.state == ToolProcessState.RUNNING:
-            result = f"🔄 " + result
+            result = "🔄 " + result
         elif self.state == ToolProcessState.FINISHED:
-            result = f"✅ " + result
+            result = "✅ " + result
         elif self.state == ToolProcessState.FAILED:
-            result = f"❌ " + result
+            result = "❌ " + result
 
         return result
 
diff --git a/shyhurricane/task_queue/finding_worker.py b/shyhurricane/task_queue/finding_worker.py
@@ -49,7 +49,7 @@ def save_finding_worker(ctx: FindingContext, item: SaveFindingQueueItem):
 
     try:
         target_info = parse_target_info(item.target)
-    except ValueError as e:
+    except ValueError:
         logger.error(f"Finding has invalid target: {item.target}")
         return
 
diff --git a/shyhurricane/utils.py b/shyhurricane/utils.py
@@ -368,7 +368,7 @@ def filter_hosts_and_addresses(input: Optional[List[str]] = None) -> List[str]:
     result = []
     for e in input:
         try:
-            if e == "localhost" or validators.domain(e) == True or ipaddress.ip_address(e):
+            if e == "localhost" or validators.domain(e) == True or ipaddress.ip_address(e):  # noqa: E712
                 result.append(e)
         except (ValueError, ValidationError):
             pass
@@ -414,7 +414,7 @@ def query_to_netloc(query: str) -> Tuple[str | None, int | None]:
             try:
                 query, _, port_str = query.partition(":")
                 try:
-                    if validators.domain(query) == False and not ipaddress.ip_address(query):
+                    if validators.domain(query) == False and not ipaddress.ip_address(query):  # noqa: E712
                         query = None
                 except (ValueError, ValidationError):
                     query = None
diff --git a/tests/oast/test_interactsh.py b/tests/oast/test_interactsh.py
@@ -178,13 +178,13 @@ async def register_ok(**kwargs):
     assert isinstance(p.domain, str) and p.domain.endswith(".oast.init")
 
     # endpoints consistency
-    ep = await p.endpoints()
-    # dns is domain without port
-    assert ep.dns == p.domain.split(":", 1)[0]
-    assert ep.http == f"http://{p.domain}"
-    assert ep.https == f"https://{p.domain}"
-    assert ep.smtp.endswith("@" + ep.smtp_domain)
-    assert ep.ldap == f"ldap://{ep.smtp_domain}"
+    for ep in [endpoints, await p.endpoints()]:
+        # dns is domain without port
+        assert ep.dns == p.domain.split(":", 1)[0]
+        assert ep.http == f"http://{p.domain}"
+        assert ep.https == f"https://{p.domain}"
+        assert ep.smtp.endswith("@" + ep.smtp_domain)
+        assert ep.ldap == f"ldap://{ep.smtp_domain}"
 
 
 @pytest.mark.asyncio
diff --git a/tests/test_normalize_html.py b/tests/test_normalize_html.py
@@ -30,7 +30,7 @@ def test_katana_files(self, input_file: str):
             self.assertFalse(cleaned.startswith("html"))
 
     def test_with_doctype(self):
-        with open(os.path.join(os.path.dirname(__file__), f"fixtures/with_doctype.html"), "rt") as f:
+        with open(os.path.join(os.path.dirname(__file__), "fixtures/with_doctype.html"), "rt") as f:
             html = f.read()
         cleaned = normalize_html(html)
         self.assertEqual("<html><head></head><body> </body></html>", cleaned)
diff --git a/tests/test_nuclei_findings.py b/tests/test_nuclei_findings.py
@@ -8,7 +8,7 @@
 
 class TestNucleiFindings(unittest.TestCase):
     def test_nuclei_findings(self):
-        with open(os.path.join(os.path.dirname(__file__), f"fixtures/juice-shop-nuclei.jsonl"), "rt") as f:
+        with open(os.path.join(os.path.dirname(__file__), "fixtures/juice-shop-nuclei.jsonl"), "rt") as f:
             jsonl = f.readlines()
         for line in jsonl:
             parsed = json.loads(line)
diff --git a/tests/test_proxy_server.py b/tests/test_proxy_server.py
@@ -3,6 +3,13 @@
 import ssl
 import contextlib
 import pytest
+import tempfile
+import shutil
+
+# Minimal async h2 client using hyper-h2 over asyncio streams
+from h2.connection import H2Connection
+from h2.config import H2Configuration
+from h2.events import ResponseReceived, DataReceived, StreamEnded
 
 from shyhurricane.proxy_server import proxy_server as srv  # noqa: F401
 
@@ -58,8 +65,8 @@ async def connect_tunnel(loop: asyncio.AbstractEventLoop, proxy_host, proxy_port
     assert line.startswith(b"HTTP/1.1 200"), f"CONNECT failed: {line!r}"
     # Drain headers
     while True:
-        l = await reader.readline()
-        if not l or l == b"\r\n":
+        line = await reader.readline()
+        if not line or line == b"\r\n":
             break
 
     # 2) Upgrade this transport to TLS (client side)
@@ -106,7 +113,6 @@ async def proxy_server():
     }
     store = DummyStore(mapping)
 
-    import tempfile, shutil
     temp_dir = tempfile.mkdtemp(prefix="replay-ca-test-")
     ca = srv.CertAuthority(cert_dir=temp_dir)
     proxy = srv.ReplayProxy(store, ca)
@@ -182,11 +188,6 @@ async def test_connect_https_h2_big_body(proxy_server):
     )
     assert selected == "h2", f"ALPN failed, got {selected!r}"
 
-    # Minimal async h2 client using hyper-h2 over asyncio streams
-    from h2.connection import H2Connection
-    from h2.config import H2Configuration
-    from h2.events import ResponseReceived, DataReceived, StreamEnded
-
     conn = H2Connection(H2Configuration(client_side=True, header_encoding="utf-8"))
     conn.initiate_connection()
     tls_writer.write(conn.data_to_send())
diff --git a/tests/test_stream_lines.py b/tests/test_stream_lines.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import re`
`2`	`1`	`from typing import List`
`3`	`2`
`4`	`3`	`from base64 import b64encode, b64decode`