Add error code and docs for invalid address error (#2032)

Co-authored-by: Nick Banks <[email protected]>

Author: thhous-msft

docs/api/QUIC_STATUS.md

@@ -43,6 +43,7 @@ Value | Meaning
 **QUIC_STATUS_HANDSHAKE_FAILURE** | The connection handshake failed.
 **QUIC_STATUS_ABORTED** | The connection or stream was aborted.
 **QUIC_STATUS_ADDRESS_IN_USE** | The local address is already in use.
+**QUIC_STATUS_INVALID_ADDRESS** | Binding to socket failed, likely caused by a family mismatch between local and remote address.
 **QUIC_STATUS_CONNECTION_TIMEOUT** | The connection timed out waiting for a response from the peer.
 **QUIC_STATUS_CONNECTION_IDLE** | The connection timed out from inactivity.
 **QUIC_STATUS_INTERNAL_ERROR** | An internal error was encountered.

src/inc/msquic_posix.h

@@ -113,6 +113,7 @@ inline ENUMTYPE &operator ^= (ENUMTYPE &a, ENUMTYPE b) throw() { return (ENUMTYP
 #define QUIC_STATUS_HANDSHAKE_FAILURE       ((QUIC_STATUS)ECONNABORTED)     // 103  (53 on macOS)
 #define QUIC_STATUS_ABORTED                 ((QUIC_STATUS)ECANCELED)        // 125  (89 on macOS)
 #define QUIC_STATUS_ADDRESS_IN_USE          ((QUIC_STATUS)EADDRINUSE)       // 98   (48 on macOS)
+#define QUIC_STATUS_INVALID_ADDRESS         ((QUIC_STATUS)EAFNOSUPPORT)     // 97   (47 on macOS)
 #define QUIC_STATUS_CONNECTION_TIMEOUT      ((QUIC_STATUS)ETIMEDOUT)        // 110  (60 on macOS)
 #define QUIC_STATUS_CONNECTION_IDLE         ((QUIC_STATUS)ETIME)            // 62   (101 on macOS)
 #define QUIC_STATUS_INTERNAL_ERROR          ((QUIC_STATUS)EIO)              // 5

src/inc/msquic_winkernel.h

@@ -97,6 +97,7 @@ typedef UINT64 uint64_t;
 #define QUIC_STATUS_HANDSHAKE_FAILURE       STATUS_QUIC_HANDSHAKE_FAILURE       // 0xc0240000
 #define QUIC_STATUS_ABORTED                 STATUS_CANCELLED                    // 0xc0000120
 #define QUIC_STATUS_ADDRESS_IN_USE          STATUS_ADDRESS_ALREADY_EXISTS       // 0xc000020a
+#define QUIC_STATUS_INVALID_ADDRESS         STATUS_INVALID_ADDRESS_COMPONENT    // 0xc0000207
 #define QUIC_STATUS_CONNECTION_TIMEOUT      STATUS_QUIC_CONNECTION_TIMEOUT      // 0xc0240006
 #define QUIC_STATUS_CONNECTION_IDLE         STATUS_QUIC_CONNECTION_IDLE         // 0xc0240005
 #define QUIC_STATUS_UNREACHABLE             STATUS_HOST_UNREACHABLE             // 0xc000023d

src/inc/msquic_winuser.h

@@ -96,6 +96,7 @@
 #define QUIC_STATUS_HANDSHAKE_FAILURE       ERROR_QUIC_HANDSHAKE_FAILURE                    // 0x80410000
 #define QUIC_STATUS_ABORTED                 E_ABORT                                         // 0x80004004
 #define QUIC_STATUS_ADDRESS_IN_USE          HRESULT_FROM_WIN32(WSAEADDRINUSE)               // 0x80072740
+#define QUIC_STATUS_INVALID_ADDRESS         HRESULT_FROM_WIN32(WSAEADDRNOTAVAIL)            // 0x80072741
 #define QUIC_STATUS_CONNECTION_TIMEOUT      ERROR_QUIC_CONNECTION_TIMEOUT                   // 0x80410006
 #define QUIC_STATUS_CONNECTION_IDLE         ERROR_QUIC_CONNECTION_IDLE                      // 0x80410005
 #define QUIC_STATUS_UNREACHABLE             HRESULT_FROM_WIN32(ERROR_HOST_UNREACHABLE)      // 0x800704d0

src/test/MsQuicTests.h

@@ -205,6 +205,10 @@ QuicTestConnectUnreachable(
     _In_ int Family
     );
 
+void
+QuicTestConnectInvalidAddress(
+    );
+
 void
 QuicTestConnectBadAlpn(
     _In_ int Family
@@ -926,4 +930,7 @@ typedef struct {
     QUIC_CTL_CODE(76, METHOD_BUFFERED, FILE_WRITE_DATA)
     // int - Family
 
-#define QUIC_MAX_IOCTL_FUNC_CODE 76
+#define IOCTL_QUIC_RUN_CONNECT_INVALID_ADDRESS \
+    QUIC_CTL_CODE(77, METHOD_BUFFERED, FILE_WRITE_DATA)
+
+#define QUIC_MAX_IOCTL_FUNC_CODE 77

src/test/bin/quic_gtest.cpp

@@ -957,6 +957,15 @@ TEST_P(WithFamilyArgs, Unreachable) {
     }
 }
 
+TEST(HandshakeTest, InvalidAddress) {
+    TestLogger Logger("QuicTestConnectInvalidAddress");
+    if (TestingKernelMode) {
+        ASSERT_TRUE(DriverClient.Run(IOCTL_QUIC_RUN_CONNECT_INVALID_ADDRESS));
+    } else {
+        QuicTestConnectInvalidAddress();
+    }
+}
+
 TEST_P(WithFamilyArgs, BadALPN) {
     TestLoggerT<ParamType> Logger("QuicTestConnectBadAlpn", GetParam());
     if (TestingKernelMode) {

src/test/bin/winkernel/control.cpp

@@ -447,6 +447,7 @@ size_t QUIC_IOCTL_BUFFER_SIZES[] =
     0,
     sizeof(UINT8),
     sizeof(INT32),
+    0,
 };
 
 CXPLAT_STATIC_ASSERT(
@@ -1110,6 +1111,10 @@ QuicTestCtlEvtIoDeviceControl(
         QuicTestCtlRun(QuicTestInterfaceBinding(Params->Family));
         break;
 
+    case IOCTL_QUIC_RUN_CONNECT_INVALID_ADDRESS:
+        QuicTestCtlRun(QuicTestConnectInvalidAddress());
+        break;
+
     default:
         Status = STATUS_NOT_IMPLEMENTED;
         break;

src/test/lib/HandshakeTest.cpp

@@ -807,6 +807,51 @@ QuicTestConnectUnreachable(
     }
 }
 
+void
+QuicTestConnectInvalidAddress(
+    )
+{
+    MsQuicRegistration Registration;
+    TEST_TRUE(Registration.IsValid());
+
+    MsQuicAlpn Alpn("MsQuicTest");
+
+    MsQuicSettings Settings;
+    Settings.SetIdleTimeoutMs(3000);
+
+    MsQuicCredentialConfig ClientCredConfig;
+    MsQuicConfiguration ClientConfiguration(Registration, Alpn, Settings, ClientCredConfig);
+    TEST_TRUE(ClientConfiguration.IsValid());
+
+    {
+        TestConnection Client(Registration);
+        TEST_TRUE(Client.IsValid());
+
+        QuicAddr LocalAddr{QUIC_ADDRESS_FAMILY_INET, true};
+        LocalAddr.SetPort(TestUdpPortBase - 2);
+
+        QuicAddr RemoteAddr{QUIC_ADDRESS_FAMILY_INET6, true};
+        RemoteAddr.SetPort(TestUdpPortBase - 1);
+
+        TEST_QUIC_SUCCEEDED(Client.SetLocalAddr(LocalAddr));
+        TEST_QUIC_SUCCEEDED(Client.SetRemoteAddr(RemoteAddr));
+
+        Client.SetExpectedTransportCloseStatus(QUIC_STATUS_INVALID_ADDRESS);
+        TEST_QUIC_SUCCEEDED(
+            Client.Start(
+                ClientConfiguration,
+                QUIC_ADDRESS_FAMILY_INET6,
+                QUIC_LOCALHOST_FOR_AF(QUIC_ADDRESS_FAMILY_INET6),
+                TestUdpPortBase - 1));
+        if (!Client.WaitForConnectionComplete()) {
+            return;
+        }
+
+        TEST_FALSE(Client.GetIsConnected());
+        TEST_TRUE(Client.GetTransportClosed());
+    }
+}
+
 void
 QuicTestVersionNegotiation(
     _In_ int Family