code-pathfinder
快速开始
安装:
brew install shivasurya/tap/pathfinder扫描 Python 项目(规则自动下载):
pathfinder scan --ruleset python/all --project .扫描 Dockerfile:
pathfinder scan --ruleset docker/all --project .无需配置文件,无需 API 密钥,无需云账户。数秒内即可在终端获得结果。
Related MCP server: CodeAudit Agent
什么是 Code Pathfinder?
Code Pathfinder 是一个开源静态分析引擎,它为你的代码库构建一张图,并追踪数据在其中的流动方式。它将源代码解析为抽象语法树,跨文件构建调用图,并运行污点分析来发现跨多个文件和函数边界的源到汇漏洞。
v2.0 引入了跨文件数据流分析:追踪用户输入从一个文件中的 HTTP 处理程序,经过辅助函数,进入另一个文件中的 SQL 查询。这正是模式匹配工具完全无法捕捉的分析类型。
跨文件污点分析
大多数开源 SAST 工具都在单个文件上运行。Code Pathfinder v2.0 跨文件边界追踪受污染的数据:
app.py:5 user_input = request.get("query") ← Source: user-controlled input
↓ calls
db.py:12 cursor.execute(query) ← Sink: SQL execution该引擎为每个函数构建变量依赖图(VDG),然后通过过程间污点传递摘要将它们连接起来。当 user_input 流入另一个文件中的函数参数时,污点通过调用图传播到汇点。
工作原理
Source Code → Tree-sitter AST → Call Graph → Variable Dependency Graph → Taint Analysis → Findings
↓
Inter-procedural
Taint Summaries
(cross-file flows)解析:Tree-sitter 为 Python、Dockerfile 和 Docker Compose 文件构建 AST
索引:将函数、调用点、参数和赋值提取为可查询的调用图
分析:为每个函数构建 VDG,解析过程间流,运行污点分析
检测:基于 Python 的安全规则查询图以找到源到汇路径
报告:以文本、JSON、SARIF(GitHub 代码扫描)或 CSV 格式输出结果
190 条安全规则,开箱即用
规则从 CDN 自动下载。无需克隆仓库或管理规则文件。
语言 | 规则包 | 规则数量 | 覆盖范围 |
django, flask, aws_lambda, cryptography, jwt, lang, deserialization, pyramid | 158 | SQL 注入、RCE、SSRF、路径遍历、XSS、反序列化、加密误用、JWT 漏洞 | |
security, best-practice, performance | 37 | root 用户、暴露秘密、镜像锁定、多阶段构建、层优化 | |
security, networking | 10 | 特权模式、socket 暴露、能力提升、网络隔离 |
# Scan with a specific bundle
pathfinder scan --ruleset python/django --project .
# Scan with multiple bundles
pathfinder scan --ruleset python/flask --ruleset python/jwt --project .
# Scan a single rule
pathfinder scan --ruleset python/PYTHON-DJANGO-SEC-001 --project .
# Scan all rules for a language
pathfinder scan --ruleset python/all --project .在规则仓库中浏览所有规则,包含示例和测试用例。
面向 AI 编码助手的 MCP 服务器
Code Pathfinder 作为 MCP 服务器运行,为 Claude Code、Cursor、Cline 及其他 AI 助手提供调用图、数据流和安全分析的访问能力。相比 LSP 提供更多上下文,专注于安全性和代码结构。
pathfinder serve --project .MCP 服务器暴露了用于查询代码图的工具:查找调用者/被调用者、追踪数据流、搜索模式以及运行安全规则——所有这些都可以在代码审查或开发期间供 AI 助手使用。
编写自定义规则
安全规则是使用 PathFinder SDK 编写的 Python 脚本。定义源、汇和消毒器——数据流引擎负责分析。
以下是一条来自仓库的真实规则(PYTHON-DJANGO-SEC-001),用于检测 Django 中的 SQL 注入:
from codepathfinder import calls, flows, QueryType
from codepathfinder.presets import PropagationPresets
class DBCursor(QueryType):
fqns = ["sqlite3.Cursor", "psycopg2.extensions.cursor"]
match_subclasses = True
@python_rule(
id="PYTHON-DJANGO-SEC-001",
name="Django SQL Injection via cursor.execute()",
severity="CRITICAL",
cwe="CWE-89",
)
def detect_django_cursor_sqli():
return flows(
from_sources=[
calls("request.GET.get"),
calls("request.POST.get"),
],
to_sinks=[
DBCursor.method("execute").tracks(0),
calls("cursor.execute"),
],
sanitized_by=[calls("escape"), calls("escape_string")],
propagates_through=PropagationPresets.standard(),
scope="global", # cross-file taint analysis
)# Run your custom rules
pathfinder scan --rules ./my_rules/ --project .探索 rules/ 目录下的全部 190 条规则,或浏览规则仓库。查看规则编写指南和数据流文档来编写你自己的规则。
安装
Homebrew(推荐)
brew install shivasurya/tap/pathfinderpip
安装 CLI 二进制文件和用于编写规则的 Python SDK。
pip install codepathfinderDocker
docker pull shivasurya/code-pathfinder:stable-latest
docker run --rm -v "$(pwd):/src" \
shivasurya/code-pathfinder:stable-latest \
scan --ruleset python/all --project /src预编译二进制文件
从 GitHub Releases 下载适用于 Linux(amd64、arm64)、macOS(Intel、Apple Silicon)和 Windows(x64)的版本。
从源码构建
git clone https://github.com/shivasurya/code-pathfinder
cd code-pathfinder/sast-engine
gradle buildGo
./build/go/pathfinder --help使用方式
# Scan with text output (default)
pathfinder scan --ruleset python/all --project .
# JSON output
pathfinder scan --ruleset python/all --project . --output json --output-file results.json
# SARIF output (GitHub Code Scanning)
pathfinder scan --ruleset python/all --project . --output sarif --output-file results.sarif
# CSV output
pathfinder scan --ruleset python/all --project . --output csv --output-file results.csv
# Fail CI on critical/high findings
pathfinder scan --ruleset python/all --project . --fail-on=critical,high
# MCP server mode
pathfinder serve --project .
# Verbose output with statistics
pathfinder scan --ruleset python/all --project . --verboseGitHub Action
name: Code Pathfinder Security SAST Scan
on:
pull_request:
permissions:
security-events: write
contents: read
pull-requests: write
jobs:
security-scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Run Security Scan
uses: shivasurya/code-pathfinder@v2.1.1
with:
ruleset: python/all, docker/all, docker-compose/all
verbose: true
pr-comment: ${{ github.event_name == 'pull_request' }}
pr-inline: ${{ github.event_name == 'pull_request' }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Upload SARIF
uses: github/codeql-action/upload-sarif@v4
if: always()
with:
sarif_file: pathfinder-results.sarif查看完整示例:.github/workflows/code-pathfinder-scan.yml
输入 | 描述 | 默认值 |
| 本地 Python 规则文件或目录的路径 | - |
| 远程规则集,逗号分隔(例如 | - |
| 源代码路径 |
|
| 输出格式: |
|
| 输出文件路径 |
|
| 失败时的严重级别(例如 | - |
| 启用详细输出 |
|
| 启用带时间戳的调试诊断 |
|
| 跳过测试文件 |
|
| 强制刷新缓存的规则集 |
|
| 禁用匿名使用统计 |
|
| 使用的 Python 版本 |
|
| 在拉取请求上发布摘要评论 |
|
| 为关键/高风险发现发布内联审查评论 |
|
| GitHub 令牌(当启用 | - |
| 禁用差异感知扫描(扫描所有文件) |
|
rules 或 ruleset 至少需要提供一个。
支持的语言
语言 | 分析能力 | 状态 |
Python | 跨文件数据流、污点分析、调用图 | 稳定 |
Dockerfile | 指令分析、安全模式 | 稳定 |
Docker Compose | 配置分析、安全模式 | 稳定 |
Go | AST 分析、调用图 | 即将推出 |
贡献
欢迎贡献。阅读贡献指南了解设置说明、如何在本地运行测试以及 PR 流程。
推送产品内公告
产品内公告(工作坊、博客文章、安全公告)通过 release/latest.json 管理。在 announcements[] 中添加条目,提交 PR,一旦合并到 main,发布工作流将在约 60 秒内将清单上传到 CDN。有关模式和 version_range 语义,请参阅版本更新检查技术规范。
所有贡献者必须在任何拉取请求合并之前签署贡献者许可协议(CLA)。
许可证
This server cannot be deployed
Maintenance
Related MCP Connectors
Zero-config MCP security scanner for AI-generated apps. 25K+ vulnerability patterns.
MCP server for static security analysis of Android source code
MCP server for secureFlows: token-free URL builders and integration-linting tools for AI agents.
MCP server for building and testing AI agents with multi-model experimentation and insights.
Related MCP Servers
AlicenseNot gradedqualityAmaintenanceMCP server that gives AI assistants impact analysis, cross-project reference tracking, and code health scoring.4Apache 2.0- FlicenseNot gradedqualityDmaintenanceMCP server for AI-powered code security, quality, and performance review. Enables auditing code directly from VS Code via right-click or MCP tools.-
- FlicenseNot gradedqualityBmaintenanceMCP server for AI coding agents that builds a complete code structure graph and semantic vector index, enabling fast querying of code entities, relationships, and impact analysis.56 npm10-
- AlicenseNot gradedqualityBmaintenanceA production-ready MCP server that enables AI assistants to intelligently understand, analyze, edit, navigate, and review software projects with multi-workspace support, Git integration, and semantic search.1MIT