Skip to content

semi-constructor/vaultscope

Repository files navigation

VaultScope Enterprise

VaultScope Logo

Professional API Security Assessment Tool

License: MIT .NET Platform Build Status

πŸ›‘οΈ Overview

VaultScope Enterprise is a professional-grade security assessment tool designed for testing localhost applications. Built with .NET 8.0 and Avalonia UI, it provides comprehensive vulnerability scanning capabilities with a modern, cross-platform interface.

✨ Key Features

  • πŸ” Comprehensive Vulnerability Detection

    • SQL Injection
    • Cross-Site Scripting (XSS)
    • Command Injection
    • XML External Entity (XXE)
    • Server-Side Request Forgery (SSRF)
    • Path Traversal
    • Authentication Bypass
    • Security Headers Analysis
  • 🎨 Modern User Interface

    • Beautiful purple/black dark theme
    • Smooth animations and transitions
    • Real-time scan progress
    • Interactive dashboard
  • πŸ“Š Advanced Reporting

    • HTML, JSON, and PDF export formats
    • Detailed vulnerability descriptions
    • OWASP categorization
    • Security scoring system
  • πŸ’Ύ Data Persistence

    • SQLite database with Entity Framework Core
    • Historical scan tracking
    • Trend analysis
  • 🌍 Cross-Platform Support

    • Windows (.msi, .exe)
    • macOS (.dmg, .pkg)
    • Linux (.deb, .rpm, .AppImage)

πŸš€ Getting Started

Prerequisites

  • .NET 8.0 SDK
  • Visual Studio 2022, VS Code, or JetBrains Rider

Installation

Option 1: Download Pre-built Binaries

Download the latest release for your platform from the Releases page.

Option 2: Build from Source

# Clone the repository
git clone https://github.com/cptcr/vaultscope.git
cd vaultscope

# Restore dependencies
dotnet restore

# Build the application
dotnet build --configuration Release

# Run the application
dotnet run --project src/VaultScope.UI/VaultScope.UI.csproj

🎯 Usage

  1. Launch VaultScope Enterprise
  2. Enter your localhost URL (e.g., http://localhost:3000)
  3. Configure scan options:
    • Select vulnerability detectors
    • Set authentication if needed
    • Choose scan depth
  4. Start the scan and monitor progress
  5. Review results in the detailed report
  6. Export findings in your preferred format

Example Scan

# Using the CLI (future feature)
vaultscope scan http://localhost:8080 --all-detectors --output report.html

πŸ—οΈ Architecture

vaultscope/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ VaultScope.Core/           # Core models and interfaces
β”‚   β”œβ”€β”€ VaultScope.Security/       # Vulnerability detectors
β”‚   β”œβ”€β”€ VaultScope.Infrastructure/ # Data access and utilities
β”‚   β”œβ”€β”€ VaultScope.UI/            # Avalonia UI application
β”‚   └── VaultScope.Tests/         # Unit and integration tests
β”œβ”€β”€ docs/                         # Documentation
β”œβ”€β”€ scripts/                      # Build and deployment scripts
└── .github/                      # GitHub workflows

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Setup

# Install development dependencies
dotnet tool restore

# Run tests
dotnet test

# Run with hot reload
dotnet watch run --project src/VaultScope.UI/VaultScope.UI.csproj

πŸ“‹ Security Policy

Please review our Security Policy for reporting vulnerabilities.

πŸ“„ License

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

πŸ™ Acknowledgments

πŸ“ž Support


Made with ❀️ by the VaultScope Team

About

Enterprise-grade Localhost API Security Assessment Tool

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors