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
//! An implementation of the TFTP Client as specified in [RFC 1350](https://datatracker.ietf.org/doc/html/rfc1350)
//! This includes retries and timeouts with exponential backoff
use parser::Packet;
use std::{
ffi::CString,
io,
net::{
SocketAddr,
UdpSocket,
},
time::Duration,
};
use thiserror::Error;
use tracing::debug;
pub mod parser;
const BLKSISZE: usize = 512;
enum State {
Send,
SendAgain,
Recv,
}
/// Download a file via tftp
pub fn download<T: AsRef<str> + std::fmt::Display>(
filename: T,
socket: &UdpSocket,
mut server: SocketAddr,
timeout: Duration,
max_timeout: Duration,
retries: usize,
) -> Result<Vec<u8>, Error> {
// Set our server address to the inital address, it will potentially change
// Make sure we can actually timeout, but preserve the old state
let old_read_timeout = socket.read_timeout().map_err(Error::SocketIo)?;
socket
.set_read_timeout(Some(timeout))
.map_err(Error::SocketIo)?;
debug!("┌── GET {filename}");
// Initialize the state of our state machine
let mut state = State::Send;
let mut local_retries = retries;
let mut local_timeout = timeout;
let mut send_pkt = Packet::ReadRequest {
filename: CString::new(filename.to_string()).map_err(|_| Error::BadFilename)?,
mode: parser::RequestMode::Octet,
};
let mut file_data = vec![];
let mut done = false;
// Run the state machine
loop {
match state {
State::Send => {
local_retries = retries;
local_timeout = timeout;
let bytes = send_pkt.to_bytes();
debug!("│ TX - {send_pkt}");
// Send the bytes and reset some other state variables
socket.send_to(&bytes, server).map_err(Error::SocketIo)?;
// Transition to recv if this wasn't the last ACK packet
if done {
break;
}
state = State::Recv
}
State::SendAgain => {
let bytes = send_pkt.to_bytes();
debug!("│ TX - {send_pkt} (Retry)");
// Send the bytes and reset some other state variables
socket.send_to(&bytes, server).map_err(Error::SocketIo)?;
// Transition to recv
state = State::Recv
}
State::Recv => {
let mut buf = vec![0; BLKSISZE + 4]; // The biggest a block can be, 2 bytes for opcode, 2 bytes for block n
let n = match socket.recv_from(&mut buf) {
Ok((n, remote_addr)) => {
// Set the server's address as it may have changed ports (as the spec
// allows)
server = remote_addr;
n
}
Err(e) => {
match e.kind() {
io::ErrorKind::TimedOut | io::ErrorKind::WouldBlock => {
debug!("│ Timeout");
// We timed out, try sending the last packet again with exponential
// backoff
local_retries -= 1;
if local_retries == 0 {
return Err(Error::Timeout);
}
local_timeout += local_timeout / 2;
if local_timeout > max_timeout {
local_timeout = max_timeout;
}
socket
.set_read_timeout(Some(local_timeout))
.map_err(Error::SocketIo)?;
state = State::SendAgain;
continue;
}
_ => return Err(Error::SocketIo(e)),
}
}
};
// Process the received packet
let recv_pkt = Packet::from_bytes(&buf[..n]).map_err(Error::Parse)?;
debug!("│ RX - {recv_pkt}");
match recv_pkt {
Packet::Data { block_n, data } => {
// We got back a chunk of data, we need to ack it and append to the data
// we're collecting
file_data.extend_from_slice(&data);
if data.len() < BLKSISZE {
done = true
}
send_pkt = Packet::Acknowledgment { block_n };
state = State::Send;
continue;
}
Packet::Error { code, msg } => {
return Err(Error::Protocol {
code,
msg: msg.into_string().expect("Error message had invalid UTF-8"),
})
}
_ => return Err(Error::UnexpectedPacket(recv_pkt)),
}
}
}
}
debug!("└");
// Return socket timeout to previous state
socket
.set_read_timeout(old_read_timeout)
.map_err(Error::SocketIo)?;
// And return the bytes we downloaded
Ok(file_data)
}
/// Upload a file via tftp
pub fn upload<T: AsRef<str> + std::fmt::Display>(
filename: T,
data: &[u8],
socket: &UdpSocket,
mut server: SocketAddr,
timeout: Duration,
max_timeout: Duration,
retries: usize,
) -> Result<(), Error> {
// Make sure we can actually timeout, but preserve the old state
let old_read_timeout = socket.read_timeout().map_err(Error::SocketIo)?;
socket
.set_read_timeout(Some(timeout))
.map_err(Error::SocketIo)?;
debug!("┌── PUT {filename}");
// Initialize the state of our state machine
let mut state = State::Send;
let mut local_retries = retries;
let mut local_timeout = timeout;
let mut send_pkt = Packet::WriteRequest {
filename: CString::new(filename.to_string()).map_err(|_| Error::BadFilename)?,
mode: parser::RequestMode::Octet,
};
// Create the chunk vec for our data
let chunks: Vec<_> = data.chunks(BLKSISZE).collect();
let mut last_block_n = -1;
// Run the state machine
loop {
match state {
State::Send => {
local_retries = retries;
local_timeout = timeout;
let bytes = send_pkt.to_bytes();
debug!("│ TX - {send_pkt}");
// Send the bytes and reset some other state variables
socket.send_to(&bytes, server).map_err(Error::SocketIo)?;
// Transition to recv if this wasn't the last ACK packet
state = State::Recv;
}
State::SendAgain => {
let bytes = send_pkt.to_bytes();
debug!("│ TX - {send_pkt} (Retry)");
// Send the bytes and reset some other state variables
socket.send_to(&bytes, server).map_err(Error::SocketIo)?;
// Transition to recv
state = State::Recv
}
State::Recv => {
let mut buf = vec![0; BLKSISZE + 4];
let n = match socket.recv_from(&mut buf) {
Ok((n, remote_addr)) => {
// Set the server's address as it may have changed ports (as the spec
// allows)
server = remote_addr;
n
}
Err(e) => {
match e.kind() {
io::ErrorKind::TimedOut | io::ErrorKind::WouldBlock => {
debug!("│ Timeout");
// We timed out, try sending the last packet again with exponential
// backoff
local_retries -= 1;
if local_retries == 0 {
return Err(Error::Timeout);
}
local_timeout += local_timeout / 2;
if local_timeout > max_timeout {
local_timeout = max_timeout;
}
socket
.set_read_timeout(Some(local_timeout))
.map_err(Error::SocketIo)?;
state = State::SendAgain;
continue;
}
_ => return Err(Error::SocketIo(e)),
}
}
};
// Process the received packet
let recv_pkt = Packet::from_bytes(&buf[..n]).map_err(Error::Parse)?;
debug!("│ RX - {recv_pkt}");
match recv_pkt {
Packet::Acknowledgment { block_n } => {
// Fix for https://en.wikipedia.org/wiki/Sorcerer%27s_Apprentice_Syndrome
// Just try to recv again and don't resend the data on duplicate Acks
if last_block_n == -1 {
// Initial block
last_block_n = block_n as i16
} else if last_block_n == block_n as i16 {
state = State::Recv;
continue;
} else {
last_block_n = block_n as i16;
}
// We got back an ack, we need to send out that ack's chunk of data
if block_n as usize == chunks.len() {
break;
}
send_pkt = Packet::Data {
block_n: block_n + 1,
data: chunks[block_n as usize].into(),
};
state = State::Send;
continue;
}
Packet::Error { code, msg } => {
return Err(Error::Protocol {
code,
msg: msg.into_string().expect("Error message had invalid UTF-8"),
})
}
_ => return Err(Error::UnexpectedPacket(recv_pkt)),
}
}
}
}
debug!("└");
// Return socket timeout to previous state
socket
.set_read_timeout(old_read_timeout)
.map_err(Error::SocketIo)?;
// And return and ok
Ok(())
}
#[derive(Debug, Error)]
pub enum Error {
#[error("Bad filename (not a valid CString)")]
BadFilename,
#[error("Socket IO error - `{0}`")]
SocketIo(std::io::Error),
#[error("Timeout while trying to complete transaction")]
Timeout,
#[error("Failed to parse incoming packet - `{0}`")]
Parse(parser::Error),
#[error("The packet we got back was unexpected")]
UnexpectedPacket(Packet),
#[error(
"The protocol itself gave us an error with code `{:?}`and msg `{msg}`",
code
)]
Protocol {
code: parser::ErrorCode,
msg: String,
},
}