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

XForwardedHeadersConfig

class XForwardedHeadersConfig

A configuration for the XForwardedHeaders plugin.

Constructors

fun XForwardedHeadersConfig()

Functions

extractEdgeProxy

fun extractEdgeProxy(block: (<ERROR CLASS>, XForwardedHeaderValues) -> Unit)

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

skipKnownProxies

fun skipKnownProxies(hosts: List<String>)

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

skipLastProxies

fun skipLastProxies(proxiesCount: Int)

Takes the proxiesCount-before-last value from the X-Forward-* headers when multiple values are present.

useFirstProxy

fun useFirstProxy()

Takes the first value from the X-Forward-* headers when multiple values are present.

useLastProxy

fun useLastProxy()

Takes the last value from the X-Forward-* headers when multiple values are present.

Properties

forHeaders

val forHeaders: MutableList<String>

Gets headers used to identify the originating IP address of a client connecting to a server through a proxy or a load balancer.

hostHeaders

val hostHeaders: ArrayList<String>

Gets headers used to identify the original host requested by the client. Default are X-Forwarded-Server and X-Forwarded-Host.

httpsFlagHeaders

val httpsFlagHeaders: MutableList<String>

Gets headers used to identify whether HTTPS/TLS is used between the client and the front-end server. Default are X-Forwarded-SSL and Front-End-Https.

portHeaders

val portHeaders: MutableList<String>

Gets headers used to identify the destination port. The default is X-Forwarded-Port.

protoHeaders

val protoHeaders: MutableList<String>

Gets headers used to identify the protocol (HTTP or HTTPS) that a client used to connect to a proxy or load balancer. Default are X-Forwarded-Proto and X-Forwarded-Protocol.