Skip to content

Commit 64d966d

Browse files
authored
Update README.md
1 parent 5be7bce commit 64d966d

1 file changed

Lines changed: 175 additions & 2 deletions

File tree

README.md

Lines changed: 175 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,175 @@
1-
# Detected
2-
Detected : A powerful and user-friendly tool for detecting SQL injection vulnerabilities in web applications, supporting GET/POST requests, custom payloads, cookies, and detailed reporting.
1+
```markdown
2+
# Detected: SQL Injection Testing Tool
3+
4+
![GitHub](https://img.shields.io/github/license/HackfutSec/Detected)
5+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/HackfutSec/Detected)
6+
![GitHub issues](https://img.shields.io/github/issues/HackfutSec/Detected)
7+
![GitHub stars](https://img.shields.io/github/stars/HackfutSec/Detected)
8+
9+
**Detected** is a powerful and user-friendly tool designed to detect SQL injection vulnerabilities in web applications. It supports both GET and POST requests, custom payloads, cookies for authenticated testing, and generates detailed JSON reports.
10+
11+
---
12+
13+
## Features
14+
15+
- **SQL Injection Detection**: Tests input parameters for SQLi vulnerabilities.
16+
- **GET and POST Support**: Allows testing of forms and URLs.
17+
- **Custom Payloads**: Load payloads from a file or use the built-in library.
18+
- **Cookie Management**: Test authenticated endpoints using cookies.
19+
- **Detailed Reporting**: Generates a JSON report of detected vulnerabilities.
20+
- **Multi-threading**: Tests multiple URLs and parameters simultaneously for improved efficiency.
21+
- **Update Checker**: Notifies users of new versions.
22+
23+
---
24+
25+
## Installation
26+
27+
### Prerequisites
28+
29+
- Python 3.7 or higher
30+
- Python libraries: `requests`, `colorama`, `tqdm`, `bs4`
31+
32+
### Installation Steps
33+
34+
1. Clone the repository:
35+
```bash
36+
git clone https://github.com/HackfutSec/Detected.git
37+
cd Detected
38+
```
39+
40+
2. Install dependencies:
41+
```bash
42+
pip install -r requirements.txt
43+
```
44+
45+
3. Run the tool:
46+
```bash
47+
python detected.py
48+
```
49+
50+
---
51+
52+
## Usage
53+
54+
### Testing a Single URL
55+
56+
1. Run the tool:
57+
```bash
58+
python detected.py
59+
```
60+
61+
2. Choose option `1` to test a single URL.
62+
3. Enter the URL, the parameter to test, and choose the method (GET or POST).
63+
4. Use default payloads or load a custom payload file.
64+
5. If needed, provide a cookie file for authenticated testing.
65+
66+
### Testing a File of URLs
67+
68+
1. Run the tool:
69+
```bash
70+
python detected.py
71+
```
72+
73+
2. Choose option `2` to test a file of URLs.
74+
3. Enter the path to the file containing URLs, the parameter to test, and choose the method (GET or POST).
75+
4. Use default payloads or load a custom payload file.
76+
5. If needed, provide a cookie file for authenticated testing.
77+
78+
### Reports
79+
80+
Detected vulnerabilities are logged in `vulnerable_urls.txt`. A detailed report is generated in `report.json`.
81+
82+
---
83+
84+
## Examples
85+
86+
### Testing a URL with Default Payloads
87+
```bash
88+
python detected.py
89+
1
90+
http://example.com/page?id=1
91+
id
92+
1
93+
1
94+
n
95+
```
96+
97+
### Testing a File of URLs with Cookies
98+
```bash
99+
python detected.py
100+
2
101+
urls.txt
102+
id
103+
1
104+
1
105+
y
106+
cookies.json
107+
```
108+
109+
---
110+
111+
## Project Structure
112+
113+
```
114+
Detected/
115+
├── detected.py # Main script
116+
├── requirements.txt # Python dependencies
117+
├── payloads.txt # Example payload file
118+
├── cookies.json # Example cookie file
119+
├── report.json # Generated report
120+
├── vulnerable_urls.txt # Detected vulnerable URLs
121+
└── README.md # Documentation
122+
```
123+
124+
---
125+
126+
## Contributing
127+
128+
Contributions are welcome! To contribute:
129+
130+
1. Fork the repository.
131+
2. Create a branch for your feature (`git checkout -b feature/AmazingFeature`).
132+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
133+
4. Push the branch (`git push origin feature/AmazingFeature`).
134+
5. Open a Pull Request.
135+
136+
---
137+
138+
## License
139+
140+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
141+
142+
---
143+
144+
## Authors
145+
146+
- **HackfutSec** - Lead developer
147+
- **Contributors** - See the list of [contributors](https://github.com/HackfutSec/Detected/contributors).
148+
149+
---
150+
151+
## Acknowledgments
152+
153+
- Thanks to the open-source community for the libraries used in this project.
154+
- Inspired by popular security tools like SQLmap.
155+
156+
---
157+
158+
## Support
159+
160+
For questions or issues, open an [issue](https://github.com/HackfutSec/Detected/issues) on GitHub.
161+
162+
```
163+
164+
---
165+
166+
### Key Points of the README:
167+
1. **Title and Badges**: Shows the project status (version, license, issues, etc.).
168+
2. **Description**: Briefly explains what the tool is and its main features.
169+
3. **Installation**: Provides clear instructions for installing and setting up the tool.
170+
4. **Usage**: Offers practical examples for testing URLs and files.
171+
5. **Project Structure**: Describes the organization of files in the repository.
172+
6. **Contributing**: Encourages contributions and explains how to contribute.
173+
7. **License**: Specifies the project license.
174+
8. **Authors and Acknowledgments**: Recognizes contributors and inspirations.
175+
9. **Support**: Indicates how to get help.

0 commit comments

Comments
 (0)