تخطٍّ إلى المحتوى
Fendixالتوثيقالتوثيق

.fendix.yaml · SEC-001 · SARIF

الإصدار الحالي v3.7.0
مرجعمستقرv3.7.0

.fendix.yaml

المخطط الصارم والقيم الافتراضية والتحقق والأولوية وربط CLI لملف .fendix.yaml.

في هذه الصفحة

إصدار المخطط الصارم الحالي لملف .fendix.yaml هو 1. تُرفض الحقول غير المعروفة والإصدارات المستقبلية غير المدعومة.

أقل تهيئة صالحة

.fendix.yaml
version: 1

سياسة إصدار شائعة

.fendix.yaml
version: 1
fail_on: HIGH
ignore_path: .fendix-ignore
scan:
  enforce_confidence: true
  deescalate_tests: true

الأولوية

تطبّق Fendix القيم الافتراضية، ثم القيم الموجودة في .fendix.yaml، ثم خيارات CLI التي مررها المستخدم صراحة فقط. ولا تستبدل قيمة CLI غير المعدّلة قيمة الملف.

defaults→.fendix.yaml→explicit CLI flags

حقول المستوى الأعلى

مرّر أفقيًا للاطلاع على جميع الحقول.

الحقلالنوعالافتراضيالإلزامالقيم المسموحةCLIالوصف
versioninteger1مطلوب1—إصدار مخطط التهيئة المطلوب.
fail_onstring—اختياريCRITICAL · HIGH · MEDIUM · LOW · empty--fail-onحد الخطورة الذي تقيّمه سياسة النتائج.
ignore_pathstring—اختياري—--ignoreمسار ملف الاستبعادات في المستودع.

حقول scan

مرّر أفقيًا للاطلاع على جميع الحقول.

الحقلالنوعالافتراضيالإلزامالقيم المسموحةCLIالوصف
scan.deescalate_testsbooleantrueاختياري—--deescalate-testsيخفض نتائج شيفرة الاختبار غير المدعومة مع إبقاء الأدلة.
scan.delay_msinteger100اختياري—--delayالفاصل بين طلبات HTTP بالمللي ثانية.
scan.enable_activebooleanfalseاختياري—--enable-activeيسمح صراحة باختبارات الحقن النشطة.
scan.enforce_confidencebooleantrueاختياري—--enforce-confidenceيشترط دعم الثقة والأدلة قبل BLOCK.
scan.formatstringjsonاختياريjson · html · sarif · pdf--formatصيغة التقرير الافتراضية.
scan.timeoutinteger10اختياري—--timeoutمهلة HTTP بالثواني.
scan.workersinteger10اختياري—--workersعدد عمال HTTP المتزامنين.

حقول crawler

مرّر أفقيًا للاطلاع على جميع الحقول.

الحقلالنوعالافتراضيالإلزامالقيم المسموحةCLIالوصف
crawler.crawl_depthinteger1اختياري—--crawl-depthعمق تتبع روابط HTML.
crawler.max_endpointsinteger500اختياري—--max-endpointsالحد الأقصى لنقاط النهاية المكتشفة.
crawler.respect_robotsbooleanfalseاختياري—--respect-robotsيفرض تعليمات Disallow في robots.txt.
crawler.wordlist_pathstring—اختياري—--wordlistمسار قائمة كلمات مخصصة للاكتشاف.

حقول budgets

مرّر أفقيًا للاطلاع على جميع الحقول.

الحقلالنوعالافتراضيالإلزامالقيم المسموحةCLIالوصف
budgets.max_durationduration0sاختياري—--max-durationحد لين للمدة الإجمالية للفحص.
budgets.max_requestsinteger0اختياري—--max-requestsحد لين لإجمالي طلبات HTTP.

حقول auth

مرّر أفقيًا للاطلاع على جميع الحقول.

الحقلالنوعالافتراضيالإلزامالقيم المسموحةCLIالوصف
auth.profilestring—اختياري—--profileاسم ملف مصادقة محلي؛ لا تُحفظ البيانات السرية في سياسة المستودع.

سلوك التحقق

  • الحقل version مطلوب ويجب أن يكون موجبًا وألا يتجاوز 1.
  • تفشل قراءة الحقول غير المعروفة؛ ولا تُتجاهل الأخطاء الإملائية بصمت.
  • يفشل إصدار المخطط المستقبلي بوضوح حتى لا يسيء إصدار أقدم من الأداة تفسير السياسة.

إمكانات مستقرة متاحة عبر CLI فقط

لا يمكن حاليًا حفظ هذه الضوابط المستقرة في .fendix.yaml. مرّرها صراحة في الأمر أو إعداد CI.

الإمكانيةخيارات CLI
بوابات التغطية--fail-on-coverage-gap, --require-analyzers
سياسة قابلية التطبيق--block-on-inapplicable
الفحص دون اتصال--offline, --offline-db
نطاق التغييرات والملفات المرحّلة--diff, --staged, --fast
اختيار المحللات--checks, --python-engine, --no-native-deps
الاستيراد والإضافات--import, --no-plugins, --allow-repo-local-plugins

تهيئة سياسة الإصدار · خيارات سياسة scan