Implement DnsResolver for Windows#129845
Open
rzikm wants to merge 19 commits into
Open
Conversation
Implements the API approved in dotnet#19443: * New Dns.Resolve*[Async] static methods for A/AAAA/SRV/MX/TXT/CNAME/PTR/NS records. * New DnsResolver / DnsResolverOptions for instance-based resolution with optional custom DNS servers. * Record types AddressRecord, SrvRecord, MxRecord, TxtRecord, CNameRecord, PtrRecord, NsRecord. * DnsResponseCode enum and DnsResult<T> envelope carrying ResponseCode, Records, and NegativeCacheTtl. Windows implementation uses DnsQueryEx (DNS_QUERY_REQUEST v1 by default; DNS_QUERY_REQUEST3 when the caller supplies non-default ports on Windows 11 build 22000+, throwing PlatformNotSupportedException otherwise). Non-Windows platforms get PlatformNotSupportedException stubs pending follow-up implementations. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds argument-validation tests and Windows-only OuterLoop network tests for the new DnsResolver / Dns.Resolve* APIs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… port 53 DnsQueryEx only contacts custom DNS servers on the standard port 53 and requires the sockaddr port field to be 0; any non-zero port (even 53) is rejected with ERROR_INVALID_PARAMETER. Simplify the Windows resolver to always use the v1 DNS_QUERY_REQUEST path, write sockaddr port 0, and throw PlatformNotSupportedException for server endpoints requesting a non-default port. Remove the now-unused v3 custom-server code path. Add an in-process loopback DNS server (bound to 127.0.0.1:53, skipped when the port is unavailable) and a comprehensive behavioral test suite covering address/SRV/MX/TXT/CNAME/PTR/NS resolution, NXDOMAIN vs NODATA, TTLs, SRV additional-address glue, port-0 acceptance, and in-flight cancellation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The synchronous Resolve* methods previously blocked on the async path via GetAwaiter().GetResult(). DnsQueryEx executes synchronously when no completion callback is supplied, so call it directly instead of going through the async state machine. Record-list parsing is factored into shared helpers reused by both the sync and async paths, and the loopback behavioral tests are parameterized over both APIs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Move all platform-specific logic from DnsResolver.Windows.cs and DnsResolver.WindowsAsync.cs into a new DnsResolverPal.Windows.cs static PAL class, mirroring the existing NameResolutionPal pattern. The cross-platform Resolve*Core methods remain on DnsResolver and delegate to the PAL, providing a seam for future instrumentation and telemetry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Instrument the Resolve*Core seam in DnsResolver with the existing NameResolutionTelemetry infrastructure (EventSource counters, the DnsLookup Activity span, and the dns.lookup.duration metric), matching the static Dns class. When no diagnostics consumer is enabled the PAL task is returned directly, keeping the common path allocation-free and preserving the synchronous-completion invariant the sync Resolve* methods depend on. Extend NameResolutionActivity.Stop to accept a string[] answer so the new record types can populate the dns.answers tag. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The Resolve*Core methods invoked the PAL eagerly and only then wrapped the resulting task with telemetry. On the synchronous path the Windows PAL executes the query while creating the task, so BeforeResolution ran after most of the work was done and the recorded duration excluded the query time. Defer the PAL invocation behind a Func so telemetry brackets the entire query for both sync and async paths. Adds a regression test asserting the recorded dns.lookup.duration covers a delayed server response on both sync and async paths. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Conform instance DnsResolver to approved API: remove ResolvePtr(IPAddress) overloads (static Dns keeps them, delegating via BuildArpaName). - Validate DnsResolverOptions.Servers setter is non-null; resolver takes a defensive snapshot of the configured servers. - Fix negative-cache TTL: always extract from authority SOA and surface it on the success path (covers NODATA), plus merge max TTL when combining A/AAAA. - PAL cleanups: typed GCHandle<T>, bool completion flag, span-based address parsing, mixed-address-family validation, checked size arithmetic, simplified using-based query helpers. - Allocation-free telemetry path via TState + static delegates. - Simplify reverse-arpa name building (plain interpolation / string.Concat). - Add XML docs across the new public surface; reword/extend SR strings. - Tests: assert NegativeCacheTtl for NODATA/NXDOMAIN; skip custom-server test when no system DNS server is configured; move IPAddress PTR tests to static API. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The approved API shape was corrected to include the IPAddress reverse-lookup overloads on the instance resolver, so restore ResolvePtr(IPAddress) and ResolvePtrAsync(IPAddress) on DnsResolver. The static Dns entry points now delegate to them. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace pointer-based record and sockaddr handling with safe Span<byte> and Marshal-based reads where possible: - TryParseAddress now reads DNS_A_DATA/DNS_AAAA_DATA via Marshal.PtrToStructure instead of byte* spans; DNS_AAAA_DATA uses an InlineArray field, removing the fixed buffer (and unsafe) from the interop struct. - BuildAddrArray populates the DNS_ADDR_ARRAY through a Span<byte> using BinaryPrimitives; WriteSockAddr takes Span<byte> instead of byte*. - Drop the unnecessary 'unsafe' modifier from PtrToString. Also fix a pre-existing compile break in MergeAddressResults (Math.Min has no TimeSpan overload). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Dns.DefaultResolver: use LazyInitializer.EnsureInitialized for thread-safe one-time initialization instead of non-atomic ??=. - DnsResolver ctor: reject null entries in the server snapshot with an ArgumentException pointing at the public Servers property. - BuildAddrArray: surface mixed-address-family ArgumentException with the public-facing 'Servers' parameter name instead of the internal 'servers'. - LoopbackDnsServer: use ConcurrentDictionary for _responses to avoid races between test-thread mutations and listener-thread reads. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Convert the Windows network tests and the DnsQueryEx synchronous-completion regression test to [ConditionalTheory] parameterized over bool async, using sync/async dispatch helpers mirroring DnsResolverLoopbackTest, so the synchronous Resolve* overloads are exercised alongside the async ones. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- WriteSockAddr now takes an IPAddress and always serializes a port-0 SOCKADDR, so custom-server endpoints with port 53 are normalized to 0 as DnsQueryEx requires (avoids serializing a non-default port). Taking IPAddress also avoids reading from the caller's mutable IPEndPoint. - Clarify the ValidateServerPorts comment: 0 and 53 are accepted and normalized to 0; any other port is rejected. - Fix the DNS_RECORD_HEADER comment: the Data union offset is 24 bytes on 32-bit and 32 bytes on 64-bit (two header pointers), so callers use Unsafe.SizeOf. - Loopback test fixture: start the server lazily on first access instead of in the IClassFixture constructor, and convert the tests to ConditionalFact/ ConditionalTheory so LoopbackDnsServer.Start()'s SkipTestException is honored (port 53 unavailable now skips rather than failing). Also stop assigning null to the server field. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
Tagging subscribers to this area: @karelz, @dotnet/ncl |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new DNS query API surface to System.Net.NameResolution and implements the Windows backend using DnsQueryEx, with functional tests (including a loopback DNS server) to validate parsing/behavior and some telemetry integration.
Changes:
- Introduces new public DNS query APIs:
Dns.Resolve*static methods,DnsResolver/DnsResolverOptions, record structs,DnsResult<T>, andDnsResponseCode. - Implements the Windows PAL (
DnsResolverPal.Windows) usingDnsQueryEx, including cancellation, TXT/SRV parsing, and negative-cache TTL extraction from SOA. - Adds functional tests for argument validation + real-network Windows coverage and deterministic loopback-driven Windows coverage.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/libraries/System.Net.NameResolution/tests/FunctionalTests/System.Net.NameResolution.Functional.Tests.csproj | Includes new functional test sources in the test project. |
| src/libraries/System.Net.NameResolution/tests/FunctionalTests/LoopbackDnsServer.cs | Adds an in-process loopback DNS server used by deterministic Windows tests. |
| src/libraries/System.Net.NameResolution/tests/FunctionalTests/DnsResponseBuilder.cs | Adds a small DNS response byte builder used by the loopback server/tests. |
| src/libraries/System.Net.NameResolution/tests/FunctionalTests/DnsResolverTest.cs | Adds functional tests covering validation + Windows network scenarios. |
| src/libraries/System.Net.NameResolution/tests/FunctionalTests/DnsResolverLoopbackTest.cs | Adds deterministic Windows tests using the loopback DNS server (port 53). |
| src/libraries/System.Net.NameResolution/src/System/Net/NameResolutionTelemetry.cs | Updates telemetry tagging to support string[] answers. |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResult.cs | Adds DnsResult<T> envelope type (ResponseCode/Records/NegativeCacheTtl). |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResponseCode.cs | Adds DnsResponseCode enum. |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResolverPal.Windows.cs | Implements Windows DNS querying/parsing via DnsQueryEx. |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResolverPal.Unsupported.cs | Adds non-Windows stub PAL (currently PNSE). |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResolverOptions.cs | Adds options type (custom server endpoints). |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsResolver.cs | Adds instance-based DNS query API with sync/async methods + telemetry. |
| src/libraries/System.Net.NameResolution/src/System/Net/DnsRecords.cs | Adds record structs (Address/Srv/Mx/Txt/CName/Ptr/Ns). |
| src/libraries/System.Net.NameResolution/src/System/Net/Dns.Resolve.cs | Adds new static Dns.Resolve* APIs backed by a shared resolver instance. |
| src/libraries/System.Net.NameResolution/src/System/Net/Dns.cs | Makes Dns partial to host the new Dns.Resolve* surface. |
| src/libraries/System.Net.NameResolution/src/System.Net.NameResolution.csproj | Wires new source files + Windows interop compile items. |
| src/libraries/System.Net.NameResolution/src/Resources/Strings.resx | Adds new resource strings for DNS resolver errors. |
| src/libraries/System.Net.NameResolution/ref/System.Net.NameResolution.cs | Adds the new public API surface to the ref assembly. |
| src/libraries/Common/src/Interop/Windows/Interop.Libraries.cs | Adds dnsapi.dll constant for P/Invoke. |
| src/libraries/Common/src/Interop/Windows/Dnsapi/Interop.DnsTypes.cs | Adds DnsQueryEx-related structs and DNS record type layouts. |
| src/libraries/Common/src/Interop/Windows/Dnsapi/Interop.DnsApi.cs | Adds DnsQueryEx/DnsCancelQuery/DnsFree P/Invokes + constants. |
- MergeAddressResults: pick the minimum non-zero negative-cache TTL when merging A/AAAA results instead of the first positive one. - Use a dedicated SR string (net_dns_unsupported_address_family) for unsupported AddressFamily values in AddressFamilyToQueryType and BuildArpaName instead of the unrelated net_invalid_ip_addr message. - LoopbackDnsServer: wrap the fire-and-forget UDP request handler in a try/catch for expected teardown exceptions to avoid unobserved task exceptions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Jun 25, 2026
teo-tsirpanis
left a comment
teo-tsirpanis
left a comment
Contributor
There was a problem hiding this comment.
There are some opportunities to use more modern interop.
| internal unsafe struct DNS_QUERY_REQUEST | ||
| { | ||
| public uint Version; | ||
| public IntPtr QueryName; // PCWSTR |
Contributor
There was a problem hiding this comment.
Suggested change
| public IntPtr QueryName; // PCWSTR | |
| public char* QueryName; |
And other PCWSTR fields.
| public ulong QueryOptions; | ||
| public DNS_ADDR_ARRAY* pDnsServerList; | ||
| public uint InterfaceIndex; | ||
| public IntPtr pQueryCompletionCallback; // PDNS_QUERY_COMPLETION_ROUTINE |
Contributor
There was a problem hiding this comment.
Suggested change
| public IntPtr pQueryCompletionCallback; // PDNS_QUERY_COMPLETION_ROUTINE | |
| public delegate* unmanaged<nint, nint, void> pQueryCompletionCallback; // PDNS_QUERY_COMPLETION_ROUTINE |
Comment on lines
+549
to
+552
| // Native callback. Marshaled to a function pointer once at startup. | ||
| // We use a managed delegate (no UnmanagedCallersOnly) because callers | ||
| // currently pass it via Marshal.GetFunctionPointerForDelegate. | ||
| private static void QueryCompletionCallback(IntPtr pQueryContext, IntPtr pQueryResults) |
Contributor
There was a problem hiding this comment.
Use UnmanagedCallersOnly?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replacement for #129302 (thanks,
gh stack submit😠)Implements the API approved in #19443:
New Dns.Resolve*[Async] static methods for A/AAAA/SRV/MX/TXT/CNAME/PTR/NS records.
New DnsResolver / DnsResolverOptions for instance-based resolution with optional custom DNS servers.
Record types AddressRecord, SrvRecord, MxRecord, TxtRecord, CNameRecord, PtrRecord, NsRecord.
DnsResponseCode enum and DnsResult envelope carrying ResponseCode, Records, and NegativeCacheTtl.
Windows implementation uses DnsQueryEx. Non-Windows platforms get PlatformNotSupportedException stubs pending follow-up implementations (splitting to multiple stacked PRs for easier review).