Skip to content

README.fa.md

Latest commit

 

History

History
212 lines (153 loc) · 10.9 KB

README.fa.md

File metadata and controls

212 lines (153 loc) · 10.9 KB
Raw

CVE Radar (رادار CVE)

CI Quality Gate codecov License: MIT Node TypeScript Docker

پایش چندمنبعی CVE و آسیب‌پذیری برای stack زیرساختی شما — فقط APIهای عمومی رایگان (NVD، OSV، GitHub Advisories، KEV سازمان CISA، RSS امنیتی). رابط RTL/LTR با تم روشن، تاریک و سیستم، به‌علاوه شش زبان رابط کاربری.

اگر برای تیم‌تان مفید بود، ستاره در GitHub بگذارید تا دیگران هم پیدایش کنند. راهنمای پروموت: docs/PROMOTION.md.

CVE Radar — داشبورد پس از اسکن کامل

داشبورد: خلاصه شدت، کارت CVE به‌ازای هر ابزار (HAProxy، Redis، …)، نمودارها، نوار کناری یکپارچه با ابزارهای پشته، تازگی منابع داده و کنترل‌های اسکن. به‌روزرسانی تصویر: DOCS_DEMO_LOCALE=fa npm run docs:product-demo.

زبان README
English README.md
فارسی همین صفحه
العربية README.ar.md
Русский README.ru.md
中文 README.zh.md
Français README.fr.md

مستندات: https://blog.raminnietzsche.ir/CVE-Radar/ · extended-docs (منبع) · واژه‌نامه

make extended-docs-serve   # پیش‌نمایش محلی http://127.0.0.1:8000

ویژگی‌ها

  • اسکن کامل — NVD + OSV + GitHub + CISA KEV + The Hacker News + TuxCare RSS
  • نظارت سریع (watch) — OSV + GitHub (+ RSS) دوره‌ای، بدون تأخیر NVD
  • داشبورد — نمودار دایره‌ای شدت، نمودار میله‌ای نوع، وضعیت هر ابزار
  • فیلترها — شدت، نوع، ابزار، جستجو، مرتب‌سازی (شدت / تاریخ / CVSS)
  • چندزبانه — فارسی، عربی، انگلیسی، روسی، چینی، فرانسوی (UI + تاریخ و اعداد محلی)
  • تم‌ها — روشن / تاریک / سیستم
  • ترجمه اختیاری فارسی — EN→FA سمت سرور (MyMemory / LibreTranslate / Ollama)
  • تازگی منبع — زمان آخرین واکشی موفق هر منبع در نوار کناری
  • ویزارد راه‌اندازی اولیه — پشته، تنظیمات و منابع قبل از داشبورد (v1.1.0)
  • کش اسکن — بازیابی آخرین اسکن هنگام reload وقتی پشته یکسان است؛ بنر نتایج ذخیره‌شده در داشبورد
  • promptهای GitHub Models — promptهای AI قابل استفاده مجدد در .github/prompts/ برای onboarding و عملیات
  • اعلان watch چندکاناله — Slack، Discord، Telegram، email، webhook عمومی از طریق NotificationService
  • قابلیت‌های self-hosted — RBAC (API_ROLE)، multi-tenancy اختیاری PostgreSQL، history/trends، کش Redis، متریک Prometheus، mirrorهای air-gap، کشف پشته K8s
  • جریان SSE اسکن — POST /api/v1/scan/stream برای رویداد پیشرفت در اسکن کامل

آخرین نسخه: v1.2.1 · راهنمای انتشار: docs/RELEASE.md

نقشه‌ی راه

کارهای فعال در GitHub Issues پیگیری می‌شود:

حوزه Epic یادداشت
تست E2E، fixture، coverage #78 Playwright export + ~257 spec؛ mirrorهای یکپارچگی بیشتر
نگهداشت SonarCloud #134–#139 پاک‌سازی code smell

تحویل‌شده تحت MIT: اعلان چندکاناله (#124، #127)، پایهٔ Drizzle (#125، #128)، RBAC، multi-tenancy، history PostgreSQL، کش Redis (#66)، Prometheus، EPSS، air-gap — فصل ۱۱.

برای مشارکت، issue با برچسب good first issue را انتخاب کنید یا قبل از PR روی epic نظر بگذارید.

راه‌اندازی سریع

git clone https://github.com/RaminNietzsche/CVE-Radar.git
cd CVE-Radar
make setup
make dev
سرویس آدرس
رابط وب http://localhost:5173
سلامت API http://localhost:3001/api/health

متغیرهای محیطی اختیاری (.env)

NVD_API_KEY=          # https://nvd.nist.gov/developers/request-an-api-key
GITHUB_TOKEN=         # سقف بالاتر GitHub Advisories
SCAN_DAYS=60
TRANSLATE_ENABLED=true
# RATE_LIMIT_SCAN_PER_MIN=12
# RATE_LIMIT_WATCH_PER_MIN=120

از .env.example کپی کنید. هرگز .env را commit نکنید.

منابع داده

منبع نقش
NVD رکوردهای رسمی CVE (اسکن کامل)
OSV آسیب‌پذیری پکیج‌های متن‌باز
GitHub Advisories GHSA / توصیه‌های بازبینی‌شده
CISA KEV آسیب‌پذیری‌های بهره‌برداری‌شده شناخته‌شده
The Hacker News RSS اخبار امنیتی
TuxCare RSS وبلاگ امنیتی

API

متد مسیر توضیح
GET /api/health وضعیت، نسخه، env (?detailed=true)
GET /metrics متریک Prometheus
GET /api/capabilities محدودیت‌ها، قابلیت‌ها، زبان‌های ترجمه
GET /api/sources فهرست منابع داخلی + RSS پیش‌فرض
GET /api/openapi.json مشخصات OpenAPI 3.1
POST /api/scan/validate اعتبارسنجی stack/منابع (بدون اسکن)
POST /api/scan اسکن کامل
POST /api/watch نظارت + newVulns / hasNew
POST /api/translate ترجمه دسته‌ای
POST /api/v1/scan/stream اسکن SSE (v1)
GET /api/v1/scans/history history tenant (PostgreSQL)
GET/POST /api/v1/tenants/stacks پشته‌های ذخیره‌شده
GET /api/v1/discovery/kubernetes کشف K8s (opt-in)

مرجع کامل: فصل API · make extended-docs-serve → API Explorer.

Production

make build
make start   # API + فایل‌های static روی PORT (پیش‌فرض 3001)

Docker

Docker Hub: raminnietzsche/cve-radar · متن Hub: docs/dockerhub/

docker pull raminnietzsche/cve-radar:latest
docker run --rm -p 3001:3001 raminnietzsche/cve-radar:latest
# or compose: docker compose -f docker-compose.hub.yml up -d

Build از منبع:

docker compose up --build
# UI + API → http://localhost:3001

جزئیات: docs/DOCKER.md.

عملیات self-hosted

تمامی قابلیت‌های پیشرفته — audit log، RBAC، تاریخچهٔ multi-tenant، متریک Prometheus، EPSS، نگاشت compliance، Kubernetes discovery، mirror آفلاین — تحت MIT و بدون tier enterprise هستند. راهنمای چندزبانه: extended-docs فصل ۱۱ (en · fa · ar · ru · zh · fr) · راهنمای maintainer: docs/self-hosted/.

GitHub Pages (extended-docs)

سایت منتشرشده: blog.raminnietzsche.ir/CVE-Radar/. مشکل deploy (404) دارید؟ docs/GITHUB_PAGES.md.

نمونه پشته: examples/stack.json. OpenAPI: docs/OPENAPI.md.

ساختار پروژه

نقشهٔ کامل: ARCHITECTURE.md.

├── src/              # React + Vite UI (see src/README.md)
├── server/           # Express API + feeds (see server/README.md)
├── extended-docs/    # Canonical MkDocs site (6 languages, CI deploy)
├── docs/             # ADRs, Docker/Pages/OpenAPI guides (see docs/README.md)
├── tests/            # API + unit tests
├── scripts/          # Tooling (screenshots, OpenAPI check, icons)
├── examples/         # Sample stack JSON
├── public/           # Static assets (favicon, brand icons)
├── .github/          # CI, Pages, Docker Hub, CODEOWNERS
└── Makefile

Makefile

make help
make check      # lint + typecheck + test
make test
make docs-serve # اختیاری: MkDocs Material site

سلب مسئولیت

این ابزار فیدهای عمومی را برای آگاهی جمع‌آوری می‌کند. یافته‌ها را همیشه با توصیه‌های سازنده و فرایند تغییر خود تأیید کنید. آیتم‌های RSS لزوماً ۱:۱ با شناسه CVE نیستند.

مشارکت

CONTRIBUTING.md، SECURITY.md، CODE_OF_CONDUCT.md و CHANGELOG.md.

مجوز

MIT