Skip to content
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.

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

Read on uninitialized buffer may cause UB ( Reader::from_reader() ) #186

Open
JOE1994 opened this issue Jan 31, 2021 · 0 comments
Open

Read on uninitialized buffer may cause UB ( Reader::from_reader() ) #186

JOE1994 opened this issue Jan 31, 2021 · 0 comments

Comments

@JOE1994
Copy link

JOE1994 commented Jan 31, 2021

Hello 🦀,
we (Rust group @sslab-gatech) found a memory-safety/soundness issue in this crate while scanning Rust code on crates.io for potential vulnerabilities.

Issue Description

impl Reader {
/// Creates a new `Reader`
#[cfg(feature = "std")]
pub fn from_reader<R: Read>(mut r: R, capacity: usize) -> Result<Reader> {
let mut buf = Vec::with_capacity(capacity);
unsafe {
buf.set_len(capacity);
}
buf.shrink_to_fit();
r.read_exact(&mut buf)?;
Ok(Reader::from_bytes(buf))
}

Reader::from_reader() method creates an uninitialized buffer and passes it to user-provided Read implementation. This is unsound, because it allows safe Rust code to exhibit an undefined behavior (read from uninitialized memory).

This part from the Read trait documentation explains the issue:

It is your responsibility to make sure that buf is initialized before calling read. Calling read with an uninitialized buf (of the kind one obtains via MaybeUninit<T>) is not safe, and can lead to undefined behavior.

How to fix the issue?

The Naive & safe way to fix the issue is to always zero-initialize a buffer before lending it to a user-provided Read implementation. Note that this approach will add runtime performance overhead of zero-initializing the buffer.

As of Jan 2021, there is not yet an ideal fix that works in stable Rust with no performance overhead. Below are links to relevant discussions & suggestions for the fix.

gerritsangel pushed a commit to gerritsangel/quick-protobuf that referenced this issue Dec 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant