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
//
// 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 File Transfer Protocol
//!
//! # Examples
//!
//! ```no_run
//! use file_protocol::*;
//! use std::time::Duration;
//!
//! fn upload() -> Result<(), ProtocolError> {
//! let config = FileProtocolConfig::new(Some("storage/dir".to_owned()), 1024, 5, 1, None, 2048);
//! let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);
//!
//! # ::std::fs::File::create("client.txt").unwrap();
//! let source_path = "client.txt";
//! let target_path = "service.txt";
//!
//! // Copy file to upload to temp storage. Calculate the hash and chunk info
//! let (hash, num_chunks, mode) = f_protocol.initialize_file(&source_path)?;
//!
//! // Generate channel id
//! let channel_id = f_protocol.generate_channel()?;
//!
//! // Tell our destination the hash and number of chunks to expect
//! f_protocol.send_metadata(channel_id, &hash, num_chunks)?;
//!
//! // Send export command for file
//! f_protocol.send_export(channel_id, &hash, &target_path, mode)?;
//!
//! // Start the engine to send the file data chunks
//! Ok(f_protocol.message_engine(|d| f_protocol.recv(Some(d)), Duration::from_millis(10), &State::Transmitting)?)
//! }
//! ```
//!
//! ```no_run
//! extern crate file_protocol;
//!
//! use file_protocol::*;
//! use std::time::Duration;
//!
//! fn download() -> Result<(), ProtocolError> {
//! let config = FileProtocolConfig::new(None, 1024, 5, 1, None, 2048);
//! let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);
//!
//! let channel_id = f_protocol.generate_channel()?;
//! # ::std::fs::File::create("service.txt").unwrap();
//! let source_path = "service.txt";
//! let target_path = "client.txt";
//!
//! // Send our file request to the remote addr and verify that it's
//! // going to be able to send it
//! f_protocol.send_import(channel_id, source_path)?;
//!
//! // Wait for the request reply
//! let reply = match f_protocol.recv(None) {
//! Ok(message) => message,
//! Err(error) => return Err(error)
//! };
//!
//! let state = f_protocol.process_message(
//! reply,
//! &State::StartReceive {
//! path: target_path.to_string(),
//! },
//! )?;
//!
//! Ok(f_protocol.message_engine(|d| f_protocol.recv(Some(d)), Duration::from_millis(10), &state)?)
//! }
//! ```
//!
#![deny(missing_docs)]
mod error;
mod messages;
mod parsers;
pub mod protocol;
mod storage;
pub use crate::error::ProtocolError;
pub use crate::protocol::Protocol as FileProtocol;
pub use crate::protocol::ProtocolConfig as FileProtocolConfig;
pub use crate::protocol::State;
pub use crate::parsers::parse_channel_id;
/// File protocol message types
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum Message {
/// TODO: Decide whether or not to keep this
Sync(u32, String),
/// Receiver should prepare a new temporary storage folder with the specified metadata
Metadata(u32, String, u32),
/// File data chunk message
ReceiveChunk(u32, String, u32, Vec<u8>),
/// Receiver has successfully gotten all data chunks of the requested file
ACK(u32, String),
/// Receiver is missing the specified file data chunks
NAK(u32, String, Option<Vec<(u32, u32)>>),
/// (Client Only) Message requesting the recipient to receive the specified file
ReqReceive(u32, String, String, Option<u32>),
/// (Client Only) Message requesting the recipient to transmit the specified file
ReqTransmit(u32, String),
/// (Server Only) Recipient has successfully processed a request to receive a file
SuccessReceive(u32, String),
/// (Server Only) Recipient has successfully prepared to transmit a file
SuccessTransmit(u32, String, u32, Option<u32>),
/// (Server Only) The transmit or receive request has failed to be completed
Failure(u32, String),
/// Request Cleanup of either whole storage directory or individual file's storage
Cleanup(u32, Option<String>),
}
#[cfg(test)]
mod tests {
use super::{messages, parsers, Message};
use serde_cbor::de;
#[test]
fn create_parse_export_request() {
let channel_id = 10;
let hash = "abcdedf".to_owned();
let target_path = "/path/to/file".to_owned();
let mode = 0o623;
let raw = messages::export_request(channel_id, &hash, &target_path, mode).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(
msg.unwrap(),
Message::ReqReceive(channel_id, hash, target_path, Some(mode))
);
}
#[test]
fn create_parse_sync() {
let channel_id = 10;
let hash = "abcdefg".to_owned();
let raw = messages::sync(channel_id, &hash).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(msg.unwrap(), Message::Sync(channel_id, hash));
}
#[test]
fn create_parse_metadata() {
let channel_id = 10;
let hash = "abcdefg".to_owned();
let num_chunks = 100;
let raw = messages::metadata(channel_id, &hash, num_chunks).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(
msg.unwrap(),
Message::Metadata(channel_id, hash, num_chunks)
);
}
#[test]
fn create_parse_chunk() {
let channel_id = 10;
let hash = "abcdefg".to_owned();
let chunk_num = 10;
let chunk_data: Vec<u8> = vec![1, 2, 3, 4, 5, 6];
let raw = messages::chunk(channel_id, &hash, chunk_num, &chunk_data).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(
msg.unwrap(),
Message::ReceiveChunk(channel_id, hash, chunk_num, chunk_data)
);
}
#[test]
fn create_parse_ack() {
let channel_id = 14;
let hash = "abcdefg".to_owned();
let num_chunks = 10;
let raw = messages::ack(channel_id, &hash, Some(num_chunks)).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(msg.unwrap(), Message::ACK(channel_id, hash));
}
#[test]
fn create_parse_nak() {
let channel_id = 11;
let hash = "abcdefg".to_owned();
let missing_chunks = vec![0, 1, 4, 10];
let chunk_ranges: Vec<(u32, u32)> = vec![(0, 1), (4, 10)];
let raw = messages::nak(channel_id, &hash, &missing_chunks).unwrap();
let msg = parsers::parse_message(de::from_slice(&raw).unwrap());
assert_eq!(
msg.unwrap(),
Message::NAK(channel_id, hash, Some(chunk_ranges))
);
}
}