PageRenderTime 72ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/Lib/test/test_ssl.py

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