daqc commited on
Commit
27764bf
Β·
verified Β·
1 Parent(s): 52b089b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -81
README.md CHANGED
@@ -1,83 +1,14 @@
1
- # Open Deep Research Vulnerability Intelligence
2
-
3
- **Open Deep Research Vulnerability Intelligence** is an AI-powered platform for automated vulnerability and threat intelligence research, built on [Hugging Face's Open Deep Research](https://huggingface.co/blog/open-deep-research) architecture.
4
-
5
- ## 🎯 What it does
6
-
7
- This AI agent specializes in automated vulnerability research and analysis. It searches across multiple security databases to provide comprehensive vulnerability intelligence reports with CVSS scores, EPSS predictions, and remediation advice.
8
-
9
- ## 🎯 Motivation
10
-
11
- The rapid growth of software systems and the increasing complexity of digital infrastructures have led to an explosion in the number and diversity of software vulnerabilities. Traditional manual approaches to vulnerability intelligence are no longer sufficient to keep pace with the evolving threat landscape. There is a critical need for automated, scalable, and intelligent systems that can:
12
-
13
- - Aggregate and correlate data from multiple heterogeneous sources (NVD, CVEDB, KEV, EPSS, etc.)
14
- - Provide timely, actionable insights for security analysts and decision-makers
15
- - Reduce the cognitive load and manual effort required for vulnerability triage and reporting
16
- - Enable reproducible, transparent, and explainable research in vulnerability intelligence
17
-
18
- This project addresses these challenges by leveraging state-of-the-art language models and multi-source data aggregation, providing a research-grade platform for both academic and industry use.
19
-
20
- ## πŸ› οΈ Available Tools & APIs
21
-
22
- - **πŸ›‘οΈ [NIST NVD](https://nvd.nist.gov/)** - National Vulnerability Database (free API)
23
- - **πŸ“Š [Shodan CVEDB](https://cvedb.com/)** - Comprehensive vulnerability database (free API)
24
- - **⚠️ [KEVin](https://kevin.gtfkd.com/)** - Known Exploited Vulnerabilities database (free API)
25
- - **πŸ“ˆ [EPSS](https://www.first.org/epss/)** - Exploit Prediction Scoring System (free API)
26
- - **🌐 Web Browser** - Navigate and extract information from web pages
27
-
28
- ## πŸš€ Features
29
-
30
- - **Multi-Source Intelligence**: Searches NVD, CVEDB, KEV, EPSS, and web sources
31
- - **Smart Product Detection**: Automatically strips version numbers for accurate searches
32
- - **Comprehensive Reports**: Generates detailed vulnerability reports with hyperlinks
33
- - **Session Management**: Secure API key handling with session-based storage
34
- - **Responsive UI**: Works on desktop and mobile devices
35
- - **Example Prompts**: Built-in examples to get started quickly
36
-
37
- ## πŸ“‹ Requirements
38
-
39
- - Python 3.8+
40
- - Hugging Face API key (free)
41
- - Internet connection
42
- - **Optional**: [Ollama](https://ollama.ai/) for local model inference
43
-
44
- ## πŸš€ Quick Start
45
-
46
- ```bash
47
- # Clone the repository
48
- git clone https://github.com/mcdaqc/open-deep-research-vulnerability-intelligence.git
49
- cd open-deep-research-vulnerability-intelligence
50
-
51
- # Create virtual environment
52
- python -m venv venv
53
- venv\Scripts\activate # Windows
54
- # source venv/bin/activate # Linux/Mac
55
-
56
- # Install dependencies
57
- pip install -r requirements.txt
58
-
59
- # Run the application
60
- python app.py
61
- ```
62
-
63
-
64
-
65
-
66
-
67
- ## πŸ—οΈ Project Structure
68
-
69
- ```
70
- β”œβ”€β”€ app.py # Main application with Gradio UI
71
- β”œβ”€β”€ scripts/ # Tool implementations
72
- β”œβ”€β”€ cvedb_tool.py # Shodan CVEDB integration
73
- β”œβ”€β”€ nvd_tool.py # NIST NVD integration
74
- β”œβ”€β”€ kevin_tool.py # KEVin database integration
75
- β”œβ”€β”€ epss_tool.py # EPSS scoring integration
76
- └── text_web_browser.py # Web browsing capabilities
77
- ```
78
-
79
-
80
-
81
  ---
82
 
83
- **Powered by** <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/smolagents/mascot_smol.png" width="20" height="20" style="vertical-align: middle; margin-right: 8px;"> **[hf/smolagents](https://github.com/huggingface/smolagents)**
 
1
+ ---
2
+ title: open deep-research vulnerability intelligence
3
+ emoji: πŸ‘Ύ
4
+ colorFrom: yellow
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: 5.25.2
8
+ app_file: app.py
9
+ pinned: true
10
+ license: apache-2.0
11
+ short_description: Open Deep Research, but for vulnerability intelligence
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  ---
13
 
14
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference