Skip to content

Commit 3d4f91a

Browse files
authored
update obsolete message and diagnosticId
1 parent f3a8519 commit 3d4f91a

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

src/DefaultBuilder/src/ForwardedHeadersOptionsSetup.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ public void Configure(ForwardedHeadersOptions options)
2727
options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto;
2828
// Only loopback proxies are allowed by default. Clear that restriction because forwarders are
2929
// being enabled by explicit configuration.
30-
#pragma warning disable CS0618 // Type or member is obsolete
30+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
3131
options.KnownNetworks.Clear();
32-
#pragma warning restore CS0618 // Type or member is obsolete
32+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
3333
options.KnownIPNetworks.Clear();
3434
options.KnownProxies.Clear();
3535
}

src/Middleware/HttpOverrides/src/ForwardedHeadersMiddleware.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,11 @@ public void ApplyForwarders(HttpContext context)
213213
// Host and Scheme initial values are never inspected, no need to set them here.
214214
};
215215

216-
#pragma warning disable CS0618 // Type or member is obsolete
217-
var checkKnownIps = _options.KnownIPNetworks.Count > 0 || _options.KnownNetworks.Count > 0 || _options.KnownProxies.Count > 0;
218-
#pragma warning restore CS0618 // Type or member is obsolete
216+
var checkKnownIps = _options.KnownIPNetworks.Count > 0
217+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
218+
|| _options.KnownNetworks.Count > 0
219+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
220+
|| _options.KnownProxies.Count > 0;
219221
bool applyChanges = false;
220222
int entriesConsumed = 0;
221223

@@ -408,15 +410,15 @@ private bool CheckKnownAddress(IPAddress address)
408410
return true;
409411
}
410412
}
411-
#pragma warning disable CS0618 // Type or member is obsolete
413+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
412414
foreach (var network in _options.KnownNetworks)
413415
{
414416
if (network.Contains(address))
415417
{
416418
return true;
417419
}
418420
}
419-
#pragma warning restore CS0618 // Type or member is obsolete
421+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
420422
return false;
421423
}
422424

src/Middleware/HttpOverrides/src/ForwardedHeadersOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public class ForwardedHeadersOptions
8686
/// Address ranges of known proxies to accept forwarded headers from.
8787
/// Obsolete, please use <see cref="KnownIPNetworks"/> instead
8888
/// </summary>
89-
[Obsolete("Please use KnownIPNetworks instead")]
89+
[Obsolete("Please use KnownIPNetworks instead. For more information, visit https://aka.ms/aspnet/deprecate/005.", DiagnosticId = "ASPDEPR005")]
9090
public IList<AspNetIPNetwork> KnownNetworks { get; } = new List<AspNetIPNetwork>() { new(IPAddress.Loopback, 8) };
9191

9292
/// <summary>

src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ public async Task XForwardedForForwardLimit(int limit, string header, string exp
120120
ForwardLimit = limit,
121121
};
122122
options.KnownProxies.Clear();
123-
#pragma warning disable CS0618 // Type or member is obsolete
123+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
124124
options.KnownNetworks.Clear();
125-
#pragma warning restore CS0618 // Type or member is obsolete
125+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
126126
options.KnownIPNetworks.Clear();
127127
app.UseForwardedHeaders(options);
128128
});
@@ -864,9 +864,9 @@ public async Task XForwardedProtoOverrideLimitedByLoopback(string protoHeader, s
864864
};
865865
if (!loopback)
866866
{
867-
#pragma warning disable CS0618 // Type or member is obsolete
867+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
868868
options.KnownNetworks.Clear();
869-
#pragma warning restore CS0618 // Type or member is obsolete
869+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
870870
options.KnownIPNetworks.Clear();
871871
options.KnownProxies.Clear();
872872
}
@@ -1140,9 +1140,9 @@ public async Task ForwardersWithDIOptionsRunsOnce(int limit, string header, stri
11401140
{
11411141
options.ForwardedHeaders = ForwardedHeaders.XForwardedProto;
11421142
options.KnownProxies.Clear();
1143-
#pragma warning disable CS0618 // Type or member is obsolete
1143+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
11441144
options.KnownNetworks.Clear();
1145-
#pragma warning restore CS0618 // Type or member is obsolete
1145+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
11461146
options.KnownIPNetworks.Clear();
11471147
options.ForwardLimit = limit;
11481148
});
@@ -1185,9 +1185,9 @@ public async Task ForwardersWithDirectOptionsRunsTwice(int limit, string header,
11851185
ForwardLimit = limit,
11861186
};
11871187
options.KnownProxies.Clear();
1188-
#pragma warning disable CS0618 // Type or member is obsolete
1188+
#pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
11891189
options.KnownNetworks.Clear();
1190-
#pragma warning restore CS0618 // Type or member is obsolete
1190+
#pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
11911191
options.KnownIPNetworks.Clear();
11921192
app.UseForwardedHeaders(options);
11931193
app.UseForwardedHeaders(options);

0 commit comments

Comments
 (0)