Skip to content

fix async protocol.read().await not returning on closed sockets #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustaceanrob merged 2 commits into from
Jan 9, 2026
Merged

fix async protocol.read().await not returning on closed sockets #160

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bb5b8e
fix: return Err when async read returns no bytes
0xB10C Jan 8, 2026
0719bcc
test: async read after connection closed
0xB10C Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions protocol/src/futures.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,15 @@ where
bytes_read,
} => {
while *bytes_read < NUM_LENGTH_BYTES {
*bytes_read += self.reader.read(&mut length_bytes[*bytes_read..]).await?;
let len = self.reader.read(&mut length_bytes[*bytes_read..]).await?;
if len == 0 {
return Err(std::io::Error::new(
std::io::ErrorKind::ConnectionAborted,
Copy link
Contributor Author

@0xB10C 0xB10C Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went with ConnectionAborted here. ConnectionReset is an alternative. Happy to be convinced to use ConnectionReset if someone has strong feelings about it.

Copy link
Collaborator

@rustaceanrob rustaceanrob Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No strong opinion here, ConnectionAborted is fine with me.

Copy link
Collaborator

@nyonson nyonson Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use UnexpectedEof? It looks like that is what tokio bubbles up in similar scenarios.

Copy link
Contributor Author

@0xB10C 0xB10C Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about this too, but found the Rust stdlib docs to not to be a perfect fit for our case? https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.UnexpectedEof

An error returned when an operation could not be completed because an “end of file” was reached prematurely.
This typically means that an operation could only succeed if it read a particular number of bytes but only a smaller number of bytes could be read.

(but also don't really care too much personally)

"read zero bytes",
)
.into());
}
*bytes_read += len;
}

let packet_bytes_len = self.inbound_cipher.decrypt_packet_len(*length_bytes);
Expand All @@ -417,7 +425,15 @@ where
bytes_read,
} => {
while *bytes_read < packet_bytes.len() {
*bytes_read += self.reader.read(&mut packet_bytes[*bytes_read..]).await?;
let len = self.reader.read(&mut packet_bytes[*bytes_read..]).await?;
if len == 0 {
return Err(std::io::Error::new(
std::io::ErrorKind::ConnectionAborted,
"read zero bytes",
)
.into());
}
*bytes_read += len;
}

let plaintext_len = InboundCipher::decryption_buffer_len(packet_bytes.len());
Expand Down