Skip to content

awaissaddiqui/WebSentry

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ›‘οΈ SecureScout - Full-featured Web Security Scanning Platform

SecureScout Logo

FastAPI Vue.js Element Plus Tailwind CSS Chart.js

SecureScout is a powerful web security scanning tool that provides a beautiful light-themed frontend interface and robust backend scanning capabilities. It helps you detect common website security vulnerabilities, including SQL injection, XSS cross-site scripting, CSRF cross-site request forgery, file upload vulnerabilities, and more.

πŸ” Security Scanning Β· Vulnerability Analysis Β· Security Scoring Β· Remediation Suggestions

✨ Features

🌟 Feature πŸ“ Description
🎨 Beautiful User Interface Modern light theme design, data visualization dashboard, intuitive and easy to use
πŸš€ Powerful Scanning Engine Supports detection of common web vulnerabilities such as SQL injection, XSS, CSRF, file upload, etc.
⚑ Asynchronous Task Processing Supports parallel processing of multiple scan tasks for efficient scanning
πŸ“Š Detailed Reports Provides visual scan results and security suggestions, including vulnerability distribution, security scores, etc.
βš™οΈ Custom Configuration Allows users to customize scan parameters and rules for flexible adaptation to different scenarios
πŸ“± Responsive Design Perfectly supports desktop and mobile, enabling security scanning anytime, anywhere

πŸ”§ Tech Stack

πŸ–₯️ Backend

  • FastAPI: Fast and efficient API framework
  • aiohttp: Asynchronous HTTP client/server
  • BeautifulSoup4: HTML parsing library
  • Uvicorn: ASGI server

🎨 Frontend

  • Vue 3: Progressive JavaScript framework
  • Vite: Modern frontend build tool
  • Element Plus: UI component library
  • Tailwind CSS: Utility-first CSS framework
  • Chart.js: Data visualization library

πŸš€ Quick Start

πŸ“‹ Requirements

  • Python 3.8+
  • Node.js 16+
  • npm 8+

πŸ“₯ Installation Steps

  1. Enter the project directory
cd SecureScout
  1. Install backend dependencies
cd backend
pip install -r requirements.txt
  1. Install frontend dependencies
cd frontend
npm install
npm run dev

▢️ Run the Application

πŸͺŸ Windows Users - One-click Start

Simply double-click the start.bat file in the project root directory to start both the frontend and backend services! The startup script will automatically:

  • βœ… Check if environment dependencies are met
  • βœ… Start the backend API service
  • βœ… Start the frontend development server
  • βœ… Open the application in your browser

πŸ–±οΈ Manual Start

  1. Start the backend service
cd backend
python run.py
  1. Start the frontend service
cd frontend
npm run dev
  1. Access the frontend page in your browser
http://localhost:3000

πŸ“š User Guide

🏠 Dashboard

The dashboard provides an overview of the system's overall security status:

  • Security score and trend analysis
  • Number and distribution of discovered vulnerabilities
  • Recent scan records and results
  • Security suggestions and quick action shortcuts

πŸ” Scan Center

The scan center is the core area for security testing:

  1. Enter the target website URL
  2. Select scan mode (Quick/Standard/Deep)
  3. Configure scan parameters (concurrency, timeout settings, etc.)
  4. Start the scan and view progress in real time
  5. View summary of results after scan completion

πŸ“Š Report Center

The report center provides detailed vulnerability analysis and security assessment:

  • Vulnerability type distribution and risk levels
  • Detailed vulnerability descriptions and reproduction steps
  • Remediation suggestions and reference materials
  • Report export function (PDF/HTML)

βš™οΈ Settings Center

The settings center allows customization of system configurations:

  • Scan rule and parameter adjustments
  • Vulnerability database updates
  • Notification settings
  • System preferences

About

πŸ›‘οΈ SecureScout

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Vue 82.3%
  • Python 8.7%
  • JavaScript 7.5%
  • Other 1.5%