PageRenderTime 65ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 1ms

/site/tests/unittests/test/test_ssl.py

https://bitbucket.org/olemis/brython
Python | 2155 lines | 1969 code | 93 blank | 93 comment | 201 complexity | 7230f5b2e798ae7d88eb5ddf617f7646 MD5 | raw file
Possible License(s): BSD-3-Clause
  1. # Test the support for SSL and sockets
  2. import sys
  3. import unittest
  4. from test import support
  5. import socket
  6. import select
  7. import time
  8. import gc
  9. import os
  10. import errno
  11. import pprint
  12. import tempfile
  13. import urllib.request
  14. import traceback
  15. import asyncore
  16. import weakref
  17. import platform
  18. import functools
  19. ssl = support.import_module("ssl")
  20. PROTOCOLS = [
  21. ssl.PROTOCOL_SSLv3,
  22. ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1
  23. ]
  24. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  25. PROTOCOLS.append(ssl.PROTOCOL_SSLv2)
  26. HOST = support.HOST
  27. data_file = lambda name: os.path.join(os.path.dirname(__file__), name)
  28. # The custom key and certificate files used in test_ssl are generated
  29. # using Lib/test/make_ssl_certs.py.
  30. # Other certificates are simply fetched from the Internet servers they
  31. # are meant to authenticate.
  32. CERTFILE = data_file("keycert.pem")
  33. BYTES_CERTFILE = os.fsencode(CERTFILE)
  34. ONLYCERT = data_file("ssl_cert.pem")
  35. ONLYKEY = data_file("ssl_key.pem")
  36. BYTES_ONLYCERT = os.fsencode(ONLYCERT)
  37. BYTES_ONLYKEY = os.fsencode(ONLYKEY)
  38. CERTFILE_PROTECTED = data_file("keycert.passwd.pem")
  39. ONLYKEY_PROTECTED = data_file("ssl_key.passwd.pem")
  40. KEY_PASSWORD = "somepass"
  41. CAPATH = data_file("capath")
  42. BYTES_CAPATH = os.fsencode(CAPATH)
  43. SVN_PYTHON_ORG_ROOT_CERT = data_file("https_svn_python_org_root.pem")
  44. EMPTYCERT = data_file("nullcert.pem")
  45. BADCERT = data_file("badcert.pem")
  46. WRONGCERT = data_file("XXXnonexisting.pem")
  47. BADKEY = data_file("badkey.pem")
  48. NOKIACERT = data_file("nokia.pem")
  49. NULLBYTECERT = data_file("nullbytecert.pem")
  50. DHFILE = data_file("dh512.pem")
  51. BYTES_DHFILE = os.fsencode(DHFILE)
  52. def handle_error(prefix):
  53. exc_format = ' '.join(traceback.format_exception(*sys.exc_info()))
  54. if support.verbose:
  55. sys.stdout.write(prefix + exc_format)
  56. def can_clear_options():
  57. # 0.9.8m or higher
  58. return ssl._OPENSSL_API_VERSION >= (0, 9, 8, 13, 15)
  59. def no_sslv2_implies_sslv3_hello():
  60. # 0.9.7h or higher
  61. return ssl.OPENSSL_VERSION_INFO >= (0, 9, 7, 8, 15)
  62. # Issue #9415: Ubuntu hijacks their OpenSSL and forcefully disables SSLv2
  63. def skip_if_broken_ubuntu_ssl(func):
  64. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  65. @functools.wraps(func)
  66. def f(*args, **kwargs):
  67. try:
  68. ssl.SSLContext(ssl.PROTOCOL_SSLv2)
  69. except ssl.SSLError:
  70. if (ssl.OPENSSL_VERSION_INFO == (0, 9, 8, 15, 15) and
  71. platform.linux_distribution() == ('debian', 'squeeze/sid', '')):
  72. raise unittest.SkipTest("Patched Ubuntu OpenSSL breaks behaviour")
  73. return func(*args, **kwargs)
  74. return f
  75. else:
  76. return func
  77. class BasicSocketTests(unittest.TestCase):
  78. def test_constants(self):
  79. #ssl.PROTOCOL_SSLv2
  80. ssl.PROTOCOL_SSLv23
  81. ssl.PROTOCOL_SSLv3
  82. ssl.PROTOCOL_TLSv1
  83. ssl.CERT_NONE
  84. ssl.CERT_OPTIONAL
  85. ssl.CERT_REQUIRED
  86. ssl.OP_CIPHER_SERVER_PREFERENCE
  87. ssl.OP_SINGLE_DH_USE
  88. if ssl.HAS_ECDH:
  89. ssl.OP_SINGLE_ECDH_USE
  90. if ssl.OPENSSL_VERSION_INFO >= (1, 0):
  91. ssl.OP_NO_COMPRESSION
  92. self.assertIn(ssl.HAS_SNI, {True, False})
  93. self.assertIn(ssl.HAS_ECDH, {True, False})
  94. def test_random(self):
  95. v = ssl.RAND_status()
  96. if support.verbose:
  97. sys.stdout.write("\n RAND_status is %d (%s)\n"
  98. % (v, (v and "sufficient randomness") or
  99. "insufficient randomness"))
  100. data, is_cryptographic = ssl.RAND_pseudo_bytes(16)
  101. self.assertEqual(len(data), 16)
  102. self.assertEqual(is_cryptographic, v == 1)
  103. if v:
  104. data = ssl.RAND_bytes(16)
  105. self.assertEqual(len(data), 16)
  106. else:
  107. self.assertRaises(ssl.SSLError, ssl.RAND_bytes, 16)
  108. self.assertRaises(TypeError, ssl.RAND_egd, 1)
  109. self.assertRaises(TypeError, ssl.RAND_egd, 'foo', 1)
  110. ssl.RAND_add("this is a random string", 75.0)
  111. @unittest.skipUnless(os.name == 'posix', 'requires posix')
  112. def test_random_fork(self):
  113. status = ssl.RAND_status()
  114. if not status:
  115. self.fail("OpenSSL's PRNG has insufficient randomness")
  116. rfd, wfd = os.pipe()
  117. pid = os.fork()
  118. if pid == 0:
  119. try:
  120. os.close(rfd)
  121. child_random = ssl.RAND_pseudo_bytes(16)[0]
  122. self.assertEqual(len(child_random), 16)
  123. os.write(wfd, child_random)
  124. os.close(wfd)
  125. except BaseException:
  126. os._exit(1)
  127. else:
  128. os._exit(0)
  129. else:
  130. os.close(wfd)
  131. self.addCleanup(os.close, rfd)
  132. _, status = os.waitpid(pid, 0)
  133. self.assertEqual(status, 0)
  134. child_random = os.read(rfd, 16)
  135. self.assertEqual(len(child_random), 16)
  136. parent_random = ssl.RAND_pseudo_bytes(16)[0]
  137. self.assertEqual(len(parent_random), 16)
  138. self.assertNotEqual(child_random, parent_random)
  139. def test_parse_cert(self):
  140. # note that this uses an 'unofficial' function in _ssl.c,
  141. # provided solely for this test, to exercise the certificate
  142. # parsing code
  143. p = ssl._ssl._test_decode_cert(CERTFILE)
  144. if support.verbose:
  145. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  146. self.assertEqual(p['issuer'],
  147. ((('countryName', 'XY'),),
  148. (('localityName', 'Castle Anthrax'),),
  149. (('organizationName', 'Python Software Foundation'),),
  150. (('commonName', 'localhost'),))
  151. )
  152. self.assertEqual(p['notAfter'], 'Oct 5 23:01:56 2020 GMT')
  153. self.assertEqual(p['notBefore'], 'Oct 8 23:01:56 2010 GMT')
  154. self.assertEqual(p['serialNumber'], 'D7C7381919AFC24E')
  155. self.assertEqual(p['subject'],
  156. ((('countryName', 'XY'),),
  157. (('localityName', 'Castle Anthrax'),),
  158. (('organizationName', 'Python Software Foundation'),),
  159. (('commonName', 'localhost'),))
  160. )
  161. self.assertEqual(p['subjectAltName'], (('DNS', 'localhost'),))
  162. # Issue #13034: the subjectAltName in some certificates
  163. # (notably projects.developer.nokia.com:443) wasn't parsed
  164. p = ssl._ssl._test_decode_cert(NOKIACERT)
  165. if support.verbose:
  166. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  167. self.assertEqual(p['subjectAltName'],
  168. (('DNS', 'projects.developer.nokia.com'),
  169. ('DNS', 'projects.forum.nokia.com'))
  170. )
  171. def test_parse_cert_CVE_2013_4238(self):
  172. p = ssl._ssl._test_decode_cert(NULLBYTECERT)
  173. if support.verbose:
  174. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  175. subject = ((('countryName', 'US'),),
  176. (('stateOrProvinceName', 'Oregon'),),
  177. (('localityName', 'Beaverton'),),
  178. (('organizationName', 'Python Software Foundation'),),
  179. (('organizationalUnitName', 'Python Core Development'),),
  180. (('commonName', 'null.python.org\x00example.org'),),
  181. (('emailAddress', 'python-dev@python.org'),))
  182. self.assertEqual(p['subject'], subject)
  183. self.assertEqual(p['issuer'], subject)
  184. if ssl._OPENSSL_API_VERSION >= (0, 9, 8):
  185. san = (('DNS', 'altnull.python.org\x00example.com'),
  186. ('email', 'null@python.org\x00user@example.org'),
  187. ('URI', 'http://null.python.org\x00http://example.org'),
  188. ('IP Address', '192.0.2.1'),
  189. ('IP Address', '2001:DB8:0:0:0:0:0:1\n'))
  190. else:
  191. # OpenSSL 0.9.7 doesn't support IPv6 addresses in subjectAltName
  192. san = (('DNS', 'altnull.python.org\x00example.com'),
  193. ('email', 'null@python.org\x00user@example.org'),
  194. ('URI', 'http://null.python.org\x00http://example.org'),
  195. ('IP Address', '192.0.2.1'),
  196. ('IP Address', '<invalid>'))
  197. self.assertEqual(p['subjectAltName'], san)
  198. def test_DER_to_PEM(self):
  199. with open(SVN_PYTHON_ORG_ROOT_CERT, 'r') as f:
  200. pem = f.read()
  201. d1 = ssl.PEM_cert_to_DER_cert(pem)
  202. p2 = ssl.DER_cert_to_PEM_cert(d1)
  203. d2 = ssl.PEM_cert_to_DER_cert(p2)
  204. self.assertEqual(d1, d2)
  205. if not p2.startswith(ssl.PEM_HEADER + '\n'):
  206. self.fail("DER-to-PEM didn't include correct header:\n%r\n" % p2)
  207. if not p2.endswith('\n' + ssl.PEM_FOOTER + '\n'):
  208. self.fail("DER-to-PEM didn't include correct footer:\n%r\n" % p2)
  209. def test_openssl_version(self):
  210. n = ssl.OPENSSL_VERSION_NUMBER
  211. t = ssl.OPENSSL_VERSION_INFO
  212. s = ssl.OPENSSL_VERSION
  213. self.assertIsInstance(n, int)
  214. self.assertIsInstance(t, tuple)
  215. self.assertIsInstance(s, str)
  216. # Some sanity checks follow
  217. # >= 0.9
  218. self.assertGreaterEqual(n, 0x900000)
  219. # < 2.0
  220. self.assertLess(n, 0x20000000)
  221. major, minor, fix, patch, status = t
  222. self.assertGreaterEqual(major, 0)
  223. self.assertLess(major, 2)
  224. self.assertGreaterEqual(minor, 0)
  225. self.assertLess(minor, 256)
  226. self.assertGreaterEqual(fix, 0)
  227. self.assertLess(fix, 256)
  228. self.assertGreaterEqual(patch, 0)
  229. self.assertLessEqual(patch, 26)
  230. self.assertGreaterEqual(status, 0)
  231. self.assertLessEqual(status, 15)
  232. # Version string as returned by OpenSSL, the format might change
  233. self.assertTrue(s.startswith("OpenSSL {:d}.{:d}.{:d}".format(major, minor, fix)),
  234. (s, t))
  235. @support.cpython_only
  236. def test_refcycle(self):
  237. # Issue #7943: an SSL object doesn't create reference cycles with
  238. # itself.
  239. s = socket.socket(socket.AF_INET)
  240. ss = ssl.wrap_socket(s)
  241. wr = weakref.ref(ss)
  242. with support.check_warnings(("", ResourceWarning)):
  243. del ss
  244. self.assertEqual(wr(), None)
  245. def test_wrapped_unconnected(self):
  246. # Methods on an unconnected SSLSocket propagate the original
  247. # socket.error raise by the underlying socket object.
  248. s = socket.socket(socket.AF_INET)
  249. with ssl.wrap_socket(s) as ss:
  250. self.assertRaises(socket.error, ss.recv, 1)
  251. self.assertRaises(socket.error, ss.recv_into, bytearray(b'x'))
  252. self.assertRaises(socket.error, ss.recvfrom, 1)
  253. self.assertRaises(socket.error, ss.recvfrom_into, bytearray(b'x'), 1)
  254. self.assertRaises(socket.error, ss.send, b'x')
  255. self.assertRaises(socket.error, ss.sendto, b'x', ('0.0.0.0', 0))
  256. def test_timeout(self):
  257. # Issue #8524: when creating an SSL socket, the timeout of the
  258. # original socket should be retained.
  259. for timeout in (None, 0.0, 5.0):
  260. s = socket.socket(socket.AF_INET)
  261. s.settimeout(timeout)
  262. with ssl.wrap_socket(s) as ss:
  263. self.assertEqual(timeout, ss.gettimeout())
  264. def test_errors(self):
  265. sock = socket.socket()
  266. self.assertRaisesRegex(ValueError,
  267. "certfile must be specified",
  268. ssl.wrap_socket, sock, keyfile=CERTFILE)
  269. self.assertRaisesRegex(ValueError,
  270. "certfile must be specified for server-side operations",
  271. ssl.wrap_socket, sock, server_side=True)
  272. self.assertRaisesRegex(ValueError,
  273. "certfile must be specified for server-side operations",
  274. ssl.wrap_socket, sock, server_side=True, certfile="")
  275. with ssl.wrap_socket(sock, server_side=True, certfile=CERTFILE) as s:
  276. self.assertRaisesRegex(ValueError, "can't connect in server-side mode",
  277. s.connect, (HOST, 8080))
  278. with self.assertRaises(IOError) as cm:
  279. with socket.socket() as sock:
  280. ssl.wrap_socket(sock, certfile=WRONGCERT)
  281. self.assertEqual(cm.exception.errno, errno.ENOENT)
  282. with self.assertRaises(IOError) as cm:
  283. with socket.socket() as sock:
  284. ssl.wrap_socket(sock, certfile=CERTFILE, keyfile=WRONGCERT)
  285. self.assertEqual(cm.exception.errno, errno.ENOENT)
  286. with self.assertRaises(IOError) as cm:
  287. with socket.socket() as sock:
  288. ssl.wrap_socket(sock, certfile=WRONGCERT, keyfile=WRONGCERT)
  289. self.assertEqual(cm.exception.errno, errno.ENOENT)
  290. def test_match_hostname(self):
  291. def ok(cert, hostname):
  292. ssl.match_hostname(cert, hostname)
  293. def fail(cert, hostname):
  294. self.assertRaises(ssl.CertificateError,
  295. ssl.match_hostname, cert, hostname)
  296. cert = {'subject': ((('commonName', 'example.com'),),)}
  297. ok(cert, 'example.com')
  298. ok(cert, 'ExAmple.cOm')
  299. fail(cert, 'www.example.com')
  300. fail(cert, '.example.com')
  301. fail(cert, 'example.org')
  302. fail(cert, 'exampleXcom')
  303. cert = {'subject': ((('commonName', '*.a.com'),),)}
  304. ok(cert, 'foo.a.com')
  305. fail(cert, 'bar.foo.a.com')
  306. fail(cert, 'a.com')
  307. fail(cert, 'Xa.com')
  308. fail(cert, '.a.com')
  309. # only match one left-most wildcard
  310. cert = {'subject': ((('commonName', 'f*.com'),),)}
  311. ok(cert, 'foo.com')
  312. ok(cert, 'f.com')
  313. fail(cert, 'bar.com')
  314. fail(cert, 'foo.a.com')
  315. fail(cert, 'bar.foo.com')
  316. # NULL bytes are bad, CVE-2013-4073
  317. cert = {'subject': ((('commonName',
  318. 'null.python.org\x00example.org'),),)}
  319. ok(cert, 'null.python.org\x00example.org') # or raise an error?
  320. fail(cert, 'example.org')
  321. fail(cert, 'null.python.org')
  322. # error cases with wildcards
  323. cert = {'subject': ((('commonName', '*.*.a.com'),),)}
  324. fail(cert, 'bar.foo.a.com')
  325. fail(cert, 'a.com')
  326. fail(cert, 'Xa.com')
  327. fail(cert, '.a.com')
  328. cert = {'subject': ((('commonName', 'a.*.com'),),)}
  329. fail(cert, 'a.foo.com')
  330. fail(cert, 'a..com')
  331. fail(cert, 'a.com')
  332. # wildcard doesn't match IDNA prefix 'xn--'
  333. idna = 'püthon.python.org'.encode("idna").decode("ascii")
  334. cert = {'subject': ((('commonName', idna),),)}
  335. ok(cert, idna)
  336. cert = {'subject': ((('commonName', 'x*.python.org'),),)}
  337. fail(cert, idna)
  338. cert = {'subject': ((('commonName', 'xn--p*.python.org'),),)}
  339. fail(cert, idna)
  340. # wildcard in first fragment and IDNA A-labels in sequent fragments
  341. # are supported.
  342. idna = 'www*.pythön.org'.encode("idna").decode("ascii")
  343. cert = {'subject': ((('commonName', idna),),)}
  344. ok(cert, 'www.pythön.org'.encode("idna").decode("ascii"))
  345. ok(cert, 'www1.pythön.org'.encode("idna").decode("ascii"))
  346. fail(cert, 'ftp.pythön.org'.encode("idna").decode("ascii"))
  347. fail(cert, 'pythön.org'.encode("idna").decode("ascii"))
  348. # Slightly fake real-world example
  349. cert = {'notAfter': 'Jun 26 21:41:46 2011 GMT',
  350. 'subject': ((('commonName', 'linuxfrz.org'),),),
  351. 'subjectAltName': (('DNS', 'linuxfr.org'),
  352. ('DNS', 'linuxfr.com'),
  353. ('othername', '<unsupported>'))}
  354. ok(cert, 'linuxfr.org')
  355. ok(cert, 'linuxfr.com')
  356. # Not a "DNS" entry
  357. fail(cert, '<unsupported>')
  358. # When there is a subjectAltName, commonName isn't used
  359. fail(cert, 'linuxfrz.org')
  360. # A pristine real-world example
  361. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  362. 'subject': ((('countryName', 'US'),),
  363. (('stateOrProvinceName', 'California'),),
  364. (('localityName', 'Mountain View'),),
  365. (('organizationName', 'Google Inc'),),
  366. (('commonName', 'mail.google.com'),))}
  367. ok(cert, 'mail.google.com')
  368. fail(cert, 'gmail.com')
  369. # Only commonName is considered
  370. fail(cert, 'California')
  371. # Neither commonName nor subjectAltName
  372. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  373. 'subject': ((('countryName', 'US'),),
  374. (('stateOrProvinceName', 'California'),),
  375. (('localityName', 'Mountain View'),),
  376. (('organizationName', 'Google Inc'),))}
  377. fail(cert, 'mail.google.com')
  378. # No DNS entry in subjectAltName but a commonName
  379. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  380. 'subject': ((('countryName', 'US'),),
  381. (('stateOrProvinceName', 'California'),),
  382. (('localityName', 'Mountain View'),),
  383. (('commonName', 'mail.google.com'),)),
  384. 'subjectAltName': (('othername', 'blabla'), )}
  385. ok(cert, 'mail.google.com')
  386. # No DNS entry subjectAltName and no commonName
  387. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  388. 'subject': ((('countryName', 'US'),),
  389. (('stateOrProvinceName', 'California'),),
  390. (('localityName', 'Mountain View'),),
  391. (('organizationName', 'Google Inc'),)),
  392. 'subjectAltName': (('othername', 'blabla'),)}
  393. fail(cert, 'google.com')
  394. # Empty cert / no cert
  395. self.assertRaises(ValueError, ssl.match_hostname, None, 'example.com')
  396. self.assertRaises(ValueError, ssl.match_hostname, {}, 'example.com')
  397. # Issue #17980: avoid denials of service by refusing more than one
  398. # wildcard per fragment.
  399. cert = {'subject': ((('commonName', 'a*b.com'),),)}
  400. ok(cert, 'axxb.com')
  401. cert = {'subject': ((('commonName', 'a*b.co*'),),)}
  402. fail(cert, 'axxb.com')
  403. cert = {'subject': ((('commonName', 'a*b*.com'),),)}
  404. with self.assertRaises(ssl.CertificateError) as cm:
  405. ssl.match_hostname(cert, 'axxbxxc.com')
  406. self.assertIn("too many wildcards", str(cm.exception))
  407. def test_server_side(self):
  408. # server_hostname doesn't work for server sockets
  409. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  410. with socket.socket() as sock:
  411. self.assertRaises(ValueError, ctx.wrap_socket, sock, True,
  412. server_hostname="some.hostname")
  413. def test_unknown_channel_binding(self):
  414. # should raise ValueError for unknown type
  415. s = socket.socket(socket.AF_INET)
  416. with ssl.wrap_socket(s) as ss:
  417. with self.assertRaises(ValueError):
  418. ss.get_channel_binding("unknown-type")
  419. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  420. "'tls-unique' channel binding not available")
  421. def test_tls_unique_channel_binding(self):
  422. # unconnected should return None for known type
  423. s = socket.socket(socket.AF_INET)
  424. with ssl.wrap_socket(s) as ss:
  425. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  426. # the same for server-side
  427. s = socket.socket(socket.AF_INET)
  428. with ssl.wrap_socket(s, server_side=True, certfile=CERTFILE) as ss:
  429. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  430. def test_dealloc_warn(self):
  431. ss = ssl.wrap_socket(socket.socket(socket.AF_INET))
  432. r = repr(ss)
  433. with self.assertWarns(ResourceWarning) as cm:
  434. ss = None
  435. support.gc_collect()
  436. self.assertIn(r, str(cm.warning.args[0]))
  437. class ContextTests(unittest.TestCase):
  438. @skip_if_broken_ubuntu_ssl
  439. def test_constructor(self):
  440. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  441. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv2)
  442. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  443. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv3)
  444. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  445. self.assertRaises(TypeError, ssl.SSLContext)
  446. self.assertRaises(ValueError, ssl.SSLContext, -1)
  447. self.assertRaises(ValueError, ssl.SSLContext, 42)
  448. @skip_if_broken_ubuntu_ssl
  449. def test_protocol(self):
  450. for proto in PROTOCOLS:
  451. ctx = ssl.SSLContext(proto)
  452. self.assertEqual(ctx.protocol, proto)
  453. def test_ciphers(self):
  454. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  455. ctx.set_ciphers("ALL")
  456. ctx.set_ciphers("DEFAULT")
  457. with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
  458. ctx.set_ciphers("^$:,;?*'dorothyx")
  459. @skip_if_broken_ubuntu_ssl
  460. def test_options(self):
  461. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  462. # OP_ALL is the default value
  463. self.assertEqual(ssl.OP_ALL, ctx.options)
  464. ctx.options |= ssl.OP_NO_SSLv2
  465. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2,
  466. ctx.options)
  467. ctx.options |= ssl.OP_NO_SSLv3
  468. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3,
  469. ctx.options)
  470. if can_clear_options():
  471. ctx.options = (ctx.options & ~ssl.OP_NO_SSLv2) | ssl.OP_NO_TLSv1
  472. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_TLSv1 | ssl.OP_NO_SSLv3,
  473. ctx.options)
  474. ctx.options = 0
  475. self.assertEqual(0, ctx.options)
  476. else:
  477. with self.assertRaises(ValueError):
  478. ctx.options = 0
  479. def test_verify(self):
  480. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  481. # Default value
  482. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  483. ctx.verify_mode = ssl.CERT_OPTIONAL
  484. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  485. ctx.verify_mode = ssl.CERT_REQUIRED
  486. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  487. ctx.verify_mode = ssl.CERT_NONE
  488. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  489. with self.assertRaises(TypeError):
  490. ctx.verify_mode = None
  491. with self.assertRaises(ValueError):
  492. ctx.verify_mode = 42
  493. def test_load_cert_chain(self):
  494. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  495. # Combined key and cert in a single file
  496. ctx.load_cert_chain(CERTFILE)
  497. ctx.load_cert_chain(CERTFILE, keyfile=CERTFILE)
  498. self.assertRaises(TypeError, ctx.load_cert_chain, keyfile=CERTFILE)
  499. with self.assertRaises(IOError) as cm:
  500. ctx.load_cert_chain(WRONGCERT)
  501. self.assertEqual(cm.exception.errno, errno.ENOENT)
  502. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  503. ctx.load_cert_chain(BADCERT)
  504. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  505. ctx.load_cert_chain(EMPTYCERT)
  506. # Separate key and cert
  507. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  508. ctx.load_cert_chain(ONLYCERT, ONLYKEY)
  509. ctx.load_cert_chain(certfile=ONLYCERT, keyfile=ONLYKEY)
  510. ctx.load_cert_chain(certfile=BYTES_ONLYCERT, keyfile=BYTES_ONLYKEY)
  511. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  512. ctx.load_cert_chain(ONLYCERT)
  513. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  514. ctx.load_cert_chain(ONLYKEY)
  515. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  516. ctx.load_cert_chain(certfile=ONLYKEY, keyfile=ONLYCERT)
  517. # Mismatching key and cert
  518. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  519. with self.assertRaisesRegex(ssl.SSLError, "key values mismatch"):
  520. ctx.load_cert_chain(SVN_PYTHON_ORG_ROOT_CERT, ONLYKEY)
  521. # Password protected key and cert
  522. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD)
  523. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD.encode())
  524. ctx.load_cert_chain(CERTFILE_PROTECTED,
  525. password=bytearray(KEY_PASSWORD.encode()))
  526. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD)
  527. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD.encode())
  528. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED,
  529. bytearray(KEY_PASSWORD.encode()))
  530. with self.assertRaisesRegex(TypeError, "should be a string"):
  531. ctx.load_cert_chain(CERTFILE_PROTECTED, password=True)
  532. with self.assertRaises(ssl.SSLError):
  533. ctx.load_cert_chain(CERTFILE_PROTECTED, password="badpass")
  534. with self.assertRaisesRegex(ValueError, "cannot be longer"):
  535. # openssl has a fixed limit on the password buffer.
  536. # PEM_BUFSIZE is generally set to 1kb.
  537. # Return a string larger than this.
  538. ctx.load_cert_chain(CERTFILE_PROTECTED, password=b'a' * 102400)
  539. # Password callback
  540. def getpass_unicode():
  541. return KEY_PASSWORD
  542. def getpass_bytes():
  543. return KEY_PASSWORD.encode()
  544. def getpass_bytearray():
  545. return bytearray(KEY_PASSWORD.encode())
  546. def getpass_badpass():
  547. return "badpass"
  548. def getpass_huge():
  549. return b'a' * (1024 * 1024)
  550. def getpass_bad_type():
  551. return 9
  552. def getpass_exception():
  553. raise Exception('getpass error')
  554. class GetPassCallable:
  555. def __call__(self):
  556. return KEY_PASSWORD
  557. def getpass(self):
  558. return KEY_PASSWORD
  559. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_unicode)
  560. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytes)
  561. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytearray)
  562. ctx.load_cert_chain(CERTFILE_PROTECTED, password=GetPassCallable())
  563. ctx.load_cert_chain(CERTFILE_PROTECTED,
  564. password=GetPassCallable().getpass)
  565. with self.assertRaises(ssl.SSLError):
  566. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_badpass)
  567. with self.assertRaisesRegex(ValueError, "cannot be longer"):
  568. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_huge)
  569. with self.assertRaisesRegex(TypeError, "must return a string"):
  570. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bad_type)
  571. with self.assertRaisesRegex(Exception, "getpass error"):
  572. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_exception)
  573. # Make sure the password function isn't called if it isn't needed
  574. ctx.load_cert_chain(CERTFILE, password=getpass_exception)
  575. def test_load_verify_locations(self):
  576. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  577. ctx.load_verify_locations(CERTFILE)
  578. ctx.load_verify_locations(cafile=CERTFILE, capath=None)
  579. ctx.load_verify_locations(BYTES_CERTFILE)
  580. ctx.load_verify_locations(cafile=BYTES_CERTFILE, capath=None)
  581. self.assertRaises(TypeError, ctx.load_verify_locations)
  582. self.assertRaises(TypeError, ctx.load_verify_locations, None, None)
  583. with self.assertRaises(IOError) as cm:
  584. ctx.load_verify_locations(WRONGCERT)
  585. self.assertEqual(cm.exception.errno, errno.ENOENT)
  586. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  587. ctx.load_verify_locations(BADCERT)
  588. ctx.load_verify_locations(CERTFILE, CAPATH)
  589. ctx.load_verify_locations(CERTFILE, capath=BYTES_CAPATH)
  590. # Issue #10989: crash if the second argument type is invalid
  591. self.assertRaises(TypeError, ctx.load_verify_locations, None, True)
  592. def test_load_dh_params(self):
  593. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  594. ctx.load_dh_params(DHFILE)
  595. if os.name != 'nt':
  596. ctx.load_dh_params(BYTES_DHFILE)
  597. self.assertRaises(TypeError, ctx.load_dh_params)
  598. self.assertRaises(TypeError, ctx.load_dh_params, None)
  599. with self.assertRaises(FileNotFoundError) as cm:
  600. ctx.load_dh_params(WRONGCERT)
  601. self.assertEqual(cm.exception.errno, errno.ENOENT)
  602. with self.assertRaises(ssl.SSLError) as cm:
  603. ctx.load_dh_params(CERTFILE)
  604. @skip_if_broken_ubuntu_ssl
  605. def test_session_stats(self):
  606. for proto in PROTOCOLS:
  607. ctx = ssl.SSLContext(proto)
  608. self.assertEqual(ctx.session_stats(), {
  609. 'number': 0,
  610. 'connect': 0,
  611. 'connect_good': 0,
  612. 'connect_renegotiate': 0,
  613. 'accept': 0,
  614. 'accept_good': 0,
  615. 'accept_renegotiate': 0,
  616. 'hits': 0,
  617. 'misses': 0,
  618. 'timeouts': 0,
  619. 'cache_full': 0,
  620. })
  621. def test_set_default_verify_paths(self):
  622. # There's not much we can do to test that it acts as expected,
  623. # so just check it doesn't crash or raise an exception.
  624. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  625. ctx.set_default_verify_paths()
  626. @unittest.skipUnless(ssl.HAS_ECDH, "ECDH disabled on this OpenSSL build")
  627. def test_set_ecdh_curve(self):
  628. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  629. ctx.set_ecdh_curve("prime256v1")
  630. ctx.set_ecdh_curve(b"prime256v1")
  631. self.assertRaises(TypeError, ctx.set_ecdh_curve)
  632. self.assertRaises(TypeError, ctx.set_ecdh_curve, None)
  633. self.assertRaises(ValueError, ctx.set_ecdh_curve, "foo")
  634. self.assertRaises(ValueError, ctx.set_ecdh_curve, b"foo")
  635. class SSLErrorTests(unittest.TestCase):
  636. def test_str(self):
  637. # The str() of a SSLError doesn't include the errno
  638. e = ssl.SSLError(1, "foo")
  639. self.assertEqual(str(e), "foo")
  640. self.assertEqual(e.errno, 1)
  641. # Same for a subclass
  642. e = ssl.SSLZeroReturnError(1, "foo")
  643. self.assertEqual(str(e), "foo")
  644. self.assertEqual(e.errno, 1)
  645. def test_lib_reason(self):
  646. # Test the library and reason attributes
  647. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  648. with self.assertRaises(ssl.SSLError) as cm:
  649. ctx.load_dh_params(CERTFILE)
  650. self.assertEqual(cm.exception.library, 'PEM')
  651. self.assertEqual(cm.exception.reason, 'NO_START_LINE')
  652. s = str(cm.exception)
  653. self.assertTrue(s.startswith("[PEM: NO_START_LINE] no start line"), s)
  654. def test_subclass(self):
  655. # Check that the appropriate SSLError subclass is raised
  656. # (this only tests one of them)
  657. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  658. with socket.socket() as s:
  659. s.bind(("127.0.0.1", 0))
  660. s.listen(5)
  661. c = socket.socket()
  662. c.connect(s.getsockname())
  663. c.setblocking(False)
  664. with ctx.wrap_socket(c, False, do_handshake_on_connect=False) as c:
  665. with self.assertRaises(ssl.SSLWantReadError) as cm:
  666. c.do_handshake()
  667. s = str(cm.exception)
  668. self.assertTrue(s.startswith("The operation did not complete (read)"), s)
  669. # For compatibility
  670. self.assertEqual(cm.exception.errno, ssl.SSL_ERROR_WANT_READ)
  671. class NetworkedTests(unittest.TestCase):
  672. def test_connect(self):
  673. with support.transient_internet("svn.python.org"):
  674. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  675. cert_reqs=ssl.CERT_NONE)
  676. try:
  677. s.connect(("svn.python.org", 443))
  678. self.assertEqual({}, s.getpeercert())
  679. finally:
  680. s.close()
  681. # this should fail because we have no verification certs
  682. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  683. cert_reqs=ssl.CERT_REQUIRED)
  684. self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
  685. s.connect, ("svn.python.org", 443))
  686. s.close()
  687. # this should succeed because we specify the root cert
  688. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  689. cert_reqs=ssl.CERT_REQUIRED,
  690. ca_certs=SVN_PYTHON_ORG_ROOT_CERT)
  691. try:
  692. s.connect(("svn.python.org", 443))
  693. self.assertTrue(s.getpeercert())
  694. finally:
  695. s.close()
  696. def test_connect_ex(self):
  697. # Issue #11326: check connect_ex() implementation
  698. with support.transient_internet("svn.python.org"):
  699. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  700. cert_reqs=ssl.CERT_REQUIRED,
  701. ca_certs=SVN_PYTHON_ORG_ROOT_CERT)
  702. try:
  703. self.assertEqual(0, s.connect_ex(("svn.python.org", 443)))
  704. self.assertTrue(s.getpeercert())
  705. finally:
  706. s.close()
  707. def test_non_blocking_connect_ex(self):
  708. # Issue #11326: non-blocking connect_ex() should allow handshake
  709. # to proceed after the socket gets ready.
  710. with support.transient_internet("svn.python.org"):
  711. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  712. cert_reqs=ssl.CERT_REQUIRED,
  713. ca_certs=SVN_PYTHON_ORG_ROOT_CERT,
  714. do_handshake_on_connect=False)
  715. try:
  716. s.setblocking(False)
  717. rc = s.connect_ex(('svn.python.org', 443))
  718. # EWOULDBLOCK under Windows, EINPROGRESS elsewhere
  719. self.assertIn(rc, (0, errno.EINPROGRESS, errno.EWOULDBLOCK))
  720. # Wait for connect to finish
  721. select.select([], [s], [], 5.0)
  722. # Non-blocking handshake
  723. while True:
  724. try:
  725. s.do_handshake()
  726. break
  727. except ssl.SSLWantReadError:
  728. select.select([s], [], [], 5.0)
  729. except ssl.SSLWantWriteError:
  730. select.select([], [s], [], 5.0)
  731. # SSL established
  732. self.assertTrue(s.getpeercert())
  733. finally:
  734. s.close()
  735. def test_timeout_connect_ex(self):
  736. # Issue #12065: on a timeout, connect_ex() should return the original
  737. # errno (mimicking the behaviour of non-SSL sockets).
  738. with support.transient_internet("svn.python.org"):
  739. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  740. cert_reqs=ssl.CERT_REQUIRED,
  741. ca_certs=SVN_PYTHON_ORG_ROOT_CERT,
  742. do_handshake_on_connect=False)
  743. try:
  744. s.settimeout(0.0000001)
  745. rc = s.connect_ex(('svn.python.org', 443))
  746. if rc == 0:
  747. self.skipTest("svn.python.org responded too quickly")
  748. self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
  749. finally:
  750. s.close()
  751. def test_connect_ex_error(self):
  752. with support.transient_internet("svn.python.org"):
  753. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  754. cert_reqs=ssl.CERT_REQUIRED,
  755. ca_certs=SVN_PYTHON_ORG_ROOT_CERT)
  756. try:
  757. self.assertEqual(errno.ECONNREFUSED,
  758. s.connect_ex(("svn.python.org", 444)))
  759. finally:
  760. s.close()
  761. def test_connect_with_context(self):
  762. with support.transient_internet("svn.python.org"):
  763. # Same as test_connect, but with a separately created context
  764. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  765. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  766. s.connect(("svn.python.org", 443))
  767. try:
  768. self.assertEqual({}, s.getpeercert())
  769. finally:
  770. s.close()
  771. # Same with a server hostname
  772. s = ctx.wrap_socket(socket.socket(socket.AF_INET),
  773. server_hostname="svn.python.org")
  774. if ssl.HAS_SNI:
  775. s.connect(("svn.python.org", 443))
  776. s.close()
  777. else:
  778. self.assertRaises(ValueError, s.connect, ("svn.python.org", 443))
  779. # This should fail because we have no verification certs
  780. ctx.verify_mode = ssl.CERT_REQUIRED
  781. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  782. self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
  783. s.connect, ("svn.python.org", 443))
  784. s.close()
  785. # This should succeed because we specify the root cert
  786. ctx.load_verify_locations(SVN_PYTHON_ORG_ROOT_CERT)
  787. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  788. s.connect(("svn.python.org", 443))
  789. try:
  790. cert = s.getpeercert()
  791. self.assertTrue(cert)
  792. finally:
  793. s.close()
  794. def test_connect_capath(self):
  795. # Verify server certificates using the `capath` argument
  796. # NOTE: the subject hashing algorithm has been changed between
  797. # OpenSSL 0.9.8n and 1.0.0, as a result the capath directory must
  798. # contain both versions of each certificate (same content, different
  799. # filename) for this test to be portable across OpenSSL releases.
  800. with support.transient_internet("svn.python.org"):
  801. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  802. ctx.verify_mode = ssl.CERT_REQUIRED
  803. ctx.load_verify_locations(capath=CAPATH)
  804. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  805. s.connect(("svn.python.org", 443))
  806. try:
  807. cert = s.getpeercert()
  808. self.assertTrue(cert)
  809. finally:
  810. s.close()
  811. # Same with a bytes `capath` argument
  812. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  813. ctx.verify_mode = ssl.CERT_REQUIRED
  814. ctx.load_verify_locations(capath=BYTES_CAPATH)
  815. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  816. s.connect(("svn.python.org", 443))
  817. try:
  818. cert = s.getpeercert()
  819. self.assertTrue(cert)
  820. finally:
  821. s.close()
  822. @unittest.skipIf(os.name == "nt", "Can't use a socket as a file under Windows")
  823. def test_makefile_close(self):
  824. # Issue #5238: creating a file-like object with makefile() shouldn't
  825. # delay closing the underlying "real socket" (here tested with its
  826. # file descriptor, hence skipping the test under Windows).
  827. with support.transient_internet("svn.python.org"):
  828. ss = ssl.wrap_socket(socket.socket(socket.AF_INET))
  829. ss.connect(("svn.python.org", 443))
  830. fd = ss.fileno()
  831. f = ss.makefile()
  832. f.close()
  833. # The fd is still open
  834. os.read(fd, 0)
  835. # Closing the SSL socket should close the fd too
  836. ss.close()
  837. gc.collect()
  838. with self.assertRaises(OSError) as e:
  839. os.read(fd, 0)
  840. self.assertEqual(e.exception.errno, errno.EBADF)
  841. def test_non_blocking_handshake(self):
  842. with support.transient_internet("svn.python.org"):
  843. s = socket.socket(socket.AF_INET)
  844. s.connect(("svn.python.org", 443))
  845. s.setblocking(False)
  846. s = ssl.wrap_socket(s,
  847. cert_reqs=ssl.CERT_NONE,
  848. do_handshake_on_connect=False)
  849. count = 0
  850. while True:
  851. try:
  852. count += 1
  853. s.do_handshake()
  854. break
  855. except ssl.SSLWantReadError:
  856. select.select([s], [], [])
  857. except ssl.SSLWantWriteError:
  858. select.select([], [s], [])
  859. s.close()
  860. if support.verbose:
  861. sys.stdout.write("\nNeeded %d calls to do_handshake() to establish session.\n" % count)
  862. def test_get_server_certificate(self):
  863. def _test_get_server_certificate(host, port, cert=None):
  864. with support.transient_internet(host):
  865. pem = ssl.get_server_certificate((host, port))
  866. if not pem:
  867. self.fail("No server certificate on %s:%s!" % (host, port))
  868. try:
  869. pem = ssl.get_server_certificate((host, port), ca_certs=CERTFILE)
  870. except ssl.SSLError as x:
  871. #should fail
  872. if support.verbose:
  873. sys.stdout.write("%s\n" % x)
  874. else:
  875. self.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
  876. pem = ssl.get_server_certificate((host, port), ca_certs=cert)
  877. if not pem:
  878. self.fail("No server certificate on %s:%s!" % (host, port))
  879. if support.verbose:
  880. sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
  881. _test_get_server_certificate('svn.python.org', 443, SVN_PYTHON_ORG_ROOT_CERT)
  882. if support.IPV6_ENABLED:
  883. _test_get_server_certificate('ipv6.google.com', 443)
  884. def test_ciphers(self):
  885. remote = ("svn.python.org", 443)
  886. with support.transient_internet(remote[0]):
  887. with ssl.wrap_socket(socket.socket(socket.AF_INET),
  888. cert_reqs=ssl.CERT_NONE, ciphers="ALL") as s:
  889. s.connect(remote)
  890. with ssl.wrap_socket(socket.socket(socket.AF_INET),
  891. cert_reqs=ssl.CERT_NONE, ciphers="DEFAULT") as s:
  892. s.connect(remote)
  893. # Error checking can happen at instantiation or when connecting
  894. with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
  895. with socket.socket(socket.AF_INET) as sock:
  896. s = ssl.wrap_socket(sock,
  897. cert_reqs=ssl.CERT_NONE, ciphers="^$:,;?*'dorothyx")
  898. s.connect(remote)
  899. def test_algorithms(self):
  900. # Issue #8484: all algorithms should be available when verifying a
  901. # certificate.
  902. # SHA256 was added in OpenSSL 0.9.8
  903. if ssl.OPENSSL_VERSION_INFO < (0, 9, 8, 0, 15):
  904. self.skipTest("SHA256 not available on %r" % ssl.OPENSSL_VERSION)
  905. # sha256.tbs-internet.com needs SNI to use the correct certificate
  906. if not ssl.HAS_SNI:
  907. self.skipTest("SNI needed for this test")
  908. # https://sha2.hboeck.de/ was used until 2011-01-08 (no route to host)
  909. remote = ("sha256.tbs-internet.com", 443)
  910. sha256_cert = os.path.join(os.path.dirname(__file__), "sha256.pem")
  911. with support.transient_internet("sha256.tbs-internet.com"):
  912. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  913. ctx.verify_mode = ssl.CERT_REQUIRED
  914. ctx.load_verify_locations(sha256_cert)
  915. s = ctx.wrap_socket(socket.socket(socket.AF_INET),
  916. server_hostname="sha256.tbs-internet.com")
  917. try:
  918. s.connect(remote)
  919. if support.verbose:
  920. sys.stdout.write("\nCipher with %r is %r\n" %
  921. (remote, s.cipher()))
  922. sys.stdout.write("Certificate is:\n%s\n" %
  923. pprint.pformat(s.getpeercert()))
  924. finally:
  925. s.close()
  926. try:
  927. import threading
  928. except ImportError:
  929. _have_threads = False
  930. else:
  931. _have_threads = True
  932. from test.ssl_servers import make_https_server
  933. class ThreadedEchoServer(threading.Thread):
  934. class ConnectionHandler(threading.Thread):
  935. """A mildly complicated class, because we want it to work both
  936. with and without the SSL wrapper around the socket connection, so
  937. that we can test the STARTTLS functionality."""
  938. def __init__(self, server, connsock, addr):
  939. self.server = server
  940. self.running = False
  941. self.sock = connsock
  942. self.addr = addr
  943. self.sock.setblocking(1)
  944. self.sslconn = None
  945. threading.Thread.__init__(self)
  946. self.daemon = True
  947. def wrap_conn(self):
  948. try:
  949. self.sslconn = self.server.context.wrap_socket(
  950. self.sock, server_side=True)
  951. self.server.selected_protocols.append(self.sslconn.selected_npn_protocol())
  952. except (ssl.SSLError, ConnectionResetError) as e:
  953. # We treat ConnectionResetError as though it were an
  954. # SSLError - OpenSSL on Ubuntu abruptly closes the
  955. # connection when asked to use an unsupported protocol.
  956. #
  957. # XXX Various errors can have happened here, for example
  958. # a mismatching protocol version, an invalid certificate,
  959. # or a low-level bug. This should be made more discriminating.
  960. self.server.conn_errors.append(e)
  961. if self.server.chatty:
  962. handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
  963. self.running = False
  964. self.server.stop()
  965. self.close()
  966. return False
  967. else:
  968. if self.server.context.verify_mode == ssl.CERT_REQUIRED:
  969. cert = self.sslconn.getpeercert()
  970. if support.verbose and self.server.chatty:
  971. sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
  972. cert_binary = self.sslconn.getpeercert(True)
  973. if support.verbose and self.server.chatty:
  974. sys.stdout.write(" cert binary is " + str(len(cert_binary)) + " bytes\n")
  975. cipher = self.sslconn.cipher()
  976. if support.verbose and self.server.chatty:
  977. sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
  978. sys.stdout.write(" server: selected protocol is now "
  979. + str(self.sslconn.selected_npn_protocol()) + "\n")
  980. return True
  981. def read(self):
  982. if self.sslconn:
  983. return self.sslconn.read()
  984. else:
  985. return self.sock.recv(1024)
  986. def write(self, bytes):
  987. if self.sslconn:
  988. return self.sslconn.write(bytes)
  989. else:
  990. return self.sock.send(bytes)
  991. def close(self):
  992. if self.sslconn:
  993. self.sslconn.close()
  994. else:
  995. self.sock.close()
  996. def run(self):
  997. self.running = True
  998. if not self.server.starttls_server:
  999. if not self.wrap_conn():
  1000. return
  1001. while self.running:
  1002. try:
  1003. msg = self.read()
  1004. stripped = msg.strip()
  1005. if not stripped:
  1006. # eof, so quit this handler
  1007. self.running = False
  1008. self.close()
  1009. elif stripped == b'over':
  1010. if support.verbose and self.server.connectionchatty:
  1011. sys.stdout.write(" server: client closed connection\n")
  1012. self.close()
  1013. return
  1014. elif (self.server.starttls_server and
  1015. stripped == b'STARTTLS'):
  1016. if support.verbose and self.server.connectionchatty:
  1017. sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
  1018. self.write(b"OK\n")
  1019. if not self.wrap_conn():
  1020. return
  1021. elif (self.server.starttls_server and self.sslconn
  1022. and stripped == b'ENDTLS'):
  1023. if support.verbose and self.server.connectionchatty:
  1024. sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
  1025. self.write(b"OK\n")
  1026. self.sock = self.sslconn.unwrap()
  1027. self.sslconn = None
  1028. if support.verbose and self.server.connectionchatty:
  1029. sys.stdout.write(" server: connection is now unencrypted...\n")
  1030. elif stripped == b'CB tls-unique':
  1031. if support.verbose and self.server.connectionchatty:
  1032. sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
  1033. data = self.sslconn.get_channel_binding("tls-unique")
  1034. self.write(repr(data).encode("us-ascii") + b"\n")
  1035. else:
  1036. if (support.verbose and
  1037. self.server.connectionchatty):
  1038. ctype = (self.sslconn and "encrypted") or "unencrypted"
  1039. sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
  1040. % (msg, ctype, msg.lower(), ctype))
  1041. self.write(msg.lower())
  1042. except socket.error:
  1043. if self.server.chatty:
  1044. handle_error("Test server failure:\n")
  1045. self.close()
  1046. self.running = False
  1047. # normally, we'd just stop here, but for the test
  1048. # harness, we want to stop the server
  1049. self.server.stop()
  1050. def __init__(self, certificate=None, ssl_version=None,
  1051. certreqs=None, cacerts=None,
  1052. chatty=True, connectionchatty=False, starttls_server=False,
  1053. npn_protocols=None, ciphers=None, context=None):
  1054. if context:
  1055. self.context = context
  1056. else:
  1057. self.context = ssl.SSLContext(ssl_version
  1058. if ssl_version is not None
  1059. else ssl.PROTOCOL_TLSv1)
  1060. self.context.verify_mode = (certreqs if certreqs is not None
  1061. else ssl.CERT_NONE)
  1062. if cacerts:
  1063. self.context.load_verify_locations(cacerts)
  1064. if certificate:
  1065. self.context.load_cert_chain(certificate)
  1066. if npn_protocols:
  1067. self.context.set_npn_protocols(npn_protocols)
  1068. if ciphers:
  1069. self.context.set_ciphers(ciphers)
  1070. self.chatty = chatty
  1071. self.connectionchatty = connectionchatty
  1072. self.starttls_server = starttls_server
  1073. self.sock = socket.socket()
  1074. self.port = support.bind_port(self.sock)
  1075. self.flag = None
  1076. self.active = False
  1077. self.selected_protocols = []
  1078. self.conn_errors = []
  1079. threading.Thread.__init__(self)
  1080. self.daemon = True
  1081. def __enter__(self):
  1082. self.start(threading.Event())
  1083. self.flag.wait()
  1084. return self
  1085. def __exit__(self, *args):
  1086. self.stop()
  1087. self.join()
  1088. def start(self, flag=None):
  1089. self.flag = flag
  1090. threading.Thread.start(self)
  1091. def run(self):
  1092. self.sock.settimeout(0.05)
  1093. self.sock.listen(5)
  1094. self.active = True
  1095. if self.flag:
  1096. # signal an event
  1097. self.flag.set()
  1098. while self.active:
  1099. try:
  1100. newconn, connaddr = self.sock.accept()
  1101. if support.verbose and self.chatty:
  1102. sys.stdout.write(' server: new connection from '
  1103. + repr(connaddr) + '\n')
  1104. handler = self.ConnectionHandler(self, newconn, connaddr)
  1105. handler.start()
  1106. handler.join()
  1107. except socket.timeout:
  1108. pass
  1109. except KeyboardInterrupt:
  1110. self.stop()
  1111. self.sock.close()
  1112. def stop(self):
  1113. self.active = False
  1114. class AsyncoreEchoServer(threading.Thread):
  1115. # this one's based on asyncore.dispatcher
  1116. class EchoServer (asyncore.dispatcher):
  1117. class ConnectionHandler (asyncore.dispatcher_with_send):
  1118. def __init__(self, conn, certfile):
  1119. self.socket = ssl.wrap_socket(conn, server_side=True,
  1120. certfile=certfile,
  1121. do_handshake_on_connect=False)
  1122. asyncore.dispatcher_with_send.__init__(self, self.socket)
  1123. self._ssl_accepting = True
  1124. self._do_ssl_handshake()
  1125. def readable(self):
  1126. if isinstance(self.socket, ssl.SSLSocket):
  1127. while self.socket.pending() > 0:
  1128. self.handle_read_event()
  1129. return True
  1130. def _do_ssl_handshake(self):
  1131. try:
  1132. self.socket.do_handshake()
  1133. except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
  1134. return
  1135. except ssl.SSLEOFError:
  1136. return self.handle_close()
  1137. except ssl.SSLError:
  1138. raise
  1139. except socket.error as err:
  1140. if err.args[0] == errno.ECONNABORTED:
  1141. return self.handle_close()
  1142. else:
  1143. self._ssl_accepting = False
  1144. def handle_read(self):
  1145. if self._ssl_accepting:
  1146. self._do_ssl_handshake()
  1147. else:
  1148. data = self.recv(1024)
  1149. if support.verbose:
  1150. sys.stdout.write(" server: read %s from client\n" % repr(data))
  1151. if not data:
  1152. self.close()
  1153. else:
  1154. self.send(data.lower())
  1155. def handle_close(self):
  1156. self.close()
  1157. if support.verbose:
  1158. sys.stdout.write(" server: closed connection %s\n" % self.socket)
  1159. def handle_error(self):
  1160. raise
  1161. def __init__(self, certfile):
  1162. self.certfile = certfile
  1163. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1164. self.port = support.bind_port(sock, '')
  1165. asyncore.dispatcher.__init__(self, sock)
  1166. self.listen(5)
  1167. def handle_accepted(self, sock_obj, addr):
  1168. if support.verbose:
  1169. sys.stdout.write(" server: new connection from %s:%s\n" %addr)
  1170. self.ConnectionHandler(sock_obj, self.certfile)
  1171. def handle_error(self):
  1172. raise
  1173. def __init__(self, certfile):
  1174. self.flag = None
  1175. self.active = False
  1176. self.server = self.EchoServer(certfile)
  1177. self.port = self.server.port
  1178. threading.Thread.__init__(self)
  1179. self.daemon = True
  1180. def __str__(self):
  1181. return "<%s %s>" % (self.__class__.__name__, self.server)
  1182. def __enter__(self):
  1183. self.start(threading.Event())
  1184. self.flag.wait()
  1185. return self
  1186. def __exit__(self, *args):
  1187. if support.verbose:
  1188. sys.stdout.write(" cleanup: stopping server.\n")
  1189. self.stop()
  1190. if support.verbose:
  1191. sys.stdout.write(" cleanup: joining server thread.\n")
  1192. self.join()
  1193. if support.verbose:
  1194. sys.stdout.write(" cleanup: successfully joined.\n")
  1195. def start (self, flag=None):
  1196. self.flag = flag
  1197. threading.Thread.start(self)
  1198. def run(self):
  1199. self.active = True
  1200. if self.flag:
  1201. self.flag.set()
  1202. while self.active:
  1203. try:
  1204. asyncore.loop(1)
  1205. except:
  1206. pass
  1207. def stop(self):
  1208. self.active = False
  1209. self.server.close()
  1210. def bad_cert_test(certfile):
  1211. """
  1212. Launch a server with CERT_REQUIRED, and check that trying to
  1213. connect to it with the given client certificate fails.
  1214. """
  1215. server = ThreadedEchoServer(CERTFILE,
  1216. certreqs=ssl.CERT_REQUIRED,
  1217. cacerts=CERTFILE, chatty=False,
  1218. connectionchatty=False)
  1219. with server:
  1220. try:
  1221. with socket.socket() as sock:
  1222. s = ssl.wrap_socket(sock,
  1223. certfile=certfile,
  1224. ssl_version=ssl.PROTOCOL_TLSv1)
  1225. s.connect((HOST, server.port))
  1226. except ssl.SSLError as x:
  1227. if support.verbose:
  1228. sys.stdout.write("\nSSLError is %s\n" % x.args[1])
  1229. except socket.error as x:
  1230. if support.verbose:
  1231. sys.stdout.write("\nsocket.error is %s\n" % x.args[1])
  1232. except IOError as x:
  1233. if x.errno != errno.ENOENT:
  1234. raise
  1235. if support.verbose:
  1236. sys.stdout.write("\IOError is %s\n" % str(x))
  1237. else:
  1238. raise AssertionError("Use of invalid cert should have failed!")
  1239. def server_params_test(client_context, server_context, indata=b"FOO\n",
  1240. chatty=True, connectionchatty=False):
  1241. """
  1242. Launch a server, connect a client to it and try various reads
  1243. and writes.
  1244. """
  1245. stats = {}
  1246. server = ThreadedEchoServer(context=server_context,
  1247. chatty=chatty,
  1248. connectionchatty=False)
  1249. with server:
  1250. with client_context.wrap_socket(socket.socket()) as s:
  1251. s.connect((HOST, server.port))
  1252. for arg in [indata, bytearray(indata), memoryview(indata)]:
  1253. if connectionchatty:
  1254. if support.verbose:
  1255. sys.stdout.write(
  1256. " client: sending %r...\n" % indata)
  1257. s.write(arg)
  1258. outdata = s.read()
  1259. if connectionchatty:
  1260. if support.verbose:
  1261. sys.stdout.write(" client: read %r\n" % outdata)
  1262. if outdata != indata.lower():
  1263. raise AssertionError(
  1264. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  1265. % (outdata[:20], len(outdata),
  1266. indata[:20].lower(), len(indata)))
  1267. s.write(b"over\n")
  1268. if connectionchatty:
  1269. if support.verbose:
  1270. sys.stdout.write(" client: closing connection.\n")
  1271. stats.update({
  1272. 'compression': s.compression(),
  1273. 'cipher': s.cipher(),
  1274. 'client_npn_protocol': s.selected_npn_protocol()
  1275. })
  1276. s.close()
  1277. stats['server_npn_protocols'] = server.selected_protocols
  1278. return stats
  1279. def try_protocol_combo(server_protocol, client_protocol, expect_success,
  1280. certsreqs=None, server_options=0, client_options=0):
  1281. if certsreqs is None:
  1282. certsreqs = ssl.CERT_NONE
  1283. certtype = {
  1284. ssl.CERT_NONE: "CERT_NONE",
  1285. ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
  1286. ssl.CERT_REQUIRED: "CERT_REQUIRED",
  1287. }[certsreqs]
  1288. if support.verbose:
  1289. formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
  1290. sys.stdout.write(formatstr %
  1291. (ssl.get_protocol_name(client_protocol),
  1292. ssl.get_protocol_name(server_protocol),
  1293. certtype))
  1294. client_context = ssl.SSLContext(client_protocol)
  1295. client_context.options = ssl.OP_ALL | client_options
  1296. server_context = ssl.SSLContext(server_protocol)
  1297. server_context.options = ssl.OP_ALL | server_options
  1298. for ctx in (client_context, server_context):
  1299. ctx.verify_mode = certsreqs
  1300. # NOTE: we must enable "ALL" ciphers, otherwise an SSLv23 client
  1301. # will send an SSLv3 hello (rather than SSLv2) starting from
  1302. # OpenSSL 1.0.0 (see issue #8322).
  1303. ctx.set_ciphers("ALL")
  1304. ctx.load_cert_chain(CERTFILE)
  1305. ctx.load_verify_locations(CERTFILE)
  1306. try:
  1307. server_params_test(client_context, server_context,
  1308. chatty=False, connectionchatty=False)
  1309. # Protocol mismatch can result in either an SSLError, or a
  1310. # "Connection reset by peer" error.
  1311. except ssl.SSLError:
  1312. if expect_success:
  1313. raise
  1314. except socket.error as e:
  1315. if expect_success or e.errno != errno.ECONNRESET:
  1316. raise
  1317. else:
  1318. if not expect_success:
  1319. raise AssertionError(
  1320. "Client protocol %s succeeded with server protocol %s!"
  1321. % (ssl.get_protocol_name(client_protocol),
  1322. ssl.get_protocol_name(server_protocol)))
  1323. class ThreadedTests(unittest.TestCase):
  1324. @skip_if_broken_ubuntu_ssl
  1325. def test_echo(self):
  1326. """Basic test of an SSL client connecting to a server"""
  1327. if support.verbose:
  1328. sys.stdout.write("\n")
  1329. for protocol in PROTOCOLS:
  1330. context = ssl.SSLContext(protocol)
  1331. context.load_cert_chain(CERTFILE)
  1332. server_params_test(context, context,
  1333. chatty=True, connectionchatty=True)
  1334. def test_getpeercert(self):
  1335. if support.verbose:
  1336. sys.stdout.write("\n")
  1337. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1338. context.verify_mode = ssl.CERT_REQUIRED
  1339. context.load_verify_locations(CERTFILE)
  1340. context.load_cert_chain(CERTFILE)
  1341. server = ThreadedEchoServer(context=context, chatty=False)
  1342. with server:
  1343. s = context.wrap_socket(socket.socket())
  1344. s.connect((HOST, server.port))
  1345. cert = s.getpeercert()
  1346. self.assertTrue(cert, "Can't get peer certificate.")
  1347. cipher = s.cipher()
  1348. if support.verbose:
  1349. sys.stdout.write(pprint.pformat(cert) + '\n')
  1350. sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
  1351. if 'subject' not in cert:
  1352. self.fail("No subject field in certificate: %s." %
  1353. pprint.pformat(cert))
  1354. if ((('organizationName', 'Python Software Foundation'),)
  1355. not in cert['subject']):
  1356. self.fail(
  1357. "Missing or invalid 'organizationName' field in certificate subject; "
  1358. "should be 'Python Software Foundation'.")
  1359. self.assertIn('notBefore', cert)
  1360. self.assertIn('notAfter', cert)
  1361. before = ssl.cert_time_to_seconds(cert['notBefore'])
  1362. after = ssl.cert_time_to_seconds(cert['notAfter'])
  1363. self.assertLess(before, after)
  1364. s.close()
  1365. def test_empty_cert(self):
  1366. """Connecting with an empty cert file"""
  1367. bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
  1368. "nullcert.pem"))
  1369. def test_malformed_cert(self):
  1370. """Connecting with a badly formatted certificate (syntax error)"""
  1371. bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
  1372. "badcert.pem"))
  1373. def test_nonexisting_cert(self):
  1374. """Connecting with a non-existing cert file"""
  1375. bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
  1376. "wrongcert.pem"))
  1377. def test_malformed_key(self):
  1378. """Connecting with a badly formatted key (syntax error)"""
  1379. bad_cert_test(os.path.join(os.path.dirname(__file__) or os.curdir,
  1380. "badkey.pem"))
  1381. def test_rude_shutdown(self):
  1382. """A brutal shutdown of an SSL server should raise an IOError
  1383. in the client when attempting handshake.
  1384. """
  1385. listener_ready = threading.Event()
  1386. listener_gone = threading.Event()
  1387. s = socket.socket()
  1388. port = support.bind_port(s, HOST)
  1389. # `listener` runs in a thread. It sits in an accept() until
  1390. # the main thread connects. Then it rudely closes the socket,
  1391. # and sets Event `listener_gone` to let the main thread know
  1392. # the socket is gone.
  1393. def listener():
  1394. s.listen(5)
  1395. listener_ready.set()
  1396. newsock, addr = s.accept()
  1397. newsock.close()
  1398. s.close()
  1399. listener_gone.set()
  1400. def connector():
  1401. listener_ready.wait()
  1402. with socket.socket() as c:
  1403. c.connect((HOST, port))
  1404. listener_gone.wait()
  1405. try:
  1406. ssl_sock = ssl.wrap_socket(c)
  1407. except IOError:
  1408. pass
  1409. else:
  1410. self.fail('connecting to closed SSL socket should have failed')
  1411. t = threading.Thread(target=listener)
  1412. t.start()
  1413. try:
  1414. connector()
  1415. finally:
  1416. t.join()
  1417. @skip_if_broken_ubuntu_ssl
  1418. @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv2'),
  1419. "OpenSSL is compiled without SSLv2 support")
  1420. def test_protocol_sslv2(self):
  1421. """Connecting to an SSLv2 server with various client options"""
  1422. if support.verbose:
  1423. sys.stdout.write("\n")
  1424. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
  1425. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
  1426. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
  1427. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True)
  1428. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
  1429. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
  1430. # SSLv23 client with specific SSL options
  1431. if no_sslv2_implies_sslv3_hello():
  1432. # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
  1433. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
  1434. client_options=ssl.OP_NO_SSLv2)
  1435. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True,
  1436. client_options=ssl.OP_NO_SSLv3)
  1437. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, True,
  1438. client_options=ssl.OP_NO_TLSv1)
  1439. @skip_if_broken_ubuntu_ssl
  1440. def test_protocol_sslv23(self):
  1441. """Connecting to an SSLv23 server with various client options"""
  1442. if support.verbose:
  1443. sys.stdout.write("\n")
  1444. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  1445. try:
  1446. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv2, True)
  1447. except (ssl.SSLError, socket.error) as x:
  1448. # this fails on some older versions of OpenSSL (0.9.7l, for instance)
  1449. if support.verbose:
  1450. sys.stdout.write(
  1451. " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
  1452. % str(x))
  1453. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True)
  1454. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True)
  1455. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True)
  1456. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True, ssl.CERT_OPTIONAL)
  1457. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_OPTIONAL)
  1458. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True, ssl.CERT_OPTIONAL)
  1459. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, True, ssl.CERT_REQUIRED)
  1460. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_REQUIRED)
  1461. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, True, ssl.CERT_REQUIRED)
  1462. # Server with specific SSL options
  1463. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False,
  1464. server_options=ssl.OP_NO_SSLv3)
  1465. # Will choose TLSv1
  1466. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True,
  1467. server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
  1468. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, False,
  1469. server_options=ssl.OP_NO_TLSv1)
  1470. @skip_if_broken_ubuntu_ssl
  1471. def test_protocol_sslv3(self):
  1472. """Connecting to an SSLv3 server with various client options"""
  1473. if support.verbose:
  1474. sys.stdout.write("\n")
  1475. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True)
  1476. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True, ssl.CERT_OPTIONAL)
  1477. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, True, ssl.CERT_REQUIRED)
  1478. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  1479. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
  1480. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, False,
  1481. client_options=ssl.OP_NO_SSLv3)
  1482. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
  1483. if no_sslv2_implies_sslv3_hello():
  1484. # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
  1485. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, True,
  1486. client_options=ssl.OP_NO_SSLv2)
  1487. @skip_if_broken_ubuntu_ssl
  1488. def test_protocol_tlsv1(self):
  1489. """Connecting to a TLSv1 server with various client options"""
  1490. if support.verbose:
  1491. sys.stdout.write("\n")
  1492. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True)
  1493. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True, ssl.CERT_OPTIONAL)
  1494. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, True, ssl.CERT_REQUIRED)
  1495. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  1496. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
  1497. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
  1498. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv23, False,
  1499. client_options=ssl.OP_NO_TLSv1)
  1500. def test_starttls(self):
  1501. """Switching from clear text to encrypted and back again."""
  1502. msgs = (b"msg 1", b"MSG 2", b"STARTTLS", b"MSG 3", b"msg 4", b"ENDTLS", b"msg 5", b"msg 6")
  1503. server = ThreadedEchoServer(CERTFILE,
  1504. ssl_version=ssl.PROTOCOL_TLSv1,
  1505. starttls_server=True,
  1506. chatty=True,
  1507. connectionchatty=True)
  1508. wrapped = False
  1509. with server:
  1510. s = socket.socket()
  1511. s.setblocking(1)
  1512. s.connect((HOST, server.port))
  1513. if support.verbose:
  1514. sys.stdout.write("\n")
  1515. for indata in msgs:
  1516. if support.verbose:
  1517. sys.stdout.write(
  1518. " client: sending %r...\n" % indata)
  1519. if wrapped:
  1520. conn.write(indata)
  1521. outdata = conn.read()
  1522. else:
  1523. s.send(indata)
  1524. outdata = s.recv(1024)
  1525. msg = outdata.strip().lower()
  1526. if indata == b"STARTTLS" and msg.startswith(b"ok"):
  1527. # STARTTLS ok, switch to secure mode
  1528. if support.verbose:
  1529. sys.stdout.write(
  1530. " client: read %r from server, starting TLS...\n"
  1531. % msg)
  1532. conn = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_TLSv1)
  1533. wrapped = True
  1534. elif indata == b"ENDTLS" and msg.startswith(b"ok"):
  1535. # ENDTLS ok, switch back to clear text
  1536. if support.verbose:
  1537. sys.stdout.write(
  1538. " client: read %r from server, ending TLS...\n"
  1539. % msg)
  1540. s = conn.unwrap()
  1541. wrapped = False
  1542. else:
  1543. if support.verbose:
  1544. sys.stdout.write(
  1545. " client: read %r from server\n" % msg)
  1546. if support.verbose:
  1547. sys.stdout.write(" client: closing connection.\n")
  1548. if wrapped:
  1549. conn.write(b"over\n")
  1550. else:
  1551. s.send(b"over\n")
  1552. if wrapped:
  1553. conn.close()
  1554. else:
  1555. s.close()
  1556. def test_socketserver(self):
  1557. """Using a SocketServer to create and manage SSL connections."""
  1558. server = make_https_server(self, CERTFILE)
  1559. # try to connect
  1560. if support.verbose:
  1561. sys.stdout.write('\n')
  1562. with open(CERTFILE, 'rb') as f:
  1563. d1 = f.read()
  1564. d2 = ''
  1565. # now fetch the same data from the HTTPS server
  1566. url = 'https://%s:%d/%s' % (
  1567. HOST, server.port, os.path.split(CERTFILE)[1])
  1568. f = urllib.request.urlopen(url)
  1569. try:
  1570. dlen = f.info().get("content-length")
  1571. if dlen and (int(dlen) > 0):
  1572. d2 = f.read(int(dlen))
  1573. if support.verbose:
  1574. sys.stdout.write(
  1575. " client: read %d bytes from remote server '%s'\n"
  1576. % (len(d2), server))
  1577. finally:
  1578. f.close()
  1579. self.assertEqual(d1, d2)
  1580. def test_asyncore_server(self):
  1581. """Check the example asyncore integration."""
  1582. indata = "TEST MESSAGE of mixed case\n"
  1583. if support.verbose:
  1584. sys.stdout.write("\n")
  1585. indata = b"FOO\n"
  1586. server = AsyncoreEchoServer(CERTFILE)
  1587. with server:
  1588. s = ssl.wrap_socket(socket.socket())
  1589. s.connect(('127.0.0.1', server.port))
  1590. if support.verbose:
  1591. sys.stdout.write(
  1592. " client: sending %r...\n" % indata)
  1593. s.write(indata)
  1594. outdata = s.read()
  1595. if support.verbose:
  1596. sys.stdout.write(" client: read %r\n" % outdata)
  1597. if outdata != indata.lower():
  1598. self.fail(
  1599. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  1600. % (outdata[:20], len(outdata),
  1601. indata[:20].lower(), len(indata)))
  1602. s.write(b"over\n")
  1603. if support.verbose:
  1604. sys.stdout.write(" client: closing connection.\n")
  1605. s.close()
  1606. if support.verbose:
  1607. sys.stdout.write(" client: connection closed.\n")
  1608. def test_recv_send(self):
  1609. """Test recv(), send() and friends."""
  1610. if support.verbose:
  1611. sys.stdout.write("\n")
  1612. server = ThreadedEchoServer(CERTFILE,
  1613. certreqs=ssl.CERT_NONE,
  1614. ssl_version=ssl.PROTOCOL_TLSv1,
  1615. cacerts=CERTFILE,
  1616. chatty=True,
  1617. connectionchatty=False)
  1618. with server:
  1619. s = ssl.wrap_socket(socket.socket(),
  1620. server_side=False,
  1621. certfile=CERTFILE,
  1622. ca_certs=CERTFILE,
  1623. cert_reqs=ssl.CERT_NONE,
  1624. ssl_version=ssl.PROTOCOL_TLSv1)
  1625. s.connect((HOST, server.port))
  1626. # helper methods for standardising recv* method signatures
  1627. def _recv_into():
  1628. b = bytearray(b"\0"*100)
  1629. count = s.recv_into(b)
  1630. return b[:count]
  1631. def _recvfrom_into():
  1632. b = bytearray(b"\0"*100)
  1633. count, addr = s.recvfrom_into(b)
  1634. return b[:count]
  1635. # (name, method, whether to expect success, *args)
  1636. send_methods = [
  1637. ('send', s.send, True, []),
  1638. ('sendto', s.sendto, False, ["some.address"]),
  1639. ('sendall', s.sendall, True, []),
  1640. ]
  1641. recv_methods = [
  1642. ('recv', s.recv, True, []),
  1643. ('recvfrom', s.recvfrom, False, ["some.address"]),
  1644. ('recv_into', _recv_into, True, []),
  1645. ('recvfrom_into', _recvfrom_into, False, []),
  1646. ]
  1647. data_prefix = "PREFIX_"
  1648. for meth_name, send_meth, expect_success, args in send_methods:
  1649. indata = (data_prefix + meth_name).encode('ascii')
  1650. try:
  1651. send_meth(indata, *args)
  1652. outdata = s.read()
  1653. if outdata != indata.lower():
  1654. self.fail(
  1655. "While sending with <<{name:s}>> bad data "
  1656. "<<{outdata:r}>> ({nout:d}) received; "
  1657. "expected <<{indata:r}>> ({nin:d})\n".format(
  1658. name=meth_name, outdata=outdata[:20],
  1659. nout=len(outdata),
  1660. indata=indata[:20], nin=len(indata)
  1661. )
  1662. )
  1663. except ValueError as e:
  1664. if expect_success:
  1665. self.fail(
  1666. "Failed to send with method <<{name:s}>>; "
  1667. "expected to succeed.\n".format(name=meth_name)
  1668. )
  1669. if not str(e).startswith(meth_name):
  1670. self.fail(
  1671. "Method <<{name:s}>> failed with unexpected "
  1672. "exception message: {exp:s}\n".format(
  1673. name=meth_name, exp=e
  1674. )
  1675. )
  1676. for meth_name, recv_meth, expect_success, args in recv_methods:
  1677. indata = (data_prefix + meth_name).encode('ascii')
  1678. try:
  1679. s.send(indata)
  1680. outdata = recv_meth(*args)
  1681. if outdata != indata.lower():
  1682. self.fail(
  1683. "While receiving with <<{name:s}>> bad data "
  1684. "<<{outdata:r}>> ({nout:d}) received; "
  1685. "expected <<{indata:r}>> ({nin:d})\n".format(
  1686. name=meth_name, outdata=outdata[:20],
  1687. nout=len(outdata),
  1688. indata=indata[:20], nin=len(indata)
  1689. )
  1690. )
  1691. except ValueError as e:
  1692. if expect_success:
  1693. self.fail(
  1694. "Failed to receive with method <<{name:s}>>; "
  1695. "expected to succeed.\n".format(name=meth_name)
  1696. )
  1697. if not str(e).startswith(meth_name):
  1698. self.fail(
  1699. "Method <<{name:s}>> failed with unexpected "
  1700. "exception message: {exp:s}\n".format(
  1701. name=meth_name, exp=e
  1702. )
  1703. )
  1704. # consume data
  1705. s.read()
  1706. # Make sure sendmsg et al are disallowed to avoid
  1707. # inadvertent disclosure of data and/or corruption
  1708. # of the encrypted data stream
  1709. self.assertRaises(NotImplementedError, s.sendmsg, [b"data"])
  1710. self.assertRaises(NotImplementedError, s.recvmsg, 100)
  1711. self.assertRaises(NotImplementedError,
  1712. s.recvmsg_into, bytearray(100))
  1713. s.write(b"over\n")
  1714. s.close()
  1715. def test_handshake_timeout(self):
  1716. # Issue #5103: SSL handshake must respect the socket timeout
  1717. server = socket.socket(socket.AF_INET)
  1718. host = "127.0.0.1"
  1719. port = support.bind_port(server)
  1720. started = threading.Event()
  1721. finish = False
  1722. def serve():
  1723. server.listen(5)
  1724. started.set()
  1725. conns = []
  1726. while not finish:
  1727. r, w, e = select.select([server], [], [], 0.1)
  1728. if server in r:
  1729. # Let the socket hang around rather than having
  1730. # it closed by garbage collection.
  1731. conns.append(server.accept()[0])
  1732. for sock in conns:
  1733. sock.close()
  1734. t = threading.Thread(target=serve)
  1735. t.start()
  1736. started.wait()
  1737. try:
  1738. try:
  1739. c = socket.socket(socket.AF_INET)
  1740. c.settimeout(0.2)
  1741. c.connect((host, port))
  1742. # Will attempt handshake and time out
  1743. self.assertRaisesRegex(socket.timeout, "timed out",
  1744. ssl.wrap_socket, c)
  1745. finally:
  1746. c.close()
  1747. try:
  1748. c = socket.socket(socket.AF_INET)
  1749. c = ssl.wrap_socket(c)
  1750. c.settimeout(0.2)
  1751. # Will attempt handshake and time out
  1752. self.assertRaisesRegex(socket.timeout, "timed out",
  1753. c.connect, (host, port))
  1754. finally:
  1755. c.close()
  1756. finally:
  1757. finish = True
  1758. t.join()
  1759. server.close()
  1760. def test_server_accept(self):
  1761. # Issue #16357: accept() on a SSLSocket created through
  1762. # SSLContext.wrap_socket().
  1763. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1764. context.verify_mode = ssl.CERT_REQUIRED
  1765. context.load_verify_locations(CERTFILE)
  1766. context.load_cert_chain(CERTFILE)
  1767. server = socket.socket(socket.AF_INET)
  1768. host = "127.0.0.1"
  1769. port = support.bind_port(server)
  1770. server = context.wrap_socket(server, server_side=True)
  1771. evt = threading.Event()
  1772. remote = None
  1773. peer = None
  1774. def serve():
  1775. nonlocal remote, peer
  1776. server.listen(5)
  1777. # Block on the accept and wait on the connection to close.
  1778. evt.set()
  1779. remote, peer = server.accept()
  1780. remote.recv(1)
  1781. t = threading.Thread(target=serve)
  1782. t.start()
  1783. # Client wait until server setup and perform a connect.
  1784. evt.wait()
  1785. client = context.wrap_socket(socket.socket())
  1786. client.connect((host, port))
  1787. client_addr = client.getsockname()
  1788. client.close()
  1789. t.join()
  1790. remote.close()
  1791. server.close()
  1792. # Sanity checks.
  1793. self.assertIsInstance(remote, ssl.SSLSocket)
  1794. self.assertEqual(peer, client_addr)
  1795. def test_default_ciphers(self):
  1796. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1797. try:
  1798. # Force a set of weak ciphers on our client context
  1799. context.set_ciphers("DES")
  1800. except ssl.SSLError:
  1801. self.skipTest("no DES cipher available")
  1802. with ThreadedEchoServer(CERTFILE,
  1803. ssl_version=ssl.PROTOCOL_SSLv23,
  1804. chatty=False) as server:
  1805. with context.wrap_socket(socket.socket()) as s:
  1806. with self.assertRaises((OSError, ssl.SSLError)):
  1807. s.connect((HOST, server.port))
  1808. self.assertIn("no shared cipher", str(server.conn_errors[0]))
  1809. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  1810. "'tls-unique' channel binding not available")
  1811. def test_tls_unique_channel_binding(self):
  1812. """Test tls-unique channel binding."""
  1813. if support.verbose:
  1814. sys.stdout.write("\n")
  1815. server = ThreadedEchoServer(CERTFILE,
  1816. certreqs=ssl.CERT_NONE,
  1817. ssl_version=ssl.PROTOCOL_TLSv1,
  1818. cacerts=CERTFILE,
  1819. chatty=True,
  1820. connectionchatty=False)
  1821. with server:
  1822. s = ssl.wrap_socket(socket.socket(),
  1823. server_side=False,
  1824. certfile=CERTFILE,
  1825. ca_certs=CERTFILE,
  1826. cert_reqs=ssl.CERT_NONE,
  1827. ssl_version=ssl.PROTOCOL_TLSv1)
  1828. s.connect((HOST, server.port))
  1829. # get the data
  1830. cb_data = s.get_channel_binding("tls-unique")
  1831. if support.verbose:
  1832. sys.stdout.write(" got channel binding data: {0!r}\n"
  1833. .format(cb_data))
  1834. # check if it is sane
  1835. self.assertIsNotNone(cb_data)
  1836. self.assertEqual(len(cb_data), 12) # True for TLSv1
  1837. # and compare with the peers version
  1838. s.write(b"CB tls-unique\n")
  1839. peer_data_repr = s.read().strip()
  1840. self.assertEqual(peer_data_repr,
  1841. repr(cb_data).encode("us-ascii"))
  1842. s.close()
  1843. # now, again
  1844. s = ssl.wrap_socket(socket.socket(),
  1845. server_side=False,
  1846. certfile=CERTFILE,
  1847. ca_certs=CERTFILE,
  1848. cert_reqs=ssl.CERT_NONE,
  1849. ssl_version=ssl.PROTOCOL_TLSv1)
  1850. s.connect((HOST, server.port))
  1851. new_cb_data = s.get_channel_binding("tls-unique")
  1852. if support.verbose:
  1853. sys.stdout.write(" got another channel binding data: {0!r}\n"
  1854. .format(new_cb_data))
  1855. # is it really unique
  1856. self.assertNotEqual(cb_data, new_cb_data)
  1857. self.assertIsNotNone(cb_data)
  1858. self.assertEqual(len(cb_data), 12) # True for TLSv1
  1859. s.write(b"CB tls-unique\n")
  1860. peer_data_repr = s.read().strip()
  1861. self.assertEqual(peer_data_repr,
  1862. repr(new_cb_data).encode("us-ascii"))
  1863. s.close()
  1864. def test_compression(self):
  1865. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1866. context.load_cert_chain(CERTFILE)
  1867. stats = server_params_test(context, context,
  1868. chatty=True, connectionchatty=True)
  1869. if support.verbose:
  1870. sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
  1871. self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
  1872. @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
  1873. "ssl.OP_NO_COMPRESSION needed for this test")
  1874. def test_compression_disabled(self):
  1875. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1876. context.load_cert_chain(CERTFILE)
  1877. context.options |= ssl.OP_NO_COMPRESSION
  1878. stats = server_params_test(context, context,
  1879. chatty=True, connectionchatty=True)
  1880. self.assertIs(stats['compression'], None)
  1881. def test_dh_params(self):
  1882. # Check we can get a connection with ephemeral Diffie-Hellman
  1883. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1884. context.load_cert_chain(CERTFILE)
  1885. context.load_dh_params(DHFILE)
  1886. context.set_ciphers("kEDH")
  1887. stats = server_params_test(context, context,
  1888. chatty=True, connectionchatty=True)
  1889. cipher = stats["cipher"][0]
  1890. parts = cipher.split("-")
  1891. if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
  1892. self.fail("Non-DH cipher: " + cipher[0])
  1893. def test_selected_npn_protocol(self):
  1894. # selected_npn_protocol() is None unless NPN is used
  1895. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1896. context.load_cert_chain(CERTFILE)
  1897. stats = server_params_test(context, context,
  1898. chatty=True, connectionchatty=True)
  1899. self.assertIs(stats['client_npn_protocol'], None)
  1900. @unittest.skipUnless(ssl.HAS_NPN, "NPN support needed for this test")
  1901. def test_npn_protocols(self):
  1902. server_protocols = ['http/1.1', 'spdy/2']
  1903. protocol_tests = [
  1904. (['http/1.1', 'spdy/2'], 'http/1.1'),
  1905. (['spdy/2', 'http/1.1'], 'http/1.1'),
  1906. (['spdy/2', 'test'], 'spdy/2'),
  1907. (['abc', 'def'], 'abc')
  1908. ]
  1909. for client_protocols, expected in protocol_tests:
  1910. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1911. server_context.load_cert_chain(CERTFILE)
  1912. server_context.set_npn_protocols(server_protocols)
  1913. client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1914. client_context.load_cert_chain(CERTFILE)
  1915. client_context.set_npn_protocols(client_protocols)
  1916. stats = server_params_test(client_context, server_context,
  1917. chatty=True, connectionchatty=True)
  1918. msg = "failed trying %s (s) and %s (c).\n" \
  1919. "was expecting %s, but got %%s from the %%s" \
  1920. % (str(server_protocols), str(client_protocols),
  1921. str(expected))
  1922. client_result = stats['client_npn_protocol']
  1923. self.assertEqual(client_result, expected, msg % (client_result, "client"))
  1924. server_result = stats['server_npn_protocols'][-1] \
  1925. if len(stats['server_npn_protocols']) else 'nothing'
  1926. self.assertEqual(server_result, expected, msg % (server_result, "server"))
  1927. def test_main(verbose=False):
  1928. if support.verbose:
  1929. plats = {
  1930. 'Linux': platform.linux_distribution,
  1931. 'Mac': platform.mac_ver,
  1932. 'Windows': platform.win32_ver,
  1933. }
  1934. for name, func in plats.items():
  1935. plat = func()
  1936. if plat and plat[0]:
  1937. plat = '%s %r' % (name, plat)
  1938. break
  1939. else:
  1940. plat = repr(platform.platform())
  1941. print("test_ssl: testing with %r %r" %
  1942. (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
  1943. print(" under %s" % plat)
  1944. print(" HAS_SNI = %r" % ssl.HAS_SNI)
  1945. for filename in [
  1946. CERTFILE, SVN_PYTHON_ORG_ROOT_CERT, BYTES_CERTFILE,
  1947. ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
  1948. BADCERT, BADKEY, EMPTYCERT]:
  1949. if not os.path.exists(filename):
  1950. raise support.TestFailed("Can't read certificate file %r" % filename)
  1951. tests = [ContextTests, BasicSocketTests, SSLErrorTests]
  1952. if support.is_resource_enabled('network'):
  1953. tests.append(NetworkedTests)
  1954. if _have_threads:
  1955. thread_info = support.threading_setup()
  1956. if thread_info:
  1957. tests.append(ThreadedTests)
  1958. try:
  1959. support.run_unittest(*tests)
  1960. finally:
  1961. if _have_threads:
  1962. support.threading_cleanup(*thread_info)
  1963. if __name__ == "__main__":
  1964. test_main()