docs
docs copied to clipboard
dotnet
[Breaking change]: Uri query redaction in HttpClient EventSource events
Description
In .NET 9, the default behavior of EventSource events emitted by HttpClient / SocketsHttpHandler has been modified to scrub query strings (EventSource name: System.Net.Http). This change is aimed at enhancing privacy by preventing the logging of potentially sensitive information contained in query strings. For scenarios where consuming query strings is necessary and deemed safe, this behavior can be overridden by enabling the System.Net.Http.DisableUriRedaction AppContext switch or by setting the DOTNET_SYSTEM_NET_HTTP_DISABLEURIREDACTION environment variable.
Version
.NET 9 Preview 7
Previous behavior
Previously, events emitted by HttpClient / SocketsHttpHandler included query string information, which could inadvertently expose sensitive information.
New behavior
With the change in https://github.com/dotnet/runtime/pull/104741, query strings are replaced by a * character in HttpClient / SocketsHttpHandler events by default. This affects specific events and parameters such as pathAndQuery in RequestStart and redirectUri in Redirect. Developers can enable query string logging globally by setting the System.Net.Http.DisableUriRedaction AppContext switch or the DOTNET_SYSTEM_NET_HTTP_DISABLEURIREDACTION environment variable.
Type of breaking change
- [ ] Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
- [ ] Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
- [X] Behavioral change: Existing binaries might behave differently at run time.
Reason for change
The primary reason for this change is to enhance privacy by reducing the risk of sensitive information being logged inadvertently. Query strings often contain sensitive data and redacting them from logs by default helps protect this information.
Recommended action
If you need query string information when consuming HttpClient / SocketsHttpHandler events and you are confident that it is safe to do so, you can enable query string logging globally by setting the System.Net.Http.DisableUriRedaction AppContext switch or the DOTNET_SYSTEM_NET_HTTP_DISABLEURIREDACTION environment variable. Otherwise, no action is required, and the default behavior will help enhance the privacy aspects of your application.
If you are using IHttpClientFactory, note that these switches will also disable query string redaction in the default IHttpClientFactory logs.
Feature area
Networking
Affected APIs
System.Net.Http.SocketsHttpHandler.Send(...)(overridesHttpMessageHandler.Send(...))System.Net.Http.SocketsHttpHandler.SendAsync(...)(overridesHttpMessageHandler.SendAsync(...))
