Fix "short writes" in Base64LineBreaker.Write #445
Merged
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
The count of bytes written is incorrectly reported by Base64LineBreaker.Write. This issue is not visible externally as Base64LineBreaker.Write is only called by encoding/base64.Encoder.Write (like in the original implementation in stdlib encoding/pem.lineBreaker) which ignores the returned bytes count. The issue is not visible either with the test suite (not even via fuzzing) because the tests use Base64LineBreaker through the encoding/base64.Encoder. So we could just keep the existing code. The only risk is if encoding/base64 behaviour changes in the future. See also https://go.dev/cl/653675 which aims to fix the same issue in encoding/pem.
|
This fix doesn't extend fuzzing with tests that would target Base64LineBreaker directly because I think it is more important to first remove Base64LineBreaker from the API. See #444. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #445 +/- ##
==========================================
- Coverage 94.34% 93.35% -0.99%
==========================================
Files 30 30
Lines 3534 3537 +3
==========================================
- Hits 3334 3302 -32
- Misses 147 187 +40
+ Partials 53 48 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thanks again for the PR and the suggestion in #444! |
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 count of bytes written is incorrectly reported by
Base64LineBreaker.Write. This issue is not visible externally asBase64LineBreaker.Writeis only called viaencoding/base64.Encoder.Write(like in the original implementation in stdlibencoding/pem.lineBreaker) which ignores the returned bytes count.The issue is not visible either with the test suite (not even via the current fuzzing tests) because the tests also use
Base64LineBreakerthrough theencoding/base64.Encoder.So we could just keep the existing code. The only risk is if
encoding/base64behavior changes in the future.See also CL 653675 which aims to fix the same issue in
encoding/pem.