sftp-protocol 0.1.0

A pure Rust implementation of the SFTP protocol
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

use super::kind::PacketType;
use super::PayloadTrait;

#[derive(Debug, Eq, PartialEq, Nom, Serialize)]
#[nom(BigEndian)]
#[cfg_attr(test, derive(test_strategy::Arbitrary))]
pub struct Request {
	pub id: u32,
	#[nom(Parse(crate::util::parse_string))]
	#[serde(serialize_with = "crate::util::str_with_u32_length")]
	pub request: String,
	#[nom(Parse(crate::util::parse_u8_vec))]
	#[serde(serialize_with = "crate::util::vec_with_u32_length")]
	pub data: Vec<u8>
}

impl PayloadTrait for Request {
	const Type: PacketType = PacketType::Extended;
	fn binsize(&self) -> u32 {
		4 + (4 + self.request.len() as u32) + (4 + self.data.len() as u32)
	}
}

impl From<Request> for super::Payload {
	fn from(p: Request) -> Self {
		Self::Extended(p)
	}
}

#[derive(Debug, Eq, PartialEq, Nom, Serialize)]
#[nom(BigEndian)]
#[cfg_attr(test, derive(test_strategy::Arbitrary))]
pub struct Response {
	pub id: u32,
	#[nom(Parse(crate::util::parse_u8_vec))]
	#[serde(serialize_with = "crate::util::vec_with_u32_length")]
	pub data: Vec<u8>
}

impl PayloadTrait for Response {
	const Type: PacketType = PacketType::ExtendedReply;
	fn binsize(&self) -> u32 {
		4 + (4 + self.data.len() as u32)
	}
}

impl From<Response> for super::Payload {
	fn from(p: Response) -> Self {
		Self::ExtendedReply(p)
	}
}

#[cfg(test)]
mod tests {
	use test_strategy::proptest;
	use crate::parser::encode;
	use crate::parser::Parser;
	use super::*;

	#[proptest]
	fn roundtrip_request_whole(input: Request) {
		let mut stream = Parser::default();
		let packet = input.into_packet();
		stream.write(&encode(&packet)).unwrap();
		assert_eq!(stream.get_packet(), Ok(Some(packet)));
		assert_eq!(stream.get_packet(), Ok(None));
	}

	#[proptest]
	fn roundtrip_response_whole(input: Response) {
		let mut stream = Parser::default();
		let packet = input.into_packet();
		stream.write(&encode(&packet)).unwrap();
		assert_eq!(stream.get_packet(), Ok(Some(packet)));
		assert_eq!(stream.get_packet(), Ok(None));
	}
}