महत्वपूर्ण। केवल उन्हीं नेटवर्कों को स्कैन करें जिनके आप मालिक हैं या जिन्हें स्कैन करने के लिए आपके पास लिखित प्राधिकरण है। UltraViolet निष्क्रिय सेवा टोही करता है — यह कमज़ोरियों का शोषण नहीं करता।

UltraViolet क्यों

सिंगल टेनेंट, एक Docker Compose स्टैक, आपके डेटा पर पूर्ण नियंत्रण।

✨ विशेषताएँ

डिस्कवरी

• डिस्कवरी इंजन के रूप में masscan या zmap वाला TCP कनेक्ट स्कैनर
• कॉन्फ़िगर करने योग्य पोर्ट पर UDP प्रोब
• होस्ट और पोर्ट सीमाओं के साथ SCAN_ALLOWED_CIDRS द्वारा स्कोप किया गया

डीप प्रोब (~100 प्रोटोकॉल)

• वेब: HTTP/HTTPS, HTTP/3, GraphQL, favicon हैश, robots.txt, security.txt, टेक स्टैक
• TLS: सर्टिफिकेट चेन, JARM, JA3S/JA4S, कॉन्फ़िगरेशन ग्रेडिंग
• मेल और डायरेक्ट्री: SMTP, POP3/IMAP, LDAP, IPMI
• डेटाबेस और क्यू: MySQL, PostgreSQL, MongoDB, Redis, Kafka, MQTT, NATS, AMQP…
• ICS/SCADA: Modbus, BACnet, DNP3, IEC 104, S7Comm, ENIP, OPC UA…
• IoT और मीडिया: ONVIF, RTSP, Chromecast, AirPlay, UPnP…
• पूरी सूची प्रोटोकॉल दस्तावेज़ में

एनरिचमेंट

• रिवर्स DNS, GeoIP (MMDB), ASN
• वैकल्पिक फॉरवर्ड DNS और CT-लॉग डिस्कवरी

CVE और जोखिम

• बैकग्राउंड सिंक और फ़िंगरप्रिंट-आधारित मिलान के साथ स्थानीय NVD मिरर
• CISA KEV और FIRST EPSS

ऑपरेशन

• RBAC (viewer / operator / admin), JWT + रिफ्रेश टोकन
• स्कैन शेड्यूल, पॉज़/रिज़्यूम, वर्कर रीस्टार्ट के बाद orphan reclaim
• Prometheus /metrics, वैकल्पिक Grafana प्रोफ़ाइल
• ऑडिट लॉग, रेट लिमिटिंग, रिटेंशन नीतियाँ

🏗 आर्किटेक्चर

flowchart TB
  Browser["Browser"]
  FE["service-frontend<br/>React + nginx"]
  API["uv-api<br/>REST · WS · metrics"]
  PG[("PostgreSQL 16")]
  SCAN["uv-scanner<br/>probe pipeline"]

  Browser --> FE
  FE -->|"/api"| API
  FE -->|"/realtime"| API
  API <--> PG
  SCAN <--> PG
  API -.->|LISTEN/NOTIFY| API

रिलीज़ UI इमेज /api/ और /realtime को uv-api पर प्रॉक्सी करती है — सिंगल ऑरिजिन, प्रति API URL फ्रंटएंड रीबिल्ड की आवश्यकता नहीं।

बैकएंड डेवलपमेंट नियम: CLAUDE.md।

🚀 त्वरित आरंभ

आवश्यकताएँ: Go 1.25+, Docker Engine ≥ 24, ~4 GB RAM। प्रोडक्शन इमेज Linux amd64 के लिए हैं।

Docker Hub से चलाएँ (सोर्स बिल्ड के बिना)

शुरुआती मार्ग — प्रकाशित इमेज को service-env/docker-compose.registry.yml से पुल करें:

cd service-env
cp env.registry.example .env
# set POSTGRES_PASSWORD, AUTH_JWT_SECRET, AUTH_BOOTSTRAP_PASSWORD
mkdir -p geoip catalog-seed
docker compose -f docker-compose.registry.yml pull
docker compose -f docker-compose.registry.yml up -d
# UI → http://localhost:3000

दस्तावेज़ साइट में Docker Registry देखें।

सोर्स से डेवलप करें

API/स्कैनर इमेज service-api/bin/ से प्रीबिल्ट बाइनरी कॉपी करती हैं (उन्हें Docker के अंदर कंपाइल नहीं किया जाता)। make dev, docker compose … --build से पहले make -C service-api build-linux चलाता है।

git clone https://github.com/yakushstanislav/UltraViolet.git
cd UltraViolet/service-env

cp .env.example .env
mkdir -p secrets
openssl rand -hex 32 > secrets/postgres_password
openssl rand -hex 32 > secrets/auth_jwt_secret

cd ..
make dev

डेव बूटस्ट्रैप: admin / admin (केवल जब APP_ENV≠production हो)।

📖 दस्तावेज़ीकरण

संपूर्ण गाइड — VitePress service-documentation-frontend/docs/ में:

make docs-dev    # → http://localhost:5173

प्रोडक्शन में, docs प्रोफ़ाइल सक्षम करें:

cd service-env && docker compose --profile docs up -d
# → http://localhost:${UV_DOCUMENTATION_PORT:-3002}

मुख्य अनुभाग: इंस्टॉलेशन · स्कैनिंग · API · डिप्लॉयमेंट · ऑफ़लाइन इंस्टॉल।

🛠 डेवलपमेंट

पूर्ण Docker

make dev    # build-linux → compose prod + dev override --build

बैकएंड बदलावों के बाद Go बाइनरी फिर से बिल्ड करें (make -C service-api build-linux), फिर रीस्टार्ट करें या make dev दोबारा चलाएँ।

हाइब्रिड मोड (तेज़ बैकएंड इटरेशन)

make dev-db   # PostgreSQL only on :5432

cd service-api && make build
export LOGGER_NAME=uv-api LOGGER_DEBUG=true
export SERVER_ADDR=0.0.0.0 SERVER_PORT=8080
export METRICS_ADDR=0.0.0.0 METRICS_PORT=9090
export REALTIME_ADDR=0.0.0.0 REALTIME_PORT=8081
export POSTGRES_ADDR=localhost POSTGRES_PORT=5432
export POSTGRES_USERNAME=ultraviolet
export POSTGRES_PASSWORD="$(cat ../service-env/secrets/postgres_password)"
export POSTGRES_DATABASE=ultraviolet
export POSTGRES_SCHEMA_PATH="$(pwd)/deploy/migrations"
export AUTH_JWT_SECRET="$(cat ../service-env/secrets/auth_jwt_secret)"
./bin/uv-api

फ्रंटएंड: cd service-frontend && npm run dev (Vite /api → :8080 और /realtime → :8081 प्रॉक्सी करता है)।

GeoIP और CVE

cd service-env && make geoip-download      # IPLocate MMDB → geoip/
make -C service-env cve-catalog-dump       # CVE dump (requires running postgres)

Docker के बिना बिल्ड

make build && make lint && make frontend-build && make docs-build

📦 रिलीज़ और इंस्टॉलेशन

लक्षित प्लेटफ़ॉर्म: linux/amd64। Apple Silicon पर, ऑफ़लाइन आर्काइव के लिए DOCKER_PLATFORM=linux/amd64 सेट करें।

git tag v0.1.0
make release VERSION=v0.1.0
make release-promote VERSION=v0.1.0   # :latest — required for local releases; GitHub Actions does this automatically

ऑनलाइन: एक्सट्रैक्ट करें → cp .env.example .env → ./install.sh (registry से पुल करें)।

ऑफ़लाइन: ./install.sh (docker load, कोई पुल नहीं)। अपग्रेड: .env, secrets/ और Postgres वॉल्यूम रखें → ./upgrade.sh।

वेरिएबल: UV_REGISTRY (डिफ़ॉल्ट docker.io/styakush), DRY_RUN=1 — पुश के बिना लोकल स्मोक बिल्ड।

# from the build machine
scp dist/ultraviolet-v0.1.0-offline.tar.gz user@host:~/

# on the server (Docker ≥ 24, amd64)
tar xzf ultraviolet-v0.1.0-offline.tar.gz && cd ultraviolet-v0.1.0
cp .env.example .env
./install.sh

docker compose -f docker-compose.yml down
# back up .env + secrets/, extract the new archive, run ./upgrade.sh

✅ प्रोडक्शन चेकलिस्ट

1. सीक्रेट्स को secrets/ में रखें, git में कभी नहीं।
2. CORS_ALLOWED_ORIGINS को केवल वास्तविक UI ऑरिजिन पर सेट करें।
3. SCAN_ALLOWED_CIDRS और होस्ट/पोर्ट सीमाएँ कॉन्फ़िगर करें।
4. बूटस्ट्रैप पासवर्ड और AUTH_JWT_SECRET बदलें (install.sh प्लेसहोल्डर अस्वीकार करता है)।
5. APP_ENV=production सेट करें — uv-api admin/admin और 8 अक्षरों से छोटे पासवर्ड अस्वीकार करता है।
6. रिवर्स प्रॉक्सी पर TLS समाप्त करें — उदाहरण: service-env/examples/nginx-tls.conf।
7. प्रॉक्सी के पीछे: AUDIT_TRUST_PROXY_HEADERS=true सेट करें।
8. PostgreSQL का बैकअप लें: service-env/scripts/backup.sh + cron; upgrade.sh भी एक डंप बनाता है।

# docker-compose.override.yml
services:
  service-frontend:
    ports:
      - "127.0.0.1:3000:8080"

CORS_ALLOWED_ORIGINS=https://ultraviolet.example.com
AUDIT_TRUST_PROXY_HEADERS=true

VITE_BASE_PATH=/ultraviolet/ make frontend-build
# UV_BASE_PATH=/ultraviolet/ in compose — must match VITE_BASE_PATH

0 3 * * * cd /opt/ultraviolet/service-env && ./scripts/backup.sh && find backups -name 'uv-*.dump' -mtime +14 -delete

0 4 1 * * cd /opt/ultraviolet/service-env && ./scripts/geoip-refresh.sh >> /var/log/uv-geoip.log 2>&1

🔐 API और RBAC

POST /v1/auth/login के बाद आपको access_token (Bearer) और refresh_token (/v1/auth/refresh) प्राप्त होता है।

GET /v1/me · GET /v1/version · GET /readyz (हेल्थ + वर्जन + कमिट)।

🤝 योगदान

देखें CONTRIBUTING.md। सुरक्षा रिपोर्ट: SECURITY.md। सामुदायिक मानक: CODE_OF_CONDUCT.md।

📄 लाइसेंस

UltraViolet MIT लाइसेंस के अंतर्गत जारी किया गया है।

_{UltraViolet — जानें कि आपके पास क्या है, समझें कि क्या बदला, और इसे अपने नेटवर्क पर ही रखें।}