[release/5.0] Fix NegotiateStream handling of EOF #43741
Merged
Conversation
This file contains 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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
In my refactoring of NegotiateStream to use async/await, I broke its handling of EOF, with it throwing an exception instead of returning 0. This fixes it to correctly handle EOF.
geoffkizer
approved these changes
Oct 23, 2020
|
The last commit is 5.0-only, correct? |
|
Yes |
|
Waiting for 5.0.1 |
leecow
added
Servicing-approved
|
Approved, waiting for branch to open mid Nov |
|
Tactics comments: OK for 5.0.1, for later servicing we might want to wait for customer evidence of impact. |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Backport of #43739 to release/5.0
/cc @stephentoub
Customer Impact
Due to a refactoring during 5.0, reaching EOF in a NegotiateStream would throw rather than return 0 or -1 as it should. This is a regression from previous releases.
To my knowledge (and http://index, http://source.dot.net, http://grep.app, and https://apisof.net/catalog/System.Net.Security.NegotiateStream), there are very few consumers of NegotiateStream… except for WCF, which has a strong dependency. However, WCF explicitly avoids this pattern, never reading via the NegotiateStream to its end, and as such, it avoids this bug. So, while this would be quickly hit on .NET 5 for anyone using NegotiateStream with typical consumption patterns, it’s probable it’ll impact few to no codebases immediately.
Testing
This was found while writing a new test suite for stream conformance in general and applying it to NegotiateStream. With the fix, all existing and new tests pass.
Risk
Low. The fix is isolated and easily reviewed for correctness.