zsh 0.8.11

Zsh interpreter and parser in Rust
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
//! TCP networking module - port of Modules/tcp.c
//!
//! Provides ztcp builtin for TCP socket operations.

use std::collections::HashMap;
use std::io::{self};
use std::net::{IpAddr, Ipv4Addr, SocketAddr, TcpListener, TcpStream, ToSocketAddrs};
use std::os::unix::io::{AsRawFd, FromRawFd, RawFd};

/// TCP session flags
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TcpSessionType {
    Outbound,
    Inbound,
    Listen,
}

/// A TCP session
#[derive(Debug)]
pub struct TcpSession {
    pub fd: RawFd,
    pub session_type: TcpSessionType,
    pub local_addr: Option<SocketAddr>,
    pub peer_addr: Option<SocketAddr>,
    pub is_zftp: bool,
}

impl TcpSession {
    pub fn new(fd: RawFd, session_type: TcpSessionType) -> Self {
        Self {
            fd,
            session_type,
            local_addr: None,
            peer_addr: None,
            is_zftp: false,
        }
    }

    pub fn type_char(&self) -> char {
        if self.is_zftp {
            'Z'
        } else {
            match self.session_type {
                TcpSessionType::Listen => 'L',
                TcpSessionType::Inbound => 'I',
                TcpSessionType::Outbound => 'O',
            }
        }
    }

    pub fn direction_str(&self) -> &'static str {
        match self.session_type {
            TcpSessionType::Listen => "-<",
            TcpSessionType::Inbound => "<-",
            TcpSessionType::Outbound => "->",
        }
    }
}

/// TCP sessions manager
#[derive(Debug, Default)]
pub struct TcpSessions {
    sessions: HashMap<RawFd, TcpSession>,
}

impl TcpSessions {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add(&mut self, session: TcpSession) {
        self.sessions.insert(session.fd, session);
    }

    pub fn get(&self, fd: RawFd) -> Option<&TcpSession> {
        self.sessions.get(&fd)
    }

    pub fn get_by_ref(&self, fd: &RawFd) -> Option<&TcpSession> {
        self.sessions.get(fd)
    }

    pub fn get_mut(&mut self, fd: RawFd) -> Option<&mut TcpSession> {
        self.sessions.get_mut(&fd)
    }

    pub fn remove(&mut self, fd: RawFd) -> Option<TcpSession> {
        self.sessions.remove(&fd)
    }

    pub fn iter(&self) -> impl Iterator<Item = (&RawFd, &TcpSession)> {
        self.sessions.iter()
    }

    pub fn close_all(&mut self) {
        for (fd, _) in self.sessions.drain() {
            let _ = close_fd(fd);
        }
    }

    pub fn len(&self) -> usize {
        self.sessions.len()
    }

    pub fn is_empty(&self) -> bool {
        self.sessions.is_empty()
    }
}

fn close_fd(fd: RawFd) -> io::Result<()> {
    #[cfg(unix)]
    {
        let result = unsafe { libc::close(fd) };
        if result < 0 {
            Err(io::Error::last_os_error())
        } else {
            Ok(())
        }
    }
    #[cfg(not(unix))]
    {
        Ok(())
    }
}

/// Options for ztcp builtin
#[derive(Debug, Default)]
pub struct ZtcpOptions {
    pub close: bool,
    pub listen: bool,
    pub accept: bool,
    pub force: bool,
    pub verbose: bool,
    pub test: bool,
    pub list_format: bool,
    pub target_fd: Option<RawFd>,
}

/// Connect to a TCP host
pub fn tcp_connect(host: &str, port: u16) -> io::Result<(RawFd, SocketAddr, SocketAddr)> {
    let addr_str = format!("{}:{}", host, port);
    let addrs: Vec<SocketAddr> = addr_str.to_socket_addrs()?.collect();

    if addrs.is_empty() {
        return Err(io::Error::new(
            io::ErrorKind::NotFound,
            "host resolution failure",
        ));
    }

    for addr in addrs {
        match TcpStream::connect(addr) {
            Ok(stream) => {
                let local = stream.local_addr()?;
                let peer = stream.peer_addr()?;
                let fd = stream.as_raw_fd();
                std::mem::forget(stream);
                return Ok((fd, local, peer));
            }
            Err(_) => continue,
        }
    }

    Err(io::Error::new(
        io::ErrorKind::ConnectionRefused,
        "connection failed",
    ))
}

/// Create a listening TCP socket
pub fn tcp_listen(port: u16) -> io::Result<(RawFd, SocketAddr)> {
    let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), port);
    let listener = TcpListener::bind(addr)?;
    let local = listener.local_addr()?;
    let fd = listener.as_raw_fd();
    std::mem::forget(listener);
    Ok((fd, local))
}

/// Accept a connection on a listening socket
pub fn tcp_accept(listen_fd: RawFd) -> io::Result<(RawFd, SocketAddr, SocketAddr)> {
    let listener = unsafe { TcpListener::from_raw_fd(listen_fd) };
    let result = listener.accept();
    std::mem::forget(listener);

    let (stream, peer) = result?;
    let local = stream.local_addr()?;
    let fd = stream.as_raw_fd();
    std::mem::forget(stream);
    Ok((fd, local, peer))
}

/// Check if a socket has pending connections (for -t option)
pub fn tcp_test_accept(listen_fd: RawFd) -> io::Result<bool> {
    #[cfg(unix)]
    {
        let mut pfd = libc::pollfd {
            fd: listen_fd,
            events: libc::POLLIN,
            revents: 0,
        };

        let result = unsafe { libc::poll(&mut pfd, 1, 0) };
        if result < 0 {
            Err(io::Error::last_os_error())
        } else {
            Ok(result > 0)
        }
    }

    #[cfg(not(unix))]
    {
        Ok(true)
    }
}

/// Close a TCP session
pub fn tcp_close(sessions: &mut TcpSessions, fd: RawFd, force: bool) -> Result<(), String> {
    if let Some(session) = sessions.get(fd) {
        if session.is_zftp && !force {
            return Err("use -f to force closure of a zftp control connection".to_string());
        }
    }

    if let Some(_session) = sessions.remove(fd) {
        close_fd(fd).map_err(|e| format!("connection close failed: {}", e))?;
        Ok(())
    } else {
        Err(format!("fd {} not found in tcp table", fd))
    }
}

/// Resolve a service name to port number
pub fn resolve_port(service: &str) -> Option<u16> {
    if let Ok(port) = service.parse::<u16>() {
        return Some(port);
    }

    #[cfg(unix)]
    {
        use std::ffi::CString;
        let service_c = CString::new(service).ok()?;
        let proto_c = CString::new("tcp").ok()?;

        unsafe {
            let serv = libc::getservbyname(service_c.as_ptr(), proto_c.as_ptr());
            if serv.is_null() {
                None
            } else {
                Some(u16::from_be((*serv).s_port as u16))
            }
        }
    }

    #[cfg(not(unix))]
    {
        None
    }
}

/// Resolve hostname to IP address
pub fn resolve_host(host: &str) -> io::Result<IpAddr> {
    if let Ok(ip) = host.parse::<IpAddr>() {
        return Ok(ip);
    }

    let addrs: Vec<SocketAddr> = format!("{}:0", host).to_socket_addrs()?.collect();
    addrs
        .first()
        .map(|a| a.ip())
        .ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "host resolution failure"))
}

/// Reverse DNS lookup
pub fn reverse_lookup(addr: &IpAddr) -> Option<String> {
    let socket_addr = SocketAddr::new(*addr, 0);
    let hostname = dns_lookup_reverse(&socket_addr);
    hostname
}

fn dns_lookup_reverse(_addr: &SocketAddr) -> Option<String> {
    None
}

/// Format a socket address for display
pub fn format_addr(addr: &SocketAddr, resolve: bool) -> String {
    if resolve {
        if let Some(hostname) = reverse_lookup(&addr.ip()) {
            return format!("{}:{}", hostname, addr.port());
        }
    }
    format!("{}:{}", addr.ip(), addr.port())
}

/// Execute ztcp builtin
pub fn builtin_ztcp(
    args: &[&str],
    options: &ZtcpOptions,
    sessions: &mut TcpSessions,
) -> (i32, String) {
    let mut output = String::new();

    if options.close {
        if args.is_empty() {
            sessions.close_all();
            return (0, output);
        }

        let fd: RawFd = match args[0].parse() {
            Ok(fd) => fd,
            Err(_) => {
                return (
                    1,
                    format!("ztcp: {} is an invalid argument to -c\n", args[0]),
                );
            }
        };

        match tcp_close(sessions, fd, options.force) {
            Ok(()) => (0, output),
            Err(e) => (1, format!("ztcp: {}\n", e)),
        }
    } else if options.listen {
        if args.is_empty() {
            return (1, "ztcp: -l requires an argument\n".to_string());
        }

        let port = match resolve_port(args[0]) {
            Some(p) => p,
            None => {
                return (1, "ztcp: bad service name or port number\n".to_string());
            }
        };

        match tcp_listen(port) {
            Ok((fd, local)) => {
                let mut session = TcpSession::new(fd, TcpSessionType::Listen);
                session.local_addr = Some(local);
                let result_fd = options.target_fd.unwrap_or(fd);
                session.fd = result_fd;
                sessions.add(session);

                if options.verbose {
                    output.push_str(&format!("{} listener is on fd {}\n", port, result_fd));
                }
                (0, output)
            }
            Err(e) => (1, format!("ztcp: could not listen: {}\n", e)),
        }
    } else if options.accept {
        if args.is_empty() {
            return (1, "ztcp: -a requires an argument\n".to_string());
        }

        let listen_fd: RawFd = match args[0].parse() {
            Ok(fd) => fd,
            Err(_) => {
                return (1, "ztcp: invalid numerical argument\n".to_string());
            }
        };

        if let Some(session) = sessions.get(listen_fd) {
            if session.session_type != TcpSessionType::Listen {
                return (1, "ztcp: tcp connection not a listener\n".to_string());
            }
        } else {
            return (
                1,
                format!(
                    "ztcp: fd {} is not registered as a tcp connection\n",
                    args[0]
                ),
            );
        }

        if options.test {
            match tcp_test_accept(listen_fd) {
                Ok(true) => {}
                Ok(false) => return (1, output),
                Err(e) => return (1, format!("ztcp: poll error: {}\n", e)),
            }
        }

        match tcp_accept(listen_fd) {
            Ok((fd, local, peer)) => {
                let mut session = TcpSession::new(fd, TcpSessionType::Inbound);
                session.local_addr = Some(local);
                session.peer_addr = Some(peer);
                let result_fd = options.target_fd.unwrap_or(fd);
                session.fd = result_fd;
                sessions.add(session);

                if options.verbose {
                    output.push_str(&format!("{} is on fd {}\n", peer.port(), result_fd));
                }
                (0, output)
            }
            Err(e) => (1, format!("ztcp: could not accept connection: {}\n", e)),
        }
    } else if args.is_empty() {
        for (_, session) in sessions.iter() {
            let local_str = session
                .local_addr
                .map(|a| format_addr(&a, true))
                .unwrap_or_else(|| "?:?".to_string());
            let peer_str = session
                .peer_addr
                .map(|a| format_addr(&a, true))
                .unwrap_or_else(|| "?:?".to_string());

            if options.list_format {
                output.push_str(&format!(
                    "{} {} {} {} {} {}\n",
                    session.fd,
                    session.type_char(),
                    session
                        .local_addr
                        .map(|a| a.ip().to_string())
                        .unwrap_or_default(),
                    session.local_addr.map(|a| a.port()).unwrap_or(0),
                    session
                        .peer_addr
                        .map(|a| a.ip().to_string())
                        .unwrap_or_default(),
                    session.peer_addr.map(|a| a.port()).unwrap_or(0),
                ));
            } else {
                let zftp_str = if session.is_zftp { " ZFTP" } else { "" };
                output.push_str(&format!(
                    "{} {} {} is on fd {}{}\n",
                    local_str,
                    session.direction_str(),
                    peer_str,
                    session.fd,
                    zftp_str,
                ));
            }
        }
        (0, output)
    } else {
        let host = args[0];
        let port = if args.len() > 1 {
            resolve_port(args[1]).unwrap_or(23)
        } else {
            23
        };

        match tcp_connect(host, port) {
            Ok((fd, local, peer)) => {
                let mut session = TcpSession::new(fd, TcpSessionType::Outbound);
                session.local_addr = Some(local);
                session.peer_addr = Some(peer);
                let result_fd = options.target_fd.unwrap_or(fd);
                session.fd = result_fd;
                sessions.add(session);

                if options.verbose {
                    output.push_str(&format!("{}:{} is now on fd {}\n", host, port, result_fd));
                }
                (0, output)
            }
            Err(e) => (1, format!("ztcp: connection failed: {}\n", e)),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::Ipv6Addr;

    #[test]
    fn test_tcp_session_type_char() {
        let session = TcpSession::new(3, TcpSessionType::Outbound);
        assert_eq!(session.type_char(), 'O');

        let session = TcpSession::new(3, TcpSessionType::Inbound);
        assert_eq!(session.type_char(), 'I');

        let session = TcpSession::new(3, TcpSessionType::Listen);
        assert_eq!(session.type_char(), 'L');

        let mut session = TcpSession::new(3, TcpSessionType::Outbound);
        session.is_zftp = true;
        assert_eq!(session.type_char(), 'Z');
    }

    #[test]
    fn test_tcp_session_direction() {
        let session = TcpSession::new(3, TcpSessionType::Outbound);
        assert_eq!(session.direction_str(), "->");

        let session = TcpSession::new(3, TcpSessionType::Inbound);
        assert_eq!(session.direction_str(), "<-");

        let session = TcpSession::new(3, TcpSessionType::Listen);
        assert_eq!(session.direction_str(), "-<");
    }

    #[test]
    fn test_tcp_sessions_manager() {
        let mut sessions = TcpSessions::new();
        assert!(sessions.is_empty());

        let session = TcpSession::new(5, TcpSessionType::Outbound);
        sessions.add(session);
        assert_eq!(sessions.len(), 1);

        assert!(sessions.get(5).is_some());
        assert!(sessions.get(6).is_none());

        sessions.remove(5);
        assert!(sessions.is_empty());
    }

    #[test]
    fn test_resolve_port() {
        assert_eq!(resolve_port("80"), Some(80));
        assert_eq!(resolve_port("443"), Some(443));
        assert_eq!(resolve_port("invalid"), None);
    }

    #[test]
    fn test_resolve_host() {
        let ip = resolve_host("127.0.0.1").unwrap();
        assert_eq!(ip, IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

        let ip = resolve_host("::1").unwrap();
        assert_eq!(ip, IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));
    }

    #[test]
    fn test_format_addr() {
        let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
        let formatted = format_addr(&addr, false);
        assert_eq!(formatted, "127.0.0.1:8080");
    }

    #[test]
    fn test_builtin_ztcp_list_empty() {
        let mut sessions = TcpSessions::new();
        let options = ZtcpOptions::default();
        let (status, output) = builtin_ztcp(&[], &options, &mut sessions);
        assert_eq!(status, 0);
        assert!(output.is_empty());
    }

    #[test]
    fn test_builtin_ztcp_close_all() {
        let mut sessions = TcpSessions::new();
        let options = ZtcpOptions {
            close: true,
            ..Default::default()
        };
        let (status, _) = builtin_ztcp(&[], &options, &mut sessions);
        assert_eq!(status, 0);
    }

    #[test]
    fn test_builtin_ztcp_listen_no_arg() {
        let mut sessions = TcpSessions::new();
        let options = ZtcpOptions {
            listen: true,
            ..Default::default()
        };
        let (status, output) = builtin_ztcp(&[], &options, &mut sessions);
        assert_eq!(status, 1);
        assert!(output.contains("requires an argument"));
    }

    #[test]
    fn test_builtin_ztcp_accept_no_arg() {
        let mut sessions = TcpSessions::new();
        let options = ZtcpOptions {
            accept: true,
            ..Default::default()
        };
        let (status, output) = builtin_ztcp(&[], &options, &mut sessions);
        assert_eq!(status, 1);
        assert!(output.contains("requires an argument"));
    }
}