ktor-server-forwarded-header/io.ktor.server.plugins.forwardedheaders/ForwardedHeadersConfig

ForwardedHeadersConfig

class ForwardedHeadersConfig

A configuration for the ForwardedHeaders plugin.

Constructors

fun ForwardedHeadersConfig()

Functions

extractValue

fun extractValue(block: (<ERROR CLASS>, List<ForwardedHeaderValue>) -> Unit)

Custom logic to extract the value from the Forward headers when multiple values are present. You need to modify MutableOriginConnectionPoint based on headers from ForwardedHeaderValue.

skipKnownProxies

fun skipKnownProxies(hosts: List<String>)

Removes known hosts from the end of the list and takes the last value from Forward headers when multiple values are present.

skipLastProxies

fun skipLastProxies(proxiesCount: Int)

Takes proxiesCount before the last value from Forward header when multiple values are present.

useFirstValue

fun useFirstValue()

Takes the first value from the Forward header when multiple values are present.

useLastValue

fun useLastValue()

Takes the last value from Forward header when multiple values are present.