讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

AniShort
AniShort

AI短剧协同制作平台

剧云
剧云

中文短剧剧本制作平台

VSCode怎么配置Semgrep代码审查_VSCode Semgrep安全扫描与规则配置

阿辰大大_3825

阿辰大大_3825

发布时间:2026-05-26 06:37:59

|

784人浏览过

|

来源于php中文网

原创

Semgrep在VSCode中只需安装官方插件并配置本地CLI和规则文件即可运行:先用pipx install semgrep安装CLI,再在VSCode设置中指定其路径;插件通过读取项目根目录下的.semgrep.yml(如含硬编码密钥、SQL拼接等Python规则)执行本地AST扫描,保存文件即触发单文件检测,右键可全量扫描,无需联网或商业平台。

vscode怎么配置semgrep代码审查_vscode semgrep安全扫描与规则配置

直接装插件 + 本地规则文件就能跑起来,不需要连商业平台或配复杂服务端。 Semgrep 在 VSCode 里本质是调用 CLI 工具做本地静态分析,核心就两件事:让编辑器知道 semgrep 命令在哪,以及告诉它用哪套规则扫描哪些文件。

怎么在 VSCode 里装上 Semgrep 插件并让它真正工作

VSCode 官方市场里搜 “Semgrep” 找到由 r2c(现 Semgrep Inc)发布的官方扩展,安装后它不会自动生效——它只是个“调度器”,真正干活的是你本地的 semgrep CLI。

  • 必须先在系统里装好 semgrep:推荐用 pipx install semgrep(避免污染全局 Python 环境),验证是否可用:semgrep --version
  • 插件默认会尝试找 semgrep 在 PATH 里,如果报错 “command not found”,就得在 VSCode 设置里手动填路径,比如 macOS 上可能是 /Users/xxx/.local/bin/semgrep
  • 插件本身不带规则库,它只读你项目根目录下的 .semgrep.yml 或通过 --config 指定的配置;没这个文件,它就安静地不扫任何东西

写一个能落地的 .semgrep.yml 规则文件

别抄网上一堆空泛示例。真实项目要防的是硬编码密钥、日志泄露、SQL 拼接——不是“禁止 print”。以下是一个开箱即用的最小可行配置:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
rules:
- id: detect-hardcoded-api-key
  pattern: "api_key = '...'"
  message: "检测到明文 API 密钥赋值,请改用环境变量"
  severity: ERROR
  languages: [python]
<ul><li><p>id: detect-sql-string-concat
pattern: "query = 'SELECT * FROM ...' + ..."
message: "SQL 查询字符串拼接,存在注入风险"
severity: ERROR
languages: [python]</p></li><li><p>id: avoid-print-in-prod
pattern: "print(...)"
message: "生产代码中应使用 logging 而非 print"
severity: WARNING
languages: [python]
paths:
include: ["src/", "app/"]
exclude: ["tests/", "migrations/"]
  • paths.include/exclude 很关键:不加的话,semgrep 默认扫整个工作区,包括 node_modules 或 venv,既慢又全是误报
  • 所有 pattern 都是基于语法树(AST)匹配,不是正则;所以 "api_key = '...'" 能匹配换行、空格、变量名变化,比正则鲁棒得多
  • 如果想复用社区规则,可把 rules 改成 rules: https://semgrep.dev/r/python-security-audit,但注意:这会触发网络请求,离线环境失效

为什么改了规则文件,VSCode 里没立刻反应

Semgrep 插件默认只在保存文件时触发单文件扫描,不会监听 .semgrep.yml 变更。也就是说,你改完规则,得手动操作一次才能生效。

  • 最简单办法:随便打开一个被规则覆盖的 Python 文件,按 Ctrl+S(保存),插件就会用新规则重扫当前文件
  • 想全量扫一遍?右键任意文件 → “Semgrep: Run Scan on Folder”,它会执行 semgrep scan --config=.semgrep.yml .
  • 常见卡点:插件设置里勾选了 “Only run on save”,但你改的是配置文件本身——它不监听自己,所以必须手动触发
  • 另一个坑:VSCode 工作区用了多根文件夹(multi-root workspace),而 .semgrep.yml 不在最外层根目录,插件可能根本找不到它,得确认配置文件位置

和 Bandit / SonarLint 混用时要注意什么

它们不是互斥关系,但职责不同,混用容易重复告警或漏检。

  • bandit 是纯 Python 安全扫描器,专注 crypto、deserialization、shell injection,但不支持跨语言、也不支持自定义 AST 模式;适合补 Semgrep 没覆盖的 Python 特定漏洞
  • sonarlint 依赖远程 SonarQube 规则集,很多规则需要连接服务器才能启用;本地离线模式下,它实际只跑一小部分内置规则,和 Semgrep 的本地自治思路完全不同
  • 三者共存时,建议用 Semgrep 主守“模式类风险”(如密钥、注入、金额精度),用 Bandit 补“Python 运行时语义风险”,SonarLint 仅用于团队已接入 SonarQube 的场景做规则对齐
  • 性能上:Semgrep 单次扫描通常比 Bandit 快 3–5 倍,尤其在混合语言项目里;但 Bandit 对 eval()、subprocess 的识别更细粒度

真正难的不是配通,而是判断哪条规则该设为 ERROR、哪条该 WARNING、哪些路径该 exclude——这些决定直接影响开发者会不会无视所有提示。规则越少、越准、越贴近当前项目真实风险,工具才越有用。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

1595

2023.06.30

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

3452

2023.07.21

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2129

2024.03.14

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1767

2024.03.14

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2627

2024.03.15

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1858

2024.03.15

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1302

2024.03.15

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1156

2024.03.15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

60

2026.11.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn