Add an assertion to unix_term::read_bytes to prevent reading past the end of a buffer#225
Open
bmoxb wants to merge 1 commit intoconsole-rs:mainfrom
Open
Add an assertion to unix_term::read_bytes to prevent reading past the end of a buffer#225bmoxb wants to merge 1 commit intoconsole-rs:mainfrom
unix_term::read_bytes to prevent reading past the end of a buffer#225bmoxb wants to merge 1 commit intoconsole-rs:mainfrom
Conversation
bmoxb
force-pushed
the
safety-assertion
branch
from
2dc2036 to
2dd8775
Compare
tamird
reviewed
Dec 16, 2024
| // If successful, return the number of bytes read. | ||
| // Will return an error if nothing was read, i.e when called at end of file. | ||
| fn read_bytes(fd: i32, buf: &mut [u8], count: u8) -> io::Result<u8> { | ||
| assert!((count as usize) <= buf.len()); // Safety precondition - prevent reading past end of buffer. |
Contributor
There was a problem hiding this comment.
the signature of this function is cursed. I've done a more thorough refactor in #223.
tamird
added a commit
to tamird/console
that referenced
this pull request
Dec 17, 2024
Slices already encode their lengths; use that instead. Remove the unused return value while I'm here. Closes console-rs#225.
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
2 participants
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.
The (marked safe)
read_bytesfunction makes a call to the unsafe functionlibc::read. Ifread_byteswere to be called with acountvalue larger than the length ofbuf, the call tolibc::readwould be undefined behaviour and unsafe. All current callsites ofread_bytesappear OK, but adding an assertion would ensure that all possible calls toread_byteswill be safe. If you would prefer to avoid a runtime assertion, I would suggest markingread_bytesas unsafe instead.