Skip to content

gh-109051: fix start_tls() on paused-for-writing transport #109603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sorcio
Copy link
Contributor

@sorcio sorcio commented Sep 20, 2023

Added a writing_paused argument to SSLProtocol() so it can wrap the existing transport+protocol in any state. Also added a test to specifically trigger the failing case on any platform.

@sorcio
Copy link
Contributor Author

sorcio commented Sep 20, 2023

CI failure is unrelated to this, already reported: #109582

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @1st1

# as possible.
_, high_water = transport.get_write_buffer_limits()
buffer_size = transport.get_write_buffer_size()
writing_paused = buffer_size > high_water
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it safe to only use this code path? (remove fast-path for _FlowControlMixin)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, and I'm not sure. I saw the pattern used by _SendfileFallbackProtocol which checks for the mixin. It's the only other outstanding use case for set_protocol() in the stdlib.

Pedantically speaking, the documentation doesn't make an unambiguous claim that pause_writing() is called instantly when the buffer is filled above the high water mark, or that a background thread (or a proactor callback? I don't truly understand that part) doesn't drain the buffer in a way that is accidentally observable. But I don't think any transport in the stdlib is susceptible to this.

A notable case happens if the high water mark is increased while paused, and before start_tls. In the current implementation, the limit returned by get_write_buffer_limits() would be the increased one, but resume_writing() would not be called yet until the next opportunity to drain.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In short, the answer is no, I don't think it would be safe. But I'd defer to an asyncio expert.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case of doubt, keep the specific code path for _FlowControlMixin.

@vstinner
Copy link
Member

vstinner commented Nov 8, 2023

@kumaraditya303 @willingc @gvanrossum: How do you feel about reviewing this asyncio fix for SSL? Do you know someone who can review such change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants