cloudpub-common 3.0.2

Common code for the client, server, and GUI
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
use core::result::Result;
use std::io::{Error, ErrorKind};
#[cfg(unix)]
use std::os::fd::AsRawFd;
use std::pin::Pin;
use std::task::{ready, Context, Poll};

use super::{
    AddrMaybeCached, Listener, NamedSocketAddr, ProtobufStream, SocketAddr, SocketOpts, Stream,
    TcpTransport, Transport,
};
use crate::config::TransportConfig;
use crate::constants::MESSAGE_TIMEOUT_SECS;
use anyhow::{anyhow, Context as _};
use async_trait::async_trait;
use bytes::{Bytes, BytesMut};
use futures_core::stream::Stream as AsyncStream;
use std::time::Duration;
use tokio::io::{AsyncBufRead, AsyncRead, AsyncWrite, ReadBuf};
use tokio::time::timeout;

use crate::utils::trace_message;
use dashmap::DashMap;
#[cfg(unix)]
use std::os::fd::RawFd;
use std::sync::Arc;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::handshake::server::{Request, Response};
use tokio_tungstenite::tungstenite::protocol::{Message, WebSocketConfig};
use tokio_tungstenite::{accept_hdr_async_with_config, client_async_with_config, WebSocketStream};
use tokio_util::io::StreamReader;
use tracing::{debug, error, trace};

use futures_util::sink::{Sink, SinkExt};
use futures_util::stream::StreamExt;

#[cfg(feature = "rustls")]
use super::tls::{get_stream, TlsStream, TlsTransport};

use crate::protocol::message::Message as ProtocolMessage;
use crate::protocol::ProstMessage;

#[derive(Debug)]
enum TransportStream {
    Insecure(Stream),
    #[cfg(feature = "rustls")]
    Secure(Box<TlsStream<Stream>>),
}

impl TransportStream {
    fn get_tcpstream(&self) -> &Stream {
        match self {
            TransportStream::Insecure(s) => s,
            #[cfg(feature = "rustls")]
            TransportStream::Secure(s) => get_stream(s.as_ref()),
        }
    }
}

impl AsyncRead for TransportStream {
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
        match self.get_mut() {
            TransportStream::Insecure(s) => Pin::new(s).poll_read(cx, buf),
            #[cfg(feature = "rustls")]
            TransportStream::Secure(s) => Pin::new(s.as_mut()).poll_read(cx, buf),
        }
    }
}

impl AsyncWrite for TransportStream {
    fn poll_write(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, std::io::Error>> {
        match self.get_mut() {
            TransportStream::Insecure(s) => Pin::new(s).poll_write(cx, buf),
            #[cfg(feature = "rustls")]
            TransportStream::Secure(s) => Pin::new(s.as_mut()).poll_write(cx, buf),
        }
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), std::io::Error>> {
        match self.get_mut() {
            TransportStream::Insecure(s) => Pin::new(s).poll_flush(cx),
            #[cfg(feature = "rustls")]
            TransportStream::Secure(s) => Pin::new(s.as_mut()).poll_flush(cx),
        }
    }

    fn poll_shutdown(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), std::io::Error>> {
        match self.get_mut() {
            TransportStream::Insecure(s) => Pin::new(s).poll_shutdown(cx),
            #[cfg(feature = "rustls")]
            TransportStream::Secure(s) => Pin::new(s.as_mut()).poll_shutdown(cx),
        }
    }
}

#[derive(Debug)]
struct StreamWrapper {
    inner: WebSocketStream<TransportStream>,
}

#[async_trait]
impl ProtobufStream for StreamWrapper {
    async fn recv_message(&mut self) -> anyhow::Result<Option<ProtocolMessage>> {
        let timeout_duration = Duration::from_secs(MESSAGE_TIMEOUT_SECS);
        let result = timeout(timeout_duration, self.inner.next()).await;

        match result {
            Err(_) => Err(anyhow!(
                "Timeout reading message after {} seconds",
                MESSAGE_TIMEOUT_SECS
            )),
            Ok(msg_result) => match msg_result {
                Some(Ok(Message::Binary(b))) => {
                    let msg = crate::protocol::Message::decode(b.as_ref())
                        .context("Failed to decode protobuf message")?;
                    let msg = msg
                        .message
                        .context("Message field is missing in the protobuf message")?;
                    trace_message("Recv", &msg);
                    Ok(Some(msg))
                }
                Some(Ok(Message::Close(_))) => {
                    debug!("WebSocket connection closed");
                    Ok(None)
                }
                Some(Ok(Message::Ping(data))) => {
                    debug!("Received ping, sending pong");
                    self.inner
                        .send(Message::Pong(data))
                        .await
                        .context("Failed to send pong")?;
                    Ok(None)
                }
                Some(Ok(Message::Pong(_))) => {
                    debug!("Received pong");
                    Ok(None)
                }
                Some(Ok(Message::Text(_))) => {
                    error!("Received unexpected text message");
                    Err(anyhow!("Unexpected text message received"))
                }
                Some(Ok(m)) => {
                    error!("Received unexpected  message: {:?}", m);
                    Err(anyhow!("Unexpected  message received"))
                }
                None => Ok(None),
                Some(Err(e)) => Err(anyhow!("WebSocket error: {}", e)),
            },
        }
    }

    async fn send_message(
        &mut self,
        msg: &crate::protocol::message::Message,
    ) -> anyhow::Result<()> {
        trace_message("Send", msg);
        let mut buf = BytesMut::new();
        let msg = crate::protocol::Message {
            message: Some(msg.clone()),
        };
        msg.encode(&mut buf)
            .context("Failed to encode protobuf message")?;

        let timeout_duration = Duration::from_secs(MESSAGE_TIMEOUT_SECS);
        timeout(
            timeout_duration,
            self.inner.send(Message::Binary(buf.into())),
        )
        .await
        .map_err(|_| {
            anyhow::anyhow!(
                "Timeout writing message after {} seconds",
                MESSAGE_TIMEOUT_SECS
            )
        })?
        .context("Failed to send WebSocket message")?;
        Ok(())
    }

    async fn close(&mut self) -> anyhow::Result<()> {
        debug!("Closing WebSocket connection");
        self.inner
            .close(None)
            .await
            .context("Failed to close WebSocket stream")
    }
}

impl AsyncStream for StreamWrapper {
    type Item = Result<Bytes, Error>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        match Pin::new(&mut self.get_mut().inner).poll_next(cx) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(None) => Poll::Ready(None),
            Poll::Ready(Some(Err(err))) => Poll::Ready(Some(Err(Error::other(err)))),
            Poll::Ready(Some(Ok(res))) => {
                if let Message::Binary(b) = res {
                    Poll::Ready(Some(Ok(b)))
                } else {
                    Poll::Ready(Some(Err(Error::new(
                        ErrorKind::InvalidData,
                        "unexpected frame",
                    ))))
                }
            }
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner.size_hint()
    }
}

#[derive(Debug)]
pub struct WebsocketStream {
    inner: StreamReader<StreamWrapper, Bytes>,
}

impl AsyncRead for WebsocketStream {
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
        Pin::new(&mut self.get_mut().inner).poll_read(cx, buf)
    }
}

impl AsyncBufRead for WebsocketStream {
    fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<std::io::Result<&[u8]>> {
        Pin::new(&mut self.get_mut().inner).poll_fill_buf(cx)
    }

    fn consume(self: Pin<&mut Self>, amt: usize) {
        Pin::new(&mut self.get_mut().inner).consume(amt)
    }
}

impl AsyncWrite for WebsocketStream {
    fn poll_write(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<Result<usize, std::io::Error>> {
        let sw = self.get_mut().inner.get_mut();
        ready!(Pin::new(&mut sw.inner).poll_ready(cx).map_err(Error::other))?;

        let bbuf = BytesMut::from(buf);

        match Pin::new(&mut sw.inner).start_send(Message::Binary(bbuf.into())) {
            Ok(()) => Poll::Ready(Ok(buf.len())),
            Err(e) => Poll::Ready(Err(Error::other(e))),
        }
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Error>> {
        Pin::new(&mut self.get_mut().inner.get_mut().inner)
            .poll_flush(cx)
            .map_err(Error::other)
    }

    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Error>> {
        Pin::new(&mut self.get_mut().inner.get_mut().inner)
            .poll_close(cx)
            .map_err(Error::other)
    }
}

#[async_trait]
impl ProtobufStream for WebsocketStream {
    async fn recv_message(&mut self) -> anyhow::Result<Option<ProtocolMessage>> {
        self.inner.get_mut().recv_message().await
    }

    async fn send_message(&mut self, msg: &ProtocolMessage) -> anyhow::Result<()> {
        self.inner.get_mut().send_message(msg).await
    }

    async fn close(&mut self) -> anyhow::Result<()> {
        debug!("Closing WebSocket stream");
        self.inner.get_mut().close().await
    }
}

#[derive(Debug)]
enum SubTransport {
    #[cfg(feature = "rustls")]
    Secure(TlsTransport),
    Insecure(TcpTransport),
}

#[derive(Debug)]
pub struct WebsocketTransport {
    sub: SubTransport,
    conf: WebSocketConfig,
    headers: Arc<DashMap<String, String>>,
}

#[async_trait]
impl Transport for WebsocketTransport {
    type Acceptor = Listener;
    type RawStream = Stream;
    type Stream = WebsocketStream;

    fn new(config: &TransportConfig) -> anyhow::Result<Self> {
        let wsconfig = config
            .websocket
            .as_ref()
            .ok_or_else(|| anyhow!("Missing websocket config"))?;

        let conf = WebSocketConfig::default().write_buffer_size(0);

        let sub = match wsconfig.tls {
            #[cfg(feature = "rustls")]
            true => SubTransport::Secure(TlsTransport::new(config)?),
            #[cfg(not(feature = "rustls"))]
            true => unreachable!("TLS support not enabled"),
            false => SubTransport::Insecure(TcpTransport::new(config)?),
        };
        let headers = Arc::new(DashMap::new());
        Ok(WebsocketTransport { sub, conf, headers })
    }

    fn hint(conn: &Self::Stream, opt: SocketOpts) {
        opt.apply(conn.inner.get_ref().inner.get_ref().get_tcpstream())
    }

    #[cfg(unix)]
    fn as_raw_fd(conn: &Self::Stream) -> RawFd {
        match conn.inner.get_ref().inner.get_ref().get_tcpstream() {
            Stream::Tcp(tcp_stream) => tcp_stream.as_raw_fd(),
            Stream::Unix(unix_stream) => unix_stream.as_raw_fd(),
        }
    }

    async fn bind(&self, addr: NamedSocketAddr) -> anyhow::Result<Self::Acceptor> {
        Listener::bind(&addr).await.map_err(Into::into)
    }

    async fn accept(&self, a: &Self::Acceptor) -> anyhow::Result<(Self::RawStream, SocketAddr)> {
        let (s, addr) = match &self.sub {
            SubTransport::Insecure(t) => t.accept(a).await?,
            #[cfg(feature = "rustls")]
            SubTransport::Secure(t) => t.accept(a).await?,
        };
        Ok((s, addr))
    }

    async fn handshake(&self, conn: Self::RawStream) -> anyhow::Result<Self::Stream> {
        let tsream = match &self.sub {
            SubTransport::Insecure(t) => {
                TransportStream::Insecure(t.handshake(conn).await?.into_stream())
            }
            #[cfg(feature = "rustls")]
            SubTransport::Secure(t) => TransportStream::Secure(Box::new(t.handshake(conn).await?)),
        };

        let headers = self.headers.clone();

        let callback = move |req: &Request, res: Response| {
            for ref header in req.headers() {
                trace!("WS headers: {:?}", header);
                headers.insert(
                    header.0.to_string(),
                    header.1.to_str().unwrap_or_default().to_string(),
                );
            }
            Ok(res)
        };

        let wsstream = accept_hdr_async_with_config(tsream, callback, Some(self.conf)).await?;

        let tun = WebsocketStream {
            inner: StreamReader::new(StreamWrapper { inner: wsstream }),
        };
        Ok(tun)
    }

    async fn connect(&self, addr: &AddrMaybeCached) -> anyhow::Result<Self::Stream> {
        let u = format!("wss://{}/endpoint/v3", &addr.addr.as_str());
        let tstream = match &self.sub {
            SubTransport::Insecure(t) => {
                TransportStream::Insecure(t.connect(addr).await?.into_stream())
            }
            #[cfg(feature = "rustls")]
            SubTransport::Secure(t) => TransportStream::Secure(Box::new(t.connect(addr).await?)),
        };
        debug!("Connecting to {}", u);
        let (wsstream, _) = client_async_with_config(
            u.clone()
                .into_client_request()
                .context("Failed to create client request")?,
            tstream,
            Some(self.conf),
        )
        .await
        .with_context(|| format!("Failed to connect to {}", u))?;

        debug!("Connected");

        let tun = WebsocketStream {
            inner: StreamReader::new(StreamWrapper { inner: wsstream }),
        };
        Ok(tun)
    }

    fn get_header(&self, name: &str) -> Option<String> {
        self.headers.get(&name.to_lowercase()).map(|v| v.clone())
    }
}