Allow Configuration of Stateless Retry Key #5112

anrossi · 2025-05-21T05:50:50Z

Description

Add a new Global SetParam to set the Stateless Retry key, algorithm, and key rotation interval.
Fixes #5005.

Testing

New tests added covering the invalid parameter cases.

Documentation

Settings.md was updated to describe the new parameter.

src/test/lib/ApiTest.cpp

src/core/library.c

src/core/library.h

src/inc/msquic.h

github-actions · 2025-05-22T23:51:00Z

Cargo - windows-latest

The rust bindings need to be updated. Please apply (git apply) this patch:

diff --git a/src/rs/ffi/win_bindings.rs b/src/rs/ffi/win_bindings.rs
index 5b5a00e..ff0bfe3 100644
--- a/src/rs/ffi/win_bindings.rs
+++ b/src/rs/ffi/win_bindings.rs
@@ -168,6 +168,7 @@ pub const QUIC_PARAM_GLOBAL_LIBRARY_GIT_HASH: u32 = 16777224;
 pub const QUIC_PARAM_GLOBAL_EXECUTION_CONFIG: u32 = 16777225;
 pub const QUIC_PARAM_GLOBAL_TLS_PROVIDER: u32 = 16777226;
 pub const QUIC_PARAM_GLOBAL_STATELESS_RESET_KEY: u32 = 16777227;
+pub const QUIC_PARAM_GLOBAL_STATELESS_RETRY_CONFIG: u32 = 16777228;
 pub const QUIC_PARAM_CONFIGURATION_SETTINGS: u32 = 50331648;
 pub const QUIC_PARAM_CONFIGURATION_TICKET_KEYS: u32 = 50331649;
 pub const QUIC_PARAM_CONFIGURATION_VERSION_SETTINGS: u32 = 50331650;
@@ -4848,6 +4849,34 @@ const _: () = {
     ["Offset of field: QUIC_STREAM_STATISTICS::StreamBlockedByAppUs"]
         [::std::mem::offset_of!(QUIC_STREAM_STATISTICS, StreamBlockedByAppUs) - 56usize];
 };
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_128_GCM: QUIC_AEAD_ALGORITHM_TYPE = 0;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_256_GCM: QUIC_AEAD_ALGORITHM_TYPE = 1;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_CHACHA20_POLY1305: QUIC_AEAD_ALGORITHM_TYPE =
+    2;
+pub type QUIC_AEAD_ALGORITHM_TYPE = ::std::os::raw::c_int;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct QUIC_STATELESS_RETRY_CONFIG {
+    pub Algorithm: QUIC_AEAD_ALGORITHM_TYPE,
+    pub RotationMs: u32,
+    pub SecretLength: u32,
+    pub Secret: [u8; 1usize],
+}
+#[allow(clippy::unnecessary_operation, clippy::identity_op)]
+const _: () = {
+    ["Size of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 16usize];
+    ["Alignment of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Algorithm"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Algorithm) - 0usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::RotationMs"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, RotationMs) - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::SecretLength"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, SecretLength) - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Secret"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 12usize];
+};
 pub type QUIC_SET_CONTEXT_FN = ::std::option::Option<
     unsafe extern "C" fn(Handle: HQUIC, Context: *mut ::std::os::raw::c_void),
 >;

github-actions · 2025-05-22T23:59:12Z

Cargo - windows-latest

The rust bindings need to be updated. Please apply (git apply) this patch:

diff --git a/src/rs/ffi/win_bindings.rs b/src/rs/ffi/win_bindings.rs
index 5b5a00e..ff0bfe3 100644
--- a/src/rs/ffi/win_bindings.rs
+++ b/src/rs/ffi/win_bindings.rs
@@ -168,6 +168,7 @@ pub const QUIC_PARAM_GLOBAL_LIBRARY_GIT_HASH: u32 = 16777224;
 pub const QUIC_PARAM_GLOBAL_EXECUTION_CONFIG: u32 = 16777225;
 pub const QUIC_PARAM_GLOBAL_TLS_PROVIDER: u32 = 16777226;
 pub const QUIC_PARAM_GLOBAL_STATELESS_RESET_KEY: u32 = 16777227;
+pub const QUIC_PARAM_GLOBAL_STATELESS_RETRY_CONFIG: u32 = 16777228;
 pub const QUIC_PARAM_CONFIGURATION_SETTINGS: u32 = 50331648;
 pub const QUIC_PARAM_CONFIGURATION_TICKET_KEYS: u32 = 50331649;
 pub const QUIC_PARAM_CONFIGURATION_VERSION_SETTINGS: u32 = 50331650;
@@ -4848,6 +4849,34 @@ const _: () = {
     ["Offset of field: QUIC_STREAM_STATISTICS::StreamBlockedByAppUs"]
         [::std::mem::offset_of!(QUIC_STREAM_STATISTICS, StreamBlockedByAppUs) - 56usize];
 };
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_128_GCM: QUIC_AEAD_ALGORITHM_TYPE = 0;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_256_GCM: QUIC_AEAD_ALGORITHM_TYPE = 1;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_CHACHA20_POLY1305: QUIC_AEAD_ALGORITHM_TYPE =
+    2;
+pub type QUIC_AEAD_ALGORITHM_TYPE = ::std::os::raw::c_int;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct QUIC_STATELESS_RETRY_CONFIG {
+    pub Algorithm: QUIC_AEAD_ALGORITHM_TYPE,
+    pub RotationMs: u32,
+    pub SecretLength: u32,
+    pub Secret: [u8; 1usize],
+}
+#[allow(clippy::unnecessary_operation, clippy::identity_op)]
+const _: () = {
+    ["Size of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 16usize];
+    ["Alignment of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Algorithm"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Algorithm) - 0usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::RotationMs"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, RotationMs) - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::SecretLength"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, SecretLength) - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Secret"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 12usize];
+};
 pub type QUIC_SET_CONTEXT_FN = ::std::option::Option<
     unsafe extern "C" fn(Handle: HQUIC, Context: *mut ::std::os::raw::c_void),
 >;

codecov · 2025-05-23T00:26:25Z

Codecov Report

Attention: Patch coverage is 96.15385% with 4 lines in your changes missing coverage. Please review.

Project coverage is 86.82%. Comparing base (31d2b73) to head (c1069ab).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/core/library.c	96.73%	3 Missing ⚠️
src/core/partition.c	91.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5112      +/-   ##
==========================================
- Coverage   87.19%   86.82%   -0.37%     
==========================================
  Files          59       59              
  Lines       18086    18183      +97     
==========================================
+ Hits        15770    15788      +18     
- Misses       2316     2395      +79

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

src/core/library.c

github-actions · 2025-05-30T00:24:19Z

Cargo - windows-latest

The rust bindings need to be updated. Please apply (git apply) this patch:

diff --git a/src/rs/ffi/win_bindings.rs b/src/rs/ffi/win_bindings.rs
index 998d8cf..18cab7e 100644
--- a/src/rs/ffi/win_bindings.rs
+++ b/src/rs/ffi/win_bindings.rs
@@ -4861,14 +4861,14 @@ pub struct QUIC_STATELESS_RETRY_CONFIG {
     pub Algorithm: QUIC_AEAD_ALGORITHM_TYPE,
     pub RotationMs: u32,
     pub SecretLength: u32,
-    pub Secret: [u8; 1usize],
+    pub Secret: *const u8,
 }
 #[allow(clippy::unnecessary_operation, clippy::identity_op)]
 const _: () = {
     ["Size of QUIC_STATELESS_RETRY_CONFIG"]
-        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 16usize];
+        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 24usize];
     ["Alignment of QUIC_STATELESS_RETRY_CONFIG"]
-        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 4usize];
+        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 8usize];
     ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Algorithm"]
         [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Algorithm) - 0usize];
     ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::RotationMs"]
@@ -4876,7 +4876,7 @@ const _: () = {
     ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::SecretLength"]
         [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, SecretLength) - 8usize];
     ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Secret"]
-        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 12usize];
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 16usize];
 };
 pub type QUIC_SET_CONTEXT_FN = ::std::option::Option<
     unsafe extern "C" fn(Handle: HQUIC, Context: *mut ::std::os::raw::c_void),

src/core/library.c

github-actions · 2025-06-14T06:14:03Z

Cargo - ubuntu-latest

The rust bindings need to be updated. Please apply (git apply) this patch:

diff --git a/src/rs/ffi/linux_bindings.rs b/src/rs/ffi/linux_bindings.rs
index cf4039b..01b44d4 100644
--- a/src/rs/ffi/linux_bindings.rs
+++ b/src/rs/ffi/linux_bindings.rs
@@ -175,6 +175,7 @@ pub const QUIC_PARAM_GLOBAL_EXECUTION_CONFIG: u32 = 16777225;
 pub const QUIC_PARAM_GLOBAL_TLS_PROVIDER: u32 = 16777226;
 pub const QUIC_PARAM_GLOBAL_STATELESS_RESET_KEY: u32 = 16777227;
 pub const QUIC_PARAM_GLOBAL_STATISTICS_V2_SIZES: u32 = 16777228;
+pub const QUIC_PARAM_GLOBAL_STATELESS_RETRY_CONFIG: u32 = 16777229;
 pub const QUIC_PARAM_CONFIGURATION_SETTINGS: u32 = 50331648;
 pub const QUIC_PARAM_CONFIGURATION_TICKET_KEYS: u32 = 50331649;
 pub const QUIC_PARAM_CONFIGURATION_VERSION_SETTINGS: u32 = 50331650;
@@ -4884,6 +4885,34 @@ const _: () = {
     ["Offset of field: QUIC_STREAM_STATISTICS::StreamBlockedByAppUs"]
         [::std::mem::offset_of!(QUIC_STREAM_STATISTICS, StreamBlockedByAppUs) - 56usize];
 };
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_128_GCM: QUIC_AEAD_ALGORITHM_TYPE = 0;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_256_GCM: QUIC_AEAD_ALGORITHM_TYPE = 1;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_CHACHA20_POLY1305: QUIC_AEAD_ALGORITHM_TYPE =
+    2;
+pub type QUIC_AEAD_ALGORITHM_TYPE = ::std::os::raw::c_uint;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct QUIC_STATELESS_RETRY_CONFIG {
+    pub Algorithm: QUIC_AEAD_ALGORITHM_TYPE,
+    pub RotationMs: u32,
+    pub SecretLength: u32,
+    pub Secret: *const u8,
+}
+#[allow(clippy::unnecessary_operation, clippy::identity_op)]
+const _: () = {
+    ["Size of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 24usize];
+    ["Alignment of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Algorithm"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Algorithm) - 0usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::RotationMs"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, RotationMs) - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::SecretLength"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, SecretLength) - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Secret"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 16usize];
+};
 pub type QUIC_SET_CONTEXT_FN = ::std::option::Option<
     unsafe extern "C" fn(Handle: HQUIC, Context: *mut ::std::os::raw::c_void),
 >;

github-actions · 2025-06-14T06:59:40Z

Cargo - ubuntu-latest

The rust bindings need to be updated. Please apply (git apply) this patch:

diff --git a/src/rs/ffi/linux_bindings.rs b/src/rs/ffi/linux_bindings.rs
index cf4039b..01b44d4 100644
--- a/src/rs/ffi/linux_bindings.rs
+++ b/src/rs/ffi/linux_bindings.rs
@@ -175,6 +175,7 @@ pub const QUIC_PARAM_GLOBAL_EXECUTION_CONFIG: u32 = 16777225;
 pub const QUIC_PARAM_GLOBAL_TLS_PROVIDER: u32 = 16777226;
 pub const QUIC_PARAM_GLOBAL_STATELESS_RESET_KEY: u32 = 16777227;
 pub const QUIC_PARAM_GLOBAL_STATISTICS_V2_SIZES: u32 = 16777228;
+pub const QUIC_PARAM_GLOBAL_STATELESS_RETRY_CONFIG: u32 = 16777229;
 pub const QUIC_PARAM_CONFIGURATION_SETTINGS: u32 = 50331648;
 pub const QUIC_PARAM_CONFIGURATION_TICKET_KEYS: u32 = 50331649;
 pub const QUIC_PARAM_CONFIGURATION_VERSION_SETTINGS: u32 = 50331650;
@@ -4884,6 +4885,34 @@ const _: () = {
     ["Offset of field: QUIC_STREAM_STATISTICS::StreamBlockedByAppUs"]
         [::std::mem::offset_of!(QUIC_STREAM_STATISTICS, StreamBlockedByAppUs) - 56usize];
 };
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_128_GCM: QUIC_AEAD_ALGORITHM_TYPE = 0;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_AES_256_GCM: QUIC_AEAD_ALGORITHM_TYPE = 1;
+pub const QUIC_AEAD_ALGORITHM_TYPE_QUIC_AEAD_ALGORITHM_CHACHA20_POLY1305: QUIC_AEAD_ALGORITHM_TYPE =
+    2;
+pub type QUIC_AEAD_ALGORITHM_TYPE = ::std::os::raw::c_uint;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct QUIC_STATELESS_RETRY_CONFIG {
+    pub Algorithm: QUIC_AEAD_ALGORITHM_TYPE,
+    pub RotationMs: u32,
+    pub SecretLength: u32,
+    pub Secret: *const u8,
+}
+#[allow(clippy::unnecessary_operation, clippy::identity_op)]
+const _: () = {
+    ["Size of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::size_of::<QUIC_STATELESS_RETRY_CONFIG>() - 24usize];
+    ["Alignment of QUIC_STATELESS_RETRY_CONFIG"]
+        [::std::mem::align_of::<QUIC_STATELESS_RETRY_CONFIG>() - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Algorithm"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Algorithm) - 0usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::RotationMs"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, RotationMs) - 4usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::SecretLength"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, SecretLength) - 8usize];
+    ["Offset of field: QUIC_STATELESS_RETRY_CONFIG::Secret"]
+        [::std::mem::offset_of!(QUIC_STATELESS_RETRY_CONFIG, Secret) - 16usize];
+};
 pub type QUIC_SET_CONTEXT_FN = ::std::option::Option<
     unsafe extern "C" fn(Handle: HQUIC, Context: *mut ::std::os::raw::c_void),
 >;

src/inc/msquic.h

docs/Settings.md

src/core/library.c

src/core/partition.c

src/core/library.c

src/test/bin/quic_gtest.cpp

src/test/lib/ApiTest.cpp

docs/Settings.md

src/inc/quic_crypt.h

src/core/partition.c

src/core/quicdef.h

src/core/library.c

…pdate Csharp API

anrossi added 4 commits May 21, 2025 05:00

Internal key rotation logic

8ba591a

Add SetParam interface

00962ac

Add API test

a06eea8

Add documentation

4a81a65

anrossi added this to DPT Iteration Tracker May 21, 2025

anrossi requested a review from a team as a code owner May 21, 2025 05:50

anrossi added Area: API Area: Core Related to the shared, core protocol logic labels May 21, 2025