Skip to content

Expose TLS Group through MsQuic API #5030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 1, 2025
Merged

Expose TLS Group through MsQuic API #5030

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
32f14e0
Expose TLS Group through MsQuic API
nibanks Apr 19, 2025
19c2bff
nit: space
nibanks Apr 19, 2025
089af77
Bindings and rename
nibanks Apr 20, 2025
170f46b
Make mac build happy
nibanks Apr 20, 2025
e33ba93
Some docs
nibanks Apr 20, 2025
1d28db1
Merge branch 'main' into tls-group
nibanks Apr 23, 2025
2889424
Merge branch 'main' into tls-group
nibanks Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions src/core/settings.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1642,24 +1642,18 @@ QuicSettingsDumpNew(
}
}

#define SETTINGS_SIZE_THRU_FIELD(SettingsType, Field) \
(FIELD_OFFSET(SettingsType, Field) + sizeof(((SettingsType*)0)->Field))

#define SETTING_HAS_FIELD(SettingsType, Size, Field) \
(Size >= SETTINGS_SIZE_THRU_FIELD(SettingsType, Field))

#define SETTING_COPY_TO_INTERNAL(Field, Settings, InternalSettings) \
InternalSettings->IsSet.Field = Settings->IsSet.Field; \
InternalSettings->Field = Settings->Field;

#define SETTING_COPY_TO_INTERNAL_SIZED(Field, SettingsType, Settings, SettingsSize, InternalSettings) \
if (SETTING_HAS_FIELD(SettingsType, SettingsSize, Field)) { \
if (CXPLAT_STRUCT_HAS_FIELD(SettingsType, SettingsSize, Field)) { \
InternalSettings->IsSet.Field = Settings->IsSet.Field; \
InternalSettings->Field = Settings->Field; \
}

#define SETTING_COPY_FLAG_TO_INTERNAL_SIZED(FlagField, Flag, SettingsType, Settings, SettingsSize, InternalSettings) \
if (SETTING_HAS_FIELD(SettingsType, SettingsSize, FlagField)) { \
if (CXPLAT_STRUCT_HAS_FIELD(SettingsType, SettingsSize, FlagField)) { \
InternalSettings->IsSet.Flag = !!Settings->IsSet.Flag; \
InternalSettings->Flag = !!Settings->Flag; \
}
Expand All @@ -1673,7 +1667,7 @@ QuicSettingsGlobalSettingsToInternal(
_Out_ QUIC_SETTINGS_INTERNAL* InternalSettings
)
{
if (!SETTING_HAS_FIELD(QUIC_GLOBAL_SETTINGS, SettingsSize, LoadBalancingMode)) {
if (!CXPLAT_STRUCT_HAS_FIELD(QUIC_GLOBAL_SETTINGS, SettingsSize, LoadBalancingMode)) {
return QUIC_STATUS_INVALID_PARAMETER;
}

Expand Down Expand Up @@ -1775,7 +1769,7 @@ QuicSettingsSettingsToInternal(
_Out_ QUIC_SETTINGS_INTERNAL* InternalSettings
)
{
if (!SETTING_HAS_FIELD(QUIC_SETTINGS, SettingsSize, MtuDiscoveryMissingProbeCount)) {
if (!CXPLAT_STRUCT_HAS_FIELD(QUIC_SETTINGS, SettingsSize, MtuDiscoveryMissingProbeCount)) {
return QUIC_STATUS_INVALID_PARAMETER;
}

Expand Down Expand Up @@ -1920,13 +1914,13 @@ QuicSettingsSettingsToInternal(
Settings->Field = InternalSettings->Field;

#define SETTING_COPY_FROM_INTERNAL_SIZED(Field, SettingsType, Settings, SettingsSize, InternalSettings) \
if (SETTING_HAS_FIELD(SettingsType, SettingsSize, Field)) { \
if (CXPLAT_STRUCT_HAS_FIELD(SettingsType, SettingsSize, Field)) { \
Settings->IsSet.Field = InternalSettings->IsSet.Field; \
Settings->Field = InternalSettings->Field; \
}

#define SETTING_COPY_FLAG_FROM_INTERNAL_SIZED(FlagField, Flag, SettingsType, Settings, SettingsSize, InternalSettings) \
if (SETTING_HAS_FIELD(SettingsType, SettingsSize, FlagField)) { \
if (CXPLAT_STRUCT_HAS_FIELD(SettingsType, SettingsSize, FlagField)) { \
Settings->IsSet.Flag = InternalSettings->IsSet.Flag; \
Settings->Flag = InternalSettings->Flag; \
}
Expand All @@ -1940,7 +1934,7 @@ QuicSettingsGetSettings(
QUIC_SETTINGS* Settings
)
{
uint32_t MinimumSettingsSize = (uint32_t)SETTINGS_SIZE_THRU_FIELD(QUIC_SETTINGS, MtuDiscoveryMissingProbeCount);
uint32_t MinimumSettingsSize = (uint32_t)CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_SETTINGS, MtuDiscoveryMissingProbeCount);

if (*SettingsLength == 0) {
*SettingsLength = sizeof(QUIC_SETTINGS);
Expand Down Expand Up @@ -2103,7 +2097,7 @@ QuicSettingsGetGlobalSettings(
QUIC_GLOBAL_SETTINGS* Settings
)
{
const uint32_t MinimumSettingsSize = (uint32_t)SETTINGS_SIZE_THRU_FIELD(QUIC_GLOBAL_SETTINGS, LoadBalancingMode);
const uint32_t MinimumSettingsSize = (uint32_t)CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_GLOBAL_SETTINGS, LoadBalancingMode);

if (*SettingsLength == 0) {
*SettingsLength = sizeof(QUIC_GLOBAL_SETTINGS);
Expand Down
18 changes: 18 additions & 0 deletions src/inc/msquic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,23 @@ typedef enum QUIC_KEY_EXCHANGE_ALGORITHM {
QUIC_KEY_EXCHANGE_ALGORITHM_NONE = 0,
} QUIC_KEY_EXCHANGE_ALGORITHM;

//
// See the following IANA registry for the TLS groups:
// https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8
//
typedef enum QUIC_TLS_GROUP {
QUIC_TLS_GROUP_NONE = 0,
QUIC_TLS_GROUP_SECP256R1 = 23,
QUIC_TLS_GROUP_SECP384R1 = 24,
QUIC_TLS_GROUP_X25519 = 29,
QUIC_TLS_GROUP_MLKEM512 = 512,
QUIC_TLS_GROUP_MLKEM768 = 513,
QUIC_TLS_GROUP_MLKEM1024 = 514,
QUIC_TLS_GROUP_SECP256R1MLKEM768 = 4587,
QUIC_TLS_GROUP_X25519MLKEM768 = 4588,
QUIC_TLS_GROUP_SECP384R1MLKEM1024 = 4589,
} QUIC_TLS_GROUP;

typedef enum QUIC_CIPHER_SUITE {
QUIC_CIPHER_SUITE_TLS_AES_128_GCM_SHA256 = 0x1301,
QUIC_CIPHER_SUITE_TLS_AES_256_GCM_SHA384 = 0x1302,
Expand All @@ -456,6 +473,7 @@ typedef struct QUIC_HANDSHAKE_INFO {
QUIC_KEY_EXCHANGE_ALGORITHM KeyExchangeAlgorithm;
int32_t KeyExchangeStrength;
QUIC_CIPHER_SUITE CipherSuite;
QUIC_TLS_GROUP TlsGroup; // Added in v2.5
} QUIC_HANDSHAKE_INFO;

//
Expand Down
6 changes: 6 additions & 0 deletions src/inc/quic_platform.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ extern "C" {
#define CXPLAT_CONTAINING_RECORD(address, type, field) \
((type *)((uint8_t*)(address) - offsetof(type, field)))

#define CXPLAT_STRUCT_SIZE_THRU_FIELD(Type, Field) \
(offsetof(Type, Field) + sizeof(((Type*)0)->Field))

#define CXPLAT_STRUCT_HAS_FIELD(Type, Size, Field) \
(Size >= CXPLAT_STRUCT_SIZE_THRU_FIELD(Type, Field))

typedef struct CXPLAT_LIST_ENTRY {
struct CXPLAT_LIST_ENTRY* Flink;
struct CXPLAT_LIST_ENTRY* Blink;
Expand Down
23 changes: 23 additions & 0 deletions src/perf/lib/SecNetPerf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,29 @@ QuicPrintConnectionStatistics(
(unsigned long long)Stats.RecvDroppedPackets,
(unsigned long long)Stats.RecvDuplicatePackets,
(unsigned long long)Stats.RecvDecryptionFailures);
QUIC_HANDSHAKE_INFO HandshakeInfo = {0};
uint32_t HandshakeInfoSize = sizeof(HandshakeInfo);
ApiTable->GetParam(Connection, QUIC_PARAM_TLS_HANDSHAKE_INFO, &HandshakeInfoSize, &HandshakeInfo);
WriteOutput(
"Connection TLS Info:\n"
" TlsProtocolVersion 0x%x\n"
" CipherAlgorithm 0x%x\n"
" CipherStrength %u\n"
" Hash 0x%x\n"
" HashStrength %u\n"
" KeyExchangeAlgorithm %u\n"
" KeyExchangeStrength %u\n"
" CipherSuite 0x%x\n"
" TlsGroup %u\n",
HandshakeInfo.TlsProtocolVersion,
HandshakeInfo.CipherAlgorithm,
HandshakeInfo.CipherStrength,
HandshakeInfo.Hash,
HandshakeInfo.HashStrength,
HandshakeInfo.KeyExchangeAlgorithm,
HandshakeInfo.KeyExchangeStrength,
HandshakeInfo.CipherSuite,
HandshakeInfo.TlsGroup);
}

inline
Expand Down
14 changes: 13 additions & 1 deletion src/platform/tls_openssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@
#include "tls_openssl.c.clog.h"
#endif

#ifdef IS_OPENSSL_3
__owur uint16_t tls1_nid2group_id(int nid); // Not currently public API
#endif

extern EVP_CIPHER *CXPLAT_AES_256_CBC_ALG_HANDLE;

uint16_t CxPlatTlsTPHeaderSize = 0;
Expand Down Expand Up @@ -2300,7 +2304,7 @@ CxPlatTlsParamGet(
switch (Param) {

case QUIC_PARAM_TLS_HANDSHAKE_INFO: {
if (*BufferLength < sizeof(QUIC_HANDSHAKE_INFO)) {
if (*BufferLength < CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_HANDSHAKE_INFO, CipherSuite)) {
*BufferLength = sizeof(QUIC_HANDSHAKE_INFO);
Status = QUIC_STATUS_BUFFER_TOO_SMALL;
break;
Expand All @@ -2312,6 +2316,7 @@ CxPlatTlsParamGet(
}

QUIC_HANDSHAKE_INFO* HandshakeInfo = (QUIC_HANDSHAKE_INFO*)Buffer;
CxPlatZeroMemory(HandshakeInfo, *BufferLength);
HandshakeInfo->TlsProtocolVersion =
CxPlatMapVersion(
SSL_get_version(TlsContext->Ssl));
Expand All @@ -2328,6 +2333,13 @@ CxPlatTlsParamGet(
}
HandshakeInfo->CipherSuite = SSL_CIPHER_get_protocol_id(Cipher);
Status = CxPlatMapCipherSuite(HandshakeInfo);
#ifdef IS_OPENSSL_3
if (CXPLAT_STRUCT_HAS_FIELD(QUIC_HANDSHAKE_INFO, *BufferLength, TlsGroup)) {
HandshakeInfo->TlsGroup =
tls1_nid2group_id(
SSL_get_negotiated_group(TlsContext->Ssl));
}
#endif
break;
}

Expand Down
5 changes: 4 additions & 1 deletion src/platform/tls_schannel.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3058,7 +3058,7 @@ CxPlatTlsParamGet(
break;

case QUIC_PARAM_TLS_HANDSHAKE_INFO: {
if (*BufferLength < sizeof(QUIC_HANDSHAKE_INFO)) {
if (*BufferLength < CXPLAT_STRUCT_SIZE_THRU_FIELD(QUIC_HANDSHAKE_INFO, CipherSuite)) {
*BufferLength = sizeof(QUIC_HANDSHAKE_INFO);
Status = QUIC_STATUS_BUFFER_TOO_SMALL;
break;
Expand Down Expand Up @@ -3121,6 +3121,9 @@ CxPlatTlsParamGet(
HandshakeInfo->KeyExchangeAlgorithm = ConnInfo.aiExch;
HandshakeInfo->KeyExchangeStrength = ConnInfo.dwExchStrength;
HandshakeInfo->CipherSuite = CipherInfo.dwCipherSuite;
if (CXPLAT_STRUCT_HAS_FIELD(QUIC_HANDSHAKE_INFO, *BufferLength, TlsGroup)) {
HandshakeInfo->TlsGroup = CipherInfo.dwKeyType;
}
break;
}

Expand Down