Skip to content
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

Jump to bottom

Wrap BaseSSLError into SSLError during response reads #1939

Merged
merged 2 commits into from Aug 31, 2020
Merged

Wrap BaseSSLError into SSLError during response reads #1939

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
cb80f84
Wrap BaseSSLError into SSLError during response reads
sethmlarson Aug 28, 2020
fcb90ef
Add testcase for SSLError on read()
sethmlarson Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/urllib3/response.py
View file
Open in desktop
Expand Up @@ -22,6 +22,7 @@
InvalidChunkLength,
InvalidHeader,
HTTPError,
SSLError,
)
from .packages.six import string_types as basestring, PY3
from .connection import HTTPException, BaseSSLError
Expand Down Expand Up @@ -443,9 +444,8 @@ def _error_catcher(self):
except BaseSSLError as e:
# FIXME: Is there a better way to differentiate between SSLErrors?
if "read operation timed out" not in str(e): # Defensive:
Copy link
Member

Choose a reason for hiding this comment

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

Can we remove that Defensive pragma? Without that, I think we won't get coverage information for that condition.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh yeah, I'll remove that :) Nice catch!

# This shouldn't happen but just in case we're missing an edge
# case, let's avoid swallowing SSL errors.
raise
# SSL errors related to framing/MAC get wrapped and reraised here
raise SSLError(e)

raise ReadTimeoutError(self._pool, None, "Read timed out.")

Expand Down
27 changes: 27 additions & 0 deletions test/test_response.py
View file
Open in desktop
@@ -1,7 +1,9 @@
# -*- coding: utf-8 -*-

import contextlib
import re
import socket
import ssl
import zlib

from io import BytesIO, BufferedReader, TextIOWrapper
Expand All @@ -19,6 +21,7 @@
httplib_IncompleteRead,
IncompleteRead,
InvalidChunkLength,
SSLError,
)
from urllib3.packages.six.moves import http_client as httplib
from urllib3.util.retry import Retry, RequestHistory
Expand Down Expand Up @@ -936,6 +939,30 @@ def stream():

assert b"foo\nbar" == data

def test_non_timeout_ssl_error_on_read(self):
mac_error = ssl.SSLError(
"SSL routines", "ssl3_get_record", "decryption failed or bad record mac"
)

@contextlib.contextmanager
def make_bad_mac_fp():
fp = BytesIO(b"")
with mock.patch.object(fp, "read") as fp_read:
# mac/decryption error
fp_read.side_effect = mac_error
yield fp

with make_bad_mac_fp() as fp:
with pytest.raises(SSLError) as e:
HTTPResponse(fp)
assert e.value.args[0] == mac_error

with make_bad_mac_fp() as fp:
resp = HTTPResponse(fp, preload_content=False)
with pytest.raises(SSLError) as e:
resp.read()
assert e.value.args[0] == mac_error


class MockChunkedEncodingResponse(object):
def __init__(self, content):
Expand Down