Easy Viper

About The Project

Easy Viper allows you to build a local Elastic Stack quickly using docker-compose and import data directly from the Kenna VI+ API using Viper.

Built With

• Docker-Compose
• Elastic Stack
• Viper

Getting Started

Prerequisites

Easy Viper was built and tested on nacOS 11.4 and requires the following software:

• Docker
  • Minimum of 4GBs of Ram
• Python3
  • PIP3
  • elasticsearch-loader

Installation

1. Clone the repository

   git clone https://github.com/KennaSecurity/Easy_Viper

2. Edit variables.txt

VI_Plus_API_Key="YourAPIKey"
API="api.kennasecurity.com"

You will need to set the API to match your host as described here. It will default to the base API of api.kennasecurity.com.

Usage

To Start Easy Viper For The First Time

  ./easy_viper.sh build

To Stop Easy Viper

  ./easy_viper.sh down

To Start Easy Viper

  ./easy_viper.sh up

To Update Easy Viper

  ./easy_viper.sh update

To Delete The Easy Viper Stack

  ./easy_viper.sh delete

DashBoard Access

Once the shell script has finished running you can access the Kibana Dashboard at http://localhost:5601/ to start exploring the data.

Roadmap

• Auto Import Dashboards
• Scheduled Viper Runs

Data Notes

Depending on your internet speed and the amount of data requested, startup can take 10 minutes to more than an hour. By Default:

• Bulid Brings In The Last 30 Days Of Data.
• Update Brings In The Last 7 Days Of Data.
• Up Brings In The Last 2 Days Of Data.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Support

Use the issues tab to report any problems or issues.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jerry Gamblin - @jgamblin KennaSecurity - KennaSecurity