Galaxy Console Fixr

一个 VS Code 扩展,旨在与 Checkmarx (或称为 Galaxy Console) 集成,自动扫描当前项目中的代码漏洞,并提供潜在的修复建议(可能利用 AI)。
功能特性
- 代码扫描: 直接在 VS Code 中触发 Checkmarx 对当前工作区进行安全扫描。
- 漏洞显示: 在 VS Code 的侧边栏或特定视图中展示扫描发现的漏洞列表。
- 快速访问: 通过状态栏按钮快速执行扫描或查看结果。
- 设置界面: 在侧边栏提供专门的设置视图,方便配置 Checkmarx 服务器和认证信息。
- AI 辅助修复: (推测功能,基于代码结构) 可能集成 AI (OpenAI, Azure, 本地) 提供代码修复建议或 Code Actions。
- 命令集成: 提供多个 VS Code 命令用于控制扫描流程、查看结果和管理设置。
- 配置灵活: 支持通过 VS Code 设置自定义 Checkmarx 服务器地址、用户名、密码、AI 提供商、API 密钥以及扫描时需要排除的目录。
- 待办清单: 可以生成漏洞修复的待办事项清单。
- 表格视图: 提供将漏洞以表格形式展示的视图。
使用方法
安装
- 通过 VS Code 扩展市场搜索 "Galaxy Console Fixr" (或根据实际发布名称)。
- 点击安装。
配置
安装完成后,您需要配置 Checkmarx 服务器的相关信息:
- 打开 VS Code 设置 (File > Preferences > Settings 或
Cmd+, /Ctrl+, )。
- 搜索 "Checkmarx Fixr"。
- 根据需要填写以下设置:
checkmarx-fixr.serverUrl : 您的 Checkmarx 服务器 URL (例如: http://your-checkmarx-server )。
checkmarx-fixr.username : 登录 Checkmarx 的用户名。
checkmarx-fixr.password : 登录 Checkmarx 的密码。
checkmarx-fixr.aiProvider : 选择用于修复建议的 AI 提供商 (openai , azure , local )。
checkmarx-fixr.aiApiKey : 您选择的 AI 服务的 API 密钥。
checkmarx-fixr.excludeDirs : 扫描时需要排除的目录列表 (默认为 ["node_modules", ".git", "dist", "build"] )。
可用命令
可以通过命令面板 (Cmd+Shift+P 或 Ctrl+Shift+P ) 访问以下命令:
Checkmarx: 扫描当前项目 : 启动对当前工作区的扫描。
Checkmarx: 设置 : 打开 Checkmarx 相关设置(可能指向设置视图或 VS Code 设置)。
Checkmarx: 刷新漏洞列表 : 重新加载或更新漏洞视图。
Checkmarx: 清除扫描结果 : 清除当前显示的扫描结果。
生成待修复清单 : 根据当前漏洞生成一个待办列表。
显示漏洞表格视图 : 以表格形式展示漏洞。
您也可以通过状态栏的按钮快速触发 扫描 和 显示扫描结果。
开发
如果需要参与开发或自行构建:
- 克隆仓库。
- 运行
pnpm install 安装依赖。
- 运行
pnpm run compile 或 pnpm run watch 进行编译。
- 按
F5 启动包含此扩展的 VS Code 开发实例。
主要依赖
axios : 用于向 Checkmarx 服务器和 AI 服务发送 HTTP 请求。
archiver : 用于打包项目文件以便上传扫描。
注意: 本 README 是基于对 package.json 和 src/extension.ts 的分析生成的。部分功能(如 AI 修复的具体实现)是基于代码结构推测的。
| |