ForwardedHeadersOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.HttpOverrides.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Options for ForwardedHeadersMiddleware

public ref class ForwardedHeadersOptions

public class ForwardedHeadersOptions

type ForwardedHeadersOptions = class

Public Class ForwardedHeadersOptions

Inheritance

Object

ForwardedHeadersOptions

Constructors

ForwardedHeadersOptions()

Properties

AllowedHosts	The allowed values from x-forwarded-host. If the list is empty then all hosts are allowed. Failing to restrict this these values may allow an attacker to spoof links generated by your service.
ForwardedForHeaderName	Gets or sets the header used to retrieve the originating client IP. Defaults to the value specified by XForwardedForHeaderName.
ForwardedHeaders	Identifies which forwarders should be processed.
ForwardedHostHeaderName	Gets or sets the header used to retrieve the original value of the Host header field. Defaults to the value specified by XForwardedHostHeaderName
ForwardedPrefixHeaderName	Gets or sets the header used to retrieve the value for the path base. Defaults to the value specified by XForwardedPrefixHeaderName
ForwardedProtoHeaderName	Gets or sets the header used to retrieve the value for the originating scheme (HTTP/HTTPS). Defaults to the value specified by XForwardedProtoHeaderName
ForwardLimit	Limits the number of entries in the headers that will be processed. The default value is 1. Set to null to disable the limit, but this should only be done if KnownProxies or KnownNetworks are configured.
KnownNetworks	Address ranges of known proxies to accept forwarded headers from.
KnownProxies	Addresses of known proxies to accept forwarded headers from.
OriginalForHeaderName	Gets or sets the header used to store the original value of client IP before applying forwarded headers. Defaults to the value specified by XOriginalForHeaderName
OriginalHostHeaderName	Gets or sets the header used to store the original value of the Host header field before applying forwarded headers. Defaults to the value specified by XOriginalHostHeaderName
OriginalPrefixHeaderName	Gets or sets the header used to store the original path base before applying forwarded headers. Defaults to the value specified by XOriginalPrefixHeaderName
OriginalProtoHeaderName	Gets or sets the header used to store the original scheme (HTTP/HTTPS) before applying forwarded headers. Defaults to the value specified by XOriginalProtoHeaderName
RequireHeaderSymmetry	Require the number of header values to be in sync between the different headers being processed. The default is 'false'.