blob: a4bcdd017ea94adc67cf0d508d69862445b2acda [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
Antoine Pitroucfcd8ad2010-04-23 23:31:47 +00009import gc
Thomas Woutersed03b412007-08-28 21:37:11 +000010import os
Antoine Pitroucfcd8ad2010-04-23 23:31:47 +000011import errno
Thomas Woutersed03b412007-08-28 21:37:11 +000012import pprint
Antoine Pitrou152efa22010-05-16 18:19:27 +000013import tempfile
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
23PROTOCOLS = [
Victor Stinner3de49192011-05-09 00:42:58 +020024 ssl.PROTOCOL_SSLv3,
Antoine Pitrou05d936d2010-10-13 11:38:36 +000025 ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1
26]
Victor Stinner3de49192011-05-09 00:42:58 +020027if hasattr(ssl, 'PROTOCOL_SSLv2'):
28 PROTOCOLS.append(ssl.PROTOCOL_SSLv2)
Thomas Woutersed03b412007-08-28 21:37:11 +000029
Benjamin Petersonee8712c2008-05-20 21:35:26 +000030HOST = support.HOST
Antoine Pitrou152efa22010-05-16 18:19:27 +000031
32data_file = lambda name: os.path.join(os.path.dirname(__file__), name)
Antoine Pitrou152efa22010-05-16 18:19:27 +000033
Antoine Pitrou81564092010-10-08 23:06:24 +000034# The custom key and certificate files used in test_ssl are generated
35# using Lib/test/make_ssl_certs.py.
36# Other certificates are simply fetched from the Internet servers they
37# are meant to authenticate.
38
Antoine Pitrou152efa22010-05-16 18:19:27 +000039CERTFILE = data_file("keycert.pem")
Victor Stinner313a1202010-06-11 23:56:51 +000040BYTES_CERTFILE = os.fsencode(CERTFILE)
Antoine Pitrou152efa22010-05-16 18:19:27 +000041ONLYCERT = data_file("ssl_cert.pem")
42ONLYKEY = data_file("ssl_key.pem")
Victor Stinner313a1202010-06-11 23:56:51 +000043BYTES_ONLYCERT = os.fsencode(ONLYCERT)
44BYTES_ONLYKEY = os.fsencode(ONLYKEY)
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020045CERTFILE_PROTECTED = data_file("keycert.passwd.pem")
46ONLYKEY_PROTECTED = data_file("ssl_key.passwd.pem")
47KEY_PASSWORD = "somepass"
Antoine Pitrou152efa22010-05-16 18:19:27 +000048CAPATH = data_file("capath")
Victor Stinner313a1202010-06-11 23:56:51 +000049BYTES_CAPATH = os.fsencode(CAPATH)
Antoine Pitrou152efa22010-05-16 18:19:27 +000050
51SVN_PYTHON_ORG_ROOT_CERT = data_file("https_svn_python_org_root.pem")
52
53EMPTYCERT = data_file("nullcert.pem")
54BADCERT = data_file("badcert.pem")
55WRONGCERT = data_file("XXXnonexisting.pem")
56BADKEY = data_file("badkey.pem")
Antoine Pitroud8c347a2011-10-01 19:20:25 +020057NOKIACERT = data_file("nokia.pem")
Antoine Pitrou152efa22010-05-16 18:19:27 +000058
Antoine Pitrou0e576f12011-12-22 10:03:38 +010059DHFILE = data_file("dh512.pem")
60BYTES_DHFILE = os.fsencode(DHFILE)
Thomas Woutersed03b412007-08-28 21:37:11 +000061
Thomas Woutersed03b412007-08-28 21:37:11 +000062def handle_error(prefix):
63 exc_format = ' '.join(traceback.format_exception(*sys.exc_info()))
Benjamin Petersonee8712c2008-05-20 21:35:26 +000064 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +000065 sys.stdout.write(prefix + exc_format)
Thomas Woutersed03b412007-08-28 21:37:11 +000066
Antoine Pitroub5218772010-05-21 09:56:06 +000067def can_clear_options():
68 # 0.9.8m or higher
Antoine Pitroub9ac25d2011-07-08 18:47:06 +020069 return ssl._OPENSSL_API_VERSION >= (0, 9, 8, 13, 15)
Antoine Pitroub5218772010-05-21 09:56:06 +000070
71def no_sslv2_implies_sslv3_hello():
72 # 0.9.7h or higher
73 return ssl.OPENSSL_VERSION_INFO >= (0, 9, 7, 8, 15)
74
Thomas Woutersed03b412007-08-28 21:37:11 +000075
Antoine Pitrou23df4832010-08-04 17:14:06 +000076# Issue #9415: Ubuntu hijacks their OpenSSL and forcefully disables SSLv2
77def skip_if_broken_ubuntu_ssl(func):
Victor Stinner3de49192011-05-09 00:42:58 +020078 if hasattr(ssl, 'PROTOCOL_SSLv2'):
79 @functools.wraps(func)
80 def f(*args, **kwargs):
81 try:
82 ssl.SSLContext(ssl.PROTOCOL_SSLv2)
83 except ssl.SSLError:
84 if (ssl.OPENSSL_VERSION_INFO == (0, 9, 8, 15, 15) and
85 platform.linux_distribution() == ('debian', 'squeeze/sid', '')):
86 raise unittest.SkipTest("Patched Ubuntu OpenSSL breaks behaviour")
87 return func(*args, **kwargs)
88 return f
89 else:
90 return func
Antoine Pitrou23df4832010-08-04 17:14:06 +000091
92
Antoine Pitrou152efa22010-05-16 18:19:27 +000093class BasicSocketTests(unittest.TestCase):
Thomas Woutersed03b412007-08-28 21:37:11 +000094
Antoine Pitrou480a1242010-04-28 21:37:09 +000095 def test_constants(self):
Victor Stinner3de49192011-05-09 00:42:58 +020096 #ssl.PROTOCOL_SSLv2
Thomas Wouters1b7f8912007-09-19 03:06:30 +000097 ssl.PROTOCOL_SSLv23
98 ssl.PROTOCOL_SSLv3
99 ssl.PROTOCOL_TLSv1
100 ssl.CERT_NONE
101 ssl.CERT_OPTIONAL
102 ssl.CERT_REQUIRED
Antoine Pitrou6db49442011-12-19 13:27:11 +0100103 ssl.OP_CIPHER_SERVER_PREFERENCE
Antoine Pitrou0e576f12011-12-22 10:03:38 +0100104 ssl.OP_SINGLE_DH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +0100105 ssl.OP_SINGLE_ECDH_USE
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +0100106 if ssl.OPENSSL_VERSION_INFO >= (1, 0):
107 ssl.OP_NO_COMPRESSION
Antoine Pitroud5323212010-10-22 18:19:07 +0000108 self.assertIn(ssl.HAS_SNI, {True, False})
Antoine Pitrou501da612011-12-21 09:27:41 +0100109 self.assertIn(ssl.HAS_ECDH, {True, False})
Thomas Woutersed03b412007-08-28 21:37:11 +0000110
Antoine Pitrou480a1242010-04-28 21:37:09 +0000111 def test_random(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000112 v = ssl.RAND_status()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000113 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000114 sys.stdout.write("\n RAND_status is %d (%s)\n"
115 % (v, (v and "sufficient randomness") or
116 "insufficient randomness"))
Victor Stinner99c8b162011-05-24 12:05:19 +0200117
118 data, is_cryptographic = ssl.RAND_pseudo_bytes(16)
119 self.assertEqual(len(data), 16)
120 self.assertEqual(is_cryptographic, v == 1)
121 if v:
122 data = ssl.RAND_bytes(16)
123 self.assertEqual(len(data), 16)
Victor Stinner2e2baa92011-05-25 11:15:16 +0200124 else:
125 self.assertRaises(ssl.SSLError, ssl.RAND_bytes, 16)
Victor Stinner99c8b162011-05-24 12:05:19 +0200126
Thomas Woutersed03b412007-08-28 21:37:11 +0000127 try:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000128 ssl.RAND_egd(1)
129 except TypeError:
130 pass
Thomas Woutersed03b412007-08-28 21:37:11 +0000131 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000132 print("didn't raise TypeError")
133 ssl.RAND_add("this is a random string", 75.0)
Thomas Woutersed03b412007-08-28 21:37:11 +0000134
Antoine Pitrou480a1242010-04-28 21:37:09 +0000135 def test_parse_cert(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000136 # note that this uses an 'unofficial' function in _ssl.c,
137 # provided solely for this test, to exercise the certificate
138 # parsing code
Antoine Pitroufb046912010-11-09 20:21:19 +0000139 p = ssl._ssl._test_decode_cert(CERTFILE)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000140 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000141 sys.stdout.write("\n" + pprint.pformat(p) + "\n")
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200142 self.assertEqual(p['issuer'],
143 ((('countryName', 'XY'),),
144 (('localityName', 'Castle Anthrax'),),
145 (('organizationName', 'Python Software Foundation'),),
146 (('commonName', 'localhost'),))
147 )
148 self.assertEqual(p['notAfter'], 'Oct 5 23:01:56 2020 GMT')
149 self.assertEqual(p['notBefore'], 'Oct 8 23:01:56 2010 GMT')
150 self.assertEqual(p['serialNumber'], 'D7C7381919AFC24E')
151 self.assertEqual(p['subject'],
152 ((('countryName', 'XY'),),
153 (('localityName', 'Castle Anthrax'),),
154 (('organizationName', 'Python Software Foundation'),),
155 (('commonName', 'localhost'),))
156 )
157 self.assertEqual(p['subjectAltName'], (('DNS', 'localhost'),))
158 # Issue #13034: the subjectAltName in some certificates
159 # (notably projects.developer.nokia.com:443) wasn't parsed
160 p = ssl._ssl._test_decode_cert(NOKIACERT)
161 if support.verbose:
162 sys.stdout.write("\n" + pprint.pformat(p) + "\n")
163 self.assertEqual(p['subjectAltName'],
164 (('DNS', 'projects.developer.nokia.com'),
165 ('DNS', 'projects.forum.nokia.com'))
166 )
Thomas Woutersed03b412007-08-28 21:37:11 +0000167
Antoine Pitrou480a1242010-04-28 21:37:09 +0000168 def test_DER_to_PEM(self):
169 with open(SVN_PYTHON_ORG_ROOT_CERT, 'r') as f:
170 pem = f.read()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000171 d1 = ssl.PEM_cert_to_DER_cert(pem)
172 p2 = ssl.DER_cert_to_PEM_cert(d1)
173 d2 = ssl.PEM_cert_to_DER_cert(p2)
Antoine Pitrou18c913e2010-04-27 10:59:39 +0000174 self.assertEqual(d1, d2)
Antoine Pitrou9bfbe612010-04-27 22:08:08 +0000175 if not p2.startswith(ssl.PEM_HEADER + '\n'):
176 self.fail("DER-to-PEM didn't include correct header:\n%r\n" % p2)
177 if not p2.endswith('\n' + ssl.PEM_FOOTER + '\n'):
178 self.fail("DER-to-PEM didn't include correct footer:\n%r\n" % p2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000179
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000180 def test_openssl_version(self):
181 n = ssl.OPENSSL_VERSION_NUMBER
182 t = ssl.OPENSSL_VERSION_INFO
183 s = ssl.OPENSSL_VERSION
184 self.assertIsInstance(n, int)
185 self.assertIsInstance(t, tuple)
186 self.assertIsInstance(s, str)
187 # Some sanity checks follow
188 # >= 0.9
189 self.assertGreaterEqual(n, 0x900000)
190 # < 2.0
191 self.assertLess(n, 0x20000000)
192 major, minor, fix, patch, status = t
193 self.assertGreaterEqual(major, 0)
194 self.assertLess(major, 2)
195 self.assertGreaterEqual(minor, 0)
196 self.assertLess(minor, 256)
197 self.assertGreaterEqual(fix, 0)
198 self.assertLess(fix, 256)
199 self.assertGreaterEqual(patch, 0)
200 self.assertLessEqual(patch, 26)
201 self.assertGreaterEqual(status, 0)
202 self.assertLessEqual(status, 15)
203 # Version string as returned by OpenSSL, the format might change
204 self.assertTrue(s.startswith("OpenSSL {:d}.{:d}.{:d}".format(major, minor, fix)),
205 (s, t))
206
Antoine Pitrou9d543662010-04-23 23:10:32 +0000207 @support.cpython_only
208 def test_refcycle(self):
209 # Issue #7943: an SSL object doesn't create reference cycles with
210 # itself.
211 s = socket.socket(socket.AF_INET)
212 ss = ssl.wrap_socket(s)
213 wr = weakref.ref(ss)
214 del ss
215 self.assertEqual(wr(), None)
216
Antoine Pitroua468adc2010-09-14 14:43:44 +0000217 def test_wrapped_unconnected(self):
218 # Methods on an unconnected SSLSocket propagate the original
219 # socket.error raise by the underlying socket object.
220 s = socket.socket(socket.AF_INET)
221 ss = ssl.wrap_socket(s)
222 self.assertRaises(socket.error, ss.recv, 1)
223 self.assertRaises(socket.error, ss.recv_into, bytearray(b'x'))
224 self.assertRaises(socket.error, ss.recvfrom, 1)
225 self.assertRaises(socket.error, ss.recvfrom_into, bytearray(b'x'), 1)
226 self.assertRaises(socket.error, ss.send, b'x')
227 self.assertRaises(socket.error, ss.sendto, b'x', ('0.0.0.0', 0))
228
Antoine Pitrou40f08742010-04-24 22:04:40 +0000229 def test_timeout(self):
230 # Issue #8524: when creating an SSL socket, the timeout of the
231 # original socket should be retained.
232 for timeout in (None, 0.0, 5.0):
233 s = socket.socket(socket.AF_INET)
234 s.settimeout(timeout)
235 ss = ssl.wrap_socket(s)
236 self.assertEqual(timeout, ss.gettimeout())
237
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000238 def test_errors(self):
239 sock = socket.socket()
Ezio Melottied3a7d22010-12-01 02:32:32 +0000240 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000241 "certfile must be specified",
242 ssl.wrap_socket, sock, keyfile=CERTFILE)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000243 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000244 "certfile must be specified for server-side operations",
245 ssl.wrap_socket, sock, server_side=True)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000246 self.assertRaisesRegex(ValueError,
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000247 "certfile must be specified for server-side operations",
248 ssl.wrap_socket, sock, server_side=True, certfile="")
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000249 s = ssl.wrap_socket(sock, server_side=True, certfile=CERTFILE)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000250 self.assertRaisesRegex(ValueError, "can't connect in server-side mode",
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000251 s.connect, (HOST, 8080))
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000252 with self.assertRaises(IOError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000253 with socket.socket() as sock:
254 ssl.wrap_socket(sock, certfile=WRONGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000255 self.assertEqual(cm.exception.errno, errno.ENOENT)
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000256 with self.assertRaises(IOError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000257 with socket.socket() as sock:
258 ssl.wrap_socket(sock, certfile=CERTFILE, keyfile=WRONGCERT)
Giampaolo Rodolà8b7da622010-08-30 18:28:05 +0000259 self.assertEqual(cm.exception.errno, errno.ENOENT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000260 with self.assertRaises(IOError) as cm:
Antoine Pitroud2eca372010-10-29 23:41:37 +0000261 with socket.socket() as sock:
262 ssl.wrap_socket(sock, certfile=WRONGCERT, keyfile=WRONGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000263 self.assertEqual(cm.exception.errno, errno.ENOENT)
Giampaolo Rodolà745ab382010-08-29 19:25:49 +0000264
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000265 def test_match_hostname(self):
266 def ok(cert, hostname):
267 ssl.match_hostname(cert, hostname)
268 def fail(cert, hostname):
269 self.assertRaises(ssl.CertificateError,
270 ssl.match_hostname, cert, hostname)
271
272 cert = {'subject': ((('commonName', 'example.com'),),)}
273 ok(cert, 'example.com')
274 ok(cert, 'ExAmple.cOm')
275 fail(cert, 'www.example.com')
276 fail(cert, '.example.com')
277 fail(cert, 'example.org')
278 fail(cert, 'exampleXcom')
279
280 cert = {'subject': ((('commonName', '*.a.com'),),)}
281 ok(cert, 'foo.a.com')
282 fail(cert, 'bar.foo.a.com')
283 fail(cert, 'a.com')
284 fail(cert, 'Xa.com')
285 fail(cert, '.a.com')
286
287 cert = {'subject': ((('commonName', 'a.*.com'),),)}
288 ok(cert, 'a.foo.com')
289 fail(cert, 'a..com')
290 fail(cert, 'a.com')
291
292 cert = {'subject': ((('commonName', 'f*.com'),),)}
293 ok(cert, 'foo.com')
294 ok(cert, 'f.com')
295 fail(cert, 'bar.com')
296 fail(cert, 'foo.a.com')
297 fail(cert, 'bar.foo.com')
298
299 # Slightly fake real-world example
300 cert = {'notAfter': 'Jun 26 21:41:46 2011 GMT',
301 'subject': ((('commonName', 'linuxfrz.org'),),),
302 'subjectAltName': (('DNS', 'linuxfr.org'),
303 ('DNS', 'linuxfr.com'),
304 ('othername', '<unsupported>'))}
305 ok(cert, 'linuxfr.org')
306 ok(cert, 'linuxfr.com')
307 # Not a "DNS" entry
308 fail(cert, '<unsupported>')
309 # When there is a subjectAltName, commonName isn't used
310 fail(cert, 'linuxfrz.org')
311
312 # A pristine real-world example
313 cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
314 'subject': ((('countryName', 'US'),),
315 (('stateOrProvinceName', 'California'),),
316 (('localityName', 'Mountain View'),),
317 (('organizationName', 'Google Inc'),),
318 (('commonName', 'mail.google.com'),))}
319 ok(cert, 'mail.google.com')
320 fail(cert, 'gmail.com')
321 # Only commonName is considered
322 fail(cert, 'California')
323
324 # Neither commonName nor subjectAltName
325 cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
326 'subject': ((('countryName', 'US'),),
327 (('stateOrProvinceName', 'California'),),
328 (('localityName', 'Mountain View'),),
329 (('organizationName', 'Google Inc'),))}
330 fail(cert, 'mail.google.com')
331
Antoine Pitrou1c86b442011-05-06 15:19:49 +0200332 # No DNS entry in subjectAltName but a commonName
333 cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
334 'subject': ((('countryName', 'US'),),
335 (('stateOrProvinceName', 'California'),),
336 (('localityName', 'Mountain View'),),
337 (('commonName', 'mail.google.com'),)),
338 'subjectAltName': (('othername', 'blabla'), )}
339 ok(cert, 'mail.google.com')
340
341 # No DNS entry subjectAltName and no commonName
342 cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
343 'subject': ((('countryName', 'US'),),
344 (('stateOrProvinceName', 'California'),),
345 (('localityName', 'Mountain View'),),
346 (('organizationName', 'Google Inc'),)),
347 'subjectAltName': (('othername', 'blabla'),)}
348 fail(cert, 'google.com')
349
Antoine Pitrou59fdd672010-10-08 10:37:08 +0000350 # Empty cert / no cert
351 self.assertRaises(ValueError, ssl.match_hostname, None, 'example.com')
352 self.assertRaises(ValueError, ssl.match_hostname, {}, 'example.com')
353
Antoine Pitroud5323212010-10-22 18:19:07 +0000354 def test_server_side(self):
355 # server_hostname doesn't work for server sockets
356 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
Antoine Pitroud2eca372010-10-29 23:41:37 +0000357 with socket.socket() as sock:
358 self.assertRaises(ValueError, ctx.wrap_socket, sock, True,
359 server_hostname="some.hostname")
Antoine Pitrou04f6a322010-04-05 21:40:07 +0000360
Antoine Pitroud6494802011-07-21 01:11:30 +0200361 def test_unknown_channel_binding(self):
362 # should raise ValueError for unknown type
363 s = socket.socket(socket.AF_INET)
364 ss = ssl.wrap_socket(s)
365 with self.assertRaises(ValueError):
366 ss.get_channel_binding("unknown-type")
367
368 @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
369 "'tls-unique' channel binding not available")
370 def test_tls_unique_channel_binding(self):
371 # unconnected should return None for known type
372 s = socket.socket(socket.AF_INET)
373 ss = ssl.wrap_socket(s)
374 self.assertIsNone(ss.get_channel_binding("tls-unique"))
375 # the same for server-side
376 s = socket.socket(socket.AF_INET)
377 ss = ssl.wrap_socket(s, server_side=True, certfile=CERTFILE)
378 self.assertIsNone(ss.get_channel_binding("tls-unique"))
379
Antoine Pitrou152efa22010-05-16 18:19:27 +0000380class ContextTests(unittest.TestCase):
381
Antoine Pitrou23df4832010-08-04 17:14:06 +0000382 @skip_if_broken_ubuntu_ssl
Antoine Pitrou152efa22010-05-16 18:19:27 +0000383 def test_constructor(self):
Victor Stinner3de49192011-05-09 00:42:58 +0200384 if hasattr(ssl, 'PROTOCOL_SSLv2'):
385 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv2)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000386 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
387 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv3)
388 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
389 self.assertRaises(TypeError, ssl.SSLContext)
390 self.assertRaises(ValueError, ssl.SSLContext, -1)
391 self.assertRaises(ValueError, ssl.SSLContext, 42)
392
Antoine Pitrou23df4832010-08-04 17:14:06 +0000393 @skip_if_broken_ubuntu_ssl
Antoine Pitrou152efa22010-05-16 18:19:27 +0000394 def test_protocol(self):
395 for proto in PROTOCOLS:
396 ctx = ssl.SSLContext(proto)
397 self.assertEqual(ctx.protocol, proto)
398
399 def test_ciphers(self):
400 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
401 ctx.set_ciphers("ALL")
402 ctx.set_ciphers("DEFAULT")
Ezio Melottied3a7d22010-12-01 02:32:32 +0000403 with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
Antoine Pitrou30474062010-05-16 23:46:26 +0000404 ctx.set_ciphers("^$:,;?*'dorothyx")
Antoine Pitrou152efa22010-05-16 18:19:27 +0000405
Antoine Pitrou23df4832010-08-04 17:14:06 +0000406 @skip_if_broken_ubuntu_ssl
Antoine Pitroub5218772010-05-21 09:56:06 +0000407 def test_options(self):
408 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
409 # OP_ALL is the default value
410 self.assertEqual(ssl.OP_ALL, ctx.options)
411 ctx.options |= ssl.OP_NO_SSLv2
412 self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2,
413 ctx.options)
414 ctx.options |= ssl.OP_NO_SSLv3
415 self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3,
416 ctx.options)
417 if can_clear_options():
418 ctx.options = (ctx.options & ~ssl.OP_NO_SSLv2) | ssl.OP_NO_TLSv1
419 self.assertEqual(ssl.OP_ALL | ssl.OP_NO_TLSv1 | ssl.OP_NO_SSLv3,
420 ctx.options)
421 ctx.options = 0
422 self.assertEqual(0, ctx.options)
423 else:
424 with self.assertRaises(ValueError):
425 ctx.options = 0
426
Antoine Pitrou152efa22010-05-16 18:19:27 +0000427 def test_verify(self):
428 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
429 # Default value
430 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
431 ctx.verify_mode = ssl.CERT_OPTIONAL
432 self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
433 ctx.verify_mode = ssl.CERT_REQUIRED
434 self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
435 ctx.verify_mode = ssl.CERT_NONE
436 self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
437 with self.assertRaises(TypeError):
438 ctx.verify_mode = None
439 with self.assertRaises(ValueError):
440 ctx.verify_mode = 42
441
442 def test_load_cert_chain(self):
443 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
444 # Combined key and cert in a single file
445 ctx.load_cert_chain(CERTFILE)
446 ctx.load_cert_chain(CERTFILE, keyfile=CERTFILE)
447 self.assertRaises(TypeError, ctx.load_cert_chain, keyfile=CERTFILE)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000448 with self.assertRaises(IOError) as cm:
Antoine Pitrou152efa22010-05-16 18:19:27 +0000449 ctx.load_cert_chain(WRONGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000450 self.assertEqual(cm.exception.errno, errno.ENOENT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000451 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000452 ctx.load_cert_chain(BADCERT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000453 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000454 ctx.load_cert_chain(EMPTYCERT)
455 # Separate key and cert
Antoine Pitroud0919502010-05-17 10:30:00 +0000456 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000457 ctx.load_cert_chain(ONLYCERT, ONLYKEY)
458 ctx.load_cert_chain(certfile=ONLYCERT, keyfile=ONLYKEY)
459 ctx.load_cert_chain(certfile=BYTES_ONLYCERT, keyfile=BYTES_ONLYKEY)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000460 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000461 ctx.load_cert_chain(ONLYCERT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000462 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000463 ctx.load_cert_chain(ONLYKEY)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000464 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000465 ctx.load_cert_chain(certfile=ONLYKEY, keyfile=ONLYCERT)
466 # Mismatching key and cert
Antoine Pitroud0919502010-05-17 10:30:00 +0000467 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000468 with self.assertRaisesRegex(ssl.SSLError, "key values mismatch"):
Antoine Pitrou81564092010-10-08 23:06:24 +0000469 ctx.load_cert_chain(SVN_PYTHON_ORG_ROOT_CERT, ONLYKEY)
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +0200470 # Password protected key and cert
471 ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD)
472 ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD.encode())
473 ctx.load_cert_chain(CERTFILE_PROTECTED,
474 password=bytearray(KEY_PASSWORD.encode()))
475 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD)
476 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD.encode())
477 ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED,
478 bytearray(KEY_PASSWORD.encode()))
479 with self.assertRaisesRegex(TypeError, "should be a string"):
480 ctx.load_cert_chain(CERTFILE_PROTECTED, password=True)
481 with self.assertRaises(ssl.SSLError):
482 ctx.load_cert_chain(CERTFILE_PROTECTED, password="badpass")
483 with self.assertRaisesRegex(ValueError, "cannot be longer"):
484 # openssl has a fixed limit on the password buffer.
485 # PEM_BUFSIZE is generally set to 1kb.
486 # Return a string larger than this.
487 ctx.load_cert_chain(CERTFILE_PROTECTED, password=b'a' * 102400)
488 # Password callback
489 def getpass_unicode():
490 return KEY_PASSWORD
491 def getpass_bytes():
492 return KEY_PASSWORD.encode()
493 def getpass_bytearray():
494 return bytearray(KEY_PASSWORD.encode())
495 def getpass_badpass():
496 return "badpass"
497 def getpass_huge():
498 return b'a' * (1024 * 1024)
499 def getpass_bad_type():
500 return 9
501 def getpass_exception():
502 raise Exception('getpass error')
503 class GetPassCallable:
504 def __call__(self):
505 return KEY_PASSWORD
506 def getpass(self):
507 return KEY_PASSWORD
508 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_unicode)
509 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytes)
510 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytearray)
511 ctx.load_cert_chain(CERTFILE_PROTECTED, password=GetPassCallable())
512 ctx.load_cert_chain(CERTFILE_PROTECTED,
513 password=GetPassCallable().getpass)
514 with self.assertRaises(ssl.SSLError):
515 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_badpass)
516 with self.assertRaisesRegex(ValueError, "cannot be longer"):
517 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_huge)
518 with self.assertRaisesRegex(TypeError, "must return a string"):
519 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bad_type)
520 with self.assertRaisesRegex(Exception, "getpass error"):
521 ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_exception)
522 # Make sure the password function isn't called if it isn't needed
523 ctx.load_cert_chain(CERTFILE, password=getpass_exception)
Antoine Pitrou152efa22010-05-16 18:19:27 +0000524
525 def test_load_verify_locations(self):
526 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
527 ctx.load_verify_locations(CERTFILE)
528 ctx.load_verify_locations(cafile=CERTFILE, capath=None)
529 ctx.load_verify_locations(BYTES_CERTFILE)
530 ctx.load_verify_locations(cafile=BYTES_CERTFILE, capath=None)
531 self.assertRaises(TypeError, ctx.load_verify_locations)
532 self.assertRaises(TypeError, ctx.load_verify_locations, None, None)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000533 with self.assertRaises(IOError) as cm:
Antoine Pitrou152efa22010-05-16 18:19:27 +0000534 ctx.load_verify_locations(WRONGCERT)
Giampaolo Rodolà4a656eb2010-08-29 22:50:39 +0000535 self.assertEqual(cm.exception.errno, errno.ENOENT)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000536 with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
Antoine Pitrou152efa22010-05-16 18:19:27 +0000537 ctx.load_verify_locations(BADCERT)
538 ctx.load_verify_locations(CERTFILE, CAPATH)
539 ctx.load_verify_locations(CERTFILE, capath=BYTES_CAPATH)
540
Victor Stinner80f75e62011-01-29 11:31:20 +0000541 # Issue #10989: crash if the second argument type is invalid
542 self.assertRaises(TypeError, ctx.load_verify_locations, None, True)
543
Antoine Pitrou0e576f12011-12-22 10:03:38 +0100544 def test_load_dh_params(self):
545 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
546 ctx.load_dh_params(DHFILE)
547 if os.name != 'nt':
548 ctx.load_dh_params(BYTES_DHFILE)
549 self.assertRaises(TypeError, ctx.load_dh_params)
550 self.assertRaises(TypeError, ctx.load_dh_params, None)
551 with self.assertRaises(FileNotFoundError) as cm:
552 ctx.load_dh_params(WRONGCERT)
553 self.assertEqual(cm.exception.errno, errno.ENOENT)
554 with self.assertRaisesRegex(ssl.SSLError, "PEM routines"):
555 ctx.load_dh_params(CERTFILE)
556
Antoine Pitroueb585ad2010-10-22 18:24:20 +0000557 @skip_if_broken_ubuntu_ssl
Antoine Pitroub0182c82010-10-12 20:09:02 +0000558 def test_session_stats(self):
559 for proto in PROTOCOLS:
560 ctx = ssl.SSLContext(proto)
561 self.assertEqual(ctx.session_stats(), {
562 'number': 0,
563 'connect': 0,
564 'connect_good': 0,
565 'connect_renegotiate': 0,
566 'accept': 0,
567 'accept_good': 0,
568 'accept_renegotiate': 0,
569 'hits': 0,
570 'misses': 0,
571 'timeouts': 0,
572 'cache_full': 0,
573 })
574
Antoine Pitrou664c2d12010-11-17 20:29:42 +0000575 def test_set_default_verify_paths(self):
576 # There's not much we can do to test that it acts as expected,
577 # so just check it doesn't crash or raise an exception.
578 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
579 ctx.set_default_verify_paths()
580
Antoine Pitrou501da612011-12-21 09:27:41 +0100581 @unittest.skipUnless(ssl.HAS_ECDH, "ECDH disabled on this OpenSSL build")
Antoine Pitrou923df6f2011-12-19 17:16:51 +0100582 def test_set_ecdh_curve(self):
583 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
584 ctx.set_ecdh_curve("prime256v1")
585 ctx.set_ecdh_curve(b"prime256v1")
586 self.assertRaises(TypeError, ctx.set_ecdh_curve)
587 self.assertRaises(TypeError, ctx.set_ecdh_curve, None)
588 self.assertRaises(ValueError, ctx.set_ecdh_curve, "foo")
589 self.assertRaises(ValueError, ctx.set_ecdh_curve, b"foo")
590
Antoine Pitrou152efa22010-05-16 18:19:27 +0000591
Bill Janssen6e027db2007-11-15 22:23:56 +0000592class NetworkedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000593
Antoine Pitrou480a1242010-04-28 21:37:09 +0000594 def test_connect(self):
Antoine Pitrou350c7222010-09-09 13:31:46 +0000595 with support.transient_internet("svn.python.org"):
596 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
597 cert_reqs=ssl.CERT_NONE)
598 try:
599 s.connect(("svn.python.org", 443))
600 self.assertEqual({}, s.getpeercert())
601 finally:
602 s.close()
603
604 # this should fail because we have no verification certs
605 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
606 cert_reqs=ssl.CERT_REQUIRED)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000607 self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
608 s.connect, ("svn.python.org", 443))
Antoine Pitrou152efa22010-05-16 18:19:27 +0000609 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000610
Antoine Pitrou350c7222010-09-09 13:31:46 +0000611 # this should succeed because we specify the root cert
612 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
613 cert_reqs=ssl.CERT_REQUIRED,
614 ca_certs=SVN_PYTHON_ORG_ROOT_CERT)
615 try:
616 s.connect(("svn.python.org", 443))
617 self.assertTrue(s.getpeercert())
618 finally:
619 s.close()
Antoine Pitrou152efa22010-05-16 18:19:27 +0000620
Antoine Pitroue93bf7a2011-02-26 23:24:06 +0000621 def test_connect_ex(self):
622 # Issue #11326: check connect_ex() implementation
623 with support.transient_internet("svn.python.org"):
624 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
625 cert_reqs=ssl.CERT_REQUIRED,
626 ca_certs=SVN_PYTHON_ORG_ROOT_CERT)
627 try:
628 self.assertEqual(0, s.connect_ex(("svn.python.org", 443)))
629 self.assertTrue(s.getpeercert())
630 finally:
631 s.close()
632
633 def test_non_blocking_connect_ex(self):
634 # Issue #11326: non-blocking connect_ex() should allow handshake
635 # to proceed after the socket gets ready.
636 with support.transient_internet("svn.python.org"):
637 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
638 cert_reqs=ssl.CERT_REQUIRED,
639 ca_certs=SVN_PYTHON_ORG_ROOT_CERT,
640 do_handshake_on_connect=False)
641 try:
642 s.setblocking(False)
643 rc = s.connect_ex(('svn.python.org', 443))
Antoine Pitrou8a14a0c2011-02-27 15:44:12 +0000644 # EWOULDBLOCK under Windows, EINPROGRESS elsewhere
645 self.assertIn(rc, (0, errno.EINPROGRESS, errno.EWOULDBLOCK))
Antoine Pitroue93bf7a2011-02-26 23:24:06 +0000646 # Wait for connect to finish
647 select.select([], [s], [], 5.0)
648 # Non-blocking handshake
649 while True:
650 try:
651 s.do_handshake()
652 break
Antoine Pitrou41032a62011-10-27 23:56:55 +0200653 except ssl.SSLWantReadError:
654 select.select([s], [], [], 5.0)
655 except ssl.SSLWantWriteError:
656 select.select([], [s], [], 5.0)
Antoine Pitroue93bf7a2011-02-26 23:24:06 +0000657 # SSL established
658 self.assertTrue(s.getpeercert())
659 finally:
660 s.close()
661
Antoine Pitroub4410db2011-05-18 18:51:06 +0200662 def test_timeout_connect_ex(self):
663 # Issue #12065: on a timeout, connect_ex() should return the original
664 # errno (mimicking the behaviour of non-SSL sockets).
665 with support.transient_internet("svn.python.org"):
666 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
667 cert_reqs=ssl.CERT_REQUIRED,
668 ca_certs=SVN_PYTHON_ORG_ROOT_CERT,
669 do_handshake_on_connect=False)
670 try:
671 s.settimeout(0.0000001)
672 rc = s.connect_ex(('svn.python.org', 443))
673 if rc == 0:
674 self.skipTest("svn.python.org responded too quickly")
675 self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
676 finally:
677 s.close()
678
Antoine Pitrou152efa22010-05-16 18:19:27 +0000679 def test_connect_with_context(self):
Antoine Pitrou350c7222010-09-09 13:31:46 +0000680 with support.transient_internet("svn.python.org"):
681 # Same as test_connect, but with a separately created context
682 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
683 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
684 s.connect(("svn.python.org", 443))
685 try:
686 self.assertEqual({}, s.getpeercert())
687 finally:
688 s.close()
Antoine Pitroud5323212010-10-22 18:19:07 +0000689 # Same with a server hostname
690 s = ctx.wrap_socket(socket.socket(socket.AF_INET),
691 server_hostname="svn.python.org")
692 if ssl.HAS_SNI:
693 s.connect(("svn.python.org", 443))
694 s.close()
695 else:
696 self.assertRaises(ValueError, s.connect, ("svn.python.org", 443))
Antoine Pitrou350c7222010-09-09 13:31:46 +0000697 # This should fail because we have no verification certs
698 ctx.verify_mode = ssl.CERT_REQUIRED
699 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
Ezio Melottied3a7d22010-12-01 02:32:32 +0000700 self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
Antoine Pitrou350c7222010-09-09 13:31:46 +0000701 s.connect, ("svn.python.org", 443))
Antoine Pitrou152efa22010-05-16 18:19:27 +0000702 s.close()
Antoine Pitrou350c7222010-09-09 13:31:46 +0000703 # This should succeed because we specify the root cert
704 ctx.load_verify_locations(SVN_PYTHON_ORG_ROOT_CERT)
705 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
706 s.connect(("svn.python.org", 443))
707 try:
708 cert = s.getpeercert()
709 self.assertTrue(cert)
710 finally:
711 s.close()
Antoine Pitrou152efa22010-05-16 18:19:27 +0000712
713 def test_connect_capath(self):
714 # Verify server certificates using the `capath` argument
Antoine Pitrou467f28d2010-05-16 19:22:44 +0000715 # NOTE: the subject hashing algorithm has been changed between
716 # OpenSSL 0.9.8n and 1.0.0, as a result the capath directory must
717 # contain both versions of each certificate (same content, different
Antoine Pitroud7e4c1c2010-05-17 14:13:10 +0000718 # filename) for this test to be portable across OpenSSL releases.
Antoine Pitrou350c7222010-09-09 13:31:46 +0000719 with support.transient_internet("svn.python.org"):
720 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
721 ctx.verify_mode = ssl.CERT_REQUIRED
722 ctx.load_verify_locations(capath=CAPATH)
723 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
724 s.connect(("svn.python.org", 443))
725 try:
726 cert = s.getpeercert()
727 self.assertTrue(cert)
728 finally:
729 s.close()
730 # Same with a bytes `capath` argument
731 ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
732 ctx.verify_mode = ssl.CERT_REQUIRED
733 ctx.load_verify_locations(capath=BYTES_CAPATH)
734 s = ctx.wrap_socket(socket.socket(socket.AF_INET))
735 s.connect(("svn.python.org", 443))
736 try:
737 cert = s.getpeercert()
738 self.assertTrue(cert)
739 finally:
740 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000741
Antoine Pitroue3220242010-04-24 11:13:53 +0000742 @unittest.skipIf(os.name == "nt", "Can't use a socket as a file under Windows")
743 def test_makefile_close(self):
744 # Issue #5238: creating a file-like object with makefile() shouldn't
745 # delay closing the underlying "real socket" (here tested with its
746 # file descriptor, hence skipping the test under Windows).
Antoine Pitrou350c7222010-09-09 13:31:46 +0000747 with support.transient_internet("svn.python.org"):
748 ss = ssl.wrap_socket(socket.socket(socket.AF_INET))
749 ss.connect(("svn.python.org", 443))
750 fd = ss.fileno()
751 f = ss.makefile()
752 f.close()
753 # The fd is still open
Antoine Pitroue3220242010-04-24 11:13:53 +0000754 os.read(fd, 0)
Antoine Pitrou350c7222010-09-09 13:31:46 +0000755 # Closing the SSL socket should close the fd too
756 ss.close()
757 gc.collect()
758 with self.assertRaises(OSError) as e:
759 os.read(fd, 0)
760 self.assertEqual(e.exception.errno, errno.EBADF)
Antoine Pitroue3220242010-04-24 11:13:53 +0000761
Antoine Pitrou480a1242010-04-28 21:37:09 +0000762 def test_non_blocking_handshake(self):
Antoine Pitrou350c7222010-09-09 13:31:46 +0000763 with support.transient_internet("svn.python.org"):
764 s = socket.socket(socket.AF_INET)
765 s.connect(("svn.python.org", 443))
766 s.setblocking(False)
767 s = ssl.wrap_socket(s,
768 cert_reqs=ssl.CERT_NONE,
769 do_handshake_on_connect=False)
770 count = 0
771 while True:
772 try:
773 count += 1
774 s.do_handshake()
775 break
Antoine Pitrou41032a62011-10-27 23:56:55 +0200776 except ssl.SSLWantReadError:
777 select.select([s], [], [])
778 except ssl.SSLWantWriteError:
779 select.select([], [s], [])
Antoine Pitrou350c7222010-09-09 13:31:46 +0000780 s.close()
781 if support.verbose:
782 sys.stdout.write("\nNeeded %d calls to do_handshake() to establish session.\n" % count)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000783
Antoine Pitrou480a1242010-04-28 21:37:09 +0000784 def test_get_server_certificate(self):
Antoine Pitrou15399c32011-04-28 19:23:55 +0200785 def _test_get_server_certificate(host, port, cert=None):
786 with support.transient_internet(host):
787 pem = ssl.get_server_certificate((host, port))
788 if not pem:
789 self.fail("No server certificate on %s:%s!" % (host, port))
Antoine Pitrou5aefa662011-04-28 19:24:46 +0200790
Antoine Pitrou15399c32011-04-28 19:23:55 +0200791 try:
792 pem = ssl.get_server_certificate((host, port), ca_certs=CERTFILE)
793 except ssl.SSLError as x:
794 #should fail
795 if support.verbose:
796 sys.stdout.write("%s\n" % x)
797 else:
Antoine Pitrou5aefa662011-04-28 19:24:46 +0200798 self.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
799
Antoine Pitrou15399c32011-04-28 19:23:55 +0200800 pem = ssl.get_server_certificate((host, port), ca_certs=cert)
801 if not pem:
Antoine Pitrou5aefa662011-04-28 19:24:46 +0200802 self.fail("No server certificate on %s:%s!" % (host, port))
Antoine Pitrou350c7222010-09-09 13:31:46 +0000803 if support.verbose:
Antoine Pitrou5aefa662011-04-28 19:24:46 +0200804 sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
Antoine Pitrou350c7222010-09-09 13:31:46 +0000805
Antoine Pitrou15399c32011-04-28 19:23:55 +0200806 _test_get_server_certificate('svn.python.org', 443, SVN_PYTHON_ORG_ROOT_CERT)
807 if support.IPV6_ENABLED:
808 _test_get_server_certificate('ipv6.google.com', 443)
Bill Janssen54cc54c2007-12-14 22:08:56 +0000809
Antoine Pitrouf4c7bad2010-08-15 23:02:22 +0000810 def test_ciphers(self):
811 remote = ("svn.python.org", 443)
Antoine Pitrou350c7222010-09-09 13:31:46 +0000812 with support.transient_internet(remote[0]):
Antoine Pitrouf4c7bad2010-08-15 23:02:22 +0000813 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
Antoine Pitrou350c7222010-09-09 13:31:46 +0000814 cert_reqs=ssl.CERT_NONE, ciphers="ALL")
Antoine Pitrouf4c7bad2010-08-15 23:02:22 +0000815 s.connect(remote)
Antoine Pitrou350c7222010-09-09 13:31:46 +0000816 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
817 cert_reqs=ssl.CERT_NONE, ciphers="DEFAULT")
818 s.connect(remote)
819 # Error checking can happen at instantiation or when connecting
Ezio Melottied3a7d22010-12-01 02:32:32 +0000820 with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
Antoine Pitroud2eca372010-10-29 23:41:37 +0000821 with socket.socket(socket.AF_INET) as sock:
822 s = ssl.wrap_socket(sock,
823 cert_reqs=ssl.CERT_NONE, ciphers="^$:,;?*'dorothyx")
824 s.connect(remote)
Antoine Pitrouf4c7bad2010-08-15 23:02:22 +0000825
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000826 def test_algorithms(self):
827 # Issue #8484: all algorithms should be available when verifying a
828 # certificate.
Antoine Pitrou29619b22010-04-22 18:43:31 +0000829 # SHA256 was added in OpenSSL 0.9.8
830 if ssl.OPENSSL_VERSION_INFO < (0, 9, 8, 0, 15):
831 self.skipTest("SHA256 not available on %r" % ssl.OPENSSL_VERSION)
Victor Stinnerf332abb2011-01-08 03:16:05 +0000832 # https://sha2.hboeck.de/ was used until 2011-01-08 (no route to host)
833 remote = ("sha256.tbs-internet.com", 443)
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000834 sha256_cert = os.path.join(os.path.dirname(__file__), "sha256.pem")
Antoine Pitrou160fd932011-01-08 10:23:29 +0000835 with support.transient_internet("sha256.tbs-internet.com"):
Antoine Pitroua88c83c2010-09-07 20:42:19 +0000836 s = ssl.wrap_socket(socket.socket(socket.AF_INET),
837 cert_reqs=ssl.CERT_REQUIRED,
838 ca_certs=sha256_cert,)
Antoine Pitroufec12ff2010-04-21 19:46:23 +0000839 try:
840 s.connect(remote)
841 if support.verbose:
842 sys.stdout.write("\nCipher with %r is %r\n" %
843 (remote, s.cipher()))
844 sys.stdout.write("Certificate is:\n%s\n" %
845 pprint.pformat(s.getpeercert()))
846 finally:
847 s.close()
848
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000849
850try:
851 import threading
852except ImportError:
853 _have_threads = False
854else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000855 _have_threads = True
856
Antoine Pitrou803e6d62010-10-13 10:36:15 +0000857 from test.ssl_servers import make_https_server
858
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000859 class ThreadedEchoServer(threading.Thread):
860
861 class ConnectionHandler(threading.Thread):
862
863 """A mildly complicated class, because we want it to work both
864 with and without the SSL wrapper around the socket connection, so
865 that we can test the STARTTLS functionality."""
866
Bill Janssen6e027db2007-11-15 22:23:56 +0000867 def __init__(self, server, connsock, addr):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000868 self.server = server
869 self.running = False
870 self.sock = connsock
Bill Janssen6e027db2007-11-15 22:23:56 +0000871 self.addr = addr
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000872 self.sock.setblocking(1)
873 self.sslconn = None
874 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +0000875 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000876
Antoine Pitrou480a1242010-04-28 21:37:09 +0000877 def wrap_conn(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000878 try:
Antoine Pitroub5218772010-05-21 09:56:06 +0000879 self.sslconn = self.server.context.wrap_socket(
880 self.sock, server_side=True)
Antoine Pitrou18c913e2010-04-27 10:59:39 +0000881 except ssl.SSLError:
882 # XXX Various errors can have happened here, for example
883 # a mismatching protocol version, an invalid certificate,
884 # or a low-level bug. This should be made more discriminating.
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000885 if self.server.chatty:
Bill Janssen6e027db2007-11-15 22:23:56 +0000886 handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +0000887 self.running = False
888 self.server.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +0000889 self.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000890 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000891 else:
Antoine Pitroub5218772010-05-21 09:56:06 +0000892 if self.server.context.verify_mode == ssl.CERT_REQUIRED:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000893 cert = self.sslconn.getpeercert()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000894 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000895 sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
896 cert_binary = self.sslconn.getpeercert(True)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000897 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000898 sys.stdout.write(" cert binary is " + str(len(cert_binary)) + " bytes\n")
899 cipher = self.sslconn.cipher()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000900 if support.verbose and self.server.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000901 sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
902 return True
903
904 def read(self):
905 if self.sslconn:
906 return self.sslconn.read()
907 else:
908 return self.sock.recv(1024)
909
910 def write(self, bytes):
911 if self.sslconn:
912 return self.sslconn.write(bytes)
913 else:
914 return self.sock.send(bytes)
915
916 def close(self):
917 if self.sslconn:
918 self.sslconn.close()
919 else:
920 self.sock.close()
921
Antoine Pitrou480a1242010-04-28 21:37:09 +0000922 def run(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000923 self.running = True
924 if not self.server.starttls_server:
925 if not self.wrap_conn():
926 return
927 while self.running:
928 try:
929 msg = self.read()
Antoine Pitrou480a1242010-04-28 21:37:09 +0000930 stripped = msg.strip()
931 if not stripped:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000932 # eof, so quit this handler
933 self.running = False
934 self.close()
Antoine Pitrou480a1242010-04-28 21:37:09 +0000935 elif stripped == b'over':
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000936 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000937 sys.stdout.write(" server: client closed connection\n")
938 self.close()
939 return
Bill Janssen6e027db2007-11-15 22:23:56 +0000940 elif (self.server.starttls_server and
Antoine Pitrou764b8782010-04-28 22:57:15 +0000941 stripped == b'STARTTLS'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000942 if support.verbose and self.server.connectionchatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000943 sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +0000944 self.write(b"OK\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000945 if not self.wrap_conn():
946 return
Bill Janssen40a0f662008-08-12 16:56:25 +0000947 elif (self.server.starttls_server and self.sslconn
Antoine Pitrou764b8782010-04-28 22:57:15 +0000948 and stripped == b'ENDTLS'):
Bill Janssen40a0f662008-08-12 16:56:25 +0000949 if support.verbose and self.server.connectionchatty:
950 sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +0000951 self.write(b"OK\n")
Bill Janssen40a0f662008-08-12 16:56:25 +0000952 self.sock = self.sslconn.unwrap()
953 self.sslconn = None
954 if support.verbose and self.server.connectionchatty:
955 sys.stdout.write(" server: connection is now unencrypted...\n")
Antoine Pitroud6494802011-07-21 01:11:30 +0200956 elif stripped == b'CB tls-unique':
957 if support.verbose and self.server.connectionchatty:
958 sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
959 data = self.sslconn.get_channel_binding("tls-unique")
960 self.write(repr(data).encode("us-ascii") + b"\n")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000961 else:
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000962 if (support.verbose and
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000963 self.server.connectionchatty):
964 ctype = (self.sslconn and "encrypted") or "unencrypted"
Antoine Pitrou480a1242010-04-28 21:37:09 +0000965 sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
966 % (msg, ctype, msg.lower(), ctype))
967 self.write(msg.lower())
Bill Janssen6e027db2007-11-15 22:23:56 +0000968 except socket.error:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000969 if self.server.chatty:
970 handle_error("Test server failure:\n")
971 self.close()
972 self.running = False
973 # normally, we'd just stop here, but for the test
974 # harness, we want to stop the server
975 self.server.stop()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000976
Antoine Pitroub5218772010-05-21 09:56:06 +0000977 def __init__(self, certificate=None, ssl_version=None,
Antoine Pitrou18c913e2010-04-27 10:59:39 +0000978 certreqs=None, cacerts=None,
Antoine Pitrou2d9cb9c2010-04-17 17:40:45 +0000979 chatty=True, connectionchatty=False, starttls_server=False,
Antoine Pitroub5218772010-05-21 09:56:06 +0000980 ciphers=None, context=None):
981 if context:
982 self.context = context
983 else:
984 self.context = ssl.SSLContext(ssl_version
985 if ssl_version is not None
986 else ssl.PROTOCOL_TLSv1)
987 self.context.verify_mode = (certreqs if certreqs is not None
988 else ssl.CERT_NONE)
989 if cacerts:
990 self.context.load_verify_locations(cacerts)
991 if certificate:
992 self.context.load_cert_chain(certificate)
993 if ciphers:
994 self.context.set_ciphers(ciphers)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000995 self.chatty = chatty
996 self.connectionchatty = connectionchatty
997 self.starttls_server = starttls_server
998 self.sock = socket.socket()
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000999 self.port = support.bind_port(self.sock)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001000 self.flag = None
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001001 self.active = False
1002 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00001003 self.daemon = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001004
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001005 def __enter__(self):
1006 self.start(threading.Event())
1007 self.flag.wait()
1008
1009 def __exit__(self, *args):
1010 self.stop()
1011 self.join()
1012
Antoine Pitrou480a1242010-04-28 21:37:09 +00001013 def start(self, flag=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001014 self.flag = flag
1015 threading.Thread.start(self)
1016
Antoine Pitrou480a1242010-04-28 21:37:09 +00001017 def run(self):
Antoine Pitrouaf7c6022010-04-27 09:56:02 +00001018 self.sock.settimeout(0.05)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001019 self.sock.listen(5)
1020 self.active = True
1021 if self.flag:
1022 # signal an event
1023 self.flag.set()
1024 while self.active:
1025 try:
1026 newconn, connaddr = self.sock.accept()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001027 if support.verbose and self.chatty:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001028 sys.stdout.write(' server: new connection from '
Bill Janssen6e027db2007-11-15 22:23:56 +00001029 + repr(connaddr) + '\n')
1030 handler = self.ConnectionHandler(self, newconn, connaddr)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001031 handler.start()
1032 except socket.timeout:
1033 pass
1034 except KeyboardInterrupt:
1035 self.stop()
Bill Janssen6e027db2007-11-15 22:23:56 +00001036 self.sock.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001037
Antoine Pitrou480a1242010-04-28 21:37:09 +00001038 def stop(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001039 self.active = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001040
Bill Janssen54cc54c2007-12-14 22:08:56 +00001041 class AsyncoreEchoServer(threading.Thread):
1042
1043 # this one's based on asyncore.dispatcher
1044
1045 class EchoServer (asyncore.dispatcher):
1046
1047 class ConnectionHandler (asyncore.dispatcher_with_send):
1048
1049 def __init__(self, conn, certfile):
1050 self.socket = ssl.wrap_socket(conn, server_side=True,
1051 certfile=certfile,
1052 do_handshake_on_connect=False)
1053 asyncore.dispatcher_with_send.__init__(self, self.socket)
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001054 self._ssl_accepting = True
1055 self._do_ssl_handshake()
Bill Janssen54cc54c2007-12-14 22:08:56 +00001056
1057 def readable(self):
1058 if isinstance(self.socket, ssl.SSLSocket):
1059 while self.socket.pending() > 0:
1060 self.handle_read_event()
1061 return True
1062
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001063 def _do_ssl_handshake(self):
1064 try:
1065 self.socket.do_handshake()
Antoine Pitrou41032a62011-10-27 23:56:55 +02001066 except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
1067 return
1068 except ssl.SSLEOFError:
1069 return self.handle_close()
1070 except ssl.SSLError:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001071 raise
1072 except socket.error as err:
1073 if err.args[0] == errno.ECONNABORTED:
1074 return self.handle_close()
Bill Janssen54cc54c2007-12-14 22:08:56 +00001075 else:
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001076 self._ssl_accepting = False
1077
1078 def handle_read(self):
1079 if self._ssl_accepting:
1080 self._do_ssl_handshake()
1081 else:
1082 data = self.recv(1024)
1083 if support.verbose:
1084 sys.stdout.write(" server: read %s from client\n" % repr(data))
1085 if not data:
1086 self.close()
1087 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001088 self.send(data.lower())
Bill Janssen54cc54c2007-12-14 22:08:56 +00001089
1090 def handle_close(self):
Bill Janssen2f5799b2008-06-29 00:08:12 +00001091 self.close()
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001092 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00001093 sys.stdout.write(" server: closed connection %s\n" % self.socket)
1094
1095 def handle_error(self):
1096 raise
1097
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001098 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00001099 self.certfile = certfile
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001100 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
1101 self.port = support.bind_port(sock, '')
1102 asyncore.dispatcher.__init__(self, sock)
Bill Janssen54cc54c2007-12-14 22:08:56 +00001103 self.listen(5)
1104
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00001105 def handle_accepted(self, sock_obj, addr):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001106 if support.verbose:
Bill Janssen54cc54c2007-12-14 22:08:56 +00001107 sys.stdout.write(" server: new connection from %s:%s\n" %addr)
1108 self.ConnectionHandler(sock_obj, self.certfile)
1109
1110 def handle_error(self):
1111 raise
1112
Trent Nelson78520002008-04-10 20:54:35 +00001113 def __init__(self, certfile):
Bill Janssen54cc54c2007-12-14 22:08:56 +00001114 self.flag = None
1115 self.active = False
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001116 self.server = self.EchoServer(certfile)
1117 self.port = self.server.port
Bill Janssen54cc54c2007-12-14 22:08:56 +00001118 threading.Thread.__init__(self)
Benjamin Peterson4171da52008-08-18 21:11:09 +00001119 self.daemon = True
Bill Janssen54cc54c2007-12-14 22:08:56 +00001120
1121 def __str__(self):
1122 return "<%s %s>" % (self.__class__.__name__, self.server)
1123
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001124 def __enter__(self):
1125 self.start(threading.Event())
1126 self.flag.wait()
1127
1128 def __exit__(self, *args):
1129 if support.verbose:
1130 sys.stdout.write(" cleanup: stopping server.\n")
1131 self.stop()
1132 if support.verbose:
1133 sys.stdout.write(" cleanup: joining server thread.\n")
1134 self.join()
1135 if support.verbose:
1136 sys.stdout.write(" cleanup: successfully joined.\n")
1137
Bill Janssen54cc54c2007-12-14 22:08:56 +00001138 def start (self, flag=None):
1139 self.flag = flag
1140 threading.Thread.start(self)
1141
Antoine Pitrou480a1242010-04-28 21:37:09 +00001142 def run(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00001143 self.active = True
1144 if self.flag:
1145 self.flag.set()
1146 while self.active:
1147 try:
1148 asyncore.loop(1)
1149 except:
1150 pass
1151
Antoine Pitrou480a1242010-04-28 21:37:09 +00001152 def stop(self):
Bill Janssen54cc54c2007-12-14 22:08:56 +00001153 self.active = False
1154 self.server.close()
1155
Antoine Pitrou480a1242010-04-28 21:37:09 +00001156 def bad_cert_test(certfile):
1157 """
1158 Launch a server with CERT_REQUIRED, and check that trying to
1159 connect to it with the given client certificate fails.
1160 """
Trent Nelson78520002008-04-10 20:54:35 +00001161 server = ThreadedEchoServer(CERTFILE,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001162 certreqs=ssl.CERT_REQUIRED,
Bill Janssen6e027db2007-11-15 22:23:56 +00001163 cacerts=CERTFILE, chatty=False,
1164 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001165 with server:
Thomas Woutersed03b412007-08-28 21:37:11 +00001166 try:
Antoine Pitroud2eca372010-10-29 23:41:37 +00001167 with socket.socket() as sock:
1168 s = ssl.wrap_socket(sock,
1169 certfile=certfile,
1170 ssl_version=ssl.PROTOCOL_TLSv1)
1171 s.connect((HOST, server.port))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001172 except ssl.SSLError as x:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001173 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001174 sys.stdout.write("\nSSLError is %s\n" % x.args[1])
Antoine Pitrou05830aa2010-04-27 13:15:18 +00001175 except socket.error as x:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001176 if support.verbose:
Georg Brandlb75b6392010-10-24 14:20:22 +00001177 sys.stdout.write("\nsocket.error is %s\n" % x.args[1])
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00001178 except IOError as x:
Giampaolo Rodolàcd9dfb92010-08-29 20:56:56 +00001179 if x.errno != errno.ENOENT:
1180 raise
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00001181 if support.verbose:
Giampaolo Rodolàcd9dfb92010-08-29 20:56:56 +00001182 sys.stdout.write("\IOError is %s\n" % str(x))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001183 else:
Antoine Pitroud75b2a92010-05-06 14:15:10 +00001184 raise AssertionError("Use of invalid cert should have failed!")
Thomas Woutersed03b412007-08-28 21:37:11 +00001185
Antoine Pitroub5218772010-05-21 09:56:06 +00001186 def server_params_test(client_context, server_context, indata=b"FOO\n",
1187 chatty=True, connectionchatty=False):
Antoine Pitrou480a1242010-04-28 21:37:09 +00001188 """
1189 Launch a server, connect a client to it and try various reads
1190 and writes.
1191 """
Antoine Pitroub5218772010-05-21 09:56:06 +00001192 server = ThreadedEchoServer(context=server_context,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001193 chatty=chatty,
Bill Janssen6e027db2007-11-15 22:23:56 +00001194 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001195 with server:
Antoine Pitroub5218772010-05-21 09:56:06 +00001196 s = client_context.wrap_socket(socket.socket())
Trent Nelson78520002008-04-10 20:54:35 +00001197 s.connect((HOST, server.port))
Antoine Pitrou480a1242010-04-28 21:37:09 +00001198 for arg in [indata, bytearray(indata), memoryview(indata)]:
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001199 if connectionchatty:
1200 if support.verbose:
1201 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001202 " client: sending %r...\n" % indata)
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001203 s.write(arg)
1204 outdata = s.read()
1205 if connectionchatty:
1206 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001207 sys.stdout.write(" client: read %r\n" % outdata)
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001208 if outdata != indata.lower():
Antoine Pitroud75b2a92010-05-06 14:15:10 +00001209 raise AssertionError(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001210 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
1211 % (outdata[:20], len(outdata),
1212 indata[:20].lower(), len(indata)))
1213 s.write(b"over\n")
Bill Janssen6e027db2007-11-15 22:23:56 +00001214 if connectionchatty:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001215 if support.verbose:
Bill Janssen6e027db2007-11-15 22:23:56 +00001216 sys.stdout.write(" client: closing connection.\n")
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001217 stats = {
1218 'compression': s.compression(),
1219 'cipher': s.cipher(),
1220 }
Bill Janssen6e027db2007-11-15 22:23:56 +00001221 s.close()
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001222 return stats
Thomas Woutersed03b412007-08-28 21:37:11 +00001223
Antoine Pitroub5218772010-05-21 09:56:06 +00001224 def try_protocol_combo(server_protocol, client_protocol, expect_success,
1225 certsreqs=None, server_options=0, client_options=0):
Benjamin Peterson2a691a82008-03-31 01:51:45 +00001226 if certsreqs is None:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001227 certsreqs = ssl.CERT_NONE
Antoine Pitrou480a1242010-04-28 21:37:09 +00001228 certtype = {
1229 ssl.CERT_NONE: "CERT_NONE",
1230 ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
1231 ssl.CERT_REQUIRED: "CERT_REQUIRED",
1232 }[certsreqs]
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001233 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001234 formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001235 sys.stdout.write(formatstr %
1236 (ssl.get_protocol_name(client_protocol),
1237 ssl.get_protocol_name(server_protocol),
1238 certtype))
Antoine Pitroub5218772010-05-21 09:56:06 +00001239 client_context = ssl.SSLContext(client_protocol)
1240 client_context.options = ssl.OP_ALL | client_options
1241 server_context = ssl.SSLContext(server_protocol)
1242 server_context.options = ssl.OP_ALL | server_options
1243 for ctx in (client_context, server_context):
1244 ctx.verify_mode = certsreqs
Antoine Pitrou2d9cb9c2010-04-17 17:40:45 +00001245 # NOTE: we must enable "ALL" ciphers, otherwise an SSLv23 client
1246 # will send an SSLv3 hello (rather than SSLv2) starting from
1247 # OpenSSL 1.0.0 (see issue #8322).
Antoine Pitroub5218772010-05-21 09:56:06 +00001248 ctx.set_ciphers("ALL")
1249 ctx.load_cert_chain(CERTFILE)
1250 ctx.load_verify_locations(CERTFILE)
1251 try:
1252 server_params_test(client_context, server_context,
1253 chatty=False, connectionchatty=False)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001254 # Protocol mismatch can result in either an SSLError, or a
1255 # "Connection reset by peer" error.
1256 except ssl.SSLError:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001257 if expect_success:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001258 raise
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001259 except socket.error as e:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001260 if expect_success or e.errno != errno.ECONNRESET:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001261 raise
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001262 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001263 if not expect_success:
Antoine Pitroud75b2a92010-05-06 14:15:10 +00001264 raise AssertionError(
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001265 "Client protocol %s succeeded with server protocol %s!"
1266 % (ssl.get_protocol_name(client_protocol),
1267 ssl.get_protocol_name(server_protocol)))
1268
1269
Bill Janssen6e027db2007-11-15 22:23:56 +00001270 class ThreadedTests(unittest.TestCase):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001271
Antoine Pitrou23df4832010-08-04 17:14:06 +00001272 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00001273 def test_echo(self):
1274 """Basic test of an SSL client connecting to a server"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001275 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001276 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00001277 for protocol in PROTOCOLS:
1278 context = ssl.SSLContext(protocol)
1279 context.load_cert_chain(CERTFILE)
1280 server_params_test(context, context,
1281 chatty=True, connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001282
Antoine Pitrou480a1242010-04-28 21:37:09 +00001283 def test_getpeercert(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001284 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001285 sys.stdout.write("\n")
Antoine Pitroub5218772010-05-21 09:56:06 +00001286 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
1287 context.verify_mode = ssl.CERT_REQUIRED
1288 context.load_verify_locations(CERTFILE)
1289 context.load_cert_chain(CERTFILE)
1290 server = ThreadedEchoServer(context=context, chatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001291 with server:
Antoine Pitroub5218772010-05-21 09:56:06 +00001292 s = context.wrap_socket(socket.socket())
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001293 s.connect((HOST, server.port))
1294 cert = s.getpeercert()
1295 self.assertTrue(cert, "Can't get peer certificate.")
1296 cipher = s.cipher()
1297 if support.verbose:
1298 sys.stdout.write(pprint.pformat(cert) + '\n')
1299 sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
1300 if 'subject' not in cert:
1301 self.fail("No subject field in certificate: %s." %
1302 pprint.pformat(cert))
1303 if ((('organizationName', 'Python Software Foundation'),)
1304 not in cert['subject']):
1305 self.fail(
1306 "Missing or invalid 'organizationName' field in certificate subject; "
1307 "should be 'Python Software Foundation'.")
Antoine Pitroufb046912010-11-09 20:21:19 +00001308 self.assertIn('notBefore', cert)
1309 self.assertIn('notAfter', cert)
1310 before = ssl.cert_time_to_seconds(cert['notBefore'])
1311 after = ssl.cert_time_to_seconds(cert['notAfter'])
1312 self.assertLess(before, after)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001313 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001314
Antoine Pitrou480a1242010-04-28 21:37:09 +00001315 def test_empty_cert(self):
1316 """Connecting with an empty cert file"""
1317 bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
1318 "nullcert.pem"))
1319 def test_malformed_cert(self):
1320 """Connecting with a badly formatted certificate (syntax error)"""
1321 bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
1322 "badcert.pem"))
1323 def test_nonexisting_cert(self):
1324 """Connecting with a non-existing cert file"""
1325 bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
1326 "wrongcert.pem"))
1327 def test_malformed_key(self):
1328 """Connecting with a badly formatted key (syntax error)"""
1329 bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
1330 "badkey.pem"))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001331
Antoine Pitrou480a1242010-04-28 21:37:09 +00001332 def test_rude_shutdown(self):
1333 """A brutal shutdown of an SSL server should raise an IOError
1334 in the client when attempting handshake.
1335 """
Trent Nelson6b240cd2008-04-10 20:12:06 +00001336 listener_ready = threading.Event()
1337 listener_gone = threading.Event()
Antoine Pitrou480a1242010-04-28 21:37:09 +00001338
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001339 s = socket.socket()
1340 port = support.bind_port(s, HOST)
Trent Nelson6b240cd2008-04-10 20:12:06 +00001341
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001342 # `listener` runs in a thread. It sits in an accept() until
1343 # the main thread connects. Then it rudely closes the socket,
1344 # and sets Event `listener_gone` to let the main thread know
1345 # the socket is gone.
Trent Nelson6b240cd2008-04-10 20:12:06 +00001346 def listener():
Trent Nelson6b240cd2008-04-10 20:12:06 +00001347 s.listen(5)
1348 listener_ready.set()
Antoine Pitroud2eca372010-10-29 23:41:37 +00001349 newsock, addr = s.accept()
1350 newsock.close()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001351 s.close()
Trent Nelson6b240cd2008-04-10 20:12:06 +00001352 listener_gone.set()
1353
1354 def connector():
1355 listener_ready.wait()
Antoine Pitroud2eca372010-10-29 23:41:37 +00001356 with socket.socket() as c:
1357 c.connect((HOST, port))
1358 listener_gone.wait()
1359 try:
1360 ssl_sock = ssl.wrap_socket(c)
1361 except IOError:
1362 pass
1363 else:
1364 self.fail('connecting to closed SSL socket should have failed')
Trent Nelson6b240cd2008-04-10 20:12:06 +00001365
1366 t = threading.Thread(target=listener)
1367 t.start()
Antoine Pitrou773b5db2010-04-27 08:53:36 +00001368 try:
1369 connector()
1370 finally:
1371 t.join()
Trent Nelson6b240cd2008-04-10 20:12:06 +00001372
Antoine Pitrou23df4832010-08-04 17:14:06 +00001373 @skip_if_broken_ubuntu_ssl
Victor Stinner3de49192011-05-09 00:42:58 +02001374 @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv2'),
1375 "OpenSSL is compiled without SSLv2 support")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001376 def test_protocol_sslv2(self):
1377 """Connecting to an SSLv2 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001378 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001379 sys.stdout.write("\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001380 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
1381 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
1382 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
1383 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True)
1384 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
1385 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00001386 # SSLv23 client with specific SSL options
1387 if no_sslv2_implies_sslv3_hello():
1388 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
1389 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
1390 client_options=ssl.OP_NO_SSLv2)
1391 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True,
1392 client_options=ssl.OP_NO_SSLv3)
1393 try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True,
1394 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001395
Antoine Pitrou23df4832010-08-04 17:14:06 +00001396 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00001397 def test_protocol_sslv23(self):
1398 """Connecting to an SSLv23 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001399 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001400 sys.stdout.write("\n")
Victor Stinner3de49192011-05-09 00:42:58 +02001401 if hasattr(ssl, 'PROTOCOL_SSLv2'):
1402 try:
1403 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv2, True)
1404 except (ssl.SSLError, socket.error) as x:
1405 # this fails on some older versions of OpenSSL (0.9.7l, for instance)
1406 if support.verbose:
1407 sys.stdout.write(
1408 " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
1409 % str(x))
Antoine Pitrou480a1242010-04-28 21:37:09 +00001410 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True)
1411 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True)
1412 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001413
Antoine Pitrou480a1242010-04-28 21:37:09 +00001414 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True, ssl.CERT_OPTIONAL)
1415 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_OPTIONAL)
1416 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True, ssl.CERT_OPTIONAL)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001417
Antoine Pitrou480a1242010-04-28 21:37:09 +00001418 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True, ssl.CERT_REQUIRED)
1419 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_REQUIRED)
1420 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True, ssl.CERT_REQUIRED)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001421
Antoine Pitroub5218772010-05-21 09:56:06 +00001422 # Server with specific SSL options
1423 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False,
1424 server_options=ssl.OP_NO_SSLv3)
1425 # Will choose TLSv1
1426 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True,
1427 server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
1428 try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, False,
1429 server_options=ssl.OP_NO_TLSv1)
1430
1431
Antoine Pitrou23df4832010-08-04 17:14:06 +00001432 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00001433 def test_protocol_sslv3(self):
1434 """Connecting to an SSLv3 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001435 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001436 sys.stdout.write("\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001437 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True)
1438 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True, ssl.CERT_OPTIONAL)
1439 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True, ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02001440 if hasattr(ssl, 'PROTOCOL_SSLv2'):
1441 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04001442 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, False,
1443 client_options=ssl.OP_NO_SSLv3)
Antoine Pitrou480a1242010-04-28 21:37:09 +00001444 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
Antoine Pitroub5218772010-05-21 09:56:06 +00001445 if no_sslv2_implies_sslv3_hello():
1446 # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
1447 try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, True,
1448 client_options=ssl.OP_NO_SSLv2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001449
Antoine Pitrou23df4832010-08-04 17:14:06 +00001450 @skip_if_broken_ubuntu_ssl
Antoine Pitrou480a1242010-04-28 21:37:09 +00001451 def test_protocol_tlsv1(self):
1452 """Connecting to a TLSv1 server with various client options"""
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001453 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001454 sys.stdout.write("\n")
Antoine Pitrou480a1242010-04-28 21:37:09 +00001455 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True)
1456 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True, ssl.CERT_OPTIONAL)
1457 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True, ssl.CERT_REQUIRED)
Victor Stinner3de49192011-05-09 00:42:58 +02001458 if hasattr(ssl, 'PROTOCOL_SSLv2'):
1459 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
Antoine Pitrou480a1242010-04-28 21:37:09 +00001460 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
Barry Warsaw46ae0ef2011-10-28 16:52:17 -04001461 try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv23, False,
1462 client_options=ssl.OP_NO_TLSv1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001463
Antoine Pitrou480a1242010-04-28 21:37:09 +00001464 def test_starttls(self):
1465 """Switching from clear text to encrypted and back again."""
1466 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 +00001467
Trent Nelson78520002008-04-10 20:54:35 +00001468 server = ThreadedEchoServer(CERTFILE,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001469 ssl_version=ssl.PROTOCOL_TLSv1,
1470 starttls_server=True,
1471 chatty=True,
1472 connectionchatty=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001473 wrapped = False
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001474 with server:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001475 s = socket.socket()
1476 s.setblocking(1)
1477 s.connect((HOST, server.port))
1478 if support.verbose:
1479 sys.stdout.write("\n")
1480 for indata in msgs:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001481 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001482 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001483 " client: sending %r...\n" % indata)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001484 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001485 conn.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001486 outdata = conn.read()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001487 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001488 s.send(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001489 outdata = s.recv(1024)
Antoine Pitrou480a1242010-04-28 21:37:09 +00001490 msg = outdata.strip().lower()
1491 if indata == b"STARTTLS" and msg.startswith(b"ok"):
1492 # STARTTLS ok, switch to secure mode
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001493 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001494 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001495 " client: read %r from server, starting TLS...\n"
1496 % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001497 conn = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_TLSv1)
1498 wrapped = True
Antoine Pitrou480a1242010-04-28 21:37:09 +00001499 elif indata == b"ENDTLS" and msg.startswith(b"ok"):
1500 # ENDTLS ok, switch back to clear text
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001501 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001502 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001503 " client: read %r from server, ending TLS...\n"
1504 % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001505 s = conn.unwrap()
1506 wrapped = False
1507 else:
1508 if support.verbose:
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001509 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001510 " client: read %r from server\n" % msg)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001511 if support.verbose:
1512 sys.stdout.write(" client: closing connection.\n")
1513 if wrapped:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001514 conn.write(b"over\n")
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001515 else:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001516 s.send(b"over\n")
Bill Janssen6e027db2007-11-15 22:23:56 +00001517 if wrapped:
1518 conn.close()
1519 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001520 s.close()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001521
Antoine Pitrou480a1242010-04-28 21:37:09 +00001522 def test_socketserver(self):
1523 """Using a SocketServer to create and manage SSL connections."""
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001524 server = make_https_server(self, CERTFILE)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001525 # try to connect
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001526 if support.verbose:
1527 sys.stdout.write('\n')
1528 with open(CERTFILE, 'rb') as f:
1529 d1 = f.read()
1530 d2 = ''
1531 # now fetch the same data from the HTTPS server
1532 url = 'https://%s:%d/%s' % (
1533 HOST, server.port, os.path.split(CERTFILE)[1])
1534 f = urllib.request.urlopen(url)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001535 try:
Barry Warsaw820c1202008-06-12 04:06:45 +00001536 dlen = f.info().get("content-length")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001537 if dlen and (int(dlen) > 0):
1538 d2 = f.read(int(dlen))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001539 if support.verbose:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001540 sys.stdout.write(
1541 " client: read %d bytes from remote server '%s'\n"
1542 % (len(d2), server))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001543 finally:
Antoine Pitrou803e6d62010-10-13 10:36:15 +00001544 f.close()
1545 self.assertEqual(d1, d2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001546
Antoine Pitrou480a1242010-04-28 21:37:09 +00001547 def test_asyncore_server(self):
1548 """Check the example asyncore integration."""
1549 indata = "TEST MESSAGE of mixed case\n"
Trent Nelson6b240cd2008-04-10 20:12:06 +00001550
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001551 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00001552 sys.stdout.write("\n")
1553
Antoine Pitrou480a1242010-04-28 21:37:09 +00001554 indata = b"FOO\n"
Trent Nelson78520002008-04-10 20:54:35 +00001555 server = AsyncoreEchoServer(CERTFILE)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001556 with server:
Trent Nelson6b240cd2008-04-10 20:12:06 +00001557 s = ssl.wrap_socket(socket.socket())
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001558 s.connect(('127.0.0.1', server.port))
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001559 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00001560 sys.stdout.write(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001561 " client: sending %r...\n" % indata)
1562 s.write(indata)
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001563 outdata = s.read()
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001564 if support.verbose:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001565 sys.stdout.write(" client: read %r\n" % outdata)
Trent Nelson6b240cd2008-04-10 20:12:06 +00001566 if outdata != indata.lower():
Antoine Pitrou18c913e2010-04-27 10:59:39 +00001567 self.fail(
Antoine Pitrou480a1242010-04-28 21:37:09 +00001568 "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
1569 % (outdata[:20], len(outdata),
1570 indata[:20].lower(), len(indata)))
1571 s.write(b"over\n")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001572 if support.verbose:
Trent Nelson6b240cd2008-04-10 20:12:06 +00001573 sys.stdout.write(" client: closing connection.\n")
1574 s.close()
Antoine Pitroued986362010-08-15 23:28:10 +00001575 if support.verbose:
1576 sys.stdout.write(" client: connection closed.\n")
Trent Nelson6b240cd2008-04-10 20:12:06 +00001577
Antoine Pitrou480a1242010-04-28 21:37:09 +00001578 def test_recv_send(self):
1579 """Test recv(), send() and friends."""
Bill Janssen58afe4c2008-09-08 16:45:19 +00001580 if support.verbose:
1581 sys.stdout.write("\n")
1582
1583 server = ThreadedEchoServer(CERTFILE,
1584 certreqs=ssl.CERT_NONE,
1585 ssl_version=ssl.PROTOCOL_TLSv1,
1586 cacerts=CERTFILE,
1587 chatty=True,
1588 connectionchatty=False)
Antoine Pitrou65a3f4b2011-12-21 16:52:40 +01001589 with server:
1590 s = ssl.wrap_socket(socket.socket(),
1591 server_side=False,
1592 certfile=CERTFILE,
1593 ca_certs=CERTFILE,
1594 cert_reqs=ssl.CERT_NONE,
1595 ssl_version=ssl.PROTOCOL_TLSv1)
1596 s.connect((HOST, server.port))
Bill Janssen58afe4c2008-09-08 16:45:19 +00001597 # helper methods for standardising recv* method signatures
1598 def _recv_into():
1599 b = bytearray(b"\0"*100)
1600 count = s.recv_into(b)
1601 return b[:count]
1602
1603 def _recvfrom_into():
1604 b = bytearray(b"\0"*100)
1605 count, addr = s.recvfrom_into(b)
1606 return b[:count]
1607
1608 # (name, method, whether to expect success, *args)
1609 send_methods = [
1610 ('send', s.send, True, []),
1611 ('sendto', s.sendto, False, ["some.address"]),
1612 ('sendall', s.sendall, True, []),
1613 ]
1614 recv_methods = [
1615 ('recv', s.recv, True, []),
1616 ('recvfrom', s.recvfrom, False, ["some.address"]),
1617 ('recv_into', _recv_into, True, []),
1618 ('recvfrom_into', _recvfrom_into, False, []),
1619 ]
1620 data_prefix = "PREFIX_"
1621
1622 for meth_name, send_meth, expect_success, args in send_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001623 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00001624 try:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001625 send_meth(indata, *args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00001626 outdata = s.read()
Bill Janssen58afe4c2008-09-08 16:45:19 +00001627 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00001628 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001629 "While sending with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00001630 "<<{outdata:r}>> ({nout:d}) received; "
1631 "expected <<{indata:r}>> ({nin:d})\n".format(
1632 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00001633 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00001634 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00001635 )
1636 )
1637 except ValueError as e:
1638 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00001639 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001640 "Failed to send with method <<{name:s}>>; "
1641 "expected to succeed.\n".format(name=meth_name)
1642 )
1643 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00001644 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001645 "Method <<{name:s}>> failed with unexpected "
1646 "exception message: {exp:s}\n".format(
1647 name=meth_name, exp=e
1648 )
1649 )
1650
1651 for meth_name, recv_meth, expect_success, args in recv_methods:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001652 indata = (data_prefix + meth_name).encode('ascii')
Bill Janssen58afe4c2008-09-08 16:45:19 +00001653 try:
Antoine Pitrou480a1242010-04-28 21:37:09 +00001654 s.send(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00001655 outdata = recv_meth(*args)
Bill Janssen58afe4c2008-09-08 16:45:19 +00001656 if outdata != indata.lower():
Georg Brandl89fad142010-03-14 10:23:39 +00001657 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001658 "While receiving with <<{name:s}>> bad data "
Antoine Pitrou480a1242010-04-28 21:37:09 +00001659 "<<{outdata:r}>> ({nout:d}) received; "
1660 "expected <<{indata:r}>> ({nin:d})\n".format(
1661 name=meth_name, outdata=outdata[:20],
Bill Janssen58afe4c2008-09-08 16:45:19 +00001662 nout=len(outdata),
Antoine Pitrou480a1242010-04-28 21:37:09 +00001663 indata=indata[:20], nin=len(indata)
Bill Janssen58afe4c2008-09-08 16:45:19 +00001664 )
1665 )
1666 except ValueError as e:
1667 if expect_success:
Georg Brandl89fad142010-03-14 10:23:39 +00001668 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001669 "Failed to receive with method <<{name:s}>>; "
1670 "expected to succeed.\n".format(name=meth_name)
1671 )
1672 if not str(e).startswith(meth_name):
Georg Brandl89fad142010-03-14 10:23:39 +00001673 self.fail(
Bill Janssen58afe4c2008-09-08 16:45:19 +00001674 "Method <<{name:s}>> failed with unexpected "
1675 "exception message: {exp:s}\n".format(
1676 name=meth_name, exp=e
1677 )
1678 )
1679 # consume data
1680 s.read()
1681
Nick Coghlan513886a2011-08-28 00:00:27 +10001682 # Make sure sendmsg et al are disallowed to avoid
1683 # inadvertent disclosure of data and/or corruption
1684 # of the encrypted data stream
1685 self.assertRaises(NotImplementedError, s.sendmsg, [b"data"])
1686 self.assertRaises(NotImplementedError, s.recvmsg, 100)
1687 self.assertRaises(NotImplementedError,
1688 s.recvmsg_into, bytearray(100))
1689
Antoine Pitrou480a1242010-04-28 21:37:09 +00001690 s.write(b"over\n")
Bill Janssen58afe4c2008-09-08 16:45:19 +00001691 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00001692
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001693 def test_handshake_timeout(self):
1694 # Issue #5103: SSL handshake must respect the socket timeout
1695 server = socket.socket(socket.AF_INET)
1696 host = "127.0.0.1"
1697 port = support.bind_port(server)
1698 started = threading.Event()
1699 finish = False
1700
1701 def serve():
1702 server.listen(5)
1703 started.set()
1704 conns = []
1705 while not finish:
1706 r, w, e = select.select([server], [], [], 0.1)
1707 if server in r:
1708 # Let the socket hang around rather than having
1709 # it closed by garbage collection.
1710 conns.append(server.accept()[0])
Antoine Pitroud2eca372010-10-29 23:41:37 +00001711 for sock in conns:
1712 sock.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001713
1714 t = threading.Thread(target=serve)
1715 t.start()
1716 started.wait()
1717
1718 try:
Antoine Pitrou40f08742010-04-24 22:04:40 +00001719 try:
1720 c = socket.socket(socket.AF_INET)
1721 c.settimeout(0.2)
1722 c.connect((host, port))
1723 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001724 self.assertRaisesRegex(socket.timeout, "timed out",
Ezio Melottied3a7d22010-12-01 02:32:32 +00001725 ssl.wrap_socket, c)
Antoine Pitrou40f08742010-04-24 22:04:40 +00001726 finally:
1727 c.close()
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001728 try:
1729 c = socket.socket(socket.AF_INET)
1730 c = ssl.wrap_socket(c)
1731 c.settimeout(0.2)
1732 # Will attempt handshake and time out
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001733 self.assertRaisesRegex(socket.timeout, "timed out",
Ezio Melottied3a7d22010-12-01 02:32:32 +00001734 c.connect, (host, port))
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001735 finally:
1736 c.close()
1737 finally:
1738 finish = True
1739 t.join()
1740 server.close()
1741
Antoine Pitroud6494802011-07-21 01:11:30 +02001742 @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
1743 "'tls-unique' channel binding not available")
1744 def test_tls_unique_channel_binding(self):
1745 """Test tls-unique channel binding."""
1746 if support.verbose:
1747 sys.stdout.write("\n")
1748
1749 server = ThreadedEchoServer(CERTFILE,
1750 certreqs=ssl.CERT_NONE,
1751 ssl_version=ssl.PROTOCOL_TLSv1,
1752 cacerts=CERTFILE,
1753 chatty=True,
1754 connectionchatty=False)
Antoine Pitrou6b15c902011-12-21 16:54:45 +01001755 with server:
1756 s = ssl.wrap_socket(socket.socket(),
1757 server_side=False,
1758 certfile=CERTFILE,
1759 ca_certs=CERTFILE,
1760 cert_reqs=ssl.CERT_NONE,
1761 ssl_version=ssl.PROTOCOL_TLSv1)
1762 s.connect((HOST, server.port))
Antoine Pitroud6494802011-07-21 01:11:30 +02001763 # get the data
1764 cb_data = s.get_channel_binding("tls-unique")
1765 if support.verbose:
1766 sys.stdout.write(" got channel binding data: {0!r}\n"
1767 .format(cb_data))
1768
1769 # check if it is sane
1770 self.assertIsNotNone(cb_data)
1771 self.assertEqual(len(cb_data), 12) # True for TLSv1
1772
1773 # and compare with the peers version
1774 s.write(b"CB tls-unique\n")
1775 peer_data_repr = s.read().strip()
1776 self.assertEqual(peer_data_repr,
1777 repr(cb_data).encode("us-ascii"))
1778 s.close()
1779
1780 # now, again
1781 s = ssl.wrap_socket(socket.socket(),
1782 server_side=False,
1783 certfile=CERTFILE,
1784 ca_certs=CERTFILE,
1785 cert_reqs=ssl.CERT_NONE,
1786 ssl_version=ssl.PROTOCOL_TLSv1)
1787 s.connect((HOST, server.port))
1788 new_cb_data = s.get_channel_binding("tls-unique")
1789 if support.verbose:
1790 sys.stdout.write(" got another channel binding data: {0!r}\n"
1791 .format(new_cb_data))
1792 # is it really unique
1793 self.assertNotEqual(cb_data, new_cb_data)
1794 self.assertIsNotNone(cb_data)
1795 self.assertEqual(len(cb_data), 12) # True for TLSv1
1796 s.write(b"CB tls-unique\n")
1797 peer_data_repr = s.read().strip()
1798 self.assertEqual(peer_data_repr,
1799 repr(new_cb_data).encode("us-ascii"))
1800 s.close()
Bill Janssen58afe4c2008-09-08 16:45:19 +00001801
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001802 def test_compression(self):
1803 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1804 context.load_cert_chain(CERTFILE)
1805 stats = server_params_test(context, context,
1806 chatty=True, connectionchatty=True)
1807 if support.verbose:
1808 sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
1809 self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
1810
1811 @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
1812 "ssl.OP_NO_COMPRESSION needed for this test")
1813 def test_compression_disabled(self):
1814 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1815 context.load_cert_chain(CERTFILE)
Antoine Pitrou8691bff2011-12-20 10:47:42 +01001816 context.options |= ssl.OP_NO_COMPRESSION
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001817 stats = server_params_test(context, context,
1818 chatty=True, connectionchatty=True)
1819 self.assertIs(stats['compression'], None)
1820
Antoine Pitrou0e576f12011-12-22 10:03:38 +01001821 def test_dh_params(self):
1822 # Check we can get a connection with ephemeral Diffie-Hellman
1823 context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
1824 context.load_cert_chain(CERTFILE)
1825 context.load_dh_params(DHFILE)
1826 context.set_ciphers("kEDH")
1827 stats = server_params_test(context, context,
1828 chatty=True, connectionchatty=True)
1829 cipher = stats["cipher"][0]
1830 parts = cipher.split("-")
1831 if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
1832 self.fail("Non-DH cipher: " + cipher[0])
1833
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001834
Thomas Woutersed03b412007-08-28 21:37:11 +00001835def test_main(verbose=False):
Antoine Pitrou15cee622010-08-04 16:45:21 +00001836 if support.verbose:
1837 plats = {
1838 'Linux': platform.linux_distribution,
1839 'Mac': platform.mac_ver,
1840 'Windows': platform.win32_ver,
1841 }
1842 for name, func in plats.items():
1843 plat = func()
1844 if plat and plat[0]:
1845 plat = '%s %r' % (name, plat)
1846 break
1847 else:
1848 plat = repr(platform.platform())
1849 print("test_ssl: testing with %r %r" %
1850 (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
1851 print(" under %s" % plat)
Antoine Pitroud5323212010-10-22 18:19:07 +00001852 print(" HAS_SNI = %r" % ssl.HAS_SNI)
Antoine Pitrou15cee622010-08-04 16:45:21 +00001853
Antoine Pitrou152efa22010-05-16 18:19:27 +00001854 for filename in [
1855 CERTFILE, SVN_PYTHON_ORG_ROOT_CERT, BYTES_CERTFILE,
1856 ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
1857 BADCERT, BADKEY, EMPTYCERT]:
1858 if not os.path.exists(filename):
1859 raise support.TestFailed("Can't read certificate file %r" % filename)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001860
Antoine Pitrou152efa22010-05-16 18:19:27 +00001861 tests = [ContextTests, BasicSocketTests]
Thomas Woutersed03b412007-08-28 21:37:11 +00001862
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001863 if support.is_resource_enabled('network'):
Bill Janssen6e027db2007-11-15 22:23:56 +00001864 tests.append(NetworkedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00001865
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001866 if _have_threads:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001867 thread_info = support.threading_setup()
1868 if thread_info and support.is_resource_enabled('network'):
Bill Janssen6e027db2007-11-15 22:23:56 +00001869 tests.append(ThreadedTests)
Thomas Woutersed03b412007-08-28 21:37:11 +00001870
Antoine Pitrou480a1242010-04-28 21:37:09 +00001871 try:
1872 support.run_unittest(*tests)
1873 finally:
1874 if _have_threads:
1875 support.threading_cleanup(*thread_info)
Thomas Woutersed03b412007-08-28 21:37:11 +00001876
1877if __name__ == "__main__":
1878 test_main()