מדריך ממשק שורת הפקודה

שרת Ogma, שנכתב ב-Rust, יכול לפעול כשרת פרוקסי מקומי, כתהליך MCP משובץ או כפקודת בדיקת חדירה ללא ממשק גרפי.

משתמשי גרסת שולחן העבודה הארוזה מפעילים בדרך כלל את Ogma מתוך היישום. שימוש בשורת הפקודה מועיל לפיתוח, לאוטומציה ולבדיקות מקומיות שבהן מפעילים את Ogma כשרת.

מצב שרת

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.

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 העצמאי

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	מושבת	הפעלת כלים ששולחים תעבורה, שולטים בדפדפן, סורקים בזחילה, מבצעים בדיקות ממוקדות, בודקים אימות או מתחברים ל-WebSocket.
--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 המשובץ.

גרסאות פיתוח

סקריפטים לבנייה מקומית זמינים בשורש המאגר:

./build-local.sh
./build-desktop-local.sh

השתמשו בבניית שולחן העבודה לבדיקת חוויית Electron הארוזה. השתמשו בבניית השרת וממשק המשתמש לבדיקת התנהגות ה-API וממשק האינטרנט.