مرجع واجهة سطر الأوامر
يمكن تشغيل خلفية Ogma المكتوبة بلغة Rust كخادم وكيل محلي أو عملية MCP مضمّنة أو أمر لاختبار الاختراق دون واجهة رسومية.
عادةً ما يبدأ مستخدمو نسخة سطح المكتب المعبّأة تشغيل Ogma من التطبيق. يفيد استخدام سطر الأوامر في التطوير والأتمتة والاختبارات المحلية التي تتطلب تشغيله كخادم.
وضع الخادم
bash
ogma \
--listen 127.0.0.1:8080 \
--api-port 127.0.0.1:8181 \
--data-dir ./ogma-dataالخيارات الشائعة
| الخيار | القيمة الافتراضية | الغرض |
|---|---|---|
--listen | 127.0.0.1:8080 | عنوان الاستماع للوكيل. |
--api-port | 127.0.0.1:8181 | عنوان واجهة REST API وخادم الواجهة الأمامية. |
--data-dir | ./ogma-data | قاعدة بيانات المشروع والشهادات والإضافات وعمليات التصدير والحالة المحلية. |
--max-plugin-size | 52428800 | الحد الأقصى لحجم حزمة الإضافة بالبايت. |
--intercept-queue-cap | 1000 | الحد الأقصى لعناصر الاعتراض في قائمة الانتظار قبل تمرير حركة المرور الجديدة. |
--ui-dir | غير محدد | المجلد الذي يحتوي على ملفات الواجهة الأمامية المبنية لتقديمها من خادم API. |
خيارات OAST
| الخيار | القيمة الافتراضية | الغرض |
|---|---|---|
--oast-http-port | 8888 | مستمع اتصالات الاستدعاء الراجع عبر HTTP. استخدم 0 لتعطيله. |
--oast-https-port | 8443 | مستمع اتصالات الاستدعاء الراجع عبر HTTPS. استخدم 0 لتعطيله. |
--oast-dns-port | 5353 | مستمع اتصالات الاستدعاء الراجع عبر DNS. استخدم 0 لتعطيله. |
--oast-smtp-port | 2525 | مستمع اتصالات الاستدعاء الراجع عبر SMTP. استخدم 0 لتعطيله. |
--oast-domain | oast.local | النطاق المستخدم لأسماء مضيفي الاستدعاء الراجع التي يجري توليدها. |
--oast-public-ip | غير محدد | عنوان IP العام الذي تُرجعه استجابات سجلات A في DNS الخاص بـ OAST. |
وضع اختبار الاختراق دون واجهة رسومية
ينفّذ الأمر الفرعي pentest الاستكشاف والتحليل السلبي والفحص النشط الاختياري، ويُصدر تقريرًا بصيغة Markdown.
bash
ogma pentest https://example.com \
--depth 3 \
--concurrency 10 \
--min-severity medium \
--output report.mdخيارات اختبار الاختراق
| الخيار | القيمة الافتراضية | الغرض |
|---|---|---|
--depth | 3 | عمق الاستكشاف. تعني 0 أنه غير محدود. |
--concurrency | 10 | الحد الأقصى للطلبات المتزامنة. |
--no-active | معطّل | تعطيل الفحص النشط؛ تنفيذ الاستكشاف والتحليل السلبي فقط. |
--min-severity | medium | أدنى مستوى خطورة يؤدي إلى إرجاع رمز الخروج 1. القيم الصالحة: info، low، medium، high، critical. |
--output | المخرج القياسي | كتابة التقرير إلى ملف بدلًا من المخرج القياسي. |
رموز الخروج:
| الرمز | المعنى |
|---|---|
0 | اكتمل التنفيذ ولم تبلغ أي نتيجة حد الخطورة المحدد. |
1 | اكتمل التنفيذ وبلغت نتيجة واحدة على الأقل حد الخطورة المحدد. |
2 | خطأ في التشغيل أو الإعداد. |
وضع MCP
يمكن بدء MCP من إعدادات Ogma أو عبر الملف التنفيذي المستقل ogma-mcp. تدعم خيارات الخلفية المخفية أيضًا وضع MCP المضمّن عندما يشغّل Ogma عملية MCP داخلية.
للإعداد المعتاد، راجع إعداد MCP.
خيارات ogma-mcp المستقل
bash
ogma-mcp \
--api-url http://127.0.0.1:8181 \
--body-preview-bytes 2048| الخيار | متغير البيئة | القيمة الافتراضية | الغرض |
|---|---|---|---|
--api-url | OGMA_API_URL | http://127.0.0.1:8181 | عنوان API لخلفية Ogma قيد التشغيل. |
--body-preview-bytes | غير محدد | 512 | الحد الأقصى لبايتات معاينة المحتوى التي تُرجعها أدوات القراءة. |
--allow-write-findings | OGMA_MCP_ALLOW_WRITE_FINDINGS | معطّل | السماح بإنشاء النتائج وتحديثها وإضافة الوسوم وربط الأدلة. |
--allow-export-data | OGMA_MCP_ALLOW_EXPORT_DATA | معطّل | السماح بإنشاء مهام التصدير. |
--allow-read-secrets | OGMA_MCP_ALLOW_READ_SECRETS | معطّل | إرجاع قيم متغيرات البيئة دون حجبها. |
--allow-send-requests | OGMA_MCP_ALLOW_SEND_REQUESTS | معطّل | تفعيل الأدوات التي ترسل حركة المرور أو تتحكم في المتصفح أو تزحف أو تستقصي أو تختبر المصادقة أو تتصل بـ WebSockets. |
--allow-run-workflows | OGMA_MCP_ALLOW_RUN_WORKFLOWS | معطّل | تفعيل أدوات معاينة مسار العمل وتشغيله وإلغائه. |
--allow-intercept-control | OGMA_MCP_ALLOW_INTERCEPT_CONTROL | معطّل | تفعيل التحكم في قائمة انتظار الاعتراض والتمرير والإسقاط والتعديل. |
--tool-profile | OGMA_MCP_TOOL_PROFILE | full | خيار للتوافق مع الإصدارات القديمة. يجري الإعلان عن جميع الأدوات دائمًا، حتى عندما يمرر أمر قديم core أو discovery. الخيار --mcp-tool-profile اسم بديل له. |
يكتب MCP رسائل البروتوكول إلى المخرج القياسي، لذلك تُوجّه سجلات التشغيل إلى مخرج الأخطاء القياسي.
تقبل متغيرات البيئة المنطقية الخاصة بالأذونات القيمة true لتفعيل الإمكانية. لا يفرض الخادم حصصًا للنشاط لكل دقيقة أو لكل جلسة؛ وتظل حدود كل أداة سارية. لا تُقبل خيارات الحصص التي أُزيلت. تضبط خيارات النقل عبر القنوات القياسية إعدادات تلك العملية بصورة مستقلة عن إعدادات MCP المضمّن.
نسخ التطوير
تتوفر نصوص البناء المحلي في جذر المستودع:
bash
./build-local.sh
./build-desktop-local.shاستخدم نسخة سطح المكتب عند اختبار تجربة Electron المعبّأة. واستخدم نسخة الخلفية والواجهة الأمامية عند اختبار سلوك API وواجهة الويب.