Skip to content

~95% on SimpleQA (e.g. Qwen3.6-27B on a 3090). Supports all local and cloud LLMs (llama.cpp, Ollama, Google, ...). 10+ search engines - arXiv, PubMed, your private documents. Everything Local & Encrypted.

security: validate search_type against allowlist in GitHub search engine (#3085)

LearningCircuitea0b24a57e3e
diff --git a/src/local_deep_research/web_search_engines/engines/search_engine_github.py b/src/local_deep_research/web_search_engines/engines/search_engine_github.py
index f3e881536a..9ef2646be0 100644
--- a/src/local_deep_research/web_search_engines/engines/search_engine_github.py
+++ b/src/local_deep_research/web_search_engines/engines/search_engine_github.py
@@ -12,6 +12,9 @@ from ...utilities.json_utils import extract_json, get_llm_response_text
from ..search_engine_base import BaseSearchEngine
+_VALID_SEARCH_TYPES = frozenset({"repositories", "code", "issues", "users"})
+
+
class GitHubSearchEngine(BaseSearchEngine):
"""
GitHub search engine implementation.
@@ -52,6 +55,11 @@ class GitHubSearchEngine(BaseSearchEngine):
settings_snapshot=settings_snapshot,
)
self.api_key = api_key
+ if search_type not in _VALID_SEARCH_TYPES:
+ raise ValueError(
+ f"Invalid GitHub search_type: {search_type!r}. "
+ f"Must be one of {_VALID_SEARCH_TYPES}"
+ )
self.search_type = search_type
self.include_readme = include_readme
self.include_issues = include_issues
@@ -853,12 +861,14 @@ class GitHubSearchEngine(BaseSearchEngine):
Args:
search_type: Type of GitHub search ("repositories", "code", "issues", "users")
"""
- if search_type in ["repositories", "code", "issues", "users"]:
- self.search_type = search_type
- self.search_endpoint = f"{self.api_base}/search/{search_type}"
- logger.info(f"Set GitHub search type to: {search_type}")
- else:
- logger.error(f"Invalid GitHub search type: {search_type}")
+ if search_type not in _VALID_SEARCH_TYPES:
+ raise ValueError(
+ f"Invalid GitHub search_type: {search_type!r}. "
+ f"Must be one of {_VALID_SEARCH_TYPES}"
+ )
+ self.search_type = search_type
+ self.search_endpoint = f"{self.api_base}/search/{search_type}"
+ logger.info(f"Set GitHub search type to: {search_type}")
def _filter_for_relevance(
self, previews: List[Dict[str, Any]], query: str
diff --git a/tests/web_search_engines/engines/test_search_engine_github.py b/tests/web_search_engines/engines/test_search_engine_github.py
index bbb63bbc7d..c1ba06bd37 100644
--- a/tests/web_search_engines/engines/test_search_engine_github.py
+++ b/tests/web_search_engines/engines/test_search_engine_github.py
@@ -15,6 +15,8 @@ Tests cover:
import base64
from unittest.mock import Mock, patch
+import pytest
+
class TestGitHubSearchEngineInit:
"""Tests for GitHubSearchEngine initialization."""
@@ -686,17 +688,15 @@ class TestSetSearchType:
assert "code" in engine.search_endpoint
def test_set_search_type_invalid(self):
- """Set search type with invalid value does nothing."""
+ """Set search type with invalid value raises ValueError."""
from local_deep_research.web_search_engines.engines.search_engine_github import (
GitHubSearchEngine,
)
engine = GitHubSearchEngine()
- original_type = engine.search_type
-
- engine.set_search_type("invalid")
- assert engine.search_type == original_type
+ with pytest.raises(ValueError, match="Invalid GitHub search_type"):
+ engine.set_search_type("invalid")
class TestOptimizeGitHubQuery:
diff --git a/tests/web_search_engines/engines/test_search_engine_github_coverage.py b/tests/web_search_engines/engines/test_search_engine_github_coverage.py
index 1c2203b6df..d1575560d4 100644
--- a/tests/web_search_engines/engines/test_search_engine_github_coverage.py
+++ b/tests/web_search_engines/engines/test_search_engine_github_coverage.py
@@ -302,14 +302,9 @@ class TestGetPreviewsCoverage:
assert previews[0]["search_type"] == "user"
def test_unknown_type_skips_result(self):
- """Unknown search type skips the result via continue."""
- engine = _make_engine(search_type="unknown_type")
- # Override the endpoint to avoid init issues
- engine.search_endpoint = f"{engine.api_base}/search/unknown_type"
- mock_results = [{"id": 1}]
- with patch.object(engine, "_search_github", return_value=mock_results):
- previews = engine._get_previews("query")
- assert previews == []
+ """Unknown search type raises ValueError in __init__."""
+ with pytest.raises(ValueError, match="Invalid GitHub search_type"):
+ _make_engine(search_type="unknown_type")
# ---------------------------------------------------------------------------
diff --git a/tests/web_search_engines/engines/test_search_engine_github_deep_coverage.py b/tests/web_search_engines/engines/test_search_engine_github_deep_coverage.py
index 20ef46beba..26e61fab67 100644
--- a/tests/web_search_engines/engines/test_search_engine_github_deep_coverage.py
+++ b/tests/web_search_engines/engines/test_search_engine_github_deep_coverage.py
@@ -24,6 +24,8 @@ Focuses on paths not covered by test_search_engine_github_coverage.py:
import base64
from unittest.mock import Mock, patch
+import pytest
+
from local_deep_research.web_search_engines.engines.search_engine_github import (
GitHubSearchEngine,
@@ -108,9 +110,8 @@ class TestSetSearchTypeDeep:
def test_invalid_search_type_does_not_change_state(self):
engine = _make_engine(search_type="repositories")
- engine.set_search_type("invalid_type")
- # State should be unchanged
- assert engine.search_type == "repositories"
+ with pytest.raises(ValueError, match="Invalid GitHub search_type"):
+ engine.set_search_type("invalid_type")
# ---------------------------------------------------------------------------