{"id":15048184,"url":"https://github.com/github/brakeman","last_synced_at":"2025-10-04T08:31:55.648Z","repository":{"id":6769828,"uuid":"8016619","full_name":"github/brakeman","owner":"github","description":"A static analysis security vulnerability scanner for Ruby on Rails applications","archived":true,"fork":true,"pushed_at":"2016-01-05T17:35:07.000Z","size":10915,"stargazers_count":30,"open_issues_count":0,"forks_count":10,"subscribers_count":26,"default_branch":"github","last_synced_at":"2024-09-25T21:08:56.272Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://brakemanscanner.org/","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"presidentbeef/brakeman","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-02-04T21:28:57.000Z","updated_at":"2024-07-31T03:21:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/github/brakeman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fbrakeman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fbrakeman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fbrakeman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fbrakeman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/brakeman/tar.gz/refs/heads/github","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219876581,"owners_count":16554769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T21:08:59.306Z","updated_at":"2025-10-04T08:31:50.136Z","avatar_url":"https://github.com/github.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Brakeman Logo](http://brakemanscanner.org/images/logo_medium.png)\n\n[![Travis CI\nStatus](https://secure.travis-ci.org/presidentbeef/brakeman.png)](https://travis-ci.org/presidentbeef/brakeman)\n[![Code\nClimate](https://codeclimate.com/github/presidentbeef/brakeman.png)](https://codeclimate.com/github/presidentbeef/brakeman)\n\n# Brakeman\n\nBrakeman is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities.\n\nIt works with Rails 2.x, 3.x, and 4.x.\n\nThere is also a [plugin available](http://brakemanscanner.org/docs/jenkins/) for Jenkins/Hudson.\n\nFor even more continuous testing, try the [Guard plugin](https://github.com/guard/guard-brakeman).\n\n# Homepage/News\n\nWebsite: http://brakemanscanner.org/\n\nTwitter: http://twitter.com/brakeman\n\nMailing list: brakeman@librelist.com\n\n# Installation\n\nUsing RubyGems:\n\n    gem install brakeman\n\nUsing Bundler, add to development group in Gemfile and set to not be required automatically:\n\n    group :development do\n      gem 'brakeman', :require =\u003e false\n    end\n\nFrom source:\n\n    gem build brakeman.gemspec\n    gem install brakeman*.gem\n\n## For Slim Users\n\n[Slim v3.0.0](https://github.com/slim-template/slim/blob/master/CHANGES#L12) dropped support for Ruby 1.8.7. Install a version of [`slim`](http://slim-lang.com/) compatible with your Ruby.\n\n| Ruby Version |       `Gemfile`       |              Command Line              |\n|--------------|-----------------------|----------------------------------------|\n| Ruby 1.8.7   | `gem 'slim', '\u003c 3.0'` | `$ gem install slim --version '\u003c 3.0'` |\n| Ruby 1.9+    | `gem 'slim'`          | `$ gem install slim`                   |\n\n# Usage\n\n    brakeman [app_path]\n\nIt is simplest to run Brakeman from the root directory of the Rails application. A path may also be supplied.\n\n# Basic Options\n\nFor a full list of options, use `brakeman --help` or see the OPTIONS.md file.\n\nTo specify an output file for the results:\n\n    brakeman -o output_file\n\nThe output format is determined by the file extension or by using the `-f` option. Current options are: `text`, `html`, `tabs`, `json`, `markdown`, and `csv`.\n\nMultiple output files can be specified:\n\n    brakeman -o output.html -o output.json\n\nTo suppress informational warnings and just output the report:\n\n    brakeman -q\n\nNote all Brakeman output except reports are sent to stderr, making it simple to redirect stdout to a file and just get the report.\n\nTo see all kinds of debugging information:\n\n    brakeman -d\n\nSpecific checks can be skipped, if desired. The name needs to be the correct case. For example, to skip looking for default routes (`DefaultRoutes`):\n\n    brakeman -x DefaultRoutes\n\nMultiple checks should be separated by a comma:\n\n    brakeman -x DefaultRoutes,Redirect\n\nTo do the opposite and only run a certain set of tests:\n\n    brakeman -t SQL,ValidationRegex\n\nIf Brakeman is running a bit slow, try\n\n    brakeman --faster\n\nThis will disable some features, but will probably be much faster (currently it is the same as `--skip-libs --no-branching`). *WARNING*: This may cause Brakeman to miss some vulnerabilities.\n\nBy default, Brakeman will return 0 as an exit code unless something went very wrong. To return an error code when warnings were found:\n\n    brakeman -z\n\nTo skip certain files that Brakeman may have trouble parsing, use:\n\n    brakeman --skip-files file1,file2,etc\n\nTo compare results of a scan with a previous scan, use the JSON output option and then:\n\n    brakeman --compare old_report.json\n\nThis will output JSON with two lists: one of fixed warnings and one of new warnings.\n\nBrakeman will ignore warnings if configured to do so. By default, it looks for a configuration file in `config/brakeman.ignore`.\nTo create and manage this file, use:\n\n    brakeman -I\n\n# Warning information\n\nSee WARNING\\_TYPES for more information on the warnings reported by this tool.\n\n# Warning context\n\nThe HTML output format provides an excerpt from the original application source where a warning was triggered. Due to the processing done while looking for vulnerabilities, the source may not resemble the reported warning and reported line numbers may be slightly off. However, the context still provides a quick look into the code which raised the warning.\n\n# Confidence levels\n\nBrakeman assigns a confidence level to each warning. This provides a rough estimate of how certain the tool is that a given warning is actually a problem. Naturally, these ratings should not be taken as absolute truth.\n\nThere are three levels of confidence:\n\n + High - Either this is a simple warning (boolean value) or user input is very likely being used in unsafe ways.\n + Medium - This generally indicates an unsafe use of a variable, but the variable may or may not be user input.\n + Weak - Typically means user input was indirectly used in a potentially unsafe manner.\n\nTo only get warnings above a given confidence level:\n\n    brakeman -w3\n\nThe `-w` switch takes a number from 1 to 3, with 1 being low (all warnings) and 3 being high (only highest confidence warnings).\n\n# Configuration files\n\nBrakeman options can stored and read from YAML files. To simplify the process of writing a configuration file, the `-C` option will output the currently set options.\n\nOptions passed in on the commandline have priority over configuration files.\n\nThe default config locations are `./config/brakeman.yml`, `~/.brakeman/config.yml`, and `/etc/brakeman/config.yml`\n\nThe `-c` option can be used to specify a configuration file to use.\n\n# Who is Using Brakeman?\n\n* [Code Climate](https://codeclimate.com/)\n* [GitHub](https://github.com/)\n* [Groupon](http://www.groupon.com/)\n* [New Relic](http://newrelic.com)\n* [Twitter](https://twitter.com/)\n\n[..and more!](http://brakemanscanner.org/brakeman_users)\n\n# License\n\nsee MIT-LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fbrakeman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fbrakeman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fbrakeman/lists"}