bindings: fix handling of s2n_shutdown errors #4358
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
lrstewart
force-pushed
the
blinding_tokio
branch
2 times, most recently
from
b8cca66 to
7670de4
Compare
jmayclin
reviewed
Jan 18, 2024
| // write the close_notify message that the server needs. | ||
| // Because time is mocked for testing, this does not actually take 10 minutes. | ||
| // TODO: replace this with a half-close once the bindings support half-close. | ||
| _ = time::timeout(time::Duration::from_secs(600), client.shutdown()).await; |
There was a problem hiding this comment.
Not necessarily in this PR, but I think we should add this as a suggestion in our documentation.
Note that shutdown().await will wait for peer acknowledgement for an unbounded amount of time. Resource sensitive consumers should consider calling shutdown with an explicit timeout added
Or something like that.
camshaft
reviewed
Jan 18, 2024
lrstewart
force-pushed
the
blinding_tokio
branch
from
573519f to
0a0107a
Compare
camshaft
reviewed
Jan 18, 2024
Comment on lines
+381
to
+386
| // poll methods shouldn't be called again after returning Ready, but | ||
| // nothing actually prevents it so poll_shutdown should handle it. | ||
| // s2n_shutdown can be polled indefinitely after succeeding, but not after failing. | ||
| // s2n_tls::error::Error isn't cloneable, so we can't just return the same error | ||
| // if poll_shutdown is called again. Instead, save a different error. | ||
| let next_error = Error::application("Shutdown called again after error".into()); |
camshaft
approved these changes
Jan 18, 2024
jmayclin
approved these changes
Jan 19, 2024
jmayclin
pushed a commit
to jmayclin/s2n-tls
that referenced
this pull request
Jan 20, 2024
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.
Description of changes:
I think I found a bug in shutdown. If s2n_shutdown fails, we never close the underlying stream. I fixed it and added new tests for the interaction between s2n_shutdown failures and underlying stream failures.
I also refactored the blinding / shutdown logic. Previously, blinding and shutdown errors were all tangled up; polling blinding could actually return a previous shutdown error and we stored shutdown errors by calling set_blinding_timer. It made the flow of shutdown very hard to follow. Blinding and shutdown errors are unrelated and can/should be handled by completely separate logic and state.
Testing:
New tests of s2n_shutdown errors in shutdown, particularly the interaction with tcp shutdown.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.