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

Package io.ktor.server.plugins.forwardedheaders

Types

Link copied to clipboard
class ForwardedHeadersConfig
Content copied to clipboard

A configuration for the ForwardedHeaders plugin.

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

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

Link copied to clipboard
class XForwardedHeadersConfig
Content copied to clipboard

A configuration for the XForwardedHeaders plugin.

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

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

Properties

Link copied to clipboard
val FORWARDED_PARSED_KEY: <ERROR CLASS><List<ForwardedHeaderValue>>
Content copied to clipboard

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

Link copied to clipboard
val ForwardedHeaders: <ERROR CLASS><ForwardedHeadersConfig>
Content copied to clipboard

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: <ERROR CLASS><XForwardedHeadersConfig>
Content copied to clipboard

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.