#![allow(clippy::upper_case_acronyms)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#[macro_use]
extern crate log;
use octets::BufferTooShortError;
#[cfg(feature = "qlog")]
use qlog::events::connectivity::ConnectivityEventType;
#[cfg(feature = "qlog")]
use qlog::events::connectivity::TransportOwner;
#[cfg(feature = "qlog")]
use qlog::events::quic::RecoveryEventType;
#[cfg(feature = "qlog")]
use qlog::events::quic::TransportEventType;
#[cfg(feature = "qlog")]
use qlog::events::DataRecipient;
#[cfg(feature = "qlog")]
use qlog::events::Event;
#[cfg(feature = "qlog")]
use qlog::events::EventData;
#[cfg(feature = "qlog")]
use qlog::events::EventImportance;
#[cfg(feature = "qlog")]
use qlog::events::EventType;
#[cfg(feature = "qlog")]
use qlog::events::RawInfo;
use recovery::OnLossDetectionTimeoutOutcome;
use stream::StreamPriorityKey;
use std::cmp;
use std::convert::TryInto;
use std::time;
use std::sync::Arc;
use std::net::SocketAddr;
use std::str::FromStr;
use std::collections::HashSet;
use std::collections::VecDeque;
use std::time::Duration;
use range_buf::DefaultBufFactory;
use smallvec::SmallVec;
use crate::recovery::OnAckReceivedOutcome;
use crate::recovery::ReleaseDecision;
pub const PROTOCOL_VERSION: u32 = PROTOCOL_VERSION_V1;
const PROTOCOL_VERSION_V1: u32 = 0x0000_0001;
pub const MAX_CONN_ID_LEN: usize = crate::packet::MAX_CID_LEN as usize;
pub const MIN_CLIENT_INITIAL_LEN: usize = 1200;
#[cfg(not(feature = "fuzzing"))]
const PAYLOAD_MIN_LEN: usize = 4;
#[cfg(feature = "fuzzing")]
const PAYLOAD_MIN_LEN: usize = 20;
const MIN_PROBING_SIZE: usize = 25;
const MAX_AMPLIFICATION_FACTOR: usize = 3;
const MAX_ACK_RANGES: usize = 68;
const MAX_STREAM_ID: u64 = 1 << 60;
const MAX_SEND_UDP_PAYLOAD_SIZE: usize = 1200;
const DEFAULT_MAX_DGRAM_QUEUE_LEN: usize = 0;
const DEFAULT_MAX_PATH_CHALLENGE_RX_QUEUE_LEN: usize = 3;
const MAX_DGRAM_FRAME_SIZE: u64 = 65536;
const PAYLOAD_LENGTH_LEN: usize = 2;
const MAX_UNDECRYPTABLE_PACKETS: usize = 10;
const RESERVED_VERSION_MASK: u32 = 0xfafafafa;
const DEFAULT_CONNECTION_WINDOW: u64 = 48 * 1024;
const MAX_CONNECTION_WINDOW: u64 = 24 * 1024 * 1024;
const CONNECTION_WINDOW_FACTOR: f64 = 1.5;
const MAX_PROBING_TIMEOUTS: usize = 3;
const DEFAULT_INITIAL_CONGESTION_WINDOW_PACKETS: usize = 10;
const MAX_CRYPTO_STREAM_OFFSET: u64 = 1 << 16;
const TX_CAP_FACTOR: f64 = 1.0;
pub type Result<T> = std::result::Result<T, Error>;
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Error {
Done,
BufferTooShort,
UnknownVersion,
InvalidFrame,
InvalidPacket,
InvalidState,
InvalidStreamState(u64),
InvalidTransportParam,
CryptoFail,
TlsFail,
FlowControl,
StreamLimit,
StreamStopped(u64),
StreamReset(u64),
FinalSize,
CongestionControl,
IdLimit,
OutOfIdentifiers,
KeyUpdate,
CryptoBufferExceeded,
InvalidAckRange,
OptimisticAckDetected,
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum WireErrorCode {
NoError = 0x0,
InternalError = 0x1,
ConnectionRefused = 0x2,
FlowControlError = 0x3,
StreamLimitError = 0x4,
StreamStateError = 0x5,
FinalSizeError = 0x6,
FrameEncodingError = 0x7,
TransportParameterError = 0x8,
ConnectionIdLimitError = 0x9,
ProtocolViolation = 0xa,
InvalidToken = 0xb,
ApplicationError = 0xc,
CryptoBufferExceeded = 0xd,
KeyUpdateError = 0xe,
AeadLimitReached = 0xf,
NoViablePath = 0x10,
}
impl Error {
fn to_wire(self) -> u64 {
match self {
Error::Done => WireErrorCode::NoError as u64,
Error::InvalidFrame => WireErrorCode::FrameEncodingError as u64,
Error::InvalidStreamState(..) =>
WireErrorCode::StreamStateError as u64,
Error::InvalidTransportParam =>
WireErrorCode::TransportParameterError as u64,
Error::FlowControl => WireErrorCode::FlowControlError as u64,
Error::StreamLimit => WireErrorCode::StreamLimitError as u64,
Error::IdLimit => WireErrorCode::ConnectionIdLimitError as u64,
Error::FinalSize => WireErrorCode::FinalSizeError as u64,
Error::CryptoBufferExceeded =>
WireErrorCode::CryptoBufferExceeded as u64,
Error::KeyUpdate => WireErrorCode::KeyUpdateError as u64,
_ => WireErrorCode::ProtocolViolation as u64,
}
}
#[cfg(feature = "ffi")]
fn to_c(self) -> libc::ssize_t {
match self {
Error::Done => -1,
Error::BufferTooShort => -2,
Error::UnknownVersion => -3,
Error::InvalidFrame => -4,
Error::InvalidPacket => -5,
Error::InvalidState => -6,
Error::InvalidStreamState(_) => -7,
Error::InvalidTransportParam => -8,
Error::CryptoFail => -9,
Error::TlsFail => -10,
Error::FlowControl => -11,
Error::StreamLimit => -12,
Error::FinalSize => -13,
Error::CongestionControl => -14,
Error::StreamStopped { .. } => -15,
Error::StreamReset { .. } => -16,
Error::IdLimit => -17,
Error::OutOfIdentifiers => -18,
Error::KeyUpdate => -19,
Error::CryptoBufferExceeded => -20,
Error::InvalidAckRange => -21,
Error::OptimisticAckDetected => -22,
}
}
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{self:?}")
}
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
impl std::convert::From<octets::BufferTooShortError> for Error {
fn from(_err: octets::BufferTooShortError) -> Self {
Error::BufferTooShort
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct RecvInfo {
pub from: SocketAddr,
pub to: SocketAddr,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SendInfo {
pub from: SocketAddr,
pub to: SocketAddr,
pub at: time::Instant,
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ConnectionError {
pub is_app: bool,
pub error_code: u64,
pub reason: Vec<u8>,
}
#[repr(C)]
#[derive(PartialEq, Eq)]
pub enum Shutdown {
Read = 0,
Write = 1,
}
#[repr(C)]
#[cfg(feature = "qlog")]
#[cfg_attr(docsrs, doc(cfg(feature = "qlog")))]
pub enum QlogLevel {
Core = 0,
Base = 1,
Extra = 2,
}
pub struct Config {
local_transport_params: TransportParams,
version: u32,
tls_ctx: tls::Context,
application_protos: Vec<Vec<u8>>,
grease: bool,
cc_algorithm: CongestionControlAlgorithm,
custom_bbr_params: Option<BbrParams>,
initial_congestion_window_packets: usize,
pmtud: bool,
hystart: bool,
pacing: bool,
max_pacing_rate: Option<u64>,
tx_cap_factor: f64,
dgram_recv_max_queue_len: usize,
dgram_send_max_queue_len: usize,
path_challenge_recv_max_queue_len: usize,
max_send_udp_payload_size: usize,
max_connection_window: u64,
max_stream_window: u64,
max_amplification_factor: usize,
disable_dcid_reuse: bool,
track_unknown_transport_params: Option<usize>,
}
fn is_reserved_version(version: u32) -> bool {
version & RESERVED_VERSION_MASK == version
}
impl Config {
pub fn new(version: u32) -> Result<Config> {
Self::with_tls_ctx(version, tls::Context::new()?)
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn with_boring_ssl_ctx_builder(
version: u32, tls_ctx_builder: boring::ssl::SslContextBuilder,
) -> Result<Config> {
Self::with_tls_ctx(version, tls::Context::from_boring(tls_ctx_builder))
}
fn with_tls_ctx(version: u32, tls_ctx: tls::Context) -> Result<Config> {
if !is_reserved_version(version) && !version_is_supported(version) {
return Err(Error::UnknownVersion);
}
Ok(Config {
local_transport_params: TransportParams::default(),
version,
tls_ctx,
application_protos: Vec::new(),
grease: true,
cc_algorithm: CongestionControlAlgorithm::CUBIC,
custom_bbr_params: None,
initial_congestion_window_packets:
DEFAULT_INITIAL_CONGESTION_WINDOW_PACKETS,
pmtud: false,
hystart: true,
pacing: true,
max_pacing_rate: None,
tx_cap_factor: TX_CAP_FACTOR,
dgram_recv_max_queue_len: DEFAULT_MAX_DGRAM_QUEUE_LEN,
dgram_send_max_queue_len: DEFAULT_MAX_DGRAM_QUEUE_LEN,
path_challenge_recv_max_queue_len:
DEFAULT_MAX_PATH_CHALLENGE_RX_QUEUE_LEN,
max_send_udp_payload_size: MAX_SEND_UDP_PAYLOAD_SIZE,
max_connection_window: MAX_CONNECTION_WINDOW,
max_stream_window: stream::MAX_STREAM_WINDOW,
max_amplification_factor: MAX_AMPLIFICATION_FACTOR,
disable_dcid_reuse: false,
track_unknown_transport_params: None,
})
}
pub fn load_cert_chain_from_pem_file(&mut self, file: &str) -> Result<()> {
self.tls_ctx.use_certificate_chain_file(file)
}
pub fn load_priv_key_from_pem_file(&mut self, file: &str) -> Result<()> {
self.tls_ctx.use_privkey_file(file)
}
pub fn load_verify_locations_from_file(&mut self, file: &str) -> Result<()> {
self.tls_ctx.load_verify_locations_from_file(file)
}
pub fn load_verify_locations_from_directory(
&mut self, dir: &str,
) -> Result<()> {
self.tls_ctx.load_verify_locations_from_directory(dir)
}
pub fn verify_peer(&mut self, verify: bool) {
self.tls_ctx.set_verify(verify);
}
pub fn discover_pmtu(&mut self, discover: bool) {
self.pmtud = discover;
}
pub fn grease(&mut self, grease: bool) {
self.grease = grease;
}
pub fn log_keys(&mut self) {
self.tls_ctx.enable_keylog();
}
pub fn set_ticket_key(&mut self, key: &[u8]) -> Result<()> {
self.tls_ctx.set_ticket_key(key)
}
pub fn enable_early_data(&mut self) {
self.tls_ctx.set_early_data_enabled(true);
}
pub fn set_application_protos(
&mut self, protos_list: &[&[u8]],
) -> Result<()> {
self.application_protos =
protos_list.iter().map(|s| s.to_vec()).collect();
self.tls_ctx.set_alpn(protos_list)
}
pub fn set_application_protos_wire_format(
&mut self, protos: &[u8],
) -> Result<()> {
let mut b = octets::Octets::with_slice(protos);
let mut protos_list = Vec::new();
while let Ok(proto) = b.get_bytes_with_u8_length() {
protos_list.push(proto.buf());
}
self.set_application_protos(&protos_list)
}
pub fn set_max_amplification_factor(&mut self, v: usize) {
self.max_amplification_factor = v;
}
pub fn set_send_capacity_factor(&mut self, v: f64) {
self.tx_cap_factor = v;
}
pub fn set_max_idle_timeout(&mut self, v: u64) {
self.local_transport_params.max_idle_timeout = v;
}
pub fn set_max_recv_udp_payload_size(&mut self, v: usize) {
self.local_transport_params.max_udp_payload_size = v as u64;
}
pub fn set_max_send_udp_payload_size(&mut self, v: usize) {
self.max_send_udp_payload_size = cmp::max(v, MAX_SEND_UDP_PAYLOAD_SIZE);
}
pub fn set_initial_max_data(&mut self, v: u64) {
self.local_transport_params.initial_max_data = v;
}
pub fn set_initial_max_stream_data_bidi_local(&mut self, v: u64) {
self.local_transport_params
.initial_max_stream_data_bidi_local = v;
}
pub fn set_initial_max_stream_data_bidi_remote(&mut self, v: u64) {
self.local_transport_params
.initial_max_stream_data_bidi_remote = v;
}
pub fn set_initial_max_stream_data_uni(&mut self, v: u64) {
self.local_transport_params.initial_max_stream_data_uni = v;
}
pub fn set_initial_max_streams_bidi(&mut self, v: u64) {
self.local_transport_params.initial_max_streams_bidi = v;
}
pub fn set_initial_max_streams_uni(&mut self, v: u64) {
self.local_transport_params.initial_max_streams_uni = v;
}
pub fn set_ack_delay_exponent(&mut self, v: u64) {
self.local_transport_params.ack_delay_exponent = v;
}
pub fn set_max_ack_delay(&mut self, v: u64) {
self.local_transport_params.max_ack_delay = v;
}
pub fn set_active_connection_id_limit(&mut self, v: u64) {
if v >= 2 {
self.local_transport_params.active_conn_id_limit = v;
}
}
pub fn set_disable_active_migration(&mut self, v: bool) {
self.local_transport_params.disable_active_migration = v;
}
pub fn set_cc_algorithm(&mut self, algo: CongestionControlAlgorithm) {
self.cc_algorithm = algo;
}
#[cfg(feature = "internal")]
#[doc(hidden)]
pub fn set_custom_bbr_params(&mut self, custom_bbr_settings: BbrParams) {
self.custom_bbr_params = Some(custom_bbr_settings);
}
pub fn set_cc_algorithm_name(&mut self, name: &str) -> Result<()> {
self.cc_algorithm = CongestionControlAlgorithm::from_str(name)?;
Ok(())
}
pub fn set_initial_congestion_window_packets(&mut self, packets: usize) {
self.initial_congestion_window_packets = packets;
}
pub fn enable_hystart(&mut self, v: bool) {
self.hystart = v;
}
pub fn enable_pacing(&mut self, v: bool) {
self.pacing = v;
}
pub fn set_max_pacing_rate(&mut self, v: u64) {
self.max_pacing_rate = Some(v);
}
pub fn enable_dgram(
&mut self, enabled: bool, recv_queue_len: usize, send_queue_len: usize,
) {
self.local_transport_params.max_datagram_frame_size = if enabled {
Some(MAX_DGRAM_FRAME_SIZE)
} else {
None
};
self.dgram_recv_max_queue_len = recv_queue_len;
self.dgram_send_max_queue_len = send_queue_len;
}
pub fn set_path_challenge_recv_max_queue_len(&mut self, queue_len: usize) {
self.path_challenge_recv_max_queue_len = queue_len;
}
pub fn set_max_connection_window(&mut self, v: u64) {
self.max_connection_window = v;
}
pub fn set_max_stream_window(&mut self, v: u64) {
self.max_stream_window = v;
}
pub fn set_stateless_reset_token(&mut self, v: Option<u128>) {
self.local_transport_params.stateless_reset_token = v;
}
pub fn set_disable_dcid_reuse(&mut self, v: bool) {
self.disable_dcid_reuse = v;
}
pub fn enable_track_unknown_transport_parameters(&mut self, size: usize) {
self.track_unknown_transport_params = Some(size);
}
}
pub struct Connection<F = DefaultBufFactory>
where
F: BufFactory,
{
version: u32,
ids: cid::ConnectionIdentifiers,
trace_id: String,
pkt_num_spaces: [packet::PktNumSpace; packet::Epoch::count()],
crypto_ctx: [packet::CryptoContext; packet::Epoch::count()],
next_pkt_num: u64,
pkt_num_manager: packet::PktNumManager,
peer_transport_params: TransportParams,
peer_transport_params_track_unknown: Option<usize>,
local_transport_params: TransportParams,
handshake: tls::Handshake,
session: Option<Vec<u8>>,
recovery_config: recovery::RecoveryConfig,
paths: path::PathMap,
path_challenge_recv_max_queue_len: usize,
path_challenge_rx_count: u64,
application_protos: Vec<Vec<u8>>,
recv_count: usize,
sent_count: usize,
lost_count: usize,
spurious_lost_count: usize,
retrans_count: usize,
dgram_sent_count: usize,
dgram_recv_count: usize,
rx_data: u64,
flow_control: flowcontrol::FlowControl,
almost_full: bool,
tx_cap: usize,
tx_cap_factor: f64,
tx_buffered: usize,
tx_data: u64,
max_tx_data: u64,
last_tx_data: u64,
stream_retrans_bytes: u64,
sent_bytes: u64,
recv_bytes: u64,
acked_bytes: u64,
lost_bytes: u64,
streams: stream::StreamMap<F>,
odcid: Option<ConnectionId<'static>>,
rscid: Option<ConnectionId<'static>>,
token: Option<Vec<u8>>,
local_error: Option<ConnectionError>,
peer_error: Option<ConnectionError>,
blocked_limit: Option<u64>,
idle_timer: Option<time::Instant>,
draining_timer: Option<time::Instant>,
undecryptable_pkts: VecDeque<(Vec<u8>, RecvInfo)>,
alpn: Vec<u8>,
is_server: bool,
derived_initial_secrets: bool,
did_version_negotiation: bool,
did_retry: bool,
got_peer_conn_id: bool,
peer_verified_initial_address: bool,
parsed_peer_transport_params: bool,
handshake_completed: bool,
handshake_done_sent: bool,
handshake_done_acked: bool,
handshake_confirmed: bool,
key_phase: bool,
ack_eliciting_sent: bool,
closed: bool,
timed_out: bool,
grease: bool,
keylog: Option<Box<dyn std::io::Write + Send + Sync>>,
#[cfg(feature = "qlog")]
qlog: QlogInfo,
dgram_recv_queue: dgram::DatagramQueue,
dgram_send_queue: dgram::DatagramQueue,
emit_dgram: bool,
disable_dcid_reuse: bool,
reset_stream_local_count: u64,
stopped_stream_local_count: u64,
reset_stream_remote_count: u64,
stopped_stream_remote_count: u64,
max_amplification_factor: usize,
}
#[inline]
pub fn accept(
scid: &ConnectionId, odcid: Option<&ConnectionId>, local: SocketAddr,
peer: SocketAddr, config: &mut Config,
) -> Result<Connection> {
let conn = Connection::new(scid, odcid, local, peer, config, true)?;
Ok(conn)
}
#[inline]
pub fn accept_with_buf_factory<F: BufFactory>(
scid: &ConnectionId, odcid: Option<&ConnectionId>, local: SocketAddr,
peer: SocketAddr, config: &mut Config,
) -> Result<Connection<F>> {
let conn = Connection::new(scid, odcid, local, peer, config, true)?;
Ok(conn)
}
#[inline]
pub fn connect(
server_name: Option<&str>, scid: &ConnectionId, local: SocketAddr,
peer: SocketAddr, config: &mut Config,
) -> Result<Connection> {
let mut conn = Connection::new(scid, None, local, peer, config, false)?;
if let Some(server_name) = server_name {
conn.handshake.set_host_name(server_name)?;
}
Ok(conn)
}
#[inline]
pub fn connect_with_buffer_factory<F: BufFactory>(
server_name: Option<&str>, scid: &ConnectionId, local: SocketAddr,
peer: SocketAddr, config: &mut Config,
) -> Result<Connection<F>> {
let mut conn = Connection::new(scid, None, local, peer, config, false)?;
if let Some(server_name) = server_name {
conn.handshake.set_host_name(server_name)?;
}
Ok(conn)
}
#[inline]
pub fn negotiate_version(
scid: &ConnectionId, dcid: &ConnectionId, out: &mut [u8],
) -> Result<usize> {
packet::negotiate_version(scid, dcid, out)
}
#[inline]
pub fn retry(
scid: &ConnectionId, dcid: &ConnectionId, new_scid: &ConnectionId,
token: &[u8], version: u32, out: &mut [u8],
) -> Result<usize> {
packet::retry(scid, dcid, new_scid, token, version, out)
}
#[inline]
pub fn version_is_supported(version: u32) -> bool {
matches!(version, PROTOCOL_VERSION_V1)
}
macro_rules! push_frame_to_pkt {
($out:expr, $frames:expr, $frame:expr, $left:expr) => {{
if $frame.wire_len() <= $left {
$left -= $frame.wire_len();
$frame.to_bytes(&mut $out)?;
$frames.push($frame);
true
} else {
false
}
}};
}
macro_rules! qlog_with_type {
($ty:expr, $qlog:expr, $qlog_streamer_ref:ident, $body:block) => {{
#[cfg(feature = "qlog")]
{
if EventImportance::from($ty).is_contained_in(&$qlog.level) {
if let Some($qlog_streamer_ref) = &mut $qlog.streamer {
$body
}
}
}
}};
}
#[cfg(feature = "qlog")]
const QLOG_PARAMS_SET: EventType =
EventType::TransportEventType(TransportEventType::ParametersSet);
#[cfg(feature = "qlog")]
const QLOG_PACKET_RX: EventType =
EventType::TransportEventType(TransportEventType::PacketReceived);
#[cfg(feature = "qlog")]
const QLOG_PACKET_TX: EventType =
EventType::TransportEventType(TransportEventType::PacketSent);
#[cfg(feature = "qlog")]
const QLOG_DATA_MV: EventType =
EventType::TransportEventType(TransportEventType::DataMoved);
#[cfg(feature = "qlog")]
const QLOG_METRICS: EventType =
EventType::RecoveryEventType(RecoveryEventType::MetricsUpdated);
#[cfg(feature = "qlog")]
const QLOG_CONNECTION_CLOSED: EventType =
EventType::ConnectivityEventType(ConnectivityEventType::ConnectionClosed);
#[cfg(feature = "qlog")]
struct QlogInfo {
streamer: Option<qlog::streamer::QlogStreamer>,
logged_peer_params: bool,
level: EventImportance,
}
#[cfg(feature = "qlog")]
impl Default for QlogInfo {
fn default() -> Self {
QlogInfo {
streamer: None,
logged_peer_params: false,
level: EventImportance::Base,
}
}
}
impl<F: BufFactory> Connection<F> {
fn new(
scid: &ConnectionId, odcid: Option<&ConnectionId>, local: SocketAddr,
peer: SocketAddr, config: &mut Config, is_server: bool,
) -> Result<Connection<F>> {
let tls = config.tls_ctx.new_handshake()?;
Connection::with_tls(scid, odcid, local, peer, config, tls, is_server)
}
fn with_tls(
scid: &ConnectionId, odcid: Option<&ConnectionId>, local: SocketAddr,
peer: SocketAddr, config: &Config, tls: tls::Handshake, is_server: bool,
) -> Result<Connection<F>> {
let max_rx_data = config.local_transport_params.initial_max_data;
let scid_as_hex: Vec<String> =
scid.iter().map(|b| format!("{b:02x}")).collect();
let reset_token = if is_server {
config.local_transport_params.stateless_reset_token
} else {
None
};
let recovery_config = recovery::RecoveryConfig::from_config(config);
let mut path = path::Path::new(
local,
peer,
&recovery_config,
config.path_challenge_recv_max_queue_len,
MIN_CLIENT_INITIAL_LEN,
true,
);
path.verified_peer_address = odcid.is_some();
path.peer_verified_local_address = is_server;
let paths = path::PathMap::new(
path,
config.local_transport_params.active_conn_id_limit as usize,
is_server,
config.pmtud,
config.max_send_udp_payload_size,
);
let active_path_id = paths.get_active_path_id()?;
let ids = cid::ConnectionIdentifiers::new(
config.local_transport_params.active_conn_id_limit as usize,
scid,
active_path_id,
reset_token,
);
let mut conn = Connection {
version: config.version,
ids,
trace_id: scid_as_hex.join(""),
pkt_num_spaces: [
packet::PktNumSpace::new(),
packet::PktNumSpace::new(),
packet::PktNumSpace::new(),
],
crypto_ctx: [
packet::CryptoContext::new(),
packet::CryptoContext::new(),
packet::CryptoContext::new(),
],
next_pkt_num: 0,
pkt_num_manager: packet::PktNumManager::new(),
peer_transport_params: TransportParams::default(),
peer_transport_params_track_unknown: config
.track_unknown_transport_params,
local_transport_params: config.local_transport_params.clone(),
handshake: tls,
session: None,
recovery_config,
paths,
path_challenge_recv_max_queue_len: config
.path_challenge_recv_max_queue_len,
path_challenge_rx_count: 0,
application_protos: config.application_protos.clone(),
recv_count: 0,
sent_count: 0,
lost_count: 0,
spurious_lost_count: 0,
retrans_count: 0,
dgram_sent_count: 0,
dgram_recv_count: 0,
sent_bytes: 0,
recv_bytes: 0,
acked_bytes: 0,
lost_bytes: 0,
rx_data: 0,
flow_control: flowcontrol::FlowControl::new(
max_rx_data,
cmp::min(max_rx_data / 2 * 3, DEFAULT_CONNECTION_WINDOW),
config.max_connection_window,
),
almost_full: false,
tx_cap: 0,
tx_cap_factor: config.tx_cap_factor,
tx_buffered: 0,
tx_data: 0,
max_tx_data: 0,
last_tx_data: 0,
stream_retrans_bytes: 0,
streams: stream::StreamMap::new(
config.local_transport_params.initial_max_streams_bidi,
config.local_transport_params.initial_max_streams_uni,
config.max_stream_window,
),
odcid: None,
rscid: None,
token: None,
local_error: None,
peer_error: None,
blocked_limit: None,
idle_timer: None,
draining_timer: None,
undecryptable_pkts: VecDeque::new(),
alpn: Vec::new(),
is_server,
derived_initial_secrets: false,
did_version_negotiation: false,
did_retry: false,
got_peer_conn_id: false,
peer_verified_initial_address: is_server,
parsed_peer_transport_params: false,
handshake_completed: false,
handshake_done_sent: false,
handshake_done_acked: false,
handshake_confirmed: false,
key_phase: false,
ack_eliciting_sent: false,
closed: false,
timed_out: false,
grease: config.grease,
keylog: None,
#[cfg(feature = "qlog")]
qlog: Default::default(),
dgram_recv_queue: dgram::DatagramQueue::new(
config.dgram_recv_max_queue_len,
),
dgram_send_queue: dgram::DatagramQueue::new(
config.dgram_send_max_queue_len,
),
emit_dgram: true,
disable_dcid_reuse: config.disable_dcid_reuse,
reset_stream_local_count: 0,
stopped_stream_local_count: 0,
reset_stream_remote_count: 0,
stopped_stream_remote_count: 0,
max_amplification_factor: config.max_amplification_factor,
};
if let Some(odcid) = odcid {
conn.local_transport_params
.original_destination_connection_id = Some(odcid.to_vec().into());
conn.local_transport_params.retry_source_connection_id =
Some(conn.ids.get_scid(0)?.cid.to_vec().into());
conn.did_retry = true;
}
conn.local_transport_params.initial_source_connection_id =
Some(conn.ids.get_scid(0)?.cid.to_vec().into());
conn.handshake.init(is_server)?;
conn.handshake
.use_legacy_codepoint(config.version != PROTOCOL_VERSION_V1);
conn.encode_transport_params()?;
if !is_server {
let mut dcid = [0; 16];
rand::rand_bytes(&mut dcid[..]);
let (aead_open, aead_seal) = crypto::derive_initial_key_material(
&dcid,
conn.version,
conn.is_server,
false,
)?;
let reset_token = conn.peer_transport_params.stateless_reset_token;
conn.set_initial_dcid(
dcid.to_vec().into(),
reset_token,
active_path_id,
)?;
conn.crypto_ctx[packet::Epoch::Initial].crypto_open = Some(aead_open);
conn.crypto_ctx[packet::Epoch::Initial].crypto_seal = Some(aead_seal);
conn.derived_initial_secrets = true;
}
Ok(conn)
}
#[inline]
pub fn set_keylog(&mut self, writer: Box<dyn std::io::Write + Send + Sync>) {
self.keylog = Some(writer);
}
#[cfg(feature = "qlog")]
#[cfg_attr(docsrs, doc(cfg(feature = "qlog")))]
pub fn set_qlog(
&mut self, writer: Box<dyn std::io::Write + Send + Sync>, title: String,
description: String,
) {
self.set_qlog_with_level(writer, title, description, QlogLevel::Base)
}
#[cfg(feature = "qlog")]
#[cfg_attr(docsrs, doc(cfg(feature = "qlog")))]
pub fn set_qlog_with_level(
&mut self, writer: Box<dyn std::io::Write + Send + Sync>, title: String,
description: String, qlog_level: QlogLevel,
) {
let vp = if self.is_server {
qlog::VantagePointType::Server
} else {
qlog::VantagePointType::Client
};
let level = match qlog_level {
QlogLevel::Core => EventImportance::Core,
QlogLevel::Base => EventImportance::Base,
QlogLevel::Extra => EventImportance::Extra,
};
self.qlog.level = level;
let trace = qlog::TraceSeq::new(
qlog::VantagePoint {
name: None,
ty: vp,
flow: None,
},
Some(title.to_string()),
Some(description.to_string()),
Some(qlog::Configuration {
time_offset: Some(0.0),
original_uris: None,
}),
None,
);
let mut streamer = qlog::streamer::QlogStreamer::new(
qlog::QLOG_VERSION.to_string(),
Some(title),
Some(description),
None,
time::Instant::now(),
trace,
self.qlog.level,
writer,
);
streamer.start_log().ok();
let ev_data = self
.local_transport_params
.to_qlog(TransportOwner::Local, self.handshake.cipher());
streamer.add_event(Event::with_time(0.0, ev_data)).ok();
self.qlog.streamer = Some(streamer);
}
#[cfg(feature = "qlog")]
#[cfg_attr(docsrs, doc(cfg(feature = "qlog")))]
pub fn qlog_streamer(&mut self) -> Option<&mut qlog::streamer::QlogStreamer> {
self.qlog.streamer.as_mut()
}
#[inline]
pub fn set_session(&mut self, session: &[u8]) -> Result<()> {
let mut b = octets::Octets::with_slice(session);
let session_len = b.get_u64()? as usize;
let session_bytes = b.get_bytes(session_len)?;
self.handshake.set_session(session_bytes.as_ref())?;
let raw_params_len = b.get_u64()? as usize;
let raw_params_bytes = b.get_bytes(raw_params_len)?;
let peer_params = TransportParams::decode(
raw_params_bytes.as_ref(),
self.is_server,
self.peer_transport_params_track_unknown,
)?;
self.process_peer_transport_params(peer_params)?;
Ok(())
}
pub fn set_max_idle_timeout(&mut self, v: u64) -> Result<()> {
self.local_transport_params.max_idle_timeout = v;
self.encode_transport_params()
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_cc_algorithm_in_handshake(
ssl: &mut boring::ssl::SslRef, algo: CongestionControlAlgorithm,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.cc_algorithm = algo;
Ok(())
}
#[cfg(all(feature = "boringssl-boring-crate", feature = "internal"))]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
#[doc(hidden)]
pub fn set_custom_bbr_settings_in_handshake(
ssl: &mut boring::ssl::SslRef, custom_bbr_params: BbrParams,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.custom_bbr_params = Some(custom_bbr_params);
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_cc_algorithm_name_in_handshake(
ssl: &mut boring::ssl::SslRef, name: &str,
) -> Result<()> {
let cc_algo = CongestionControlAlgorithm::from_str(name)?;
Self::set_cc_algorithm_in_handshake(ssl, cc_algo)
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_initial_congestion_window_packets_in_handshake(
ssl: &mut boring::ssl::SslRef, packets: usize,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.initial_congestion_window_packets = packets;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_hystart_in_handshake(
ssl: &mut boring::ssl::SslRef, v: bool,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.hystart = v;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_pacing_in_handshake(
ssl: &mut boring::ssl::SslRef, v: bool,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.pacing = v;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_max_pacing_rate_in_handshake(
ssl: &mut boring::ssl::SslRef, v: Option<u64>,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.max_pacing_rate = v;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_max_send_udp_payload_size_in_handshake(
ssl: &mut boring::ssl::SslRef, v: usize,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.recovery_config.max_send_udp_payload_size = v;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_send_capacity_factor_in_handshake(
ssl: &mut boring::ssl::SslRef, v: f64,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.tx_cap_factor = v;
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_discover_pmtu_in_handshake(
ssl: &mut boring::ssl::SslRef, discover: bool,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.pmtud = Some(discover);
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_max_idle_timeout_in_handshake(
ssl: &mut boring::ssl::SslRef, v: u64,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.local_transport_params.max_idle_timeout = v;
Self::set_transport_parameters_in_hanshake(
ex_data.local_transport_params.clone(),
ex_data.is_server,
ssl,
)
}
#[cfg(feature = "boringssl-boring-crate")]
#[cfg_attr(docsrs, doc(cfg(feature = "boringssl-boring-crate")))]
pub fn set_initial_max_streams_bidi_in_handshake(
ssl: &mut boring::ssl::SslRef, v: u64,
) -> Result<()> {
let ex_data = tls::ExData::from_ssl_ref(ssl).ok_or(Error::TlsFail)?;
ex_data.local_transport_params.initial_max_streams_bidi = v;
Self::set_transport_parameters_in_hanshake(
ex_data.local_transport_params.clone(),
ex_data.is_server,
ssl,
)
}
#[cfg(feature = "boringssl-boring-crate")]
fn set_transport_parameters_in_hanshake(
params: TransportParams, is_server: bool, ssl: &mut boring::ssl::SslRef,
) -> Result<()> {
use foreign_types_shared::ForeignTypeRef;
let mut handshake =
unsafe { tls::Handshake::from_ptr(ssl.as_ptr() as _) };
handshake.set_quic_transport_params(¶ms, is_server)?;
std::mem::forget(handshake);
Ok(())
}
pub fn recv(&mut self, buf: &mut [u8], info: RecvInfo) -> Result<usize> {
let len = buf.len();
if len == 0 {
return Err(Error::BufferTooShort);
}
let recv_pid = self.paths.path_id_from_addrs(&(info.to, info.from));
if let Some(recv_pid) = recv_pid {
let recv_path = self.paths.get_mut(recv_pid)?;
if self.is_server && !recv_path.verified_peer_address {
recv_path.max_send_bytes += len * self.max_amplification_factor;
}
} else if !self.is_server {
trace!(
"{} client received packet from unknown address {:?}, dropping",
self.trace_id,
info,
);
return Ok(len);
}
let mut done = 0;
let mut left = len;
while left > 0 {
let read = match self.recv_single(
&mut buf[len - left..len],
&info,
recv_pid,
) {
Ok(v) => v,
Err(Error::Done) => {
if self.is_stateless_reset(&buf[len - left..len]) {
trace!("{} packet is a stateless reset", self.trace_id);
self.mark_closed();
}
left
},
Err(e) => {
self.close(false, e.to_wire(), b"").ok();
return Err(e);
},
};
done += read;
left -= read;
}
self.process_undecrypted_0rtt_packets()?;
Ok(done)
}
fn process_undecrypted_0rtt_packets(&mut self) -> Result<()> {
if self.crypto_ctx[packet::Epoch::Application]
.crypto_0rtt_open
.is_some()
{
while let Some((mut pkt, info)) = self.undecryptable_pkts.pop_front()
{
if let Err(e) = self.recv(&mut pkt, info) {
self.undecryptable_pkts.clear();
return Err(e);
}
}
}
Ok(())
}
fn is_stateless_reset(&self, buf: &[u8]) -> bool {
let buf_len = buf.len();
if buf_len < 21 {
return false;
}
match self.peer_transport_params.stateless_reset_token {
Some(token) => {
let token_len = 16;
crypto::verify_slices_are_equal(
&token.to_be_bytes(),
&buf[buf_len - token_len..buf_len],
)
.is_ok()
},
None => false,
}
}
fn recv_single(
&mut self, buf: &mut [u8], info: &RecvInfo, recv_pid: Option<usize>,
) -> Result<usize> {
let now = time::Instant::now();
if buf.is_empty() {
return Err(Error::Done);
}
if self.is_closed() || self.is_draining() {
return Err(Error::Done);
}
let is_closing = self.local_error.is_some();
if is_closing {
return Err(Error::Done);
}
let buf_len = buf.len();
let mut b = octets::OctetsMut::with_slice(buf);
let mut hdr = Header::from_bytes(&mut b, self.source_id().len())
.map_err(|e| {
drop_pkt_on_err(
e,
self.recv_count,
self.is_server,
&self.trace_id,
)
})?;
if hdr.ty == packet::Type::VersionNegotiation {
if self.is_server {
return Err(Error::Done);
}
if self.did_version_negotiation {
return Err(Error::Done);
}
if self.recv_count > 0 {
return Err(Error::Done);
}
if hdr.dcid != self.source_id() {
return Err(Error::Done);
}
if hdr.scid != self.destination_id() {
return Err(Error::Done);
}
trace!("{} rx pkt {:?}", self.trace_id, hdr);
let versions = hdr.versions.ok_or(Error::Done)?;
if versions.contains(&self.version) {
return Err(Error::Done);
}
let supported_versions =
versions.iter().filter(|&&v| version_is_supported(v));
let mut found_version = false;
for &v in supported_versions {
found_version = true;
if v == PROTOCOL_VERSION_V1 {
self.version = v;
break;
}
self.version = cmp::max(self.version, v);
}
if !found_version {
return Err(Error::UnknownVersion);
}
self.did_version_negotiation = true;
let (aead_open, aead_seal) = crypto::derive_initial_key_material(
&self.destination_id(),
self.version,
self.is_server,
true,
)?;
self.drop_epoch_state(packet::Epoch::Initial, now);
self.got_peer_conn_id = false;
self.handshake.clear()?;
self.crypto_ctx[packet::Epoch::Initial].crypto_open = Some(aead_open);
self.crypto_ctx[packet::Epoch::Initial].crypto_seal = Some(aead_seal);
self.handshake
.use_legacy_codepoint(self.version != PROTOCOL_VERSION_V1);
self.encode_transport_params()?;
return Err(Error::Done);
}
if hdr.ty == packet::Type::Retry {
if self.is_server {
return Err(Error::Done);
}
if self.did_retry {
return Err(Error::Done);
}
if packet::verify_retry_integrity(
&b,
&self.destination_id(),
self.version,
)
.is_err()
{
return Err(Error::Done);
}
trace!("{} rx pkt {:?}", self.trace_id, hdr);
self.token = hdr.token;
self.did_retry = true;
self.odcid = Some(self.destination_id().into_owned());
self.set_initial_dcid(
hdr.scid.clone(),
None,
self.paths.get_active_path_id()?,
)?;
self.rscid = Some(self.destination_id().into_owned());
let (aead_open, aead_seal) = crypto::derive_initial_key_material(
&hdr.scid,
self.version,
self.is_server,
true,
)?;
self.drop_epoch_state(packet::Epoch::Initial, now);
self.got_peer_conn_id = false;
self.handshake.clear()?;
self.crypto_ctx[packet::Epoch::Initial].crypto_open = Some(aead_open);
self.crypto_ctx[packet::Epoch::Initial].crypto_seal = Some(aead_seal);
return Err(Error::Done);
}
if self.is_server && !self.did_version_negotiation {
if !version_is_supported(hdr.version) {
return Err(Error::UnknownVersion);
}
self.version = hdr.version;
self.did_version_negotiation = true;
self.handshake
.use_legacy_codepoint(self.version != PROTOCOL_VERSION_V1);
self.encode_transport_params()?;
}
if hdr.ty != packet::Type::Short && hdr.version != self.version {
return Err(Error::Done);
}
let payload_len = if hdr.ty == packet::Type::Short {
b.cap()
} else {
b.get_varint().map_err(|e| {
drop_pkt_on_err(
e.into(),
self.recv_count,
self.is_server,
&self.trace_id,
)
})? as usize
};
if payload_len > b.cap() {
return Err(drop_pkt_on_err(
Error::InvalidPacket,
self.recv_count,
self.is_server,
&self.trace_id,
));
}
if !self.derived_initial_secrets {
let (aead_open, aead_seal) = crypto::derive_initial_key_material(
&hdr.dcid,
self.version,
self.is_server,
false,
)?;
self.crypto_ctx[packet::Epoch::Initial].crypto_open = Some(aead_open);
self.crypto_ctx[packet::Epoch::Initial].crypto_seal = Some(aead_seal);
self.derived_initial_secrets = true;
}
let epoch = hdr.ty.to_epoch()?;
let aead = if hdr.ty == packet::Type::ZeroRTT {
self.crypto_ctx[epoch].crypto_0rtt_open.as_ref()
} else {
self.crypto_ctx[epoch].crypto_open.as_ref()
};
let mut aead = match aead {
Some(v) => v,
None => {
if hdr.ty == packet::Type::ZeroRTT &&
self.undecryptable_pkts.len() < MAX_UNDECRYPTABLE_PACKETS &&
!self.is_established()
{
let pkt_len = b.off() + payload_len;
let pkt = (b.buf()[..pkt_len]).to_vec();
self.undecryptable_pkts.push_back((pkt, *info));
return Ok(pkt_len);
}
let e = drop_pkt_on_err(
Error::CryptoFail,
self.recv_count,
self.is_server,
&self.trace_id,
);
return Err(e);
},
};
let aead_tag_len = aead.alg().tag_len();
packet::decrypt_hdr(&mut b, &mut hdr, aead).map_err(|e| {
drop_pkt_on_err(e, self.recv_count, self.is_server, &self.trace_id)
})?;
let pn = packet::decode_pkt_num(
self.pkt_num_spaces[epoch].largest_rx_pkt_num,
hdr.pkt_num,
hdr.pkt_num_len,
);
let pn_len = hdr.pkt_num_len;
trace!(
"{} rx pkt {:?} len={} pn={} {}",
self.trace_id,
hdr,
payload_len,
pn,
AddrTupleFmt(info.from, info.to)
);
#[cfg(feature = "qlog")]
let mut qlog_frames = vec![];
let mut aead_next = None;
if self.handshake_confirmed &&
hdr.ty != Type::ZeroRTT &&
hdr.key_phase != self.key_phase
{
if let Some(key_update) = self.crypto_ctx[epoch]
.key_update
.as_ref()
.and_then(|key_update| {
(pn < key_update.pn_on_update).then_some(key_update)
})
{
aead = &key_update.crypto_open;
} else {
trace!("{} peer-initiated key update", self.trace_id);
aead_next = Some((
self.crypto_ctx[epoch]
.crypto_open
.as_ref()
.unwrap()
.derive_next_packet_key()?,
self.crypto_ctx[epoch]
.crypto_seal
.as_ref()
.unwrap()
.derive_next_packet_key()?,
));
aead = &aead_next.as_ref().unwrap().0;
}
}
let mut payload = packet::decrypt_pkt(
&mut b,
pn,
pn_len,
payload_len,
aead,
)
.map_err(|e| {
drop_pkt_on_err(e, self.recv_count, self.is_server, &self.trace_id)
})?;
if self.pkt_num_spaces[epoch].recv_pkt_num.contains(pn) {
trace!("{} ignored duplicate packet {}", self.trace_id, pn);
return Err(Error::Done);
}
if payload.cap() == 0 {
return Err(Error::InvalidPacket);
}
let recv_pid = if hdr.ty == packet::Type::Short && self.got_peer_conn_id {
let pkt_dcid = ConnectionId::from_ref(&hdr.dcid);
self.get_or_create_recv_path_id(recv_pid, &pkt_dcid, buf_len, info)?
} else {
self.paths.get_active_path_id()?
};
if let Some((open_next, seal_next)) = aead_next {
if !self.crypto_ctx[epoch]
.key_update
.as_ref()
.is_none_or(|prev| prev.update_acked)
{
return Err(Error::KeyUpdate);
}
trace!("{} key update verified", self.trace_id);
let _ = self.crypto_ctx[epoch].crypto_seal.replace(seal_next);
let open_prev = self.crypto_ctx[epoch]
.crypto_open
.replace(open_next)
.unwrap();
let recv_path = self.paths.get_mut(recv_pid)?;
self.crypto_ctx[epoch].key_update = Some(packet::KeyUpdate {
crypto_open: open_prev,
pn_on_update: pn,
update_acked: false,
timer: now + (recv_path.recovery.pto() * 3),
});
self.key_phase = !self.key_phase;
qlog_with_type!(QLOG_PACKET_RX, self.qlog, q, {
let trigger = Some(
qlog::events::security::KeyUpdateOrRetiredTrigger::RemoteUpdate,
);
let ev_data_client =
EventData::KeyUpdated(qlog::events::security::KeyUpdated {
key_type:
qlog::events::security::KeyType::Client1RttSecret,
trigger: trigger.clone(),
..Default::default()
});
q.add_event_data_with_instant(ev_data_client, now).ok();
let ev_data_server =
EventData::KeyUpdated(qlog::events::security::KeyUpdated {
key_type:
qlog::events::security::KeyType::Server1RttSecret,
trigger,
..Default::default()
});
q.add_event_data_with_instant(ev_data_server, now).ok();
});
}
if !self.is_server && !self.got_peer_conn_id {
if self.odcid.is_none() {
self.odcid = Some(self.destination_id().into_owned());
}
self.set_initial_dcid(
hdr.scid.clone(),
self.peer_transport_params.stateless_reset_token,
recv_pid,
)?;
self.got_peer_conn_id = true;
}
if self.is_server && !self.got_peer_conn_id {
self.set_initial_dcid(hdr.scid.clone(), None, recv_pid)?;
if !self.did_retry {
self.local_transport_params
.original_destination_connection_id =
Some(hdr.dcid.to_vec().into());
self.encode_transport_params()?;
}
self.got_peer_conn_id = true;
}
let mut ack_elicited = false;
let mut frame_processing_err = None;
let mut probing = true;
while payload.cap() > 0 {
let frame = frame::Frame::from_bytes(&mut payload, hdr.ty)?;
qlog_with_type!(QLOG_PACKET_RX, self.qlog, _q, {
qlog_frames.push(frame.to_qlog());
});
if frame.ack_eliciting() {
ack_elicited = true;
}
if !frame.probing() {
probing = false;
}
if let Err(e) = self.process_frame(frame, &hdr, recv_pid, epoch, now)
{
frame_processing_err = Some(e);
break;
}
}
qlog_with_type!(QLOG_PACKET_RX, self.qlog, q, {
let packet_size = b.len();
let qlog_pkt_hdr = qlog::events::quic::PacketHeader::with_type(
hdr.ty.to_qlog(),
Some(pn),
Some(hdr.version),
Some(&hdr.scid),
Some(&hdr.dcid),
);
let qlog_raw_info = RawInfo {
length: Some(packet_size as u64),
payload_length: Some(payload_len as u64),
data: None,
};
let ev_data =
EventData::PacketReceived(qlog::events::quic::PacketReceived {
header: qlog_pkt_hdr,
frames: Some(qlog_frames),
raw: Some(qlog_raw_info),
..Default::default()
});
q.add_event_data_with_instant(ev_data, now).ok();
});
qlog_with_type!(QLOG_PACKET_RX, self.qlog, q, {
let recv_path = self.paths.get_mut(recv_pid)?;
if let Some(ev_data) = recv_path.recovery.maybe_qlog() {
q.add_event_data_with_instant(ev_data, now).ok();
}
});
if let Some(e) = frame_processing_err {
return Err(e);
}
if self.is_established() {
qlog_with_type!(QLOG_PARAMS_SET, self.qlog, q, {
if !self.qlog.logged_peer_params {
let ev_data = self
.peer_transport_params
.to_qlog(TransportOwner::Remote, self.handshake.cipher());
q.add_event_data_with_instant(ev_data, now).ok();
self.qlog.logged_peer_params = true;
}
});
}
let mut successful_pmtud_probe = false;
for (_, p) in self.paths.iter_mut() {
for acked in p.recovery.get_acked_frames(epoch) {
match acked {
frame::Frame::Ping {
mtu_probe: Some(mtu_probe),
} => {
let current_mtu = p.pmtud.get_current_mtu();
p.pmtud.set_current_mtu(cmp::max(current_mtu, mtu_probe));
p.pmtud.set_should_probe(false);
successful_pmtud_probe = true;
trace!(
"{} pmtud acked; current mtu: {:?}",
self.trace_id,
p.pmtud.get_current_mtu()
);
},
frame::Frame::ACK { ranges, .. } => {
if let Some(largest_acked) = ranges.last() {
self.pkt_num_spaces[epoch]
.recv_pkt_need_ack
.remove_until(largest_acked);
}
},
frame::Frame::CryptoHeader { offset, length } => {
self.crypto_ctx[epoch]
.crypto_stream
.send
.ack_and_drop(offset, length);
},
frame::Frame::StreamHeader {
stream_id,
offset,
length,
..
} => {
let stream = match self.streams.get_mut(stream_id) {
Some(v) => v,
None => continue,
};
stream.send.ack_and_drop(offset, length);
self.tx_buffered =
self.tx_buffered.saturating_sub(length);
qlog_with_type!(QLOG_DATA_MV, self.qlog, q, {
let ev_data = EventData::DataMoved(
qlog::events::quic::DataMoved {
stream_id: Some(stream_id),
offset: Some(offset),
length: Some(length as u64),
from: Some(DataRecipient::Transport),
to: Some(DataRecipient::Dropped),
..Default::default()
},
);
q.add_event_data_with_instant(ev_data, now).ok();
});
if stream.is_complete() && !stream.is_readable() {
let local = stream.local;
self.streams.collect(stream_id, local);
}
},
frame::Frame::HandshakeDone => {
self.handshake_done_sent = true;
self.handshake_done_acked = true;
},
frame::Frame::ResetStream { stream_id, .. } => {
let stream = match self.streams.get_mut(stream_id) {
Some(v) => v,
None => continue,
};
if stream.is_complete() && !stream.is_readable() {
let local = stream.local;
self.streams.collect(stream_id, local);
}
},
_ => (),
}
}
if successful_pmtud_probe {
trace!(
"{} updating pmtu to {:?}",
p.pmtud.get_current_mtu(),
self.trace_id
);
qlog_with_type!(
EventType::ConnectivityEventType(
ConnectivityEventType::MtuUpdated
),
self.qlog,
q,
{
let pmtu_data = EventData::MtuUpdated(
qlog::events::connectivity::MtuUpdated {
old: Some(p.recovery.max_datagram_size() as u16),
new: p.pmtud.get_current_mtu() as u16,
done: Some(true),
},
);
q.add_event_data_with_instant(pmtu_data, now).ok();
}
);
p.recovery
.pmtud_update_max_datagram_size(p.pmtud.get_current_mtu());
}
}
let no_dcid = self
.paths
.iter_mut()
.filter(|(_, p)| p.active_dcid_seq.is_none());
for (pid, p) in no_dcid {
if self.ids.zero_length_dcid() {
p.active_dcid_seq = Some(0);
continue;
}
let dcid_seq = match self.ids.lowest_available_dcid_seq() {
Some(seq) => seq,
None => break,
};
self.ids.link_dcid_to_path_id(dcid_seq, pid)?;
p.active_dcid_seq = Some(dcid_seq);
}
if self.pkt_num_spaces[epoch].recv_pkt_need_ack.last() < Some(pn) {
self.pkt_num_spaces[epoch].largest_rx_pkt_time = now;
}
self.pkt_num_spaces[epoch].recv_pkt_num.insert(pn);
self.pkt_num_spaces[epoch].recv_pkt_need_ack.push_item(pn);
self.pkt_num_spaces[epoch].ack_elicited =
cmp::max(self.pkt_num_spaces[epoch].ack_elicited, ack_elicited);
self.pkt_num_spaces[epoch].largest_rx_pkt_num =
cmp::max(self.pkt_num_spaces[epoch].largest_rx_pkt_num, pn);
if !probing {
self.pkt_num_spaces[epoch].largest_rx_non_probing_pkt_num = cmp::max(
self.pkt_num_spaces[epoch].largest_rx_non_probing_pkt_num,
pn,
);
let active_path_id = self.paths.get_active_path_id()?;
if self.is_server &&
recv_pid != active_path_id &&
self.pkt_num_spaces[epoch].largest_rx_non_probing_pkt_num == pn
{
self.on_peer_migrated(recv_pid, self.disable_dcid_reuse, now)?;
}
}
if let Some(idle_timeout) = self.idle_timeout() {
self.idle_timer = Some(now + idle_timeout);
}
self.update_tx_cap();
self.recv_count += 1;
self.paths.get_mut(recv_pid)?.recv_count += 1;
let read = b.off() + aead_tag_len;
self.recv_bytes += read as u64;
self.paths.get_mut(recv_pid)?.recv_bytes += read as u64;
if self.is_server && hdr.ty == packet::Type::Handshake {
self.drop_epoch_state(packet::Epoch::Initial, now);
self.paths.get_mut(recv_pid)?.verified_peer_address = true;
}
self.ack_eliciting_sent = false;
Ok(read)
}
pub fn send(&mut self, out: &mut [u8]) -> Result<(usize, SendInfo)> {
self.send_on_path(out, None, None)
}
pub fn send_on_path(
&mut self, out: &mut [u8], from: Option<SocketAddr>,
to: Option<SocketAddr>,
) -> Result<(usize, SendInfo)> {
if out.is_empty() {
return Err(Error::BufferTooShort);
}
if self.is_closed() || self.is_draining() {
return Err(Error::Done);
}
let now = time::Instant::now();
if self.local_error.is_none() {
self.do_handshake(now)?;
}
let _ = self.process_undecrypted_0rtt_packets();
if !self.derived_initial_secrets {
return Err(Error::Done);
}
let mut has_initial = false;
let mut done = 0;
let mut left = cmp::min(out.len(), self.max_send_udp_payload_size());
let send_pid = match (from, to) {
(Some(f), Some(t)) => self
.paths
.path_id_from_addrs(&(f, t))
.ok_or(Error::InvalidState)?,
_ => self.get_send_path_id(from, to)?,
};
let send_path = self.paths.get_mut(send_pid)?;
if send_path.pmtud.get_should_probe() {
let size = if self.handshake_confirmed || self.handshake_done_sent {
send_path.pmtud.get_probe_size()
} else {
send_path.pmtud.get_current_mtu()
};
send_path.recovery.pmtud_update_max_datagram_size(size);
left = cmp::min(out.len(), send_path.recovery.max_datagram_size());
}
if !send_path.verified_peer_address && self.is_server {
left = cmp::min(left, send_path.max_send_bytes);
}
while left > 0 {
let (ty, written) = match self.send_single(
&mut out[done..done + left],
send_pid,
has_initial,
now,
) {
Ok(v) => v,
Err(Error::BufferTooShort) | Err(Error::Done) => break,
Err(e) => return Err(e),
};
done += written;
left -= written;
match ty {
packet::Type::Initial => has_initial = true,
packet::Type::Short => break,
_ => (),
};
if let Ok(epoch) = ty.to_epoch() {
if self.paths.get_mut(send_pid)?.recovery.loss_probes(epoch) > 0 {
break;
}
}
if !(from.is_some() && to.is_some()) &&
self.get_send_path_id(from, to)? != send_pid
{
break;
}
}
if done == 0 {
self.last_tx_data = self.tx_data;
return Err(Error::Done);
}
#[cfg(not(feature = "fuzzing"))]
if has_initial && left > 0 && done < MIN_CLIENT_INITIAL_LEN {
let pad_len = cmp::min(left, MIN_CLIENT_INITIAL_LEN - done);
out[done..done + pad_len].fill(0);
done += pad_len;
}
let send_path = self.paths.get(send_pid)?;
let info = SendInfo {
from: send_path.local_addr(),
to: send_path.peer_addr(),
at: send_path.recovery.get_packet_send_time(now),
};
Ok((done, info))
}
fn send_single(
&mut self, out: &mut [u8], send_pid: usize, has_initial: bool,
now: time::Instant,
) -> Result<(packet::Type, usize)> {
if out.is_empty() {
return Err(Error::BufferTooShort);
}
if self.is_draining() {
return Err(Error::Done);
}
let is_closing = self.local_error.is_some();
let out_len = out.len();
let mut b = octets::OctetsMut::with_slice(out);
let pkt_type = self.write_pkt_type(send_pid)?;
let max_dgram_len = if !self.dgram_send_queue.is_empty() {
self.dgram_max_writable_len()
} else {
None
};
let epoch = pkt_type.to_epoch()?;
let pkt_space = &mut self.pkt_num_spaces[epoch];
let crypto_ctx = &mut self.crypto_ctx[epoch];
for (_, p) in self.paths.iter_mut() {
for lost in p.recovery.get_lost_frames(epoch) {
match lost {
frame::Frame::CryptoHeader { offset, length } => {
crypto_ctx.crypto_stream.send.retransmit(offset, length);
self.stream_retrans_bytes += length as u64;
p.stream_retrans_bytes += length as u64;
self.retrans_count += 1;
p.retrans_count += 1;
},
frame::Frame::StreamHeader {
stream_id,
offset,
length,
fin,
} => {
let stream = match self.streams.get_mut(stream_id) {
Some(v) => v,
None => continue,
};
let was_flushable = stream.is_flushable();
let empty_fin = length == 0 && fin;
stream.send.retransmit(offset, length);
if (stream.is_flushable() || empty_fin) && !was_flushable
{
let priority_key = Arc::clone(&stream.priority_key);
self.streams.insert_flushable(&priority_key);
}
self.stream_retrans_bytes += length as u64;
p.stream_retrans_bytes += length as u64;
self.retrans_count += 1;
p.retrans_count += 1;
},
frame::Frame::ACK { .. } => {
pkt_space.ack_elicited = true;
},
frame::Frame::ResetStream {
stream_id,
error_code,
final_size,
} =>
if self.streams.get(stream_id).is_some() {
self.streams
.insert_reset(stream_id, error_code, final_size);
},
frame::Frame::HandshakeDone if !self.handshake_done_acked => {
self.handshake_done_sent = false;
},
frame::Frame::MaxStreamData { stream_id, .. } => {
if self.streams.get(stream_id).is_some() {
self.streams.insert_almost_full(stream_id);
}
},
frame::Frame::MaxData { .. } => {
self.almost_full = true;
},
frame::Frame::NewConnectionId { seq_num, .. } => {
self.ids.mark_advertise_new_scid_seq(seq_num, true);
},
frame::Frame::RetireConnectionId { seq_num } => {
self.ids.mark_retire_dcid_seq(seq_num, true)?;
},
frame::Frame::Ping { mtu_probe } if mtu_probe.is_some() => {
p.pmtud.pmtu_probe_lost();
},
_ => (),
}
}
}
let is_app_limited = self.delivery_rate_check_if_app_limited();
let n_paths = self.paths.len();
let path = self.paths.get_mut(send_pid)?;
let flow_control = &mut self.flow_control;
let pkt_space = &mut self.pkt_num_spaces[epoch];
let crypto_ctx = &mut self.crypto_ctx[epoch];
let pkt_num_manager = &mut self.pkt_num_manager;
let mut left = if path.pmtud.is_enabled() {
cmp::min(path.pmtud.get_current_mtu(), b.cap())
} else {
b.cap()
};
if pkt_num_manager.should_skip_pn(self.handshake_completed) {
pkt_num_manager.set_skip_pn(Some(self.next_pkt_num));
self.next_pkt_num += 1;
};
let pn = self.next_pkt_num;
let largest_acked_pkt =
path.recovery.get_largest_acked_on_epoch(epoch).unwrap_or(0);
let pn_len = packet::pkt_num_len(pn, largest_acked_pkt);
let crypto_overhead = crypto_ctx.crypto_overhead().ok_or(Error::Done)?;
let dcid_seq = path.active_dcid_seq.ok_or(Error::OutOfIdentifiers)?;
let dcid =
ConnectionId::from_ref(self.ids.get_dcid(dcid_seq)?.cid.as_ref());
let scid = if let Some(scid_seq) = path.active_scid_seq {
ConnectionId::from_ref(self.ids.get_scid(scid_seq)?.cid.as_ref())
} else if pkt_type == packet::Type::Short {
ConnectionId::default()
} else {
return Err(Error::InvalidState);
};
let hdr = Header {
ty: pkt_type,
version: self.version,
dcid,
scid,
pkt_num: 0,
pkt_num_len: pn_len,
token: if pkt_type == packet::Type::Initial {
self.token.clone()
} else {
None
},
versions: None,
key_phase: self.key_phase,
};
hdr.to_bytes(&mut b)?;
let hdr_trace = if log::max_level() == log::LevelFilter::Trace {
Some(format!("{hdr:?}"))
} else {
None
};
let hdr_ty = hdr.ty;
#[cfg(feature = "qlog")]
let qlog_pkt_hdr = self.qlog.streamer.as_ref().map(|_q| {
qlog::events::quic::PacketHeader::with_type(
hdr.ty.to_qlog(),
Some(pn),
Some(hdr.version),
Some(&hdr.scid),
Some(&hdr.dcid),
)
});
let mut overhead = b.off() + pn_len + crypto_overhead;
if pkt_type != packet::Type::Short {
overhead += PAYLOAD_LENGTH_LEN;
}
match left.checked_sub(overhead) {
Some(v) => left = v,
None => {
path.recovery.update_app_limited(false);
return Err(Error::Done);
},
}
if left < PAYLOAD_MIN_LEN {
path.recovery.update_app_limited(false);
return Err(Error::Done);
}
let mut frames: SmallVec<[frame::Frame; 1]> = SmallVec::new();
let mut ack_eliciting = false;
let mut in_flight = false;
let mut is_pmtud_probe = false;
let mut has_data = false;
let ack_elicit_required = path.recovery.should_elicit_ack(epoch);
let header_offset = b.off();
if pkt_type != packet::Type::Short {
b.skip(PAYLOAD_LENGTH_LEN)?;
}
packet::encode_pkt_num(pn, pn_len, &mut b)?;
let payload_offset = b.off();
let cwnd_available =
path.recovery.cwnd_available().saturating_sub(overhead);
let left_before_packing_ack_frame = left;
if pkt_space.recv_pkt_need_ack.len() > 0 &&
(pkt_space.ack_elicited || ack_elicit_required) &&
(!is_closing ||
(pkt_type == Type::Handshake &&
self.local_error
.as_ref()
.is_some_and(|le| le.is_app))) &&
path.active()
{
let ack_delay = pkt_space.largest_rx_pkt_time.elapsed();
let ack_delay = ack_delay.as_micros() as u64 /
2_u64
.pow(self.local_transport_params.ack_delay_exponent as u32);
let frame = frame::Frame::ACK {
ack_delay,
ranges: pkt_space.recv_pkt_need_ack.clone(),
ecn_counts: None, };
if pkt_space.ack_elicited || frame.wire_len() < cwnd_available {
if push_frame_to_pkt!(b, frames, frame, left) {
pkt_space.ack_elicited = false;
}
}
}
left = cmp::min(
left,
cwnd_available.saturating_sub(left_before_packing_ack_frame - left),
);
let mut challenge_data = None;
let active_path = self.paths.get_active_mut()?;
if pkt_type == packet::Type::Short {
let should_probe_pmtu = active_path.should_send_pmtu_probe(
self.handshake_confirmed,
self.handshake_done_sent,
out_len,
is_closing,
frames.is_empty(),
);
if should_probe_pmtu {
trace!(
"{} sending pmtud probe pmtu_probe={} next_size={} current_mtu={}",
self.trace_id,
active_path.pmtud.get_probe_size(),
active_path.pmtud.get_should_probe(),
active_path.pmtud.get_current_mtu(),
);
left = active_path.pmtud.get_probe_size();
match left.checked_sub(overhead) {
Some(v) => left = v,
None => {
active_path.recovery.update_app_limited(false);
return Err(Error::Done);
},
}
let frame = frame::Frame::Padding {
len: active_path.pmtud.get_probe_size() - overhead - 1,
};
if push_frame_to_pkt!(b, frames, frame, left) {
let frame = frame::Frame::Ping {
mtu_probe: Some(active_path.pmtud.get_probe_size()),
};
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
}
}
is_pmtud_probe = true;
}
let path = self.paths.get_mut(send_pid)?;
while let Some(challenge) = path.pop_received_challenge() {
let frame = frame::Frame::PathResponse { data: challenge };
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
} else {
break;
}
}
if path.validation_requested() {
let data = rand::rand_u64().to_be_bytes();
let frame = frame::Frame::PathChallenge { data };
if push_frame_to_pkt!(b, frames, frame, left) {
challenge_data = Some(data);
ack_eliciting = true;
in_flight = true;
}
}
if let Some(key_update) = crypto_ctx.key_update.as_mut() {
key_update.update_acked = true;
}
}
let path = self.paths.get_mut(send_pid)?;
if pkt_type == packet::Type::Short && !is_closing {
while let Some(seq_num) = self.ids.next_advertise_new_scid_seq() {
let frame = self.ids.get_new_connection_id_frame_for(seq_num)?;
if push_frame_to_pkt!(b, frames, frame, left) {
self.ids.mark_advertise_new_scid_seq(seq_num, false);
ack_eliciting = true;
in_flight = true;
} else {
break;
}
}
}
if pkt_type == packet::Type::Short && !is_closing && path.active() {
if self.handshake_completed &&
!self.handshake_done_sent &&
self.is_server
{
let frame = frame::Frame::HandshakeDone;
if push_frame_to_pkt!(b, frames, frame, left) {
self.handshake_done_sent = true;
ack_eliciting = true;
in_flight = true;
}
}
if self.streams.should_update_max_streams_bidi() {
let frame = frame::Frame::MaxStreamsBidi {
max: self.streams.max_streams_bidi_next(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
self.streams.update_max_streams_bidi();
ack_eliciting = true;
in_flight = true;
}
}
if self.streams.should_update_max_streams_uni() {
let frame = frame::Frame::MaxStreamsUni {
max: self.streams.max_streams_uni_next(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
self.streams.update_max_streams_uni();
ack_eliciting = true;
in_flight = true;
}
}
if let Some(limit) = self.blocked_limit {
let frame = frame::Frame::DataBlocked { limit };
if push_frame_to_pkt!(b, frames, frame, left) {
self.blocked_limit = None;
ack_eliciting = true;
in_flight = true;
}
}
for stream_id in self.streams.almost_full() {
let stream = match self.streams.get_mut(stream_id) {
Some(v) => v,
None => {
self.streams.remove_almost_full(stream_id);
continue;
},
};
stream.recv.autotune_window(now, path.recovery.rtt());
let frame = frame::Frame::MaxStreamData {
stream_id,
max: stream.recv.max_data_next(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
let recv_win = stream.recv.window();
stream.recv.update_max_data(now);
self.streams.remove_almost_full(stream_id);
ack_eliciting = true;
in_flight = true;
flow_control.ensure_window_lower_bound(
(recv_win as f64 * CONNECTION_WINDOW_FACTOR) as u64,
);
self.almost_full = true;
}
}
if self.almost_full &&
flow_control.max_data() < flow_control.max_data_next()
{
flow_control.autotune_window(now, path.recovery.rtt());
let frame = frame::Frame::MaxData {
max: flow_control.max_data_next(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
self.almost_full = false;
flow_control.update_max_data(now);
ack_eliciting = true;
in_flight = true;
}
}
for (stream_id, error_code) in self
.streams
.stopped()
.map(|(&k, &v)| (k, v))
.collect::<Vec<(u64, u64)>>()
{
let frame = frame::Frame::StopSending {
stream_id,
error_code,
};
if push_frame_to_pkt!(b, frames, frame, left) {
self.streams.remove_stopped(stream_id);
ack_eliciting = true;
in_flight = true;
}
}
for (stream_id, (error_code, final_size)) in self
.streams
.reset()
.map(|(&k, &v)| (k, v))
.collect::<Vec<(u64, (u64, u64))>>()
{
let frame = frame::Frame::ResetStream {
stream_id,
error_code,
final_size,
};
if push_frame_to_pkt!(b, frames, frame, left) {
self.streams.remove_reset(stream_id);
ack_eliciting = true;
in_flight = true;
}
}
for (stream_id, limit) in self
.streams
.blocked()
.map(|(&k, &v)| (k, v))
.collect::<Vec<(u64, u64)>>()
{
let frame = frame::Frame::StreamDataBlocked { stream_id, limit };
if push_frame_to_pkt!(b, frames, frame, left) {
self.streams.remove_blocked(stream_id);
ack_eliciting = true;
in_flight = true;
}
}
while let Some(seq_num) = self.ids.next_retire_dcid_seq() {
let dcid_seq = path.active_dcid_seq.ok_or(Error::InvalidState)?;
if seq_num == dcid_seq {
continue;
}
let frame = frame::Frame::RetireConnectionId { seq_num };
if push_frame_to_pkt!(b, frames, frame, left) {
self.ids.mark_retire_dcid_seq(seq_num, false)?;
ack_eliciting = true;
in_flight = true;
} else {
break;
}
}
}
if path.active() || n_paths == 1 {
if let Some(conn_err) = self.local_error.as_ref() {
if conn_err.is_app {
if pkt_type == packet::Type::Short {
let frame = frame::Frame::ApplicationClose {
error_code: conn_err.error_code,
reason: conn_err.reason.clone(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
let pto = path.recovery.pto();
self.draining_timer = Some(now + (pto * 3));
ack_eliciting = true;
in_flight = true;
}
}
} else {
let frame = frame::Frame::ConnectionClose {
error_code: conn_err.error_code,
frame_type: 0,
reason: conn_err.reason.clone(),
};
if push_frame_to_pkt!(b, frames, frame, left) {
let pto = path.recovery.pto();
self.draining_timer = Some(now + (pto * 3));
ack_eliciting = true;
in_flight = true;
}
}
}
}
if crypto_ctx.crypto_stream.is_flushable() &&
left > frame::MAX_CRYPTO_OVERHEAD &&
!is_closing &&
path.active()
{
let crypto_off = crypto_ctx.crypto_stream.send.off_front();
let hdr_off = b.off();
let hdr_len = 1 + octets::varint_len(crypto_off) + 2;
if let Some(max_len) = left.checked_sub(hdr_len) {
let (mut crypto_hdr, mut crypto_payload) =
b.split_at(hdr_off + hdr_len)?;
let (len, _) = crypto_ctx
.crypto_stream
.send
.emit(&mut crypto_payload.as_mut()[..max_len])?;
crypto_hdr.skip(hdr_off)?;
frame::encode_crypto_header(
crypto_off,
len as u64,
&mut crypto_hdr,
)?;
b.skip(hdr_len + len)?;
let frame = frame::Frame::CryptoHeader {
offset: crypto_off,
length: len,
};
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
has_data = true;
}
}
}
let mut dgram_emitted = false;
let dgrams_to_emit = max_dgram_len.is_some();
let stream_to_emit = self.streams.has_flushable();
let mut do_dgram = self.emit_dgram && dgrams_to_emit;
let do_stream = !self.emit_dgram && stream_to_emit;
if !do_stream && dgrams_to_emit {
do_dgram = true;
}
if (pkt_type == packet::Type::Short || pkt_type == packet::Type::ZeroRTT) &&
left > frame::MAX_DGRAM_OVERHEAD &&
!is_closing &&
path.active() &&
do_dgram
{
if let Some(max_dgram_payload) = max_dgram_len {
while let Some(len) = self.dgram_send_queue.peek_front_len() {
let hdr_off = b.off();
let hdr_len = 1 + 2;
if (hdr_len + len) <= left {
match self.dgram_send_queue.pop() {
Some(data) => {
let (mut dgram_hdr, mut dgram_payload) =
b.split_at(hdr_off + hdr_len)?;
dgram_payload.as_mut()[..len]
.copy_from_slice(&data);
dgram_hdr.skip(hdr_off)?;
frame::encode_dgram_header(
len as u64,
&mut dgram_hdr,
)?;
b.skip(hdr_len + len)?;
let frame =
frame::Frame::DatagramHeader { length: len };
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
dgram_emitted = true;
let _ =
self.dgram_sent_count.saturating_add(1);
let _ =
path.dgram_sent_count.saturating_add(1);
}
},
None => continue,
};
} else if len > max_dgram_payload {
self.dgram_send_queue.pop();
} else {
break;
}
}
}
}
if (pkt_type == packet::Type::Short || pkt_type == packet::Type::ZeroRTT) &&
left > frame::MAX_STREAM_OVERHEAD &&
!is_closing &&
path.active() &&
!dgram_emitted
{
while let Some(priority_key) = self.streams.peek_flushable() {
let stream_id = priority_key.id;
let stream = match self.streams.get_mut(stream_id) {
Some(v) if !v.send.is_stopped() => v,
_ => {
self.streams.remove_flushable(&priority_key);
continue;
},
};
let stream_off = stream.send.off_front();
let hdr_off = b.off();
let hdr_len = 1 + octets::varint_len(stream_id) + octets::varint_len(stream_off) + 2;
let max_len = match left.checked_sub(hdr_len) {
Some(v) => v,
None => {
let priority_key = Arc::clone(&stream.priority_key);
self.streams.remove_flushable(&priority_key);
continue;
},
};
let (mut stream_hdr, mut stream_payload) =
b.split_at(hdr_off + hdr_len)?;
let (len, fin) =
stream.send.emit(&mut stream_payload.as_mut()[..max_len])?;
stream_hdr.skip(hdr_off)?;
frame::encode_stream_header(
stream_id,
stream_off,
len as u64,
fin,
&mut stream_hdr,
)?;
b.skip(hdr_len + len)?;
let frame = frame::Frame::StreamHeader {
stream_id,
offset: stream_off,
length: len,
fin,
};
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
has_data = true;
}
let priority_key = Arc::clone(&stream.priority_key);
if !stream.is_flushable() {
self.streams.remove_flushable(&priority_key);
} else if stream.incremental {
self.streams.remove_flushable(&priority_key);
self.streams.insert_flushable(&priority_key);
}
#[cfg(feature = "fuzzing")]
if left > frame::MAX_STREAM_OVERHEAD {
continue;
}
break;
}
}
self.emit_dgram = !dgram_emitted;
if (ack_elicit_required || path.needs_ack_eliciting) &&
!ack_eliciting &&
left >= 1 &&
!is_closing
{
let frame = frame::Frame::Ping { mtu_probe: None };
if push_frame_to_pkt!(b, frames, frame, left) {
ack_eliciting = true;
in_flight = true;
}
}
if ack_eliciting && !is_pmtud_probe {
path.needs_ack_eliciting = false;
path.recovery.ping_sent(epoch);
}
if !has_data &&
!dgram_emitted &&
cwnd_available > frame::MAX_STREAM_OVERHEAD
{
path.recovery.on_app_limited();
}
if frames.is_empty() {
path.recovery.update_app_limited(false);
return Err(Error::Done);
}
if (has_initial || !path.validated()) &&
pkt_type == packet::Type::Short &&
left >= 1
{
let frame = frame::Frame::Padding { len: left };
if push_frame_to_pkt!(b, frames, frame, left) {
in_flight = true;
}
}
if b.off() - payload_offset < PAYLOAD_MIN_LEN {
let payload_len = b.off() - payload_offset;
let frame = frame::Frame::Padding {
len: PAYLOAD_MIN_LEN - payload_len,
};
#[allow(unused_assignments)]
if push_frame_to_pkt!(b, frames, frame, left) {
in_flight = true;
}
}
let payload_len = b.off() - payload_offset;
if pkt_type != packet::Type::Short {
let len = pn_len + payload_len + crypto_overhead;
let (_, mut payload_with_len) = b.split_at(header_offset)?;
payload_with_len
.put_varint_with_len(len as u64, PAYLOAD_LENGTH_LEN)?;
}
trace!(
"{} tx pkt {} len={} pn={} {}",
self.trace_id,
hdr_trace.unwrap_or_default(),
payload_len,
pn,
AddrTupleFmt(path.local_addr(), path.peer_addr())
);
#[cfg(feature = "qlog")]
let mut qlog_frames: SmallVec<
[qlog::events::quic::QuicFrame; 1],
> = SmallVec::with_capacity(frames.len());
for frame in &mut frames {
trace!("{} tx frm {:?}", self.trace_id, frame);
qlog_with_type!(QLOG_PACKET_TX, self.qlog, _q, {
qlog_frames.push(frame.to_qlog());
});
}
qlog_with_type!(QLOG_PACKET_TX, self.qlog, q, {
if let Some(header) = qlog_pkt_hdr {
let length = payload_len + payload_offset + crypto_overhead;
let qlog_raw_info = RawInfo {
length: Some(length as u64),
payload_length: Some(payload_len as u64),
data: None,
};
let send_at_time =
now.duration_since(q.start_time()).as_secs_f32() * 1000.0;
let ev_data =
EventData::PacketSent(qlog::events::quic::PacketSent {
header,
frames: Some(qlog_frames),
raw: Some(qlog_raw_info),
send_at_time: Some(send_at_time),
..Default::default()
});
q.add_event_data_with_instant(ev_data, now).ok();
}
});
let aead = match crypto_ctx.crypto_seal {
Some(ref v) => v,
None => return Err(Error::InvalidState),
};
let written = packet::encrypt_pkt(
&mut b,
pn,
pn_len,
payload_len,
payload_offset,
None,
aead,
)?;
let sent_pkt_has_data = if path.recovery.gcongestion_enabled() {
has_data || dgram_emitted
} else {
has_data
};
let sent_pkt = recovery::Sent {
pkt_num: pn,
frames,
time_sent: now,
time_acked: None,
time_lost: None,
size: if ack_eliciting { written } else { 0 },
ack_eliciting,
in_flight,
delivered: 0,
delivered_time: now,
first_sent_time: now,
is_app_limited: false,
tx_in_flight: 0,
lost: 0,
has_data: sent_pkt_has_data,
is_pmtud_probe,
};
if in_flight && is_app_limited {
path.recovery.delivery_rate_update_app_limited(true);
}
self.next_pkt_num += 1;
let handshake_status = recovery::HandshakeStatus {
has_handshake_keys: self.crypto_ctx[packet::Epoch::Handshake]
.has_keys(),
peer_verified_address: self.peer_verified_initial_address,
completed: self.handshake_completed,
};
self.on_packet_sent(send_pid, sent_pkt, epoch, handshake_status, now)?;
let path = self.paths.get_mut(send_pid)?;
qlog_with_type!(QLOG_METRICS, self.qlog, q, {
if let Some(ev_data) = path.recovery.maybe_qlog() {
q.add_event_data_with_instant(ev_data, now).ok();
}
});
if let Some(data) = challenge_data {
path.add_challenge_sent(data, written, now);
}
self.sent_count += 1;
self.sent_bytes += written as u64;
path.sent_count += 1;
path.sent_bytes += written as u64;
if self.dgram_send_queue.byte_size() > path.recovery.cwnd_available() {
path.recovery.update_app_limited(false);
}
path.max_send_bytes = path.max_send_bytes.saturating_sub(written);
if !self.is_server && hdr_ty == packet::Type::Handshake {
self.drop_epoch_state(packet::Epoch::Initial, now);
}
if ack_eliciting && !self.ack_eliciting_sent {
if let Some(idle_timeout) = self.idle_timeout() {
self.idle_timer = Some(now + idle_timeout);
}
}
if ack_eliciting {
self.ack_eliciting_sent = true;
}
let active_path = self.paths.get_active_mut()?;
if active_path.pmtud.is_enabled() {
active_path.recovery.pmtud_update_max_datagram_size(
active_path.pmtud.get_current_mtu(),
);
}
Ok((pkt_type, written))
}
fn on_packet_sent(
&mut self, send_pid: usize, sent_pkt: recovery::Sent,
epoch: packet::Epoch, handshake_status: recovery::HandshakeStatus,
now: std::time::Instant,
) -> Result<()> {
let path = self.paths.get_mut(send_pid)?;
let cwnd = path.recovery.cwnd();
let max_datagram_size = path.recovery.max_datagram_size();
self.pkt_num_spaces[epoch].on_packet_sent(&sent_pkt);
self.pkt_num_manager.on_packet_sent(
cwnd,
max_datagram_size,
self.handshake_completed,
);
path.recovery.on_packet_sent(
sent_pkt,
epoch,
handshake_status,
now,
&self.trace_id,
);
Ok(())
}
#[inline]
pub fn get_next_release_time(&self) -> Option<ReleaseDecision> {
Some(
self.paths
.get_active()
.ok()?
.recovery
.get_next_release_time(),
)
}
#[inline]
pub fn gcongestion_enabled(&self) -> Option<bool> {
Some(self.paths.get_active().ok()?.recovery.gcongestion_enabled())
}
pub fn max_release_into_future(&self) -> time::Duration {
self.paths
.get_active()
.map(|p| p.recovery.rtt().mul_f64(0.125))
.unwrap_or(time::Duration::from_millis(1))
.max(Duration::from_millis(1))
.min(Duration::from_millis(5))
}
#[inline]
pub fn pacing_enabled(&self) -> bool {
self.recovery_config.pacing
}
#[inline]
pub fn send_quantum(&self) -> usize {
match self.paths.get_active() {
Ok(p) => p.recovery.send_quantum(),
_ => 0,
}
}
pub fn send_quantum_on_path(
&self, local_addr: SocketAddr, peer_addr: SocketAddr,
) -> usize {
self.paths
.path_id_from_addrs(&(local_addr, peer_addr))
.and_then(|pid| self.paths.get(pid).ok())
.map(|path| path.recovery.send_quantum())
.unwrap_or(0)
}
pub fn stream_recv(
&mut self, stream_id: u64, out: &mut [u8],
) -> Result<(usize, bool)> {
if !stream::is_bidi(stream_id) &&
stream::is_local(stream_id, self.is_server)
{
return Err(Error::InvalidStreamState(stream_id));
}
let stream = self
.streams
.get_mut(stream_id)
.ok_or(Error::InvalidStreamState(stream_id))?;
if !stream.is_readable() {
return Err(Error::Done);
}
let local = stream.local;
let priority_key = Arc::clone(&stream.priority_key);
#[cfg(feature = "qlog")]
let offset = stream.recv.off_front();
let (read, fin) = match stream.recv.emit(out) {
Ok(v) => v,
Err(e) => {
if stream.is_complete() {
self.streams.collect(stream_id, local);
}
self.streams.remove_readable(&priority_key);
return Err(e);
},
};
self.flow_control.add_consumed(read as u64);
let readable = stream.is_readable();
let complete = stream.is_complete();
if stream.recv.almost_full() {
self.streams.insert_almost_full(stream_id);
}
if !readable {
self.streams.remove_readable(&priority_key);
}
if complete {
self.streams.collect(stream_id, local);
}
qlog_with_type!(QLOG_DATA_MV, self.qlog, q, {
let ev_data = EventData::DataMoved(qlog::events::quic::DataMoved {
stream_id: Some(stream_id),
offset: Some(offset),
length: Some(read as u64),
from: Some(DataRecipient::Transport),
to: Some(DataRecipient::Application),
..Default::default()
});
let now = time::Instant::now();
q.add_event_data_with_instant(ev_data, now).ok();
});
if self.should_update_max_data() {
self.almost_full = true;
}
if priority_key.incremental && readable {
self.streams.remove_readable(&priority_key);
self.streams.insert_readable(&priority_key);
}
Ok((read, fin))
}
pub fn stream_send(
&mut self, stream_id: u64, buf: &[u8], fin: bool,
) -> Result<usize> {
self.stream_do_send(
stream_id,
buf,
fin,
|stream: &mut stream::Stream<F>,
buf: &[u8],
cap: usize,
fin: bool| {
stream.send.write(&buf[..cap], fin).map(|v| (v, v))
},
)
}
pub fn stream_send_zc(
&mut self, stream_id: u64, buf: F::Buf, len: Option<usize>, fin: bool,
) -> Result<(usize, Option<F::Buf>)>
where
F::Buf: BufSplit,
{
self.stream_do_send(
stream_id,
buf,
fin,
|stream: &mut stream::Stream<F>,
buf: F::Buf,
cap: usize,
fin: bool| {
let len = len.unwrap_or(usize::MAX).min(cap);
let (sent, remaining) = stream.send.append_buf(buf, len, fin)?;
Ok((sent, (sent, remaining)))
},
)
}
fn stream_do_send<B, R, SND>(
&mut self, stream_id: u64, buf: B, fin: bool, write_fn: SND,
) -> Result<R>
where
B: AsRef<[u8]>,
SND: FnOnce(&mut stream::Stream<F>, B, usize, bool) -> Result<(usize, R)>,
{
if !stream::is_bidi(stream_id) &&
!stream::is_local(stream_id, self.is_server)
{
return Err(Error::InvalidStreamState(stream_id));
}
let len = buf.as_ref().len();
if self.max_tx_data - self.tx_data < len as u64 {
self.blocked_limit = Some(self.max_tx_data);
}
let cap = self.tx_cap;
let stream = self.get_or_create_stream(stream_id, true)?;
#[cfg(feature = "qlog")]
let offset = stream.send.off_back();
let was_writable = stream.is_writable();
let was_flushable = stream.is_flushable();
let priority_key = Arc::clone(&stream.priority_key);
if cap == 0 && len > 0 {
if was_writable {
self.streams.insert_writable(&priority_key);
}
return Err(Error::Done);
}
let (cap, fin, blocked_by_cap) = if cap < len {
(cap, false, true)
} else {
(len, fin, false)
};
let (sent, ret) = match write_fn(stream, buf, cap, fin) {
Ok(v) => v,
Err(e) => {
self.streams.remove_writable(&priority_key);
return Err(e);
},
};
let incremental = stream.incremental;
let priority_key = Arc::clone(&stream.priority_key);
let flushable = stream.is_flushable();
let writable = stream.is_writable();
let empty_fin = len == 0 && fin;
if sent < cap {
let max_off = stream.send.max_off();
if stream.send.blocked_at() != Some(max_off) {
stream.send.update_blocked_at(Some(max_off));
self.streams.insert_blocked(stream_id, max_off);
}
} else {
stream.send.update_blocked_at(None);
self.streams.remove_blocked(stream_id);
}
if (flushable || empty_fin) && !was_flushable {
self.streams.insert_flushable(&priority_key);
}
if !writable {
self.streams.remove_writable(&priority_key);
} else if was_writable && blocked_by_cap {
self.streams.insert_writable(&priority_key);
}
self.tx_cap -= sent;
self.tx_data += sent as u64;
self.tx_buffered += sent;
qlog_with_type!(QLOG_DATA_MV, self.qlog, q, {
let ev_data = EventData::DataMoved(qlog::events::quic::DataMoved {
stream_id: Some(stream_id),
offset: Some(offset),
length: Some(sent as u64),
from: Some(DataRecipient::Application),
to: Some(DataRecipient::Transport),
..Default::default()
});
let now = time::Instant::now();
q.add_event_data_with_instant(ev_data, now).ok();
});
if sent == 0 && cap > 0 {
return Err(Error::Done);
}
if incremental && writable {
self.streams.remove_writable(&priority_key);
self.streams.insert_writable(&priority_key);
}
Ok(ret)
}
pub fn stream_priority(
&mut self, stream_id: u64, urgency: u8, incremental: bool,
) -> Result<()> {
let stream = match self.get_or_create_stream(stream_id, true) {
Ok(v) => v,
Err(Error::Done) => return Ok(()),
Err(e) => return Err(e),
};
if stream.urgency == urgency && stream.incremental == incremental {
return Ok(());
}
stream.urgency = urgency;
stream.incremental = incremental;
let new_priority_key = Arc::new(StreamPriorityKey {
urgency: stream.urgency,
incremental: stream.incremental,
id: stream_id,
..Default::default()
});
let old_priority_key =
std::mem::replace(&mut stream.priority_key, new_priority_key.clone());
self.streams
.update_priority(&old_priority_key, &new_priority_key);
Ok(())
}
pub fn stream_shutdown(
&mut self, stream_id: u64, direction: Shutdown, err: u64,
) -> Result<()> {
if direction == Shutdown::Read &&
stream::is_local(stream_id, self.is_server) &&
!stream::is_bidi(stream_id)
{
return Err(Error::InvalidStreamState(stream_id));
}
if direction == Shutdown::Write &&
!stream::is_local(stream_id, self.is_server) &&
!stream::is_bidi(stream_id)
{
return Err(Error::InvalidStreamState(stream_id));
}
let stream = self.streams.get_mut(stream_id).ok_or(Error::Done)?;
let priority_key = Arc::clone(&stream.priority_key);
match direction {
Shutdown::Read => {
stream.recv.shutdown()?;
if !stream.recv.is_fin() {
self.streams.insert_stopped(stream_id, err);
}
self.streams.remove_readable(&priority_key);
self.stopped_stream_local_count =
self.stopped_stream_local_count.saturating_add(1);
},
Shutdown::Write => {
let (final_size, unsent) = stream.send.shutdown()?;
self.tx_data = self.tx_data.saturating_sub(unsent);
self.tx_buffered =
self.tx_buffered.saturating_sub(unsent as usize);
self.update_tx_cap();
self.streams.insert_reset(stream_id, err, final_size);
self.streams.remove_writable(&priority_key);
self.reset_stream_local_count =
self.reset_stream_local_count.saturating_add(1);
},
}
Ok(())
}
#[inline]
pub fn stream_capacity(&self, stream_id: u64) -> Result<usize> {
if let Some(stream) = self.streams.get(stream_id) {
let cap = cmp::min(self.tx_cap, stream.send.cap()?);
return Ok(cap);
};
Err(Error::InvalidStreamState(stream_id))
}
pub fn stream_readable_next(&mut self) -> Option<u64> {
let priority_key = self.streams.readable.front().clone_pointer()?;
self.streams.remove_readable(&priority_key);
Some(priority_key.id)
}
pub fn stream_readable(&self, stream_id: u64) -> bool {
let stream = match self.streams.get(stream_id) {
Some(v) => v,
None => return false,
};
stream.is_readable()
}
pub fn stream_writable_next(&mut self) -> Option<u64> {
if self.tx_cap == 0 {
return None;
}
let mut cursor = self.streams.writable.front();
while let Some(priority_key) = cursor.clone_pointer() {
if let Some(stream) = self.streams.get(priority_key.id) {
let cap = match stream.send.cap() {
Ok(v) => v,
Err(_) =>
return {
self.streams.remove_writable(&priority_key);
Some(priority_key.id)
},
};
if cmp::min(self.tx_cap, cap) >= stream.send_lowat {
self.streams.remove_writable(&priority_key);
return Some(priority_key.id);
}
}
cursor.move_next();
}
None
}
#[inline]
pub fn stream_writable(
&mut self, stream_id: u64, len: usize,
) -> Result<bool> {
if self.stream_capacity(stream_id)? >= len {
return Ok(true);
}
let stream = match self.streams.get_mut(stream_id) {
Some(v) => v,
None => return Err(Error::InvalidStreamState(stream_id)),
};
stream.send_lowat = cmp::max(1, len);
let is_writable = stream.is_writable();
let priority_key = Arc::clone(&stream.priority_key);
if self.max_tx_data - self.tx_data < len as u64 {
self.blocked_limit = Some(self.max_tx_data);
}
if stream.send.cap()? < len {
let max_off = stream.send.max_off();
if stream.send.blocked_at() != Some(max_off) {
stream.send.update_blocked_at(Some(max_off));
self.streams.insert_blocked(stream_id, max_off);
}
} else if is_writable {
self.streams.insert_writable(&priority_key);
}
Ok(false)
}
#[inline]
pub fn stream_finished(&self, stream_id: u64) -> bool {
let stream = match self.streams.get(stream_id) {
Some(v) => v,
None => return true,
};
stream.recv.is_fin()
}
#[inline]
pub fn peer_streams_left_bidi(&self) -> u64 {
self.streams.peer_streams_left_bidi()
}
#[inline]
pub fn peer_streams_left_uni(&self) -> u64 {
self.streams.peer_streams_left_uni()
}
#[inline]
pub fn readable(&self) -> StreamIter {
self.streams.readable()
}
#[inline]
pub fn writable(&self) -> StreamIter {
if self.tx_cap == 0 {
return StreamIter::default();
}
self.streams.writable()
}
pub fn max_send_udp_payload_size(&self) -> usize {
let max_datagram_size = self
.paths
.get_active()
.ok()
.map(|p| p.recovery.max_datagram_size());
if let Some(max_datagram_size) = max_datagram_size {
if self.is_established() {
return cmp::min(16383, max_datagram_size);
}
}
MIN_CLIENT_INITIAL_LEN
}
pub fn send_ack_eliciting(&mut self) -> Result<()> {
if self.is_closed() || self.is_draining() {
return Ok(());
}
self.paths.get_active_mut()?.needs_ack_eliciting = true;
Ok(())
}
pub fn send_ack_eliciting_on_path(
&mut self, local: SocketAddr, peer: SocketAddr,
) -> Result<()> {
if self.is_closed() || self.is_draining() {
return Ok(());
}
let path_id = self
.paths
.path_id_from_addrs(&(local, peer))
.ok_or(Error::InvalidState)?;
self.paths.get_mut(path_id)?.needs_ack_eliciting = true;
Ok(())
}
#[inline]
pub fn dgram_recv(&mut self, buf: &mut [u8]) -> Result<usize> {
match self.dgram_recv_queue.pop() {
Some(d) => {
if d.len() > buf.len() {
return Err(Error::BufferTooShort);
}
buf[..d.len()].copy_from_slice(&d);
Ok(d.len())
},
None => Err(Error::Done),
}
}
#[inline]
pub fn dgram_recv_vec(&mut self) -> Result<Vec<u8>> {
match self.dgram_recv_queue.pop() {
Some(d) => Ok(d),
None => Err(Error::Done),
}
}
#[inline]
pub fn dgram_recv_peek(&self, buf: &mut [u8], len: usize) -> Result<usize> {
self.dgram_recv_queue.peek_front_bytes(buf, len)
}
#[inline]
pub fn dgram_recv_front_len(&self) -> Option<usize> {
self.dgram_recv_queue.peek_front_len()
}
#[inline]
pub fn dgram_recv_queue_len(&self) -> usize {
self.dgram_recv_queue.len()
}
#[inline]
pub fn dgram_recv_queue_byte_size(&self) -> usize {
self.dgram_recv_queue.byte_size()
}
#[inline]
pub fn dgram_send_queue_len(&self) -> usize {
self.dgram_send_queue.len()
}
#[inline]
pub fn dgram_send_queue_byte_size(&self) -> usize {
self.dgram_send_queue.byte_size()
}
#[inline]
pub fn is_dgram_send_queue_full(&self) -> bool {
self.dgram_send_queue.is_full()
}
#[inline]
pub fn is_dgram_recv_queue_full(&self) -> bool {
self.dgram_recv_queue.is_full()
}
pub fn dgram_send(&mut self, buf: &[u8]) -> Result<()> {
let max_payload_len = match self.dgram_max_writable_len() {
Some(v) => v,
None => return Err(Error::InvalidState),
};
if buf.len() > max_payload_len {
return Err(Error::BufferTooShort);
}
self.dgram_send_queue.push(buf.to_vec())?;
let active_path = self.paths.get_active_mut()?;
if self.dgram_send_queue.byte_size() >
active_path.recovery.cwnd_available()
{
active_path.recovery.update_app_limited(false);
}
Ok(())
}
pub fn dgram_send_vec(&mut self, buf: Vec<u8>) -> Result<()> {
let max_payload_len = match self.dgram_max_writable_len() {
Some(v) => v,
None => return Err(Error::InvalidState),
};
if buf.len() > max_payload_len {
return Err(Error::BufferTooShort);
}
self.dgram_send_queue.push(buf)?;
let active_path = self.paths.get_active_mut()?;
if self.dgram_send_queue.byte_size() >
active_path.recovery.cwnd_available()
{
active_path.recovery.update_app_limited(false);
}
Ok(())
}
#[inline]
pub fn dgram_purge_outgoing<FN: Fn(&[u8]) -> bool>(&mut self, f: FN) {
self.dgram_send_queue.purge(f);
}
#[inline]
pub fn dgram_max_writable_len(&self) -> Option<usize> {
match self.peer_transport_params.max_datagram_frame_size {
None => None,
Some(peer_frame_len) => {
let dcid = self.destination_id();
let mut max_len = self.max_send_udp_payload_size();
max_len = max_len.saturating_sub(1 + dcid.len());
max_len = max_len.saturating_sub(packet::MAX_PKT_NUM_LEN);
max_len = max_len.saturating_sub(
self.crypto_ctx[packet::Epoch::Application]
.crypto_overhead()?,
);
max_len = cmp::min(peer_frame_len as usize, max_len);
max_len.checked_sub(1 + frame::MAX_DGRAM_OVERHEAD)
},
}
}
fn dgram_enabled(&self) -> bool {
self.local_transport_params
.max_datagram_frame_size
.is_some()
}
pub fn timeout_instant(&self) -> Option<time::Instant> {
if self.is_closed() {
return None;
}
if self.is_draining() {
self.draining_timer
} else {
let path_timer = self
.paths
.iter()
.filter_map(|(_, p)| p.recovery.loss_detection_timer())
.min();
let key_update_timer = self.crypto_ctx[packet::Epoch::Application]
.key_update
.as_ref()
.map(|key_update| key_update.timer);
let timers = [self.idle_timer, path_timer, key_update_timer];
timers.iter().filter_map(|&x| x).min()
}
}
pub fn timeout(&self) -> Option<time::Duration> {
self.timeout_instant().map(|timeout| {
let now = time::Instant::now();
if timeout <= now {
time::Duration::ZERO
} else {
timeout.duration_since(now)
}
})
}
pub fn on_timeout(&mut self) {
let now = time::Instant::now();
if let Some(draining_timer) = self.draining_timer {
if draining_timer <= now {
trace!("{} draining timeout expired", self.trace_id);
self.mark_closed();
}
return;
}
if let Some(timer) = self.idle_timer {
if timer <= now {
trace!("{} idle timeout expired", self.trace_id);
self.mark_closed();
self.timed_out = true;
return;
}
}
if let Some(timer) = self.crypto_ctx[packet::Epoch::Application]
.key_update
.as_ref()
.map(|key_update| key_update.timer)
{
if timer <= now {
let _ = self.crypto_ctx[packet::Epoch::Application]
.key_update
.take();
}
}
let handshake_status = self.handshake_status();
for (_, p) in self.paths.iter_mut() {
if let Some(timer) = p.recovery.loss_detection_timer() {
if timer <= now {
trace!("{} loss detection timeout expired", self.trace_id);
let OnLossDetectionTimeoutOutcome {
lost_packets,
lost_bytes,
} = p.on_loss_detection_timeout(
handshake_status,
now,
self.is_server,
&self.trace_id,
);
self.lost_count += lost_packets;
self.lost_bytes += lost_bytes as u64;
qlog_with_type!(QLOG_METRICS, self.qlog, q, {
if let Some(ev_data) = p.recovery.maybe_qlog() {
q.add_event_data_with_instant(ev_data, now).ok();
}
});
}
}
}
self.paths.notify_failed_validations();
if self.paths.get_active_path_id().is_err() {
match self.paths.find_candidate_path() {
Some(pid) => {
if self.set_active_path(pid, now).is_err() {
self.mark_closed();
}
},
None => {
self.mark_closed();
},
}
}
}
pub fn probe_path(
&mut self, local_addr: SocketAddr, peer_addr: SocketAddr,
) -> Result<u64> {
let pid = match self.paths.path_id_from_addrs(&(local_addr, peer_addr)) {
Some(pid) => pid,
None => self.create_path_on_client(local_addr, peer_addr)?,
};
let path = self.paths.get_mut(pid)?;
path.request_validation();
path.active_dcid_seq.ok_or(Error::InvalidState)
}
pub fn migrate_source(&mut self, local_addr: SocketAddr) -> Result<u64> {
let peer_addr = self.paths.get_active()?.peer_addr();
self.migrate(local_addr, peer_addr)
}
pub fn migrate(
&mut self, local_addr: SocketAddr, peer_addr: SocketAddr,
) -> Result<u64> {
if self.is_server {
return Err(Error::InvalidState);
}
let (pid, dcid_seq) = if let Some(pid) =
self.paths.path_id_from_addrs(&(local_addr, peer_addr))
{
let path = self.paths.get_mut(pid)?;
if path.active() {
return path.active_dcid_seq.ok_or(Error::OutOfIdentifiers);
}
if !self.ids.zero_length_scid() &&
path.active_scid_seq.is_none() &&
self.ids.available_scids() == 0
{
return Err(Error::OutOfIdentifiers);
}
let dcid_seq = if let Some(dcid_seq) = path.active_dcid_seq {
dcid_seq
} else {
let dcid_seq = self
.ids
.lowest_available_dcid_seq()
.ok_or(Error::OutOfIdentifiers)?;
self.ids.link_dcid_to_path_id(dcid_seq, pid)?;
path.active_dcid_seq = Some(dcid_seq);
dcid_seq
};
(pid, dcid_seq)
} else {
let pid = self.create_path_on_client(local_addr, peer_addr)?;
let dcid_seq = self
.paths
.get(pid)?
.active_dcid_seq
.ok_or(Error::InvalidState)?;
(pid, dcid_seq)
};
self.set_active_path(pid, time::Instant::now())?;
Ok(dcid_seq)
}
pub fn new_scid(
&mut self, scid: &ConnectionId, reset_token: u128, retire_if_needed: bool,
) -> Result<u64> {
self.ids.new_scid(
scid.to_vec().into(),
Some(reset_token),
true,
None,
retire_if_needed,
)
}
pub fn active_scids(&self) -> usize {
self.ids.active_source_cids()
}
#[inline]
pub fn scids_left(&self) -> usize {
let max_active_source_cids = cmp::min(
self.peer_transport_params.active_conn_id_limit,
self.local_transport_params.active_conn_id_limit,
) as usize;
max_active_source_cids - self.active_scids()
}
pub fn retire_dcid(&mut self, dcid_seq: u64) -> Result<()> {
if self.ids.zero_length_dcid() {
return Err(Error::InvalidState);
}
let active_path_dcid_seq = self
.paths
.get_active()?
.active_dcid_seq
.ok_or(Error::InvalidState)?;
let active_path_id = self.paths.get_active_path_id()?;
if active_path_dcid_seq == dcid_seq &&
self.ids.lowest_available_dcid_seq().is_none() &&
!self
.paths
.iter()
.any(|(pid, p)| pid != active_path_id && p.usable())
{
return Err(Error::OutOfIdentifiers);
}
if let Some(pid) = self.ids.retire_dcid(dcid_seq)? {
let path = self.paths.get_mut(pid)?;
let dcid_seq = self.ids.lowest_available_dcid_seq();
if let Some(dcid_seq) = dcid_seq {
self.ids.link_dcid_to_path_id(dcid_seq, pid)?;
}
path.active_dcid_seq = dcid_seq;
}
Ok(())
}
pub fn path_event_next(&mut self) -> Option<PathEvent> {
self.paths.pop_event()
}
pub fn retired_scids(&self) -> usize {
self.ids.retired_source_cids()
}
pub fn retired_scid_next(&mut self) -> Option<ConnectionId<'static>> {
self.ids.pop_retired_scid()
}
pub fn available_dcids(&self) -> usize {
self.ids.available_dcids()
}
#[inline]
pub fn paths_iter(&self, from: SocketAddr) -> SocketAddrIter {
SocketAddrIter {
sockaddrs: self
.paths
.iter()
.filter(|(_, p)| p.active_dcid_seq.is_some())
.filter(|(_, p)| p.usable() || p.probing_required())
.filter(|(_, p)| p.local_addr() == from)
.map(|(_, p)| p.peer_addr())
.collect(),
index: 0,
}
}
pub fn close(&mut self, app: bool, err: u64, reason: &[u8]) -> Result<()> {
if self.is_closed() || self.is_draining() {
return Err(Error::Done);
}
if self.local_error.is_some() {
return Err(Error::Done);
}
let is_safe_to_send_app_data =
self.is_established() || self.is_in_early_data();
if app && !is_safe_to_send_app_data {
self.local_error = Some(ConnectionError {
is_app: false,
error_code: 0x0c,
reason: vec![],
});
} else {
self.local_error = Some(ConnectionError {
is_app: app,
error_code: err,
reason: reason.to_vec(),
});
}
if self.recv_count == 0 {
self.mark_closed();
}
Ok(())
}
#[inline]
pub fn trace_id(&self) -> &str {
&self.trace_id
}
#[inline]
pub fn application_proto(&self) -> &[u8] {
self.alpn.as_ref()
}
#[inline]
pub fn server_name(&self) -> Option<&str> {
self.handshake.server_name()
}
#[inline]
pub fn peer_cert(&self) -> Option<&[u8]> {
self.handshake.peer_cert()
}
#[inline]
pub fn peer_cert_chain(&self) -> Option<Vec<&[u8]>> {
self.handshake.peer_cert_chain()
}
#[inline]
pub fn session(&self) -> Option<&[u8]> {
self.session.as_deref()
}
#[inline]
pub fn source_id(&self) -> ConnectionId<'_> {
if let Ok(path) = self.paths.get_active() {
if let Some(active_scid_seq) = path.active_scid_seq {
if let Ok(e) = self.ids.get_scid(active_scid_seq) {
return ConnectionId::from_ref(e.cid.as_ref());
}
}
}
let e = self.ids.oldest_scid();
ConnectionId::from_ref(e.cid.as_ref())
}
#[inline]
pub fn source_ids(&self) -> impl Iterator<Item = &ConnectionId<'_>> {
self.ids.scids_iter()
}
#[inline]
pub fn destination_id(&self) -> ConnectionId<'_> {
if let Ok(path) = self.paths.get_active() {
if let Some(active_dcid_seq) = path.active_dcid_seq {
if let Ok(e) = self.ids.get_dcid(active_dcid_seq) {
return ConnectionId::from_ref(e.cid.as_ref());
}
}
}
let e = self.ids.oldest_dcid();
ConnectionId::from_ref(e.cid.as_ref())
}
#[inline]
pub fn is_established(&self) -> bool {
self.handshake_completed
}
#[inline]
pub fn is_resumed(&self) -> bool {
self.handshake.is_resumed()
}
#[inline]
pub fn is_in_early_data(&self) -> bool {
self.handshake.is_in_early_data()
}
#[inline]
pub fn is_readable(&self) -> bool {
self.streams.has_readable() || self.dgram_recv_front_len().is_some()
}
pub fn is_path_validated(
&self, from: SocketAddr, to: SocketAddr,
) -> Result<bool> {
let pid = self
.paths
.path_id_from_addrs(&(from, to))
.ok_or(Error::InvalidState)?;
Ok(self.paths.get(pid)?.validated())
}
#[inline]
pub fn is_draining(&self) -> bool {
self.draining_timer.is_some()
}
#[inline]
pub fn is_closed(&self) -> bool {
self.closed
}
#[inline]
pub fn is_timed_out(&self) -> bool {
self.timed_out
}
#[inline]
pub fn peer_error(&self) -> Option<&ConnectionError> {
self.peer_error.as_ref()
}
#[inline]
pub fn local_error(&self) -> Option<&ConnectionError> {
self.local_error.as_ref()
}
#[inline]
pub fn stats(&self) -> Stats {
Stats {
recv: self.recv_count,
sent: self.sent_count,
lost: self.lost_count,
spurious_lost: self.spurious_lost_count,
retrans: self.retrans_count,
sent_bytes: self.sent_bytes,
recv_bytes: self.recv_bytes,
acked_bytes: self.acked_bytes,
lost_bytes: self.lost_bytes,
stream_retrans_bytes: self.stream_retrans_bytes,
dgram_recv: self.dgram_recv_count,
dgram_sent: self.dgram_sent_count,
paths_count: self.paths.len(),
reset_stream_count_local: self.reset_stream_local_count,
stopped_stream_count_local: self.stopped_stream_local_count,
reset_stream_count_remote: self.reset_stream_remote_count,
stopped_stream_count_remote: self.stopped_stream_remote_count,
path_challenge_rx_count: self.path_challenge_rx_count,
bytes_in_flight_duration: self.bytes_in_flight_duration(),
}
}
fn bytes_in_flight_duration(&self) -> Duration {
self.paths.iter().fold(Duration::ZERO, |acc, (_, path)| {
acc + path.bytes_in_flight_duration()
})
}
pub fn peer_transport_params(&self) -> Option<&TransportParams> {
if !self.parsed_peer_transport_params {
return None;
}
Some(&self.peer_transport_params)
}
pub fn path_stats(&self) -> impl Iterator<Item = PathStats> + '_ {
self.paths.iter().map(|(_, p)| p.stats())
}
pub fn is_server(&self) -> bool {
self.is_server
}
fn encode_transport_params(&mut self) -> Result<()> {
self.handshake.set_quic_transport_params(
&self.local_transport_params,
self.is_server,
)
}
fn parse_peer_transport_params(
&mut self, peer_params: TransportParams,
) -> Result<()> {
match &peer_params.initial_source_connection_id {
Some(v) if v != &self.destination_id() =>
return Err(Error::InvalidTransportParam),
Some(_) => (),
None => return Err(Error::InvalidTransportParam),
}
if let Some(odcid) = &self.odcid {
match &peer_params.original_destination_connection_id {
Some(v) if v != odcid =>
return Err(Error::InvalidTransportParam),
Some(_) => (),
None if !self.is_server =>
return Err(Error::InvalidTransportParam),
None => (),
}
}
if let Some(rscid) = &self.rscid {
match &peer_params.retry_source_connection_id {
Some(v) if v != rscid =>
return Err(Error::InvalidTransportParam),
Some(_) => (),
None => return Err(Error::InvalidTransportParam),
}
}
self.process_peer_transport_params(peer_params)?;
self.parsed_peer_transport_params = true;
Ok(())
}
fn process_peer_transport_params(
&mut self, peer_params: TransportParams,
) -> Result<()> {
self.max_tx_data = peer_params.initial_max_data;
self.update_tx_cap();
self.streams
.update_peer_max_streams_bidi(peer_params.initial_max_streams_bidi);
self.streams
.update_peer_max_streams_uni(peer_params.initial_max_streams_uni);
let max_ack_delay =
time::Duration::from_millis(peer_params.max_ack_delay);
self.recovery_config.max_ack_delay = max_ack_delay;
let active_path = self.paths.get_active_mut()?;
active_path.recovery.update_max_ack_delay(max_ack_delay);
if active_path.pmtud.get_should_probe() {
active_path.recovery.pmtud_update_max_datagram_size(
active_path
.pmtud
.get_probe_size()
.min(peer_params.max_udp_payload_size as usize),
);
} else {
active_path.recovery.update_max_datagram_size(
peer_params.max_udp_payload_size as usize,
);
}
self.ids
.set_source_conn_id_limit(peer_params.active_conn_id_limit);
self.peer_transport_params = peer_params;
Ok(())
}
fn do_handshake(&mut self, now: time::Instant) -> Result<()> {
let mut ex_data = tls::ExData {
application_protos: &self.application_protos,
crypto_ctx: &mut self.crypto_ctx,
session: &mut self.session,
local_error: &mut self.local_error,
keylog: self.keylog.as_mut(),
trace_id: &self.trace_id,
local_transport_params: self.local_transport_params.clone(),
recovery_config: self.recovery_config,
tx_cap_factor: self.tx_cap_factor,
pmtud: None,
is_server: self.is_server,
};
if self.handshake_completed {
return self.handshake.process_post_handshake(&mut ex_data);
}
match self.handshake.do_handshake(&mut ex_data) {
Ok(_) => (),
Err(Error::Done) => {
if self.sent_count == 0 {
if ex_data.recovery_config != self.recovery_config {
if let Ok(path) = self.paths.get_active_mut() {
self.recovery_config = ex_data.recovery_config;
path.reinit_recovery(&self.recovery_config);
}
}
if ex_data.tx_cap_factor != self.tx_cap_factor {
self.tx_cap_factor = ex_data.tx_cap_factor;
}
if let Some(discover) = ex_data.pmtud {
self.paths.set_discover_pmtu_on_existing_paths(
discover,
self.recovery_config.max_send_udp_payload_size,
);
}
if ex_data.local_transport_params !=
self.local_transport_params
{
self.streams.set_max_streams_bidi(
ex_data
.local_transport_params
.initial_max_streams_bidi,
);
self.local_transport_params =
ex_data.local_transport_params;
}
}
let raw_params = self.handshake.quic_transport_params();
if !self.parsed_peer_transport_params && !raw_params.is_empty() {
let peer_params = TransportParams::decode(
raw_params,
self.is_server,
self.peer_transport_params_track_unknown,
)?;
self.parse_peer_transport_params(peer_params)?;
}
return Ok(());
},
Err(e) => return Err(e),
};
self.handshake_completed = self.handshake.is_completed();
self.alpn = self.handshake.alpn_protocol().to_vec();
let raw_params = self.handshake.quic_transport_params();
if !self.parsed_peer_transport_params && !raw_params.is_empty() {
let peer_params = TransportParams::decode(
raw_params,
self.is_server,
self.peer_transport_params_track_unknown,
)?;
self.parse_peer_transport_params(peer_params)?;
}
if self.handshake_completed {
if self.is_server {
self.handshake_confirmed = true;
self.drop_epoch_state(packet::Epoch::Handshake, now);
}
self.undecryptable_pkts.clear();
trace!("{} connection established: proto={:?} cipher={:?} curve={:?} sigalg={:?} resumed={} {:?}",
&self.trace_id,
std::str::from_utf8(self.application_proto()),
self.handshake.cipher(),
self.handshake.curve(),
self.handshake.sigalg(),
self.handshake.is_resumed(),
self.peer_transport_params);
}
Ok(())
}
fn write_pkt_type(&self, send_pid: usize) -> Result<packet::Type> {
if self
.local_error
.as_ref()
.is_some_and(|conn_err| !conn_err.is_app)
{
let epoch = match self.handshake.write_level() {
crypto::Level::Initial => packet::Epoch::Initial,
crypto::Level::ZeroRTT => unreachable!(),
crypto::Level::Handshake => packet::Epoch::Handshake,
crypto::Level::OneRTT => packet::Epoch::Application,
};
if !self.handshake_confirmed {
match epoch {
packet::Epoch::Application =>
return Ok(packet::Type::Handshake),
packet::Epoch::Handshake
if self.crypto_ctx[packet::Epoch::Initial].has_keys() =>
return Ok(packet::Type::Initial),
_ => (),
};
}
return Ok(packet::Type::from_epoch(epoch));
}
for &epoch in packet::Epoch::epochs(
packet::Epoch::Initial..=packet::Epoch::Application,
) {
let crypto_ctx = &self.crypto_ctx[epoch];
let pkt_space = &self.pkt_num_spaces[epoch];
if crypto_ctx.crypto_seal.is_none() {
continue;
}
if crypto_ctx.data_available() || pkt_space.ready() {
return Ok(packet::Type::from_epoch(epoch));
}
for (_, p) in self.paths.iter() {
if p.recovery.has_lost_frames(epoch) {
return Ok(packet::Type::from_epoch(epoch));
}
if p.recovery.loss_probes(epoch) > 0 {
return Ok(packet::Type::from_epoch(epoch));
}
}
}
let send_path = self.paths.get(send_pid)?;
if (self.is_established() || self.is_in_early_data()) &&
(self.should_send_handshake_done() ||
self.almost_full ||
self.blocked_limit.is_some() ||
self.dgram_send_queue.has_pending() ||
self.local_error
.as_ref()
.is_some_and(|conn_err| conn_err.is_app) ||
self.streams.should_update_max_streams_bidi() ||
self.streams.should_update_max_streams_uni() ||
self.streams.has_flushable() ||
self.streams.has_almost_full() ||
self.streams.has_blocked() ||
self.streams.has_reset() ||
self.streams.has_stopped() ||
self.ids.has_new_scids() ||
self.ids.has_retire_dcids() ||
send_path.pmtud.get_should_probe() ||
send_path.needs_ack_eliciting ||
send_path.probing_required())
{
if !self.is_server && self.is_in_early_data() {
return Ok(packet::Type::ZeroRTT);
}
return Ok(packet::Type::Short);
}
Err(Error::Done)
}
fn get_or_create_stream(
&mut self, id: u64, local: bool,
) -> Result<&mut stream::Stream<F>> {
self.streams.get_or_create(
id,
&self.local_transport_params,
&self.peer_transport_params,
local,
self.is_server,
)
}
fn process_frame(
&mut self, frame: frame::Frame, hdr: &packet::Header,
recv_path_id: usize, epoch: packet::Epoch, now: time::Instant,
) -> Result<()> {
trace!("{} rx frm {:?}", self.trace_id, frame);
match frame {
frame::Frame::Padding { .. } => (),
frame::Frame::Ping { .. } => (),
frame::Frame::ACK {
ranges, ack_delay, ..
} => {
let ack_delay = ack_delay
.checked_mul(2_u64.pow(
self.peer_transport_params.ack_delay_exponent as u32,
))
.ok_or(Error::InvalidFrame)?;
if epoch == packet::Epoch::Handshake ||
(epoch == packet::Epoch::Application &&
self.is_established())
{
self.peer_verified_initial_address = true;
}
let handshake_status = self.handshake_status();
let is_app_limited = self.delivery_rate_check_if_app_limited();
let largest_acked = ranges.last().expect(
"ACK frames should always have at least one ack range",
);
for (_, p) in self.paths.iter_mut() {
if self.pkt_num_spaces[epoch]
.largest_tx_pkt_num
.is_some_and(|largest_sent| largest_sent < largest_acked)
{
return Err(Error::InvalidAckRange);
}
if is_app_limited {
p.recovery.delivery_rate_update_app_limited(true);
}
let OnAckReceivedOutcome {
lost_packets,
lost_bytes,
acked_bytes,
spurious_losses,
} = p.recovery.on_ack_received(
&ranges,
ack_delay,
epoch,
handshake_status,
now,
self.pkt_num_manager.skip_pn(),
&self.trace_id,
)?;
let skip_pn = self.pkt_num_manager.skip_pn();
let largest_acked =
p.recovery.get_largest_acked_on_epoch(epoch);
if let Some((largest_acked, skip_pn)) =
largest_acked.zip(skip_pn)
{
if largest_acked > skip_pn {
self.pkt_num_manager.set_skip_pn(None);
}
}
self.lost_count += lost_packets;
self.lost_bytes += lost_bytes as u64;
self.acked_bytes += acked_bytes as u64;
self.spurious_lost_count += spurious_losses;
}
},
frame::Frame::ResetStream {
stream_id,
error_code,
final_size,
} => {
if !stream::is_bidi(stream_id) &&
stream::is_local(stream_id, self.is_server)
{
return Err(Error::InvalidStreamState(stream_id));
}
let max_rx_data_left = self.max_rx_data() - self.rx_data;
let stream = match self.get_or_create_stream(stream_id, false) {
Ok(v) => v,
Err(Error::Done) => return Ok(()),
Err(e) => return Err(e),
};
let was_readable = stream.is_readable();
let priority_key = Arc::clone(&stream.priority_key);
let max_off_delta =
stream.recv.reset(error_code, final_size)? as u64;
if max_off_delta > max_rx_data_left {
return Err(Error::FlowControl);
}
if !was_readable && stream.is_readable() {
self.streams.insert_readable(&priority_key);
}
self.rx_data += max_off_delta;
self.reset_stream_remote_count =
self.reset_stream_remote_count.saturating_add(1);
},
frame::Frame::StopSending {
stream_id,
error_code,
} => {
if !stream::is_local(stream_id, self.is_server) &&
!stream::is_bidi(stream_id)
{
return Err(Error::InvalidStreamState(stream_id));
}
let stream = match self.get_or_create_stream(stream_id, false) {
Ok(v) => v,
Err(Error::Done) => return Ok(()),
Err(e) => return Err(e),
};
let was_writable = stream.is_writable();
let priority_key = Arc::clone(&stream.priority_key);
if let Ok((final_size, unsent)) = stream.send.stop(error_code) {
self.tx_data = self.tx_data.saturating_sub(unsent);
self.tx_buffered =
self.tx_buffered.saturating_sub(unsent as usize);
self.streams.insert_reset(stream_id, error_code, final_size);
if !was_writable {
self.streams.insert_writable(&priority_key);
}
self.stopped_stream_remote_count =
self.stopped_stream_remote_count.saturating_add(1);
self.reset_stream_local_count =
self.reset_stream_local_count.saturating_add(1);
}
},
frame::Frame::Crypto { data } => {
if data.max_off() >= MAX_CRYPTO_STREAM_OFFSET {
return Err(Error::CryptoBufferExceeded);
}
self.crypto_ctx[epoch].crypto_stream.recv.write(data)?;
let mut crypto_buf = [0; 512];
let level = crypto::Level::from_epoch(epoch);
let stream = &mut self.crypto_ctx[epoch].crypto_stream;
while let Ok((read, _)) = stream.recv.emit(&mut crypto_buf) {
let recv_buf = &crypto_buf[..read];
self.handshake.provide_data(level, recv_buf)?;
}
self.do_handshake(now)?;
},
frame::Frame::CryptoHeader { .. } => unreachable!(),
frame::Frame::NewToken { .. } =>
if self.is_server {
return Err(Error::InvalidPacket);
},
frame::Frame::Stream { stream_id, data } => {
if !stream::is_bidi(stream_id) &&
stream::is_local(stream_id, self.is_server)
{
return Err(Error::InvalidStreamState(stream_id));
}
let max_rx_data_left = self.max_rx_data() - self.rx_data;
let stream = match self.get_or_create_stream(stream_id, false) {
Ok(v) => v,
Err(Error::Done) => return Ok(()),
Err(e) => return Err(e),
};
let max_off_delta =
data.max_off().saturating_sub(stream.recv.max_off());
if max_off_delta > max_rx_data_left {
return Err(Error::FlowControl);
}
let was_readable = stream.is_readable();
let priority_key = Arc::clone(&stream.priority_key);
let was_draining = stream.recv.is_draining();
stream.recv.write(data)?;
if !was_readable && stream.is_readable() {
self.streams.insert_readable(&priority_key);
}
self.rx_data += max_off_delta;
if was_draining {
self.flow_control.add_consumed(max_off_delta);
if self.should_update_max_data() {
self.almost_full = true;
}
}
},
frame::Frame::StreamHeader { .. } => unreachable!(),
frame::Frame::MaxData { max } => {
self.max_tx_data = cmp::max(self.max_tx_data, max);
},
frame::Frame::MaxStreamData { stream_id, max } => {
if !stream::is_bidi(stream_id) &&
!stream::is_local(stream_id, self.is_server)
{
return Err(Error::InvalidStreamState(stream_id));
}
let stream = match self.get_or_create_stream(stream_id, false) {
Ok(v) => v,
Err(Error::Done) => return Ok(()),
Err(e) => return Err(e),
};
let was_flushable = stream.is_flushable();
stream.send.update_max_data(max);
let writable = stream.is_writable();
let priority_key = Arc::clone(&stream.priority_key);
if stream.is_flushable() && !was_flushable {
let priority_key = Arc::clone(&stream.priority_key);
self.streams.insert_flushable(&priority_key);
}
if writable {
self.streams.insert_writable(&priority_key);
}
},
frame::Frame::MaxStreamsBidi { max } => {
if max > MAX_STREAM_ID {
return Err(Error::InvalidFrame);
}
self.streams.update_peer_max_streams_bidi(max);
},
frame::Frame::MaxStreamsUni { max } => {
if max > MAX_STREAM_ID {
return Err(Error::InvalidFrame);
}
self.streams.update_peer_max_streams_uni(max);
},
frame::Frame::DataBlocked { .. } => (),
frame::Frame::StreamDataBlocked { .. } => (),
frame::Frame::StreamsBlockedBidi { limit } => {
if limit > MAX_STREAM_ID {
return Err(Error::InvalidFrame);
}
},
frame::Frame::StreamsBlockedUni { limit } => {
if limit > MAX_STREAM_ID {
return Err(Error::InvalidFrame);
}
},
frame::Frame::NewConnectionId {
seq_num,
retire_prior_to,
conn_id,
reset_token,
} => {
if self.ids.zero_length_dcid() {
return Err(Error::InvalidState);
}
let mut retired_path_ids = SmallVec::new();
let new_dcid_res = self.ids.new_dcid(
conn_id.into(),
seq_num,
u128::from_be_bytes(reset_token),
retire_prior_to,
&mut retired_path_ids,
);
for (dcid_seq, pid) in retired_path_ids {
let path = self.paths.get_mut(pid)?;
if path.active_dcid_seq != Some(dcid_seq) {
continue;
}
if let Some(new_dcid_seq) =
self.ids.lowest_available_dcid_seq()
{
path.active_dcid_seq = Some(new_dcid_seq);
self.ids.link_dcid_to_path_id(new_dcid_seq, pid)?;
trace!(
"{} path ID {} changed DCID: old seq num {} new seq num {}",
self.trace_id, pid, dcid_seq, new_dcid_seq,
);
} else {
path.active_dcid_seq = None;
trace!(
"{} path ID {} cannot be used; DCID seq num {} has been retired",
self.trace_id, pid, dcid_seq,
);
}
}
new_dcid_res?;
},
frame::Frame::RetireConnectionId { seq_num } => {
if self.ids.zero_length_scid() {
return Err(Error::InvalidState);
}
if let Some(pid) = self.ids.retire_scid(seq_num, &hdr.dcid)? {
let path = self.paths.get_mut(pid)?;
if path.active_scid_seq == Some(seq_num) {
path.active_scid_seq = None;
}
}
},
frame::Frame::PathChallenge { data } => {
self.path_challenge_rx_count += 1;
self.paths
.get_mut(recv_path_id)?
.on_challenge_received(data);
},
frame::Frame::PathResponse { data } => {
self.paths.on_response_received(data)?;
},
frame::Frame::ConnectionClose {
error_code, reason, ..
} => {
self.peer_error = Some(ConnectionError {
is_app: false,
error_code,
reason,
});
let path = self.paths.get_active()?;
self.draining_timer = Some(now + (path.recovery.pto() * 3));
},
frame::Frame::ApplicationClose { error_code, reason } => {
self.peer_error = Some(ConnectionError {
is_app: true,
error_code,
reason,
});
let path = self.paths.get_active()?;
self.draining_timer = Some(now + (path.recovery.pto() * 3));
},
frame::Frame::HandshakeDone => {
if self.is_server {
return Err(Error::InvalidPacket);
}
self.peer_verified_initial_address = true;
self.handshake_confirmed = true;
self.drop_epoch_state(packet::Epoch::Handshake, now);
},
frame::Frame::Datagram { data } => {
if !self.dgram_enabled() {
return Err(Error::InvalidState);
}
if self.dgram_recv_queue.is_full() {
self.dgram_recv_queue.pop();
}
self.dgram_recv_queue.push(data)?;
let _ = self.dgram_recv_count.saturating_add(1);
let _ = self
.paths
.get_mut(recv_path_id)?
.dgram_recv_count
.saturating_add(1);
},
frame::Frame::DatagramHeader { .. } => unreachable!(),
}
Ok(())
}
fn drop_epoch_state(&mut self, epoch: packet::Epoch, now: time::Instant) {
let crypto_ctx = &mut self.crypto_ctx[epoch];
if crypto_ctx.crypto_open.is_none() {
return;
}
crypto_ctx.clear();
self.pkt_num_spaces[epoch].clear();
let handshake_status = self.handshake_status();
for (_, p) in self.paths.iter_mut() {
p.recovery
.on_pkt_num_space_discarded(epoch, handshake_status, now);
}
trace!("{} dropped epoch {} state", self.trace_id, epoch);
}
fn should_update_max_data(&self) -> bool {
self.flow_control.should_update_max_data()
}
fn max_rx_data(&self) -> u64 {
self.flow_control.max_data()
}
fn should_send_handshake_done(&self) -> bool {
self.is_established() && !self.handshake_done_sent && self.is_server
}
fn idle_timeout(&self) -> Option<time::Duration> {
if self.local_transport_params.max_idle_timeout == 0 &&
self.peer_transport_params.max_idle_timeout == 0
{
return None;
}
let idle_timeout = if self.local_transport_params.max_idle_timeout == 0 {
self.peer_transport_params.max_idle_timeout
} else if self.peer_transport_params.max_idle_timeout == 0 {
self.local_transport_params.max_idle_timeout
} else {
cmp::min(
self.local_transport_params.max_idle_timeout,
self.peer_transport_params.max_idle_timeout,
)
};
let path_pto = match self.paths.get_active() {
Ok(p) => p.recovery.pto(),
Err(_) => time::Duration::ZERO,
};
let idle_timeout = time::Duration::from_millis(idle_timeout);
let idle_timeout = cmp::max(idle_timeout, 3 * path_pto);
Some(idle_timeout)
}
fn handshake_status(&self) -> recovery::HandshakeStatus {
recovery::HandshakeStatus {
has_handshake_keys: self.crypto_ctx[packet::Epoch::Handshake]
.has_keys(),
peer_verified_address: self.peer_verified_initial_address,
completed: self.is_established(),
}
}
fn update_tx_cap(&mut self) {
let cwin_available = match self.paths.get_active() {
Ok(p) => p.recovery.cwnd_available() as u64,
Err(_) => 0,
};
let cap =
cmp::min(cwin_available, self.max_tx_data - self.tx_data) as usize;
self.tx_cap = (cap as f64 * self.tx_cap_factor).ceil() as usize;
}
fn delivery_rate_check_if_app_limited(&self) -> bool {
let cwin_available = self
.paths
.iter()
.filter(|&(_, p)| p.active())
.map(|(_, p)| p.recovery.cwnd_available())
.sum();
((self.tx_buffered + self.dgram_send_queue_byte_size()) < cwin_available) &&
(self.tx_data.saturating_sub(self.last_tx_data)) <
cwin_available as u64 &&
cwin_available > 0
}
fn set_initial_dcid(
&mut self, cid: ConnectionId<'static>, reset_token: Option<u128>,
path_id: usize,
) -> Result<()> {
self.ids.set_initial_dcid(cid, reset_token, Some(path_id));
self.paths.get_mut(path_id)?.active_dcid_seq = Some(0);
Ok(())
}
fn get_or_create_recv_path_id(
&mut self, recv_pid: Option<usize>, dcid: &ConnectionId, buf_len: usize,
info: &RecvInfo,
) -> Result<usize> {
let ids = &mut self.ids;
let (in_scid_seq, mut in_scid_pid) =
ids.find_scid_seq(dcid).ok_or(Error::InvalidState)?;
if let Some(recv_pid) = recv_pid {
let recv_path = self.paths.get_mut(recv_pid)?;
let cid_entry =
recv_path.active_scid_seq.and_then(|v| ids.get_scid(v).ok());
if cid_entry.map(|e| &e.cid) != Some(dcid) {
let incoming_cid_entry = ids.get_scid(in_scid_seq)?;
let prev_recv_pid =
incoming_cid_entry.path_id.unwrap_or(recv_pid);
if prev_recv_pid != recv_pid {
trace!(
"{} peer reused CID {:?} from path {} on path {}",
self.trace_id,
dcid,
prev_recv_pid,
recv_pid
);
}
trace!(
"{} path ID {} now see SCID with seq num {}",
self.trace_id,
recv_pid,
in_scid_seq
);
recv_path.active_scid_seq = Some(in_scid_seq);
ids.link_scid_to_path_id(in_scid_seq, recv_pid)?;
}
return Ok(recv_pid);
}
if ids.zero_length_scid() {
in_scid_pid = None;
}
if let Some(in_scid_pid) = in_scid_pid {
let old_path = self.paths.get_mut(in_scid_pid)?;
let old_local_addr = old_path.local_addr();
let old_peer_addr = old_path.peer_addr();
trace!(
"{} reused CID seq {} of ({},{}) (path {}) on ({},{})",
self.trace_id,
in_scid_seq,
old_local_addr,
old_peer_addr,
in_scid_pid,
info.to,
info.from
);
self.paths
.notify_event(path::PathEvent::ReusedSourceConnectionId(
in_scid_seq,
(old_local_addr, old_peer_addr),
(info.to, info.from),
));
}
let mut path = path::Path::new(
info.to,
info.from,
&self.recovery_config,
self.path_challenge_recv_max_queue_len,
MIN_CLIENT_INITIAL_LEN,
false,
);
path.max_send_bytes = buf_len * self.max_amplification_factor;
path.active_scid_seq = Some(in_scid_seq);
path.request_validation();
let pid = self.paths.insert_path(path, self.is_server)?;
if in_scid_pid.is_none() {
ids.link_scid_to_path_id(in_scid_seq, pid)?;
}
Ok(pid)
}
fn get_send_path_id(
&self, from: Option<SocketAddr>, to: Option<SocketAddr>,
) -> Result<usize> {
if self.is_established() {
let mut probing = self
.paths
.iter()
.filter(|(_, p)| from.is_none() || Some(p.local_addr()) == from)
.filter(|(_, p)| to.is_none() || Some(p.peer_addr()) == to)
.filter(|(_, p)| p.active_dcid_seq.is_some())
.filter(|(_, p)| p.probing_required())
.map(|(pid, _)| pid);
if let Some(pid) = probing.next() {
return Ok(pid);
}
}
if let Some((pid, p)) = self.paths.get_active_with_pid() {
if from.is_some() && Some(p.local_addr()) != from {
return Err(Error::Done);
}
if to.is_some() && Some(p.peer_addr()) != to {
return Err(Error::Done);
}
return Ok(pid);
};
Err(Error::InvalidState)
}
fn set_active_path(
&mut self, path_id: usize, now: time::Instant,
) -> Result<()> {
if let Ok(old_active_path) = self.paths.get_active_mut() {
for &e in packet::Epoch::epochs(
packet::Epoch::Initial..=packet::Epoch::Application,
) {
let (lost_packets, lost_bytes) = old_active_path
.recovery
.on_path_change(e, now, &self.trace_id);
self.lost_count += lost_packets;
self.lost_bytes += lost_bytes as u64;
}
}
self.paths.set_active_path(path_id)
}
fn on_peer_migrated(
&mut self, new_pid: usize, disable_dcid_reuse: bool, now: time::Instant,
) -> Result<()> {
let active_path_id = self.paths.get_active_path_id()?;
if active_path_id == new_pid {
return Ok(());
}
self.set_active_path(new_pid, now)?;
let no_spare_dcid =
self.paths.get_mut(new_pid)?.active_dcid_seq.is_none();
if no_spare_dcid && !disable_dcid_reuse {
self.paths.get_mut(new_pid)?.active_dcid_seq =
self.paths.get_mut(active_path_id)?.active_dcid_seq;
}
Ok(())
}
fn create_path_on_client(
&mut self, local_addr: SocketAddr, peer_addr: SocketAddr,
) -> Result<usize> {
if self.is_server {
return Err(Error::InvalidState);
}
if !self.ids.zero_length_scid() && self.ids.available_scids() == 0 {
return Err(Error::OutOfIdentifiers);
}
let dcid_seq = if self.ids.zero_length_dcid() {
0
} else {
self.ids
.lowest_available_dcid_seq()
.ok_or(Error::OutOfIdentifiers)?
};
let mut path = path::Path::new(
local_addr,
peer_addr,
&self.recovery_config,
self.path_challenge_recv_max_queue_len,
MIN_CLIENT_INITIAL_LEN,
false,
);
path.active_dcid_seq = Some(dcid_seq);
let pid = self
.paths
.insert_path(path, false)
.map_err(|_| Error::OutOfIdentifiers)?;
self.ids.link_dcid_to_path_id(dcid_seq, pid)?;
Ok(pid)
}
fn mark_closed(&mut self) {
#[cfg(feature = "qlog")]
{
let cc = match (self.is_established(), self.timed_out, &self.peer_error, &self.local_error) {
(false, _, _, _) => qlog::events::connectivity::ConnectionClosed {
owner: Some(TransportOwner::Local),
connection_code: None,
application_code: None,
internal_code: None,
reason: Some("Failed to establish connection".to_string()),
trigger: Some(qlog::events::connectivity::ConnectionClosedTrigger::HandshakeTimeout)
},
(true, true, _, _) => qlog::events::connectivity::ConnectionClosed {
owner: Some(TransportOwner::Local),
connection_code: None,
application_code: None,
internal_code: None,
reason: Some("Idle timeout".to_string()),
trigger: Some(qlog::events::connectivity::ConnectionClosedTrigger::IdleTimeout)
},
(true, false, Some(peer_error), None) => {
let (connection_code, application_code, trigger) = if peer_error.is_app {
(None, Some(qlog::events::ApplicationErrorCode::Value(peer_error.error_code)), None)
} else {
let trigger = if peer_error.error_code == WireErrorCode::NoError as u64 {
Some(qlog::events::connectivity::ConnectionClosedTrigger::Clean)
} else {
Some(qlog::events::connectivity::ConnectionClosedTrigger::Error)
};
(Some(qlog::events::ConnectionErrorCode::Value(peer_error.error_code)), None, trigger)
};
qlog::events::connectivity::ConnectionClosed {
owner: Some(TransportOwner::Remote),
connection_code,
application_code,
internal_code: None,
reason: Some(String::from_utf8_lossy(&peer_error.reason).to_string()),
trigger,
}
},
(true, false, None, Some(local_error)) => {
let (connection_code, application_code, trigger) = if local_error.is_app {
(None, Some(qlog::events::ApplicationErrorCode::Value(local_error.error_code)), None)
} else {
let trigger = if local_error.error_code == WireErrorCode::NoError as u64 {
Some(qlog::events::connectivity::ConnectionClosedTrigger::Clean)
} else {
Some(qlog::events::connectivity::ConnectionClosedTrigger::Error)
};
(Some(qlog::events::ConnectionErrorCode::Value(local_error.error_code)), None, trigger)
};
qlog::events::connectivity::ConnectionClosed {
owner: Some(TransportOwner::Local),
connection_code,
application_code,
internal_code: None,
reason: Some(String::from_utf8_lossy(&local_error.reason).to_string()),
trigger,
}
},
_ => qlog::events::connectivity::ConnectionClosed {
owner: None,
connection_code: None,
application_code: None,
internal_code: None,
reason: None,
trigger: None,
},
};
qlog_with_type!(QLOG_CONNECTION_CLOSED, self.qlog, q, {
let ev_data = qlog::events::EventData::ConnectionClosed(cc);
q.add_event_data_now(ev_data).ok();
});
self.qlog.streamer = None;
}
self.closed = true;
}
}
#[cfg(feature = "boringssl-boring-crate")]
impl<F: BufFactory> AsMut<boring::ssl::SslRef> for Connection<F> {
fn as_mut(&mut self) -> &mut boring::ssl::SslRef {
self.handshake.ssl_mut()
}
}
fn drop_pkt_on_err(
e: Error, recv_count: usize, is_server: bool, trace_id: &str,
) -> Error {
if is_server && recv_count == 0 {
return e;
}
trace!("{} dropped invalid packet", trace_id);
Error::Done
}
struct AddrTupleFmt(SocketAddr, SocketAddr);
impl std::fmt::Display for AddrTupleFmt {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let AddrTupleFmt(src, dst) = &self;
if src.ip().is_unspecified() || dst.ip().is_unspecified() {
return Ok(());
}
f.write_fmt(format_args!("src:{src} dst:{dst}"))
}
}
#[derive(Clone, Default)]
pub struct Stats {
pub recv: usize,
pub sent: usize,
pub lost: usize,
pub spurious_lost: usize,
pub retrans: usize,
pub sent_bytes: u64,
pub recv_bytes: u64,
pub acked_bytes: u64,
pub lost_bytes: u64,
pub stream_retrans_bytes: u64,
pub dgram_recv: usize,
pub dgram_sent: usize,
pub paths_count: usize,
pub reset_stream_count_local: u64,
pub stopped_stream_count_local: u64,
pub reset_stream_count_remote: u64,
pub stopped_stream_count_remote: u64,
pub path_challenge_rx_count: u64,
pub bytes_in_flight_duration: Duration,
}
impl std::fmt::Debug for Stats {
#[inline]
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(
f,
"recv={} sent={} lost={} retrans={}",
self.recv, self.sent, self.lost, self.retrans,
)?;
write!(
f,
" sent_bytes={} recv_bytes={} lost_bytes={}",
self.sent_bytes, self.recv_bytes, self.lost_bytes,
)?;
Ok(())
}
}
#[derive(Clone, Debug, PartialEq)]
pub struct UnknownTransportParameter<T> {
pub id: u64,
pub value: T,
}
impl<T> UnknownTransportParameter<T> {
pub fn is_reserved(&self) -> bool {
let n = (self.id - 27) / 31;
self.id == 31 * n + 27
}
}
#[cfg(feature = "qlog")]
impl From<UnknownTransportParameter<Vec<u8>>>
for qlog::events::quic::UnknownTransportParameter
{
fn from(value: UnknownTransportParameter<Vec<u8>>) -> Self {
Self {
id: value.id,
value: qlog::HexSlice::maybe_string(Some(value.value.as_slice()))
.unwrap_or_default(),
}
}
}
impl From<UnknownTransportParameter<&[u8]>>
for UnknownTransportParameter<Vec<u8>>
{
fn from(value: UnknownTransportParameter<&[u8]>) -> Self {
Self {
id: value.id,
value: value.value.to_vec(),
}
}
}
#[derive(Clone, Debug, PartialEq, Default)]
pub struct UnknownTransportParameters {
pub capacity: usize,
pub parameters: Vec<UnknownTransportParameter<Vec<u8>>>,
}
impl UnknownTransportParameters {
pub fn push(&mut self, new: UnknownTransportParameter<&[u8]>) -> Result<()> {
let new_unknown_tp_size = new.value.len() + std::mem::size_of::<u64>();
if new_unknown_tp_size < self.capacity {
self.capacity -= new_unknown_tp_size;
self.parameters.push(new.into());
Ok(())
} else {
Err(BufferTooShortError.into())
}
}
}
pub struct UnknownTransportParameterIterator<'a> {
index: usize,
parameters: &'a Vec<UnknownTransportParameter<Vec<u8>>>,
}
impl<'a> IntoIterator for &'a UnknownTransportParameters {
type IntoIter = UnknownTransportParameterIterator<'a>;
type Item = &'a UnknownTransportParameter<Vec<u8>>;
fn into_iter(self) -> Self::IntoIter {
UnknownTransportParameterIterator {
index: 0,
parameters: &self.parameters,
}
}
}
impl<'a> Iterator for UnknownTransportParameterIterator<'a> {
type Item = &'a UnknownTransportParameter<Vec<u8>>;
fn next(&mut self) -> Option<Self::Item> {
let result = self.parameters.get(self.index);
self.index += 1;
result
}
}
#[derive(Clone, Debug, PartialEq)]
pub struct TransportParams {
pub original_destination_connection_id: Option<ConnectionId<'static>>,
pub max_idle_timeout: u64,
pub stateless_reset_token: Option<u128>,
pub max_udp_payload_size: u64,
pub initial_max_data: u64,
pub initial_max_stream_data_bidi_local: u64,
pub initial_max_stream_data_bidi_remote: u64,
pub initial_max_stream_data_uni: u64,
pub initial_max_streams_bidi: u64,
pub initial_max_streams_uni: u64,
pub ack_delay_exponent: u64,
pub max_ack_delay: u64,
pub disable_active_migration: bool,
pub active_conn_id_limit: u64,
pub initial_source_connection_id: Option<ConnectionId<'static>>,
pub retry_source_connection_id: Option<ConnectionId<'static>>,
pub max_datagram_frame_size: Option<u64>,
pub unknown_params: Option<UnknownTransportParameters>,
}
impl Default for TransportParams {
fn default() -> TransportParams {
TransportParams {
original_destination_connection_id: None,
max_idle_timeout: 0,
stateless_reset_token: None,
max_udp_payload_size: 65527,
initial_max_data: 0,
initial_max_stream_data_bidi_local: 0,
initial_max_stream_data_bidi_remote: 0,
initial_max_stream_data_uni: 0,
initial_max_streams_bidi: 0,
initial_max_streams_uni: 0,
ack_delay_exponent: 3,
max_ack_delay: 25,
disable_active_migration: false,
active_conn_id_limit: 2,
initial_source_connection_id: None,
retry_source_connection_id: None,
max_datagram_frame_size: None,
unknown_params: Default::default(),
}
}
}
impl TransportParams {
fn decode(
buf: &[u8], is_server: bool, unknown_size: Option<usize>,
) -> Result<TransportParams> {
let mut params = octets::Octets::with_slice(buf);
let mut seen_params = HashSet::new();
let mut tp = TransportParams::default();
if let Some(unknown_transport_param_tracking_size) = unknown_size {
tp.unknown_params = Some(UnknownTransportParameters {
capacity: unknown_transport_param_tracking_size,
parameters: vec![],
});
}
while params.cap() > 0 {
let id = params.get_varint()?;
if seen_params.contains(&id) {
return Err(Error::InvalidTransportParam);
}
seen_params.insert(id);
let mut val = params.get_bytes_with_varint_length()?;
match id {
0x0000 => {
if is_server {
return Err(Error::InvalidTransportParam);
}
tp.original_destination_connection_id =
Some(val.to_vec().into());
},
0x0001 => {
tp.max_idle_timeout = val.get_varint()?;
},
0x0002 => {
if is_server {
return Err(Error::InvalidTransportParam);
}
tp.stateless_reset_token = Some(u128::from_be_bytes(
val.get_bytes(16)?
.to_vec()
.try_into()
.map_err(|_| Error::BufferTooShort)?,
));
},
0x0003 => {
tp.max_udp_payload_size = val.get_varint()?;
if tp.max_udp_payload_size < 1200 {
return Err(Error::InvalidTransportParam);
}
},
0x0004 => {
tp.initial_max_data = val.get_varint()?;
},
0x0005 => {
tp.initial_max_stream_data_bidi_local = val.get_varint()?;
},
0x0006 => {
tp.initial_max_stream_data_bidi_remote = val.get_varint()?;
},
0x0007 => {
tp.initial_max_stream_data_uni = val.get_varint()?;
},
0x0008 => {
let max = val.get_varint()?;
if max > MAX_STREAM_ID {
return Err(Error::InvalidTransportParam);
}
tp.initial_max_streams_bidi = max;
},
0x0009 => {
let max = val.get_varint()?;
if max > MAX_STREAM_ID {
return Err(Error::InvalidTransportParam);
}
tp.initial_max_streams_uni = max;
},
0x000a => {
let ack_delay_exponent = val.get_varint()?;
if ack_delay_exponent > 20 {
return Err(Error::InvalidTransportParam);
}
tp.ack_delay_exponent = ack_delay_exponent;
},
0x000b => {
let max_ack_delay = val.get_varint()?;
if max_ack_delay >= 2_u64.pow(14) {
return Err(Error::InvalidTransportParam);
}
tp.max_ack_delay = max_ack_delay;
},
0x000c => {
tp.disable_active_migration = true;
},
0x000d => {
if is_server {
return Err(Error::InvalidTransportParam);
}
},
0x000e => {
let limit = val.get_varint()?;
if limit < 2 {
return Err(Error::InvalidTransportParam);
}
tp.active_conn_id_limit = limit;
},
0x000f => {
tp.initial_source_connection_id = Some(val.to_vec().into());
},
0x00010 => {
if is_server {
return Err(Error::InvalidTransportParam);
}
tp.retry_source_connection_id = Some(val.to_vec().into());
},
0x0020 => {
tp.max_datagram_frame_size = Some(val.get_varint()?);
},
unknown_tp_id => {
if let Some(unknown_params) = &mut tp.unknown_params {
let _ = unknown_params.push(UnknownTransportParameter {
id: unknown_tp_id,
value: val.buf(),
});
}
},
}
}
Ok(tp)
}
fn encode_param(
b: &mut octets::OctetsMut, ty: u64, len: usize,
) -> Result<()> {
b.put_varint(ty)?;
b.put_varint(len as u64)?;
Ok(())
}
fn encode<'a>(
tp: &TransportParams, is_server: bool, out: &'a mut [u8],
) -> Result<&'a mut [u8]> {
let mut b = octets::OctetsMut::with_slice(out);
if is_server {
if let Some(ref odcid) = tp.original_destination_connection_id {
TransportParams::encode_param(&mut b, 0x0000, odcid.len())?;
b.put_bytes(odcid)?;
}
};
if tp.max_idle_timeout != 0 {
TransportParams::encode_param(
&mut b,
0x0001,
octets::varint_len(tp.max_idle_timeout),
)?;
b.put_varint(tp.max_idle_timeout)?;
}
if is_server {
if let Some(ref token) = tp.stateless_reset_token {
TransportParams::encode_param(&mut b, 0x0002, 16)?;
b.put_bytes(&token.to_be_bytes())?;
}
}
if tp.max_udp_payload_size != 0 {
TransportParams::encode_param(
&mut b,
0x0003,
octets::varint_len(tp.max_udp_payload_size),
)?;
b.put_varint(tp.max_udp_payload_size)?;
}
if tp.initial_max_data != 0 {
TransportParams::encode_param(
&mut b,
0x0004,
octets::varint_len(tp.initial_max_data),
)?;
b.put_varint(tp.initial_max_data)?;
}
if tp.initial_max_stream_data_bidi_local != 0 {
TransportParams::encode_param(
&mut b,
0x0005,
octets::varint_len(tp.initial_max_stream_data_bidi_local),
)?;
b.put_varint(tp.initial_max_stream_data_bidi_local)?;
}
if tp.initial_max_stream_data_bidi_remote != 0 {
TransportParams::encode_param(
&mut b,
0x0006,
octets::varint_len(tp.initial_max_stream_data_bidi_remote),
)?;
b.put_varint(tp.initial_max_stream_data_bidi_remote)?;
}
if tp.initial_max_stream_data_uni != 0 {
TransportParams::encode_param(
&mut b,
0x0007,
octets::varint_len(tp.initial_max_stream_data_uni),
)?;
b.put_varint(tp.initial_max_stream_data_uni)?;
}
if tp.initial_max_streams_bidi != 0 {
TransportParams::encode_param(
&mut b,
0x0008,
octets::varint_len(tp.initial_max_streams_bidi),
)?;
b.put_varint(tp.initial_max_streams_bidi)?;
}
if tp.initial_max_streams_uni != 0 {
TransportParams::encode_param(
&mut b,
0x0009,
octets::varint_len(tp.initial_max_streams_uni),
)?;
b.put_varint(tp.initial_max_streams_uni)?;
}
if tp.ack_delay_exponent != 0 {
TransportParams::encode_param(
&mut b,
0x000a,
octets::varint_len(tp.ack_delay_exponent),
)?;
b.put_varint(tp.ack_delay_exponent)?;
}
if tp.max_ack_delay != 0 {
TransportParams::encode_param(
&mut b,
0x000b,
octets::varint_len(tp.max_ack_delay),
)?;
b.put_varint(tp.max_ack_delay)?;
}
if tp.disable_active_migration {
TransportParams::encode_param(&mut b, 0x000c, 0)?;
}
if tp.active_conn_id_limit != 2 {
TransportParams::encode_param(
&mut b,
0x000e,
octets::varint_len(tp.active_conn_id_limit),
)?;
b.put_varint(tp.active_conn_id_limit)?;
}
if let Some(scid) = &tp.initial_source_connection_id {
TransportParams::encode_param(&mut b, 0x000f, scid.len())?;
b.put_bytes(scid)?;
}
if is_server {
if let Some(scid) = &tp.retry_source_connection_id {
TransportParams::encode_param(&mut b, 0x0010, scid.len())?;
b.put_bytes(scid)?;
}
}
if let Some(max_datagram_frame_size) = tp.max_datagram_frame_size {
TransportParams::encode_param(
&mut b,
0x0020,
octets::varint_len(max_datagram_frame_size),
)?;
b.put_varint(max_datagram_frame_size)?;
}
let out_len = b.off();
Ok(&mut out[..out_len])
}
#[cfg(feature = "qlog")]
pub fn to_qlog(
&self, owner: TransportOwner, cipher: Option<crypto::Algorithm>,
) -> EventData {
let original_destination_connection_id = qlog::HexSlice::maybe_string(
self.original_destination_connection_id.as_ref(),
);
let stateless_reset_token = qlog::HexSlice::maybe_string(
self.stateless_reset_token.map(|s| s.to_be_bytes()).as_ref(),
);
let tls_cipher: Option<String> = cipher.map(|f| format!("{f:?}"));
EventData::TransportParametersSet(
qlog::events::quic::TransportParametersSet {
owner: Some(owner),
tls_cipher,
original_destination_connection_id,
stateless_reset_token,
disable_active_migration: Some(self.disable_active_migration),
max_idle_timeout: Some(self.max_idle_timeout),
max_udp_payload_size: Some(self.max_udp_payload_size as u32),
ack_delay_exponent: Some(self.ack_delay_exponent as u16),
max_ack_delay: Some(self.max_ack_delay as u16),
active_connection_id_limit: Some(
self.active_conn_id_limit as u32,
),
initial_max_data: Some(self.initial_max_data),
initial_max_stream_data_bidi_local: Some(
self.initial_max_stream_data_bidi_local,
),
initial_max_stream_data_bidi_remote: Some(
self.initial_max_stream_data_bidi_remote,
),
initial_max_stream_data_uni: Some(
self.initial_max_stream_data_uni,
),
initial_max_streams_bidi: Some(self.initial_max_streams_bidi),
initial_max_streams_uni: Some(self.initial_max_streams_uni),
unknown_parameters: self
.unknown_params
.as_ref()
.map(|unknown_params| {
unknown_params
.into_iter()
.cloned()
.map(
Into::<
qlog::events::quic::UnknownTransportParameter,
>::into,
)
.collect()
})
.unwrap_or_default(),
..Default::default()
},
)
}
}
#[doc(hidden)]
pub mod testing {
use super::*;
use crate::recovery::Sent;
use smallvec::smallvec;
use std::time::Instant;
pub struct Pipe {
pub client: Connection,
pub server: Connection,
}
impl Pipe {
pub fn new(cc_algorithm_name: &str) -> Result<Pipe> {
let mut config = Config::new(crate::PROTOCOL_VERSION)?;
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config.load_cert_chain_from_pem_file("examples/cert.crt")?;
config.load_priv_key_from_pem_file("examples/cert.key")?;
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
Pipe::with_config(&mut config)
}
pub fn client_addr() -> SocketAddr {
"127.0.0.1:1234".parse().unwrap()
}
pub fn server_addr() -> SocketAddr {
"127.0.0.1:4321".parse().unwrap()
}
pub fn with_config(config: &mut Config) -> Result<Pipe> {
let mut client_scid = [0; 16];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = Pipe::client_addr();
let mut server_scid = [0; 16];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = Pipe::server_addr();
Ok(Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
config,
)?,
server: accept(
&server_scid,
None,
server_addr,
client_addr,
config,
)?,
})
}
pub fn with_config_and_scid_lengths(
config: &mut Config, client_scid_len: usize, server_scid_len: usize,
) -> Result<Pipe> {
let mut client_scid = vec![0; client_scid_len];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = Pipe::client_addr();
let mut server_scid = vec![0; server_scid_len];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = Pipe::server_addr();
Ok(Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
config,
)?,
server: accept(
&server_scid,
None,
server_addr,
client_addr,
config,
)?,
})
}
pub fn with_client_config(client_config: &mut Config) -> Result<Pipe> {
let mut client_scid = [0; 16];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = Pipe::client_addr();
let mut server_scid = [0; 16];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = Pipe::server_addr();
let mut config = Config::new(crate::PROTOCOL_VERSION)?;
config.load_cert_chain_from_pem_file("examples/cert.crt")?;
config.load_priv_key_from_pem_file("examples/cert.key")?;
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_ack_delay_exponent(8);
Ok(Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
client_config,
)?,
server: accept(
&server_scid,
None,
server_addr,
client_addr,
&mut config,
)?,
})
}
pub fn with_server_config(server_config: &mut Config) -> Result<Pipe> {
let mut client_scid = [0; 16];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = Pipe::client_addr();
let mut server_scid = [0; 16];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = Pipe::server_addr();
let mut config = Config::new(crate::PROTOCOL_VERSION)?;
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_ack_delay_exponent(8);
Ok(Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
&mut config,
)?,
server: accept(
&server_scid,
None,
server_addr,
client_addr,
server_config,
)?,
})
}
pub fn with_client_and_server_config(
client_config: &mut Config, server_config: &mut Config,
) -> Result<Pipe> {
let mut client_scid = [0; 16];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = Pipe::client_addr();
let mut server_scid = [0; 16];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = Pipe::server_addr();
Ok(Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
client_config,
)?,
server: accept(
&server_scid,
None,
server_addr,
client_addr,
server_config,
)?,
})
}
pub fn handshake(&mut self) -> Result<()> {
while !self.client.is_established() || !self.server.is_established() {
let flight = emit_flight(&mut self.client)?;
process_flight(&mut self.server, flight)?;
let flight = emit_flight(&mut self.server)?;
process_flight(&mut self.client, flight)?;
}
Ok(())
}
pub fn advance(&mut self) -> Result<()> {
let mut client_done = false;
let mut server_done = false;
while !client_done || !server_done {
match emit_flight(&mut self.client) {
Ok(flight) => process_flight(&mut self.server, flight)?,
Err(Error::Done) => client_done = true,
Err(e) => return Err(e),
};
match emit_flight(&mut self.server) {
Ok(flight) => process_flight(&mut self.client, flight)?,
Err(Error::Done) => server_done = true,
Err(e) => return Err(e),
};
}
Ok(())
}
pub fn client_recv(&mut self, buf: &mut [u8]) -> Result<usize> {
let server_path = &self.server.paths.get_active().unwrap();
let info = RecvInfo {
to: server_path.peer_addr(),
from: server_path.local_addr(),
};
self.client.recv(buf, info)
}
pub fn server_recv(&mut self, buf: &mut [u8]) -> Result<usize> {
let client_path = &self.client.paths.get_active().unwrap();
let info = RecvInfo {
to: client_path.peer_addr(),
from: client_path.local_addr(),
};
self.server.recv(buf, info)
}
pub fn send_pkt_to_server(
&mut self, pkt_type: packet::Type, frames: &[frame::Frame],
buf: &mut [u8],
) -> Result<usize> {
let written = encode_pkt(&mut self.client, pkt_type, frames, buf)?;
recv_send(&mut self.server, buf, written)
}
pub fn client_update_key(&mut self) -> Result<()> {
let crypto_ctx =
&mut self.client.crypto_ctx[packet::Epoch::Application];
let open_next = crypto_ctx
.crypto_open
.as_ref()
.unwrap()
.derive_next_packet_key()
.unwrap();
let seal_next = crypto_ctx
.crypto_seal
.as_ref()
.unwrap()
.derive_next_packet_key()?;
let open_prev = crypto_ctx.crypto_open.replace(open_next);
crypto_ctx.crypto_seal.replace(seal_next);
crypto_ctx.key_update = Some(packet::KeyUpdate {
crypto_open: open_prev.unwrap(),
pn_on_update: self.client.next_pkt_num,
update_acked: true,
timer: time::Instant::now(),
});
self.client.key_phase = !self.client.key_phase;
Ok(())
}
}
pub fn recv_send<F: BufFactory>(
conn: &mut Connection<F>, buf: &mut [u8], len: usize,
) -> Result<usize> {
let active_path = conn.paths.get_active()?;
let info = RecvInfo {
to: active_path.local_addr(),
from: active_path.peer_addr(),
};
conn.recv(&mut buf[..len], info)?;
let mut off = 0;
match conn.send(&mut buf[off..]) {
Ok((write, _)) => off += write,
Err(Error::Done) => (),
Err(e) => return Err(e),
}
Ok(off)
}
pub fn process_flight(
conn: &mut Connection, flight: Vec<(Vec<u8>, SendInfo)>,
) -> Result<()> {
for (mut pkt, si) in flight {
let info = RecvInfo {
to: si.to,
from: si.from,
};
conn.recv(&mut pkt, info)?;
}
Ok(())
}
pub fn emit_flight_with_max_buffer(
conn: &mut Connection, out_size: usize, from: Option<SocketAddr>,
to: Option<SocketAddr>,
) -> Result<Vec<(Vec<u8>, SendInfo)>> {
let mut flight = Vec::new();
loop {
let mut out = vec![0u8; out_size];
let info = match conn.send_on_path(&mut out, from, to) {
Ok((written, info)) => {
out.truncate(written);
info
},
Err(Error::Done) => break,
Err(e) => return Err(e),
};
flight.push((out, info));
}
if flight.is_empty() {
return Err(Error::Done);
}
Ok(flight)
}
pub fn emit_flight_on_path(
conn: &mut Connection, from: Option<SocketAddr>, to: Option<SocketAddr>,
) -> Result<Vec<(Vec<u8>, SendInfo)>> {
emit_flight_with_max_buffer(conn, 65535, from, to)
}
pub fn emit_flight(
conn: &mut Connection,
) -> Result<Vec<(Vec<u8>, SendInfo)>> {
emit_flight_on_path(conn, None, None)
}
pub fn encode_pkt(
conn: &mut Connection, pkt_type: packet::Type, frames: &[frame::Frame],
buf: &mut [u8],
) -> Result<usize> {
let mut b = octets::OctetsMut::with_slice(buf);
let epoch = pkt_type.to_epoch()?;
let crypto_ctx = &mut conn.crypto_ctx[epoch];
let pn = conn.next_pkt_num;
let pn_len = 4;
let send_path = conn.paths.get_active()?;
let active_dcid_seq = send_path
.active_dcid_seq
.as_ref()
.ok_or(Error::InvalidState)?;
let active_scid_seq = send_path
.active_scid_seq
.as_ref()
.ok_or(Error::InvalidState)?;
let hdr = Header {
ty: pkt_type,
version: conn.version,
dcid: ConnectionId::from_ref(
conn.ids.get_dcid(*active_dcid_seq)?.cid.as_ref(),
),
scid: ConnectionId::from_ref(
conn.ids.get_scid(*active_scid_seq)?.cid.as_ref(),
),
pkt_num: pn,
pkt_num_len: pn_len,
token: conn.token.clone(),
versions: None,
key_phase: conn.key_phase,
};
hdr.to_bytes(&mut b)?;
let payload_len = frames.iter().fold(0, |acc, x| acc + x.wire_len());
if pkt_type != packet::Type::Short {
let len =
pn_len + payload_len + crypto_ctx.crypto_overhead().unwrap();
b.put_varint(len as u64)?;
}
b.put_u32(pn as u32)?;
let payload_offset = b.off();
for frame in frames {
frame.to_bytes(&mut b)?;
}
let aead = match crypto_ctx.crypto_seal {
Some(ref v) => v,
None => return Err(Error::InvalidState),
};
let written = packet::encrypt_pkt(
&mut b,
pn,
pn_len,
payload_len,
payload_offset,
None,
aead,
)?;
conn.next_pkt_num += 1;
Ok(written)
}
pub fn decode_pkt(
conn: &mut Connection, buf: &mut [u8],
) -> Result<Vec<frame::Frame>> {
let mut b = octets::OctetsMut::with_slice(buf);
let mut hdr = Header::from_bytes(&mut b, conn.source_id().len()).unwrap();
let epoch = hdr.ty.to_epoch()?;
let aead = conn.crypto_ctx[epoch].crypto_open.as_ref().unwrap();
let payload_len = b.cap();
packet::decrypt_hdr(&mut b, &mut hdr, aead).unwrap();
let pn = packet::decode_pkt_num(
conn.pkt_num_spaces[epoch].largest_rx_pkt_num,
hdr.pkt_num,
hdr.pkt_num_len,
);
let mut payload =
packet::decrypt_pkt(&mut b, pn, hdr.pkt_num_len, payload_len, aead)
.unwrap();
let mut frames = Vec::new();
while payload.cap() > 0 {
let frame = frame::Frame::from_bytes(&mut payload, hdr.ty)?;
frames.push(frame);
}
Ok(frames)
}
pub fn create_cid_and_reset_token(
cid_len: usize,
) -> (ConnectionId<'static>, u128) {
let mut cid = vec![0; cid_len];
rand::rand_bytes(&mut cid[..]);
let cid = ConnectionId::from_ref(&cid).into_owned();
let mut reset_token = [0; 16];
rand::rand_bytes(&mut reset_token);
let reset_token = u128::from_be_bytes(reset_token);
(cid, reset_token)
}
pub fn helper_packet_sent(pkt_num: u64, now: Instant, size: usize) -> Sent {
Sent {
pkt_num,
frames: smallvec![],
time_sent: now,
time_acked: None,
time_lost: None,
size,
ack_eliciting: true,
in_flight: true,
delivered: 0,
delivered_time: now,
first_sent_time: now,
is_app_limited: false,
tx_in_flight: 0,
lost: 0,
has_data: false,
is_pmtud_probe: false,
}
}
}
#[cfg(test)]
mod tests {
use crate::range_buf::RangeBuf;
use rstest::rstest;
use super::*;
#[test]
fn transport_params() {
let tp = TransportParams {
original_destination_connection_id: None,
max_idle_timeout: 30,
stateless_reset_token: Some(u128::from_be_bytes([0xba; 16])),
max_udp_payload_size: 23_421,
initial_max_data: 424_645_563,
initial_max_stream_data_bidi_local: 154_323_123,
initial_max_stream_data_bidi_remote: 6_587_456,
initial_max_stream_data_uni: 2_461_234,
initial_max_streams_bidi: 12_231,
initial_max_streams_uni: 18_473,
ack_delay_exponent: 20,
max_ack_delay: 2_u64.pow(14) - 1,
disable_active_migration: true,
active_conn_id_limit: 8,
initial_source_connection_id: Some(b"woot woot".to_vec().into()),
retry_source_connection_id: Some(b"retry".to_vec().into()),
max_datagram_frame_size: Some(32),
unknown_params: Default::default(),
};
let mut raw_params = [42; 256];
let raw_params =
TransportParams::encode(&tp, true, &mut raw_params).unwrap();
assert_eq!(raw_params.len(), 94);
let new_tp = TransportParams::decode(raw_params, false, None).unwrap();
assert_eq!(new_tp, tp);
let tp = TransportParams {
original_destination_connection_id: None,
max_idle_timeout: 30,
stateless_reset_token: None,
max_udp_payload_size: 23_421,
initial_max_data: 424_645_563,
initial_max_stream_data_bidi_local: 154_323_123,
initial_max_stream_data_bidi_remote: 6_587_456,
initial_max_stream_data_uni: 2_461_234,
initial_max_streams_bidi: 12_231,
initial_max_streams_uni: 18_473,
ack_delay_exponent: 20,
max_ack_delay: 2_u64.pow(14) - 1,
disable_active_migration: true,
active_conn_id_limit: 8,
initial_source_connection_id: Some(b"woot woot".to_vec().into()),
retry_source_connection_id: None,
max_datagram_frame_size: Some(32),
unknown_params: Default::default(),
};
let mut raw_params = [42; 256];
let raw_params =
TransportParams::encode(&tp, false, &mut raw_params).unwrap();
assert_eq!(raw_params.len(), 69);
let new_tp = TransportParams::decode(raw_params, true, None).unwrap();
assert_eq!(new_tp, tp);
}
#[test]
fn transport_params_forbid_duplicates() {
let initial_source_connection_id = b"id";
let initial_source_connection_id_raw = [
15,
initial_source_connection_id.len() as u8,
initial_source_connection_id[0],
initial_source_connection_id[1],
];
let tp = TransportParams::decode(
initial_source_connection_id_raw.as_slice(),
true,
None,
)
.unwrap();
assert_eq!(
tp.initial_source_connection_id,
Some(initial_source_connection_id.to_vec().into())
);
let mut raw_params = Vec::new();
raw_params.append(&mut initial_source_connection_id_raw.to_vec());
raw_params.append(&mut initial_source_connection_id_raw.to_vec());
assert_eq!(
TransportParams::decode(raw_params.as_slice(), true, None),
Err(Error::InvalidTransportParam)
);
}
#[test]
fn transport_params_unknown_zero_space() {
let mut unknown_params: UnknownTransportParameters =
UnknownTransportParameters {
capacity: 0,
parameters: vec![],
};
let massive_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 5,
value: &[0xau8; 280],
};
assert!(unknown_params.push(massive_unknown_param).is_err());
assert!(unknown_params.capacity == 0);
assert!(unknown_params.parameters.is_empty());
}
#[test]
fn transport_params_unknown_max_space_respected() {
let mut unknown_params: UnknownTransportParameters =
UnknownTransportParameters {
capacity: 256,
parameters: vec![],
};
let massive_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 5,
value: &[0xau8; 280],
};
let big_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 5,
value: &[0xau8; 232],
};
let little_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 6,
value: &[0xau8; 7],
};
assert!(unknown_params.push(massive_unknown_param).is_err());
assert!(unknown_params.capacity == 256);
assert!(unknown_params.parameters.is_empty());
unknown_params.push(big_unknown_param).unwrap();
assert!(unknown_params.capacity == 16);
assert!(unknown_params.parameters.len() == 1);
unknown_params.push(little_unknown_param.clone()).unwrap();
assert!(unknown_params.capacity == 1);
assert!(unknown_params.parameters.len() == 2);
assert!(unknown_params.push(little_unknown_param).is_err());
let mut unknown_params_iter = unknown_params.into_iter();
let unknown_params_first = unknown_params_iter
.next()
.expect("Should have a 0th element.");
assert!(
unknown_params_first.id == 5 &&
unknown_params_first.value == vec![0xau8; 232]
);
let unknown_params_second = unknown_params_iter
.next()
.expect("Should have a 1th element.");
assert!(
unknown_params_second.id == 6 &&
unknown_params_second.value == vec![0xau8; 7]
);
}
#[test]
fn transport_params_unknown_is_reserved() {
let reserved_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 31 * 17 + 27,
value: &[0xau8; 280],
};
let not_reserved_unknown_param = UnknownTransportParameter::<&[u8]> {
id: 32 * 17 + 27,
value: &[0xau8; 280],
};
assert!(reserved_unknown_param.is_reserved());
assert!(!not_reserved_unknown_param.is_reserved());
}
#[test]
fn unknown_version() {
let mut config = Config::new(0xbabababa).unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Err(Error::UnknownVersion));
}
#[test]
fn config_version_reserved() {
Config::new(0xbabababa).unwrap();
Config::new(0x1a2a3a4a).unwrap();
}
#[test]
fn config_version_invalid() {
assert_eq!(
Config::new(0xb1bababa).err().unwrap(),
Error::UnknownVersion
);
}
#[test]
fn version_negotiation() {
let mut buf = [0; 65535];
let mut config = Config::new(0xbabababa).unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
let (mut len, _) = pipe.client.send(&mut buf).unwrap();
let hdr = packet::Header::from_slice(&mut buf[..len], 0).unwrap();
len = crate::negotiate_version(&hdr.scid, &hdr.dcid, &mut buf).unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.version, PROTOCOL_VERSION);
assert_eq!(pipe.server.version, PROTOCOL_VERSION);
}
#[test]
fn verify_custom_root() {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
config.verify_peer(true);
config
.load_verify_locations_from_file("examples/rootca.crt")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
}
#[cfg(not(feature = "openssl"))]
#[test]
fn verify_client_invalid() {
let mut server_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
server_config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
server_config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
server_config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
server_config.set_initial_max_data(30);
server_config.set_initial_max_stream_data_bidi_local(15);
server_config.set_initial_max_stream_data_bidi_remote(15);
server_config.set_initial_max_streams_bidi(3);
server_config.verify_peer(true);
let mut client_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
client_config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
client_config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
client_config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
client_config.set_initial_max_data(30);
client_config.set_initial_max_stream_data_bidi_local(15);
client_config.set_initial_max_stream_data_bidi_remote(15);
client_config.set_initial_max_streams_bidi(3);
client_config
.load_verify_locations_from_file("examples/rootca.crt")
.unwrap();
client_config.verify_peer(true);
let mut pipe = testing::Pipe::with_client_and_server_config(
&mut client_config,
&mut server_config,
)
.unwrap();
assert_eq!(pipe.handshake(), Err(Error::TlsFail));
assert!(pipe.server.peer_cert().is_some());
}
#[test]
fn verify_client_anonymous() {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.verify_peer(true);
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert!(pipe.server.peer_cert().is_none());
}
#[rstest]
fn missing_initial_source_connection_id(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
pipe.client
.local_transport_params
.initial_source_connection_id = None;
assert_eq!(pipe.client.encode_transport_params(), Ok(()));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(
pipe.server_recv(&mut buf[..len]),
Err(Error::InvalidTransportParam)
);
}
#[rstest]
fn invalid_initial_source_connection_id(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
pipe.client
.local_transport_params
.initial_source_connection_id = Some(b"bogus value".to_vec().into());
assert_eq!(pipe.client.encode_transport_params(), Ok(()));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(
pipe.server_recv(&mut buf[..len]),
Err(Error::InvalidTransportParam)
);
}
#[rstest]
fn change_idle_timeout(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(0x1).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_max_idle_timeout(999999);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.client.local_transport_params.max_idle_timeout, 999999);
assert_eq!(pipe.client.peer_transport_params.max_idle_timeout, 0);
assert_eq!(pipe.server.local_transport_params.max_idle_timeout, 0);
assert_eq!(pipe.server.peer_transport_params.max_idle_timeout, 0);
pipe.client.set_max_idle_timeout(456000).unwrap();
pipe.server.set_max_idle_timeout(234000).unwrap();
assert_eq!(pipe.client.local_transport_params.max_idle_timeout, 456000);
assert_eq!(pipe.client.peer_transport_params.max_idle_timeout, 0);
assert_eq!(pipe.server.local_transport_params.max_idle_timeout, 234000);
assert_eq!(pipe.server.peer_transport_params.max_idle_timeout, 0);
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.idle_timeout(),
Some(time::Duration::from_millis(234000))
);
assert_eq!(
pipe.server.idle_timeout(),
Some(time::Duration::from_millis(234000))
);
}
#[rstest]
fn handshake(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.application_proto(),
pipe.server.application_proto()
);
assert_eq!(pipe.server.server_name(), Some("quic.tech"));
}
#[rstest]
fn handshake_done(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
pipe.server.handshake.set_options(0x0000_4000);
assert_eq!(pipe.handshake(), Ok(()));
assert!(pipe.server.handshake_done_sent);
}
#[rstest]
fn handshake_confirmation(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.client.is_established());
assert!(!pipe.client.handshake_confirmed);
assert!(!pipe.server.is_established());
assert!(!pipe.server.handshake_confirmed);
testing::process_flight(&mut pipe.client, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
assert!(pipe.client.is_established());
assert!(!pipe.client.handshake_confirmed);
assert!(!pipe.server.is_established());
assert!(!pipe.server.handshake_confirmed);
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(pipe.client.is_established());
assert!(!pipe.client.handshake_confirmed);
assert!(pipe.server.is_established());
assert!(pipe.server.handshake_confirmed);
testing::process_flight(&mut pipe.client, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
assert!(pipe.client.is_established());
assert!(pipe.client.handshake_confirmed);
assert!(pipe.server.is_established());
assert!(pipe.server.handshake_confirmed);
testing::process_flight(&mut pipe.server, flight).unwrap();
assert!(pipe.client.is_established());
assert!(pipe.client.handshake_confirmed);
assert!(pipe.server.is_established());
assert!(pipe.server.handshake_confirmed);
}
#[rstest]
fn handshake_resumption(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
#[cfg(not(feature = "openssl"))]
const SESSION_TICKET_KEY: [u8; 48] = [0xa; 48];
#[cfg(feature = "openssl")]
const SESSION_TICKET_KEY: [u8; 80] = [0xa; 80];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.set_ticket_key(&SESSION_TICKET_KEY).unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert!(pipe.client.is_established());
assert!(pipe.server.is_established());
assert!(!pipe.client.is_resumed());
assert!(!pipe.server.is_resumed());
let session = pipe.client.session().unwrap();
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.set_ticket_key(&SESSION_TICKET_KEY).unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
assert_eq!(pipe.client.set_session(session), Ok(()));
assert_eq!(pipe.handshake(), Ok(()));
assert!(pipe.client.is_established());
assert!(pipe.server.is_established());
assert!(pipe.client.is_resumed());
assert!(pipe.server.is_resumed());
}
#[rstest]
fn handshake_alpn_mismatch(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto3\x06proto4"])
.unwrap();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Err(Error::TlsFail));
assert_eq!(pipe.client.application_proto(), b"");
assert_eq!(pipe.server.application_proto(), b"");
let (len, _) = pipe.server.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(pipe.server.send(&mut buf), Err(Error::Done));
assert_eq!(pipe.server.sent_count, 1);
}
#[cfg(not(feature = "openssl"))] #[rstest]
fn handshake_0rtt(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.enable_early_data();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let session = pipe.client.session().unwrap();
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.client.set_session(session), Ok(()));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let pkt_type = packet::Type::ZeroRTT;
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaa", 0, true),
}];
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Ok(1200)
);
assert_eq!(pipe.server.undecryptable_pkts.len(), 0);
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, true)));
assert_eq!(&b[..5], b"aaaaa");
}
#[cfg(not(feature = "openssl"))] #[rstest]
fn handshake_0rtt_reordered(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.enable_early_data();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let session = pipe.client.session().unwrap();
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.client.set_session(session), Ok(()));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let mut initial = buf[..len].to_vec();
let pkt_type = packet::Type::ZeroRTT;
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaa", 0, true),
}];
let len =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let mut zrtt = buf[..len].to_vec();
assert_eq!(pipe.server_recv(&mut zrtt), Ok(zrtt.len()));
assert_eq!(pipe.server.undecryptable_pkts.len(), 1);
assert_eq!(pipe.server.undecryptable_pkts[0].0.len(), zrtt.len());
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.server_recv(&mut initial), Ok(initial.len()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, true)));
assert_eq!(&b[..5], b"aaaaa");
}
#[cfg(not(feature = "openssl"))] #[rstest]
fn handshake_0rtt_truncated(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.enable_early_data();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let session = pipe.client.session().unwrap();
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.client.set_session(session), Ok(()));
pipe.client.send(&mut buf).unwrap();
let pkt_type = packet::Type::ZeroRTT;
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaa", 0, true),
}];
let len =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let mut zrtt = buf[..len - 1].to_vec();
assert_eq!(pipe.server_recv(&mut zrtt), Err(Error::InvalidPacket));
assert_eq!(pipe.server.undecryptable_pkts.len(), 0);
assert!(pipe.server.is_closed());
}
#[rstest]
fn crypto_limit(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.enable_early_data();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Crypto {
data: RangeBuf::from(b"a", MAX_CRYPTO_STREAM_OFFSET, false),
}];
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let active_path = pipe.server.paths.get_active().unwrap();
let info = RecvInfo {
to: active_path.local_addr(),
from: active_path.peer_addr(),
};
assert_eq!(
pipe.server.recv(&mut buf[..written], info),
Err(Error::CryptoBufferExceeded)
);
let written = match pipe.server.send(&mut buf) {
Ok((write, _)) => write,
Err(_) => unreachable!(),
};
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..written]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::ConnectionClose {
error_code: 0x0d,
frame_type: 0,
reason: Vec::new(),
})
);
}
#[rstest]
fn limit_handshake_data(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert-big.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
let client_sent = flight.iter().fold(0, |out, p| out + p.0.len());
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
let server_sent = flight.iter().fold(0, |out, p| out + p.0.len());
assert_eq!(server_sent, client_sent * MAX_AMPLIFICATION_FACTOR);
}
#[rstest]
fn custom_limit_handshake_data(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
const CUSTOM_AMPLIFICATION_FACTOR: usize = 2;
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert-big.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_max_amplification_factor(CUSTOM_AMPLIFICATION_FACTOR);
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
let client_sent = flight.iter().fold(0, |out, p| out + p.0.len());
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
let server_sent = flight.iter().fold(0, |out, p| out + p.0.len());
assert_eq!(server_sent, client_sent * CUSTOM_AMPLIFICATION_FACTOR);
}
#[rstest]
fn streamio(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello, world", true), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.server.stream_finished(4));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((12, true)));
assert_eq!(&b[..12], b"hello, world");
assert!(pipe.server.stream_finished(4));
}
#[cfg(not(feature = "openssl"))] #[rstest]
fn zero_rtt(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.enable_early_data();
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let session = pipe.client.session().unwrap();
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.client.set_session(session), Ok(()));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let mut initial = buf[..len].to_vec();
assert!(pipe.client.is_in_early_data());
assert_eq!(pipe.client.stream_send(4, b"hello, world", true), Ok(12));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let mut zrtt = buf[..len].to_vec();
assert_eq!(pipe.server_recv(&mut initial), Ok(initial.len()));
assert!(pipe.server.is_in_early_data());
assert_eq!(pipe.server_recv(&mut zrtt), Ok(zrtt.len()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((12, true)));
assert_eq!(&b[..12], b"hello, world");
}
#[rstest]
fn stream_send_on_32bit_arch(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(2_u64.pow(32) + 5);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello, world", true), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.server.stream_finished(4));
}
#[rstest]
fn empty_stream_frame(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaa", 0, false),
}];
let pkt_type = packet::Type::Short;
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
let mut readable = pipe.server.readable();
assert_eq!(readable.next(), Some(4));
assert_eq!(pipe.server.stream_recv(4, &mut buf), Ok((5, false)));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"", 5, true),
}];
let pkt_type = packet::Type::Short;
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
let mut readable = pipe.server.readable();
assert_eq!(readable.next(), Some(4));
assert_eq!(pipe.server.stream_recv(4, &mut buf), Ok((0, true)));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"", 15, true),
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FinalSize)
);
}
#[rstest]
fn update_key_request(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client_update_key(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, false)));
assert_eq!(&b[..5], b"hello");
assert!(
pipe.server.crypto_ctx[packet::Epoch::Application]
.key_update
.as_ref()
.unwrap()
.update_acked
);
assert_eq!(pipe.server.stream_send(4, b"world", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(4, &mut b), Ok((5, false)));
assert_eq!(&b[..5], b"world");
for _ in 0..10 {
assert_eq!(pipe.server.stream_send(4, b"world", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(4, &mut b), Ok((5, false)));
assert_eq!(&b[..5], b"world");
}
}
#[rstest]
fn update_key_request_twice_error(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"hello", 0, false),
}];
assert_eq!(pipe.client_update_key(), Ok(()));
let written = testing::encode_pkt(
&mut pipe.client,
packet::Type::Short,
&frames,
&mut buf,
)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
assert_eq!(pipe.client_update_key(), Ok(()));
let written = testing::encode_pkt(
&mut pipe.client,
packet::Type::Short,
&frames,
&mut buf,
)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..written]), Err(Error::KeyUpdate));
}
#[rstest]
fn max_stream_data_receive_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(2, b"hello", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let frames = [frame::Frame::MaxStreamData {
stream_id: 2,
max: 1024,
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::InvalidStreamState(2)),
);
}
#[rstest]
fn empty_payload(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &[], &mut buf),
Err(Error::InvalidPacket)
);
}
#[rstest]
fn min_payload(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let frames = [frame::Frame::Padding { len: 4 }];
let pkt_type = packet::Type::Initial;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
let initial_path = pipe
.server
.paths
.get_active()
.expect("initial path not found");
assert_eq!(initial_path.max_send_bytes, 195);
pipe.server
.paths
.get_active_mut()
.expect("no active path")
.recovery
.inc_loss_probes(packet::Epoch::Initial);
let initial_path = pipe
.server
.paths
.get_active_mut()
.expect("initial path not found");
initial_path.max_send_bytes = 60;
assert_eq!(pipe.server.send(&mut buf), Err(Error::Done));
}
#[rstest]
fn flow_control_limit(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"a", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FlowControl),
);
}
#[rstest]
fn flow_control_limit_dup(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
}
#[rstest]
fn flow_control_update(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
pipe.server.stream_recv(0, &mut buf).unwrap();
pipe.server.stream_recv(4, &mut buf).unwrap();
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 1, false),
}];
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert!(len > 0);
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next().unwrap();
assert_eq!(
iter.next(),
Some(&frame::Frame::MaxStreamData {
stream_id: 0,
max: 30
})
);
assert_eq!(iter.next(), Some(&frame::Frame::MaxData { max: 61 }));
}
#[rstest]
fn flow_control_drain(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.stream_send(4, b"aaaaa", true), Ok(5));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", true), Ok(5));
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Read, 42), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.advance(), Ok(()));
}
#[rstest]
fn stream_flow_control_limit_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaaa", 0, true),
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FlowControl),
);
}
#[rstest]
fn stream_flow_control_limit_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Stream {
stream_id: 2,
data: <RangeBuf>::from(b"aaaaaaaaaaa", 0, true),
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FlowControl),
);
}
#[rstest]
fn stream_flow_control_update(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaaaaaa", 0, false),
}];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
pipe.server.stream_recv(4, &mut buf).unwrap();
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 9, false),
}];
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert!(len > 0);
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next().unwrap();
assert_eq!(
iter.next(),
Some(&frame::Frame::MaxStreamData {
stream_id: 4,
max: 24,
})
);
}
#[rstest]
fn stream_left_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(3, pipe.client.peer_streams_left_bidi());
assert_eq!(3, pipe.server.peer_streams_left_bidi());
pipe.server.stream_send(1, b"a", false).ok();
assert_eq!(2, pipe.server.peer_streams_left_bidi());
pipe.server.stream_send(5, b"a", false).ok();
assert_eq!(1, pipe.server.peer_streams_left_bidi());
pipe.server.stream_send(9, b"a", false).ok();
assert_eq!(0, pipe.server.peer_streams_left_bidi());
let frames = [frame::Frame::MaxStreamsBidi { max: MAX_STREAM_ID }];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
assert_eq!(MAX_STREAM_ID - 3, pipe.server.peer_streams_left_bidi());
}
#[rstest]
fn stream_left_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(3, pipe.client.peer_streams_left_uni());
assert_eq!(3, pipe.server.peer_streams_left_uni());
pipe.server.stream_send(3, b"a", false).ok();
assert_eq!(2, pipe.server.peer_streams_left_uni());
pipe.server.stream_send(7, b"a", false).ok();
assert_eq!(1, pipe.server.peer_streams_left_uni());
pipe.server.stream_send(11, b"a", false).ok();
assert_eq!(0, pipe.server.peer_streams_left_uni());
let frames = [frame::Frame::MaxStreamsUni { max: MAX_STREAM_ID }];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
assert_eq!(MAX_STREAM_ID - 3, pipe.server.peer_streams_left_uni());
}
#[rstest]
fn stream_limit_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 12,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 16,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 20,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 24,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 28,
data: <RangeBuf>::from(b"a", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::StreamLimit),
);
}
#[rstest]
fn stream_limit_max_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::MaxStreamsBidi { max: MAX_STREAM_ID }];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let frames = [frame::Frame::MaxStreamsBidi {
max: MAX_STREAM_ID + 1,
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::InvalidFrame),
);
}
#[rstest]
fn stream_limit_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 2,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 6,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 10,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 14,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 18,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 22,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::Stream {
stream_id: 26,
data: <RangeBuf>::from(b"a", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::StreamLimit),
);
}
#[rstest]
fn stream_limit_max_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::MaxStreamsUni { max: MAX_STREAM_ID }];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let frames = [frame::Frame::MaxStreamsUni {
max: MAX_STREAM_ID + 1,
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::InvalidFrame),
);
}
#[rstest]
fn stream_left_reset_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(3, pipe.client.peer_streams_left_bidi());
assert_eq!(3, pipe.server.peer_streams_left_bidi());
pipe.client.stream_send(0, b"a", false).ok();
assert_eq!(2, pipe.client.peer_streams_left_bidi());
pipe.client.stream_send(4, b"a", false).ok();
assert_eq!(1, pipe.client.peer_streams_left_bidi());
pipe.client.stream_send(8, b"a", false).ok();
assert_eq!(0, pipe.client.peer_streams_left_bidi());
pipe.client
.stream_shutdown(0, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
assert_eq!(0, pipe.client.peer_streams_left_bidi());
let mut r = pipe.server.readable();
assert_eq!(Some(0), r.next());
assert_eq!(Some(4), r.next());
assert_eq!(Some(8), r.next());
assert_eq!(None, r.next());
assert_eq!(
pipe.server.stream_recv(0, &mut buf),
Err(Error::StreamReset(1001))
);
let mut r = pipe.server.readable();
assert_eq!(Some(4), r.next());
assert_eq!(Some(8), r.next());
assert_eq!(None, r.next());
pipe.server
.stream_shutdown(0, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
assert_eq!(1, pipe.client.peer_streams_left_bidi());
pipe.client
.stream_shutdown(4, Shutdown::Write, 1001)
.unwrap();
pipe.client
.stream_shutdown(8, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
let mut r = pipe.server.readable();
assert_eq!(Some(4), r.next());
assert_eq!(Some(8), r.next());
assert_eq!(None, r.next());
assert_eq!(
pipe.server.stream_recv(4, &mut buf),
Err(Error::StreamReset(1001))
);
assert_eq!(
pipe.server.stream_recv(8, &mut buf),
Err(Error::StreamReset(1001))
);
let mut r = pipe.server.readable();
assert_eq!(None, r.next());
pipe.server
.stream_shutdown(4, Shutdown::Write, 1001)
.unwrap();
pipe.server
.stream_shutdown(8, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
assert_eq!(3, pipe.client.peer_streams_left_bidi());
}
#[rstest]
fn stream_reset_counts(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
pipe.client.stream_send(0, b"a", false).ok();
pipe.client.stream_send(2, b"a", false).ok();
pipe.client.stream_send(4, b"a", false).ok();
pipe.client.stream_send(8, b"a", false).ok();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.reset_stream_count_local, 0);
pipe.client
.stream_shutdown(0, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.reset_stream_count_local, 1);
assert_eq!(stats.reset_stream_count_remote, 0);
let stats = pipe.server.stats();
assert_eq!(stats.reset_stream_count_local, 0);
assert_eq!(stats.reset_stream_count_remote, 1);
pipe.server
.stream_shutdown(0, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.reset_stream_count_local, 1);
assert_eq!(stats.reset_stream_count_remote, 1);
let stats = pipe.server.stats();
assert_eq!(stats.reset_stream_count_local, 1);
assert_eq!(stats.reset_stream_count_remote, 1);
pipe.client
.stream_shutdown(2, Shutdown::Write, 1001)
.unwrap();
pipe.client
.stream_shutdown(4, Shutdown::Write, 1001)
.unwrap();
pipe.client
.stream_shutdown(8, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
pipe.server
.stream_shutdown(4, Shutdown::Write, 1001)
.unwrap();
pipe.server
.stream_shutdown(8, Shutdown::Write, 1001)
.unwrap();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.reset_stream_count_local, 4);
assert_eq!(stats.reset_stream_count_remote, 3);
let stats = pipe.server.stats();
assert_eq!(stats.reset_stream_count_local, 3);
assert_eq!(stats.reset_stream_count_remote, 4);
}
#[rstest]
fn stream_stop_counts(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
pipe.client.stream_send(0, b"a", false).ok();
pipe.client.stream_send(2, b"a", false).ok();
pipe.client.stream_send(4, b"a", false).ok();
pipe.client.stream_send(8, b"a", false).ok();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.reset_stream_count_local, 0);
pipe.server
.stream_shutdown(0, Shutdown::Read, 1001)
.unwrap();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.stopped_stream_count_local, 0);
assert_eq!(stats.stopped_stream_count_remote, 1);
assert_eq!(stats.reset_stream_count_local, 1);
assert_eq!(stats.reset_stream_count_remote, 0);
let stats = pipe.server.stats();
assert_eq!(stats.stopped_stream_count_local, 1);
assert_eq!(stats.stopped_stream_count_remote, 0);
assert_eq!(stats.reset_stream_count_local, 0);
assert_eq!(stats.reset_stream_count_remote, 1);
pipe.server
.stream_shutdown(2, Shutdown::Read, 1001)
.unwrap();
pipe.server
.stream_shutdown(4, Shutdown::Read, 1001)
.unwrap();
pipe.server
.stream_shutdown(8, Shutdown::Read, 1001)
.unwrap();
pipe.advance().unwrap();
let stats = pipe.client.stats();
assert_eq!(stats.stopped_stream_count_local, 0);
assert_eq!(stats.stopped_stream_count_remote, 4);
assert_eq!(stats.reset_stream_count_local, 4);
assert_eq!(stats.reset_stream_count_remote, 0);
let stats = pipe.server.stats();
assert_eq!(stats.stopped_stream_count_local, 4);
assert_eq!(stats.stopped_stream_count_remote, 0);
assert_eq!(stats.reset_stream_count_local, 0);
assert_eq!(stats.reset_stream_count_remote, 4);
}
#[rstest]
fn streams_blocked_max_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::StreamsBlockedBidi {
limit: MAX_STREAM_ID,
}];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let frames = [frame::Frame::StreamsBlockedBidi {
limit: MAX_STREAM_ID + 1,
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::InvalidFrame),
);
}
#[rstest]
fn streams_blocked_max_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::StreamsBlockedUni {
limit: MAX_STREAM_ID,
}];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let frames = [frame::Frame::StreamsBlockedUni {
limit: MAX_STREAM_ID + 1,
}];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::InvalidFrame),
);
}
#[rstest]
fn stream_data_overlap(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"bbbbb", 3, false),
},
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"ccccc", 6, false),
},
];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((11, false)));
assert_eq!(&b[..11], b"aaaaabbbccc");
}
#[rstest]
fn stream_data_overlap_with_reordering(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"ccccc", 6, false),
},
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"bbbbb", 3, false),
},
];
let pkt_type = packet::Type::Short;
assert!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf).is_ok());
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((11, false)));
assert_eq!(&b[..11], b"aaaaabccccc");
}
#[rstest]
fn reset_stream_data_recvd(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hello", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((5, false)));
assert!(!pipe.server.stream_finished(0));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(0, &mut b), Ok((0, true)));
assert!(pipe.client.stream_finished(0));
let frames = [frame::Frame::ResetStream {
stream_id: 0,
error_code: 42,
final_size: 5,
}];
let pkt_type = packet::Type::Short;
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(
pipe.server.stream_recv(0, &mut b),
Err(Error::StreamReset(42))
);
assert!(pipe.server.stream_finished(0));
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
}
#[rstest]
fn reset_stream_data_not_recvd(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"h", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((1, false)));
assert!(!pipe.server.stream_finished(0));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(0, &mut b), Ok((0, true)));
assert!(pipe.client.stream_finished(0));
let frames = [frame::Frame::ResetStream {
stream_id: 0,
error_code: 42,
final_size: 5,
}];
let pkt_type = packet::Type::Short;
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(
pipe.server.stream_recv(0, &mut b),
Err(Error::StreamReset(42))
);
assert!(pipe.server.stream_finished(0));
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
}
#[rstest]
fn reset_stream_flow_control(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
},
frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::ResetStream {
stream_id: 4,
error_code: 0,
final_size: 15,
},
frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"a", 0, false),
},
];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FlowControl),
);
}
#[rstest]
fn reset_stream_flow_control_stream(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [
frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 0, false),
},
frame::Frame::ResetStream {
stream_id: 4,
error_code: 0,
final_size: 16, },
];
let pkt_type = packet::Type::Short;
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf),
Err(Error::FlowControl),
);
}
#[rstest]
fn path_challenge(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::PathChallenge { data: [0xba; 8] }];
let pkt_type = packet::Type::Short;
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert!(len > 0);
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next().unwrap();
assert_eq!(
iter.next(),
Some(&frame::Frame::PathResponse { data: [0xba; 8] })
);
}
#[cfg(not(feature = "openssl"))] #[rstest]
fn early_1rtt_packet(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
let delayed = flight;
testing::emit_flight(&mut pipe.server).ok();
assert!(pipe.client.is_established());
let frames = [frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"hello, world", 0, true),
}];
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
let frames = [frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"hello, world", 0, true),
}];
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
assert!(!pipe.server.is_established());
assert_eq!(
pipe.server.pkt_num_spaces[packet::Epoch::Application]
.largest_rx_pkt_num,
0
);
testing::process_flight(&mut pipe.server, delayed).unwrap();
assert!(pipe.server.is_established());
assert_eq!(
pipe.server.pkt_num_spaces[packet::Epoch::Application]
.largest_rx_pkt_num,
0
);
}
#[rstest]
fn stop_sending(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((5, true)));
assert!(pipe.server.stream_finished(0));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
while pipe.server.stream_send(0, b"world", false) != Err(Error::Done) {
assert_eq!(pipe.advance(), Ok(()));
}
let mut r = pipe.server.writable();
assert_eq!(r.next(), None);
let frames = [frame::Frame::StopSending {
stream_id: 0,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::ResetStream {
stream_id: 0,
error_code: 42,
final_size: 15,
})
);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(
pipe.server.stream_send(0, b"world", true),
Err(Error::StreamStopped(42)),
);
assert_eq!(pipe.server.streams.len(), 1);
let mut ranges = ranges::RangeSet::default();
ranges.insert(pipe.server.next_pkt_num - 5..pipe.server.next_pkt_num);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(0));
assert_eq!(pipe.server.streams.len(), 0);
let frames = [frame::Frame::StopSending {
stream_id: 0,
error_code: 42,
}];
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(frames.len(), 1);
match frames.first() {
Some(frame::Frame::ACK { .. }) => (),
f => panic!("expected ACK frame, got {:?}", f),
};
let mut r = pipe.server.writable();
assert_eq!(r.next(), None);
}
#[rstest]
fn stop_sending_fin(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, true)));
assert!(pipe.server.stream_finished(4));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_send(4, b"world", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"world", true), Ok(5));
let frames = [frame::Frame::StopSending {
stream_id: 4,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::ResetStream {
stream_id: 4,
error_code: 42,
final_size: 5,
})
);
assert_eq!(iter.next(), None);
}
#[rstest]
fn stop_sending_unsent_tx_cap(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(15);
config.set_initial_max_stream_data_bidi_local(30);
config.set_initial_max_stream_data_bidi_remote(30);
config.set_initial_max_stream_data_uni(30);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, true)));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(
pipe.server.stream_send(4, b"hello", false),
Err(Error::Done)
);
let frames = [frame::Frame::StopSending {
stream_id: 4,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(pipe.client.stream_send(8, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(8, b"hello", false), Ok(5));
assert_eq!(pipe.server.stream_send(8, b"hello", false), Ok(5));
assert_eq!(
pipe.server.stream_send(8, b"hello", false),
Err(Error::Done)
);
assert_eq!(pipe.advance(), Ok(()));
}
#[rstest]
fn stream_shutdown_read(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello, world", false), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.server.streams.len(), 1);
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Read, 42), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let (len, _) = pipe.server.send(&mut buf).unwrap();
let mut dummy = buf[..len].to_vec();
let frames =
testing::decode_pkt(&mut pipe.client, &mut dummy[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::StopSending {
stream_id: 4,
error_code: 42,
})
);
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.writable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(
pipe.client.stream_send(4, b"bye", false),
Err(Error::StreamStopped(42))
);
assert_eq!(pipe.server.stream_send(4, b"hello, world", true), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(4, &mut buf), Ok((12, true)));
assert_eq!(pipe.client.streams.len(), 0);
assert_eq!(pipe.server.streams.len(), 0);
assert_eq!(
pipe.server.stream_shutdown(4, Shutdown::Read, 0),
Err(Error::Done)
);
}
#[rstest]
fn stream_shutdown_read_after_fin(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello, world", true), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.server.streams.len(), 1);
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Read, 42), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.server.send(&mut buf), Err(Error::Done));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"hello, world", true), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_recv(4, &mut buf), Ok((12, true)));
assert_eq!(pipe.client.streams.len(), 0);
assert_eq!(pipe.server.streams.len(), 0);
assert_eq!(
pipe.server.stream_shutdown(4, Shutdown::Read, 0),
Err(Error::Done)
);
}
#[rstest]
fn stream_shutdown_read_update_max_data(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(10000);
config.set_initial_max_stream_data_bidi_remote(10000);
config.set_initial_max_streams_bidi(10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_recv(0, &mut buf), Ok((1, false)));
assert_eq!(pipe.server.stream_shutdown(0, Shutdown::Read, 123), Ok(()));
assert_eq!(pipe.server.rx_data, 1);
assert_eq!(pipe.client.tx_data, 1);
assert_eq!(pipe.client.max_tx_data, 30);
assert_eq!(
pipe.client
.stream_send(0, &buf[..pipe.client.tx_cap], false),
Ok(29)
);
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.server.stream_readable(0));
assert_eq!(pipe.client.tx_data, 30);
assert_eq!(pipe.server.rx_data, 30);
assert_eq!(pipe.client.tx_cap, 45);
}
#[rstest]
fn stream_shutdown_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(2, b"hello, world", false), Ok(10));
assert_eq!(pipe.server.stream_send(3, b"hello, world", false), Ok(10));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_shutdown(2, Shutdown::Write, 42), Ok(()));
assert_eq!(
pipe.client.stream_shutdown(2, Shutdown::Read, 42),
Err(Error::InvalidStreamState(2))
);
assert_eq!(
pipe.client.stream_shutdown(3, Shutdown::Write, 42),
Err(Error::InvalidStreamState(3))
);
assert_eq!(pipe.client.stream_shutdown(3, Shutdown::Read, 42), Ok(()));
}
#[rstest]
fn stream_shutdown_write(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello, world", false), Ok(12));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.server.streams.len(), 1);
assert_eq!(pipe.server.stream_send(4, b"goodbye, world", false), Ok(14));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Write, 42), Ok(()));
let mut r = pipe.server.writable();
assert_eq!(r.next(), None);
let (len, _) = pipe.server.send(&mut buf).unwrap();
let mut dummy = buf[..len].to_vec();
let frames =
testing::decode_pkt(&mut pipe.client, &mut dummy[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::ResetStream {
stream_id: 4,
error_code: 42,
final_size: 14,
})
);
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.server.stream_send(4, b"bye", false),
Err(Error::FinalSize)
);
assert_eq!(pipe.client.stream_send(4, b"bye", true), Ok(3));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(4, &mut buf), Ok((15, true)));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
assert_eq!(
pipe.client.stream_recv(4, &mut buf),
Err(Error::StreamReset(42))
);
assert_eq!(pipe.client.streams.len(), 0);
assert_eq!(pipe.server.streams.len(), 0);
assert_eq!(
pipe.server.stream_shutdown(4, Shutdown::Write, 0),
Err(Error::Done)
);
}
#[rstest]
fn stream_shutdown_write_unsent_tx_cap(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(15);
config.set_initial_max_stream_data_bidi_local(30);
config.set_initial_max_stream_data_bidi_remote(30);
config.set_initial_max_stream_data_uni(30);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), None);
let mut b = [0; 15];
assert_eq!(pipe.server.stream_recv(4, &mut b), Ok((5, true)));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(pipe.server.stream_send(4, b"hello", false), Ok(5));
assert_eq!(
pipe.server.stream_send(4, b"hello", false),
Err(Error::Done)
);
assert!(!pipe.client.should_update_max_data());
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Write, 42), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(8, b"hello", false), Ok(5));
assert_eq!(pipe.server.stream_send(8, b"hello", false), Ok(5));
assert_eq!(
pipe.server.stream_send(8, b"hello", false),
Err(Error::Done)
);
assert_eq!(pipe.advance(), Ok(()));
}
#[rstest]
fn stream_round_robin(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.stream_send(0, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"aaaaa", 0, false),
})
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaa", 0, false),
})
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"aaaaa", 0, false),
})
);
}
#[rstest]
fn stream_readable(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_send(0, b"aaaaa", false), Ok(5));
let mut r = pipe.client.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(
pipe.server.stream_send(0, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
let mut b = [0; 15];
pipe.client.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_shutdown(0, Shutdown::Read, 0), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.len(), 2);
assert!(r.next().is_some());
assert!(r.next().is_some());
assert!(r.next().is_none());
assert_eq!(r.len(), 0);
}
#[rstest]
fn stream_writable(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut w = pipe.client.writable();
assert_eq!(w.next(), None);
assert_eq!(pipe.client.stream_send(0, b"aaaaa", false), Ok(5));
let mut w = pipe.client.writable();
assert_eq!(w.next(), Some(0));
assert_eq!(w.next(), None);
assert_eq!(pipe.advance(), Ok(()));
let mut w = pipe.server.writable();
assert_eq!(w.next(), Some(0));
assert_eq!(w.next(), None);
assert_eq!(
pipe.server.stream_send(0, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
let mut w = pipe.server.writable();
assert_eq!(w.next(), None);
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.client.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let mut w = pipe.server.writable();
assert_eq!(w.next(), Some(0));
assert_eq!(w.next(), None);
assert_eq!(pipe.server.stream_shutdown(0, Shutdown::Write, 0), Ok(()));
let mut w = pipe.server.writable();
assert_eq!(w.next(), None);
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut w = pipe.server.writable();
assert_eq!(w.len(), 2);
assert!(w.next().is_some());
assert!(w.next().is_some());
assert!(w.next().is_none());
assert_eq!(w.len(), 0);
assert_eq!(pipe.server.stream_send(8, b"aaaaa", true), Ok(5));
let mut w = pipe.server.writable();
assert_eq!(w.next(), Some(4));
assert_eq!(w.next(), None);
}
#[rstest]
fn stream_writable_blocked(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = crate::Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config.set_application_protos(&[b"h3"]).unwrap();
config.set_initial_max_data(70);
config.set_initial_max_stream_data_bidi_local(150000);
config.set_initial_max_stream_data_bidi_remote(150000);
config.set_initial_max_stream_data_uni(150000);
config.set_initial_max_streams_bidi(100);
config.set_initial_max_streams_uni(5);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let send_buf = [0; 35];
assert_eq!(pipe.client.stream_send(0, &send_buf, false), Ok(35));
assert_eq!(pipe.client.stream_writable_next(), Some(0));
assert_eq!(pipe.client.stream_writable_next(), None);
let send_buf = [0; 36];
assert_eq!(pipe.client.stream_send(0, &send_buf, false), Ok(35));
assert_eq!(pipe.client.stream_writable_next(), None);
assert_eq!(pipe.client.tx_cap, 0);
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 70];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_ne!(pipe.client.tx_cap, 0);
assert_eq!(pipe.client.stream_writable_next(), Some(0));
assert_eq!(pipe.client.stream_writable_next(), None);
}
#[rstest]
fn flow_control_limit_send(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.stream_send(0, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.stream_send(4, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"a", false), Err(Error::Done));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert!(r.next().is_some());
assert!(r.next().is_some());
assert!(r.next().is_none());
}
#[rstest]
fn invalid_initial_server(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let frames = [frame::Frame::Padding { len: 10 }];
let written = testing::encode_pkt(
&mut pipe.client,
packet::Type::Initial,
&frames,
&mut buf,
)
.unwrap();
buf[written - 1] = !buf[written - 1];
assert_eq!(pipe.server.timeout(), None);
assert_eq!(
pipe.server_recv(&mut buf[..written]),
Err(Error::CryptoFail)
);
assert!(pipe.server.is_closed());
}
#[rstest]
fn invalid_initial_client(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(1200));
let frames = [frame::Frame::Padding { len: 10 }];
let written = testing::encode_pkt(
&mut pipe.server,
packet::Type::Initial,
&frames,
&mut buf,
)
.unwrap();
buf[written - 1] = !buf[written - 1];
assert_eq!(pipe.client_recv(&mut buf[..written]), Ok(71));
assert!(!pipe.client.is_closed());
assert!(pipe.client.idle_timer.is_some());
}
#[rstest]
fn invalid_initial_payload(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let mut b = octets::OctetsMut::with_slice(&mut buf);
let epoch = packet::Type::Initial.to_epoch().unwrap();
let pn = 0;
let pn_len = packet::pkt_num_len(pn, 0);
let dcid = pipe.client.destination_id();
let scid = pipe.client.source_id();
let hdr = Header {
ty: packet::Type::Initial,
version: pipe.client.version,
dcid: ConnectionId::from_ref(&dcid),
scid: ConnectionId::from_ref(&scid),
pkt_num: 0,
pkt_num_len: pn_len,
token: pipe.client.token.clone(),
versions: None,
key_phase: false,
};
hdr.to_bytes(&mut b).unwrap();
let payload_len = 4096;
let len = pn_len + payload_len;
b.put_varint(len as u64).unwrap();
packet::encode_pkt_num(pn, pn_len, &mut b).unwrap();
let payload_offset = b.off();
let frames = [frame::Frame::Padding { len: 10 }];
for frame in &frames {
frame.to_bytes(&mut b).unwrap();
}
let crypto_ctx = &mut pipe.client.crypto_ctx[epoch];
let payload_len = frames.iter().fold(0, |acc, x| acc + x.wire_len());
let aead = crypto_ctx.crypto_seal.as_ref().unwrap();
let written = packet::encrypt_pkt(
&mut b,
pn,
pn_len,
payload_len,
payload_offset,
None,
aead,
)
.unwrap();
assert_eq!(pipe.server.timeout(), None);
assert_eq!(
pipe.server_recv(&mut buf[..written]),
Err(Error::InvalidPacket)
);
assert!(pipe.server.is_closed());
}
#[rstest]
fn invalid_packet(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Padding { len: 10 }];
let written = testing::encode_pkt(
&mut pipe.client,
packet::Type::Short,
&frames,
&mut buf,
)
.unwrap();
buf[written - 1] = !buf[written - 1];
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
buf[0] = 255;
assert_eq!(pipe.server_recv(&mut buf[..written]), Ok(written));
}
#[rstest]
fn recv_empty_buffer(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server_recv(&mut buf[..0]), Err(Error::BufferTooShort));
}
#[rstest]
fn stop_sending_before_flushed_packets(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((5, true)));
assert!(pipe.server.stream_finished(0));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
while pipe.server.stream_send(0, b"world", false) != Err(Error::Done) {}
let mut r = pipe.server.writable();
assert_eq!(r.next(), None);
let frames = [frame::Frame::StopSending {
stream_id: 0,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::ResetStream {
stream_id: 0,
error_code: 42,
final_size: 0,
})
);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(
pipe.server.stream_send(0, b"world", true),
Err(Error::StreamStopped(42)),
);
assert_eq!(pipe.server.streams.len(), 1);
let mut ranges = ranges::RangeSet::default();
ranges.insert(0..6);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(0));
assert_eq!(pipe.server.streams.len(), 0);
}
#[rstest]
fn reset_before_flushed_packets(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(5);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_streams_bidi(3);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((5, true)));
assert!(pipe.server.stream_finished(0));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let mut r = pipe.server.writable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
assert_eq!(pipe.server.stream_send(0, b"helloworld", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_recv(0, &mut b), Ok((5, false)));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(0, b"world", false), Ok(5));
pipe.server.stream_shutdown(0, Shutdown::Write, 42).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.streams.len(), 0);
}
#[rstest]
fn stream_limit_update_bidi(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
pipe.server.stream_recv(4, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(4, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(0, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(12, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(16, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.stream_send(20, b"a", false),
Err(Error::StreamLimit)
);
assert_eq!(pipe.server.readable().len(), 3);
}
#[rstest]
fn stream_limit_update_uni(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(0);
config.set_initial_max_streams_uni(3);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(2, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(6, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(6, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(2, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(2, &mut b).unwrap();
pipe.server.stream_recv(6, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(10, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(14, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(18, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.stream_send(22, b"a", false),
Err(Error::StreamLimit)
);
assert_eq!(pipe.server.readable().len(), 3);
}
#[rstest]
fn stream_zero_length_fin(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.stream_send(0, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert!(r.next().is_none());
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert!(r.next().is_none());
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
}
#[rstest]
fn stream_zero_length_fin_deferred_collection(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.stream_send(0, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert!(r.next().is_none());
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert!(r.next().is_none());
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"", true), Ok(0));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.next(), None);
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(0));
pipe.client.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), None);
}
#[rstest]
fn stream_zero_length_non_fin(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"", false), Ok(0));
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert!(r.next().is_none());
}
#[rstest]
fn collect_streams(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.streams.len(), 0);
assert_eq!(pipe.server.streams.len(), 0);
assert_eq!(pipe.client.stream_send(0, b"aaaaa", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.client.stream_finished(0));
assert!(!pipe.server.stream_finished(0));
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.server.streams.len(), 1);
let mut b = [0; 5];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.stream_send(0, b"aaaaa", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.client.stream_finished(0));
assert!(pipe.server.stream_finished(0));
assert_eq!(pipe.client.streams.len(), 1);
assert_eq!(pipe.server.streams.len(), 0);
let mut b = [0; 5];
pipe.client.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.streams.len(), 0);
assert_eq!(pipe.server.streams.len(), 0);
assert!(pipe.client.stream_finished(0));
assert!(pipe.server.stream_finished(0));
assert_eq!(pipe.client.stream_send(0, b"", true), Err(Error::Done));
let frames = [frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aa", 0, false),
}];
let pkt_type = packet::Type::Short;
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(39));
}
#[test]
fn config_set_cc_algorithm_name() {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name("reno"), Ok(()));
assert_eq!(
config.set_cc_algorithm_name("???"),
Err(Error::CongestionControl)
);
}
#[rstest]
fn peer_cert(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
match pipe.client.peer_cert() {
Some(c) => assert_eq!(c.len(), 753),
None => panic!("missing server certificate"),
}
}
#[rstest]
fn peer_cert_chain(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert-big.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
match pipe.client.peer_cert_chain() {
Some(c) => assert_eq!(c.len(), 5),
None => panic!("missing server certificate chain"),
}
}
#[rstest]
fn retry(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let (mut len, _) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
let odcid = hdr.dcid.clone();
let mut scid = [0; MAX_CONN_ID_LEN];
rand::rand_bytes(&mut scid[..]);
let scid = ConnectionId::from_ref(&scid);
let token = b"quiche test retry token";
len = packet::retry(
&hdr.scid,
&hdr.dcid,
&scid,
token,
hdr.version,
&mut buf,
)
.unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
let (len, send_info) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
assert_eq!(&hdr.token.unwrap(), token);
pipe.server = accept(
&scid,
Some(&odcid),
testing::Pipe::server_addr(),
send_info.from,
&mut config,
)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe.client.is_established());
assert!(pipe.server.is_established());
}
#[rstest]
fn retry_with_pto(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let (mut len, _) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
let odcid = hdr.dcid.clone();
let mut scid = [0; MAX_CONN_ID_LEN];
rand::rand_bytes(&mut scid[..]);
let scid = ConnectionId::from_ref(&scid);
let token = b"quiche test retry token";
len = packet::retry(
&hdr.scid,
&hdr.dcid,
&scid,
token,
hdr.version,
&mut buf,
)
.unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
let (len, send_info) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
assert_eq!(&hdr.token.unwrap(), token);
pipe.server = accept(
&scid,
Some(&odcid),
testing::Pipe::server_addr(),
send_info.from,
&mut config,
)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let timer = pipe.client.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe.client.is_established());
assert!(pipe.server.is_established());
}
#[rstest]
fn missing_retry_source_connection_id(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let (mut len, _) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
let mut scid = [0; MAX_CONN_ID_LEN];
rand::rand_bytes(&mut scid[..]);
let scid = ConnectionId::from_ref(&scid);
let token = b"quiche test retry token";
len = packet::retry(
&hdr.scid,
&hdr.dcid,
&scid,
token,
hdr.version,
&mut buf,
)
.unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let from = "127.0.0.1:1234".parse().unwrap();
pipe.server =
accept(&scid, None, testing::Pipe::server_addr(), from, &mut config)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert_eq!(
testing::process_flight(&mut pipe.client, flight),
Err(Error::InvalidTransportParam)
);
}
#[rstest]
fn invalid_retry_source_connection_id(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
let (mut len, _) = pipe.client.send(&mut buf).unwrap();
let hdr = Header::from_slice(&mut buf[..len], MAX_CONN_ID_LEN).unwrap();
let mut scid = [0; MAX_CONN_ID_LEN];
rand::rand_bytes(&mut scid[..]);
let scid = ConnectionId::from_ref(&scid);
let token = b"quiche test retry token";
len = packet::retry(
&hdr.scid,
&hdr.dcid,
&scid,
token,
hdr.version,
&mut buf,
)
.unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let from = "127.0.0.1:1234".parse().unwrap();
let odcid = ConnectionId::from_ref(b"bogus value");
pipe.server = accept(
&scid,
Some(&odcid),
testing::Pipe::server_addr(),
from,
&mut config,
)
.unwrap();
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert_eq!(
testing::process_flight(&mut pipe.client, flight),
Err(Error::InvalidTransportParam)
);
}
#[rstest]
fn zero_length_new_token(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = vec![frame::Frame::NewToken { token: vec![] }];
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.server, pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(
pipe.client_recv(&mut buf[..written]),
Err(Error::InvalidFrame)
);
}
#[rstest]
fn client_sent_new_token(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = vec![frame::Frame::NewToken {
token: vec![1, 2, 3],
}];
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(
pipe.server_recv(&mut buf[..written]),
Err(Error::InvalidPacket)
);
}
fn check_send(_: &mut impl Send) {}
#[rstest]
fn config_must_be_send(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
check_send(&mut config);
}
#[rstest]
fn connection_must_be_send(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
check_send(&mut pipe.client);
}
fn check_sync(_: &mut impl Sync) {}
#[rstest]
fn config_must_be_sync(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
check_sync(&mut config);
}
#[rstest]
fn connection_must_be_sync(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
check_sync(&mut pipe.client);
}
#[rstest]
fn data_blocked(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"aaaaaaaaaa", false), Ok(10));
assert_eq!(pipe.client.blocked_limit, None);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"aaaaaaaaaa", false), Ok(10));
assert_eq!(pipe.client.blocked_limit, None);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"aaaaaaaaaaa", false), Ok(10));
assert_eq!(pipe.client.blocked_limit, Some(30));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.client.blocked_limit, None);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(iter.next(), Some(&frame::Frame::DataBlocked { limit: 30 }));
assert_eq!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"aaaaaaaaaa", 0, false),
})
);
assert_eq!(iter.next(), None);
}
#[rstest]
fn stream_data_blocked(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.stream_send(0, b"aaaaa", false), Ok(5));
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.stream_send(0, b"aaaaaa", false), Ok(5));
assert_eq!(pipe.client.streams.blocked().len(), 1);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.client.streams.blocked().len(), 0);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::StreamDataBlocked {
stream_id: 0,
limit: 15,
})
);
assert_eq!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aaaaaaaaaaaaaaa", 0, false),
})
);
assert_eq!(iter.next(), None);
assert_eq!(pipe.client.stream_send(4, b"a", false), Ok(1));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.client.streams.blocked().len(), 0);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"a", 0, false),
})
);
assert_eq!(iter.next(), None);
assert_eq!(
pipe.client.stream_send(0, b"aaaaaa", false),
Err(Error::Done)
);
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.send(&mut buf), Err(Error::Done));
}
#[rstest]
fn stream_data_blocked_unblocked_flow_control(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.stream_send(0, b"aaaaaaaaaaaaaaah", false),
Ok(15)
);
assert_eq!(pipe.client.streams.blocked().len(), 1);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.stream_send(0, b"h", false), Err(Error::Done));
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.stream_send(0, b"h", false), Err(Error::Done));
assert_eq!(pipe.client.send(&mut buf), Err(Error::Done));
assert_eq!(pipe.client.stream_send(0, b"h", false), Err(Error::Done));
assert_eq!(pipe.client.send(&mut buf), Err(Error::Done));
assert_eq!(pipe.client.stream_send(0, b"h", false), Err(Error::Done));
assert_eq!(pipe.client.send(&mut buf), Err(Error::Done));
let mut r = pipe.server.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), None);
let mut b = [0; 10];
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((10, false)));
assert_eq!(&b[..10], b"aaaaaaaaaa");
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hhhhhhhhhh!", false), Ok(10));
assert_eq!(pipe.client.streams.blocked().len(), 1);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.client.streams.blocked().len(), 0);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::StreamDataBlocked {
stream_id: 0,
limit: 25,
})
);
assert_eq!(pipe.client.stream_send(0, b"!", false), Err(Error::Done));
assert_eq!(pipe.client.streams.blocked().len(), 0);
assert_eq!(pipe.client.send(&mut buf), Err(Error::Done));
}
#[rstest]
fn app_limited_true(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let send_buf = [0; 10000];
assert_eq!(pipe.server.stream_send(0, &send_buf, false), Ok(10000));
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe
.server
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
}
#[rstest]
fn app_limited_false(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let send_buf1 = [0; 20000];
assert_eq!(pipe.server.stream_send(0, &send_buf1, false), Ok(12000));
testing::emit_flight(&mut pipe.server).ok();
assert!(!pipe
.server
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
}
#[test]
fn tx_cap_factor() {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(12000);
config.set_initial_max_stream_data_bidi_remote(12000);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
config.set_send_capacity_factor(2.0);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.client.stream_send(4, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 50000];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let send_buf = [0; 50000];
assert_eq!(pipe.server.stream_send(0, &send_buf, false), Ok(12000));
assert_eq!(pipe.server.stream_send(4, &send_buf, false), Ok(12000));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.client.readable();
assert_eq!(r.next(), Some(0));
assert_eq!(pipe.client.stream_recv(0, &mut b), Ok((12000, false)));
assert_eq!(r.next(), Some(4));
assert_eq!(pipe.client.stream_recv(4, &mut b), Ok((12000, false)));
assert_eq!(r.next(), None);
}
#[rstest]
fn sends_ack_only_pkt_when_full_cwnd_and_ack_elicited(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let send_buf1 = [0; 20000];
assert_eq!(
pipe.client.stream_send(0, &send_buf1, false),
if cc_algorithm_name == "cubic" {
Ok(12000)
} else {
if cfg!(feature = "openssl") {
Ok(12345)
} else {
Ok(12299)
}
}
);
testing::emit_flight(&mut pipe.client).ok();
assert_eq!(
pipe.server.stream_send(1, &send_buf1[..500], false),
Ok(500)
);
testing::process_flight(
&mut pipe.client,
testing::emit_flight(&mut pipe.server).unwrap(),
)
.unwrap();
let mut buf = [0; 2000];
let ret = pipe.client.send(&mut buf);
assert_eq!(pipe.client.tx_cap, 0);
assert!(matches!(ret, Ok((_, _))), "the client should at least send one packet to acknowledge the newly received data");
let (sent, _) = ret.unwrap();
assert_ne!(sent, 0, "the client should at least send a pure ACK packet");
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..sent]).unwrap();
assert_eq!(1, frames.len());
assert!(
matches!(frames[0], frame::Frame::ACK { .. }),
"the packet sent by the client must be an ACK only packet"
);
}
#[rstest]
fn sends_ack_only_pkt_when_full_cwnd_and_ack_elicited_despite_max_unacknowledging(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let send_buf1 = [0; 20000];
assert_eq!(
pipe.client.stream_send(0, &send_buf1, false),
if cc_algorithm_name == "cubic" {
Ok(12000)
} else {
if cfg!(feature = "openssl") {
Ok(12345)
} else {
Ok(12299)
}
}
);
testing::emit_flight(&mut pipe.client).ok();
let mut buf = [0; 2000];
for _ in 0..recovery::MAX_OUTSTANDING_NON_ACK_ELICITING {
let written = testing::encode_pkt(
&mut pipe.server,
packet::Type::Short,
&[frame::Frame::Ping { mtu_probe: None }],
&mut buf,
)
.unwrap();
pipe.client_recv(&mut buf[..written])
.expect("client recv ping");
let ret = pipe.client.send(&mut buf);
assert!(matches!(ret, Ok((_, _))), "the client should at least send one packet to acknowledge the newly received data");
let (sent, _) = ret.unwrap();
assert_ne!(
sent, 0,
"the client should at least send a pure ACK packet"
);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..sent]).unwrap();
assert_eq!(1, frames.len());
assert!(
matches!(frames[0], frame::Frame::ACK { .. }),
"the packet sent by the client must be an ACK only packet"
);
}
assert_eq!(
pipe.client.send(&mut buf),
Err(Error::Done),
"nothing for client to send after ACK-only packet"
);
}
#[rstest]
fn validate_peer_sent_ack_range(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
config.set_cc_algorithm_name(cc_algorithm_name).unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(30);
config.set_initial_max_stream_data_bidi_remote(30);
config.set_initial_max_stream_data_uni(30);
config.set_initial_max_streams_bidi(10);
config.set_initial_max_streams_uni(10);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
pipe.handshake().unwrap();
let mut buf = [0; 2000];
let epoch = packet::Epoch::Application;
let pkt_type = packet::Type::Short;
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let expected_max_active_pkt_sent = 3;
let recovery = &pipe.server.paths.get_active().unwrap().recovery;
assert_eq!(
recovery.largest_sent_pkt_num_on_path(epoch).unwrap(),
expected_max_active_pkt_sent
);
assert_eq!(recovery.get_largest_acked_on_epoch(epoch).unwrap(), 3);
assert_eq!(recovery.sent_packets_len(epoch), 0);
assert_eq!(
pipe.server.pkt_num_spaces[epoch]
.largest_tx_pkt_num
.unwrap(),
expected_max_active_pkt_sent
);
let frames = [frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"aa", 0, false),
}];
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let recovery = &pipe.server.paths.get_active().unwrap().recovery;
assert_eq!(recovery.largest_sent_pkt_num_on_path(epoch).unwrap(), 4);
assert_eq!(recovery.get_largest_acked_on_epoch(epoch).unwrap(), 3);
assert_eq!(recovery.sent_packets_len(epoch), 1);
let mut ranges = ranges::RangeSet::default();
ranges.insert(0..10);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap_err(),
Error::InvalidAckRange
);
assert_eq!(
pipe.server.local_error.unwrap().error_code,
WireErrorCode::ProtocolViolation as u64
);
}
#[rstest]
fn validate_peer_sent_ack_range_for_multi_path(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
let probed_pid =
pipe.client.probe_path(client_addr_2, server_addr).unwrap() as usize;
pipe.advance().unwrap();
assert_eq!(pipe.server.paths.len(), 2);
let mut buf = [0; 2000];
let epoch = packet::Epoch::Application;
let pkt_type = packet::Type::Short;
let expected_max_active_pkt_sent = 7;
let active_path = &pipe.server.paths.get_mut(0).unwrap();
let p1_recovery = &active_path.recovery;
assert_eq!(
p1_recovery.largest_sent_pkt_num_on_path(epoch).unwrap(),
expected_max_active_pkt_sent
);
assert_eq!(p1_recovery.get_largest_acked_on_epoch(epoch).unwrap(), 6);
assert_eq!(p1_recovery.sent_packets_len(epoch), 1);
let expected_max_second_pkt_sent = 5;
let second_path = &pipe.server.paths.get_mut(probed_pid).unwrap();
let p2_recovery = &second_path.recovery;
assert_eq!(
p2_recovery.largest_sent_pkt_num_on_path(epoch).unwrap(),
expected_max_second_pkt_sent
);
assert_eq!(p2_recovery.get_largest_acked_on_epoch(epoch).unwrap(), 5);
assert_eq!(p2_recovery.sent_packets_len(epoch), 0);
let global_max_sent = pipe.server.pkt_num_spaces[epoch]
.largest_tx_pkt_num
.unwrap();
assert_eq!(
global_max_sent,
expected_max_active_pkt_sent.max(expected_max_second_pkt_sent)
);
let mut ranges = ranges::RangeSet::default();
ranges.insert(0..global_max_sent + 1);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let active_path = &pipe.server.paths.get_mut(0).unwrap();
assert!(active_path.active());
let p1_recovery = &active_path.recovery;
assert_eq!(p1_recovery.largest_sent_pkt_num_on_path(epoch).unwrap(), 7);
assert_eq!(p1_recovery.get_largest_acked_on_epoch(epoch).unwrap(), 7);
assert_eq!(p1_recovery.sent_packets_len(epoch), 0);
let second_path = &pipe.server.paths.get_mut(probed_pid).unwrap();
let p2_recovery = &second_path.recovery;
assert_eq!(p2_recovery.largest_sent_pkt_num_on_path(epoch).unwrap(), 5);
assert_eq!(p2_recovery.get_largest_acked_on_epoch(epoch).unwrap(), 5);
assert_eq!(p2_recovery.sent_packets_len(epoch), 0);
let mut ranges = ranges::RangeSet::default();
ranges.insert(0..global_max_sent + 2);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap_err(),
Error::InvalidAckRange
);
assert_eq!(
pipe.server.local_error.unwrap().error_code,
WireErrorCode::ProtocolViolation as u64
);
}
#[rstest]
fn optimistic_ack_mitigation_via_skip_pn(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
config.set_cc_algorithm_name(cc_algorithm_name).unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(100_0000);
config.set_initial_max_stream_data_bidi_local(100_000);
config.set_initial_max_stream_data_bidi_remote(100_000);
config.set_initial_max_streams_bidi(10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
pipe.handshake().unwrap();
let mut server_skip_pn = None;
let mut client_skip_pn = None;
let buf = [42; 100];
while server_skip_pn.is_none() || client_skip_pn.is_none() {
assert_eq!(pipe.server.stream_send(1, &buf, false).unwrap(), 100);
let flight = testing::emit_flight(&mut pipe.server).unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
let server_num_manager = &pipe.server.pkt_num_manager;
if let Some(skip_pn) = server_num_manager.skip_pn() {
server_skip_pn = Some(skip_pn);
}
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let client_num_manager = &pipe.client.pkt_num_manager;
if let Some(skip_pn) = client_num_manager.skip_pn() {
client_skip_pn = Some(skip_pn);
}
}
assert!(server_skip_pn.is_some() && client_skip_pn.is_some());
}
#[rstest]
fn prevent_optimistic_ack(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
config.set_cc_algorithm_name(cc_algorithm_name).unwrap();
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(100_0000);
config.set_initial_max_stream_data_bidi_local(100_000);
config.set_initial_max_stream_data_bidi_remote(100_000);
config.set_initial_max_streams_bidi(10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
pipe.handshake().unwrap();
let mut server_skip_pn = None;
let buf = [42; 100];
while server_skip_pn.is_none() {
pipe.server.stream_send(1, &buf, false).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
if let Some(skip_pn) = pipe.server.pkt_num_manager.skip_pn() {
server_skip_pn = Some(skip_pn);
}
}
let pkt_type = packet::Type::Short;
let mut buf = [0; 2000];
let skip_pn = server_skip_pn.unwrap();
let mut ranges = ranges::RangeSet::default();
ranges.insert(skip_pn..skip_pn + 1);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.err()
.unwrap(),
Error::OptimisticAckDetected
);
assert_eq!(
pipe.server.local_error.unwrap().error_code,
WireErrorCode::ProtocolViolation as u64
);
}
#[rstest]
fn app_limited_false_no_frame(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_max_recv_udp_payload_size(1405);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let send_buf1 = [0; 20000];
assert_eq!(pipe.server.stream_send(0, &send_buf1, false), Ok(12000));
testing::emit_flight(&mut pipe.server).ok();
assert!(!pipe
.server
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
}
#[rstest]
fn app_limited_false_no_header(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_max_recv_udp_payload_size(1406);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
let send_buf1 = [0; 20000];
assert_eq!(pipe.server.stream_send(0, &send_buf1, false), Ok(12000));
testing::emit_flight(&mut pipe.server).ok();
assert!(!pipe
.server
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
}
#[rstest]
fn app_limited_not_changed_on_no_new_frames(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(50000);
config.set_initial_max_stream_data_bidi_local(50000);
config.set_initial_max_stream_data_bidi_remote(50000);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe
.client
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
assert_eq!(testing::emit_flight(&mut pipe.client), Err(Error::Done));
assert!(pipe
.client
.paths
.get_active()
.expect("no active")
.recovery
.app_limited());
}
#[rstest]
fn limit_ack_ranges(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let epoch = packet::Epoch::Application;
assert_eq!(pipe.server.pkt_num_spaces[epoch].recv_pkt_need_ack.len(), 0);
let frames = [
frame::Frame::Ping { mtu_probe: None },
frame::Frame::Padding { len: 3 },
];
let pkt_type = packet::Type::Short;
let mut last_packet_sent = 0;
for _ in 0..512 {
let recv_count = pipe.server.recv_count;
last_packet_sent = pipe.client.next_pkt_num;
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert_eq!(pipe.server.recv_count, recv_count + 1);
pipe.client.next_pkt_num += 1;
}
assert_eq!(
pipe.server.pkt_num_spaces[epoch].recv_pkt_need_ack.len(),
MAX_ACK_RANGES
);
assert_eq!(
pipe.server.pkt_num_spaces[epoch].recv_pkt_need_ack.first(),
Some(last_packet_sent - ((MAX_ACK_RANGES as u64) - 1) * 2)
);
assert_eq!(
pipe.server.pkt_num_spaces[epoch].recv_pkt_need_ack.last(),
Some(last_packet_sent)
);
}
#[rstest]
fn stream_priority(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
const MAX_TEST_PACKET_SIZE: usize = 540;
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(1_000_000);
config.set_initial_max_stream_data_bidi_local(1_000_000);
config.set_initial_max_stream_data_bidi_remote(1_000_000);
config.set_initial_max_stream_data_uni(0);
config.set_initial_max_streams_bidi(100);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(12, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(16, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(20, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 1];
let out = [b'b'; 500];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(0, 255, true), Ok(()));
pipe.server.stream_send(0, &out, false).unwrap();
pipe.server.stream_send(0, &out, false).unwrap();
pipe.server.stream_send(0, &out, false).unwrap();
pipe.server.stream_recv(12, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(12, 42, true), Ok(()));
pipe.server.stream_send(12, &out, false).unwrap();
pipe.server.stream_send(12, &out, false).unwrap();
pipe.server.stream_send(12, &out, false).unwrap();
pipe.server.stream_recv(16, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(16, 10, false), Ok(()));
pipe.server.stream_send(16, &out, false).unwrap();
pipe.server.stream_send(16, &out, false).unwrap();
pipe.server.stream_send(16, &out, false).unwrap();
pipe.server.stream_recv(4, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(4, 42, true), Ok(()));
pipe.server.stream_send(4, &out, false).unwrap();
pipe.server.stream_send(4, &out, false).unwrap();
pipe.server.stream_send(4, &out, false).unwrap();
pipe.server.stream_recv(8, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(8, 10, false), Ok(()));
pipe.server.stream_send(8, &out, false).unwrap();
pipe.server.stream_send(8, &out, false).unwrap();
pipe.server.stream_send(8, &out, false).unwrap();
pipe.server.stream_recv(20, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(20, 42, false), Ok(()));
pipe.server.stream_send(20, &out, false).unwrap();
pipe.server.stream_send(20, &out, false).unwrap();
pipe.server.stream_send(20, &out, false).unwrap();
let mut off = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let stream = frames.first().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(&out, off, false),
});
off = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
}
let mut off = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let stream = frames.first().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 16,
data: <RangeBuf>::from(&out, off, false),
});
off = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
}
let mut off = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let stream = frames.first().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 20,
data: <RangeBuf>::from(&out, off, false),
});
off = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
}
let mut off = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 12,
data: <RangeBuf>::from(&out, off, false),
})
);
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let stream = frames.first().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(&out, off, false),
});
off = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
}
let mut off = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let stream = frames.first().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(&out, off, false),
});
off = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
}
assert_eq!(pipe.server.send(&mut buf), Err(Error::Done));
}
#[rstest]
fn stream_reprioritize(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(0);
config.set_initial_max_streams_bidi(5);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(12, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 1];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(0, 255, true), Ok(()));
pipe.server.stream_send(0, b"b", false).unwrap();
pipe.server.stream_recv(12, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(12, 42, true), Ok(()));
pipe.server.stream_send(12, b"b", false).unwrap();
pipe.server.stream_recv(8, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(8, 10, true), Ok(()));
pipe.server.stream_send(8, b"b", false).unwrap();
pipe.server.stream_recv(4, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(4, 42, true), Ok(()));
pipe.server.stream_send(4, b"b", false).unwrap();
assert_eq!(pipe.server.stream_priority(0, 20, true), Ok(()));
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 8,
data: <RangeBuf>::from(b"b", 0, false),
})
);
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(b"b", 0, false),
})
);
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 12,
data: <RangeBuf>::from(b"b", 0, false),
})
);
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"b", 0, false),
})
);
assert_eq!(pipe.server.send(&mut buf), Err(Error::Done));
}
#[rstest]
fn stream_datagram_priority(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
const MAX_TEST_PACKET_SIZE: usize = 540;
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(1_000_000);
config.set_initial_max_stream_data_bidi_local(1_000_000);
config.set_initial_max_stream_data_bidi_remote(1_000_000);
config.set_initial_max_stream_data_uni(0);
config.set_initial_max_streams_bidi(100);
config.set_initial_max_streams_uni(0);
config.enable_dgram(true, 10, 10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 1];
let out = [b'b'; 500];
pipe.server.stream_recv(0, &mut b).unwrap();
assert_eq!(pipe.server.stream_priority(0, 255, true), Ok(()));
pipe.server.stream_send(0, &out, false).unwrap();
pipe.server.stream_send(0, &out, false).unwrap();
pipe.server.stream_send(0, &out, false).unwrap();
assert_eq!(pipe.server.stream_priority(4, 255, true), Ok(()));
pipe.server.stream_send(4, &out, false).unwrap();
pipe.server.stream_send(4, &out, false).unwrap();
pipe.server.stream_send(4, &out, false).unwrap();
for _ in 1..=6 {
assert_eq!(pipe.server.dgram_send(&out), Ok(()));
}
let mut off_0 = 0;
let mut off_4 = 0;
for _ in 1..=3 {
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut frame_iter = frames.iter();
assert_eq!(frame_iter.next().unwrap(), &frame::Frame::Datagram {
data: out.into()
});
assert_eq!(frame_iter.next(), None);
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut frame_iter = frames.iter();
let stream = frame_iter.next().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 0,
data: <RangeBuf>::from(&out, off_0, false),
});
off_0 = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
assert_eq!(frame_iter.next(), None);
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut frame_iter = frames.iter();
assert_eq!(frame_iter.next().unwrap(), &frame::Frame::Datagram {
data: out.into()
});
assert_eq!(frame_iter.next(), None);
let (len, _) =
pipe.server.send(&mut buf[..MAX_TEST_PACKET_SIZE]).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut frame_iter = frames.iter();
let stream = frame_iter.next().unwrap();
assert_eq!(stream, &frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(&out, off_4, false),
});
off_4 = match stream {
frame::Frame::Stream { data, .. } => data.max_off(),
_ => unreachable!(),
};
assert_eq!(frame_iter.next(), None);
}
}
#[rstest]
fn early_retransmit(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"a", false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"b", false), Ok(1));
assert!(pipe.client.send(&mut buf).is_ok());
let timer = pipe.client.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
let epoch = packet::Epoch::Application;
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
1,
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
0,
);
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 4,
data: <RangeBuf>::from(b"b", 0, false),
})
);
assert_eq!(pipe.client.stats().retrans, 1);
}
#[rstest]
fn dont_coalesce_probes(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(pipe.client.path_stats().next().unwrap().total_pto_count, 0);
let timer = pipe.client.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
assert_eq!(pipe.client.path_stats().next().unwrap().total_pto_count, 1);
let epoch = packet::Epoch::Initial;
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
1,
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
0,
);
let timer = pipe.client.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
assert_eq!(pipe.client.path_stats().next().unwrap().total_pto_count, 2);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
2,
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
1,
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.recovery
.loss_probes(epoch),
0,
);
}
#[rstest]
fn coalesce_padding_short(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, MIN_CLIENT_INITIAL_LEN);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let (len, _) = pipe.server.send(&mut buf).unwrap();
assert_eq!(len, MIN_CLIENT_INITIAL_LEN);
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
let (len, _) = pipe.server.send(&mut buf).unwrap();
assert_eq!(pipe.client_recv(&mut buf[..len]), Ok(len));
assert!(pipe.client.is_established());
assert_eq!(pipe.client.stream_send(4, b"hello", true), Ok(5));
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, MIN_CLIENT_INITIAL_LEN);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
assert_eq!(pipe.client.sent_count, pipe.server.recv_count);
assert_eq!(pipe.server.sent_count, pipe.client.recv_count);
}
#[rstest]
fn handshake_anti_deadlock(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert-big.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
let mut pipe = testing::Pipe::with_server_config(&mut config).unwrap();
assert!(!pipe.client.handshake_status().has_handshake_keys);
assert!(!pipe.client.handshake_status().peer_verified_address);
assert!(!pipe.server.handshake_status().has_handshake_keys);
assert!(pipe.server.handshake_status().peer_verified_address);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.client.handshake_status().has_handshake_keys);
assert!(!pipe.client.handshake_status().peer_verified_address);
assert!(pipe.server.handshake_status().has_handshake_keys);
assert!(pipe.server.handshake_status().peer_verified_address);
testing::process_flight(&mut pipe.client, flight).unwrap();
testing::emit_flight(&mut pipe.client).unwrap();
assert!(pipe.client.handshake_status().has_handshake_keys);
assert!(!pipe.client.handshake_status().peer_verified_address);
assert!(pipe.server.handshake_status().has_handshake_keys);
assert!(pipe.server.handshake_status().peer_verified_address);
assert!(pipe.client.timeout().is_some());
}
#[rstest]
fn handshake_packet_type_corruption(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(len, 1200);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let flight = testing::emit_flight(&mut pipe.server).unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
let active_pid =
pipe.client.paths.get_active_path_id().expect("no active");
let (ty, len) = pipe
.client
.send_single(&mut buf, active_pid, false, time::Instant::now())
.unwrap();
assert_eq!(ty, Type::Initial);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let (ty, len) = pipe
.client
.send_single(&mut buf, active_pid, false, time::Instant::now())
.unwrap();
assert_eq!(ty, Type::Handshake);
buf[0] &= !(0x20);
let hdr = Header::from_slice(&mut buf[..len], 0).unwrap();
assert_eq!(hdr.ty, Type::Initial);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
}
#[rstest]
fn dgram_send_fails_invalidstate(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.client.dgram_send(b"hello, world"),
Err(Error::InvalidState)
);
}
#[rstest]
fn dgram_send_app_limited(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let send_buf = [0xcf; 1000];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 1000, 1000);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
for _ in 0..1000 {
assert_eq!(pipe.client.dgram_send(&send_buf), Ok(()));
}
assert_eq!(
!pipe
.client
.paths
.get_active()
.expect("no active")
.recovery
.app_limited(),
cc_algorithm_name != "bbr2_gcongestion"
);
assert_eq!(pipe.client.dgram_send_queue.byte_size(), 1_000_000);
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_ne!(pipe.client.dgram_send_queue.byte_size(), 0);
assert_ne!(pipe.client.dgram_send_queue.byte_size(), 1_000_000);
assert_eq!(
!pipe
.client
.paths
.get_active()
.expect("no active")
.recovery
.app_limited(),
cc_algorithm_name != "bbr2_gcongestion"
);
assert_eq!(pipe.server_recv(&mut buf[..len]), Ok(len));
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
assert_ne!(pipe.client.dgram_send_queue.byte_size(), 0);
assert_ne!(pipe.client.dgram_send_queue.byte_size(), 1_000_000);
assert_eq!(
!pipe
.client
.paths
.get_active()
.expect("no active")
.recovery
.app_limited(),
cc_algorithm_name != "bbr2_gcongestion"
);
}
#[rstest]
fn dgram_single_datagram(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 10, 10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hello, world"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
let result1 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result1, Ok(12));
let result2 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result2, Err(Error::Done));
}
#[rstest]
fn dgram_multiple_datagrams(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 2, 3);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.dgram_send_queue_len(), 0);
assert_eq!(pipe.client.dgram_send_queue_byte_size(), 0);
assert_eq!(pipe.client.dgram_send(b"hello, world"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"ciao, mondo"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hola, mundo"), Ok(()));
assert!(pipe.client.is_dgram_send_queue_full());
assert_eq!(pipe.client.dgram_send_queue_byte_size(), 34);
pipe.client
.dgram_purge_outgoing(|d: &[u8]| -> bool { d[0] == b'c' });
assert_eq!(pipe.client.dgram_send_queue_len(), 2);
assert_eq!(pipe.client.dgram_send_queue_byte_size(), 23);
assert!(!pipe.client.is_dgram_send_queue_full());
assert_eq!(pipe.server.dgram_recv_queue_len(), 0);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.dgram_send_queue_len(), 0);
assert_eq!(pipe.client.dgram_send_queue_byte_size(), 0);
assert_eq!(pipe.server.dgram_recv_queue_len(), 2);
assert_eq!(pipe.server.dgram_recv_queue_byte_size(), 23);
assert!(pipe.server.is_dgram_recv_queue_full());
let result1 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result1, Ok(12));
assert_eq!(buf[0], b'h');
assert_eq!(buf[1], b'e');
assert!(!pipe.server.is_dgram_recv_queue_full());
let result2 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result2, Ok(11));
assert_eq!(buf[0], b'h');
assert_eq!(buf[1], b'o');
let result3 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result3, Err(Error::Done));
assert_eq!(pipe.server.dgram_recv_queue_len(), 0);
assert_eq!(pipe.server.dgram_recv_queue_byte_size(), 0);
}
#[rstest]
fn dgram_send_queue_overflow(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 10, 2);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hello, world"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"ciao, mondo"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hola, mundo"), Err(Error::Done));
assert_eq!(pipe.advance(), Ok(()));
let result1 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result1, Ok(12));
assert_eq!(buf[0], b'h');
assert_eq!(buf[1], b'e');
let result2 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result2, Ok(11));
assert_eq!(buf[0], b'c');
assert_eq!(buf[1], b'i');
let result3 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result3, Err(Error::Done));
}
#[rstest]
fn dgram_recv_queue_overflow(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 2, 10);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hello, world"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"ciao, mondo"), Ok(()));
assert_eq!(pipe.client.dgram_send(b"hola, mundo"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
let result1 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result1, Ok(11));
assert_eq!(buf[0], b'c');
assert_eq!(buf[1], b'i');
let result2 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result2, Ok(11));
assert_eq!(buf[0], b'h');
assert_eq!(buf[1], b'o');
let result3 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result3, Err(Error::Done));
}
#[rstest]
fn dgram_send_max_size(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; MAX_DGRAM_FRAME_SIZE as usize];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 10, 10);
config.set_max_recv_udp_payload_size(1452);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.client.dgram_max_writable_len(), None);
assert_eq!(pipe.handshake(), Ok(()));
let max_dgram_size = pipe.client.dgram_max_writable_len().unwrap();
assert_eq!(max_dgram_size, 1160);
let dgram_packet: Vec<u8> = vec![42; max_dgram_size];
assert_eq!(pipe.client.dgram_send(&dgram_packet), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
let result1 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result1, Ok(max_dgram_size));
let result2 = pipe.server.dgram_recv(&mut buf);
assert_eq!(result2, Err(Error::Done));
}
#[rstest]
fn is_readable(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.enable_dgram(true, 10, 10);
config.set_max_recv_udp_payload_size(1452);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert!(!pipe.client.is_readable());
assert!(!pipe.server.is_readable());
assert_eq!(pipe.client.stream_send(4, b"aaaaa", false), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.client.is_readable());
assert!(pipe.server.is_readable());
assert_eq!(
pipe.server.stream_send(4, b"aaaaaaaaaaaaaaa", false),
Ok(15)
);
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe.client.is_readable());
assert!(pipe.server.is_readable());
let mut b = [0; 15];
pipe.client.stream_recv(4, &mut b).unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.client.is_readable());
assert!(pipe.server.is_readable());
assert_eq!(pipe.server.stream_shutdown(4, Shutdown::Read, 0), Ok(()));
assert!(!pipe.server.is_readable());
assert_eq!(pipe.client.dgram_send(b"dddddddddddddd"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert!(!pipe.client.is_readable());
assert!(pipe.server.is_readable());
assert_eq!(pipe.server.dgram_send(b"dddddddddddddd"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe.client.is_readable());
assert!(pipe.server.is_readable());
let r = pipe.server.dgram_recv(&mut buf);
assert_eq!(r, Ok(14));
assert!(!pipe.server.is_readable());
let r = pipe.client.dgram_recv(&mut buf);
assert_eq!(r, Ok(14));
assert!(!pipe.client.is_readable());
}
#[rstest]
fn close(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.close(false, 0x1234, b"hello?"), Ok(()));
assert_eq!(
pipe.client.close(false, 0x4321, b"hello?"),
Err(Error::Done)
);
let (len, _) = pipe.client.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::ConnectionClose {
error_code: 0x1234,
frame_type: 0,
reason: b"hello?".to_vec(),
})
);
}
#[rstest]
fn app_close_by_client(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.close(true, 0x1234, b"hello!"), Ok(()));
assert_eq!(pipe.client.close(true, 0x4321, b"hello!"), Err(Error::Done));
let (len, _) = pipe.client.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.server, &mut buf[..len]).unwrap();
assert_eq!(
frames.first(),
Some(&frame::Frame::ApplicationClose {
error_code: 0x1234,
reason: b"hello!".to_vec(),
})
);
}
#[cfg(not(feature = "openssl"))]
#[rstest]
fn app_close_by_server_during_handshake_private_key_failure(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
pipe.server.handshake.set_failing_private_key_method();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
assert_eq!(
testing::process_flight(&mut pipe.server, flight),
Err(Error::TlsFail)
);
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.server.is_established());
assert!(!pipe.client.is_established());
assert_eq!(
pipe.server.close(true, 123, b"fail whale"),
Err(Error::Done)
);
testing::process_flight(&mut pipe.client, flight).unwrap();
assert_eq!(
pipe.client.close(true, 123, b"fail whale"),
Err(Error::Done)
);
assert!(!pipe.server.is_established());
assert!(!pipe.client.is_established());
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.server.local_error(),
Some(&ConnectionError {
is_app: false,
error_code: 0x01,
reason: vec![],
})
);
assert_eq!(
pipe.client.peer_error(),
Some(&ConnectionError {
is_app: false,
error_code: 0x01,
reason: vec![],
})
);
}
#[rstest]
fn app_close_by_server_during_handshake_not_established(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.client.is_established() && !pipe.server.is_established());
pipe.server.close(true, 123, b"fail whale").unwrap();
testing::process_flight(&mut pipe.client, flight).unwrap();
assert!(pipe.client.is_established());
pipe.client.stream_send(0, b"badauthtoken", true).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
assert!(!pipe.server.is_established());
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.server.local_error(),
Some(&ConnectionError {
is_app: false,
error_code: 0x0c,
reason: vec![],
})
);
assert_eq!(
pipe.client.peer_error(),
Some(&ConnectionError {
is_app: false,
error_code: 0x0c,
reason: vec![],
})
);
}
#[rstest]
fn app_close_by_server_during_handshake_established(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.client.is_established() && !pipe.server.is_established());
testing::process_flight(&mut pipe.client, flight).unwrap();
assert!(pipe.client.is_established());
pipe.client.stream_send(0, b"badauthtoken", true).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
assert!(pipe.server.is_established());
pipe.server
.close(true, 123, b"Invalid authentication")
.unwrap();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.server.local_error(),
Some(&ConnectionError {
is_app: true,
error_code: 123,
reason: b"Invalid authentication".to_vec()
})
);
assert_eq!(
pipe.client.peer_error(),
Some(&ConnectionError {
is_app: true,
error_code: 123,
reason: b"Invalid authentication".to_vec()
})
);
}
#[rstest]
fn transport_close_by_client_during_handshake_established(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
let flight = testing::emit_flight(&mut pipe.server).unwrap();
assert!(!pipe.client.is_established() && !pipe.server.is_established());
testing::process_flight(&mut pipe.client, flight).unwrap();
assert!(pipe.client.is_established());
pipe.client.close(false, 123, b"connection close").unwrap();
let flight = testing::emit_flight(&mut pipe.client).unwrap();
testing::process_flight(&mut pipe.server, flight).unwrap();
assert_eq!(
pipe.server.peer_error(),
Some(&ConnectionError {
is_app: false,
error_code: 123,
reason: b"connection close".to_vec()
})
);
assert_eq!(
pipe.client.local_error(),
Some(&ConnectionError {
is_app: false,
error_code: 123,
reason: b"connection close".to_vec()
})
);
}
#[rstest]
fn peer_error(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server.close(false, 0x1234, b"hello?"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.peer_error(),
Some(&ConnectionError {
is_app: false,
error_code: 0x1234u64,
reason: b"hello?".to_vec()
})
);
}
#[rstest]
fn app_peer_error(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server.close(true, 0x1234, b"hello!"), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.peer_error(),
Some(&ConnectionError {
is_app: true,
error_code: 0x1234u64,
reason: b"hello!".to_vec()
})
);
}
#[rstest]
fn local_error(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server.local_error(), None);
assert_eq!(pipe.server.close(true, 0x1234, b"hello!"), Ok(()));
assert_eq!(
pipe.server.local_error(),
Some(&ConnectionError {
is_app: true,
error_code: 0x1234u64,
reason: b"hello!".to_vec()
})
);
}
#[rstest]
fn update_max_datagram_size(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut client_scid = [0; 16];
rand::rand_bytes(&mut client_scid[..]);
let client_scid = ConnectionId::from_ref(&client_scid);
let client_addr = "127.0.0.1:1234".parse().unwrap();
let mut server_scid = [0; 16];
rand::rand_bytes(&mut server_scid[..]);
let server_scid = ConnectionId::from_ref(&server_scid);
let server_addr = "127.0.0.1:4321".parse().unwrap();
let mut client_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(
client_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
client_config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
client_config.set_max_recv_udp_payload_size(1200);
let mut server_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(
server_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
server_config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
server_config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
server_config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
server_config.verify_peer(false);
server_config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
server_config.set_max_send_udp_payload_size(1500);
let mut pipe = testing::Pipe {
client: connect(
Some("quic.tech"),
&client_scid,
client_addr,
server_addr,
&mut client_config,
)
.unwrap(),
server: accept(
&server_scid,
None,
server_addr,
client_addr,
&mut server_config,
)
.unwrap(),
};
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.recovery
.max_datagram_size(),
1500,
);
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.recovery
.max_datagram_size(),
1200,
);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.recovery
.cwnd(),
if cc_algorithm_name == "cubic" {
12000
} else {
if cfg!(feature = "openssl") {
13437
} else {
13421
}
},
);
}
#[rstest]
fn send_capacity(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(100000);
config.set_initial_max_stream_data_bidi_local(10000);
config.set_initial_max_stream_data_bidi_remote(10000);
config.set_initial_max_streams_bidi(10);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(0, b"hello!", true), Ok(6));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"hello!", true), Ok(6));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(8, b"hello!", true), Ok(6));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.stream_send(12, b"hello!", true), Ok(6));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable().collect::<Vec<u64>>();
assert_eq!(r.len(), 4);
r.sort();
assert_eq!(r, [0, 4, 8, 12]);
assert_eq!(pipe.server.stream_recv(0, &mut buf), Ok((6, true)));
assert_eq!(pipe.server.stream_recv(4, &mut buf), Ok((6, true)));
assert_eq!(pipe.server.stream_recv(8, &mut buf), Ok((6, true)));
assert_eq!(pipe.server.stream_recv(12, &mut buf), Ok((6, true)));
assert_eq!(
pipe.server.tx_cap,
if cc_algorithm_name == "cubic" {
12000
} else {
if cfg!(feature = "openssl") {
13959
} else {
13873
}
}
);
assert_eq!(pipe.server.stream_send(0, &buf[..5000], false), Ok(5000));
assert_eq!(pipe.server.stream_send(4, &buf[..5000], false), Ok(5000));
assert_eq!(
pipe.server.stream_send(8, &buf[..5000], false),
if cc_algorithm_name == "cubic" {
Ok(2000)
} else {
if cfg!(feature = "openssl") {
Ok(3959)
} else {
Ok(3873)
}
}
);
assert_eq!(
pipe.server.stream_send(12, &buf[..5000], false),
Err(Error::Done)
);
assert_eq!(pipe.server.tx_cap, 0);
assert_eq!(pipe.advance(), Ok(()));
}
#[cfg(feature = "boringssl-boring-crate")]
#[rstest]
fn user_provided_boring_ctx(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) -> Result<()> {
let mut server_tls_ctx_builder =
boring::ssl::SslContextBuilder::new(boring::ssl::SslMethod::tls())
.unwrap();
server_tls_ctx_builder
.set_certificate_chain_file("examples/cert.crt")
.unwrap();
server_tls_ctx_builder
.set_private_key_file(
"examples/cert.key",
boring::ssl::SslFiletype::PEM,
)
.unwrap();
let mut server_config = Config::with_boring_ssl_ctx_builder(
crate::PROTOCOL_VERSION,
server_tls_ctx_builder,
)?;
let mut client_config = Config::new(crate::PROTOCOL_VERSION)?;
assert_eq!(
client_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
client_config.load_cert_chain_from_pem_file("examples/cert.crt")?;
client_config.load_priv_key_from_pem_file("examples/cert.key")?;
for config in [&mut client_config, &mut server_config] {
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
}
let mut pipe = testing::Pipe::with_client_and_server_config(
&mut client_config,
&mut server_config,
)?;
assert_eq!(pipe.handshake(), Ok(()));
Ok(())
}
#[cfg(feature = "boringssl-boring-crate")]
#[rstest]
fn in_handshake_config(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) -> Result<()> {
let mut buf = [0; 65535];
const CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS: usize = 30;
const CUSTOM_INITIAL_MAX_STREAMS_BIDI: u64 = 30;
const CUSTOM_MAX_IDLE_TIMEOUT: Duration = Duration::from_secs(3);
let mut server_tls_ctx_builder =
boring::ssl::SslContextBuilder::new(boring::ssl::SslMethod::tls())
.unwrap();
server_tls_ctx_builder
.set_certificate_chain_file("examples/cert.crt")
.unwrap();
server_tls_ctx_builder
.set_private_key_file(
"examples/cert.key",
boring::ssl::SslFiletype::PEM,
)
.unwrap();
server_tls_ctx_builder.set_select_certificate_callback(|mut hello| {
<Connection>::set_initial_congestion_window_packets_in_handshake(
hello.ssl_mut(),
CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS,
)
.unwrap();
<Connection>::set_max_idle_timeout_in_handshake(
hello.ssl_mut(),
CUSTOM_MAX_IDLE_TIMEOUT.as_millis() as u64,
)
.unwrap();
<Connection>::set_initial_max_streams_bidi_in_handshake(
hello.ssl_mut(),
CUSTOM_INITIAL_MAX_STREAMS_BIDI,
)
.unwrap();
Ok(())
});
let mut server_config = Config::with_boring_ssl_ctx_builder(
crate::PROTOCOL_VERSION,
server_tls_ctx_builder,
)?;
assert_eq!(
server_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
let mut client_config = Config::new(crate::PROTOCOL_VERSION)?;
client_config.load_cert_chain_from_pem_file("examples/cert.crt")?;
client_config.load_priv_key_from_pem_file("examples/cert.key")?;
for config in [&mut client_config, &mut server_config] {
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(1000000);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
}
let mut pipe = testing::Pipe::with_client_and_server_config(
&mut client_config,
&mut server_config,
)?;
let (len, _) = pipe.client.send(&mut buf).unwrap();
assert_eq!(pipe.server.tx_cap, 0);
pipe.server_recv(&mut buf[..len]).unwrap();
assert_eq!(
pipe.server.tx_cap,
CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS * 1200
);
assert_eq!(pipe.server.idle_timeout(), Some(CUSTOM_MAX_IDLE_TIMEOUT));
let (len, _) = pipe.server.send(&mut buf).unwrap();
pipe.client_recv(&mut buf[..len]).unwrap();
assert_eq!(pipe.client.idle_timeout(), Some(CUSTOM_MAX_IDLE_TIMEOUT));
assert_eq!(
pipe.client.peer_streams_left_bidi(),
CUSTOM_INITIAL_MAX_STREAMS_BIDI
);
assert_eq!(pipe.handshake(), Ok(()));
Ok(())
}
#[rstest]
fn initial_cwnd(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) -> Result<()> {
const CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS: usize = 30;
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config.set_initial_congestion_window_packets(
CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS,
);
config.load_cert_chain_from_pem_file("examples/cert.crt")?;
config.load_priv_key_from_pem_file("examples/cert.key")?;
config.set_application_protos(&[b"proto1", b"proto2"])?;
config.set_initial_max_data(1000000);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
if cc_algorithm_name == "cubic" {
assert_eq!(
pipe.server.tx_cap,
CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS * 1200
);
} else {
let expected = CUSTOM_INITIAL_CONGESTION_WINDOW_PACKETS * 1200 +
if cfg!(feature = "openssl") {
1463
} else {
1447
};
assert!(
pipe.server.tx_cap >= expected,
"{} vs {}",
pipe.server.tx_cap,
expected
);
assert!(
pipe.server.tx_cap <= expected + 1,
"{} vs {}",
pipe.server.tx_cap,
expected + 1
);
}
Ok(())
}
#[rstest]
fn last_tx_data_larger_than_tx_data(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(12000);
config.set_initial_max_stream_data_bidi_local(20000);
config.set_initial_max_stream_data_bidi_remote(20000);
config.set_max_recv_udp_payload_size(1200);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_client_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.stream_send(4, b"a", true), Ok(1));
assert_eq!(pipe.client.stream_send(8, b"b", true), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let mut b = [0; 15];
pipe.server.stream_recv(4, &mut b).unwrap();
let buf = [0; 10000];
assert_eq!(pipe.server.stream_send(4, &buf, false), Ok(10000));
testing::emit_flight(&mut pipe.server).unwrap();
let mut buf = [0; 1200];
assert_eq!(pipe.server.stream_send(4, &buf, false), Ok(1200));
assert_eq!(pipe.server.stream_send(8, &buf, false), Ok(800));
assert_eq!(pipe.server.stream_send(4, &buf, false), Err(Error::Done));
let timer = pipe.server.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.server.on_timeout();
let (len, _) = pipe.server.send(&mut buf).unwrap();
assert_eq!(len, 1200);
let frames = [frame::Frame::StopSending {
stream_id: 4,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
pipe.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
}
#[rstest]
fn send_connection_ids(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(3);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 2);
let (scid, reset_token) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid, reset_token, false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 1);
let (scid, reset_token) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid, reset_token, false), Ok(2));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 2);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 0);
let (scid, reset_token) = testing::create_cid_and_reset_token(16);
assert_eq!(
pipe.client.new_scid(&scid, reset_token, false),
Err(Error::IdLimit),
);
}
#[rstest]
fn connection_id_zero(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut frames = Vec::new();
let (scid, reset_token) = testing::create_cid_and_reset_token(0);
frames.push(frame::Frame::NewConnectionId {
seq_num: 1,
retire_prior_to: 0,
conn_id: scid.to_vec(),
reset_token: reset_token.to_be_bytes(),
});
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let active_path = pipe.server.paths.get_active().unwrap();
let info = RecvInfo {
to: active_path.local_addr(),
from: active_path.peer_addr(),
};
assert_eq!(
pipe.server.recv(&mut buf[..written], info),
Err(Error::InvalidFrame)
);
let written = match pipe.server.send(&mut buf) {
Ok((write, _)) => write,
Err(_) => unreachable!(),
};
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..written]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::ConnectionClose {
error_code: 0x7,
frame_type: 0,
reason: Vec::new(),
})
);
}
#[rstest]
fn connection_id_invalid_max_len(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut frames = Vec::new();
let (scid, reset_token) =
testing::create_cid_and_reset_token(MAX_CONN_ID_LEN + 1);
frames.push(frame::Frame::NewConnectionId {
seq_num: 1,
retire_prior_to: 0,
conn_id: scid.to_vec(),
reset_token: reset_token.to_be_bytes(),
});
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let active_path = pipe.server.paths.get_active().unwrap();
let info = RecvInfo {
to: active_path.local_addr(),
from: active_path.peer_addr(),
};
assert_eq!(
pipe.server.recv(&mut buf[..written], info),
Err(Error::InvalidFrame)
);
let written = match pipe.server.send(&mut buf) {
Ok((write, _)) => write,
Err(_) => unreachable!(),
};
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..written]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::ConnectionClose {
error_code: 0x7,
frame_type: 0,
reason: Vec::new(),
})
);
}
#[rstest]
fn connection_id_handling(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 1);
let scid = pipe.client.source_id().into_owned();
let (scid_1, reset_token_1) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 0);
let (scid_2, reset_token_2) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid_2, reset_token_2, true), Ok(2));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.retired_scid_next(), Some(scid));
assert_eq!(pipe.client.retired_scid_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 0);
assert_eq!(pipe.server.destination_id(), scid_1);
assert_eq!(pipe.server.retire_dcid(0), Err(Error::InvalidState));
assert_eq!(pipe.server.retire_dcid(3), Err(Error::InvalidState));
assert_eq!(pipe.server.retire_dcid(1), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.retired_scid_next(), Some(scid_1));
assert_eq!(pipe.client.retired_scid_next(), None);
assert_eq!(pipe.server.destination_id(), scid_2);
assert_eq!(pipe.server.available_dcids(), 0);
assert_eq!(pipe.server.retire_dcid(2), Err(Error::OutOfIdentifiers));
}
#[rstest]
fn lost_connection_id_frames(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let scid = pipe.client.source_id().into_owned();
let (scid_1, reset_token_1) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(1));
testing::emit_flight(&mut pipe.client).unwrap();
let timer = pipe.client.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.retire_dcid(0), Ok(()));
testing::emit_flight(&mut pipe.server).unwrap();
let timer = pipe.server.timeout().unwrap();
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.server.on_timeout();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.retired_scid_next(), Some(scid));
assert_eq!(pipe.client.retired_scid_next(), None);
}
#[rstest]
fn sending_duplicate_scids(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(3);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let (scid_1, reset_token_1) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
let reset_token_2 = reset_token_1.wrapping_add(1);
assert_eq!(
pipe.client.new_scid(&scid_1, reset_token_2, false),
Err(Error::InvalidState),
);
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(1));
assert!(!pipe.client.ids.has_new_scids());
assert_eq!(pipe.server.retire_dcid(1), Ok(()));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(2));
}
#[rstest]
fn connection_id_retire_limit(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 1);
let (scid_1, reset_token_1) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&scid_1, reset_token_1, false), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.scids_left(), 0);
let mut frames = Vec::new();
for i in 2..=7 {
let (scid, reset_token) = testing::create_cid_and_reset_token(16);
frames.push(frame::Frame::NewConnectionId {
seq_num: i,
retire_prior_to: i,
conn_id: scid.to_vec(),
reset_token: reset_token.to_be_bytes(),
});
}
let pkt_type = packet::Type::Short;
let written =
testing::encode_pkt(&mut pipe.client, pkt_type, &frames, &mut buf)
.unwrap();
let active_path = pipe.server.paths.get_active().unwrap();
let info = RecvInfo {
to: active_path.local_addr(),
from: active_path.peer_addr(),
};
assert_eq!(
pipe.server.recv(&mut buf[..written], info),
Err(Error::IdLimit)
);
let written = match pipe.server.send(&mut buf) {
Ok((write, _)) => write,
Err(_) => unreachable!(),
};
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..written]).unwrap();
let mut iter = frames.iter();
assert_eq!(
iter.next(),
Some(&frame::Frame::ConnectionClose {
error_code: 0x9,
frame_type: 0,
reason: Vec::new(),
})
);
}
fn pipe_with_exchanged_cids(
config: &mut Config, client_scid_len: usize, server_scid_len: usize,
additional_cids: usize,
) -> testing::Pipe {
let mut pipe = testing::Pipe::with_config_and_scid_lengths(
config,
client_scid_len,
server_scid_len,
)
.unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut c_cids = Vec::new();
let mut c_reset_tokens = Vec::new();
let mut s_cids = Vec::new();
let mut s_reset_tokens = Vec::new();
for i in 0..additional_cids {
if client_scid_len > 0 {
let (c_cid, c_reset_token) =
testing::create_cid_and_reset_token(client_scid_len);
c_cids.push(c_cid);
c_reset_tokens.push(c_reset_token);
assert_eq!(
pipe.client.new_scid(&c_cids[i], c_reset_tokens[i], true),
Ok(i as u64 + 1)
);
}
if server_scid_len > 0 {
let (s_cid, s_reset_token) =
testing::create_cid_and_reset_token(server_scid_len);
s_cids.push(s_cid);
s_reset_tokens.push(s_reset_token);
assert_eq!(
pipe.server.new_scid(&s_cids[i], s_reset_tokens[i], true),
Ok(i as u64 + 1)
);
}
}
assert_eq!(pipe.advance(), Ok(()));
if client_scid_len > 0 {
assert_eq!(pipe.server.available_dcids(), additional_cids);
}
if server_scid_len > 0 {
assert_eq!(pipe.client.available_dcids(), additional_cids);
}
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.path_event_next(), None);
pipe
}
#[rstest]
fn path_validation(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(
pipe.client.probe_path(client_addr_2, server_addr),
Err(Error::OutOfIdentifiers)
);
let (c_cid, c_reset_token) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.client.new_scid(&c_cid, c_reset_token, true), Ok(1));
let (s_cid, s_reset_token) = testing::create_cid_and_reset_token(16);
assert_eq!(pipe.server.new_scid(&s_cid, s_reset_token, true), Ok(1));
assert_eq!(
pipe.client.probe_path(client_addr_2, server_addr),
Err(Error::OutOfIdentifiers)
);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.server.available_dcids(), 1);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.available_dcids(), 1);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
assert_eq!(
pipe.server.probe_path(server_addr, client_addr_2),
Err(Error::InvalidState),
);
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr)),
);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2)),
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2)),
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.server.probe_path(server_addr, client_addr_2), Ok(1));
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.server.path_event_next(), None);
}
#[rstest]
fn losing_probing_packets(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
testing::emit_flight(&mut pipe.client).unwrap();
let probed_pid = pipe
.client
.paths
.path_id_from_addrs(&(client_addr_2, server_addr))
.unwrap();
let probe_instant = pipe
.client
.paths
.get(probed_pid)
.unwrap()
.recovery
.loss_detection_timer()
.unwrap();
let timer = probe_instant.duration_since(time::Instant::now());
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr))
);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2))
);
assert_eq!(pipe.server.path_event_next(), None);
}
#[rstest]
fn failed_path_validation(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
for _ in 0..MAX_PROBING_TIMEOUTS {
testing::emit_flight(&mut pipe.client).unwrap();
let probed_pid = pipe
.client
.paths
.path_id_from_addrs(&(client_addr_2, server_addr))
.unwrap();
let probe_instant = pipe
.client
.paths
.get(probed_pid)
.unwrap()
.recovery
.loss_detection_timer()
.unwrap();
let timer = probe_instant.duration_since(time::Instant::now());
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.client.on_timeout();
}
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::FailedValidation(client_addr_2, server_addr)),
);
}
#[rstest]
fn client_discard_unknown_address(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_initial_max_data(30);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_uni(3);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server.stream_send(3, b"a", true), Ok(1));
let mut flight =
testing::emit_flight(&mut pipe.server).expect("no packet");
flight
.iter_mut()
.for_each(|(_, si)| si.from = "127.0.0.1:9292".parse().unwrap());
assert_eq!(testing::process_flight(&mut pipe.client, flight), Ok(()));
assert_eq!(pipe.client.paths.len(), 1);
}
#[rstest]
fn path_validation_limited_mtu(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
testing::process_flight(
&mut pipe.server,
testing::emit_flight_with_max_buffer(
&mut pipe.client,
1199,
None,
None,
)
.expect("no packet"),
)
.expect("error when processing client packets");
testing::process_flight(
&mut pipe.client,
testing::emit_flight(&mut pipe.server).expect("no packet"),
)
.expect("error when processing client packets");
let probed_pid = pipe
.client
.paths
.path_id_from_addrs(&(client_addr_2, server_addr))
.unwrap();
assert!(!pipe.client.paths.get(probed_pid).unwrap().validated(),);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(pipe.advance(), Ok(()));
assert!(pipe.client.paths.get(probed_pid).unwrap().validated());
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr))
);
}
#[rstest]
fn path_probing_dos(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr))
);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2))
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.server.paths.len(), 2);
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
let client_addr_3 = "127.0.0.1:9012".parse().unwrap();
let mut flight =
testing::emit_flight(&mut pipe.client).expect("no generated packet");
flight
.iter_mut()
.for_each(|(_, si)| si.from = client_addr_3);
testing::process_flight(&mut pipe.server, flight)
.expect("failed to process");
assert_eq!(pipe.server.paths.len(), 2);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::ReusedSourceConnectionId(
1,
(server_addr, client_addr_2),
(server_addr, client_addr_3)
))
);
assert_eq!(pipe.server.path_event_next(), None);
}
#[rstest]
fn retiring_active_path_dcid(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.client.retire_dcid(0), Err(Error::OutOfIdentifiers));
}
#[rstest]
fn send_on_path_test(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_initial_max_data(100000);
config.set_initial_max_stream_data_bidi_local(100000);
config.set_initial_max_stream_data_bidi_remote(100000);
config.set_initial_max_streams_bidi(2);
config.set_active_connection_id_limit(4);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 3);
let server_addr = testing::Pipe::server_addr();
let client_addr = testing::Pipe::client_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
let mut buf = [0; 65535];
assert_eq!(
pipe.client.send_on_path(
&mut buf,
Some(client_addr),
Some(server_addr)
),
Err(Error::Done)
);
let (sent, si) = pipe
.client
.send_on_path(&mut buf, Some(client_addr_2), Some(server_addr))
.expect("No error");
assert_eq!(sent, MIN_CLIENT_INITIAL_LEN);
assert_eq!(si.from, client_addr_2);
assert_eq!(si.to, server_addr);
let ri = RecvInfo {
to: si.to,
from: si.from,
};
assert_eq!(pipe.server.recv(&mut buf[..sent], ri), Ok(sent));
let stats = pipe.server.stats();
assert_eq!(stats.path_challenge_rx_count, 1);
let client_addr_3 = "127.0.0.1:9012".parse().unwrap();
let server_addr_2 = "127.0.0.1:9876".parse().unwrap();
assert_eq!(
pipe.client.send_on_path(
&mut buf,
Some(client_addr_3),
Some(server_addr)
),
Err(Error::InvalidState)
);
assert_eq!(
pipe.client.send_on_path(
&mut buf,
Some(client_addr),
Some(server_addr_2)
),
Err(Error::InvalidState)
);
assert_eq!(pipe.client.probe_path(client_addr, server_addr_2), Ok(2));
assert_eq!(pipe.client.probe_path(client_addr_3, server_addr), Ok(3));
assert_eq!(pipe.client.stream_send(0, &buf[..1201], true), Ok(1201));
let (sent, si) = pipe
.client
.send_on_path(&mut buf, Some(client_addr), None)
.expect("No error");
assert_eq!(sent, MIN_CLIENT_INITIAL_LEN);
assert_eq!(si.from, client_addr);
assert_eq!(si.to, server_addr_2);
let ri = RecvInfo {
to: si.to,
from: si.from,
};
assert_eq!(pipe.server.recv(&mut buf[..sent], ri), Ok(sent));
let stats = pipe.server.stats();
assert_eq!(stats.path_challenge_rx_count, 2);
let (sent, si) = pipe
.client
.send_on_path(&mut buf, Some(client_addr), None)
.expect("No error");
assert_eq!(si.from, client_addr);
assert_eq!(si.to, server_addr);
let ri = RecvInfo {
to: si.to,
from: si.from,
};
assert_eq!(pipe.server.recv(&mut buf[..sent], ri), Ok(sent));
let stats = pipe.server.stats();
assert_eq!(stats.path_challenge_rx_count, 2);
let (sent, si) = pipe
.client
.send_on_path(&mut buf, None, Some(server_addr))
.expect("No error");
assert_eq!(sent, MIN_CLIENT_INITIAL_LEN);
assert_eq!(si.from, client_addr_3);
assert_eq!(si.to, server_addr);
let ri = RecvInfo {
to: si.to,
from: si.from,
};
assert_eq!(pipe.server.recv(&mut buf[..sent], ri), Ok(sent));
let stats = pipe.server.stats();
assert_eq!(stats.path_challenge_rx_count, 3);
let (sent, si) = pipe
.client
.send_on_path(&mut buf, None, Some(server_addr))
.expect("No error");
assert_eq!(si.from, client_addr);
assert_eq!(si.to, server_addr);
let ri = RecvInfo {
to: si.to,
from: si.from,
};
assert_eq!(pipe.server.recv(&mut buf[..sent], ri), Ok(sent));
assert_eq!(
pipe.client.send_on_path(&mut buf, Some(client_addr), None),
Err(Error::Done)
);
assert_eq!(
pipe.client.send_on_path(&mut buf, None, Some(server_addr)),
Err(Error::Done)
);
assert_eq!(pipe.advance(), Ok(()));
let mut v1 = pipe.client.paths_iter(client_addr).collect::<Vec<_>>();
let mut v2 = vec![server_addr, server_addr_2];
v1.sort();
v2.sort();
assert_eq!(v1, v2);
let mut v1 = pipe.client.paths_iter(client_addr_2).collect::<Vec<_>>();
let mut v2 = vec![server_addr];
v1.sort();
v2.sort();
assert_eq!(v1, v2);
let mut v1 = pipe.client.paths_iter(client_addr_3).collect::<Vec<_>>();
let mut v2 = vec![server_addr];
v1.sort();
v2.sort();
assert_eq!(v1, v2);
let stats = pipe.server.stats();
assert_eq!(stats.path_challenge_rx_count, 3);
}
#[rstest]
fn connection_migration(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(3);
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 2);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
let client_addr_3 = "127.0.0.1:9012".parse().unwrap();
let client_addr_4 = "127.0.0.1:8908".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr))
);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2))
);
assert_eq!(
pipe.client.is_path_validated(client_addr_2, server_addr),
Ok(true)
);
assert_eq!(
pipe.server.is_path_validated(server_addr, client_addr_2),
Ok(true)
);
assert_eq!(
pipe.server.migrate(server_addr, client_addr_2),
Err(Error::InvalidState)
);
assert_eq!(pipe.client.migrate(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.client.stream_send(0, b"data", true), Ok(4));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.local_addr(),
client_addr_2
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.peer_addr(),
server_addr
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::PeerMigrated(server_addr, client_addr_2))
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.local_addr(),
server_addr
);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.peer_addr(),
client_addr_2
);
assert_eq!(pipe.client.migrate(client_addr_3, server_addr), Ok(2));
assert_eq!(pipe.client.stream_send(4, b"data", true), Ok(4));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.local_addr(),
client_addr_3
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.peer_addr(),
server_addr
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_3))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_3))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::PeerMigrated(server_addr, client_addr_3))
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.local_addr(),
server_addr
);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.peer_addr(),
client_addr_3
);
assert_eq!(pipe.client.migrate(client_addr_3, server_addr), Ok(2));
assert_eq!(pipe.client.stream_send(8, b"data", true), Ok(4));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.local_addr(),
client_addr_3
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.peer_addr(),
server_addr
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.local_addr(),
server_addr
);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.peer_addr(),
client_addr_3
);
assert_eq!(
pipe.client.migrate(client_addr_4, server_addr),
Err(Error::OutOfIdentifiers)
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.local_addr(),
client_addr_3
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.peer_addr(),
server_addr
);
}
#[rstest]
fn connection_migration_zero_length_cid(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
let mut pipe = pipe_with_exchanged_cids(&mut config, 0, 16, 1);
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.migrate(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.client.stream_send(4, b"data", true), Ok(4));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.local_addr(),
client_addr_2
);
assert_eq!(
pipe.client
.paths
.get_active()
.expect("no active")
.peer_addr(),
server_addr
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::PeerMigrated(server_addr, client_addr_2))
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.local_addr(),
server_addr
);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.peer_addr(),
client_addr_2
);
}
#[rstest]
fn connection_migration_reordered_non_probing(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(2);
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let client_addr = testing::Pipe::client_addr();
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
assert_eq!(pipe.client.probe_path(client_addr_2, server_addr), Ok(1));
assert_eq!(pipe.advance(), Ok(()));
assert_eq!(
pipe.client.path_event_next(),
Some(PathEvent::Validated(client_addr_2, server_addr))
);
assert_eq!(pipe.client.path_event_next(), None);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, client_addr_2))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::Validated(server_addr, client_addr_2))
);
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(pipe.client.stream_send(0, b"data", true), Ok(4));
let mut first = testing::emit_flight(&mut pipe.client).unwrap();
first.iter_mut().for_each(|(_, si)| si.from = client_addr_2);
assert_eq!(pipe.client.stream_send(4, b"data", true), Ok(4));
let second = testing::emit_flight(&mut pipe.client).unwrap();
assert_eq!(testing::process_flight(&mut pipe.server, second), Ok(()));
assert_eq!(testing::process_flight(&mut pipe.server, first), Ok(()));
assert_eq!(pipe.server.path_event_next(), None);
assert_eq!(
pipe.server
.paths
.get_active()
.expect("no active")
.peer_addr(),
client_addr
);
}
#[rstest]
fn resilience_against_migration_attack(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(3);
config.set_initial_max_data(100000);
config.set_initial_max_stream_data_bidi_local(100000);
config.set_initial_max_stream_data_bidi_remote(100000);
config.set_initial_max_streams_bidi(2);
let mut pipe = pipe_with_exchanged_cids(&mut config, 16, 16, 1);
let client_addr = testing::Pipe::client_addr();
let server_addr = testing::Pipe::server_addr();
let spoofed_client_addr = "127.0.0.1:6666".parse().unwrap();
const DATA_BYTES: usize = 24000;
let buf = [42; DATA_BYTES];
let mut recv_buf = [0; DATA_BYTES];
let send1_bytes = pipe.server.stream_send(1, &buf, true).unwrap();
assert_eq!(send1_bytes, match cc_algorithm_name {
#[cfg(feature = "openssl")]
"bbr2" => 14041,
#[cfg(not(feature = "openssl"))]
"bbr2" => 13955,
#[cfg(feature = "openssl")]
"bbr2_gcongestion" => 13966,
#[cfg(not(feature = "openssl"))]
"bbr2_gcongestion" => 13880,
_ => 12000,
});
assert_eq!(
testing::process_flight(
&mut pipe.client,
testing::emit_flight(&mut pipe.server).unwrap()
),
Ok(())
);
let (rcv_data_1, _) = pipe.client.stream_recv(1, &mut recv_buf).unwrap();
let mut faked_addr_flight =
testing::emit_flight(&mut pipe.client).unwrap();
faked_addr_flight
.iter_mut()
.for_each(|(_, si)| si.from = spoofed_client_addr);
assert_eq!(
testing::process_flight(&mut pipe.server, faked_addr_flight),
Ok(())
);
assert_eq!(
pipe.server.stream_send(1, &buf[send1_bytes..], true),
Ok(24000 - send1_bytes)
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::ReusedSourceConnectionId(
0,
(server_addr, client_addr),
(server_addr, spoofed_client_addr)
))
);
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::New(server_addr, spoofed_client_addr))
);
assert_eq!(
pipe.server.is_path_validated(server_addr, client_addr),
Ok(true)
);
assert_eq!(
pipe.server
.is_path_validated(server_addr, spoofed_client_addr),
Ok(false)
);
testing::emit_flight(&mut pipe.server).unwrap();
let probed_pid = pipe
.server
.paths
.path_id_from_addrs(&(server_addr, spoofed_client_addr))
.unwrap();
let probe_instant = pipe
.server
.paths
.get(probed_pid)
.unwrap()
.recovery
.loss_detection_timer()
.unwrap();
let timer = probe_instant.duration_since(time::Instant::now());
std::thread::sleep(timer + time::Duration::from_millis(1));
pipe.server.on_timeout();
assert_eq!(
pipe.server.path_event_next(),
Some(PathEvent::FailedValidation(
server_addr,
spoofed_client_addr
))
);
assert_eq!(
pipe.server.is_path_validated(server_addr, client_addr),
Ok(true)
);
assert_eq!(
pipe.server
.is_path_validated(server_addr, spoofed_client_addr),
Ok(false)
);
let server_active_path = pipe.server.paths.get_active().unwrap();
assert_eq!(server_active_path.local_addr(), server_addr);
assert_eq!(server_active_path.peer_addr(), client_addr);
assert_eq!(pipe.advance(), Ok(()));
let (rcv_data_2, fin) =
pipe.client.stream_recv(1, &mut recv_buf).unwrap();
assert!(fin);
assert_eq!(rcv_data_1 + rcv_data_2, DATA_BYTES);
}
#[rstest]
fn consecutive_non_ack_eliciting(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut buf = [0; 65535];
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let frames = [frame::Frame::Ping { mtu_probe: None }];
let pkt_type = packet::Type::Short;
for _ in 0..24 {
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert!(len > 0);
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert!(
frames
.iter()
.all(|frame| matches!(frame, frame::Frame::ACK { .. })),
"ACK only"
);
}
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
assert!(len > 0);
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert!(
frames
.iter()
.any(|frame| matches!(frame, frame::Frame::Ping {
mtu_probe: None
})),
"found a PING"
);
}
#[rstest]
fn send_ack_eliciting_causes_ping(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
pipe.server.send_ack_eliciting().unwrap();
let mut buf = [0; 1500];
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
assert_eq!(iter.next(), Some(&frame::Frame::Ping { mtu_probe: None }));
}
#[rstest]
fn send_ack_eliciting_no_ping(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut pipe = testing::Pipe::new(cc_algorithm_name).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
pipe.server.send_ack_eliciting().unwrap();
assert_eq!(pipe.server.stream_send(1, b"a", false), Ok(1));
let mut buf = [0; 1500];
let (len, _) = pipe.server.send(&mut buf).unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
assert!(matches!(
iter.next(),
Some(&frame::Frame::Stream {
stream_id: 1,
data: _
})
));
assert!(iter.next().is_none());
}
#[rstest]
fn stop_sending_stream_send_after_reset_stream_ack(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut b = [0; 15];
let mut buf = [0; 65535];
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(999999999);
config.set_initial_max_stream_data_bidi_local(30);
config.set_initial_max_stream_data_bidi_remote(30);
config.set_initial_max_stream_data_uni(30);
config.set_initial_max_streams_bidi(1000);
config.set_initial_max_streams_uni(0);
config.verify_peer(false);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
assert_eq!(pipe.server.streams.len(), 0);
assert_eq!(pipe.server.readable().len(), 0);
assert_eq!(pipe.server.writable().len(), 0);
assert_eq!(pipe.client.stream_send(0, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(4, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(8, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(12, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(16, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(20, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(24, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(28, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(32, b"hello", true), Ok(5));
assert_eq!(pipe.client.stream_send(36, b"hello", true), Ok(5));
assert_eq!(pipe.advance(), Ok(()));
let mut r = pipe.server.readable();
assert_eq!(r.len(), 10);
assert_eq!(r.next(), Some(0));
assert_eq!(r.next(), Some(4));
assert_eq!(r.next(), Some(8));
assert_eq!(r.next(), Some(12));
assert_eq!(r.next(), Some(16));
assert_eq!(r.next(), Some(20));
assert_eq!(r.next(), Some(24));
assert_eq!(r.next(), Some(28));
assert_eq!(r.next(), Some(32));
assert_eq!(r.next(), Some(36));
assert_eq!(r.next(), None);
let mut w = pipe.server.writable();
assert_eq!(w.len(), 10);
assert_eq!(w.next(), Some(0));
assert_eq!(w.next(), Some(4));
assert_eq!(w.next(), Some(8));
assert_eq!(w.next(), Some(12));
assert_eq!(w.next(), Some(16));
assert_eq!(w.next(), Some(20));
assert_eq!(w.next(), Some(24));
assert_eq!(w.next(), Some(28));
assert_eq!(w.next(), Some(32));
assert_eq!(w.next(), Some(36));
assert_eq!(w.next(), None);
assert_eq!(pipe.server.stream_recv(0, &mut b), Ok((5, true)));
assert!(pipe.server.stream_finished(0));
assert_eq!(pipe.server.readable().len(), 9);
assert_eq!(pipe.server.writable().len(), 10);
assert_eq!(pipe.server.stream_writable(0, 0), Ok(true));
while pipe.server.stream_send(0, b"world", false) != Err(Error::Done) {
assert_eq!(pipe.advance(), Ok(()));
}
assert_eq!(pipe.server.writable().len(), 9);
assert_eq!(pipe.server.stream_writable(0, 0), Ok(true));
let frames = [frame::Frame::StopSending {
stream_id: 0,
error_code: 42,
}];
let pkt_type = packet::Type::Short;
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
let mut iter = frames.iter();
iter.next();
assert_eq!(
iter.next(),
Some(&frame::Frame::ResetStream {
stream_id: 0,
error_code: 42,
final_size: 30,
})
);
let mut w = pipe.server.writable();
assert_eq!(w.len(), 10);
assert!(w.any(|s| s == 0));
assert_eq!(
pipe.server.stream_writable(0, 1),
Err(Error::StreamStopped(42))
);
assert_eq!(pipe.server.writable().len(), 10);
assert_eq!(pipe.server.streams.len(), 10);
let mut ranges = ranges::RangeSet::default();
ranges.insert(0..12);
let frames = [frame::Frame::ACK {
ack_delay: 15,
ranges,
ecn_counts: None,
}];
assert_eq!(pipe.send_pkt_to_server(pkt_type, &frames, &mut buf), Ok(0));
assert_eq!(pipe.server.streams.len(), 9);
let frames = [frame::Frame::StopSending {
stream_id: 0,
error_code: 42,
}];
let len = pipe
.send_pkt_to_server(pkt_type, &frames, &mut buf)
.unwrap();
let frames =
testing::decode_pkt(&mut pipe.client, &mut buf[..len]).unwrap();
assert_eq!(frames.len(), 1);
match frames.first() {
Some(frame::Frame::ACK { .. }) => (),
f => panic!("expected ACK frame, got {:?}", f),
};
assert_eq!(pipe.server.streams.len(), 9);
let mut w = pipe.server.writable();
assert_eq!(w.len(), 9);
assert!(!w.any(|s| s == 0));
assert_eq!(pipe.server.stream_send(0, b"world", true), Err(Error::Done),);
let mut w = pipe.server.writable();
assert_eq!(w.len(), 9);
assert!(!w.any(|s| s == 0));
}
#[rstest]
fn challenge_no_cids(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_active_connection_id_limit(4);
config.set_initial_max_data(30);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
let mut pipe =
testing::Pipe::with_config_and_scid_lengths(&mut config, 16, 16)
.unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let mut server_cids = Vec::new();
for _ in 0..2 {
let (cid, reset_token) = testing::create_cid_and_reset_token(16);
pipe.server
.new_scid(&cid, reset_token, true)
.expect("server issue cid");
server_cids.push(cid);
}
assert_eq!(pipe.advance(), Ok(()));
let server_addr = testing::Pipe::server_addr();
let client_addr_2 = "127.0.0.1:5678".parse().unwrap();
let frames = [frame::Frame::PathChallenge {
data: [0, 1, 2, 3, 4, 5, 6, 7],
}];
let mut pkt_buf = [0u8; 1500];
let mut b = octets::OctetsMut::with_slice(&mut pkt_buf);
let epoch = packet::Type::Short.to_epoch().unwrap();
let crypto_ctx = &mut pipe.client.crypto_ctx[epoch];
let pn = pipe.client.next_pkt_num;
let pn_len = 4;
let hdr = Header {
ty: packet::Type::Short,
version: pipe.client.version,
dcid: server_cids[0].clone(),
scid: ConnectionId::from_ref(&[5, 4, 3, 2, 1]),
pkt_num: 0,
pkt_num_len: pn_len,
token: pipe.client.token.clone(),
versions: None,
key_phase: pipe.client.key_phase,
};
hdr.to_bytes(&mut b).expect("encode header");
let payload_len = frames.iter().fold(0, |acc, x| acc + x.wire_len());
b.put_u32(pn as u32).expect("put pn");
let payload_offset = b.off();
for frame in frames {
frame.to_bytes(&mut b).expect("encode frames");
}
let aead = crypto_ctx.crypto_seal.as_ref().expect("crypto seal");
let written = packet::encrypt_pkt(
&mut b,
pn,
pn_len,
payload_len,
payload_offset,
None,
aead,
)
.expect("packet encrypt");
pipe.client.next_pkt_num += 1;
pipe.server
.recv(&mut pkt_buf[..written], RecvInfo {
to: server_addr,
from: client_addr_2,
})
.expect("server receive path challenge");
assert!(!pipe
.server
.paths_iter(server_addr)
.any(|path| path == client_addr_2));
}
#[rstest]
fn successful_probe_pmtud(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_initial_max_data(100000);
config.set_initial_max_stream_data_bidi_local(100000);
config.set_initial_max_stream_data_bidi_remote(100000);
config.set_initial_max_streams_bidi(2);
config.set_active_connection_id_limit(4);
config.set_max_send_udp_payload_size(1350);
config.set_max_recv_udp_payload_size(1350);
config.discover_pmtu(true);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let server_addr = testing::Pipe::server_addr();
let client_addr = testing::Pipe::client_addr();
let pid_1 = pipe
.server
.paths
.path_id_from_addrs(&(server_addr, client_addr))
.expect("no such path");
let pmtu_param = &mut pipe.server.paths.get_mut(pid_1).unwrap().pmtud;
assert!(pmtu_param.get_should_probe());
assert_eq!(pmtu_param.get_probe_size(), 1350);
assert_eq!(pipe.advance(), Ok(()));
for (_, p) in pipe.server.paths.iter_mut() {
assert_eq!(p.pmtud.get_current_mtu(), 1350);
assert!(!p.pmtud.get_should_probe());
}
}
#[rstest]
fn pmtud_probe_loss(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut config = Config::new(crate::PROTOCOL_VERSION).unwrap();
assert_eq!(config.set_cc_algorithm_name(cc_algorithm_name), Ok(()));
config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.verify_peer(false);
config.set_initial_max_data(100000);
config.set_initial_max_stream_data_bidi_local(100000);
config.set_initial_max_stream_data_bidi_remote(100000);
config.set_initial_max_streams_bidi(2);
config.set_active_connection_id_limit(4);
config.set_max_send_udp_payload_size(1350);
config.set_max_recv_udp_payload_size(1250);
config.discover_pmtu(true);
let mut pipe = testing::Pipe::with_config(&mut config).unwrap();
assert_eq!(pipe.handshake(), Ok(()));
let server_addr = testing::Pipe::server_addr();
let client_addr = testing::Pipe::client_addr();
let pid_1 = pipe
.server
.paths
.path_id_from_addrs(&(server_addr, client_addr))
.expect("no such path");
let pmtu_param = &mut pipe.server.paths.get_mut(pid_1).unwrap().pmtud;
assert!(pmtu_param.get_should_probe());
assert_eq!(pmtu_param.get_probe_size(), 1350);
std::thread::sleep(
pipe.server.paths.get_mut(pid_1).unwrap().recovery.rtt() +
time::Duration::from_millis(1),
);
let active_server_path = pipe.server.paths.get_active_mut().unwrap();
let pmtu_param = &mut active_server_path.pmtud;
assert_eq!(pmtu_param.get_current_mtu(), 1200);
assert!(pmtu_param.get_should_probe());
}
#[cfg(feature = "boringssl-boring-crate")]
#[rstest]
fn enable_pmtud_mid_handshake(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut server_tls_ctx_builder =
boring::ssl::SslContextBuilder::new(boring::ssl::SslMethod::tls())
.unwrap();
server_tls_ctx_builder
.set_certificate_chain_file("examples/cert.crt")
.unwrap();
server_tls_ctx_builder
.set_private_key_file(
"examples/cert.key",
boring::ssl::SslFiletype::PEM,
)
.unwrap();
server_tls_ctx_builder.set_select_certificate_callback(|mut hello| {
<Connection>::set_discover_pmtu_in_handshake(hello.ssl_mut(), true)
.unwrap();
Ok(())
});
let mut server_config = Config::with_boring_ssl_ctx_builder(
crate::PROTOCOL_VERSION,
server_tls_ctx_builder,
)
.unwrap();
assert_eq!(
server_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
let mut client_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
client_config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
client_config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
for config in [&mut client_config, &mut server_config] {
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(1000000);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
config.set_max_send_udp_payload_size(1350);
}
let mut pipe = testing::Pipe::with_client_and_server_config(
&mut client_config,
&mut server_config,
)
.unwrap();
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert!(!active_path.pmtud.is_enabled());
assert_eq!(pipe.handshake(), Ok(()));
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert!(active_path.pmtud.is_enabled());
assert_eq!(active_path.pmtud.get_current_mtu(), 1200);
assert_eq!(pipe.advance(), Ok(()));
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert_eq!(active_path.pmtud.get_current_mtu(), 1350);
}
#[cfg(feature = "boringssl-boring-crate")]
#[rstest]
fn disable_pmtud_mid_handshake(
#[values("cubic", "bbr2", "bbr2_gcongestion")] cc_algorithm_name: &str,
) {
let mut server_tls_ctx_builder =
boring::ssl::SslContextBuilder::new(boring::ssl::SslMethod::tls())
.unwrap();
server_tls_ctx_builder
.set_certificate_chain_file("examples/cert.crt")
.unwrap();
server_tls_ctx_builder
.set_private_key_file(
"examples/cert.key",
boring::ssl::SslFiletype::PEM,
)
.unwrap();
server_tls_ctx_builder.set_select_certificate_callback(|mut hello| {
<Connection>::set_discover_pmtu_in_handshake(hello.ssl_mut(), false)
.unwrap();
Ok(())
});
let mut server_config = Config::with_boring_ssl_ctx_builder(
crate::PROTOCOL_VERSION,
server_tls_ctx_builder,
)
.unwrap();
assert_eq!(
server_config.set_cc_algorithm_name(cc_algorithm_name),
Ok(())
);
let mut client_config = Config::new(crate::PROTOCOL_VERSION).unwrap();
client_config
.load_cert_chain_from_pem_file("examples/cert.crt")
.unwrap();
client_config
.load_priv_key_from_pem_file("examples/cert.key")
.unwrap();
for config in [&mut client_config, &mut server_config] {
config
.set_application_protos(&[b"proto1", b"proto2"])
.unwrap();
config.set_initial_max_data(1000000);
config.set_initial_max_stream_data_bidi_local(15);
config.set_initial_max_stream_data_bidi_remote(15);
config.set_initial_max_stream_data_uni(10);
config.set_initial_max_streams_bidi(3);
config.set_initial_max_streams_uni(3);
config.set_max_idle_timeout(180_000);
config.verify_peer(false);
config.set_ack_delay_exponent(8);
config.set_max_send_udp_payload_size(1350);
config.discover_pmtu(true);
}
let mut pipe = testing::Pipe::with_client_and_server_config(
&mut client_config,
&mut server_config,
)
.unwrap();
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert!(active_path.pmtud.is_enabled());
assert_eq!(pipe.handshake(), Ok(()));
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert!(!active_path.pmtud.is_enabled());
assert_eq!(active_path.pmtud.get_current_mtu(), 1200);
assert_eq!(pipe.advance(), Ok(()));
let active_path = pipe.server.paths.get_active_mut().unwrap();
assert_eq!(active_path.pmtud.get_current_mtu(), 1200);
}
}
pub use crate::packet::ConnectionId;
pub use crate::packet::Header;
pub use crate::packet::Type;
pub use crate::path::PathEvent;
pub use crate::path::PathStats;
pub use crate::path::SocketAddrIter;
pub use crate::recovery::BbrBwLoReductionStrategy;
pub use crate::recovery::BbrParams;
pub use crate::recovery::CongestionControlAlgorithm;
use crate::recovery::RecoveryOps;
pub use crate::recovery::StartupExit;
pub use crate::recovery::StartupExitReason;
pub use crate::stream::StreamIter;
pub use crate::range_buf::BufFactory;
pub use crate::range_buf::BufSplit;
mod cid;
mod crypto;
mod dgram;
#[cfg(feature = "ffi")]
mod ffi;
mod flowcontrol;
mod frame;
pub mod h3;
mod minmax;
mod packet;
mod path;
mod pmtud;
mod rand;
mod range_buf;
mod ranges;
mod recovery;
mod stream;
mod tls;