1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
use crate::{
connection::{
self,
id::{ConnectionInfo, Generator as _},
limits::{ConnectionInfo as LimitsInfo, Limiter as _},
Trait as _,
},
endpoint,
recovery::congestion_controller::{self, Endpoint as _},
space::PacketSpaceManager,
};
use core::convert::TryInto;
use s2n_codec::DecoderBufferMut;
use s2n_quic_core::{
crypto::{tls, tls::Endpoint as TLSEndpoint, CryptoSuite, InitialKey},
datagram::{Endpoint, PreConnectionInfo},
event::{self, supervisor, ConnectionPublisher, IntoEvent, Subscriber as _},
inet::{datagram, DatagramInfo},
packet::initial::ProtectedInitial,
path::Handle as _,
stateless_reset::token::Generator as _,
transport::{self, parameters::ServerTransportParameters},
};
impl<Config: endpoint::Config> endpoint::Endpoint<Config> {
pub(super) fn handle_initial_packet(
&mut self,
header: &datagram::Header<Config::PathHandle>,
datagram: &DatagramInfo,
packet: ProtectedInitial,
remaining: DecoderBufferMut,
retry_token_dcid: Option<connection::InitialId>,
) -> Result<(), connection::Error> {
debug_assert!(
Config::ENDPOINT_TYPE.is_server(),
"only servers can accept new initial connections"
);
//= https://www.rfc-editor.org/rfc/rfc9000#section-14.1
//# A client MUST expand the payload of all UDP datagrams carrying
//# Initial packets to at least the smallest allowed maximum datagram
//# size of 1200 bytes
//= https://www.rfc-editor.org/rfc/rfc9000#section-14.1
//# A server MUST discard an Initial packet that is carried in a UDP
//# datagram with a payload that is smaller than the smallest allowed
//# maximum datagram size of 1200 bytes.
//= https://www.rfc-editor.org/rfc/rfc9001#section-9.3
//# First, the packet
//# containing a ClientHello MUST be padded to a minimum size.
if datagram.payload_len < 1200 {
return Err(transport::Error::PROTOCOL_VIOLATION
.with_reason("packet too small")
.into());
}
let remote_address = header.path.remote_address();
// The first connection ID to persist and use for routing incoming packets
let initial_connection_id;
// The randomly generated destination connection ID that was sent from the client
let original_destination_connection_id;
if let Some(retry_dcid) = retry_token_dcid {
original_destination_connection_id = retry_dcid;
// This initial packet was in response to a Retry, so the destination connection ID
// on the packet was generated by this server. We can use this destination connection
// ID as the initial_connection_id.
initial_connection_id = datagram.destination_connection_id;
} else {
//= https://www.rfc-editor.org/rfc/rfc9000#section-7.2
//# When an Initial packet is sent by a client that has not previously
//# received an Initial or Retry packet from the server, the client
//# populates the Destination Connection ID field with an unpredictable
//# value. This Destination Connection ID MUST be at least 8 bytes in
//# length.
original_destination_connection_id =
datagram.destination_connection_id.try_into().map_err(|_| {
transport::Error::PROTOCOL_VIOLATION
.with_reason("destination connection id too short")
})?;
// The destination connection ID on the packet was randomly generated by the client
// so we'll generate a new initial_connection_id.
let connection_info = ConnectionInfo::new(&remote_address);
initial_connection_id = self
.config
.context()
.connection_id_format
.generate(&connection_info);
}
//= https://www.rfc-editor.org/rfc/rfc9000#section-17.2
//# Endpoints that receive a version 1 long header
//# with a value larger than 20 MUST drop the packet.
let source_connection_id = packet
.source_connection_id()
.try_into()
.map_err(transport::Error::from)?;
//= https://www.rfc-editor.org/rfc/rfc9000#section-17.2.5.2
//# Changing the Destination Connection ID field also results in
//# a change to the keys used to protect the Initial packet.
let (initial_key, initial_header_key) =
<<Config::TLSEndpoint as tls::Endpoint>::Session as CryptoSuite>::InitialKey::new_server(
datagram.destination_connection_id.as_bytes(),
);
let largest_packet_number = Default::default();
let packet = packet.unprotect(&initial_header_key, largest_packet_number)?;
let packet = packet.decrypt(&initial_key)?;
// TODO handle token with stateless retry
let internal_connection_id = self.connection_id_generator.generate_id();
let initial_connection_id_expiration_time = self
.config
.context()
.connection_id_format
.lifetime()
.map(|duration| datagram.timestamp + duration);
let stateless_reset_token = self
.config
.context()
.stateless_reset_token_generator
.generate(initial_connection_id.as_bytes());
let local_id_registry = self.connection_id_mapper.create_local_id_registry(
internal_connection_id,
&initial_connection_id,
initial_connection_id_expiration_time,
stateless_reset_token,
);
let peer_id_registry = self
.connection_id_mapper
.create_server_peer_id_registry(internal_connection_id, source_connection_id);
let wakeup_handle = self
.wakeup_queue
.create_wakeup_handle(internal_connection_id);
let mut transport_parameters = ServerTransportParameters::default();
let limits = self
.config
.context()
.connection_limits
.on_connection(&LimitsInfo::new(&remote_address));
transport_parameters.load_limits(&limits);
//= https://www.rfc-editor.org/rfc/rfc9000#section-7.3
//# A server includes the Destination Connection ID field from the first
//# Initial packet it received from the client in the
//# original_destination_connection_id transport parameter; if the server
//# sent a Retry packet, this refers to the first Initial packet received
//# before sending the Retry packet. If it sends a Retry packet, a
//# server also includes the Source Connection ID field from the Retry
//# packet in the retry_source_connection_id transport parameter.
transport_parameters.original_destination_connection_id = Some(
original_destination_connection_id
.try_into()
.expect("connection ID already validated"),
);
if retry_token_dcid.is_some() {
transport_parameters.retry_source_connection_id = Some(
datagram
.destination_connection_id
.try_into()
.expect("failed to convert source connection id"),
);
}
//= https://www.rfc-editor.org/rfc/rfc9000#section-7.3
//# Each endpoint includes the value of the Source Connection ID field
//# from the first Initial packet it sent in the
//# initial_source_connection_id transport parameter
transport_parameters.initial_source_connection_id = Some(
initial_connection_id
.as_bytes()
.try_into()
.expect("connection ID already validated"),
);
//= https://www.rfc-editor.org/rfc/rfc9000#section-18.2
//# active_connection_id_limit (0x0e): This is an integer value
//# specifying the maximum number of connection IDs from the peer that
//# an endpoint is willing to store. This value includes the
//# connection ID received during the handshake, that received in the
//# preferred_address transport parameter, and those received in
//# NEW_CONNECTION_ID frames.
transport_parameters.active_connection_id_limit = s2n_quic_core::varint::VarInt::from(
connection::peer_id_registry::ACTIVE_CONNECTION_ID_LIMIT,
)
.try_into()
.unwrap();
let endpoint_context = self.config.context();
transport_parameters.max_datagram_frame_size = endpoint_context
.datagram
.max_datagram_frame_size(&PreConnectionInfo::new())
.try_into()
.expect("Failed to convert max_datagram_frame_size");
let tls_session = endpoint_context
.tls
.new_server_session(&transport_parameters);
let path_info = congestion_controller::PathInfo::new(&remote_address);
let congestion_controller = endpoint_context
.congestion_controller
.new_congestion_controller(path_info);
let quic_version = packet.version;
let meta = event::builder::ConnectionMeta {
endpoint_type: Config::ENDPOINT_TYPE,
id: internal_connection_id.into(),
timestamp: datagram.timestamp,
};
let supervisor_context = supervisor::Context::new(
self.connections.handshake_connections(),
self.connections.len(),
&remote_address,
true,
);
let mut event_context = endpoint_context.event_subscriber.create_connection_context(
&meta.clone().into_event(),
&event::builder::ConnectionInfo {}.into_event(),
);
let mut publisher = event::ConnectionPublisherSubscriber::new(
meta,
quic_version,
endpoint_context.event_subscriber,
&mut event_context,
);
let space_manager = PacketSpaceManager::new(
original_destination_connection_id,
tls_session,
initial_key,
initial_header_key,
datagram.timestamp,
&mut publisher,
);
let max_mtu = self.max_mtu;
let connection_parameters = connection::Parameters {
internal_connection_id,
local_id_registry,
peer_id_registry,
space_manager,
wakeup_handle,
//= https://www.rfc-editor.org/rfc/rfc9000#section-7.2
//# A server MUST set the Destination Connection ID it
//# uses for sending packets based on the first received Initial packet.
peer_connection_id: source_connection_id,
local_connection_id: initial_connection_id,
path_handle: header.path,
congestion_controller,
timestamp: datagram.timestamp,
quic_version,
limits,
max_mtu,
event_context,
supervisor_context: &supervisor_context,
event_subscriber: endpoint_context.event_subscriber,
datagram_endpoint: endpoint_context.datagram,
};
let mut connection = <Config as endpoint::Config>::Connection::new(connection_parameters)?;
let endpoint_context = self.config.context();
let handle_first_packet =
move |connection: &mut <Config as endpoint::Config>::Connection| {
let path_id = connection.on_datagram_received(
&header.path,
datagram,
endpoint_context.congestion_controller,
endpoint_context.path_migration,
max_mtu,
endpoint_context.event_subscriber,
);
let path_id = path_id.map_err(|err| {
connection.with_event_publisher(
datagram.timestamp,
None,
endpoint_context.event_subscriber,
|publisher, _path| {
publisher.on_datagram_dropped(event::builder::DatagramDropped {
len: datagram.payload_len as u16,
reason: err,
});
},
);
debug_assert!(
false,
"on_datagram_received should not fail for a newly created connection"
);
connection::Error::unspecified()
})?;
connection
.handle_cleartext_initial_packet(
datagram,
path_id,
packet,
endpoint_context.random_generator,
endpoint_context.event_subscriber,
endpoint_context.packet_interceptor,
endpoint_context.datagram,
)
.map_err(|err| {
use connection::ProcessingError;
match err {
ProcessingError::CryptoError(err) => err.into(),
ProcessingError::ConnectionError(err) => err,
// this is the first packet this connection has received
// so getting this error would be incorrect
ProcessingError::DuplicatePacket => {
debug_assert!(false, "got duplicate packet error on first packet");
transport::Error::INTERNAL_ERROR.into()
}
// this error is only raised by the client
ProcessingError::NonEmptyRetryToken => {
debug_assert!(false, "got non empty retry token error on server");
transport::Error::INTERNAL_ERROR.into()
}
// this error is only emitted when processing a Retry packet
ProcessingError::RetryScidEqualsDcid => {
debug_assert!(
false,
"got a Retry packet error while processing an Initial packet"
);
transport::Error::INTERNAL_ERROR.into()
}
}
})?;
connection.handle_remaining_packets(
&header.path,
datagram,
path_id,
endpoint_context.connection_id_format,
remaining,
endpoint_context.random_generator,
endpoint_context.event_subscriber,
endpoint_context.packet_interceptor,
endpoint_context.datagram,
)?;
Ok(())
};
if let Err(error) = handle_first_packet(&mut connection) {
let endpoint_context = self.config.context();
connection.with_event_publisher(
datagram.timestamp,
None,
endpoint_context.event_subscriber,
|publisher, _path| {
use s2n_quic_core::event::builder::ConnectionClosed;
publisher.on_connection_closed(ConnectionClosed { error });
},
);
return Err(error);
}
//= https://www.rfc-editor.org/rfc/rfc9001#section-4.3
//= type=TODO
//= tracking-issue=299
//# If the
//# ClientHello spans multiple Initial packets, such servers would need
//# to buffer the first received fragments, which could consume excessive
//# resources if the client's address has not yet been validated. To
//# avoid this, servers MAY use the Retry feature (see Section 8.1 of
//# [QUIC-TRANSPORT]) to only buffer partial ClientHello messages from
//# clients with a validated address.
let result = self
.connection_id_mapper
.try_insert_initial_id(original_destination_connection_id, internal_connection_id);
debug_assert!(
result.is_ok(),
"Initial ID {original_destination_connection_id:?} was already in the map"
);
// Only persist the connection if everything is good.
// Otherwise the connection will automatically get dropped. This
// will also clean up all state which was already allocated for
// the connection
self.connections
.insert_server_connection(connection, internal_connection_id);
Ok(())
}
}