websocat 4.0.0-alpha3

Command-line client for web sockets, like netcat/curl/socat for ws://.
Documentation
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
use std::net::{IpAddr, SocketAddr};

use http::{uri::Authority, Uri};
use tracing::{debug, warn};

use crate::cli::WebsocatArgs;

use super::{
    types::{
        Endpoint, EndpointDiscriminants, Overlay, OverlayDiscriminants, PreparatoryAction,
        SocketType, SpecifierStack, WebsocatInvocation, WebsocatInvocationStacks,
    },
    utils::IdentifierGenerator,
};

impl WebsocatInvocation {
    pub fn patches(&mut self, vars: &mut IdentifierGenerator) -> anyhow::Result<()> {
        self.stacks
            .apply_to_all(|x| x.maybe_patch_existing_ws_request(&self.opts))?;
        self.stacks
            .apply_to_all(|x| x.maybe_splitup_client_ws_endpoint())?;
        self.stacks
            .apply_to_all(|x| x.maybe_splitup_ws_c_overlay(&self.opts))?;
        self.stacks
            .apply_to_all(|x| x.maybe_splitup_ws_u_overlay(&self.opts))?;
        self.stacks
            .apply_to_all(|x| x.maybe_splitup_server_ws_endpoint())?;
        if !self.opts.late_resolve {
            self.stacks
                .apply_to_all(|x| x.maybe_early_resolve(&mut self.beginning, vars))?;
        }
        self.maybe_fill_in_tls_details(vars)?;

        if self.opts.log_traffic
            && !self.stacks.right.insert_log_overlay()
            && !self.stacks.left.insert_log_overlay()
        {
            warn!("Failed to automaticelly insert log: overlay");
        }
        self.stacks.apply_to_all(|x| x.fill_in_log_overlay_type())?;

        if !self.opts.less_fixups {
            self.maybe_auto_insert_write_splitoff_overlay()?;
        }

        let mut write_splitoff = std::mem::take(&mut self.stacks.write_splitoff);
        self.stacks
            .apply_to_all(|x| x.maybe_process_writesplitoff(&mut write_splitoff, &self.opts))?;

        let session_typ_so_far = self.session_socket_type();
        self.stacks
            .apply_to_all(|x| x.infer_mirror_type(session_typ_so_far))?;

        if !self.opts.less_fixups {
            self.check_tee_overlay_count()?;
        }
        if !self.opts.less_fixups {
            self.maybe_auto_insert_tee()?;
        }

        let mut tee = std::mem::take(&mut self.stacks.tee);
        self.stacks
            .apply_to_all(|x| x.maybe_process_tee(&mut tee, &self.opts))?;

        self.maybe_insert_chunker()?;

        if !self.opts.less_fixups {
            self.maybe_insert_reuser();
        }

        self.stacks
            .apply_to_all(|x| x.check_required_socket_types(&self.opts))?;

        self.stacks
            .apply_to_all(|x| x.maybe_process_reuser(vars, &mut self.beginning))?;

        Ok(())
    }
}
impl WebsocatInvocationStacks {
    fn apply_to_all(
        &mut self,
        mut f: impl FnMut(&mut SpecifierStack) -> anyhow::Result<()>,
    ) -> anyhow::Result<()> {
        f(&mut self.left)?;
        f(&mut self.right)?;
        if let Some(ref mut splt) = self.write_splitoff {
            f(splt)?;
        }
        for flt in &mut self.filter {
            f(flt)?;
        }
        for flt in &mut self.filter_reverse {
            f(flt)?;
        }
        for flt in &mut self.tee {
            f(flt)?;
        }
        Ok(())
    }

    fn check_if_any_stack(&self, f: fn(&SpecifierStack) -> bool) -> bool {
        f(&self.left)
            || f(&self.right)
            || self.write_splitoff.iter().any(f)
            || self.filter.iter().any(f)
            || self.filter_reverse.iter().any(f)
            || self.tee.iter().any(f)
    }
}
impl WebsocatInvocation {
    fn maybe_auto_insert_write_splitoff_overlay(&mut self) -> anyhow::Result<()> {
        if self.opts.write_splitoff.is_some()
            && !self
                .stacks
                .check_if_any_stack(|s| s.contains_overlay(OverlayDiscriminants::WriteSplitoff))
        {
            debug!("Auto-inserting write-splitoff: overlay");
            self.stacks.right.overlays.push(Overlay::WriteSplitoff);
        }
        Ok(())
    }

    fn check_tee_overlay_count(&mut self) -> anyhow::Result<()> {
        let mut count = 0usize;
        self.stacks.apply_to_all(|x| {
            for ovl in &x.overlays {
                if matches!(ovl, Overlay::Tee { .. }) {
                    count += 1;
                }
            }
            Ok(())
        })?;
        if count > 1 {
            anyhow::bail!("Too many tee: overlays specified in the stack. Only one is supported");
        }
        if self
            .stacks
            .tee
            .iter()
            .any(|x| x.contains_overlay(OverlayDiscriminants::Tee))
        {
            anyhow::bail!("--tee specifier cannot itself contain `tee:` overlays");
        }
        Ok(())
    }

    fn maybe_auto_insert_tee(&mut self) -> anyhow::Result<()> {
        let mut count = 0usize;
        self.stacks.apply_to_all(|x| {
            for ovl in &x.overlays {
                if matches!(ovl, Overlay::Tee { .. }) {
                    count += 1;
                }
            }
            Ok(())
        })?;
        if count == 0 && !self.opts.tee.is_empty() {
            debug!("Auto-inserting tee: overlay");
            self.stacks.right.overlays.push(Overlay::Tee);
        }
        Ok(())
    }

    fn maybe_insert_chunker(&mut self) -> anyhow::Result<()> {
        if self.opts.exec_dup2.is_some() {
            // dup2 mode is speial, it ignores any overlays and directly forwards
            // file desciptor to process. messages vs bytestreams distinction does not matter in this mode.
            return Ok(());
        }

        // use Datagrams copying type (and auto-insert appropriate overlays) if at least one of things expects datagrams.

        let right_typ = self.stacks.right.provides_socket_type();
        let left_typ = self.stacks.left.provides_socket_type();

        if right_typ == SocketType::SocketSender {
            // this type is special; right side will omit SpecifierStack scenario printer completely
            return Ok(());
        }

        let mut working_copying_type = left_typ;
        if right_typ.is_dgrms() {
            working_copying_type = SocketType::Datarams;
        }

        for x in &self.stacks.filter {
            if x.provides_socket_type().is_dgrms() {
                working_copying_type = SocketType::Datarams;
            }
        }
        for x in &self.stacks.filter_reverse {
            if x.provides_socket_type().is_dgrms() {
                working_copying_type = SocketType::Datarams;
            }
        }

        if working_copying_type.is_bstrm() {
            // everything is already ByteStream
            return Ok(());
        }

        let overlay_to_insert = || {
            if self.opts.binary {
                Overlay::StreamChunks
            } else {
                Overlay::LineChunks
            }
        };

        if left_typ.is_bstrm() {
            self.stacks.left.overlays.push(overlay_to_insert());
        }
        if right_typ.is_bstrm() {
            self.stacks.right.overlays.push(overlay_to_insert());
        }

        for x in &mut self.stacks.filter {
            if x.provides_socket_type().is_bstrm() {
                x.overlays.push(overlay_to_insert());
            }
        }
        for x in &mut self.stacks.filter_reverse {
            if x.provides_socket_type().is_bstrm() {
                x.overlays.push(overlay_to_insert());
            }
        }

        let final_left_type = self.stacks.left.provides_socket_type();
        let final_right_type = self.stacks.right.provides_socket_type();
        if final_left_type != final_right_type {
            anyhow::bail!("Socket type mismatch; at the left: {final_left_type:?}, at the right: {final_right_type:?}");
        }
        Ok(())
    }

    fn maybe_insert_reuser(&mut self) {
        if self.session_socket_type() == SocketType::Datarams
            && self.stacks.left.is_multiconn(&self.opts)
            && self.stacks.right.prefers_being_single(&self.opts)
        {
            self.stacks.right.overlays.push(Overlay::SimpleReuser);
        }
    }

    fn maybe_fill_in_tls_details(&mut self, vars: &mut IdentifierGenerator) -> anyhow::Result<()> {
        if let Some(ref d) = self.opts.tls_domain {
            let mut patch_occurred = false;
            for x in self
                .stacks
                .left
                .overlays
                .iter_mut()
                .chain(self.stacks.right.overlays.iter_mut())
            {
                if let Overlay::TlsClient { domain, .. } = x {
                    if domain != d {
                        *domain = d.clone();
                        patch_occurred = true;
                    }
                }
            }
            if !patch_occurred {
                warn!("--tls-domain option did not affect anything");
            }
        }

        let mut need_to_insert_context = false;
        for x in self
            .stacks
            .left
            .overlays
            .iter()
            .chain(self.stacks.right.overlays.iter())
        {
            match x {
                Overlay::TlsClient {
                    varname_for_connector,
                    ..
                } if varname_for_connector.is_empty() => need_to_insert_context = true,
                _ => (),
            }
        }
        if !need_to_insert_context {
            return Ok(());
        }
        let varname_for_connector = vars.getnewvarname("tlsctx");
        let v = varname_for_connector.clone();
        self.beginning.push(PreparatoryAction::CreateTlsConnector {
            varname_for_connector,
        });
        for x in self
            .stacks
            .left
            .overlays
            .iter_mut()
            .chain(self.stacks.right.overlays.iter_mut())
        {
            match x {
                Overlay::TlsClient {
                    varname_for_connector,
                    ..
                } if varname_for_connector.is_empty() => {
                    *varname_for_connector = v.clone();
                }
                _ => (),
            }
        }
        Ok(())
    }
}

struct MyUrlParts {
    auth: Option<Authority>,
    /// just the path part
    newurl: Uri,
}

impl MyUrlParts {
    fn process_url(u: &Uri) -> anyhow::Result<Self> {
        let mut parts = u.clone().into_parts();

        let auth = parts.authority.take();
        if let Some(ref auth) = auth {
            if auth.as_str().contains('@') {
                anyhow::bail!("Usernames in URLs not supported");
            }
        }

        parts.scheme = None;
        let mut newurl = Uri::from_parts(parts).unwrap();

        if newurl.path().is_empty() {
            debug!("Patching empty URL to be /");
            newurl = Uri::from_static("/");
        }
        Ok(MyUrlParts { auth, newurl })
    }
}

impl SpecifierStack {
    fn maybe_splitup_client_ws_endpoint(&mut self) -> anyhow::Result<()> {
        match self.innermost {
            Endpoint::WsUrl(ref u) | Endpoint::WssUrl(ref u) => {
                let MyUrlParts { auth, newurl } = MyUrlParts::process_url(u)?;

                // URI should be checked to be a full one in `fromstr.rs`.
                let auth = auth.unwrap();

                let wss_mode = match self.innermost {
                    Endpoint::WsUrl(_) => false,
                    Endpoint::WssUrl(_) => true,
                    _ => unreachable!(),
                };

                let default_port = if wss_mode { 443 } else { 80 };
                let (mut host, port) = (auth.host(), auth.port_u16().unwrap_or(default_port));

                if host.starts_with('[') && host.ends_with(']') {
                    host = host.strip_prefix('[').unwrap().strip_suffix(']').unwrap();
                }

                let ip: Result<IpAddr, _> = host.parse();

                match ip {
                    Ok(ip) => {
                        let addr = SocketAddr::new(ip, port);

                        self.innermost = Endpoint::TcpConnectByIp(addr);
                    }
                    Err(_) => {
                        self.innermost = Endpoint::TcpConnectByLateHostname {
                            hostname: format!("{host}:{port}"),
                        };
                    }
                };

                self.overlays.insert(
                    0,
                    Overlay::WsUpgrade {
                        uri: newurl,
                        host: Some(auth.to_string()),
                    },
                );
                self.overlays
                    .insert(1, Overlay::WsFramer { client_mode: true });

                if wss_mode {
                    self.overlays.insert(
                        0,
                        Overlay::TlsClient {
                            domain: host.to_owned(),
                            varname_for_connector: String::new(),
                        },
                    );
                }
            }
            _ => (),
        }
        Ok(())
    }

    fn maybe_patch_existing_ws_request(&mut self, opts: &WebsocatArgs) -> anyhow::Result<()> {
        for ovl in &mut self.overlays {
            if let Overlay::WsUpgrade { uri, host } = ovl {
                if let Some(ref ws_c_uri) = opts.ws_c_uri {
                    if uri == "/" && host.is_none() {
                        let ws_c_uri = Uri::try_from(ws_c_uri)?;
                        let MyUrlParts { auth, newurl } = MyUrlParts::process_url(&ws_c_uri)?;
                        *uri = newurl;
                        *host = auth.map(|x| x.to_string());
                    }
                }
            }
        }
        Ok(())
    }

    fn maybe_splitup_ws_c_overlay(&mut self, opts: &WebsocatArgs) -> anyhow::Result<()> {
        let Some((position_to_redact, _)) = self
            .overlays
            .iter()
            .enumerate()
            .find(|(_, ovl)| matches!(ovl, Overlay::WsClient))
        else {
            return Ok(());
        };

        let uri = Uri::try_from(opts.ws_c_uri.as_deref().unwrap_or("/"))?;
        let MyUrlParts { auth, newurl } = MyUrlParts::process_url(&uri)?;

        self.overlays.remove(position_to_redact);
        self.overlays.insert(
            position_to_redact,
            Overlay::WsUpgrade {
                uri: newurl,
                host: auth.map(|x| x.to_string()),
            },
        );
        self.overlays.insert(
            position_to_redact + 1,
            Overlay::WsFramer { client_mode: true },
        );

        Ok(())
    }

    fn maybe_splitup_ws_u_overlay(&mut self, _opts: &WebsocatArgs) -> anyhow::Result<()> {
        let Some((position_to_redact, _)) = self
            .overlays
            .iter()
            .enumerate()
            .find(|(_, ovl)| matches!(ovl, Overlay::WsServer))
        else {
            return Ok(());
        };

        self.overlays.remove(position_to_redact);
        self.overlays
            .insert(position_to_redact, Overlay::WsAccept {});
        self.overlays.insert(
            position_to_redact + 1,
            Overlay::WsFramer { client_mode: false },
        );

        Ok(())
    }

    fn maybe_splitup_server_ws_endpoint(&mut self) -> anyhow::Result<()> {
        if let Endpoint::WsListen(a) = self.innermost {
            self.innermost = Endpoint::TcpListen(a);

            self.overlays.insert(0, Overlay::WsAccept {});
            self.overlays
                .insert(1, Overlay::WsFramer { client_mode: false });
        }
        Ok(())
    }

    fn maybe_early_resolve(
        &mut self,
        beginning: &mut Vec<PreparatoryAction>,
        vars: &mut IdentifierGenerator,
    ) -> anyhow::Result<()> {
        if let Endpoint::TcpConnectByLateHostname { hostname } = &self.innermost {
            let varname_for_addrs = vars.getnewvarname("addrs");
            beginning.push(PreparatoryAction::ResolveHostname {
                hostname: hostname.clone(),
                varname_for_addrs: varname_for_addrs.clone(),
            });
            self.innermost = Endpoint::TcpConnectByEarlyHostname { varname_for_addrs };
        }
        Ok(())
    }

    fn fill_in_log_overlay_type(&mut self) -> anyhow::Result<()> {
        let mut typ = self.innermost.provides_socket_type();
        for ovl in &mut self.overlays {
            match ovl {
                Overlay::Log { datagram_mode } => {
                    *datagram_mode = typ == SocketType::Datarams;
                }
                x => {
                    if let Some(nct) = x.provides_socket_type() {
                        typ = nct
                    }
                }
            }
        }
        Ok(())
    }
    fn infer_mirror_type(&mut self, outer_socket_type: SocketType) -> anyhow::Result<()> {
        let mut resulting_type = outer_socket_type;
        for ovl in self.overlays.iter().rev() {
            if let Some(t) = ovl.requires_socket_type() {
                resulting_type = t;
            }
        }
        if let Endpoint::Mirror { datagram_mode } = &mut self.innermost {
            if resulting_type.is_dgrms() {
                *datagram_mode = true;
            }
        }
        Ok(())
    }

    /// returns true if it was inserted (or `log:` already present)
    fn insert_log_overlay(&mut self) -> bool {
        let mut index = None;
        for (i, ovl) in self.overlays.iter().enumerate() {
            match ovl {
                Overlay::WsUpgrade { .. } => (),
                Overlay::WsAccept { .. } => (),
                Overlay::WsFramer { .. } => (),
                Overlay::TlsClient { .. } => {
                    index = Some(i);
                    break;
                }
                Overlay::StreamChunks => (),
                Overlay::Log { .. } => return true,
                Overlay::LineChunks => (),
                Overlay::WsClient => (),
                Overlay::WsServer => (),
                Overlay::ReadChunkLimiter => (),
                Overlay::WriteChunkLimiter => (),
                Overlay::WriteBuffer => (),
                Overlay::LengthPrefixedChunks => (),
                Overlay::SimpleReuser => (),
                Overlay::WriteSplitoff => (),
                Overlay::Defragment => (),
                Overlay::Tee => (),
            }
        }
        if let Some(i) = index {
            self.overlays.insert(
                i + 1,
                Overlay::Log {
                    datagram_mode: false,
                },
            );
            true
        } else {
            let do_insert = match &self.innermost {
                Endpoint::TcpConnectByEarlyHostname { .. } => true,
                Endpoint::TcpConnectByLateHostname { .. } => true,
                Endpoint::TcpConnectByIp(_) => true,
                Endpoint::TcpListen(_) => true,
                Endpoint::TcpListenFd(_) => true,
                Endpoint::TcpListenFdNamed(_) => true,
                Endpoint::WsUrl(_) => false,
                Endpoint::WssUrl(_) => false,
                Endpoint::WsListen(_) => false,
                Endpoint::Stdio => false,
                Endpoint::UdpConnect(_) => true,
                Endpoint::UdpBind(_) => true,
                Endpoint::UdpFd(_) => true,
                Endpoint::UdpFdNamed(_) => true,
                Endpoint::UdpServer(_) => true,
                Endpoint::UdpServerFd(_) => true,
                Endpoint::UdpServerFdNamed(_) => true,
                Endpoint::Exec(_) => true,
                Endpoint::Cmd(_) => true,
                Endpoint::DummyStream => false,
                Endpoint::DummyDatagrams => false,
                Endpoint::Literal(_) => false,
                Endpoint::LiteralBase64(_) => false,
                Endpoint::UnixConnect(_) => true,
                Endpoint::UnixListen(_) => true,
                Endpoint::AbstractConnect(_) => true,
                Endpoint::AbstractListen(_) => true,
                Endpoint::UnixListenFd(_) => true,
                Endpoint::UnixListenFdNamed(_) => true,
                Endpoint::SeqpacketConnect(_) => true,
                Endpoint::SeqpacketListen(_) => true,
                Endpoint::AbstractSeqpacketConnect(_) => true,
                Endpoint::AbstractSeqpacketListen(_) => true,
                Endpoint::SeqpacketListenFd(_) => true,
                Endpoint::SeqpacketListenFdNamed(_) => true,
                Endpoint::MockStreamSocket(_) => false,
                Endpoint::RegistryStreamListen(_) => false,
                Endpoint::RegistryStreamConnect(_) => false,
                Endpoint::AsyncFd(_) => true,
                Endpoint::SimpleReuserEndpoint(..) => false,
                Endpoint::ReadFile(..) => false,
                Endpoint::WriteFile(..) => false,
                Endpoint::AppendFile(..) => false,
                Endpoint::Random => false,
                Endpoint::Zero => false,
                Endpoint::WriteSplitoff { .. } => false,
                Endpoint::Mirror { .. } => false,
                Endpoint::RegistrySend(_) => false,
                Endpoint::RegistryDatagramListen(_) => false,
                Endpoint::RegistryDatagramConnect(_) => false,
                Endpoint::Tee { .. } => false,
            };
            if do_insert {
                // datagram mode may be patched later
                self.overlays.insert(
                    0,
                    Overlay::Log {
                        datagram_mode: false,
                    },
                )
            }
            do_insert
        }
    }

    fn replace_overlay_with_endpoint(&mut self, index: usize) -> Box<SpecifierStack> {
        let mut switcheroo = Box::new(SpecifierStack {
            innermost: Endpoint::DummyDatagrams, // temporary
            overlays: vec![],                    // temporary
            position: self.position,
        });
        std::mem::swap(self, &mut switcheroo);

        // Preserve overlays specified the one we are replacing
        self.overlays = Vec::from_iter(switcheroo.overlays.drain(index + 1..));
        // Remove the overlay being replaced
        switcheroo.overlays.remove(index);
        switcheroo
    }

    fn maybe_process_reuser(
        &mut self,
        vars: &mut IdentifierGenerator,
        beginnings: &mut Vec<PreparatoryAction>,
    ) -> anyhow::Result<()> {
        let mut the_index = None;
        for (i, ovl) in self.overlays.iter().enumerate() {
            if let Overlay::SimpleReuser = ovl {
                the_index = Some(i);
                break;
            }
        }

        if let Some(i) = the_index {
            let stack_after_reuser = self.replace_overlay_with_endpoint(i);

            let varname = vars.getnewvarname("reuser");
            beginnings.push(PreparatoryAction::CreateSimpleReuserListener {
                varname_for_reuser: varname.clone(),
            });
            self.innermost = Endpoint::SimpleReuserEndpoint(varname, stack_after_reuser);

            // continue substituting other, nested reusers, if any
            self.maybe_process_reuser(vars, beginnings)?;
        }
        Ok(())
    }

    fn maybe_process_writesplitoff(
        &mut self,
        write_splitoff: &mut Option<SpecifierStack>,
        opts: &WebsocatArgs,
    ) -> anyhow::Result<()> {
        let mut the_index = None;
        for (i, ovl) in self.overlays.iter().enumerate() {
            if let Overlay::WriteSplitoff = ovl {
                the_index = Some(i);
                break;
            }
        }

        let Some(the_index) = the_index else {
            return Ok(());
        };
        let Some(write_splitoff_stack) = write_splitoff.take() else {
            anyhow::bail!("`write-splitoff:` overlay specified without accompanying --write-splitoff option or specified multiple times")
        };

        let stack_after_the_splitoff = self.replace_overlay_with_endpoint(the_index);

        let mut read = stack_after_the_splitoff;
        let mut write = Box::new(write_splitoff_stack);

        let chunker_overlay_to_insert = || {
            if opts.binary {
                Overlay::StreamChunks
            } else {
                Overlay::LineChunks
            }
        };

        match (read.provides_socket_type(), write.provides_socket_type()) {
            (SocketType::ByteStream, SocketType::ByteStream) => {}
            (SocketType::ByteStream, SocketType::Datarams) => {
                read.overlays.push(chunker_overlay_to_insert())
            }
            (SocketType::Datarams, SocketType::ByteStream) => {
                write.overlays.push(chunker_overlay_to_insert())
            }
            (SocketType::Datarams, SocketType::Datarams) => {}
            (SocketType::SocketSender, _) | (_, SocketType::SocketSender) => {
                anyhow::bail!("write-splitoff: does not support socketsender socket type")
            }
        }

        self.innermost = Endpoint::WriteSplitoff { read, write };

        // continue processing deeper just to handle possible duplicate errors
        self.maybe_process_writesplitoff(&mut None, opts)?;

        Ok(())
    }

    fn maybe_process_tee(
        &mut self,
        tee: &mut Vec<SpecifierStack>,
        opts: &WebsocatArgs,
    ) -> anyhow::Result<()> {
        let mut the_index = None;
        for (i, ovl) in self.overlays.iter().enumerate() {
            if let Overlay::Tee = ovl {
                the_index = Some(i);
                break;
            }
        }

        let Some(the_index) = the_index else {
            return Ok(());
        };
        if tee.is_empty() {
            warn!("`tee:` overlay specified without accompanying --tee option");
        }

        let stack_after_the_splitoff = self.replace_overlay_with_endpoint(the_index);

        let mut nodes = Vec::with_capacity(tee.len() + 1);

        nodes.push(*stack_after_the_splitoff);
        nodes.append(tee);

        let chunker_overlay_to_insert = || {
            if opts.binary {
                Overlay::StreamChunks
            } else {
                Overlay::LineChunks
            }
        };

        for n in &mut nodes {
            if n.provides_socket_type().is_bstrm() {
                n.overlays.push(chunker_overlay_to_insert());
            }
        }

        self.innermost = Endpoint::Tee { nodes };

        // no need to check for inner `tee:`s, as only one must exist.

        Ok(())
    }

    fn check_required_socket_types(&self, _opts: &WebsocatArgs) -> anyhow::Result<()> {
        enum SocketProvider {
            Endpoint(EndpointDiscriminants),
            Overlay(OverlayDiscriminants),
        }
        impl std::fmt::Debug for SocketProvider {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                match self {
                    Self::Endpoint(x) => x.fmt(f),
                    Self::Overlay(x) => x.fmt(f),
                }
            }
        }

        let mut origin = SocketProvider::Endpoint((&self.innermost).into());
        let mut curtyp = self.innermost.provides_socket_type();

        for ovl in &self.overlays {
            if let Some(rq) = ovl.requires_socket_type() {
                if rq != curtyp {
                    let ovlt: OverlayDiscriminants = ovl.into();
                    anyhow::bail!("{ovlt:?} requires {rq:?} socket type, but {origin:?} provides a {curtyp:?} socket");
                }
            }
            if let Some(pr) = ovl.provides_socket_type() {
                curtyp = pr;
                origin = SocketProvider::Overlay(ovl.into())
            }
        }

        Ok(())
    }
}