test_ssl.py 139 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139
  1. # -*- coding: utf-8 -*-
  2. # Test the support for SSL and sockets
  3. import sys
  4. import unittest
  5. from test import test_support as support
  6. from test.script_helper import assert_python_ok
  7. import asyncore
  8. import socket
  9. import select
  10. import time
  11. import datetime
  12. import gc
  13. import os
  14. import errno
  15. import pprint
  16. import tempfile
  17. import urllib2
  18. import traceback
  19. import weakref
  20. import platform
  21. import functools
  22. from contextlib import closing
  23. ssl = support.import_module("ssl")
  24. PROTOCOLS = sorted(ssl._PROTOCOL_NAMES)
  25. HOST = support.HOST
  26. def data_file(*name):
  27. return 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 = CERTFILE.encode(sys.getfilesystemencoding())
  34. ONLYCERT = data_file("ssl_cert.pem")
  35. ONLYKEY = data_file("ssl_key.pem")
  36. BYTES_ONLYCERT = ONLYCERT.encode(sys.getfilesystemencoding())
  37. BYTES_ONLYKEY = ONLYKEY.encode(sys.getfilesystemencoding())
  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 = CAPATH.encode(sys.getfilesystemencoding())
  43. CAFILE_NEURONIO = data_file("capath", "4e1295a3.0")
  44. CAFILE_CACERT = data_file("capath", "5ed36f99.0")
  45. # empty CRL
  46. CRLFILE = data_file("revocation.crl")
  47. # Two keys and certs signed by the same CA (for SNI tests)
  48. SIGNED_CERTFILE = data_file("keycert3.pem")
  49. SIGNED_CERTFILE2 = data_file("keycert4.pem")
  50. SIGNING_CA = data_file("pycacert.pem")
  51. REMOTE_HOST = "self-signed.pythontest.net"
  52. REMOTE_ROOT_CERT = data_file("selfsigned_pythontestdotnet.pem")
  53. EMPTYCERT = data_file("nullcert.pem")
  54. BADCERT = data_file("badcert.pem")
  55. NONEXISTINGCERT = data_file("XXXnonexisting.pem")
  56. BADKEY = data_file("badkey.pem")
  57. NOKIACERT = data_file("nokia.pem")
  58. NULLBYTECERT = data_file("nullbytecert.pem")
  59. DHFILE = data_file("dh1024.pem")
  60. BYTES_DHFILE = DHFILE.encode(sys.getfilesystemencoding())
  61. def handle_error(prefix):
  62. exc_format = ' '.join(traceback.format_exception(*sys.exc_info()))
  63. if support.verbose:
  64. sys.stdout.write(prefix + exc_format)
  65. class BasicTests(unittest.TestCase):
  66. def test_sslwrap_simple(self):
  67. # A crude test for the legacy API
  68. try:
  69. ssl.sslwrap_simple(socket.socket(socket.AF_INET))
  70. except IOError, e:
  71. if e.errno == 32: # broken pipe when ssl_sock.do_handshake(), this test doesn't care about that
  72. pass
  73. else:
  74. raise
  75. try:
  76. ssl.sslwrap_simple(socket.socket(socket.AF_INET)._sock)
  77. except IOError, e:
  78. if e.errno == 32: # broken pipe when ssl_sock.do_handshake(), this test doesn't care about that
  79. pass
  80. else:
  81. raise
  82. def can_clear_options():
  83. # 0.9.8m or higher
  84. return ssl._OPENSSL_API_VERSION >= (0, 9, 8, 13, 15)
  85. def no_sslv2_implies_sslv3_hello():
  86. # 0.9.7h or higher
  87. return ssl.OPENSSL_VERSION_INFO >= (0, 9, 7, 8, 15)
  88. def have_verify_flags():
  89. # 0.9.8 or higher
  90. return ssl.OPENSSL_VERSION_INFO >= (0, 9, 8, 0, 15)
  91. def utc_offset(): #NOTE: ignore issues like #1647654
  92. # local time = utc time + utc offset
  93. if time.daylight and time.localtime().tm_isdst > 0:
  94. return -time.altzone # seconds
  95. return -time.timezone
  96. def asn1time(cert_time):
  97. # Some versions of OpenSSL ignore seconds, see #18207
  98. # 0.9.8.i
  99. if ssl._OPENSSL_API_VERSION == (0, 9, 8, 9, 15):
  100. fmt = "%b %d %H:%M:%S %Y GMT"
  101. dt = datetime.datetime.strptime(cert_time, fmt)
  102. dt = dt.replace(second=0)
  103. cert_time = dt.strftime(fmt)
  104. # %d adds leading zero but ASN1_TIME_print() uses leading space
  105. if cert_time[4] == "0":
  106. cert_time = cert_time[:4] + " " + cert_time[5:]
  107. return cert_time
  108. # Issue #9415: Ubuntu hijacks their OpenSSL and forcefully disables SSLv2
  109. def skip_if_broken_ubuntu_ssl(func):
  110. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  111. @functools.wraps(func)
  112. def f(*args, **kwargs):
  113. try:
  114. ssl.SSLContext(ssl.PROTOCOL_SSLv2)
  115. except ssl.SSLError:
  116. if (ssl.OPENSSL_VERSION_INFO == (0, 9, 8, 15, 15) and
  117. platform.linux_distribution() == ('debian', 'squeeze/sid', '')):
  118. raise unittest.SkipTest("Patched Ubuntu OpenSSL breaks behaviour")
  119. return func(*args, **kwargs)
  120. return f
  121. else:
  122. return func
  123. needs_sni = unittest.skipUnless(ssl.HAS_SNI, "SNI support needed for this test")
  124. class BasicSocketTests(unittest.TestCase):
  125. def test_constants(self):
  126. ssl.CERT_NONE
  127. ssl.CERT_OPTIONAL
  128. ssl.CERT_REQUIRED
  129. ssl.OP_CIPHER_SERVER_PREFERENCE
  130. ssl.OP_SINGLE_DH_USE
  131. if ssl.HAS_ECDH:
  132. ssl.OP_SINGLE_ECDH_USE
  133. if ssl.OPENSSL_VERSION_INFO >= (1, 0):
  134. ssl.OP_NO_COMPRESSION
  135. self.assertIn(ssl.HAS_SNI, {True, False})
  136. self.assertIn(ssl.HAS_ECDH, {True, False})
  137. def test_random(self):
  138. v = ssl.RAND_status()
  139. if support.verbose:
  140. sys.stdout.write("\n RAND_status is %d (%s)\n"
  141. % (v, (v and "sufficient randomness") or
  142. "insufficient randomness"))
  143. if hasattr(ssl, 'RAND_egd'):
  144. self.assertRaises(TypeError, ssl.RAND_egd, 1)
  145. self.assertRaises(TypeError, ssl.RAND_egd, 'foo', 1)
  146. ssl.RAND_add("this is a random string", 75.0)
  147. def test_parse_cert(self):
  148. # note that this uses an 'unofficial' function in _ssl.c,
  149. # provided solely for this test, to exercise the certificate
  150. # parsing code
  151. p = ssl._ssl._test_decode_cert(CERTFILE)
  152. if support.verbose:
  153. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  154. self.assertEqual(p['issuer'],
  155. ((('countryName', 'XY'),),
  156. (('localityName', 'Castle Anthrax'),),
  157. (('organizationName', 'Python Software Foundation'),),
  158. (('commonName', 'localhost'),))
  159. )
  160. # Note the next three asserts will fail if the keys are regenerated
  161. self.assertEqual(p['notAfter'], asn1time('Oct 5 23:01:56 2020 GMT'))
  162. self.assertEqual(p['notBefore'], asn1time('Oct 8 23:01:56 2010 GMT'))
  163. self.assertEqual(p['serialNumber'], 'D7C7381919AFC24E')
  164. self.assertEqual(p['subject'],
  165. ((('countryName', 'XY'),),
  166. (('localityName', 'Castle Anthrax'),),
  167. (('organizationName', 'Python Software Foundation'),),
  168. (('commonName', 'localhost'),))
  169. )
  170. self.assertEqual(p['subjectAltName'], (('DNS', 'localhost'),))
  171. # Issue #13034: the subjectAltName in some certificates
  172. # (notably projects.developer.nokia.com:443) wasn't parsed
  173. p = ssl._ssl._test_decode_cert(NOKIACERT)
  174. if support.verbose:
  175. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  176. self.assertEqual(p['subjectAltName'],
  177. (('DNS', 'projects.developer.nokia.com'),
  178. ('DNS', 'projects.forum.nokia.com'))
  179. )
  180. # extra OCSP and AIA fields
  181. self.assertEqual(p['OCSP'], ('http://ocsp.verisign.com',))
  182. self.assertEqual(p['caIssuers'],
  183. ('http://SVRIntl-G3-aia.verisign.com/SVRIntlG3.cer',))
  184. self.assertEqual(p['crlDistributionPoints'],
  185. ('http://SVRIntl-G3-crl.verisign.com/SVRIntlG3.crl',))
  186. def test_parse_cert_CVE_2013_4238(self):
  187. p = ssl._ssl._test_decode_cert(NULLBYTECERT)
  188. if support.verbose:
  189. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  190. subject = ((('countryName', 'US'),),
  191. (('stateOrProvinceName', 'Oregon'),),
  192. (('localityName', 'Beaverton'),),
  193. (('organizationName', 'Python Software Foundation'),),
  194. (('organizationalUnitName', 'Python Core Development'),),
  195. (('commonName', 'null.python.org\x00example.org'),),
  196. (('emailAddress', 'python-dev@python.org'),))
  197. self.assertEqual(p['subject'], subject)
  198. self.assertEqual(p['issuer'], subject)
  199. if ssl._OPENSSL_API_VERSION >= (0, 9, 8):
  200. san = (('DNS', 'altnull.python.org\x00example.com'),
  201. ('email', 'null@python.org\x00user@example.org'),
  202. ('URI', 'http://null.python.org\x00http://example.org'),
  203. ('IP Address', '192.0.2.1'),
  204. ('IP Address', '2001:DB8:0:0:0:0:0:1\n'))
  205. else:
  206. # OpenSSL 0.9.7 doesn't support IPv6 addresses in subjectAltName
  207. san = (('DNS', 'altnull.python.org\x00example.com'),
  208. ('email', 'null@python.org\x00user@example.org'),
  209. ('URI', 'http://null.python.org\x00http://example.org'),
  210. ('IP Address', '192.0.2.1'),
  211. ('IP Address', '<invalid>'))
  212. self.assertEqual(p['subjectAltName'], san)
  213. def test_DER_to_PEM(self):
  214. with open(CAFILE_CACERT, 'r') as f:
  215. pem = f.read()
  216. d1 = ssl.PEM_cert_to_DER_cert(pem)
  217. p2 = ssl.DER_cert_to_PEM_cert(d1)
  218. d2 = ssl.PEM_cert_to_DER_cert(p2)
  219. self.assertEqual(d1, d2)
  220. if not p2.startswith(ssl.PEM_HEADER + '\n'):
  221. self.fail("DER-to-PEM didn't include correct header:\n%r\n" % p2)
  222. if not p2.endswith('\n' + ssl.PEM_FOOTER + '\n'):
  223. self.fail("DER-to-PEM didn't include correct footer:\n%r\n" % p2)
  224. def test_openssl_version(self):
  225. n = ssl.OPENSSL_VERSION_NUMBER
  226. t = ssl.OPENSSL_VERSION_INFO
  227. s = ssl.OPENSSL_VERSION
  228. self.assertIsInstance(n, (int, long))
  229. self.assertIsInstance(t, tuple)
  230. self.assertIsInstance(s, str)
  231. # Some sanity checks follow
  232. # >= 0.9
  233. self.assertGreaterEqual(n, 0x900000)
  234. # < 3.0
  235. self.assertLess(n, 0x30000000)
  236. major, minor, fix, patch, status = t
  237. self.assertGreaterEqual(major, 0)
  238. self.assertLess(major, 3)
  239. self.assertGreaterEqual(minor, 0)
  240. self.assertLess(minor, 256)
  241. self.assertGreaterEqual(fix, 0)
  242. self.assertLess(fix, 256)
  243. self.assertGreaterEqual(patch, 0)
  244. self.assertLessEqual(patch, 63)
  245. self.assertGreaterEqual(status, 0)
  246. self.assertLessEqual(status, 15)
  247. # Version string as returned by {Open,Libre}SSL, the format might change
  248. if "LibreSSL" in s:
  249. self.assertTrue(s.startswith("LibreSSL {:d}.{:d}".format(major, minor)),
  250. (s, t))
  251. else:
  252. self.assertTrue(s.startswith("OpenSSL {:d}.{:d}.{:d}".format(major, minor, fix)),
  253. (s, t))
  254. @support.cpython_only
  255. def test_refcycle(self):
  256. # Issue #7943: an SSL object doesn't create reference cycles with
  257. # itself.
  258. s = socket.socket(socket.AF_INET)
  259. ss = ssl.wrap_socket(s)
  260. wr = weakref.ref(ss)
  261. del ss
  262. self.assertEqual(wr(), None)
  263. def test_wrapped_unconnected(self):
  264. # Methods on an unconnected SSLSocket propagate the original
  265. # socket.error raise by the underlying socket object.
  266. s = socket.socket(socket.AF_INET)
  267. with closing(ssl.wrap_socket(s)) as ss:
  268. self.assertRaises(socket.error, ss.recv, 1)
  269. self.assertRaises(socket.error, ss.recv_into, bytearray(b'x'))
  270. self.assertRaises(socket.error, ss.recvfrom, 1)
  271. self.assertRaises(socket.error, ss.recvfrom_into, bytearray(b'x'), 1)
  272. self.assertRaises(socket.error, ss.send, b'x')
  273. self.assertRaises(socket.error, ss.sendto, b'x', ('0.0.0.0', 0))
  274. def test_timeout(self):
  275. # Issue #8524: when creating an SSL socket, the timeout of the
  276. # original socket should be retained.
  277. for timeout in (None, 0.0, 5.0):
  278. s = socket.socket(socket.AF_INET)
  279. s.settimeout(timeout)
  280. with closing(ssl.wrap_socket(s)) as ss:
  281. self.assertEqual(timeout, ss.gettimeout())
  282. def test_errors(self):
  283. sock = socket.socket()
  284. self.assertRaisesRegexp(ValueError,
  285. "certfile must be specified",
  286. ssl.wrap_socket, sock, keyfile=CERTFILE)
  287. self.assertRaisesRegexp(ValueError,
  288. "certfile must be specified for server-side operations",
  289. ssl.wrap_socket, sock, server_side=True)
  290. self.assertRaisesRegexp(ValueError,
  291. "certfile must be specified for server-side operations",
  292. ssl.wrap_socket, sock, server_side=True, certfile="")
  293. with closing(ssl.wrap_socket(sock, server_side=True, certfile=CERTFILE)) as s:
  294. self.assertRaisesRegexp(ValueError, "can't connect in server-side mode",
  295. s.connect, (HOST, 8080))
  296. with self.assertRaises(IOError) as cm:
  297. with closing(socket.socket()) as sock:
  298. ssl.wrap_socket(sock, certfile=NONEXISTINGCERT)
  299. self.assertEqual(cm.exception.errno, errno.ENOENT)
  300. with self.assertRaises(IOError) as cm:
  301. with closing(socket.socket()) as sock:
  302. ssl.wrap_socket(sock,
  303. certfile=CERTFILE, keyfile=NONEXISTINGCERT)
  304. self.assertEqual(cm.exception.errno, errno.ENOENT)
  305. with self.assertRaises(IOError) as cm:
  306. with closing(socket.socket()) as sock:
  307. ssl.wrap_socket(sock,
  308. certfile=NONEXISTINGCERT, keyfile=NONEXISTINGCERT)
  309. self.assertEqual(cm.exception.errno, errno.ENOENT)
  310. def bad_cert_test(self, certfile):
  311. """Check that trying to use the given client certificate fails"""
  312. certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
  313. certfile)
  314. sock = socket.socket()
  315. self.addCleanup(sock.close)
  316. with self.assertRaises(ssl.SSLError):
  317. ssl.wrap_socket(sock,
  318. certfile=certfile,
  319. ssl_version=ssl.PROTOCOL_TLSv1)
  320. def test_empty_cert(self):
  321. """Wrapping with an empty cert file"""
  322. self.bad_cert_test("nullcert.pem")
  323. def test_malformed_cert(self):
  324. """Wrapping with a badly formatted certificate (syntax error)"""
  325. self.bad_cert_test("badcert.pem")
  326. def test_malformed_key(self):
  327. """Wrapping with a badly formatted key (syntax error)"""
  328. self.bad_cert_test("badkey.pem")
  329. def test_match_hostname(self):
  330. def ok(cert, hostname):
  331. ssl.match_hostname(cert, hostname)
  332. def fail(cert, hostname):
  333. self.assertRaises(ssl.CertificateError,
  334. ssl.match_hostname, cert, hostname)
  335. cert = {'subject': ((('commonName', 'example.com'),),)}
  336. ok(cert, 'example.com')
  337. ok(cert, 'ExAmple.cOm')
  338. fail(cert, 'www.example.com')
  339. fail(cert, '.example.com')
  340. fail(cert, 'example.org')
  341. fail(cert, 'exampleXcom')
  342. cert = {'subject': ((('commonName', '*.a.com'),),)}
  343. ok(cert, 'foo.a.com')
  344. fail(cert, 'bar.foo.a.com')
  345. fail(cert, 'a.com')
  346. fail(cert, 'Xa.com')
  347. fail(cert, '.a.com')
  348. # only match one left-most wildcard
  349. cert = {'subject': ((('commonName', 'f*.com'),),)}
  350. ok(cert, 'foo.com')
  351. ok(cert, 'f.com')
  352. fail(cert, 'bar.com')
  353. fail(cert, 'foo.a.com')
  354. fail(cert, 'bar.foo.com')
  355. # NULL bytes are bad, CVE-2013-4073
  356. cert = {'subject': ((('commonName',
  357. 'null.python.org\x00example.org'),),)}
  358. ok(cert, 'null.python.org\x00example.org') # or raise an error?
  359. fail(cert, 'example.org')
  360. fail(cert, 'null.python.org')
  361. # error cases with wildcards
  362. cert = {'subject': ((('commonName', '*.*.a.com'),),)}
  363. fail(cert, 'bar.foo.a.com')
  364. fail(cert, 'a.com')
  365. fail(cert, 'Xa.com')
  366. fail(cert, '.a.com')
  367. cert = {'subject': ((('commonName', 'a.*.com'),),)}
  368. fail(cert, 'a.foo.com')
  369. fail(cert, 'a..com')
  370. fail(cert, 'a.com')
  371. # wildcard doesn't match IDNA prefix 'xn--'
  372. idna = u'püthon.python.org'.encode("idna").decode("ascii")
  373. cert = {'subject': ((('commonName', idna),),)}
  374. ok(cert, idna)
  375. cert = {'subject': ((('commonName', 'x*.python.org'),),)}
  376. fail(cert, idna)
  377. cert = {'subject': ((('commonName', 'xn--p*.python.org'),),)}
  378. fail(cert, idna)
  379. # wildcard in first fragment and IDNA A-labels in sequent fragments
  380. # are supported.
  381. idna = u'www*.pythön.org'.encode("idna").decode("ascii")
  382. cert = {'subject': ((('commonName', idna),),)}
  383. ok(cert, u'www.pythön.org'.encode("idna").decode("ascii"))
  384. ok(cert, u'www1.pythön.org'.encode("idna").decode("ascii"))
  385. fail(cert, u'ftp.pythön.org'.encode("idna").decode("ascii"))
  386. fail(cert, u'pythön.org'.encode("idna").decode("ascii"))
  387. # Slightly fake real-world example
  388. cert = {'notAfter': 'Jun 26 21:41:46 2011 GMT',
  389. 'subject': ((('commonName', 'linuxfrz.org'),),),
  390. 'subjectAltName': (('DNS', 'linuxfr.org'),
  391. ('DNS', 'linuxfr.com'),
  392. ('othername', '<unsupported>'))}
  393. ok(cert, 'linuxfr.org')
  394. ok(cert, 'linuxfr.com')
  395. # Not a "DNS" entry
  396. fail(cert, '<unsupported>')
  397. # When there is a subjectAltName, commonName isn't used
  398. fail(cert, 'linuxfrz.org')
  399. # A pristine real-world example
  400. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  401. 'subject': ((('countryName', 'US'),),
  402. (('stateOrProvinceName', 'California'),),
  403. (('localityName', 'Mountain View'),),
  404. (('organizationName', 'Google Inc'),),
  405. (('commonName', 'mail.google.com'),))}
  406. ok(cert, 'mail.google.com')
  407. fail(cert, 'gmail.com')
  408. # Only commonName is considered
  409. fail(cert, 'California')
  410. # Neither commonName nor subjectAltName
  411. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  412. 'subject': ((('countryName', 'US'),),
  413. (('stateOrProvinceName', 'California'),),
  414. (('localityName', 'Mountain View'),),
  415. (('organizationName', 'Google Inc'),))}
  416. fail(cert, 'mail.google.com')
  417. # No DNS entry in subjectAltName but a commonName
  418. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  419. 'subject': ((('countryName', 'US'),),
  420. (('stateOrProvinceName', 'California'),),
  421. (('localityName', 'Mountain View'),),
  422. (('commonName', 'mail.google.com'),)),
  423. 'subjectAltName': (('othername', 'blabla'), )}
  424. ok(cert, 'mail.google.com')
  425. # No DNS entry subjectAltName and no commonName
  426. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  427. 'subject': ((('countryName', 'US'),),
  428. (('stateOrProvinceName', 'California'),),
  429. (('localityName', 'Mountain View'),),
  430. (('organizationName', 'Google Inc'),)),
  431. 'subjectAltName': (('othername', 'blabla'),)}
  432. fail(cert, 'google.com')
  433. # Empty cert / no cert
  434. self.assertRaises(ValueError, ssl.match_hostname, None, 'example.com')
  435. self.assertRaises(ValueError, ssl.match_hostname, {}, 'example.com')
  436. # Issue #17980: avoid denials of service by refusing more than one
  437. # wildcard per fragment.
  438. cert = {'subject': ((('commonName', 'a*b.com'),),)}
  439. ok(cert, 'axxb.com')
  440. cert = {'subject': ((('commonName', 'a*b.co*'),),)}
  441. fail(cert, 'axxb.com')
  442. cert = {'subject': ((('commonName', 'a*b*.com'),),)}
  443. with self.assertRaises(ssl.CertificateError) as cm:
  444. ssl.match_hostname(cert, 'axxbxxc.com')
  445. self.assertIn("too many wildcards", str(cm.exception))
  446. def test_server_side(self):
  447. # server_hostname doesn't work for server sockets
  448. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  449. with closing(socket.socket()) as sock:
  450. self.assertRaises(ValueError, ctx.wrap_socket, sock, True,
  451. server_hostname="some.hostname")
  452. def test_unknown_channel_binding(self):
  453. # should raise ValueError for unknown type
  454. s = socket.socket(socket.AF_INET)
  455. with closing(ssl.wrap_socket(s)) as ss:
  456. with self.assertRaises(ValueError):
  457. ss.get_channel_binding("unknown-type")
  458. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  459. "'tls-unique' channel binding not available")
  460. def test_tls_unique_channel_binding(self):
  461. # unconnected should return None for known type
  462. s = socket.socket(socket.AF_INET)
  463. with closing(ssl.wrap_socket(s)) as ss:
  464. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  465. # the same for server-side
  466. s = socket.socket(socket.AF_INET)
  467. with closing(ssl.wrap_socket(s, server_side=True, certfile=CERTFILE)) as ss:
  468. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  469. def test_get_default_verify_paths(self):
  470. paths = ssl.get_default_verify_paths()
  471. self.assertEqual(len(paths), 6)
  472. self.assertIsInstance(paths, ssl.DefaultVerifyPaths)
  473. with support.EnvironmentVarGuard() as env:
  474. env["SSL_CERT_DIR"] = CAPATH
  475. env["SSL_CERT_FILE"] = CERTFILE
  476. paths = ssl.get_default_verify_paths()
  477. self.assertEqual(paths.cafile, CERTFILE)
  478. self.assertEqual(paths.capath, CAPATH)
  479. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  480. def test_enum_certificates(self):
  481. self.assertTrue(ssl.enum_certificates("CA"))
  482. self.assertTrue(ssl.enum_certificates("ROOT"))
  483. self.assertRaises(TypeError, ssl.enum_certificates)
  484. self.assertRaises(WindowsError, ssl.enum_certificates, "")
  485. trust_oids = set()
  486. for storename in ("CA", "ROOT"):
  487. store = ssl.enum_certificates(storename)
  488. self.assertIsInstance(store, list)
  489. for element in store:
  490. self.assertIsInstance(element, tuple)
  491. self.assertEqual(len(element), 3)
  492. cert, enc, trust = element
  493. self.assertIsInstance(cert, bytes)
  494. self.assertIn(enc, {"x509_asn", "pkcs_7_asn"})
  495. self.assertIsInstance(trust, (set, bool))
  496. if isinstance(trust, set):
  497. trust_oids.update(trust)
  498. serverAuth = "1.3.6.1.5.5.7.3.1"
  499. self.assertIn(serverAuth, trust_oids)
  500. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  501. def test_enum_crls(self):
  502. self.assertTrue(ssl.enum_crls("CA"))
  503. self.assertRaises(TypeError, ssl.enum_crls)
  504. self.assertRaises(WindowsError, ssl.enum_crls, "")
  505. crls = ssl.enum_crls("CA")
  506. self.assertIsInstance(crls, list)
  507. for element in crls:
  508. self.assertIsInstance(element, tuple)
  509. self.assertEqual(len(element), 2)
  510. self.assertIsInstance(element[0], bytes)
  511. self.assertIn(element[1], {"x509_asn", "pkcs_7_asn"})
  512. def test_asn1object(self):
  513. expected = (129, 'serverAuth', 'TLS Web Server Authentication',
  514. '1.3.6.1.5.5.7.3.1')
  515. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
  516. self.assertEqual(val, expected)
  517. self.assertEqual(val.nid, 129)
  518. self.assertEqual(val.shortname, 'serverAuth')
  519. self.assertEqual(val.longname, 'TLS Web Server Authentication')
  520. self.assertEqual(val.oid, '1.3.6.1.5.5.7.3.1')
  521. self.assertIsInstance(val, ssl._ASN1Object)
  522. self.assertRaises(ValueError, ssl._ASN1Object, 'serverAuth')
  523. val = ssl._ASN1Object.fromnid(129)
  524. self.assertEqual(val, expected)
  525. self.assertIsInstance(val, ssl._ASN1Object)
  526. self.assertRaises(ValueError, ssl._ASN1Object.fromnid, -1)
  527. with self.assertRaisesRegexp(ValueError, "unknown NID 100000"):
  528. ssl._ASN1Object.fromnid(100000)
  529. for i in range(1000):
  530. try:
  531. obj = ssl._ASN1Object.fromnid(i)
  532. except ValueError:
  533. pass
  534. else:
  535. self.assertIsInstance(obj.nid, int)
  536. self.assertIsInstance(obj.shortname, str)
  537. self.assertIsInstance(obj.longname, str)
  538. self.assertIsInstance(obj.oid, (str, type(None)))
  539. val = ssl._ASN1Object.fromname('TLS Web Server Authentication')
  540. self.assertEqual(val, expected)
  541. self.assertIsInstance(val, ssl._ASN1Object)
  542. self.assertEqual(ssl._ASN1Object.fromname('serverAuth'), expected)
  543. self.assertEqual(ssl._ASN1Object.fromname('1.3.6.1.5.5.7.3.1'),
  544. expected)
  545. with self.assertRaisesRegexp(ValueError, "unknown object 'serverauth'"):
  546. ssl._ASN1Object.fromname('serverauth')
  547. def test_purpose_enum(self):
  548. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
  549. self.assertIsInstance(ssl.Purpose.SERVER_AUTH, ssl._ASN1Object)
  550. self.assertEqual(ssl.Purpose.SERVER_AUTH, val)
  551. self.assertEqual(ssl.Purpose.SERVER_AUTH.nid, 129)
  552. self.assertEqual(ssl.Purpose.SERVER_AUTH.shortname, 'serverAuth')
  553. self.assertEqual(ssl.Purpose.SERVER_AUTH.oid,
  554. '1.3.6.1.5.5.7.3.1')
  555. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.2')
  556. self.assertIsInstance(ssl.Purpose.CLIENT_AUTH, ssl._ASN1Object)
  557. self.assertEqual(ssl.Purpose.CLIENT_AUTH, val)
  558. self.assertEqual(ssl.Purpose.CLIENT_AUTH.nid, 130)
  559. self.assertEqual(ssl.Purpose.CLIENT_AUTH.shortname, 'clientAuth')
  560. self.assertEqual(ssl.Purpose.CLIENT_AUTH.oid,
  561. '1.3.6.1.5.5.7.3.2')
  562. def test_unsupported_dtls(self):
  563. s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  564. self.addCleanup(s.close)
  565. with self.assertRaises(NotImplementedError) as cx:
  566. ssl.wrap_socket(s, cert_reqs=ssl.CERT_NONE)
  567. self.assertEqual(str(cx.exception), "only stream sockets are supported")
  568. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  569. with self.assertRaises(NotImplementedError) as cx:
  570. ctx.wrap_socket(s)
  571. self.assertEqual(str(cx.exception), "only stream sockets are supported")
  572. def cert_time_ok(self, timestring, timestamp):
  573. self.assertEqual(ssl.cert_time_to_seconds(timestring), timestamp)
  574. def cert_time_fail(self, timestring):
  575. with self.assertRaises(ValueError):
  576. ssl.cert_time_to_seconds(timestring)
  577. @unittest.skipUnless(utc_offset(),
  578. 'local time needs to be different from UTC')
  579. def test_cert_time_to_seconds_timezone(self):
  580. # Issue #19940: ssl.cert_time_to_seconds() returns wrong
  581. # results if local timezone is not UTC
  582. self.cert_time_ok("May 9 00:00:00 2007 GMT", 1178668800.0)
  583. self.cert_time_ok("Jan 5 09:34:43 2018 GMT", 1515144883.0)
  584. def test_cert_time_to_seconds(self):
  585. timestring = "Jan 5 09:34:43 2018 GMT"
  586. ts = 1515144883.0
  587. self.cert_time_ok(timestring, ts)
  588. # accept keyword parameter, assert its name
  589. self.assertEqual(ssl.cert_time_to_seconds(cert_time=timestring), ts)
  590. # accept both %e and %d (space or zero generated by strftime)
  591. self.cert_time_ok("Jan 05 09:34:43 2018 GMT", ts)
  592. # case-insensitive
  593. self.cert_time_ok("JaN 5 09:34:43 2018 GmT", ts)
  594. self.cert_time_fail("Jan 5 09:34 2018 GMT") # no seconds
  595. self.cert_time_fail("Jan 5 09:34:43 2018") # no GMT
  596. self.cert_time_fail("Jan 5 09:34:43 2018 UTC") # not GMT timezone
  597. self.cert_time_fail("Jan 35 09:34:43 2018 GMT") # invalid day
  598. self.cert_time_fail("Jon 5 09:34:43 2018 GMT") # invalid month
  599. self.cert_time_fail("Jan 5 24:00:00 2018 GMT") # invalid hour
  600. self.cert_time_fail("Jan 5 09:60:43 2018 GMT") # invalid minute
  601. newyear_ts = 1230768000.0
  602. # leap seconds
  603. self.cert_time_ok("Dec 31 23:59:60 2008 GMT", newyear_ts)
  604. # same timestamp
  605. self.cert_time_ok("Jan 1 00:00:00 2009 GMT", newyear_ts)
  606. self.cert_time_ok("Jan 5 09:34:59 2018 GMT", 1515144899)
  607. # allow 60th second (even if it is not a leap second)
  608. self.cert_time_ok("Jan 5 09:34:60 2018 GMT", 1515144900)
  609. # allow 2nd leap second for compatibility with time.strptime()
  610. self.cert_time_ok("Jan 5 09:34:61 2018 GMT", 1515144901)
  611. self.cert_time_fail("Jan 5 09:34:62 2018 GMT") # invalid seconds
  612. # no special treatement for the special value:
  613. # 99991231235959Z (rfc 5280)
  614. self.cert_time_ok("Dec 31 23:59:59 9999 GMT", 253402300799.0)
  615. @support.run_with_locale('LC_ALL', '')
  616. def test_cert_time_to_seconds_locale(self):
  617. # `cert_time_to_seconds()` should be locale independent
  618. def local_february_name():
  619. return time.strftime('%b', (1, 2, 3, 4, 5, 6, 0, 0, 0))
  620. if local_february_name().lower() == 'feb':
  621. self.skipTest("locale-specific month name needs to be "
  622. "different from C locale")
  623. # locale-independent
  624. self.cert_time_ok("Feb 9 00:00:00 2007 GMT", 1170979200.0)
  625. self.cert_time_fail(local_february_name() + " 9 00:00:00 2007 GMT")
  626. class ContextTests(unittest.TestCase):
  627. @skip_if_broken_ubuntu_ssl
  628. def test_constructor(self):
  629. for protocol in PROTOCOLS:
  630. ssl.SSLContext(protocol)
  631. self.assertRaises(TypeError, ssl.SSLContext)
  632. self.assertRaises(ValueError, ssl.SSLContext, -1)
  633. self.assertRaises(ValueError, ssl.SSLContext, 42)
  634. @skip_if_broken_ubuntu_ssl
  635. def test_protocol(self):
  636. for proto in PROTOCOLS:
  637. ctx = ssl.SSLContext(proto)
  638. self.assertEqual(ctx.protocol, proto)
  639. def test_ciphers(self):
  640. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  641. ctx.set_ciphers("ALL")
  642. ctx.set_ciphers("DEFAULT")
  643. with self.assertRaisesRegexp(ssl.SSLError, "No cipher can be selected"):
  644. ctx.set_ciphers("^$:,;?*'dorothyx")
  645. @skip_if_broken_ubuntu_ssl
  646. def test_options(self):
  647. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  648. # OP_ALL | OP_NO_SSLv2 | OP_NO_SSLv3 is the default value
  649. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3,
  650. ctx.options)
  651. ctx.options |= ssl.OP_NO_TLSv1
  652. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3 | ssl.OP_NO_TLSv1,
  653. ctx.options)
  654. if can_clear_options():
  655. ctx.options = (ctx.options & ~ssl.OP_NO_SSLv2) | ssl.OP_NO_TLSv1
  656. self.assertEqual(ssl.OP_ALL | ssl.OP_NO_TLSv1 | ssl.OP_NO_SSLv3,
  657. ctx.options)
  658. ctx.options = 0
  659. self.assertEqual(0, ctx.options)
  660. else:
  661. with self.assertRaises(ValueError):
  662. ctx.options = 0
  663. def test_verify_mode(self):
  664. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  665. # Default value
  666. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  667. ctx.verify_mode = ssl.CERT_OPTIONAL
  668. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  669. ctx.verify_mode = ssl.CERT_REQUIRED
  670. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  671. ctx.verify_mode = ssl.CERT_NONE
  672. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  673. with self.assertRaises(TypeError):
  674. ctx.verify_mode = None
  675. with self.assertRaises(ValueError):
  676. ctx.verify_mode = 42
  677. @unittest.skipUnless(have_verify_flags(),
  678. "verify_flags need OpenSSL > 0.9.8")
  679. def test_verify_flags(self):
  680. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  681. # default value
  682. tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
  683. self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT | tf)
  684. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF
  685. self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_LEAF)
  686. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_CHAIN
  687. self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_CHAIN)
  688. ctx.verify_flags = ssl.VERIFY_DEFAULT
  689. self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT)
  690. # supports any value
  691. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT
  692. self.assertEqual(ctx.verify_flags,
  693. ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT)
  694. with self.assertRaises(TypeError):
  695. ctx.verify_flags = None
  696. def test_load_cert_chain(self):
  697. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  698. # Combined key and cert in a single file
  699. ctx.load_cert_chain(CERTFILE, keyfile=None)
  700. ctx.load_cert_chain(CERTFILE, keyfile=CERTFILE)
  701. self.assertRaises(TypeError, ctx.load_cert_chain, keyfile=CERTFILE)
  702. with self.assertRaises(IOError) as cm:
  703. ctx.load_cert_chain(NONEXISTINGCERT)
  704. self.assertEqual(cm.exception.errno, errno.ENOENT)
  705. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  706. ctx.load_cert_chain(BADCERT)
  707. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  708. ctx.load_cert_chain(EMPTYCERT)
  709. # Separate key and cert
  710. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  711. ctx.load_cert_chain(ONLYCERT, ONLYKEY)
  712. ctx.load_cert_chain(certfile=ONLYCERT, keyfile=ONLYKEY)
  713. ctx.load_cert_chain(certfile=BYTES_ONLYCERT, keyfile=BYTES_ONLYKEY)
  714. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  715. ctx.load_cert_chain(ONLYCERT)
  716. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  717. ctx.load_cert_chain(ONLYKEY)
  718. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  719. ctx.load_cert_chain(certfile=ONLYKEY, keyfile=ONLYCERT)
  720. # Mismatching key and cert
  721. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  722. with self.assertRaisesRegexp(ssl.SSLError, "key values mismatch"):
  723. ctx.load_cert_chain(CAFILE_CACERT, ONLYKEY)
  724. # Password protected key and cert
  725. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD)
  726. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD.encode())
  727. ctx.load_cert_chain(CERTFILE_PROTECTED,
  728. password=bytearray(KEY_PASSWORD.encode()))
  729. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD)
  730. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD.encode())
  731. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED,
  732. bytearray(KEY_PASSWORD.encode()))
  733. with self.assertRaisesRegexp(TypeError, "should be a string"):
  734. ctx.load_cert_chain(CERTFILE_PROTECTED, password=True)
  735. with self.assertRaises(ssl.SSLError):
  736. ctx.load_cert_chain(CERTFILE_PROTECTED, password="badpass")
  737. with self.assertRaisesRegexp(ValueError, "cannot be longer"):
  738. # openssl has a fixed limit on the password buffer.
  739. # PEM_BUFSIZE is generally set to 1kb.
  740. # Return a string larger than this.
  741. ctx.load_cert_chain(CERTFILE_PROTECTED, password=b'a' * 102400)
  742. # Password callback
  743. def getpass_unicode():
  744. return KEY_PASSWORD
  745. def getpass_bytes():
  746. return KEY_PASSWORD.encode()
  747. def getpass_bytearray():
  748. return bytearray(KEY_PASSWORD.encode())
  749. def getpass_badpass():
  750. return "badpass"
  751. def getpass_huge():
  752. return b'a' * (1024 * 1024)
  753. def getpass_bad_type():
  754. return 9
  755. def getpass_exception():
  756. raise Exception('getpass error')
  757. class GetPassCallable:
  758. def __call__(self):
  759. return KEY_PASSWORD
  760. def getpass(self):
  761. return KEY_PASSWORD
  762. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_unicode)
  763. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytes)
  764. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytearray)
  765. ctx.load_cert_chain(CERTFILE_PROTECTED, password=GetPassCallable())
  766. ctx.load_cert_chain(CERTFILE_PROTECTED,
  767. password=GetPassCallable().getpass)
  768. with self.assertRaises(ssl.SSLError):
  769. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_badpass)
  770. with self.assertRaisesRegexp(ValueError, "cannot be longer"):
  771. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_huge)
  772. with self.assertRaisesRegexp(TypeError, "must return a string"):
  773. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bad_type)
  774. with self.assertRaisesRegexp(Exception, "getpass error"):
  775. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_exception)
  776. # Make sure the password function isn't called if it isn't needed
  777. ctx.load_cert_chain(CERTFILE, password=getpass_exception)
  778. def test_load_verify_locations(self):
  779. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  780. ctx.load_verify_locations(CERTFILE)
  781. ctx.load_verify_locations(cafile=CERTFILE, capath=None)
  782. ctx.load_verify_locations(BYTES_CERTFILE)
  783. ctx.load_verify_locations(cafile=BYTES_CERTFILE, capath=None)
  784. ctx.load_verify_locations(cafile=BYTES_CERTFILE.decode('utf-8'))
  785. self.assertRaises(TypeError, ctx.load_verify_locations)
  786. self.assertRaises(TypeError, ctx.load_verify_locations, None, None, None)
  787. with self.assertRaises(IOError) as cm:
  788. ctx.load_verify_locations(NONEXISTINGCERT)
  789. self.assertEqual(cm.exception.errno, errno.ENOENT)
  790. with self.assertRaises(IOError):
  791. ctx.load_verify_locations(u'')
  792. with self.assertRaisesRegexp(ssl.SSLError, "PEM lib"):
  793. ctx.load_verify_locations(BADCERT)
  794. ctx.load_verify_locations(CERTFILE, CAPATH)
  795. ctx.load_verify_locations(CERTFILE, capath=BYTES_CAPATH)
  796. # Issue #10989: crash if the second argument type is invalid
  797. self.assertRaises(TypeError, ctx.load_verify_locations, None, True)
  798. def test_load_verify_cadata(self):
  799. # test cadata
  800. with open(CAFILE_CACERT) as f:
  801. cacert_pem = f.read().decode("ascii")
  802. cacert_der = ssl.PEM_cert_to_DER_cert(cacert_pem)
  803. with open(CAFILE_NEURONIO) as f:
  804. neuronio_pem = f.read().decode("ascii")
  805. neuronio_der = ssl.PEM_cert_to_DER_cert(neuronio_pem)
  806. # test PEM
  807. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  808. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 0)
  809. ctx.load_verify_locations(cadata=cacert_pem)
  810. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 1)
  811. ctx.load_verify_locations(cadata=neuronio_pem)
  812. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  813. # cert already in hash table
  814. ctx.load_verify_locations(cadata=neuronio_pem)
  815. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  816. # combined
  817. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  818. combined = "\n".join((cacert_pem, neuronio_pem))
  819. ctx.load_verify_locations(cadata=combined)
  820. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  821. # with junk around the certs
  822. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  823. combined = ["head", cacert_pem, "other", neuronio_pem, "again",
  824. neuronio_pem, "tail"]
  825. ctx.load_verify_locations(cadata="\n".join(combined))
  826. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  827. # test DER
  828. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  829. ctx.load_verify_locations(cadata=cacert_der)
  830. ctx.load_verify_locations(cadata=neuronio_der)
  831. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  832. # cert already in hash table
  833. ctx.load_verify_locations(cadata=cacert_der)
  834. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  835. # combined
  836. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  837. combined = b"".join((cacert_der, neuronio_der))
  838. ctx.load_verify_locations(cadata=combined)
  839. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  840. # error cases
  841. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  842. self.assertRaises(TypeError, ctx.load_verify_locations, cadata=object)
  843. with self.assertRaisesRegexp(ssl.SSLError, "no start line"):
  844. ctx.load_verify_locations(cadata=u"broken")
  845. with self.assertRaisesRegexp(ssl.SSLError, "not enough data"):
  846. ctx.load_verify_locations(cadata=b"broken")
  847. def test_load_dh_params(self):
  848. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  849. ctx.load_dh_params(DHFILE)
  850. if os.name != 'nt':
  851. ctx.load_dh_params(BYTES_DHFILE)
  852. self.assertRaises(TypeError, ctx.load_dh_params)
  853. self.assertRaises(TypeError, ctx.load_dh_params, None)
  854. with self.assertRaises(IOError) as cm:
  855. ctx.load_dh_params(NONEXISTINGCERT)
  856. self.assertEqual(cm.exception.errno, errno.ENOENT)
  857. with self.assertRaises(ssl.SSLError) as cm:
  858. ctx.load_dh_params(CERTFILE)
  859. @skip_if_broken_ubuntu_ssl
  860. def test_session_stats(self):
  861. for proto in PROTOCOLS:
  862. ctx = ssl.SSLContext(proto)
  863. self.assertEqual(ctx.session_stats(), {
  864. 'number': 0,
  865. 'connect': 0,
  866. 'connect_good': 0,
  867. 'connect_renegotiate': 0,
  868. 'accept': 0,
  869. 'accept_good': 0,
  870. 'accept_renegotiate': 0,
  871. 'hits': 0,
  872. 'misses': 0,
  873. 'timeouts': 0,
  874. 'cache_full': 0,
  875. })
  876. def test_set_default_verify_paths(self):
  877. # There's not much we can do to test that it acts as expected,
  878. # so just check it doesn't crash or raise an exception.
  879. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  880. ctx.set_default_verify_paths()
  881. @unittest.skipUnless(ssl.HAS_ECDH, "ECDH disabled on this OpenSSL build")
  882. def test_set_ecdh_curve(self):
  883. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  884. ctx.set_ecdh_curve("prime256v1")
  885. ctx.set_ecdh_curve(b"prime256v1")
  886. self.assertRaises(TypeError, ctx.set_ecdh_curve)
  887. self.assertRaises(TypeError, ctx.set_ecdh_curve, None)
  888. self.assertRaises(ValueError, ctx.set_ecdh_curve, "foo")
  889. self.assertRaises(ValueError, ctx.set_ecdh_curve, b"foo")
  890. @needs_sni
  891. def test_sni_callback(self):
  892. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  893. # set_servername_callback expects a callable, or None
  894. self.assertRaises(TypeError, ctx.set_servername_callback)
  895. self.assertRaises(TypeError, ctx.set_servername_callback, 4)
  896. self.assertRaises(TypeError, ctx.set_servername_callback, "")
  897. self.assertRaises(TypeError, ctx.set_servername_callback, ctx)
  898. def dummycallback(sock, servername, ctx):
  899. pass
  900. ctx.set_servername_callback(None)
  901. ctx.set_servername_callback(dummycallback)
  902. @needs_sni
  903. def test_sni_callback_refcycle(self):
  904. # Reference cycles through the servername callback are detected
  905. # and cleared.
  906. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  907. def dummycallback(sock, servername, ctx, cycle=ctx):
  908. pass
  909. ctx.set_servername_callback(dummycallback)
  910. wr = weakref.ref(ctx)
  911. del ctx, dummycallback
  912. gc.collect()
  913. self.assertIs(wr(), None)
  914. def test_cert_store_stats(self):
  915. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  916. self.assertEqual(ctx.cert_store_stats(),
  917. {'x509_ca': 0, 'crl': 0, 'x509': 0})
  918. ctx.load_cert_chain(CERTFILE)
  919. self.assertEqual(ctx.cert_store_stats(),
  920. {'x509_ca': 0, 'crl': 0, 'x509': 0})
  921. ctx.load_verify_locations(CERTFILE)
  922. self.assertEqual(ctx.cert_store_stats(),
  923. {'x509_ca': 0, 'crl': 0, 'x509': 1})
  924. ctx.load_verify_locations(CAFILE_CACERT)
  925. self.assertEqual(ctx.cert_store_stats(),
  926. {'x509_ca': 1, 'crl': 0, 'x509': 2})
  927. def test_get_ca_certs(self):
  928. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  929. self.assertEqual(ctx.get_ca_certs(), [])
  930. # CERTFILE is not flagged as X509v3 Basic Constraints: CA:TRUE
  931. ctx.load_verify_locations(CERTFILE)
  932. self.assertEqual(ctx.get_ca_certs(), [])
  933. # but CAFILE_CACERT is a CA cert
  934. ctx.load_verify_locations(CAFILE_CACERT)
  935. self.assertEqual(ctx.get_ca_certs(),
  936. [{'issuer': ((('organizationName', 'Root CA'),),
  937. (('organizationalUnitName', 'http://www.cacert.org'),),
  938. (('commonName', 'CA Cert Signing Authority'),),
  939. (('emailAddress', 'support@cacert.org'),)),
  940. 'notAfter': asn1time('Mar 29 12:29:49 2033 GMT'),
  941. 'notBefore': asn1time('Mar 30 12:29:49 2003 GMT'),
  942. 'serialNumber': '00',
  943. 'crlDistributionPoints': ('https://www.cacert.org/revoke.crl',),
  944. 'subject': ((('organizationName', 'Root CA'),),
  945. (('organizationalUnitName', 'http://www.cacert.org'),),
  946. (('commonName', 'CA Cert Signing Authority'),),
  947. (('emailAddress', 'support@cacert.org'),)),
  948. 'version': 3}])
  949. with open(CAFILE_CACERT) as f:
  950. pem = f.read()
  951. der = ssl.PEM_cert_to_DER_cert(pem)
  952. self.assertEqual(ctx.get_ca_certs(True), [der])
  953. def test_load_default_certs(self):
  954. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  955. ctx.load_default_certs()
  956. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  957. ctx.load_default_certs(ssl.Purpose.SERVER_AUTH)
  958. ctx.load_default_certs()
  959. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  960. ctx.load_default_certs(ssl.Purpose.CLIENT_AUTH)
  961. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  962. self.assertRaises(TypeError, ctx.load_default_certs, None)
  963. self.assertRaises(TypeError, ctx.load_default_certs, 'SERVER_AUTH')
  964. @unittest.skipIf(sys.platform == "win32", "not-Windows specific")
  965. def test_load_default_certs_env(self):
  966. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  967. with support.EnvironmentVarGuard() as env:
  968. env["SSL_CERT_DIR"] = CAPATH
  969. env["SSL_CERT_FILE"] = CERTFILE
  970. ctx.load_default_certs()
  971. self.assertEqual(ctx.cert_store_stats(), {"crl": 0, "x509": 1, "x509_ca": 0})
  972. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  973. def test_load_default_certs_env_windows(self):
  974. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  975. ctx.load_default_certs()
  976. stats = ctx.cert_store_stats()
  977. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  978. with support.EnvironmentVarGuard() as env:
  979. env["SSL_CERT_DIR"] = CAPATH
  980. env["SSL_CERT_FILE"] = CERTFILE
  981. ctx.load_default_certs()
  982. stats["x509"] += 1
  983. self.assertEqual(ctx.cert_store_stats(), stats)
  984. def test_create_default_context(self):
  985. ctx = ssl.create_default_context()
  986. self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
  987. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  988. self.assertTrue(ctx.check_hostname)
  989. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  990. self.assertEqual(
  991. ctx.options & getattr(ssl, "OP_NO_COMPRESSION", 0),
  992. getattr(ssl, "OP_NO_COMPRESSION", 0),
  993. )
  994. with open(SIGNING_CA) as f:
  995. cadata = f.read().decode("ascii")
  996. ctx = ssl.create_default_context(cafile=SIGNING_CA, capath=CAPATH,
  997. cadata=cadata)
  998. self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
  999. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1000. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1001. self.assertEqual(
  1002. ctx.options & getattr(ssl, "OP_NO_COMPRESSION", 0),
  1003. getattr(ssl, "OP_NO_COMPRESSION", 0),
  1004. )
  1005. ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
  1006. self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
  1007. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1008. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1009. self.assertEqual(
  1010. ctx.options & getattr(ssl, "OP_NO_COMPRESSION", 0),
  1011. getattr(ssl, "OP_NO_COMPRESSION", 0),
  1012. )
  1013. self.assertEqual(
  1014. ctx.options & getattr(ssl, "OP_SINGLE_DH_USE", 0),
  1015. getattr(ssl, "OP_SINGLE_DH_USE", 0),
  1016. )
  1017. self.assertEqual(
  1018. ctx.options & getattr(ssl, "OP_SINGLE_ECDH_USE", 0),
  1019. getattr(ssl, "OP_SINGLE_ECDH_USE", 0),
  1020. )
  1021. def test__create_stdlib_context(self):
  1022. ctx = ssl._create_stdlib_context()
  1023. self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
  1024. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1025. self.assertFalse(ctx.check_hostname)
  1026. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1027. ctx = ssl._create_stdlib_context(ssl.PROTOCOL_TLSv1)
  1028. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1)
  1029. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1030. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1031. ctx = ssl._create_stdlib_context(ssl.PROTOCOL_TLSv1,
  1032. cert_reqs=ssl.CERT_REQUIRED,
  1033. check_hostname=True)
  1034. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1)
  1035. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1036. self.assertTrue(ctx.check_hostname)
  1037. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1038. ctx = ssl._create_stdlib_context(purpose=ssl.Purpose.CLIENT_AUTH)
  1039. self.assertEqual(ctx.protocol, ssl.PROTOCOL_SSLv23)
  1040. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1041. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1042. def test__https_verify_certificates(self):
  1043. # Unit test to check the contect factory mapping
  1044. # The factories themselves are tested above
  1045. # This test will fail by design if run under PYTHONHTTPSVERIFY=0
  1046. # (as will various test_httplib tests)
  1047. # Uses a fresh SSL module to avoid affecting the real one
  1048. local_ssl = support.import_fresh_module("ssl")
  1049. # Certificate verification is enabled by default
  1050. self.assertIs(local_ssl._create_default_https_context,
  1051. local_ssl.create_default_context)
  1052. # Turn default verification off
  1053. local_ssl._https_verify_certificates(enable=False)
  1054. self.assertIs(local_ssl._create_default_https_context,
  1055. local_ssl._create_unverified_context)
  1056. # And back on
  1057. local_ssl._https_verify_certificates(enable=True)
  1058. self.assertIs(local_ssl._create_default_https_context,
  1059. local_ssl.create_default_context)
  1060. # The default behaviour is to enable
  1061. local_ssl._https_verify_certificates(enable=False)
  1062. local_ssl._https_verify_certificates()
  1063. self.assertIs(local_ssl._create_default_https_context,
  1064. local_ssl.create_default_context)
  1065. def test__https_verify_envvar(self):
  1066. # Unit test to check the PYTHONHTTPSVERIFY handling
  1067. # Need to use a subprocess so it can still be run under -E
  1068. https_is_verified = """import ssl, sys; \
  1069. status = "Error: _create_default_https_context does not verify certs" \
  1070. if ssl._create_default_https_context is \
  1071. ssl._create_unverified_context \
  1072. else None; \
  1073. sys.exit(status)"""
  1074. https_is_not_verified = """import ssl, sys; \
  1075. status = "Error: _create_default_https_context verifies certs" \
  1076. if ssl._create_default_https_context is \
  1077. ssl.create_default_context \
  1078. else None; \
  1079. sys.exit(status)"""
  1080. extra_env = {}
  1081. # Omitting it leaves verification on
  1082. assert_python_ok("-c", https_is_verified, **extra_env)
  1083. # Setting it to zero turns verification off
  1084. extra_env[ssl._https_verify_envvar] = "0"
  1085. assert_python_ok("-c", https_is_not_verified, **extra_env)
  1086. # Any other value should also leave it on
  1087. for setting in ("", "1", "enabled", "foo"):
  1088. extra_env[ssl._https_verify_envvar] = setting
  1089. assert_python_ok("-c", https_is_verified, **extra_env)
  1090. def test_check_hostname(self):
  1091. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1092. self.assertFalse(ctx.check_hostname)
  1093. # Requires CERT_REQUIRED or CERT_OPTIONAL
  1094. with self.assertRaises(ValueError):
  1095. ctx.check_hostname = True
  1096. ctx.verify_mode = ssl.CERT_REQUIRED
  1097. self.assertFalse(ctx.check_hostname)
  1098. ctx.check_hostname = True
  1099. self.assertTrue(ctx.check_hostname)
  1100. ctx.verify_mode = ssl.CERT_OPTIONAL
  1101. ctx.check_hostname = True
  1102. self.assertTrue(ctx.check_hostname)
  1103. # Cannot set CERT_NONE with check_hostname enabled
  1104. with self.assertRaises(ValueError):
  1105. ctx.verify_mode = ssl.CERT_NONE
  1106. ctx.check_hostname = False
  1107. self.assertFalse(ctx.check_hostname)
  1108. class SSLErrorTests(unittest.TestCase):
  1109. def test_str(self):
  1110. # The str() of a SSLError doesn't include the errno
  1111. e = ssl.SSLError(1, "foo")
  1112. self.assertEqual(str(e), "foo")
  1113. self.assertEqual(e.errno, 1)
  1114. # Same for a subclass
  1115. e = ssl.SSLZeroReturnError(1, "foo")
  1116. self.assertEqual(str(e), "foo")
  1117. self.assertEqual(e.errno, 1)
  1118. def test_lib_reason(self):
  1119. # Test the library and reason attributes
  1120. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1121. with self.assertRaises(ssl.SSLError) as cm:
  1122. ctx.load_dh_params(CERTFILE)
  1123. self.assertEqual(cm.exception.library, 'PEM')
  1124. self.assertEqual(cm.exception.reason, 'NO_START_LINE')
  1125. s = str(cm.exception)
  1126. self.assertTrue(s.startswith("[PEM: NO_START_LINE] no start line"), s)
  1127. def test_subclass(self):
  1128. # Check that the appropriate SSLError subclass is raised
  1129. # (this only tests one of them)
  1130. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1131. with closing(socket.socket()) as s:
  1132. s.bind(("127.0.0.1", 0))
  1133. s.listen(5)
  1134. c = socket.socket()
  1135. c.connect(s.getsockname())
  1136. c.setblocking(False)
  1137. with closing(ctx.wrap_socket(c, False, do_handshake_on_connect=False)) as c:
  1138. with self.assertRaises(ssl.SSLWantReadError) as cm:
  1139. c.do_handshake()
  1140. s = str(cm.exception)
  1141. self.assertTrue(s.startswith("The operation did not complete (read)"), s)
  1142. # For compatibility
  1143. self.assertEqual(cm.exception.errno, ssl.SSL_ERROR_WANT_READ)
  1144. class NetworkedTests(unittest.TestCase):
  1145. def test_connect(self):
  1146. with support.transient_internet(REMOTE_HOST):
  1147. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1148. cert_reqs=ssl.CERT_NONE)
  1149. try:
  1150. s.connect((REMOTE_HOST, 443))
  1151. self.assertEqual({}, s.getpeercert())
  1152. finally:
  1153. s.close()
  1154. # this should fail because we have no verification certs
  1155. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1156. cert_reqs=ssl.CERT_REQUIRED)
  1157. self.assertRaisesRegexp(ssl.SSLError, "certificate verify failed",
  1158. s.connect, (REMOTE_HOST, 443))
  1159. s.close()
  1160. # this should succeed because we specify the root cert
  1161. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1162. cert_reqs=ssl.CERT_REQUIRED,
  1163. ca_certs=REMOTE_ROOT_CERT)
  1164. try:
  1165. s.connect((REMOTE_HOST, 443))
  1166. self.assertTrue(s.getpeercert())
  1167. finally:
  1168. s.close()
  1169. def test_connect_ex(self):
  1170. # Issue #11326: check connect_ex() implementation
  1171. with support.transient_internet(REMOTE_HOST):
  1172. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1173. cert_reqs=ssl.CERT_REQUIRED,
  1174. ca_certs=REMOTE_ROOT_CERT)
  1175. try:
  1176. self.assertEqual(0, s.connect_ex((REMOTE_HOST, 443)))
  1177. self.assertTrue(s.getpeercert())
  1178. finally:
  1179. s.close()
  1180. def test_non_blocking_connect_ex(self):
  1181. # Issue #11326: non-blocking connect_ex() should allow handshake
  1182. # to proceed after the socket gets ready.
  1183. with support.transient_internet(REMOTE_HOST):
  1184. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1185. cert_reqs=ssl.CERT_REQUIRED,
  1186. ca_certs=REMOTE_ROOT_CERT,
  1187. do_handshake_on_connect=False)
  1188. try:
  1189. s.setblocking(False)
  1190. rc = s.connect_ex((REMOTE_HOST, 443))
  1191. # EWOULDBLOCK under Windows, EINPROGRESS elsewhere
  1192. self.assertIn(rc, (0, errno.EINPROGRESS, errno.EWOULDBLOCK))
  1193. # Wait for connect to finish
  1194. select.select([], [s], [], 5.0)
  1195. # Non-blocking handshake
  1196. while True:
  1197. try:
  1198. s.do_handshake()
  1199. break
  1200. except ssl.SSLWantReadError:
  1201. select.select([s], [], [], 5.0)
  1202. except ssl.SSLWantWriteError:
  1203. select.select([], [s], [], 5.0)
  1204. # SSL established
  1205. self.assertTrue(s.getpeercert())
  1206. finally:
  1207. s.close()
  1208. def test_timeout_connect_ex(self):
  1209. # Issue #12065: on a timeout, connect_ex() should return the original
  1210. # errno (mimicking the behaviour of non-SSL sockets).
  1211. with support.transient_internet(REMOTE_HOST):
  1212. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1213. cert_reqs=ssl.CERT_REQUIRED,
  1214. ca_certs=REMOTE_ROOT_CERT,
  1215. do_handshake_on_connect=False)
  1216. try:
  1217. s.settimeout(0.0000001)
  1218. rc = s.connect_ex((REMOTE_HOST, 443))
  1219. if rc == 0:
  1220. self.skipTest("REMOTE_HOST responded too quickly")
  1221. self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
  1222. finally:
  1223. s.close()
  1224. def test_connect_ex_error(self):
  1225. with support.transient_internet(REMOTE_HOST):
  1226. s = ssl.wrap_socket(socket.socket(socket.AF_INET),
  1227. cert_reqs=ssl.CERT_REQUIRED,
  1228. ca_certs=REMOTE_ROOT_CERT)
  1229. try:
  1230. rc = s.connect_ex((REMOTE_HOST, 444))
  1231. # Issue #19919: Windows machines or VMs hosted on Windows
  1232. # machines sometimes return EWOULDBLOCK.
  1233. errors = (
  1234. errno.ECONNREFUSED, errno.EHOSTUNREACH, errno.ETIMEDOUT,
  1235. errno.EWOULDBLOCK,
  1236. )
  1237. self.assertIn(rc, errors)
  1238. finally:
  1239. s.close()
  1240. def test_connect_with_context(self):
  1241. with support.transient_internet(REMOTE_HOST):
  1242. # Same as test_connect, but with a separately created context
  1243. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1244. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1245. s.connect((REMOTE_HOST, 443))
  1246. try:
  1247. self.assertEqual({}, s.getpeercert())
  1248. finally:
  1249. s.close()
  1250. # Same with a server hostname
  1251. s = ctx.wrap_socket(socket.socket(socket.AF_INET),
  1252. server_hostname=REMOTE_HOST)
  1253. s.connect((REMOTE_HOST, 443))
  1254. s.close()
  1255. # This should fail because we have no verification certs
  1256. ctx.verify_mode = ssl.CERT_REQUIRED
  1257. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1258. self.assertRaisesRegexp(ssl.SSLError, "certificate verify failed",
  1259. s.connect, (REMOTE_HOST, 443))
  1260. s.close()
  1261. # This should succeed because we specify the root cert
  1262. ctx.load_verify_locations(REMOTE_ROOT_CERT)
  1263. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1264. s.connect((REMOTE_HOST, 443))
  1265. try:
  1266. cert = s.getpeercert()
  1267. self.assertTrue(cert)
  1268. finally:
  1269. s.close()
  1270. def test_connect_capath(self):
  1271. # Verify server certificates using the `capath` argument
  1272. # NOTE: the subject hashing algorithm has been changed between
  1273. # OpenSSL 0.9.8n and 1.0.0, as a result the capath directory must
  1274. # contain both versions of each certificate (same content, different
  1275. # filename) for this test to be portable across OpenSSL releases.
  1276. with support.transient_internet(REMOTE_HOST):
  1277. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1278. ctx.verify_mode = ssl.CERT_REQUIRED
  1279. ctx.load_verify_locations(capath=CAPATH)
  1280. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1281. s.connect((REMOTE_HOST, 443))
  1282. try:
  1283. cert = s.getpeercert()
  1284. self.assertTrue(cert)
  1285. finally:
  1286. s.close()
  1287. # Same with a bytes `capath` argument
  1288. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1289. ctx.verify_mode = ssl.CERT_REQUIRED
  1290. ctx.load_verify_locations(capath=BYTES_CAPATH)
  1291. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1292. s.connect((REMOTE_HOST, 443))
  1293. try:
  1294. cert = s.getpeercert()
  1295. self.assertTrue(cert)
  1296. finally:
  1297. s.close()
  1298. def test_connect_cadata(self):
  1299. with open(REMOTE_ROOT_CERT) as f:
  1300. pem = f.read().decode('ascii')
  1301. der = ssl.PEM_cert_to_DER_cert(pem)
  1302. with support.transient_internet(REMOTE_HOST):
  1303. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1304. ctx.verify_mode = ssl.CERT_REQUIRED
  1305. ctx.load_verify_locations(cadata=pem)
  1306. with closing(ctx.wrap_socket(socket.socket(socket.AF_INET))) as s:
  1307. s.connect((REMOTE_HOST, 443))
  1308. cert = s.getpeercert()
  1309. self.assertTrue(cert)
  1310. # same with DER
  1311. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1312. ctx.verify_mode = ssl.CERT_REQUIRED
  1313. ctx.load_verify_locations(cadata=der)
  1314. with closing(ctx.wrap_socket(socket.socket(socket.AF_INET))) as s:
  1315. s.connect((REMOTE_HOST, 443))
  1316. cert = s.getpeercert()
  1317. self.assertTrue(cert)
  1318. @unittest.skipIf(os.name == "nt", "Can't use a socket as a file under Windows")
  1319. def test_makefile_close(self):
  1320. # Issue #5238: creating a file-like object with makefile() shouldn't
  1321. # delay closing the underlying "real socket" (here tested with its
  1322. # file descriptor, hence skipping the test under Windows).
  1323. with support.transient_internet(REMOTE_HOST):
  1324. ss = ssl.wrap_socket(socket.socket(socket.AF_INET))
  1325. ss.connect((REMOTE_HOST, 443))
  1326. fd = ss.fileno()
  1327. f = ss.makefile()
  1328. f.close()
  1329. # The fd is still open
  1330. os.read(fd, 0)
  1331. # Closing the SSL socket should close the fd too
  1332. ss.close()
  1333. gc.collect()
  1334. with self.assertRaises(OSError) as e:
  1335. os.read(fd, 0)
  1336. self.assertEqual(e.exception.errno, errno.EBADF)
  1337. def test_non_blocking_handshake(self):
  1338. with support.transient_internet(REMOTE_HOST):
  1339. s = socket.socket(socket.AF_INET)
  1340. s.connect((REMOTE_HOST, 443))
  1341. s.setblocking(False)
  1342. s = ssl.wrap_socket(s,
  1343. cert_reqs=ssl.CERT_NONE,
  1344. do_handshake_on_connect=False)
  1345. count = 0
  1346. while True:
  1347. try:
  1348. count += 1
  1349. s.do_handshake()
  1350. break
  1351. except ssl.SSLWantReadError:
  1352. select.select([s], [], [])
  1353. except ssl.SSLWantWriteError:
  1354. select.select([], [s], [])
  1355. s.close()
  1356. if support.verbose:
  1357. sys.stdout.write("\nNeeded %d calls to do_handshake() to establish session.\n" % count)
  1358. def test_get_server_certificate(self):
  1359. def _test_get_server_certificate(host, port, cert=None):
  1360. with support.transient_internet(host):
  1361. pem = ssl.get_server_certificate((host, port))
  1362. if not pem:
  1363. self.fail("No server certificate on %s:%s!" % (host, port))
  1364. try:
  1365. pem = ssl.get_server_certificate((host, port),
  1366. ca_certs=CERTFILE)
  1367. except ssl.SSLError as x:
  1368. #should fail
  1369. if support.verbose:
  1370. sys.stdout.write("%s\n" % x)
  1371. else:
  1372. self.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
  1373. pem = ssl.get_server_certificate((host, port),
  1374. ca_certs=cert)
  1375. if not pem:
  1376. self.fail("No server certificate on %s:%s!" % (host, port))
  1377. if support.verbose:
  1378. sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
  1379. _test_get_server_certificate(REMOTE_HOST, 443, REMOTE_ROOT_CERT)
  1380. if support.IPV6_ENABLED:
  1381. _test_get_server_certificate('ipv6.google.com', 443)
  1382. def test_ciphers(self):
  1383. remote = (REMOTE_HOST, 443)
  1384. with support.transient_internet(remote[0]):
  1385. with closing(ssl.wrap_socket(socket.socket(socket.AF_INET),
  1386. cert_reqs=ssl.CERT_NONE, ciphers="ALL")) as s:
  1387. s.connect(remote)
  1388. with closing(ssl.wrap_socket(socket.socket(socket.AF_INET),
  1389. cert_reqs=ssl.CERT_NONE, ciphers="DEFAULT")) as s:
  1390. s.connect(remote)
  1391. # Error checking can happen at instantiation or when connecting
  1392. with self.assertRaisesRegexp(ssl.SSLError, "No cipher can be selected"):
  1393. with closing(socket.socket(socket.AF_INET)) as sock:
  1394. s = ssl.wrap_socket(sock,
  1395. cert_reqs=ssl.CERT_NONE, ciphers="^$:,;?*'dorothyx")
  1396. s.connect(remote)
  1397. def test_algorithms(self):
  1398. # Issue #8484: all algorithms should be available when verifying a
  1399. # certificate.
  1400. # SHA256 was added in OpenSSL 0.9.8
  1401. if ssl.OPENSSL_VERSION_INFO < (0, 9, 8, 0, 15):
  1402. self.skipTest("SHA256 not available on %r" % ssl.OPENSSL_VERSION)
  1403. # sha256.tbs-internet.com needs SNI to use the correct certificate
  1404. if not ssl.HAS_SNI:
  1405. self.skipTest("SNI needed for this test")
  1406. # https://sha2.hboeck.de/ was used until 2011-01-08 (no route to host)
  1407. remote = ("sha256.tbs-internet.com", 443)
  1408. sha256_cert = os.path.join(os.path.dirname(__file__), "sha256.pem")
  1409. with support.transient_internet("sha256.tbs-internet.com"):
  1410. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1411. ctx.verify_mode = ssl.CERT_REQUIRED
  1412. ctx.load_verify_locations(sha256_cert)
  1413. s = ctx.wrap_socket(socket.socket(socket.AF_INET),
  1414. server_hostname="sha256.tbs-internet.com")
  1415. try:
  1416. s.connect(remote)
  1417. if support.verbose:
  1418. sys.stdout.write("\nCipher with %r is %r\n" %
  1419. (remote, s.cipher()))
  1420. sys.stdout.write("Certificate is:\n%s\n" %
  1421. pprint.pformat(s.getpeercert()))
  1422. finally:
  1423. s.close()
  1424. def test_get_ca_certs_capath(self):
  1425. # capath certs are loaded on request
  1426. with support.transient_internet(REMOTE_HOST):
  1427. ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1428. ctx.verify_mode = ssl.CERT_REQUIRED
  1429. ctx.load_verify_locations(capath=CAPATH)
  1430. self.assertEqual(ctx.get_ca_certs(), [])
  1431. s = ctx.wrap_socket(socket.socket(socket.AF_INET))
  1432. s.connect((REMOTE_HOST, 443))
  1433. try:
  1434. cert = s.getpeercert()
  1435. self.assertTrue(cert)
  1436. finally:
  1437. s.close()
  1438. self.assertEqual(len(ctx.get_ca_certs()), 1)
  1439. @needs_sni
  1440. def test_context_setget(self):
  1441. # Check that the context of a connected socket can be replaced.
  1442. with support.transient_internet(REMOTE_HOST):
  1443. ctx1 = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1444. ctx2 = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1445. s = socket.socket(socket.AF_INET)
  1446. with closing(ctx1.wrap_socket(s)) as ss:
  1447. ss.connect((REMOTE_HOST, 443))
  1448. self.assertIs(ss.context, ctx1)
  1449. self.assertIs(ss._sslobj.context, ctx1)
  1450. ss.context = ctx2
  1451. self.assertIs(ss.context, ctx2)
  1452. self.assertIs(ss._sslobj.context, ctx2)
  1453. try:
  1454. import threading
  1455. except ImportError:
  1456. _have_threads = False
  1457. else:
  1458. _have_threads = True
  1459. from test.ssl_servers import make_https_server
  1460. class ThreadedEchoServer(threading.Thread):
  1461. class ConnectionHandler(threading.Thread):
  1462. """A mildly complicated class, because we want it to work both
  1463. with and without the SSL wrapper around the socket connection, so
  1464. that we can test the STARTTLS functionality."""
  1465. def __init__(self, server, connsock, addr):
  1466. self.server = server
  1467. self.running = False
  1468. self.sock = connsock
  1469. self.addr = addr
  1470. self.sock.setblocking(1)
  1471. self.sslconn = None
  1472. threading.Thread.__init__(self)
  1473. self.daemon = True
  1474. def wrap_conn(self):
  1475. try:
  1476. self.sslconn = self.server.context.wrap_socket(
  1477. self.sock, server_side=True)
  1478. self.server.selected_npn_protocols.append(self.sslconn.selected_npn_protocol())
  1479. self.server.selected_alpn_protocols.append(self.sslconn.selected_alpn_protocol())
  1480. except socket.error as e:
  1481. # We treat ConnectionResetError as though it were an
  1482. # SSLError - OpenSSL on Ubuntu abruptly closes the
  1483. # connection when asked to use an unsupported protocol.
  1484. #
  1485. # XXX Various errors can have happened here, for example
  1486. # a mismatching protocol version, an invalid certificate,
  1487. # or a low-level bug. This should be made more discriminating.
  1488. if not isinstance(e, ssl.SSLError) and e.errno != errno.ECONNRESET:
  1489. raise
  1490. self.server.conn_errors.append(e)
  1491. if self.server.chatty:
  1492. handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
  1493. self.running = False
  1494. self.server.stop()
  1495. self.close()
  1496. return False
  1497. else:
  1498. if self.server.context.verify_mode == ssl.CERT_REQUIRED:
  1499. cert = self.sslconn.getpeercert()
  1500. if support.verbose and self.server.chatty:
  1501. sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
  1502. cert_binary = self.sslconn.getpeercert(True)
  1503. if support.verbose and self.server.chatty:
  1504. sys.stdout.write(" cert binary is " + str(len(cert_binary)) + " bytes\n")
  1505. cipher = self.sslconn.cipher()
  1506. if support.verbose and self.server.chatty:
  1507. sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
  1508. sys.stdout.write(" server: selected protocol is now "
  1509. + str(self.sslconn.selected_npn_protocol()) + "\n")
  1510. return True
  1511. def read(self):
  1512. if self.sslconn:
  1513. return self.sslconn.read()
  1514. else:
  1515. return self.sock.recv(1024)
  1516. def write(self, bytes):
  1517. if self.sslconn:
  1518. return self.sslconn.write(bytes)
  1519. else:
  1520. return self.sock.send(bytes)
  1521. def close(self):
  1522. if self.sslconn:
  1523. self.sslconn.close()
  1524. else:
  1525. self.sock.close()
  1526. def run(self):
  1527. self.running = True
  1528. if not self.server.starttls_server:
  1529. if not self.wrap_conn():
  1530. return
  1531. while self.running:
  1532. try:
  1533. msg = self.read()
  1534. stripped = msg.strip()
  1535. if not stripped:
  1536. # eof, so quit this handler
  1537. self.running = False
  1538. self.close()
  1539. elif stripped == b'over':
  1540. if support.verbose and self.server.connectionchatty:
  1541. sys.stdout.write(" server: client closed connection\n")
  1542. self.close()
  1543. return
  1544. elif (self.server.starttls_server and
  1545. stripped == b'STARTTLS'):
  1546. if support.verbose and self.server.connectionchatty:
  1547. sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
  1548. self.write(b"OK\n")
  1549. if not self.wrap_conn():
  1550. return
  1551. elif (self.server.starttls_server and self.sslconn
  1552. and stripped == b'ENDTLS'):
  1553. if support.verbose and self.server.connectionchatty:
  1554. sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
  1555. self.write(b"OK\n")
  1556. self.sock = self.sslconn.unwrap()
  1557. self.sslconn = None
  1558. if support.verbose and self.server.connectionchatty:
  1559. sys.stdout.write(" server: connection is now unencrypted...\n")
  1560. elif stripped == b'CB tls-unique':
  1561. if support.verbose and self.server.connectionchatty:
  1562. sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
  1563. data = self.sslconn.get_channel_binding("tls-unique")
  1564. self.write(repr(data).encode("us-ascii") + b"\n")
  1565. else:
  1566. if (support.verbose and
  1567. self.server.connectionchatty):
  1568. ctype = (self.sslconn and "encrypted") or "unencrypted"
  1569. sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
  1570. % (msg, ctype, msg.lower(), ctype))
  1571. self.write(msg.lower())
  1572. except ssl.SSLError:
  1573. if self.server.chatty:
  1574. handle_error("Test server failure:\n")
  1575. self.close()
  1576. self.running = False
  1577. # normally, we'd just stop here, but for the test
  1578. # harness, we want to stop the server
  1579. self.server.stop()
  1580. def __init__(self, certificate=None, ssl_version=None,
  1581. certreqs=None, cacerts=None,
  1582. chatty=True, connectionchatty=False, starttls_server=False,
  1583. npn_protocols=None, alpn_protocols=None,
  1584. ciphers=None, context=None):
  1585. if context:
  1586. self.context = context
  1587. else:
  1588. self.context = ssl.SSLContext(ssl_version
  1589. if ssl_version is not None
  1590. else ssl.PROTOCOL_TLSv1)
  1591. self.context.verify_mode = (certreqs if certreqs is not None
  1592. else ssl.CERT_NONE)
  1593. if cacerts:
  1594. self.context.load_verify_locations(cacerts)
  1595. if certificate:
  1596. self.context.load_cert_chain(certificate)
  1597. if npn_protocols:
  1598. self.context.set_npn_protocols(npn_protocols)
  1599. if alpn_protocols:
  1600. self.context.set_alpn_protocols(alpn_protocols)
  1601. if ciphers:
  1602. self.context.set_ciphers(ciphers)
  1603. self.chatty = chatty
  1604. self.connectionchatty = connectionchatty
  1605. self.starttls_server = starttls_server
  1606. self.sock = socket.socket()
  1607. self.port = support.bind_port(self.sock)
  1608. self.flag = None
  1609. self.active = False
  1610. self.selected_npn_protocols = []
  1611. self.selected_alpn_protocols = []
  1612. self.conn_errors = []
  1613. threading.Thread.__init__(self)
  1614. self.daemon = True
  1615. def __enter__(self):
  1616. self.start(threading.Event())
  1617. self.flag.wait()
  1618. return self
  1619. def __exit__(self, *args):
  1620. self.stop()
  1621. self.join()
  1622. def start(self, flag=None):
  1623. self.flag = flag
  1624. threading.Thread.start(self)
  1625. def run(self):
  1626. self.sock.settimeout(0.05)
  1627. self.sock.listen(5)
  1628. self.active = True
  1629. if self.flag:
  1630. # signal an event
  1631. self.flag.set()
  1632. while self.active:
  1633. try:
  1634. newconn, connaddr = self.sock.accept()
  1635. if support.verbose and self.chatty:
  1636. sys.stdout.write(' server: new connection from '
  1637. + repr(connaddr) + '\n')
  1638. handler = self.ConnectionHandler(self, newconn, connaddr)
  1639. handler.start()
  1640. handler.join()
  1641. except socket.timeout:
  1642. pass
  1643. except KeyboardInterrupt:
  1644. self.stop()
  1645. self.sock.close()
  1646. def stop(self):
  1647. self.active = False
  1648. class AsyncoreEchoServer(threading.Thread):
  1649. class EchoServer(asyncore.dispatcher):
  1650. class ConnectionHandler(asyncore.dispatcher_with_send):
  1651. def __init__(self, conn, certfile):
  1652. self.socket = ssl.wrap_socket(conn, server_side=True,
  1653. certfile=certfile,
  1654. do_handshake_on_connect=False)
  1655. asyncore.dispatcher_with_send.__init__(self, self.socket)
  1656. self._ssl_accepting = True
  1657. self._do_ssl_handshake()
  1658. def readable(self):
  1659. if isinstance(self.socket, ssl.SSLSocket):
  1660. while self.socket.pending() > 0:
  1661. self.handle_read_event()
  1662. return True
  1663. def _do_ssl_handshake(self):
  1664. try:
  1665. self.socket.do_handshake()
  1666. except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
  1667. return
  1668. except ssl.SSLEOFError:
  1669. return self.handle_close()
  1670. except ssl.SSLError:
  1671. raise
  1672. except socket.error, err:
  1673. if err.args[0] == errno.ECONNABORTED:
  1674. return self.handle_close()
  1675. else:
  1676. self._ssl_accepting = False
  1677. def handle_read(self):
  1678. if self._ssl_accepting:
  1679. self._do_ssl_handshake()
  1680. else:
  1681. data = self.recv(1024)
  1682. if support.verbose:
  1683. sys.stdout.write(" server: read %s from client\n" % repr(data))
  1684. if not data:
  1685. self.close()
  1686. else:
  1687. self.send(data.lower())
  1688. def handle_close(self):
  1689. self.close()
  1690. if support.verbose:
  1691. sys.stdout.write(" server: closed connection %s\n" % self.socket)
  1692. def handle_error(self):
  1693. raise
  1694. def __init__(self, certfile):
  1695. self.certfile = certfile
  1696. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  1697. self.port = support.bind_port(sock, '')
  1698. asyncore.dispatcher.__init__(self, sock)
  1699. self.listen(5)
  1700. def handle_accept(self):
  1701. sock_obj, addr = self.accept()
  1702. if support.verbose:
  1703. sys.stdout.write(" server: new connection from %s:%s\n" %addr)
  1704. self.ConnectionHandler(sock_obj, self.certfile)
  1705. def handle_error(self):
  1706. raise
  1707. def __init__(self, certfile):
  1708. self.flag = None
  1709. self.active = False
  1710. self.server = self.EchoServer(certfile)
  1711. self.port = self.server.port
  1712. threading.Thread.__init__(self)
  1713. self.daemon = True
  1714. def __str__(self):
  1715. return "<%s %s>" % (self.__class__.__name__, self.server)
  1716. def __enter__(self):
  1717. self.start(threading.Event())
  1718. self.flag.wait()
  1719. return self
  1720. def __exit__(self, *args):
  1721. if support.verbose:
  1722. sys.stdout.write(" cleanup: stopping server.\n")
  1723. self.stop()
  1724. if support.verbose:
  1725. sys.stdout.write(" cleanup: joining server thread.\n")
  1726. self.join()
  1727. if support.verbose:
  1728. sys.stdout.write(" cleanup: successfully joined.\n")
  1729. def start(self, flag=None):
  1730. self.flag = flag
  1731. threading.Thread.start(self)
  1732. def run(self):
  1733. self.active = True
  1734. if self.flag:
  1735. self.flag.set()
  1736. while self.active:
  1737. try:
  1738. asyncore.loop(1)
  1739. except:
  1740. pass
  1741. def stop(self):
  1742. self.active = False
  1743. self.server.close()
  1744. def server_params_test(client_context, server_context, indata=b"FOO\n",
  1745. chatty=True, connectionchatty=False, sni_name=None):
  1746. """
  1747. Launch a server, connect a client to it and try various reads
  1748. and writes.
  1749. """
  1750. stats = {}
  1751. server = ThreadedEchoServer(context=server_context,
  1752. chatty=chatty,
  1753. connectionchatty=False)
  1754. with server:
  1755. with closing(client_context.wrap_socket(socket.socket(),
  1756. server_hostname=sni_name)) as s:
  1757. s.connect((HOST, server.port))
  1758. for arg in [indata, bytearray(indata), memoryview(indata)]:
  1759. if connectionchatty:
  1760. if support.verbose:
  1761. sys.stdout.write(
  1762. " client: sending %r...\n" % indata)
  1763. s.write(arg)
  1764. outdata = s.read()
  1765. if connectionchatty:
  1766. if support.verbose:
  1767. sys.stdout.write(" client: read %r\n" % outdata)
  1768. if outdata != indata.lower():
  1769. raise AssertionError(
  1770. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  1771. % (outdata[:20], len(outdata),
  1772. indata[:20].lower(), len(indata)))
  1773. s.write(b"over\n")
  1774. if connectionchatty:
  1775. if support.verbose:
  1776. sys.stdout.write(" client: closing connection.\n")
  1777. stats.update({
  1778. 'compression': s.compression(),
  1779. 'cipher': s.cipher(),
  1780. 'peercert': s.getpeercert(),
  1781. 'client_alpn_protocol': s.selected_alpn_protocol(),
  1782. 'client_npn_protocol': s.selected_npn_protocol(),
  1783. 'version': s.version(),
  1784. })
  1785. s.close()
  1786. stats['server_alpn_protocols'] = server.selected_alpn_protocols
  1787. stats['server_npn_protocols'] = server.selected_npn_protocols
  1788. return stats
  1789. def try_protocol_combo(server_protocol, client_protocol, expect_success,
  1790. certsreqs=None, server_options=0, client_options=0):
  1791. """
  1792. Try to SSL-connect using *client_protocol* to *server_protocol*.
  1793. If *expect_success* is true, assert that the connection succeeds,
  1794. if it's false, assert that the connection fails.
  1795. Also, if *expect_success* is a string, assert that it is the protocol
  1796. version actually used by the connection.
  1797. """
  1798. if certsreqs is None:
  1799. certsreqs = ssl.CERT_NONE
  1800. certtype = {
  1801. ssl.CERT_NONE: "CERT_NONE",
  1802. ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
  1803. ssl.CERT_REQUIRED: "CERT_REQUIRED",
  1804. }[certsreqs]
  1805. if support.verbose:
  1806. formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
  1807. sys.stdout.write(formatstr %
  1808. (ssl.get_protocol_name(client_protocol),
  1809. ssl.get_protocol_name(server_protocol),
  1810. certtype))
  1811. client_context = ssl.SSLContext(client_protocol)
  1812. client_context.options |= client_options
  1813. server_context = ssl.SSLContext(server_protocol)
  1814. server_context.options |= server_options
  1815. # NOTE: we must enable "ALL" ciphers on the client, otherwise an
  1816. # SSLv23 client will send an SSLv3 hello (rather than SSLv2)
  1817. # starting from OpenSSL 1.0.0 (see issue #8322).
  1818. if client_context.protocol == ssl.PROTOCOL_SSLv23:
  1819. client_context.set_ciphers("ALL")
  1820. for ctx in (client_context, server_context):
  1821. ctx.verify_mode = certsreqs
  1822. ctx.load_cert_chain(CERTFILE)
  1823. ctx.load_verify_locations(CERTFILE)
  1824. try:
  1825. stats = server_params_test(client_context, server_context,
  1826. chatty=False, connectionchatty=False)
  1827. # Protocol mismatch can result in either an SSLError, or a
  1828. # "Connection reset by peer" error.
  1829. except ssl.SSLError:
  1830. if expect_success:
  1831. raise
  1832. except socket.error as e:
  1833. if expect_success or e.errno != errno.ECONNRESET:
  1834. raise
  1835. else:
  1836. if not expect_success:
  1837. raise AssertionError(
  1838. "Client protocol %s succeeded with server protocol %s!"
  1839. % (ssl.get_protocol_name(client_protocol),
  1840. ssl.get_protocol_name(server_protocol)))
  1841. elif (expect_success is not True
  1842. and expect_success != stats['version']):
  1843. raise AssertionError("version mismatch: expected %r, got %r"
  1844. % (expect_success, stats['version']))
  1845. class ThreadedTests(unittest.TestCase):
  1846. @skip_if_broken_ubuntu_ssl
  1847. def test_echo(self):
  1848. """Basic test of an SSL client connecting to a server"""
  1849. if support.verbose:
  1850. sys.stdout.write("\n")
  1851. for protocol in PROTOCOLS:
  1852. context = ssl.SSLContext(protocol)
  1853. context.load_cert_chain(CERTFILE)
  1854. server_params_test(context, context,
  1855. chatty=True, connectionchatty=True)
  1856. def test_getpeercert(self):
  1857. if support.verbose:
  1858. sys.stdout.write("\n")
  1859. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  1860. context.verify_mode = ssl.CERT_REQUIRED
  1861. context.load_verify_locations(CERTFILE)
  1862. context.load_cert_chain(CERTFILE)
  1863. server = ThreadedEchoServer(context=context, chatty=False)
  1864. with server:
  1865. s = context.wrap_socket(socket.socket(),
  1866. do_handshake_on_connect=False)
  1867. s.connect((HOST, server.port))
  1868. # getpeercert() raise ValueError while the handshake isn't
  1869. # done.
  1870. with self.assertRaises(ValueError):
  1871. s.getpeercert()
  1872. s.do_handshake()
  1873. cert = s.getpeercert()
  1874. self.assertTrue(cert, "Can't get peer certificate.")
  1875. cipher = s.cipher()
  1876. if support.verbose:
  1877. sys.stdout.write(pprint.pformat(cert) + '\n')
  1878. sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
  1879. if 'subject' not in cert:
  1880. self.fail("No subject field in certificate: %s." %
  1881. pprint.pformat(cert))
  1882. if ((('organizationName', 'Python Software Foundation'),)
  1883. not in cert['subject']):
  1884. self.fail(
  1885. "Missing or invalid 'organizationName' field in certificate subject; "
  1886. "should be 'Python Software Foundation'.")
  1887. self.assertIn('notBefore', cert)
  1888. self.assertIn('notAfter', cert)
  1889. before = ssl.cert_time_to_seconds(cert['notBefore'])
  1890. after = ssl.cert_time_to_seconds(cert['notAfter'])
  1891. self.assertLess(before, after)
  1892. s.close()
  1893. @unittest.skipUnless(have_verify_flags(),
  1894. "verify_flags need OpenSSL > 0.9.8")
  1895. def test_crl_check(self):
  1896. if support.verbose:
  1897. sys.stdout.write("\n")
  1898. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1899. server_context.load_cert_chain(SIGNED_CERTFILE)
  1900. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1901. context.verify_mode = ssl.CERT_REQUIRED
  1902. context.load_verify_locations(SIGNING_CA)
  1903. tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
  1904. self.assertEqual(context.verify_flags, ssl.VERIFY_DEFAULT | tf)
  1905. # VERIFY_DEFAULT should pass
  1906. server = ThreadedEchoServer(context=server_context, chatty=True)
  1907. with server:
  1908. with closing(context.wrap_socket(socket.socket())) as s:
  1909. s.connect((HOST, server.port))
  1910. cert = s.getpeercert()
  1911. self.assertTrue(cert, "Can't get peer certificate.")
  1912. # VERIFY_CRL_CHECK_LEAF without a loaded CRL file fails
  1913. context.verify_flags |= ssl.VERIFY_CRL_CHECK_LEAF
  1914. server = ThreadedEchoServer(context=server_context, chatty=True)
  1915. with server:
  1916. with closing(context.wrap_socket(socket.socket())) as s:
  1917. with self.assertRaisesRegexp(ssl.SSLError,
  1918. "certificate verify failed"):
  1919. s.connect((HOST, server.port))
  1920. # now load a CRL file. The CRL file is signed by the CA.
  1921. context.load_verify_locations(CRLFILE)
  1922. server = ThreadedEchoServer(context=server_context, chatty=True)
  1923. with server:
  1924. with closing(context.wrap_socket(socket.socket())) as s:
  1925. s.connect((HOST, server.port))
  1926. cert = s.getpeercert()
  1927. self.assertTrue(cert, "Can't get peer certificate.")
  1928. def test_check_hostname(self):
  1929. if support.verbose:
  1930. sys.stdout.write("\n")
  1931. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1932. server_context.load_cert_chain(SIGNED_CERTFILE)
  1933. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  1934. context.verify_mode = ssl.CERT_REQUIRED
  1935. context.check_hostname = True
  1936. context.load_verify_locations(SIGNING_CA)
  1937. # correct hostname should verify
  1938. server = ThreadedEchoServer(context=server_context, chatty=True)
  1939. with server:
  1940. with closing(context.wrap_socket(socket.socket(),
  1941. server_hostname="localhost")) as s:
  1942. s.connect((HOST, server.port))
  1943. cert = s.getpeercert()
  1944. self.assertTrue(cert, "Can't get peer certificate.")
  1945. # incorrect hostname should raise an exception
  1946. server = ThreadedEchoServer(context=server_context, chatty=True)
  1947. with server:
  1948. with closing(context.wrap_socket(socket.socket(),
  1949. server_hostname="invalid")) as s:
  1950. with self.assertRaisesRegexp(ssl.CertificateError,
  1951. "hostname 'invalid' doesn't match u?'localhost'"):
  1952. s.connect((HOST, server.port))
  1953. # missing server_hostname arg should cause an exception, too
  1954. server = ThreadedEchoServer(context=server_context, chatty=True)
  1955. with server:
  1956. with closing(socket.socket()) as s:
  1957. with self.assertRaisesRegexp(ValueError,
  1958. "check_hostname requires server_hostname"):
  1959. context.wrap_socket(s)
  1960. def test_wrong_cert(self):
  1961. """Connecting when the server rejects the client's certificate
  1962. Launch a server with CERT_REQUIRED, and check that trying to
  1963. connect to it with a wrong client certificate fails.
  1964. """
  1965. certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
  1966. "wrongcert.pem")
  1967. server = ThreadedEchoServer(CERTFILE,
  1968. certreqs=ssl.CERT_REQUIRED,
  1969. cacerts=CERTFILE, chatty=False,
  1970. connectionchatty=False)
  1971. with server, \
  1972. closing(socket.socket()) as sock, \
  1973. closing(ssl.wrap_socket(sock,
  1974. certfile=certfile,
  1975. ssl_version=ssl.PROTOCOL_TLSv1)) as s:
  1976. try:
  1977. # Expect either an SSL error about the server rejecting
  1978. # the connection, or a low-level connection reset (which
  1979. # sometimes happens on Windows)
  1980. s.connect((HOST, server.port))
  1981. except ssl.SSLError as e:
  1982. if support.verbose:
  1983. sys.stdout.write("\nSSLError is %r\n" % e)
  1984. except socket.error as e:
  1985. if e.errno != errno.ECONNRESET:
  1986. raise
  1987. if support.verbose:
  1988. sys.stdout.write("\nsocket.error is %r\n" % e)
  1989. else:
  1990. self.fail("Use of invalid cert should have failed!")
  1991. def test_rude_shutdown(self):
  1992. """A brutal shutdown of an SSL server should raise an OSError
  1993. in the client when attempting handshake.
  1994. """
  1995. listener_ready = threading.Event()
  1996. listener_gone = threading.Event()
  1997. s = socket.socket()
  1998. port = support.bind_port(s, HOST)
  1999. # `listener` runs in a thread. It sits in an accept() until
  2000. # the main thread connects. Then it rudely closes the socket,
  2001. # and sets Event `listener_gone` to let the main thread know
  2002. # the socket is gone.
  2003. def listener():
  2004. s.listen(5)
  2005. listener_ready.set()
  2006. newsock, addr = s.accept()
  2007. newsock.close()
  2008. s.close()
  2009. listener_gone.set()
  2010. def connector():
  2011. listener_ready.wait()
  2012. with closing(socket.socket()) as c:
  2013. c.connect((HOST, port))
  2014. listener_gone.wait()
  2015. try:
  2016. ssl_sock = ssl.wrap_socket(c)
  2017. except socket.error:
  2018. pass
  2019. else:
  2020. self.fail('connecting to closed SSL socket should have failed')
  2021. t = threading.Thread(target=listener)
  2022. t.start()
  2023. try:
  2024. connector()
  2025. finally:
  2026. t.join()
  2027. @skip_if_broken_ubuntu_ssl
  2028. @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv2'),
  2029. "OpenSSL is compiled without SSLv2 support")
  2030. def test_protocol_sslv2(self):
  2031. """Connecting to an SSLv2 server with various client options"""
  2032. if support.verbose:
  2033. sys.stdout.write("\n")
  2034. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
  2035. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
  2036. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
  2037. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False)
  2038. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
  2039. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
  2040. # SSLv23 client with specific SSL options
  2041. if no_sslv2_implies_sslv3_hello():
  2042. # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
  2043. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
  2044. client_options=ssl.OP_NO_SSLv2)
  2045. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
  2046. client_options=ssl.OP_NO_SSLv3)
  2047. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv23, False,
  2048. client_options=ssl.OP_NO_TLSv1)
  2049. @skip_if_broken_ubuntu_ssl
  2050. def test_protocol_sslv23(self):
  2051. """Connecting to an SSLv23 server with various client options"""
  2052. if support.verbose:
  2053. sys.stdout.write("\n")
  2054. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  2055. try:
  2056. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv2, True)
  2057. except socket.error as x:
  2058. # this fails on some older versions of OpenSSL (0.9.7l, for instance)
  2059. if support.verbose:
  2060. sys.stdout.write(
  2061. " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
  2062. % str(x))
  2063. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2064. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False)
  2065. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True)
  2066. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1')
  2067. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2068. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False, ssl.CERT_OPTIONAL)
  2069. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_OPTIONAL)
  2070. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
  2071. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2072. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False, ssl.CERT_REQUIRED)
  2073. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True, ssl.CERT_REQUIRED)
  2074. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
  2075. # Server with specific SSL options
  2076. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2077. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv3, False,
  2078. server_options=ssl.OP_NO_SSLv3)
  2079. # Will choose TLSv1
  2080. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_SSLv23, True,
  2081. server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
  2082. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1, False,
  2083. server_options=ssl.OP_NO_TLSv1)
  2084. @skip_if_broken_ubuntu_ssl
  2085. @unittest.skipUnless(hasattr(ssl, 'PROTOCOL_SSLv3'),
  2086. "OpenSSL is compiled without SSLv3 support")
  2087. def test_protocol_sslv3(self):
  2088. """Connecting to an SSLv3 server with various client options"""
  2089. if support.verbose:
  2090. sys.stdout.write("\n")
  2091. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3')
  2092. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_OPTIONAL)
  2093. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_REQUIRED)
  2094. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  2095. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
  2096. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23, False,
  2097. client_options=ssl.OP_NO_SSLv3)
  2098. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
  2099. if no_sslv2_implies_sslv3_hello():
  2100. # No SSLv2 => client will use an SSLv3 hello on recent OpenSSLs
  2101. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv23,
  2102. False, client_options=ssl.OP_NO_SSLv2)
  2103. @skip_if_broken_ubuntu_ssl
  2104. def test_protocol_tlsv1(self):
  2105. """Connecting to a TLSv1 server with various client options"""
  2106. if support.verbose:
  2107. sys.stdout.write("\n")
  2108. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1')
  2109. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
  2110. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
  2111. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  2112. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
  2113. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2114. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
  2115. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv23, False,
  2116. client_options=ssl.OP_NO_TLSv1)
  2117. @skip_if_broken_ubuntu_ssl
  2118. @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_1"),
  2119. "TLS version 1.1 not supported.")
  2120. def test_protocol_tlsv1_1(self):
  2121. """Connecting to a TLSv1.1 server with various client options.
  2122. Testing against older TLS versions."""
  2123. if support.verbose:
  2124. sys.stdout.write("\n")
  2125. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
  2126. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  2127. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv2, False)
  2128. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2129. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv3, False)
  2130. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv23, False,
  2131. client_options=ssl.OP_NO_TLSv1_1)
  2132. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
  2133. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1, False)
  2134. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_1, False)
  2135. @skip_if_broken_ubuntu_ssl
  2136. @unittest.skipUnless(hasattr(ssl, "PROTOCOL_TLSv1_2"),
  2137. "TLS version 1.2 not supported.")
  2138. def test_protocol_tlsv1_2(self):
  2139. """Connecting to a TLSv1.2 server with various client options.
  2140. Testing against older TLS versions."""
  2141. if support.verbose:
  2142. sys.stdout.write("\n")
  2143. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2',
  2144. server_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,
  2145. client_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,)
  2146. if hasattr(ssl, 'PROTOCOL_SSLv2'):
  2147. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv2, False)
  2148. if hasattr(ssl, 'PROTOCOL_SSLv3'):
  2149. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv3, False)
  2150. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv23, False,
  2151. client_options=ssl.OP_NO_TLSv1_2)
  2152. try_protocol_combo(ssl.PROTOCOL_SSLv23, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2')
  2153. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1, False)
  2154. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_2, False)
  2155. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_1, False)
  2156. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_2, False)
  2157. def test_starttls(self):
  2158. """Switching from clear text to encrypted and back again."""
  2159. msgs = (b"msg 1", b"MSG 2", b"STARTTLS", b"MSG 3", b"msg 4", b"ENDTLS", b"msg 5", b"msg 6")
  2160. server = ThreadedEchoServer(CERTFILE,
  2161. ssl_version=ssl.PROTOCOL_TLSv1,
  2162. starttls_server=True,
  2163. chatty=True,
  2164. connectionchatty=True)
  2165. wrapped = False
  2166. with server:
  2167. s = socket.socket()
  2168. s.setblocking(1)
  2169. s.connect((HOST, server.port))
  2170. if support.verbose:
  2171. sys.stdout.write("\n")
  2172. for indata in msgs:
  2173. if support.verbose:
  2174. sys.stdout.write(
  2175. " client: sending %r...\n" % indata)
  2176. if wrapped:
  2177. conn.write(indata)
  2178. outdata = conn.read()
  2179. else:
  2180. s.send(indata)
  2181. outdata = s.recv(1024)
  2182. msg = outdata.strip().lower()
  2183. if indata == b"STARTTLS" and msg.startswith(b"ok"):
  2184. # STARTTLS ok, switch to secure mode
  2185. if support.verbose:
  2186. sys.stdout.write(
  2187. " client: read %r from server, starting TLS...\n"
  2188. % msg)
  2189. conn = ssl.wrap_socket(s, ssl_version=ssl.PROTOCOL_TLSv1)
  2190. wrapped = True
  2191. elif indata == b"ENDTLS" and msg.startswith(b"ok"):
  2192. # ENDTLS ok, switch back to clear text
  2193. if support.verbose:
  2194. sys.stdout.write(
  2195. " client: read %r from server, ending TLS...\n"
  2196. % msg)
  2197. s = conn.unwrap()
  2198. wrapped = False
  2199. else:
  2200. if support.verbose:
  2201. sys.stdout.write(
  2202. " client: read %r from server\n" % msg)
  2203. if support.verbose:
  2204. sys.stdout.write(" client: closing connection.\n")
  2205. if wrapped:
  2206. conn.write(b"over\n")
  2207. else:
  2208. s.send(b"over\n")
  2209. if wrapped:
  2210. conn.close()
  2211. else:
  2212. s.close()
  2213. def test_socketserver(self):
  2214. """Using a SocketServer to create and manage SSL connections."""
  2215. server = make_https_server(self, certfile=CERTFILE)
  2216. # try to connect
  2217. if support.verbose:
  2218. sys.stdout.write('\n')
  2219. with open(CERTFILE, 'rb') as f:
  2220. d1 = f.read()
  2221. d2 = ''
  2222. # now fetch the same data from the HTTPS server
  2223. url = 'https://localhost:%d/%s' % (
  2224. server.port, os.path.split(CERTFILE)[1])
  2225. context = ssl.create_default_context(cafile=CERTFILE)
  2226. f = urllib2.urlopen(url, context=context)
  2227. try:
  2228. dlen = f.info().getheader("content-length")
  2229. if dlen and (int(dlen) > 0):
  2230. d2 = f.read(int(dlen))
  2231. if support.verbose:
  2232. sys.stdout.write(
  2233. " client: read %d bytes from remote server '%s'\n"
  2234. % (len(d2), server))
  2235. finally:
  2236. f.close()
  2237. self.assertEqual(d1, d2)
  2238. def test_asyncore_server(self):
  2239. """Check the example asyncore integration."""
  2240. indata = "TEST MESSAGE of mixed case\n"
  2241. if support.verbose:
  2242. sys.stdout.write("\n")
  2243. indata = b"FOO\n"
  2244. server = AsyncoreEchoServer(CERTFILE)
  2245. with server:
  2246. s = ssl.wrap_socket(socket.socket())
  2247. s.connect(('127.0.0.1', server.port))
  2248. if support.verbose:
  2249. sys.stdout.write(
  2250. " client: sending %r...\n" % indata)
  2251. s.write(indata)
  2252. outdata = s.read()
  2253. if support.verbose:
  2254. sys.stdout.write(" client: read %r\n" % outdata)
  2255. if outdata != indata.lower():
  2256. self.fail(
  2257. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  2258. % (outdata[:20], len(outdata),
  2259. indata[:20].lower(), len(indata)))
  2260. s.write(b"over\n")
  2261. if support.verbose:
  2262. sys.stdout.write(" client: closing connection.\n")
  2263. s.close()
  2264. if support.verbose:
  2265. sys.stdout.write(" client: connection closed.\n")
  2266. def test_recv_send(self):
  2267. """Test recv(), send() and friends."""
  2268. if support.verbose:
  2269. sys.stdout.write("\n")
  2270. server = ThreadedEchoServer(CERTFILE,
  2271. certreqs=ssl.CERT_NONE,
  2272. ssl_version=ssl.PROTOCOL_TLSv1,
  2273. cacerts=CERTFILE,
  2274. chatty=True,
  2275. connectionchatty=False)
  2276. with server:
  2277. s = ssl.wrap_socket(socket.socket(),
  2278. server_side=False,
  2279. certfile=CERTFILE,
  2280. ca_certs=CERTFILE,
  2281. cert_reqs=ssl.CERT_NONE,
  2282. ssl_version=ssl.PROTOCOL_TLSv1)
  2283. s.connect((HOST, server.port))
  2284. # helper methods for standardising recv* method signatures
  2285. def _recv_into():
  2286. b = bytearray(b"\0"*100)
  2287. count = s.recv_into(b)
  2288. return b[:count]
  2289. def _recvfrom_into():
  2290. b = bytearray(b"\0"*100)
  2291. count, addr = s.recvfrom_into(b)
  2292. return b[:count]
  2293. # (name, method, whether to expect success, *args)
  2294. send_methods = [
  2295. ('send', s.send, True, []),
  2296. ('sendto', s.sendto, False, ["some.address"]),
  2297. ('sendall', s.sendall, True, []),
  2298. ]
  2299. recv_methods = [
  2300. ('recv', s.recv, True, []),
  2301. ('recvfrom', s.recvfrom, False, ["some.address"]),
  2302. ('recv_into', _recv_into, True, []),
  2303. ('recvfrom_into', _recvfrom_into, False, []),
  2304. ]
  2305. data_prefix = u"PREFIX_"
  2306. for meth_name, send_meth, expect_success, args in send_methods:
  2307. indata = (data_prefix + meth_name).encode('ascii')
  2308. try:
  2309. send_meth(indata, *args)
  2310. outdata = s.read()
  2311. if outdata != indata.lower():
  2312. self.fail(
  2313. "While sending with <<{name:s}>> bad data "
  2314. "<<{outdata:r}>> ({nout:d}) received; "
  2315. "expected <<{indata:r}>> ({nin:d})\n".format(
  2316. name=meth_name, outdata=outdata[:20],
  2317. nout=len(outdata),
  2318. indata=indata[:20], nin=len(indata)
  2319. )
  2320. )
  2321. except ValueError as e:
  2322. if expect_success:
  2323. self.fail(
  2324. "Failed to send with method <<{name:s}>>; "
  2325. "expected to succeed.\n".format(name=meth_name)
  2326. )
  2327. if not str(e).startswith(meth_name):
  2328. self.fail(
  2329. "Method <<{name:s}>> failed with unexpected "
  2330. "exception message: {exp:s}\n".format(
  2331. name=meth_name, exp=e
  2332. )
  2333. )
  2334. for meth_name, recv_meth, expect_success, args in recv_methods:
  2335. indata = (data_prefix + meth_name).encode('ascii')
  2336. try:
  2337. s.send(indata)
  2338. outdata = recv_meth(*args)
  2339. if outdata != indata.lower():
  2340. self.fail(
  2341. "While receiving with <<{name:s}>> bad data "
  2342. "<<{outdata:r}>> ({nout:d}) received; "
  2343. "expected <<{indata:r}>> ({nin:d})\n".format(
  2344. name=meth_name, outdata=outdata[:20],
  2345. nout=len(outdata),
  2346. indata=indata[:20], nin=len(indata)
  2347. )
  2348. )
  2349. except ValueError as e:
  2350. if expect_success:
  2351. self.fail(
  2352. "Failed to receive with method <<{name:s}>>; "
  2353. "expected to succeed.\n".format(name=meth_name)
  2354. )
  2355. if not str(e).startswith(meth_name):
  2356. self.fail(
  2357. "Method <<{name:s}>> failed with unexpected "
  2358. "exception message: {exp:s}\n".format(
  2359. name=meth_name, exp=e
  2360. )
  2361. )
  2362. # consume data
  2363. s.read()
  2364. data = b"data"
  2365. # read(-1, buffer) is supported, even though read(-1) is not
  2366. s.send(data)
  2367. buffer = bytearray(len(data))
  2368. self.assertEqual(s.read(-1, buffer), len(data))
  2369. self.assertEqual(buffer, data)
  2370. # recv/read(0) should return no data
  2371. s.send(data)
  2372. self.assertEqual(s.recv(0), b"")
  2373. self.assertEqual(s.read(0), b"")
  2374. self.assertEqual(s.read(), data)
  2375. s.write(b"over\n")
  2376. self.assertRaises(ValueError, s.recv, -1)
  2377. self.assertRaises(ValueError, s.read, -1)
  2378. s.close()
  2379. def test_handshake_timeout(self):
  2380. # Issue #5103: SSL handshake must respect the socket timeout
  2381. server = socket.socket(socket.AF_INET)
  2382. host = "127.0.0.1"
  2383. port = support.bind_port(server)
  2384. started = threading.Event()
  2385. finish = False
  2386. def serve():
  2387. server.listen(5)
  2388. started.set()
  2389. conns = []
  2390. while not finish:
  2391. r, w, e = select.select([server], [], [], 0.1)
  2392. if server in r:
  2393. # Let the socket hang around rather than having
  2394. # it closed by garbage collection.
  2395. conns.append(server.accept()[0])
  2396. for sock in conns:
  2397. sock.close()
  2398. t = threading.Thread(target=serve)
  2399. t.start()
  2400. started.wait()
  2401. try:
  2402. try:
  2403. c = socket.socket(socket.AF_INET)
  2404. c.settimeout(0.2)
  2405. c.connect((host, port))
  2406. # Will attempt handshake and time out
  2407. self.assertRaisesRegexp(ssl.SSLError, "timed out",
  2408. ssl.wrap_socket, c)
  2409. finally:
  2410. c.close()
  2411. try:
  2412. c = socket.socket(socket.AF_INET)
  2413. c = ssl.wrap_socket(c)
  2414. c.settimeout(0.2)
  2415. # Will attempt handshake and time out
  2416. self.assertRaisesRegexp(ssl.SSLError, "timed out",
  2417. c.connect, (host, port))
  2418. finally:
  2419. c.close()
  2420. finally:
  2421. finish = True
  2422. t.join()
  2423. server.close()
  2424. def test_server_accept(self):
  2425. # Issue #16357: accept() on a SSLSocket created through
  2426. # SSLContext.wrap_socket().
  2427. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2428. context.verify_mode = ssl.CERT_REQUIRED
  2429. context.load_verify_locations(CERTFILE)
  2430. context.load_cert_chain(CERTFILE)
  2431. server = socket.socket(socket.AF_INET)
  2432. host = "127.0.0.1"
  2433. port = support.bind_port(server)
  2434. server = context.wrap_socket(server, server_side=True)
  2435. evt = threading.Event()
  2436. remote = [None]
  2437. peer = [None]
  2438. def serve():
  2439. server.listen(5)
  2440. # Block on the accept and wait on the connection to close.
  2441. evt.set()
  2442. remote[0], peer[0] = server.accept()
  2443. remote[0].recv(1)
  2444. t = threading.Thread(target=serve)
  2445. t.start()
  2446. # Client wait until server setup and perform a connect.
  2447. evt.wait()
  2448. client = context.wrap_socket(socket.socket())
  2449. client.connect((host, port))
  2450. client_addr = client.getsockname()
  2451. client.close()
  2452. t.join()
  2453. remote[0].close()
  2454. server.close()
  2455. # Sanity checks.
  2456. self.assertIsInstance(remote[0], ssl.SSLSocket)
  2457. self.assertEqual(peer[0], client_addr)
  2458. def test_getpeercert_enotconn(self):
  2459. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2460. with closing(context.wrap_socket(socket.socket())) as sock:
  2461. with self.assertRaises(socket.error) as cm:
  2462. sock.getpeercert()
  2463. self.assertEqual(cm.exception.errno, errno.ENOTCONN)
  2464. def test_do_handshake_enotconn(self):
  2465. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2466. with closing(context.wrap_socket(socket.socket())) as sock:
  2467. with self.assertRaises(socket.error) as cm:
  2468. sock.do_handshake()
  2469. self.assertEqual(cm.exception.errno, errno.ENOTCONN)
  2470. def test_default_ciphers(self):
  2471. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2472. try:
  2473. # Force a set of weak ciphers on our client context
  2474. context.set_ciphers("DES")
  2475. except ssl.SSLError:
  2476. self.skipTest("no DES cipher available")
  2477. with ThreadedEchoServer(CERTFILE,
  2478. ssl_version=ssl.PROTOCOL_SSLv23,
  2479. chatty=False) as server:
  2480. with closing(context.wrap_socket(socket.socket())) as s:
  2481. with self.assertRaises(ssl.SSLError):
  2482. s.connect((HOST, server.port))
  2483. self.assertIn("no shared cipher", str(server.conn_errors[0]))
  2484. def test_version_basic(self):
  2485. """
  2486. Basic tests for SSLSocket.version().
  2487. More tests are done in the test_protocol_*() methods.
  2488. """
  2489. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2490. with ThreadedEchoServer(CERTFILE,
  2491. ssl_version=ssl.PROTOCOL_TLSv1,
  2492. chatty=False) as server:
  2493. with closing(context.wrap_socket(socket.socket())) as s:
  2494. self.assertIs(s.version(), None)
  2495. s.connect((HOST, server.port))
  2496. self.assertEqual(s.version(), "TLSv1")
  2497. self.assertIs(s.version(), None)
  2498. @unittest.skipUnless(ssl.HAS_ECDH, "test requires ECDH-enabled OpenSSL")
  2499. def test_default_ecdh_curve(self):
  2500. # Issue #21015: elliptic curve-based Diffie Hellman key exchange
  2501. # should be enabled by default on SSL contexts.
  2502. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2503. context.load_cert_chain(CERTFILE)
  2504. # Prior to OpenSSL 1.0.0, ECDH ciphers have to be enabled
  2505. # explicitly using the 'ECCdraft' cipher alias. Otherwise,
  2506. # our default cipher list should prefer ECDH-based ciphers
  2507. # automatically.
  2508. if ssl.OPENSSL_VERSION_INFO < (1, 0, 0):
  2509. context.set_ciphers("ECCdraft:ECDH")
  2510. with ThreadedEchoServer(context=context) as server:
  2511. with closing(context.wrap_socket(socket.socket())) as s:
  2512. s.connect((HOST, server.port))
  2513. self.assertIn("ECDH", s.cipher()[0])
  2514. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  2515. "'tls-unique' channel binding not available")
  2516. def test_tls_unique_channel_binding(self):
  2517. """Test tls-unique channel binding."""
  2518. if support.verbose:
  2519. sys.stdout.write("\n")
  2520. server = ThreadedEchoServer(CERTFILE,
  2521. certreqs=ssl.CERT_NONE,
  2522. ssl_version=ssl.PROTOCOL_TLSv1,
  2523. cacerts=CERTFILE,
  2524. chatty=True,
  2525. connectionchatty=False)
  2526. with server:
  2527. s = ssl.wrap_socket(socket.socket(),
  2528. server_side=False,
  2529. certfile=CERTFILE,
  2530. ca_certs=CERTFILE,
  2531. cert_reqs=ssl.CERT_NONE,
  2532. ssl_version=ssl.PROTOCOL_TLSv1)
  2533. s.connect((HOST, server.port))
  2534. # get the data
  2535. cb_data = s.get_channel_binding("tls-unique")
  2536. if support.verbose:
  2537. sys.stdout.write(" got channel binding data: {0!r}\n"
  2538. .format(cb_data))
  2539. # check if it is sane
  2540. self.assertIsNotNone(cb_data)
  2541. self.assertEqual(len(cb_data), 12) # True for TLSv1
  2542. # and compare with the peers version
  2543. s.write(b"CB tls-unique\n")
  2544. peer_data_repr = s.read().strip()
  2545. self.assertEqual(peer_data_repr,
  2546. repr(cb_data).encode("us-ascii"))
  2547. s.close()
  2548. # now, again
  2549. s = ssl.wrap_socket(socket.socket(),
  2550. server_side=False,
  2551. certfile=CERTFILE,
  2552. ca_certs=CERTFILE,
  2553. cert_reqs=ssl.CERT_NONE,
  2554. ssl_version=ssl.PROTOCOL_TLSv1)
  2555. s.connect((HOST, server.port))
  2556. new_cb_data = s.get_channel_binding("tls-unique")
  2557. if support.verbose:
  2558. sys.stdout.write(" got another channel binding data: {0!r}\n"
  2559. .format(new_cb_data))
  2560. # is it really unique
  2561. self.assertNotEqual(cb_data, new_cb_data)
  2562. self.assertIsNotNone(cb_data)
  2563. self.assertEqual(len(cb_data), 12) # True for TLSv1
  2564. s.write(b"CB tls-unique\n")
  2565. peer_data_repr = s.read().strip()
  2566. self.assertEqual(peer_data_repr,
  2567. repr(new_cb_data).encode("us-ascii"))
  2568. s.close()
  2569. def test_compression(self):
  2570. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2571. context.load_cert_chain(CERTFILE)
  2572. stats = server_params_test(context, context,
  2573. chatty=True, connectionchatty=True)
  2574. if support.verbose:
  2575. sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
  2576. self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
  2577. @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
  2578. "ssl.OP_NO_COMPRESSION needed for this test")
  2579. def test_compression_disabled(self):
  2580. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2581. context.load_cert_chain(CERTFILE)
  2582. context.options |= ssl.OP_NO_COMPRESSION
  2583. stats = server_params_test(context, context,
  2584. chatty=True, connectionchatty=True)
  2585. self.assertIs(stats['compression'], None)
  2586. def test_dh_params(self):
  2587. # Check we can get a connection with ephemeral Diffie-Hellman
  2588. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2589. context.load_cert_chain(CERTFILE)
  2590. context.load_dh_params(DHFILE)
  2591. context.set_ciphers("kEDH")
  2592. stats = server_params_test(context, context,
  2593. chatty=True, connectionchatty=True)
  2594. cipher = stats["cipher"][0]
  2595. parts = cipher.split("-")
  2596. if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
  2597. self.fail("Non-DH cipher: " + cipher[0])
  2598. def test_selected_alpn_protocol(self):
  2599. # selected_alpn_protocol() is None unless ALPN is used.
  2600. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2601. context.load_cert_chain(CERTFILE)
  2602. stats = server_params_test(context, context,
  2603. chatty=True, connectionchatty=True)
  2604. self.assertIs(stats['client_alpn_protocol'], None)
  2605. @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support required")
  2606. def test_selected_alpn_protocol_if_server_uses_alpn(self):
  2607. # selected_alpn_protocol() is None unless ALPN is used by the client.
  2608. client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2609. client_context.load_verify_locations(CERTFILE)
  2610. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2611. server_context.load_cert_chain(CERTFILE)
  2612. server_context.set_alpn_protocols(['foo', 'bar'])
  2613. stats = server_params_test(client_context, server_context,
  2614. chatty=True, connectionchatty=True)
  2615. self.assertIs(stats['client_alpn_protocol'], None)
  2616. @unittest.skipUnless(ssl.HAS_ALPN, "ALPN support needed for this test")
  2617. def test_alpn_protocols(self):
  2618. server_protocols = ['foo', 'bar', 'milkshake']
  2619. protocol_tests = [
  2620. (['foo', 'bar'], 'foo'),
  2621. (['bar', 'foo'], 'foo'),
  2622. (['milkshake'], 'milkshake'),
  2623. (['http/3.0', 'http/4.0'], None)
  2624. ]
  2625. for client_protocols, expected in protocol_tests:
  2626. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2627. server_context.load_cert_chain(CERTFILE)
  2628. server_context.set_alpn_protocols(server_protocols)
  2629. client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2630. client_context.load_cert_chain(CERTFILE)
  2631. client_context.set_alpn_protocols(client_protocols)
  2632. stats = server_params_test(client_context, server_context,
  2633. chatty=True, connectionchatty=True)
  2634. msg = "failed trying %s (s) and %s (c).\n" \
  2635. "was expecting %s, but got %%s from the %%s" \
  2636. % (str(server_protocols), str(client_protocols),
  2637. str(expected))
  2638. client_result = stats['client_alpn_protocol']
  2639. self.assertEqual(client_result, expected, msg % (client_result, "client"))
  2640. server_result = stats['server_alpn_protocols'][-1] \
  2641. if len(stats['server_alpn_protocols']) else 'nothing'
  2642. self.assertEqual(server_result, expected, msg % (server_result, "server"))
  2643. def test_selected_npn_protocol(self):
  2644. # selected_npn_protocol() is None unless NPN is used
  2645. context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2646. context.load_cert_chain(CERTFILE)
  2647. stats = server_params_test(context, context,
  2648. chatty=True, connectionchatty=True)
  2649. self.assertIs(stats['client_npn_protocol'], None)
  2650. @unittest.skipUnless(ssl.HAS_NPN, "NPN support needed for this test")
  2651. def test_npn_protocols(self):
  2652. server_protocols = ['http/1.1', 'spdy/2']
  2653. protocol_tests = [
  2654. (['http/1.1', 'spdy/2'], 'http/1.1'),
  2655. (['spdy/2', 'http/1.1'], 'http/1.1'),
  2656. (['spdy/2', 'test'], 'spdy/2'),
  2657. (['abc', 'def'], 'abc')
  2658. ]
  2659. for client_protocols, expected in protocol_tests:
  2660. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2661. server_context.load_cert_chain(CERTFILE)
  2662. server_context.set_npn_protocols(server_protocols)
  2663. client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2664. client_context.load_cert_chain(CERTFILE)
  2665. client_context.set_npn_protocols(client_protocols)
  2666. stats = server_params_test(client_context, server_context,
  2667. chatty=True, connectionchatty=True)
  2668. msg = "failed trying %s (s) and %s (c).\n" \
  2669. "was expecting %s, but got %%s from the %%s" \
  2670. % (str(server_protocols), str(client_protocols),
  2671. str(expected))
  2672. client_result = stats['client_npn_protocol']
  2673. self.assertEqual(client_result, expected, msg % (client_result, "client"))
  2674. server_result = stats['server_npn_protocols'][-1] \
  2675. if len(stats['server_npn_protocols']) else 'nothing'
  2676. self.assertEqual(server_result, expected, msg % (server_result, "server"))
  2677. def sni_contexts(self):
  2678. server_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2679. server_context.load_cert_chain(SIGNED_CERTFILE)
  2680. other_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2681. other_context.load_cert_chain(SIGNED_CERTFILE2)
  2682. client_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  2683. client_context.verify_mode = ssl.CERT_REQUIRED
  2684. client_context.load_verify_locations(SIGNING_CA)
  2685. return server_context, other_context, client_context
  2686. def check_common_name(self, stats, name):
  2687. cert = stats['peercert']
  2688. self.assertIn((('commonName', name),), cert['subject'])
  2689. @needs_sni
  2690. def test_sni_callback(self):
  2691. calls = []
  2692. server_context, other_context, client_context = self.sni_contexts()
  2693. def servername_cb(ssl_sock, server_name, initial_context):
  2694. calls.append((server_name, initial_context))
  2695. if server_name is not None:
  2696. ssl_sock.context = other_context
  2697. server_context.set_servername_callback(servername_cb)
  2698. stats = server_params_test(client_context, server_context,
  2699. chatty=True,
  2700. sni_name='supermessage')
  2701. # The hostname was fetched properly, and the certificate was
  2702. # changed for the connection.
  2703. self.assertEqual(calls, [("supermessage", server_context)])
  2704. # CERTFILE4 was selected
  2705. self.check_common_name(stats, 'fakehostname')
  2706. calls = []
  2707. # The callback is called with server_name=None
  2708. stats = server_params_test(client_context, server_context,
  2709. chatty=True,
  2710. sni_name=None)
  2711. self.assertEqual(calls, [(None, server_context)])
  2712. self.check_common_name(stats, 'localhost')
  2713. # Check disabling the callback
  2714. calls = []
  2715. server_context.set_servername_callback(None)
  2716. stats = server_params_test(client_context, server_context,
  2717. chatty=True,
  2718. sni_name='notfunny')
  2719. # Certificate didn't change
  2720. self.check_common_name(stats, 'localhost')
  2721. self.assertEqual(calls, [])
  2722. @needs_sni
  2723. def test_sni_callback_alert(self):
  2724. # Returning a TLS alert is reflected to the connecting client
  2725. server_context, other_context, client_context = self.sni_contexts()
  2726. def cb_returning_alert(ssl_sock, server_name, initial_context):
  2727. return ssl.ALERT_DESCRIPTION_ACCESS_DENIED
  2728. server_context.set_servername_callback(cb_returning_alert)
  2729. with self.assertRaises(ssl.SSLError) as cm:
  2730. stats = server_params_test(client_context, server_context,
  2731. chatty=False,
  2732. sni_name='supermessage')
  2733. self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_ACCESS_DENIED')
  2734. @needs_sni
  2735. def test_sni_callback_raising(self):
  2736. # Raising fails the connection with a TLS handshake failure alert.
  2737. server_context, other_context, client_context = self.sni_contexts()
  2738. def cb_raising(ssl_sock, server_name, initial_context):
  2739. 1.0/0.0
  2740. server_context.set_servername_callback(cb_raising)
  2741. with self.assertRaises(ssl.SSLError) as cm, \
  2742. support.captured_stderr() as stderr:
  2743. stats = server_params_test(client_context, server_context,
  2744. chatty=False,
  2745. sni_name='supermessage')
  2746. self.assertEqual(cm.exception.reason, 'SSLV3_ALERT_HANDSHAKE_FAILURE')
  2747. self.assertIn("ZeroDivisionError", stderr.getvalue())
  2748. @needs_sni
  2749. def test_sni_callback_wrong_return_type(self):
  2750. # Returning the wrong return type terminates the TLS connection
  2751. # with an internal error alert.
  2752. server_context, other_context, client_context = self.sni_contexts()
  2753. def cb_wrong_return_type(ssl_sock, server_name, initial_context):
  2754. return "foo"
  2755. server_context.set_servername_callback(cb_wrong_return_type)
  2756. with self.assertRaises(ssl.SSLError) as cm, \
  2757. support.captured_stderr() as stderr:
  2758. stats = server_params_test(client_context, server_context,
  2759. chatty=False,
  2760. sni_name='supermessage')
  2761. self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_INTERNAL_ERROR')
  2762. self.assertIn("TypeError", stderr.getvalue())
  2763. def test_read_write_after_close_raises_valuerror(self):
  2764. context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
  2765. context.verify_mode = ssl.CERT_REQUIRED
  2766. context.load_verify_locations(CERTFILE)
  2767. context.load_cert_chain(CERTFILE)
  2768. server = ThreadedEchoServer(context=context, chatty=False)
  2769. with server:
  2770. s = context.wrap_socket(socket.socket())
  2771. s.connect((HOST, server.port))
  2772. s.close()
  2773. self.assertRaises(ValueError, s.read, 1024)
  2774. self.assertRaises(ValueError, s.write, b'hello')
  2775. def test_main(verbose=False):
  2776. if support.verbose:
  2777. plats = {
  2778. 'Linux': platform.linux_distribution,
  2779. 'Mac': platform.mac_ver,
  2780. 'Windows': platform.win32_ver,
  2781. }
  2782. for name, func in plats.items():
  2783. plat = func()
  2784. if plat and plat[0]:
  2785. plat = '%s %r' % (name, plat)
  2786. break
  2787. else:
  2788. plat = repr(platform.platform())
  2789. print("test_ssl: testing with %r %r" %
  2790. (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
  2791. print(" under %s" % plat)
  2792. print(" HAS_SNI = %r" % ssl.HAS_SNI)
  2793. print(" OP_ALL = 0x%8x" % ssl.OP_ALL)
  2794. try:
  2795. print(" OP_NO_TLSv1_1 = 0x%8x" % ssl.OP_NO_TLSv1_1)
  2796. except AttributeError:
  2797. pass
  2798. for filename in [
  2799. CERTFILE, REMOTE_ROOT_CERT, BYTES_CERTFILE,
  2800. ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
  2801. SIGNED_CERTFILE, SIGNED_CERTFILE2, SIGNING_CA,
  2802. BADCERT, BADKEY, EMPTYCERT]:
  2803. if not os.path.exists(filename):
  2804. raise support.TestFailed("Can't read certificate file %r" % filename)
  2805. tests = [ContextTests, BasicTests, BasicSocketTests, SSLErrorTests]
  2806. if support.is_resource_enabled('network'):
  2807. tests.append(NetworkedTests)
  2808. if _have_threads:
  2809. thread_info = support.threading_setup()
  2810. if thread_info:
  2811. tests.append(ThreadedTests)
  2812. try:
  2813. support.run_unittest(*tests)
  2814. finally:
  2815. if _have_threads:
  2816. support.threading_cleanup(*thread_info)
  2817. if __name__ == "__main__":
  2818. test_main()