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

io: extend Buf length only after having read into it #7054

Merged

Conversation

paolobarbolini
Copy link
Contributor

@paolobarbolini paolobarbolini commented Dec 29, 2024

Motivation

I've discovered that Buf::ensure_capacity_for is unsound because it uses Vec::set_len to grow the Vec past the init area. This violates the documented safety invariants of Vec::set_len, which say The elements at old_len..new_len must be initialized.

This can be tested very easily by adding for &byte in &self.buf {} after the self.buf.set_len call.

Solution

Have reads use the spare capacity of buf and Vec::set_len afterwards.

@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch from e64152a to a2a4b8a Compare December 29, 2024 17:48
@Darksonn
Copy link
Contributor

Please add a test that would catch the unsoundness in question if run under miri.

@Darksonn Darksonn added A-tokio Area: The main tokio crate M-io Module: tokio/io labels Dec 29, 2024
@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch 3 times, most recently from 5759994 to 064afef Compare December 29, 2024 19:03
@Darksonn
Copy link
Contributor

I don't think this qualifies as a security issue, because Blocking is only used internally with stdlib types that don't read from the buffer passed to read. It's a similar situation to this:

// Safety: The caller must ensure that `E` can read into uninitialized memory
pub(crate) unsafe fn poll_read<'a>(

Still, I agree that the particular implementation is not the greatest. We should avoid calling set_len until after actually filling the data with read. The constructor of Buf should also unsafely assert that the IO resource doesn't read from the slice in read.

@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch from 064afef to 8ec1726 Compare January 2, 2025 09:55
@paolobarbolini paolobarbolini changed the title io: fix unsound Buf::ensure_capacity_for io: extend via Vec::set_len only after having read into it Jan 2, 2025
Copy link
Contributor Author

@paolobarbolini paolobarbolini left a comment

Choose a reason for hiding this comment

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

I'm not too happy about the current &mut [MaybeUninit<u8>] -> &mut [u8] hacks but given that everything else also relies on it I've changed it here too

tokio/src/io/blocking.rs Outdated Show resolved Hide resolved
@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch from 8ec1726 to c95f8a6 Compare January 2, 2025 10:08
@paolobarbolini paolobarbolini changed the title io: extend via Vec::set_len only after having read into it io: extend Buf length only after having read into it Jan 2, 2025
tokio/src/io/blocking.rs Show resolved Hide resolved
tokio/src/io/blocking.rs Show resolved Hide resolved
tokio/src/io/blocking.rs Show resolved Hide resolved
@Darksonn
Copy link
Contributor

Darksonn commented Jan 6, 2025

Thanks a lot. Looks quite reasonable. Just a few minor nits remaining.

@Darksonn
Copy link
Contributor

Darksonn commented Jan 7, 2025

I'm going to make a release as soon as this is merged.

@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch 2 times, most recently from be3cc8c to d61b542 Compare January 8, 2025 09:05
tokio/src/io/stderr.rs Outdated Show resolved Hide resolved
@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch 2 times, most recently from 6c5930d to 90f0629 Compare January 8, 2025 09:36
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

Thank you.

tokio/src/io/stdin.rs Outdated Show resolved Hide resolved
tokio/src/io/stdout.rs Outdated Show resolved Hide resolved
@paolobarbolini paolobarbolini force-pushed the unsound-ensure-capacity-for branch from 90f0629 to ebc5dd9 Compare January 8, 2025 09:48
@Darksonn Darksonn enabled auto-merge (squash) January 8, 2025 09:49
@Darksonn Darksonn merged commit ad41834 into tokio-rs:master Jan 8, 2025
84 checks passed
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Jan 13, 2025
⚠️  Dependabot is rebasing this PR ⚠️
Rebasing might not happen immediately, so don't worry if this takes some time.
Note: if you make any changes to this PR yourself, they will take precedence over the rebase.

Bumps tokio from 1.42.0 to 1.43.0.

Release notes
Sourced from tokio's releases.

Tokio v1.43.0
1.43.0 (Jan 8th, 2025)
Added

net: add UdpSocket::peek methods (#7068)
net: add support for Haiku OS (#7042)
process: add Command::into_std() (#7014)
signal: add SignalKind::info on illumos (#6995)
signal: add support for realtime signals on illumos (#7029)

Fixed

io: don't call set_len before initializing vector in Blocking (#7054)
macros: suppress clippy::needless_return in #[tokio::main] (#6874)
runtime: fix thread parking on WebAssembly (#7041)

Changes

chore: use unsync loads for unsync_load (#7073)
io: use Buf::put_bytes in Repeat read impl (#7055)
task: drop the join waker of a task eagerly (#6986)

Changes to unstable APIs

metrics: improve flexibility of H2Histogram Configuration (#6963)
taskdump: add accessor methods for backtrace (#6975)

Documented

io: clarify ReadBuf::uninit allows initialized buffers as well (#7053)
net: fix ambiguity in TcpStream::try_write_vectored docs (#7067)
runtime: fix LocalRuntime doc links (#7074)
sync: extend documentation for watch::Receiver::wait_for (#7038)
sync: fix typos in OnceCell docs (#7047)

#6874: tokio-rs/tokio#6874
#6963: tokio-rs/tokio#6963
#6975: tokio-rs/tokio#6975
#6986: tokio-rs/tokio#6986
#6995: tokio-rs/tokio#6995
#7014: tokio-rs/tokio#7014
#7029: tokio-rs/tokio#7029
#7038: tokio-rs/tokio#7038
#7041: tokio-rs/tokio#7041
#7042: tokio-rs/tokio#7042
#7047: tokio-rs/tokio#7047
#7053: tokio-rs/tokio#7053
#7054: tokio-rs/tokio#7054
#7055: tokio-rs/tokio#7055


... (truncated)


Commits

5f3296d chore: prepare Tokio v1.43.0 (#7079)
cc974a6 chore: prepare tokio-macros v2.5.0 (#7078)
15495fd metrics: improve flexibility of H2Histogram Configuration (#6963)
ad41834 io: don't call set_len before initializing vector in Blocking (#7054)
bd3e857 runtime: move is_join_waker_set assertion in unset_waker (#7072)
15f7366 runtime: fix LocalRuntime doc links (#7074)
fd2048d ci: split miri jobs into unit and integration tests (#7071)
e8f3915 chore: use unsync loads for unsync_load (#7073)
67f1277 net: fix ambiguity in TcpStream::try_write_vectored docs (#7067)
463502c io: clarify ReadBuf::uninit allows initialized buffers as well (#7053)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-io Module: tokio/io
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants