Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-29406: asyncio SSL contexts leak sockets after calling close with certain servers #409

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 10, 2017
Merged

bpo-29406: asyncio SSL contexts leak sockets after calling close with certain servers #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4eb6ae
asyncio SSL contexts leak sockets after calling close with certain se…
fafhrd91 Mar 3, 2017
31d625a
cleanup _shutdown_timeout_handle on _fatal_error
fafhrd91 Jun 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion Lib/asyncio/sslproto.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
ssl = None

from . import base_events
from . import compat
from . import futures
from . import protocols
from . import transports
from .log import logger
Expand Down Expand Up @@ -407,7 +409,7 @@ class SSLProtocol(protocols.Protocol):

def __init__(self, loop, app_protocol, sslcontext, waiter,
server_side=False, server_hostname=None,
call_connection_made=True):
call_connection_made=True, shutdown_timeout=5.0):
Copy link
Member

Choose a reason for hiding this comment

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

Why is it 5 seconds? Is this some timeout value defined in some SSL RFC?

if ssl is None:
raise RuntimeError('stdlib ssl module not available')

Expand Down Expand Up @@ -438,6 +440,8 @@ def __init__(self, loop, app_protocol, sslcontext, waiter,
self._session_established = False
self._in_handshake = False
self._in_shutdown = False
self._shutdown_timeout = shutdown_timeout
self._shutdown_timeout_handle = None
# transport, ex: SelectorSocketTransport
self._transport = None
self._call_connection_made = call_connection_made
Expand Down Expand Up @@ -552,6 +556,15 @@ def _start_shutdown(self):
self._in_shutdown = True
self._write_appdata(b'')

if self._shutdown_timeout is not None:
self._shutdown_timeout_handle = self._loop.call_later(
self._shutdown_timeout, self._on_shutdown_timeout)

def _on_shutdown_timeout(self):
if self._transport is not None:
self._fatal_error(
futures.TimeoutError(), 'Can not complete shitdown operation')

def _write_appdata(self, data):
self._write_backlog.append((data, 0))
self._write_buffer_size += len(data)
Expand Down Expand Up @@ -679,12 +692,22 @@ def _fatal_error(self, exc, message='Fatal error on transport'):
})
if self._transport:
self._transport._force_close(exc)
self._transport = None
Copy link
Member

Choose a reason for hiding this comment

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

Should we also cleanup _shutdown_timeout_handle here?

Copy link
Member

Choose a reason for hiding this comment

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

Should fatal_error just call finalize?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think that makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added cleanup code for _shutdown_timeout_handle, it is possible to get here while handle still active


if self._shutdown_timeout_handle is not None:
self._shutdown_timeout_handle.cancel()
self._shutdown_timeout_handle = None

def _finalize(self):
self._sslpipe = None

if self._transport is not None:
self._transport.close()
self._transport = None

if self._shutdown_timeout_handle is not None:
self._shutdown_timeout_handle.cancel()
self._shutdown_timeout_handle = None

def _abort(self):
try:
Expand Down
34 changes: 34 additions & 0 deletions Lib/test/test_asyncio/test_sslproto.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,40 @@ def test_connection_lost(self):
test_utils.run_briefly(self.loop)
self.assertIsInstance(waiter.exception(), ConnectionAbortedError)

def test_close_abort(self):
# From issue #bpo-29406
# abort connection if server does not complete shutdown procedure
ssl_proto = self.ssl_protocol()
transport = self.connection_made(ssl_proto)
ssl_proto._on_handshake_complete(None)
ssl_proto._start_shutdown()
self.assertIsNotNone(ssl_proto._shutdown_timeout_handle)

exc_handler = mock.Mock()
self.loop.set_exception_handler(exc_handler)
ssl_proto._shutdown_timeout_handle._run()

exc_handler.assert_called_with(
self.loop, {'message': 'Can not complete shitdown operation',
'exception': mock.ANY,
'transport': transport,
'protocol': ssl_proto}
)
self.assertIsNone(ssl_proto._shutdown_timeout_handle)

def test_close(self):
# From issue #bpo-29406
# abort connection if server does not complete shutdown procedure
ssl_proto = self.ssl_protocol()
transport = self.connection_made(ssl_proto)
ssl_proto._on_handshake_complete(None)
ssl_proto._start_shutdown()
self.assertIsNotNone(ssl_proto._shutdown_timeout_handle)

ssl_proto._finalize()
self.assertIsNone(ssl_proto._transport)
self.assertIsNone(ssl_proto._shutdown_timeout_handle)

def test_close_during_handshake(self):
# bpo-29743 Closing transport during handshake process leaks socket
waiter = asyncio.Future(loop=self.loop)
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,10 @@ Library
- bpo-29743: Closing transport during handshake process leaks open socket.
Patch by Nikolay Kim

- bpo-29406: asyncio SSL contexts leak sockets after calling close with
certain servers.
Patch by Nikolay Kim

- bpo-27585: Fix waiter cancellation in asyncio.Lock.
Patch by Mathieu Sornay.

Expand Down