Skip to content

Commit d6285bc

Browse files
xaitaxxaitax
committed
Update README.md
1 parent 1936e65 commit d6285bc

1 file changed

Lines changed: 145 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 145 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@
66

77
SploitScan is a powerful and user-friendly tool designed to streamline the process of identifying exploits for known vulnerabilities and their respective exploitation probability. Empowering cybersecurity professionals with the capability to swiftly identify and apply known and test exploits. It's particularly valuable for professionals seeking to enhance their security measures or develop robust detection strategies against emerging threats.
88

9+
## 📖 Table of contents
10+
11+
- 📜 [Description](#-description)
12+
- 🌟 [Features](#-features)
13+
- 💣 [Supported Exploit Databases](#-supported-exploit-databases)
14+
- 📁 [Supported Vulnerability Scanner Import](#-supported-vulnerability-scanner-import)
15+
- ⚙️ [Installation](#️-installation)
16+
- 🚀 [Usage](#-usage)
17+
- 🤖 [AI-Powered Risk Assessment](#-ai-powered-risk-assessment)
18+
- 🛡️ [Patching Priority System](#️-patching-priority-system)
19+
- 📆 [Changelog](#-changelog)
20+
- 🫱🏼‍🫲🏽 [Contributing](#-contributing)
21+
- 📌 [Author](#-author)
22+
- 📚 [References](#-references)
23+
924
## 🌟 Features
1025

1126
- **CVE Information Retrieval**: Fetches CVE details from the National Vulnerability Database.
@@ -34,12 +49,47 @@ SploitScan is a powerful and user-friendly tool designed to streamline the proce
3449
- **[OpenVAS](https://www.openvas.org/) (.xml)**
3550
- **[Docker](https://docs.docker.com/scout/) (.json)**
3651

37-
## 🚀 Usage
52+
## ⚙️ Installation
53+
54+
### GitHub
55+
56+
```shell
57+
git clone https://github.com/xaitax/SploitScan.git
58+
pip install -r requirements.txt
59+
cd sploitscan
60+
```
61+
62+
### pip
63+
64+
```shell
65+
pip install --user sploitscan
66+
```
3867

39-
### Installation
68+
### Kali/Ubuntu/Debian
69+
70+
```shell
71+
apt install sploitscan
72+
```
73+
74+
### Configuration File
75+
76+
Create a `config.json` file in one of the following locations with your API keys:
77+
78+
- Current directory
79+
- `~/.sploitscan/`
80+
- `~/.config/sploitscan/`
81+
- `/etc/sploitscan/`
82+
83+
```json
84+
{
85+
"vulncheck_api_key": "your_vulncheck_api_key",
86+
"openai_api_key": "your_openai_api_key"
87+
}
88+
```
89+
90+
## 🚀 Usage
4091

4192
```shell
42-
$ pip install --user sploitscan
4393
$ sploitscan
4494

4595
███████╗██████╗ ██╗ ██████╗ ██╗████████╗███████╗ ██████╗ █████╗ ███╗ ██╗
@@ -53,46 +103,121 @@ v0.9 / Alexander Hagenah / @xaitax / ah@primepage.de
53103
❌ No CVE IDs provided. Please provide CVE IDs or an import file and type.
54104
```
55105

56-
### Regular
106+
### Single CVE Query
57107

58108
```bash
59-
python sploitscan.py CVE-YYYY-NNNNN
109+
sploitscan CVE-2024-1709
60110
```
61111

62-
**Enter one or more CVE IDs to fetch data. Separate multiple CVE IDs with spaces.**
112+
### Multiple CVE Query
63113

64114
```bash
65-
python sploitscan.py CVE-YYYY-NNNNN CVE-YYYY-NNNNN
115+
sploitscan CVE-2024-1709 CVE-2024-21413
66116
```
67117

68-
**Optional: Import functionality. Specify the type: 'nessus', 'nexpose', 'openvas' or 'docker' and import file.**
118+
### Import from Vulnerability Scanner
119+
120+
Specify the type: 'nessus', 'nexpose', 'openvas', or 'docker' and provide the file path.
69121

70122
```bash
71-
python sploitscan.py --import-file path/to/yourfile.nessus --type nessus
123+
sploitscan --import-file path/to/yourfile.nessus --type nessus
72124
```
73125

74-
**Optional: Export the results to a JSON, CSV or HTML file. Specify the format: 'json', 'csv' or 'html'.**
126+
### Export Results
127+
128+
Specify the export format: 'json', 'csv', or 'html'.
75129

76130
```bash
77-
python sploitscan.py CVE-YYYY-NNNNN -e HTML
131+
sploitscan CVE-2024-1709 -e html
78132
```
79133

80134
### Docker
81135

82136
```shell
83-
$ docker build -t sploitscan .
84-
$ docker run --rm sploitscan CVE-2024-1709
137+
docker build -t sploitscan .
138+
docker run --rm sploitscan CVE-2024-1709
139+
```
85140

86141
With a volume mounted from the current directory
87142

88-
Windows (Powershell)
89-
$ docker run -v ${PWD}:/app --rm sploitscan CVE-2024-1709 -e JSON
143+
#### Windows (Powershell)
144+
145+
```shell
146+
docker run -v ${PWD}:/app --rm sploitscan CVE-2024-1709 -e JSON
147+
```
148+
149+
#### Linux
150+
151+
```shell
152+
docker run -v $(pwd):/app --rm sploitscan CVE-2024-1709 -e JSON
153+
```
154+
155+
## 🤖 AI-Powered Risk Assessment
156+
157+
SploitScan integrates with OpenAI to provide a comprehensive AI-powered risk assessment for each CVE. This feature includes:
158+
159+
- Detailed Risk Assessment: Understand the nature of the vulnerability and its business impact.
160+
- Potential Attack Scenarios: Get descriptions of potential attack scenarios leveraging the vulnerability.
161+
- Mitigation Recommendations: Receive specific, actionable recommendations to mitigate the risk.
162+
- Executive Summary: A concise summary accessible to non-technical stakeholders, highlighting the business impact and urgency.
90163

91-
Linux
92-
$ docker run -v $(pwd):/app --rm sploitscan CVE-2024-1709 -e JSON
164+
### Example output
165+
166+
```shell
167+
168+
$ sploitscan.py CVE-2024-21413
169+
170+
[...]
171+
172+
┌───[ 🤖 AI-Powered Risk Assessment ]
173+
|
174+
| 1. Risk Assessment
175+
| -------------------
176+
| The vulnerability identified by CVE-2024-21413 is a critical remote code execution flaw in
177+
| Microsoft Outlook with a CVSS score of 9.8. The impact on business operations can be severe due to
178+
| its high potential to be exploited over a network without any user interactions or elevated
179+
| privileges. This unvalidated input vulnerability (CWE-20) could allow an attacker to execute
180+
| arbitrary code on the target system, thereby compromising the confidentiality, integrity, and
181+
| availability of critical business data and systems. Given its critical rating and the existence of
182+
| multiple exploits on public repositories like GitHub, the likelihood of exploitation is very high.
183+
| This necessitates immediate attention from the security teams to mitigate the risks associated.
184+
|
185+
| 2. Potential Attack Scenarios
186+
| ------------------------------
187+
| An attacker could exploit this vulnerability by sending a specially crafted email to a victim
188+
| using Microsoft Outlook. Once the email is opened or previewed, the malicious payload would
189+
| execute, allowing the attacker to gain control over the victim's system. The process involves: 1.
190+
| Crafting a malicious email leveraging the specific flaw in email handling within Microsoft
191+
| Outlook. 2. Sending the email to the intended victim. 3. Upon opening or previewing the email, the
192+
| victim’s system executes the malicious code. The potential outcomes of this attack include theft
193+
| of sensitive information, installation of malware or ransomware, and compromising other systems
194+
| within the same network due to lateral movement capabilities.
195+
|
196+
| 3. Mitigation Recommendations
197+
| ------------------------------
198+
| Immediate mitigation recommendation includes: 1. Applying the latest security patches provided by
199+
| Microsoft. Reference: https://msrc.microsoft.com/update-guide/vulnerability/CVE-2024-21413 2.
200+
| Implementing network-level protections such as email filtering and network segmentation to limit
201+
| the spread of potential infections. 3. Conducting regular security awareness training for users to
202+
| recognize phishing and malicious emails. 4. Monitoring network and system activity for signs of
203+
| suspicious behavior and unauthorized execution. 5. Regularly backing up critical data and ensuring
204+
| the integrity of backups.
205+
|
206+
| 4. Executive Summary
207+
| ---------------------
208+
| CVE-2024-21413, a critical remote code execution vulnerability in Microsoft Outlook, poses a
209+
| significant risk to businesses due to its potential to be exploited without user interaction.
210+
| Multiple exploit proofs are publicly available, increasing the likelihood of attacks.
211+
| Organizations must act swiftly by applying the necessary patches from Microsoft, enhancing their
212+
| email security protocols, and educating their staff to identify potential phishing attempts.
213+
| Mitigating this vulnerability is essential to protect sensitive information, maintain business
214+
| integrity, and ensure system availability, thus preventing potential financial and reputational
215+
| damage. Immediate action is crucial to safeguard the organization against this severe threat.
216+
|
217+
└────────────────────────────────────────
93218
```
94219
95-
## 🛡️ Patching Prioritization System
220+
## 🛡️ Patching Priority System
96221
97222
The Patching Prioritization System in SploitScan provides a strategic approach to prioritizing security patches based on the severity and exploitability of vulnerabilities. It's influenced by the model from [CVE Prioritizer](https://github.com/TURROKS/CVE_Prioritizer), with enhancements for handling publicly available exploits. Here's how it works:
98223
@@ -170,6 +295,8 @@ This system assists users in making informed decisions on which vulnerabilities
170295

171296
Contributions are welcome. Please feel free to fork, modify, and make pull requests or report issues.
172297

298+
Special thanks to:
299+
173300
- [Nilsonfsilva](https://github.com/Nilsonfsilva) for support on Debian packaging.
174301
- [bcoles](https://github.com/bcoles) for bugfixes.
175302
- [Javier Álvarez](https://github.com/jalvarezz13) for bugfixes.

0 commit comments

Comments
 (0)