System Requirements Document (SRD)

Project Name: feral-keylogger

1. Introduction

The feral-keylogger project is designed to provide a practical understanding of keylogger functionality within legal boundaries. This document outlines the system requirements for developing a keylogger tool that operates responsibly and securely, adhering to ethical and legal standards.

The project is intended for educational purposes, enabling users to explore the mechanics of keylogging in a controlled environment. The tool will be designed to log keyboard inputs and other relevant data on an Android device, while ensuring it is used exclusively for personal learning or cybersecurity research.

Prabhdeep Singh, based in India, is the primary user of this project, and the system will be tailored to meet his requirements and locale-specific considerations.

2. System Overview

The feral-keylogger system will consist of two main components:

1. Keylogger Application: A lightweight application installed on an Android device to capture keyboard inputs and other specified data.
2. Remote Monitoring Dashboard: A web-based interface accessible from a laptop, allowing the user to view and analyze logged data securely.

The system will prioritize stealth, ensuring the keylogger operates discreetly without being visible on the Android device. However, it will include safeguards to prevent misuse and ensure compliance with legal and ethical standards.

3. Functional Requirements

Keylogger Functionality

• As a User, I should be able to log keyboard inputs from my Android device.
• As a User, I should be able to capture touch events on the Android device.
• As a User, I should be able to view logged data remotely from my laptop.
• As a User, I should be able to ensure the keylogger operates discreetly without being visible on the Android device.
• As a User, I should be able to configure the keylogger to operate within legal boundaries.

Remote Monitoring Dashboard

• As a User, I should be able to access a secure web-based dashboard to view and analyze logged data.
• As a User, I should be able to filter logged data by time, type, or device.
• As a User, I should be able to export logged data for further analysis.

4. User Personas

Persona 1: Educational Researcher

• Description: A cybersecurity enthusiast exploring keylogger functionality for personal learning and practical understanding.
• Goals: To understand how keyloggers work, test their functionality, and analyze logged data in a controlled environment.
• Needs: A discreet, secure, and legally compliant tool for logging and monitoring data.

5. Visuals Colors and Theme

Color Palette

The feral-keylogger project will adopt a sleek, stealthy theme to reflect its discreet nature. The color palette includes:

• Background: #1A1A1D (Dark Charcoal)
• Surface: #333333 (Gunmetal Gray)
• Text: #EAEAEA (Soft White)
• Accent: #FF4500 (Burnt Orange)
• Muted Tones: #808080 (Neutral Gray)

6. Signature Design Concept

Concept: "Digital Shadows"

The homepage of the feral-keylogger dashboard will feature a dynamic, interactive design inspired by the concept of shadows and stealth.

• Visuals: The background will simulate a flowing shadow effect, with subtle gradients shifting between dark charcoal and gunmetal gray.
• Animations: As users move their cursor, the shadows will ripple and distort slightly, creating a sense of depth and motion.
• Micro-Interactions: Buttons and icons will "glow" with a burnt orange accent when hovered over, emphasizing the stealthy theme.
• Dashboard Layout: The dashboard will resemble a futuristic control panel, with data displayed in modular cards that can be rearranged and resized.
• Transitions: Smooth fade-ins and slide animations will enhance the user experience, making interactions feel seamless and intuitive.

This design will make the feral-keylogger dashboard visually striking and memorable, while reinforcing its discreet and sophisticated identity.

7. Non-Functional Requirements

• The system must operate discreetly without being visible on the Android device.
• The system must ensure secure communication between the keylogger and the remote dashboard.
• The system must comply with legal and ethical standards for cybersecurity tools.
• The system must be lightweight and optimized for performance on Android devices.
• The dashboard must be responsive and accessible across different screen sizes.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (preferred for structured data storage)
• Alembic for database migrations

AI Tools

• GPT 5.4 for user-friendly responses in the dashboard

Local Orchestration

• Docker
• docker-compose

9. Assumptions and Constraints

Assumptions

• The keylogger will be used exclusively for personal learning or cybersecurity research within legal boundaries.
• The user has access to a laptop and an Android device for testing.
• The user has basic knowledge of cybersecurity and programming.

Constraints

• The system must not violate privacy laws or ethical standards.
• The keylogger must operate discreetly without being detectable by the Android device's user interface.
• The dashboard must be secure and accessible only to authorized users.

10. Glossary

• Keylogger: A software tool that records keyboard inputs on a device.
• Dashboard: A web-based interface for viewing and analyzing logged data.
• Stealth: The ability to operate discreetly without being visible or detectable.
• Legal Boundaries: Adherence to laws and regulations governing the use of cybersecurity tools.
• Cybersecurity Research: The study and testing of tools and techniques to understand and improve digital security.