Referenční dokumentace CLI

Backend Ogma v Rustu může běžet jako místní proxy server, vložený proces MCP nebo příkaz pro penetrační testování bez grafického rozhraní.

Uživatelé zabalené desktopové verze obvykle spouštějí Ogma z aplikace. CLI je užitečné pro vývoj, automatizaci a místní testování v serverovém režimu.

Serverový režim

ogma \
  --listen 127.0.0.1:8080 \
  --api-port 127.0.0.1:8181 \
  --data-dir ./ogma-data

Běžné přepínače

Přepínač	Výchozí hodnota	Účel
--listen	127.0.0.1:8080	Adresa, na které proxy naslouchá.
--api-port	127.0.0.1:8181	Adresa serveru REST API a frontendu.
--data-dir	./ogma-data	Databáze projektu, certifikáty, pluginy, exporty a místní stav.
--max-plugin-size	52428800	Maximální velikost balíčku pluginu v bajtech.
--intercept-queue-cap	1000	Maximální počet položek ve frontě zachytávání, po jehož dosažení se nový provoz předává dál.
--ui-dir	nenastaveno	Adresář se sestavenými soubory frontendu, které má poskytovat server API.

Přepínače OAST

Přepínač	Výchozí hodnota	Účel
--oast-http-port	8888	Naslouchající rozhraní pro zpětná volání HTTP. Vypněte hodnotou 0.
--oast-https-port	8443	Naslouchající rozhraní pro zpětná volání HTTPS. Vypněte hodnotou 0.
--oast-dns-port	5353	Naslouchající rozhraní pro zpětná volání DNS. Vypněte hodnotou 0.
--oast-smtp-port	2525	Naslouchající rozhraní pro zpětná volání SMTP. Vypněte hodnotou 0.
--oast-domain	oast.local	Doména používaná pro generované názvy hostitelů zpětných volání.
--oast-public-ip	nenastaveno	Veřejná IP adresa vracená v odpovědích OAST DNS pro záznamy A.

Penetrační testování bez grafického rozhraní

Podpříkaz pentest provádí vyhledávání obsahu, pasivní analýzu, volitelně aktivní skenování a vytváří zprávu ve formátu Markdown.

ogma pentest https://example.com \
  --depth 3 \
  --concurrency 10 \
  --min-severity medium \
  --output report.md

Přepínače penetračního testování

Přepínač	Výchozí hodnota	Účel
--depth	3	Hloubka vyhledávání obsahu. 0 znamená bez omezení.
--concurrency	10	Maximální počet souběžných požadavků.
--no-active	vypnuto	Vypne aktivní skenování; provádí pouze vyhledávání obsahu a pasivní analýzu.
--min-severity	medium	Minimální závažnost, při které se vrátí návratový kód 1. Platné hodnoty: info, low, medium, high, critical.
--output	standardní výstup	Zapíše zprávu do souboru místo na standardní výstup.

Návratové kódy:

Kód	Význam
0	Dokončeno a žádný nález nedosáhl prahové závažnosti.
1	Dokončeno a alespoň jeden nález dosáhl prahové závažnosti.
2	Chyba za běhu nebo chyba konfigurace.

Režim MCP

MCP lze spustit z nastavení Ogma nebo prostřednictvím samostatného binárního souboru ogma-mcp. Skryté přepínače backendu také podporují vložený režim MCP, když Ogma spouští interní proces MCP.

Pro běžné nastavení použijte Nastavení MCP.

Přepínače samostatného ogma-mcp

ogma-mcp \
  --api-url http://127.0.0.1:8181 \
  --body-preview-bytes 2048

Přepínač	Proměnná prostředí	Výchozí hodnota	Účel
--api-url	OGMA_API_URL	http://127.0.0.1:8181	URL API běžícího backendu Ogma.
--body-preview-bytes	nenastaveno	512	Maximální počet bajtů náhledu těla vrácených nástroji pro čtení.
--allow-write-findings	OGMA_MCP_ALLOW_WRITE_FINDINGS	vypnuto	Povolí vytváření a aktualizace nálezů, štítky a propojování s důkazy.
--allow-export-data	OGMA_MCP_ALLOW_EXPORT_DATA	vypnuto	Povolí vytváření exportních úloh.
--allow-read-secrets	OGMA_MCP_ALLOW_READ_SECRETS	vypnuto	Vrací nemaskované hodnoty proměnných prostředí.
--allow-send-requests	OGMA_MCP_ALLOW_SEND_REQUESTS	vypnuto	Povolí nástroje, které odesílají provoz, ovládají prohlížeč, procházejí web, provádějí sondování, testují autentizaci nebo se připojují k WebSocketům.
--allow-run-workflows	OGMA_MCP_ALLOW_RUN_WORKFLOWS	vypnuto	Povolí nástroje pro náhled, spuštění a zrušení pracovních postupů.
--allow-intercept-control	OGMA_MCP_ALLOW_INTERCEPT_CONTROL	vypnuto	Povolí ovládání fronty zachytávání, předávání, zahazování a úpravy.
--tool-profile	OGMA_MCP_TOOL_PROFILE	full	Starší přepínač pro kompatibilitu. Všechny nástroje jsou vždy inzerovány, i když starší příkaz předá core nebo discovery. --mcp-tool-profile je alias.

MCP zapisuje zprávy protokolu na standardní výstup, proto se protokolování za běhu směruje na standardní chybový výstup.

Booleovské proměnné prostředí pro oprávnění přijímají hodnotu true, která danou schopnost povolí. Server nemá kvóty aktivity za minutu ani za relaci; omezení jednotlivých nástrojů nadále platí. Odstraněné přepínače kvót nejsou přijímány. Přepínače pro stdio konfigurují daný proces nezávisle na nastavení vloženého MCP.

Vývojová sestavení

Skripty pro místní sestavení jsou dostupné v kořenovém adresáři repozitáře:

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

Při testování zabalené aplikace v Electronu použijte desktopové sestavení. Při testování chování API a webového rozhraní použijte sestavení backendu/frontendu.