🔍 Advanced static code analysis tool for comprehensive security vulnerability detection

🚀 Installation • 📱 Web Interface • 📖 Usage Guide • 🔧 API Reference • 🌐 Languages

---

🛡️ What CodeGuard Does

CodeGuard is a cutting-edge static code analyzer that identifies security vulnerabilities using advanced pattern matching and comprehensive code analysis across multiple programming languages.

🔍 Security Detection Code Injection - eval(), exec(), dynamic execution Authentication Flaws - Hardcoded secrets & credentials Command Injection - System command vulnerabilities Memory Safety - Buffer overflows (C/C++) Web Security - XSS, CSRF, DOM manipulation Database Security - SQL injection patterns Cryptography - Weak algorithms & implementations

📊 Professional Features Real-time Analysis - Instant vulnerability detection Severity Classification - Critical, High, Medium, Low Smart Recommendations - Auto-generated fix suggestions Multiple Formats - JSON, CSV, HTML reports Web Dashboard - Interactive browser interface REST API - Programmatic access & integration CI/CD Ready - Pipeline integration support

---

🚀 Installation

🌍 Cross-Platform Installation

🪟 Windows # PowerShell git clone https://github.com/ZeroHack01/CodeGuard.git cd CodeGuard # Virtual Environment python -m venv venv venv\Scripts\activate # Dependencies pip install -r requirements.txt # Launch Scanner python app.py 💡 Access: http://localhost:5000

🍎 macOS # Terminal git clone https://github.com/ZeroHack01/CodeGuard.git cd CodeGuard # Virtual Environment python3 -m venv venv source venv/bin/activate # Dependencies pip3 install -r requirements.txt # Launch Scanner python3 app.py 💡 Access: http://localhost:5000

🐧 Linux # Ubuntu/Debian sudo apt update && sudo apt install -y \ python3 python3-pip python3-venv git # CentOS/RHEL/Fedora sudo dnf install python3 python3-pip git # Setup git clone https://github.com/ZeroHack01/CodeGuard.git cd CodeGuard python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt # Launch python3 app.py 💡 Access: http://localhost:5000

🐳 Docker Deployment

# Option 1: Docker Hub
docker pull zerohack01/codeguard:latest
docker run -d -p 5000:5000 --name codeguard-scanner zerohack01/codeguard:latest

# Option 2: Build from Source
git clone https://github.com/ZeroHack01/CodeGuard.git && cd CodeGuard
docker build -t codeguard-scanner .
docker run -d -p 5000:5000 --name codeguard-scanner codeguard-scanner

# Container Management
docker stop codeguard-scanner      # Stop container
docker start codeguard-scanner     # Start container  
docker rm codeguard-scanner        # Remove container

🌐 Web Interface: http://localhost:5000

---

📱 Web Interface Preview

🎮 Interactive Dashboard

🎯 Main Dashboard - Clean interface for uploading and managing code analysis

📤 Smart File Upload System

🔄 Drag & Drop Upload - Support for multiple files with automatic language detection

📊 Comprehensive Results Dashboard

🔍 Detailed Analysis - Line-by-line vulnerability reporting with severity levels and fix recommendations

---

📖 Usage Guide

🐧 Linux

1. Access via browser: localhost:5000
2. Select files for scanning
3. Process vulnerability analysis
4. Examine color-coded results
5. Generate exportable reports

💻 Command Line Interface

# Python Integration
from scanner import scan_file

# Single file analysis
results = scan_file('vulnerable_app.py')
for vulnerability in results:
    print(f"🚨 Line {vulnerability['line']}: {vulnerability['issue']}")
    print(f"   Severity: {vulnerability['severity']}")

# REST API Usage
curl -X POST -F "file=@security_test.py" \
     -H "Content-Type: multipart/form-data" \
     http://localhost:5000/api/scan

---

🌐 Supported Languages and Frameworks

Visual distribution of CodeGuard's language detection capabilities

---

📋 Language Details

Language	Extensions	Security Patterns	Framework Support
🐍 Python	.py .pyw .pyc	eval(), exec(), os.system(), pickle.loads()	Django, Flask, FastAPI
🟨 JavaScript	.js .jsx .mjs	innerHTML, eval(), document.write()	React, Vue, Angular
⚡ TypeScript	.ts .tsx .d.ts	Type safety issues, XSS vulnerabilities	Angular, React TS
🔵 C/C++	.c .cpp .h .hpp	gets(), strcpy(), malloc(), system()	Native, Qt, Boost
☕ Java	.java .jar .class	Runtime.exec(), reflection, deserialization	Spring, Struts, JSF
🐘 PHP	.php .phtml .php3	eval(), shell_exec(), include(), mysqli	Laravel, Symfony, CodeIgniter
💎 Ruby	.rb .rbw .rake	eval(), system(), send(), constantize()	Rails, Sinatra, Hanami
🐹 Go	.go .mod .sum	exec.Command(), unsafe.Pointer, sql.Query	Gin, Echo, Fiber
🌐 HTML/CSS	.html .htm .css	Script injection, unsafe protocols	Bootstrap, Tailwind

---

📊 Total: 9 Languages | 75+ Security Patterns | 83% Average Coverage

---

🔧 API Reference

📡 Available Endpoints

Method	Endpoint	Description	Parameters
POST	/api/scan	Upload and analyze file	file (multipart/form-data)
GET	/	Access web interface	None

📝 API Usage Examples

# Upload and scan a file
curl -X POST \
  -F "file=@source_code.py" \
  -H "Accept: application/json" \
  http://localhost:5000/api/scan

# Test with vulnerable Python code
echo 'eval(user_input)' > test.py
curl -X POST -F "file=@test.py" http://localhost:5000/api/scan

# Test with hardcoded credentials
echo 'password = "admin123"' > config.py  
curl -X POST -F "file=@config.py" http://localhost:5000/api/scan

📋 Response Format

{
  "success": true,
  "filename": "source_code.py",
  "language": "python",
  "issues": [
    {
      "line": 15,
      "code": "eval(data)",
      "issue": "Code Injection",
      "severity": "Critical"
    }
  ],
  "total_issues": 1
}

---

📊 Sample Output

🔍 Example scan results

{
  "filename": "app.py",
  "language": "python",
  "scan_time": 0.8,
  "issues": [
    {
      "line": 23,
      "code": "eval(user_input)",
      "issue": "Code Injection",
      "severity": "Critical",
      "description": "Dynamic code execution detected"
    },
    {
      "line": 15,
      "code": "password = 'admin123'",
      "issue": "Hardcoded Password",
      "severity": "High",
      "description": "Credentials found in source code"
    },
    {
      "line": 31,
      "code": "os.system(command)",
      "issue": "Command Injection",
      "severity": "High",
      "description": "System command execution risk"
    }
  ],
  "summary": {
    "total_issues": 3,
    "critical": 1,
    "high": 2,
    "medium": 0
  }
}

---

🧪 Testing CodeGuard

Create a test file with known vulnerabilities:

# test_vulnerable.py
api_key = "sk-1234567890abcdef"    # Hardcoded credential
user_code = input("Enter code: ")
eval(user_code)                    # Code injection
os.system("ls " + user_path)       # Command injection

Expected result: 3 security issues detected

---

⚙️ Configuration

🔧 Environment Settings

# Server Configuration
FLASK_HOST=0.0.0.0              # Bind address
FLASK_PORT=5000                 # Port number
FLASK_DEBUG=false               # Debug mode

# File Processing
MAX_FILE_SIZE=10485760          # 10MB limit
UPLOAD_TIMEOUT=30               # 30 seconds

# Scanner Options
SEVERITY_THRESHOLD=medium       # Minimum severity to report
EXPORT_FORMATS=json,csv         # Available export formats

---

🤝 Contributing

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing-detection
3. Implement your security improvements
4. Add comprehensive tests
5. Commit changes: git commit -m "Add new feature"
6. Push to branch: git push origin feature/amazing-detection
7. Submit Pull Request

🐛 Bug Reports & Feature Requests

• 🐛 Bug Reports: Use GitHub Issues with detailed reproduction steps
• 💡 Feature Requests: Create GitHub Issues with enhancement label
• 🔒 Security Issues: Email mongwoiching2080@gmail.com for responsible disclosure

---

📄 License

This project is licensed under the MIT License - see LICENSE file for complete terms.

📦 Dependencies

• Flask - Web framework for the interface
• Werkzeug - WSGI web application library
• Other dependencies - See requirements.txt for complete list

---

🐛 Report Issues • 💼 LinkedIn • 📧 Email

⭐ Star this repository if CodeGuard helped secure your code!