Skip to content

Commit 49de7d7

Browse files
authored
Update README.md
1 parent a68516f commit 49de7d7

File tree

1 file changed

+124
-52
lines changed

1 file changed

+124
-52
lines changed

README.md

Lines changed: 124 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,89 @@
11
# EscalateX
22

3-
A Linux privilege escalation scanner built to help security professionals find potential vectors for privilege escalation during penetration tests and security audits.
3+
<div align="center">
44

5-
```
6-
███████╗███████╗ ██████╗ █████╗ ██╗ █████╗ ████████╗███████╗██╗ ██╗
7-
██╔════╝██╔════╝██╔════╝██╔══██╗██║ ██╔══██╗╚══██╔══╝██╔════╝╚██╗██╔╝
8-
█████╗ ███████╗██║ ███████║██║ ███████║ ██║ █████╗ ╚███╔╝
9-
██╔══╝ ╚════██║██║ ██╔══██║██║ ██╔══██║ ██║ ██╔══╝ ██╔██╗
10-
███████╗███████║╚██████╗██║ ██║███████╗██║ ██║ ██║ ███████╗██╔╝ ██╗
11-
╚══════╝╚══════╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═╝
12-
```
5+
![EscalateX Logo](https://img.shields.io/badge/EscalateX-Privilege%20Escalation%20Scanner-red?style=for-the-badge)
6+
[![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
7+
![Bash](https://img.shields.io/badge/Made%20with-Bash-1f425f.svg)
8+
![Platform](https://img.shields.io/badge/Platform-Linux-blue)
9+
![Status](https://img.shields.io/badge/Status-Active-success)
10+
![Downloads](https://img.shields.io/github/downloads/reschjonas/EscalateX/total?color=brightgreen)
11+
12+
![EscalateX Preview](screen.png)
13+
14+
**A powerful Linux privilege escalation scanner for security professionals**
15+
16+
[Installation](#installation)[Usage](#usage)[Features](#what-it-checks-for)[Contributing](#contributing)[Roadmap](#roadmap)
17+
18+
</div>
19+
20+
## 📖 About
21+
22+
EscalateX is a cybersecurity tool designed to identify priviledge escalation vectors on Linux systems. Automating the process of finding potential vulnerabilities and a modern alternative to LinPEAS is the purpose of EscalateX.
1323

14-
## About
24+
The tool is currently in its early development phase. Bugs can and will occur while running the tool - therefore, please report your findings by sending me an email.
1525

16-
EscalateX scans Linux systems for common privilege escalation vulnerabilities and misconfigurations. I built this tool after getting tired of manually checking the same things during every pentest engagement.
26+
### Key Features
1727

18-
What it does:
19-
- Checks system configs, permissions, and security settings
20-
- Identifies SUID/SGID binaries and capabilities that could be abused
21-
- Finds writable files and directories in sensitive locations
22-
- Detects kernel vulnerabilities that might lead to privilege escalation
23-
- Evaluates container escape vectors
28+
-**System Configuration Analysis**: Identifies misconfigurations in system settings
29+
-**Privilege Abuse Detection**: Locates SUID/SGID binaries and dangerous capabilities
30+
-**Filesystem Vulnerability Scanning**: Finds writable files in sensitive locations
31+
-**Kernel Exploit Detection**: Discovers kernel vulnerabilities that could lead to privilege escalation
32+
-**Container Security**: Evaluates potential container escape vectors
2433

25-
## Installation
34+
## 🚀 Installation
2635

27-
Pretty simple setup:
36+
Quick setup in three simple steps:
2837

2938
```bash
30-
# Clone it
39+
# Clone the repository
3140
git clone https://github.com/reschjonas/EscalateX.git
3241

33-
# Go to the directory
42+
# Navigate to the directory
3443
cd EscalateX
3544

3645
# Make it executable
3746
chmod +x escalatex.sh
3847
```
3948

40-
### Requirements
49+
### 📋 Requirements
4150

42-
Runs on most Linux distros with:
51+
Runs on most Linux distributions with:
4352
- Bash 4.0+
44-
- Standard Unix tools (find, grep, ls, etc.)
45-
- The `timeout` command is nice to have but not required
53+
- Standard Unix utilities (find, grep, ls, etc.)
54+
- The `timeout` command (optional but recommended)
4655

47-
## Usage
56+
## 💻 Usage
4857

49-
### Basic Usage
58+
### Basic Operation
5059

51-
Just run it:
60+
Simply run the script:
5261

5362
```bash
5463
./escalatex.sh
5564
```
5665

57-
### More Options
66+
### Advanced Options
5867

5968
```bash
60-
# Run a more thorough scan (takes longer but finds more)
69+
# Run a comprehensive scan (longer but more thorough)
6170
./escalatex.sh --thorough
6271

63-
# Only check for specific things
72+
# Target specific checks only
6473
./escalatex.sh --only system_info,suid_sgid
6574

66-
# Use sudo to get more info
75+
# Use elevated privileges for deeper analysis
6776
./escalatex.sh --multi --password yourpassword
6877

69-
# The kitchen sink (all checks, maximum depth)
78+
# Maximum depth scan for critical systems
7079
./escalatex.sh --extreme
7180
```
7281

7382
### Command Line Options
7483

84+
<details>
85+
<summary><b>Click to expand all options</b></summary>
86+
7587
#### Core Options
7688
- `-a, --all` - Run all checks (thorough mode)
7789
- `-t, --thorough` - More comprehensive but slower scan
@@ -92,36 +104,52 @@ Just run it:
92104
- `-S, --sudo-pass` - Prompt for sudo password for privilege escalation attempts
93105
- `-D, --debug` - Verbose logging
94106
- `-h, --help` - Show help
107+
</details>
108+
109+
## 🔍 What It Checks For
95110

96-
## What It Checks For
111+
<details>
112+
<summary><b>System Information</b></summary>
97113

98-
### System Information
99114
- OS details and kernel version
100115
- Security configurations and patch status
101116
- Hardware info and resource usage
102117
- Filesystem mounts and permissions
103118
- Boot configuration and services
119+
</details>
120+
121+
<details>
122+
<summary><b>User & Permissions</b></summary>
104123

105-
### User & Permissions
106124
- Current user privileges
107125
- User enumeration and group memberships
108126
- Password policy issues
109127
- Sudo rules that could be abused
110128
- Home directory permissions
129+
</details>
130+
131+
<details>
132+
<summary><b>Privilege Escalation Vectors</b></summary>
111133

112-
### Privilege Escalation Vectors
113134
- SUID/SGID binaries (especially exploitable ones)
114135
- Files with dangerous capabilities
115136
- Custom privilege escalation paths
116137
- Container security issues
138+
</details>
139+
140+
<details>
141+
<summary><b>Filesystem Issues</b></summary>
117142

118-
### Filesystem Issues
119143
- Writable files in sensitive locations
120144
- Misconfigured home directory permissions
121145
- PATH manipulation vulnerabilities
122146
- Wildcard injection opportunities
147+
</details>
148+
149+
## 📊 Sample Output
123150

124-
## Sample Output
151+
<details>
152+
<summary><b>Click to see sample scan results</b></summary>
125153

126154
```
127155
┏━━━━━━━━━━━━━━━━━━━━━━━━━━ System Information ━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -160,10 +188,37 @@ Just run it:
160188
161189
Thank you for using EscalateX!
162190
```
191+
</details>
192+
193+
## 🗺️ Roadmap
194+
195+
<div align="center">
196+
197+
### Future Development Plans
198+
199+
</div>
200+
201+
| Feature | Status | Description |
202+
|---------|--------|-------------|
203+
| 📑 **Report Generator** | Planned | Create comprehensive HTML/PDF reports with findings and remediation recommendations |
204+
| 🔍 **Service Version Scanning** | Planned | Identify outdated software versions running as services |
205+
| 🌐 **Real-time CVE Collection** | Planned | Connect to vulnerability databases to map identified software versions to known CVEs |
206+
| 🛠️ **Automatic Vulnerability Exploiter** | Considering | Optional module to automatically exploit identified vulnerabilities |
207+
208+
<div align="center">
209+
210+
### Progress Tracker
211+
212+
![](https://progress-bar.dev/20/?title=Overall%20Progress&width=400&color=e6194B)
213+
214+
</div>
215+
216+
## 🧩 Custom Modules
163217

164-
## Custom Modules
218+
You can extend EscalateX with your own custom modules:
165219

166-
You can write your own modules if you want to check for specific things. Here's how:
220+
<details>
221+
<summary><b>How to create custom modules</b></summary>
167222

168223
1. Create a script in the modules directory
169224
2. Use this basic structure:
@@ -200,17 +255,28 @@ custom_checks() {
200255
```
201256

202257
3. Add your module to loader.sh
258+
</details>
203259

204-
## Important Warning
260+
## ⚠️ Important Warning
205261

206-
This is a security tool. Use it responsibly:
262+
<div align="center">
263+
264+
**This is a security tool. Use it responsibly.**
265+
266+
</div>
267+
268+
- 🔒 Only run it on systems you own or have permission to test
269+
- 🚨 Some checks might trigger security alerts or monitoring
270+
- ⚙️ Be careful in production environments
271+
- 🤝 Don't be a jerk - never use this for unauthorized access
272+
273+
## 📝 License
207274

208-
- Only run it on systems you own or have permission to test
209-
- Some checks might trigger security alerts or monitoring
210-
- Be careful in production environments
211-
- Don't be a jerk - never use this for unauthorized access
275+
<div align="center">
276+
277+
[![License: CC BY-NC 4.0](https://licensebuttons.net/l/by-nc/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc/4.0/)
212278

213-
## License
279+
</div>
214280

215281
This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0) - see the [LICENSE](LICENSE.md) file for details.
216282

@@ -220,12 +286,18 @@ This means you can freely use, modify, and distribute this software, as long as:
220286

221287
For more information, visit: https://creativecommons.org/licenses/by-nc/4.0/
222288

223-
## Contributing
289+
## 👥 Contributing
224290

225-
Contributions welcome! To contribute:
291+
Contributions are welcome and appreciated! To contribute:
226292

227-
1. Fork the repo
293+
1. Fork the repository
228294
2. Create a branch (`git checkout -b cool-new-feature`)
229295
3. Commit your changes (`git commit -m 'Added some cool feature'`)
230296
4. Push to your branch (`git push origin cool-new-feature`)
231-
5. Open a PR
297+
5. Open a Pull Request
298+
299+
<div align="center">
300+
301+
**[⬆ Back to top](#escalatex)**
302+
303+
</div>

0 commit comments

Comments
 (0)