Skip to content

README.md

Latest commit

 

History

History
212 lines (163 loc) · 6.39 KB

README.md

File metadata and controls

212 lines (163 loc) · 6.39 KB

🌌 CipherSentinel - Advanced Secret & API Key Detector

🔐 A futuristic DevSecOps platform designed to detect API keys, hardcoded secrets, tokens, and configuration leaks with a stunning cyberpunk command-center UI.

✨ Key Highlights

  • 🔑 Advanced Secret & API Key Detection Engine\
  • 🧠 Heuristic + Signature-Based Scanning\
  • 🌌 Futuristic Cyberpunk Dashboard UI\
  • 🗄️ Lightweight SimpleDB (JSON-based storage)\
  • 📊 Interactive Risk Analytics & Visualization\
  • 🔒 Privacy Mode & Secret Masking\
  • ⚡ Fast, Modular & Git-Friendly Architecture

🚀 Overview

CipherSentinel is a next-generation Secret & Vulnerability Detection platform built for developers, security researchers, and DevSecOps teams.
It scans files, code snippets, and configuration data to proactively identify exposed credentials before they become real-world security risks.

🧠 System Block Diagram

flowchart TD
    A[User Uploads File / Pastes Code] --> B[React Frontend]
    B --> C[Validation Layer]
    C --> D[REST API Call]
    D --> E[Express Backend]
    E --> F[Input Sanitization]
    F --> G[Heuristic Detection Engine]
    G --> H[Signature Library]
    G --> I[Entropy & Pattern Analysis]
    H --> J{Secrets Found?}
    I --> J
    J -->|Yes| K[Risk Scoring Engine]
    J -->|No| L[Safe Result Response]
    K --> M[Severity Classification]
    M --> N[Store Scan Metadata]
    N --> O[(SimpleDB JSON Database)]
    E --> P[Return Structured JSON Report]
    P --> Q[Frontend Visualization]
    Q --> R[Monaco Highlight]
    Q --> S[Risk Gauge & Charts]
Loading

🏗️ Project File Architecture

CipherSentinel-Secret-API-Key-Detector/
│
├── client/                         # React Cyberpunk Frontend
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── hooks/
│   │   ├── utils/
│   │   ├── animations/
│   │   └── styles/
│   └── package.json
│
├── server/                         # Express Backend
│   ├── controllers/
│   ├── routes/
│   ├── services/
│   ├── detectors/
│   ├── simpledb/
│   └── utils/
│
├── simpledb-data/                  # JSON Database Storage
│   ├── scans.json
│   └── settings.json
│
├── test-files/
├── public/
├── README.md
└── package.json

🔍 Core Features Breakdown

1️⃣ Heuristic Scanner Engine

  • Detects AWS Keys, JWT Tokens, Stripe Secrets, Google API Keys, Private Keys (.pem), Slack Tokens
  • Regex + Heuristic Analysis
  • Drag & Drop File Scanning
  • Paste Code Instant Analysis

2️⃣ Command Center Dashboard

  • Total Scans Overview
  • Critical Threat Counter
  • Risk Trend Graphs (Recharts)
  • Recent Scan Activity Panel

3️⃣ Vulnerability Lab (Results Page)

  • 🎯 Dynamic Risk Score (0--100 Gauge)
  • 🔴 Highlighted Secrets in Monaco Editor
  • 🧾 Detailed Detection Metadata (File, Line, Type)
  • 🔒 Secret Masking Toggle (**** Protection)

4️⃣ Scan Archive (History)

  • Stored securely using SimpleDB JSON
  • Search & Filter Past Scans
  • Two-Step Secure Deletion Flow

5️⃣ Settings & DevSecOps Controls

  • Deep Scan Mode
  • Sensitivity Slider
  • Privacy Mode (No File Storage)
  • Detection Signature Toggles
  • SimpleDB Data Management

⚙️ Running the Fully Functional Project

📦 1️⃣ Install All Dependencies (Client + Server)

From the root directory, run:

npm run install:all

🚀 2️⃣ Start the Full Development Environment

npm run dev

Frontend Dashboard:

http://localhost:5173

Backend API:

http://localhost:5000

🗄️ SimpleDB Schema Example

{
  "scanId": "uuid",
  "fileName": "sample.env",
  "secretsDetected": [],
  "severity": "Critical",
  "riskScore": 87,
  "createdAt": "timestamp"
}

🛠️ Tech Stack

Layer Technologies
Frontend React 19, TypeScript, TailwindCSS 4, Framer Motion
Backend Node.js, Express 5, Multer
Database SimpleDB (JSON File-Based)
Visualization Recharts, Monaco Editor
UI Design Cyberpunk Glassmorphism + Neon UI
Icons Material Symbols

🎨 UI/UX Philosophy

  • Cyberpunk Command Center Theme\
  • Glassmorphism + Neon Glow\
  • Interactive Risk Intelligence\
  • Beginner-Friendly but Enterprise-Level Feel

🔒 Security Notice

CipherSentinel is designed for internal auditing and research purposes.
Ensure simpledb-data/ is excluded from public repositories if containing sensitive results.

Built as a DevSecOps Vulnerability Research Platform.