🕵️‍♂️ Keylogger Client-Server (Cybersecurity Education)

A lightweight keylogger project for educational and ethical penetration testing purposes. It consists of a Windows-based client that logs keystrokes and sends them to a Flask server for centralized storage and review.

---

📁 Project Structure

keylogger-project/
├── client/
│   ├── keylogger.py            # Main keylogger script
│   ├── auto_start.py           # Adds the .exe to Windows startup
│   ├── remote_sender.py        # Sends logs to the server
│   ├── setup_client.py         # Combines all logic and sets up the client
│   └── uninstall_keylogger.py  # Cleanly removes the keylogger
├── server/
│   ├── log_receiver.py         # Flask server that receives logs
│   └── received_logs/          # Where received logs are stored
├── icons/
│   └── icon.ico                # Optional icon for the executable
├── README.md                   # Project documentation
├── requirements.txt            # Required Python dependencies
└── LICENSE                     # License information (MIT recommended)

---

🚀 How It Works

• The keylogger logs keystrokes and saves them locally in captured_keys.log
• Every X minutes, logs are sent via HTTP POST to the Flask server
• The server stores them in timestamped files inside received_logs/

---

🛠️ Getting Started

Server Setup (Receiver)

1. Navigate to the server/ directory.
2. Install dependencies:

   pip install -r ../requirements.txt

3. Run the server:

   python log_receiver.py

Client Setup (Keylogger)

1. Customize remote_sender.py with your server IP address.
2. Use PyInstaller to build the keylogger:

   pyinstaller --onefile --noconsole --icon=icons/icon.ico setup_client.py

3. Transfer and run the .exe on the target Windows machine.

---

🧼 Uninstallation

Run the following to remove the keylogger and all its traces:

python uninstall_keylogger.py

---

⚠️ Disclaimer

This project is strictly for educational use only. Unauthorized deployment of keyloggers is illegal and unethical. Always obtain proper consent.

---

📄 License

This project is open-source and available under the MIT License.