forked from quinn-rs/quinn
/
lib.rs
250 lines (221 loc) · 6.8 KB
/
lib.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
//! Low-level protocol logic for the QUIC protoocol
//!
//! quinn-proto contains a fully deterministic implementation of QUIC protocol logic. It contains
//! no networking code and does not get any relevant timestamps from the operating system. Most
//! users may want to use the futures-based quinn API instead.
//!
//! The quinn-proto API might be of interest if you want to use it from a C or C++ project
//! through C bindings or if you want to use a different event loop than the one tokio provides.
//!
//! The most important types are `Endpoint`, which conceptually represents the protocol state for
//! a single socket and mostly manages configuration and dispatches incoming datagrams to the
//! related `Connection`. `Connection` types contain the bulk of the protocol logic related to
//! managing a single connection and all the related state (such as streams).
#![warn(missing_docs)]
#[cfg(test)]
#[macro_use]
extern crate assert_matches;
#[cfg(test)]
#[macro_use]
extern crate hex_literal;
#[cfg(test)]
#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate slog;
use std::fmt;
use std::net::SocketAddr;
use std::ops;
use std::time::Duration;
mod assembler;
#[doc(hidden)]
pub mod coding;
mod packet;
mod range_set;
mod spaces;
#[cfg(test)]
mod tests;
mod transport_parameters;
#[doc(hidden)]
pub mod varint;
mod connection;
pub use crate::connection::{Connection, ConnectionError, Event, Timer, TimerSetting, TimerUpdate};
mod crypto;
pub use crate::crypto::TokenKey;
mod frame;
use crate::frame::Frame;
pub use crate::frame::{ApplicationClose, ConnectionClose};
mod endpoint;
pub use crate::endpoint::{
ClientConfig, ConnectError, ConnectionHandle, DatagramEvent, Endpoint, EndpointConfig,
ServerConfig,
};
mod shared;
pub use crate::shared::{
ConfigError, ConnectionEvent, ConnectionId, EcnCodepoint, EndpointEvent, TransportConfig,
};
mod stream;
pub use crate::stream::{FinishError, ReadError, WriteError};
mod transport_error;
pub use crate::transport_error::{Code as TransportErrorCode, Error as TransportError};
/// The QUIC protocol version implemented
pub const VERSION: u32 = 0xff00_0014;
/// TLS ALPN value for HTTP over QUIC
pub const ALPN_QUIC_HTTP: &[u8] = b"hq-20";
/// TLS ALPN value for H3
pub const ALPN_QUIC_H3: &[u8] = b"h3-20";
/// Whether an endpoint was the initiator of a connection
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum Side {
/// The initiator of a connection
Client = 0,
/// The acceptor of a connection
Server = 1,
}
impl Side {
#[inline]
/// Shorthand for `self == Side::Client`
pub fn is_client(self) -> bool {
self == Side::Client
}
#[inline]
/// Shorthand for `self == Side::Server`
pub fn is_server(self) -> bool {
self == Side::Server
}
}
impl ops::Not for Side {
type Output = Side;
fn not(self) -> Side {
match self {
Side::Client => Side::Server,
Side::Server => Side::Client,
}
}
}
impl slog::Value for Side {
fn serialize(
&self,
_: &slog::Record<'_>,
key: slog::Key,
serializer: &mut dyn slog::Serializer,
) -> slog::Result {
serializer.emit_arguments(key, &format_args!("{:?}", self))
}
}
/// Whether a stream communicates data in both directions or only from the initiator
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum Directionality {
/// Data flows in both directions
Bi = 0,
/// Data flows only from the stream's initiator
Uni = 1,
}
impl fmt::Display for Directionality {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
use self::Directionality::*;
f.pad(match *self {
Bi => "bidirectional",
Uni => "unidirectional",
})
}
}
impl slog::Value for Directionality {
fn serialize(
&self,
_: &slog::Record<'_>,
key: slog::Key,
serializer: &mut dyn slog::Serializer,
) -> slog::Result {
serializer.emit_arguments(key, &format_args!("{:?}", self))
}
}
/// Identifier for a stream within a particular connection
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct StreamId(#[doc(hidden)] pub u64);
impl fmt::Display for StreamId {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let initiator = match self.initiator() {
Side::Client => "client",
Side::Server => "server",
};
let directionality = match self.directionality() {
Directionality::Uni => "uni",
Directionality::Bi => "bi",
};
write!(
f,
"{} {}directional stream {}",
initiator,
directionality,
self.index()
)
}
}
impl slog::Value for StreamId {
fn serialize(
&self,
_: &slog::Record<'_>,
key: slog::Key,
serializer: &mut dyn slog::Serializer,
) -> slog::Result {
serializer.emit_arguments(key, &format_args!("{:?}", self))
}
}
impl StreamId {
pub(crate) fn new(initiator: Side, directionality: Directionality, index: u64) -> Self {
StreamId(index << 2 | (directionality as u64) << 1 | initiator as u64)
}
/// Which side of a connection initiated the stream
pub fn initiator(self) -> Side {
if self.0 & 0x1 == 0 {
Side::Client
} else {
Side::Server
}
}
/// Which directions data flows in
pub fn directionality(self) -> Directionality {
if self.0 & 0x2 == 0 {
Directionality::Bi
} else {
Directionality::Uni
}
}
/// Distinguishes streams of the same initiator and directionality
pub fn index(self) -> u64 {
self.0 >> 2
}
}
impl coding::Codec for StreamId {
fn decode<B: bytes::Buf>(buf: &mut B) -> coding::Result<StreamId> {
varint::read(buf).map(StreamId).ok_or(coding::UnexpectedEnd)
}
fn encode<B: bytes::BufMut>(&self, buf: &mut B) {
varint::write(self.0, buf).unwrap()
}
}
/// An outgoing packet
#[derive(Debug)]
pub struct Transmit {
/// The socket this datagram should be sent to
pub destination: SocketAddr,
/// Explicit congestion notification bits to set on the packet
pub ecn: Option<EcnCodepoint>,
/// Contents of the datagram
pub packet: Box<[u8]>,
}
//
// Useful internal constants
//
/// Draft 17 §5.1.1: endpoints SHOULD provide and maintain at least eight
/// connection IDs
const LOC_CID_COUNT: usize = 8;
const RESET_TOKEN_SIZE: usize = 16;
const MAX_CID_SIZE: usize = 18;
const MIN_CID_SIZE: usize = 4;
const MIN_INITIAL_SIZE: usize = 1200;
const MIN_MTU: u16 = 1232;
const TIMER_GRANULARITY: Duration = Duration::from_millis(1);
/// Maximum number of streams that can be uniquely identified by a stream ID
const MAX_STREAM_COUNT: u64 = 1 << 60;