| | | 1 | | namespace ProjectTemplate.Web.Options; |
| | | 2 | | |
| | | 3 | | /// <summary> |
| | | 4 | | /// Configuration settings for forwarded headers support. |
| | | 5 | | /// </summary> |
| | | 6 | | public sealed class ApplicationForwardedHeadersOptions |
| | | 7 | | { |
| | | 8 | | /// <summary> |
| | | 9 | | /// Configuration section name for forwarded headers settings. |
| | | 10 | | /// </summary> |
| | | 11 | | public const string SectionName = "ProjectTemplate:ForwardedHeaders"; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Enables or disables forwarded headers middleware. |
| | | 15 | | /// </summary> |
| | 1344 | 16 | | public bool Enabled { get; set; } = true; |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Gets or sets a value indicating whether startup must fail outside Development when forwarded |
| | | 20 | | /// client IP processing and rate limiting are enabled without an explicitly configured trusted proxy or network. |
| | | 21 | | /// </summary> |
| | 1030 | 22 | | public bool RequireExplicitProxyTrust { get; set; } |
| | | 23 | | |
| | | 24 | | /// <summary> |
| | | 25 | | /// Forwarded header values to process. |
| | | 26 | | /// Valid values include XForwardedFor, XForwardedProto, XForwardedHost, and XForwardedPrefix. |
| | | 27 | | /// </summary> |
| | 1790 | 28 | | public string[] Headers { get; set; } = |
| | 456 | 29 | | [ |
| | 456 | 30 | | "XForwardedFor", |
| | 456 | 31 | | "XForwardedProto" |
| | 456 | 32 | | ]; |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// Limits the number of forwarded header entries processed. |
| | | 36 | | /// Keep this low unless the proxy chain is well understood. |
| | | 37 | | /// </summary> |
| | 1354 | 38 | | public int? ForwardLimit { get; set; } = 1; |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Requires the number of values to match across forwarded headers. |
| | | 42 | | /// </summary> |
| | 596 | 43 | | public bool RequireHeaderSymmetry { get; set; } |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// Clears default known proxies/networks before applying configured values. |
| | | 47 | | /// For production, set this to true and explicitly configure trusted proxies/networks. |
| | | 48 | | /// </summary> |
| | 596 | 49 | | public bool ClearKnownNetworksAndProxies { get; set; } |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// Exact proxy IP addresses trusted to send forwarded headers. |
| | | 53 | | /// </summary> |
| | 1942 | 54 | | public string[] KnownProxies { get; set; } = []; |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Trusted proxy networks in CIDR notation. |
| | | 58 | | /// Example: 10.0.0.0/24 |
| | | 59 | | /// </summary> |
| | 1932 | 60 | | public string[] KnownNetworks { get; set; } = []; |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Allowed host values from X-Forwarded-Host. |
| | | 64 | | /// Only needed when XForwardedHost is enabled. |
| | | 65 | | /// </summary> |
| | 1506 | 66 | | public string[] AllowedHosts { get; set; } = []; |
| | | 67 | | } |