Share via

KestrelServerOptions.AllowAlternateSchemes Property

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Server.Kestrel.Core
Assembly:
Microsoft.AspNetCore.Server.Kestrel.Core.dll
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
KestrelServerOptions.cs

Gets or sets a value that controls how the :scheme field for HTTP/2 and HTTP/3 requests is validated.

If false then the `:scheme` field for HTTP/2 and HTTP/3 requests must exactly match the transport (e.g. https for TLS connections, http for non-TLS). If true then the `:scheme` field for HTTP/2 and HTTP/3 requests can be set to alternate values and this will be reflected by `HttpRequest.Scheme`. The Scheme must still be valid according to https://datatracker.ietf.org/doc/html/rfc3986/#section-3.1. Only enable this when working with a trusted proxy. This can be used in scenarios such as proxies converting from alternate protocols. See https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.3. Applications that enable this should validate an expected scheme is provided before using it. 

public bool AllowAlternateSchemes { get; set; }
member this.AllowAlternateSchemes : bool with get, set
Public Property AllowAlternateSchemes As Boolean

Property Value

Boolean

Remarks

Defaults to false.

Applies to