Skip to content
OldDiamondPublic

About

Cloud based web vulnerability scanner with AI assisted remediation report.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

SillyAuthority

NetNeedle

NetNeedle is a full-stack cybersecurity assessment platform that helps users map their external attack surface, review web security findings, and turn scan evidence into actionable reports. It brings account management, controlled scanning, progress tracking, reporting, and administration into one workspace.

The project combines security tooling with product design and backend engineering: users can follow an assessment from its initial configuration to a report that developers and managers can both use.

NetNeedle landing page

Table Of Contents

  1. Explore the screenshots
  2. See the engineering
  3. Deployment guide
  4. Source code
  5. About Author

The problem it addresses

Security tools often produce separate outputs that require additional work to understand, prioritize, and share. Developers need specific evidence and fixes; managers need an understandable view of risk and the next actions to take.

NetNeedle connects those needs through a shared workflow: define the assessment scope, run the appropriate checks, review normalized findings, and generate reports for different audiences from the same underlying evidence.

What users can do

Capability What it delivers
Network assessment Discover reachable hosts, open ports, services, and DNS, HTTP, and TLS observations within a configured scope.
Web assessment Crawl website pages and review headers, cookies, technologies, exposed resources, and supported scanner findings.
Advanced web assessment Configure deeper, authorization-gated testing with authentication options, bounded tool execution, and evidence tracking.
Scan management Follow incremental progress, inspect findings, stop jobs, restart assessments, and resume supported scan types.
Reports for two audiences Export executive and detailed assessment reports as HTML or PDF, with risk summaries, evidence, and remediation guidance.
Accounts and administration Use email verification and password recovery, manage profiles and plans, review payment submissions, and administer users.
AI support and report narratives Use an Ollama-backed support agent and evidence-bounded report explanations when an AI engine is configured.

A complete assessment workflow

  1. Create an account. Register, verify the emailed code, and sign in.
  2. Define the scope. Choose a scan type, enter targets and exclusions, and configure the permitted checks.
  3. Start the assessment. Background workers execute the scan while the dashboard shows progress and findings.
  4. Review the evidence. Inspect severity, confirmation status, affected targets, and the observations behind each finding.
  5. Share the result. Generate an executive report for decision-makers or a detailed report for technical follow-up.

Scans continue on the server after the user leaves the browser. The application stores their state so users can return to review results and generate reports.

Product tour

Click to expand Installation

1. Overview dashboard

A central workspace for assessment activity, scan status, and security findings.

NetNeedle scanner dashboard

2. Assessment configuration

Users choose the assessment type and define its scope and execution settings before starting a scan.

Scanner configuration

3. Progress and findings

Incremental results make the assessment observable while it runs. Findings retain their source and evidence so users can understand what a check actually found.

Completed Scan

4. Executive report

A management-focused view of the assessment, its risk summary, and recommended actions, built from the same findings used in the technical report.

Executive Report

5. Detailed assessment report

A technical view of findings, captured evidence, affected endpoints, and remediation guidance for investigation and implementation.

outdated javascript vulnerability

6. Administration

An administration workspace supports user management, subscription changes, payment review, and AI configuration.

Admin Portal

Engineering highlights

Click to expand Installation

Background processing with visible state

FastAPI handles application requests while Celery workers execute longer-running tasks. Scans use a dedicated queue; reports and notifications run in a separate worker. PostgreSQL stores application data and assessment state, while Redis provides the task broker. This separation keeps scan execution and report generation outside the browser request lifecycle.

Reports grounded in evidence

Executive and detailed reports share normalized findings and deterministic risk calculations. Confirmation status distinguishes confirmed findings, issues that need manual validation, and informational observations.

AI can contribute explanations and remediation prose, while counts, severity, evidence, and scoring remain controlled by application logic. Generated narratives are validated, and reports use deterministic text when AI output is unavailable or unsuitable.

Controlled scanner integration

The scanner pipeline combines built-in checks with specialist tools such as Nmap, Masscan, Nuclei, WhatWeb, Nikto, and testssl.sh. Targets and exclusions are validated, execution has time and scope limits, and tool status is recorded. Supported checks depend on the scan configuration and available tooling.

Sensitive scan credentials are encrypted when new configurations are saved and redacted from normal responses and command previews. Authenticated assessments support configured credentials, cookies, or tokens, with browser-assisted login for supported JavaScript applications.

Product interface and repeatable delivery

The frontend combines JavaScript application controllers with React-powered public pages and Three.js visuals. The repository includes frontend checks, browser verification scripts, backend tests, and a GitHub Actions workflow for frontend verification and builds. Docker Compose assembles the services, and Alembic applies the database schema history during startup.

Architecture at a glance

flowchart LR
    User[User] --> Frontend[Web interface and Nginx]
    Frontend --> API[FastAPI application]
    API --> DB[(PostgreSQL)]
    API --> Redis[(Redis task broker)]
    Redis --> Scanner[Scan worker]
    Redis --> Reports[Report and notification worker]
    Scanner --> Tools[Security assessment tools]
    Scanner --> DB
    Reports --> DB
    Reports --> Files[Generated report files]
    Reports --> Email[Email delivery]
    API --> AI[Ollama AI engine]
    Reports --> AI
Loading

Technology stack

Area Technologies
Frontend JavaScript, React, Vite, HTML/CSS, Three.js, GSAP
API and application logic Python, FastAPI, Pydantic
Database PostgreSQL, SQLAlchemy, Alembic
Background jobs Celery, Redis
Assessment tooling Nmap, Masscan, Nuclei, WhatWeb, Nikto, and additional specialist scanners
Reporting and AI HTML/CSS report templates, WeasyPrint PDF generation, Ollama
Deployment and automation Docker, Docker Compose, Nginx, GitHub Actions

What this project demonstrates

Skill area Concrete work in the repository
Full-stack development Account workflows, authenticated APIs, frontend views, persisted scans, and report delivery.
Backend system design Queue routing, worker separation, scan lifecycle management, and database migrations.
Security engineering Scope validation, authentication controls, secret handling, bounded execution, and evidence-aware findings.
Applied AI engineering Schema-validated narratives, controlled factual fields, and deterministic fallbacks.
Product thinking Separate reports for managers and technical teams, guided scan configuration, and administration workflows.
Delivery and maintainability Containerized services, automated frontend checks, focused backend tests, and deployment documentation.

Current scope

The implemented assessment workflows cover network, web, and advanced web scans. Authenticated Windows operating-system assessment is marked coming soon in the interface. Some specialist checks require additional tooling, credentials, or explicit configuration; their availability is reflected in execution status.

NetNeedle is designed for assessments of assets the user owns or is authorized to test. Findings preserve uncertainty where additional manual validation is needed.

About Author

I'm Mohammad Yasin, web application security professional. This project reflects my skills and something I can showcase to show my passionate with what I do.

🌐 olddiamond.github.io
📧 yasinnadeemswiss@gmail.com

About

Cloud based web vulnerability scanner with AI assisted remediation report.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors