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. Also create the ability to set this via the registry.
Fixes #5005.

Testing

New tests added covering the invalid parameter cases.

Documentation

Settings.md was updated to describe the new parameter. New documentation for QUIC_STATELESS_RETRY_CONFIG.

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.12%. Comparing base (be90c9c) to head (aaaf838).
Report is 4 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.41%   86.12%   -1.29%     
==========================================
  Files          59       59              
  Lines       18086    18330     +244     
==========================================
- Hits        15809    15787      -22     
- Misses       2277     2543     +266

☔ 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

src/core/partition.c

src/core/library.c

src/core/partition.c

src/core/unittest/main.h

src/core/library.c

src/platform/storage_winuser.c

src/core/library.c

src/core/partition.c

src/core/library.c

github-actions · 2025-06-27T01:21:58Z

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 01b44d4..d863f72 100644
--- a/src/rs/ffi/linux_bindings.rs
+++ b/src/rs/ffi/linux_bindings.rs
@@ -4887,8 +4887,6 @@ const _: () = {
 };
 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)]

github-actions · 2025-06-27T01:22:32Z

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 afb9206..4f7ebfd 100644
--- a/src/rs/ffi/win_bindings.rs
+++ b/src/rs/ffi/win_bindings.rs
@@ -4881,8 +4881,6 @@ const _: () = {
 };
 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)]

guhetier

LGTM

docs/api/QUIC_STATELESS_RETRY_CONFIG.md

src/inc/quic_crypt.h

sm-msft · 2025-06-27T21:41:03Z

Looks good to me.

sm-msft · 2025-06-27T21:42:06Z

(Pls ignore the re-review. Hit the wrong button)

sm-msft

Looks good to me.

* Add SetParam interface * Add API test * Add documentation * Add registry read logic. * Add GetParam only for debug builds * Write tests for the registry settings * Require secret and algorithm to change together in registry --------- Co-authored-by: Nick Banks <nibanks@microsoft.com>

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 labels May 21, 2025