CLI संदर्भ
Ogma का Rust बैकएंड स्थानीय प्रॉक्सी सर्वर, एम्बेडेड MCP प्रक्रिया या ग्राफिकल इंटरफ़ेस के बिना पेनटेस्ट कमांड के रूप में चल सकता है।
पैकेज किए गए डेस्कटॉप संस्करण के उपयोगकर्ता आम तौर पर एप्लिकेशन से Ogma शुरू करते हैं। CLI का उपयोग डेवलपमेंट, स्वचालन और सर्वर की तरह चलने वाले स्थानीय परीक्षणों के लिए उपयोगी है।
सर्वर मोड
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 | सेट नहीं | OAST DNS की A-रिकॉर्ड प्रतिक्रियाओं में लौटाया जाने वाला सार्वजनिक IP। |
ग्राफिकल इंटरफ़ेस के बिना पेनटेस्ट मोड
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 बाइनरी के माध्यम से शुरू किया जा सकता है। जब Ogma आंतरिक MCP प्रक्रिया शुरू करता है, तब बैकएंड के छिपे हुए फ़्लैग भी एम्बेडेड 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 | चल रहे Ogma बैकएंड API का URL। |
--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 सेटिंग से स्वतंत्र रूप से कॉन्फ़िगर करते हैं।
डेवलपमेंट बिल्ड
स्थानीय बिल्ड स्क्रिप्ट रिपॉज़िटरी की रूट डायरेक्टरी में उपलब्ध हैं:
bash
./build-local.sh
./build-desktop-local.shपैकेज किए गए Electron अनुभव की जाँच के लिए डेस्कटॉप बिल्ड का उपयोग करें। API और वेब UI के व्यवहार की जाँच के लिए बैकएंड/फ़्रंटएंड बिल्ड का उपयोग करें।