vcl-protocol 1.1.0

Cryptographically chained packet transport protocol with SHA-256 integrity, Ed25519 signatures, and XChaCha20-Poly1305 encryption
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
//! # VCL Transport Abstraction
//!
//! Provides a unified [`VCLTransport`] enum that abstracts over TCP, UDP, and WebSocket.
//! This allows [`VCLConnection`] to work with any transport transparently.
//!
//! ## Example
//!
//! ```no_run
//! use vcl_protocol::transport::VCLTransport;
//!
//! #[tokio::main]
//! async fn main() {
//!     // UDP transport
//!     let udp = VCLTransport::bind_udp("127.0.0.1:8080").await.unwrap();
//!
//!     // TCP transport (server)
//!     let tcp = VCLTransport::bind_tcp("127.0.0.1:8081").await.unwrap();
//!
//!     // WebSocket transport (server)
//!     let ws = VCLTransport::bind_ws("127.0.0.1:8082").await.unwrap();
//! }
//! ```
//!
//! [`VCLConnection`]: crate::connection::VCLConnection

use crate::error::VCLError;
use crate::config::{TransportMode, VCLConfig};
use tokio::net::{UdpSocket, TcpListener, TcpStream};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio_tungstenite::{
    accept_async, connect_async,
    tungstenite::Message,
    WebSocketStream, MaybeTlsStream,
};
use futures_util::{SinkExt, StreamExt};
use std::net::SocketAddr;
use tracing::{debug, info};

const UDP_MAX_SIZE: usize = 65535;
const TCP_HEADER_SIZE: usize = 4;

/// Unified transport layer for VCL Protocol.
///
/// Abstracts over UDP, TCP, and WebSocket so that higher-level code
/// does not need to care about the underlying protocol.
///
/// - **UDP** — low latency, no connection state, best for gaming/streaming
/// - **TCP** — reliable, ordered, best for VPN/file transfer
/// - **WebSocket** — browser-compatible, works through HTTP proxies
pub enum VCLTransport {
    /// UDP transport backed by [`tokio::net::UdpSocket`].
    Udp {
        socket: UdpSocket,
        peer_addr: Option<SocketAddr>,
    },
    /// TCP transport backed by [`tokio::net::TcpStream`].
    Tcp {
        stream: TcpStream,
        peer_addr: SocketAddr,
    },
    /// TCP listener — server side, waiting for incoming connections.
    TcpListener {
        listener: TcpListener,
        local_addr: SocketAddr,
    },
    /// WebSocket client connection.
    WebSocketClient {
        stream: WebSocketStream<MaybeTlsStream<TcpStream>>,
        peer_addr: String,
    },
    /// WebSocket server connection (accepted from a listener).
    WebSocketServer {
        stream: WebSocketStream<TcpStream>,
        peer_addr: SocketAddr,
    },
    /// WebSocket listener — server side, waiting for incoming WS connections.
    WebSocketListener {
        listener: TcpListener,
        local_addr: SocketAddr,
    },
}

impl VCLTransport {
    // ─── Constructors ─────────────────────────────────────────────────────────

    /// Bind a UDP socket to a local address.
    pub async fn bind_udp(addr: &str) -> Result<Self, VCLError> {
        let socket = UdpSocket::bind(addr).await?;
        let local = socket.local_addr()
            .map(|a| a.to_string())
            .unwrap_or_else(|_| addr.to_string());
        info!(addr = %local, "UDP transport bound");
        Ok(VCLTransport::Udp { socket, peer_addr: None })
    }

    /// Bind a TCP listener to a local address (server side).
    pub async fn bind_tcp(addr: &str) -> Result<Self, VCLError> {
        let listener = TcpListener::bind(addr).await?;
        let local_addr = listener.local_addr()?;
        info!(addr = %local_addr, "TCP transport bound");
        Ok(VCLTransport::TcpListener { listener, local_addr })
    }

    /// Connect a TCP stream to a remote address (client side).
    pub async fn connect_tcp(addr: &str) -> Result<Self, VCLError> {
        let parsed: SocketAddr = addr.parse()?;
        let stream = TcpStream::connect(parsed).await?;
        let peer_addr = stream.peer_addr()?;
        info!(peer = %peer_addr, "TCP transport connected");
        Ok(VCLTransport::Tcp { stream, peer_addr })
    }

    /// Bind a WebSocket listener to a local address (server side).
    ///
    /// Call [`accept()`](VCLTransport::accept) to wait for an incoming WS connection.
    pub async fn bind_ws(addr: &str) -> Result<Self, VCLError> {
        let listener = TcpListener::bind(addr).await?;
        let local_addr = listener.local_addr()?;
        info!(addr = %local_addr, "WebSocket transport bound");
        Ok(VCLTransport::WebSocketListener { listener, local_addr })
    }

    /// Connect a WebSocket client to a remote URL.
    ///
    /// `url` should be in the form `ws://host:port/path` or `wss://host:port/path`.
    ///
    /// # Example
    /// ```no_run
    /// use vcl_protocol::transport::VCLTransport;
    ///
    /// # async fn example() {
    /// let ws = VCLTransport::connect_ws("ws://127.0.0.1:8082").await.unwrap();
    /// # }
    /// ```
    pub async fn connect_ws(url: &str) -> Result<Self, VCLError> {
        let peer_addr = url.to_string();
        let (stream, _response) = connect_async(url)
            .await
            .map_err(|e| VCLError::IoError(format!("WebSocket connect failed: {}", e)))?;
        info!(url = %url, "WebSocket transport connected");
        Ok(VCLTransport::WebSocketClient { stream, peer_addr })
    }

    /// Accept an incoming connection (server side).
    ///
    /// Works for both [`TcpListener`](VCLTransport::TcpListener) and
    /// [`WebSocketListener`](VCLTransport::WebSocketListener).
    pub async fn accept(&self) -> Result<Self, VCLError> {
        match self {
            VCLTransport::TcpListener { listener, .. } => {
                let (stream, peer_addr) = listener.accept().await?;
                info!(peer = %peer_addr, "TCP connection accepted");
                Ok(VCLTransport::Tcp { stream, peer_addr })
            }
            VCLTransport::WebSocketListener { listener, .. } => {
                let (tcp_stream, peer_addr) = listener.accept().await?;
                let ws_stream = accept_async(tcp_stream)
                    .await
                    .map_err(|e| VCLError::IoError(format!("WebSocket handshake failed: {}", e)))?;
                info!(peer = %peer_addr, "WebSocket connection accepted");
                Ok(VCLTransport::WebSocketServer { stream: ws_stream, peer_addr })
            }
            _ => Err(VCLError::InvalidPacket(
                "accept() called on non-listener transport".to_string(),
            )),
        }
    }

    /// Create the appropriate transport from a [`VCLConfig`] for a client.
    pub async fn from_config_client(
        local_addr: &str,
        peer_addr: &str,
        config: &VCLConfig,
    ) -> Result<Self, VCLError> {
        if config.is_tcp() {
            info!("Config selected TCP transport (client)");
            VCLTransport::connect_tcp(peer_addr).await
        } else {
            info!("Config selected UDP transport (client)");
            VCLTransport::bind_udp(local_addr).await
        }
    }

    /// Create the appropriate transport from a [`VCLConfig`] for a server.
    pub async fn from_config_server(
        local_addr: &str,
        config: &VCLConfig,
    ) -> Result<Self, VCLError> {
        if config.is_tcp() {
            info!("Config selected TCP transport (server)");
            VCLTransport::bind_tcp(local_addr).await
        } else {
            info!("Config selected UDP transport (server)");
            VCLTransport::bind_udp(local_addr).await
        }
    }

    // ─── Send / Recv ──────────────────────────────────────────────────────────

    /// Send raw bytes to the peer.
    ///
    /// - UDP: single datagram to `peer_addr`
    /// - TCP: 4-byte length prefix + data
    /// - WebSocket: binary message
    pub async fn send_raw(&mut self, data: &[u8]) -> Result<(), VCLError> {
        match self {
            VCLTransport::Udp { socket, peer_addr } => {
                let addr = peer_addr.ok_or(VCLError::NoPeerAddress)?;
                socket.send_to(data, addr).await?;
                debug!(peer = %addr, size = data.len(), "UDP send");
                Ok(())
            }
            VCLTransport::Tcp { stream, peer_addr } => {
                let len = data.len() as u32;
                let mut frame = Vec::with_capacity(TCP_HEADER_SIZE + data.len());
                frame.extend_from_slice(&len.to_be_bytes());
                frame.extend_from_slice(data);
                stream.write_all(&frame).await?;
                debug!(peer = %peer_addr, size = data.len(), "TCP send");
                Ok(())
            }
            VCLTransport::WebSocketClient { stream, peer_addr } => {
                stream
                    .send(Message::Binary(data.to_vec()))
                    .await
                    .map_err(|e| VCLError::IoError(format!("WebSocket send failed: {}", e)))?;
                debug!(peer = %peer_addr, size = data.len(), "WebSocket client send");
                Ok(())
            }
            VCLTransport::WebSocketServer { stream, peer_addr } => {
                stream
                    .send(Message::Binary(data.to_vec()))
                    .await
                    .map_err(|e| VCLError::IoError(format!("WebSocket send failed: {}", e)))?;
                debug!(peer = %peer_addr, size = data.len(), "WebSocket server send");
                Ok(())
            }
            VCLTransport::TcpListener { .. } | VCLTransport::WebSocketListener { .. } => {
                Err(VCLError::InvalidPacket(
                    "send_raw() called on listener — call accept() first".to_string(),
                ))
            }
        }
    }

    /// Receive raw bytes from the peer.
    ///
    /// - UDP: single datagram, sets peer address on first receive
    /// - TCP: reads framed message (4-byte length prefix + data)
    /// - WebSocket: reads next binary message (skips ping/pong/text frames)
    ///
    /// Returns `(data, sender_addr_string)`.
    pub async fn recv_raw(&mut self) -> Result<(Vec<u8>, SocketAddr), VCLError> {
        match self {
            VCLTransport::Udp { socket, peer_addr } => {
                let mut buf = vec![0u8; UDP_MAX_SIZE];
                let (len, addr) = socket.recv_from(&mut buf).await?;
                buf.truncate(len);
                if peer_addr.is_none() {
                    *peer_addr = Some(addr);
                }
                debug!(peer = %addr, size = len, "UDP recv");
                Ok((buf, addr))
            }
            VCLTransport::Tcp { stream, peer_addr } => {
                let mut header = [0u8; TCP_HEADER_SIZE];
                stream.read_exact(&mut header).await
                    .map_err(|e| VCLError::IoError(format!("TCP read header: {}", e)))?;
                let msg_len = u32::from_be_bytes(header) as usize;
                if msg_len == 0 || msg_len > UDP_MAX_SIZE {
                    return Err(VCLError::InvalidPacket(format!(
                        "TCP frame length out of range: {}", msg_len
                    )));
                }
                let mut buf = vec![0u8; msg_len];
                stream.read_exact(&mut buf).await
                    .map_err(|e| VCLError::IoError(format!("TCP read body: {}", e)))?;
                debug!(peer = %peer_addr, size = msg_len, "TCP recv");
                Ok((buf, *peer_addr))
            }
            VCLTransport::WebSocketClient { stream, peer_addr } => {
                loop {
                    let msg = stream.next().await
                        .ok_or_else(|| VCLError::IoError("WebSocket stream closed".to_string()))?
                        .map_err(|e| VCLError::IoError(format!("WebSocket recv failed: {}", e)))?;
                    match msg {
                        Message::Binary(data) => {
                            let size = data.len();
                            debug!(peer = %peer_addr, size, "WebSocket client recv");
                            // WebSocket client has no SocketAddr — use 0.0.0.0:0 as placeholder
                            let placeholder: SocketAddr = "0.0.0.0:0".parse().unwrap();
                            return Ok((data, placeholder));
                        }
                        Message::Close(_) => {
                            return Err(VCLError::IoError("WebSocket connection closed".to_string()));
                        }
                        // Skip ping, pong, text frames
                        _ => continue,
                    }
                }
            }
            VCLTransport::WebSocketServer { stream, peer_addr } => {
                loop {
                    let msg = stream.next().await
                        .ok_or_else(|| VCLError::IoError("WebSocket stream closed".to_string()))?
                        .map_err(|e| VCLError::IoError(format!("WebSocket recv failed: {}", e)))?;
                    match msg {
                        Message::Binary(data) => {
                            let size = data.len();
                            debug!(peer = %peer_addr, size, "WebSocket server recv");
                            return Ok((data, *peer_addr));
                        }
                        Message::Close(_) => {
                            return Err(VCLError::IoError("WebSocket connection closed".to_string()));
                        }
                        _ => continue,
                    }
                }
            }
            VCLTransport::TcpListener { .. } | VCLTransport::WebSocketListener { .. } => {
                Err(VCLError::InvalidPacket(
                    "recv_raw() called on listener — call accept() first".to_string(),
                ))
            }
        }
    }

    // ─── Info ─────────────────────────────────────────────────────────────────

    /// Returns the local address this transport is bound to.
    pub fn local_addr(&self) -> Option<SocketAddr> {
        match self {
            VCLTransport::Udp { socket, .. }          => socket.local_addr().ok(),
            VCLTransport::Tcp { stream, .. }           => stream.local_addr().ok(),
            VCLTransport::TcpListener { local_addr, .. } => Some(*local_addr),
            VCLTransport::WebSocketListener { local_addr, .. } => Some(*local_addr),
            VCLTransport::WebSocketServer { peer_addr, .. } => Some(*peer_addr),
            VCLTransport::WebSocketClient { .. }       => None,
        }
    }

    /// Returns the remote peer address if known.
    pub fn peer_addr(&self) -> Option<SocketAddr> {
        match self {
            VCLTransport::Udp { peer_addr, .. }        => *peer_addr,
            VCLTransport::Tcp { peer_addr, .. }        => Some(*peer_addr),
            VCLTransport::WebSocketServer { peer_addr, .. } => Some(*peer_addr),
            VCLTransport::TcpListener { .. }
            | VCLTransport::WebSocketListener { .. }
            | VCLTransport::WebSocketClient { .. }     => None,
        }
    }

    /// Set the peer address for UDP transport.
    pub fn set_peer_addr(&mut self, addr: SocketAddr) {
        if let VCLTransport::Udp { peer_addr, .. } = self {
            *peer_addr = Some(addr);
        }
    }

    /// Returns the [`TransportMode`] of this transport.
    pub fn mode(&self) -> TransportMode {
        match self {
            VCLTransport::Udp { .. } => TransportMode::Udp,
            VCLTransport::Tcp { .. }
            | VCLTransport::TcpListener { .. } => TransportMode::Tcp,
            VCLTransport::WebSocketClient { .. }
            | VCLTransport::WebSocketServer { .. }
            | VCLTransport::WebSocketListener { .. } => TransportMode::Tcp,
        }
    }

    /// Returns `true` if this is a TCP transport.
    pub fn is_tcp(&self) -> bool {
        matches!(
            self,
            VCLTransport::Tcp { .. } | VCLTransport::TcpListener { .. }
        )
    }

    /// Returns `true` if this is a UDP transport.
    pub fn is_udp(&self) -> bool {
        matches!(self, VCLTransport::Udp { .. })
    }

    /// Returns `true` if this is a WebSocket transport.
    pub fn is_websocket(&self) -> bool {
        matches!(
            self,
            VCLTransport::WebSocketClient { .. }
                | VCLTransport::WebSocketServer { .. }
                | VCLTransport::WebSocketListener { .. }
        )
    }
}

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

    #[tokio::test]
    async fn test_udp_bind() {
        let t = VCLTransport::bind_udp("127.0.0.1:0").await.unwrap();
        assert!(t.is_udp());
        assert!(!t.is_tcp());
        assert!(!t.is_websocket());
        assert!(t.local_addr().is_some());
        assert!(t.peer_addr().is_none());
    }

    #[tokio::test]
    async fn test_tcp_bind() {
        let t = VCLTransport::bind_tcp("127.0.0.1:0").await.unwrap();
        assert!(t.is_tcp());
        assert!(!t.is_udp());
        assert!(!t.is_websocket());
        assert!(t.local_addr().is_some());
    }

    #[tokio::test]
    async fn test_ws_bind() {
        let t = VCLTransport::bind_ws("127.0.0.1:0").await.unwrap();
        assert!(t.is_websocket());
        assert!(!t.is_udp());
        assert!(!t.is_tcp());
        assert!(t.local_addr().is_some());
    }

    #[tokio::test]
    async fn test_udp_send_recv() {
        let mut server = VCLTransport::bind_udp("127.0.0.1:0").await.unwrap();
        let server_addr = server.local_addr().unwrap();
        let mut client = VCLTransport::bind_udp("127.0.0.1:0").await.unwrap();
        client.set_peer_addr(server_addr);
        client.send_raw(b"hello vcl").await.unwrap();
        let (data, _) = server.recv_raw().await.unwrap();
        assert_eq!(data, b"hello vcl");
    }

    #[tokio::test]
    async fn test_tcp_send_recv() {
        let server_listener = VCLTransport::bind_tcp("127.0.0.1:0").await.unwrap();
        let server_addr = server_listener.local_addr().unwrap().to_string();
        let (server_result, client_result) = tokio::join!(
            server_listener.accept(),
            VCLTransport::connect_tcp(&server_addr),
        );
        let mut server_conn = server_result.unwrap();
        let mut client_conn = client_result.unwrap();
        client_conn.send_raw(b"hello tcp vcl").await.unwrap();
        let (data, _) = server_conn.recv_raw().await.unwrap();
        assert_eq!(data, b"hello tcp vcl");
    }

    #[tokio::test]
    async fn test_tcp_multiple_messages() {
        let server_listener = VCLTransport::bind_tcp("127.0.0.1:0").await.unwrap();
        let server_addr = server_listener.local_addr().unwrap().to_string();
        let (server_result, client_result) = tokio::join!(
            server_listener.accept(),
            VCLTransport::connect_tcp(&server_addr),
        );
        let mut server_conn = server_result.unwrap();
        let mut client_conn = client_result.unwrap();
        for i in 0..5u8 {
            let msg = vec![i; 100];
            client_conn.send_raw(&msg).await.unwrap();
            let (data, _) = server_conn.recv_raw().await.unwrap();
            assert_eq!(data, msg);
        }
    }

    #[tokio::test]
    async fn test_ws_send_recv() {
        let server_listener = VCLTransport::bind_ws("127.0.0.1:0").await.unwrap();
        let server_addr = format!("ws://{}", server_listener.local_addr().unwrap());
        let (server_result, client_result) = tokio::join!(
            server_listener.accept(),
            VCLTransport::connect_ws(&server_addr),
        );
        let mut server_conn = server_result.unwrap();
        let mut client_conn = client_result.unwrap();
        client_conn.send_raw(b"hello websocket vcl").await.unwrap();
        let (data, _) = server_conn.recv_raw().await.unwrap();
        assert_eq!(data, b"hello websocket vcl");
    }

    #[tokio::test]
    async fn test_ws_multiple_messages() {
        let server_listener = VCLTransport::bind_ws("127.0.0.1:0").await.unwrap();
        let server_addr = format!("ws://{}", server_listener.local_addr().unwrap());
        let (server_result, client_result) = tokio::join!(
            server_listener.accept(),
            VCLTransport::connect_ws(&server_addr),
        );
        let mut server_conn = server_result.unwrap();
        let mut client_conn = client_result.unwrap();
        for i in 0..5u8 {
            let msg = vec![i; 200];
            client_conn.send_raw(&msg).await.unwrap();
            let (data, _) = server_conn.recv_raw().await.unwrap();
            assert_eq!(data, msg);
        }
    }

    #[tokio::test]
    async fn test_from_config_udp() {
        let config = VCLConfig::gaming();
        let t = VCLTransport::from_config_server("127.0.0.1:0", &config).await.unwrap();
        assert!(t.is_udp());
    }

    #[tokio::test]
    async fn test_from_config_tcp() {
        let config = VCLConfig::vpn();
        let t = VCLTransport::from_config_server("127.0.0.1:0", &config).await.unwrap();
        assert!(t.is_tcp());
    }

    #[tokio::test]
    async fn test_mode() {
        let udp = VCLTransport::bind_udp("127.0.0.1:0").await.unwrap();
        assert_eq!(udp.mode(), TransportMode::Udp);
        let tcp = VCLTransport::bind_tcp("127.0.0.1:0").await.unwrap();
        assert_eq!(tcp.mode(), TransportMode::Tcp);
        let ws = VCLTransport::bind_ws("127.0.0.1:0").await.unwrap();
        assert_eq!(ws.mode(), TransportMode::Tcp);
    }

    #[tokio::test]
    async fn test_set_peer_addr() {
        let mut t = VCLTransport::bind_udp("127.0.0.1:0").await.unwrap();
        assert!(t.peer_addr().is_none());
        let addr: SocketAddr = "127.0.0.1:9999".parse().unwrap();
        t.set_peer_addr(addr);
        assert_eq!(t.peer_addr(), Some(addr));
    }
}