Skip to content

Jaime1108/SiteSheriff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤠 Site Sheriff — Ethical Web Vulnerability Scanner (Best Gemini API Project for RowdyHack 🏆)

Site Sheriff is an educational and interactive web-based vulnerability scanner designed to simulate real-world web security testing in a safe, ethical environment.
The goal of the project is to teach, detect, and visualize common web vulnerabilities such as SQL injection, XSS, and weak authentication while promoting ethical hacking and secure coding practices.


🔥 Features

  • 🔍 Vulnerability Scanning in file content
    Detects common web vulnerabilities, including SQL Injection, Cross-Site Scripting (XSS), broken authentication, and insecure admin portals.

  • 🤖 AI-Powered Code Auditor
    Uses an integrated AI model (Gemini 2.5 Pro) to analyze uploaded code and identify insecure patterns with explanations and recommended fixes.

  • 🧠 Safe Sandbox Testing
    Includes a test website environment for students and developers to practice penetration testing legally and safely.

  • 📊 Interactive Report Dashboard
    Displays vulnerability scan results, severity ratings, and suggested remediations.
    Each discovered issue rewards a “bounty” — themed with a fun cyber-cowboy aesthetic 🤠.

  • 💬 Real-Time Feedback System
    The scanner explains why an issue exists, its risk level, and how to mitigate it.


🧩 Tech Stack

Layer Technology
Frontend HTML5, TailwindCSS & Bootstrap & Vanilla CSS,JavaScript, Jinja2 Templates
Backend Flask (Python 3)
AI Integration GEMINI 2.5 Pro
Security Tools Custom Python scripts, Prompt engineer to prevent injection, Bash Script to handle redeployment on failure
Deployment Vultr Cloud Environment

⚙️ Installation & Setup

1. Clone the repository

git clone https://github.com/Jaime1108/SiteSheriff.git
cd SiteSheriff

2. Install Dependencies

python -m venv venv
source venv/bin/activate     # On Windows use: venv\Scripts\activate
pip install -r requirements.txt

3. Configuring the environment

Create a .env file to store the api key

GEMINI_API_KEY=your_api_key_here

4. Run the Flask application

python main.py

5. Visit the app

https://localhost:5000

🤠 Meet Our Team

Name Role GitHub
[James] Frontend, DevOps & Backend Support @Jaime1108
[Holton] Optimizer, Backend & API Integration @Holton-S
[Ash] Main Theme Designer, Frontend, Prompt Engineering & QA @Ashley-Hernandez

About

This is an AI-powered Vulnerability detector that we built for RowdyHack event

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors