Address Discovery and Server Initiated Connection Migration and NAT Traversal (#3)

Author: masa-koz

Cargo.toml

@@ -79,7 +79,7 @@ include = [
 path = "src/rs/lib.rs"
 
 [features]
-default = ["src"]
+default = ["src", "preview-api"]
 # Build c code from source
 src = [ "dep:cmake" ]
 # Find prebuilt msquic. Use vcpkg installed location on Windows,

docs/Settings.md

@@ -67,6 +67,9 @@ The following settings are available via registry as well as via [QUIC_SETTINGS]
 | Stream Multi Receive               | uint8_t    | StreamMultiReceiveEnabled   |         0 (FALSE) | Enable multi receive support                                                                                                  |
 | XDP                                | uint8_t    | XdpEnabled                  |         0 (FALSE) | Enable XDP. |
 | QTIP                               | uint8_t    | QTIPEnabled                 |         0 (FALSE) | Enable QTIP. XDP must be used. Clients will only send/recv QTIP xor UDP traffic, listeners accept both. [More info](./QTIP.md)|
+| Server Initiated Migration         | uint8_t    | ServerMigrationEnabled      |         0 (FALSE) | Enable Server Initiated Migration. |
+| ADD_ADDRESS handling mode          | uint8_t    | AddAddressMode              |         0 (AUTO)  | Control handling of ADD_ADDRESS Frame |
+| IgnoreUnreachable                  | uint8_t    | IgnoreUnreachable           |         0 (FALSE) | Ignore Unreachable during the Handshake |
 
 The types map to registry types as follows:
   - `uint64_t` is a `REG_QWORD`.
@@ -207,6 +210,15 @@ These parameters are accessed by calling [GetParam](./api/GetParam.md) or [SetPa
 | `QUIC_PARAM_CONN_SEND_DSCP` <br> 25               | uint8_t                       | Both      | The DiffServ Code Point put in the DiffServ field (formerly TypeOfService/TrafficClass) on packets sent from this connection. |
 | `QUIC_PARAM_CONN_NETWORK_STATISTICS` <br> 32      | QUIC_NETWORK_STATISTICS       | Get-only  | Returns Connection level network statistics |
 | `QUIC_PARAM_CONN_CLOSE_ASYNC` <br> 26      | uint8_t (BOOLEAN)      | Both  | The desired connection close behavior. Defaults to false (synchronous). |
+| `QUIC_PARAM_CONN_ADD_BOUND_ADDRESS` <br> 27       | QUIC_ADDR                     | Set-only  | Add a bound address. Server only. |
+| `QUIC_PARAM_CONN_ADD_OBSERVED_ADDRESS` <br> 28    | QUIC_ADD_OBSERVED_ADDRESS     | Set-only  | Set an observed address for a bound address. Server only. |
+| `QUIC_PARAM_CONN_REMOVE_BOUND_ADDRESS` <br> 29    | QUIC_ADDR                     | Set-only  | Remove a bound address. Server only. |
+| `QUIC_PARAM_CONN_ADD_PATH` <br> 30                | QUIC_PATH_PARAM               | Set-only  | Add a path. Client only. |
+| `QUIC_PARAM_CONN_ACTIVATE_PATH` <br> 31           | QUIC_PATH_PARAM               | Set-only  | Activate a path. Client only. |
+| `QUIC_PARAM_CONN_REMOVE_PATH` <br> 32             | QUIC_PATH_PARAM               | Set-only  | Remove a path. Client only. |
+| `QUIC_PARAM_CONN_ADD_CANDIDATE_ADDRESS` <br> 33   | QUIC_CANDIDATE_ADDRESS        | Set-only  | Add a candidate address. Client only. |
+| `QUIC_PARAM_CONN_REMOVE_CANDIDATE_ADDRESS` <br> 34| QUIC_CANDIDATE_ADDRESS        | Set-only  | Remove a candidate address. Client only. |
+
 
 ### QUIC_PARAM_CONN_STATISTICS_V2
 

docs/api/QUIC_CONNECTION_EVENT.md

@@ -28,6 +28,10 @@ typedef enum QUIC_CONNECTION_EVENT_TYPE {
     QUIC_CONNECTION_EVENT_RELIABLE_RESET_NEGOTIATED         = 16,   // Only indicated if QUIC_SETTINGS.ReliableResetEnabled is TRUE.
     QUIC_CONNECTION_EVENT_ONE_WAY_DELAY_NEGOTIATED          = 17,   // Only indicated if QUIC_SETTINGS.OneWayDelayEnabled is TRUE.
     QUIC_CONNECTION_EVENT_NETWORK_STATISTICS                = 18,   // Only indicated if QUIC_SETTINGS.EnableNetStatsEvent is TRUE.
+    QUIC_CONNECTION_EVENT_NOTIFY_OBSERVED_ADDRESS           = 19,
+    QUIC_CONNECTION_EVENT_NOTIFY_REMOTE_ADDRESS_ADDED       = 20,   // Only indicated if QUIC_SETTINGS.AddAddressMode is MANUAL
+    QUIC_CONNECTION_EVENT_PATH_VALIDATED                    = 21,
+    QUIC_CONNECTION_EVENT_NOTIFY_REMOTE_ADDRESS_REMOVED     = 22,   // Only indicated if QUIC_SETTINGS.AddAddressMode is MANUAL
 #endif
 
 } QUIC_CONNECTION_EVENT_TYPE;
@@ -113,6 +117,21 @@ typedef struct QUIC_CONNECTION_EVENT {
             BOOLEAN ReceiveNegotiated;          // TRUE if receiving one-way delay timestamps is negotiated.
         } ONE_WAY_DELAY_NEGOTIATED;
         QUIC_NETWORK_STATISTICS NETWORK_STATISTICS;
+        struct {
+            QUIC_ADDR *LocalAddress;
+            QUIC_ADDR *ObservedAddress;
+        } NOTIFY_OBSERVED_ADDRESS;
+        struct {
+            QUIC_ADDR *Address;
+            QUIC_UINT62 SequenceNumber;
+        } NOTIFY_REMOTE_ADDRESS_ADDED;
+        struct {
+            QUIC_ADDR *LocalAddress;
+            QUIC_ADDR *RemoteAddress;
+        } PATH_VALIDATED;
+        struct {
+            QUIC_UINT62 SequenceNumber;
+        } NOTIFY_REMOTE_ADDRESS_REMOVED;
 #endif
 
     };
@@ -469,6 +488,70 @@ Congestion Window
 
 Estimated bandwidth
 
+# QUIC_CONNECTION_EVENT_NOTIFY_OBSERVED_ADDRESS
+
+**Preview feature**: This event is in [preview](../PreviewFeatures.md). It should be considered unstable and can be subject to breaking changes.
+
+This event indicates the content of an OBSERVED_ADDRESS frame.
+
+## NOTIFY_OBSERVED_ADDRESS
+Both Observed address and local address are passed in the `NOTIFY_OBSERVED_ADDRESS` struct/union.
+
+`LocalAddress`
+
+The local IP address.
+
+`ObservedAddress`
+
+The observed IP address.
+
+# QUIC_CONNECTION_EVENT_NOTIFY_REMOTE_ADDRESS_ADDED
+
+**Preview feature**: This event is in [preview](../PreviewFeatures.md). It should be considered unstable and can be subject to breaking changes.
+
+This event is only indicated if QUIC_SETTINGS.AddAddressMode is MANUAL. This event indicates the content of an ADD_ADDRESS frame.
+
+## NOTIFY_REMOTE_ADDRESS_ADDED
+The contents of ADD_ADDRESS frame are passed in the `NOTIFY_REMOTE_ADDRESS_ADDED` struct/union.
+
+`Address`
+
+The new Remote IP address.
+
+`SequenceNumber`
+
+The Sequence Number of the added address.
+
+# QUIC_CONNECTION_EVENT_PATH_VALIDATED
+
+**Preview feature**: This event is in [preview](../PreviewFeatures.md). It should be considered unstable and can be subject to breaking changes.
+
+This event is delivered when a path has been validated.
+
+## PATH_VALIDATED
+Both the Local IP address and the Remote IP address are  passed in the `PATH_VALIDATED` struct/union.
+
+`LocalAddress`
+
+The Local IP address of a path.
+
+`RemoteAddress`
+
+The Remote IP address of a path.
+
+# QUIC_CONNECTION_EVENT_NOTIFY_REMOTE_ADDRESS_REMOVED
+
+**Preview feature**: This event is in [preview](../PreviewFeatures.md). It should be considered unstable and can be subject to breaking changes.
+
+This event is only indicated if QUIC_SETTINGS.AddAddressMode is MANUAL. This event indicates the content of a REMOVE_ADDRESS frame.
+
+## NOTIFY_REMOTE_ADDRESS_REMOVED
+The content of REMOVE_ADDRESS frame is passed in the `NOTIFY_REMOTE_ADDRESS_REMOVED` struct/union.
+
+`SequenceNumber`
+
+The Sequence Number of the removed address.
+
 
 # See Also
 

src/core/binding.c

@@ -1362,6 +1362,34 @@ QuicBindingCreateConnection(
     BindingRefAdded = TRUE;
     NewConnection->Paths[0].Binding = Binding;
 
+    // Add the local address to the connection's list of bound addresses.
+    QUIC_BOUND_ADDRESS_LIST_ENTRY* Bound =
+        (QUIC_BOUND_ADDRESS_LIST_ENTRY*)
+        CXPLAT_ALLOC_NONPAGED(
+            sizeof(QUIC_BOUND_ADDRESS_LIST_ENTRY),
+            QUIC_POOL_BOUND_ADDRESS_LIST);
+    if (Bound == NULL) {
+        QuicPacketLogDrop(Binding, Packet, "Failed to allocate local address");
+        goto Exit;
+    }
+
+    if (!QuicLibraryTryAddRefBinding(Binding)) {
+        QuicPacketLogDrop(Binding, Packet, "Clean up in progress");
+        CXPLAT_FREE(Bound, QUIC_POOL_BOUND_ADDRESS_LIST);
+        goto Exit;
+    }
+
+    CxPlatCopyMemory(&Bound->Address, &Packet->Route->LocalAddress, sizeof(QUIC_ADDR));
+    Bound->SequenceNumber = QUIC_VAR_INT_MAX;
+    Bound->SequenceNumberValid = FALSE;
+    Bound->ObservedAddressSet = FALSE;
+    Bound->SendAddAddress = FALSE;
+    Bound->Removing = FALSE;
+    Bound->SendRemoveAddress = FALSE;
+    Bound->Binding = Binding;
+
+    CxPlatListInsertTail(&NewConnection->BoundAddresses, &Bound->Link);
+
     if (!QuicLookupAddRemoteHash(
             &Binding->Lookup,
             NewConnection,