CLI başvuru kaynağı
Ogma'nın Rust arka ucu yerel proxy sunucusu, yerleşik MCP süreci veya arayüzsüz sızma testi komutu olarak çalışabilir.
Paketlenmiş masaüstü sürümünün kullanıcıları Ogma'yı genellikle uygulamadan başlatır. CLI kullanımı geliştirme, otomasyon ve sunucu tarzı yerel testlerde yararlıdır.
Sunucu modu
bash
ogma \
--listen 127.0.0.1:8080 \
--api-port 127.0.0.1:8181 \
--data-dir ./ogma-dataYaygın bayraklar
| Bayrak | Varsayılan | Amaç |
|---|---|---|
--listen | 127.0.0.1:8080 | Proxy dinleyicisi adresi. |
--api-port | 127.0.0.1:8181 | REST API ve ön uç sunucu adresi. |
--data-dir | ./ogma-data | Proje veritabanı, sertifikalar, eklentiler, dışa aktarımlar ve yerel durum. |
--max-plugin-size | 52428800 | Bayt cinsinden en fazla eklenti paketi boyutu. |
--intercept-queue-cap | 1000 | Yeni trafik iletilmeden önce kuyrukta tutulabilecek en fazla öğe sayısı. |
--ui-dir | ayarlanmamış | API sunucusundan sunulacak derlenmiş ön uç dosyalarının dizini. |
OAST bayrakları
| Bayrak | Varsayılan | Amaç |
|---|---|---|
--oast-http-port | 8888 | HTTP geri çağrı dinleyicisi. Kapatmak için 0 kullanın. |
--oast-https-port | 8443 | HTTPS geri çağrı dinleyicisi. Kapatmak için 0 kullanın. |
--oast-dns-port | 5353 | DNS geri çağrı dinleyicisi. Kapatmak için 0 kullanın. |
--oast-smtp-port | 2525 | SMTP geri çağrı dinleyicisi. Kapatmak için 0 kullanın. |
--oast-domain | oast.local | Üretilen geri çağrı ana makine adlarında kullanılan alan adı. |
--oast-public-ip | ayarlanmamış | OAST DNS A kaydı yanıtlarında döndürülen genel IP. |
Arayüzsüz sızma testi modu
pentest alt komutu keşif, pasif analiz ve isteğe bağlı aktif tarama çalıştırır, Markdown raporu üretir.
bash
ogma pentest https://example.com \
--depth 3 \
--concurrency 10 \
--min-severity medium \
--output report.mdSızma testi bayrakları
| Bayrak | Varsayılan | Amaç |
|---|---|---|
--depth | 3 | Keşif derinliği. 0 sınırsız demektir. |
--concurrency | 10 | En fazla eşzamanlı istek sayısı. |
--no-active | kapalı | Aktif taramayı kapatır; yalnızca keşif ve pasif analiz çalıştırır. |
--min-severity | medium | 1 çıkış kodu döndüren en düşük önem derecesi. Geçerli değerler: info, low, medium, high, critical. |
--output | stdout | Raporu stdout yerine dosyaya yazar. |
Çıkış kodları:
| Kod | Anlamı |
|---|---|
0 | Tamamlandı ve hiçbir bulgu önem eşiğine ulaşmadı. |
1 | Tamamlandı ve en az bir bulgu önem eşiğine ulaştı. |
2 | Çalışma zamanı veya yapılandırma hatası. |
MCP modu
MCP, Ogma ayarlarından veya bağımsız ogma-mcp ikili dosyasıyla başlatılabilir. Gizli arka uç bayrakları da Ogma bir iç MCP süreci başlattığında yerleşik MCP modunu destekler.
Normal kurulum için MCP kurulumu bölümünü kullanın.
Bağımsız ogma-mcp bayrakları
bash
ogma-mcp \
--api-url http://127.0.0.1:8181 \
--body-preview-bytes 2048| Bayrak | Ortam değişkeni | Varsayılan | Amaç |
|---|---|---|---|
--api-url | OGMA_API_URL | http://127.0.0.1:8181 | Çalışan Ogma arka uç API URL'si. |
--body-preview-bytes | ayarlanmamış | 512 | Okuma araçlarının döndürdüğü en fazla gövde önizleme baytı. |
--allow-write-findings | OGMA_MCP_ALLOW_WRITE_FINDINGS | kapalı | Bulgu oluşturma, güncelleme, etiketleme ve kanıt bağlamayı etkinleştirir. |
--allow-export-data | OGMA_MCP_ALLOW_EXPORT_DATA | kapalı | Dışa aktarım işi oluşturmayı etkinleştirir. |
--allow-read-secrets | OGMA_MCP_ALLOW_READ_SECRETS | kapalı | Maskelenmemiş ortam değişkeni değerlerini döndürür. |
--allow-send-requests | OGMA_MCP_ALLOW_SEND_REQUESTS | kapalı | Trafik gönderen, web tarayıcısını yöneten, site tarayan, yoklama yapan, kimlik doğrulamayı test eden veya WebSocket'e bağlanan araçları etkinleştirir. |
--allow-run-workflows | OGMA_MCP_ALLOW_RUN_WORKFLOWS | kapalı | İş akışı önizleme, çalıştırma ve iptal araçlarını etkinleştirir. |
--allow-intercept-control | OGMA_MCP_ALLOW_INTERCEPT_CONTROL | kapalı | Trafik durdurma kuyruğu kontrolünü, iletmeyi, engellemeyi ve değiştirmeyi etkinleştirir. |
--tool-profile | OGMA_MCP_TOOL_PROFILE | full | Eski uyumluluk bayrağı. Eski bir komut core veya discovery geçirdiğinde bile tüm araçlar her zaman ilan edilir. --mcp-tool-profile aynı işlevin diğer adıdır. |
MCP protokol mesajlarını stdout'a yazar; çalışma zamanı günlükleri stderr'e gider.
Boolean izin ortam değişkenleri yeteneği etkinleştirmek için true kabul eder. Sunucunun dakika/oturum başına etkinlik kotası yoktur; araçların kendi sınırları geçerlidir. Kaldırılmış kota bayrakları kabul edilmez. Stdio bayrakları, o süreci yerleşik MCP ayarlarından bağımsız yapılandırır.
Geliştirme derlemeleri
Yerel derleme betikleri depo kökünde bulunur:
bash
./build-local.sh
./build-desktop-local.shPaketlenmiş Electron deneyimini test ederken masaüstü derlemesini kullanın. API ve web arayüzü davranışını test ederken arka uç/ön uç derlemesini kullanın.