verivent-ktor/io.github.asanre.verivent.ktor/VeriventConfig

VeriventConfig

DSL for install(Verivent) { ... }. Everything is a lambda so the host filters and redacts with plain predicates. All lists are additive across multiple calls.

Constructors

VeriventConfig

constructor()

Properties

maxContentLength

var maxContentLength: Long

Bodies larger than this (in bytes/chars) are captured truncated with a "truncated" flag.

Functions

filter

fun filter(predicate: (HttpRequestBuilder) -> Boolean)

Keep only requests for which every filter returns true; a false skips capture entirely.

sanitizeBody

fun sanitizeBody(transform: (String) -> String)

Rewrite captured body previews (request and response) before they are stored — e.g. blank out a JSON field. Transforms apply in registration order, after truncation; only the stored preview is affected, never the real traffic.

sanitizeHeader

fun sanitizeHeader(predicate: (String) -> Boolean)

Redact matching headers with a visible placeholder. Matches on the header name. Authorization, Cookie and Set-Cookie are always redacted on top of these.

sanitizePath

fun sanitizePath(transform: (String) -> String)

Rewrite the captured path, percent-encoded as sent, to hide a secret in it: a reset token, an API key in /v1/keys/<key>. Off by default, since most ids in a path (/orders/123) are what you want to see. Applies to the path and to the captured URL, in registration order; a transform that throws hides the whole path.

sanitizeQueryParameter

fun sanitizeQueryParameter(predicate: (String) -> Boolean)

Redact matching query parameter values in the captured URL. Matches on the parameter name. Common secret-bearing parameters (api_key, token, ...) are always redacted on top of these.