From 9249773f0dd29f45f7ed4f1a5cc76335dcdcd618 Mon Sep 17 00:00:00 2001 From: "QUIC Dev[bot]" Date: Thu, 7 Mar 2024 15:20:09 +0000 Subject: [PATCH] Update DocFx after documentation changes. --- msquicdocs/docs/api/QUIC_NEW_CONNECTION_INFO.html | 12 ++++++++++++ msquicdocs/index.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/msquicdocs/docs/api/QUIC_NEW_CONNECTION_INFO.html b/msquicdocs/docs/api/QUIC_NEW_CONNECTION_INFO.html index 099d8a783..51d0ab6e0 100644 --- a/msquicdocs/docs/api/QUIC_NEW_CONNECTION_INFO.html +++ b/msquicdocs/docs/api/QUIC_NEW_CONNECTION_INFO.html @@ -132,6 +132,18 @@ typedef struct QUIC_NEW_CONNECTION_INFO {

This pointer indicates the negotiated ALPN between server and client.

ServerName

This pointer indicates the server name (SNI) of the new incoming connection.

+
+

Note: this buffer comes directly from the TLS ClientHello, and its format is governed by TLS. +From RFC 6066:

+
+

"HostName" contains the fully qualified DNS hostname of the server, +as understood by the client. The hostname is represented as a byte +string using ASCII encoding without a trailing dot. This allows the +support of internationalized domain names through the use of A-labels +defined in [RFC5890]. DNS hostnames are case-insensitive. The +algorithm to compare hostnames is described in [RFC5890, Section 2.3.2.4].

+
+

See Also

QUIC_LISTENER_CALLBACK
QUIC_LISTENER_EVENT

diff --git a/msquicdocs/index.json b/msquicdocs/index.json index 304a41f39..ea7b15d0b 100644 --- a/msquicdocs/index.json +++ b/msquicdocs/index.json @@ -247,7 +247,7 @@ "docs/api/QUIC_NEW_CONNECTION_INFO.html": { "href": "docs/api/QUIC_NEW_CONNECTION_INFO.html", "title": "QUIC_NEW_CONNECTION_INFO structure", - "keywords": "QUIC_NEW_CONNECTION_INFO structure All available information for new incoming QUIC connection. // // All the available information describing a new incoming connection. // typedef struct QUIC_NEW_CONNECTION_INFO { uint32_t QuicVersion; const QUIC_ADDR* LocalAddress; const QUIC_ADDR* RemoteAddress; uint32_t CryptoBufferLength; uint16_t ClientAlpnListLength; uint16_t ServerNameLength; uint8_t NegotiatedAlpnLength; _Field_size_bytes_(CryptoBufferLength) const uint8_t* CryptoBuffer; _Field_size_bytes_(ClientAlpnListLength) const uint8_t* ClientAlpnList; _Field_size_bytes_(NegotiatedAlpnLength) const uint8_t* NegotiatedAlpn; _Field_size_bytes_opt_(ServerNameLength) const char* ServerName; } QUIC_NEW_CONNECTION_INFO; Parameters QuicVersion The QUIC version negotiated for the new incoming connection. LocalAddress This field indicates the local address of the new incoming connection. RemoteAddress This field indicates the remote address of the new incoming connection. CryptoBufferLength This field indicates the length of the crypto buffer. ClientAlpnListLength This field indicates the total bytes of the client ALPN list. ServerNameLength This field indicates the length of the server name (SNI). NegotiatedAlpnLength This field indicates the length of the negotiated ALPN. CryptoBuffer This pointer indicates the crypto buffer for the new incoming connection. ClientAlpnList This pointer indicates the sent ALPN list from the client via the new incoming connection. NegotiatedAlpn This pointer indicates the negotiated ALPN between server and client. ServerName This pointer indicates the server name (SNI) of the new incoming connection. See Also QUIC_LISTENER_CALLBACK QUIC_LISTENER_EVENT" + "keywords": "QUIC_NEW_CONNECTION_INFO structure All available information for new incoming QUIC connection. // // All the available information describing a new incoming connection. // typedef struct QUIC_NEW_CONNECTION_INFO { uint32_t QuicVersion; const QUIC_ADDR* LocalAddress; const QUIC_ADDR* RemoteAddress; uint32_t CryptoBufferLength; uint16_t ClientAlpnListLength; uint16_t ServerNameLength; uint8_t NegotiatedAlpnLength; _Field_size_bytes_(CryptoBufferLength) const uint8_t* CryptoBuffer; _Field_size_bytes_(ClientAlpnListLength) const uint8_t* ClientAlpnList; _Field_size_bytes_(NegotiatedAlpnLength) const uint8_t* NegotiatedAlpn; _Field_size_bytes_opt_(ServerNameLength) const char* ServerName; } QUIC_NEW_CONNECTION_INFO; Parameters QuicVersion The QUIC version negotiated for the new incoming connection. LocalAddress This field indicates the local address of the new incoming connection. RemoteAddress This field indicates the remote address of the new incoming connection. CryptoBufferLength This field indicates the length of the crypto buffer. ClientAlpnListLength This field indicates the total bytes of the client ALPN list. ServerNameLength This field indicates the length of the server name (SNI). NegotiatedAlpnLength This field indicates the length of the negotiated ALPN. CryptoBuffer This pointer indicates the crypto buffer for the new incoming connection. ClientAlpnList This pointer indicates the sent ALPN list from the client via the new incoming connection. NegotiatedAlpn This pointer indicates the negotiated ALPN between server and client. ServerName This pointer indicates the server name (SNI) of the new incoming connection. Note: this buffer comes directly from the TLS ClientHello, and its format is governed by TLS. From RFC 6066: \"HostName\" contains the fully qualified DNS hostname of the server, as understood by the client. The hostname is represented as a byte string using ASCII encoding without a trailing dot. This allows the support of internationalized domain names through the use of A-labels defined in [RFC5890]. DNS hostnames are case-insensitive. The algorithm to compare hostnames is described in [RFC5890, Section 2.3.2.4]. See Also QUIC_LISTENER_CALLBACK QUIC_LISTENER_EVENT" }, "docs/api/QUIC_REGISTRATION_CONFIG.html": { "href": "docs/api/QUIC_REGISTRATION_CONFIG.html",