presidentbeef/brakeman

Brakeman

Brakeman是一款静态分析工具，用于检查Ruby on Rails应用程序中的安全漏洞。

镜像概述和主要用途

Brakeman专为Ruby on Rails应用设计，通过静态代码分析识别潜在安全风险，帮助开发人员在开发阶段发现并修复漏洞。支持多种输出格式，可集成到开发流程和持续集成环境中，提升应用程序安全性。

核心功能和特性

• 静态代码分析：无需运行应用即可检测安全漏洞
• 多版本兼容：支持Rails 2.3.x至6.x版本
• 多种输出格式：支持text、html、json、junit等多种报告格式
• 灵活配置：可通过命令行选项或配置文件自定义扫描行为
• 置信度分级：对检测到的漏洞提供高、中、低三级置信度评估

兼容性

• Rails版本：兼容Rails 2.3.x至6.x
• Ruby语法：可分析Ruby 1.8及以上语法编写的代码
• 运行环境：运行时需要至少Ruby 2.3.0

安装方法

使用Docker

直接拉取镜像：

bash
docker pull presidentbeef/brakeman

从源码构建镜像：

bash
git clone https://github.com/presidentbeef/brakeman.git
cd brakeman
docker build . -t brakeman

使用方法

Docker运行方式

基本使用（从Rails应用根目录）

bash
docker run -v "$(pwd)":/code presidentbeef/brakeman

带颜色输出

bash
docker run -v "$(pwd)":/code presidentbeef/brakeman --color

生成HTML报告

bash
docker run -v "$(pwd)":/code presidentbeef/brakeman -o brakeman_results.html

非Rails根目录运行

bash
docker run -v 'path/to/rails/application':/code presidentbeef/brakeman -o brakeman_results.html

本地运行方式（非Docker）

从Rails应用根目录：

bash
brakeman

从非Rails根目录：

bash
brakeman /path/to/rails/application

基本选项

使用brakeman --help查看完整选项列表，常用选项包括：

输出选项

• 指定输出文件：-o output_file，格式由文件扩展名或-f选项指定
• 支持格式：text、html、tabs、json、junit、markdown、csv、codeclimate、sonar
• 多输出文件：brakeman -o output.html -o output.json
• 同时输出到控制台和文件：brakeman --color -o /dev/stdout -o output.json

扫描控制选项

• 抑制信息警告：brakeman -q
• 调试信息：brakeman -d
• 跳过特定检查：brakeman -x CheckName1,CheckName2（如-x DefaultRoutes,Redirect）
• 仅运行特定检查：brakeman -t CheckName1,CheckName2（如-t SQL,ValidationRegex）
• 快速模式（可能遗漏部分漏洞）：brakeman --faster
• 忽略警告和错误的退出码：brakeman --no-exit-on-warn --no-exit-on-error
• 跳过文件/目录：brakeman --skip-files file1,/path1/,path2/

置信度筛选

Brakeman将警告分为三级置信度：

• 高：简单警告或用户输入极可能被不安全使用
• 中：变量使用不安全，但变量可能不是用户输入
• 弱：用户输入间接用于潜在不安全场景

筛选置信度：brakeman -w3（-w后接1-3，1为所有警告，3仅最高置信度警告）

配置文件

Brakeman支持从YAML配置文件读取选项，默认配置路径：

• ./config/brakeman.yml
• ~/.brakeman/config.yml
• /etc/brakeman/config.yml

生成配置文件：brakeman -C [选项]，例如：

bash
brakeman -C --skip-files plugins/

指定配置文件：brakeman -c /path/to/config.yml

持续集成

• Jenkins/Hudson：提供专用插件
• Guard插件：https://github.com/guard/guard-brakeman%E6%94%AF%E6%8C%81%E6%8C%81%E7%BB%AD%E6%B5%8B%E8%AF%95
• GitHub Actions：https://github.com/marketplace?type=actions&query=brakeman

许可证

Brakeman非商业使用免费，详情见COPYING。

相关链接

• 官网：[***]
• ：[]
• 社区聊天：[***]