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

Package-level declarations

Types

Link copied to clipboard
class ForwardedHeadersConfig

A configuration for the ForwardedHeaders plugin.

Link copied to clipboard
data class ForwardedHeaderValue(val host: String?, val by: String?, val forParam: String?, val proto: String?, val others: Map<String, String>)

Parsed a forwarded header value. All fields are optional as proxy could provide different fields.

Link copied to clipboard
class XForwardedHeadersConfig

A configuration for the XForwardedHeaders plugin.

Link copied to clipboard
data class XForwardedHeaderValues(val protoHeader: String?, val forHeader: String?, val hostHeader: String?, val httpsFlagHeader: String?, val portHeader: String?)

Values of the X-Forward-* headers. Each property may contain multiple comma-separated values.

Properties

Link copied to clipboard
val FORWARDED_PARSED_KEY: AttributeKey<List<ForwardedHeaderValue>>

A key for the application call attribute that is used to cache parsed header values.

Link copied to clipboard
val ForwardedHeaders: ApplicationPlugin<ForwardedHeadersConfig>

A plugin that allows you to handle reverse proxy headers to get information about the original request when a Ktor server is placed behind a reverse proxy.

Link copied to clipboard
val XForwardedHeaders: ApplicationPlugin<XForwardedHeadersConfig>

A plugin that allows you to handle reverse proxy headers to get information about the original request when a Ktor server is placed behind a reverse proxy.