Update README.md
Browse files
README.md
CHANGED
@@ -1,83 +1,14 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
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 |
-
|
|
|
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
|