diff --git a/plugins/inject_header.lua b/plugins/inject_header.lua index 3eef4eb..829997e 100644 --- a/plugins/inject_header.lua +++ b/plugins/inject_header.lua @@ -3,7 +3,7 @@ Plugin = { description = [[ Inject custom headers into every intercepted request. -**Config** (YAML): +**Config**: ```yaml headers: - "X-My-Header: myvalue" diff --git a/plugins/ip_filter.lua b/plugins/ip_filter.lua index 8f07d41..8cc3a5c 100644 --- a/plugins/ip_filter.lua +++ b/plugins/ip_filter.lua @@ -3,12 +3,13 @@ Plugin = { description = [[ Checks that the proxy's outbound IP is in an allowed list on startup. -**Config** (YAML): +**Config**: ```yaml ips: - "1.2.3.4" # whitelist entry - "!5.6.7.8" # blacklist entry (blocked) ``` + - If no IPs are configured, the check is skipped. ]], on_start = { sync = false }, diff --git a/plugins/match_replace.lua b/plugins/match_replace.lua index a0dc9d7..f4e49de 100644 --- a/plugins/match_replace.lua +++ b/plugins/match_replace.lua @@ -3,7 +3,7 @@ Plugin = { description = [[ Automatically find and replace content in requests and responses. -**Config** (YAML): +**Config**: ```yaml rules: - on: "request" # "request", "response", or "both" (default: "both") diff --git a/plugins/scopes.lua b/plugins/scopes.lua index 5f985be..0eacff8 100644 --- a/plugins/scopes.lua +++ b/plugins/scopes.lua @@ -3,7 +3,7 @@ Plugin = { description = [[ Auto-forward requests and exclude them from history based on patterns. -**Config** (YAML): +**Config**: ```yaml patterns: - "pattern" # whitelist: only intercept matching requests/responses and history diff --git a/plugins/secretscan.lua b/plugins/secretscan.lua index db5509f..d40f4e9 100644 --- a/plugins/secretscan.lua +++ b/plugins/secretscan.lua @@ -185,9 +185,11 @@ local function scan(label, ct, body, host, path) title = "Potential secret in " .. label .. " (" .. host .. ")", description = "**Host:** `" .. host - .. "` \n**Path:** `" + .. "`\n" + .. "\n**Path:** `" .. path - .. "`\n\n**Match:** `" + .. "`\n" + .. "\n**Match:** `" .. display .. "`\n\n" .. ctx, diff --git a/plugins/trufflehog.lua b/plugins/trufflehog.lua index ee25cab..078551a 100644 --- a/plugins/trufflehog.lua +++ b/plugins/trufflehog.lua @@ -4,9 +4,6 @@ Plugin = { Scans request and response bodies for secrets using [TruffleHog](https://github.com/trufflesecurity/trufflehog). Requires `trufflehog` v3+ to be installed and available in PATH. - -Each finding is stored on the **Findings** page with the matched detector output. -Findings are deduplicated per host+path+body content so repeated requests do not create duplicates. ]], on_start = { sync = false }, on_request = { sync = false }, @@ -56,7 +53,7 @@ local function scan(label, content, host, path) for _, block in ipairs(blocks) do create_finding({ title = "Secret detected in " .. label .. " (" .. host .. ")", - description = "**Host:** `" .. host .. "` \n**Path:** `" .. path .. "`\n\n```\n" .. block .. "\n```", + description = "**Host:** `" .. host .. "`\n\n**Path:** `" .. path .. "`\n\n```\n" .. block .. "\n```", key = host .. "|" .. path .. "|" .. label .. "|" .. block, severity = "high", })