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
//
// Copyright (C) 2018 Kubos Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

//! Kubos CBOR over UDP communication crate
//!
//! # Examples
//!
//! ```no_run
//! use cbor_protocol::*;
//! use serde_cbor::ser;
//! use std::time::Duration;
//!
//! let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
//! let message = ser::to_vec_packed(&("hello", "world")).unwrap();
//!
//! cbor_connection.send_message(&message, "0.0.0.0:8001".parse().unwrap()).unwrap();
//!
//! match cbor_connection.recv_message_peer_timeout(Duration::from_millis(10)) {
//!     Ok((source, message)) => {
//!         println!("Received message from {:?}: {:?}", source, message);
//!     }
//!     Err(ProtocolError::Timeout) => println!("Timed out waiting for reply"),
//!     Err(err) => eprintln!("Failed to receive message: {}", err)
//! }
//! ```
//!

#![deny(missing_docs)]
#![deny(warnings)]

use failure::Fail;
use serde_cbor::de;
use std::io;
use std::net::{SocketAddr, UdpSocket};
use std::time::Duration;

/// An error generated during protocol execution
#[derive(Debug, Fail)]
pub enum ProtocolError {
    /// Indicates a timeout when sending or receiving
    #[fail(display = "Protocol timed out")]
    Timeout,
    /// Indicates no data was received
    #[fail(display = "No valid data received")]
    NoDataReceived,
    /// Indicates a failure to receive
    #[fail(display = "Failed to receive message from: {}", err)]
    ReceiveFailed {
        /// Cause of receive failure
        err: io::Error,
    },
    /// Indicates a failure to send
    #[fail(display = "Failed to send message to {}: {}", dest, err)]
    SendFailed {
        /// Intended send destination
        dest: SocketAddr,
        /// Cause of send failure
        err: io::Error,
    },
    #[fail(display = "Encountered io Error: {}", err)]
    /// Indicates a non-send/received Io error
    IoError {
        /// Root Io Error
        err: io::Error,
    },
    /// Indicates a failure to parse a message
    #[fail(display = "Failed to parse data: {:?}", err)]
    ParseFail {
        /// Cause of parsing failure
        err: String,
    },
}

/// CBOR protocol communication structure
pub struct Protocol {
    handle: UdpSocket,
    msg_size: usize,
}

impl Protocol {
    /// Binds a UDP listener socket and saves it in a new protocol instance
    ///
    /// # Arguments
    ///
    /// * host_url - The IP address and port to bind
    /// * data_size - Expected max size of payload in messages
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will panic
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    /// ```
    ///
    pub fn new(host_url: &str, data_size: usize) -> Self {
        Self {
            handle: UdpSocket::bind(host_url.parse::<SocketAddr>().unwrap()).unwrap(),
            msg_size: data_size + 50,
        }
    }

    /// Send a CBOR packet to a specified UDP socket destination
    ///
    /// # Arguments
    ///
    /// * message - CBOR packet to send. Packet must be a serialized array or tuple.
    /// * dest - UDP socket destination
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    /// use serde_cbor::ser;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    /// let message = ser::to_vec_packed(&["ping"]).unwrap();
    ///
    /// cbor_connection.send_message(&message, "0.0.0.0:8001".parse().unwrap());
    /// ```
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    /// use serde_cbor::ser;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    /// let message = ser::to_vec_packed(&("hello", "world")).unwrap();
    ///
    /// cbor_connection.send_message(&message, "0.0.0.0:8001".parse().unwrap());
    /// ```
    ///
    pub fn send_message(&self, message: &[u8], dest: SocketAddr) -> Result<(), ProtocolError> {
        // TODO: If paused, just queue up the message

        let mut payload = vec![];
        payload.extend(message);
        payload.insert(0, 0);

        self.handle
            .send_to(&payload, &dest)
            .map_err(|err| ProtocolError::SendFailed { dest, err })?;
        Ok(())
    }

    /// Send a pause message to a specified UDP socket destination
    ///
    /// # Arguments
    ///
    /// * dest - UDP socket destination
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// cbor_connection.send_pause("0.0.0.0:8001".parse().unwrap());
    /// ```
    ///
    pub fn send_pause(&self, dest: SocketAddr) -> Result<(), ProtocolError> {
        println!("-> pause");

        let payload = vec![1];
        self.handle
            .send_to(&payload, &dest)
            .map_err(|err| ProtocolError::SendFailed { dest, err })?;
        Ok(())
    }

    /// Send a resume message to a specified UDP socket destination
    ///
    /// # Arguments
    ///
    /// * dest - UDP socket destination
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// cbor_connection.send_resume("0.0.0.0:8001".parse().unwrap());
    /// ```
    ///
    pub fn send_resume(&self, dest: SocketAddr) -> Result<(), ProtocolError> {
        println!("-> resume");

        let payload = vec![2];
        self.handle
            .send_to(&payload, &dest)
            .map_err(|err| ProtocolError::SendFailed { dest, err })?;
        Ok(())
    }

    /// Receive a UDP message (no timeout)
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// let message = cbor_connection.recv_message().unwrap();
    /// ```
    ///
    pub fn recv_message(&self) -> Result<serde_cbor::Value, ProtocolError> {
        let mut buf = vec![0; self.msg_size];
        let (size, _peer) = self
            .handle
            .recv_from(&mut buf)
            .map_err(|err| ProtocolError::ReceiveFailed { err })?;

        self.recv_start(&buf[0..size])
    }

    /// Peek at the sender information for the next message in the UDP receive buffer
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// let source = cbor_connection.peek_peer();
    /// ```
    ///
    pub fn peek_peer(&self) -> Result<SocketAddr, ProtocolError> {
        let mut buf = vec![0; self.msg_size];

        let (_size, peer) = self
            .handle
            .peek_from(&mut buf)
            .map_err(|err| ProtocolError::ReceiveFailed { err })?;

        Ok(peer)
    }

    /// Receive a UDP message and take note of the sender (no timeout)
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// let (source, message) = cbor_connection.recv_message_peer().unwrap();
    /// ```
    ///
    pub fn recv_message_peer(&self) -> Result<(SocketAddr, serde_cbor::Value), ProtocolError> {
        let mut buf = vec![0; self.msg_size];
        let (size, peer) = self
            .handle
            .recv_from(&mut buf)
            .map_err(|err| ProtocolError::ReceiveFailed { err })?;

        let message = self.recv_start(&buf[0..size])?;
        Ok((peer, message))
    }

    /// Receive a UDP message and take note of the sender (with timeout)
    ///
    /// # Arguments
    ///
    /// * timeout - Maximum amount of time to wait for a UDP packet
    ///
    /// # Errors
    ///
    /// - If this function times out, it will return Err(None)
    /// - If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    /// use std::time::Duration;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:8000".to_owned(), 4096);
    ///
    /// let (source, message) = match cbor_connection.recv_message_peer_timeout(Duration::from_secs(1)) {
    ///     Ok(data) => data,
    ///     Err(ProtocolError::Timeout) => {
    ///         println!("Timeout waiting for message");
    ///         return;
    ///     }
    ///     Err(err) => panic!("Failed to receive message: {}", err),
    /// };
    /// ```
    ///
    pub fn recv_message_peer_timeout(
        &self,
        timeout: Duration,
    ) -> Result<(SocketAddr, serde_cbor::Value), ProtocolError> {
        // Set the timeout for this particular receive
        self.handle
            .set_read_timeout(Some(timeout))
            .map_err(|err| ProtocolError::IoError { err })?;

        let mut buf = vec![0; self.msg_size];

        let result = self.handle.recv_from(&mut buf);

        // Reset the timeout for future calls
        // TODO: Decide what should happen if this fails...
        let _ = self.handle.set_read_timeout(None);

        let (size, peer) = match result {
            Ok(data) => data,
            Err(err) => match err.kind() {
                // For some reason, UDP recv returns WouldBlock for timeouts
                io::ErrorKind::WouldBlock => return Err(ProtocolError::Timeout),
                _ => return Err(ProtocolError::ReceiveFailed { err }),
            },
        };

        let message = self.recv_start(&buf[0..size])?;
        Ok((peer, message))
    }

    /// Receive a UDP message (with timeout)
    ///
    /// # Arguments
    ///
    /// * timeout - Maximum amount of time to wait for a UDP packet
    ///
    /// # Errors
    ///
    /// - If this function times out, it will return Err(None)
    /// - If this function encounters any errors, it will return an error message string
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use cbor_protocol::*;
    /// use std::time::Duration;
    ///
    /// let cbor_connection = Protocol::new(&"0.0.0.0:9000".to_owned(), 4096);
    ///
    /// let message = match cbor_connection.recv_message_timeout(Duration::from_secs(1)) {
    ///     Ok(data) => data,
    ///     Err(ProtocolError::Timeout) => {
    ///         println!("Timeout while waiting for message");
    ///         return;
    ///     }
    ///     Err(err) => panic!("Failed to receive message: {}", err),
    /// };
    /// ```
    ///
    pub fn recv_message_timeout(
        &self,
        timeout: Duration,
    ) -> Result<serde_cbor::Value, ProtocolError> {
        // Set the timeout for this particular receive
        self.handle
            .set_read_timeout(Some(timeout))
            .map_err(|err| ProtocolError::IoError { err })?;

        let mut buf = vec![0; self.msg_size];

        let result = self.handle.recv_from(&mut buf);

        // Reset the timeout for future calls
        // TODO: Decide what should happen if this fails...
        let _ = self.handle.set_read_timeout(None);

        let (size, _peer) = match result {
            Ok(data) => data,
            Err(err) => match err.kind() {
                // For some reason, UDP recv returns WouldBlock for timeouts
                ::std::io::ErrorKind::WouldBlock => return Err(ProtocolError::Timeout),
                _ => return Err(ProtocolError::ReceiveFailed { err }),
            },
        };

        Ok(self.recv_start(&buf[0..size])?)
    }

    // Parse the received CBOR message
    fn recv_start(&self, data: &[u8]) -> Result<serde_cbor::Value, ProtocolError> {
        if data.is_empty() {
            return Err(ProtocolError::NoDataReceived);
        }

        let result = match data[0] {
            0 => {
                let message: serde_cbor::Value =
                    de::from_slice(&data[1..]).map_err(|err| ProtocolError::ParseFail {
                        err: format!("{:?}", err),
                    })?;

                if message.is_array() {
                    message
                } else {
                    return Err(ProtocolError::ParseFail {
                        err: "Body is not an array".to_owned(),
                    });
                }
            }
            1 => {
                println!("<- pause");
                //TODO: Evaluate whether to keep/use pause & resume
                //TODO: self.pause()?;
                return Err(ProtocolError::NoDataReceived);
            }
            2 => {
                println!("<- resume");
                // TODO: self.resume()?;
                return Err(ProtocolError::NoDataReceived);
            }
            x => {
                eprintln!("Ignoring unknown control frame: {}", x);
                return Err(ProtocolError::NoDataReceived);
            }
        };

        Ok(result)
    }
}