blob: 16cad9de80bab4e445fb84c60aee31996e9e996e [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 Heimes68771112017-09-05 21:55:40 -07001749 self.assertIsNone(sslobj.version())
Christian Heimes01113fa2016-09-05 23:23:24 +02001750 self.assertIsNotNone(sslobj.shared_ciphers())
Martin Panter3840b2a2016-03-27 01:53:46 +00001751 self.assertRaises(ValueError, sslobj.getpeercert)
1752 if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
1753 self.assertIsNone(sslobj.get_channel_binding('tls-unique'))
1754 self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
1755 self.assertTrue(sslobj.cipher())
Christian Heimes01113fa2016-09-05 23:23:24 +02001756 self.assertIsNotNone(sslobj.shared_ciphers())
Christian Heimes68771112017-09-05 21:55:40 -07001757 self.assertIsNotNone(sslobj.version())
Martin Panter3840b2a2016-03-27 01:53:46 +00001758 self.assertTrue(sslobj.getpeercert())
1759 if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
1760 self.assertTrue(sslobj.get_channel_binding('tls-unique'))
1761 try:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001762 self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
Martin Panter3840b2a2016-03-27 01:53:46 +00001763 except ssl.SSLSyscallError:
1764 # If the server shuts down the TCP connection without sending a
1765 # secure shutdown message, this is reported as SSL_ERROR_SYSCALL
1766 pass
1767 self.assertRaises(ssl.SSLError, sslobj.write, b'foo')
1768
1769 def test_bio_read_write_data(self):
1770 sock = socket.socket(socket.AF_INET)
1771 self.addCleanup(sock.close)
1772 sock.connect(self.server_addr)
1773 incoming = ssl.MemoryBIO()
1774 outgoing = ssl.MemoryBIO()
1775 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1776 ctx.verify_mode = ssl.CERT_NONE
1777 sslobj = ctx.wrap_bio(incoming, outgoing, False)
1778 self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
1779 req = b'FOO\n'
1780 self.ssl_io_loop(sock, incoming, outgoing, sslobj.write, req)
1781 buf = self.ssl_io_loop(sock, incoming, outgoing, sslobj.read, 1024)
1782 self.assertEqual(buf, b'foo\n')
1783 self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001784
1785
Martin Panter3840b2a2016-03-27 01:53:46 +00001786class NetworkedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001787
Martin Panter3840b2a2016-03-27 01:53:46 +00001788 def test_timeout_connect_ex(self):
1789 # Issue #12065: on a timeout, connect_ex() should return the original
1790 # errno (mimicking the behaviour of non-SSL sockets).
1791 with support.transient_internet(REMOTE_HOST):
Christian Heimesd0486372016-09-10 23:23:33 +02001792 s = test_wrap_socket(socket.socket(socket.AF_INET),
Martin Panter3840b2a2016-03-27 01:53:46 +00001793 cert_reqs=ssl.CERT_REQUIRED,
1794 do_handshake_on_connect=False)
1795 self.addCleanup(s.close)
1796 s.settimeout(0.0000001)
1797 rc = s.connect_ex((REMOTE_HOST, 443))
1798 if rc == 0:
1799 self.skipTest("REMOTE_HOST responded too quickly")
1800 self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
1801
1802 @unittest.skipUnless(support.IPV6_ENABLED, 'Needs IPv6')
1803 def test_get_server_certificate_ipv6(self):
1804 with support.transient_internet('ipv6.google.com'):
1805 _test_get_server_certificate(self, 'ipv6.google.com', 443)
1806 _test_get_server_certificate_fail(self, 'ipv6.google.com', 443)
1807
Martin Panter3840b2a2016-03-27 01:53:46 +00001808
1809def _test_get_server_certificate(test, host, port, cert=None):
1810 pem = ssl.get_server_certificate((host, port))
1811 if not pem:
1812 test.fail("No server certificate on %s:%s!" % (host, port))
1813
1814 pem = ssl.get_server_certificate((host, port), ca_certs=cert)
1815 if not pem:
1816 test.fail("No server certificate on %s:%s!" % (host, port))
1817 if support.verbose:
1818 sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
1819
1820def _test_get_server_certificate_fail(test, host, port):
1821 try:
1822 pem = ssl.get_server_certificate((host, port), ca_certs=CERTFILE)
1823 except ssl.SSLError as x:
1824 #should fail
1825 if support.verbose:
1826 sys.stdout.write("%s\n" % x)
1827 else:
1828 test.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
1829
1830
1831if _have_threads:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001832 from test.ssl_servers import make_https_server
1833
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001834 class ThreadedEchoServer(threading.Thread):
1835
1836 class ConnectionHandler(threading.Thread):
1837
1838 """A mildly complicated class, because we want it to work both
1839 with and without the SSL wrapper around the socket connection, so
1840 that we can test the STARTTLS functionality."""
1841
Bill Janssen6e027db2007-11-15 22:23:56 +00001842 def __init__(self, server, connsock, addr):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001843 self.server = server
1844 self.running = False
1845 self.sock = connsock
Bill Janssen6e027db2007-11-15 22:23:56 +00001846 self.addr = addr
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001847 self.sock.setblocking(1)
1848 self.sslconn = None
1849 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00001850 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001851
Antoine Pitrou480a1242010-04-28 21:37:09 +00001852 def wrap_conn(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001853 try:
Antoine Pitroub5218772010-05-21 09:56:06 +00001854 self.sslconn = self.server.context.wrap_socket(
1855 self.sock, server_side=True)
Benjamin Petersoncca27322015-01-23 16:35:37 -05001856 self.server.selected_npn_protocols.append(self.sslconn.selected_npn_protocol())
1857 self.server.selected_alpn_protocols.append(self.sslconn.selected_alpn_protocol())
Christian Heimes305e56c2017-09-05 16:37:09 -07001858 except (ssl.SSLError, ConnectionResetError, OSError) as e:
Nadeem Vawdaad246bf2013-03-03 22:44:22 +01001859 # We treat ConnectionResetError as though it were an
1860 # SSLError - OpenSSL on Ubuntu abruptly closes the
1861 # connection when asked to use an unsupported protocol.
1862 #
Christian Heimes305e56c2017-09-05 16:37:09 -07001863 # OSError may occur with wrong protocols, e.g. both
1864 # sides use PROTOCOL_TLS_SERVER.
1865 #
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001866 # XXX Various errors can have happened here, for example
1867 # a mismatching protocol version, an invalid certificate,
1868 # or a low-level bug. This should be made more discriminating.
Victor Stinner86871012017-09-02 00:26:17 +02001869 #
1870 # bpo-31323: Store the exception as string to prevent
1871 # a reference leak: server -> conn_errors -> exception
1872 # -> traceback -> self (ConnectionHandler) -> server
1873 self.server.conn_errors.append(str(e))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001874 if self.server.chatty:
Bill Janssen6e027db2007-11-15 22:23:56 +00001875 handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001876 self.running = False
1877 self.server.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +00001878 self.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001879 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001880 else:
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001881 self.server.shared_ciphers.append(self.sslconn.shared_ciphers())
Antoine Pitroub5218772010-05-21 09:56:06 +00001882 if self.server.context.verify_mode == ssl.CERT_REQUIRED:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001883 cert = self.sslconn.getpeercert()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001884 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001885 sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
1886 cert_binary = self.sslconn.getpeercert(True)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001887 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001888 sys.stdout.write(" cert binary is " + str(len(cert_binary)) + " bytes\n")
1889 cipher = self.sslconn.cipher()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001890 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001891 sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001892 sys.stdout.write(" server: selected protocol is now "
1893 + str(self.sslconn.selected_npn_protocol()) + "\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001894 return True
1895
1896 def read(self):
1897 if self.sslconn:
1898 return self.sslconn.read()
1899 else:
1900 return self.sock.recv(1024)
1901
1902 def write(self, bytes):
1903 if self.sslconn:
1904 return self.sslconn.write(bytes)
1905 else:
1906 return self.sock.send(bytes)
1907
1908 def close(self):
1909 if self.sslconn:
1910 self.sslconn.close()
1911 else:
1912 self.sock.close()
1913
Antoine Pitrou480a1242010-04-28 21:37:09 +00001914 def run(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001915 self.running = True
1916 if not self.server.starttls_server:
1917 if not self.wrap_conn():
1918 return
1919 while self.running:
1920 try:
1921 msg = self.read()
Antoine Pitrou480a1242010-04-28 21:37:09 +00001922 stripped = msg.strip()
1923 if not stripped:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001924 # eof, so quit this handler
1925 self.running = False
Martin Panter3840b2a2016-03-27 01:53:46 +00001926 try:
1927 self.sock = self.sslconn.unwrap()
1928 except OSError:
1929 # Many tests shut the TCP connection down
1930 # without an SSL shutdown. This causes
1931 # unwrap() to raise OSError with errno=0!
1932 pass
1933 else:
1934 self.sslconn = None
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001935 self.close()
Antoine Pitrou480a1242010-04-28 21:37:09 +00001936 elif stripped == b'over':
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001937 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001938 sys.stdout.write(" server: client closed connection\n")
1939 self.close()
1940 return
Bill Janssen6e027db2007-11-15 22:23:56 +00001941 elif (self.server.starttls_server and
Antoine Pitrou764b8782010-04-28 22:57:15 +00001942 stripped == b'STARTTLS'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001943 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001944 sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001945 self.write(b"OK\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001946 if not self.wrap_conn():
1947 return
Bill Janssen40a0f662008-08-12 16:56:25 +00001948 elif (self.server.starttls_server and self.sslconn
Antoine Pitrou764b8782010-04-28 22:57:15 +00001949 and stripped == b'ENDTLS'):
Bill Janssen40a0f662008-08-12 16:56:25 +00001950 if support.verbose and self.server.connectionchatty:
1951 sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001952 self.write(b"OK\n")
Bill Janssen40a0f662008-08-12 16:56:25 +00001953 self.sock = self.sslconn.unwrap()
1954 self.sslconn = None
1955 if support.verbose and self.server.connectionchatty:
1956 sys.stdout.write(" server: connection is now unencrypted...\n")
Antoine Pitroud6494802011-07-21 01:11:30 +02001957 elif stripped == b'CB tls-unique':
1958 if support.verbose and self.server.connectionchatty:
1959 sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
1960 data = self.sslconn.get_channel_binding("tls-unique")
1961 self.write(repr(data).encode("us-ascii") + b"\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001962 else:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001963 if (support.verbose and
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001964 self.server.connectionchatty):
1965 ctype = (self.sslconn and "encrypted") or "unencrypted"
Antoine Pitrou480a1242010-04-28 21:37:09 +00001966 sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
1967 % (msg, ctype, msg.lower(), ctype))
1968 self.write(msg.lower())
Andrew Svetlov0832af62012-12-18 23:10:48 +02001969 except OSError:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001970 if self.server.chatty:
1971 handle_error("Test server failure:\n")
1972 self.close()
1973 self.running = False
1974 # normally, we'd just stop here, but for the test
1975 # harness, we want to stop the server
1976 self.server.stop()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001977
Antoine Pitroub5218772010-05-21 09:56:06 +00001978 def __init__(self, certificate=None, ssl_version=None,
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001979 certreqs=None, cacerts=None,
Antoine Pitrou2d9cb9c2010-04-17 17:40:45 +00001980 chatty=True, connectionchatty=False, starttls_server=False,
Benjamin Petersoncca27322015-01-23 16:35:37 -05001981 npn_protocols=None, alpn_protocols=None,
1982 ciphers=None, context=None):
Antoine Pitroub5218772010-05-21 09:56:06 +00001983 if context:
1984 self.context = context
1985 else:
1986 self.context = ssl.SSLContext(ssl_version
1987 if ssl_version is not None
1988 else ssl.PROTOCOL_TLSv1)
1989 self.context.verify_mode = (certreqs if certreqs is not None
1990 else ssl.CERT_NONE)
1991 if cacerts:
1992 self.context.load_verify_locations(cacerts)
1993 if certificate:
1994 self.context.load_cert_chain(certificate)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001995 if npn_protocols:
1996 self.context.set_npn_protocols(npn_protocols)
Benjamin Petersoncca27322015-01-23 16:35:37 -05001997 if alpn_protocols:
1998 self.context.set_alpn_protocols(alpn_protocols)
Antoine Pitroub5218772010-05-21 09:56:06 +00001999 if ciphers:
2000 self.context.set_ciphers(ciphers)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002001 self.chatty = chatty
2002 self.connectionchatty = connectionchatty
2003 self.starttls_server = starttls_server
2004 self.sock = socket.socket()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002005 self.port = support.bind_port(self.sock)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002006 self.flag = None
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002007 self.active = False
Benjamin Petersoncca27322015-01-23 16:35:37 -05002008 self.selected_npn_protocols = []
2009 self.selected_alpn_protocols = []
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002010 self.shared_ciphers = []
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002011 self.conn_errors = []
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002012 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00002013 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002014
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002015 def __enter__(self):
2016 self.start(threading.Event())
2017 self.flag.wait()
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002018 return self
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002019
2020 def __exit__(self, *args):
2021 self.stop()
2022 self.join()
2023
Antoine Pitrou480a1242010-04-28 21:37:09 +00002024 def start(self, flag=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002025 self.flag = flag
2026 threading.Thread.start(self)
2027
Antoine Pitrou480a1242010-04-28 21:37:09 +00002028 def run(self):
Antoine Pitrouaf7c6022010-04-27 09:56:02 +00002029 self.sock.settimeout(0.05)
Charles-François Natali6e204602014-07-23 19:28:13 +01002030 self.sock.listen()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002031 self.active = True
2032 if self.flag:
2033 # signal an event
2034 self.flag.set()
2035 while self.active:
2036 try:
2037 newconn, connaddr = self.sock.accept()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002038 if support.verbose and self.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002039 sys.stdout.write(' server: new connection from '
Bill Janssen6e027db2007-11-15 22:23:56 +00002040 + repr(connaddr) + '\n')
2041 handler = self.ConnectionHandler(self, newconn, connaddr)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002042 handler.start()
Antoine Pitroueced82e2012-01-27 17:33:01 +01002043 handler.join()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002044 except socket.timeout:
2045 pass
2046 except KeyboardInterrupt:
2047 self.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +00002048 self.sock.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002049
Antoine Pitrou480a1242010-04-28 21:37:09 +00002050 def stop(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002051 self.active = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002052
Bill Janssen54cc54c2007-12-14 22:08:56 +00002053 class AsyncoreEchoServer(threading.Thread):
2054
2055 # this one's based on asyncore.dispatcher
2056
2057 class EchoServer (asyncore.dispatcher):
2058
Victor Stinner1dae7452017-05-02 13:12:02 +02002059 class ConnectionHandler(asyncore.dispatcher_with_send):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002060
2061 def __init__(self, conn, certfile):
Christian Heimesd0486372016-09-10 23:23:33 +02002062 self.socket = test_wrap_socket(conn, server_side=True,
Bill Janssen54cc54c2007-12-14 22:08:56 +00002063 certfile=certfile,
2064 do_handshake_on_connect=False)
2065 asyncore.dispatcher_with_send.__init__(self, self.socket)
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002066 self._ssl_accepting = True
2067 self._do_ssl_handshake()
Bill Janssen54cc54c2007-12-14 22:08:56 +00002068
2069 def readable(self):
2070 if isinstance(self.socket, ssl.SSLSocket):
2071 while self.socket.pending() > 0:
2072 self.handle_read_event()
2073 return True
2074
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002075 def _do_ssl_handshake(self):
2076 try:
2077 self.socket.do_handshake()
Antoine Pitrou41032a62011-10-27 23:56:55 +02002078 except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
2079 return
2080 except ssl.SSLEOFError:
2081 return self.handle_close()
2082 except ssl.SSLError:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002083 raise
Andrew Svetlov0832af62012-12-18 23:10:48 +02002084 except OSError as err:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002085 if err.args[0] == errno.ECONNABORTED:
2086 return self.handle_close()
Bill Janssen54cc54c2007-12-14 22:08:56 +00002087 else:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002088 self._ssl_accepting = False
2089
2090 def handle_read(self):
2091 if self._ssl_accepting:
2092 self._do_ssl_handshake()
2093 else:
2094 data = self.recv(1024)
2095 if support.verbose:
2096 sys.stdout.write(" server: read %s from client\n" % repr(data))
2097 if not data:
2098 self.close()
2099 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002100 self.send(data.lower())
Bill Janssen54cc54c2007-12-14 22:08:56 +00002101
2102 def handle_close(self):
Bill Janssen2f5799b2008-06-29 00:08:12 +00002103 self.close()
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002104 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00002105 sys.stdout.write(" server: closed connection %s\n" % self.socket)
2106
2107 def handle_error(self):
2108 raise
2109
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002110 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002111 self.certfile = certfile
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002112 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
2113 self.port = support.bind_port(sock, '')
2114 asyncore.dispatcher.__init__(self, sock)
Bill Janssen54cc54c2007-12-14 22:08:56 +00002115 self.listen(5)
2116
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00002117 def handle_accepted(self, sock_obj, addr):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002118 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00002119 sys.stdout.write(" server: new connection from %s:%s\n" %addr)
2120 self.ConnectionHandler(sock_obj, self.certfile)
2121
2122 def handle_error(self):
2123 raise
2124
Trent Nelson78520002008-04-10 20:54:35 +00002125 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002126 self.flag = None
2127 self.active = False
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002128 self.server = self.EchoServer(certfile)
2129 self.port = self.server.port
Bill Janssen54cc54c2007-12-14 22:08:56 +00002130 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00002131 self.daemon = True
Bill Janssen54cc54c2007-12-14 22:08:56 +00002132
2133 def __str__(self):
2134 return "<%s %s>" % (self.__class__.__name__, self.server)
2135
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002136 def __enter__(self):
2137 self.start(threading.Event())
2138 self.flag.wait()
Antoine Pitrou8f85f902012-01-03 22:46:48 +01002139 return self
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002140
2141 def __exit__(self, *args):
2142 if support.verbose:
2143 sys.stdout.write(" cleanup: stopping server.\n")
2144 self.stop()
2145 if support.verbose:
2146 sys.stdout.write(" cleanup: joining server thread.\n")
2147 self.join()
2148 if support.verbose:
2149 sys.stdout.write(" cleanup: successfully joined.\n")
Victor Stinner1dae7452017-05-02 13:12:02 +02002150 # make sure that ConnectionHandler is removed from socket_map
2151 asyncore.close_all(ignore_all=True)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002152
Bill Janssen54cc54c2007-12-14 22:08:56 +00002153 def start (self, flag=None):
2154 self.flag = flag
2155 threading.Thread.start(self)
2156
Antoine Pitrou480a1242010-04-28 21:37:09 +00002157 def run(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002158 self.active = True
2159 if self.flag:
2160 self.flag.set()
2161 while self.active:
2162 try:
2163 asyncore.loop(1)
2164 except:
2165 pass
2166
Antoine Pitrou480a1242010-04-28 21:37:09 +00002167 def stop(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00002168 self.active = False
2169 self.server.close()
2170
Antoine Pitroub5218772010-05-21 09:56:06 +00002171 def server_params_test(client_context, server_context, indata=b"FOO\n",
Christian Heimes99a65702016-09-10 23:44:53 +02002172 chatty=True, connectionchatty=False, sni_name=None,
2173 session=None):
Antoine Pitrou480a1242010-04-28 21:37:09 +00002174 """
2175 Launch a server, connect a client to it and try various reads
2176 and writes.
2177 """
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002178 stats = {}
Antoine Pitroub5218772010-05-21 09:56:06 +00002179 server = ThreadedEchoServer(context=server_context,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002180 chatty=chatty,
Bill Janssen6e027db2007-11-15 22:23:56 +00002181 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002182 with server:
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002183 with client_context.wrap_socket(socket.socket(),
Christian Heimes99a65702016-09-10 23:44:53 +02002184 server_hostname=sni_name, session=session) as s:
Antoine Pitroueba63c42012-01-28 17:38:34 +01002185 s.connect((HOST, server.port))
2186 for arg in [indata, bytearray(indata), memoryview(indata)]:
2187 if connectionchatty:
2188 if support.verbose:
2189 sys.stdout.write(
2190 " client: sending %r...\n" % indata)
2191 s.write(arg)
2192 outdata = s.read()
2193 if connectionchatty:
2194 if support.verbose:
2195 sys.stdout.write(" client: read %r\n" % outdata)
2196 if outdata != indata.lower():
2197 raise AssertionError(
2198 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
2199 % (outdata[:20], len(outdata),
2200 indata[:20].lower(), len(indata)))
2201 s.write(b"over\n")
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00002202 if connectionchatty:
2203 if support.verbose:
Antoine Pitroueba63c42012-01-28 17:38:34 +01002204 sys.stdout.write(" client: closing connection.\n")
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002205 stats.update({
Antoine Pitrouce816a52012-01-28 17:40:23 +01002206 'compression': s.compression(),
2207 'cipher': s.cipher(),
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002208 'peercert': s.getpeercert(),
Benjamin Petersoncca27322015-01-23 16:35:37 -05002209 'client_alpn_protocol': s.selected_alpn_protocol(),
Antoine Pitrou47e40422014-09-04 21:00:10 +02002210 'client_npn_protocol': s.selected_npn_protocol(),
2211 'version': s.version(),
Christian Heimes99a65702016-09-10 23:44:53 +02002212 'session_reused': s.session_reused,
2213 'session': s.session,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002214 })
Antoine Pitroueba63c42012-01-28 17:38:34 +01002215 s.close()
Benjamin Petersoncca27322015-01-23 16:35:37 -05002216 stats['server_alpn_protocols'] = server.selected_alpn_protocols
2217 stats['server_npn_protocols'] = server.selected_npn_protocols
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002218 stats['server_shared_ciphers'] = server.shared_ciphers
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002219 return stats
Thomas Woutersed03b412007-08-28 21:37:11 +00002220
Antoine Pitroub5218772010-05-21 09:56:06 +00002221 def try_protocol_combo(server_protocol, client_protocol, expect_success,
2222 certsreqs=None, server_options=0, client_options=0):
Antoine Pitrou47e40422014-09-04 21:00:10 +02002223 """
2224 Try to SSL-connect using *client_protocol* to *server_protocol*.
2225 If *expect_success* is true, assert that the connection succeeds,
2226 if it's false, assert that the connection fails.
2227 Also, if *expect_success* is a string, assert that it is the protocol
2228 version actually used by the connection.
2229 """
Benjamin Peterson2a691a82008-03-31 01:51:45 +00002230 if certsreqs is None:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002231 certsreqs = ssl.CERT_NONE
Antoine Pitrou480a1242010-04-28 21:37:09 +00002232 certtype = {
2233 ssl.CERT_NONE: "CERT_NONE",
2234 ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
2235 ssl.CERT_REQUIRED: "CERT_REQUIRED",
2236 }[certsreqs]
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002237 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002238 formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002239 sys.stdout.write(formatstr %
2240 (ssl.get_protocol_name(client_protocol),
2241 ssl.get_protocol_name(server_protocol),
2242 certtype))
Antoine Pitroub5218772010-05-21 09:56:06 +00002243 client_context = ssl.SSLContext(client_protocol)
Antoine Pitrou32c49152014-01-09 21:28:48 +01002244 client_context.options |= client_options
Antoine Pitroub5218772010-05-21 09:56:06 +00002245 server_context = ssl.SSLContext(server_protocol)
Antoine Pitrou32c49152014-01-09 21:28:48 +01002246 server_context.options |= server_options
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002247
2248 # NOTE: we must enable "ALL" ciphers on the client, otherwise an
2249 # SSLv23 client will send an SSLv3 hello (rather than SSLv2)
2250 # starting from OpenSSL 1.0.0 (see issue #8322).
2251 if client_context.protocol == ssl.PROTOCOL_SSLv23:
2252 client_context.set_ciphers("ALL")
2253
Antoine Pitroub5218772010-05-21 09:56:06 +00002254 for ctx in (client_context, server_context):
2255 ctx.verify_mode = certsreqs
Antoine Pitroub5218772010-05-21 09:56:06 +00002256 ctx.load_cert_chain(CERTFILE)
2257 ctx.load_verify_locations(CERTFILE)
2258 try:
Antoine Pitrou47e40422014-09-04 21:00:10 +02002259 stats = server_params_test(client_context, server_context,
2260 chatty=False, connectionchatty=False)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002261 # Protocol mismatch can result in either an SSLError, or a
2262 # "Connection reset by peer" error.
2263 except ssl.SSLError:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002264 if expect_success:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002265 raise
Andrew Svetlov0832af62012-12-18 23:10:48 +02002266 except OSError as e:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002267 if expect_success or e.errno != errno.ECONNRESET:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002268 raise
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002269 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002270 if not expect_success:
Antoine Pitroud75b2a92010-05-06 14:15:10 +00002271 raise AssertionError(
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002272 "Client protocol %s succeeded with server protocol %s!"
2273 % (ssl.get_protocol_name(client_protocol),
2274 ssl.get_protocol_name(server_protocol)))
Antoine Pitrou47e40422014-09-04 21:00:10 +02002275 elif (expect_success is not True
2276 and expect_success != stats['version']):
2277 raise AssertionError("version mismatch: expected %r, got %r"
2278 % (expect_success, stats['version']))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002279
2280
Bill Janssen6e027db2007-11-15 22:23:56 +00002281 class ThreadedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002282
Antoine Pitrou23df4832010-08-04 17:14:06 +00002283 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002284 def test_echo(self):
2285 """Basic test of an SSL client connecting to a server"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002286 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002287 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00002288 for protocol in PROTOCOLS:
Christian Heimes5fe668c2016-09-12 00:01:11 +02002289 if protocol in {ssl.PROTOCOL_TLS_CLIENT, ssl.PROTOCOL_TLS_SERVER}:
2290 continue
Antoine Pitrou972d5bb2013-03-29 17:56:03 +01002291 with self.subTest(protocol=ssl._PROTOCOL_NAMES[protocol]):
2292 context = ssl.SSLContext(protocol)
2293 context.load_cert_chain(CERTFILE)
2294 server_params_test(context, context,
2295 chatty=True, connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002296
Christian Heimes5fe668c2016-09-12 00:01:11 +02002297 client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
2298 client_context.load_verify_locations(SIGNING_CA)
2299 server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
2300 # server_context.load_verify_locations(SIGNING_CA)
2301 server_context.load_cert_chain(SIGNED_CERTFILE2)
2302
Christian Heimes9017ec12016-09-12 10:48:20 +02002303 with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_SERVER):
Christian Heimes5fe668c2016-09-12 00:01:11 +02002304 server_params_test(client_context=client_context,
2305 server_context=server_context,
2306 chatty=True, connectionchatty=True,
2307 sni_name='fakehostname')
2308
Christian Heimes9017ec12016-09-12 10:48:20 +02002309 client_context.check_hostname = False
2310 with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_CLIENT):
2311 with self.assertRaises(ssl.SSLError) as e:
Christian Heimes5fe668c2016-09-12 00:01:11 +02002312 server_params_test(client_context=server_context,
2313 server_context=client_context,
2314 chatty=True, connectionchatty=True,
2315 sni_name='fakehostname')
Christian Heimes9017ec12016-09-12 10:48:20 +02002316 self.assertIn('called a function you should not call',
2317 str(e.exception))
2318
2319 with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_SERVER):
2320 with self.assertRaises(ssl.SSLError) as e:
2321 server_params_test(client_context=server_context,
2322 server_context=server_context,
2323 chatty=True, connectionchatty=True)
2324 self.assertIn('called a function you should not call',
2325 str(e.exception))
2326
2327 with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_CLIENT):
2328 with self.assertRaises(ssl.SSLError) as e:
2329 server_params_test(client_context=server_context,
2330 server_context=client_context,
2331 chatty=True, connectionchatty=True)
2332 self.assertIn('called a function you should not call',
2333 str(e.exception))
2334
Christian Heimes5fe668c2016-09-12 00:01:11 +02002335
Antoine Pitrou480a1242010-04-28 21:37:09 +00002336 def test_getpeercert(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002337 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002338 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00002339 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
2340 context.verify_mode = ssl.CERT_REQUIRED
2341 context.load_verify_locations(CERTFILE)
2342 context.load_cert_chain(CERTFILE)
2343 server = ThreadedEchoServer(context=context, chatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002344 with server:
Antoine Pitrou20b85552013-09-29 19:50:53 +02002345 s = context.wrap_socket(socket.socket(),
2346 do_handshake_on_connect=False)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002347 s.connect((HOST, server.port))
Antoine Pitrou20b85552013-09-29 19:50:53 +02002348 # getpeercert() raise ValueError while the handshake isn't
2349 # done.
2350 with self.assertRaises(ValueError):
2351 s.getpeercert()
2352 s.do_handshake()
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002353 cert = s.getpeercert()
2354 self.assertTrue(cert, "Can't get peer certificate.")
2355 cipher = s.cipher()
2356 if support.verbose:
2357 sys.stdout.write(pprint.pformat(cert) + '\n')
2358 sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
2359 if 'subject' not in cert:
2360 self.fail("No subject field in certificate: %s." %
2361 pprint.pformat(cert))
2362 if ((('organizationName', 'Python Software Foundation'),)
2363 not in cert['subject']):
2364 self.fail(
2365 "Missing or invalid 'organizationName' field in certificate subject; "
2366 "should be 'Python Software Foundation'.")
Antoine Pitroufb046912010-11-09 20:21:19 +00002367 self.assertIn('notBefore', cert)
2368 self.assertIn('notAfter', cert)
2369 before = ssl.cert_time_to_seconds(cert['notBefore'])
2370 after = ssl.cert_time_to_seconds(cert['notAfter'])
2371 self.assertLess(before, after)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002372 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002373
Christian Heimes2427b502013-11-23 11:24:32 +01002374 @unittest.skipUnless(have_verify_flags(),
2375 "verify_flags need OpenSSL > 0.9.8")
Christian Heimes22587792013-11-21 23:56:13 +01002376 def test_crl_check(self):
2377 if support.verbose:
2378 sys.stdout.write("\n")
2379
2380 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2381 server_context.load_cert_chain(SIGNED_CERTFILE)
2382
2383 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2384 context.verify_mode = ssl.CERT_REQUIRED
2385 context.load_verify_locations(SIGNING_CA)
Benjamin Petersonc3d9c5c2015-03-04 23:18:48 -05002386 tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
2387 self.assertEqual(context.verify_flags, ssl.VERIFY_DEFAULT | tf)
Christian Heimes22587792013-11-21 23:56:13 +01002388
2389 # VERIFY_DEFAULT should pass
2390 server = ThreadedEchoServer(context=server_context, chatty=True)
2391 with server:
2392 with context.wrap_socket(socket.socket()) as s:
2393 s.connect((HOST, server.port))
2394 cert = s.getpeercert()
2395 self.assertTrue(cert, "Can't get peer certificate.")
2396
2397 # VERIFY_CRL_CHECK_LEAF without a loaded CRL file fails
Christian Heimes32f0c7a2013-11-22 03:43:48 +01002398 context.verify_flags |= ssl.VERIFY_CRL_CHECK_LEAF
Christian Heimes22587792013-11-21 23:56:13 +01002399
2400 server = ThreadedEchoServer(context=server_context, chatty=True)
2401 with server:
2402 with context.wrap_socket(socket.socket()) as s:
2403 with self.assertRaisesRegex(ssl.SSLError,
2404 "certificate verify failed"):
2405 s.connect((HOST, server.port))
2406
2407 # now load a CRL file. The CRL file is signed by the CA.
2408 context.load_verify_locations(CRLFILE)
2409
2410 server = ThreadedEchoServer(context=server_context, chatty=True)
2411 with server:
2412 with context.wrap_socket(socket.socket()) as s:
2413 s.connect((HOST, server.port))
2414 cert = s.getpeercert()
2415 self.assertTrue(cert, "Can't get peer certificate.")
2416
Christian Heimes1aa9a752013-12-02 02:41:19 +01002417 def test_check_hostname(self):
2418 if support.verbose:
2419 sys.stdout.write("\n")
2420
2421 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2422 server_context.load_cert_chain(SIGNED_CERTFILE)
2423
2424 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
2425 context.verify_mode = ssl.CERT_REQUIRED
2426 context.check_hostname = True
2427 context.load_verify_locations(SIGNING_CA)
2428
2429 # correct hostname should verify
2430 server = ThreadedEchoServer(context=server_context, chatty=True)
2431 with server:
2432 with context.wrap_socket(socket.socket(),
2433 server_hostname="localhost") as s:
2434 s.connect((HOST, server.port))
2435 cert = s.getpeercert()
2436 self.assertTrue(cert, "Can't get peer certificate.")
2437
2438 # incorrect hostname should raise an exception
2439 server = ThreadedEchoServer(context=server_context, chatty=True)
2440 with server:
2441 with context.wrap_socket(socket.socket(),
2442 server_hostname="invalid") as s:
2443 with self.assertRaisesRegex(ssl.CertificateError,
2444 "hostname 'invalid' doesn't match 'localhost'"):
2445 s.connect((HOST, server.port))
2446
2447 # missing server_hostname arg should cause an exception, too
2448 server = ThreadedEchoServer(context=server_context, chatty=True)
2449 with server:
2450 with socket.socket() as s:
2451 with self.assertRaisesRegex(ValueError,
2452 "check_hostname requires server_hostname"):
2453 context.wrap_socket(s)
2454
Martin Panter407b62f2016-01-30 03:41:43 +00002455 def test_wrong_cert(self):
Martin Panter3464ea22016-02-01 21:58:11 +00002456 """Connecting when the server rejects the client's certificate
2457
2458 Launch a server with CERT_REQUIRED, and check that trying to
2459 connect to it with a wrong client certificate fails.
2460 """
2461 certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
2462 "wrongcert.pem")
2463 server = ThreadedEchoServer(CERTFILE,
2464 certreqs=ssl.CERT_REQUIRED,
2465 cacerts=CERTFILE, chatty=False,
2466 connectionchatty=False)
2467 with server, \
2468 socket.socket() as sock, \
Christian Heimesd0486372016-09-10 23:23:33 +02002469 test_wrap_socket(sock,
Martin Panter3464ea22016-02-01 21:58:11 +00002470 certfile=certfile,
2471 ssl_version=ssl.PROTOCOL_TLSv1) as s:
2472 try:
2473 # Expect either an SSL error about the server rejecting
2474 # the connection, or a low-level connection reset (which
2475 # sometimes happens on Windows)
2476 s.connect((HOST, server.port))
2477 except ssl.SSLError as e:
2478 if support.verbose:
2479 sys.stdout.write("\nSSLError is %r\n" % e)
2480 except OSError as e:
2481 if e.errno != errno.ECONNRESET:
2482 raise
2483 if support.verbose:
2484 sys.stdout.write("\nsocket.error is %r\n" % e)
2485 else:
2486 self.fail("Use of invalid cert should have failed!")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002487
Antoine Pitrou480a1242010-04-28 21:37:09 +00002488 def test_rude_shutdown(self):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02002489 """A brutal shutdown of an SSL server should raise an OSError
Antoine Pitrou480a1242010-04-28 21:37:09 +00002490 in the client when attempting handshake.
2491 """
Trent Nelson6b240cd2008-04-10 20:12:06 +00002492 listener_ready = threading.Event()
2493 listener_gone = threading.Event()
Antoine Pitrou480a1242010-04-28 21:37:09 +00002494
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002495 s = socket.socket()
2496 port = support.bind_port(s, HOST)
Trent Nelson6b240cd2008-04-10 20:12:06 +00002497
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002498 # `listener` runs in a thread. It sits in an accept() until
2499 # the main thread connects. Then it rudely closes the socket,
2500 # and sets Event `listener_gone` to let the main thread know
2501 # the socket is gone.
Trent Nelson6b240cd2008-04-10 20:12:06 +00002502 def listener():
Charles-François Natali6e204602014-07-23 19:28:13 +01002503 s.listen()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002504 listener_ready.set()
Antoine Pitroud2eca372010-10-29 23:41:37 +00002505 newsock, addr = s.accept()
2506 newsock.close()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002507 s.close()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002508 listener_gone.set()
2509
2510 def connector():
2511 listener_ready.wait()
Antoine Pitroud2eca372010-10-29 23:41:37 +00002512 with socket.socket() as c:
2513 c.connect((HOST, port))
2514 listener_gone.wait()
2515 try:
Christian Heimesd0486372016-09-10 23:23:33 +02002516 ssl_sock = test_wrap_socket(c)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02002517 except OSError:
Antoine Pitroud2eca372010-10-29 23:41:37 +00002518 pass
2519 else:
2520 self.fail('connecting to closed SSL socket should have failed')
Trent Nelson6b240cd2008-04-10 20:12:06 +00002521
2522 t = threading.Thread(target=listener)
2523 t.start()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00002524 try:
2525 connector()
2526 finally:
2527 t.join()
Trent Nelson6b240cd2008-04-10 20:12:06 +00002528
Antoine Pitrou23df4832010-08-04 17:14:06 +00002529 @skip_if_broken_ubuntu_ssl
Victor Stinner3de49192011-05-09 00:42:58 +02002530 @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv2'),
2531 "OpenSSL is compiled without SSLv2 support")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002532 def test_protocol_sslv2(self):
2533 """Connecting to an SSLv2 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002534 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002535 sys.stdout.write("\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002536 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
2537 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
2538 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002539 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False)
Victor Stinner648b8622014-12-12 12:23:59 +01002540 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2541 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002542 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00002543 # SSLv23 client with specific SSL options
2544 if no_sslv2_implies_sslv3_hello():
2545 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
2546 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
2547 client_options=ssl.OP_NO_SSLv2)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002548 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002549 client_options=ssl.OP_NO_SSLv3)
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002550 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002551 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002552
Antoine Pitrou23df4832010-08-04 17:14:06 +00002553 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002554 def test_protocol_sslv23(self):
2555 """Connecting to an SSLv23 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002556 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002557 sys.stdout.write("\n")
Victor Stinner3de49192011-05-09 00:42:58 +02002558 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2559 try:
2560 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv2, True)
Andrew Svetlov0832af62012-12-18 23:10:48 +02002561 except OSError as x:
Victor Stinner3de49192011-05-09 00:42:58 +02002562 # this fails on some older versions of OpenSSL (0.9.7l, for instance)
2563 if support.verbose:
2564 sys.stdout.write(
2565 " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
2566 % str(x))
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)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002569 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002570 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1')
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_OPTIONAL)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002574 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_OPTIONAL)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002575 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002576
Benjamin Petersone32467c2014-12-05 21:59:35 -05002577 if hasattr(ssl, 'PROTOCOL_SSLv3'):
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002578 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False, ssl.CERT_REQUIRED)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002579 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_REQUIRED)
Antoine Pitrou47e40422014-09-04 21:00:10 +02002580 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002581
Antoine Pitroub5218772010-05-21 09:56:06 +00002582 # Server with specific SSL options
Benjamin Petersone32467c2014-12-05 21:59:35 -05002583 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2584 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False,
Antoine Pitroub5218772010-05-21 09:56:06 +00002585 server_options=ssl.OP_NO_SSLv3)
2586 # Will choose TLSv1
2587 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True,
2588 server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
2589 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, False,
2590 server_options=ssl.OP_NO_TLSv1)
2591
2592
Antoine Pitrou23df4832010-08-04 17:14:06 +00002593 @skip_if_broken_ubuntu_ssl
Benjamin Petersone32467c2014-12-05 21:59:35 -05002594 @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv3'),
2595 "OpenSSL is compiled without SSLv3 support")
Antoine Pitrou480a1242010-04-28 21:37:09 +00002596 def test_protocol_sslv3(self):
2597 """Connecting to an SSLv3 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002598 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002599 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002600 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3')
2601 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_OPTIONAL)
2602 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02002603 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2604 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04002605 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, False,
2606 client_options=ssl.OP_NO_SSLv3)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002607 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00002608 if no_sslv2_implies_sslv3_hello():
2609 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002610 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23,
2611 False, client_options=ssl.OP_NO_SSLv2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002612
Antoine Pitrou23df4832010-08-04 17:14:06 +00002613 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00002614 def test_protocol_tlsv1(self):
2615 """Connecting to a TLSv1 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002616 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002617 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002618 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1')
2619 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
2620 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02002621 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2622 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002623 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2624 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04002625 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv23, False,
2626 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002627
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002628 @skip_if_broken_ubuntu_ssl
2629 @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_1"),
2630 "TLS version 1.1 not supported.")
2631 def test_protocol_tlsv1_1(self):
2632 """Connecting to a TLSv1.1 server with various client options.
2633 Testing against older TLS versions."""
2634 if support.verbose:
2635 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002636 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002637 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2638 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002639 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2640 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002641 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv23, False,
2642 client_options=ssl.OP_NO_TLSv1_1)
2643
Antoine Pitrou47e40422014-09-04 21:00:10 +02002644 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002645 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1, False)
2646 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_1, False)
2647
2648
2649 @skip_if_broken_ubuntu_ssl
2650 @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_2"),
2651 "TLS version 1.2 not supported.")
2652 def test_protocol_tlsv1_2(self):
2653 """Connecting to a TLSv1.2 server with various client options.
2654 Testing against older TLS versions."""
2655 if support.verbose:
2656 sys.stdout.write("\n")
Antoine Pitrou47e40422014-09-04 21:00:10 +02002657 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2',
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002658 server_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,
2659 client_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,)
2660 if hasattr(ssl, 'PROTOCOL_SSLv2'):
2661 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv2, False)
Benjamin Petersone32467c2014-12-05 21:59:35 -05002662 if hasattr(ssl, 'PROTOCOL_SSLv3'):
2663 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv3, False)
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002664 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv23, False,
2665 client_options=ssl.OP_NO_TLSv1_2)
2666
Antoine Pitrou47e40422014-09-04 21:00:10 +02002667 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2')
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002668 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1, False)
2669 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_2, False)
2670 try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_1, False)
2671 try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_2, False)
2672
Antoine Pitrou480a1242010-04-28 21:37:09 +00002673 def test_starttls(self):
2674 """Switching from clear text to encrypted and back again."""
2675 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 +00002676
Trent Nelson78520002008-04-10 20:54:35 +00002677 server = ThreadedEchoServer(CERTFILE,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002678 ssl_version=ssl.PROTOCOL_TLSv1,
2679 starttls_server=True,
2680 chatty=True,
2681 connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002682 wrapped = False
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002683 with server:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002684 s = socket.socket()
2685 s.setblocking(1)
2686 s.connect((HOST, server.port))
2687 if support.verbose:
2688 sys.stdout.write("\n")
2689 for indata in msgs:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002690 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002691 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002692 " client: sending %r...\n" % indata)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002693 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002694 conn.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002695 outdata = conn.read()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002696 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002697 s.send(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002698 outdata = s.recv(1024)
Antoine Pitrou480a1242010-04-28 21:37:09 +00002699 msg = outdata.strip().lower()
2700 if indata == b"STARTTLS" and msg.startswith(b"ok"):
2701 # STARTTLS ok, switch to secure mode
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002702 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002703 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002704 " client: read %r from server, starting TLS...\n"
2705 % msg)
Christian Heimesd0486372016-09-10 23:23:33 +02002706 conn = test_wrap_socket(s, ssl_version=ssl.PROTOCOL_TLSv1)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002707 wrapped = True
Antoine Pitrou480a1242010-04-28 21:37:09 +00002708 elif indata == b"ENDTLS" and msg.startswith(b"ok"):
2709 # ENDTLS ok, switch back to clear text
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002710 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002711 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002712 " client: read %r from server, ending TLS...\n"
2713 % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002714 s = conn.unwrap()
2715 wrapped = False
2716 else:
2717 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002718 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002719 " client: read %r from server\n" % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002720 if support.verbose:
2721 sys.stdout.write(" client: closing connection.\n")
2722 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002723 conn.write(b"over\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002724 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002725 s.send(b"over\n")
Bill Janssen6e027db2007-11-15 22:23:56 +00002726 if wrapped:
2727 conn.close()
2728 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002730
Antoine Pitrou480a1242010-04-28 21:37:09 +00002731 def test_socketserver(self):
Martin Panter463ef2b2016-09-22 09:37:56 +00002732 """Using socketserver to create and manage SSL connections."""
Antoine Pitrouda232592013-02-05 21:20:51 +01002733 server = make_https_server(self, certfile=CERTFILE)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002734 # try to connect
Antoine Pitrou803e6d62010-10-13 10:36:15 +00002735 if support.verbose:
2736 sys.stdout.write('\n')
2737 with open(CERTFILE, 'rb') as f:
2738 d1 = f.read()
2739 d2 = ''
2740 # now fetch the same data from the HTTPS server
Benjamin Peterson4ffb0752014-11-03 14:29:33 -05002741 url = 'https://localhost:%d/%s' % (
2742 server.port, os.path.split(CERTFILE)[1])
2743 context = ssl.create_default_context(cafile=CERTFILE)
2744 f = urllib.request.urlopen(url, context=context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002745 try:
Barry Warsaw820c1202008-06-12 04:06:45 +00002746 dlen = f.info().get("content-length")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002747 if dlen and (int(dlen) > 0):
2748 d2 = f.read(int(dlen))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002749 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002750 sys.stdout.write(
2751 " client: read %d bytes from remote server '%s'\n"
2752 % (len(d2), server))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002753 finally:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00002754 f.close()
2755 self.assertEqual(d1, d2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002756
Antoine Pitrou480a1242010-04-28 21:37:09 +00002757 def test_asyncore_server(self):
2758 """Check the example asyncore integration."""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002759 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002760 sys.stdout.write("\n")
2761
Antoine Pitrou480a1242010-04-28 21:37:09 +00002762 indata = b"FOO\n"
Trent Nelson78520002008-04-10 20:54:35 +00002763 server = AsyncoreEchoServer(CERTFILE)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002764 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002765 s = test_wrap_socket(socket.socket())
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002766 s.connect(('127.0.0.1', server.port))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002767 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002768 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002769 " client: sending %r...\n" % indata)
2770 s.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002771 outdata = s.read()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002772 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002773 sys.stdout.write(" client: read %r\n" % outdata)
Trent Nelson6b240cd2008-04-10 20:12:06 +00002774 if outdata != indata.lower():
Antoine Pitrou18c913e2010-04-27 10:59:39 +00002775 self.fail(
Antoine Pitrou480a1242010-04-28 21:37:09 +00002776 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
2777 % (outdata[:20], len(outdata),
2778 indata[:20].lower(), len(indata)))
2779 s.write(b"over\n")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002780 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00002781 sys.stdout.write(" client: closing connection.\n")
2782 s.close()
Antoine Pitroued986362010-08-15 23:28:10 +00002783 if support.verbose:
2784 sys.stdout.write(" client: connection closed.\n")
Trent Nelson6b240cd2008-04-10 20:12:06 +00002785
Antoine Pitrou480a1242010-04-28 21:37:09 +00002786 def test_recv_send(self):
2787 """Test recv(), send() and friends."""
Bill Janssen58afe4c2008-09-08 16:45:19 +00002788 if support.verbose:
2789 sys.stdout.write("\n")
2790
2791 server = ThreadedEchoServer(CERTFILE,
2792 certreqs=ssl.CERT_NONE,
2793 ssl_version=ssl.PROTOCOL_TLSv1,
2794 cacerts=CERTFILE,
2795 chatty=True,
2796 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002797 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002798 s = test_wrap_socket(socket.socket(),
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01002799 server_side=False,
2800 certfile=CERTFILE,
2801 ca_certs=CERTFILE,
2802 cert_reqs=ssl.CERT_NONE,
2803 ssl_version=ssl.PROTOCOL_TLSv1)
2804 s.connect((HOST, server.port))
Bill Janssen58afe4c2008-09-08 16:45:19 +00002805 # helper methods for standardising recv* method signatures
2806 def _recv_into():
2807 b = bytearray(b"\0"*100)
2808 count = s.recv_into(b)
2809 return b[:count]
2810
2811 def _recvfrom_into():
2812 b = bytearray(b"\0"*100)
2813 count, addr = s.recvfrom_into(b)
2814 return b[:count]
2815
Martin Panter519f9122016-04-03 02:12:54 +00002816 # (name, method, expect success?, *args, return value func)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002817 send_methods = [
Martin Panter519f9122016-04-03 02:12:54 +00002818 ('send', s.send, True, [], len),
2819 ('sendto', s.sendto, False, ["some.address"], len),
2820 ('sendall', s.sendall, True, [], lambda x: None),
Bill Janssen58afe4c2008-09-08 16:45:19 +00002821 ]
Martin Panter519f9122016-04-03 02:12:54 +00002822 # (name, method, whether to expect success, *args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002823 recv_methods = [
2824 ('recv', s.recv, True, []),
2825 ('recvfrom', s.recvfrom, False, ["some.address"]),
2826 ('recv_into', _recv_into, True, []),
2827 ('recvfrom_into', _recvfrom_into, False, []),
2828 ]
2829 data_prefix = "PREFIX_"
2830
Martin Panter519f9122016-04-03 02:12:54 +00002831 for (meth_name, send_meth, expect_success, args,
2832 ret_val_meth) in send_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002833 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00002834 try:
Martin Panter519f9122016-04-03 02:12:54 +00002835 ret = send_meth(indata, *args)
2836 msg = "sending with {}".format(meth_name)
2837 self.assertEqual(ret, ret_val_meth(indata), msg=msg)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002838 outdata = s.read()
Bill Janssen58afe4c2008-09-08 16:45:19 +00002839 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00002840 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002841 "While sending with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00002842 "<<{outdata:r}>> ({nout:d}) received; "
2843 "expected <<{indata:r}>> ({nin:d})\n".format(
2844 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00002845 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00002846 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002847 )
2848 )
2849 except ValueError as e:
2850 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00002851 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002852 "Failed to send with method <<{name:s}>>; "
2853 "expected to succeed.\n".format(name=meth_name)
2854 )
2855 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00002856 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002857 "Method <<{name:s}>> failed with unexpected "
2858 "exception message: {exp:s}\n".format(
2859 name=meth_name, exp=e
2860 )
2861 )
2862
2863 for meth_name, recv_meth, expect_success, args in recv_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002864 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00002865 try:
Antoine Pitrou480a1242010-04-28 21:37:09 +00002866 s.send(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002867 outdata = recv_meth(*args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002868 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00002869 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002870 "While receiving with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00002871 "<<{outdata:r}>> ({nout:d}) received; "
2872 "expected <<{indata:r}>> ({nin:d})\n".format(
2873 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00002874 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00002875 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00002876 )
2877 )
2878 except ValueError as e:
2879 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00002880 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002881 "Failed to receive with method <<{name:s}>>; "
2882 "expected to succeed.\n".format(name=meth_name)
2883 )
2884 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00002885 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00002886 "Method <<{name:s}>> failed with unexpected "
2887 "exception message: {exp:s}\n".format(
2888 name=meth_name, exp=e
2889 )
2890 )
2891 # consume data
2892 s.read()
2893
Martin Panterf6b1d662016-03-28 00:22:09 +00002894 # read(-1, buffer) is supported, even though read(-1) is not
Martin Panterbed7f1a2016-07-11 00:17:13 +00002895 data = b"data"
Martin Panter5503d472016-03-27 05:35:19 +00002896 s.send(data)
2897 buffer = bytearray(len(data))
2898 self.assertEqual(s.read(-1, buffer), len(data))
2899 self.assertEqual(buffer, data)
2900
Nick Coghlan513886a2011-08-28 00:00:27 +10002901 # Make sure sendmsg et al are disallowed to avoid
2902 # inadvertent disclosure of data and/or corruption
2903 # of the encrypted data stream
2904 self.assertRaises(NotImplementedError, s.sendmsg, [b"data"])
2905 self.assertRaises(NotImplementedError, s.recvmsg, 100)
2906 self.assertRaises(NotImplementedError,
2907 s.recvmsg_into, bytearray(100))
2908
Antoine Pitrou480a1242010-04-28 21:37:09 +00002909 s.write(b"over\n")
Martin Panter5503d472016-03-27 05:35:19 +00002910
2911 self.assertRaises(ValueError, s.recv, -1)
2912 self.assertRaises(ValueError, s.read, -1)
2913
Bill Janssen58afe4c2008-09-08 16:45:19 +00002914 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00002915
Martin Panterbed7f1a2016-07-11 00:17:13 +00002916 def test_recv_zero(self):
2917 server = ThreadedEchoServer(CERTFILE)
2918 server.__enter__()
2919 self.addCleanup(server.__exit__, None, None)
2920 s = socket.create_connection((HOST, server.port))
2921 self.addCleanup(s.close)
Christian Heimesd0486372016-09-10 23:23:33 +02002922 s = test_wrap_socket(s, suppress_ragged_eofs=False)
Martin Panterbed7f1a2016-07-11 00:17:13 +00002923 self.addCleanup(s.close)
2924
2925 # recv/read(0) should return no data
2926 s.send(b"data")
2927 self.assertEqual(s.recv(0), b"")
2928 self.assertEqual(s.read(0), b"")
2929 self.assertEqual(s.read(), b"data")
2930
2931 # Should not block if the other end sends no data
2932 s.setblocking(False)
2933 self.assertEqual(s.recv(0), b"")
2934 self.assertEqual(s.recv_into(bytearray()), 0)
2935
Antoine Pitroub4bebda2014-04-29 10:03:28 +02002936 def test_nonblocking_send(self):
2937 server = ThreadedEchoServer(CERTFILE,
2938 certreqs=ssl.CERT_NONE,
2939 ssl_version=ssl.PROTOCOL_TLSv1,
2940 cacerts=CERTFILE,
2941 chatty=True,
2942 connectionchatty=False)
2943 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02002944 s = test_wrap_socket(socket.socket(),
Antoine Pitroub4bebda2014-04-29 10:03:28 +02002945 server_side=False,
2946 certfile=CERTFILE,
2947 ca_certs=CERTFILE,
2948 cert_reqs=ssl.CERT_NONE,
2949 ssl_version=ssl.PROTOCOL_TLSv1)
2950 s.connect((HOST, server.port))
2951 s.setblocking(False)
2952
2953 # If we keep sending data, at some point the buffers
2954 # will be full and the call will block
2955 buf = bytearray(8192)
2956 def fill_buffer():
2957 while True:
2958 s.send(buf)
2959 self.assertRaises((ssl.SSLWantWriteError,
2960 ssl.SSLWantReadError), fill_buffer)
2961
2962 # Now read all the output and discard it
2963 s.setblocking(True)
2964 s.close()
2965
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002966 def test_handshake_timeout(self):
2967 # Issue #5103: SSL handshake must respect the socket timeout
2968 server = socket.socket(socket.AF_INET)
2969 host = "127.0.0.1"
2970 port = support.bind_port(server)
2971 started = threading.Event()
2972 finish = False
2973
2974 def serve():
Charles-François Natali6e204602014-07-23 19:28:13 +01002975 server.listen()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002976 started.set()
2977 conns = []
2978 while not finish:
2979 r, w, e = select.select([server], [], [], 0.1)
2980 if server in r:
2981 # Let the socket hang around rather than having
2982 # it closed by garbage collection.
2983 conns.append(server.accept()[0])
Antoine Pitroud2eca372010-10-29 23:41:37 +00002984 for sock in conns:
2985 sock.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00002986
2987 t = threading.Thread(target=serve)
2988 t.start()
2989 started.wait()
2990
2991 try:
Antoine Pitrou40f08742010-04-24 22:04:40 +00002992 try:
2993 c = socket.socket(socket.AF_INET)
2994 c.settimeout(0.2)
2995 c.connect((host, port))
2996 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002997 self.assertRaisesRegex(socket.timeout, "timed out",
Christian Heimesd0486372016-09-10 23:23:33 +02002998 test_wrap_socket, c)
Antoine Pitrou40f08742010-04-24 22:04:40 +00002999 finally:
3000 c.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00003001 try:
3002 c = socket.socket(socket.AF_INET)
Christian Heimesd0486372016-09-10 23:23:33 +02003003 c = test_wrap_socket(c)
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00003004 c.settimeout(0.2)
3005 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00003006 self.assertRaisesRegex(socket.timeout, "timed out",
Ezio Melottied3a7d22010-12-01 02:32:32 +00003007 c.connect, (host, port))
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00003008 finally:
3009 c.close()
3010 finally:
3011 finish = True
3012 t.join()
3013 server.close()
3014
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003015 def test_server_accept(self):
3016 # Issue #16357: accept() on a SSLSocket created through
3017 # SSLContext.wrap_socket().
3018 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3019 context.verify_mode = ssl.CERT_REQUIRED
3020 context.load_verify_locations(CERTFILE)
3021 context.load_cert_chain(CERTFILE)
3022 server = socket.socket(socket.AF_INET)
3023 host = "127.0.0.1"
3024 port = support.bind_port(server)
3025 server = context.wrap_socket(server, server_side=True)
Christian Heimesa5d07652016-09-24 10:48:05 +02003026 self.assertTrue(server.server_side)
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003027
3028 evt = threading.Event()
3029 remote = None
3030 peer = None
3031 def serve():
3032 nonlocal remote, peer
Charles-François Natali6e204602014-07-23 19:28:13 +01003033 server.listen()
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003034 # Block on the accept and wait on the connection to close.
3035 evt.set()
3036 remote, peer = server.accept()
3037 remote.recv(1)
3038
3039 t = threading.Thread(target=serve)
3040 t.start()
3041 # Client wait until server setup and perform a connect.
3042 evt.wait()
3043 client = context.wrap_socket(socket.socket())
3044 client.connect((host, port))
3045 client_addr = client.getsockname()
3046 client.close()
3047 t.join()
Antoine Pitroue1ceb502013-01-12 21:54:44 +01003048 remote.close()
3049 server.close()
Antoine Pitrou5c89b4e2012-11-11 01:25:36 +01003050 # Sanity checks.
3051 self.assertIsInstance(remote, ssl.SSLSocket)
3052 self.assertEqual(peer, client_addr)
3053
Antoine Pitrou242db722013-05-01 20:52:07 +02003054 def test_getpeercert_enotconn(self):
3055 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3056 with context.wrap_socket(socket.socket()) as sock:
3057 with self.assertRaises(OSError) as cm:
3058 sock.getpeercert()
3059 self.assertEqual(cm.exception.errno, errno.ENOTCONN)
3060
3061 def test_do_handshake_enotconn(self):
3062 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3063 with context.wrap_socket(socket.socket()) as sock:
3064 with self.assertRaises(OSError) as cm:
3065 sock.do_handshake()
3066 self.assertEqual(cm.exception.errno, errno.ENOTCONN)
3067
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003068 def test_default_ciphers(self):
3069 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3070 try:
3071 # Force a set of weak ciphers on our client context
3072 context.set_ciphers("DES")
3073 except ssl.SSLError:
3074 self.skipTest("no DES cipher available")
3075 with ThreadedEchoServer(CERTFILE,
3076 ssl_version=ssl.PROTOCOL_SSLv23,
3077 chatty=False) as server:
Antoine Pitroue1ceb502013-01-12 21:54:44 +01003078 with context.wrap_socket(socket.socket()) as s:
Andrew Svetlov0832af62012-12-18 23:10:48 +02003079 with self.assertRaises(OSError):
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003080 s.connect((HOST, server.port))
Victor Stinner86871012017-09-02 00:26:17 +02003081 self.assertIn("no shared cipher", server.conn_errors[0])
Antoine Pitrou8f85f902012-01-03 22:46:48 +01003082
Antoine Pitrou47e40422014-09-04 21:00:10 +02003083 def test_version_basic(self):
3084 """
3085 Basic tests for SSLSocket.version().
3086 More tests are done in the test_protocol_*() methods.
3087 """
3088 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3089 with ThreadedEchoServer(CERTFILE,
3090 ssl_version=ssl.PROTOCOL_TLSv1,
3091 chatty=False) as server:
3092 with context.wrap_socket(socket.socket()) as s:
3093 self.assertIs(s.version(), None)
3094 s.connect((HOST, server.port))
Christian Heimes598894f2016-09-05 23:19:05 +02003095 self.assertEqual(s.version(), 'TLSv1')
Antoine Pitrou47e40422014-09-04 21:00:10 +02003096 self.assertIs(s.version(), None)
3097
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003098 @unittest.skipUnless(ssl.HAS_ECDH, "test requires ECDH-enabled OpenSSL")
3099 def test_default_ecdh_curve(self):
3100 # Issue #21015: elliptic curve-based Diffie Hellman key exchange
3101 # should be enabled by default on SSL contexts.
3102 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3103 context.load_cert_chain(CERTFILE)
Antoine Pitrouc0430612014-04-16 18:33:39 +02003104 # Prior to OpenSSL 1.0.0, ECDH ciphers have to be enabled
3105 # explicitly using the 'ECCdraft' cipher alias. Otherwise,
3106 # our default cipher list should prefer ECDH-based ciphers
3107 # automatically.
3108 if ssl.OPENSSL_VERSION_INFO < (1, 0, 0):
3109 context.set_ciphers("ECCdraft:ECDH")
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003110 with ThreadedEchoServer(context=context) as server:
3111 with context.wrap_socket(socket.socket()) as s:
3112 s.connect((HOST, server.port))
3113 self.assertIn("ECDH", s.cipher()[0])
3114
Antoine Pitroud6494802011-07-21 01:11:30 +02003115 @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
3116 "'tls-unique' channel binding not available")
3117 def test_tls_unique_channel_binding(self):
3118 """Test tls-unique channel binding."""
3119 if support.verbose:
3120 sys.stdout.write("\n")
3121
3122 server = ThreadedEchoServer(CERTFILE,
3123 certreqs=ssl.CERT_NONE,
3124 ssl_version=ssl.PROTOCOL_TLSv1,
3125 cacerts=CERTFILE,
3126 chatty=True,
3127 connectionchatty=False)
Antoine Pitrou6b15c902011-12-21 16:54:45 +01003128 with server:
Christian Heimesd0486372016-09-10 23:23:33 +02003129 s = test_wrap_socket(socket.socket(),
Antoine Pitrou6b15c902011-12-21 16:54:45 +01003130 server_side=False,
3131 certfile=CERTFILE,
3132 ca_certs=CERTFILE,
3133 cert_reqs=ssl.CERT_NONE,
3134 ssl_version=ssl.PROTOCOL_TLSv1)
3135 s.connect((HOST, server.port))
Antoine Pitroud6494802011-07-21 01:11:30 +02003136 # get the data
3137 cb_data = s.get_channel_binding("tls-unique")
3138 if support.verbose:
3139 sys.stdout.write(" got channel binding data: {0!r}\n"
3140 .format(cb_data))
3141
3142 # check if it is sane
3143 self.assertIsNotNone(cb_data)
3144 self.assertEqual(len(cb_data), 12) # True for TLSv1
3145
3146 # and compare with the peers version
3147 s.write(b"CB tls-unique\n")
3148 peer_data_repr = s.read().strip()
3149 self.assertEqual(peer_data_repr,
3150 repr(cb_data).encode("us-ascii"))
3151 s.close()
3152
3153 # now, again
Christian Heimesd0486372016-09-10 23:23:33 +02003154 s = test_wrap_socket(socket.socket(),
Antoine Pitroud6494802011-07-21 01:11:30 +02003155 server_side=False,
3156 certfile=CERTFILE,
3157 ca_certs=CERTFILE,
3158 cert_reqs=ssl.CERT_NONE,
3159 ssl_version=ssl.PROTOCOL_TLSv1)
3160 s.connect((HOST, server.port))
3161 new_cb_data = s.get_channel_binding("tls-unique")
3162 if support.verbose:
3163 sys.stdout.write(" got another channel binding data: {0!r}\n"
3164 .format(new_cb_data))
3165 # is it really unique
3166 self.assertNotEqual(cb_data, new_cb_data)
3167 self.assertIsNotNone(cb_data)
3168 self.assertEqual(len(cb_data), 12) # True for TLSv1
3169 s.write(b"CB tls-unique\n")
3170 peer_data_repr = s.read().strip()
3171 self.assertEqual(peer_data_repr,
3172 repr(new_cb_data).encode("us-ascii"))
3173 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00003174
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003175 def test_compression(self):
3176 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3177 context.load_cert_chain(CERTFILE)
3178 stats = server_params_test(context, context,
3179 chatty=True, connectionchatty=True)
3180 if support.verbose:
3181 sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
3182 self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
3183
3184 @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
3185 "ssl.OP_NO_COMPRESSION needed for this test")
3186 def test_compression_disabled(self):
3187 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3188 context.load_cert_chain(CERTFILE)
Antoine Pitrou8691bff2011-12-20 10:47:42 +01003189 context.options |= ssl.OP_NO_COMPRESSION
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003190 stats = server_params_test(context, context,
3191 chatty=True, connectionchatty=True)
3192 self.assertIs(stats['compression'], None)
3193
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003194 def test_dh_params(self):
3195 # Check we can get a connection with ephemeral Diffie-Hellman
3196 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3197 context.load_cert_chain(CERTFILE)
3198 context.load_dh_params(DHFILE)
3199 context.set_ciphers("kEDH")
3200 stats = server_params_test(context, context,
3201 chatty=True, connectionchatty=True)
3202 cipher = stats["cipher"][0]
3203 parts = cipher.split("-")
3204 if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
3205 self.fail("Non-DH cipher: " + cipher[0])
3206
Benjamin Petersoncca27322015-01-23 16:35:37 -05003207 def test_selected_alpn_protocol(self):
3208 # selected_alpn_protocol() is None unless ALPN is used.
3209 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3210 context.load_cert_chain(CERTFILE)
3211 stats = server_params_test(context, context,
3212 chatty=True, connectionchatty=True)
3213 self.assertIs(stats['client_alpn_protocol'], None)
3214
3215 @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support required")
3216 def test_selected_alpn_protocol_if_server_uses_alpn(self):
3217 # selected_alpn_protocol() is None unless ALPN is used by the client.
3218 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3219 client_context.load_verify_locations(CERTFILE)
3220 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3221 server_context.load_cert_chain(CERTFILE)
3222 server_context.set_alpn_protocols(['foo', 'bar'])
3223 stats = server_params_test(client_context, server_context,
3224 chatty=True, connectionchatty=True)
3225 self.assertIs(stats['client_alpn_protocol'], None)
3226
3227 @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support needed for this test")
3228 def test_alpn_protocols(self):
3229 server_protocols = ['foo', 'bar', 'milkshake']
3230 protocol_tests = [
3231 (['foo', 'bar'], 'foo'),
Benjamin Peterson88615022015-01-23 17:30:26 -05003232 (['bar', 'foo'], 'foo'),
Benjamin Petersoncca27322015-01-23 16:35:37 -05003233 (['milkshake'], 'milkshake'),
Benjamin Peterson88615022015-01-23 17:30:26 -05003234 (['http/3.0', 'http/4.0'], None)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003235 ]
3236 for client_protocols, expected in protocol_tests:
Christian Heimes598894f2016-09-05 23:19:05 +02003237 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003238 server_context.load_cert_chain(CERTFILE)
3239 server_context.set_alpn_protocols(server_protocols)
Christian Heimes598894f2016-09-05 23:19:05 +02003240 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003241 client_context.load_cert_chain(CERTFILE)
3242 client_context.set_alpn_protocols(client_protocols)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003243
Christian Heimes598894f2016-09-05 23:19:05 +02003244 try:
3245 stats = server_params_test(client_context,
3246 server_context,
3247 chatty=True,
3248 connectionchatty=True)
3249 except ssl.SSLError as e:
3250 stats = e
3251
Christian Heimes7b40cb72017-08-15 10:33:43 +02003252 if (expected is None and IS_OPENSSL_1_1
3253 and ssl.OPENSSL_VERSION_INFO < (1, 1, 0, 6)):
3254 # OpenSSL 1.1.0 to 1.1.0e raises handshake error
Christian Heimes598894f2016-09-05 23:19:05 +02003255 self.assertIsInstance(stats, ssl.SSLError)
3256 else:
3257 msg = "failed trying %s (s) and %s (c).\n" \
3258 "was expecting %s, but got %%s from the %%s" \
3259 % (str(server_protocols), str(client_protocols),
3260 str(expected))
3261 client_result = stats['client_alpn_protocol']
3262 self.assertEqual(client_result, expected,
3263 msg % (client_result, "client"))
3264 server_result = stats['server_alpn_protocols'][-1] \
3265 if len(stats['server_alpn_protocols']) else 'nothing'
3266 self.assertEqual(server_result, expected,
3267 msg % (server_result, "server"))
Benjamin Petersoncca27322015-01-23 16:35:37 -05003268
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003269 def test_selected_npn_protocol(self):
3270 # selected_npn_protocol() is None unless NPN is used
3271 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3272 context.load_cert_chain(CERTFILE)
3273 stats = server_params_test(context, context,
3274 chatty=True, connectionchatty=True)
3275 self.assertIs(stats['client_npn_protocol'], None)
3276
3277 @unittest.skipUnless(ssl.HAS_NPN, "NPN support needed for this test")
3278 def test_npn_protocols(self):
3279 server_protocols = ['http/1.1', 'spdy/2']
3280 protocol_tests = [
3281 (['http/1.1', 'spdy/2'], 'http/1.1'),
3282 (['spdy/2', 'http/1.1'], 'http/1.1'),
3283 (['spdy/2', 'test'], 'spdy/2'),
3284 (['abc', 'def'], 'abc')
3285 ]
3286 for client_protocols, expected in protocol_tests:
3287 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3288 server_context.load_cert_chain(CERTFILE)
3289 server_context.set_npn_protocols(server_protocols)
3290 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3291 client_context.load_cert_chain(CERTFILE)
3292 client_context.set_npn_protocols(client_protocols)
3293 stats = server_params_test(client_context, server_context,
3294 chatty=True, connectionchatty=True)
3295
3296 msg = "failed trying %s (s) and %s (c).\n" \
3297 "was expecting %s, but got %%s from the %%s" \
3298 % (str(server_protocols), str(client_protocols),
3299 str(expected))
3300 client_result = stats['client_npn_protocol']
3301 self.assertEqual(client_result, expected, msg % (client_result, "client"))
3302 server_result = stats['server_npn_protocols'][-1] \
3303 if len(stats['server_npn_protocols']) else 'nothing'
3304 self.assertEqual(server_result, expected, msg % (server_result, "server"))
3305
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003306 def sni_contexts(self):
3307 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3308 server_context.load_cert_chain(SIGNED_CERTFILE)
3309 other_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3310 other_context.load_cert_chain(SIGNED_CERTFILE2)
3311 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3312 client_context.verify_mode = ssl.CERT_REQUIRED
3313 client_context.load_verify_locations(SIGNING_CA)
3314 return server_context, other_context, client_context
3315
3316 def check_common_name(self, stats, name):
3317 cert = stats['peercert']
3318 self.assertIn((('commonName', name),), cert['subject'])
3319
3320 @needs_sni
3321 def test_sni_callback(self):
3322 calls = []
3323 server_context, other_context, client_context = self.sni_contexts()
3324
3325 def servername_cb(ssl_sock, server_name, initial_context):
3326 calls.append((server_name, initial_context))
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003327 if server_name is not None:
3328 ssl_sock.context = other_context
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003329 server_context.set_servername_callback(servername_cb)
3330
3331 stats = server_params_test(client_context, server_context,
3332 chatty=True,
3333 sni_name='supermessage')
3334 # The hostname was fetched properly, and the certificate was
3335 # changed for the connection.
3336 self.assertEqual(calls, [("supermessage", server_context)])
3337 # CERTFILE4 was selected
3338 self.check_common_name(stats, 'fakehostname')
3339
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003340 calls = []
3341 # The callback is called with server_name=None
3342 stats = server_params_test(client_context, server_context,
3343 chatty=True,
3344 sni_name=None)
3345 self.assertEqual(calls, [(None, server_context)])
3346 self.check_common_name(stats, 'localhost')
3347
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003348 # Check disabling the callback
3349 calls = []
3350 server_context.set_servername_callback(None)
3351
3352 stats = server_params_test(client_context, server_context,
3353 chatty=True,
3354 sni_name='notfunny')
3355 # Certificate didn't change
3356 self.check_common_name(stats, 'localhost')
3357 self.assertEqual(calls, [])
3358
3359 @needs_sni
3360 def test_sni_callback_alert(self):
3361 # Returning a TLS alert is reflected to the connecting client
3362 server_context, other_context, client_context = self.sni_contexts()
3363
3364 def cb_returning_alert(ssl_sock, server_name, initial_context):
3365 return ssl.ALERT_DESCRIPTION_ACCESS_DENIED
3366 server_context.set_servername_callback(cb_returning_alert)
3367
3368 with self.assertRaises(ssl.SSLError) as cm:
3369 stats = server_params_test(client_context, server_context,
3370 chatty=False,
3371 sni_name='supermessage')
3372 self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_ACCESS_DENIED')
3373
3374 @needs_sni
3375 def test_sni_callback_raising(self):
3376 # Raising fails the connection with a TLS handshake failure alert.
3377 server_context, other_context, client_context = self.sni_contexts()
3378
3379 def cb_raising(ssl_sock, server_name, initial_context):
3380 1/0
3381 server_context.set_servername_callback(cb_raising)
3382
3383 with self.assertRaises(ssl.SSLError) as cm, \
3384 support.captured_stderr() as stderr:
3385 stats = server_params_test(client_context, server_context,
3386 chatty=False,
3387 sni_name='supermessage')
3388 self.assertEqual(cm.exception.reason, 'SSLV3_ALERT_HANDSHAKE_FAILURE')
3389 self.assertIn("ZeroDivisionError", stderr.getvalue())
3390
3391 @needs_sni
3392 def test_sni_callback_wrong_return_type(self):
3393 # Returning the wrong return type terminates the TLS connection
3394 # with an internal error alert.
3395 server_context, other_context, client_context = self.sni_contexts()
3396
3397 def cb_wrong_return_type(ssl_sock, server_name, initial_context):
3398 return "foo"
3399 server_context.set_servername_callback(cb_wrong_return_type)
3400
3401 with self.assertRaises(ssl.SSLError) as cm, \
3402 support.captured_stderr() as stderr:
3403 stats = server_params_test(client_context, server_context,
3404 chatty=False,
3405 sni_name='supermessage')
3406 self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_INTERNAL_ERROR')
3407 self.assertIn("TypeError", stderr.getvalue())
3408
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003409 def test_shared_ciphers(self):
Benjamin Petersonaacd5242015-01-07 11:42:38 -06003410 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Benjamin Peterson15042922015-01-07 22:12:43 -06003411 server_context.load_cert_chain(SIGNED_CERTFILE)
3412 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3413 client_context.verify_mode = ssl.CERT_REQUIRED
3414 client_context.load_verify_locations(SIGNING_CA)
Christian Heimes598894f2016-09-05 23:19:05 +02003415 if ssl.OPENSSL_VERSION_INFO >= (1, 0, 2):
3416 client_context.set_ciphers("AES128:AES256")
3417 server_context.set_ciphers("AES256")
3418 alg1 = "AES256"
3419 alg2 = "AES-256"
3420 else:
3421 client_context.set_ciphers("AES:3DES")
3422 server_context.set_ciphers("3DES")
3423 alg1 = "3DES"
3424 alg2 = "DES-CBC3"
3425
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003426 stats = server_params_test(client_context, server_context)
3427 ciphers = stats['server_shared_ciphers'][0]
3428 self.assertGreater(len(ciphers), 0)
3429 for name, tls_version, bits in ciphers:
Christian Heimes598894f2016-09-05 23:19:05 +02003430 if not alg1 in name.split("-") and alg2 not in name:
3431 self.fail(name)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06003432
Antoine Pitrou60a26e02013-07-20 19:35:16 +02003433 def test_read_write_after_close_raises_valuerror(self):
3434 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3435 context.verify_mode = ssl.CERT_REQUIRED
3436 context.load_verify_locations(CERTFILE)
3437 context.load_cert_chain(CERTFILE)
3438 server = ThreadedEchoServer(context=context, chatty=False)
3439
3440 with server:
3441 s = context.wrap_socket(socket.socket())
3442 s.connect((HOST, server.port))
3443 s.close()
3444
3445 self.assertRaises(ValueError, s.read, 1024)
Antoine Pitrou28940732013-07-20 19:36:15 +02003446 self.assertRaises(ValueError, s.write, b'hello')
Antoine Pitrou60a26e02013-07-20 19:35:16 +02003447
Giampaolo Rodola'915d1412014-06-11 03:54:30 +02003448 def test_sendfile(self):
3449 TEST_DATA = b"x" * 512
3450 with open(support.TESTFN, 'wb') as f:
3451 f.write(TEST_DATA)
3452 self.addCleanup(support.unlink, support.TESTFN)
3453 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3454 context.verify_mode = ssl.CERT_REQUIRED
3455 context.load_verify_locations(CERTFILE)
3456 context.load_cert_chain(CERTFILE)
3457 server = ThreadedEchoServer(context=context, chatty=False)
3458 with server:
3459 with context.wrap_socket(socket.socket()) as s:
3460 s.connect((HOST, server.port))
3461 with open(support.TESTFN, 'rb') as file:
3462 s.sendfile(file)
3463 self.assertEqual(s.recv(1024), TEST_DATA)
3464
Christian Heimes99a65702016-09-10 23:44:53 +02003465 def test_session(self):
3466 server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3467 server_context.load_cert_chain(SIGNED_CERTFILE)
3468 client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
3469 client_context.verify_mode = ssl.CERT_REQUIRED
3470 client_context.load_verify_locations(SIGNING_CA)
3471
Martin Panterb1321fb2016-10-10 00:38:21 +00003472 # first connection without session
Christian Heimes99a65702016-09-10 23:44:53 +02003473 stats = server_params_test(client_context, server_context)
3474 session = stats['session']
3475 self.assertTrue(session.id)
3476 self.assertGreater(session.time, 0)
3477 self.assertGreater(session.timeout, 0)
3478 self.assertTrue(session.has_ticket)
3479 if ssl.OPENSSL_VERSION_INFO > (1, 0, 1):
3480 self.assertGreater(session.ticket_lifetime_hint, 0)
3481 self.assertFalse(stats['session_reused'])
3482 sess_stat = server_context.session_stats()
3483 self.assertEqual(sess_stat['accept'], 1)
3484 self.assertEqual(sess_stat['hits'], 0)
3485
3486 # reuse session
3487 stats = server_params_test(client_context, server_context, session=session)
3488 sess_stat = server_context.session_stats()
3489 self.assertEqual(sess_stat['accept'], 2)
3490 self.assertEqual(sess_stat['hits'], 1)
3491 self.assertTrue(stats['session_reused'])
3492 session2 = stats['session']
3493 self.assertEqual(session2.id, session.id)
3494 self.assertEqual(session2, session)
3495 self.assertIsNot(session2, session)
3496 self.assertGreaterEqual(session2.time, session.time)
3497 self.assertGreaterEqual(session2.timeout, session.timeout)
3498
3499 # another one without session
3500 stats = server_params_test(client_context, server_context)
3501 self.assertFalse(stats['session_reused'])
3502 session3 = stats['session']
3503 self.assertNotEqual(session3.id, session.id)
3504 self.assertNotEqual(session3, session)
3505 sess_stat = server_context.session_stats()
3506 self.assertEqual(sess_stat['accept'], 3)
3507 self.assertEqual(sess_stat['hits'], 1)
3508
3509 # reuse session again
3510 stats = server_params_test(client_context, server_context, session=session)
3511 self.assertTrue(stats['session_reused'])
3512 session4 = stats['session']
3513 self.assertEqual(session4.id, session.id)
3514 self.assertEqual(session4, session)
3515 self.assertGreaterEqual(session4.time, session.time)
3516 self.assertGreaterEqual(session4.timeout, session.timeout)
3517 sess_stat = server_context.session_stats()
3518 self.assertEqual(sess_stat['accept'], 4)
3519 self.assertEqual(sess_stat['hits'], 2)
3520
3521 def test_session_handling(self):
3522 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3523 context.verify_mode = ssl.CERT_REQUIRED
3524 context.load_verify_locations(CERTFILE)
3525 context.load_cert_chain(CERTFILE)
3526
3527 context2 = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
3528 context2.verify_mode = ssl.CERT_REQUIRED
3529 context2.load_verify_locations(CERTFILE)
3530 context2.load_cert_chain(CERTFILE)
3531
3532 server = ThreadedEchoServer(context=context, chatty=False)
3533 with server:
3534 with context.wrap_socket(socket.socket()) as s:
3535 # session is None before handshake
3536 self.assertEqual(s.session, None)
3537 self.assertEqual(s.session_reused, None)
3538 s.connect((HOST, server.port))
3539 session = s.session
3540 self.assertTrue(session)
3541 with self.assertRaises(TypeError) as e:
3542 s.session = object
3543 self.assertEqual(str(e.exception), 'Value is not a SSLSession.')
3544
3545 with context.wrap_socket(socket.socket()) as s:
3546 s.connect((HOST, server.port))
3547 # cannot set session after handshake
3548 with self.assertRaises(ValueError) as e:
3549 s.session = session
3550 self.assertEqual(str(e.exception),
3551 'Cannot set session after handshake.')
3552
3553 with context.wrap_socket(socket.socket()) as s:
3554 # can set session before handshake and before the
3555 # connection was established
3556 s.session = session
3557 s.connect((HOST, server.port))
3558 self.assertEqual(s.session.id, session.id)
3559 self.assertEqual(s.session, session)
3560 self.assertEqual(s.session_reused, True)
3561
3562 with context2.wrap_socket(socket.socket()) as s:
3563 # cannot re-use session with a different SSLContext
3564 with self.assertRaises(ValueError) as e:
3565 s.session = session
3566 s.connect((HOST, server.port))
3567 self.assertEqual(str(e.exception),
3568 'Session refers to a different SSLContext.')
3569
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01003570
Thomas Woutersed03b412007-08-28 21:37:11 +00003571def test_main(verbose=False):
Antoine Pitrou15cee622010-08-04 16:45:21 +00003572 if support.verbose:
Berker Peksag9e7990a2015-05-16 23:21:26 +03003573 import warnings
Antoine Pitrou15cee622010-08-04 16:45:21 +00003574 plats = {
3575 'Linux': platform.linux_distribution,
3576 'Mac': platform.mac_ver,
3577 'Windows': platform.win32_ver,
3578 }
Berker Peksag9e7990a2015-05-16 23:21:26 +03003579 with warnings.catch_warnings():
3580 warnings.filterwarnings(
3581 'ignore',
R David Murray44b548d2016-09-08 13:59:53 -04003582 r'dist\(\) and linux_distribution\(\) '
Berker Peksag9e7990a2015-05-16 23:21:26 +03003583 'functions are deprecated .*',
3584 PendingDeprecationWarning,
3585 )
3586 for name, func in plats.items():
3587 plat = func()
3588 if plat and plat[0]:
3589 plat = '%s %r' % (name, plat)
3590 break
3591 else:
3592 plat = repr(platform.platform())
Antoine Pitrou15cee622010-08-04 16:45:21 +00003593 print("test_ssl: testing with %r %r" %
3594 (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
3595 print(" under %s" % plat)
Antoine Pitroud5323212010-10-22 18:19:07 +00003596 print(" HAS_SNI = %r" % ssl.HAS_SNI)
Antoine Pitrou609ef012013-03-29 18:09:06 +01003597 print(" OP_ALL = 0x%8x" % ssl.OP_ALL)
3598 try:
3599 print(" OP_NO_TLSv1_1 = 0x%8x" % ssl.OP_NO_TLSv1_1)
3600 except AttributeError:
3601 pass
Antoine Pitrou15cee622010-08-04 16:45:21 +00003602
Antoine Pitrou152efa22010-05-16 18:19:27 +00003603 for filename in [
Martin Panter3840b2a2016-03-27 01:53:46 +00003604 CERTFILE, BYTES_CERTFILE,
Antoine Pitrou152efa22010-05-16 18:19:27 +00003605 ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003606 SIGNED_CERTFILE, SIGNED_CERTFILE2, SIGNING_CA,
Antoine Pitrou152efa22010-05-16 18:19:27 +00003607 BADCERT, BADKEY, EMPTYCERT]:
3608 if not os.path.exists(filename):
3609 raise support.TestFailed("Can't read certificate file %r" % filename)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003610
Martin Panter3840b2a2016-03-27 01:53:46 +00003611 tests = [
3612 ContextTests, BasicSocketTests, SSLErrorTests, MemoryBIOTests,
3613 SimpleBackgroundTests,
3614 ]
Thomas Woutersed03b412007-08-28 21:37:11 +00003615
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003616 if support.is_resource_enabled('network'):
Bill Janssen6e027db2007-11-15 22:23:56 +00003617 tests.append(NetworkedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00003618
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003619 if _have_threads:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003620 thread_info = support.threading_setup()
Antoine Pitroudb5012a2013-01-12 22:00:09 +01003621 if thread_info:
Bill Janssen6e027db2007-11-15 22:23:56 +00003622 tests.append(ThreadedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00003623
Antoine Pitrou480a1242010-04-28 21:37:09 +00003624 try:
3625 support.run_unittest(*tests)
3626 finally:
3627 if _have_threads:
3628 support.threading_cleanup(*thread_info)
Thomas Woutersed03b412007-08-28 21:37:11 +00003629
3630if __name__ == "__main__":
3631 test_main()