-
Notifications
You must be signed in to change notification settings - Fork 123
/
connection.rs
1639 lines (1495 loc) · 61.8 KB
/
connection.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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#![allow(clippy::module_name_repetitions)]
use std::{
cell::RefCell,
collections::{BTreeSet, HashMap},
fmt::Debug,
mem,
rc::Rc,
};
use neqo_common::{qdebug, qerror, qinfo, qtrace, qwarn, Decoder, Header, MessageType, Role};
use neqo_qpack::{decoder::QPackDecoder, encoder::QPackEncoder};
use neqo_transport::{
streams::SendOrder, AppError, Connection, ConnectionError, DatagramTracking, State, StreamId,
StreamType, ZeroRttState,
};
use crate::{
client_events::Http3ClientEvents,
control_stream_local::ControlStreamLocal,
control_stream_remote::ControlStreamRemote,
features::extended_connect::{
webtransport_session::WebTransportSession,
webtransport_streams::{WebTransportRecvStream, WebTransportSendStream},
ExtendedConnectEvents, ExtendedConnectFeature, ExtendedConnectType,
},
frames::HFrame,
push_controller::PushController,
qpack_decoder_receiver::DecoderRecvStream,
qpack_encoder_receiver::EncoderRecvStream,
recv_message::{RecvMessage, RecvMessageInfo},
request_target::{AsRequestTarget, RequestTarget},
send_message::SendMessage,
settings::{HSettingType, HSettings, HttpZeroRttChecker},
stream_type_reader::NewStreamHeadReader,
CloseType, Error, Http3Parameters, Http3StreamType, HttpRecvStreamEvents, NewStreamType,
Priority, PriorityHandler, ReceiveOutput, RecvStream, RecvStreamEvents, Res, SendStream,
SendStreamEvents,
};
pub(crate) struct RequestDescription<'b, 't, T>
where
T: AsRequestTarget<'t> + ?Sized + Debug,
{
pub method: &'b str,
pub connect_type: Option<ExtendedConnectType>,
pub target: &'t T,
pub headers: &'b [Header],
pub priority: Priority,
}
pub enum WebTransportSessionAcceptAction {
Accept,
Reject(Vec<Header>),
}
impl ::std::fmt::Display for WebTransportSessionAcceptAction {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match self {
WebTransportSessionAcceptAction::Accept => f.write_str("Accept"),
WebTransportSessionAcceptAction::Reject(_) => f.write_str("Reject"),
}
}
}
#[derive(Debug)]
enum Http3RemoteSettingsState {
NotReceived,
Received(HSettings),
ZeroRtt(HSettings),
}
/// States:
/// - `Initializing`: this is the state during the QUIC handshake,
/// - `ZeroRtt`: 0-RTT has been enabled and is active
/// - Connected
/// - GoingAway(StreamId): The connection has received a `GOAWAY` frame
/// - Closing(ConnectionError): The connection is closed. The closing has been initiated by this end
/// of the connection, e.g., the `CONNECTION_CLOSE` frame has been sent. In this state, the
/// connection waits a certain amount of time to retransmit the `CONNECTION_CLOSE` frame if
/// needed.
/// - Closed(ConnectionError): This is the final close state: closing has been initialized by the
/// peer and an ack for the `CONNECTION_CLOSE` frame has been sent or the closing has been
/// initiated by this end of the connection and the ack for the `CONNECTION_CLOSE` has been
/// received or the waiting time has passed.
#[derive(Debug, PartialEq, PartialOrd, Ord, Eq, Clone)]
pub enum Http3State {
Initializing,
ZeroRtt,
Connected,
GoingAway(StreamId),
Closing(ConnectionError),
Closed(ConnectionError),
}
impl Http3State {
#[must_use]
pub fn active(&self) -> bool {
matches!(
self,
Http3State::Connected | Http3State::GoingAway(_) | Http3State::ZeroRtt
)
}
}
/**
# HTTP/3 core implementation
This is the core implementation of HTTP/3 protocol. It implements most of the features of the
protocol. `Http3Client` and `Http3ServerHandler` implement only client and server side behavior.
The API consists of:
- functions that correspond to the `Http3Client` and `Http3ServerHandler` API:
- `new`
- `close`
- `fetch` - only used by the client-side implementation
- `read_data`
- `stream_reset_send`
- `stream_stop_sending`
- `cancel_fetch`
- `stream_close_send`
- functions that correspond to [`WebTransport`](https://w3c.github.io/webtransport/) functions:
- `webtransport_create_session` - only used by the client-side implementation
- `webtransport_session_accept` - only used by the server-side implementation
- `webtransport_close_session`
- `webtransport_create_stream_local` - this function is called when an application wants to open
a new `WebTransport` stream. For example `Http3Client::webtransport_create_stream` will call
this function.
- `webtransport_create_stream_remote` - this is called when a `WebTransport` stream has been
opened by the peer and this function sets up the appropriate handler for the stream.
- functions that are called by `process_http3`
- `process_sending` - some send-streams are buffered streams(see the Streams section) and this
function is called to trigger sending of the buffer data.
- functions that are called to handle `ConnectionEvent`s:
- `add_new_stream`
- `handle_stream_readable`
- `handle_stream_reset`
- `handle_stream_stop_sending`
- `handle_state_change`
- `handle_zero_rtt_rejected`
- Additional functions:
- `set_features_listener`
- `stream_has_pending_data`
- `has_data_to_send`
- `add_streams`
- `add_recv_stream`
- `queue_control_frame`
- `queue_update_priority`
- `set_0rtt_settings`
- `get_settings`
- `state`
- `webtransport_enabled`
## Streams
Each `Http3Connection` holds a list of stream handlers. Each send and receive-handler is registered in
`send_streams` and `recv_streams`. Unidirectional streams are registered only on one of the lists
and bidirectional streams are registered in both lists and the 2 handlers are independent, e.g. one
can be closed and removed ane second may still be active.
The only streams that are not registered are the local control stream, local QPACK decoder stream,
and local QPACK encoder stream. These streams are send-streams and sending data on this stream is
handled a bit differently. This is done in the `process_sending` function, i.e. the control data is
sent first and QPACK data is sent after regular stream data is sent because this stream may have
new data only after regular streams are handled (TODO we may improve this a bit to send QPACK
commands before headers.)
There are the following types of streams:
- `Control`: there is only a receiver stream of this type and the handler is `ControlStreamRemote`.
- `Decoder`: there is only a receiver stream of this type and the handler is `DecoderRecvStream`.
- `Encoder`: there is only a receiver stream of this type and the handler is `EncoderRecvStream`.
- `NewStream`: there is only a receiver stream of this type and the handler is
`NewStreamHeadReader`.
- `Http`: `SendMessage` and `RecvMessage` handlers are responsible for this type of streams.
- `Push`: `RecvMessage` is responsible for this type of streams.
- `ExtendedConnect`: `WebTransportSession` is responsible sender and receiver handler.
- `WebTransport(StreamId)`: `WebTransportSendStream` and `WebTransportRecvStream` are responsible
sender and receiver handler.
- `Unknown`: These are all other stream types that are not unknown to the current implementation
and should be handled properly by the spec, e.g., in our implementation the streams are
reset.
The streams are registered in `send_streams` and `recv_streams` in following ways depending if they
are local or remote:
- local streams:
- all local stream will be registered with the appropriate handler.
- remote streams:
- all new incoming streams are registered with `NewStreamHeadReader`. This is triggered by
`ConnectionEvent::NewStream` and `add_new_stream` is called.
- reading from a `NewStreamHeadReader` stream, via the `receive` function, will decode a stream
type. `NewStreamHeadReader::receive` will return `ReceiveOutput::NewStream(_)` when a stream
type has been decoded. After this point the stream:
- will be regegistered with the appropriate handler,
- will be canceled if is an unknown stream type or
- the connection will fail if it is unallowed stream type (receiveing HTTP request on the
client-side).
The output is handled in `handle_new_stream`, for control, qpack streams and partially
`WebTransport` streams, otherwise the output is handled by `Http3Client` and `Http3ServerHandler`.
### Receiving data
Reading from a stream is triggered by `ConnectionEvent::RecvStreamReadable` events for the stream.
The receive handler is retrieved from `recv_streams` and its `RecvStream::receive` function is
called.
Receiving data on `Http` streams is also triggered by the `read_data` function.
`ConnectionEvent::RecvStreamReadable` events will trigger reading `HEADERS` frame and frame headers
for `DATA` frames which will produce `Http3ClientEvent` or `Http3ServerEvent` events. The content of
`DATA` frames is read by the application using the `read_data` function. The `read_data` function
may read frame headers for consecutive `DATA` frames.
On a `WebTransport(_)` stream data will be read only by the `read_data` function. The
`RecvStream::receive` function only produces an `Http3ClientEvent` or `Http3ServerEvent` event.
The `receive` and `read_data` functions may detect that the stream is done, e.g. FIN received. In
this case, the stream will be removed from the `recv_stream` register, see `remove_recv_stream`.
### Sending data
All sender stream handlers have buffers. Data is first written into a buffer before being supplied
to the QUIC layer. All data except the `DATA` frame and `WebTransport(_)`’s payload are written
into the buffer. This includes stream type byte, e.g. `WEBTRANSPORT_STREAM` as well. In the case of
`Http` and `WebTransport(_)` applications can write directly to the QUIC layer using the
`send_data` function to avoid copying data. Sending data via the `send_data` function is only
possible if there is no buffered data.
If a stream has buffered data it will be registered in the `streams_with_pending_data` queue and
actual sending will be performed in the `process_sending` function call. (This is done in this way,
i.e. data is buffered first and then sent, for 2 reasons: in this way, sending will happen in a
single function, therefore error handling and clean up is easier and the QUIC layer may not be
able to accept all data and being able to buffer data is required in any case.)
The `send` and `send_data` functions may detect that the stream is closed and all outstanding data
has been transferred to the QUIC layer. In this case, the stream will be removed from the
`send_stream` register.
### `ControlStreamRemote`
The `ControlStreamRemote` handler uses `FrameReader` to read and decode frames received on the
control frame. The `receive` returns `ReceiveOutput::ControlFrames(_)` with a list of control
frames read (the list may be empty). The control frames are handled by `Http3Connection` and/or by
`Http3Client` and `Http3ServerHandler`.
### `DecoderRecvStream` and `EncoderRecvStream`
The `receive` functions of these handlers call corresponding `receive` functions of `QPackDecoder`
and `QPackDecoder`.
`DecoderRecvStream` returns `ReceiveOutput::UnblockedStreams(_)` that may contain a list of stream
ids that are unblocked by receiving qpack decoder commands. `Http3Connection` will handle this
output by calling `receive` for the listed stream ids.
`EncoderRecvStream` only returns `ReceiveOutput::NoOutput`.
Both handlers may return an error that will close the connection.
### `NewStreamHeadReader`
A new incoming receiver stream registers a `NewStreamHeadReader` handler. This handler reads the
first bytes of a stream to detect a stream type. The `receive` function returns
`ReceiveOutput::NoOutput` if a stream type is still not known by reading the available stream data
or `ReceiveOutput::NewStream(_)`. The handling of the output is explained above.
### `SendMessage` and `RecvMessage`
`RecvMessage::receive` only returns `ReceiveOutput::NoOutput`. It also have an event listener of
type `HttpRecvStreamEvents`. The listener is called when headers are ready, or data is ready, etc.
For example for `Http` stream the listener will produce `HeaderReady` and `DataReadable` events.
### `WebTransportSession`
A `WebTransport` session is connected to a control stream that is in essence an HTTP transaction.
Therefore, `WebTransportSession` will internally use a `SendMessage` and `RecvMessage` handler to
handle parsing and sending of HTTP part of the control stream. When HTTP headers are exchenged,
`WebTransportSession` will take over handling of stream data. `WebTransportSession` sets
`WebTransportSessionListener` as the `RecvMessage` event listener.
`WebTransportSendStream` and `WebTransportRecvStream` are associated with a `WebTransportSession`
and they will be canceled if the session is closed. To be avle to do this `WebTransportSession`
holds a list of its active streams and clean up is done in `remove_extended_connect`.
### `WebTransportSendStream` and `WebTransportRecvStream`
`WebTransport` streams are associated with a session. `WebTransportSendStream` and
`WebTransportRecvStream` hold a reference to the session and are registered in the session upon
creation by `Http3Connection`. The `WebTransportSendStream` and `WebTransportRecvStream`
handlers will be unregistered from the session if they are closed, reset, or canceled.
The call to function `receive` may produce `Http3ClientEvent::DataReadable`. Actual reading of
data is done in the `read_data` function.
*/
#[derive(Debug)]
pub(crate) struct Http3Connection {
role: Role,
pub state: Http3State,
local_params: Http3Parameters,
control_stream_local: ControlStreamLocal,
pub qpack_encoder: Rc<RefCell<QPackEncoder>>,
pub qpack_decoder: Rc<RefCell<QPackDecoder>>,
settings_state: Http3RemoteSettingsState,
streams_with_pending_data: BTreeSet<StreamId>,
pub send_streams: HashMap<StreamId, Box<dyn SendStream>>,
pub recv_streams: HashMap<StreamId, Box<dyn RecvStream>>,
webtransport: ExtendedConnectFeature,
}
impl ::std::fmt::Display for Http3Connection {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
write!(f, "Http3 connection")
}
}
impl Http3Connection {
/// Create a new connection.
pub fn new(conn_params: Http3Parameters, role: Role) -> Self {
Self {
state: Http3State::Initializing,
control_stream_local: ControlStreamLocal::new(),
qpack_encoder: Rc::new(RefCell::new(QPackEncoder::new(
conn_params.get_qpack_settings(),
true,
))),
qpack_decoder: Rc::new(RefCell::new(QPackDecoder::new(
conn_params.get_qpack_settings(),
))),
webtransport: ExtendedConnectFeature::new(
ExtendedConnectType::WebTransport,
conn_params.get_webtransport(),
),
local_params: conn_params,
settings_state: Http3RemoteSettingsState::NotReceived,
streams_with_pending_data: BTreeSet::new(),
send_streams: HashMap::new(),
recv_streams: HashMap::new(),
role,
}
}
/// This function is called when a not default feature needs to be negotiated. This is currently
/// only used for the `WebTransport` feature. The negotiation is done via the `SETTINGS` frame
/// and when the peer's `SETTINGS` frame has been received the listener will be called.
pub fn set_features_listener(&mut self, feature_listener: Http3ClientEvents) {
self.webtransport.set_listener(feature_listener);
}
/// This function creates and initializes, i.e. send stream type, the control and qpack
/// streams.
fn initialize_http3_connection(&mut self, conn: &mut Connection) -> Res<()> {
qinfo!([self], "Initialize the http3 connection.");
self.control_stream_local.create(conn)?;
self.send_settings();
self.create_qpack_streams(conn)?;
Ok(())
}
fn send_settings(&mut self) {
qdebug!([self], "Send settings.");
self.control_stream_local.queue_frame(&HFrame::Settings {
settings: HSettings::from(&self.local_params),
});
self.control_stream_local.queue_frame(&HFrame::Grease);
}
/// Save settings for adding to the session ticket.
pub(crate) fn save_settings(&self) -> Vec<u8> {
HttpZeroRttChecker::save(&self.local_params)
}
fn create_qpack_streams(&mut self, conn: &mut Connection) -> Res<()> {
qdebug!([self], "create_qpack_streams.");
self.qpack_encoder
.borrow_mut()
.add_send_stream(conn.stream_create(StreamType::UniDi)?);
self.qpack_decoder
.borrow_mut()
.add_send_stream(conn.stream_create(StreamType::UniDi)?);
Ok(())
}
/// Inform a `HttpConnection` that a stream has data to send and that `send` should be called
/// for the stream.
pub fn stream_has_pending_data(&mut self, stream_id: StreamId) {
self.streams_with_pending_data.insert(stream_id);
}
/// Return true if there is a stream that needs to send data.
pub fn has_data_to_send(&self) -> bool {
!self.streams_with_pending_data.is_empty()
}
/// This function calls the `send` function for all streams that have data to send. If a stream
/// has data to send it will be added to the `streams_with_pending_data` list.
///
/// Control and QPACK streams are handled differently and are never added to the list.
fn send_non_control_streams(&mut self, conn: &mut Connection) -> Res<()> {
let to_send = mem::take(&mut self.streams_with_pending_data);
for stream_id in to_send {
let done = if let Some(s) = &mut self.send_streams.get_mut(&stream_id) {
s.send(conn)?;
if s.has_data_to_send() {
self.streams_with_pending_data.insert(stream_id);
}
s.done()
} else {
false
};
if done {
self.remove_send_stream(stream_id, conn);
}
}
Ok(())
}
/// Call `send` for all streams that need to send data. See explanation for the main structure
/// for more details.
pub fn process_sending(&mut self, conn: &mut Connection) -> Res<()> {
// check if control stream has data to send.
self.control_stream_local
.send(conn, &mut self.recv_streams)?;
self.send_non_control_streams(conn)?;
self.qpack_decoder.borrow_mut().send(conn)?;
match self.qpack_encoder.borrow_mut().send_encoder_updates(conn) {
Ok(())
| Err(neqo_qpack::Error::EncoderStreamBlocked | neqo_qpack::Error::DynamicTableFull) => {
}
Err(e) => return Err(Error::QpackError(e)),
}
Ok(())
}
/// We have a resumption token which remembers previous settings. Update the setting.
pub fn set_0rtt_settings(&mut self, conn: &mut Connection, settings: HSettings) -> Res<()> {
self.initialize_http3_connection(conn)?;
self.set_qpack_settings(&settings)?;
self.settings_state = Http3RemoteSettingsState::ZeroRtt(settings);
self.state = Http3State::ZeroRtt;
Ok(())
}
/// Returns the settings for a connection. This is used for creating a resumption token.
pub fn get_settings(&self) -> Option<HSettings> {
if let Http3RemoteSettingsState::Received(settings) = &self.settings_state {
Some(settings.clone())
} else {
None
}
}
/// This is called when a `ConnectionEvent::NewStream` event is received. This register the
/// stream with a `NewStreamHeadReader` handler.
pub fn add_new_stream(&mut self, stream_id: StreamId) {
qtrace!([self], "A new stream: {}.", stream_id);
self.recv_streams.insert(
stream_id,
Box::new(NewStreamHeadReader::new(stream_id, self.role)),
);
}
/// The function calls `receive` for a stream. It also deals with the outcome of a read by
/// calling `handle_stream_manipulation_output`.
#[allow(clippy::option_if_let_else)] // False positive as borrow scope isn't lexical here.
fn stream_receive(&mut self, conn: &mut Connection, stream_id: StreamId) -> Res<ReceiveOutput> {
qtrace!([self], "Readable stream {}.", stream_id);
if let Some(recv_stream) = self.recv_streams.get_mut(&stream_id) {
let res = recv_stream.receive(conn);
return self
.handle_stream_manipulation_output(res, stream_id, conn)
.map(|(output, _)| output);
}
Ok(ReceiveOutput::NoOutput)
}
fn handle_unblocked_streams(
&mut self,
unblocked_streams: Vec<StreamId>,
conn: &mut Connection,
) -> Res<()> {
for stream_id in unblocked_streams {
qdebug!([self], "Stream {} is unblocked", stream_id);
if let Some(r) = self.recv_streams.get_mut(&stream_id) {
let res = r
.http_stream()
.ok_or(Error::HttpInternal(10))?
.header_unblocked(conn);
let res = self.handle_stream_manipulation_output(res, stream_id, conn)?;
debug_assert!(matches!(res, (ReceiveOutput::NoOutput, _)));
}
}
Ok(())
}
/// This function handles reading from all streams, i.e. control, qpack, request/response
/// stream and unidi stream that are still do not have a type.
/// The function cannot handle:
/// 1) a `Push(_)`, `Htttp` or `WebTransportStream(_)` stream
/// 2) frames `MaxPushId`, `PriorityUpdateRequest`, `PriorityUpdateRequestPush` or `Goaway` must
/// be handled by `Http3Client`/`Server`.
/// The function returns `ReceiveOutput`.
pub fn handle_stream_readable(
&mut self,
conn: &mut Connection,
stream_id: StreamId,
) -> Res<ReceiveOutput> {
let mut output = self.stream_receive(conn, stream_id)?;
if let ReceiveOutput::NewStream(stream_type) = output {
output = self.handle_new_stream(conn, stream_type, stream_id)?;
}
#[allow(clippy::match_same_arms)] // clippy is being stupid here
match output {
ReceiveOutput::UnblockedStreams(unblocked_streams) => {
self.handle_unblocked_streams(unblocked_streams, conn)?;
Ok(ReceiveOutput::NoOutput)
}
ReceiveOutput::ControlFrames(mut control_frames) => {
let mut rest = Vec::new();
for cf in control_frames.drain(..) {
if let Some(not_handled) = self.handle_control_frame(cf)? {
rest.push(not_handled);
}
}
Ok(ReceiveOutput::ControlFrames(rest))
}
ReceiveOutput::NewStream(
NewStreamType::Push(_) | NewStreamType::Http | NewStreamType::WebTransportStream(_),
) => Ok(output),
ReceiveOutput::NewStream(_) => {
unreachable!("NewStream should have been handled already")
}
ReceiveOutput::NoOutput => Ok(output),
}
}
/// This is called when a RESET frame has been received.
pub fn handle_stream_reset(
&mut self,
stream_id: StreamId,
app_error: AppError,
conn: &mut Connection,
) -> Res<()> {
qinfo!(
[self],
"Handle a stream reset stream_id={} app_err={}",
stream_id,
app_error
);
self.close_recv(stream_id, CloseType::ResetRemote(app_error), conn)
}
pub fn handle_stream_stop_sending(
&mut self,
stream_id: StreamId,
app_error: AppError,
conn: &mut Connection,
) -> Res<()> {
qinfo!(
[self],
"Handle stream_stop_sending stream_id={} app_err={}",
stream_id,
app_error
);
if self.send_stream_is_critical(stream_id) {
return Err(Error::HttpClosedCriticalStream);
}
self.close_send(stream_id, CloseType::ResetRemote(app_error), conn);
Ok(())
}
/// This is called when `neqo_transport::Connection` state has been change to take proper
/// actions in the HTTP3 layer.
pub fn handle_state_change(&mut self, conn: &mut Connection, state: &State) -> Res<bool> {
qdebug!([self], "Handle state change {:?}", state);
match state {
State::Handshaking => {
if self.role == Role::Server
&& conn.zero_rtt_state() == ZeroRttState::AcceptedServer
{
self.state = Http3State::ZeroRtt;
self.initialize_http3_connection(conn)?;
Ok(true)
} else {
Ok(false)
}
}
State::Connected => {
debug_assert!(matches!(
self.state,
Http3State::Initializing | Http3State::ZeroRtt
));
if self.state == Http3State::Initializing {
self.initialize_http3_connection(conn)?;
}
self.state = Http3State::Connected;
Ok(true)
}
State::Closing { error, .. } | State::Draining { error, .. } => {
if matches!(self.state, Http3State::Closing(_) | Http3State::Closed(_)) {
Ok(false)
} else {
self.state = Http3State::Closing(error.clone());
Ok(true)
}
}
State::Closed(error) => {
if matches!(self.state, Http3State::Closed(_)) {
Ok(false)
} else {
self.state = Http3State::Closed(error.clone());
Ok(true)
}
}
_ => Ok(false),
}
}
/// This is called when 0RTT has been reset to clear `send_streams`, `recv_streams` and
/// settings.
pub fn handle_zero_rtt_rejected(&mut self) -> Res<()> {
if self.state == Http3State::ZeroRtt {
self.state = Http3State::Initializing;
self.control_stream_local = ControlStreamLocal::new();
self.qpack_encoder = Rc::new(RefCell::new(QPackEncoder::new(
self.local_params.get_qpack_settings(),
true,
)));
self.qpack_decoder = Rc::new(RefCell::new(QPackDecoder::new(
self.local_params.get_qpack_settings(),
)));
self.settings_state = Http3RemoteSettingsState::NotReceived;
self.streams_with_pending_data.clear();
// TODO: investigate whether this code can automatically retry failed transactions.
self.send_streams.clear();
self.recv_streams.clear();
Ok(())
} else {
debug_assert!(false, "Zero rtt rejected in the wrong state.");
Err(Error::HttpInternal(3))
}
}
pub fn handle_datagram(&mut self, datagram: &[u8]) {
let mut decoder = Decoder::new(datagram);
let session = decoder
.decode_varint()
.and_then(|id| self.recv_streams.get_mut(&StreamId::from(id * 4)))
.and_then(|stream| stream.webtransport());
if let Some(s) = session {
s.borrow_mut().datagram(decoder.decode_remainder().to_vec());
}
}
fn check_stream_exists(&self, stream_type: Http3StreamType) -> Res<()> {
if self
.recv_streams
.values()
.any(|c| c.stream_type() == stream_type)
{
Err(Error::HttpStreamCreation)
} else {
Ok(())
}
}
/// If the new stream is a control or QPACK stream, this function creates a proper handler
/// and perform a read.
/// if the new stream is a `Push(_)`, `Http` or `WebTransportStream(_)` stream, the function
/// returns `ReceiveOutput::NewStream(_)` and the caller will handle it.
/// If the stream is of a unknown type the stream will be closed.
fn handle_new_stream(
&mut self,
conn: &mut Connection,
stream_type: NewStreamType,
stream_id: StreamId,
) -> Res<ReceiveOutput> {
match stream_type {
NewStreamType::Control => {
self.check_stream_exists(Http3StreamType::Control)?;
self.recv_streams
.insert(stream_id, Box::new(ControlStreamRemote::new(stream_id)));
}
NewStreamType::Push(push_id) => {
qinfo!(
[self],
"A new push stream {} push_id:{}.",
stream_id,
push_id
);
}
NewStreamType::Decoder => {
qinfo!([self], "A new remote qpack encoder stream {}", stream_id);
self.check_stream_exists(Http3StreamType::Decoder)?;
self.recv_streams.insert(
stream_id,
Box::new(DecoderRecvStream::new(
stream_id,
Rc::clone(&self.qpack_decoder),
)),
);
}
NewStreamType::Encoder => {
qinfo!([self], "A new remote qpack decoder stream {}", stream_id);
self.check_stream_exists(Http3StreamType::Encoder)?;
self.recv_streams.insert(
stream_id,
Box::new(EncoderRecvStream::new(
stream_id,
Rc::clone(&self.qpack_encoder),
)),
);
}
NewStreamType::Http => {
qinfo!([self], "A new http stream {}.", stream_id);
}
NewStreamType::WebTransportStream(session_id) => {
let session_exists = self
.send_streams
.get(&StreamId::from(session_id))
.map_or(false, |s| {
s.stream_type() == Http3StreamType::ExtendedConnect
});
if !session_exists {
conn.stream_stop_sending(stream_id, Error::HttpStreamCreation.code())?;
return Ok(ReceiveOutput::NoOutput);
}
// set incoming WebTransport streams to be fair (share bandwidth)
conn.stream_fairness(stream_id, true).ok();
qinfo!(
[self],
"A new WebTransport stream {} for session {}.",
stream_id,
session_id
);
}
NewStreamType::Unknown => {
conn.stream_stop_sending(stream_id, Error::HttpStreamCreation.code())?;
}
};
match stream_type {
NewStreamType::Control | NewStreamType::Decoder | NewStreamType::Encoder => {
self.stream_receive(conn, stream_id)
}
NewStreamType::Push(_) | NewStreamType::Http | NewStreamType::WebTransportStream(_) => {
Ok(ReceiveOutput::NewStream(stream_type))
}
NewStreamType::Unknown => Ok(ReceiveOutput::NoOutput),
}
}
/// This is called when an application closes the connection.
pub fn close(&mut self, error: AppError) {
qinfo!([self], "Close connection error {:?}.", error);
self.state = Http3State::Closing(ConnectionError::Application(error));
if (!self.send_streams.is_empty() || !self.recv_streams.is_empty()) && (error == 0) {
qwarn!("close(0) called when streams still active");
}
self.send_streams.clear();
self.recv_streams.clear();
}
/// This function will not handle the output of the function completely, but only
/// handle the indication that a stream is closed. There are 2 cases:
/// - an error occurred or
/// - the stream is done, i.e. the second value in `output` tuple is true if the stream is done
/// and can be removed from the `recv_streams`
/// How it is handling `output`:
/// - if the stream is done, it removes the stream from `recv_streams`
/// - if the stream is not done and there is no error, return `output` and the caller will
/// handle it.
/// - in case of an error:
/// - if it is only a stream error and the stream is not critical, send `STOP_SENDING` frame,
/// remove the stream from `recv_streams` and inform the listener that the stream has been
/// reset.
/// - otherwise this is a connection error. In this case, propagate the error to the caller
/// that will handle it properly.
fn handle_stream_manipulation_output<U>(
&mut self,
output: Res<(U, bool)>,
stream_id: StreamId,
conn: &mut Connection,
) -> Res<(U, bool)>
where
U: Default,
{
match &output {
Ok((_, true)) => {
self.remove_recv_stream(stream_id, conn);
}
Ok((_, false)) => {}
Err(e) => {
if e.stream_reset_error() && !self.recv_stream_is_critical(stream_id) {
mem::drop(conn.stream_stop_sending(stream_id, e.code()));
self.close_recv(stream_id, CloseType::LocalError(e.code()), conn)?;
return Ok((U::default(), false));
}
}
}
output
}
fn create_fetch_headers<'b, 't, T>(request: &RequestDescription<'b, 't, T>) -> Res<Vec<Header>>
where
T: AsRequestTarget<'t> + ?Sized + Debug,
{
let target = request
.target
.as_request_target()
.map_err(|_| Error::InvalidRequestTarget)?;
// Transform pseudo-header fields
let mut final_headers = vec![
Header::new(":method", request.method),
Header::new(":scheme", target.scheme()),
Header::new(":authority", target.authority()),
Header::new(":path", target.path()),
];
if let Some(conn_type) = request.connect_type {
final_headers.push(Header::new(":protocol", conn_type.string()));
}
if let Some(priority_header) = request.priority.header() {
final_headers.push(priority_header);
}
final_headers.extend_from_slice(request.headers);
Ok(final_headers)
}
pub fn fetch<'b, 't, T>(
&mut self,
conn: &mut Connection,
send_events: Box<dyn SendStreamEvents>,
recv_events: Box<dyn HttpRecvStreamEvents>,
push_handler: Option<Rc<RefCell<PushController>>>,
request: &RequestDescription<'b, 't, T>,
) -> Res<StreamId>
where
T: AsRequestTarget<'t> + ?Sized + Debug,
{
qinfo!(
[self],
"Fetch method={} target: {:?}",
request.method,
request.target,
);
let id = self.create_bidi_transport_stream(conn)?;
self.fetch_with_stream(id, conn, send_events, recv_events, push_handler, request)?;
Ok(id)
}
fn create_bidi_transport_stream(&self, conn: &mut Connection) -> Res<StreamId> {
// Requests cannot be created when a connection is in states: Initializing, GoingAway,
// Closing and Closed.
match self.state() {
Http3State::GoingAway(..) | Http3State::Closing(..) | Http3State::Closed(..) => {
return Err(Error::AlreadyClosed)
}
Http3State::Initializing => return Err(Error::Unavailable),
_ => {}
}
let id = conn
.stream_create(StreamType::BiDi)
.map_err(|e| Error::map_stream_create_errors(&e))?;
conn.stream_keep_alive(id, true)?;
Ok(id)
}
fn fetch_with_stream<'b, 't, T>(
&mut self,
stream_id: StreamId,
conn: &mut Connection,
send_events: Box<dyn SendStreamEvents>,
recv_events: Box<dyn HttpRecvStreamEvents>,
push_handler: Option<Rc<RefCell<PushController>>>,
request: &RequestDescription<'b, 't, T>,
) -> Res<()>
where
T: AsRequestTarget<'t> + ?Sized + Debug,
{
let final_headers = Http3Connection::create_fetch_headers(request)?;
let stream_type = if request.connect_type.is_some() {
Http3StreamType::ExtendedConnect
} else {
Http3StreamType::Http
};
let mut send_message = SendMessage::new(
MessageType::Request,
stream_type,
stream_id,
self.qpack_encoder.clone(),
send_events,
);
send_message
.http_stream()
.unwrap()
.send_headers(&final_headers, conn)?;
self.add_streams(
stream_id,
Box::new(send_message),
Box::new(RecvMessage::new(
&RecvMessageInfo {
message_type: MessageType::Response,
stream_type,
stream_id,
header_frame_type_read: false,
},
Rc::clone(&self.qpack_decoder),
recv_events,
push_handler,
PriorityHandler::new(false, request.priority),
)),
);
// Call immediately send so that at least headers get sent. This will make Firefox faster,
// since it can send request body immediately in most cases and does not need to do
// a complete process loop.
self.send_streams
.get_mut(&stream_id)
.ok_or(Error::InvalidStreamId)?
.send(conn)?;
Ok(())
}
/// Stream data are read directly into a buffer supplied as a parameter of this function to
/// avoid copying data.
///
/// # Errors
///
/// It returns an error if a stream does not exist or an error happens while reading a stream,
/// e.g. early close, protocol error, etc.
pub fn read_data(
&mut self,
conn: &mut Connection,
stream_id: StreamId,
buf: &mut [u8],
) -> Res<(usize, bool)> {
qinfo!([self], "read_data from stream {}.", stream_id);
let res = self
.recv_streams
.get_mut(&stream_id)
.ok_or(Error::InvalidStreamId)?
.read_data(conn, buf);
self.handle_stream_manipulation_output(res, stream_id, conn)
}
/// This is called when an application resets a stream.
/// The application reset will close both sides.
pub fn stream_reset_send(
&mut self,
conn: &mut Connection,
stream_id: StreamId,
error: AppError,
) -> Res<()> {
qinfo!(
[self],
"Reset sending side of stream {} error={}.",
stream_id,
error
);
if self.send_stream_is_critical(stream_id) {
return Err(Error::InvalidStreamId);
}
self.close_send(stream_id, CloseType::ResetApp(error), conn);
conn.stream_reset_send(stream_id, error)?;
Ok(())
}
pub fn stream_stop_sending(
&mut self,
conn: &mut Connection,
stream_id: StreamId,
error: AppError,
) -> Res<()> {
qinfo!(
[self],
"Send stop sending for stream {} error={}.",
stream_id,