RubyMine 2025.2 Help

Brakeman

Brakeman 是一个开源安全工具,旨在分析 Ruby on Rails 应用程序中的潜在安全漏洞。 作为一个静态分析工具,Brakeman 扫描应用程序的源代码以识别常见的安全问题,例如 SQL 注入、跨站脚本攻击 (XSS) 和其他漏洞。 RubyMine 支持将 Brakeman 作为检查运行,并以用户友好的格式显示分析结果。

安装 Brakeman

  1. brakeman gem(版本 5.0.0 或更高版本)添加到您的 Gemfile

  2. 将 gem 安装到您的项目解释器中

运行 Brakeman

  1. 在主菜单中,前往 代码 | 分析代码 | 通过名称运行检查(R)… 或按下 Ctrl+Alt+Shift+I

  2. 在弹出窗口中,开始输入 Brakeman 并从下拉列表中选择所需的检查。

    运行 Brakeman 检查
  3. 配置检查范围

    如有必要,在 检查选项 部分中配置 Brakeman 警告:

    • 置信度级别 :指定要报告的警告的最低级别,其中 Weak 包括所有警告, High 仅包括严重警告。

    • // :配置特定级别的警告在 RubyMine 中的呈现方式。 Brakeman 的 置信级别 直接映射到 RubyMine 的 严重级别

    配置警告选项
  4. 点击 确定 运行检查。

检查 Brakeman 分析结果

RubyMine 在 问题 工具窗口中打开检查结果。

Brakeman 分析结果

RubyMine 显示发现的弱点的代码片段、文件和详细信息,并提供指向 Brakeman 文档 中相关主题的链接。

  • 使用 忽略 按钮忽略特定警告,并将其添加到 brakeman.ignore 文件中。 如果您的项目中尚无此文件,RubyMine 将自动创建它。

  • 使用 跳过此类型的检查 按钮跳过当前类型的所有警告,并在运行 Brakeman 检查时停止检查它们。 RubyMine 将把必要的配置添加到 brakeman.yml 文件中。 如果您的项目中尚无此文件,RubyMine 将自动创建它。

最后修改日期: 2025年 9月 26日