Skip to content

[3.7] bpo-34745: Fix asyncio sslproto memory issues (GH-12386) #12387

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

Merged
merged 1 commit into from
Mar 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions Lib/asyncio/sslproto.py
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,11 @@ def connection_lost(self, exc):
self._app_transport._closed = True
self._transport = None
self._app_transport = None
if getattr(self, '_handshake_timeout_handle', None):
self._handshake_timeout_handle.cancel()
self._wakeup_waiter(exc)
self._app_protocol = None
self._sslpipe = None

def pause_writing(self):
"""Called when the low-level transport's buffer goes over
Expand Down
72 changes: 72 additions & 0 deletions Lib/test/test_asyncio/test_sslproto.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import socket
import sys
import unittest
import weakref
from unittest import mock
try:
import ssl
Expand Down Expand Up @@ -270,6 +271,72 @@ async def client(addr):
self.loop.run_until_complete(
asyncio.wait_for(client(srv.addr), loop=self.loop, timeout=10))

# No garbage is left if SSL is closed uncleanly
client_context = weakref.ref(client_context)
self.assertIsNone(client_context())

def test_create_connection_memory_leak(self):
HELLO_MSG = b'1' * self.PAYLOAD_SIZE

server_context = test_utils.simple_server_sslcontext()
client_context = test_utils.simple_client_sslcontext()

def serve(sock):
sock.settimeout(self.TIMEOUT)

sock.start_tls(server_context, server_side=True)

sock.sendall(b'O')
data = sock.recv_all(len(HELLO_MSG))
self.assertEqual(len(data), len(HELLO_MSG))

sock.shutdown(socket.SHUT_RDWR)
sock.close()

class ClientProto(asyncio.Protocol):
def __init__(self, on_data, on_eof):
self.on_data = on_data
self.on_eof = on_eof
self.con_made_cnt = 0

def connection_made(proto, tr):
# XXX: We assume user stores the transport in protocol
proto.tr = tr
proto.con_made_cnt += 1
# Ensure connection_made gets called only once.
self.assertEqual(proto.con_made_cnt, 1)

def data_received(self, data):
self.on_data.set_result(data)

def eof_received(self):
self.on_eof.set_result(True)

async def client(addr):
await asyncio.sleep(0.5)

on_data = self.loop.create_future()
on_eof = self.loop.create_future()

tr, proto = await self.loop.create_connection(
lambda: ClientProto(on_data, on_eof), *addr,
ssl=client_context)

self.assertEqual(await on_data, b'O')
tr.write(HELLO_MSG)
await on_eof

tr.close()

with self.tcp_server(serve, timeout=self.TIMEOUT) as srv:
self.loop.run_until_complete(
asyncio.wait_for(client(srv.addr), timeout=10))

# No garbage is left for SSL client from loop.create_connection, even
# if user stores the SSLTransport in corresponding protocol instance
client_context = weakref.ref(client_context)
self.assertIsNone(client_context())

def test_start_tls_client_buf_proto_1(self):
HELLO_MSG = b'1' * self.PAYLOAD_SIZE

Expand Down Expand Up @@ -560,6 +627,11 @@ async def client(addr):
# exception or log an error, even if the handshake failed
self.assertEqual(messages, [])

# The 10s handshake timeout should be cancelled to free related
# objects without really waiting for 10s
client_sslctx = weakref.ref(client_sslctx)
self.assertIsNone(client_sslctx())

def test_create_connection_ssl_slow_handshake(self):
client_sslctx = test_utils.simple_client_sslcontext()

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix :mod:`asyncio` ssl memory issues caused by circular references