VulScrape
VulScrape is a source code vulnerability detection and prediction tool.
Install / Use
/learn @Saleh-Ibtasham/VulScrapeREADME
VulScrape
Table of Contents
About The Project
VulScrape is a vulnerability detection & prediction tool for forecasting exploits of common vulnerabilities found in source code written in C/C++. The tool is created as a Google Chrome extension for ease of use.
This project is inspired by the works of Li, Zhen, et al. (2021) & Fang, Yong, et al. (2020). The web extension integrates the vulnerability detection methodology from Li, Zhen, et al. (2018) where they used a deep neural network to detect code vulnerabilities and exploit prediction methodology from Fang, Yong, et al. (2020)'s ensemble machine learning algorithm.
All vulnerabilities that can be detected by VulScrape are listed under the National Vulnerability Database's CVE listing.
<p align="right"><a href="#vulscrape">back to top</a></p>Technologies
This section describes the essential packages and frameworks used for the project.
- Python 3.7
- Django 3.1
- Joern 0.3
- Neo4j 2.1.8
- TensorFlow 1.14
- Gensim 3.8.3
- PostgreSQL
- React
- Material-UI
Web App Demo
<table style="width:100%" class="center"> <tr> <th colspan = "100%">Pick the detection module and find vulnerabilities from your code!!</th> </tr> <tr> <td><img src="documentation/demo/1.png"/></td> <td><img src="documentation/demo/2.png"/></td> </tr> <tr> <th colspan = "100%">Detect vulnerability as using any one of the two models!</th> </tr> <tr> <td><img src="documentation/demo/3.png"/></td> <td><img src="documentation/demo/4.png"/></td> </tr> <tr> <th colspan = "100%">Convenient storage option for the detailed report!</th> </tr> <tr> <td><img src="documentation/demo/5.png"/></td> <td><img src="documentation/demo/6.png"/></td> </tr> <tr> <th colspan = "100%">Predict exploits for any detected vulnerabilities using their IDs!</th> </tr> <tr> <td><img src="documentation/demo/7.png"/></td> <td><img src="documentation/demo/8.png"/></td> </tr> <tr> <th colspan = "100%">Save the risk of any exploit for future reference...</th> </tr> <tr> <td><img src="documentation/demo/9.png"/></td> <td><img src="documentation/demo/10.png"/></td> </tr> </table> <p align="right"><a href="#partocalc">back to top</a></p>Getting Started
Installation
- Download the compressed extension from here.
- Extract the extension with WinRAR or 7zip.
- Load the extension from Google Chrome's manage extensions option.
- Clone the project repo
git clone https://github.com/Saleh-Ibtasham/VulScrape.git
Usage
-
Specify the ".joernIndex" folder in joern
-
Turn on Joern and Neo4j database locally
-
Run the downloaded Django project repo in the background
-
Open the extension in Google Chrome
For detailed extension instructions, please refer to the user manual section at the end of the Documentation
Acknowledgements
Included here are the projects that inspired this work:
<p align="right"><a href="#vulscrape">back to top</a></p>License
Copyright 2021 Md Saleh Ibtasham
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Connect With Me
<img alt="md-saleh-ibtasham" src="https://img.shields.io/badge/website-000000?style=for-the-badge&logoColor=white" /> <img alt="md-saleh-ibtasham | LinkedIn" src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
<p align="right"><a href="#vulscrape">back to top</a></p>