pySigma

pySigma هي مكتبة بايثون تقوم بتحليل وتحويل قواعد Sigma إلى استعلامات. وهي بديل لسلسلة أدوات Sigma القديمة (sigmac) بتصميم أنظف بكثير وهي شبه مختبرة بالكامل. الخلفيات (Backends) لدعم التحويل إلى لغات الاستعلام وخطوط المعالجة لتحويل القواعد لنماذج بيانات السجلات مفصولة في مشاريع مخصصة لإبقاء pySigma نفسه خفيفًا ومحايدًا تجاه البائعين. انظر قسم المشاريع ذات الصلة أدناه للحصول على نظرة عامة.

البدء

لبدء استخدام pySigma، تحتاج إلى Python 3.10 أو أحدث. قم بتثبيته باستخدام مدير حزم بايثون الذي تختاره. أمثلة:

pip install pysigma
pipenv install pysigma
poetry add pysigma

يمكن العثور على التوثيق مع بعض الأمثلة الاستخدامية هنا.

إنشاء الخلفية الخاصة بك لـ pySigma

أصبح إنشاء خلفية أسهل بكثير مع pySigma. نوصي باستخدام "قالب Cookie Cutter" ومراجعة الخلفيات الموجودة المدرجة في قسم "المشاريع ذات الصلة" في هذا README.

قالب pySigma Cookie Cutter

الميزات

يجلب pySigma عددًا من الميزات الإضافية مقارنةً بـ sigmac الشامل، بالإضافة إلى بعض التغييرات.

sigma-cli هو المكافئ لـ sigmac للتحويل عبر سطر الأوامر

المعدِّل (Modifier)

استخدم sigma list modifiers

الخلفيات (Backends)

استخدم sigma plugin list --plugin-type backend

نظرة عامة

نظرة عامة على التحويل

خطوط المعالجة

مزيد من التفاصيل موصوفة في التوثيق.

الاختبار

يستخدم pySigma إطار الاختبار pytest. قم بتشغيل pytest لتشغيل جميع الاختبارات. قم بتشغيل pytest --cov=sigma للحصول على تقرير تغطية.

البناء

لبناء الحزمة الخاصة بك قم بتشغيل poetry build.

فحص الكود (Linting)

لفحص الكود قم بتشغيل poetry run black. للتحقق من أخطاء الفحص قم بتشغيل poetry run black --check.

يستخدم هذا المشروع أيضًا pre-commit، والذي يتم تثبيته بواسطة poetry كجزء من التبعيات التطويرية. لتثبيت خطافات git قم بتشغيل poetry run pre-commit install بعد استنساخ المستودع وتثبيت التبعيات.

المساهمة

مرحبًا بالطلبات المقدمة (Pull Requests). لا تتردد في تقديم أي مشكلات/طلبات PR كنقاط نقاش.

تشرح هذه المشاركة بقلم Micah Babinski العملية من منظور المطور.

المشرفون

المشروع مشرف عليه حاليًا من قبل:

• Thomas Patzke [email protected]
• François Hubaut

المشاريع ذات الصلة

pySigma ليست مكتبة متجانسة تحاول دعم كل شيء بل النواة فقط. يتم توفير الدعم للغات الاستعلام المستهدفة ونماذج بيانات السجلات بواسطة حزم إضافية توسع pySigma:

• sigma-cli: واجهة سطر أوامر لتحويل قواعد Sigma بناءً على pySigma.
• pySigma-backend-splunk
• pySigma-pipeline-sysmon
• pySigma-pipeline-crowdstrike
• pySigma-backend-netwitness
• pySigma-backend-panther

يمكن أيضًا تثبيت جميع الحزم من PyPI ما لم يُذكر خلاف ذلك بواسطة مدير حزم Python الذي تختاره.

الترخيص

رخصة جنو العمومية الصغرى الإصدار 2.1. للتفاصيل، يرجى الاطلاع على ملف الترخيص الكامل الموجود هنا.