stream: fix NewDecryptReaderAt EOF handling#708
Open
arpitguptagithub wants to merge 1 commit intoFiloSottile:mainfrom
Open
stream: fix NewDecryptReaderAt EOF handling#708arpitguptagithub wants to merge 1 commit intoFiloSottile:mainfrom
arpitguptagithub wants to merge 1 commit intoFiloSottile:mainfrom
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.
The bug
I noticed that the
NewDecryptReaderAtfails when theio.ReaderAtit's given returnsio.EOFalong with a successful read of the final chunk.The current code is like :
The
io.ReaderAtdocs say implementations are allowed to returnerr == io.EOFeven whenn == len(p), if the read happens to land right at EOF. The current code treats that as a fatal error.... so whether decryption works or not depends on whichReaderAtyou pass in.bytes.Readerhappens to returnnilhere so it works, but other valid implementations hit the EOF path and break.The fix
If
ReadAtreturnsio.EOFbut we got all the bytes we asked for, treat it as success and move on. If we got fewer bytes than expected, surface it asio.ErrUnexpectedEOFinstead ... which is the more accurate error anyway.This is the same EOF handling that
DecryptReaderAt.ReadAtalready does a few lines down in the same file. The constructor was just inconsistent with the method on the same type.Test
Added
TestDecryptReaderAtEOFininternal/stream/stream_test.go. It wraps the source in a smalleofReaderAthelper that forces an eagerio.EOFat the payload boundary, so this edge case stays covered going forward.