Skip to content

About

We make domain safety scanning easy , and strategy making easy.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

domain-scanner

We make domain safety scanning easy, and strategy making easy.

Golden padlock and key illustration representing domain security

About

This project uses vulnerability scanning technologies to help identify and analyze domain security issues.

Legal & Licensing

Using Nuclei

This project may integrate with ProjectDiscovery's Nuclei, a vulnerability scanner licensed under the MIT License. Our legal analysis confirms:

  • ✅ Safe for commercial and open-source use
  • ✅ Compatible with our MIT License
  • ✅ Low legal risk with proper attribution
  • ✅ No licensing fees required

See NUCLEI_LICENSE_ANALYSIS.md for complete legal analysis and risk assessment.

Domain Scanner

Security scanning results that business leaders can actually understand and act on.

What is Domain Scanner?

Domain Scanner transforms technical security scan results into actionable business intelligence. Built on top of NUCLEI, we bridge the gap between security tools and business decision-making.

For Business Leaders: Understand your security risks in plain English, with clear guidance on what to do next.

For Security Teams: Leverage NUCLEI's powerful scanning with automatic translation to business impact.

The Problem We Solve

Traditional security scanners output technical jargon that business decision makers can't act on:

  • ❌ "CVE-2023-12345: RCE vulnerability detected, CVSS 8.5"
  • ❌ Raw technical reports requiring security expertise
  • ❌ No guidance on business impact or next actions

Our Solution

We translate technical findings into business language with clear action plans:

  • ✅ "Operational Risk: Server compromise possible. Service disruption likely. Priority: Immediate. Action: Apply security patch within 24 hours."
  • ✅ Business-friendly reports for executives and decision makers
  • ✅ Clear guidance on what to do, who should do it, and when

Key Features

  • 🎯 Business-First Interface - Designed for non-technical decision makers
  • 💼 Risk Translation - Converts technical findings to business impact (Financial, Governance, Operational)
  • 📋 Action Guidance - Every finding includes clear next steps and ownership
  • 📊 Executive Dashboard - High-level overview with trends and priorities
  • 📱 Mobile Responsive - Access insights anywhere, on any device
  • 🔍 Progressive Disclosure - Business view by default, technical details on demand
  • 🤖 Powered by NUCLEI - Leverages industry-leading open-source scanner

Documentation

Comprehensive documentation to understand our vision, scope, and design:

Quick Start

Prerequisites

  • NUCLEI - The scanning engine (required)
  • Docker & Docker Compose - For easy deployment (recommended)
  • Node.js 18+ - For local development (if not using Docker)
  • PostgreSQL 15+ - Database (via Docker or local)
  • Redis 7+ - Queue system (via Docker or local)

Installing NUCLEI

# macOS (Homebrew)
brew install nuclei

# Linux
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest

# Or download binary from: https://github.com/projectdiscovery/nuclei/releases

Verify installation:

nuclei -version

Installation (Docker - Recommended)

# Clone the repository
git clone https://github.com/Kiara-Dev-Team/domain-scanner.git
cd domain-scanner

# Copy environment file
cp .env.example .env

# Start all services with Docker Compose
docker-compose up -d

# Wait for services to be ready (about 30 seconds)
docker-compose logs -f

# Access the application:
# - Web UI: http://localhost:3000
# - API: http://localhost:3001/api
# - Health Check: http://localhost:3001/health

Installation (Local Development)

# Clone the repository
git clone https://github.com/Kiara-Dev-Team/domain-scanner.git
cd domain-scanner

# Copy environment file
cp .env.example .env

# Install dependencies
npm install

# Start PostgreSQL and Redis (using Docker)
docker-compose up -d postgres redis

# Install backend dependencies
cd backend
npm install
cd ..

# Install frontend dependencies
cd frontend
npm install
cd ..

# Start development servers (from project root)
npm run dev

# Access the application:
# - Web UI: http://localhost:3000
# - API: http://localhost:3001/api

Running Your First Scan

  1. Open http://localhost:3000 in your browser
  2. Click "Start New Scan"
  3. Enter a domain (e.g., example.com or https://example.com)
  4. Click "Start Scan"
  5. Wait for the scan to complete (1-5 minutes)
  6. View business-friendly results with actionable recommendations

⚠️ Important: Only scan domains you own or have explicit permission to scan.

Use Cases

  • Executive Risk Review - Quick security posture assessment for leadership
  • Pre-Investment Due Diligence - Evaluate target company security for M&A decisions
  • Board Reporting - Generate quarterly security reports with business context
  • Operational Risk Management - Monitor external attack surface continuously
  • Vendor Security Assessment - Evaluate third-party security in business terms

Roadmap

Phase 1: MVP (Current) ✅

  • NUCLEI integration
  • Basic business translation engine
  • Simple web dashboard
  • Executive summary view
  • Business-first findings with progressive disclosure
  • Mobile-responsive UI
  • PDF/HTML reporting (planned)

Phase 2: Core Features

  • Advanced translation engine
  • Scan scheduling
  • Historical tracking
  • Mobile-responsive UI
  • API for integrations

Phase 3: Enterprise Features

  • Multi-tenant support
  • Role-based access control
  • Advanced analytics
  • Third-party integrations

See DEV_SCOPE.md for detailed development phases.

Technology Stack

Foundation:

  • NUCLEI - Security scanning engine

Backend (Recommended):

  • Language: TypeScript (Node.js) - Quick summary | Full analysis
  • Framework: NestJS (enterprise-ready, structured)
  • Database: PostgreSQL
  • Cache: Redis
  • Queue: Bull (Redis-backed)

Frontend:

  • Framework: React + TypeScript
  • UI Library: TailwindCSS + shadcn/ui
  • Visualization: Recharts + D3.js

LLM Integration:

  • TypeScript SDKs (OpenAI, Anthropic, etc.)
  • API-based approach (no separate Python service needed)

Contributing

We welcome contributions! Please see our contributing guidelines (coming soon).

Development Principles

  1. Business value first - Every feature must serve business decision makers
  2. Leverage NUCLEI - Don't rebuild the scanner, enhance the output
  3. Clear over clever - Simple, understandable code and UX
  4. User-centric design - Design for non-technical users by default
  5. Progressive disclosure - Show high-level first, details on demand

Target Users

Primary: Business decision makers (executives, product owners, risk managers, operations leaders)

Secondary: Security teams needing to communicate with business stakeholders

Not for: Security researchers, penetration testers (they should use NUCLEI directly)

Differentiation

Aspect Traditional Scanners Domain Scanner
Primary User Security engineers Business decision makers
Output Language Technical jargon Business language
After Detection Lists vulnerabilities Provides action plan
Risk Framing CVSS scores Business impact
UI/UX Tool-centric User-outcome-centric

Philosophy

We convert technical security value into business value without diminishing the underlying technical rigor.

  • We don't replace security tools - we make them accessible to business users
  • We don't simplify security - we translate it to business impact
  • We don't hide details - we present them progressively

License

MIT License - see LICENSE file for details.

Support

Acknowledgments

Built on top of NUCLEI by ProjectDiscovery. We're grateful for their excellent open-source security tooling.

Header image: Golden padlock and key illustration from Unsplash.


Status: 🚧 Under Active Development

Current Phase: Planning & Architecture

Looking for: Contributors, feedback, early adopters

About

We make domain safety scanning easy , and strategy making easy.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages