Git Product home page Git Product logo

cve-db's Introduction

CVE-DB

Version: 1.0

Authors: Ramin Mammadov, Nihad Goylarov, Toghrul Mustafali, Mahammadali Kazimov

Copyright: Copyright (C) 2024 Group E, CH3, AKM.

License: Public Domain

Documentation Structure:

  1. Copyright Information
  2. Dependencies
  3. Features
  4. Installation
  5. Usage
  6. Usage Example
  7. Code Overview
  8. Additional Code
  9. Scrapper

Introduction:

This documentation provides information about a CVE (Common Vulnerabilities and Exposures) scraper tool. The tool allows users to retrieve information about CVEs from various sources, generate outputs, and download related exploits.

Dependencies:

  • Python 3.x
  • Requests library
  • Beautiful Soup (bs4)

Features:

  1. Retrieve information about CVEs from multiple sources.
  2. Check the existence and publication status of a CVE.
  3. Generate outputs in various formats, including PDF, HTML, TXT, and CLI.
  4. Option to download related exploits.

Installation:

No installation is required other than ensuring that Python 3.x is installed along with the Requests and Beautiful Soup (bs4) libraries.

Usage:

  1. Run the script in a Python environment.
  2. Follow the prompts to enter the CVE ID.
  3. Choose the desired sources to retrieve information from.
  4. Select the output formats for the generated report.
  5. Optionally, choose to download related exploits.

Usage Example:

  • To use the script, provide a valid CVE ID when prompted. ##Validation process
  1. Clear Screen: Clears the terminal screen for better user interaction.
  2. Validate User Input: Verifies the format of the user-provided CVE ID, ensuring it adheres to the CVE standard (e.g., CVE-YYYY-NNNN).
  3. Check CVE Existence: Utilizes the MITRE API to determine if the CVE exists.
  4. Check CVE Publication Status: Verifies if the CVE is published or not.
  5. Retrieve Information: Scrapes detailed information about the CVE from selected sources.
  6. Generate Output: Provides options to generate output in PDF, HTML, TXT, and CLI formats.
  7. Terminate: Properly exits the script when execution is complete.

Usage:

  1. Launch the script in a Python environment.
  2. Enter the CVE ID when prompted by the script.
  3. The script validates the entered CVE ID format and ensures it adheres to the standard (CVE-YYYY-NNNN).
  4. If the input is invalid or out of scope (e.g., invalid year or ID), appropriate error messages are displayed, and the script exits.
  5. Select desired information sources from the available options.
  6. Choose the output format(s) you prefer.
  7. Output files will be generated in the 'output' directory for further analysis and reference.
  • Choose the desired sources (NIST, MITRE CVE, Vulmon DB) to retrieve information from.
  • Select the output types (PDF, HTML, TXT, Console) for the generated report.

Overview:

  • The script begins by clearing the screen and initializing necessary modules and variables.
  • It validates the user input for the CVE ID using regular expressions.
  • Checks whether the CVE exists and is published using the MITRE API.
  • Retrieves information from user-selected sources (NIST, MITRE, Vulmon).
  • Provides an option to download related exploits.
  • Generates outputs in various formats based on user preferences.
  1. CVE Information Scraper

Overview: The CVE Information Scraper is a Python script designed to retrieve comprehensive information about Common Vulnerabilities and Exposures (CVE) entries from various sources. This tool is developed to assist security professionals in accessing CVE details efficiently.

Functionality:

  1. Scrapping Functions: The script contains functions to scrape CVE information from multiple sources, including MITRE, NIST, and Vulmon.
  2. Multithreading: Utilizes multithreading for simultaneous scraping and displaying progress.
  3. JSON Output: Stores the scraped information in a JSON file named "scrap_result.json" for further analysis.

Dependencies: The script relies on the following libraries and modules:

  • BeautifulSoup (bs4): For HTML parsing.
  • lib.colors: Defines color codes for terminal output.
  • threading: Implements multithreading for concurrent execution.
  • requests: For making HTTP requests.
  • time: Handles time-related tasks.
  • re: Performs regular expression operations.
  • json: Deals with JSON data.

Usage:

  1. Launch the script in a Python environment.
  2. Enter the CVE ID when prompted by the script.
  3. The script scrapes information from multiple sources simultaneously.
  4. Progress of each scraping process is displayed in the terminal.
  5. Once the scraping is complete, the consolidated results are stored in the "scrap_result.json" file.

cve-db's People

Contributors

memokazim avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.