Home

Welcome to the spyware-detector wiki!

Spyware Detector Wiki

Overview

Spyware Detector is a backend service built with Node.js and Express.js. It scans files for potential spyware threats and logs the results. The project supports file uploads, validation, and logging features.

Features

• File upload support using Multer
• Input validation with Express Validator
• Logging with Winston
• Environment variable management via Dotenv
• API endpoints for scanning and retrieving logs

Installation

Prerequisites

• Node.js and npm (or pnpm)
• Docker (if using containers)

Steps

1. Clone the repository:

   git clone https://github.com/ahmed-n-abdeltwab/spyware-detector.git
   cd spyware-detector/backend
2. Install dependencies:

   npm install  # or pnpm install
3. Set up environment variables: Create a .env file and configure it as needed.
4. Start the server:

   npm start

API Endpoints

1. Upload a File

POST /api/upload

Description: Uploads a file for spyware scanning.

Request Body:

• file (multipart/form-data) - The file to scan

Response:

• Success: { "message": "File uploaded successfully", "scanResult": "..." }
• Error: { "error": "Invalid file format" }

2. Get Scan Logs

GET /api/logs

Description: Retrieves scan logs.

Response:

• Success: { "logs": [...] }

Development Guide

Linting & Formatting

npm run lint   # Check for linting errors
npm run format # Format code using Prettier

Running with Docker

docker-compose up --build

Contributing

See CONTRIBUTING.md for details.

Security

For security guidelines, refer to SECURITY.md.