PageRenderTime 61ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 1ms

/Lib/test/test_ssl.py

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