Open
Conversation
jmayclin
reviewed
Feb 24, 2026
|
|
||
| int s2n_connection_peek_alert(struct s2n_connection *conn) | ||
| { | ||
| POSIX_ENSURE_REF(conn); |
Contributor
There was a problem hiding this comment.
Why does this have to be a new API? Can we just fix the behavior of the original s2n_connection_get_alert?
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.
Goal
Make Connection::alert non-mutating, since it takes a non-mut reference.
Why
Connection::alert can currently violate the borrow rules, which is dangerous. It also blocks reporting the error from the bindings: #5754
How
Add a private alternative "s2n_connection_peek_alert" C method that retrieves the alert without modifying the connection in any way. Swap that method into the bindings.
Callouts
This is arguably a behavior change, if a customer was relying on Connection::alert modifying the connection. But customers shouldn't expect a &self method to modify self, so this change should be way less risky than changing Connection::alert to take a &mut self.
Testing
Added C unit tests.
Related
#5754
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.