Skip to content
Python

fix(security): validate ticker before using as path component (#618)

Yijia-Xiao2c97bad45c77
diff --git a/tests/test_safe_ticker_component.py b/tests/test_safe_ticker_component.py
new file mode 100644
index 000000000..3bdc02234
--- /dev/null
+++ b/tests/test_safe_ticker_component.py
@@ -0,0 +1,52 @@
+"""Tests for the ticker path-component validator that blocks directory traversal."""
+
+import os
+import unittest
+
+import pytest
+
+from tradingagents.dataflows.utils import safe_ticker_component
+
+
+class TestSafeTickerComponent(unittest.TestCase):
+ def test_accepts_common_ticker_formats(self):
+ for ticker in ("AAPL", "BRK-B", "BRK.A", "0700.HK", "7203.T", "BHP.AX", "^GSPC"):
+ self.assertEqual(safe_ticker_component(ticker), ticker)
+
+ def test_rejects_path_separators(self):
+ for bad in (".", "..", "../etc", "a/b", "a\\b", "/abs", "..\\..\\x"):
+ with self.assertRaises(ValueError):
+ safe_ticker_component(bad)
+
+ def test_rejects_null_byte_and_whitespace(self):
+ for bad in ("AAP L", "AAPL\x00", "AAPL\n", "\tAAPL"):
+ with self.assertRaises(ValueError):
+ safe_ticker_component(bad)
+
+ def test_rejects_empty_or_non_string(self):
+ for bad in ("", None, 123, b"AAPL"):
+ with self.assertRaises(ValueError):
+ safe_ticker_component(bad)
+
+ def test_rejects_overlong_input(self):
+ with self.assertRaises(ValueError):
+ safe_ticker_component("A" * 33)
+
+ def test_rejects_dot_only_values(self):
+ # '.' and '..' pass the regex but traverse when used as a path
+ # component (e.g. ``Path(results_dir) / ticker / "logs"``).
+ for bad in (".", "..", "...", "...."):
+ with self.assertRaises(ValueError):
+ safe_ticker_component(bad)
+
+ def test_traversal_string_does_not_escape_join(self):
+ """Sanity: sanitized values stay within base when joined."""
+ base = os.path.realpath("/tmp/cache")
+ ticker = safe_ticker_component("AAPL")
+ joined = os.path.realpath(os.path.join(base, f"{ticker}.csv"))
+ self.assertTrue(joined.startswith(base + os.sep))
+
+
+if __name__ == "__main__":
+ unittest.main()
diff --git a/tradingagents/dataflows/stockstats_utils.py b/tradingagents/dataflows/stockstats_utils.py
index cb24c5d6a..260ef73cd 100644
--- a/tradingagents/dataflows/stockstats_utils.py
+++ b/tradingagents/dataflows/stockstats_utils.py
@@ -8,6 +8,7 @@ from stockstats import wrap
from typing import Annotated
import os
from .config import get_config
+from .utils import safe_ticker_component
logger = logging.getLogger(__name__)
@@ -51,6 +52,10 @@ def load_ohlcv(symbol: str, curr_date: str) -> pd.DataFrame:
subsequent calls the cache is reused. Rows after curr_date are
filtered out so backtests never see future prices.
"""
+ # Reject ticker values that would escape the cache directory when
+ # interpolated into the cache filename (e.g. ``../../tmp/x``).
+ safe_symbol = safe_ticker_component(symbol)
+
config = get_config()
curr_date_dt = pd.to_datetime(curr_date)
@@ -63,7 +68,7 @@ def load_ohlcv(symbol: str, curr_date: str) -> pd.DataFrame:
os.makedirs(config["data_cache_dir"], exist_ok=True)
data_file = os.path.join(
config["data_cache_dir"],
- f"{symbol}-YFin-data-{start_str}-{end_str}.csv",
+ f"{safe_symbol}-YFin-data-{start_str}-{end_str}.csv",
)
if os.path.exists(data_file):
diff --git a/tradingagents/dataflows/utils.py b/tradingagents/dataflows/utils.py
index c99b777ab..3d8a45d81 100644
--- a/tradingagents/dataflows/utils.py
+++ b/tradingagents/dataflows/utils.py
@@ -1,4 +1,5 @@
import os
+import re
import json
import pandas as pd
from datetime import date, timedelta, datetime
@@ -6,6 +7,40 @@ from typing import Annotated
SavePathType = Annotated[str, "File path to save data. If None, data is not saved."]
+# Tickers can contain letters, digits, dot, dash, underscore, and caret
+# (for index symbols like ^GSPC). Anything else is rejected so the value
+# never escapes a containing directory when interpolated into a path.
+_TICKER_PATH_RE = re.compile(r"^[A-Za-z0-9._\-\^]+$")
+
+
+def safe_ticker_component(value: str, *, max_len: int = 32) -> str:
+ """Validate ``value`` is safe to interpolate into a filesystem path.
+
+ Tickers come from user CLI input or from LLM tool calls, both of which
+ can be influenced by attacker-controlled content (e.g. prompt injection
+ embedded in fetched news). Without validation, a value like
+ ``"../../../etc/foo"`` flows into ``os.path.join`` / ``Path /`` and
+ escapes the configured cache, checkpoint, or results directory.
+
+ Returns ``value`` unchanged when it matches the allowed pattern; raises
+ ``ValueError`` otherwise.
+ """
+ if not isinstance(value, str) or not value:
+ raise ValueError(f"ticker must be a non-empty string, got {value!r}")
+ if len(value) > max_len:
+ raise ValueError(f"ticker exceeds {max_len} chars: {value!r}")
+ if not _TICKER_PATH_RE.fullmatch(value):
+ raise ValueError(
+ f"ticker contains characters not allowed in a filesystem path: {value!r}"
+ )
+ # The regex above allows '.', so values like '.', '..', '...' would pass,
+ # and as a path component they traverse the parent directory. Reject any
+ # value that's only dots.
+ if set(value) == {"."}:
+ raise ValueError(f"ticker cannot consist solely of dots: {value!r}")
+ return value
+
+
def save_output(data: pd.DataFrame, tag: str, save_path: SavePathType = None) -> None:
if save_path:
data.to_csv(save_path, encoding="utf-8")
diff --git a/tradingagents/graph/checkpointer.py b/tradingagents/graph/checkpointer.py
index 7a73ee446..3ba19726d 100644
--- a/tradingagents/graph/checkpointer.py
+++ b/tradingagents/graph/checkpointer.py
@@ -13,12 +13,16 @@ from typing import Generator
from langgraph.checkpoint.sqlite import SqliteSaver
+from tradingagents.dataflows.utils import safe_ticker_component
+
def _db_path(data_dir: str | Path, ticker: str) -> Path:
"""Return the SQLite checkpoint DB path for a ticker."""
+ # Reject ticker values that would escape the checkpoints directory.
+ safe = safe_ticker_component(ticker).upper()
p = Path(data_dir) / "checkpoints"
p.mkdir(parents=True, exist_ok=True)
- return p / f"{ticker.upper()}.db"
+ return p / f"{safe}.db"
def thread_id(ticker: str, date: str) -> str:
diff --git a/tradingagents/graph/trading_graph.py b/tradingagents/graph/trading_graph.py
index bd6f1fc5c..d7e8b5731 100644
--- a/tradingagents/graph/trading_graph.py
+++ b/tradingagents/graph/trading_graph.py
@@ -18,6 +18,7 @@ from tradingagents.llm_clients import create_llm_client
from tradingagents.agents import *
from tradingagents.default_config import DEFAULT_CONFIG
from tradingagents.agents.utils.memory import TradingMemoryLog
+from tradingagents.dataflows.utils import safe_ticker_component
from tradingagents.agents.utils.agent_states import (
AgentState,
InvestDebateState,
@@ -378,8 +379,10 @@ class TradingAgentsGraph:
"final_trade_decision": final_state["final_trade_decision"],
}
- # Save to file
- directory = Path(self.config["results_dir"]) / self.ticker / "TradingAgentsStrategy_logs"
+ # Save to file. Reject ticker values that would escape the
+ # results directory when joined as a path component.
+ safe_ticker = safe_ticker_component(self.ticker)
+ directory = Path(self.config["results_dir"]) / safe_ticker / "TradingAgentsStrategy_logs"
directory.mkdir(parents=True, exist_ok=True)
log_path = directory / f"full_states_log_{trade_date}.json"