fix(codec): eliminate uninitialized memory in encode_item on unwind - #2847
Open
nathanielford wants to merge 1 commit into
Open
fix(codec): eliminate uninitialized memory in encode_item on unwind#2847nathanielford wants to merge 1 commit into
nathanielford wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Fixes #2720.
In
tonic/src/codec/encode.rs,encode_itempreviously advanced the buffer's logical length by 5 bytes usingunsafe { buf.advance_mut(HEADER_SIZE); }before invoking the user-providedEncoder::encode. If the encoder panicked or unwound,bufwas left with 5 uninitialized bytes exposed to callers catching unwinds.Solution
unsafe { buf.advance_mut(HEADER_SIZE); }with safe zero-filled initialization viabuf.put_slice(&[0u8; HEADER_SIZE]), eliminating theunsafeblock entirely.finish_encodingincurs minimal performance impact (a single store instruction).unsafecode and could resurface the soundness vulnerability ifstd::mem::forget(or a similar leak) were ever introduced.encode_item_exception_safety_on_panicverifying that unwinding panics leave only initialized zero bytes in the buffer.Test Plan
cargo test -p tonic codec::encode.cargo fmt --all --check.cargo clippy.