Skip to content

README.md

Latest commit

 

History

History
214 lines (150 loc) · 6.77 KB

README.md

File metadata and controls

214 lines (150 loc) · 6.77 KB

🛡️ Apex Security Auditor

GitHub License GitHub Release Build Status Tauri Rust React TypeScript

Advanced API Security Analysis and Vulnerability Detection Desktop Application

Apex Security Auditor is a comprehensive desktop application for analyzing API security configurations, detecting PII (Personally Identifiable Information), and auditing OpenAPI/REST endpoints for potential vulnerabilities and compliance issues.

✨ Key Features

  • 🔍 OpenAPI Parser - Comprehensive analysis of OpenAPI 3.0+ specifications
  • 🎯 PII Detection - Advanced detection of sensitive data patterns (emails, SSNs, credit cards, etc.)
  • 🔐 Security Scanning - Identify common security misconfigurations and vulnerabilities
  • 📊 Interactive Inspector - Visual analysis of API endpoints and security properties
  • 🗄️ Local Database - SQLite backend for storing audit results
  • 🤖 AI-Powered Analysis - Integration with AI models for intelligent vulnerability detection
  • 💻 Cross-Platform - Works on Windows, macOS, and Linux

🚀 Quick Start

Prerequisites

  • Rust 1.70+ (Install)
  • Node.js 18+ (Install)
  • npm or pnpm for package management

Installation

# Clone the repository
git clone https://github.com/logix727/apex-security-auditor.git
cd apex-security-auditor

# Install dependencies
npm install

# Install Rust dependencies (from src-tauri directory)
cd src-tauri
cargo build
cd ..

Development

# Start development server
npm run dev

# In another terminal, run Tauri dev
npm run tauri dev

Build

# Build for production
npm run tauri build

For detailed setup instructions, see INSTALLATION.md

📁 Project Structure

apex-security-auditor/
├── src/                          # React/TypeScript frontend
│   ├── components/               # React components
│   │   ├── DebugConsole.tsx     # Debug output interface
│   │   ├── Inspector.tsx         # API endpoint inspector
│   │   └── PIIMasker.tsx         # PII detection and masking
│   ├── App.tsx                   # Main application component
│   ├── main.tsx                  # React entry point
│   └── vite-env.d.ts             # Vite environment variables
├── src-tauri/                    # Rust backend
│   ├── src/
│   │   ├── main.rs               # Tauri app entry point
│   │   ├── ai.rs                 # AI integration module
│   │   ├── data.rs               # Data structures
│   │   ├── db.rs                 # Database operations
│   │   ├── detectors.rs          # Vulnerability detectors
│   │   ├── openapi_parser.rs     # OpenAPI parsing logic
│   │   ├── scanner.rs            # Security scanning engine
│   │   └── ui/                   # UI integration modules
│   ├── Cargo.toml                # Rust dependencies
│   └── tauri.conf.json           # Tauri configuration
├── docs/                         # Documentation
├── package.json                  # Frontend dependencies
├── vite.config.ts                # Vite configuration
└── README.md                     # This file

🔧 Technologies Stack

Frontend

  • React 18 - UI framework
  • TypeScript - Type safety
  • Vite - Build tool
  • CSS3 - Styling

Backend

  • Rust - Performance and safety
  • Tauri - Desktop application framework
  • SQLite - Local database
  • serde - Serialization

Development Tools

  • HMR (Hot Module Reload) - Fast development experience
  • Cargo - Rust package manager
  • npm - Node package manager

📖 Documentation

🔍 Usage Examples

Analyzing an OpenAPI Specification

  1. Open Apex Security Auditor
  2. Load an OpenAPI JSON/YAML file
  3. Review detected vulnerabilities in the Inspector panel
  4. Export results for compliance reporting

Detecting PII in API Responses

  1. Configure sensitive data patterns
  2. Run PII detection scanner
  3. View masked results in PIIMasker component
  4. Generate audit reports

🐛 Known Issues & Limitations

  • Large OpenAPI specs (>50MB) may take longer to parse
  • Some database operations require write permissions
  • AI analysis requires API credentials

See Issues for reported bugs and feature requests.

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for:

  • Code of conduct
  • Development setup
  • Commit message guidelines
  • Pull request process

📝 License

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

🎓 Resources

📞 Support & Contact

🔄 Latest Updates

v0.1.0 - Initial release with core features:

  • OpenAPI parsing and analysis
  • PII detection engine
  • Security scanning
  • Database integration
  • Interactive UI components

back to top

Made with ❤️ by the Apex Security team