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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
#![allow(clippy::new_without_default)]
use std::collections::VecDeque;
use std::fmt;
use std::net::SocketAddr;
use std::panic::UnwindSafe;
use std::sync::Arc;
use std::time::Instant;
use sctp_proto::{Association, AssociationHandle, DatagramEvent};
use sctp_proto::{Endpoint, EndpointConfig, Stream, StreamEvent, Transmit};
use sctp_proto::{Event, Payload, PayloadProtocolIdentifier, ServerConfig};
use snap::{b64_encode, webrtc_transport_config};
pub use sctp_proto::Error as ProtoError;
use sctp_proto::ReliabilityType;
mod snap;
pub use snap::SctpInitData;
mod dcep;
use dcep::DcepAck;
use dcep::DcepOpen;
mod error;
pub use error::SctpError;
/// Bytes that can be buffered inside str0m across all streams.
const MAX_BUFFERED_ACROSS_STREAMS: usize = 128 * 1024;
pub(crate) struct RtcSctp {
state: RtcSctpState,
endpoint: Endpoint,
fake_addr: SocketAddr,
handle: AssociationHandle,
assoc: Option<Association>,
entries: Vec<StreamEntry>,
pushed_back_transmit: Option<VecDeque<Vec<u8>>>,
last_now: Instant,
client: bool,
snap_enabled: bool,
snap_init: Option<SctpInitData>,
}
/// This is okay because there is no way for a user of Rtc to interact with the Sctp subsystem
/// in a way that would allow them to observe a potentially broken invariant when catching a panic.
impl UnwindSafe for RtcSctp {}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum RtcSctpState {
Uninited,
AwaitRemoteAssociation,
AwaitAssociationEstablished,
Established,
}
impl RtcSctpState {
pub fn propagate_endpoint_to_assoc(&self) -> bool {
matches!(
self,
RtcSctpState::AwaitAssociationEstablished | RtcSctpState::Established
)
}
}
#[derive(Debug)]
struct StreamEntry {
/// Config as provided when opening the channel. This is None if we discover
/// the channel from the remote peer before getting a DcepOpen or local open_stream.
config: Option<ChannelConfig>,
/// Current state
state: StreamEntryState,
/// Actual stream id. Negotiated or automatically allocated.
id: u16,
/// If we are to close this entry.
do_close: bool,
/// If the queued outgoing data drops below this threshold, Rtc is to emit an
/// event to the user.
buffered_threshold: BufferedThresholdConfig,
}
#[derive(Debug)]
/// Tracks the `buffered_amount_low_threshold` for a stream.
///
/// Lets us defer applying user changes to the underlying SCTP
/// stream until the next poll cycle, without first querying the current
/// configured value.
enum BufferedThresholdConfig {
/// No threshold has been set or it was cleared after an error.
Unconfigured,
/// A user-requested threshold to apply on the next poll.
Desired(usize),
/// The threshold value currently configured in the SCTP stream.
Configured(usize),
}
impl BufferedThresholdConfig {
pub fn set(&mut self, v: usize) {
let is_change = match self {
BufferedThresholdConfig::Unconfigured => true,
BufferedThresholdConfig::Desired(w) if v != *w => true,
BufferedThresholdConfig::Configured(x) if v != *x => true,
_ => false,
};
if is_change {
*self = BufferedThresholdConfig::Desired(v);
}
}
}
pub(crate) enum SctpEvent {
Transmit {
packets: VecDeque<Vec<u8>>,
},
Open {
id: u16,
label: String,
},
Close {
id: u16,
},
Data {
id: u16,
binary: bool,
data: Vec<u8>,
},
BufferedAmountLow {
id: u16,
},
}
/// These are the possible paths:
/// ```text
/// local inited, in-band AwaitOpen -> AwaitDcepAck -> Open
/// local inited, out-of-band AwaitOpen -> Open
/// remote inited, in-band AwaitConfig -> (receive dcep) -> Open
/// remote inited, out-of-band AwaitConfig -> (open_stream) -> Open
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum StreamEntryState {
/// A new stream declared locally, not discovered from remote.
AwaitOpen,
/// A new stream, discovered from remote. It can either be in-band or out-of band
/// We will either receive DcepOpen in-band, or a open_stream() call out-of-band.
AwaitConfig,
/// If we have sent DcepOpen and are waiting for the ack.
AwaitDcepAck,
/// Stream is open, ready to send data.
Open,
/// If some error occurs.
Closed,
}
/// (Low level) configuration for a data channel.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ChannelConfig {
/// The label to use for the user to identify the channel.
pub label: String,
/// Whether channel is guaranteed ordered delivery of messages.
pub ordered: bool,
/// The reliability setting, which can allow to drop messages.
pub reliability: Reliability,
/// Whether channel is negotiated in-band (DCEP) or out-of-band.
/// None means in-band negotiated. Some(stream_id) means out-of-band.
pub negotiated: Option<u16>,
/// Protocol name.
///
/// Defaults to ""
pub protocol: String,
}
impl Default for ChannelConfig {
fn default() -> Self {
Self {
label: Default::default(),
ordered: true,
reliability: Default::default(),
negotiated: Default::default(),
protocol: Default::default(),
}
}
}
/// Reliability setting of a data channel.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Reliability {
/// Packets are delivered in order, with retransmits.
#[default]
Reliable,
/// Packets delivered out of order with a max lifetime.
MaxPacketLifetime {
/// The lifetime of a packet in milliseconds.
lifetime: u16,
},
/// Packets delivered out of order with a max number of retransmits.
MaxRetransmits {
/// Number of retransmits before giving up.
retransmits: u16,
},
}
impl StreamEntry {
fn set_state(&mut self, state: StreamEntryState) -> bool {
if self.state == state {
return false;
}
debug!("Stream {:?} -> {:?}", self.state, state);
self.state = state;
true
}
#[must_use]
fn configure_reliability(&mut self, stream: &mut Stream) -> bool {
let dcep: DcepOpen = self.config.as_ref().expect("config to be set").into();
let ret = stream.set_reliability_params(
dcep.unordered,
dcep.channel_type,
dcep.reliability_parameter,
);
if let Err(e) = ret {
warn!(
"Failed to set reliability params on stream {}: {:?}",
self.id, e
);
self.do_close = true;
return false;
}
true
}
}
impl RtcSctp {
pub fn new() -> Self {
let mut config = EndpointConfig::default();
// Default here is 1200, I've seen warnings that are 77 over.
// DTLS above MTU 1200: 1277
// Let's try 1120, see if we can avoid warnings.
config.max_payload_size(1120);
let mut server_config = ServerConfig::default();
server_config.transport = webrtc_transport_config();
let endpoint = Endpoint::new(Arc::new(config), Some(Arc::new(server_config)));
let fake_addr = "1.1.1.1:5000".parse().unwrap();
RtcSctp {
state: RtcSctpState::Uninited,
endpoint,
fake_addr,
handle: AssociationHandle(0), // temporary
assoc: None,
entries: vec![],
pushed_back_transmit: None,
last_now: Instant::now(), // placeholder until init()
client: false,
snap_enabled: false,
snap_init: None,
}
}
pub fn is_inited(&self) -> bool {
self.state != RtcSctpState::Uninited
}
pub fn init(
&mut self,
client: bool,
now: Instant,
sctp_init_data: Option<SctpInitData>,
) -> Result<(), SctpError> {
if self.state != RtcSctpState::Uninited {
return Err(SctpError::Proto(ProtoError::Other(
"SCTP already initialized".into(),
)));
}
self.client = client;
self.last_now = now;
if let Some(snap_data) = sctp_init_data {
// SNAP path: both local and remote INIT chunks must be present.
if snap_data.local_init.is_none() || snap_data.remote_init.is_none() {
return Err(SctpError::Proto(ProtoError::Other(
"SNAP requires both local and remote SCTP INIT chunks".into(),
)));
}
let config = snap_data.into_client_config();
debug!(
"New {} association (out-of-band: true)",
if client { "local" } else { "server" },
);
let (handle, assoc) = self
.endpoint
.connect(config, self.fake_addr)
.map_err(|e| SctpError::Proto(ProtoError::Other(e.to_string())))?;
self.handle = handle;
self.assoc = Some(assoc);
// With SNAP, both sides exchanged INIT chunks out-of-band. The
// sctp-proto association is already in established state (via
// `with_snap`). We set our state to Established immediately
// even though DTLS may not be connected yet. This is safe
// because the `dtls_connected` guard in `do_poll_output`
// prevents any SCTP packets from flowing until the DTLS
// handshake completes.
set_state(&mut self.state, RtcSctpState::Established);
} else if client {
// Normal client path: initiate the SCTP association.
let config = SctpInitData::default().into_client_config();
debug!("New local association (out-of-band: false)");
let (handle, assoc) = self
.endpoint
.connect(config, self.fake_addr)
.map_err(|e| SctpError::Proto(ProtoError::Other(e.to_string())))?;
self.handle = handle;
self.assoc = Some(assoc);
set_state(&mut self.state, RtcSctpState::AwaitAssociationEstablished);
} else {
// Normal server path: wait for the remote to initiate.
set_state(&mut self.state, RtcSctpState::AwaitRemoteAssociation);
}
Ok(())
}
pub fn is_client(&self) -> bool {
self.client
}
/// Enable SNAP by pre-populating the init data.
pub fn enable_snap(&mut self) {
self.snap_enabled = true;
self.snap_init.get_or_insert_with(SctpInitData::new);
}
/// Whether local offers should opt in to SNAP.
pub fn snap_enabled(&self) -> bool {
self.snap_enabled
}
/// Ensure the local SNAP INIT chunk is generated. Returns `false` if
/// generation failed (degrades to non-SNAP).
pub fn ensure_local_snap_init(&mut self) -> bool {
let init_data = self.snap_init.get_or_insert_with(SctpInitData::new);
if init_data.local_init_chunk().is_err() {
self.snap_init = None;
false
} else {
true
}
}
/// Discard pending SNAP negotiation state before SCTP starts.
///
/// This preserves local opt-in for future offers.
pub fn disable_pending_snap(&mut self) {
if !self.is_inited() {
self.snap_init = None;
}
}
/// Get the local INIT chunk as a base64 string for SDP, if applicable.
///
/// Returns `None` when:
/// - SNAP is not active
/// - SCTP is established without SNAP (non-SNAP association)
pub fn local_sctp_init_for_sdp(&self) -> Option<String> {
let d = self.snap_init.as_ref()?;
if self.is_inited() && d.remote_init.is_none() {
// Established non-SNAP association — MUST NOT inject sctp-init.
return None;
}
d.local_init.as_ref().map(|b| b64_encode(b))
}
/// Get the cached remote INIT string, if set.
pub fn snap_remote_init_string(&self) -> Option<String> {
self.snap_init.as_ref().and_then(|d| d.remote_init_string())
}
/// Whether this is an established SNAP association (has remote init).
pub fn is_snap_established(&self) -> bool {
self.is_inited()
&& self
.snap_init
.as_ref()
.and_then(|d| d.remote_init.as_ref())
.is_some()
}
/// Set the remote SNAP INIT from a base64 string. Returns `Ok(true)` if
/// accepted, `Ok(false)` on decode error (degrades to non-SNAP).
pub fn set_remote_snap_init_string(&mut self, value: &str) -> bool {
let init_data = self.snap_init.get_or_insert_with(SctpInitData::new);
match init_data.set_remote_init_string(value) {
Ok(()) => true,
Err(_) => {
self.disable_pending_snap();
false
}
}
}
/// Build a cloned `SctpInitData` for passing to `init()`, if both local
/// and remote INIT chunks are present.
pub fn build_snap_init_data(&self) -> Option<SctpInitData> {
let d = self.snap_init.as_ref()?;
if d.local_init.is_none() || d.remote_init.is_none() {
return None;
}
Some(d.clone())
}
/// Opens a new stream.
pub fn open_stream(&mut self, id: u16, config: ChannelConfig) {
// The channel might already have arrived via SCTP, and if it is negotiated out-of-band
// we are waiting for the configuration.
let entry = stream_entry(
&mut self.entries,
id,
StreamEntryState::AwaitOpen,
"open_stream",
);
let in_band = config.negotiated.is_none();
// Stream should not already have a config, we are either waiting for DcepOpen, or this is
// out-of-band configuration, in which case this call is setting the config.
if entry.config.is_some() {
warn!("Stream is already configured: {}", id);
entry.do_close = true;
return;
} else {
entry.config = Some(config);
}
// If we are in AwaitConfig, the stream was discovered from the remote peer before
// we got to do open_stream. This means we _must_ be in the out-of-band track,
// since we shouldn't call open_stream on remotely started in-band.
if entry.state == StreamEntryState::AwaitConfig {
if in_band {
warn!("open_stream in-band negotiation for remote stream: {}", id);
entry.do_close = true;
} else {
// out-of-band where remote started. We can go to Open, but must configure the local
// stream for it first.
// The association must be open since we don't get AwaitConfig state without
// polling from the remote peer.
let mut stream = self
.assoc
.as_mut()
.expect("association to be open")
.stream(entry.id)
.expect("stream of entry in AwaitConfig");
if !entry.configure_reliability(&mut stream) {
return;
}
entry.set_state(StreamEntryState::Open);
}
}
}
/// Close stream.
pub fn close_stream(&mut self, id: u16) {
if let Some(entry) = self.entries.iter_mut().find(|v| v.id == id) {
entry.do_close = true;
}
}
pub fn is_open(&self, id: u16) -> bool {
if self.state != RtcSctpState::Established {
return false;
}
let Some(rec) = self.entries.iter().find(|e| e.id == id) else {
return false;
};
rec.state == StreamEntryState::Open
}
// TODO: fix sctp-proto so we don't need &mut here.
pub fn available(&mut self) -> usize {
let Some(assoc) = &mut self.assoc else {
return 0;
};
// The amount currently buffered.
let total: usize = self
.entries
.iter()
.filter_map(|e| {
assoc
.stream(e.id)
.ok()
.and_then(|s| s.buffered_amount().ok())
})
.sum();
MAX_BUFFERED_ACROSS_STREAMS - total
}
pub fn write(&mut self, id: u16, binary: bool, buf: &[u8]) -> Result<usize, SctpError> {
if self.state != RtcSctpState::Established {
return Err(SctpError::WriteBeforeEstablished);
}
let assoc = self
.assoc
.as_mut()
.ok_or(SctpError::WriteBeforeEstablished)?;
let rec = self
.entries
.iter()
.find(|e| e.id == id)
.expect("stream entry for write");
if rec.state != StreamEntryState::Open {
return Err(SctpError::WriteBeforeEstablished);
}
let mut stream = assoc.stream(id)?;
let ppi = if binary {
if buf.is_empty() {
PayloadProtocolIdentifier::BinaryEmpty
} else {
PayloadProtocolIdentifier::Binary
}
} else if buf.is_empty() {
PayloadProtocolIdentifier::StringEmpty
} else {
PayloadProtocolIdentifier::String
};
Ok(stream.write_with_ppi(buf, ppi)?)
}
pub fn buffered_amount(&mut self, id: u16) -> usize {
let Some(assoc) = self.assoc.as_mut() else {
return 0;
};
let Ok(stream) = assoc.stream(id) else {
return 0;
};
stream.buffered_amount().unwrap_or(0)
}
pub fn set_buffered_amount_low_threshold(&mut self, id: u16, threshold: usize) {
let entry = self
.entries
.iter_mut()
.find(|e| e.id == id)
.expect("stream entry for valid channel id");
// This update will be propagated on next poll.
entry.buffered_threshold.set(threshold);
}
pub fn handle_input(&mut self, now: Instant, data: &[u8]) {
trace!("Handle input: {}", data.len());
// TODO, remove Bytes in sctp and just use &[u8].
let data = data.to_vec().into();
let r = self.endpoint.handle(now, self.fake_addr, None, None, data);
let Some((handle, event)) = r else {
return;
};
match event {
DatagramEvent::NewAssociation(a) => {
// In slow or unreliable networks from browsers (use 3g or slow 4g) settings.
// The browser resends a new associations and str0m would override the previously
// acked association. Webrtc should use only 1 association.
if self.assoc.is_some() {
return;
}
debug!("New remote association");
// Remote side initiated the association
self.assoc = Some(a);
self.handle = handle;
set_state(&mut self.state, RtcSctpState::AwaitAssociationEstablished);
}
DatagramEvent::AssociationEvent(event) => {
self.assoc
.as_mut()
.expect("association for event")
.handle_event(event);
}
}
}
pub fn handle_timeout(&mut self, now: Instant) {
if self.state == RtcSctpState::Uninited {
// Need to call `init()` before any timeouts are accepted.
return;
}
self.last_now = now;
// Remove closed entries.
self.entries.retain(|e| e.state != StreamEntryState::Closed);
let Some(assoc) = &mut self.assoc else {
return;
};
assoc.handle_timeout(now);
// propagate events between endpoint and association.
while let Some(e) = assoc.poll_endpoint_event() {
if let Some(ae) = self.endpoint.handle_event(self.handle, e) {
assoc.handle_event(ae);
}
}
}
pub fn poll(&mut self) -> Option<SctpEvent> {
let r = self.do_poll();
if let Some(r) = &r {
trace!("Poll {:?}", r);
}
r
}
pub fn do_poll(&mut self) -> Option<SctpEvent> {
if self.state == RtcSctpState::Uninited {
// Need to call `init()` before any polling starts.
return None;
}
if let Some(t) = self.pushed_back_transmit.take() {
return Some(SctpEvent::Transmit { packets: t });
}
while let Some(t) = self.poll_transmit() {
let Some(buf) = transmit_to_vec(t) else {
continue;
};
return Some(SctpEvent::Transmit { packets: buf });
}
// Don't progress to move data between association and endpoint until we have an
// association we want to drive forward.
if !self.state.propagate_endpoint_to_assoc() {
return None;
}
let assoc = self.assoc.as_mut()?;
while let Some(e) = assoc.poll() {
if let Event::Connected = e {
set_state(&mut self.state, RtcSctpState::Established);
return self.poll();
}
// TODO: Do we need to handle AssociationLost?
if let Event::Stream(se) = e {
match se {
StreamEvent::Readable { id } | StreamEvent::Writable { id } => {
stream_entry(
&mut self.entries,
id,
StreamEntryState::AwaitConfig,
"readable/writable",
);
}
StreamEvent::Finished { id } | StreamEvent::Stopped { id, .. } => {
let entry = stream_entry(
&mut self.entries,
id,
StreamEntryState::AwaitConfig,
"closed",
);
debug!("Stream {} closed", id);
entry.do_close = true;
}
StreamEvent::BufferedAmountLow { id } => {
return Some(SctpEvent::BufferedAmountLow { id });
}
_ => {}
}
}
}
// Must wait for association state to be established before opening streams.
if self.state != RtcSctpState::Established {
return None;
}
for entry in &mut self.entries {
let want_open = entry.state == StreamEntryState::AwaitOpen;
if want_open {
debug!("Open stream {}", entry.id);
match assoc.open_stream(entry.id, PayloadProtocolIdentifier::Unknown) {
Ok(mut s) => {
if !entry.configure_reliability(&mut s) {
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
let config = entry.config.as_ref().expect("config if AwaitOpen");
let in_band = config.negotiated.is_none();
if in_band {
let dcep: DcepOpen = config.into();
let mut buf = vec![0; 1500];
let n = dcep.marshal_to(&mut buf);
buf.truncate(n);
match s.write_with_ppi(&buf, PayloadProtocolIdentifier::Dcep) {
Ok(l) => {
assert!(n == l);
entry.set_state(StreamEntryState::AwaitDcepAck);
// Start over with polling, since we might have caused
// some network traffic by writing the DcepOpen.
return self.do_poll();
}
Err(e) => {
warn!(
"Failed to write DCEP open on stream {}: {:?}",
entry.id, e
);
entry.do_close = true;
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
}
}
// Continuing means we are opening the stream out-of-band.
}
Err(ProtoError::ErrStreamAlreadyExist) => {
let config = entry.config.as_ref().expect("config if AwaitOpen");
let in_band = config.negotiated.is_none();
if in_band {
warn!(
"Opening stream {} failed: ErrStreamAlreadyExists with in-band",
entry.id
);
entry.do_close = true;
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
// Continuing means we are opening the stream out-of-band. The error can happen
// if both streams are declared and one side starts sending to the other
}
Err(e) => {
warn!("Opening stream {} failed: {:?}", entry.id, e);
entry.do_close = true;
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
}
// Consider out-of-band stream open.
let config = entry.config.as_ref().expect("config if AwaitOpen");
let in_band = config.negotiated.is_none();
assert!(!in_band);
let label = config.label.clone();
entry.set_state(StreamEntryState::Open);
return Some(SctpEvent::Open {
id: entry.id,
label,
});
}
if entry.do_close && entry.state != StreamEntryState::Closed {
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
let mut stream = match assoc.stream(entry.id) {
Ok(v) => v,
Err(e) => {
// This is expected on browser refresh or similar abrupt shutdown.
debug!("Getting stream {} failed: {:?}", entry.id, e);
entry.do_close = true;
continue;
}
};
// Propagate the desired buffered threshold.
// The idea is to only do this if the user has changed the value for it without
// incurring the cost of looking up the currently confifured value.
if let BufferedThresholdConfig::Desired(x) = entry.buffered_threshold {
if let Err(e) = stream.set_buffered_amount_low_threshold(x) {
debug!("Setting buffered_amount_low_threshold failed: {:?}", e);
entry.do_close = true;
entry.buffered_threshold = BufferedThresholdConfig::Unconfigured;
continue;
}
entry.buffered_threshold = BufferedThresholdConfig::Configured(x);
}
match stream_read_data(&mut stream) {
Ok(Some((buf, ppi))) => {
if ppi != PayloadProtocolIdentifier::Dcep {
// This is the normal path for incoming data.
let buf = ppi_adjust_buf(buf, ppi);
let binary = matches!(
ppi,
PayloadProtocolIdentifier::Binary
| PayloadProtocolIdentifier::BinaryEmpty
);
return Some(SctpEvent::Data {
id: entry.id,
binary,
data: buf,
});
}
// It's Dcep, either a DcepOpen or DcepAck.
match entry.state {
// We are in AwaitConfig state which means we are either going to get it via
// the DcepOpen, or by an out-of-band configuration via open_stream.
// This indicates we are doing in-band.
StreamEntryState::AwaitConfig => {
let dcep: DcepOpen = match buf.as_slice().try_into() {
Ok(v) => v,
Err(e) => {
warn!("Failed to read incoming DCEP {}: {:?}", entry.id, e);
entry.do_close = true;
continue;
}
};
if entry.config.is_none() {
entry.config = Some((&dcep).into());
} else {
warn!("Received DcepOpen for configured stream: {}", entry.id);
}
let mut obuf = [0];
DcepAck.marshal_to(&mut obuf);
match stream.write_with_ppi(&obuf, PayloadProtocolIdentifier::Dcep) {
Ok(l) => {
assert!(obuf.len() == l);
entry.set_state(StreamEntryState::Open);
return Some(SctpEvent::Open {
id: entry.id,
label: dcep.label,
});
}
Err(e) => {
warn!(
"Failed to write DCEP ack on stream {}: {:?}",
entry.id, e
);
entry.do_close = true;
entry.set_state(StreamEntryState::Closed);
return Some(SctpEvent::Close { id: entry.id });
}
}
}
StreamEntryState::AwaitDcepAck => {
let res: Result<DcepAck, _> = buf.as_slice().try_into();
if let Err(e) = res {
warn!("Failed to read incoming DCEP ACK {}: {:?}", entry.id, e);
entry.do_close = true;
continue;
}
entry.set_state(StreamEntryState::Open);
let config = entry.config.as_ref().expect("config when DcepAck");
return Some(SctpEvent::Open {
id: entry.id,
label: config.label.clone(),
});
}
_ => {
warn!(
"Stream {} in wrong state when receiving DCEP: {:?}",
entry.id, entry.state
);
entry.do_close = true;
continue;
}
}
}
Ok(None) => continue,
Err(_) => entry.do_close = true,
}
}
None
}
pub fn poll_timeout(&mut self) -> Option<Instant> {
self.assoc.as_mut().and_then(|a| a.poll_timeout())
}
pub fn push_back_transmit(&mut self, data: VecDeque<Vec<u8>>) {
trace!("Push back transmit: {}", data.len());
assert!(self.pushed_back_transmit.is_none());
self.pushed_back_transmit = Some(data);
}
fn poll_transmit(&mut self) -> Option<Transmit> {
if let Some(t) = self.endpoint.poll_transmit() {
return Some(t);
}
if let Some(t) = self.assoc.as_mut()?.poll_transmit(self.last_now) {
return Some(t);
}
None
}
pub fn config(&self, sctp_stream_id: u16) -> Option<&ChannelConfig> {
self.entries
.iter()
.find(|s| s.id == sctp_stream_id)
.and_then(|s| s.config.as_ref())
}
}
fn transmit_to_vec(t: Transmit) -> Option<VecDeque<Vec<u8>>> {
let Payload::RawEncode(v) = t.payload else {
return None;
};
Some(v.into_iter().map(|b| b.to_vec()).collect())
}
fn set_state(current_state: &mut RtcSctpState, state: RtcSctpState) {
if *current_state != state {
debug!("{:?} => {:?}", current_state, state);
*current_state = state;
}
}
fn stream_entry<'a>(
entries: &'a mut Vec<StreamEntry>,
id: u16,
initial_state: StreamEntryState,
reason: &'static str,
) -> &'a mut StreamEntry {
let idx = entries.iter().position(|v| v.id == id);
if let Some(idx) = idx {
entries.get_mut(idx).unwrap()
} else {
debug!("New stream {} ({:?}): {}", id, initial_state, reason);
let e = StreamEntry {
config: None,
state: initial_state,
id,
do_close: false,
buffered_threshold: BufferedThresholdConfig::Unconfigured,
};
entries.push(e);
entries.last_mut().unwrap()
}
}
fn stream_read_data(
stream: &mut Stream,
) -> Result<Option<(Vec<u8>, PayloadProtocolIdentifier)>, SctpError> {
let Some(chunks) = stream.read()? else {
return Ok(None);
};
let n = chunks.len();
let mut buf = vec![0; n];
let l = chunks.read(&mut buf)?;
assert!(l == n);
use PayloadProtocolIdentifier::*;
match chunks.ppi {
Dcep | String | Binary => {} // keep as is
StringEmpty | BinaryEmpty => buf.clear(),
_ => {
return Err(SctpError::Proto(ProtoError::Other(
"Unknown PayloadProtocolIdentifier".into(),
)));
}
}
Ok(Some((buf, chunks.ppi)))
}
fn ppi_adjust_buf(mut buf: Vec<u8>, ppi: PayloadProtocolIdentifier) -> Vec<u8> {
match ppi {
PayloadProtocolIdentifier::StringEmpty | PayloadProtocolIdentifier::BinaryEmpty => {
buf.clear();
buf
}
_ => buf,
}
}
impl fmt::Debug for SctpEvent {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Transmit { packets } => f
.debug_struct("Transmit")
.field("packets", &packets.len())
.finish(),
Self::Open { id, label } => f
.debug_struct("Open")
.field("id", id)
.field("label", label)
.finish(),
Self::Close { id } => f.debug_struct("Close").field("id", id).finish(),
Self::Data { id, binary, data } => f
.debug_struct("Data")
.field("id", id)
.field("binary", binary)
.field("data", &data.len())
.finish(),
Self::BufferedAmountLow { id } => {
f.debug_struct("BufferedAmountLow").field("id", id).finish()
}
}
}
}
impl From<&ChannelConfig> for DcepOpen {
fn from(v: &ChannelConfig) -> Self {
let (channel_type, reliability_parameter) = (&v.reliability).into();
DcepOpen {
unordered: !v.ordered,
channel_type,
reliability_parameter,
priority: 0,
label: v.label.clone(),
protocol: v.protocol.clone(),
}
}
}
impl From<&Reliability> for (ReliabilityType, u32) {
fn from(v: &Reliability) -> Self {
match v {
Reliability::Reliable => (ReliabilityType::Reliable, 0),
Reliability::MaxPacketLifetime { lifetime } => {
(ReliabilityType::Timed, *lifetime as u32)
}
Reliability::MaxRetransmits { retransmits } => {
(ReliabilityType::Rexmit, *retransmits as u32)
}
}
}
}
impl From<&DcepOpen> for ChannelConfig {
fn from(v: &DcepOpen) -> Self {
ChannelConfig {
label: v.label.clone(),
ordered: !v.unordered,
reliability: (v.channel_type, v.reliability_parameter).into(),
negotiated: None,
protocol: v.protocol.clone(),
}
}
}
impl From<(ReliabilityType, u32)> for Reliability {
fn from((r, p): (ReliabilityType, u32)) -> Self {
match r {
ReliabilityType::Reliable => Reliability::Reliable,
ReliabilityType::Rexmit => Reliability::MaxRetransmits {
retransmits: p as u16,
},
ReliabilityType::Timed => Reliability::MaxPacketLifetime { lifetime: p as u16 },
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn partial_snap_init_requires_both_chunks() {
let now = Instant::now();
let mut sctp = RtcSctp::new();
let mut init_data = SctpInitData::new();
init_data.local_init_chunk().unwrap();
let err = sctp.init(true, now, Some(init_data)).unwrap_err();
assert!(
err.to_string()
.contains("SNAP requires both local and remote SCTP INIT chunks")
);
}
#[test]
fn malformed_remote_snap_does_not_disable_local_opt_in() {
let mut sctp = RtcSctp::new();
sctp.enable_snap();
assert!(!sctp.set_remote_snap_init_string("!!!not-valid-base64!!!"));
assert!(sctp.snap_enabled());
assert!(sctp.ensure_local_snap_init());
assert!(sctp.local_sctp_init_for_sdp().is_some());
}
/// Helper to connect a client and server RtcSctp pair to Established state.
fn connect_client_server() -> (RtcSctp, RtcSctp) {
let now = Instant::now();
let mut client = RtcSctp::new();
let mut server = RtcSctp::new();
client.init(true, now, None).unwrap();
server.init(false, now, None).unwrap();
// Exchange packets until both are Established.
for _ in 0..20 {
// Drain client transmits -> feed to server
while let Some(t) = client.poll_transmit() {
if let Some(bufs) = transmit_to_vec(t) {
for buf in bufs {
server.handle_input(now, &buf);
}
}
}
// Process server events
while let Some(e) = server.do_poll() {
if let SctpEvent::Transmit { packets } = e {
for buf in packets {
client.handle_input(now, &buf);
}
}
}
// Drain server transmits -> feed to client
while let Some(t) = server.poll_transmit() {
if let Some(bufs) = transmit_to_vec(t) {
for buf in bufs {
client.handle_input(now, &buf);
}
}
}
// Process client events
while let Some(e) = client.do_poll() {
if let SctpEvent::Transmit { packets } = e {
for buf in packets {
server.handle_input(now, &buf);
}
}
}
// Check if both established
if client.state == RtcSctpState::Established
&& server.state == RtcSctpState::Established
{
break;
}
}
assert_eq!(client.state, RtcSctpState::Established);
assert_eq!(server.state, RtcSctpState::Established);
(client, server)
}
/// Regression test: when `assoc.open_stream()` returns `ErrStreamAlreadyExist`
/// for an in-band (DCEP) data channel, the entry must transition to Closed and
/// emit `SctpEvent::Close`. Before the fix, it stayed in `AwaitOpen` and retried
/// on every `do_poll()`, causing an infinite loop.
#[test]
fn err_stream_already_exist_in_band_returns_close() {
let (mut client, _server) = connect_client_server();
let stream_id: u16 = 0;
// Pre-create the stream in the association so the next open_stream() with the
// same ID will return ErrStreamAlreadyExist.
let assoc = client.assoc.as_mut().unwrap();
assoc
.open_stream(stream_id, PayloadProtocolIdentifier::Unknown)
.expect("first open_stream should succeed");
// Manually add an entry in AwaitOpen state with in-band config (negotiated: None).
// This simulates a locally-initiated in-band channel whose stream ID conflicts
// with one already opened by the remote peer.
client.entries.push(StreamEntry {
config: Some(ChannelConfig {
label: "test".to_string(),
ordered: true,
reliability: Reliability::Reliable,
negotiated: None, // in-band
protocol: String::new(),
}),
state: StreamEntryState::AwaitOpen,
id: stream_id,
do_close: false,
buffered_threshold: BufferedThresholdConfig::Unconfigured,
});
// Before the fix: do_poll() would return None (continue skipped close handling)
// and the entry would remain in AwaitOpen, retrying forever.
// After the fix: do_poll() should return SctpEvent::Close.
let event = client.do_poll();
assert!(
matches!(&event, Some(SctpEvent::Close { id }) if *id == stream_id),
"expected SctpEvent::Close for stream {stream_id}, got {event:?}"
);
// Verify entry transitioned to Closed.
let entry = client.entries.iter().find(|e| e.id == stream_id).unwrap();
assert_eq!(entry.state, StreamEntryState::Closed);
}
}