CLI-naslagwerk

De Rust-backend van Ogma kan worden uitgevoerd als lokale proxyserver, ingesloten MCP-proces of pentestopdracht zonder grafische interface.

Gebruikers van de verpakte desktopversie starten Ogma doorgaans via de applicatie. De CLI is handig voor ontwikkeling, automatisering en lokale tests waarbij Ogma als server draait.

Servermodus

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

Veelgebruikte opties

Optie	Standaard	Doel
--listen	127.0.0.1:8080	Adres van de proxylistener.
--api-port	127.0.0.1:8181	Adres van de REST-API en frontendserver.
--data-dir	./ogma-data	Projectdatabase, certificaten, plugins, exports en lokale toestand.
--max-plugin-size	52428800	Maximale grootte van een pluginpakket in bytes.
--intercept-queue-cap	1000	Maximaal aantal interceptie-items in de wachtrij voordat nieuw verkeer wordt doorgestuurd.
--ui-dir	niet ingesteld	Map met gebouwde frontendbestanden die de API-server aanbiedt.

OAST-opties

Optie	Standaard	Doel
--oast-http-port	8888	HTTP-callbacklistener. Gebruik 0 om deze uit te schakelen.
--oast-https-port	8443	HTTPS-callbacklistener. Gebruik 0 om deze uit te schakelen.
--oast-dns-port	5353	DNS-callbacklistener. Gebruik 0 om deze uit te schakelen.
--oast-smtp-port	2525	SMTP-callbacklistener. Gebruik 0 om deze uit te schakelen.
--oast-domain	oast.local	Domein voor gegenereerde callbackhostnamen.
--oast-public-ip	niet ingesteld	Publiek IP-adres dat wordt geretourneerd in OAST DNS-antwoorden met A-records.

Pentestmodus zonder grafische interface

De subopdracht pentest voert inhoudsontdekking, passieve analyse en optioneel actieve scans uit en produceert een Markdown-rapport.

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

Pentestopties

Optie	Standaard	Doel
--depth	3	Diepte voor inhoudsontdekking. 0 betekent onbeperkt.
--concurrency	10	Maximaal aantal gelijktijdige verzoeken.
--no-active	uitgeschakeld	Schakel actieve scans uit; voer alleen inhoudsontdekking en passieve analyse uit.
--min-severity	medium	Minimale ernst waarbij afsluitcode 1 wordt geretourneerd. Geldige waarden: info, low, medium, high, critical.
--output	stdout	Schrijf het rapport naar een bestand in plaats van stdout.

Afsluitcodes:

Code	Betekenis
0	Voltooid en geen enkele bevinding bereikte de ernstdrempel.
1	Voltooid en ten minste één bevinding bereikte de ernstdrempel.
2	Runtime- of configuratiefout.

MCP-modus

MCP kan worden gestart vanuit de Ogma-instellingen of via het zelfstandige uitvoerbare bestand ogma-mcp. Verborgen backendopties ondersteunen ook een ingesloten MCP-modus wanneer Ogma een intern MCP-proces start.

Gebruik MCP instellen voor de gebruikelijke configuratie.

Opties voor het zelfstandige ogma-mcp

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

Optie	Omgevingsvariabele	Standaard	Doel
--api-url	OGMA_API_URL	http://127.0.0.1:8181	API-URL van de actieve Ogma-backend.
--body-preview-bytes	niet ingesteld	512	Maximaal aantal bytes van de bodyvoorvertoning dat leestools retourneren.
--allow-write-findings	OGMA_MCP_ALLOW_WRITE_FINDINGS	uitgeschakeld	Schakel het aanmaken en bijwerken van bevindingen, tags en koppelingen naar bewijsmateriaal in.
--allow-export-data	OGMA_MCP_ALLOW_EXPORT_DATA	uitgeschakeld	Schakel het aanmaken van exporttaken in.
--allow-read-secrets	OGMA_MCP_ALLOW_READ_SECRETS	uitgeschakeld	Retourneer ongemaskeerde waarden van omgevingsvariabelen.
--allow-send-requests	OGMA_MCP_ALLOW_SEND_REQUESTS	uitgeschakeld	Schakel tools in die verkeer versturen, de browser bedienen, crawlen, probes uitvoeren, authenticatie testen of verbinding maken met WebSockets.
--allow-run-workflows	OGMA_MCP_ALLOW_RUN_WORKFLOWS	uitgeschakeld	Schakel tools in voor het voorvertonen, uitvoeren en annuleren van workflows.
--allow-intercept-control	OGMA_MCP_ALLOW_INTERCEPT_CONTROL	uitgeschakeld	Schakel het besturen van de interceptiewachtrij en het doorsturen, verwerpen en wijzigen van verkeer in.
--tool-profile	OGMA_MCP_TOOL_PROFILE	full	Optie voor compatibiliteit met oudere versies. Alle tools worden altijd bekendgemaakt, ook wanneer een oudere opdracht core of discovery meegeeft. --mcp-tool-profile is een alias.

MCP schrijft protocolberichten naar stdout; daarom gaat runtimelogging naar stderr.

Booleaanse omgevingsvariabelen voor machtigingen accepteren true om de mogelijkheid in te schakelen. De server heeft geen activiteitsquota per minuut of per sessie; de afzonderlijke toollimieten blijven gelden. Verwijderde quotaopties worden niet geaccepteerd. Stdio-opties configureren dat proces onafhankelijk van de ingesloten MCP-instellingen.

Ontwikkelbuilds

Lokale buildscripts staan in de hoofdmap van de repository:

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

Gebruik de desktopbuild om de verpakte Electron-ervaring te testen. Gebruik de backend-/frontendbuild om het gedrag van de API en webinterface te testen.