vile-brakeman

A Vile plugin for finding security vulnerabilities in your Rails code (via Brakeman).

Requirements

• Node.js
• Ruby

Installation

Currently, you need to have brakeman installed manually.

Example:

npm i -D vile vile-brakeman
gem install brakeman

Note: A good strategy is to use Bundler.

Configuration

Currently, you have to do all your config via a .brakeman.yml config file.

You can specify the config file path like this:

brakeman:
  config: .brakeman.yml

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

1. Please consider tests and code quality before submitting.
2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

• Brent Lintner - @brentlintner

Architecture

This project is currently written in JavaScript. Brakeman provides a JSON CLI output that is currently used until a more ideal IPC option is implemented.

• bin houses any shell based scripts
• src is es6+ syntax compiled with Babel
• lib generated js library
• test any test related code written in coffeescript
• .test generated js test code

Developing

cd vile-brakeman
npm install
gem install brakeman
npm run dev
npm test