1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
|
import json
import os.path
import shutil
import socket
import tempfile
from test import (
LONG_TIMEOUT,
SHORT_TIMEOUT,
onlyPy2,
onlyPy3,
onlySecureTransport,
withPyOpenSSL,
)
import pytest
import trustme
from dummyserver.server import DEFAULT_CA, HAS_IPV6, get_unreachable_address
from dummyserver.testcase import HTTPDummyProxyTestCase, IPv6HTTPDummyProxyTestCase
from urllib3._collections import HTTPHeaderDict
from urllib3.connectionpool import VerifiedHTTPSConnection, connection_from_url
from urllib3.exceptions import (
ConnectTimeoutError,
MaxRetryError,
ProxyError,
ProxySchemeUnknown,
ProxySchemeUnsupported,
SSLError,
)
from urllib3.poolmanager import ProxyManager, proxy_from_url
from urllib3.util.ssl_ import create_urllib3_context
from .. import TARPIT_HOST, requires_network
# Retry failed tests
pytestmark = pytest.mark.flaky
class TestHTTPProxyManager(HTTPDummyProxyTestCase):
@classmethod
def setup_class(cls):
super(TestHTTPProxyManager, cls).setup_class()
cls.http_url = "http://%s:%d" % (cls.http_host, cls.http_port)
cls.http_url_alt = "http://%s:%d" % (cls.http_host_alt, cls.http_port)
cls.https_url = "https://%s:%d" % (cls.https_host, cls.https_port)
cls.https_url_alt = "https://%s:%d" % (cls.https_host_alt, cls.https_port)
cls.proxy_url = "http://%s:%d" % (cls.proxy_host, cls.proxy_port)
cls.https_proxy_url = "https://%s:%d" % (
cls.proxy_host,
cls.https_proxy_port,
)
# Generate another CA to test verification failure
cls.certs_dir = tempfile.mkdtemp()
bad_ca = trustme.CA()
cls.bad_ca_path = os.path.join(cls.certs_dir, "ca_bad.pem")
bad_ca.cert_pem.write_to_path(cls.bad_ca_path)
@classmethod
def teardown_class(cls):
super(TestHTTPProxyManager, cls).teardown_class()
shutil.rmtree(cls.certs_dir)
def test_basic_proxy(self):
with proxy_from_url(self.proxy_url, ca_certs=DEFAULT_CA) as http:
r = http.request("GET", "%s/" % self.http_url)
assert r.status == 200
r = http.request("GET", "%s/" % self.https_url)
assert r.status == 200
@onlyPy3
def test_https_proxy(self):
with proxy_from_url(self.https_proxy_url, ca_certs=DEFAULT_CA) as https:
r = https.request("GET", "%s/" % self.https_url)
assert r.status == 200
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
@onlyPy3
def test_https_proxy_with_proxy_ssl_context(self):
proxy_ssl_context = create_urllib3_context()
proxy_ssl_context.load_verify_locations(DEFAULT_CA)
with proxy_from_url(
self.https_proxy_url,
proxy_ssl_context=proxy_ssl_context,
ca_certs=DEFAULT_CA,
) as https:
r = https.request("GET", "%s/" % self.https_url)
assert r.status == 200
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
@onlyPy2
def test_https_proxy_not_supported(self):
with proxy_from_url(self.https_proxy_url, ca_certs=DEFAULT_CA) as https:
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
with pytest.raises(ProxySchemeUnsupported) as excinfo:
https.request("GET", "%s/" % self.https_url)
assert "is not supported in Python 2" in str(excinfo.value)
@withPyOpenSSL
@onlyPy3
def test_https_proxy_pyopenssl_not_supported(self):
with proxy_from_url(self.https_proxy_url, ca_certs=DEFAULT_CA) as https:
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
with pytest.raises(ProxySchemeUnsupported) as excinfo:
https.request("GET", "%s/" % self.https_url)
assert "isn't available on non-native SSLContext" in str(excinfo.value)
@onlySecureTransport
@onlyPy3
def test_https_proxy_securetransport_not_supported(self):
with proxy_from_url(self.https_proxy_url, ca_certs=DEFAULT_CA) as https:
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
with pytest.raises(ProxySchemeUnsupported) as excinfo:
https.request("GET", "%s/" % self.https_url)
assert "isn't available on non-native SSLContext" in str(excinfo.value)
def test_https_proxy_forwarding_for_https(self):
with proxy_from_url(
self.https_proxy_url,
ca_certs=DEFAULT_CA,
use_forwarding_for_https=True,
) as https:
r = https.request("GET", "%s/" % self.http_url)
assert r.status == 200
r = https.request("GET", "%s/" % self.https_url)
assert r.status == 200
def test_nagle_proxy(self):
"""Test that proxy connections do not have TCP_NODELAY turned on"""
with ProxyManager(self.proxy_url) as http:
hc2 = http.connection_from_host(self.http_host, self.http_port)
conn = hc2._get_conn()
try:
hc2._make_request(conn, "GET", "/")
tcp_nodelay_setting = conn.sock.getsockopt(
socket.IPPROTO_TCP, socket.TCP_NODELAY
)
assert tcp_nodelay_setting == 0, (
"Expected TCP_NODELAY for proxies to be set "
"to zero, instead was %s" % tcp_nodelay_setting
)
finally:
conn.close()
def test_proxy_conn_fail(self):
host, port = get_unreachable_address()
with proxy_from_url(
"http://%s:%s/" % (host, port), retries=1, timeout=LONG_TIMEOUT
) as http:
with pytest.raises(MaxRetryError):
http.request("GET", "%s/" % self.https_url)
with pytest.raises(MaxRetryError):
http.request("GET", "%s/" % self.http_url)
with pytest.raises(MaxRetryError) as e:
http.request("GET", "%s/" % self.http_url)
assert type(e.value.reason) == ProxyError
def test_oldapi(self):
with ProxyManager(
connection_from_url(self.proxy_url), ca_certs=DEFAULT_CA
) as http:
r = http.request("GET", "%s/" % self.http_url)
assert r.status == 200
r = http.request("GET", "%s/" % self.https_url)
assert r.status == 200
def test_proxy_verified(self):
with proxy_from_url(
self.proxy_url, cert_reqs="REQUIRED", ca_certs=self.bad_ca_path
) as http:
https_pool = http._new_pool("https", self.https_host, self.https_port)
with pytest.raises(MaxRetryError) as e:
https_pool.request("GET", "/", retries=0)
assert isinstance(e.value.reason, SSLError)
assert "certificate verify failed" in str(e.value.reason), (
"Expected 'certificate verify failed', instead got: %r" % e.value.reason
)
http = proxy_from_url(
self.proxy_url, cert_reqs="REQUIRED", ca_certs=DEFAULT_CA
)
https_pool = http._new_pool("https", self.https_host, self.https_port)
conn = https_pool._new_conn()
assert conn.__class__ == VerifiedHTTPSConnection
https_pool.request("GET", "/") # Should succeed without exceptions.
http = proxy_from_url(
self.proxy_url, cert_reqs="REQUIRED", ca_certs=DEFAULT_CA
)
https_fail_pool = http._new_pool("https", "127.0.0.1", self.https_port)
with pytest.raises(MaxRetryError) as e:
https_fail_pool.request("GET", "/", retries=0)
assert isinstance(e.value.reason, SSLError)
assert "doesn't match" in str(e.value.reason)
def test_redirect(self):
with proxy_from_url(self.proxy_url) as http:
r = http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": "%s/" % self.http_url},
redirect=False,
)
assert r.status == 303
r = http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": "%s/" % self.http_url},
)
assert r.status == 200
assert r.data == b"Dummy server!"
def test_cross_host_redirect(self):
with proxy_from_url(self.proxy_url) as http:
cross_host_location = "%s/echo?a=b" % self.http_url_alt
with pytest.raises(MaxRetryError):
http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": cross_host_location},
retries=0,
)
r = http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": "%s/echo?a=b" % self.http_url_alt},
retries=1,
)
assert r._pool.host != self.http_host_alt
def test_cross_protocol_redirect(self):
with proxy_from_url(self.proxy_url, ca_certs=DEFAULT_CA) as http:
cross_protocol_location = "%s/echo?a=b" % self.https_url
with pytest.raises(MaxRetryError):
http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": cross_protocol_location},
retries=0,
)
r = http.request(
"GET",
"%s/redirect" % self.http_url,
fields={"target": "%s/echo?a=b" % self.https_url},
retries=1,
)
assert r._pool.host == self.https_host
def test_headers(self):
with proxy_from_url(
self.proxy_url,
headers={"Foo": "bar"},
proxy_headers={"Hickory": "dickory"},
ca_certs=DEFAULT_CA,
) as http:
r = http.request_encode_url("GET", "%s/headers" % self.http_url)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host,
self.http_port,
)
r = http.request_encode_url("GET", "%s/headers" % self.http_url_alt)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host_alt,
self.http_port,
)
r = http.request_encode_url("GET", "%s/headers" % self.https_url)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") is None
assert returned_headers.get("Host") == "%s:%s" % (
self.https_host,
self.https_port,
)
r = http.request_encode_body("POST", "%s/headers" % self.http_url)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host,
self.http_port,
)
r = http.request_encode_url(
"GET", "%s/headers" % self.http_url, headers={"Baz": "quux"}
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") is None
assert returned_headers.get("Baz") == "quux"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host,
self.http_port,
)
r = http.request_encode_url(
"GET", "%s/headers" % self.https_url, headers={"Baz": "quux"}
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") is None
assert returned_headers.get("Baz") == "quux"
assert returned_headers.get("Hickory") is None
assert returned_headers.get("Host") == "%s:%s" % (
self.https_host,
self.https_port,
)
r = http.request_encode_body(
"GET", "%s/headers" % self.http_url, headers={"Baz": "quux"}
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") is None
assert returned_headers.get("Baz") == "quux"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host,
self.http_port,
)
r = http.request_encode_body(
"GET", "%s/headers" % self.https_url, headers={"Baz": "quux"}
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") is None
assert returned_headers.get("Baz") == "quux"
assert returned_headers.get("Hickory") is None
assert returned_headers.get("Host") == "%s:%s" % (
self.https_host,
self.https_port,
)
@onlyPy3
def test_https_headers(self):
with proxy_from_url(
self.https_proxy_url,
headers={"Foo": "bar"},
proxy_headers={"Hickory": "dickory"},
ca_certs=DEFAULT_CA,
) as http:
r = http.request_encode_url("GET", "%s/headers" % self.http_url)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host,
self.http_port,
)
r = http.request_encode_url("GET", "%s/headers" % self.http_url_alt)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.http_host_alt,
self.http_port,
)
r = http.request_encode_body(
"GET", "%s/headers" % self.https_url, headers={"Baz": "quux"}
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") is None
assert returned_headers.get("Baz") == "quux"
assert returned_headers.get("Hickory") is None
assert returned_headers.get("Host") == "%s:%s" % (
self.https_host,
self.https_port,
)
def test_https_headers_forwarding_for_https(self):
with proxy_from_url(
self.https_proxy_url,
headers={"Foo": "bar"},
proxy_headers={"Hickory": "dickory"},
ca_certs=DEFAULT_CA,
use_forwarding_for_https=True,
) as http:
r = http.request_encode_url("GET", "%s/headers" % self.https_url)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Hickory") == "dickory"
assert returned_headers.get("Host") == "%s:%s" % (
self.https_host,
self.https_port,
)
def test_headerdict(self):
default_headers = HTTPHeaderDict(a="b")
proxy_headers = HTTPHeaderDict()
proxy_headers.add("foo", "bar")
with proxy_from_url(
self.proxy_url, headers=default_headers, proxy_headers=proxy_headers
) as http:
request_headers = HTTPHeaderDict(baz="quux")
r = http.request(
"GET", "%s/headers" % self.http_url, headers=request_headers
)
returned_headers = json.loads(r.data.decode())
assert returned_headers.get("Foo") == "bar"
assert returned_headers.get("Baz") == "quux"
def test_proxy_pooling(self):
with proxy_from_url(self.proxy_url, cert_reqs="NONE") as http:
for x in range(2):
http.urlopen("GET", self.http_url)
assert len(http.pools) == 1
for x in range(2):
http.urlopen("GET", self.http_url_alt)
assert len(http.pools) == 1
for x in range(2):
http.urlopen("GET", self.https_url)
assert len(http.pools) == 2
for x in range(2):
http.urlopen("GET", self.https_url_alt)
assert len(http.pools) == 3
def test_proxy_pooling_ext(self):
with proxy_from_url(self.proxy_url) as http:
hc1 = http.connection_from_url(self.http_url)
hc2 = http.connection_from_host(self.http_host, self.http_port)
hc3 = http.connection_from_url(self.http_url_alt)
hc4 = http.connection_from_host(self.http_host_alt, self.http_port)
assert hc1 == hc2
assert hc2 == hc3
assert hc3 == hc4
sc1 = http.connection_from_url(self.https_url)
sc2 = http.connection_from_host(
self.https_host, self.https_port, scheme="https"
)
sc3 = http.connection_from_url(self.https_url_alt)
sc4 = http.connection_from_host(
self.https_host_alt, self.https_port, scheme="https"
)
assert sc1 == sc2
assert sc2 != sc3
assert sc3 == sc4
@pytest.mark.timeout(0.5)
@requires_network
def test_https_proxy_timeout(self):
with proxy_from_url("https://{host}".format(host=TARPIT_HOST)) as https:
with pytest.raises(MaxRetryError) as e:
https.request("GET", self.http_url, timeout=SHORT_TIMEOUT)
assert type(e.value.reason) == ConnectTimeoutError
@pytest.mark.timeout(0.5)
@requires_network
def test_https_proxy_pool_timeout(self):
with proxy_from_url(
"https://{host}".format(host=TARPIT_HOST), timeout=SHORT_TIMEOUT
) as https:
with pytest.raises(MaxRetryError) as e:
https.request("GET", self.http_url)
assert type(e.value.reason) == ConnectTimeoutError
def test_scheme_host_case_insensitive(self):
"""Assert that upper-case schemes and hosts are normalized."""
with proxy_from_url(self.proxy_url.upper(), ca_certs=DEFAULT_CA) as http:
r = http.request("GET", "%s/" % self.http_url.upper())
assert r.status == 200
r = http.request("GET", "%s/" % self.https_url.upper())
assert r.status == 200
@pytest.mark.parametrize(
"url, error_msg",
[
(
"127.0.0.1",
"Proxy URL had no scheme, should start with http:// or https://",
),
(
"localhost:8080",
"Proxy URL had no scheme, should start with http:// or https://",
),
(
"ftp://google.com",
"Proxy URL had unsupported scheme ftp, should use http:// or https://",
),
],
)
def test_invalid_schema(self, url, error_msg):
with pytest.raises(ProxySchemeUnknown, match=error_msg):
proxy_from_url(url)
@pytest.mark.skipif(not HAS_IPV6, reason="Only runs on IPv6 systems")
class TestIPv6HTTPProxyManager(IPv6HTTPDummyProxyTestCase):
@classmethod
def setup_class(cls):
HTTPDummyProxyTestCase.setup_class()
cls.http_url = "http://%s:%d" % (cls.http_host, cls.http_port)
cls.http_url_alt = "http://%s:%d" % (cls.http_host_alt, cls.http_port)
cls.https_url = "https://%s:%d" % (cls.https_host, cls.https_port)
cls.https_url_alt = "https://%s:%d" % (cls.https_host_alt, cls.https_port)
cls.proxy_url = "http://[%s]:%d" % (cls.proxy_host, cls.proxy_port)
def test_basic_ipv6_proxy(self):
with proxy_from_url(self.proxy_url, ca_certs=DEFAULT_CA) as http:
r = http.request("GET", "%s/" % self.http_url)
assert r.status == 200
r = http.request("GET", "%s/" % self.https_url)
assert r.status == 200
class TestHTTPSProxyVerification:
@onlyPy3
def test_https_proxy_hostname_verification(self, no_localhost_san_server):
bad_server = no_localhost_san_server
bad_proxy_url = "https://%s:%s" % (bad_server.host, bad_server.port)
# An exception will be raised before we contact the destination domain.
test_url = "testing.com"
with proxy_from_url(bad_proxy_url, ca_certs=bad_server.ca_certs) as https:
with pytest.raises(MaxRetryError) as e:
https.request("GET", "http://%s/" % test_url)
assert isinstance(e.value.reason, SSLError)
assert "hostname 'localhost' doesn't match" in str(e.value.reason)
with pytest.raises(MaxRetryError) as e:
https.request("GET", "https://%s/" % test_url)
assert isinstance(e.value.reason, SSLError)
assert "hostname 'localhost' doesn't match" in str(
e.value.reason
) or "Hostname mismatch" in str(e.value.reason)
|