Add versioning support for Connection resumption ticket

src/core/crypto.c

@@ -2144,6 +2144,31 @@
     PacketSpace->CurrentKeyPhaseBytesSent = 0;
 }
 
+uint8_t
+QuicGetOutgoingResumptionTicketVersion(_In_opt_ QUIC_CONNECTION* Connection)
+{
+
+    CXPLAT_FRE_ASSERT(QuicVarIntSize(CXPLAT_TLS_RESUMPTION_TICKET_VERSION) == sizeof(Connection->Settings.ResumptionTicketMaxVersion));
+    CXPLAT_FRE_ASSERT(sizeof(uint8_t) == sizeof(Connection->Settings.ResumptionTicketMaxVersion));
+
+    if (Connection == NULL) {
+        return (uint8_t)CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+    }
+
+    return Connection->Settings.ResumptionTicketMaxVersion;
+}
+
+BOOLEAN
+IsQuicIncomingResumptionTicketSupported(_In_ QUIC_CONNECTION* Connection, QUIC_VAR_INT TicketVersion)
+{
+    if (TicketVersion >= Connection->Settings.ResumptionTicketMinVersion &&
+        TicketVersion <= Connection->Settings.ResumptionTicketMaxVersion) {
+        return TRUE;
+    }
+
+    return FALSE;
+}
+
 QUIC_STATUS
 QuicCryptoEncodeServerTicket(
     _In_opt_ QUIC_CONNECTION* Connection,
@@ -2233,7 +2258,7 @@
     //
 
     _Analysis_assume_(sizeof(*TicketBuffer) >= 8);
-    uint8_t* TicketCursor = QuicVarIntEncode(CXPLAT_TLS_RESUMPTION_TICKET_VERSION, TicketBuffer);
+    uint8_t* TicketCursor = QuicVarIntEncode(QuicGetOutgoingResumptionTicketVersion(Connection), TicketBuffer);
     CxPlatCopyMemory(TicketCursor, &QuicVersion, sizeof(QuicVersion));
     TicketCursor += sizeof(QuicVersion);
     TicketCursor = QuicVarIntEncode(AlpnLength, TicketCursor);
@@ -2292,7 +2317,8 @@
             "Resumption Ticket version failed to decode");
         goto Error;
     }
-    if (TicketVersion != CXPLAT_TLS_RESUMPTION_TICKET_VERSION) {
+
+    if (!IsQuicIncomingResumptionTicketSupported(Connection, TicketVersion)) {
         QuicTraceEvent(
             ConnError,
             "[conn][%p] ERROR, %s.",
@@ -2301,6 +2327,10 @@
         goto Error;
     }
 
+    if (TicketVersion == CXPLAT_TLS_RESUMPTION_TICKET_VERSION_V2) {
+        // Handle V2 ticket specific extensions
+    }
+
     if (TicketLength < Offset + sizeof(uint32_t)) {
         QuicTraceEvent(
             ConnError,

src/core/quicdef.h

@@ -444,11 +444,22 @@ CXPLAT_STATIC_ASSERT(
 //
 #define QUIC_DEFAULT_SERVER_RESUMPTION_LEVEL    QUIC_SERVER_NO_RESUME
 
+
 //
-// Version of the wire-format for resumption tickets.
-// This needs to be incremented for each change in order or count of fields.
+// Valid Resumption Ticket Versions - these must be contiguous
+//
+#define CXPLAT_TLS_RESUMPTION_TICKET_VERSION_V1   1
+#define CXPLAT_TLS_RESUMPTION_TICKET_VERSION_V2   2
+
+//
+// Min version of the wire-format for resumption tickets.
+//
+#define CXPLAT_TLS_RESUMPTION_TICKET_VERSION      CXPLAT_TLS_RESUMPTION_TICKET_VERSION_V1
+
+//
+// Max version of the wire-format for resumption tickets.
 //
-#define CXPLAT_TLS_RESUMPTION_TICKET_VERSION      1
+#define CXPLAT_TLS_RESUMPTION_TICKET_MAX_VERSION      CXPLAT_TLS_RESUMPTION_TICKET_VERSION_V2
 
 //
 // Version of the blob for client resumption tickets.
@@ -700,3 +711,5 @@ CXPLAT_STATIC_ASSERT(
 #define QUIC_SETTING_MTU_MISSING_PROBE_COUNT        "MtuDiscoveryMissingProbeCount"
 
 #define QUIC_SETTING_CONGESTION_CONTROL_ALGORITHM   "CongestionControlAlgorithm"
+#define QUIC_SETTING_RESUMPTION_TICKET_MIN_VERSION "ResumptionTicketMinVersion"
+#define QUIC_SETTING_RESUMPTION_TICKET_MAX_VERSION "ResumptionTicketMaxVersion"

src/core/settings.c

@@ -177,6 +177,13 @@
     if (!Settings->IsSet.StreamMultiReceiveEnabled) {
         Settings->StreamMultiReceiveEnabled = QUIC_DEFAULT_STREAM_MULTI_RECEIVE_ENABLED;
     }
+    if (!Settings->IsSet.ResumptionTicketMinVersion) {
+        Settings->ResumptionTicketMinVersion = CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+    }
+    if (!Settings->IsSet.ResumptionTicketMaxVersion) {
+        // Default to the min version if not explicitly set
+        Settings->ResumptionTicketMaxVersion = CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+    }
 }
 
 _IRQL_requires_max_(PASSIVE_LEVEL)
@@ -354,6 +361,12 @@
     if (!Destination->IsSet.StreamMultiReceiveEnabled) {
         Destination->StreamMultiReceiveEnabled = Source->StreamMultiReceiveEnabled;
     }
+    if (!Destination->IsSet.ResumptionTicketMinVersion) {
+        Destination->ResumptionTicketMinVersion = Source->ResumptionTicketMinVersion;
+    }
+    if (!Destination->IsSet.ResumptionTicketMaxVersion) {
+        Destination->ResumptionTicketMaxVersion = Source->ResumptionTicketMaxVersion;
+    }
 }
 
 _IRQL_requires_max_(PASSIVE_LEVEL)
@@ -747,6 +760,17 @@
         Destination->StreamMultiReceiveEnabled = Source->StreamMultiReceiveEnabled;
         Destination->IsSet.StreamMultiReceiveEnabled = TRUE;
     }
+
+    if (Source->IsSet.ResumptionTicketMinVersion && (!Destination->IsSet.ResumptionTicketMinVersion || OverWrite)) {
+        Destination->ResumptionTicketMinVersion = Source->ResumptionTicketMinVersion;
+        Destination->IsSet.ResumptionTicketMinVersion = TRUE;
+    }
+
+    if (Source->IsSet.ResumptionTicketMaxVersion && (!Destination->IsSet.ResumptionTicketMaxVersion || OverWrite)) {
+        Destination->ResumptionTicketMaxVersion = Source->ResumptionTicketMaxVersion;
+        Destination->IsSet.ResumptionTicketMaxVersion = TRUE;
+    }
+
     return TRUE;
 }
 
@@ -1445,6 +1469,38 @@
             &ValueLen);
         Settings->StreamMultiReceiveEnabled = !!Value;
     }
+    if (!Settings->IsSet.ResumptionTicketMinVersion) {
+        Value = CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+        ValueLen = sizeof(Value);
+        CxPlatStorageReadValue(
+            Storage,
+            QUIC_SETTING_RESUMPTION_TICKET_MIN_VERSION,
+            (uint8_t*)&Value,
+            &ValueLen);
+        Settings->ResumptionTicketMinVersion = (uint8_t)Value;
+
+        if (Settings->ResumptionTicketMinVersion > CXPLAT_TLS_RESUMPTION_TICKET_MAX_VERSION) {
+            Settings->ResumptionTicketMinVersion = CXPLAT_TLS_RESUMPTION_TICKET_MAX_VERSION;
+        } else if (Settings->ResumptionTicketMinVersion < CXPLAT_TLS_RESUMPTION_TICKET_VERSION) {
+            Settings->ResumptionTicketMinVersion = CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+        }
+    }
+    if (!Settings->IsSet.ResumptionTicketMaxVersion) {
+        Value = CXPLAT_TLS_RESUMPTION_TICKET_VERSION;
+        ValueLen = sizeof(Value);
+        CxPlatStorageReadValue(
+            Storage,
+            QUIC_SETTING_RESUMPTION_TICKET_MAX_VERSION,
+            (uint8_t*)&Value,
+            &ValueLen);
+        Settings->ResumptionTicketMaxVersion = (uint8_t)Value;
+        if (Settings->ResumptionTicketMaxVersion > CXPLAT_TLS_RESUMPTION_TICKET_MAX_VERSION) {
+            Settings->ResumptionTicketMaxVersion = CXPLAT_TLS_RESUMPTION_TICKET_MAX_VERSION;
+        }
+        else if (Settings->ResumptionTicketMaxVersion < Settings->ResumptionTicketMinVersion) {
+            Settings->ResumptionTicketMaxVersion = Settings->ResumptionTicketMinVersion;
+        }
+    }
 }
 
 _IRQL_requires_max_(PASSIVE_LEVEL)
@@ -1517,6 +1573,8 @@
     QuicTraceLogVerbose(SettingOneWayDelayEnabled,          "[sett] OneWayDelayEnabled     = %hhu", Settings->OneWayDelayEnabled);
     QuicTraceLogVerbose(SettingNetStatsEventEnabled,        "[sett] NetStatsEventEnabled   = %hhu", Settings->NetStatsEventEnabled);
     QuicTraceLogVerbose(SettingsStreamMultiReceiveEnabled,  "[sett] StreamMultiReceiveEnabled= %hhu", Settings->StreamMultiReceiveEnabled);
+    QuicTraceLogVerbose(SettingsDumpResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
+    QuicTraceLogVerbose(SettingsDumpResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
 }
 
 _IRQL_requires_max_(PASSIVE_LEVEL)
@@ -1690,6 +1748,12 @@
     if (Settings->IsSet.StreamMultiReceiveEnabled) {
         QuicTraceLogVerbose(SettingStreamMultiReceiveEnabled,       "[sett] StreamMultiReceiveEnabled  = %hhu", Settings->StreamMultiReceiveEnabled);
     }
+    if (Settings->IsSet.ResumptionTicketMinVersion) {
+        QuicTraceLogVerbose(SettingResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
+    }
+    if (Settings->IsSet.ResumptionTicketMaxVersion) {
+        QuicTraceLogVerbose(SettingResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
+    }
 }
 
 #define SETTING_COPY_TO_INTERNAL(Field, Settings, InternalSettings) \
@@ -1819,7 +1883,7 @@
     _Out_ QUIC_SETTINGS_INTERNAL* InternalSettings
     )
 {
-    if (!CXPLAT_STRUCT_HAS_FIELD(QUIC_SETTINGS, SettingsSize, MtuDiscoveryMissingProbeCount)) {
+    if (!CXPLAT_STRUCT_HAS_FIELD(QUIC_SETTINGS, SettingsSize, ResumptionTicketMaxVersion)) {
         return QUIC_STATUS_INVALID_PARAMETER;
     }
 
@@ -1972,6 +2036,20 @@
         SettingsSize,
         InternalSettings);
 
+    SETTING_COPY_TO_INTERNAL_SIZED(
+        ResumptionTicketMinVersion,
+        QUIC_SETTINGS,
+        Settings,
+        SettingsSize,
+        InternalSettings);
+
+    SETTING_COPY_TO_INTERNAL_SIZED(
+        ResumptionTicketMaxVersion,
+        QUIC_SETTINGS,
+        Settings,
+        SettingsSize,
+        InternalSettings);
+
     return QUIC_STATUS_SUCCESS;
 }
 
@@ -2000,7 +2078,7 @@
         QUIC_SETTINGS* Settings
     )
 {
-    uint32_t MinimumSettingsSize = (uint32_t)CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_SETTINGS, MtuDiscoveryMissingProbeCount);
+    uint32_t MinimumSettingsSize = (uint32_t)CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_SETTINGS, ResumptionTicketMaxVersion);
 
     if (*SettingsLength == 0) {
         *SettingsLength = sizeof(QUIC_SETTINGS);
@@ -2165,6 +2243,20 @@
         *SettingsLength,
         InternalSettings);
 
+    SETTING_COPY_FROM_INTERNAL_SIZED(
+        ResumptionTicketMinVersion,
+        QUIC_SETTINGS,
+        Settings,
+        *SettingsLength,
+        InternalSettings);
+
+    SETTING_COPY_FROM_INTERNAL_SIZED(
+        ResumptionTicketMaxVersion,
+        QUIC_SETTINGS,
+        Settings,
+        *SettingsLength,
+        InternalSettings);
+
     *SettingsLength = CXPLAT_MIN(*SettingsLength, sizeof(QUIC_SETTINGS));
 
     return QUIC_STATUS_SUCCESS;

src/core/settings.h

@@ -65,7 +65,9 @@ typedef struct QUIC_SETTINGS_INTERNAL {
             uint64_t XdpEnabled                             : 1;
             uint64_t QTIPEnabled                            : 1;
             uint64_t RioEnabled                             : 1;
-            uint64_t RESERVED                               : 13;
+            uint64_t ResumptionTicketMinVersion             : 1;
+            uint64_t ResumptionTicketMaxVersion             : 1;
+            uint64_t RESERVED                               : 11;
         } IsSet;
     };
 
@@ -120,6 +122,8 @@ typedef struct QUIC_SETTINGS_INTERNAL {
     uint8_t QTIPEnabled                     : 1;
     uint8_t RioEnabled                      : 1;
     uint8_t MtuDiscoveryMissingProbeCount;
+    uint8_t ResumptionTicketMinVersion;
+    uint8_t ResumptionTicketMaxVersion;
 } QUIC_SETTINGS_INTERNAL;
 
 //