blob: 5916a2bcf160ec11bbe8462450b40041d05759ce [file] [log] [blame]
Thomas Woutersed03b412007-08-28 21:37:11 +00001# Test the support for SSL and sockets
2
3import sys
4import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00005from test import support
Thomas Woutersed03b412007-08-28 21:37:11 +00006import socket
Bill Janssen6e027db2007-11-15 22:23:56 +00007import select
Thomas Woutersed03b412007-08-28 21:37:11 +00008import time
Christian Heimes9424bb42013-06-17 15:32:57 +02009import datetime
Antoine Pitroucfcd8ad2010-04-23 23:31:47 +000010import gc
Thomas Woutersed03b412007-08-28 21:37:11 +000011import os
Antoine Pitroucfcd8ad2010-04-23 23:31:47 +000012import errno
Thomas Woutersed03b412007-08-28 21:37:11 +000013import pprint
Antoine Pitrou803e6d62010-10-13 10:36:15 +000014import urllib.request
Thomas Woutersed03b412007-08-28 21:37:11 +000015import traceback
Bill Janssen54cc54c2007-12-14 22:08:56 +000016import asyncore
Antoine Pitrou9d543662010-04-23 23:10:32 +000017import weakref
Antoine Pitrou15cee622010-08-04 16:45:21 +000018import platform
Antoine Pitrou23df4832010-08-04 17:14:06 +000019import functools
Thomas Woutersed03b412007-08-28 21:37:11 +000020
Antoine Pitrou05d936d2010-10-13 11:38:36 +000021ssl = support.import_module("ssl")
22
Martin Panter3840b2a2016-03-27 01:53:46 +000023try:
24 import threading
25except ImportError:
26 _have_threads = False
27else:
28 _have_threads = True
29
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010030PROTOCOLS = sorted(ssl._PROTOCOL_NAMES)
Benjamin Petersonee8712c2008-05-20 21:35:26 +000031HOST = support.HOST
Christian Heimes598894f2016-09-05 23:19:05 +020032IS_LIBRESSL = ssl.OPENSSL_VERSION.startswith('LibreSSL')
33IS_OPENSSL_1_1 = not IS_LIBRESSL and ssl.OPENSSL_VERSION_INFO >= (1, 1, 0)
34
Antoine Pitrou152efa22010-05-16 18:19:27 +000035
Christian Heimesefff7062013-11-21 03:35:02 +010036def data_file(*name):
37 return os.path.join(os.path.dirname(__file__), *name)
Antoine Pitrou152efa22010-05-16 18:19:27 +000038
Antoine Pitrou81564092010-10-08 23:06:24 +000039# The custom key and certificate files used in test_ssl are generated
40# using Lib/test/make_ssl_certs.py.
41# Other certificates are simply fetched from the Internet servers they
42# are meant to authenticate.
43
Antoine Pitrou152efa22010-05-16 18:19:27 +000044CERTFILE = data_file("keycert.pem")
Victor Stinner313a1202010-06-11 23:56:51 +000045BYTES_CERTFILE = os.fsencode(CERTFILE)
Antoine Pitrou152efa22010-05-16 18:19:27 +000046ONLYCERT = data_file("ssl_cert.pem")
47ONLYKEY = data_file("ssl_key.pem")
Victor Stinner313a1202010-06-11 23:56:51 +000048BYTES_ONLYCERT = os.fsencode(ONLYCERT)
49BYTES_ONLYKEY = os.fsencode(ONLYKEY)
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020050CERTFILE_PROTECTED = data_file("keycert.passwd.pem")
51ONLYKEY_PROTECTED = data_file("ssl_key.passwd.pem")
52KEY_PASSWORD = "somepass"
Antoine Pitrou152efa22010-05-16 18:19:27 +000053CAPATH = data_file("capath")
Victor Stinner313a1202010-06-11 23:56:51 +000054BYTES_CAPATH = os.fsencode(CAPATH)
Christian Heimesefff7062013-11-21 03:35:02 +010055CAFILE_NEURONIO = data_file("capath", "4e1295a3.0")
56CAFILE_CACERT = data_file("capath", "5ed36f99.0")
57
Antoine Pitrou152efa22010-05-16 18:19:27 +000058
Christian Heimes22587792013-11-21 23:56:13 +010059# empty CRL
60CRLFILE = data_file("revocation.crl")
61
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +010062# Two keys and certs signed by the same CA (for SNI tests)
63SIGNED_CERTFILE = data_file("keycert3.pem")
64SIGNED_CERTFILE2 = data_file("keycert4.pem")
Martin Panter3840b2a2016-03-27 01:53:46 +000065# Same certificate as pycacert.pem, but without extra text in file
66SIGNING_CA = data_file("capath", "ceff1710.0")
Christian Heimes1c03abd2016-09-06 23:25:35 +020067# cert with all kinds of subject alt names
68ALLSANFILE = data_file("allsans.pem")
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +010069
Martin Panter3d81d932016-01-14 09:36:00 +000070REMOTE_HOST = "self-signed.pythontest.net"
Antoine Pitrou152efa22010-05-16 18:19:27 +000071
72EMPTYCERT = data_file("nullcert.pem")
73BADCERT = data_file("badcert.pem")
Martin Panter407b62f2016-01-30 03:41:43 +000074NONEXISTINGCERT = data_file("XXXnonexisting.pem")
Antoine Pitrou152efa22010-05-16 18:19:27 +000075BADKEY = data_file("badkey.pem")
Antoine Pitroud8c347a2011-10-01 19:20:25 +020076NOKIACERT = data_file("nokia.pem")
Christian Heimes824f7f32013-08-17 00:54:47 +020077NULLBYTECERT = data_file("nullbytecert.pem")
Antoine Pitrou152efa22010-05-16 18:19:27 +000078
Benjamin Petersona7eaf562015-04-02 00:04:06 -040079DHFILE = data_file("dh1024.pem")
Antoine Pitrou0e576f12011-12-22 10:03:38 +010080BYTES_DHFILE = os.fsencode(DHFILE)
Thomas Woutersed03b412007-08-28 21:37:11 +000081
Christian Heimes358cfd42016-09-10 22:43:48 +020082# Not defined in all versions of OpenSSL
83OP_NO_COMPRESSION = getattr(ssl, "OP_NO_COMPRESSION", 0)
84OP_SINGLE_DH_USE = getattr(ssl, "OP_SINGLE_DH_USE", 0)
85OP_SINGLE_ECDH_USE = getattr(ssl, "OP_SINGLE_ECDH_USE", 0)
86OP_CIPHER_SERVER_PREFERENCE = getattr(ssl, "OP_CIPHER_SERVER_PREFERENCE", 0)
87
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +010088
Thomas Woutersed03b412007-08-28 21:37:11 +000089def handle_error(prefix):
90 exc_format = ' '.join(traceback.format_exception(*sys.exc_info()))
Benjamin Petersonee8712c2008-05-20 21:35:26 +000091 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +000092 sys.stdout.write(prefix + exc_format)
Thomas Woutersed03b412007-08-28 21:37:11 +000093
Antoine Pitroub5218772010-05-21 09:56:06 +000094def can_clear_options():
95 # 0.9.8m or higher
Antoine Pitroub9ac25d2011-07-08 18:47:06 +020096 return ssl._OPENSSL_API_VERSION >= (0, 9, 8, 13, 15)
Antoine Pitroub5218772010-05-21 09:56:06 +000097
98def no_sslv2_implies_sslv3_hello():
99 # 0.9.7h or higher
100 return ssl.OPENSSL_VERSION_INFO >= (0, 9, 7, 8, 15)
101
Christian Heimes2427b502013-11-23 11:24:32 +0100102def have_verify_flags():
103 # 0.9.8 or higher
104 return ssl.OPENSSL_VERSION_INFO >= (0, 9, 8, 0, 15)
105
Antoine Pitrouc695c952014-04-28 20:57:36 +0200106def utc_offset(): #NOTE: ignore issues like #1647654
107 # local time = utc time + utc offset
108 if time.daylight and time.localtime().tm_isdst > 0:
109 return -time.altzone # seconds
110 return -time.timezone
111
Christian Heimes9424bb42013-06-17 15:32:57 +0200112def asn1time(cert_time):
113 # Some versions of OpenSSL ignore seconds, see #18207
114 # 0.9.8.i
115 if ssl._OPENSSL_API_VERSION == (0, 9, 8, 9, 15):
116 fmt = "%b %d %H:%M:%S %Y GMT"
117 dt = datetime.datetime.strptime(cert_time, fmt)
118 dt = dt.replace(second=0)
119 cert_time = dt.strftime(fmt)
120 # %d adds leading zero but ASN1_TIME_print() uses leading space
121 if cert_time[4] == "0":
122 cert_time = cert_time[:4] + " " + cert_time[5:]
123
124 return cert_time
Thomas Woutersed03b412007-08-28 21:37:11 +0000125
Antoine Pitrou23df4832010-08-04 17:14:06 +0000126# Issue #9415: Ubuntu hijacks their OpenSSL and forcefully disables SSLv2
127def skip_if_broken_ubuntu_ssl(func):
Victor Stinner3de49192011-05-09 00:42:58 +0200128 if hasattr(ssl, 'PROTOCOL_SSLv2'):
129 @functools.wraps(func)
130 def f(*args, **kwargs):
131 try:
132 ssl.SSLContext(ssl.PROTOCOL_SSLv2)
133 except ssl.SSLError:
134 if (ssl.OPENSSL_VERSION_INFO == (0, 9, 8, 15, 15) and
135 platform.linux_distribution() == ('debian', 'squeeze/sid', '')):
136 raise unittest.SkipTest("Patched Ubuntu OpenSSL breaks behaviour")
137 return func(*args, **kwargs)
138 return f
139 else:
140 return func
Antoine Pitrou23df4832010-08-04 17:14:06 +0000141
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100142needs_sni = unittest.skipUnless(ssl.HAS_SNI, "SNI support needed for this test")
143
Antoine Pitrou23df4832010-08-04 17:14:06 +0000144
Christian Heimesd0486372016-09-10 23:23:33 +0200145def test_wrap_socket(sock, ssl_version=ssl.PROTOCOL_TLS, *,
146 cert_reqs=ssl.CERT_NONE, ca_certs=None,
147 ciphers=None, certfile=None, keyfile=None,
148 **kwargs):
149 context = ssl.SSLContext(ssl_version)
150 if cert_reqs is not None:
151 context.verify_mode = cert_reqs
152 if ca_certs is not None:
153 context.load_verify_locations(ca_certs)
154 if certfile is not None or keyfile is not None:
155 context.load_cert_chain(certfile, keyfile)
156 if ciphers is not None:
157 context.set_ciphers(ciphers)
158 return context.wrap_socket(sock, **kwargs)
159
Antoine Pitrou152efa22010-05-16 18:19:27 +0000160class BasicSocketTests(unittest.TestCase):
Thomas Woutersed03b412007-08-28 21:37:11 +0000161
Antoine Pitrou480a1242010-04-28 21:37:09 +0000162 def test_constants(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000163 ssl.CERT_NONE
164 ssl.CERT_OPTIONAL
165 ssl.CERT_REQUIRED
Antoine Pitrou6db49442011-12-19 13:27:11 +0100166 ssl.OP_CIPHER_SERVER_PREFERENCE
Antoine Pitrou0e576f12011-12-22 10:03:38 +0100167 ssl.OP_SINGLE_DH_USE
Antoine Pitrouc135fa42012-02-19 21:22:39 +0100168 if ssl.HAS_ECDH:
169 ssl.OP_SINGLE_ECDH_USE
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +0100170 if ssl.OPENSSL_VERSION_INFO >= (1, 0):
171 ssl.OP_NO_COMPRESSION
Antoine Pitroud5323212010-10-22 18:19:07 +0000172 self.assertIn(ssl.HAS_SNI, {True, False})
Antoine Pitrou501da612011-12-21 09:27:41 +0100173 self.assertIn(ssl.HAS_ECDH, {True, False})
Thomas Woutersed03b412007-08-28 21:37:11 +0000174
Antoine Pitrou172f0252014-04-18 20:33:08 +0200175 def test_str_for_enums(self):
176 # Make sure that the PROTOCOL_* constants have enum-like string
177 # reprs.
Christian Heimes598894f2016-09-05 23:19:05 +0200178 proto = ssl.PROTOCOL_TLS
179 self.assertEqual(str(proto), '_SSLMethod.PROTOCOL_TLS')
Antoine Pitrou172f0252014-04-18 20:33:08 +0200180 ctx = ssl.SSLContext(proto)
181 self.assertIs(ctx.protocol, proto)
182
Antoine Pitrou480a1242010-04-28 21:37:09 +0000183 def test_random(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000184 v = ssl.RAND_status()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000185 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000186 sys.stdout.write("\n RAND_status is %d (%s)\n"
187 % (v, (v and "sufficient randomness") or
188 "insufficient randomness"))
Victor Stinner99c8b162011-05-24 12:05:19 +0200189
190 data, is_cryptographic = ssl.RAND_pseudo_bytes(16)
191 self.assertEqual(len(data), 16)
192 self.assertEqual(is_cryptographic, v == 1)
193 if v:
194 data = ssl.RAND_bytes(16)
195 self.assertEqual(len(data), 16)
Victor Stinner2e2baa92011-05-25 11:15:16 +0200196 else:
197 self.assertRaises(ssl.SSLError, ssl.RAND_bytes, 16)
Victor Stinner99c8b162011-05-24 12:05:19 +0200198
Victor Stinner1e81a392013-12-19 16:47:04 +0100199 # negative num is invalid
200 self.assertRaises(ValueError, ssl.RAND_bytes, -5)
201 self.assertRaises(ValueError, ssl.RAND_pseudo_bytes, -5)
202
Victor Stinnerbeeb5122014-11-28 13:28:25 +0100203 if hasattr(ssl, 'RAND_egd'):
204 self.assertRaises(TypeError, ssl.RAND_egd, 1)
205 self.assertRaises(TypeError, ssl.RAND_egd, 'foo', 1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000206 ssl.RAND_add("this is a random string", 75.0)
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +0200207 ssl.RAND_add(b"this is a random bytes object", 75.0)
208 ssl.RAND_add(bytearray(b"this is a random bytearray object"), 75.0)
Thomas Woutersed03b412007-08-28 21:37:11 +0000209
Christian Heimesf77b4b22013-08-21 13:26:05 +0200210 @unittest.skipUnless(os.name == 'posix', 'requires posix')
211 def test_random_fork(self):
212 status = ssl.RAND_status()
213 if not status:
214 self.fail("OpenSSL's PRNG has insufficient randomness")
215
216 rfd, wfd = os.pipe()
217 pid = os.fork()
218 if pid == 0:
219 try:
220 os.close(rfd)
221 child_random = ssl.RAND_pseudo_bytes(16)[0]
222 self.assertEqual(len(child_random), 16)
223 os.write(wfd, child_random)
224 os.close(wfd)
225 except BaseException:
226 os._exit(1)
227 else:
228 os._exit(0)
229 else:
230 os.close(wfd)
231 self.addCleanup(os.close, rfd)
232 _, status = os.waitpid(pid, 0)
233 self.assertEqual(status, 0)
234
235 child_random = os.read(rfd, 16)
236 self.assertEqual(len(child_random), 16)
237 parent_random = ssl.RAND_pseudo_bytes(16)[0]
238 self.assertEqual(len(parent_random), 16)
239
240 self.assertNotEqual(child_random, parent_random)
241
Antoine Pitrou480a1242010-04-28 21:37:09 +0000242 def test_parse_cert(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000243 # note that this uses an 'unofficial' function in _ssl.c,
244 # provided solely for this test, to exercise the certificate
245 # parsing code
Antoine Pitroufb046912010-11-09 20:21:19 +0000246 p = ssl._ssl._test_decode_cert(CERTFILE)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000247 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000248 sys.stdout.write("\n" + pprint.pformat(p) + "\n")
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200249 self.assertEqual(p['issuer'],
250 ((('countryName', 'XY'),),
251 (('localityName', 'Castle Anthrax'),),
252 (('organizationName', 'Python Software Foundation'),),
253 (('commonName', 'localhost'),))
254 )
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100255 # Note the next three asserts will fail if the keys are regenerated
Christian Heimes9424bb42013-06-17 15:32:57 +0200256 self.assertEqual(p['notAfter'], asn1time('Oct 5 23:01:56 2020 GMT'))
257 self.assertEqual(p['notBefore'], asn1time('Oct 8 23:01:56 2010 GMT'))
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200258 self.assertEqual(p['serialNumber'], 'D7C7381919AFC24E')
259 self.assertEqual(p['subject'],
260 ((('countryName', 'XY'),),
261 (('localityName', 'Castle Anthrax'),),
262 (('organizationName', 'Python Software Foundation'),),
263 (('commonName', 'localhost'),))
264 )
265 self.assertEqual(p['subjectAltName'], (('DNS', 'localhost'),))
266 # Issue #13034: the subjectAltName in some certificates
267 # (notably projects.developer.nokia.com:443) wasn't parsed
268 p = ssl._ssl._test_decode_cert(NOKIACERT)
269 if support.verbose:
270 sys.stdout.write("\n" + pprint.pformat(p) + "\n")
271 self.assertEqual(p['subjectAltName'],
272 (('DNS', 'projects.developer.nokia.com'),
273 ('DNS', 'projects.forum.nokia.com'))
274 )
Christian Heimesbd3a7f92013-11-21 03:40:15 +0100275 # extra OCSP and AIA fields
276 self.assertEqual(p['OCSP'], ('http://ocsp.verisign.com',))
277 self.assertEqual(p['caIssuers'],
278 ('http://SVRIntl-G3-aia.verisign.com/SVRIntlG3.cer',))
279 self.assertEqual(p['crlDistributionPoints'],
280 ('http://SVRIntl-G3-crl.verisign.com/SVRIntlG3.crl',))
Thomas Woutersed03b412007-08-28 21:37:11 +0000281
Christian Heimes824f7f32013-08-17 00:54:47 +0200282 def test_parse_cert_CVE_2013_4238(self):
283 p = ssl._ssl._test_decode_cert(NULLBYTECERT)
284 if support.verbose:
285 sys.stdout.write("\n" + pprint.pformat(p) + "\n")
286 subject = ((('countryName', 'US'),),
287 (('stateOrProvinceName', 'Oregon'),),
288 (('localityName', 'Beaverton'),),
289 (('organizationName', 'Python Software Foundation'),),
290 (('organizationalUnitName', 'Python Core Development'),),
291 (('commonName', 'null.python.org\x00example.org'),),
292 (('emailAddress', 'python-dev@python.org'),))
293 self.assertEqual(p['subject'], subject)
294 self.assertEqual(p['issuer'], subject)
Christian Heimes157c9832013-08-25 14:12:41 +0200295 if ssl._OPENSSL_API_VERSION >= (0, 9, 8):
296 san = (('DNS', 'altnull.python.org\x00example.com'),
297 ('email', 'null@python.org\x00user@example.org'),
298 ('URI', 'http://null.python.org\x00http://example.org'),
299 ('IP Address', '192.0.2.1'),
300 ('IP Address', '2001:DB8:0:0:0:0:0:1\n'))
301 else:
302 # OpenSSL 0.9.7 doesn't support IPv6 addresses in subjectAltName
303 san = (('DNS', 'altnull.python.org\x00example.com'),
304 ('email', 'null@python.org\x00user@example.org'),
305 ('URI', 'http://null.python.org\x00http://example.org'),
306 ('IP Address', '192.0.2.1'),
307 ('IP Address', '<invalid>'))
308
309 self.assertEqual(p['subjectAltName'], san)
Christian Heimes824f7f32013-08-17 00:54:47 +0200310
Christian Heimes1c03abd2016-09-06 23:25:35 +0200311 def test_parse_all_sans(self):
312 p = ssl._ssl._test_decode_cert(ALLSANFILE)
313 self.assertEqual(p['subjectAltName'],
314 (
315 ('DNS', 'allsans'),
316 ('othername', '<unsupported>'),
317 ('othername', '<unsupported>'),
318 ('email', 'user@example.org'),
319 ('DNS', 'www.example.org'),
320 ('DirName',
321 ((('countryName', 'XY'),),
322 (('localityName', 'Castle Anthrax'),),
323 (('organizationName', 'Python Software Foundation'),),
324 (('commonName', 'dirname example'),))),
325 ('URI', 'https://www.python.org/'),
326 ('IP Address', '127.0.0.1'),
327 ('IP Address', '0:0:0:0:0:0:0:1\n'),
328 ('Registered ID', '1.2.3.4.5')
329 )
330 )
331
Antoine Pitrou480a1242010-04-28 21:37:09 +0000332 def test_DER_to_PEM(self):
Martin Panter3d81d932016-01-14 09:36:00 +0000333 with open(CAFILE_CACERT, 'r') as f:
Antoine Pitrou480a1242010-04-28 21:37:09 +0000334 pem = f.read()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000335 d1 = ssl.PEM_cert_to_DER_cert(pem)
336 p2 = ssl.DER_cert_to_PEM_cert(d1)
337 d2 = ssl.PEM_cert_to_DER_cert(p2)
Antoine Pitrou18c913e2010-04-27 10:59:39 +0000338 self.assertEqual(d1, d2)
Antoine Pitrou9bfbe612010-04-27 22:08:08 +0000339 if not p2.startswith(ssl.PEM_HEADER + '\n'):
340 self.fail("DER-to-PEM didn't include correct header:\n%r\n" % p2)
341 if not p2.endswith('\n' + ssl.PEM_FOOTER + '\n'):
342 self.fail("DER-to-PEM didn't include correct footer:\n%r\n" % p2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000343
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000344 def test_openssl_version(self):
345 n = ssl.OPENSSL_VERSION_NUMBER
346 t = ssl.OPENSSL_VERSION_INFO
347 s = ssl.OPENSSL_VERSION
348 self.assertIsInstance(n, int)
349 self.assertIsInstance(t, tuple)
350 self.assertIsInstance(s, str)
351 # Some sanity checks follow
352 # >= 0.9
353 self.assertGreaterEqual(n, 0x900000)
Antoine Pitroudfab9352014-07-21 18:35:01 -0400354 # < 3.0
355 self.assertLess(n, 0x30000000)
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000356 major, minor, fix, patch, status = t
357 self.assertGreaterEqual(major, 0)
Antoine Pitroudfab9352014-07-21 18:35:01 -0400358 self.assertLess(major, 3)
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000359 self.assertGreaterEqual(minor, 0)
360 self.assertLess(minor, 256)
361 self.assertGreaterEqual(fix, 0)
362 self.assertLess(fix, 256)
363 self.assertGreaterEqual(patch, 0)
Ned Deily05784a72015-02-05 17:20:13 +1100364 self.assertLessEqual(patch, 63)
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000365 self.assertGreaterEqual(status, 0)
366 self.assertLessEqual(status, 15)
Antoine Pitroudfab9352014-07-21 18:35:01 -0400367 # Version string as returned by {Open,Libre}SSL, the format might change
Christian Heimes598894f2016-09-05 23:19:05 +0200368 if IS_LIBRESSL:
369 self.assertTrue(s.startswith("LibreSSL {:d}".format(major)),
Victor Stinner789b8052015-01-06 11:51:06 +0100370 (s, t, hex(n)))
Antoine Pitroudfab9352014-07-21 18:35:01 -0400371 else:
372 self.assertTrue(s.startswith("OpenSSL {:d}.{:d}.{:d}".format(major, minor, fix)),
Victor Stinner789b8052015-01-06 11:51:06 +0100373 (s, t, hex(n)))
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000374
Antoine Pitrou9d543662010-04-23 23:10:32 +0000375 @support.cpython_only
376 def test_refcycle(self):
377 # Issue #7943: an SSL object doesn't create reference cycles with
378 # itself.
379 s = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +0200380 ss = test_wrap_socket(s)
Antoine Pitrou9d543662010-04-23 23:10:32 +0000381 wr = weakref.ref(ss)
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100382 with support.check_warnings(("", ResourceWarning)):
383 del ss
Victor Stinnere0b75b72016-03-21 17:26:04 +0100384 self.assertEqual(wr(), None)
Antoine Pitrou9d543662010-04-23 23:10:32 +0000385
Antoine Pitroua468adc2010-09-14 14:43:44 +0000386 def test_wrapped_unconnected(self):
387 # Methods on an unconnected SSLSocket propagate the original
Andrew Svetlov0832af62012-12-18 23:10:48 +0200388 # OSError raise by the underlying socket object.
Antoine Pitroua468adc2010-09-14 14:43:44 +0000389 s = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +0200390 with test_wrap_socket(s) as ss:
Antoine Pitroue9bb4732013-01-12 21:56:56 +0100391 self.assertRaises(OSError, ss.recv, 1)
392 self.assertRaises(OSError, ss.recv_into, bytearray(b'x'))
393 self.assertRaises(OSError, ss.recvfrom, 1)
394 self.assertRaises(OSError, ss.recvfrom_into, bytearray(b'x'), 1)
395 self.assertRaises(OSError, ss.send, b'x')
396 self.assertRaises(OSError, ss.sendto, b'x', ('0.0.0.0', 0))
Antoine Pitroua468adc2010-09-14 14:43:44 +0000397
Antoine Pitrou40f08742010-04-24 22:04:40 +0000398 def test_timeout(self):
399 # Issue #8524: when creating an SSL socket, the timeout of the
400 # original socket should be retained.
401 for timeout in (None, 0.0, 5.0):
402 s = socket.socket(socket.AF_INET)
403 s.settimeout(timeout)
Christian Heimesd0486372016-09-10 23:23:33 +0200404 with test_wrap_socket(s) as ss:
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100405 self.assertEqual(timeout, ss.gettimeout())
Antoine Pitrou40f08742010-04-24 22:04:40 +0000406
Christian Heimesd0486372016-09-10 23:23:33 +0200407 def test_errors_sslwrap(self):
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000408 sock = socket.socket()
Ezio Melottied3a7d22010-12-01 02:32:32 +0000409 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000410 "certfile must be specified",
411 ssl.wrap_socket, sock, keyfile=CERTFILE)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000412 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000413 "certfile must be specified for server-side operations",
414 ssl.wrap_socket, sock, server_side=True)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000415 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000416 "certfile must be specified for server-side operations",
Christian Heimesd0486372016-09-10 23:23:33 +0200417 ssl.wrap_socket, sock, server_side=True, certfile="")
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100418 with ssl.wrap_socket(sock, server_side=True, certfile=CERTFILE) as s:
419 self.assertRaisesRegex(ValueError, "can't connect in server-side mode",
Christian Heimesd0486372016-09-10 23:23:33 +0200420 s.connect, (HOST, 8080))
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200421 with self.assertRaises(OSError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000422 with socket.socket() as sock:
Martin Panter407b62f2016-01-30 03:41:43 +0000423 ssl.wrap_socket(sock, certfile=NONEXISTINGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000424 self.assertEqual(cm.exception.errno, errno.ENOENT)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200425 with self.assertRaises(OSError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000426 with socket.socket() as sock:
Martin Panter407b62f2016-01-30 03:41:43 +0000427 ssl.wrap_socket(sock,
428 certfile=CERTFILE, keyfile=NONEXISTINGCERT)
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000429 self.assertEqual(cm.exception.errno, errno.ENOENT)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200430 with self.assertRaises(OSError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000431 with socket.socket() as sock:
Martin Panter407b62f2016-01-30 03:41:43 +0000432 ssl.wrap_socket(sock,
433 certfile=NONEXISTINGCERT, keyfile=NONEXISTINGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000434 self.assertEqual(cm.exception.errno, errno.ENOENT)
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000435
Martin Panter3464ea22016-02-01 21:58:11 +0000436 def bad_cert_test(self, certfile):
437 """Check that trying to use the given client certificate fails"""
438 certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
439 certfile)
440 sock = socket.socket()
441 self.addCleanup(sock.close)
442 with self.assertRaises(ssl.SSLError):
Christian Heimesd0486372016-09-10 23:23:33 +0200443 test_wrap_socket(sock,
Martin Panter3464ea22016-02-01 21:58:11 +0000444 certfile=certfile,
445 ssl_version=ssl.PROTOCOL_TLSv1)
446
447 def test_empty_cert(self):
448 """Wrapping with an empty cert file"""
449 self.bad_cert_test("nullcert.pem")
450
451 def test_malformed_cert(self):
452 """Wrapping with a badly formatted certificate (syntax error)"""
453 self.bad_cert_test("badcert.pem")
454
455 def test_malformed_key(self):
456 """Wrapping with a badly formatted key (syntax error)"""
457 self.bad_cert_test("badkey.pem")
458
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000459 def test_match_hostname(self):
460 def ok(cert, hostname):
461 ssl.match_hostname(cert, hostname)
462 def fail(cert, hostname):
463 self.assertRaises(ssl.CertificateError,
464 ssl.match_hostname, cert, hostname)
465
Antoine Pitrouc481bfb2015-02-15 18:12:20 +0100466 # -- Hostname matching --
467
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000468 cert = {'subject': ((('commonName', 'example.com'),),)}
469 ok(cert, 'example.com')
470 ok(cert, 'ExAmple.cOm')
471 fail(cert, 'www.example.com')
472 fail(cert, '.example.com')
473 fail(cert, 'example.org')
474 fail(cert, 'exampleXcom')
475
476 cert = {'subject': ((('commonName', '*.a.com'),),)}
477 ok(cert, 'foo.a.com')
478 fail(cert, 'bar.foo.a.com')
479 fail(cert, 'a.com')
480 fail(cert, 'Xa.com')
481 fail(cert, '.a.com')
482
Georg Brandl72c98d32013-10-27 07:16:53 +0100483 # only match one left-most wildcard
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000484 cert = {'subject': ((('commonName', 'f*.com'),),)}
485 ok(cert, 'foo.com')
486 ok(cert, 'f.com')
487 fail(cert, 'bar.com')
488 fail(cert, 'foo.a.com')
489 fail(cert, 'bar.foo.com')
490
Christian Heimes824f7f32013-08-17 00:54:47 +0200491 # NULL bytes are bad, CVE-2013-4073
492 cert = {'subject': ((('commonName',
493 'null.python.org\x00example.org'),),)}
494 ok(cert, 'null.python.org\x00example.org') # or raise an error?
495 fail(cert, 'example.org')
496 fail(cert, 'null.python.org')
497
Georg Brandl72c98d32013-10-27 07:16:53 +0100498 # error cases with wildcards
499 cert = {'subject': ((('commonName', '*.*.a.com'),),)}
500 fail(cert, 'bar.foo.a.com')
501 fail(cert, 'a.com')
502 fail(cert, 'Xa.com')
503 fail(cert, '.a.com')
504
505 cert = {'subject': ((('commonName', 'a.*.com'),),)}
506 fail(cert, 'a.foo.com')
507 fail(cert, 'a..com')
508 fail(cert, 'a.com')
509
510 # wildcard doesn't match IDNA prefix 'xn--'
511 idna = 'püthon.python.org'.encode("idna").decode("ascii")
512 cert = {'subject': ((('commonName', idna),),)}
513 ok(cert, idna)
514 cert = {'subject': ((('commonName', 'x*.python.org'),),)}
515 fail(cert, idna)
516 cert = {'subject': ((('commonName', 'xn--p*.python.org'),),)}
517 fail(cert, idna)
518
519 # wildcard in first fragment and IDNA A-labels in sequent fragments
520 # are supported.
521 idna = 'www*.pythön.org'.encode("idna").decode("ascii")
522 cert = {'subject': ((('commonName', idna),),)}
523 ok(cert, 'www.pythön.org'.encode("idna").decode("ascii"))
524 ok(cert, 'www1.pythön.org'.encode("idna").decode("ascii"))
525 fail(cert, 'ftp.pythön.org'.encode("idna").decode("ascii"))
526 fail(cert, 'pythön.org'.encode("idna").decode("ascii"))
527
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000528 # Slightly fake real-world example
529 cert = {'notAfter': 'Jun 26 21:41:46 2011 GMT',
530 'subject': ((('commonName', 'linuxfrz.org'),),),
531 'subjectAltName': (('DNS', 'linuxfr.org'),
532 ('DNS', 'linuxfr.com'),
533 ('othername', '<unsupported>'))}
534 ok(cert, 'linuxfr.org')
535 ok(cert, 'linuxfr.com')
536 # Not a "DNS" entry
537 fail(cert, '<unsupported>')
538 # When there is a subjectAltName, commonName isn't used
539 fail(cert, 'linuxfrz.org')
540
541 # A pristine real-world example
542 cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
543 'subject': ((('countryName', 'US'),),
544 (('stateOrProvinceName', 'California'),),
545 (('localityName', 'Mountain View'),),
546 (('organizationName', 'Google Inc'),),
547 (('commonName', 'mail.google.com'),))}
548 ok(cert, 'mail.google.com')
549 fail(cert, 'gmail.com')
550 # Only commonName is considered
551 fail(cert, 'California')
552
Antoine Pitrouc481bfb2015-02-15 18:12:20 +0100553 # -- IPv4 matching --
554 cert = {'subject': ((('commonName', 'example.com'),),),
555 'subjectAltName': (('DNS', 'example.com'),
556 ('IP Address', '10.11.12.13'),
557 ('IP Address', '14.15.16.17'))}
558 ok(cert, '10.11.12.13')
559 ok(cert, '14.15.16.17')
560 fail(cert, '14.15.16.18')
561 fail(cert, 'example.net')
562
563 # -- IPv6 matching --
564 cert = {'subject': ((('commonName', 'example.com'),),),
565 'subjectAltName': (('DNS', 'example.com'),
566 ('IP Address', '2001:0:0:0:0:0:0:CAFE\n'),
567 ('IP Address', '2003:0:0:0:0:0:0:BABA\n'))}
568 ok(cert, '2001::cafe')
569 ok(cert, '2003::baba')
570 fail(cert, '2003::bebe')
571 fail(cert, 'example.net')
572
573 # -- Miscellaneous --
574
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000575 # Neither commonName nor subjectAltName
576 cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
577 'subject': ((('countryName', 'US'),),
578 (('stateOrProvinceName', 'California'),),
579 (('localityName', 'Mountain View'),),
580 (('organizationName', 'Google Inc'),))}
581 fail(cert, 'mail.google.com')
582
Antoine Pitrou1c86b442011-05-06 15:19:49 +0200583 # No DNS entry in subjectAltName but a commonName
584 cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
585 'subject': ((('countryName', 'US'),),
586 (('stateOrProvinceName', 'California'),),
587 (('localityName', 'Mountain View'),),
588 (('commonName', 'mail.google.com'),)),
589 'subjectAltName': (('othername', 'blabla'), )}
590 ok(cert, 'mail.google.com')
591
592 # No DNS entry subjectAltName and no commonName
593 cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
594 'subject': ((('countryName', 'US'),),
595 (('stateOrProvinceName', 'California'),),
596 (('localityName', 'Mountain View'),),
597 (('organizationName', 'Google Inc'),)),
598 'subjectAltName': (('othername', 'blabla'),)}
599 fail(cert, 'google.com')
600
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000601 # Empty cert / no cert
602 self.assertRaises(ValueError, ssl.match_hostname, None, 'example.com')
603 self.assertRaises(ValueError, ssl.match_hostname, {}, 'example.com')
604
Antoine Pitrou636f93c2013-05-18 17:56:42 +0200605 # Issue #17980: avoid denials of service by refusing more than one
606 # wildcard per fragment.
607 cert = {'subject': ((('commonName', 'a*b.com'),),)}
608 ok(cert, 'axxb.com')
609 cert = {'subject': ((('commonName', 'a*b.co*'),),)}
Georg Brandl72c98d32013-10-27 07:16:53 +0100610 fail(cert, 'axxb.com')
Antoine Pitrou636f93c2013-05-18 17:56:42 +0200611 cert = {'subject': ((('commonName', 'a*b*.com'),),)}
612 with self.assertRaises(ssl.CertificateError) as cm:
613 ssl.match_hostname(cert, 'axxbxxc.com')
614 self.assertIn("too many wildcards", str(cm.exception))
615
Antoine Pitroud5323212010-10-22 18:19:07 +0000616 def test_server_side(self):
617 # server_hostname doesn't work for server sockets
618 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
Antoine Pitroud2eca372010-10-29 23:41:37 +0000619 with socket.socket() as sock:
620 self.assertRaises(ValueError, ctx.wrap_socket, sock, True,
621 server_hostname="some.hostname")
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000622
Antoine Pitroud6494802011-07-21 01:11:30 +0200623 def test_unknown_channel_binding(self):
624 # should raise ValueError for unknown type
625 s = socket.socket(socket.AF_INET)
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200626 s.bind(('127.0.0.1', 0))
627 s.listen()
628 c = socket.socket(socket.AF_INET)
629 c.connect(s.getsockname())
Christian Heimesd0486372016-09-10 23:23:33 +0200630 with test_wrap_socket(c, do_handshake_on_connect=False) as ss:
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100631 with self.assertRaises(ValueError):
632 ss.get_channel_binding("unknown-type")
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200633 s.close()
Antoine Pitroud6494802011-07-21 01:11:30 +0200634
635 @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
636 "'tls-unique' channel binding not available")
637 def test_tls_unique_channel_binding(self):
638 # unconnected should return None for known type
639 s = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +0200640 with test_wrap_socket(s) as ss:
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100641 self.assertIsNone(ss.get_channel_binding("tls-unique"))
Antoine Pitroud6494802011-07-21 01:11:30 +0200642 # the same for server-side
643 s = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +0200644 with test_wrap_socket(s, server_side=True, certfile=CERTFILE) as ss:
Antoine Pitroue1ceb502013-01-12 21:54:44 +0100645 self.assertIsNone(ss.get_channel_binding("tls-unique"))
Antoine Pitroud6494802011-07-21 01:11:30 +0200646
Benjamin Peterson36f7b972013-01-10 14:16:20 -0600647 def test_dealloc_warn(self):
Christian Heimesd0486372016-09-10 23:23:33 +0200648 ss = test_wrap_socket(socket.socket(socket.AF_INET))
Benjamin Peterson36f7b972013-01-10 14:16:20 -0600649 r = repr(ss)
650 with self.assertWarns(ResourceWarning) as cm:
651 ss = None
652 support.gc_collect()
653 self.assertIn(r, str(cm.warning.args[0]))
654
Christian Heimes6d7ad132013-06-09 18:02:55 +0200655 def test_get_default_verify_paths(self):
656 paths = ssl.get_default_verify_paths()
657 self.assertEqual(len(paths), 6)
658 self.assertIsInstance(paths, ssl.DefaultVerifyPaths)
659
660 with support.EnvironmentVarGuard() as env:
661 env["SSL_CERT_DIR"] = CAPATH
662 env["SSL_CERT_FILE"] = CERTFILE
663 paths = ssl.get_default_verify_paths()
664 self.assertEqual(paths.cafile, CERTFILE)
665 self.assertEqual(paths.capath, CAPATH)
666
Christian Heimes44109d72013-11-22 01:51:30 +0100667 @unittest.skipUnless(sys.platform == "win32", "Windows specific")
668 def test_enum_certificates(self):
669 self.assertTrue(ssl.enum_certificates("CA"))
670 self.assertTrue(ssl.enum_certificates("ROOT"))
671
672 self.assertRaises(TypeError, ssl.enum_certificates)
673 self.assertRaises(WindowsError, ssl.enum_certificates, "")
674
Christian Heimesc2d65e12013-11-22 16:13:55 +0100675 trust_oids = set()
676 for storename in ("CA", "ROOT"):
677 store = ssl.enum_certificates(storename)
678 self.assertIsInstance(store, list)
679 for element in store:
680 self.assertIsInstance(element, tuple)
681 self.assertEqual(len(element), 3)
682 cert, enc, trust = element
683 self.assertIsInstance(cert, bytes)
684 self.assertIn(enc, {"x509_asn", "pkcs_7_asn"})
685 self.assertIsInstance(trust, (set, bool))
686 if isinstance(trust, set):
687 trust_oids.update(trust)
Christian Heimes44109d72013-11-22 01:51:30 +0100688
689 serverAuth = "1.3.6.1.5.5.7.3.1"
Christian Heimesc2d65e12013-11-22 16:13:55 +0100690 self.assertIn(serverAuth, trust_oids)
Christian Heimes6d7ad132013-06-09 18:02:55 +0200691
Christian Heimes46bebee2013-06-09 19:03:31 +0200692 @unittest.skipUnless(sys.platform == "win32", "Windows specific")
Christian Heimes44109d72013-11-22 01:51:30 +0100693 def test_enum_crls(self):
694 self.assertTrue(ssl.enum_crls("CA"))
695 self.assertRaises(TypeError, ssl.enum_crls)
696 self.assertRaises(WindowsError, ssl.enum_crls, "")
Christian Heimes46bebee2013-06-09 19:03:31 +0200697
Christian Heimes44109d72013-11-22 01:51:30 +0100698 crls = ssl.enum_crls("CA")
699 self.assertIsInstance(crls, list)
700 for element in crls:
701 self.assertIsInstance(element, tuple)
702 self.assertEqual(len(element), 2)
703 self.assertIsInstance(element[0], bytes)
704 self.assertIn(element[1], {"x509_asn", "pkcs_7_asn"})
Christian Heimes46bebee2013-06-09 19:03:31 +0200705
Christian Heimes46bebee2013-06-09 19:03:31 +0200706
Christian Heimesa6bc95a2013-11-17 19:59:14 +0100707 def test_asn1object(self):
708 expected = (129, 'serverAuth', 'TLS Web Server Authentication',
709 '1.3.6.1.5.5.7.3.1')
710
711 val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
712 self.assertEqual(val, expected)
713 self.assertEqual(val.nid, 129)
714 self.assertEqual(val.shortname, 'serverAuth')
715 self.assertEqual(val.longname, 'TLS Web Server Authentication')
716 self.assertEqual(val.oid, '1.3.6.1.5.5.7.3.1')
717 self.assertIsInstance(val, ssl._ASN1Object)
718 self.assertRaises(ValueError, ssl._ASN1Object, 'serverAuth')
719
720 val = ssl._ASN1Object.fromnid(129)
721 self.assertEqual(val, expected)
722 self.assertIsInstance(val, ssl._ASN1Object)
723 self.assertRaises(ValueError, ssl._ASN1Object.fromnid, -1)
Christian Heimes5398e1a2013-11-22 16:20:53 +0100724 with self.assertRaisesRegex(ValueError, "unknown NID 100000"):
725 ssl._ASN1Object.fromnid(100000)
Christian Heimesa6bc95a2013-11-17 19:59:14 +0100726 for i in range(1000):
727 try:
728 obj = ssl._ASN1Object.fromnid(i)
729 except ValueError:
730 pass
731 else:
732 self.assertIsInstance(obj.nid, int)
733 self.assertIsInstance(obj.shortname, str)
734 self.assertIsInstance(obj.longname, str)
735 self.assertIsInstance(obj.oid, (str, type(None)))
736
737 val = ssl._ASN1Object.fromname('TLS Web Server Authentication')
738 self.assertEqual(val, expected)
739 self.assertIsInstance(val, ssl._ASN1Object)
740 self.assertEqual(ssl._ASN1Object.fromname('serverAuth'), expected)
741 self.assertEqual(ssl._ASN1Object.fromname('1.3.6.1.5.5.7.3.1'),
742 expected)
Christian Heimes5398e1a2013-11-22 16:20:53 +0100743 with self.assertRaisesRegex(ValueError, "unknown object 'serverauth'"):
744 ssl._ASN1Object.fromname('serverauth')
Christian Heimesa6bc95a2013-11-17 19:59:14 +0100745
Christian Heimes72d28502013-11-23 13:56:58 +0100746 def test_purpose_enum(self):
747 val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
748 self.assertIsInstance(ssl.Purpose.SERVER_AUTH, ssl._ASN1Object)
749 self.assertEqual(ssl.Purpose.SERVER_AUTH, val)
750 self.assertEqual(ssl.Purpose.SERVER_AUTH.nid, 129)
751 self.assertEqual(ssl.Purpose.SERVER_AUTH.shortname, 'serverAuth')
752 self.assertEqual(ssl.Purpose.SERVER_AUTH.oid,
753 '1.3.6.1.5.5.7.3.1')
754
755 val = ssl._ASN1Object('1.3.6.1.5.5.7.3.2')
756 self.assertIsInstance(ssl.Purpose.CLIENT_AUTH, ssl._ASN1Object)
757 self.assertEqual(ssl.Purpose.CLIENT_AUTH, val)
758 self.assertEqual(ssl.Purpose.CLIENT_AUTH.nid, 130)
759 self.assertEqual(ssl.Purpose.CLIENT_AUTH.shortname, 'clientAuth')
760 self.assertEqual(ssl.Purpose.CLIENT_AUTH.oid,
761 '1.3.6.1.5.5.7.3.2')
762
Antoine Pitrou3e86ba42013-12-28 17:26:33 +0100763 def test_unsupported_dtls(self):
764 s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
765 self.addCleanup(s.close)
766 with self.assertRaises(NotImplementedError) as cx:
Christian Heimesd0486372016-09-10 23:23:33 +0200767 test_wrap_socket(s, cert_reqs=ssl.CERT_NONE)
Antoine Pitrou3e86ba42013-12-28 17:26:33 +0100768 self.assertEqual(str(cx.exception), "only stream sockets are supported")
769 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
770 with self.assertRaises(NotImplementedError) as cx:
771 ctx.wrap_socket(s)
772 self.assertEqual(str(cx.exception), "only stream sockets are supported")
773
Antoine Pitrouc695c952014-04-28 20:57:36 +0200774 def cert_time_ok(self, timestring, timestamp):
775 self.assertEqual(ssl.cert_time_to_seconds(timestring), timestamp)
776
777 def cert_time_fail(self, timestring):
778 with self.assertRaises(ValueError):
779 ssl.cert_time_to_seconds(timestring)
780
781 @unittest.skipUnless(utc_offset(),
782 'local time needs to be different from UTC')
783 def test_cert_time_to_seconds_timezone(self):
784 # Issue #19940: ssl.cert_time_to_seconds() returns wrong
785 # results if local timezone is not UTC
786 self.cert_time_ok("May 9 00:00:00 2007 GMT", 1178668800.0)
787 self.cert_time_ok("Jan 5 09:34:43 2018 GMT", 1515144883.0)
788
789 def test_cert_time_to_seconds(self):
790 timestring = "Jan 5 09:34:43 2018 GMT"
791 ts = 1515144883.0
792 self.cert_time_ok(timestring, ts)
793 # accept keyword parameter, assert its name
794 self.assertEqual(ssl.cert_time_to_seconds(cert_time=timestring), ts)
795 # accept both %e and %d (space or zero generated by strftime)
796 self.cert_time_ok("Jan 05 09:34:43 2018 GMT", ts)
797 # case-insensitive
798 self.cert_time_ok("JaN 5 09:34:43 2018 GmT", ts)
799 self.cert_time_fail("Jan 5 09:34 2018 GMT") # no seconds
800 self.cert_time_fail("Jan 5 09:34:43 2018") # no GMT
801 self.cert_time_fail("Jan 5 09:34:43 2018 UTC") # not GMT timezone
802 self.cert_time_fail("Jan 35 09:34:43 2018 GMT") # invalid day
803 self.cert_time_fail("Jon 5 09:34:43 2018 GMT") # invalid month
804 self.cert_time_fail("Jan 5 24:00:00 2018 GMT") # invalid hour
805 self.cert_time_fail("Jan 5 09:60:43 2018 GMT") # invalid minute
806
807 newyear_ts = 1230768000.0
808 # leap seconds
809 self.cert_time_ok("Dec 31 23:59:60 2008 GMT", newyear_ts)
810 # same timestamp
811 self.cert_time_ok("Jan 1 00:00:00 2009 GMT", newyear_ts)
812
813 self.cert_time_ok("Jan 5 09:34:59 2018 GMT", 1515144899)
814 # allow 60th second (even if it is not a leap second)
815 self.cert_time_ok("Jan 5 09:34:60 2018 GMT", 1515144900)
816 # allow 2nd leap second for compatibility with time.strptime()
817 self.cert_time_ok("Jan 5 09:34:61 2018 GMT", 1515144901)
818 self.cert_time_fail("Jan 5 09:34:62 2018 GMT") # invalid seconds
819
820 # no special treatement for the special value:
821 # 99991231235959Z (rfc 5280)
822 self.cert_time_ok("Dec 31 23:59:59 9999 GMT", 253402300799.0)
823
824 @support.run_with_locale('LC_ALL', '')
825 def test_cert_time_to_seconds_locale(self):
826 # `cert_time_to_seconds()` should be locale independent
827
828 def local_february_name():
829 return time.strftime('%b', (1, 2, 3, 4, 5, 6, 0, 0, 0))
830
831 if local_february_name().lower() == 'feb':
832 self.skipTest("locale-specific month name needs to be "
833 "different from C locale")
834
835 # locale-independent
836 self.cert_time_ok("Feb 9 00:00:00 2007 GMT", 1170979200.0)
837 self.cert_time_fail(local_february_name() + " 9 00:00:00 2007 GMT")
838
Martin Panter3840b2a2016-03-27 01:53:46 +0000839 def test_connect_ex_error(self):
840 server = socket.socket(socket.AF_INET)
841 self.addCleanup(server.close)
842 port = support.bind_port(server) # Reserve port but don't listen
Christian Heimesd0486372016-09-10 23:23:33 +0200843 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +0000844 cert_reqs=ssl.CERT_REQUIRED)
845 self.addCleanup(s.close)
846 rc = s.connect_ex((HOST, port))
847 # Issue #19919: Windows machines or VMs hosted on Windows
848 # machines sometimes return EWOULDBLOCK.
849 errors = (
850 errno.ECONNREFUSED, errno.EHOSTUNREACH, errno.ETIMEDOUT,
851 errno.EWOULDBLOCK,
852 )
853 self.assertIn(rc, errors)
854
Christian Heimesa6bc95a2013-11-17 19:59:14 +0100855
Antoine Pitrou152efa22010-05-16 18:19:27 +0000856class ContextTests(unittest.TestCase):
857
Antoine Pitrou23df4832010-08-04 17:14:06 +0000858 @skip_if_broken_ubuntu_ssl
Antoine Pitrou152efa22010-05-16 18:19:27 +0000859 def test_constructor(self):
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100860 for protocol in PROTOCOLS:
861 ssl.SSLContext(protocol)
Christian Heimes598894f2016-09-05 23:19:05 +0200862 ctx = ssl.SSLContext()
863 self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000864 self.assertRaises(ValueError, ssl.SSLContext, -1)
865 self.assertRaises(ValueError, ssl.SSLContext, 42)
866
Antoine Pitrou23df4832010-08-04 17:14:06 +0000867 @skip_if_broken_ubuntu_ssl
Antoine Pitrou152efa22010-05-16 18:19:27 +0000868 def test_protocol(self):
869 for proto in PROTOCOLS:
870 ctx = ssl.SSLContext(proto)
871 self.assertEqual(ctx.protocol, proto)
872
873 def test_ciphers(self):
874 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
875 ctx.set_ciphers("ALL")
876 ctx.set_ciphers("DEFAULT")
Ezio Melottied3a7d22010-12-01 02:32:32 +0000877 with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
Antoine Pitrou30474062010-05-16 23:46:26 +0000878 ctx.set_ciphers("^$:,;?*'dorothyx")
Antoine Pitrou152efa22010-05-16 18:19:27 +0000879
Christian Heimes25bfcd52016-09-06 00:04:45 +0200880 @unittest.skipIf(ssl.OPENSSL_VERSION_INFO < (1, 0, 2, 0, 0), 'OpenSSL too old')
881 def test_get_ciphers(self):
882 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Christian Heimesea9b2dc2016-09-06 10:45:44 +0200883 ctx.set_ciphers('AESGCM')
Christian Heimes25bfcd52016-09-06 00:04:45 +0200884 names = set(d['name'] for d in ctx.get_ciphers())
Christian Heimes582282b2016-09-06 11:27:25 +0200885 self.assertIn('AES256-GCM-SHA384', names)
886 self.assertIn('AES128-GCM-SHA256', names)
Christian Heimes25bfcd52016-09-06 00:04:45 +0200887
Antoine Pitrou23df4832010-08-04 17:14:06 +0000888 @skip_if_broken_ubuntu_ssl
Antoine Pitroub5218772010-05-21 09:56:06 +0000889 def test_options(self):
890 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Benjamin Petersona9dcdab2015-11-11 22:38:41 -0800891 # OP_ALL | OP_NO_SSLv2 | OP_NO_SSLv3 is the default value
Christian Heimes598894f2016-09-05 23:19:05 +0200892 default = (ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
Christian Heimes358cfd42016-09-10 22:43:48 +0200893 # SSLContext also enables these by default
894 default |= (OP_NO_COMPRESSION | OP_CIPHER_SERVER_PREFERENCE |
895 OP_SINGLE_DH_USE | OP_SINGLE_ECDH_USE)
Christian Heimes598894f2016-09-05 23:19:05 +0200896 self.assertEqual(default, ctx.options)
Benjamin Petersona9dcdab2015-11-11 22:38:41 -0800897 ctx.options |= ssl.OP_NO_TLSv1
Christian Heimes598894f2016-09-05 23:19:05 +0200898 self.assertEqual(default | ssl.OP_NO_TLSv1, ctx.options)
Antoine Pitroub5218772010-05-21 09:56:06 +0000899 if can_clear_options():
Christian Heimes598894f2016-09-05 23:19:05 +0200900 ctx.options = (ctx.options & ~ssl.OP_NO_TLSv1)
901 self.assertEqual(default, ctx.options)
Antoine Pitroub5218772010-05-21 09:56:06 +0000902 ctx.options = 0
Matthias Klosef7c56242016-06-12 23:40:00 -0700903 # Ubuntu has OP_NO_SSLv3 forced on by default
904 self.assertEqual(0, ctx.options & ~ssl.OP_NO_SSLv3)
Antoine Pitroub5218772010-05-21 09:56:06 +0000905 else:
906 with self.assertRaises(ValueError):
907 ctx.options = 0
908
Christian Heimes22587792013-11-21 23:56:13 +0100909 def test_verify_mode(self):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000910 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
911 # Default value
912 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
913 ctx.verify_mode = ssl.CERT_OPTIONAL
914 self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
915 ctx.verify_mode = ssl.CERT_REQUIRED
916 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
917 ctx.verify_mode = ssl.CERT_NONE
918 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
919 with self.assertRaises(TypeError):
920 ctx.verify_mode = None
921 with self.assertRaises(ValueError):
922 ctx.verify_mode = 42
923
Christian Heimes2427b502013-11-23 11:24:32 +0100924 @unittest.skipUnless(have_verify_flags(),
925 "verify_flags need OpenSSL > 0.9.8")
Christian Heimes22587792013-11-21 23:56:13 +0100926 def test_verify_flags(self):
927 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Benjamin Peterson990fcaa2015-03-04 22:49:41 -0500928 # default value
929 tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
930 self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT | tf)
Christian Heimes22587792013-11-21 23:56:13 +0100931 ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF
932 self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_LEAF)
933 ctx.verify_flags = ssl.VERIFY_CRL_CHECK_CHAIN
934 self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_CHAIN)
935 ctx.verify_flags = ssl.VERIFY_DEFAULT
936 self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT)
937 # supports any value
938 ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT
939 self.assertEqual(ctx.verify_flags,
940 ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT)
941 with self.assertRaises(TypeError):
942 ctx.verify_flags = None
943
Antoine Pitrou152efa22010-05-16 18:19:27 +0000944 def test_load_cert_chain(self):
945 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
946 # Combined key and cert in a single file
Benjamin Peterson1ea070e2014-11-03 21:05:01 -0500947 ctx.load_cert_chain(CERTFILE, keyfile=None)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000948 ctx.load_cert_chain(CERTFILE, keyfile=CERTFILE)
949 self.assertRaises(TypeError, ctx.load_cert_chain, keyfile=CERTFILE)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200950 with self.assertRaises(OSError) as cm:
Martin Panter407b62f2016-01-30 03:41:43 +0000951 ctx.load_cert_chain(NONEXISTINGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000952 self.assertEqual(cm.exception.errno, errno.ENOENT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000953 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000954 ctx.load_cert_chain(BADCERT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000955 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000956 ctx.load_cert_chain(EMPTYCERT)
957 # Separate key and cert
Antoine Pitroud0919502010-05-17 10:30:00 +0000958 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000959 ctx.load_cert_chain(ONLYCERT, ONLYKEY)
960 ctx.load_cert_chain(certfile=ONLYCERT, keyfile=ONLYKEY)
961 ctx.load_cert_chain(certfile=BYTES_ONLYCERT, keyfile=BYTES_ONLYKEY)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000962 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000963 ctx.load_cert_chain(ONLYCERT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000964 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000965 ctx.load_cert_chain(ONLYKEY)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000966 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000967 ctx.load_cert_chain(certfile=ONLYKEY, keyfile=ONLYCERT)
968 # Mismatching key and cert
Antoine Pitroud0919502010-05-17 10:30:00 +0000969 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000970 with self.assertRaisesRegex(ssl.SSLError, "key values mismatch"):
Martin Panter3d81d932016-01-14 09:36:00 +0000971 ctx.load_cert_chain(CAFILE_CACERT, ONLYKEY)
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +0200972 # Password protected key and cert
973 ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD)
974 ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD.encode())
975 ctx.load_cert_chain(CERTFILE_PROTECTED,
976 password=bytearray(KEY_PASSWORD.encode()))
977 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD)
978 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD.encode())
979 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED,
980 bytearray(KEY_PASSWORD.encode()))
981 with self.assertRaisesRegex(TypeError, "should be a string"):
982 ctx.load_cert_chain(CERTFILE_PROTECTED, password=True)
983 with self.assertRaises(ssl.SSLError):
984 ctx.load_cert_chain(CERTFILE_PROTECTED, password="badpass")
985 with self.assertRaisesRegex(ValueError, "cannot be longer"):
986 # openssl has a fixed limit on the password buffer.
987 # PEM_BUFSIZE is generally set to 1kb.
988 # Return a string larger than this.
989 ctx.load_cert_chain(CERTFILE_PROTECTED, password=b'a' * 102400)
990 # Password callback
991 def getpass_unicode():
992 return KEY_PASSWORD
993 def getpass_bytes():
994 return KEY_PASSWORD.encode()
995 def getpass_bytearray():
996 return bytearray(KEY_PASSWORD.encode())
997 def getpass_badpass():
998 return "badpass"
999 def getpass_huge():
1000 return b'a' * (1024 * 1024)
1001 def getpass_bad_type():
1002 return 9
1003 def getpass_exception():
1004 raise Exception('getpass error')
1005 class GetPassCallable:
1006 def __call__(self):
1007 return KEY_PASSWORD
1008 def getpass(self):
1009 return KEY_PASSWORD
1010 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_unicode)
1011 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytes)
1012 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytearray)
1013 ctx.load_cert_chain(CERTFILE_PROTECTED, password=GetPassCallable())
1014 ctx.load_cert_chain(CERTFILE_PROTECTED,
1015 password=GetPassCallable().getpass)
1016 with self.assertRaises(ssl.SSLError):
1017 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_badpass)
1018 with self.assertRaisesRegex(ValueError, "cannot be longer"):
1019 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_huge)
1020 with self.assertRaisesRegex(TypeError, "must return a string"):
1021 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bad_type)
1022 with self.assertRaisesRegex(Exception, "getpass error"):
1023 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_exception)
1024 # Make sure the password function isn't called if it isn't needed
1025 ctx.load_cert_chain(CERTFILE, password=getpass_exception)
Antoine Pitrou152efa22010-05-16 18:19:27 +00001026
1027 def test_load_verify_locations(self):
1028 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1029 ctx.load_verify_locations(CERTFILE)
1030 ctx.load_verify_locations(cafile=CERTFILE, capath=None)
1031 ctx.load_verify_locations(BYTES_CERTFILE)
1032 ctx.load_verify_locations(cafile=BYTES_CERTFILE, capath=None)
1033 self.assertRaises(TypeError, ctx.load_verify_locations)
Christian Heimesefff7062013-11-21 03:35:02 +01001034 self.assertRaises(TypeError, ctx.load_verify_locations, None, None, None)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001035 with self.assertRaises(OSError) as cm:
Martin Panter407b62f2016-01-30 03:41:43 +00001036 ctx.load_verify_locations(NONEXISTINGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +00001037 self.assertEqual(cm.exception.errno, errno.ENOENT)
Ezio Melottied3a7d22010-12-01 02:32:32 +00001038 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +00001039 ctx.load_verify_locations(BADCERT)
1040 ctx.load_verify_locations(CERTFILE, CAPATH)
1041 ctx.load_verify_locations(CERTFILE, capath=BYTES_CAPATH)
1042
Victor Stinner80f75e62011-01-29 11:31:20 +00001043 # Issue #10989: crash if the second argument type is invalid
1044 self.assertRaises(TypeError, ctx.load_verify_locations, None, True)
1045
Christian Heimesefff7062013-11-21 03:35:02 +01001046 def test_load_verify_cadata(self):
1047 # test cadata
1048 with open(CAFILE_CACERT) as f:
1049 cacert_pem = f.read()
1050 cacert_der = ssl.PEM_cert_to_DER_cert(cacert_pem)
1051 with open(CAFILE_NEURONIO) as f:
1052 neuronio_pem = f.read()
1053 neuronio_der = ssl.PEM_cert_to_DER_cert(neuronio_pem)
1054
1055 # test PEM
1056 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1057 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 0)
1058 ctx.load_verify_locations(cadata=cacert_pem)
1059 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 1)
1060 ctx.load_verify_locations(cadata=neuronio_pem)
1061 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1062 # cert already in hash table
1063 ctx.load_verify_locations(cadata=neuronio_pem)
1064 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1065
1066 # combined
1067 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1068 combined = "\n".join((cacert_pem, neuronio_pem))
1069 ctx.load_verify_locations(cadata=combined)
1070 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1071
1072 # with junk around the certs
1073 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1074 combined = ["head", cacert_pem, "other", neuronio_pem, "again",
1075 neuronio_pem, "tail"]
1076 ctx.load_verify_locations(cadata="\n".join(combined))
1077 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1078
1079 # test DER
1080 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1081 ctx.load_verify_locations(cadata=cacert_der)
1082 ctx.load_verify_locations(cadata=neuronio_der)
1083 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1084 # cert already in hash table
1085 ctx.load_verify_locations(cadata=cacert_der)
1086 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1087
1088 # combined
1089 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1090 combined = b"".join((cacert_der, neuronio_der))
1091 ctx.load_verify_locations(cadata=combined)
1092 self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
1093
1094 # error cases
1095 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1096 self.assertRaises(TypeError, ctx.load_verify_locations, cadata=object)
1097
1098 with self.assertRaisesRegex(ssl.SSLError, "no start line"):
1099 ctx.load_verify_locations(cadata="broken")
1100 with self.assertRaisesRegex(ssl.SSLError, "not enough data"):
1101 ctx.load_verify_locations(cadata=b"broken")
1102
1103
Antoine Pitrou0e576f12011-12-22 10:03:38 +01001104 def test_load_dh_params(self):
1105 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1106 ctx.load_dh_params(DHFILE)
1107 if os.name != 'nt':
1108 ctx.load_dh_params(BYTES_DHFILE)
1109 self.assertRaises(TypeError, ctx.load_dh_params)
1110 self.assertRaises(TypeError, ctx.load_dh_params, None)
1111 with self.assertRaises(FileNotFoundError) as cm:
Martin Panter407b62f2016-01-30 03:41:43 +00001112 ctx.load_dh_params(NONEXISTINGCERT)
Antoine Pitrou0e576f12011-12-22 10:03:38 +01001113 self.assertEqual(cm.exception.errno, errno.ENOENT)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02001114 with self.assertRaises(ssl.SSLError) as cm:
Antoine Pitrou0e576f12011-12-22 10:03:38 +01001115 ctx.load_dh_params(CERTFILE)
1116
Antoine Pitroueb585ad2010-10-22 18:24:20 +00001117 @skip_if_broken_ubuntu_ssl
Antoine Pitroub0182c82010-10-12 20:09:02 +00001118 def test_session_stats(self):
1119 for proto in PROTOCOLS:
1120 ctx = ssl.SSLContext(proto)
1121 self.assertEqual(ctx.session_stats(), {
1122 'number': 0,
1123 'connect': 0,
1124 'connect_good': 0,
1125 'connect_renegotiate': 0,
1126 'accept': 0,
1127 'accept_good': 0,
1128 'accept_renegotiate': 0,
1129 'hits': 0,
1130 'misses': 0,
1131 'timeouts': 0,
1132 'cache_full': 0,
1133 })
1134
Antoine Pitrou664c2d12010-11-17 20:29:42 +00001135 def test_set_default_verify_paths(self):
1136 # There's not much we can do to test that it acts as expected,
1137 # so just check it doesn't crash or raise an exception.
1138 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1139 ctx.set_default_verify_paths()
1140
Antoine Pitrou501da612011-12-21 09:27:41 +01001141 @unittest.skipUnless(ssl.HAS_ECDH, "ECDH disabled on this OpenSSL build")
Antoine Pitrou923df6f2011-12-19 17:16:51 +01001142 def test_set_ecdh_curve(self):
1143 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1144 ctx.set_ecdh_curve("prime256v1")
1145 ctx.set_ecdh_curve(b"prime256v1")
1146 self.assertRaises(TypeError, ctx.set_ecdh_curve)
1147 self.assertRaises(TypeError, ctx.set_ecdh_curve, None)
1148 self.assertRaises(ValueError, ctx.set_ecdh_curve, "foo")
1149 self.assertRaises(ValueError, ctx.set_ecdh_curve, b"foo")
1150
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001151 @needs_sni
1152 def test_sni_callback(self):
1153 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1154
1155 # set_servername_callback expects a callable, or None
1156 self.assertRaises(TypeError, ctx.set_servername_callback)
1157 self.assertRaises(TypeError, ctx.set_servername_callback, 4)
1158 self.assertRaises(TypeError, ctx.set_servername_callback, "")
1159 self.assertRaises(TypeError, ctx.set_servername_callback, ctx)
1160
1161 def dummycallback(sock, servername, ctx):
1162 pass
1163 ctx.set_servername_callback(None)
1164 ctx.set_servername_callback(dummycallback)
1165
1166 @needs_sni
1167 def test_sni_callback_refcycle(self):
1168 # Reference cycles through the servername callback are detected
1169 # and cleared.
1170 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1171 def dummycallback(sock, servername, ctx, cycle=ctx):
1172 pass
1173 ctx.set_servername_callback(dummycallback)
1174 wr = weakref.ref(ctx)
1175 del ctx, dummycallback
1176 gc.collect()
1177 self.assertIs(wr(), None)
1178
Christian Heimes9a5395a2013-06-17 15:44:12 +02001179 def test_cert_store_stats(self):
1180 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1181 self.assertEqual(ctx.cert_store_stats(),
1182 {'x509_ca': 0, 'crl': 0, 'x509': 0})
1183 ctx.load_cert_chain(CERTFILE)
1184 self.assertEqual(ctx.cert_store_stats(),
1185 {'x509_ca': 0, 'crl': 0, 'x509': 0})
1186 ctx.load_verify_locations(CERTFILE)
1187 self.assertEqual(ctx.cert_store_stats(),
1188 {'x509_ca': 0, 'crl': 0, 'x509': 1})
Martin Panterb55f8b72016-01-14 12:53:56 +00001189 ctx.load_verify_locations(CAFILE_CACERT)
Christian Heimes9a5395a2013-06-17 15:44:12 +02001190 self.assertEqual(ctx.cert_store_stats(),
1191 {'x509_ca': 1, 'crl': 0, 'x509': 2})
1192
1193 def test_get_ca_certs(self):
1194 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1195 self.assertEqual(ctx.get_ca_certs(), [])
1196 # CERTFILE is not flagged as X509v3 Basic Constraints: CA:TRUE
1197 ctx.load_verify_locations(CERTFILE)
1198 self.assertEqual(ctx.get_ca_certs(), [])
Martin Panterb55f8b72016-01-14 12:53:56 +00001199 # but CAFILE_CACERT is a CA cert
1200 ctx.load_verify_locations(CAFILE_CACERT)
Christian Heimes9a5395a2013-06-17 15:44:12 +02001201 self.assertEqual(ctx.get_ca_certs(),
1202 [{'issuer': ((('organizationName', 'Root CA'),),
1203 (('organizationalUnitName', 'http://www.cacert.org'),),
1204 (('commonName', 'CA Cert Signing Authority'),),
1205 (('emailAddress', 'support@cacert.org'),)),
1206 'notAfter': asn1time('Mar 29 12:29:49 2033 GMT'),
1207 'notBefore': asn1time('Mar 30 12:29:49 2003 GMT'),
1208 'serialNumber': '00',
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001209 'crlDistributionPoints': ('https://www.cacert.org/revoke.crl',),
Christian Heimes9a5395a2013-06-17 15:44:12 +02001210 'subject': ((('organizationName', 'Root CA'),),
1211 (('organizationalUnitName', 'http://www.cacert.org'),),
1212 (('commonName', 'CA Cert Signing Authority'),),
1213 (('emailAddress', 'support@cacert.org'),)),
1214 'version': 3}])
1215
Martin Panterb55f8b72016-01-14 12:53:56 +00001216 with open(CAFILE_CACERT) as f:
Christian Heimes9a5395a2013-06-17 15:44:12 +02001217 pem = f.read()
1218 der = ssl.PEM_cert_to_DER_cert(pem)
1219 self.assertEqual(ctx.get_ca_certs(True), [der])
1220
Christian Heimes72d28502013-11-23 13:56:58 +01001221 def test_load_default_certs(self):
1222 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1223 ctx.load_default_certs()
1224
1225 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1226 ctx.load_default_certs(ssl.Purpose.SERVER_AUTH)
1227 ctx.load_default_certs()
1228
1229 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1230 ctx.load_default_certs(ssl.Purpose.CLIENT_AUTH)
1231
1232 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1233 self.assertRaises(TypeError, ctx.load_default_certs, None)
1234 self.assertRaises(TypeError, ctx.load_default_certs, 'SERVER_AUTH')
1235
Benjamin Peterson91244e02014-10-03 18:17:15 -04001236 @unittest.skipIf(sys.platform == "win32", "not-Windows specific")
Christian Heimes598894f2016-09-05 23:19:05 +02001237 @unittest.skipIf(IS_LIBRESSL, "LibreSSL doesn't support env vars")
Benjamin Peterson5915b0f2014-10-03 17:27:05 -04001238 def test_load_default_certs_env(self):
1239 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1240 with support.EnvironmentVarGuard() as env:
1241 env["SSL_CERT_DIR"] = CAPATH
1242 env["SSL_CERT_FILE"] = CERTFILE
1243 ctx.load_default_certs()
1244 self.assertEqual(ctx.cert_store_stats(), {"crl": 0, "x509": 1, "x509_ca": 0})
1245
Benjamin Peterson91244e02014-10-03 18:17:15 -04001246 @unittest.skipUnless(sys.platform == "win32", "Windows specific")
Steve Dower68d663c2017-07-17 11:15:48 +02001247 @unittest.skipIf(hasattr(sys, "gettotalrefcount"), "Debug build does not share environment between CRTs")
Benjamin Peterson91244e02014-10-03 18:17:15 -04001248 def test_load_default_certs_env_windows(self):
1249 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1250 ctx.load_default_certs()
1251 stats = ctx.cert_store_stats()
1252
1253 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1254 with support.EnvironmentVarGuard() as env:
1255 env["SSL_CERT_DIR"] = CAPATH
1256 env["SSL_CERT_FILE"] = CERTFILE
1257 ctx.load_default_certs()
1258 stats["x509"] += 1
1259 self.assertEqual(ctx.cert_store_stats(), stats)
1260
Christian Heimes358cfd42016-09-10 22:43:48 +02001261 def _assert_context_options(self, ctx):
1262 self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
1263 if OP_NO_COMPRESSION != 0:
1264 self.assertEqual(ctx.options & OP_NO_COMPRESSION,
1265 OP_NO_COMPRESSION)
1266 if OP_SINGLE_DH_USE != 0:
1267 self.assertEqual(ctx.options & OP_SINGLE_DH_USE,
1268 OP_SINGLE_DH_USE)
1269 if OP_SINGLE_ECDH_USE != 0:
1270 self.assertEqual(ctx.options & OP_SINGLE_ECDH_USE,
1271 OP_SINGLE_ECDH_USE)
1272 if OP_CIPHER_SERVER_PREFERENCE != 0:
1273 self.assertEqual(ctx.options & OP_CIPHER_SERVER_PREFERENCE,
1274 OP_CIPHER_SERVER_PREFERENCE)
1275
Christian Heimes4c05b472013-11-23 15:58:30 +01001276 def test_create_default_context(self):
1277 ctx = ssl.create_default_context()
Christian Heimes358cfd42016-09-10 22:43:48 +02001278
Donald Stufft6a2ba942014-03-23 19:05:28 -04001279 self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
Christian Heimes4c05b472013-11-23 15:58:30 +01001280 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
Christian Heimes1aa9a752013-12-02 02:41:19 +01001281 self.assertTrue(ctx.check_hostname)
Christian Heimes358cfd42016-09-10 22:43:48 +02001282 self._assert_context_options(ctx)
1283
Christian Heimes4c05b472013-11-23 15:58:30 +01001284
1285 with open(SIGNING_CA) as f:
1286 cadata = f.read()
1287 ctx = ssl.create_default_context(cafile=SIGNING_CA, capath=CAPATH,
1288 cadata=cadata)
Donald Stufft6a2ba942014-03-23 19:05:28 -04001289 self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
Christian Heimes4c05b472013-11-23 15:58:30 +01001290 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
Christian Heimes358cfd42016-09-10 22:43:48 +02001291 self._assert_context_options(ctx)
Christian Heimes4c05b472013-11-23 15:58:30 +01001292
1293 ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
Donald Stufft6a2ba942014-03-23 19:05:28 -04001294 self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
Christian Heimes4c05b472013-11-23 15:58:30 +01001295 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
Christian Heimes358cfd42016-09-10 22:43:48 +02001296 self._assert_context_options(ctx)
Christian Heimes4c05b472013-11-23 15:58:30 +01001297
Christian Heimes67986f92013-11-23 22:43:47 +01001298 def test__create_stdlib_context(self):
1299 ctx = ssl._create_stdlib_context()
1300 self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
1301 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
Christian Heimes1aa9a752013-12-02 02:41:19 +01001302 self.assertFalse(ctx.check_hostname)
Christian Heimes358cfd42016-09-10 22:43:48 +02001303 self._assert_context_options(ctx)
Christian Heimes67986f92013-11-23 22:43:47 +01001304
1305 ctx = ssl._create_stdlib_context(ssl.PROTOCOL_TLSv1)
1306 self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1)
1307 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
Christian Heimes358cfd42016-09-10 22:43:48 +02001308 self._assert_context_options(ctx)
Christian Heimes67986f92013-11-23 22:43:47 +01001309
1310 ctx = ssl._create_stdlib_context(ssl.PROTOCOL_TLSv1,
Christian Heimesa02c69a2013-12-02 20:59:28 +01001311 cert_reqs=ssl.CERT_REQUIRED,
1312 check_hostname=True)
Christian Heimes67986f92013-11-23 22:43:47 +01001313 self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1)
1314 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
Christian Heimesa02c69a2013-12-02 20:59:28 +01001315 self.assertTrue(ctx.check_hostname)
Christian Heimes358cfd42016-09-10 22:43:48 +02001316 self._assert_context_options(ctx)
Christian Heimes67986f92013-11-23 22:43:47 +01001317
1318 ctx = ssl._create_stdlib_context(purpose=ssl.Purpose.CLIENT_AUTH)
1319 self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
1320 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
Christian Heimes358cfd42016-09-10 22:43:48 +02001321 self._assert_context_options(ctx)
Christian Heimes4c05b472013-11-23 15:58:30 +01001322
Christian Heimes1aa9a752013-12-02 02:41:19 +01001323 def test_check_hostname(self):
1324 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1325 self.assertFalse(ctx.check_hostname)
1326
1327 # Requires CERT_REQUIRED or CERT_OPTIONAL
1328 with self.assertRaises(ValueError):
1329 ctx.check_hostname = True
1330 ctx.verify_mode = ssl.CERT_REQUIRED
1331 self.assertFalse(ctx.check_hostname)
1332 ctx.check_hostname = True
1333 self.assertTrue(ctx.check_hostname)
1334
1335 ctx.verify_mode = ssl.CERT_OPTIONAL
1336 ctx.check_hostname = True
1337 self.assertTrue(ctx.check_hostname)
1338
1339 # Cannot set CERT_NONE with check_hostname enabled
1340 with self.assertRaises(ValueError):
1341 ctx.verify_mode = ssl.CERT_NONE
1342 ctx.check_hostname = False
1343 self.assertFalse(ctx.check_hostname)
1344
Christian Heimes5fe668c2016-09-12 00:01:11 +02001345 def test_context_client_server(self):
1346 # PROTOCOL_TLS_CLIENT has sane defaults
1347 ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
1348 self.assertTrue(ctx.check_hostname)
1349 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
1350
1351 # PROTOCOL_TLS_SERVER has different but also sane defaults
1352 ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
1353 self.assertFalse(ctx.check_hostname)
1354 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
1355
Antoine Pitrou152efa22010-05-16 18:19:27 +00001356
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02001357class SSLErrorTests(unittest.TestCase):
1358
1359 def test_str(self):
1360 # The str() of a SSLError doesn't include the errno
1361 e = ssl.SSLError(1, "foo")
1362 self.assertEqual(str(e), "foo")
1363 self.assertEqual(e.errno, 1)
1364 # Same for a subclass
1365 e = ssl.SSLZeroReturnError(1, "foo")
1366 self.assertEqual(str(e), "foo")
1367 self.assertEqual(e.errno, 1)
1368
1369 def test_lib_reason(self):
1370 # Test the library and reason attributes
1371 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1372 with self.assertRaises(ssl.SSLError) as cm:
1373 ctx.load_dh_params(CERTFILE)
1374 self.assertEqual(cm.exception.library, 'PEM')
1375 self.assertEqual(cm.exception.reason, 'NO_START_LINE')
1376 s = str(cm.exception)
1377 self.assertTrue(s.startswith("[PEM: NO_START_LINE] no start line"), s)
1378
1379 def test_subclass(self):
1380 # Check that the appropriate SSLError subclass is raised
1381 # (this only tests one of them)
1382 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1383 with socket.socket() as s:
1384 s.bind(("127.0.0.1", 0))
Charles-François Natali6e204602014-07-23 19:28:13 +01001385 s.listen()
Antoine Pitroue1ceb502013-01-12 21:54:44 +01001386 c = socket.socket()
1387 c.connect(s.getsockname())
1388 c.setblocking(False)
1389 with ctx.wrap_socket(c, False, do_handshake_on_connect=False) as c:
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02001390 with self.assertRaises(ssl.SSLWantReadError) as cm:
1391 c.do_handshake()
1392 s = str(cm.exception)
1393 self.assertTrue(s.startswith("The operation did not complete (read)"), s)
1394 # For compatibility
1395 self.assertEqual(cm.exception.errno, ssl.SSL_ERROR_WANT_READ)
1396
Nathaniel J. Smith59fdf0f2017-06-09 02:35:16 -07001397 def test_bad_idna_in_server_hostname(self):
1398 # Note: this test is testing some code that probably shouldn't exist
1399 # in the first place, so if it starts failing at some point because
1400 # you made the ssl module stop doing IDNA decoding then please feel
1401 # free to remove it. The test was mainly added because this case used
1402 # to cause memory corruption (see bpo-30594).
1403 ctx = ssl.create_default_context()
1404 with self.assertRaises(UnicodeError):
1405 ctx.wrap_bio(ssl.MemoryBIO(), ssl.MemoryBIO(),
1406 server_hostname="xn--.com")
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02001407
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001408class MemoryBIOTests(unittest.TestCase):
1409
1410 def test_read_write(self):
1411 bio = ssl.MemoryBIO()
1412 bio.write(b'foo')
1413 self.assertEqual(bio.read(), b'foo')
1414 self.assertEqual(bio.read(), b'')
1415 bio.write(b'foo')
1416 bio.write(b'bar')
1417 self.assertEqual(bio.read(), b'foobar')
1418 self.assertEqual(bio.read(), b'')
1419 bio.write(b'baz')
1420 self.assertEqual(bio.read(2), b'ba')
1421 self.assertEqual(bio.read(1), b'z')
1422 self.assertEqual(bio.read(1), b'')
1423
1424 def test_eof(self):
1425 bio = ssl.MemoryBIO()
1426 self.assertFalse(bio.eof)
1427 self.assertEqual(bio.read(), b'')
1428 self.assertFalse(bio.eof)
1429 bio.write(b'foo')
1430 self.assertFalse(bio.eof)
1431 bio.write_eof()
1432 self.assertFalse(bio.eof)
1433 self.assertEqual(bio.read(2), b'fo')
1434 self.assertFalse(bio.eof)
1435 self.assertEqual(bio.read(1), b'o')
1436 self.assertTrue(bio.eof)
1437 self.assertEqual(bio.read(), b'')
1438 self.assertTrue(bio.eof)
1439
1440 def test_pending(self):
1441 bio = ssl.MemoryBIO()
1442 self.assertEqual(bio.pending, 0)
1443 bio.write(b'foo')
1444 self.assertEqual(bio.pending, 3)
1445 for i in range(3):
1446 bio.read(1)
1447 self.assertEqual(bio.pending, 3-i-1)
1448 for i in range(3):
1449 bio.write(b'x')
1450 self.assertEqual(bio.pending, i+1)
1451 bio.read()
1452 self.assertEqual(bio.pending, 0)
1453
1454 def test_buffer_types(self):
1455 bio = ssl.MemoryBIO()
1456 bio.write(b'foo')
1457 self.assertEqual(bio.read(), b'foo')
1458 bio.write(bytearray(b'bar'))
1459 self.assertEqual(bio.read(), b'bar')
1460 bio.write(memoryview(b'baz'))
1461 self.assertEqual(bio.read(), b'baz')
1462
1463 def test_error_types(self):
1464 bio = ssl.MemoryBIO()
1465 self.assertRaises(TypeError, bio.write, 'foo')
1466 self.assertRaises(TypeError, bio.write, None)
1467 self.assertRaises(TypeError, bio.write, True)
1468 self.assertRaises(TypeError, bio.write, 1)
1469
1470
Martin Panter3840b2a2016-03-27 01:53:46 +00001471@unittest.skipUnless(_have_threads, "Needs threading module")
1472class SimpleBackgroundTests(unittest.TestCase):
1473
1474 """Tests that connect to a simple server running in the background"""
1475
1476 def setUp(self):
1477 server = ThreadedEchoServer(SIGNED_CERTFILE)
1478 self.server_addr = (HOST, server.port)
1479 server.__enter__()
1480 self.addCleanup(server.__exit__, None, None, None)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001481
Antoine Pitrou480a1242010-04-28 21:37:09 +00001482 def test_connect(self):
Christian Heimesd0486372016-09-10 23:23:33 +02001483 with test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001484 cert_reqs=ssl.CERT_NONE) as s:
1485 s.connect(self.server_addr)
1486 self.assertEqual({}, s.getpeercert())
Christian Heimesa5d07652016-09-24 10:48:05 +02001487 self.assertFalse(s.server_side)
Antoine Pitrou350c7222010-09-09 13:31:46 +00001488
Martin Panter3840b2a2016-03-27 01:53:46 +00001489 # this should succeed because we specify the root cert
Christian Heimesd0486372016-09-10 23:23:33 +02001490 with test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001491 cert_reqs=ssl.CERT_REQUIRED,
1492 ca_certs=SIGNING_CA) as s:
1493 s.connect(self.server_addr)
1494 self.assertTrue(s.getpeercert())
Christian Heimesa5d07652016-09-24 10:48:05 +02001495 self.assertFalse(s.server_side)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001496
Martin Panter3840b2a2016-03-27 01:53:46 +00001497 def test_connect_fail(self):
1498 # This should fail because we have no verification certs. Connection
1499 # failure crashes ThreadedEchoServer, so run this in an independent
1500 # test method.
Christian Heimesd0486372016-09-10 23:23:33 +02001501 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001502 cert_reqs=ssl.CERT_REQUIRED)
1503 self.addCleanup(s.close)
1504 self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
1505 s.connect, self.server_addr)
Antoine Pitrou152efa22010-05-16 18:19:27 +00001506
Antoine Pitroue93bf7a2011-02-26 23:24:06 +00001507 def test_connect_ex(self):
1508 # Issue #11326: check connect_ex() implementation
Christian Heimesd0486372016-09-10 23:23:33 +02001509 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001510 cert_reqs=ssl.CERT_REQUIRED,
1511 ca_certs=SIGNING_CA)
1512 self.addCleanup(s.close)
1513 self.assertEqual(0, s.connect_ex(self.server_addr))
1514 self.assertTrue(s.getpeercert())
Antoine Pitroue93bf7a2011-02-26 23:24:06 +00001515
1516 def test_non_blocking_connect_ex(self):
1517 # Issue #11326: non-blocking connect_ex() should allow handshake
1518 # to proceed after the socket gets ready.
Christian Heimesd0486372016-09-10 23:23:33 +02001519 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001520 cert_reqs=ssl.CERT_REQUIRED,
1521 ca_certs=SIGNING_CA,
1522 do_handshake_on_connect=False)
1523 self.addCleanup(s.close)
1524 s.setblocking(False)
1525 rc = s.connect_ex(self.server_addr)
1526 # EWOULDBLOCK under Windows, EINPROGRESS elsewhere
1527 self.assertIn(rc, (0, errno.EINPROGRESS, errno.EWOULDBLOCK))
1528 # Wait for connect to finish
1529 select.select([], [s], [], 5.0)
1530 # Non-blocking handshake
1531 while True:
Antoine Pitroue93bf7a2011-02-26 23:24:06 +00001532 try:
Martin Panter3840b2a2016-03-27 01:53:46 +00001533 s.do_handshake()
1534 break
1535 except ssl.SSLWantReadError:
1536 select.select([s], [], [], 5.0)
1537 except ssl.SSLWantWriteError:
Antoine Pitroue93bf7a2011-02-26 23:24:06 +00001538 select.select([], [s], [], 5.0)
Martin Panter3840b2a2016-03-27 01:53:46 +00001539 # SSL established
1540 self.assertTrue(s.getpeercert())
Antoine Pitrou40f12ab2012-12-28 19:03:43 +01001541
Antoine Pitrou152efa22010-05-16 18:19:27 +00001542 def test_connect_with_context(self):
Martin Panter3840b2a2016-03-27 01:53:46 +00001543 # Same as test_connect, but with a separately created context
1544 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1545 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1546 s.connect(self.server_addr)
1547 self.assertEqual({}, s.getpeercert())
1548 # Same with a server hostname
1549 with ctx.wrap_socket(socket.socket(socket.AF_INET),
1550 server_hostname="dummy") as s:
1551 s.connect(self.server_addr)
1552 ctx.verify_mode = ssl.CERT_REQUIRED
1553 # This should succeed because we specify the root cert
1554 ctx.load_verify_locations(SIGNING_CA)
1555 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1556 s.connect(self.server_addr)
1557 cert = s.getpeercert()
1558 self.assertTrue(cert)
1559
1560 def test_connect_with_context_fail(self):
1561 # This should fail because we have no verification certs. Connection
1562 # failure crashes ThreadedEchoServer, so run this in an independent
1563 # test method.
1564 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1565 ctx.verify_mode = ssl.CERT_REQUIRED
1566 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
1567 self.addCleanup(s.close)
1568 self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
1569 s.connect, self.server_addr)
Antoine Pitrou152efa22010-05-16 18:19:27 +00001570
1571 def test_connect_capath(self):
1572 # Verify server certificates using the `capath` argument
Antoine Pitrou467f28d2010-05-16 19:22:44 +00001573 # NOTE: the subject hashing algorithm has been changed between
1574 # OpenSSL 0.9.8n and 1.0.0, as a result the capath directory must
1575 # contain both versions of each certificate (same content, different
Antoine Pitroud7e4c1c2010-05-17 14:13:10 +00001576 # filename) for this test to be portable across OpenSSL releases.
Martin Panter3840b2a2016-03-27 01:53:46 +00001577 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1578 ctx.verify_mode = ssl.CERT_REQUIRED
1579 ctx.load_verify_locations(capath=CAPATH)
1580 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1581 s.connect(self.server_addr)
1582 cert = s.getpeercert()
1583 self.assertTrue(cert)
1584 # Same with a bytes `capath` argument
1585 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1586 ctx.verify_mode = ssl.CERT_REQUIRED
1587 ctx.load_verify_locations(capath=BYTES_CAPATH)
1588 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1589 s.connect(self.server_addr)
1590 cert = s.getpeercert()
1591 self.assertTrue(cert)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001592
Christian Heimesefff7062013-11-21 03:35:02 +01001593 def test_connect_cadata(self):
Martin Panter3840b2a2016-03-27 01:53:46 +00001594 with open(SIGNING_CA) as f:
Christian Heimesefff7062013-11-21 03:35:02 +01001595 pem = f.read()
1596 der = ssl.PEM_cert_to_DER_cert(pem)
Martin Panter3840b2a2016-03-27 01:53:46 +00001597 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1598 ctx.verify_mode = ssl.CERT_REQUIRED
1599 ctx.load_verify_locations(cadata=pem)
1600 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1601 s.connect(self.server_addr)
1602 cert = s.getpeercert()
1603 self.assertTrue(cert)
Christian Heimesefff7062013-11-21 03:35:02 +01001604
Martin Panter3840b2a2016-03-27 01:53:46 +00001605 # same with DER
1606 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1607 ctx.verify_mode = ssl.CERT_REQUIRED
1608 ctx.load_verify_locations(cadata=der)
1609 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1610 s.connect(self.server_addr)
1611 cert = s.getpeercert()
1612 self.assertTrue(cert)
Christian Heimesefff7062013-11-21 03:35:02 +01001613
Antoine Pitroue3220242010-04-24 11:13:53 +00001614 @unittest.skipIf(os.name == "nt", "Can't use a socket as a file under Windows")
1615 def test_makefile_close(self):
1616 # Issue #5238: creating a file-like object with makefile() shouldn't
1617 # delay closing the underlying "real socket" (here tested with its
1618 # file descriptor, hence skipping the test under Windows).
Christian Heimesd0486372016-09-10 23:23:33 +02001619 ss = test_wrap_socket(socket.socket(socket.AF_INET))
Martin Panter3840b2a2016-03-27 01:53:46 +00001620 ss.connect(self.server_addr)
1621 fd = ss.fileno()
1622 f = ss.makefile()
1623 f.close()
1624 # The fd is still open
1625 os.read(fd, 0)
1626 # Closing the SSL socket should close the fd too
1627 ss.close()
1628 gc.collect()
1629 with self.assertRaises(OSError) as e:
Antoine Pitroue3220242010-04-24 11:13:53 +00001630 os.read(fd, 0)
Martin Panter3840b2a2016-03-27 01:53:46 +00001631 self.assertEqual(e.exception.errno, errno.EBADF)
Antoine Pitroue3220242010-04-24 11:13:53 +00001632
Antoine Pitrou480a1242010-04-28 21:37:09 +00001633 def test_non_blocking_handshake(self):
Martin Panter3840b2a2016-03-27 01:53:46 +00001634 s = socket.socket(socket.AF_INET)
1635 s.connect(self.server_addr)
1636 s.setblocking(False)
Christian Heimesd0486372016-09-10 23:23:33 +02001637 s = test_wrap_socket(s,
Martin Panter3840b2a2016-03-27 01:53:46 +00001638 cert_reqs=ssl.CERT_NONE,
1639 do_handshake_on_connect=False)
1640 self.addCleanup(s.close)
1641 count = 0
1642 while True:
1643 try:
1644 count += 1
1645 s.do_handshake()
1646 break
1647 except ssl.SSLWantReadError:
1648 select.select([s], [], [])
1649 except ssl.SSLWantWriteError:
1650 select.select([], [s], [])
1651 if support.verbose:
1652 sys.stdout.write("\nNeeded %d calls to do_handshake() to establish session.\n" % count)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001653
Antoine Pitrou480a1242010-04-28 21:37:09 +00001654 def test_get_server_certificate(self):
Martin Panter3840b2a2016-03-27 01:53:46 +00001655 _test_get_server_certificate(self, *self.server_addr, cert=SIGNING_CA)
Antoine Pitrou5aefa662011-04-28 19:24:46 +02001656
Martin Panter3840b2a2016-03-27 01:53:46 +00001657 def test_get_server_certificate_fail(self):
1658 # Connection failure crashes ThreadedEchoServer, so run this in an
1659 # independent test method
1660 _test_get_server_certificate_fail(self, *self.server_addr)
Bill Janssen54cc54c2007-12-14 22:08:56 +00001661
Antoine Pitrouf4c7bad2010-08-15 23:02:22 +00001662 def test_ciphers(self):
Christian Heimesd0486372016-09-10 23:23:33 +02001663 with test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001664 cert_reqs=ssl.CERT_NONE, ciphers="ALL") as s:
1665 s.connect(self.server_addr)
Christian Heimesd0486372016-09-10 23:23:33 +02001666 with test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001667 cert_reqs=ssl.CERT_NONE, ciphers="DEFAULT") as s:
1668 s.connect(self.server_addr)
1669 # Error checking can happen at instantiation or when connecting
1670 with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
1671 with socket.socket(socket.AF_INET) as sock:
Christian Heimesd0486372016-09-10 23:23:33 +02001672 s = test_wrap_socket(sock,
Martin Panter3840b2a2016-03-27 01:53:46 +00001673 cert_reqs=ssl.CERT_NONE, ciphers="^$:,;?*'dorothyx")
1674 s.connect(self.server_addr)
Antoine Pitroufec12ff2010-04-21 19:46:23 +00001675
Christian Heimes9a5395a2013-06-17 15:44:12 +02001676 def test_get_ca_certs_capath(self):
1677 # capath certs are loaded on request
Martin Panter3840b2a2016-03-27 01:53:46 +00001678 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1679 ctx.verify_mode = ssl.CERT_REQUIRED
1680 ctx.load_verify_locations(capath=CAPATH)
1681 self.assertEqual(ctx.get_ca_certs(), [])
1682 with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
1683 s.connect(self.server_addr)
1684 cert = s.getpeercert()
1685 self.assertTrue(cert)
1686 self.assertEqual(len(ctx.get_ca_certs()), 1)
Christian Heimes9a5395a2013-06-17 15:44:12 +02001687
Christian Heimes575596e2013-12-15 21:49:17 +01001688 @needs_sni
Christian Heimes8e7f3942013-12-05 07:41:08 +01001689 def test_context_setget(self):
1690 # Check that the context of a connected socket can be replaced.
Martin Panter3840b2a2016-03-27 01:53:46 +00001691 ctx1 = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1692 ctx2 = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1693 s = socket.socket(socket.AF_INET)
1694 with ctx1.wrap_socket(s) as ss:
1695 ss.connect(self.server_addr)
1696 self.assertIs(ss.context, ctx1)
1697 self.assertIs(ss._sslobj.context, ctx1)
1698 ss.context = ctx2
1699 self.assertIs(ss.context, ctx2)
1700 self.assertIs(ss._sslobj.context, ctx2)
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001701
1702 def ssl_io_loop(self, sock, incoming, outgoing, func, *args, **kwargs):
1703 # A simple IO loop. Call func(*args) depending on the error we get
1704 # (WANT_READ or WANT_WRITE) move data between the socket and the BIOs.
1705 timeout = kwargs.get('timeout', 10)
1706 count = 0
1707 while True:
1708 errno = None
1709 count += 1
1710 try:
1711 ret = func(*args)
1712 except ssl.SSLError as e:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001713 if e.errno not in (ssl.SSL_ERROR_WANT_READ,
Martin Panter40b97ec2016-01-14 13:05:46 +00001714 ssl.SSL_ERROR_WANT_WRITE):
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001715 raise
1716 errno = e.errno
1717 # Get any data from the outgoing BIO irrespective of any error, and
1718 # send it to the socket.
1719 buf = outgoing.read()
1720 sock.sendall(buf)
1721 # If there's no error, we're done. For WANT_READ, we need to get
1722 # data from the socket and put it in the incoming BIO.
1723 if errno is None:
1724 break
1725 elif errno == ssl.SSL_ERROR_WANT_READ:
1726 buf = sock.recv(32768)
1727 if buf:
1728 incoming.write(buf)
1729 else:
1730 incoming.write_eof()
1731 if support.verbose:
1732 sys.stdout.write("Needed %d calls to complete %s().\n"
1733 % (count, func.__name__))
1734 return ret
1735
Martin Panter3840b2a2016-03-27 01:53:46 +00001736 def test_bio_handshake(self):
1737 sock = socket.socket(socket.AF_INET)
1738 self.addCleanup(sock.close)
1739 sock.connect(self.server_addr)
1740 incoming = ssl.MemoryBIO()
1741 outgoing = ssl.MemoryBIO()
1742 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1743 ctx.verify_mode = ssl.CERT_REQUIRED
1744 ctx.load_verify_locations(SIGNING_CA)
1745 ctx.check_hostname = True
1746 sslobj = ctx.wrap_bio(incoming, outgoing, False, 'localhost')
1747 self.assertIs(sslobj._sslobj.owner, sslobj)
1748 self.assertIsNone(sslobj.cipher())
Christian Heimes01113fa2016-09-05 23:23:24 +02001749 self.assertIsNotNone(sslobj.shared_ciphers())
Martin Panter3840b2a2016-03-27 01:53:46 +00001750 self.assertRaises(ValueError, sslobj.getpeercert)
1751 if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
1752 self.assertIsNone(sslobj.get_channel_binding('tls-unique'))
1753 self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
1754 self.assertTrue(sslobj.cipher())
Christian Heimes01113fa2016-09-05 23:23:24 +02001755 self.assertIsNotNone(sslobj.shared_ciphers())
Martin Panter3840b2a2016-03-27 01:53:46 +00001756 self.assertTrue(sslobj.getpeercert())
1757 if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
1758 self.assertTrue(sslobj.get_channel_binding('tls-unique'))
1759 try:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001760 self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
Martin Panter3840b2a2016-03-27 01:53:46 +00001761 except ssl.SSLSyscallError:
1762 # If the server shuts down the TCP connection without sending a
1763 # secure shutdown message, this is reported as SSL_ERROR_SYSCALL
1764 pass
1765 self.assertRaises(ssl.SSLError, sslobj.write, b'foo')
1766
1767 def test_bio_read_write_data(self):
1768 sock = socket.socket(socket.AF_INET)
1769 self.addCleanup(sock.close)
1770 sock.connect(self.server_addr)
1771 incoming = ssl.MemoryBIO()
1772 outgoing = ssl.MemoryBIO()
1773 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1774 ctx.verify_mode = ssl.CERT_NONE
1775 sslobj = ctx.wrap_bio(incoming, outgoing, False)
1776 self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
1777 req = b'FOO\n'
1778 self.ssl_io_loop(sock, incoming, outgoing, sslobj.write, req)
1779 buf = self.ssl_io_loop(sock, incoming, outgoing, sslobj.read, 1024)
1780 self.assertEqual(buf, b'foo\n')
1781 self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001782
1783
Martin Panter3840b2a2016-03-27 01:53:46 +00001784class NetworkedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001785
Martin Panter3840b2a2016-03-27 01:53:46 +00001786 def test_timeout_connect_ex(self):
1787 # Issue #12065: on a timeout, connect_ex() should return the original
1788 # errno (mimicking the behaviour of non-SSL sockets).
1789 with support.transient_internet(REMOTE_HOST):
Christian Heimesd0486372016-09-10 23:23:33 +02001790 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001791 cert_reqs=ssl.CERT_REQUIRED,
1792 do_handshake_on_connect=False)
1793 self.addCleanup(s.close)
1794 s.settimeout(0.0000001)
1795 rc = s.connect_ex((REMOTE_HOST, 443))
1796 if rc == 0:
1797 self.skipTest("REMOTE_HOST responded too quickly")
1798 self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
1799
1800 @unittest.skipUnless(support.IPV6_ENABLED, 'Needs IPv6')
1801 def test_get_server_certificate_ipv6(self):
1802 with support.transient_internet('ipv6.google.com'):
1803 _test_get_server_certificate(self, 'ipv6.google.com', 443)
1804 _test_get_server_certificate_fail(self, 'ipv6.google.com', 443)
1805
Martin Panter3840b2a2016-03-27 01:53:46 +00001806
1807def _test_get_server_certificate(test, host, port, cert=None):
1808 pem = ssl.get_server_certificate((host, port))
1809 if not pem:
1810 test.fail("No server certificate on %s:%s!" % (host, port))
1811
1812 pem = ssl.get_server_certificate((host, port), ca_certs=cert)
1813 if not pem:
1814 test.fail("No server certificate on %s:%s!" % (host, port))
1815 if support.verbose:
1816 sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
1817
1818def _test_get_server_certificate_fail(test, host, port):
1819 try:
1820 pem = ssl.get_server_certificate((host, port), ca_certs=CERTFILE)
1821 except ssl.SSLError as x:
1822 #should fail
1823 if support.verbose:
1824 sys.stdout.write("%s\n" % x)
1825 else:
1826 test.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
1827
1828
1829if _have_threads:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001830 from test.ssl_servers import make_https_server
1831
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001832 class ThreadedEchoServer(threading.Thread):
1833
1834 class ConnectionHandler(threading.Thread):
1835
1836 """A mildly complicated class, because we want it to work both
1837 with and without the SSL wrapper around the socket connection, so
1838 that we can test the STARTTLS functionality."""
1839
Bill Janssen6e027db2007-11-15 22:23:56 +00001840 def __init__(self, server, connsock, addr):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001841 self.server = server
1842 self.running = False
1843 self.sock = connsock
Bill Janssen6e027db2007-11-15 22:23:56 +00001844 self.addr = addr
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001845 self.sock.setblocking(1)
1846 self.sslconn = None
1847 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00001848 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001849
Antoine Pitrou480a1242010-04-28 21:37:09 +00001850 def wrap_conn(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001851 try:
Antoine Pitroub5218772010-05-21 09:56:06 +00001852 self.sslconn = self.server.context.wrap_socket(
1853 self.sock, server_side=True)
Benjamin Petersoncca27322015-01-23 16:35:37 -05001854 self.server.selected_npn_protocols.append(self.sslconn.selected_npn_protocol())
1855 self.server.selected_alpn_protocols.append(self.sslconn.selected_alpn_protocol())
Nadeem Vawdaad246bf2013-03-03 22:44:22 +01001856 except (ssl.SSLError, ConnectionResetError) as e:
1857 # We treat ConnectionResetError as though it were an
1858 # SSLError - OpenSSL on Ubuntu abruptly closes the
1859 # connection when asked to use an unsupported protocol.
1860 #
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001861 # XXX Various errors can have happened here, for example
1862 # a mismatching protocol version, an invalid certificate,
1863 # or a low-level bug. This should be made more discriminating.
Victor Stinner86871012017-09-02 00:26:17 +02001864 #
1865 # bpo-31323: Store the exception as string to prevent
1866 # a reference leak: server -> conn_errors -> exception
1867 # -> traceback -> self (ConnectionHandler) -> server
1868 self.server.conn_errors.append(str(e))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001869 if self.server.chatty:
Bill Janssen6e027db2007-11-15 22:23:56 +00001870 handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001871 self.running = False
1872 self.server.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +00001873 self.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001874 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001875 else:
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001876 self.server.shared_ciphers.append(self.sslconn.shared_ciphers())
Antoine Pitroub5218772010-05-21 09:56:06 +00001877 if self.server.context.verify_mode == ssl.CERT_REQUIRED:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001878 cert = self.sslconn.getpeercert()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001879 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001880 sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
1881 cert_binary = self.sslconn.getpeercert(True)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001882 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001883 sys.stdout.write(" cert binary is " + str(len(cert_binary)) + " bytes\n")
1884 cipher = self.sslconn.cipher()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001885 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001886 sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001887 sys.stdout.write(" server: selected protocol is now "
1888 + str(self.sslconn.selected_npn_protocol()) + "\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001889 return True
1890
1891 def read(self):
1892 if self.sslconn:
1893 return self.sslconn.read()
1894 else:
1895 return self.sock.recv(1024)
1896
1897 def write(self, bytes):
1898 if self.sslconn:
1899 return self.sslconn.write(bytes)
1900 else:
1901 return self.sock.send(bytes)
1902
1903 def close(self):
1904 if self.sslconn:
1905 self.sslconn.close()
1906 else:
1907 self.sock.close()
1908
Antoine Pitrou480a1242010-04-28 21:37:09 +00001909 def run(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001910 self.running = True
1911 if not self.server.starttls_server:
1912 if not self.wrap_conn():
1913 return
1914 while self.running:
1915 try:
1916 msg = self.read()
Antoine Pitrou480a1242010-04-28 21:37:09 +00001917 stripped = msg.strip()
1918 if not stripped:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001919 # eof, so quit this handler
1920 self.running = False
Martin Panter3840b2a2016-03-27 01:53:46 +00001921 try:
1922 self.sock = self.sslconn.unwrap()
1923 except OSError:
1924 # Many tests shut the TCP connection down
1925 # without an SSL shutdown. This causes
1926 # unwrap() to raise OSError with errno=0!
1927 pass
1928 else:
1929 self.sslconn = None
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001930 self.close()
Antoine Pitrou480a1242010-04-28 21:37:09 +00001931 elif stripped == b'over':
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001932 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001933 sys.stdout.write(" server: client closed connection\n")
1934 self.close()
1935 return
Bill Janssen6e027db2007-11-15 22:23:56 +00001936 elif (self.server.starttls_server and
Antoine Pitrou764b8782010-04-28 22:57:15 +00001937 stripped == b'STARTTLS'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001938 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001939 sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001940 self.write(b"OK\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001941 if not self.wrap_conn():
1942 return
Bill Janssen40a0f662008-08-12 16:56:25 +00001943 elif (self.server.starttls_server and self.sslconn
Antoine Pitrou764b8782010-04-28 22:57:15 +00001944 and stripped == b'ENDTLS'):
Bill Janssen40a0f662008-08-12 16:56:25 +00001945 if support.verbose and self.server.connectionchatty:
1946 sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001947 self.write(b"OK\n")
Bill Janssen40a0f662008-08-12 16:56:25 +00001948 self.sock = self.sslconn.unwrap()
1949 self.sslconn = None
1950 if support.verbose and self.server.connectionchatty:
1951 sys.stdout.write(" server: connection is now unencrypted...\n")
Antoine Pitroud6494802011-07-21 01:11:30 +02001952 elif stripped == b'CB tls-unique':
1953 if support.verbose and self.server.connectionchatty:
1954 sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
1955 data = self.sslconn.get_channel_binding("tls-unique")
1956 self.write(repr(data).encode("us-ascii") + b"\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001957 else:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001958 if (support.verbose and
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001959 self.server.connectionchatty):
1960 ctype = (self.sslconn and "encrypted") or "unencrypted"
Antoine Pitrou480a1242010-04-28 21:37:09 +00001961 sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
1962 % (msg, ctype, msg.lower(), ctype))
1963 self.write(msg.lower())
Andrew Svetlov0832af62012-12-18 23:10:48 +02001964 except OSError:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001965 if self.server.chatty:
1966 handle_error("Test server failure:\n")
1967 self.close()
1968 self.running = False
1969 # normally, we'd just stop here, but for the test
1970 # harness, we want to stop the server
1971 self.server.stop()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001972
Antoine Pitroub5218772010-05-21 09:56:06 +00001973 def __init__(self, certificate=None, ssl_version=None,
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001974 certreqs=None, cacerts=None,
Antoine Pitrou2d9cb9c2010-04-17 17:40:45 +00001975 chatty=True, connectionchatty=False, starttls_server=False,
Benjamin Petersoncca27322015-01-23 16:35:37 -05001976 npn_protocols=None, alpn_protocols=None,
1977 ciphers=None, context=None):
Antoine Pitroub5218772010-05-21 09:56:06 +00001978 if context:
1979 self.context = context
1980 else:
1981 self.context = ssl.SSLContext(ssl_version
1982 if ssl_version is not None
1983 else ssl.PROTOCOL_TLSv1)
1984 self.context.verify_mode = (certreqs if certreqs is not None
1985 else ssl.CERT_NONE)
1986 if cacerts:
1987 self.context.load_verify_locations(cacerts)
1988 if certificate:
1989 self.context.load_cert_chain(certificate)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001990 if npn_protocols:
1991 self.context.set_npn_protocols(npn_protocols)
Benjamin Petersoncca27322015-01-23 16:35:37 -05001992 if alpn_protocols:
1993 self.context.set_alpn_protocols(alpn_protocols)
Antoine Pitroub5218772010-05-21 09:56:06 +00001994 if ciphers:
1995 self.context.set_ciphers(ciphers)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001996 self.chatty = chatty
1997 self.connectionchatty = connectionchatty
1998 self.starttls_server = starttls_server
1999 self.sock = socket.socket()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002000 self.port = support.bind_port(self.sock)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002001 self.flag = None
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002002 self.active = False
Benjamin Petersoncca27322015-01-23 16:35:37 -05002003 self.selected_npn_protocols = []
2004 self.selected_alpn_protocols = []
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002005 self.shared_ciphers = []
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002006 self.conn_errors = []
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002007 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00002008 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002009
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002010 def __enter__(self):
2011 self.start(threading.Event())
2012 self.flag.wait()
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002013 return self
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002014
2015 def __exit__(self, *args):
2016 self.stop()
2017 self.join()
2018
Antoine Pitrou480a1242010-04-28 21:37:09 +00002019 def start(self, flag=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002020 self.flag = flag
2021 threading.Thread.start(self)
2022
Antoine Pitrou480a1242010-04-28 21:37:09 +00002023 def run(self):
Antoine Pitrouaf7c6022010-04-27 09:56:02 +00002024 self.sock.settimeout(0.05)
Charles-François Natali6e204602014-07-23 19:28:13 +01002025 self.sock.listen()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002026 self.active = True
2027 if self.flag:
2028 # signal an event
2029 self.flag.set()
2030 while self.active:
2031 try:
2032 newconn, connaddr = self.sock.accept()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002033 if support.verbose and self.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002034 sys.stdout.write(' server: new connection from '
Bill Janssen6e027db2007-11-15 22:23:56 +00002035 + repr(connaddr) + '\n')
2036 handler = self.ConnectionHandler(self, newconn, connaddr)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002037 handler.start()
Antoine Pitroueced82e2012-01-27 17:33:01 +01002038 handler.join()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002039 except socket.timeout:
2040 pass
2041 except KeyboardInterrupt:
2042 self.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +00002043 self.sock.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002044
Antoine Pitrou480a1242010-04-28 21:37:09 +00002045 def stop(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002046 self.active = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002047
Bill Janssen54cc54c2007-12-14 22:08:56 +00002048 class AsyncoreEchoServer(threading.Thread):
2049
2050 # this one's based on asyncore.dispatcher
2051
2052 class EchoServer (asyncore.dispatcher):
2053
Victor Stinner1dae7452017-05-02 13:12:02 +02002054 class ConnectionHandler(asyncore.dispatcher_with_send):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002055
2056 def __init__(self, conn, certfile):
Christian Heimesd0486372016-09-10 23:23:33 +02002057 self.socket = test_wrap_socket(conn, server_side=True,
Bill Janssen54cc54c2007-12-14 22:08:56 +00002058 certfile=certfile,
2059 do_handshake_on_connect=False)
2060 asyncore.dispatcher_with_send.__init__(self, self.socket)
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002061 self._ssl_accepting = True
2062 self._do_ssl_handshake()
Bill Janssen54cc54c2007-12-14 22:08:56 +00002063
2064 def readable(self):
2065 if isinstance(self.socket, ssl.SSLSocket):
2066 while self.socket.pending() > 0:
2067 self.handle_read_event()
2068 return True
2069
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002070 def _do_ssl_handshake(self):
2071 try:
2072 self.socket.do_handshake()
Antoine Pitrou41032a62011-10-27 23:56:55 +02002073 except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
2074 return
2075 except ssl.SSLEOFError:
2076 return self.handle_close()
2077 except ssl.SSLError:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002078 raise
Andrew Svetlov0832af62012-12-18 23:10:48 +02002079 except OSError as err:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002080 if err.args[0] == errno.ECONNABORTED:
2081 return self.handle_close()
Bill Janssen54cc54c2007-12-14 22:08:56 +00002082 else:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002083 self._ssl_accepting = False
2084
2085 def handle_read(self):
2086 if self._ssl_accepting:
2087 self._do_ssl_handshake()
2088 else:
2089 data = self.recv(1024)
2090 if support.verbose:
2091 sys.stdout.write(" server: read %s from client\n" % repr(data))
2092 if not data:
2093 self.close()
2094 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002095 self.send(data.lower())
Bill Janssen54cc54c2007-12-14 22:08:56 +00002096
2097 def handle_close(self):
Bill Janssen2f5799b2008-06-29 00:08:12 +00002098 self.close()
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002099 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00002100 sys.stdout.write(" server: closed connection %s\n" % self.socket)
2101
2102 def handle_error(self):
2103 raise
2104
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002105 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002106 self.certfile = certfile
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002107 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
2108 self.port = support.bind_port(sock, '')
2109 asyncore.dispatcher.__init__(self, sock)
Bill Janssen54cc54c2007-12-14 22:08:56 +00002110 self.listen(5)
2111
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00002112 def handle_accepted(self, sock_obj, addr):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002113 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00002114 sys.stdout.write(" server: new connection from %s:%s\n" %addr)
2115 self.ConnectionHandler(sock_obj, self.certfile)
2116
2117 def handle_error(self):
2118 raise
2119
Trent Nelson78520002008-04-10 20:54:35 +00002120 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002121 self.flag = None
2122 self.active = False
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002123 self.server = self.EchoServer(certfile)
2124 self.port = self.server.port
Bill Janssen54cc54c2007-12-14 22:08:56 +00002125 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00002126 self.daemon = True
Bill Janssen54cc54c2007-12-14 22:08:56 +00002127
2128 def __str__(self):
2129 return "<%s %s>" % (self.__class__.__name__, self.server)
2130
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002131 def __enter__(self):
2132 self.start(threading.Event())
2133 self.flag.wait()
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002134 return self
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002135
2136 def __exit__(self, *args):
2137 if support.verbose:
2138 sys.stdout.write(" cleanup: stopping server.\n")
2139 self.stop()
2140 if support.verbose:
2141 sys.stdout.write(" cleanup: joining server thread.\n")
2142 self.join()
2143 if support.verbose:
2144 sys.stdout.write(" cleanup: successfully joined.\n")
Victor Stinner1dae7452017-05-02 13:12:02 +02002145 # make sure that ConnectionHandler is removed from socket_map
2146 asyncore.close_all(ignore_all=True)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002147
Bill Janssen54cc54c2007-12-14 22:08:56 +00002148 def start (self, flag=None):
2149 self.flag = flag
2150 threading.Thread.start(self)
2151
Antoine Pitrou480a1242010-04-28 21:37:09 +00002152 def run(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002153 self.active = True
2154 if self.flag:
2155 self.flag.set()
2156 while self.active:
2157 try:
2158 asyncore.loop(1)
2159 except:
2160 pass
2161
Antoine Pitrou480a1242010-04-28 21:37:09 +00002162 def stop(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002163 self.active = False
2164 self.server.close()
2165
Antoine Pitroub5218772010-05-21 09:56:06 +00002166 def server_params_test(client_context, server_context, indata=b"FOO\n",
Christian Heimes99a65702016-09-10 23:44:53 +02002167 chatty=True, connectionchatty=False, sni_name=None,
2168 session=None):
Antoine Pitrou480a1242010-04-28 21:37:09 +00002169 """
2170 Launch a server, connect a client to it and try various reads
2171 and writes.
2172 """
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002173 stats = {}
Antoine Pitroub5218772010-05-21 09:56:06 +00002174 server = ThreadedEchoServer(context=server_context,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002175 chatty=chatty,
Bill Janssen6e027db2007-11-15 22:23:56 +00002176 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002177 with server:
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002178 with client_context.wrap_socket(socket.socket(),
Christian Heimes99a65702016-09-10 23:44:53 +02002179 server_hostname=sni_name, session=session) as s:
Antoine Pitroueba63c42012-01-28 17:38:34 +01002180 s.connect((HOST, server.port))
2181 for arg in [indata, bytearray(indata), memoryview(indata)]:
2182 if connectionchatty:
2183 if support.verbose:
2184 sys.stdout.write(
2185 " client: sending %r...\n" % indata)
2186 s.write(arg)
2187 outdata = s.read()
2188 if connectionchatty:
2189 if support.verbose:
2190 sys.stdout.write(" client: read %r\n" % outdata)
2191 if outdata != indata.lower():
2192 raise AssertionError(
2193 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
2194 % (outdata[:20], len(outdata),
2195 indata[:20].lower(), len(indata)))
2196 s.write(b"over\n")
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00002197 if connectionchatty:
2198 if support.verbose:
Antoine Pitroueba63c42012-01-28 17:38:34 +01002199 sys.stdout.write(" client: closing connection.\n")
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002200 stats.update({
Antoine Pitrouce816a52012-01-28 17:40:23 +01002201 'compression': s.compression(),
2202 'cipher': s.cipher(),
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002203 'peercert': s.getpeercert(),
Benjamin Petersoncca27322015-01-23 16:35:37 -05002204 'client_alpn_protocol': s.selected_alpn_protocol(),
Antoine Pitrou47e40422014-09-04 21:00:10 +02002205 'client_npn_protocol': s.selected_npn_protocol(),
2206 'version': s.version(),
Christian Heimes99a65702016-09-10 23:44:53 +02002207 'session_reused': s.session_reused,
2208 'session': s.session,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002209 })
Antoine Pitroueba63c42012-01-28 17:38:34 +01002210 s.close()
Benjamin Petersoncca27322015-01-23 16:35:37 -05002211 stats['server_alpn_protocols'] = server.selected_alpn_protocols
2212 stats['server_npn_protocols'] = server.selected_npn_protocols
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002213 stats['server_shared_ciphers'] = server.shared_ciphers
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002214 return stats
Thomas Woutersed03b412007-08-28 21:37:11 +00002215
Antoine Pitroub5218772010-05-21 09:56:06 +00002216 def try_protocol_combo(server_protocol, client_protocol, expect_success,
2217 certsreqs=None, server_options=0, client_options=0):
Antoine Pitrou47e40422014-09-04 21:00:10 +02002218 """
2219 Try to SSL-connect using *client_protocol* to *server_protocol*.
2220 If *expect_success* is true, assert that the connection succeeds,
2221 if it's false, assert that the connection fails.
2222 Also, if *expect_success* is a string, assert that it is the protocol
2223 version actually used by the connection.
2224 """
Benjamin Peterson2a691a82008-03-31 01:51:45 +00002225 if certsreqs is None:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002226 certsreqs = ssl.CERT_NONE
Antoine Pitrou480a1242010-04-28 21:37:09 +00002227 certtype = {
2228 ssl.CERT_NONE: "CERT_NONE",
2229 ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
2230 ssl.CERT_REQUIRED: "CERT_REQUIRED",
2231 }[certsreqs]
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002232 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002233 formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002234 sys.stdout.write(formatstr %
2235 (ssl.get_protocol_name(client_protocol),
2236 ssl.get_protocol_name(server_protocol),
2237 certtype))
Antoine Pitroub5218772010-05-21 09:56:06 +00002238 client_context = ssl.SSLContext(client_protocol)
Antoine Pitrou32c49152014-01-09 21:28:48 +01002239 client_context.options |= client_options
Antoine Pitroub5218772010-05-21 09:56:06 +00002240 server_context = ssl.SSLContext(server_protocol)
Antoine Pitrou32c49152014-01-09 21:28:48 +01002241 server_context.options |= server_options
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002242
2243 # NOTE: we must enable "ALL" ciphers on the client, otherwise an
2244 # SSLv23 client will send an SSLv3 hello (rather than SSLv2)
2245 # starting from OpenSSL 1.0.0 (see issue #8322).
2246 if client_context.protocol == ssl.PROTOCOL_SSLv23:
2247 client_context.set_ciphers("ALL")
2248
Antoine Pitroub5218772010-05-21 09:56:06 +00002249 for ctx in (client_context, server_context):
2250 ctx.verify_mode = certsreqs
Antoine Pitroub5218772010-05-21 09:56:06 +00002251 ctx.load_cert_chain(CERTFILE)
2252 ctx.load_verify_locations(CERTFILE)
2253 try:
Antoine Pitrou47e40422014-09-04 21:00:10 +02002254 stats = server_params_test(client_context, server_context,
2255 chatty=False, connectionchatty=False)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002256 # Protocol mismatch can result in either an SSLError, or a
2257 # "Connection reset by peer" error.
2258 except ssl.SSLError:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002259 if expect_success:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002260 raise
Andrew Svetlov0832af62012-12-18 23:10:48 +02002261 except OSError as e:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002262 if expect_success or e.errno != errno.ECONNRESET:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002263 raise
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002264 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002265 if not expect_success:
Antoine Pitroud75b2a92010-05-06 14:15:10 +00002266 raise AssertionError(
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002267 "Client protocol %s succeeded with server protocol %s!"
2268 % (ssl.get_protocol_name(client_protocol),
2269 ssl.get_protocol_name(server_protocol)))
Antoine Pitrou47e40422014-09-04 21:00:10 +02002270 elif (expect_success is not True
2271 and expect_success != stats['version']):
2272 raise AssertionError("version mismatch: expected %r, got %r"
2273 % (expect_success, stats['version']))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002274
2275
Bill Janssen6e027db2007-11-15 22:23:56 +00002276 class ThreadedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002277
Antoine Pitrou23df4832010-08-04 17:14:06 +00002278 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002279 def test_echo(self):
2280 """Basic test of an SSL client connecting to a server"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002281 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002282 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00002283 for protocol in PROTOCOLS:
Christian Heimes5fe668c2016-09-12 00:01:11 +02002284 if protocol in {ssl.PROTOCOL_TLS_CLIENT, ssl.PROTOCOL_TLS_SERVER}:
2285 continue
Antoine Pitrou972d5bb2013-03-29 17:56:03 +01002286 with self.subTest(protocol=ssl._PROTOCOL_NAMES[protocol]):
2287 context = ssl.SSLContext(protocol)
2288 context.load_cert_chain(CERTFILE)
2289 server_params_test(context, context,
2290 chatty=True, connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002291
Christian Heimes5fe668c2016-09-12 00:01:11 +02002292 client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
2293 client_context.load_verify_locations(SIGNING_CA)
2294 server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
2295 # server_context.load_verify_locations(SIGNING_CA)
2296 server_context.load_cert_chain(SIGNED_CERTFILE2)
2297
Christian Heimes9017ec12016-09-12 10:48:20 +02002298 with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_SERVER):
Christian Heimes5fe668c2016-09-12 00:01:11 +02002299 server_params_test(client_context=client_context,
2300 server_context=server_context,
2301 chatty=True, connectionchatty=True,
2302 sni_name='fakehostname')
2303
Christian Heimes9017ec12016-09-12 10:48:20 +02002304 client_context.check_hostname = False
2305 with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_CLIENT):
2306 with self.assertRaises(ssl.SSLError) as e:
Christian Heimes5fe668c2016-09-12 00:01:11 +02002307 server_params_test(client_context=server_context,
2308 server_context=client_context,
2309 chatty=True, connectionchatty=True,
2310 sni_name='fakehostname')
Christian Heimes9017ec12016-09-12 10:48:20 +02002311 self.assertIn('called a function you should not call',
2312 str(e.exception))
2313
2314 with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_SERVER):
2315 with self.assertRaises(ssl.SSLError) as e:
2316 server_params_test(client_context=server_context,
2317 server_context=server_context,
2318 chatty=True, connectionchatty=True)
2319 self.assertIn('called a function you should not call',
2320 str(e.exception))
2321
2322 with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_CLIENT):
2323 with self.assertRaises(ssl.SSLError) as e:
2324 server_params_test(client_context=server_context,
2325 server_context=client_context,
2326 chatty=True, connectionchatty=True)
2327 self.assertIn('called a function you should not call',
2328 str(e.exception))
2329
Christian Heimes5fe668c2016-09-12 00:01:11 +02002330
Antoine Pitrou480a1242010-04-28 21:37:09 +00002331 def test_getpeercert(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002332 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002333 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00002334 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
2335 context.verify_mode = ssl.CERT_REQUIRED
2336 context.load_verify_locations(CERTFILE)
2337 context.load_cert_chain(CERTFILE)
2338 server = ThreadedEchoServer(context=context, chatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002339 with server:
Antoine Pitrou20b85552013-09-29 19:50:53 +02002340 s = context.wrap_socket(socket.socket(),
2341 do_handshake_on_connect=False)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002342 s.connect((HOST, server.port))
Antoine Pitrou20b85552013-09-29 19:50:53 +02002343 # getpeercert() raise ValueError while the handshake isn't
2344 # done.
2345 with self.assertRaises(ValueError):
2346 s.getpeercert()
2347 s.do_handshake()
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002348 cert = s.getpeercert()
2349 self.assertTrue(cert, "Can't get peer certificate.")
2350 cipher = s.cipher()
2351 if support.verbose:
2352 sys.stdout.write(pprint.pformat(cert) + '\n')
2353 sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
2354 if 'subject' not in cert:
2355 self.fail("No subject field in certificate: %s." %
2356 pprint.pformat(cert))
2357 if ((('organizationName', 'Python Software Foundation'),)
2358 not in cert['subject']):
2359 self.fail(
2360 "Missing or invalid 'organizationName' field in certificate subject; "
2361 "should be 'Python Software Foundation'.")
Antoine Pitroufb046912010-11-09 20:21:19 +00002362 self.assertIn('notBefore', cert)
2363 self.assertIn('notAfter', cert)
2364 before = ssl.cert_time_to_seconds(cert['notBefore'])
2365 after = ssl.cert_time_to_seconds(cert['notAfter'])
2366 self.assertLess(before, after)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002367 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002368
Christian Heimes2427b502013-11-23 11:24:32 +01002369 @unittest.skipUnless(have_verify_flags(),
2370 "verify_flags need OpenSSL > 0.9.8")
Christian Heimes22587792013-11-21 23:56:13 +01002371 def test_crl_check(self):
2372 if support.verbose:
2373 sys.stdout.write("\n")
2374
2375 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2376 server_context.load_cert_chain(SIGNED_CERTFILE)
2377
2378 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2379 context.verify_mode = ssl.CERT_REQUIRED
2380 context.load_verify_locations(SIGNING_CA)
Benjamin Petersonc3d9c5c2015-03-04 23:18:48 -05002381 tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
2382 self.assertEqual(context.verify_flags, ssl.VERIFY_DEFAULT | tf)
Christian Heimes22587792013-11-21 23:56:13 +01002383
2384 # VERIFY_DEFAULT should pass
2385 server = ThreadedEchoServer(context=server_context, chatty=True)
2386 with server:
2387 with context.wrap_socket(socket.socket()) as s:
2388 s.connect((HOST, server.port))
2389 cert = s.getpeercert()
2390 self.assertTrue(cert, "Can't get peer certificate.")
2391
2392 # VERIFY_CRL_CHECK_LEAF without a loaded CRL file fails
Christian Heimes32f0c7a2013-11-22 03:43:48 +01002393 context.verify_flags |= ssl.VERIFY_CRL_CHECK_LEAF
Christian Heimes22587792013-11-21 23:56:13 +01002394
2395 server = ThreadedEchoServer(context=server_context, chatty=True)
2396 with server:
2397 with context.wrap_socket(socket.socket()) as s:
2398 with self.assertRaisesRegex(ssl.SSLError,
2399 "certificate verify failed"):
2400 s.connect((HOST, server.port))
2401
2402 # now load a CRL file. The CRL file is signed by the CA.
2403 context.load_verify_locations(CRLFILE)
2404
2405 server = ThreadedEchoServer(context=server_context, chatty=True)
2406 with server:
2407 with context.wrap_socket(socket.socket()) as s:
2408 s.connect((HOST, server.port))
2409 cert = s.getpeercert()
2410 self.assertTrue(cert, "Can't get peer certificate.")
2411
Christian Heimes1aa9a752013-12-02 02:41:19 +01002412 def test_check_hostname(self):
2413 if support.verbose:
2414 sys.stdout.write("\n")
2415
2416 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2417 server_context.load_cert_chain(SIGNED_CERTFILE)
2418
2419 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2420 context.verify_mode = ssl.CERT_REQUIRED
2421 context.check_hostname = True
2422 context.load_verify_locations(SIGNING_CA)
2423
2424 # correct hostname should verify
2425 server = ThreadedEchoServer(context=server_context, chatty=True)
2426 with server:
2427 with context.wrap_socket(socket.socket(),
2428 server_hostname="localhost") as s:
2429 s.connect((HOST, server.port))
2430 cert = s.getpeercert()
2431 self.assertTrue(cert, "Can't get peer certificate.")
2432
2433 # incorrect hostname should raise an exception
2434 server = ThreadedEchoServer(context=server_context, chatty=True)
2435 with server:
2436 with context.wrap_socket(socket.socket(),
2437 server_hostname="invalid") as s:
2438 with self.assertRaisesRegex(ssl.CertificateError,
2439 "hostname 'invalid' doesn't match 'localhost'"):
2440 s.connect((HOST, server.port))
2441
2442 # missing server_hostname arg should cause an exception, too
2443 server = ThreadedEchoServer(context=server_context, chatty=True)
2444 with server:
2445 with socket.socket() as s:
2446 with self.assertRaisesRegex(ValueError,
2447 "check_hostname requires server_hostname"):
2448 context.wrap_socket(s)
2449
Martin Panter407b62f2016-01-30 03:41:43 +00002450 def test_wrong_cert(self):
Martin Panter3464ea22016-02-01 21:58:11 +00002451 """Connecting when the server rejects the client's certificate
2452
2453 Launch a server with CERT_REQUIRED, and check that trying to
2454 connect to it with a wrong client certificate fails.
2455 """
2456 certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
2457 "wrongcert.pem")
2458 server = ThreadedEchoServer(CERTFILE,
2459 certreqs=ssl.CERT_REQUIRED,
2460 cacerts=CERTFILE, chatty=False,
2461 connectionchatty=False)
2462 with server, \
2463 socket.socket() as sock, \
Christian Heimesd0486372016-09-10 23:23:33 +02002464 test_wrap_socket(sock,
Martin Panter3464ea22016-02-01 21:58:11 +00002465 certfile=certfile,
2466 ssl_version=ssl.PROTOCOL_TLSv1) as s:
2467 try:
2468 # Expect either an SSL error about the server rejecting
2469 # the connection, or a low-level connection reset (which
2470 # sometimes happens on Windows)
2471 s.connect((HOST, server.port))
2472 except ssl.SSLError as e:
2473 if support.verbose:
2474 sys.stdout.write("\nSSLError is %r\n" % e)
2475 except OSError as e:
2476 if e.errno != errno.ECONNRESET:
2477 raise
2478 if support.verbose:
2479 sys.stdout.write("\nsocket.error is %r\n" % e)
2480 else:
2481 self.fail("Use of invalid cert should have failed!")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002482
Antoine Pitrou480a1242010-04-28 21:37:09 +00002483 def test_rude_shutdown(self):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02002484 """A brutal shutdown of an SSL server should raise an OSError
Antoine Pitrou480a1242010-04-28 21:37:09 +00002485 in the client when attempting handshake.
2486 """
Trent Nelson6b240cd2008-04-10 20:12:06 +00002487 listener_ready = threading.Event()
2488 listener_gone = threading.Event()
Antoine Pitrou480a1242010-04-28 21:37:09 +00002489
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002490 s = socket.socket()
2491 port = support.bind_port(s, HOST)
Trent Nelson6b240cd2008-04-10 20:12:06 +00002492
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002493 # `listener` runs in a thread. It sits in an accept() until
2494 # the main thread connects. Then it rudely closes the socket,
2495 # and sets Event `listener_gone` to let the main thread know
2496 # the socket is gone.
Trent Nelson6b240cd2008-04-10 20:12:06 +00002497 def listener():
Charles-François Natali6e204602014-07-23 19:28:13 +01002498 s.listen()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002499 listener_ready.set()
Antoine Pitroud2eca372010-10-29 23:41:37 +00002500 newsock, addr = s.accept()
2501 newsock.close()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002502 s.close()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002503 listener_gone.set()
2504
2505 def connector():
2506 listener_ready.wait()
Antoine Pitroud2eca372010-10-29 23:41:37 +00002507 with socket.socket() as c:
2508 c.connect((HOST, port))
2509 listener_gone.wait()
2510 try:
Christian Heimesd0486372016-09-10 23:23:33 +02002511 ssl_sock = test_wrap_socket(c)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02002512 except OSError:
Antoine Pitroud2eca372010-10-29 23:41:37 +00002513 pass
2514 else:
2515 self.fail('connecting to closed SSL socket should have failed')
Trent Nelson6b240cd2008-04-10 20:12:06 +00002516
2517 t = threading.Thread(target=listener)
2518 t.start()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002519 try:
2520 connector()
2521 finally:
2522 t.join()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002523
Antoine Pitrou23df4832010-08-04 17:14:06 +00002524 @skip_if_broken_ubuntu_ssl
Victor Stinner3de49192011-05-09 00:42:58 +02002525 @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv2'),
2526 "OpenSSL is compiled without SSLv2 support")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002527 def test_protocol_sslv2(self):
2528 """Connecting to an SSLv2 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002529 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002530 sys.stdout.write("\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002531 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
2532 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
2533 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002534 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False)
Victor Stinner648b8622014-12-12 12:23:59 +01002535 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2536 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002537 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00002538 # SSLv23 client with specific SSL options
2539 if no_sslv2_implies_sslv3_hello():
2540 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
2541 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
2542 client_options=ssl.OP_NO_SSLv2)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002543 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002544 client_options=ssl.OP_NO_SSLv3)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002545 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002546 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002547
Antoine Pitrou23df4832010-08-04 17:14:06 +00002548 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002549 def test_protocol_sslv23(self):
2550 """Connecting to an SSLv23 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002551 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002552 sys.stdout.write("\n")
Victor Stinner3de49192011-05-09 00:42:58 +02002553 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2554 try:
2555 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv2, True)
Andrew Svetlov0832af62012-12-18 23:10:48 +02002556 except OSError as x:
Victor Stinner3de49192011-05-09 00:42:58 +02002557 # this fails on some older versions of OpenSSL (0.9.7l, for instance)
2558 if support.verbose:
2559 sys.stdout.write(
2560 " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
2561 % str(x))
Benjamin Petersone32467c2014-12-05 21:59:35 -05002562 if hasattr(ssl, 'PROTOCOL_SSLv3'):
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002563 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002564 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002565 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002566
Benjamin Petersone32467c2014-12-05 21:59:35 -05002567 if hasattr(ssl, 'PROTOCOL_SSLv3'):
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002568 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False, ssl.CERT_OPTIONAL)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002569 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_OPTIONAL)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002570 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002571
Benjamin Petersone32467c2014-12-05 21:59:35 -05002572 if hasattr(ssl, 'PROTOCOL_SSLv3'):
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002573 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False, ssl.CERT_REQUIRED)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002574 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_REQUIRED)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002575 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002576
Antoine Pitroub5218772010-05-21 09:56:06 +00002577 # Server with specific SSL options
Benjamin Petersone32467c2014-12-05 21:59:35 -05002578 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2579 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002580 server_options=ssl.OP_NO_SSLv3)
2581 # Will choose TLSv1
2582 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True,
2583 server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
2584 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, False,
2585 server_options=ssl.OP_NO_TLSv1)
2586
2587
Antoine Pitrou23df4832010-08-04 17:14:06 +00002588 @skip_if_broken_ubuntu_ssl
Benjamin Petersone32467c2014-12-05 21:59:35 -05002589 @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv3'),
2590 "OpenSSL is compiled without SSLv3 support")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002591 def test_protocol_sslv3(self):
2592 """Connecting to an SSLv3 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002593 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002594 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002595 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3')
2596 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_OPTIONAL)
2597 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02002598 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2599 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04002600 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, False,
2601 client_options=ssl.OP_NO_SSLv3)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002602 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00002603 if no_sslv2_implies_sslv3_hello():
2604 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002605 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23,
2606 False, client_options=ssl.OP_NO_SSLv2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002607
Antoine Pitrou23df4832010-08-04 17:14:06 +00002608 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002609 def test_protocol_tlsv1(self):
2610 """Connecting to a TLSv1 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002611 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002612 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002613 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1')
2614 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
2615 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02002616 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2617 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002618 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2619 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04002620 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv23, False,
2621 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002622
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002623 @skip_if_broken_ubuntu_ssl
2624 @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_1"),
2625 "TLS version 1.1 not supported.")
2626 def test_protocol_tlsv1_1(self):
2627 """Connecting to a TLSv1.1 server with various client options.
2628 Testing against older TLS versions."""
2629 if support.verbose:
2630 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002631 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002632 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2633 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002634 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2635 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002636 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv23, False,
2637 client_options=ssl.OP_NO_TLSv1_1)
2638
Antoine Pitrou47e40422014-09-04 21:00:10 +02002639 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002640 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1, False)
2641 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_1, False)
2642
2643
2644 @skip_if_broken_ubuntu_ssl
2645 @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_2"),
2646 "TLS version 1.2 not supported.")
2647 def test_protocol_tlsv1_2(self):
2648 """Connecting to a TLSv1.2 server with various client options.
2649 Testing against older TLS versions."""
2650 if support.verbose:
2651 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002652 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2',
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002653 server_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,
2654 client_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,)
2655 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2656 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002657 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2658 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002659 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv23, False,
2660 client_options=ssl.OP_NO_TLSv1_2)
2661
Antoine Pitrou47e40422014-09-04 21:00:10 +02002662 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002663 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1, False)
2664 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_2, False)
2665 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_1, False)
2666 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_2, False)
2667
Antoine Pitrou480a1242010-04-28 21:37:09 +00002668 def test_starttls(self):
2669 """Switching from clear text to encrypted and back again."""
2670 msgs = (b"msg 1", b"MSG 2", b"STARTTLS", b"MSG 3", b"msg 4", b"ENDTLS", b"msg 5", b"msg 6")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002671
Trent Nelson78520002008-04-10 20:54:35 +00002672 server = ThreadedEchoServer(CERTFILE,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002673 ssl_version=ssl.PROTOCOL_TLSv1,
2674 starttls_server=True,
2675 chatty=True,
2676 connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002677 wrapped = False
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002678 with server:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002679 s = socket.socket()
2680 s.setblocking(1)
2681 s.connect((HOST, server.port))
2682 if support.verbose:
2683 sys.stdout.write("\n")
2684 for indata in msgs:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002685 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002686 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002687 " client: sending %r...\n" % indata)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002688 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002689 conn.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002690 outdata = conn.read()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002691 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002692 s.send(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002693 outdata = s.recv(1024)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002694 msg = outdata.strip().lower()
2695 if indata == b"STARTTLS" and msg.startswith(b"ok"):
2696 # STARTTLS ok, switch to secure mode
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002697 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002698 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002699 " client: read %r from server, starting TLS...\n"
2700 % msg)
Christian Heimesd0486372016-09-10 23:23:33 +02002701 conn = test_wrap_socket(s, ssl_version=ssl.PROTOCOL_TLSv1)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002702 wrapped = True
Antoine Pitrou480a1242010-04-28 21:37:09 +00002703 elif indata == b"ENDTLS" and msg.startswith(b"ok"):
2704 # ENDTLS ok, switch back to clear text
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002705 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002706 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002707 " client: read %r from server, ending TLS...\n"
2708 % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002709 s = conn.unwrap()
2710 wrapped = False
2711 else:
2712 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002713 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002714 " client: read %r from server\n" % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002715 if support.verbose:
2716 sys.stdout.write(" client: closing connection.\n")
2717 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002718 conn.write(b"over\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002719 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002720 s.send(b"over\n")
Bill Janssen6e027db2007-11-15 22:23:56 +00002721 if wrapped:
2722 conn.close()
2723 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002724 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002725
Antoine Pitrou480a1242010-04-28 21:37:09 +00002726 def test_socketserver(self):
Martin Panter463ef2b2016-09-22 09:37:56 +00002727 """Using socketserver to create and manage SSL connections."""
Antoine Pitrouda232592013-02-05 21:20:51 +01002728 server = make_https_server(self, certfile=CERTFILE)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 # try to connect
Antoine Pitrou803e6d62010-10-13 10:36:15 +00002730 if support.verbose:
2731 sys.stdout.write('\n')
2732 with open(CERTFILE, 'rb') as f:
2733 d1 = f.read()
2734 d2 = ''
2735 # now fetch the same data from the HTTPS server
Benjamin Peterson4ffb0752014-11-03 14:29:33 -05002736 url = 'https://localhost:%d/%s' % (
2737 server.port, os.path.split(CERTFILE)[1])
2738 context = ssl.create_default_context(cafile=CERTFILE)
2739 f = urllib.request.urlopen(url, context=context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002740 try:
Barry Warsaw820c1202008-06-12 04:06:45 +00002741 dlen = f.info().get("content-length")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002742 if dlen and (int(dlen) > 0):
2743 d2 = f.read(int(dlen))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002744 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002745 sys.stdout.write(
2746 " client: read %d bytes from remote server '%s'\n"
2747 % (len(d2), server))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002748 finally:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00002749 f.close()
2750 self.assertEqual(d1, d2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002751
Antoine Pitrou480a1242010-04-28 21:37:09 +00002752 def test_asyncore_server(self):
2753 """Check the example asyncore integration."""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002754 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002755 sys.stdout.write("\n")
2756
Antoine Pitrou480a1242010-04-28 21:37:09 +00002757 indata = b"FOO\n"
Trent Nelson78520002008-04-10 20:54:35 +00002758 server = AsyncoreEchoServer(CERTFILE)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002759 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002760 s = test_wrap_socket(socket.socket())
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002761 s.connect(('127.0.0.1', server.port))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002762 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002763 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002764 " client: sending %r...\n" % indata)
2765 s.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002766 outdata = s.read()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002767 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002768 sys.stdout.write(" client: read %r\n" % outdata)
Trent Nelson6b240cd2008-04-10 20:12:06 +00002769 if outdata != indata.lower():
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002770 self.fail(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002771 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
2772 % (outdata[:20], len(outdata),
2773 indata[:20].lower(), len(indata)))
2774 s.write(b"over\n")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002775 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002776 sys.stdout.write(" client: closing connection.\n")
2777 s.close()
Antoine Pitroued986362010-08-15 23:28:10 +00002778 if support.verbose:
2779 sys.stdout.write(" client: connection closed.\n")
Trent Nelson6b240cd2008-04-10 20:12:06 +00002780
Antoine Pitrou480a1242010-04-28 21:37:09 +00002781 def test_recv_send(self):
2782 """Test recv(), send() and friends."""
Bill Janssen58afe4c2008-09-08 16:45:19 +00002783 if support.verbose:
2784 sys.stdout.write("\n")
2785
2786 server = ThreadedEchoServer(CERTFILE,
2787 certreqs=ssl.CERT_NONE,
2788 ssl_version=ssl.PROTOCOL_TLSv1,
2789 cacerts=CERTFILE,
2790 chatty=True,
2791 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002792 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002793 s = test_wrap_socket(socket.socket(),
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002794 server_side=False,
2795 certfile=CERTFILE,
2796 ca_certs=CERTFILE,
2797 cert_reqs=ssl.CERT_NONE,
2798 ssl_version=ssl.PROTOCOL_TLSv1)
2799 s.connect((HOST, server.port))
Bill Janssen58afe4c2008-09-08 16:45:19 +00002800 # helper methods for standardising recv* method signatures
2801 def _recv_into():
2802 b = bytearray(b"\0"*100)
2803 count = s.recv_into(b)
2804 return b[:count]
2805
2806 def _recvfrom_into():
2807 b = bytearray(b"\0"*100)
2808 count, addr = s.recvfrom_into(b)
2809 return b[:count]
2810
Martin Panter519f9122016-04-03 02:12:54 +00002811 # (name, method, expect success?, *args, return value func)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002812 send_methods = [
Martin Panter519f9122016-04-03 02:12:54 +00002813 ('send', s.send, True, [], len),
2814 ('sendto', s.sendto, False, ["some.address"], len),
2815 ('sendall', s.sendall, True, [], lambda x: None),
Bill Janssen58afe4c2008-09-08 16:45:19 +00002816 ]
Martin Panter519f9122016-04-03 02:12:54 +00002817 # (name, method, whether to expect success, *args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002818 recv_methods = [
2819 ('recv', s.recv, True, []),
2820 ('recvfrom', s.recvfrom, False, ["some.address"]),
2821 ('recv_into', _recv_into, True, []),
2822 ('recvfrom_into', _recvfrom_into, False, []),
2823 ]
2824 data_prefix = "PREFIX_"
2825
Martin Panter519f9122016-04-03 02:12:54 +00002826 for (meth_name, send_meth, expect_success, args,
2827 ret_val_meth) in send_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002828 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00002829 try:
Martin Panter519f9122016-04-03 02:12:54 +00002830 ret = send_meth(indata, *args)
2831 msg = "sending with {}".format(meth_name)
2832 self.assertEqual(ret, ret_val_meth(indata), msg=msg)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002833 outdata = s.read()
Bill Janssen58afe4c2008-09-08 16:45:19 +00002834 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00002835 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002836 "While sending with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00002837 "<<{outdata:r}>> ({nout:d}) received; "
2838 "expected <<{indata:r}>> ({nin:d})\n".format(
2839 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00002840 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00002841 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002842 )
2843 )
2844 except ValueError as e:
2845 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00002846 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002847 "Failed to send with method <<{name:s}>>; "
2848 "expected to succeed.\n".format(name=meth_name)
2849 )
2850 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00002851 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002852 "Method <<{name:s}>> failed with unexpected "
2853 "exception message: {exp:s}\n".format(
2854 name=meth_name, exp=e
2855 )
2856 )
2857
2858 for meth_name, recv_meth, expect_success, args in recv_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002859 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00002860 try:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002861 s.send(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002862 outdata = recv_meth(*args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002863 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00002864 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002865 "While receiving with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00002866 "<<{outdata:r}>> ({nout:d}) received; "
2867 "expected <<{indata:r}>> ({nin:d})\n".format(
2868 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00002869 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00002870 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002871 )
2872 )
2873 except ValueError as e:
2874 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00002875 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002876 "Failed to receive with method <<{name:s}>>; "
2877 "expected to succeed.\n".format(name=meth_name)
2878 )
2879 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00002880 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002881 "Method <<{name:s}>> failed with unexpected "
2882 "exception message: {exp:s}\n".format(
2883 name=meth_name, exp=e
2884 )
2885 )
2886 # consume data
2887 s.read()
2888
Martin Panterf6b1d662016-03-28 00:22:09 +00002889 # read(-1, buffer) is supported, even though read(-1) is not
Martin Panterbed7f1a2016-07-11 00:17:13 +00002890 data = b"data"
Martin Panter5503d472016-03-27 05:35:19 +00002891 s.send(data)
2892 buffer = bytearray(len(data))
2893 self.assertEqual(s.read(-1, buffer), len(data))
2894 self.assertEqual(buffer, data)
2895
Nick Coghlan513886a2011-08-28 00:00:27 +10002896 # Make sure sendmsg et al are disallowed to avoid
2897 # inadvertent disclosure of data and/or corruption
2898 # of the encrypted data stream
2899 self.assertRaises(NotImplementedError, s.sendmsg, [b"data"])
2900 self.assertRaises(NotImplementedError, s.recvmsg, 100)
2901 self.assertRaises(NotImplementedError,
2902 s.recvmsg_into, bytearray(100))
2903
Antoine Pitrou480a1242010-04-28 21:37:09 +00002904 s.write(b"over\n")
Martin Panter5503d472016-03-27 05:35:19 +00002905
2906 self.assertRaises(ValueError, s.recv, -1)
2907 self.assertRaises(ValueError, s.read, -1)
2908
Bill Janssen58afe4c2008-09-08 16:45:19 +00002909 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00002910
Martin Panterbed7f1a2016-07-11 00:17:13 +00002911 def test_recv_zero(self):
2912 server = ThreadedEchoServer(CERTFILE)
2913 server.__enter__()
2914 self.addCleanup(server.__exit__, None, None)
2915 s = socket.create_connection((HOST, server.port))
2916 self.addCleanup(s.close)
Christian Heimesd0486372016-09-10 23:23:33 +02002917 s = test_wrap_socket(s, suppress_ragged_eofs=False)
Martin Panterbed7f1a2016-07-11 00:17:13 +00002918 self.addCleanup(s.close)
2919
2920 # recv/read(0) should return no data
2921 s.send(b"data")
2922 self.assertEqual(s.recv(0), b"")
2923 self.assertEqual(s.read(0), b"")
2924 self.assertEqual(s.read(), b"data")
2925
2926 # Should not block if the other end sends no data
2927 s.setblocking(False)
2928 self.assertEqual(s.recv(0), b"")
2929 self.assertEqual(s.recv_into(bytearray()), 0)
2930
Antoine Pitroub4bebda2014-04-29 10:03:28 +02002931 def test_nonblocking_send(self):
2932 server = ThreadedEchoServer(CERTFILE,
2933 certreqs=ssl.CERT_NONE,
2934 ssl_version=ssl.PROTOCOL_TLSv1,
2935 cacerts=CERTFILE,
2936 chatty=True,
2937 connectionchatty=False)
2938 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002939 s = test_wrap_socket(socket.socket(),
Antoine Pitroub4bebda2014-04-29 10:03:28 +02002940 server_side=False,
2941 certfile=CERTFILE,
2942 ca_certs=CERTFILE,
2943 cert_reqs=ssl.CERT_NONE,
2944 ssl_version=ssl.PROTOCOL_TLSv1)
2945 s.connect((HOST, server.port))
2946 s.setblocking(False)
2947
2948 # If we keep sending data, at some point the buffers
2949 # will be full and the call will block
2950 buf = bytearray(8192)
2951 def fill_buffer():
2952 while True:
2953 s.send(buf)
2954 self.assertRaises((ssl.SSLWantWriteError,
2955 ssl.SSLWantReadError), fill_buffer)
2956
2957 # Now read all the output and discard it
2958 s.setblocking(True)
2959 s.close()
2960
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002961 def test_handshake_timeout(self):
2962 # Issue #5103: SSL handshake must respect the socket timeout
2963 server = socket.socket(socket.AF_INET)
2964 host = "127.0.0.1"
2965 port = support.bind_port(server)
2966 started = threading.Event()
2967 finish = False
2968
2969 def serve():
Charles-François Natali6e204602014-07-23 19:28:13 +01002970 server.listen()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002971 started.set()
2972 conns = []
2973 while not finish:
2974 r, w, e = select.select([server], [], [], 0.1)
2975 if server in r:
2976 # Let the socket hang around rather than having
2977 # it closed by garbage collection.
2978 conns.append(server.accept()[0])
Antoine Pitroud2eca372010-10-29 23:41:37 +00002979 for sock in conns:
2980 sock.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002981
2982 t = threading.Thread(target=serve)
2983 t.start()
2984 started.wait()
2985
2986 try:
Antoine Pitrou40f08742010-04-24 22:04:40 +00002987 try:
2988 c = socket.socket(socket.AF_INET)
2989 c.settimeout(0.2)
2990 c.connect((host, port))
2991 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002992 self.assertRaisesRegex(socket.timeout, "timed out",
Christian Heimesd0486372016-09-10 23:23:33 +02002993 test_wrap_socket, c)
Antoine Pitrou40f08742010-04-24 22:04:40 +00002994 finally:
2995 c.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002996 try:
2997 c = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +02002998 c = test_wrap_socket(c)
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002999 c.settimeout(0.2)
3000 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00003001 self.assertRaisesRegex(socket.timeout, "timed out",
Ezio Melottied3a7d22010-12-01 02:32:32 +00003002 c.connect, (host, port))
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00003003 finally:
3004 c.close()
3005 finally:
3006 finish = True
3007 t.join()
3008 server.close()
3009
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003010 def test_server_accept(self):
3011 # Issue #16357: accept() on a SSLSocket created through
3012 # SSLContext.wrap_socket().
3013 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3014 context.verify_mode = ssl.CERT_REQUIRED
3015 context.load_verify_locations(CERTFILE)
3016 context.load_cert_chain(CERTFILE)
3017 server = socket.socket(socket.AF_INET)
3018 host = "127.0.0.1"
3019 port = support.bind_port(server)
3020 server = context.wrap_socket(server, server_side=True)
Christian Heimesa5d07652016-09-24 10:48:05 +02003021 self.assertTrue(server.server_side)
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003022
3023 evt = threading.Event()
3024 remote = None
3025 peer = None
3026 def serve():
3027 nonlocal remote, peer
Charles-François Natali6e204602014-07-23 19:28:13 +01003028 server.listen()
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003029 # Block on the accept and wait on the connection to close.
3030 evt.set()
3031 remote, peer = server.accept()
3032 remote.recv(1)
3033
3034 t = threading.Thread(target=serve)
3035 t.start()
3036 # Client wait until server setup and perform a connect.
3037 evt.wait()
3038 client = context.wrap_socket(socket.socket())
3039 client.connect((host, port))
3040 client_addr = client.getsockname()
3041 client.close()
3042 t.join()
Antoine Pitroue1ceb502013-01-12 21:54:44 +01003043 remote.close()
3044 server.close()
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003045 # Sanity checks.
3046 self.assertIsInstance(remote, ssl.SSLSocket)
3047 self.assertEqual(peer, client_addr)
3048
Antoine Pitrou242db722013-05-01 20:52:07 +02003049 def test_getpeercert_enotconn(self):
3050 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3051 with context.wrap_socket(socket.socket()) as sock:
3052 with self.assertRaises(OSError) as cm:
3053 sock.getpeercert()
3054 self.assertEqual(cm.exception.errno, errno.ENOTCONN)
3055
3056 def test_do_handshake_enotconn(self):
3057 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3058 with context.wrap_socket(socket.socket()) as sock:
3059 with self.assertRaises(OSError) as cm:
3060 sock.do_handshake()
3061 self.assertEqual(cm.exception.errno, errno.ENOTCONN)
3062
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003063 def test_default_ciphers(self):
3064 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3065 try:
3066 # Force a set of weak ciphers on our client context
3067 context.set_ciphers("DES")
3068 except ssl.SSLError:
3069 self.skipTest("no DES cipher available")
3070 with ThreadedEchoServer(CERTFILE,
3071 ssl_version=ssl.PROTOCOL_SSLv23,
3072 chatty=False) as server:
Antoine Pitroue1ceb502013-01-12 21:54:44 +01003073 with context.wrap_socket(socket.socket()) as s:
Andrew Svetlov0832af62012-12-18 23:10:48 +02003074 with self.assertRaises(OSError):
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003075 s.connect((HOST, server.port))
Victor Stinner86871012017-09-02 00:26:17 +02003076 self.assertIn("no shared cipher", server.conn_errors[0])
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003077
Antoine Pitrou47e40422014-09-04 21:00:10 +02003078 def test_version_basic(self):
3079 """
3080 Basic tests for SSLSocket.version().
3081 More tests are done in the test_protocol_*() methods.
3082 """
3083 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3084 with ThreadedEchoServer(CERTFILE,
3085 ssl_version=ssl.PROTOCOL_TLSv1,
3086 chatty=False) as server:
3087 with context.wrap_socket(socket.socket()) as s:
3088 self.assertIs(s.version(), None)
3089 s.connect((HOST, server.port))
Christian Heimes598894f2016-09-05 23:19:05 +02003090 self.assertEqual(s.version(), 'TLSv1')
Antoine Pitrou47e40422014-09-04 21:00:10 +02003091 self.assertIs(s.version(), None)
3092
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003093 @unittest.skipUnless(ssl.HAS_ECDH, "test requires ECDH-enabled OpenSSL")
3094 def test_default_ecdh_curve(self):
3095 # Issue #21015: elliptic curve-based Diffie Hellman key exchange
3096 # should be enabled by default on SSL contexts.
3097 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3098 context.load_cert_chain(CERTFILE)
Antoine Pitrouc0430612014-04-16 18:33:39 +02003099 # Prior to OpenSSL 1.0.0, ECDH ciphers have to be enabled
3100 # explicitly using the 'ECCdraft' cipher alias. Otherwise,
3101 # our default cipher list should prefer ECDH-based ciphers
3102 # automatically.
3103 if ssl.OPENSSL_VERSION_INFO < (1, 0, 0):
3104 context.set_ciphers("ECCdraft:ECDH")
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003105 with ThreadedEchoServer(context=context) as server:
3106 with context.wrap_socket(socket.socket()) as s:
3107 s.connect((HOST, server.port))
3108 self.assertIn("ECDH", s.cipher()[0])
3109
Antoine Pitroud6494802011-07-21 01:11:30 +02003110 @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
3111 "'tls-unique' channel binding not available")
3112 def test_tls_unique_channel_binding(self):
3113 """Test tls-unique channel binding."""
3114 if support.verbose:
3115 sys.stdout.write("\n")
3116
3117 server = ThreadedEchoServer(CERTFILE,
3118 certreqs=ssl.CERT_NONE,
3119 ssl_version=ssl.PROTOCOL_TLSv1,
3120 cacerts=CERTFILE,
3121 chatty=True,
3122 connectionchatty=False)
Antoine Pitrou6b15c902011-12-21 16:54:45 +01003123 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02003124 s = test_wrap_socket(socket.socket(),
Antoine Pitrou6b15c902011-12-21 16:54:45 +01003125 server_side=False,
3126 certfile=CERTFILE,
3127 ca_certs=CERTFILE,
3128 cert_reqs=ssl.CERT_NONE,
3129 ssl_version=ssl.PROTOCOL_TLSv1)
3130 s.connect((HOST, server.port))
Antoine Pitroud6494802011-07-21 01:11:30 +02003131 # get the data
3132 cb_data = s.get_channel_binding("tls-unique")
3133 if support.verbose:
3134 sys.stdout.write(" got channel binding data: {0!r}\n"
3135 .format(cb_data))
3136
3137 # check if it is sane
3138 self.assertIsNotNone(cb_data)
3139 self.assertEqual(len(cb_data), 12) # True for TLSv1
3140
3141 # and compare with the peers version
3142 s.write(b"CB tls-unique\n")
3143 peer_data_repr = s.read().strip()
3144 self.assertEqual(peer_data_repr,
3145 repr(cb_data).encode("us-ascii"))
3146 s.close()
3147
3148 # now, again
Christian Heimesd0486372016-09-10 23:23:33 +02003149 s = test_wrap_socket(socket.socket(),
Antoine Pitroud6494802011-07-21 01:11:30 +02003150 server_side=False,
3151 certfile=CERTFILE,
3152 ca_certs=CERTFILE,
3153 cert_reqs=ssl.CERT_NONE,
3154 ssl_version=ssl.PROTOCOL_TLSv1)
3155 s.connect((HOST, server.port))
3156 new_cb_data = s.get_channel_binding("tls-unique")
3157 if support.verbose:
3158 sys.stdout.write(" got another channel binding data: {0!r}\n"
3159 .format(new_cb_data))
3160 # is it really unique
3161 self.assertNotEqual(cb_data, new_cb_data)
3162 self.assertIsNotNone(cb_data)
3163 self.assertEqual(len(cb_data), 12) # True for TLSv1
3164 s.write(b"CB tls-unique\n")
3165 peer_data_repr = s.read().strip()
3166 self.assertEqual(peer_data_repr,
3167 repr(new_cb_data).encode("us-ascii"))
3168 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00003169
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003170 def test_compression(self):
3171 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3172 context.load_cert_chain(CERTFILE)
3173 stats = server_params_test(context, context,
3174 chatty=True, connectionchatty=True)
3175 if support.verbose:
3176 sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
3177 self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
3178
3179 @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
3180 "ssl.OP_NO_COMPRESSION needed for this test")
3181 def test_compression_disabled(self):
3182 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3183 context.load_cert_chain(CERTFILE)
Antoine Pitrou8691bff2011-12-20 10:47:42 +01003184 context.options |= ssl.OP_NO_COMPRESSION
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003185 stats = server_params_test(context, context,
3186 chatty=True, connectionchatty=True)
3187 self.assertIs(stats['compression'], None)
3188
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003189 def test_dh_params(self):
3190 # Check we can get a connection with ephemeral Diffie-Hellman
3191 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3192 context.load_cert_chain(CERTFILE)
3193 context.load_dh_params(DHFILE)
3194 context.set_ciphers("kEDH")
3195 stats = server_params_test(context, context,
3196 chatty=True, connectionchatty=True)
3197 cipher = stats["cipher"][0]
3198 parts = cipher.split("-")
3199 if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
3200 self.fail("Non-DH cipher: " + cipher[0])
3201
Benjamin Petersoncca27322015-01-23 16:35:37 -05003202 def test_selected_alpn_protocol(self):
3203 # selected_alpn_protocol() is None unless ALPN is used.
3204 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3205 context.load_cert_chain(CERTFILE)
3206 stats = server_params_test(context, context,
3207 chatty=True, connectionchatty=True)
3208 self.assertIs(stats['client_alpn_protocol'], None)
3209
3210 @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support required")
3211 def test_selected_alpn_protocol_if_server_uses_alpn(self):
3212 # selected_alpn_protocol() is None unless ALPN is used by the client.
3213 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3214 client_context.load_verify_locations(CERTFILE)
3215 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3216 server_context.load_cert_chain(CERTFILE)
3217 server_context.set_alpn_protocols(['foo', 'bar'])
3218 stats = server_params_test(client_context, server_context,
3219 chatty=True, connectionchatty=True)
3220 self.assertIs(stats['client_alpn_protocol'], None)
3221
3222 @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support needed for this test")
3223 def test_alpn_protocols(self):
3224 server_protocols = ['foo', 'bar', 'milkshake']
3225 protocol_tests = [
3226 (['foo', 'bar'], 'foo'),
Benjamin Peterson88615022015-01-23 17:30:26 -05003227 (['bar', 'foo'], 'foo'),
Benjamin Petersoncca27322015-01-23 16:35:37 -05003228 (['milkshake'], 'milkshake'),
Benjamin Peterson88615022015-01-23 17:30:26 -05003229 (['http/3.0', 'http/4.0'], None)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003230 ]
3231 for client_protocols, expected in protocol_tests:
Christian Heimes598894f2016-09-05 23:19:05 +02003232 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003233 server_context.load_cert_chain(CERTFILE)
3234 server_context.set_alpn_protocols(server_protocols)
Christian Heimes598894f2016-09-05 23:19:05 +02003235 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003236 client_context.load_cert_chain(CERTFILE)
3237 client_context.set_alpn_protocols(client_protocols)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003238
Christian Heimes598894f2016-09-05 23:19:05 +02003239 try:
3240 stats = server_params_test(client_context,
3241 server_context,
3242 chatty=True,
3243 connectionchatty=True)
3244 except ssl.SSLError as e:
3245 stats = e
3246
Christian Heimes7b40cb72017-08-15 10:33:43 +02003247 if (expected is None and IS_OPENSSL_1_1
3248 and ssl.OPENSSL_VERSION_INFO < (1, 1, 0, 6)):
3249 # OpenSSL 1.1.0 to 1.1.0e raises handshake error
Christian Heimes598894f2016-09-05 23:19:05 +02003250 self.assertIsInstance(stats, ssl.SSLError)
3251 else:
3252 msg = "failed trying %s (s) and %s (c).\n" \
3253 "was expecting %s, but got %%s from the %%s" \
3254 % (str(server_protocols), str(client_protocols),
3255 str(expected))
3256 client_result = stats['client_alpn_protocol']
3257 self.assertEqual(client_result, expected,
3258 msg % (client_result, "client"))
3259 server_result = stats['server_alpn_protocols'][-1] \
3260 if len(stats['server_alpn_protocols']) else 'nothing'
3261 self.assertEqual(server_result, expected,
3262 msg % (server_result, "server"))
Benjamin Petersoncca27322015-01-23 16:35:37 -05003263
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003264 def test_selected_npn_protocol(self):
3265 # selected_npn_protocol() is None unless NPN is used
3266 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3267 context.load_cert_chain(CERTFILE)
3268 stats = server_params_test(context, context,
3269 chatty=True, connectionchatty=True)
3270 self.assertIs(stats['client_npn_protocol'], None)
3271
3272 @unittest.skipUnless(ssl.HAS_NPN, "NPN support needed for this test")
3273 def test_npn_protocols(self):
3274 server_protocols = ['http/1.1', 'spdy/2']
3275 protocol_tests = [
3276 (['http/1.1', 'spdy/2'], 'http/1.1'),
3277 (['spdy/2', 'http/1.1'], 'http/1.1'),
3278 (['spdy/2', 'test'], 'spdy/2'),
3279 (['abc', 'def'], 'abc')
3280 ]
3281 for client_protocols, expected in protocol_tests:
3282 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3283 server_context.load_cert_chain(CERTFILE)
3284 server_context.set_npn_protocols(server_protocols)
3285 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3286 client_context.load_cert_chain(CERTFILE)
3287 client_context.set_npn_protocols(client_protocols)
3288 stats = server_params_test(client_context, server_context,
3289 chatty=True, connectionchatty=True)
3290
3291 msg = "failed trying %s (s) and %s (c).\n" \
3292 "was expecting %s, but got %%s from the %%s" \
3293 % (str(server_protocols), str(client_protocols),
3294 str(expected))
3295 client_result = stats['client_npn_protocol']
3296 self.assertEqual(client_result, expected, msg % (client_result, "client"))
3297 server_result = stats['server_npn_protocols'][-1] \
3298 if len(stats['server_npn_protocols']) else 'nothing'
3299 self.assertEqual(server_result, expected, msg % (server_result, "server"))
3300
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003301 def sni_contexts(self):
3302 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3303 server_context.load_cert_chain(SIGNED_CERTFILE)
3304 other_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3305 other_context.load_cert_chain(SIGNED_CERTFILE2)
3306 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3307 client_context.verify_mode = ssl.CERT_REQUIRED
3308 client_context.load_verify_locations(SIGNING_CA)
3309 return server_context, other_context, client_context
3310
3311 def check_common_name(self, stats, name):
3312 cert = stats['peercert']
3313 self.assertIn((('commonName', name),), cert['subject'])
3314
3315 @needs_sni
3316 def test_sni_callback(self):
3317 calls = []
3318 server_context, other_context, client_context = self.sni_contexts()
3319
3320 def servername_cb(ssl_sock, server_name, initial_context):
3321 calls.append((server_name, initial_context))
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003322 if server_name is not None:
3323 ssl_sock.context = other_context
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003324 server_context.set_servername_callback(servername_cb)
3325
3326 stats = server_params_test(client_context, server_context,
3327 chatty=True,
3328 sni_name='supermessage')
3329 # The hostname was fetched properly, and the certificate was
3330 # changed for the connection.
3331 self.assertEqual(calls, [("supermessage", server_context)])
3332 # CERTFILE4 was selected
3333 self.check_common_name(stats, 'fakehostname')
3334
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003335 calls = []
3336 # The callback is called with server_name=None
3337 stats = server_params_test(client_context, server_context,
3338 chatty=True,
3339 sni_name=None)
3340 self.assertEqual(calls, [(None, server_context)])
3341 self.check_common_name(stats, 'localhost')
3342
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003343 # Check disabling the callback
3344 calls = []
3345 server_context.set_servername_callback(None)
3346
3347 stats = server_params_test(client_context, server_context,
3348 chatty=True,
3349 sni_name='notfunny')
3350 # Certificate didn't change
3351 self.check_common_name(stats, 'localhost')
3352 self.assertEqual(calls, [])
3353
3354 @needs_sni
3355 def test_sni_callback_alert(self):
3356 # Returning a TLS alert is reflected to the connecting client
3357 server_context, other_context, client_context = self.sni_contexts()
3358
3359 def cb_returning_alert(ssl_sock, server_name, initial_context):
3360 return ssl.ALERT_DESCRIPTION_ACCESS_DENIED
3361 server_context.set_servername_callback(cb_returning_alert)
3362
3363 with self.assertRaises(ssl.SSLError) as cm:
3364 stats = server_params_test(client_context, server_context,
3365 chatty=False,
3366 sni_name='supermessage')
3367 self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_ACCESS_DENIED')
3368
3369 @needs_sni
3370 def test_sni_callback_raising(self):
3371 # Raising fails the connection with a TLS handshake failure alert.
3372 server_context, other_context, client_context = self.sni_contexts()
3373
3374 def cb_raising(ssl_sock, server_name, initial_context):
3375 1/0
3376 server_context.set_servername_callback(cb_raising)
3377
3378 with self.assertRaises(ssl.SSLError) as cm, \
3379 support.captured_stderr() as stderr:
3380 stats = server_params_test(client_context, server_context,
3381 chatty=False,
3382 sni_name='supermessage')
3383 self.assertEqual(cm.exception.reason, 'SSLV3_ALERT_HANDSHAKE_FAILURE')
3384 self.assertIn("ZeroDivisionError", stderr.getvalue())
3385
3386 @needs_sni
3387 def test_sni_callback_wrong_return_type(self):
3388 # Returning the wrong return type terminates the TLS connection
3389 # with an internal error alert.
3390 server_context, other_context, client_context = self.sni_contexts()
3391
3392 def cb_wrong_return_type(ssl_sock, server_name, initial_context):
3393 return "foo"
3394 server_context.set_servername_callback(cb_wrong_return_type)
3395
3396 with self.assertRaises(ssl.SSLError) as cm, \
3397 support.captured_stderr() as stderr:
3398 stats = server_params_test(client_context, server_context,
3399 chatty=False,
3400 sni_name='supermessage')
3401 self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_INTERNAL_ERROR')
3402 self.assertIn("TypeError", stderr.getvalue())
3403
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003404 def test_shared_ciphers(self):
Benjamin Petersonaacd5242015-01-07 11:42:38 -06003405 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Benjamin Peterson15042922015-01-07 22:12:43 -06003406 server_context.load_cert_chain(SIGNED_CERTFILE)
3407 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3408 client_context.verify_mode = ssl.CERT_REQUIRED
3409 client_context.load_verify_locations(SIGNING_CA)
Christian Heimes598894f2016-09-05 23:19:05 +02003410 if ssl.OPENSSL_VERSION_INFO >= (1, 0, 2):
3411 client_context.set_ciphers("AES128:AES256")
3412 server_context.set_ciphers("AES256")
3413 alg1 = "AES256"
3414 alg2 = "AES-256"
3415 else:
3416 client_context.set_ciphers("AES:3DES")
3417 server_context.set_ciphers("3DES")
3418 alg1 = "3DES"
3419 alg2 = "DES-CBC3"
3420
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003421 stats = server_params_test(client_context, server_context)
3422 ciphers = stats['server_shared_ciphers'][0]
3423 self.assertGreater(len(ciphers), 0)
3424 for name, tls_version, bits in ciphers:
Christian Heimes598894f2016-09-05 23:19:05 +02003425 if not alg1 in name.split("-") and alg2 not in name:
3426 self.fail(name)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003427
Antoine Pitrou60a26e02013-07-20 19:35:16 +02003428 def test_read_write_after_close_raises_valuerror(self):
3429 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3430 context.verify_mode = ssl.CERT_REQUIRED
3431 context.load_verify_locations(CERTFILE)
3432 context.load_cert_chain(CERTFILE)
3433 server = ThreadedEchoServer(context=context, chatty=False)
3434
3435 with server:
3436 s = context.wrap_socket(socket.socket())
3437 s.connect((HOST, server.port))
3438 s.close()
3439
3440 self.assertRaises(ValueError, s.read, 1024)
Antoine Pitrou28940732013-07-20 19:36:15 +02003441 self.assertRaises(ValueError, s.write, b'hello')
Antoine Pitrou60a26e02013-07-20 19:35:16 +02003442
Giampaolo Rodola'915d1412014-06-11 03:54:30 +02003443 def test_sendfile(self):
3444 TEST_DATA = b"x" * 512
3445 with open(support.TESTFN, 'wb') as f:
3446 f.write(TEST_DATA)
3447 self.addCleanup(support.unlink, support.TESTFN)
3448 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3449 context.verify_mode = ssl.CERT_REQUIRED
3450 context.load_verify_locations(CERTFILE)
3451 context.load_cert_chain(CERTFILE)
3452 server = ThreadedEchoServer(context=context, chatty=False)
3453 with server:
3454 with context.wrap_socket(socket.socket()) as s:
3455 s.connect((HOST, server.port))
3456 with open(support.TESTFN, 'rb') as file:
3457 s.sendfile(file)
3458 self.assertEqual(s.recv(1024), TEST_DATA)
3459
Christian Heimes99a65702016-09-10 23:44:53 +02003460 def test_session(self):
3461 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3462 server_context.load_cert_chain(SIGNED_CERTFILE)
3463 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3464 client_context.verify_mode = ssl.CERT_REQUIRED
3465 client_context.load_verify_locations(SIGNING_CA)
3466
Martin Panterb1321fb2016-10-10 00:38:21 +00003467 # first connection without session
Christian Heimes99a65702016-09-10 23:44:53 +02003468 stats = server_params_test(client_context, server_context)
3469 session = stats['session']
3470 self.assertTrue(session.id)
3471 self.assertGreater(session.time, 0)
3472 self.assertGreater(session.timeout, 0)
3473 self.assertTrue(session.has_ticket)
3474 if ssl.OPENSSL_VERSION_INFO > (1, 0, 1):
3475 self.assertGreater(session.ticket_lifetime_hint, 0)
3476 self.assertFalse(stats['session_reused'])
3477 sess_stat = server_context.session_stats()
3478 self.assertEqual(sess_stat['accept'], 1)
3479 self.assertEqual(sess_stat['hits'], 0)
3480
3481 # reuse session
3482 stats = server_params_test(client_context, server_context, session=session)
3483 sess_stat = server_context.session_stats()
3484 self.assertEqual(sess_stat['accept'], 2)
3485 self.assertEqual(sess_stat['hits'], 1)
3486 self.assertTrue(stats['session_reused'])
3487 session2 = stats['session']
3488 self.assertEqual(session2.id, session.id)
3489 self.assertEqual(session2, session)
3490 self.assertIsNot(session2, session)
3491 self.assertGreaterEqual(session2.time, session.time)
3492 self.assertGreaterEqual(session2.timeout, session.timeout)
3493
3494 # another one without session
3495 stats = server_params_test(client_context, server_context)
3496 self.assertFalse(stats['session_reused'])
3497 session3 = stats['session']
3498 self.assertNotEqual(session3.id, session.id)
3499 self.assertNotEqual(session3, session)
3500 sess_stat = server_context.session_stats()
3501 self.assertEqual(sess_stat['accept'], 3)
3502 self.assertEqual(sess_stat['hits'], 1)
3503
3504 # reuse session again
3505 stats = server_params_test(client_context, server_context, session=session)
3506 self.assertTrue(stats['session_reused'])
3507 session4 = stats['session']
3508 self.assertEqual(session4.id, session.id)
3509 self.assertEqual(session4, session)
3510 self.assertGreaterEqual(session4.time, session.time)
3511 self.assertGreaterEqual(session4.timeout, session.timeout)
3512 sess_stat = server_context.session_stats()
3513 self.assertEqual(sess_stat['accept'], 4)
3514 self.assertEqual(sess_stat['hits'], 2)
3515
3516 def test_session_handling(self):
3517 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3518 context.verify_mode = ssl.CERT_REQUIRED
3519 context.load_verify_locations(CERTFILE)
3520 context.load_cert_chain(CERTFILE)
3521
3522 context2 = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3523 context2.verify_mode = ssl.CERT_REQUIRED
3524 context2.load_verify_locations(CERTFILE)
3525 context2.load_cert_chain(CERTFILE)
3526
3527 server = ThreadedEchoServer(context=context, chatty=False)
3528 with server:
3529 with context.wrap_socket(socket.socket()) as s:
3530 # session is None before handshake
3531 self.assertEqual(s.session, None)
3532 self.assertEqual(s.session_reused, None)
3533 s.connect((HOST, server.port))
3534 session = s.session
3535 self.assertTrue(session)
3536 with self.assertRaises(TypeError) as e:
3537 s.session = object
3538 self.assertEqual(str(e.exception), 'Value is not a SSLSession.')
3539
3540 with context.wrap_socket(socket.socket()) as s:
3541 s.connect((HOST, server.port))
3542 # cannot set session after handshake
3543 with self.assertRaises(ValueError) as e:
3544 s.session = session
3545 self.assertEqual(str(e.exception),
3546 'Cannot set session after handshake.')
3547
3548 with context.wrap_socket(socket.socket()) as s:
3549 # can set session before handshake and before the
3550 # connection was established
3551 s.session = session
3552 s.connect((HOST, server.port))
3553 self.assertEqual(s.session.id, session.id)
3554 self.assertEqual(s.session, session)
3555 self.assertEqual(s.session_reused, True)
3556
3557 with context2.wrap_socket(socket.socket()) as s:
3558 # cannot re-use session with a different SSLContext
3559 with self.assertRaises(ValueError) as e:
3560 s.session = session
3561 s.connect((HOST, server.port))
3562 self.assertEqual(str(e.exception),
3563 'Session refers to a different SSLContext.')
3564
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003565
Thomas Woutersed03b412007-08-28 21:37:11 +00003566def test_main(verbose=False):
Antoine Pitrou15cee622010-08-04 16:45:21 +00003567 if support.verbose:
Berker Peksag9e7990a2015-05-16 23:21:26 +03003568 import warnings
Antoine Pitrou15cee622010-08-04 16:45:21 +00003569 plats = {
3570 'Linux': platform.linux_distribution,
3571 'Mac': platform.mac_ver,
3572 'Windows': platform.win32_ver,
3573 }
Berker Peksag9e7990a2015-05-16 23:21:26 +03003574 with warnings.catch_warnings():
3575 warnings.filterwarnings(
3576 'ignore',
R David Murray44b548d2016-09-08 13:59:53 -04003577 r'dist\(\) and linux_distribution\(\) '
Berker Peksag9e7990a2015-05-16 23:21:26 +03003578 'functions are deprecated .*',
3579 PendingDeprecationWarning,
3580 )
3581 for name, func in plats.items():
3582 plat = func()
3583 if plat and plat[0]:
3584 plat = '%s %r' % (name, plat)
3585 break
3586 else:
3587 plat = repr(platform.platform())
Antoine Pitrou15cee622010-08-04 16:45:21 +00003588 print("test_ssl: testing with %r %r" %
3589 (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
3590 print(" under %s" % plat)
Antoine Pitroud5323212010-10-22 18:19:07 +00003591 print(" HAS_SNI = %r" % ssl.HAS_SNI)
Antoine Pitrou609ef012013-03-29 18:09:06 +01003592 print(" OP_ALL = 0x%8x" % ssl.OP_ALL)
3593 try:
3594 print(" OP_NO_TLSv1_1 = 0x%8x" % ssl.OP_NO_TLSv1_1)
3595 except AttributeError:
3596 pass
Antoine Pitrou15cee622010-08-04 16:45:21 +00003597
Antoine Pitrou152efa22010-05-16 18:19:27 +00003598 for filename in [
Martin Panter3840b2a2016-03-27 01:53:46 +00003599 CERTFILE, BYTES_CERTFILE,
Antoine Pitrou152efa22010-05-16 18:19:27 +00003600 ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003601 SIGNED_CERTFILE, SIGNED_CERTFILE2, SIGNING_CA,
Antoine Pitrou152efa22010-05-16 18:19:27 +00003602 BADCERT, BADKEY, EMPTYCERT]:
3603 if not os.path.exists(filename):
3604 raise support.TestFailed("Can't read certificate file %r" % filename)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003605
Martin Panter3840b2a2016-03-27 01:53:46 +00003606 tests = [
3607 ContextTests, BasicSocketTests, SSLErrorTests, MemoryBIOTests,
3608 SimpleBackgroundTests,
3609 ]
Thomas Woutersed03b412007-08-28 21:37:11 +00003610
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003611 if support.is_resource_enabled('network'):
Bill Janssen6e027db2007-11-15 22:23:56 +00003612 tests.append(NetworkedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00003613
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003614 if _have_threads:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003615 thread_info = support.threading_setup()
Antoine Pitroudb5012a2013-01-12 22:00:09 +01003616 if thread_info:
Bill Janssen6e027db2007-11-15 22:23:56 +00003617 tests.append(ThreadedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00003618
Antoine Pitrou480a1242010-04-28 21:37:09 +00003619 try:
3620 support.run_unittest(*tests)
3621 finally:
3622 if _have_threads:
3623 support.threading_cleanup(*thread_info)
Thomas Woutersed03b412007-08-28 21:37:11 +00003624
3625if __name__ == "__main__":
3626 test_main()