vulnreport: Open-source pentesting management and automation platform
Vulnreport
Pentesting management and automation platform
Vulnreport is a platform for managing penetration tests and generating well-formatted, actionable findings reports without the normal overhead that takes up security engineer’s time. The platform is built to support automation at every stage of the process and allow customization for whatever other systems you use as part of your pentesting process.
Vulnreport was built by the Salesforce Product Security team as a way to get rid of the time we spent writing, formatting, and proofing reports for penetration tests. Our goal was and continues to be to build great security tools that let pentesters and security engineers focus on finding and fixing vulns.
For full documentation, see http://vulnreport.io/documentation
Deployment
Vulnreport is a Ruby web application (Sinatra/Rack stack) backed by a PostgreSQL database with a Redis cache layer.
Vulnreport can be installed on a local VM or server behind something like nginx, or can be deployed to Heroku.
Local Deploy / Your own server
To deploy locally, you’ll need to make sure you have installed the dependencies:
- Ruby >= 2.1
- PostgreSQL
- Redis
- Rollbar
- Bundler
Clone the repo and open up the .env file, updating it as necessary. The run bundle install
. You’ll probably want to modify start.sh
to make it work for your environment – the one included in the repo is intended to be used for local use during debugging/development.
You should also create a .env file based on .env.example, or set the same ENV variables defined in .env in your environment.
Installation
To handle the initial configuration for Vulnreport, run the SEED.rb
script. If you are deploying on Heroku, run this via heroku run ./SEED.rb
.
If you used the automated ‘Deploy to Heroku’ feature, this step should have been handled for you automatically.