Scoring Engine

Scoring Engine هي منصة مفتوحة المصدر لإدارة مسابقات الأمن السيبراني للفرق الحمراء/البيضاء/الزرقاء. تقوم بأتمتة فحوصات الخدمة كل جولة وتوفر واجهة ويب للوحة النتائج والتكوين.

الميزات

• الجدولة الآلية وتنفيذ فحوصات الخدمة
• التنفيذ الموزع المتوازي عبر عمال Celery و Redis
• واجهة ويب لعرض النتائج وتكوين الخدمات
• واجهة برمجة تطبيقات JSON للوصول البرمجي إلى النتائج والتكوين
• 28 فحص خدمة مدمج (SSH، HTTP، DNS، SMTP، والمزيد)
• دعم النشر في بيئات منعزلة/غير متصلة بالإنترنت
• وضع تجريبي مع بيانات توضيحية معبأة مسبقًا

البنية

يستخدم Scoring Engine بنية موزعة بالمكونات التالية:

فحوصات الخدمة المدعومة

يتضمن Scoring Engine فحوصات للخدمات الشائعة مباشرة:

يمكن إضافة فحوصات مخصصة عن طريق إنشاء صنف بايثون في المسار scoring_engine/checks/.

المتطلبات الأساسية

تثبيت Docker (موصى به)

• Docker
• Docker Compose (مضمن مع Docker Desktop؛ على Linux يتم تثبيته بشكل منفصل)
• لمستخدمي Windows، تأكد من ضبط Docker Desktop لـ استخدام حاويات Linux.

التثبيت من المصدر

للتثبيت من المصدر بدون Docker:

• يتطلب Python 3.10 أو أعلى
• خادم قاعدة بيانات MariaDB/MySQL
• خادم Redis

# Install the package
pip install -e .

# Or install with test dependencies
pip install -e .
pip install -r tests/requirements.txt

البداية السريعة

بناء وتشغيل جميع الخدمات:

docker compose build
docker compose up

أو استخدم Makefile للراحة:

make build
make run

بمجرد التشغيل، قم بالوصول إلى التطبيق على http://localhost.

بيانات الاعتماد التجريبية

سجل الدخول باستخدام أي من بيانات الاعتماد التالية:

متغيرات البيئة

إعادة تعيين قاعدة البيانات قبل البدء:

SCORINGENGINE_OVERWRITE_DB=true docker compose up

التشغيل مع بيانات عينة (وضع تجريبي):

SCORINGENGINE_EXAMPLE=true docker compose up

أو دمج الاثنين للحصول على نسخة تجريبية جديدة:

make run-demo

صور Docker المعدة مسبقًا

الصور المعدة مسبقًا متوفرة من كلا السجلين:

• GitHub Container Registry: ghcr.io/scoringengine/scoringengine/<image>:<tag>
• Docker Hub: scoringengine/<image>:<tag>

الصور المتاحة: base، bootstrap، engine، web، worker

الوسوم: latest، develop، وسوم الإصدارات (مثل v1.1.0)

النشر في البيئات المنعزلة

للمسابقات التي لا تتوفر فيها إمكانية الوصول إلى الإنترنت:

# Create a complete deployment package
./bin/create-airgapped-package.sh

# Transfer scoringengine-airgapped.tar.gz to the airgapped system
# Then extract and deploy:
tar -xzf scoringengine-airgapped.tar.gz
cd scoringengine-airgapped
./deploy.sh

راجع دليل النشر في البيئات المنعزلة للحصول على تعليمات مفصلة.

التطوير

أوامر Makefile

تشغيل الاختبارات

قم بتشغيل أدوات التحليل ومجموعة الاختبارات قبل تقديم التغييرات:

# Install pre-commit hooks
pip install pre-commit
pre-commit install

# Run linters on changed files
pre-commit run --files <changed-files>

# Run all tests
pytest tests/

# Run tests with coverage
make run-tests

للتحقق من جميع الملفات: pre-commit run --all-files

بناء التوثيق محليًا

pip install -r docs/requirements.txt
cd docs
make html

افتح docs/build/html/index.html في متصفحك.

إدارة الإصدارات

يستخدم هذا المشروع الإصدارات الدلالية. لترقية الإصدارات:

# Install development dependencies
pip install -r tests/requirements.txt

# Bump version (patch/minor/major)
bump-my-version bump patch

راجع VERSION_MANAGEMENT.md للحصول على تعليمات مفصلة.

التوثيق

التوثيق الكامل متاح على https://scoringengine.readthedocs.io/en/latest/.

الترخيص

تم الإصدار بموجب رخصة MIT.