test_ssl.py 211 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074
  1. # Test the support for SSL and sockets
  2. import sys
  3. import unittest
  4. import unittest.mock
  5. from test import support
  6. from test.support import import_helper
  7. from test.support import os_helper
  8. from test.support import socket_helper
  9. from test.support import threading_helper
  10. from test.support import warnings_helper
  11. import socket
  12. import select
  13. import time
  14. import enum
  15. import gc
  16. import os
  17. import errno
  18. import pprint
  19. import urllib.request
  20. import threading
  21. import traceback
  22. import weakref
  23. import platform
  24. import sysconfig
  25. import functools
  26. try:
  27. import ctypes
  28. except ImportError:
  29. ctypes = None
  30. asyncore = warnings_helper.import_deprecated('asyncore')
  31. ssl = import_helper.import_module("ssl")
  32. import _ssl
  33. from ssl import TLSVersion, _TLSContentType, _TLSMessageType, _TLSAlertType
  34. Py_DEBUG = hasattr(sys, 'gettotalrefcount')
  35. Py_DEBUG_WIN32 = Py_DEBUG and sys.platform == 'win32'
  36. PROTOCOLS = sorted(ssl._PROTOCOL_NAMES)
  37. HOST = socket_helper.HOST
  38. IS_OPENSSL_3_0_0 = ssl.OPENSSL_VERSION_INFO >= (3, 0, 0)
  39. PY_SSL_DEFAULT_CIPHERS = sysconfig.get_config_var('PY_SSL_DEFAULT_CIPHERS')
  40. PROTOCOL_TO_TLS_VERSION = {}
  41. for proto, ver in (
  42. ("PROTOCOL_SSLv23", "SSLv3"),
  43. ("PROTOCOL_TLSv1", "TLSv1"),
  44. ("PROTOCOL_TLSv1_1", "TLSv1_1"),
  45. ):
  46. try:
  47. proto = getattr(ssl, proto)
  48. ver = getattr(ssl.TLSVersion, ver)
  49. except AttributeError:
  50. continue
  51. PROTOCOL_TO_TLS_VERSION[proto] = ver
  52. def data_file(*name):
  53. return os.path.join(os.path.dirname(__file__), *name)
  54. # The custom key and certificate files used in test_ssl are generated
  55. # using Lib/test/make_ssl_certs.py.
  56. # Other certificates are simply fetched from the internet servers they
  57. # are meant to authenticate.
  58. CERTFILE = data_file("keycert.pem")
  59. BYTES_CERTFILE = os.fsencode(CERTFILE)
  60. ONLYCERT = data_file("ssl_cert.pem")
  61. ONLYKEY = data_file("ssl_key.pem")
  62. BYTES_ONLYCERT = os.fsencode(ONLYCERT)
  63. BYTES_ONLYKEY = os.fsencode(ONLYKEY)
  64. CERTFILE_PROTECTED = data_file("keycert.passwd.pem")
  65. ONLYKEY_PROTECTED = data_file("ssl_key.passwd.pem")
  66. KEY_PASSWORD = "somepass"
  67. CAPATH = data_file("capath")
  68. BYTES_CAPATH = os.fsencode(CAPATH)
  69. CAFILE_NEURONIO = data_file("capath", "4e1295a3.0")
  70. CAFILE_CACERT = data_file("capath", "5ed36f99.0")
  71. CERTFILE_INFO = {
  72. 'issuer': ((('countryName', 'XY'),),
  73. (('localityName', 'Castle Anthrax'),),
  74. (('organizationName', 'Python Software Foundation'),),
  75. (('commonName', 'localhost'),)),
  76. 'notAfter': 'Aug 26 14:23:15 2028 GMT',
  77. 'notBefore': 'Aug 29 14:23:15 2018 GMT',
  78. 'serialNumber': '98A7CF88C74A32ED',
  79. 'subject': ((('countryName', 'XY'),),
  80. (('localityName', 'Castle Anthrax'),),
  81. (('organizationName', 'Python Software Foundation'),),
  82. (('commonName', 'localhost'),)),
  83. 'subjectAltName': (('DNS', 'localhost'),),
  84. 'version': 3
  85. }
  86. # empty CRL
  87. CRLFILE = data_file("revocation.crl")
  88. # Two keys and certs signed by the same CA (for SNI tests)
  89. SIGNED_CERTFILE = data_file("keycert3.pem")
  90. SIGNED_CERTFILE_HOSTNAME = 'localhost'
  91. SIGNED_CERTFILE_INFO = {
  92. 'OCSP': ('http://testca.pythontest.net/testca/ocsp/',),
  93. 'caIssuers': ('http://testca.pythontest.net/testca/pycacert.cer',),
  94. 'crlDistributionPoints': ('http://testca.pythontest.net/testca/revocation.crl',),
  95. 'issuer': ((('countryName', 'XY'),),
  96. (('organizationName', 'Python Software Foundation CA'),),
  97. (('commonName', 'our-ca-server'),)),
  98. 'notAfter': 'Oct 28 14:23:16 2037 GMT',
  99. 'notBefore': 'Aug 29 14:23:16 2018 GMT',
  100. 'serialNumber': 'CB2D80995A69525C',
  101. 'subject': ((('countryName', 'XY'),),
  102. (('localityName', 'Castle Anthrax'),),
  103. (('organizationName', 'Python Software Foundation'),),
  104. (('commonName', 'localhost'),)),
  105. 'subjectAltName': (('DNS', 'localhost'),),
  106. 'version': 3
  107. }
  108. SIGNED_CERTFILE2 = data_file("keycert4.pem")
  109. SIGNED_CERTFILE2_HOSTNAME = 'fakehostname'
  110. SIGNED_CERTFILE_ECC = data_file("keycertecc.pem")
  111. SIGNED_CERTFILE_ECC_HOSTNAME = 'localhost-ecc'
  112. # Same certificate as pycacert.pem, but without extra text in file
  113. SIGNING_CA = data_file("capath", "ceff1710.0")
  114. # cert with all kinds of subject alt names
  115. ALLSANFILE = data_file("allsans.pem")
  116. IDNSANSFILE = data_file("idnsans.pem")
  117. NOSANFILE = data_file("nosan.pem")
  118. NOSAN_HOSTNAME = 'localhost'
  119. REMOTE_HOST = "self-signed.pythontest.net"
  120. EMPTYCERT = data_file("nullcert.pem")
  121. BADCERT = data_file("badcert.pem")
  122. NONEXISTINGCERT = data_file("XXXnonexisting.pem")
  123. BADKEY = data_file("badkey.pem")
  124. NOKIACERT = data_file("nokia.pem")
  125. NULLBYTECERT = data_file("nullbytecert.pem")
  126. TALOS_INVALID_CRLDP = data_file("talos-2019-0758.pem")
  127. DHFILE = data_file("ffdh3072.pem")
  128. BYTES_DHFILE = os.fsencode(DHFILE)
  129. # Not defined in all versions of OpenSSL
  130. OP_NO_COMPRESSION = getattr(ssl, "OP_NO_COMPRESSION", 0)
  131. OP_SINGLE_DH_USE = getattr(ssl, "OP_SINGLE_DH_USE", 0)
  132. OP_SINGLE_ECDH_USE = getattr(ssl, "OP_SINGLE_ECDH_USE", 0)
  133. OP_CIPHER_SERVER_PREFERENCE = getattr(ssl, "OP_CIPHER_SERVER_PREFERENCE", 0)
  134. OP_ENABLE_MIDDLEBOX_COMPAT = getattr(ssl, "OP_ENABLE_MIDDLEBOX_COMPAT", 0)
  135. OP_IGNORE_UNEXPECTED_EOF = getattr(ssl, "OP_IGNORE_UNEXPECTED_EOF", 0)
  136. # Ubuntu has patched OpenSSL and changed behavior of security level 2
  137. # see https://bugs.python.org/issue41561#msg389003
  138. def is_ubuntu():
  139. try:
  140. # Assume that any references of "ubuntu" implies Ubuntu-like distro
  141. # The workaround is not required for 18.04, but doesn't hurt either.
  142. with open("/etc/os-release", encoding="utf-8") as f:
  143. return "ubuntu" in f.read()
  144. except FileNotFoundError:
  145. return False
  146. if is_ubuntu():
  147. def seclevel_workaround(*ctxs):
  148. """"Lower security level to '1' and allow all ciphers for TLS 1.0/1"""
  149. for ctx in ctxs:
  150. if (
  151. hasattr(ctx, "minimum_version") and
  152. ctx.minimum_version <= ssl.TLSVersion.TLSv1_1
  153. ):
  154. ctx.set_ciphers("@SECLEVEL=1:ALL")
  155. else:
  156. def seclevel_workaround(*ctxs):
  157. pass
  158. def has_tls_protocol(protocol):
  159. """Check if a TLS protocol is available and enabled
  160. :param protocol: enum ssl._SSLMethod member or name
  161. :return: bool
  162. """
  163. if isinstance(protocol, str):
  164. assert protocol.startswith('PROTOCOL_')
  165. protocol = getattr(ssl, protocol, None)
  166. if protocol is None:
  167. return False
  168. if protocol in {
  169. ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLS_SERVER,
  170. ssl.PROTOCOL_TLS_CLIENT
  171. }:
  172. # auto-negotiate protocols are always available
  173. return True
  174. name = protocol.name
  175. return has_tls_version(name[len('PROTOCOL_'):])
  176. @functools.lru_cache
  177. def has_tls_version(version):
  178. """Check if a TLS/SSL version is enabled
  179. :param version: TLS version name or ssl.TLSVersion member
  180. :return: bool
  181. """
  182. if version == "SSLv2":
  183. # never supported and not even in TLSVersion enum
  184. return False
  185. if isinstance(version, str):
  186. version = ssl.TLSVersion.__members__[version]
  187. # check compile time flags like ssl.HAS_TLSv1_2
  188. if not getattr(ssl, f'HAS_{version.name}'):
  189. return False
  190. if IS_OPENSSL_3_0_0 and version < ssl.TLSVersion.TLSv1_2:
  191. # bpo43791: 3.0.0-alpha14 fails with TLSV1_ALERT_INTERNAL_ERROR
  192. return False
  193. # check runtime and dynamic crypto policy settings. A TLS version may
  194. # be compiled in but disabled by a policy or config option.
  195. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  196. if (
  197. hasattr(ctx, 'minimum_version') and
  198. ctx.minimum_version != ssl.TLSVersion.MINIMUM_SUPPORTED and
  199. version < ctx.minimum_version
  200. ):
  201. return False
  202. if (
  203. hasattr(ctx, 'maximum_version') and
  204. ctx.maximum_version != ssl.TLSVersion.MAXIMUM_SUPPORTED and
  205. version > ctx.maximum_version
  206. ):
  207. return False
  208. return True
  209. def requires_tls_version(version):
  210. """Decorator to skip tests when a required TLS version is not available
  211. :param version: TLS version name or ssl.TLSVersion member
  212. :return:
  213. """
  214. def decorator(func):
  215. @functools.wraps(func)
  216. def wrapper(*args, **kw):
  217. if not has_tls_version(version):
  218. raise unittest.SkipTest(f"{version} is not available.")
  219. else:
  220. return func(*args, **kw)
  221. return wrapper
  222. return decorator
  223. def handle_error(prefix):
  224. exc_format = ' '.join(traceback.format_exception(*sys.exc_info()))
  225. if support.verbose:
  226. sys.stdout.write(prefix + exc_format)
  227. def utc_offset(): #NOTE: ignore issues like #1647654
  228. # local time = utc time + utc offset
  229. if time.daylight and time.localtime().tm_isdst > 0:
  230. return -time.altzone # seconds
  231. return -time.timezone
  232. ignore_deprecation = warnings_helper.ignore_warnings(
  233. category=DeprecationWarning
  234. )
  235. def test_wrap_socket(sock, *,
  236. cert_reqs=ssl.CERT_NONE, ca_certs=None,
  237. ciphers=None, certfile=None, keyfile=None,
  238. **kwargs):
  239. if not kwargs.get("server_side"):
  240. kwargs["server_hostname"] = SIGNED_CERTFILE_HOSTNAME
  241. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  242. else:
  243. context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  244. if cert_reqs is not None:
  245. if cert_reqs == ssl.CERT_NONE:
  246. context.check_hostname = False
  247. context.verify_mode = cert_reqs
  248. if ca_certs is not None:
  249. context.load_verify_locations(ca_certs)
  250. if certfile is not None or keyfile is not None:
  251. context.load_cert_chain(certfile, keyfile)
  252. if ciphers is not None:
  253. context.set_ciphers(ciphers)
  254. return context.wrap_socket(sock, **kwargs)
  255. def testing_context(server_cert=SIGNED_CERTFILE, *, server_chain=True):
  256. """Create context
  257. client_context, server_context, hostname = testing_context()
  258. """
  259. if server_cert == SIGNED_CERTFILE:
  260. hostname = SIGNED_CERTFILE_HOSTNAME
  261. elif server_cert == SIGNED_CERTFILE2:
  262. hostname = SIGNED_CERTFILE2_HOSTNAME
  263. elif server_cert == NOSANFILE:
  264. hostname = NOSAN_HOSTNAME
  265. else:
  266. raise ValueError(server_cert)
  267. client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  268. client_context.load_verify_locations(SIGNING_CA)
  269. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  270. server_context.load_cert_chain(server_cert)
  271. if server_chain:
  272. server_context.load_verify_locations(SIGNING_CA)
  273. return client_context, server_context, hostname
  274. class BasicSocketTests(unittest.TestCase):
  275. def test_constants(self):
  276. ssl.CERT_NONE
  277. ssl.CERT_OPTIONAL
  278. ssl.CERT_REQUIRED
  279. ssl.OP_CIPHER_SERVER_PREFERENCE
  280. ssl.OP_SINGLE_DH_USE
  281. ssl.OP_SINGLE_ECDH_USE
  282. ssl.OP_NO_COMPRESSION
  283. self.assertEqual(ssl.HAS_SNI, True)
  284. self.assertEqual(ssl.HAS_ECDH, True)
  285. self.assertEqual(ssl.HAS_TLSv1_2, True)
  286. self.assertEqual(ssl.HAS_TLSv1_3, True)
  287. ssl.OP_NO_SSLv2
  288. ssl.OP_NO_SSLv3
  289. ssl.OP_NO_TLSv1
  290. ssl.OP_NO_TLSv1_3
  291. ssl.OP_NO_TLSv1_1
  292. ssl.OP_NO_TLSv1_2
  293. self.assertEqual(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv23)
  294. def test_ssl_types(self):
  295. ssl_types = [
  296. _ssl._SSLContext,
  297. _ssl._SSLSocket,
  298. _ssl.MemoryBIO,
  299. _ssl.Certificate,
  300. _ssl.SSLSession,
  301. _ssl.SSLError,
  302. ]
  303. for ssl_type in ssl_types:
  304. with self.subTest(ssl_type=ssl_type):
  305. with self.assertRaisesRegex(TypeError, "immutable type"):
  306. ssl_type.value = None
  307. support.check_disallow_instantiation(self, _ssl.Certificate)
  308. def test_private_init(self):
  309. with self.assertRaisesRegex(TypeError, "public constructor"):
  310. with socket.socket() as s:
  311. ssl.SSLSocket(s)
  312. def test_str_for_enums(self):
  313. # Make sure that the PROTOCOL_* constants have enum-like string
  314. # reprs.
  315. proto = ssl.PROTOCOL_TLS_CLIENT
  316. self.assertEqual(repr(proto), '<_SSLMethod.PROTOCOL_TLS_CLIENT: %r>' % proto.value)
  317. self.assertEqual(str(proto), str(proto.value))
  318. ctx = ssl.SSLContext(proto)
  319. self.assertIs(ctx.protocol, proto)
  320. def test_random(self):
  321. v = ssl.RAND_status()
  322. if support.verbose:
  323. sys.stdout.write("\n RAND_status is %d (%s)\n"
  324. % (v, (v and "sufficient randomness") or
  325. "insufficient randomness"))
  326. with warnings_helper.check_warnings():
  327. data, is_cryptographic = ssl.RAND_pseudo_bytes(16)
  328. self.assertEqual(len(data), 16)
  329. self.assertEqual(is_cryptographic, v == 1)
  330. if v:
  331. data = ssl.RAND_bytes(16)
  332. self.assertEqual(len(data), 16)
  333. else:
  334. self.assertRaises(ssl.SSLError, ssl.RAND_bytes, 16)
  335. # negative num is invalid
  336. self.assertRaises(ValueError, ssl.RAND_bytes, -5)
  337. with warnings_helper.check_warnings():
  338. self.assertRaises(ValueError, ssl.RAND_pseudo_bytes, -5)
  339. ssl.RAND_add("this is a random string", 75.0)
  340. ssl.RAND_add(b"this is a random bytes object", 75.0)
  341. ssl.RAND_add(bytearray(b"this is a random bytearray object"), 75.0)
  342. def test_parse_cert(self):
  343. # note that this uses an 'unofficial' function in _ssl.c,
  344. # provided solely for this test, to exercise the certificate
  345. # parsing code
  346. self.assertEqual(
  347. ssl._ssl._test_decode_cert(CERTFILE),
  348. CERTFILE_INFO
  349. )
  350. self.assertEqual(
  351. ssl._ssl._test_decode_cert(SIGNED_CERTFILE),
  352. SIGNED_CERTFILE_INFO
  353. )
  354. # Issue #13034: the subjectAltName in some certificates
  355. # (notably projects.developer.nokia.com:443) wasn't parsed
  356. p = ssl._ssl._test_decode_cert(NOKIACERT)
  357. if support.verbose:
  358. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  359. self.assertEqual(p['subjectAltName'],
  360. (('DNS', 'projects.developer.nokia.com'),
  361. ('DNS', 'projects.forum.nokia.com'))
  362. )
  363. # extra OCSP and AIA fields
  364. self.assertEqual(p['OCSP'], ('http://ocsp.verisign.com',))
  365. self.assertEqual(p['caIssuers'],
  366. ('http://SVRIntl-G3-aia.verisign.com/SVRIntlG3.cer',))
  367. self.assertEqual(p['crlDistributionPoints'],
  368. ('http://SVRIntl-G3-crl.verisign.com/SVRIntlG3.crl',))
  369. def test_parse_cert_CVE_2019_5010(self):
  370. p = ssl._ssl._test_decode_cert(TALOS_INVALID_CRLDP)
  371. if support.verbose:
  372. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  373. self.assertEqual(
  374. p,
  375. {
  376. 'issuer': (
  377. (('countryName', 'UK'),), (('commonName', 'cody-ca'),)),
  378. 'notAfter': 'Jun 14 18:00:58 2028 GMT',
  379. 'notBefore': 'Jun 18 18:00:58 2018 GMT',
  380. 'serialNumber': '02',
  381. 'subject': ((('countryName', 'UK'),),
  382. (('commonName',
  383. 'codenomicon-vm-2.test.lal.cisco.com'),)),
  384. 'subjectAltName': (
  385. ('DNS', 'codenomicon-vm-2.test.lal.cisco.com'),),
  386. 'version': 3
  387. }
  388. )
  389. def test_parse_cert_CVE_2013_4238(self):
  390. p = ssl._ssl._test_decode_cert(NULLBYTECERT)
  391. if support.verbose:
  392. sys.stdout.write("\n" + pprint.pformat(p) + "\n")
  393. subject = ((('countryName', 'US'),),
  394. (('stateOrProvinceName', 'Oregon'),),
  395. (('localityName', 'Beaverton'),),
  396. (('organizationName', 'Python Software Foundation'),),
  397. (('organizationalUnitName', 'Python Core Development'),),
  398. (('commonName', 'null.python.org\x00example.org'),),
  399. (('emailAddress', 'python-dev@python.org'),))
  400. self.assertEqual(p['subject'], subject)
  401. self.assertEqual(p['issuer'], subject)
  402. if ssl._OPENSSL_API_VERSION >= (0, 9, 8):
  403. san = (('DNS', 'altnull.python.org\x00example.com'),
  404. ('email', 'null@python.org\x00user@example.org'),
  405. ('URI', 'http://null.python.org\x00http://example.org'),
  406. ('IP Address', '192.0.2.1'),
  407. ('IP Address', '2001:DB8:0:0:0:0:0:1'))
  408. else:
  409. # OpenSSL 0.9.7 doesn't support IPv6 addresses in subjectAltName
  410. san = (('DNS', 'altnull.python.org\x00example.com'),
  411. ('email', 'null@python.org\x00user@example.org'),
  412. ('URI', 'http://null.python.org\x00http://example.org'),
  413. ('IP Address', '192.0.2.1'),
  414. ('IP Address', '<invalid>'))
  415. self.assertEqual(p['subjectAltName'], san)
  416. def test_parse_all_sans(self):
  417. p = ssl._ssl._test_decode_cert(ALLSANFILE)
  418. self.assertEqual(p['subjectAltName'],
  419. (
  420. ('DNS', 'allsans'),
  421. ('othername', '<unsupported>'),
  422. ('othername', '<unsupported>'),
  423. ('email', 'user@example.org'),
  424. ('DNS', 'www.example.org'),
  425. ('DirName',
  426. ((('countryName', 'XY'),),
  427. (('localityName', 'Castle Anthrax'),),
  428. (('organizationName', 'Python Software Foundation'),),
  429. (('commonName', 'dirname example'),))),
  430. ('URI', 'https://www.python.org/'),
  431. ('IP Address', '127.0.0.1'),
  432. ('IP Address', '0:0:0:0:0:0:0:1'),
  433. ('Registered ID', '1.2.3.4.5')
  434. )
  435. )
  436. def test_DER_to_PEM(self):
  437. with open(CAFILE_CACERT, 'r') as f:
  438. pem = f.read()
  439. d1 = ssl.PEM_cert_to_DER_cert(pem)
  440. p2 = ssl.DER_cert_to_PEM_cert(d1)
  441. d2 = ssl.PEM_cert_to_DER_cert(p2)
  442. self.assertEqual(d1, d2)
  443. if not p2.startswith(ssl.PEM_HEADER + '\n'):
  444. self.fail("DER-to-PEM didn't include correct header:\n%r\n" % p2)
  445. if not p2.endswith('\n' + ssl.PEM_FOOTER + '\n'):
  446. self.fail("DER-to-PEM didn't include correct footer:\n%r\n" % p2)
  447. def test_openssl_version(self):
  448. n = ssl.OPENSSL_VERSION_NUMBER
  449. t = ssl.OPENSSL_VERSION_INFO
  450. s = ssl.OPENSSL_VERSION
  451. self.assertIsInstance(n, int)
  452. self.assertIsInstance(t, tuple)
  453. self.assertIsInstance(s, str)
  454. # Some sanity checks follow
  455. # >= 1.1.1
  456. self.assertGreaterEqual(n, 0x10101000)
  457. # < 4.0
  458. self.assertLess(n, 0x40000000)
  459. major, minor, fix, patch, status = t
  460. self.assertGreaterEqual(major, 1)
  461. self.assertLess(major, 4)
  462. self.assertGreaterEqual(minor, 0)
  463. self.assertLess(minor, 256)
  464. self.assertGreaterEqual(fix, 0)
  465. self.assertLess(fix, 256)
  466. self.assertGreaterEqual(patch, 0)
  467. self.assertLessEqual(patch, 63)
  468. self.assertGreaterEqual(status, 0)
  469. self.assertLessEqual(status, 15)
  470. libressl_ver = f"LibreSSL {major:d}"
  471. if major >= 3:
  472. # 3.x uses 0xMNN00PP0L
  473. openssl_ver = f"OpenSSL {major:d}.{minor:d}.{patch:d}"
  474. else:
  475. openssl_ver = f"OpenSSL {major:d}.{minor:d}.{fix:d}"
  476. self.assertTrue(
  477. s.startswith((openssl_ver, libressl_ver)),
  478. (s, t, hex(n))
  479. )
  480. @support.cpython_only
  481. def test_refcycle(self):
  482. # Issue #7943: an SSL object doesn't create reference cycles with
  483. # itself.
  484. s = socket.socket(socket.AF_INET)
  485. ss = test_wrap_socket(s)
  486. wr = weakref.ref(ss)
  487. with warnings_helper.check_warnings(("", ResourceWarning)):
  488. del ss
  489. self.assertEqual(wr(), None)
  490. def test_wrapped_unconnected(self):
  491. # Methods on an unconnected SSLSocket propagate the original
  492. # OSError raise by the underlying socket object.
  493. s = socket.socket(socket.AF_INET)
  494. with test_wrap_socket(s) as ss:
  495. self.assertRaises(OSError, ss.recv, 1)
  496. self.assertRaises(OSError, ss.recv_into, bytearray(b'x'))
  497. self.assertRaises(OSError, ss.recvfrom, 1)
  498. self.assertRaises(OSError, ss.recvfrom_into, bytearray(b'x'), 1)
  499. self.assertRaises(OSError, ss.send, b'x')
  500. self.assertRaises(OSError, ss.sendto, b'x', ('0.0.0.0', 0))
  501. self.assertRaises(NotImplementedError, ss.dup)
  502. self.assertRaises(NotImplementedError, ss.sendmsg,
  503. [b'x'], (), 0, ('0.0.0.0', 0))
  504. self.assertRaises(NotImplementedError, ss.recvmsg, 100)
  505. self.assertRaises(NotImplementedError, ss.recvmsg_into,
  506. [bytearray(100)])
  507. def test_timeout(self):
  508. # Issue #8524: when creating an SSL socket, the timeout of the
  509. # original socket should be retained.
  510. for timeout in (None, 0.0, 5.0):
  511. s = socket.socket(socket.AF_INET)
  512. s.settimeout(timeout)
  513. with test_wrap_socket(s) as ss:
  514. self.assertEqual(timeout, ss.gettimeout())
  515. def test_openssl111_deprecations(self):
  516. options = [
  517. ssl.OP_NO_TLSv1,
  518. ssl.OP_NO_TLSv1_1,
  519. ssl.OP_NO_TLSv1_2,
  520. ssl.OP_NO_TLSv1_3
  521. ]
  522. protocols = [
  523. ssl.PROTOCOL_TLSv1,
  524. ssl.PROTOCOL_TLSv1_1,
  525. ssl.PROTOCOL_TLSv1_2,
  526. ssl.PROTOCOL_TLS
  527. ]
  528. versions = [
  529. ssl.TLSVersion.SSLv3,
  530. ssl.TLSVersion.TLSv1,
  531. ssl.TLSVersion.TLSv1_1,
  532. ]
  533. for option in options:
  534. with self.subTest(option=option):
  535. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  536. with self.assertWarns(DeprecationWarning) as cm:
  537. ctx.options |= option
  538. self.assertEqual(
  539. 'ssl.OP_NO_SSL*/ssl.OP_NO_TLS* options are deprecated',
  540. str(cm.warning)
  541. )
  542. for protocol in protocols:
  543. if not has_tls_protocol(protocol):
  544. continue
  545. with self.subTest(protocol=protocol):
  546. with self.assertWarns(DeprecationWarning) as cm:
  547. ssl.SSLContext(protocol)
  548. self.assertEqual(
  549. f'ssl.{protocol.name} is deprecated',
  550. str(cm.warning)
  551. )
  552. for version in versions:
  553. if not has_tls_version(version):
  554. continue
  555. with self.subTest(version=version):
  556. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  557. with self.assertWarns(DeprecationWarning) as cm:
  558. ctx.minimum_version = version
  559. version_text = '%s.%s' % (version.__class__.__name__, version.name)
  560. self.assertEqual(
  561. f'ssl.{version_text} is deprecated',
  562. str(cm.warning)
  563. )
  564. @ignore_deprecation
  565. def test_errors_sslwrap(self):
  566. sock = socket.socket()
  567. self.assertRaisesRegex(ValueError,
  568. "certfile must be specified",
  569. ssl.wrap_socket, sock, keyfile=CERTFILE)
  570. self.assertRaisesRegex(ValueError,
  571. "certfile must be specified for server-side operations",
  572. ssl.wrap_socket, sock, server_side=True)
  573. self.assertRaisesRegex(ValueError,
  574. "certfile must be specified for server-side operations",
  575. ssl.wrap_socket, sock, server_side=True, certfile="")
  576. with ssl.wrap_socket(sock, server_side=True, certfile=CERTFILE) as s:
  577. self.assertRaisesRegex(ValueError, "can't connect in server-side mode",
  578. s.connect, (HOST, 8080))
  579. with self.assertRaises(OSError) as cm:
  580. with socket.socket() as sock:
  581. ssl.wrap_socket(sock, certfile=NONEXISTINGCERT)
  582. self.assertEqual(cm.exception.errno, errno.ENOENT)
  583. with self.assertRaises(OSError) as cm:
  584. with socket.socket() as sock:
  585. ssl.wrap_socket(sock,
  586. certfile=CERTFILE, keyfile=NONEXISTINGCERT)
  587. self.assertEqual(cm.exception.errno, errno.ENOENT)
  588. with self.assertRaises(OSError) as cm:
  589. with socket.socket() as sock:
  590. ssl.wrap_socket(sock,
  591. certfile=NONEXISTINGCERT, keyfile=NONEXISTINGCERT)
  592. self.assertEqual(cm.exception.errno, errno.ENOENT)
  593. def bad_cert_test(self, certfile):
  594. """Check that trying to use the given client certificate fails"""
  595. certfile = os.path.join(os.path.dirname(__file__) or os.curdir,
  596. certfile)
  597. sock = socket.socket()
  598. self.addCleanup(sock.close)
  599. with self.assertRaises(ssl.SSLError):
  600. test_wrap_socket(sock,
  601. certfile=certfile)
  602. def test_empty_cert(self):
  603. """Wrapping with an empty cert file"""
  604. self.bad_cert_test("nullcert.pem")
  605. def test_malformed_cert(self):
  606. """Wrapping with a badly formatted certificate (syntax error)"""
  607. self.bad_cert_test("badcert.pem")
  608. def test_malformed_key(self):
  609. """Wrapping with a badly formatted key (syntax error)"""
  610. self.bad_cert_test("badkey.pem")
  611. @ignore_deprecation
  612. def test_match_hostname(self):
  613. def ok(cert, hostname):
  614. ssl.match_hostname(cert, hostname)
  615. def fail(cert, hostname):
  616. self.assertRaises(ssl.CertificateError,
  617. ssl.match_hostname, cert, hostname)
  618. # -- Hostname matching --
  619. cert = {'subject': ((('commonName', 'example.com'),),)}
  620. ok(cert, 'example.com')
  621. ok(cert, 'ExAmple.cOm')
  622. fail(cert, 'www.example.com')
  623. fail(cert, '.example.com')
  624. fail(cert, 'example.org')
  625. fail(cert, 'exampleXcom')
  626. cert = {'subject': ((('commonName', '*.a.com'),),)}
  627. ok(cert, 'foo.a.com')
  628. fail(cert, 'bar.foo.a.com')
  629. fail(cert, 'a.com')
  630. fail(cert, 'Xa.com')
  631. fail(cert, '.a.com')
  632. # only match wildcards when they are the only thing
  633. # in left-most segment
  634. cert = {'subject': ((('commonName', 'f*.com'),),)}
  635. fail(cert, 'foo.com')
  636. fail(cert, 'f.com')
  637. fail(cert, 'bar.com')
  638. fail(cert, 'foo.a.com')
  639. fail(cert, 'bar.foo.com')
  640. # NULL bytes are bad, CVE-2013-4073
  641. cert = {'subject': ((('commonName',
  642. 'null.python.org\x00example.org'),),)}
  643. ok(cert, 'null.python.org\x00example.org') # or raise an error?
  644. fail(cert, 'example.org')
  645. fail(cert, 'null.python.org')
  646. # error cases with wildcards
  647. cert = {'subject': ((('commonName', '*.*.a.com'),),)}
  648. fail(cert, 'bar.foo.a.com')
  649. fail(cert, 'a.com')
  650. fail(cert, 'Xa.com')
  651. fail(cert, '.a.com')
  652. cert = {'subject': ((('commonName', 'a.*.com'),),)}
  653. fail(cert, 'a.foo.com')
  654. fail(cert, 'a..com')
  655. fail(cert, 'a.com')
  656. # wildcard doesn't match IDNA prefix 'xn--'
  657. idna = 'püthon.python.org'.encode("idna").decode("ascii")
  658. cert = {'subject': ((('commonName', idna),),)}
  659. ok(cert, idna)
  660. cert = {'subject': ((('commonName', 'x*.python.org'),),)}
  661. fail(cert, idna)
  662. cert = {'subject': ((('commonName', 'xn--p*.python.org'),),)}
  663. fail(cert, idna)
  664. # wildcard in first fragment and IDNA A-labels in sequent fragments
  665. # are supported.
  666. idna = 'www*.pythön.org'.encode("idna").decode("ascii")
  667. cert = {'subject': ((('commonName', idna),),)}
  668. fail(cert, 'www.pythön.org'.encode("idna").decode("ascii"))
  669. fail(cert, 'www1.pythön.org'.encode("idna").decode("ascii"))
  670. fail(cert, 'ftp.pythön.org'.encode("idna").decode("ascii"))
  671. fail(cert, 'pythön.org'.encode("idna").decode("ascii"))
  672. # Slightly fake real-world example
  673. cert = {'notAfter': 'Jun 26 21:41:46 2011 GMT',
  674. 'subject': ((('commonName', 'linuxfrz.org'),),),
  675. 'subjectAltName': (('DNS', 'linuxfr.org'),
  676. ('DNS', 'linuxfr.com'),
  677. ('othername', '<unsupported>'))}
  678. ok(cert, 'linuxfr.org')
  679. ok(cert, 'linuxfr.com')
  680. # Not a "DNS" entry
  681. fail(cert, '<unsupported>')
  682. # When there is a subjectAltName, commonName isn't used
  683. fail(cert, 'linuxfrz.org')
  684. # A pristine real-world example
  685. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  686. 'subject': ((('countryName', 'US'),),
  687. (('stateOrProvinceName', 'California'),),
  688. (('localityName', 'Mountain View'),),
  689. (('organizationName', 'Google Inc'),),
  690. (('commonName', 'mail.google.com'),))}
  691. ok(cert, 'mail.google.com')
  692. fail(cert, 'gmail.com')
  693. # Only commonName is considered
  694. fail(cert, 'California')
  695. # -- IPv4 matching --
  696. cert = {'subject': ((('commonName', 'example.com'),),),
  697. 'subjectAltName': (('DNS', 'example.com'),
  698. ('IP Address', '10.11.12.13'),
  699. ('IP Address', '14.15.16.17'),
  700. ('IP Address', '127.0.0.1'))}
  701. ok(cert, '10.11.12.13')
  702. ok(cert, '14.15.16.17')
  703. # socket.inet_ntoa(socket.inet_aton('127.1')) == '127.0.0.1'
  704. fail(cert, '127.1')
  705. fail(cert, '14.15.16.17 ')
  706. fail(cert, '14.15.16.17 extra data')
  707. fail(cert, '14.15.16.18')
  708. fail(cert, 'example.net')
  709. # -- IPv6 matching --
  710. if socket_helper.IPV6_ENABLED:
  711. cert = {'subject': ((('commonName', 'example.com'),),),
  712. 'subjectAltName': (
  713. ('DNS', 'example.com'),
  714. ('IP Address', '2001:0:0:0:0:0:0:CAFE\n'),
  715. ('IP Address', '2003:0:0:0:0:0:0:BABA\n'))}
  716. ok(cert, '2001::cafe')
  717. ok(cert, '2003::baba')
  718. fail(cert, '2003::baba ')
  719. fail(cert, '2003::baba extra data')
  720. fail(cert, '2003::bebe')
  721. fail(cert, 'example.net')
  722. # -- Miscellaneous --
  723. # Neither commonName nor subjectAltName
  724. cert = {'notAfter': 'Dec 18 23:59:59 2011 GMT',
  725. 'subject': ((('countryName', 'US'),),
  726. (('stateOrProvinceName', 'California'),),
  727. (('localityName', 'Mountain View'),),
  728. (('organizationName', 'Google Inc'),))}
  729. fail(cert, 'mail.google.com')
  730. # No DNS entry in subjectAltName but a commonName
  731. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  732. 'subject': ((('countryName', 'US'),),
  733. (('stateOrProvinceName', 'California'),),
  734. (('localityName', 'Mountain View'),),
  735. (('commonName', 'mail.google.com'),)),
  736. 'subjectAltName': (('othername', 'blabla'), )}
  737. ok(cert, 'mail.google.com')
  738. # No DNS entry subjectAltName and no commonName
  739. cert = {'notAfter': 'Dec 18 23:59:59 2099 GMT',
  740. 'subject': ((('countryName', 'US'),),
  741. (('stateOrProvinceName', 'California'),),
  742. (('localityName', 'Mountain View'),),
  743. (('organizationName', 'Google Inc'),)),
  744. 'subjectAltName': (('othername', 'blabla'),)}
  745. fail(cert, 'google.com')
  746. # Empty cert / no cert
  747. self.assertRaises(ValueError, ssl.match_hostname, None, 'example.com')
  748. self.assertRaises(ValueError, ssl.match_hostname, {}, 'example.com')
  749. # Issue #17980: avoid denials of service by refusing more than one
  750. # wildcard per fragment.
  751. cert = {'subject': ((('commonName', 'a*b.example.com'),),)}
  752. with self.assertRaisesRegex(
  753. ssl.CertificateError,
  754. "partial wildcards in leftmost label are not supported"):
  755. ssl.match_hostname(cert, 'axxb.example.com')
  756. cert = {'subject': ((('commonName', 'www.*.example.com'),),)}
  757. with self.assertRaisesRegex(
  758. ssl.CertificateError,
  759. "wildcard can only be present in the leftmost label"):
  760. ssl.match_hostname(cert, 'www.sub.example.com')
  761. cert = {'subject': ((('commonName', 'a*b*.example.com'),),)}
  762. with self.assertRaisesRegex(
  763. ssl.CertificateError,
  764. "too many wildcards"):
  765. ssl.match_hostname(cert, 'axxbxxc.example.com')
  766. cert = {'subject': ((('commonName', '*'),),)}
  767. with self.assertRaisesRegex(
  768. ssl.CertificateError,
  769. "sole wildcard without additional labels are not support"):
  770. ssl.match_hostname(cert, 'host')
  771. cert = {'subject': ((('commonName', '*.com'),),)}
  772. with self.assertRaisesRegex(
  773. ssl.CertificateError,
  774. r"hostname 'com' doesn't match '\*.com'"):
  775. ssl.match_hostname(cert, 'com')
  776. # extra checks for _inet_paton()
  777. for invalid in ['1', '', '1.2.3', '256.0.0.1', '127.0.0.1/24']:
  778. with self.assertRaises(ValueError):
  779. ssl._inet_paton(invalid)
  780. for ipaddr in ['127.0.0.1', '192.168.0.1']:
  781. self.assertTrue(ssl._inet_paton(ipaddr))
  782. if socket_helper.IPV6_ENABLED:
  783. for ipaddr in ['::1', '2001:db8:85a3::8a2e:370:7334']:
  784. self.assertTrue(ssl._inet_paton(ipaddr))
  785. def test_server_side(self):
  786. # server_hostname doesn't work for server sockets
  787. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  788. with socket.socket() as sock:
  789. self.assertRaises(ValueError, ctx.wrap_socket, sock, True,
  790. server_hostname="some.hostname")
  791. def test_unknown_channel_binding(self):
  792. # should raise ValueError for unknown type
  793. s = socket.create_server(('127.0.0.1', 0))
  794. c = socket.socket(socket.AF_INET)
  795. c.connect(s.getsockname())
  796. with test_wrap_socket(c, do_handshake_on_connect=False) as ss:
  797. with self.assertRaises(ValueError):
  798. ss.get_channel_binding("unknown-type")
  799. s.close()
  800. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  801. "'tls-unique' channel binding not available")
  802. def test_tls_unique_channel_binding(self):
  803. # unconnected should return None for known type
  804. s = socket.socket(socket.AF_INET)
  805. with test_wrap_socket(s) as ss:
  806. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  807. # the same for server-side
  808. s = socket.socket(socket.AF_INET)
  809. with test_wrap_socket(s, server_side=True, certfile=CERTFILE) as ss:
  810. self.assertIsNone(ss.get_channel_binding("tls-unique"))
  811. def test_dealloc_warn(self):
  812. ss = test_wrap_socket(socket.socket(socket.AF_INET))
  813. r = repr(ss)
  814. with self.assertWarns(ResourceWarning) as cm:
  815. ss = None
  816. support.gc_collect()
  817. self.assertIn(r, str(cm.warning.args[0]))
  818. def test_get_default_verify_paths(self):
  819. paths = ssl.get_default_verify_paths()
  820. self.assertEqual(len(paths), 6)
  821. self.assertIsInstance(paths, ssl.DefaultVerifyPaths)
  822. with os_helper.EnvironmentVarGuard() as env:
  823. env["SSL_CERT_DIR"] = CAPATH
  824. env["SSL_CERT_FILE"] = CERTFILE
  825. paths = ssl.get_default_verify_paths()
  826. self.assertEqual(paths.cafile, CERTFILE)
  827. self.assertEqual(paths.capath, CAPATH)
  828. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  829. def test_enum_certificates(self):
  830. self.assertTrue(ssl.enum_certificates("CA"))
  831. self.assertTrue(ssl.enum_certificates("ROOT"))
  832. self.assertRaises(TypeError, ssl.enum_certificates)
  833. self.assertRaises(WindowsError, ssl.enum_certificates, "")
  834. trust_oids = set()
  835. for storename in ("CA", "ROOT"):
  836. store = ssl.enum_certificates(storename)
  837. self.assertIsInstance(store, list)
  838. for element in store:
  839. self.assertIsInstance(element, tuple)
  840. self.assertEqual(len(element), 3)
  841. cert, enc, trust = element
  842. self.assertIsInstance(cert, bytes)
  843. self.assertIn(enc, {"x509_asn", "pkcs_7_asn"})
  844. self.assertIsInstance(trust, (frozenset, set, bool))
  845. if isinstance(trust, (frozenset, set)):
  846. trust_oids.update(trust)
  847. serverAuth = "1.3.6.1.5.5.7.3.1"
  848. self.assertIn(serverAuth, trust_oids)
  849. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  850. def test_enum_crls(self):
  851. self.assertTrue(ssl.enum_crls("CA"))
  852. self.assertRaises(TypeError, ssl.enum_crls)
  853. self.assertRaises(WindowsError, ssl.enum_crls, "")
  854. crls = ssl.enum_crls("CA")
  855. self.assertIsInstance(crls, list)
  856. for element in crls:
  857. self.assertIsInstance(element, tuple)
  858. self.assertEqual(len(element), 2)
  859. self.assertIsInstance(element[0], bytes)
  860. self.assertIn(element[1], {"x509_asn", "pkcs_7_asn"})
  861. def test_asn1object(self):
  862. expected = (129, 'serverAuth', 'TLS Web Server Authentication',
  863. '1.3.6.1.5.5.7.3.1')
  864. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
  865. self.assertEqual(val, expected)
  866. self.assertEqual(val.nid, 129)
  867. self.assertEqual(val.shortname, 'serverAuth')
  868. self.assertEqual(val.longname, 'TLS Web Server Authentication')
  869. self.assertEqual(val.oid, '1.3.6.1.5.5.7.3.1')
  870. self.assertIsInstance(val, ssl._ASN1Object)
  871. self.assertRaises(ValueError, ssl._ASN1Object, 'serverAuth')
  872. val = ssl._ASN1Object.fromnid(129)
  873. self.assertEqual(val, expected)
  874. self.assertIsInstance(val, ssl._ASN1Object)
  875. self.assertRaises(ValueError, ssl._ASN1Object.fromnid, -1)
  876. with self.assertRaisesRegex(ValueError, "unknown NID 100000"):
  877. ssl._ASN1Object.fromnid(100000)
  878. for i in range(1000):
  879. try:
  880. obj = ssl._ASN1Object.fromnid(i)
  881. except ValueError:
  882. pass
  883. else:
  884. self.assertIsInstance(obj.nid, int)
  885. self.assertIsInstance(obj.shortname, str)
  886. self.assertIsInstance(obj.longname, str)
  887. self.assertIsInstance(obj.oid, (str, type(None)))
  888. val = ssl._ASN1Object.fromname('TLS Web Server Authentication')
  889. self.assertEqual(val, expected)
  890. self.assertIsInstance(val, ssl._ASN1Object)
  891. self.assertEqual(ssl._ASN1Object.fromname('serverAuth'), expected)
  892. self.assertEqual(ssl._ASN1Object.fromname('1.3.6.1.5.5.7.3.1'),
  893. expected)
  894. with self.assertRaisesRegex(ValueError, "unknown object 'serverauth'"):
  895. ssl._ASN1Object.fromname('serverauth')
  896. def test_purpose_enum(self):
  897. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.1')
  898. self.assertIsInstance(ssl.Purpose.SERVER_AUTH, ssl._ASN1Object)
  899. self.assertEqual(ssl.Purpose.SERVER_AUTH, val)
  900. self.assertEqual(ssl.Purpose.SERVER_AUTH.nid, 129)
  901. self.assertEqual(ssl.Purpose.SERVER_AUTH.shortname, 'serverAuth')
  902. self.assertEqual(ssl.Purpose.SERVER_AUTH.oid,
  903. '1.3.6.1.5.5.7.3.1')
  904. val = ssl._ASN1Object('1.3.6.1.5.5.7.3.2')
  905. self.assertIsInstance(ssl.Purpose.CLIENT_AUTH, ssl._ASN1Object)
  906. self.assertEqual(ssl.Purpose.CLIENT_AUTH, val)
  907. self.assertEqual(ssl.Purpose.CLIENT_AUTH.nid, 130)
  908. self.assertEqual(ssl.Purpose.CLIENT_AUTH.shortname, 'clientAuth')
  909. self.assertEqual(ssl.Purpose.CLIENT_AUTH.oid,
  910. '1.3.6.1.5.5.7.3.2')
  911. def test_unsupported_dtls(self):
  912. s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  913. self.addCleanup(s.close)
  914. with self.assertRaises(NotImplementedError) as cx:
  915. test_wrap_socket(s, cert_reqs=ssl.CERT_NONE)
  916. self.assertEqual(str(cx.exception), "only stream sockets are supported")
  917. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  918. with self.assertRaises(NotImplementedError) as cx:
  919. ctx.wrap_socket(s)
  920. self.assertEqual(str(cx.exception), "only stream sockets are supported")
  921. def cert_time_ok(self, timestring, timestamp):
  922. self.assertEqual(ssl.cert_time_to_seconds(timestring), timestamp)
  923. def cert_time_fail(self, timestring):
  924. with self.assertRaises(ValueError):
  925. ssl.cert_time_to_seconds(timestring)
  926. @unittest.skipUnless(utc_offset(),
  927. 'local time needs to be different from UTC')
  928. def test_cert_time_to_seconds_timezone(self):
  929. # Issue #19940: ssl.cert_time_to_seconds() returns wrong
  930. # results if local timezone is not UTC
  931. self.cert_time_ok("May 9 00:00:00 2007 GMT", 1178668800.0)
  932. self.cert_time_ok("Jan 5 09:34:43 2018 GMT", 1515144883.0)
  933. def test_cert_time_to_seconds(self):
  934. timestring = "Jan 5 09:34:43 2018 GMT"
  935. ts = 1515144883.0
  936. self.cert_time_ok(timestring, ts)
  937. # accept keyword parameter, assert its name
  938. self.assertEqual(ssl.cert_time_to_seconds(cert_time=timestring), ts)
  939. # accept both %e and %d (space or zero generated by strftime)
  940. self.cert_time_ok("Jan 05 09:34:43 2018 GMT", ts)
  941. # case-insensitive
  942. self.cert_time_ok("JaN 5 09:34:43 2018 GmT", ts)
  943. self.cert_time_fail("Jan 5 09:34 2018 GMT") # no seconds
  944. self.cert_time_fail("Jan 5 09:34:43 2018") # no GMT
  945. self.cert_time_fail("Jan 5 09:34:43 2018 UTC") # not GMT timezone
  946. self.cert_time_fail("Jan 35 09:34:43 2018 GMT") # invalid day
  947. self.cert_time_fail("Jon 5 09:34:43 2018 GMT") # invalid month
  948. self.cert_time_fail("Jan 5 24:00:00 2018 GMT") # invalid hour
  949. self.cert_time_fail("Jan 5 09:60:43 2018 GMT") # invalid minute
  950. newyear_ts = 1230768000.0
  951. # leap seconds
  952. self.cert_time_ok("Dec 31 23:59:60 2008 GMT", newyear_ts)
  953. # same timestamp
  954. self.cert_time_ok("Jan 1 00:00:00 2009 GMT", newyear_ts)
  955. self.cert_time_ok("Jan 5 09:34:59 2018 GMT", 1515144899)
  956. # allow 60th second (even if it is not a leap second)
  957. self.cert_time_ok("Jan 5 09:34:60 2018 GMT", 1515144900)
  958. # allow 2nd leap second for compatibility with time.strptime()
  959. self.cert_time_ok("Jan 5 09:34:61 2018 GMT", 1515144901)
  960. self.cert_time_fail("Jan 5 09:34:62 2018 GMT") # invalid seconds
  961. # no special treatment for the special value:
  962. # 99991231235959Z (rfc 5280)
  963. self.cert_time_ok("Dec 31 23:59:59 9999 GMT", 253402300799.0)
  964. @support.run_with_locale('LC_ALL', '')
  965. def test_cert_time_to_seconds_locale(self):
  966. # `cert_time_to_seconds()` should be locale independent
  967. def local_february_name():
  968. return time.strftime('%b', (1, 2, 3, 4, 5, 6, 0, 0, 0))
  969. if local_february_name().lower() == 'feb':
  970. self.skipTest("locale-specific month name needs to be "
  971. "different from C locale")
  972. # locale-independent
  973. self.cert_time_ok("Feb 9 00:00:00 2007 GMT", 1170979200.0)
  974. self.cert_time_fail(local_february_name() + " 9 00:00:00 2007 GMT")
  975. def test_connect_ex_error(self):
  976. server = socket.socket(socket.AF_INET)
  977. self.addCleanup(server.close)
  978. port = socket_helper.bind_port(server) # Reserve port but don't listen
  979. s = test_wrap_socket(socket.socket(socket.AF_INET),
  980. cert_reqs=ssl.CERT_REQUIRED)
  981. self.addCleanup(s.close)
  982. rc = s.connect_ex((HOST, port))
  983. # Issue #19919: Windows machines or VMs hosted on Windows
  984. # machines sometimes return EWOULDBLOCK.
  985. errors = (
  986. errno.ECONNREFUSED, errno.EHOSTUNREACH, errno.ETIMEDOUT,
  987. errno.EWOULDBLOCK,
  988. )
  989. self.assertIn(rc, errors)
  990. def test_read_write_zero(self):
  991. # empty reads and writes now work, bpo-42854, bpo-31711
  992. client_context, server_context, hostname = testing_context()
  993. server = ThreadedEchoServer(context=server_context)
  994. with server:
  995. with client_context.wrap_socket(socket.socket(),
  996. server_hostname=hostname) as s:
  997. s.connect((HOST, server.port))
  998. self.assertEqual(s.recv(0), b"")
  999. self.assertEqual(s.send(b""), 0)
  1000. class ContextTests(unittest.TestCase):
  1001. def test_constructor(self):
  1002. for protocol in PROTOCOLS:
  1003. if has_tls_protocol(protocol):
  1004. with warnings_helper.check_warnings():
  1005. ctx = ssl.SSLContext(protocol)
  1006. self.assertEqual(ctx.protocol, protocol)
  1007. with warnings_helper.check_warnings():
  1008. ctx = ssl.SSLContext()
  1009. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS)
  1010. self.assertRaises(ValueError, ssl.SSLContext, -1)
  1011. self.assertRaises(ValueError, ssl.SSLContext, 42)
  1012. def test_ciphers(self):
  1013. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1014. ctx.set_ciphers("ALL")
  1015. ctx.set_ciphers("DEFAULT")
  1016. with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
  1017. ctx.set_ciphers("^$:,;?*'dorothyx")
  1018. @unittest.skipUnless(PY_SSL_DEFAULT_CIPHERS == 1,
  1019. "Test applies only to Python default ciphers")
  1020. def test_python_ciphers(self):
  1021. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1022. ciphers = ctx.get_ciphers()
  1023. for suite in ciphers:
  1024. name = suite['name']
  1025. self.assertNotIn("PSK", name)
  1026. self.assertNotIn("SRP", name)
  1027. self.assertNotIn("MD5", name)
  1028. self.assertNotIn("RC4", name)
  1029. self.assertNotIn("3DES", name)
  1030. def test_get_ciphers(self):
  1031. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1032. ctx.set_ciphers('AESGCM')
  1033. names = set(d['name'] for d in ctx.get_ciphers())
  1034. expected = {
  1035. 'AES128-GCM-SHA256',
  1036. 'ECDHE-ECDSA-AES128-GCM-SHA256',
  1037. 'ECDHE-RSA-AES128-GCM-SHA256',
  1038. 'DHE-RSA-AES128-GCM-SHA256',
  1039. 'AES256-GCM-SHA384',
  1040. 'ECDHE-ECDSA-AES256-GCM-SHA384',
  1041. 'ECDHE-RSA-AES256-GCM-SHA384',
  1042. 'DHE-RSA-AES256-GCM-SHA384',
  1043. }
  1044. intersection = names.intersection(expected)
  1045. self.assertGreaterEqual(
  1046. len(intersection), 2, f"\ngot: {sorted(names)}\nexpected: {sorted(expected)}"
  1047. )
  1048. def test_options(self):
  1049. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1050. # OP_ALL | OP_NO_SSLv2 | OP_NO_SSLv3 is the default value
  1051. default = (ssl.OP_ALL | ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
  1052. # SSLContext also enables these by default
  1053. default |= (OP_NO_COMPRESSION | OP_CIPHER_SERVER_PREFERENCE |
  1054. OP_SINGLE_DH_USE | OP_SINGLE_ECDH_USE |
  1055. OP_ENABLE_MIDDLEBOX_COMPAT |
  1056. OP_IGNORE_UNEXPECTED_EOF)
  1057. self.assertEqual(default, ctx.options)
  1058. with warnings_helper.check_warnings():
  1059. ctx.options |= ssl.OP_NO_TLSv1
  1060. self.assertEqual(default | ssl.OP_NO_TLSv1, ctx.options)
  1061. with warnings_helper.check_warnings():
  1062. ctx.options = (ctx.options & ~ssl.OP_NO_TLSv1)
  1063. self.assertEqual(default, ctx.options)
  1064. ctx.options = 0
  1065. # Ubuntu has OP_NO_SSLv3 forced on by default
  1066. self.assertEqual(0, ctx.options & ~ssl.OP_NO_SSLv3)
  1067. def test_verify_mode_protocol(self):
  1068. with warnings_helper.check_warnings():
  1069. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS)
  1070. # Default value
  1071. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1072. ctx.verify_mode = ssl.CERT_OPTIONAL
  1073. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  1074. ctx.verify_mode = ssl.CERT_REQUIRED
  1075. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1076. ctx.verify_mode = ssl.CERT_NONE
  1077. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1078. with self.assertRaises(TypeError):
  1079. ctx.verify_mode = None
  1080. with self.assertRaises(ValueError):
  1081. ctx.verify_mode = 42
  1082. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1083. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1084. self.assertFalse(ctx.check_hostname)
  1085. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1086. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1087. self.assertTrue(ctx.check_hostname)
  1088. def test_hostname_checks_common_name(self):
  1089. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1090. self.assertTrue(ctx.hostname_checks_common_name)
  1091. if ssl.HAS_NEVER_CHECK_COMMON_NAME:
  1092. ctx.hostname_checks_common_name = True
  1093. self.assertTrue(ctx.hostname_checks_common_name)
  1094. ctx.hostname_checks_common_name = False
  1095. self.assertFalse(ctx.hostname_checks_common_name)
  1096. ctx.hostname_checks_common_name = True
  1097. self.assertTrue(ctx.hostname_checks_common_name)
  1098. else:
  1099. with self.assertRaises(AttributeError):
  1100. ctx.hostname_checks_common_name = True
  1101. @ignore_deprecation
  1102. def test_min_max_version(self):
  1103. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1104. # OpenSSL default is MINIMUM_SUPPORTED, however some vendors like
  1105. # Fedora override the setting to TLS 1.0.
  1106. minimum_range = {
  1107. # stock OpenSSL
  1108. ssl.TLSVersion.MINIMUM_SUPPORTED,
  1109. # Fedora 29 uses TLS 1.0 by default
  1110. ssl.TLSVersion.TLSv1,
  1111. # RHEL 8 uses TLS 1.2 by default
  1112. ssl.TLSVersion.TLSv1_2
  1113. }
  1114. maximum_range = {
  1115. # stock OpenSSL
  1116. ssl.TLSVersion.MAXIMUM_SUPPORTED,
  1117. # Fedora 32 uses TLS 1.3 by default
  1118. ssl.TLSVersion.TLSv1_3
  1119. }
  1120. self.assertIn(
  1121. ctx.minimum_version, minimum_range
  1122. )
  1123. self.assertIn(
  1124. ctx.maximum_version, maximum_range
  1125. )
  1126. ctx.minimum_version = ssl.TLSVersion.TLSv1_1
  1127. ctx.maximum_version = ssl.TLSVersion.TLSv1_2
  1128. self.assertEqual(
  1129. ctx.minimum_version, ssl.TLSVersion.TLSv1_1
  1130. )
  1131. self.assertEqual(
  1132. ctx.maximum_version, ssl.TLSVersion.TLSv1_2
  1133. )
  1134. ctx.minimum_version = ssl.TLSVersion.MINIMUM_SUPPORTED
  1135. ctx.maximum_version = ssl.TLSVersion.TLSv1
  1136. self.assertEqual(
  1137. ctx.minimum_version, ssl.TLSVersion.MINIMUM_SUPPORTED
  1138. )
  1139. self.assertEqual(
  1140. ctx.maximum_version, ssl.TLSVersion.TLSv1
  1141. )
  1142. ctx.maximum_version = ssl.TLSVersion.MAXIMUM_SUPPORTED
  1143. self.assertEqual(
  1144. ctx.maximum_version, ssl.TLSVersion.MAXIMUM_SUPPORTED
  1145. )
  1146. ctx.maximum_version = ssl.TLSVersion.MINIMUM_SUPPORTED
  1147. self.assertIn(
  1148. ctx.maximum_version,
  1149. {ssl.TLSVersion.TLSv1, ssl.TLSVersion.TLSv1_1, ssl.TLSVersion.SSLv3}
  1150. )
  1151. ctx.minimum_version = ssl.TLSVersion.MAXIMUM_SUPPORTED
  1152. self.assertIn(
  1153. ctx.minimum_version,
  1154. {ssl.TLSVersion.TLSv1_2, ssl.TLSVersion.TLSv1_3}
  1155. )
  1156. with self.assertRaises(ValueError):
  1157. ctx.minimum_version = 42
  1158. if has_tls_protocol(ssl.PROTOCOL_TLSv1_1):
  1159. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1_1)
  1160. self.assertIn(
  1161. ctx.minimum_version, minimum_range
  1162. )
  1163. self.assertEqual(
  1164. ctx.maximum_version, ssl.TLSVersion.MAXIMUM_SUPPORTED
  1165. )
  1166. with self.assertRaises(ValueError):
  1167. ctx.minimum_version = ssl.TLSVersion.MINIMUM_SUPPORTED
  1168. with self.assertRaises(ValueError):
  1169. ctx.maximum_version = ssl.TLSVersion.TLSv1
  1170. @unittest.skipUnless(
  1171. hasattr(ssl.SSLContext, 'security_level'),
  1172. "requires OpenSSL >= 1.1.0"
  1173. )
  1174. def test_security_level(self):
  1175. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1176. # The default security callback allows for levels between 0-5
  1177. # with OpenSSL defaulting to 1, however some vendors override the
  1178. # default value (e.g. Debian defaults to 2)
  1179. security_level_range = {
  1180. 0,
  1181. 1, # OpenSSL default
  1182. 2, # Debian
  1183. 3,
  1184. 4,
  1185. 5,
  1186. }
  1187. self.assertIn(ctx.security_level, security_level_range)
  1188. def test_verify_flags(self):
  1189. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1190. # default value
  1191. tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
  1192. self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT | tf)
  1193. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF
  1194. self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_LEAF)
  1195. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_CHAIN
  1196. self.assertEqual(ctx.verify_flags, ssl.VERIFY_CRL_CHECK_CHAIN)
  1197. ctx.verify_flags = ssl.VERIFY_DEFAULT
  1198. self.assertEqual(ctx.verify_flags, ssl.VERIFY_DEFAULT)
  1199. ctx.verify_flags = ssl.VERIFY_ALLOW_PROXY_CERTS
  1200. self.assertEqual(ctx.verify_flags, ssl.VERIFY_ALLOW_PROXY_CERTS)
  1201. # supports any value
  1202. ctx.verify_flags = ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT
  1203. self.assertEqual(ctx.verify_flags,
  1204. ssl.VERIFY_CRL_CHECK_LEAF | ssl.VERIFY_X509_STRICT)
  1205. with self.assertRaises(TypeError):
  1206. ctx.verify_flags = None
  1207. def test_load_cert_chain(self):
  1208. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1209. # Combined key and cert in a single file
  1210. ctx.load_cert_chain(CERTFILE, keyfile=None)
  1211. ctx.load_cert_chain(CERTFILE, keyfile=CERTFILE)
  1212. self.assertRaises(TypeError, ctx.load_cert_chain, keyfile=CERTFILE)
  1213. with self.assertRaises(OSError) as cm:
  1214. ctx.load_cert_chain(NONEXISTINGCERT)
  1215. self.assertEqual(cm.exception.errno, errno.ENOENT)
  1216. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1217. ctx.load_cert_chain(BADCERT)
  1218. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1219. ctx.load_cert_chain(EMPTYCERT)
  1220. # Separate key and cert
  1221. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1222. ctx.load_cert_chain(ONLYCERT, ONLYKEY)
  1223. ctx.load_cert_chain(certfile=ONLYCERT, keyfile=ONLYKEY)
  1224. ctx.load_cert_chain(certfile=BYTES_ONLYCERT, keyfile=BYTES_ONLYKEY)
  1225. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1226. ctx.load_cert_chain(ONLYCERT)
  1227. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1228. ctx.load_cert_chain(ONLYKEY)
  1229. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1230. ctx.load_cert_chain(certfile=ONLYKEY, keyfile=ONLYCERT)
  1231. # Mismatching key and cert
  1232. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1233. with self.assertRaisesRegex(ssl.SSLError, "key values mismatch"):
  1234. ctx.load_cert_chain(CAFILE_CACERT, ONLYKEY)
  1235. # Password protected key and cert
  1236. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD)
  1237. ctx.load_cert_chain(CERTFILE_PROTECTED, password=KEY_PASSWORD.encode())
  1238. ctx.load_cert_chain(CERTFILE_PROTECTED,
  1239. password=bytearray(KEY_PASSWORD.encode()))
  1240. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD)
  1241. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED, KEY_PASSWORD.encode())
  1242. ctx.load_cert_chain(ONLYCERT, ONLYKEY_PROTECTED,
  1243. bytearray(KEY_PASSWORD.encode()))
  1244. with self.assertRaisesRegex(TypeError, "should be a string"):
  1245. ctx.load_cert_chain(CERTFILE_PROTECTED, password=True)
  1246. with self.assertRaises(ssl.SSLError):
  1247. ctx.load_cert_chain(CERTFILE_PROTECTED, password="badpass")
  1248. with self.assertRaisesRegex(ValueError, "cannot be longer"):
  1249. # openssl has a fixed limit on the password buffer.
  1250. # PEM_BUFSIZE is generally set to 1kb.
  1251. # Return a string larger than this.
  1252. ctx.load_cert_chain(CERTFILE_PROTECTED, password=b'a' * 102400)
  1253. # Password callback
  1254. def getpass_unicode():
  1255. return KEY_PASSWORD
  1256. def getpass_bytes():
  1257. return KEY_PASSWORD.encode()
  1258. def getpass_bytearray():
  1259. return bytearray(KEY_PASSWORD.encode())
  1260. def getpass_badpass():
  1261. return "badpass"
  1262. def getpass_huge():
  1263. return b'a' * (1024 * 1024)
  1264. def getpass_bad_type():
  1265. return 9
  1266. def getpass_exception():
  1267. raise Exception('getpass error')
  1268. class GetPassCallable:
  1269. def __call__(self):
  1270. return KEY_PASSWORD
  1271. def getpass(self):
  1272. return KEY_PASSWORD
  1273. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_unicode)
  1274. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytes)
  1275. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bytearray)
  1276. ctx.load_cert_chain(CERTFILE_PROTECTED, password=GetPassCallable())
  1277. ctx.load_cert_chain(CERTFILE_PROTECTED,
  1278. password=GetPassCallable().getpass)
  1279. with self.assertRaises(ssl.SSLError):
  1280. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_badpass)
  1281. with self.assertRaisesRegex(ValueError, "cannot be longer"):
  1282. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_huge)
  1283. with self.assertRaisesRegex(TypeError, "must return a string"):
  1284. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_bad_type)
  1285. with self.assertRaisesRegex(Exception, "getpass error"):
  1286. ctx.load_cert_chain(CERTFILE_PROTECTED, password=getpass_exception)
  1287. # Make sure the password function isn't called if it isn't needed
  1288. ctx.load_cert_chain(CERTFILE, password=getpass_exception)
  1289. def test_load_verify_locations(self):
  1290. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1291. ctx.load_verify_locations(CERTFILE)
  1292. ctx.load_verify_locations(cafile=CERTFILE, capath=None)
  1293. ctx.load_verify_locations(BYTES_CERTFILE)
  1294. ctx.load_verify_locations(cafile=BYTES_CERTFILE, capath=None)
  1295. self.assertRaises(TypeError, ctx.load_verify_locations)
  1296. self.assertRaises(TypeError, ctx.load_verify_locations, None, None, None)
  1297. with self.assertRaises(OSError) as cm:
  1298. ctx.load_verify_locations(NONEXISTINGCERT)
  1299. self.assertEqual(cm.exception.errno, errno.ENOENT)
  1300. with self.assertRaisesRegex(ssl.SSLError, "PEM lib"):
  1301. ctx.load_verify_locations(BADCERT)
  1302. ctx.load_verify_locations(CERTFILE, CAPATH)
  1303. ctx.load_verify_locations(CERTFILE, capath=BYTES_CAPATH)
  1304. # Issue #10989: crash if the second argument type is invalid
  1305. self.assertRaises(TypeError, ctx.load_verify_locations, None, True)
  1306. def test_load_verify_cadata(self):
  1307. # test cadata
  1308. with open(CAFILE_CACERT) as f:
  1309. cacert_pem = f.read()
  1310. cacert_der = ssl.PEM_cert_to_DER_cert(cacert_pem)
  1311. with open(CAFILE_NEURONIO) as f:
  1312. neuronio_pem = f.read()
  1313. neuronio_der = ssl.PEM_cert_to_DER_cert(neuronio_pem)
  1314. # test PEM
  1315. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1316. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 0)
  1317. ctx.load_verify_locations(cadata=cacert_pem)
  1318. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 1)
  1319. ctx.load_verify_locations(cadata=neuronio_pem)
  1320. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1321. # cert already in hash table
  1322. ctx.load_verify_locations(cadata=neuronio_pem)
  1323. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1324. # combined
  1325. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1326. combined = "\n".join((cacert_pem, neuronio_pem))
  1327. ctx.load_verify_locations(cadata=combined)
  1328. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1329. # with junk around the certs
  1330. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1331. combined = ["head", cacert_pem, "other", neuronio_pem, "again",
  1332. neuronio_pem, "tail"]
  1333. ctx.load_verify_locations(cadata="\n".join(combined))
  1334. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1335. # test DER
  1336. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1337. ctx.load_verify_locations(cadata=cacert_der)
  1338. ctx.load_verify_locations(cadata=neuronio_der)
  1339. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1340. # cert already in hash table
  1341. ctx.load_verify_locations(cadata=cacert_der)
  1342. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1343. # combined
  1344. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1345. combined = b"".join((cacert_der, neuronio_der))
  1346. ctx.load_verify_locations(cadata=combined)
  1347. self.assertEqual(ctx.cert_store_stats()["x509_ca"], 2)
  1348. # error cases
  1349. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1350. self.assertRaises(TypeError, ctx.load_verify_locations, cadata=object)
  1351. with self.assertRaisesRegex(
  1352. ssl.SSLError,
  1353. "no start line: cadata does not contain a certificate"
  1354. ):
  1355. ctx.load_verify_locations(cadata="broken")
  1356. with self.assertRaisesRegex(
  1357. ssl.SSLError,
  1358. "not enough data: cadata does not contain a certificate"
  1359. ):
  1360. ctx.load_verify_locations(cadata=b"broken")
  1361. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  1362. def test_load_dh_params(self):
  1363. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1364. ctx.load_dh_params(DHFILE)
  1365. if os.name != 'nt':
  1366. ctx.load_dh_params(BYTES_DHFILE)
  1367. self.assertRaises(TypeError, ctx.load_dh_params)
  1368. self.assertRaises(TypeError, ctx.load_dh_params, None)
  1369. with self.assertRaises(FileNotFoundError) as cm:
  1370. ctx.load_dh_params(NONEXISTINGCERT)
  1371. self.assertEqual(cm.exception.errno, errno.ENOENT)
  1372. with self.assertRaises(ssl.SSLError) as cm:
  1373. ctx.load_dh_params(CERTFILE)
  1374. def test_session_stats(self):
  1375. for proto in {ssl.PROTOCOL_TLS_CLIENT, ssl.PROTOCOL_TLS_SERVER}:
  1376. ctx = ssl.SSLContext(proto)
  1377. self.assertEqual(ctx.session_stats(), {
  1378. 'number': 0,
  1379. 'connect': 0,
  1380. 'connect_good': 0,
  1381. 'connect_renegotiate': 0,
  1382. 'accept': 0,
  1383. 'accept_good': 0,
  1384. 'accept_renegotiate': 0,
  1385. 'hits': 0,
  1386. 'misses': 0,
  1387. 'timeouts': 0,
  1388. 'cache_full': 0,
  1389. })
  1390. def test_set_default_verify_paths(self):
  1391. # There's not much we can do to test that it acts as expected,
  1392. # so just check it doesn't crash or raise an exception.
  1393. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1394. ctx.set_default_verify_paths()
  1395. @unittest.skipUnless(ssl.HAS_ECDH, "ECDH disabled on this OpenSSL build")
  1396. def test_set_ecdh_curve(self):
  1397. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1398. ctx.set_ecdh_curve("prime256v1")
  1399. ctx.set_ecdh_curve(b"prime256v1")
  1400. self.assertRaises(TypeError, ctx.set_ecdh_curve)
  1401. self.assertRaises(TypeError, ctx.set_ecdh_curve, None)
  1402. self.assertRaises(ValueError, ctx.set_ecdh_curve, "foo")
  1403. self.assertRaises(ValueError, ctx.set_ecdh_curve, b"foo")
  1404. def test_sni_callback(self):
  1405. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1406. # set_servername_callback expects a callable, or None
  1407. self.assertRaises(TypeError, ctx.set_servername_callback)
  1408. self.assertRaises(TypeError, ctx.set_servername_callback, 4)
  1409. self.assertRaises(TypeError, ctx.set_servername_callback, "")
  1410. self.assertRaises(TypeError, ctx.set_servername_callback, ctx)
  1411. def dummycallback(sock, servername, ctx):
  1412. pass
  1413. ctx.set_servername_callback(None)
  1414. ctx.set_servername_callback(dummycallback)
  1415. def test_sni_callback_refcycle(self):
  1416. # Reference cycles through the servername callback are detected
  1417. # and cleared.
  1418. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1419. def dummycallback(sock, servername, ctx, cycle=ctx):
  1420. pass
  1421. ctx.set_servername_callback(dummycallback)
  1422. wr = weakref.ref(ctx)
  1423. del ctx, dummycallback
  1424. gc.collect()
  1425. self.assertIs(wr(), None)
  1426. def test_cert_store_stats(self):
  1427. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1428. self.assertEqual(ctx.cert_store_stats(),
  1429. {'x509_ca': 0, 'crl': 0, 'x509': 0})
  1430. ctx.load_cert_chain(CERTFILE)
  1431. self.assertEqual(ctx.cert_store_stats(),
  1432. {'x509_ca': 0, 'crl': 0, 'x509': 0})
  1433. ctx.load_verify_locations(CERTFILE)
  1434. self.assertEqual(ctx.cert_store_stats(),
  1435. {'x509_ca': 0, 'crl': 0, 'x509': 1})
  1436. ctx.load_verify_locations(CAFILE_CACERT)
  1437. self.assertEqual(ctx.cert_store_stats(),
  1438. {'x509_ca': 1, 'crl': 0, 'x509': 2})
  1439. def test_get_ca_certs(self):
  1440. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1441. self.assertEqual(ctx.get_ca_certs(), [])
  1442. # CERTFILE is not flagged as X509v3 Basic Constraints: CA:TRUE
  1443. ctx.load_verify_locations(CERTFILE)
  1444. self.assertEqual(ctx.get_ca_certs(), [])
  1445. # but CAFILE_CACERT is a CA cert
  1446. ctx.load_verify_locations(CAFILE_CACERT)
  1447. self.assertEqual(ctx.get_ca_certs(),
  1448. [{'issuer': ((('organizationName', 'Root CA'),),
  1449. (('organizationalUnitName', 'http://www.cacert.org'),),
  1450. (('commonName', 'CA Cert Signing Authority'),),
  1451. (('emailAddress', 'support@cacert.org'),)),
  1452. 'notAfter': 'Mar 29 12:29:49 2033 GMT',
  1453. 'notBefore': 'Mar 30 12:29:49 2003 GMT',
  1454. 'serialNumber': '00',
  1455. 'crlDistributionPoints': ('https://www.cacert.org/revoke.crl',),
  1456. 'subject': ((('organizationName', 'Root CA'),),
  1457. (('organizationalUnitName', 'http://www.cacert.org'),),
  1458. (('commonName', 'CA Cert Signing Authority'),),
  1459. (('emailAddress', 'support@cacert.org'),)),
  1460. 'version': 3}])
  1461. with open(CAFILE_CACERT) as f:
  1462. pem = f.read()
  1463. der = ssl.PEM_cert_to_DER_cert(pem)
  1464. self.assertEqual(ctx.get_ca_certs(True), [der])
  1465. def test_load_default_certs(self):
  1466. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1467. ctx.load_default_certs()
  1468. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1469. ctx.load_default_certs(ssl.Purpose.SERVER_AUTH)
  1470. ctx.load_default_certs()
  1471. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1472. ctx.load_default_certs(ssl.Purpose.CLIENT_AUTH)
  1473. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1474. self.assertRaises(TypeError, ctx.load_default_certs, None)
  1475. self.assertRaises(TypeError, ctx.load_default_certs, 'SERVER_AUTH')
  1476. @unittest.skipIf(sys.platform == "win32", "not-Windows specific")
  1477. def test_load_default_certs_env(self):
  1478. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1479. with os_helper.EnvironmentVarGuard() as env:
  1480. env["SSL_CERT_DIR"] = CAPATH
  1481. env["SSL_CERT_FILE"] = CERTFILE
  1482. ctx.load_default_certs()
  1483. self.assertEqual(ctx.cert_store_stats(), {"crl": 0, "x509": 1, "x509_ca": 0})
  1484. @unittest.skipUnless(sys.platform == "win32", "Windows specific")
  1485. @unittest.skipIf(hasattr(sys, "gettotalrefcount"), "Debug build does not share environment between CRTs")
  1486. def test_load_default_certs_env_windows(self):
  1487. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1488. ctx.load_default_certs()
  1489. stats = ctx.cert_store_stats()
  1490. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1491. with os_helper.EnvironmentVarGuard() as env:
  1492. env["SSL_CERT_DIR"] = CAPATH
  1493. env["SSL_CERT_FILE"] = CERTFILE
  1494. ctx.load_default_certs()
  1495. stats["x509"] += 1
  1496. self.assertEqual(ctx.cert_store_stats(), stats)
  1497. def _assert_context_options(self, ctx):
  1498. self.assertEqual(ctx.options & ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv2)
  1499. if OP_NO_COMPRESSION != 0:
  1500. self.assertEqual(ctx.options & OP_NO_COMPRESSION,
  1501. OP_NO_COMPRESSION)
  1502. if OP_SINGLE_DH_USE != 0:
  1503. self.assertEqual(ctx.options & OP_SINGLE_DH_USE,
  1504. OP_SINGLE_DH_USE)
  1505. if OP_SINGLE_ECDH_USE != 0:
  1506. self.assertEqual(ctx.options & OP_SINGLE_ECDH_USE,
  1507. OP_SINGLE_ECDH_USE)
  1508. if OP_CIPHER_SERVER_PREFERENCE != 0:
  1509. self.assertEqual(ctx.options & OP_CIPHER_SERVER_PREFERENCE,
  1510. OP_CIPHER_SERVER_PREFERENCE)
  1511. def test_create_default_context(self):
  1512. ctx = ssl.create_default_context()
  1513. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS_CLIENT)
  1514. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1515. self.assertTrue(ctx.check_hostname)
  1516. self._assert_context_options(ctx)
  1517. with open(SIGNING_CA) as f:
  1518. cadata = f.read()
  1519. ctx = ssl.create_default_context(cafile=SIGNING_CA, capath=CAPATH,
  1520. cadata=cadata)
  1521. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS_CLIENT)
  1522. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1523. self._assert_context_options(ctx)
  1524. ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
  1525. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS_SERVER)
  1526. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1527. self._assert_context_options(ctx)
  1528. def test__create_stdlib_context(self):
  1529. ctx = ssl._create_stdlib_context()
  1530. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS_CLIENT)
  1531. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1532. self.assertFalse(ctx.check_hostname)
  1533. self._assert_context_options(ctx)
  1534. if has_tls_protocol(ssl.PROTOCOL_TLSv1):
  1535. with warnings_helper.check_warnings():
  1536. ctx = ssl._create_stdlib_context(ssl.PROTOCOL_TLSv1)
  1537. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1)
  1538. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1539. self._assert_context_options(ctx)
  1540. with warnings_helper.check_warnings():
  1541. ctx = ssl._create_stdlib_context(
  1542. ssl.PROTOCOL_TLSv1_2,
  1543. cert_reqs=ssl.CERT_REQUIRED,
  1544. check_hostname=True
  1545. )
  1546. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLSv1_2)
  1547. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1548. self.assertTrue(ctx.check_hostname)
  1549. self._assert_context_options(ctx)
  1550. ctx = ssl._create_stdlib_context(purpose=ssl.Purpose.CLIENT_AUTH)
  1551. self.assertEqual(ctx.protocol, ssl.PROTOCOL_TLS_SERVER)
  1552. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1553. self._assert_context_options(ctx)
  1554. def test_check_hostname(self):
  1555. with warnings_helper.check_warnings():
  1556. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS)
  1557. self.assertFalse(ctx.check_hostname)
  1558. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1559. # Auto set CERT_REQUIRED
  1560. ctx.check_hostname = True
  1561. self.assertTrue(ctx.check_hostname)
  1562. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1563. ctx.check_hostname = False
  1564. ctx.verify_mode = ssl.CERT_REQUIRED
  1565. self.assertFalse(ctx.check_hostname)
  1566. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1567. # Changing verify_mode does not affect check_hostname
  1568. ctx.check_hostname = False
  1569. ctx.verify_mode = ssl.CERT_NONE
  1570. ctx.check_hostname = False
  1571. self.assertFalse(ctx.check_hostname)
  1572. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1573. # Auto set
  1574. ctx.check_hostname = True
  1575. self.assertTrue(ctx.check_hostname)
  1576. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1577. ctx.check_hostname = False
  1578. ctx.verify_mode = ssl.CERT_OPTIONAL
  1579. ctx.check_hostname = False
  1580. self.assertFalse(ctx.check_hostname)
  1581. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  1582. # keep CERT_OPTIONAL
  1583. ctx.check_hostname = True
  1584. self.assertTrue(ctx.check_hostname)
  1585. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  1586. # Cannot set CERT_NONE with check_hostname enabled
  1587. with self.assertRaises(ValueError):
  1588. ctx.verify_mode = ssl.CERT_NONE
  1589. ctx.check_hostname = False
  1590. self.assertFalse(ctx.check_hostname)
  1591. ctx.verify_mode = ssl.CERT_NONE
  1592. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1593. def test_context_client_server(self):
  1594. # PROTOCOL_TLS_CLIENT has sane defaults
  1595. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1596. self.assertTrue(ctx.check_hostname)
  1597. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  1598. # PROTOCOL_TLS_SERVER has different but also sane defaults
  1599. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1600. self.assertFalse(ctx.check_hostname)
  1601. self.assertEqual(ctx.verify_mode, ssl.CERT_NONE)
  1602. def test_context_custom_class(self):
  1603. class MySSLSocket(ssl.SSLSocket):
  1604. pass
  1605. class MySSLObject(ssl.SSLObject):
  1606. pass
  1607. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1608. ctx.sslsocket_class = MySSLSocket
  1609. ctx.sslobject_class = MySSLObject
  1610. with ctx.wrap_socket(socket.socket(), server_side=True) as sock:
  1611. self.assertIsInstance(sock, MySSLSocket)
  1612. obj = ctx.wrap_bio(ssl.MemoryBIO(), ssl.MemoryBIO(), server_side=True)
  1613. self.assertIsInstance(obj, MySSLObject)
  1614. def test_num_tickest(self):
  1615. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1616. self.assertEqual(ctx.num_tickets, 2)
  1617. ctx.num_tickets = 1
  1618. self.assertEqual(ctx.num_tickets, 1)
  1619. ctx.num_tickets = 0
  1620. self.assertEqual(ctx.num_tickets, 0)
  1621. with self.assertRaises(ValueError):
  1622. ctx.num_tickets = -1
  1623. with self.assertRaises(TypeError):
  1624. ctx.num_tickets = None
  1625. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1626. self.assertEqual(ctx.num_tickets, 2)
  1627. with self.assertRaises(ValueError):
  1628. ctx.num_tickets = 1
  1629. class SSLErrorTests(unittest.TestCase):
  1630. def test_str(self):
  1631. # The str() of a SSLError doesn't include the errno
  1632. e = ssl.SSLError(1, "foo")
  1633. self.assertEqual(str(e), "foo")
  1634. self.assertEqual(e.errno, 1)
  1635. # Same for a subclass
  1636. e = ssl.SSLZeroReturnError(1, "foo")
  1637. self.assertEqual(str(e), "foo")
  1638. self.assertEqual(e.errno, 1)
  1639. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  1640. def test_lib_reason(self):
  1641. # Test the library and reason attributes
  1642. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1643. with self.assertRaises(ssl.SSLError) as cm:
  1644. ctx.load_dh_params(CERTFILE)
  1645. self.assertEqual(cm.exception.library, 'PEM')
  1646. self.assertEqual(cm.exception.reason, 'NO_START_LINE')
  1647. s = str(cm.exception)
  1648. self.assertTrue(s.startswith("[PEM: NO_START_LINE] no start line"), s)
  1649. def test_subclass(self):
  1650. # Check that the appropriate SSLError subclass is raised
  1651. # (this only tests one of them)
  1652. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1653. ctx.check_hostname = False
  1654. ctx.verify_mode = ssl.CERT_NONE
  1655. with socket.create_server(("127.0.0.1", 0)) as s:
  1656. c = socket.create_connection(s.getsockname())
  1657. c.setblocking(False)
  1658. with ctx.wrap_socket(c, False, do_handshake_on_connect=False) as c:
  1659. with self.assertRaises(ssl.SSLWantReadError) as cm:
  1660. c.do_handshake()
  1661. s = str(cm.exception)
  1662. self.assertTrue(s.startswith("The operation did not complete (read)"), s)
  1663. # For compatibility
  1664. self.assertEqual(cm.exception.errno, ssl.SSL_ERROR_WANT_READ)
  1665. def test_bad_server_hostname(self):
  1666. ctx = ssl.create_default_context()
  1667. with self.assertRaises(ValueError):
  1668. ctx.wrap_bio(ssl.MemoryBIO(), ssl.MemoryBIO(),
  1669. server_hostname="")
  1670. with self.assertRaises(ValueError):
  1671. ctx.wrap_bio(ssl.MemoryBIO(), ssl.MemoryBIO(),
  1672. server_hostname=".example.org")
  1673. with self.assertRaises(TypeError):
  1674. ctx.wrap_bio(ssl.MemoryBIO(), ssl.MemoryBIO(),
  1675. server_hostname="example.org\x00evil.com")
  1676. class MemoryBIOTests(unittest.TestCase):
  1677. def test_read_write(self):
  1678. bio = ssl.MemoryBIO()
  1679. bio.write(b'foo')
  1680. self.assertEqual(bio.read(), b'foo')
  1681. self.assertEqual(bio.read(), b'')
  1682. bio.write(b'foo')
  1683. bio.write(b'bar')
  1684. self.assertEqual(bio.read(), b'foobar')
  1685. self.assertEqual(bio.read(), b'')
  1686. bio.write(b'baz')
  1687. self.assertEqual(bio.read(2), b'ba')
  1688. self.assertEqual(bio.read(1), b'z')
  1689. self.assertEqual(bio.read(1), b'')
  1690. def test_eof(self):
  1691. bio = ssl.MemoryBIO()
  1692. self.assertFalse(bio.eof)
  1693. self.assertEqual(bio.read(), b'')
  1694. self.assertFalse(bio.eof)
  1695. bio.write(b'foo')
  1696. self.assertFalse(bio.eof)
  1697. bio.write_eof()
  1698. self.assertFalse(bio.eof)
  1699. self.assertEqual(bio.read(2), b'fo')
  1700. self.assertFalse(bio.eof)
  1701. self.assertEqual(bio.read(1), b'o')
  1702. self.assertTrue(bio.eof)
  1703. self.assertEqual(bio.read(), b'')
  1704. self.assertTrue(bio.eof)
  1705. def test_pending(self):
  1706. bio = ssl.MemoryBIO()
  1707. self.assertEqual(bio.pending, 0)
  1708. bio.write(b'foo')
  1709. self.assertEqual(bio.pending, 3)
  1710. for i in range(3):
  1711. bio.read(1)
  1712. self.assertEqual(bio.pending, 3-i-1)
  1713. for i in range(3):
  1714. bio.write(b'x')
  1715. self.assertEqual(bio.pending, i+1)
  1716. bio.read()
  1717. self.assertEqual(bio.pending, 0)
  1718. def test_buffer_types(self):
  1719. bio = ssl.MemoryBIO()
  1720. bio.write(b'foo')
  1721. self.assertEqual(bio.read(), b'foo')
  1722. bio.write(bytearray(b'bar'))
  1723. self.assertEqual(bio.read(), b'bar')
  1724. bio.write(memoryview(b'baz'))
  1725. self.assertEqual(bio.read(), b'baz')
  1726. def test_error_types(self):
  1727. bio = ssl.MemoryBIO()
  1728. self.assertRaises(TypeError, bio.write, 'foo')
  1729. self.assertRaises(TypeError, bio.write, None)
  1730. self.assertRaises(TypeError, bio.write, True)
  1731. self.assertRaises(TypeError, bio.write, 1)
  1732. class SSLObjectTests(unittest.TestCase):
  1733. def test_private_init(self):
  1734. bio = ssl.MemoryBIO()
  1735. with self.assertRaisesRegex(TypeError, "public constructor"):
  1736. ssl.SSLObject(bio, bio)
  1737. def test_unwrap(self):
  1738. client_ctx, server_ctx, hostname = testing_context()
  1739. c_in = ssl.MemoryBIO()
  1740. c_out = ssl.MemoryBIO()
  1741. s_in = ssl.MemoryBIO()
  1742. s_out = ssl.MemoryBIO()
  1743. client = client_ctx.wrap_bio(c_in, c_out, server_hostname=hostname)
  1744. server = server_ctx.wrap_bio(s_in, s_out, server_side=True)
  1745. # Loop on the handshake for a bit to get it settled
  1746. for _ in range(5):
  1747. try:
  1748. client.do_handshake()
  1749. except ssl.SSLWantReadError:
  1750. pass
  1751. if c_out.pending:
  1752. s_in.write(c_out.read())
  1753. try:
  1754. server.do_handshake()
  1755. except ssl.SSLWantReadError:
  1756. pass
  1757. if s_out.pending:
  1758. c_in.write(s_out.read())
  1759. # Now the handshakes should be complete (don't raise WantReadError)
  1760. client.do_handshake()
  1761. server.do_handshake()
  1762. # Now if we unwrap one side unilaterally, it should send close-notify
  1763. # and raise WantReadError:
  1764. with self.assertRaises(ssl.SSLWantReadError):
  1765. client.unwrap()
  1766. # But server.unwrap() does not raise, because it reads the client's
  1767. # close-notify:
  1768. s_in.write(c_out.read())
  1769. server.unwrap()
  1770. # And now that the client gets the server's close-notify, it doesn't
  1771. # raise either.
  1772. c_in.write(s_out.read())
  1773. client.unwrap()
  1774. class SimpleBackgroundTests(unittest.TestCase):
  1775. """Tests that connect to a simple server running in the background"""
  1776. def setUp(self):
  1777. self.server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  1778. self.server_context.load_cert_chain(SIGNED_CERTFILE)
  1779. server = ThreadedEchoServer(context=self.server_context)
  1780. self.enterContext(server)
  1781. self.server_addr = (HOST, server.port)
  1782. def test_connect(self):
  1783. with test_wrap_socket(socket.socket(socket.AF_INET),
  1784. cert_reqs=ssl.CERT_NONE) as s:
  1785. s.connect(self.server_addr)
  1786. self.assertEqual({}, s.getpeercert())
  1787. self.assertFalse(s.server_side)
  1788. # this should succeed because we specify the root cert
  1789. with test_wrap_socket(socket.socket(socket.AF_INET),
  1790. cert_reqs=ssl.CERT_REQUIRED,
  1791. ca_certs=SIGNING_CA) as s:
  1792. s.connect(self.server_addr)
  1793. self.assertTrue(s.getpeercert())
  1794. self.assertFalse(s.server_side)
  1795. def test_connect_fail(self):
  1796. # This should fail because we have no verification certs. Connection
  1797. # failure crashes ThreadedEchoServer, so run this in an independent
  1798. # test method.
  1799. s = test_wrap_socket(socket.socket(socket.AF_INET),
  1800. cert_reqs=ssl.CERT_REQUIRED)
  1801. self.addCleanup(s.close)
  1802. self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
  1803. s.connect, self.server_addr)
  1804. def test_connect_ex(self):
  1805. # Issue #11326: check connect_ex() implementation
  1806. s = test_wrap_socket(socket.socket(socket.AF_INET),
  1807. cert_reqs=ssl.CERT_REQUIRED,
  1808. ca_certs=SIGNING_CA)
  1809. self.addCleanup(s.close)
  1810. self.assertEqual(0, s.connect_ex(self.server_addr))
  1811. self.assertTrue(s.getpeercert())
  1812. def test_non_blocking_connect_ex(self):
  1813. # Issue #11326: non-blocking connect_ex() should allow handshake
  1814. # to proceed after the socket gets ready.
  1815. s = test_wrap_socket(socket.socket(socket.AF_INET),
  1816. cert_reqs=ssl.CERT_REQUIRED,
  1817. ca_certs=SIGNING_CA,
  1818. do_handshake_on_connect=False)
  1819. self.addCleanup(s.close)
  1820. s.setblocking(False)
  1821. rc = s.connect_ex(self.server_addr)
  1822. # EWOULDBLOCK under Windows, EINPROGRESS elsewhere
  1823. self.assertIn(rc, (0, errno.EINPROGRESS, errno.EWOULDBLOCK))
  1824. # Wait for connect to finish
  1825. select.select([], [s], [], 5.0)
  1826. # Non-blocking handshake
  1827. while True:
  1828. try:
  1829. s.do_handshake()
  1830. break
  1831. except ssl.SSLWantReadError:
  1832. select.select([s], [], [], 5.0)
  1833. except ssl.SSLWantWriteError:
  1834. select.select([], [s], [], 5.0)
  1835. # SSL established
  1836. self.assertTrue(s.getpeercert())
  1837. def test_connect_with_context(self):
  1838. # Same as test_connect, but with a separately created context
  1839. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1840. ctx.check_hostname = False
  1841. ctx.verify_mode = ssl.CERT_NONE
  1842. with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
  1843. s.connect(self.server_addr)
  1844. self.assertEqual({}, s.getpeercert())
  1845. # Same with a server hostname
  1846. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1847. server_hostname="dummy") as s:
  1848. s.connect(self.server_addr)
  1849. ctx.verify_mode = ssl.CERT_REQUIRED
  1850. # This should succeed because we specify the root cert
  1851. ctx.load_verify_locations(SIGNING_CA)
  1852. with ctx.wrap_socket(socket.socket(socket.AF_INET)) as s:
  1853. s.connect(self.server_addr)
  1854. cert = s.getpeercert()
  1855. self.assertTrue(cert)
  1856. def test_connect_with_context_fail(self):
  1857. # This should fail because we have no verification certs. Connection
  1858. # failure crashes ThreadedEchoServer, so run this in an independent
  1859. # test method.
  1860. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1861. s = ctx.wrap_socket(
  1862. socket.socket(socket.AF_INET),
  1863. server_hostname=SIGNED_CERTFILE_HOSTNAME
  1864. )
  1865. self.addCleanup(s.close)
  1866. self.assertRaisesRegex(ssl.SSLError, "certificate verify failed",
  1867. s.connect, self.server_addr)
  1868. def test_connect_capath(self):
  1869. # Verify server certificates using the `capath` argument
  1870. # NOTE: the subject hashing algorithm has been changed between
  1871. # OpenSSL 0.9.8n and 1.0.0, as a result the capath directory must
  1872. # contain both versions of each certificate (same content, different
  1873. # filename) for this test to be portable across OpenSSL releases.
  1874. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1875. ctx.load_verify_locations(capath=CAPATH)
  1876. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1877. server_hostname=SIGNED_CERTFILE_HOSTNAME) as s:
  1878. s.connect(self.server_addr)
  1879. cert = s.getpeercert()
  1880. self.assertTrue(cert)
  1881. # Same with a bytes `capath` argument
  1882. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1883. ctx.load_verify_locations(capath=BYTES_CAPATH)
  1884. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1885. server_hostname=SIGNED_CERTFILE_HOSTNAME) as s:
  1886. s.connect(self.server_addr)
  1887. cert = s.getpeercert()
  1888. self.assertTrue(cert)
  1889. def test_connect_cadata(self):
  1890. with open(SIGNING_CA) as f:
  1891. pem = f.read()
  1892. der = ssl.PEM_cert_to_DER_cert(pem)
  1893. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1894. ctx.load_verify_locations(cadata=pem)
  1895. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1896. server_hostname=SIGNED_CERTFILE_HOSTNAME) as s:
  1897. s.connect(self.server_addr)
  1898. cert = s.getpeercert()
  1899. self.assertTrue(cert)
  1900. # same with DER
  1901. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1902. ctx.load_verify_locations(cadata=der)
  1903. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1904. server_hostname=SIGNED_CERTFILE_HOSTNAME) as s:
  1905. s.connect(self.server_addr)
  1906. cert = s.getpeercert()
  1907. self.assertTrue(cert)
  1908. @unittest.skipIf(os.name == "nt", "Can't use a socket as a file under Windows")
  1909. def test_makefile_close(self):
  1910. # Issue #5238: creating a file-like object with makefile() shouldn't
  1911. # delay closing the underlying "real socket" (here tested with its
  1912. # file descriptor, hence skipping the test under Windows).
  1913. ss = test_wrap_socket(socket.socket(socket.AF_INET))
  1914. ss.connect(self.server_addr)
  1915. fd = ss.fileno()
  1916. f = ss.makefile()
  1917. f.close()
  1918. # The fd is still open
  1919. os.read(fd, 0)
  1920. # Closing the SSL socket should close the fd too
  1921. ss.close()
  1922. gc.collect()
  1923. with self.assertRaises(OSError) as e:
  1924. os.read(fd, 0)
  1925. self.assertEqual(e.exception.errno, errno.EBADF)
  1926. def test_non_blocking_handshake(self):
  1927. s = socket.socket(socket.AF_INET)
  1928. s.connect(self.server_addr)
  1929. s.setblocking(False)
  1930. s = test_wrap_socket(s,
  1931. cert_reqs=ssl.CERT_NONE,
  1932. do_handshake_on_connect=False)
  1933. self.addCleanup(s.close)
  1934. count = 0
  1935. while True:
  1936. try:
  1937. count += 1
  1938. s.do_handshake()
  1939. break
  1940. except ssl.SSLWantReadError:
  1941. select.select([s], [], [])
  1942. except ssl.SSLWantWriteError:
  1943. select.select([], [s], [])
  1944. if support.verbose:
  1945. sys.stdout.write("\nNeeded %d calls to do_handshake() to establish session.\n" % count)
  1946. def test_get_server_certificate(self):
  1947. _test_get_server_certificate(self, *self.server_addr, cert=SIGNING_CA)
  1948. def test_get_server_certificate_sni(self):
  1949. host, port = self.server_addr
  1950. server_names = []
  1951. # We store servername_cb arguments to make sure they match the host
  1952. def servername_cb(ssl_sock, server_name, initial_context):
  1953. server_names.append(server_name)
  1954. self.server_context.set_servername_callback(servername_cb)
  1955. pem = ssl.get_server_certificate((host, port))
  1956. if not pem:
  1957. self.fail("No server certificate on %s:%s!" % (host, port))
  1958. pem = ssl.get_server_certificate((host, port), ca_certs=SIGNING_CA)
  1959. if not pem:
  1960. self.fail("No server certificate on %s:%s!" % (host, port))
  1961. if support.verbose:
  1962. sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port, pem))
  1963. self.assertEqual(server_names, [host, host])
  1964. def test_get_server_certificate_fail(self):
  1965. # Connection failure crashes ThreadedEchoServer, so run this in an
  1966. # independent test method
  1967. _test_get_server_certificate_fail(self, *self.server_addr)
  1968. def test_get_server_certificate_timeout(self):
  1969. def servername_cb(ssl_sock, server_name, initial_context):
  1970. time.sleep(0.2)
  1971. self.server_context.set_servername_callback(servername_cb)
  1972. with self.assertRaises(socket.timeout):
  1973. ssl.get_server_certificate(self.server_addr, ca_certs=SIGNING_CA,
  1974. timeout=0.1)
  1975. def test_ciphers(self):
  1976. with test_wrap_socket(socket.socket(socket.AF_INET),
  1977. cert_reqs=ssl.CERT_NONE, ciphers="ALL") as s:
  1978. s.connect(self.server_addr)
  1979. with test_wrap_socket(socket.socket(socket.AF_INET),
  1980. cert_reqs=ssl.CERT_NONE, ciphers="DEFAULT") as s:
  1981. s.connect(self.server_addr)
  1982. # Error checking can happen at instantiation or when connecting
  1983. with self.assertRaisesRegex(ssl.SSLError, "No cipher can be selected"):
  1984. with socket.socket(socket.AF_INET) as sock:
  1985. s = test_wrap_socket(sock,
  1986. cert_reqs=ssl.CERT_NONE, ciphers="^$:,;?*'dorothyx")
  1987. s.connect(self.server_addr)
  1988. def test_get_ca_certs_capath(self):
  1989. # capath certs are loaded on request
  1990. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  1991. ctx.load_verify_locations(capath=CAPATH)
  1992. self.assertEqual(ctx.get_ca_certs(), [])
  1993. with ctx.wrap_socket(socket.socket(socket.AF_INET),
  1994. server_hostname='localhost') as s:
  1995. s.connect(self.server_addr)
  1996. cert = s.getpeercert()
  1997. self.assertTrue(cert)
  1998. self.assertEqual(len(ctx.get_ca_certs()), 1)
  1999. def test_context_setget(self):
  2000. # Check that the context of a connected socket can be replaced.
  2001. ctx1 = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2002. ctx1.load_verify_locations(capath=CAPATH)
  2003. ctx2 = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2004. ctx2.load_verify_locations(capath=CAPATH)
  2005. s = socket.socket(socket.AF_INET)
  2006. with ctx1.wrap_socket(s, server_hostname='localhost') as ss:
  2007. ss.connect(self.server_addr)
  2008. self.assertIs(ss.context, ctx1)
  2009. self.assertIs(ss._sslobj.context, ctx1)
  2010. ss.context = ctx2
  2011. self.assertIs(ss.context, ctx2)
  2012. self.assertIs(ss._sslobj.context, ctx2)
  2013. def ssl_io_loop(self, sock, incoming, outgoing, func, *args, **kwargs):
  2014. # A simple IO loop. Call func(*args) depending on the error we get
  2015. # (WANT_READ or WANT_WRITE) move data between the socket and the BIOs.
  2016. timeout = kwargs.get('timeout', support.SHORT_TIMEOUT)
  2017. deadline = time.monotonic() + timeout
  2018. count = 0
  2019. while True:
  2020. if time.monotonic() > deadline:
  2021. self.fail("timeout")
  2022. errno = None
  2023. count += 1
  2024. try:
  2025. ret = func(*args)
  2026. except ssl.SSLError as e:
  2027. if e.errno not in (ssl.SSL_ERROR_WANT_READ,
  2028. ssl.SSL_ERROR_WANT_WRITE):
  2029. raise
  2030. errno = e.errno
  2031. # Get any data from the outgoing BIO irrespective of any error, and
  2032. # send it to the socket.
  2033. buf = outgoing.read()
  2034. sock.sendall(buf)
  2035. # If there's no error, we're done. For WANT_READ, we need to get
  2036. # data from the socket and put it in the incoming BIO.
  2037. if errno is None:
  2038. break
  2039. elif errno == ssl.SSL_ERROR_WANT_READ:
  2040. buf = sock.recv(32768)
  2041. if buf:
  2042. incoming.write(buf)
  2043. else:
  2044. incoming.write_eof()
  2045. if support.verbose:
  2046. sys.stdout.write("Needed %d calls to complete %s().\n"
  2047. % (count, func.__name__))
  2048. return ret
  2049. def test_bio_handshake(self):
  2050. sock = socket.socket(socket.AF_INET)
  2051. self.addCleanup(sock.close)
  2052. sock.connect(self.server_addr)
  2053. incoming = ssl.MemoryBIO()
  2054. outgoing = ssl.MemoryBIO()
  2055. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2056. self.assertTrue(ctx.check_hostname)
  2057. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  2058. ctx.load_verify_locations(SIGNING_CA)
  2059. sslobj = ctx.wrap_bio(incoming, outgoing, False,
  2060. SIGNED_CERTFILE_HOSTNAME)
  2061. self.assertIs(sslobj._sslobj.owner, sslobj)
  2062. self.assertIsNone(sslobj.cipher())
  2063. self.assertIsNone(sslobj.version())
  2064. self.assertIsNotNone(sslobj.shared_ciphers())
  2065. self.assertRaises(ValueError, sslobj.getpeercert)
  2066. if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
  2067. self.assertIsNone(sslobj.get_channel_binding('tls-unique'))
  2068. self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
  2069. self.assertTrue(sslobj.cipher())
  2070. self.assertIsNotNone(sslobj.shared_ciphers())
  2071. self.assertIsNotNone(sslobj.version())
  2072. self.assertTrue(sslobj.getpeercert())
  2073. if 'tls-unique' in ssl.CHANNEL_BINDING_TYPES:
  2074. self.assertTrue(sslobj.get_channel_binding('tls-unique'))
  2075. try:
  2076. self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
  2077. except ssl.SSLSyscallError:
  2078. # If the server shuts down the TCP connection without sending a
  2079. # secure shutdown message, this is reported as SSL_ERROR_SYSCALL
  2080. pass
  2081. self.assertRaises(ssl.SSLError, sslobj.write, b'foo')
  2082. def test_bio_read_write_data(self):
  2083. sock = socket.socket(socket.AF_INET)
  2084. self.addCleanup(sock.close)
  2085. sock.connect(self.server_addr)
  2086. incoming = ssl.MemoryBIO()
  2087. outgoing = ssl.MemoryBIO()
  2088. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2089. ctx.check_hostname = False
  2090. ctx.verify_mode = ssl.CERT_NONE
  2091. sslobj = ctx.wrap_bio(incoming, outgoing, False)
  2092. self.ssl_io_loop(sock, incoming, outgoing, sslobj.do_handshake)
  2093. req = b'FOO\n'
  2094. self.ssl_io_loop(sock, incoming, outgoing, sslobj.write, req)
  2095. buf = self.ssl_io_loop(sock, incoming, outgoing, sslobj.read, 1024)
  2096. self.assertEqual(buf, b'foo\n')
  2097. self.ssl_io_loop(sock, incoming, outgoing, sslobj.unwrap)
  2098. @support.requires_resource('network')
  2099. class NetworkedTests(unittest.TestCase):
  2100. def test_timeout_connect_ex(self):
  2101. # Issue #12065: on a timeout, connect_ex() should return the original
  2102. # errno (mimicking the behaviour of non-SSL sockets).
  2103. with socket_helper.transient_internet(REMOTE_HOST):
  2104. s = test_wrap_socket(socket.socket(socket.AF_INET),
  2105. cert_reqs=ssl.CERT_REQUIRED,
  2106. do_handshake_on_connect=False)
  2107. self.addCleanup(s.close)
  2108. s.settimeout(0.0000001)
  2109. rc = s.connect_ex((REMOTE_HOST, 443))
  2110. if rc == 0:
  2111. self.skipTest("REMOTE_HOST responded too quickly")
  2112. elif rc == errno.ENETUNREACH:
  2113. self.skipTest("Network unreachable.")
  2114. self.assertIn(rc, (errno.EAGAIN, errno.EWOULDBLOCK))
  2115. @unittest.skipUnless(socket_helper.IPV6_ENABLED, 'Needs IPv6')
  2116. def test_get_server_certificate_ipv6(self):
  2117. with socket_helper.transient_internet('ipv6.google.com'):
  2118. _test_get_server_certificate(self, 'ipv6.google.com', 443)
  2119. _test_get_server_certificate_fail(self, 'ipv6.google.com', 443)
  2120. def _test_get_server_certificate(test, host, port, cert=None):
  2121. pem = ssl.get_server_certificate((host, port))
  2122. if not pem:
  2123. test.fail("No server certificate on %s:%s!" % (host, port))
  2124. pem = ssl.get_server_certificate((host, port), ca_certs=cert)
  2125. if not pem:
  2126. test.fail("No server certificate on %s:%s!" % (host, port))
  2127. if support.verbose:
  2128. sys.stdout.write("\nVerified certificate for %s:%s is\n%s\n" % (host, port ,pem))
  2129. def _test_get_server_certificate_fail(test, host, port):
  2130. try:
  2131. pem = ssl.get_server_certificate((host, port), ca_certs=CERTFILE)
  2132. except ssl.SSLError as x:
  2133. #should fail
  2134. if support.verbose:
  2135. sys.stdout.write("%s\n" % x)
  2136. else:
  2137. test.fail("Got server certificate %s for %s:%s!" % (pem, host, port))
  2138. from test.ssl_servers import make_https_server
  2139. class ThreadedEchoServer(threading.Thread):
  2140. class ConnectionHandler(threading.Thread):
  2141. """A mildly complicated class, because we want it to work both
  2142. with and without the SSL wrapper around the socket connection, so
  2143. that we can test the STARTTLS functionality."""
  2144. def __init__(self, server, connsock, addr):
  2145. self.server = server
  2146. self.running = False
  2147. self.sock = connsock
  2148. self.addr = addr
  2149. self.sock.setblocking(True)
  2150. self.sslconn = None
  2151. threading.Thread.__init__(self)
  2152. self.daemon = True
  2153. def wrap_conn(self):
  2154. try:
  2155. self.sslconn = self.server.context.wrap_socket(
  2156. self.sock, server_side=True)
  2157. self.server.selected_alpn_protocols.append(self.sslconn.selected_alpn_protocol())
  2158. except (ConnectionResetError, BrokenPipeError, ConnectionAbortedError) as e:
  2159. # We treat ConnectionResetError as though it were an
  2160. # SSLError - OpenSSL on Ubuntu abruptly closes the
  2161. # connection when asked to use an unsupported protocol.
  2162. #
  2163. # BrokenPipeError is raised in TLS 1.3 mode, when OpenSSL
  2164. # tries to send session tickets after handshake.
  2165. # https://github.com/openssl/openssl/issues/6342
  2166. #
  2167. # ConnectionAbortedError is raised in TLS 1.3 mode, when OpenSSL
  2168. # tries to send session tickets after handshake when using WinSock.
  2169. self.server.conn_errors.append(str(e))
  2170. if self.server.chatty:
  2171. handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
  2172. self.running = False
  2173. self.close()
  2174. return False
  2175. except (ssl.SSLError, OSError) as e:
  2176. # OSError may occur with wrong protocols, e.g. both
  2177. # sides use PROTOCOL_TLS_SERVER.
  2178. #
  2179. # XXX Various errors can have happened here, for example
  2180. # a mismatching protocol version, an invalid certificate,
  2181. # or a low-level bug. This should be made more discriminating.
  2182. #
  2183. # bpo-31323: Store the exception as string to prevent
  2184. # a reference leak: server -> conn_errors -> exception
  2185. # -> traceback -> self (ConnectionHandler) -> server
  2186. self.server.conn_errors.append(str(e))
  2187. if self.server.chatty:
  2188. handle_error("\n server: bad connection attempt from " + repr(self.addr) + ":\n")
  2189. # bpo-44229, bpo-43855, bpo-44237, and bpo-33450:
  2190. # Ignore spurious EPROTOTYPE returned by write() on macOS.
  2191. # See also http://erickt.github.io/blog/2014/11/19/adventures-in-debugging-a-potential-osx-kernel-bug/
  2192. if e.errno != errno.EPROTOTYPE and sys.platform != "darwin":
  2193. self.running = False
  2194. self.server.stop()
  2195. self.close()
  2196. return False
  2197. else:
  2198. self.server.shared_ciphers.append(self.sslconn.shared_ciphers())
  2199. if self.server.context.verify_mode == ssl.CERT_REQUIRED:
  2200. cert = self.sslconn.getpeercert()
  2201. if support.verbose and self.server.chatty:
  2202. sys.stdout.write(" client cert is " + pprint.pformat(cert) + "\n")
  2203. cert_binary = self.sslconn.getpeercert(True)
  2204. if support.verbose and self.server.chatty:
  2205. if cert_binary is None:
  2206. sys.stdout.write(" client did not provide a cert\n")
  2207. else:
  2208. sys.stdout.write(f" cert binary is {len(cert_binary)}b\n")
  2209. cipher = self.sslconn.cipher()
  2210. if support.verbose and self.server.chatty:
  2211. sys.stdout.write(" server: connection cipher is now " + str(cipher) + "\n")
  2212. return True
  2213. def read(self):
  2214. if self.sslconn:
  2215. return self.sslconn.read()
  2216. else:
  2217. return self.sock.recv(1024)
  2218. def write(self, bytes):
  2219. if self.sslconn:
  2220. return self.sslconn.write(bytes)
  2221. else:
  2222. return self.sock.send(bytes)
  2223. def close(self):
  2224. if self.sslconn:
  2225. self.sslconn.close()
  2226. else:
  2227. self.sock.close()
  2228. def run(self):
  2229. self.running = True
  2230. if not self.server.starttls_server:
  2231. if not self.wrap_conn():
  2232. return
  2233. while self.running:
  2234. try:
  2235. msg = self.read()
  2236. stripped = msg.strip()
  2237. if not stripped:
  2238. # eof, so quit this handler
  2239. self.running = False
  2240. try:
  2241. self.sock = self.sslconn.unwrap()
  2242. except OSError:
  2243. # Many tests shut the TCP connection down
  2244. # without an SSL shutdown. This causes
  2245. # unwrap() to raise OSError with errno=0!
  2246. pass
  2247. else:
  2248. self.sslconn = None
  2249. self.close()
  2250. elif stripped == b'over':
  2251. if support.verbose and self.server.connectionchatty:
  2252. sys.stdout.write(" server: client closed connection\n")
  2253. self.close()
  2254. return
  2255. elif (self.server.starttls_server and
  2256. stripped == b'STARTTLS'):
  2257. if support.verbose and self.server.connectionchatty:
  2258. sys.stdout.write(" server: read STARTTLS from client, sending OK...\n")
  2259. self.write(b"OK\n")
  2260. if not self.wrap_conn():
  2261. return
  2262. elif (self.server.starttls_server and self.sslconn
  2263. and stripped == b'ENDTLS'):
  2264. if support.verbose and self.server.connectionchatty:
  2265. sys.stdout.write(" server: read ENDTLS from client, sending OK...\n")
  2266. self.write(b"OK\n")
  2267. self.sock = self.sslconn.unwrap()
  2268. self.sslconn = None
  2269. if support.verbose and self.server.connectionchatty:
  2270. sys.stdout.write(" server: connection is now unencrypted...\n")
  2271. elif stripped == b'CB tls-unique':
  2272. if support.verbose and self.server.connectionchatty:
  2273. sys.stdout.write(" server: read CB tls-unique from client, sending our CB data...\n")
  2274. data = self.sslconn.get_channel_binding("tls-unique")
  2275. self.write(repr(data).encode("us-ascii") + b"\n")
  2276. elif stripped == b'PHA':
  2277. if support.verbose and self.server.connectionchatty:
  2278. sys.stdout.write(" server: initiating post handshake auth\n")
  2279. try:
  2280. self.sslconn.verify_client_post_handshake()
  2281. except ssl.SSLError as e:
  2282. self.write(repr(e).encode("us-ascii") + b"\n")
  2283. else:
  2284. self.write(b"OK\n")
  2285. elif stripped == b'HASCERT':
  2286. if self.sslconn.getpeercert() is not None:
  2287. self.write(b'TRUE\n')
  2288. else:
  2289. self.write(b'FALSE\n')
  2290. elif stripped == b'GETCERT':
  2291. cert = self.sslconn.getpeercert()
  2292. self.write(repr(cert).encode("us-ascii") + b"\n")
  2293. elif stripped == b'VERIFIEDCHAIN':
  2294. certs = self.sslconn._sslobj.get_verified_chain()
  2295. self.write(len(certs).to_bytes(1, "big") + b"\n")
  2296. elif stripped == b'UNVERIFIEDCHAIN':
  2297. certs = self.sslconn._sslobj.get_unverified_chain()
  2298. self.write(len(certs).to_bytes(1, "big") + b"\n")
  2299. else:
  2300. if (support.verbose and
  2301. self.server.connectionchatty):
  2302. ctype = (self.sslconn and "encrypted") or "unencrypted"
  2303. sys.stdout.write(" server: read %r (%s), sending back %r (%s)...\n"
  2304. % (msg, ctype, msg.lower(), ctype))
  2305. self.write(msg.lower())
  2306. except OSError as e:
  2307. # handles SSLError and socket errors
  2308. if self.server.chatty and support.verbose:
  2309. if isinstance(e, ConnectionError):
  2310. # OpenSSL 1.1.1 sometimes raises
  2311. # ConnectionResetError when connection is not
  2312. # shut down gracefully.
  2313. print(
  2314. f" Connection reset by peer: {self.addr}"
  2315. )
  2316. else:
  2317. handle_error("Test server failure:\n")
  2318. try:
  2319. self.write(b"ERROR\n")
  2320. except OSError:
  2321. pass
  2322. self.close()
  2323. self.running = False
  2324. # normally, we'd just stop here, but for the test
  2325. # harness, we want to stop the server
  2326. self.server.stop()
  2327. def __init__(self, certificate=None, ssl_version=None,
  2328. certreqs=None, cacerts=None,
  2329. chatty=True, connectionchatty=False, starttls_server=False,
  2330. alpn_protocols=None,
  2331. ciphers=None, context=None):
  2332. if context:
  2333. self.context = context
  2334. else:
  2335. self.context = ssl.SSLContext(ssl_version
  2336. if ssl_version is not None
  2337. else ssl.PROTOCOL_TLS_SERVER)
  2338. self.context.verify_mode = (certreqs if certreqs is not None
  2339. else ssl.CERT_NONE)
  2340. if cacerts:
  2341. self.context.load_verify_locations(cacerts)
  2342. if certificate:
  2343. self.context.load_cert_chain(certificate)
  2344. if alpn_protocols:
  2345. self.context.set_alpn_protocols(alpn_protocols)
  2346. if ciphers:
  2347. self.context.set_ciphers(ciphers)
  2348. self.chatty = chatty
  2349. self.connectionchatty = connectionchatty
  2350. self.starttls_server = starttls_server
  2351. self.sock = socket.socket()
  2352. self.port = socket_helper.bind_port(self.sock)
  2353. self.flag = None
  2354. self.active = False
  2355. self.selected_alpn_protocols = []
  2356. self.shared_ciphers = []
  2357. self.conn_errors = []
  2358. threading.Thread.__init__(self)
  2359. self.daemon = True
  2360. def __enter__(self):
  2361. self.start(threading.Event())
  2362. self.flag.wait()
  2363. return self
  2364. def __exit__(self, *args):
  2365. self.stop()
  2366. self.join()
  2367. def start(self, flag=None):
  2368. self.flag = flag
  2369. threading.Thread.start(self)
  2370. def run(self):
  2371. self.sock.settimeout(1.0)
  2372. self.sock.listen(5)
  2373. self.active = True
  2374. if self.flag:
  2375. # signal an event
  2376. self.flag.set()
  2377. while self.active:
  2378. try:
  2379. newconn, connaddr = self.sock.accept()
  2380. if support.verbose and self.chatty:
  2381. sys.stdout.write(' server: new connection from '
  2382. + repr(connaddr) + '\n')
  2383. handler = self.ConnectionHandler(self, newconn, connaddr)
  2384. handler.start()
  2385. handler.join()
  2386. except TimeoutError as e:
  2387. if support.verbose:
  2388. sys.stdout.write(f' connection timeout {e!r}\n')
  2389. except KeyboardInterrupt:
  2390. self.stop()
  2391. except BaseException as e:
  2392. if support.verbose and self.chatty:
  2393. sys.stdout.write(
  2394. ' connection handling failed: ' + repr(e) + '\n')
  2395. self.close()
  2396. def close(self):
  2397. if self.sock is not None:
  2398. self.sock.close()
  2399. self.sock = None
  2400. def stop(self):
  2401. self.active = False
  2402. class AsyncoreEchoServer(threading.Thread):
  2403. # this one's based on asyncore.dispatcher
  2404. class EchoServer (asyncore.dispatcher):
  2405. class ConnectionHandler(asyncore.dispatcher_with_send):
  2406. def __init__(self, conn, certfile):
  2407. self.socket = test_wrap_socket(conn, server_side=True,
  2408. certfile=certfile,
  2409. do_handshake_on_connect=False)
  2410. asyncore.dispatcher_with_send.__init__(self, self.socket)
  2411. self._ssl_accepting = True
  2412. self._do_ssl_handshake()
  2413. def readable(self):
  2414. if isinstance(self.socket, ssl.SSLSocket):
  2415. while self.socket.pending() > 0:
  2416. self.handle_read_event()
  2417. return True
  2418. def _do_ssl_handshake(self):
  2419. try:
  2420. self.socket.do_handshake()
  2421. except (ssl.SSLWantReadError, ssl.SSLWantWriteError):
  2422. return
  2423. except ssl.SSLEOFError:
  2424. return self.handle_close()
  2425. except ssl.SSLError:
  2426. raise
  2427. except OSError as err:
  2428. if err.args[0] == errno.ECONNABORTED:
  2429. return self.handle_close()
  2430. else:
  2431. self._ssl_accepting = False
  2432. def handle_read(self):
  2433. if self._ssl_accepting:
  2434. self._do_ssl_handshake()
  2435. else:
  2436. data = self.recv(1024)
  2437. if support.verbose:
  2438. sys.stdout.write(" server: read %s from client\n" % repr(data))
  2439. if not data:
  2440. self.close()
  2441. else:
  2442. self.send(data.lower())
  2443. def handle_close(self):
  2444. self.close()
  2445. if support.verbose:
  2446. sys.stdout.write(" server: closed connection %s\n" % self.socket)
  2447. def handle_error(self):
  2448. raise
  2449. def __init__(self, certfile):
  2450. self.certfile = certfile
  2451. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  2452. self.port = socket_helper.bind_port(sock, '')
  2453. asyncore.dispatcher.__init__(self, sock)
  2454. self.listen(5)
  2455. def handle_accepted(self, sock_obj, addr):
  2456. if support.verbose:
  2457. sys.stdout.write(" server: new connection from %s:%s\n" %addr)
  2458. self.ConnectionHandler(sock_obj, self.certfile)
  2459. def handle_error(self):
  2460. raise
  2461. def __init__(self, certfile):
  2462. self.flag = None
  2463. self.active = False
  2464. self.server = self.EchoServer(certfile)
  2465. self.port = self.server.port
  2466. threading.Thread.__init__(self)
  2467. self.daemon = True
  2468. def __str__(self):
  2469. return "<%s %s>" % (self.__class__.__name__, self.server)
  2470. def __enter__(self):
  2471. self.start(threading.Event())
  2472. self.flag.wait()
  2473. return self
  2474. def __exit__(self, *args):
  2475. if support.verbose:
  2476. sys.stdout.write(" cleanup: stopping server.\n")
  2477. self.stop()
  2478. if support.verbose:
  2479. sys.stdout.write(" cleanup: joining server thread.\n")
  2480. self.join()
  2481. if support.verbose:
  2482. sys.stdout.write(" cleanup: successfully joined.\n")
  2483. # make sure that ConnectionHandler is removed from socket_map
  2484. asyncore.close_all(ignore_all=True)
  2485. def start (self, flag=None):
  2486. self.flag = flag
  2487. threading.Thread.start(self)
  2488. def run(self):
  2489. self.active = True
  2490. if self.flag:
  2491. self.flag.set()
  2492. while self.active:
  2493. try:
  2494. asyncore.loop(1)
  2495. except:
  2496. pass
  2497. def stop(self):
  2498. self.active = False
  2499. self.server.close()
  2500. def server_params_test(client_context, server_context, indata=b"FOO\n",
  2501. chatty=True, connectionchatty=False, sni_name=None,
  2502. session=None):
  2503. """
  2504. Launch a server, connect a client to it and try various reads
  2505. and writes.
  2506. """
  2507. stats = {}
  2508. server = ThreadedEchoServer(context=server_context,
  2509. chatty=chatty,
  2510. connectionchatty=False)
  2511. with server:
  2512. with client_context.wrap_socket(socket.socket(),
  2513. server_hostname=sni_name, session=session) as s:
  2514. s.connect((HOST, server.port))
  2515. for arg in [indata, bytearray(indata), memoryview(indata)]:
  2516. if connectionchatty:
  2517. if support.verbose:
  2518. sys.stdout.write(
  2519. " client: sending %r...\n" % indata)
  2520. s.write(arg)
  2521. outdata = s.read()
  2522. if connectionchatty:
  2523. if support.verbose:
  2524. sys.stdout.write(" client: read %r\n" % outdata)
  2525. if outdata != indata.lower():
  2526. raise AssertionError(
  2527. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  2528. % (outdata[:20], len(outdata),
  2529. indata[:20].lower(), len(indata)))
  2530. s.write(b"over\n")
  2531. if connectionchatty:
  2532. if support.verbose:
  2533. sys.stdout.write(" client: closing connection.\n")
  2534. stats.update({
  2535. 'compression': s.compression(),
  2536. 'cipher': s.cipher(),
  2537. 'peercert': s.getpeercert(),
  2538. 'client_alpn_protocol': s.selected_alpn_protocol(),
  2539. 'version': s.version(),
  2540. 'session_reused': s.session_reused,
  2541. 'session': s.session,
  2542. })
  2543. s.close()
  2544. stats['server_alpn_protocols'] = server.selected_alpn_protocols
  2545. stats['server_shared_ciphers'] = server.shared_ciphers
  2546. return stats
  2547. def try_protocol_combo(server_protocol, client_protocol, expect_success,
  2548. certsreqs=None, server_options=0, client_options=0):
  2549. """
  2550. Try to SSL-connect using *client_protocol* to *server_protocol*.
  2551. If *expect_success* is true, assert that the connection succeeds,
  2552. if it's false, assert that the connection fails.
  2553. Also, if *expect_success* is a string, assert that it is the protocol
  2554. version actually used by the connection.
  2555. """
  2556. if certsreqs is None:
  2557. certsreqs = ssl.CERT_NONE
  2558. certtype = {
  2559. ssl.CERT_NONE: "CERT_NONE",
  2560. ssl.CERT_OPTIONAL: "CERT_OPTIONAL",
  2561. ssl.CERT_REQUIRED: "CERT_REQUIRED",
  2562. }[certsreqs]
  2563. if support.verbose:
  2564. formatstr = (expect_success and " %s->%s %s\n") or " {%s->%s} %s\n"
  2565. sys.stdout.write(formatstr %
  2566. (ssl.get_protocol_name(client_protocol),
  2567. ssl.get_protocol_name(server_protocol),
  2568. certtype))
  2569. with warnings_helper.check_warnings():
  2570. # ignore Deprecation warnings
  2571. client_context = ssl.SSLContext(client_protocol)
  2572. client_context.options |= client_options
  2573. server_context = ssl.SSLContext(server_protocol)
  2574. server_context.options |= server_options
  2575. min_version = PROTOCOL_TO_TLS_VERSION.get(client_protocol, None)
  2576. if (min_version is not None
  2577. # SSLContext.minimum_version is only available on recent OpenSSL
  2578. # (setter added in OpenSSL 1.1.0, getter added in OpenSSL 1.1.1)
  2579. and hasattr(server_context, 'minimum_version')
  2580. and server_protocol == ssl.PROTOCOL_TLS
  2581. and server_context.minimum_version > min_version
  2582. ):
  2583. # If OpenSSL configuration is strict and requires more recent TLS
  2584. # version, we have to change the minimum to test old TLS versions.
  2585. with warnings_helper.check_warnings():
  2586. server_context.minimum_version = min_version
  2587. # NOTE: we must enable "ALL" ciphers on the client, otherwise an
  2588. # SSLv23 client will send an SSLv3 hello (rather than SSLv2)
  2589. # starting from OpenSSL 1.0.0 (see issue #8322).
  2590. if client_context.protocol == ssl.PROTOCOL_TLS:
  2591. client_context.set_ciphers("ALL")
  2592. seclevel_workaround(server_context, client_context)
  2593. for ctx in (client_context, server_context):
  2594. ctx.verify_mode = certsreqs
  2595. ctx.load_cert_chain(SIGNED_CERTFILE)
  2596. ctx.load_verify_locations(SIGNING_CA)
  2597. try:
  2598. stats = server_params_test(client_context, server_context,
  2599. chatty=False, connectionchatty=False)
  2600. # Protocol mismatch can result in either an SSLError, or a
  2601. # "Connection reset by peer" error.
  2602. except ssl.SSLError:
  2603. if expect_success:
  2604. raise
  2605. except OSError as e:
  2606. if expect_success or e.errno != errno.ECONNRESET:
  2607. raise
  2608. else:
  2609. if not expect_success:
  2610. raise AssertionError(
  2611. "Client protocol %s succeeded with server protocol %s!"
  2612. % (ssl.get_protocol_name(client_protocol),
  2613. ssl.get_protocol_name(server_protocol)))
  2614. elif (expect_success is not True
  2615. and expect_success != stats['version']):
  2616. raise AssertionError("version mismatch: expected %r, got %r"
  2617. % (expect_success, stats['version']))
  2618. class ThreadedTests(unittest.TestCase):
  2619. def test_echo(self):
  2620. """Basic test of an SSL client connecting to a server"""
  2621. if support.verbose:
  2622. sys.stdout.write("\n")
  2623. client_context, server_context, hostname = testing_context()
  2624. with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_SERVER):
  2625. server_params_test(client_context=client_context,
  2626. server_context=server_context,
  2627. chatty=True, connectionchatty=True,
  2628. sni_name=hostname)
  2629. client_context.check_hostname = False
  2630. with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_CLIENT):
  2631. with self.assertRaises(ssl.SSLError) as e:
  2632. server_params_test(client_context=server_context,
  2633. server_context=client_context,
  2634. chatty=True, connectionchatty=True,
  2635. sni_name=hostname)
  2636. self.assertIn(
  2637. 'Cannot create a client socket with a PROTOCOL_TLS_SERVER context',
  2638. str(e.exception)
  2639. )
  2640. with self.subTest(client=ssl.PROTOCOL_TLS_SERVER, server=ssl.PROTOCOL_TLS_SERVER):
  2641. with self.assertRaises(ssl.SSLError) as e:
  2642. server_params_test(client_context=server_context,
  2643. server_context=server_context,
  2644. chatty=True, connectionchatty=True)
  2645. self.assertIn(
  2646. 'Cannot create a client socket with a PROTOCOL_TLS_SERVER context',
  2647. str(e.exception)
  2648. )
  2649. with self.subTest(client=ssl.PROTOCOL_TLS_CLIENT, server=ssl.PROTOCOL_TLS_CLIENT):
  2650. with self.assertRaises(ssl.SSLError) as e:
  2651. server_params_test(client_context=server_context,
  2652. server_context=client_context,
  2653. chatty=True, connectionchatty=True)
  2654. self.assertIn(
  2655. 'Cannot create a client socket with a PROTOCOL_TLS_SERVER context',
  2656. str(e.exception))
  2657. def test_getpeercert(self):
  2658. if support.verbose:
  2659. sys.stdout.write("\n")
  2660. client_context, server_context, hostname = testing_context()
  2661. server = ThreadedEchoServer(context=server_context, chatty=False)
  2662. with server:
  2663. with client_context.wrap_socket(socket.socket(),
  2664. do_handshake_on_connect=False,
  2665. server_hostname=hostname) as s:
  2666. s.connect((HOST, server.port))
  2667. # getpeercert() raise ValueError while the handshake isn't
  2668. # done.
  2669. with self.assertRaises(ValueError):
  2670. s.getpeercert()
  2671. s.do_handshake()
  2672. cert = s.getpeercert()
  2673. self.assertTrue(cert, "Can't get peer certificate.")
  2674. cipher = s.cipher()
  2675. if support.verbose:
  2676. sys.stdout.write(pprint.pformat(cert) + '\n')
  2677. sys.stdout.write("Connection cipher is " + str(cipher) + '.\n')
  2678. if 'subject' not in cert:
  2679. self.fail("No subject field in certificate: %s." %
  2680. pprint.pformat(cert))
  2681. if ((('organizationName', 'Python Software Foundation'),)
  2682. not in cert['subject']):
  2683. self.fail(
  2684. "Missing or invalid 'organizationName' field in certificate subject; "
  2685. "should be 'Python Software Foundation'.")
  2686. self.assertIn('notBefore', cert)
  2687. self.assertIn('notAfter', cert)
  2688. before = ssl.cert_time_to_seconds(cert['notBefore'])
  2689. after = ssl.cert_time_to_seconds(cert['notAfter'])
  2690. self.assertLess(before, after)
  2691. def test_crl_check(self):
  2692. if support.verbose:
  2693. sys.stdout.write("\n")
  2694. client_context, server_context, hostname = testing_context()
  2695. tf = getattr(ssl, "VERIFY_X509_TRUSTED_FIRST", 0)
  2696. self.assertEqual(client_context.verify_flags, ssl.VERIFY_DEFAULT | tf)
  2697. # VERIFY_DEFAULT should pass
  2698. server = ThreadedEchoServer(context=server_context, chatty=True)
  2699. with server:
  2700. with client_context.wrap_socket(socket.socket(),
  2701. server_hostname=hostname) as s:
  2702. s.connect((HOST, server.port))
  2703. cert = s.getpeercert()
  2704. self.assertTrue(cert, "Can't get peer certificate.")
  2705. # VERIFY_CRL_CHECK_LEAF without a loaded CRL file fails
  2706. client_context.verify_flags |= ssl.VERIFY_CRL_CHECK_LEAF
  2707. server = ThreadedEchoServer(context=server_context, chatty=True)
  2708. with server:
  2709. with client_context.wrap_socket(socket.socket(),
  2710. server_hostname=hostname) as s:
  2711. with self.assertRaisesRegex(ssl.SSLError,
  2712. "certificate verify failed"):
  2713. s.connect((HOST, server.port))
  2714. # now load a CRL file. The CRL file is signed by the CA.
  2715. client_context.load_verify_locations(CRLFILE)
  2716. server = ThreadedEchoServer(context=server_context, chatty=True)
  2717. with server:
  2718. with client_context.wrap_socket(socket.socket(),
  2719. server_hostname=hostname) as s:
  2720. s.connect((HOST, server.port))
  2721. cert = s.getpeercert()
  2722. self.assertTrue(cert, "Can't get peer certificate.")
  2723. def test_check_hostname(self):
  2724. if support.verbose:
  2725. sys.stdout.write("\n")
  2726. client_context, server_context, hostname = testing_context()
  2727. # correct hostname should verify
  2728. server = ThreadedEchoServer(context=server_context, chatty=True)
  2729. with server:
  2730. with client_context.wrap_socket(socket.socket(),
  2731. server_hostname=hostname) as s:
  2732. s.connect((HOST, server.port))
  2733. cert = s.getpeercert()
  2734. self.assertTrue(cert, "Can't get peer certificate.")
  2735. # incorrect hostname should raise an exception
  2736. server = ThreadedEchoServer(context=server_context, chatty=True)
  2737. with server:
  2738. with client_context.wrap_socket(socket.socket(),
  2739. server_hostname="invalid") as s:
  2740. with self.assertRaisesRegex(
  2741. ssl.CertificateError,
  2742. "Hostname mismatch, certificate is not valid for 'invalid'."):
  2743. s.connect((HOST, server.port))
  2744. # missing server_hostname arg should cause an exception, too
  2745. server = ThreadedEchoServer(context=server_context, chatty=True)
  2746. with server:
  2747. with socket.socket() as s:
  2748. with self.assertRaisesRegex(ValueError,
  2749. "check_hostname requires server_hostname"):
  2750. client_context.wrap_socket(s)
  2751. @unittest.skipUnless(
  2752. ssl.HAS_NEVER_CHECK_COMMON_NAME, "test requires hostname_checks_common_name"
  2753. )
  2754. def test_hostname_checks_common_name(self):
  2755. client_context, server_context, hostname = testing_context()
  2756. assert client_context.hostname_checks_common_name
  2757. client_context.hostname_checks_common_name = False
  2758. # default cert has a SAN
  2759. server = ThreadedEchoServer(context=server_context, chatty=True)
  2760. with server:
  2761. with client_context.wrap_socket(socket.socket(),
  2762. server_hostname=hostname) as s:
  2763. s.connect((HOST, server.port))
  2764. client_context, server_context, hostname = testing_context(NOSANFILE)
  2765. client_context.hostname_checks_common_name = False
  2766. server = ThreadedEchoServer(context=server_context, chatty=True)
  2767. with server:
  2768. with client_context.wrap_socket(socket.socket(),
  2769. server_hostname=hostname) as s:
  2770. with self.assertRaises(ssl.SSLCertVerificationError):
  2771. s.connect((HOST, server.port))
  2772. def test_ecc_cert(self):
  2773. client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2774. client_context.load_verify_locations(SIGNING_CA)
  2775. client_context.set_ciphers('ECDHE:ECDSA:!NULL:!aRSA')
  2776. hostname = SIGNED_CERTFILE_ECC_HOSTNAME
  2777. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  2778. # load ECC cert
  2779. server_context.load_cert_chain(SIGNED_CERTFILE_ECC)
  2780. # correct hostname should verify
  2781. server = ThreadedEchoServer(context=server_context, chatty=True)
  2782. with server:
  2783. with client_context.wrap_socket(socket.socket(),
  2784. server_hostname=hostname) as s:
  2785. s.connect((HOST, server.port))
  2786. cert = s.getpeercert()
  2787. self.assertTrue(cert, "Can't get peer certificate.")
  2788. cipher = s.cipher()[0].split('-')
  2789. self.assertTrue(cipher[:2], ('ECDHE', 'ECDSA'))
  2790. def test_dual_rsa_ecc(self):
  2791. client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2792. client_context.load_verify_locations(SIGNING_CA)
  2793. # TODO: fix TLSv1.3 once SSLContext can restrict signature
  2794. # algorithms.
  2795. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  2796. # only ECDSA certs
  2797. client_context.set_ciphers('ECDHE:ECDSA:!NULL:!aRSA')
  2798. hostname = SIGNED_CERTFILE_ECC_HOSTNAME
  2799. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  2800. # load ECC and RSA key/cert pairs
  2801. server_context.load_cert_chain(SIGNED_CERTFILE_ECC)
  2802. server_context.load_cert_chain(SIGNED_CERTFILE)
  2803. # correct hostname should verify
  2804. server = ThreadedEchoServer(context=server_context, chatty=True)
  2805. with server:
  2806. with client_context.wrap_socket(socket.socket(),
  2807. server_hostname=hostname) as s:
  2808. s.connect((HOST, server.port))
  2809. cert = s.getpeercert()
  2810. self.assertTrue(cert, "Can't get peer certificate.")
  2811. cipher = s.cipher()[0].split('-')
  2812. self.assertTrue(cipher[:2], ('ECDHE', 'ECDSA'))
  2813. def test_check_hostname_idn(self):
  2814. if support.verbose:
  2815. sys.stdout.write("\n")
  2816. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  2817. server_context.load_cert_chain(IDNSANSFILE)
  2818. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2819. context.verify_mode = ssl.CERT_REQUIRED
  2820. context.check_hostname = True
  2821. context.load_verify_locations(SIGNING_CA)
  2822. # correct hostname should verify, when specified in several
  2823. # different ways
  2824. idn_hostnames = [
  2825. ('könig.idn.pythontest.net',
  2826. 'xn--knig-5qa.idn.pythontest.net'),
  2827. ('xn--knig-5qa.idn.pythontest.net',
  2828. 'xn--knig-5qa.idn.pythontest.net'),
  2829. (b'xn--knig-5qa.idn.pythontest.net',
  2830. 'xn--knig-5qa.idn.pythontest.net'),
  2831. ('königsgäßchen.idna2003.pythontest.net',
  2832. 'xn--knigsgsschen-lcb0w.idna2003.pythontest.net'),
  2833. ('xn--knigsgsschen-lcb0w.idna2003.pythontest.net',
  2834. 'xn--knigsgsschen-lcb0w.idna2003.pythontest.net'),
  2835. (b'xn--knigsgsschen-lcb0w.idna2003.pythontest.net',
  2836. 'xn--knigsgsschen-lcb0w.idna2003.pythontest.net'),
  2837. # ('königsgäßchen.idna2008.pythontest.net',
  2838. # 'xn--knigsgchen-b4a3dun.idna2008.pythontest.net'),
  2839. ('xn--knigsgchen-b4a3dun.idna2008.pythontest.net',
  2840. 'xn--knigsgchen-b4a3dun.idna2008.pythontest.net'),
  2841. (b'xn--knigsgchen-b4a3dun.idna2008.pythontest.net',
  2842. 'xn--knigsgchen-b4a3dun.idna2008.pythontest.net'),
  2843. ]
  2844. for server_hostname, expected_hostname in idn_hostnames:
  2845. server = ThreadedEchoServer(context=server_context, chatty=True)
  2846. with server:
  2847. with context.wrap_socket(socket.socket(),
  2848. server_hostname=server_hostname) as s:
  2849. self.assertEqual(s.server_hostname, expected_hostname)
  2850. s.connect((HOST, server.port))
  2851. cert = s.getpeercert()
  2852. self.assertEqual(s.server_hostname, expected_hostname)
  2853. self.assertTrue(cert, "Can't get peer certificate.")
  2854. # incorrect hostname should raise an exception
  2855. server = ThreadedEchoServer(context=server_context, chatty=True)
  2856. with server:
  2857. with context.wrap_socket(socket.socket(),
  2858. server_hostname="python.example.org") as s:
  2859. with self.assertRaises(ssl.CertificateError):
  2860. s.connect((HOST, server.port))
  2861. def test_wrong_cert_tls12(self):
  2862. """Connecting when the server rejects the client's certificate
  2863. Launch a server with CERT_REQUIRED, and check that trying to
  2864. connect to it with a wrong client certificate fails.
  2865. """
  2866. client_context, server_context, hostname = testing_context()
  2867. # load client cert that is not signed by trusted CA
  2868. client_context.load_cert_chain(CERTFILE)
  2869. # require TLS client authentication
  2870. server_context.verify_mode = ssl.CERT_REQUIRED
  2871. # TLS 1.3 has different handshake
  2872. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  2873. server = ThreadedEchoServer(
  2874. context=server_context, chatty=True, connectionchatty=True,
  2875. )
  2876. with server, \
  2877. client_context.wrap_socket(socket.socket(),
  2878. server_hostname=hostname) as s:
  2879. try:
  2880. # Expect either an SSL error about the server rejecting
  2881. # the connection, or a low-level connection reset (which
  2882. # sometimes happens on Windows)
  2883. s.connect((HOST, server.port))
  2884. except ssl.SSLError as e:
  2885. if support.verbose:
  2886. sys.stdout.write("\nSSLError is %r\n" % e)
  2887. except OSError as e:
  2888. if e.errno != errno.ECONNRESET:
  2889. raise
  2890. if support.verbose:
  2891. sys.stdout.write("\nsocket.error is %r\n" % e)
  2892. else:
  2893. self.fail("Use of invalid cert should have failed!")
  2894. @requires_tls_version('TLSv1_3')
  2895. def test_wrong_cert_tls13(self):
  2896. client_context, server_context, hostname = testing_context()
  2897. # load client cert that is not signed by trusted CA
  2898. client_context.load_cert_chain(CERTFILE)
  2899. server_context.verify_mode = ssl.CERT_REQUIRED
  2900. server_context.minimum_version = ssl.TLSVersion.TLSv1_3
  2901. client_context.minimum_version = ssl.TLSVersion.TLSv1_3
  2902. server = ThreadedEchoServer(
  2903. context=server_context, chatty=True, connectionchatty=True,
  2904. )
  2905. with server, \
  2906. client_context.wrap_socket(socket.socket(),
  2907. server_hostname=hostname,
  2908. suppress_ragged_eofs=False) as s:
  2909. s.connect((HOST, server.port))
  2910. with self.assertRaisesRegex(
  2911. ssl.SSLError,
  2912. 'alert unknown ca|EOF occurred'
  2913. ):
  2914. # TLS 1.3 perform client cert exchange after handshake
  2915. s.write(b'data')
  2916. s.read(1000)
  2917. s.write(b'should have failed already')
  2918. s.read(1000)
  2919. def test_rude_shutdown(self):
  2920. """A brutal shutdown of an SSL server should raise an OSError
  2921. in the client when attempting handshake.
  2922. """
  2923. listener_ready = threading.Event()
  2924. listener_gone = threading.Event()
  2925. s = socket.socket()
  2926. port = socket_helper.bind_port(s, HOST)
  2927. # `listener` runs in a thread. It sits in an accept() until
  2928. # the main thread connects. Then it rudely closes the socket,
  2929. # and sets Event `listener_gone` to let the main thread know
  2930. # the socket is gone.
  2931. def listener():
  2932. s.listen()
  2933. listener_ready.set()
  2934. newsock, addr = s.accept()
  2935. newsock.close()
  2936. s.close()
  2937. listener_gone.set()
  2938. def connector():
  2939. listener_ready.wait()
  2940. with socket.socket() as c:
  2941. c.connect((HOST, port))
  2942. listener_gone.wait()
  2943. try:
  2944. ssl_sock = test_wrap_socket(c)
  2945. except OSError:
  2946. pass
  2947. else:
  2948. self.fail('connecting to closed SSL socket should have failed')
  2949. t = threading.Thread(target=listener)
  2950. t.start()
  2951. try:
  2952. connector()
  2953. finally:
  2954. t.join()
  2955. def test_ssl_cert_verify_error(self):
  2956. if support.verbose:
  2957. sys.stdout.write("\n")
  2958. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  2959. server_context.load_cert_chain(SIGNED_CERTFILE)
  2960. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  2961. server = ThreadedEchoServer(context=server_context, chatty=True)
  2962. with server:
  2963. with context.wrap_socket(socket.socket(),
  2964. server_hostname=SIGNED_CERTFILE_HOSTNAME) as s:
  2965. try:
  2966. s.connect((HOST, server.port))
  2967. except ssl.SSLError as e:
  2968. msg = 'unable to get local issuer certificate'
  2969. self.assertIsInstance(e, ssl.SSLCertVerificationError)
  2970. self.assertEqual(e.verify_code, 20)
  2971. self.assertEqual(e.verify_message, msg)
  2972. self.assertIn(msg, repr(e))
  2973. self.assertIn('certificate verify failed', repr(e))
  2974. @requires_tls_version('SSLv2')
  2975. def test_protocol_sslv2(self):
  2976. """Connecting to an SSLv2 server with various client options"""
  2977. if support.verbose:
  2978. sys.stdout.write("\n")
  2979. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True)
  2980. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_OPTIONAL)
  2981. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv2, True, ssl.CERT_REQUIRED)
  2982. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLS, False)
  2983. if has_tls_version('SSLv3'):
  2984. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_SSLv3, False)
  2985. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLSv1, False)
  2986. # SSLv23 client with specific SSL options
  2987. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLS, False,
  2988. client_options=ssl.OP_NO_SSLv3)
  2989. try_protocol_combo(ssl.PROTOCOL_SSLv2, ssl.PROTOCOL_TLS, False,
  2990. client_options=ssl.OP_NO_TLSv1)
  2991. def test_PROTOCOL_TLS(self):
  2992. """Connecting to an SSLv23 server with various client options"""
  2993. if support.verbose:
  2994. sys.stdout.write("\n")
  2995. if has_tls_version('SSLv2'):
  2996. try:
  2997. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv2, True)
  2998. except OSError as x:
  2999. # this fails on some older versions of OpenSSL (0.9.7l, for instance)
  3000. if support.verbose:
  3001. sys.stdout.write(
  3002. " SSL2 client to SSL23 server test unexpectedly failed:\n %s\n"
  3003. % str(x))
  3004. if has_tls_version('SSLv3'):
  3005. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv3, False)
  3006. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLS, True)
  3007. if has_tls_version('TLSv1'):
  3008. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1, 'TLSv1')
  3009. if has_tls_version('SSLv3'):
  3010. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv3, False, ssl.CERT_OPTIONAL)
  3011. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLS, True, ssl.CERT_OPTIONAL)
  3012. if has_tls_version('TLSv1'):
  3013. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
  3014. if has_tls_version('SSLv3'):
  3015. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv3, False, ssl.CERT_REQUIRED)
  3016. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLS, True, ssl.CERT_REQUIRED)
  3017. if has_tls_version('TLSv1'):
  3018. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
  3019. # Server with specific SSL options
  3020. if has_tls_version('SSLv3'):
  3021. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_SSLv3, False,
  3022. server_options=ssl.OP_NO_SSLv3)
  3023. # Will choose TLSv1
  3024. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLS, True,
  3025. server_options=ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3)
  3026. if has_tls_version('TLSv1'):
  3027. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1, False,
  3028. server_options=ssl.OP_NO_TLSv1)
  3029. @requires_tls_version('SSLv3')
  3030. def test_protocol_sslv3(self):
  3031. """Connecting to an SSLv3 server with various client options"""
  3032. if support.verbose:
  3033. sys.stdout.write("\n")
  3034. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3')
  3035. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_OPTIONAL)
  3036. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv3, 'SSLv3', ssl.CERT_REQUIRED)
  3037. if has_tls_version('SSLv2'):
  3038. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_SSLv2, False)
  3039. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLS, False,
  3040. client_options=ssl.OP_NO_SSLv3)
  3041. try_protocol_combo(ssl.PROTOCOL_SSLv3, ssl.PROTOCOL_TLSv1, False)
  3042. @requires_tls_version('TLSv1')
  3043. def test_protocol_tlsv1(self):
  3044. """Connecting to a TLSv1 server with various client options"""
  3045. if support.verbose:
  3046. sys.stdout.write("\n")
  3047. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1')
  3048. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_OPTIONAL)
  3049. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1, 'TLSv1', ssl.CERT_REQUIRED)
  3050. if has_tls_version('SSLv2'):
  3051. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv2, False)
  3052. if has_tls_version('SSLv3'):
  3053. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_SSLv3, False)
  3054. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLS, False,
  3055. client_options=ssl.OP_NO_TLSv1)
  3056. @requires_tls_version('TLSv1_1')
  3057. def test_protocol_tlsv1_1(self):
  3058. """Connecting to a TLSv1.1 server with various client options.
  3059. Testing against older TLS versions."""
  3060. if support.verbose:
  3061. sys.stdout.write("\n")
  3062. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
  3063. if has_tls_version('SSLv2'):
  3064. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv2, False)
  3065. if has_tls_version('SSLv3'):
  3066. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_SSLv3, False)
  3067. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLS, False,
  3068. client_options=ssl.OP_NO_TLSv1_1)
  3069. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1_1, 'TLSv1.1')
  3070. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_2, False)
  3071. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_1, False)
  3072. @requires_tls_version('TLSv1_2')
  3073. def test_protocol_tlsv1_2(self):
  3074. """Connecting to a TLSv1.2 server with various client options.
  3075. Testing against older TLS versions."""
  3076. if support.verbose:
  3077. sys.stdout.write("\n")
  3078. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2',
  3079. server_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,
  3080. client_options=ssl.OP_NO_SSLv3|ssl.OP_NO_SSLv2,)
  3081. if has_tls_version('SSLv2'):
  3082. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv2, False)
  3083. if has_tls_version('SSLv3'):
  3084. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_SSLv3, False)
  3085. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLS, False,
  3086. client_options=ssl.OP_NO_TLSv1_2)
  3087. try_protocol_combo(ssl.PROTOCOL_TLS, ssl.PROTOCOL_TLSv1_2, 'TLSv1.2')
  3088. if has_tls_protocol(ssl.PROTOCOL_TLSv1):
  3089. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1, False)
  3090. try_protocol_combo(ssl.PROTOCOL_TLSv1, ssl.PROTOCOL_TLSv1_2, False)
  3091. if has_tls_protocol(ssl.PROTOCOL_TLSv1_1):
  3092. try_protocol_combo(ssl.PROTOCOL_TLSv1_2, ssl.PROTOCOL_TLSv1_1, False)
  3093. try_protocol_combo(ssl.PROTOCOL_TLSv1_1, ssl.PROTOCOL_TLSv1_2, False)
  3094. def test_starttls(self):
  3095. """Switching from clear text to encrypted and back again."""
  3096. msgs = (b"msg 1", b"MSG 2", b"STARTTLS", b"MSG 3", b"msg 4", b"ENDTLS", b"msg 5", b"msg 6")
  3097. server = ThreadedEchoServer(CERTFILE,
  3098. starttls_server=True,
  3099. chatty=True,
  3100. connectionchatty=True)
  3101. wrapped = False
  3102. with server:
  3103. s = socket.socket()
  3104. s.setblocking(True)
  3105. s.connect((HOST, server.port))
  3106. if support.verbose:
  3107. sys.stdout.write("\n")
  3108. for indata in msgs:
  3109. if support.verbose:
  3110. sys.stdout.write(
  3111. " client: sending %r...\n" % indata)
  3112. if wrapped:
  3113. conn.write(indata)
  3114. outdata = conn.read()
  3115. else:
  3116. s.send(indata)
  3117. outdata = s.recv(1024)
  3118. msg = outdata.strip().lower()
  3119. if indata == b"STARTTLS" and msg.startswith(b"ok"):
  3120. # STARTTLS ok, switch to secure mode
  3121. if support.verbose:
  3122. sys.stdout.write(
  3123. " client: read %r from server, starting TLS...\n"
  3124. % msg)
  3125. conn = test_wrap_socket(s)
  3126. wrapped = True
  3127. elif indata == b"ENDTLS" and msg.startswith(b"ok"):
  3128. # ENDTLS ok, switch back to clear text
  3129. if support.verbose:
  3130. sys.stdout.write(
  3131. " client: read %r from server, ending TLS...\n"
  3132. % msg)
  3133. s = conn.unwrap()
  3134. wrapped = False
  3135. else:
  3136. if support.verbose:
  3137. sys.stdout.write(
  3138. " client: read %r from server\n" % msg)
  3139. if support.verbose:
  3140. sys.stdout.write(" client: closing connection.\n")
  3141. if wrapped:
  3142. conn.write(b"over\n")
  3143. else:
  3144. s.send(b"over\n")
  3145. if wrapped:
  3146. conn.close()
  3147. else:
  3148. s.close()
  3149. def test_socketserver(self):
  3150. """Using socketserver to create and manage SSL connections."""
  3151. server = make_https_server(self, certfile=SIGNED_CERTFILE)
  3152. # try to connect
  3153. if support.verbose:
  3154. sys.stdout.write('\n')
  3155. with open(CERTFILE, 'rb') as f:
  3156. d1 = f.read()
  3157. d2 = ''
  3158. # now fetch the same data from the HTTPS server
  3159. url = 'https://localhost:%d/%s' % (
  3160. server.port, os.path.split(CERTFILE)[1])
  3161. context = ssl.create_default_context(cafile=SIGNING_CA)
  3162. f = urllib.request.urlopen(url, context=context)
  3163. try:
  3164. dlen = f.info().get("content-length")
  3165. if dlen and (int(dlen) > 0):
  3166. d2 = f.read(int(dlen))
  3167. if support.verbose:
  3168. sys.stdout.write(
  3169. " client: read %d bytes from remote server '%s'\n"
  3170. % (len(d2), server))
  3171. finally:
  3172. f.close()
  3173. self.assertEqual(d1, d2)
  3174. def test_asyncore_server(self):
  3175. """Check the example asyncore integration."""
  3176. if support.verbose:
  3177. sys.stdout.write("\n")
  3178. indata = b"FOO\n"
  3179. server = AsyncoreEchoServer(CERTFILE)
  3180. with server:
  3181. s = test_wrap_socket(socket.socket())
  3182. s.connect(('127.0.0.1', server.port))
  3183. if support.verbose:
  3184. sys.stdout.write(
  3185. " client: sending %r...\n" % indata)
  3186. s.write(indata)
  3187. outdata = s.read()
  3188. if support.verbose:
  3189. sys.stdout.write(" client: read %r\n" % outdata)
  3190. if outdata != indata.lower():
  3191. self.fail(
  3192. "bad data <<%r>> (%d) received; expected <<%r>> (%d)\n"
  3193. % (outdata[:20], len(outdata),
  3194. indata[:20].lower(), len(indata)))
  3195. s.write(b"over\n")
  3196. if support.verbose:
  3197. sys.stdout.write(" client: closing connection.\n")
  3198. s.close()
  3199. if support.verbose:
  3200. sys.stdout.write(" client: connection closed.\n")
  3201. def test_recv_send(self):
  3202. """Test recv(), send() and friends."""
  3203. if support.verbose:
  3204. sys.stdout.write("\n")
  3205. server = ThreadedEchoServer(CERTFILE,
  3206. certreqs=ssl.CERT_NONE,
  3207. ssl_version=ssl.PROTOCOL_TLS_SERVER,
  3208. cacerts=CERTFILE,
  3209. chatty=True,
  3210. connectionchatty=False)
  3211. with server:
  3212. s = test_wrap_socket(socket.socket(),
  3213. server_side=False,
  3214. certfile=CERTFILE,
  3215. ca_certs=CERTFILE,
  3216. cert_reqs=ssl.CERT_NONE)
  3217. s.connect((HOST, server.port))
  3218. # helper methods for standardising recv* method signatures
  3219. def _recv_into():
  3220. b = bytearray(b"\0"*100)
  3221. count = s.recv_into(b)
  3222. return b[:count]
  3223. def _recvfrom_into():
  3224. b = bytearray(b"\0"*100)
  3225. count, addr = s.recvfrom_into(b)
  3226. return b[:count]
  3227. # (name, method, expect success?, *args, return value func)
  3228. send_methods = [
  3229. ('send', s.send, True, [], len),
  3230. ('sendto', s.sendto, False, ["some.address"], len),
  3231. ('sendall', s.sendall, True, [], lambda x: None),
  3232. ]
  3233. # (name, method, whether to expect success, *args)
  3234. recv_methods = [
  3235. ('recv', s.recv, True, []),
  3236. ('recvfrom', s.recvfrom, False, ["some.address"]),
  3237. ('recv_into', _recv_into, True, []),
  3238. ('recvfrom_into', _recvfrom_into, False, []),
  3239. ]
  3240. data_prefix = "PREFIX_"
  3241. for (meth_name, send_meth, expect_success, args,
  3242. ret_val_meth) in send_methods:
  3243. indata = (data_prefix + meth_name).encode('ascii')
  3244. try:
  3245. ret = send_meth(indata, *args)
  3246. msg = "sending with {}".format(meth_name)
  3247. self.assertEqual(ret, ret_val_meth(indata), msg=msg)
  3248. outdata = s.read()
  3249. if outdata != indata.lower():
  3250. self.fail(
  3251. "While sending with <<{name:s}>> bad data "
  3252. "<<{outdata:r}>> ({nout:d}) received; "
  3253. "expected <<{indata:r}>> ({nin:d})\n".format(
  3254. name=meth_name, outdata=outdata[:20],
  3255. nout=len(outdata),
  3256. indata=indata[:20], nin=len(indata)
  3257. )
  3258. )
  3259. except ValueError as e:
  3260. if expect_success:
  3261. self.fail(
  3262. "Failed to send with method <<{name:s}>>; "
  3263. "expected to succeed.\n".format(name=meth_name)
  3264. )
  3265. if not str(e).startswith(meth_name):
  3266. self.fail(
  3267. "Method <<{name:s}>> failed with unexpected "
  3268. "exception message: {exp:s}\n".format(
  3269. name=meth_name, exp=e
  3270. )
  3271. )
  3272. for meth_name, recv_meth, expect_success, args in recv_methods:
  3273. indata = (data_prefix + meth_name).encode('ascii')
  3274. try:
  3275. s.send(indata)
  3276. outdata = recv_meth(*args)
  3277. if outdata != indata.lower():
  3278. self.fail(
  3279. "While receiving with <<{name:s}>> bad data "
  3280. "<<{outdata:r}>> ({nout:d}) received; "
  3281. "expected <<{indata:r}>> ({nin:d})\n".format(
  3282. name=meth_name, outdata=outdata[:20],
  3283. nout=len(outdata),
  3284. indata=indata[:20], nin=len(indata)
  3285. )
  3286. )
  3287. except ValueError as e:
  3288. if expect_success:
  3289. self.fail(
  3290. "Failed to receive with method <<{name:s}>>; "
  3291. "expected to succeed.\n".format(name=meth_name)
  3292. )
  3293. if not str(e).startswith(meth_name):
  3294. self.fail(
  3295. "Method <<{name:s}>> failed with unexpected "
  3296. "exception message: {exp:s}\n".format(
  3297. name=meth_name, exp=e
  3298. )
  3299. )
  3300. # consume data
  3301. s.read()
  3302. # read(-1, buffer) is supported, even though read(-1) is not
  3303. data = b"data"
  3304. s.send(data)
  3305. buffer = bytearray(len(data))
  3306. self.assertEqual(s.read(-1, buffer), len(data))
  3307. self.assertEqual(buffer, data)
  3308. # sendall accepts bytes-like objects
  3309. if ctypes is not None:
  3310. ubyte = ctypes.c_ubyte * len(data)
  3311. byteslike = ubyte.from_buffer_copy(data)
  3312. s.sendall(byteslike)
  3313. self.assertEqual(s.read(), data)
  3314. # Make sure sendmsg et al are disallowed to avoid
  3315. # inadvertent disclosure of data and/or corruption
  3316. # of the encrypted data stream
  3317. self.assertRaises(NotImplementedError, s.dup)
  3318. self.assertRaises(NotImplementedError, s.sendmsg, [b"data"])
  3319. self.assertRaises(NotImplementedError, s.recvmsg, 100)
  3320. self.assertRaises(NotImplementedError,
  3321. s.recvmsg_into, [bytearray(100)])
  3322. s.write(b"over\n")
  3323. self.assertRaises(ValueError, s.recv, -1)
  3324. self.assertRaises(ValueError, s.read, -1)
  3325. s.close()
  3326. def test_recv_zero(self):
  3327. server = ThreadedEchoServer(CERTFILE)
  3328. self.enterContext(server)
  3329. s = socket.create_connection((HOST, server.port))
  3330. self.addCleanup(s.close)
  3331. s = test_wrap_socket(s, suppress_ragged_eofs=False)
  3332. self.addCleanup(s.close)
  3333. # recv/read(0) should return no data
  3334. s.send(b"data")
  3335. self.assertEqual(s.recv(0), b"")
  3336. self.assertEqual(s.read(0), b"")
  3337. self.assertEqual(s.read(), b"data")
  3338. # Should not block if the other end sends no data
  3339. s.setblocking(False)
  3340. self.assertEqual(s.recv(0), b"")
  3341. self.assertEqual(s.recv_into(bytearray()), 0)
  3342. def test_nonblocking_send(self):
  3343. server = ThreadedEchoServer(CERTFILE,
  3344. certreqs=ssl.CERT_NONE,
  3345. ssl_version=ssl.PROTOCOL_TLS_SERVER,
  3346. cacerts=CERTFILE,
  3347. chatty=True,
  3348. connectionchatty=False)
  3349. with server:
  3350. s = test_wrap_socket(socket.socket(),
  3351. server_side=False,
  3352. certfile=CERTFILE,
  3353. ca_certs=CERTFILE,
  3354. cert_reqs=ssl.CERT_NONE)
  3355. s.connect((HOST, server.port))
  3356. s.setblocking(False)
  3357. # If we keep sending data, at some point the buffers
  3358. # will be full and the call will block
  3359. buf = bytearray(8192)
  3360. def fill_buffer():
  3361. while True:
  3362. s.send(buf)
  3363. self.assertRaises((ssl.SSLWantWriteError,
  3364. ssl.SSLWantReadError), fill_buffer)
  3365. # Now read all the output and discard it
  3366. s.setblocking(True)
  3367. s.close()
  3368. def test_handshake_timeout(self):
  3369. # Issue #5103: SSL handshake must respect the socket timeout
  3370. server = socket.socket(socket.AF_INET)
  3371. host = "127.0.0.1"
  3372. port = socket_helper.bind_port(server)
  3373. started = threading.Event()
  3374. finish = False
  3375. def serve():
  3376. server.listen()
  3377. started.set()
  3378. conns = []
  3379. while not finish:
  3380. r, w, e = select.select([server], [], [], 0.1)
  3381. if server in r:
  3382. # Let the socket hang around rather than having
  3383. # it closed by garbage collection.
  3384. conns.append(server.accept()[0])
  3385. for sock in conns:
  3386. sock.close()
  3387. t = threading.Thread(target=serve)
  3388. t.start()
  3389. started.wait()
  3390. try:
  3391. try:
  3392. c = socket.socket(socket.AF_INET)
  3393. c.settimeout(0.2)
  3394. c.connect((host, port))
  3395. # Will attempt handshake and time out
  3396. self.assertRaisesRegex(TimeoutError, "timed out",
  3397. test_wrap_socket, c)
  3398. finally:
  3399. c.close()
  3400. try:
  3401. c = socket.socket(socket.AF_INET)
  3402. c = test_wrap_socket(c)
  3403. c.settimeout(0.2)
  3404. # Will attempt handshake and time out
  3405. self.assertRaisesRegex(TimeoutError, "timed out",
  3406. c.connect, (host, port))
  3407. finally:
  3408. c.close()
  3409. finally:
  3410. finish = True
  3411. t.join()
  3412. server.close()
  3413. def test_server_accept(self):
  3414. # Issue #16357: accept() on a SSLSocket created through
  3415. # SSLContext.wrap_socket().
  3416. client_ctx, server_ctx, hostname = testing_context()
  3417. server = socket.socket(socket.AF_INET)
  3418. host = "127.0.0.1"
  3419. port = socket_helper.bind_port(server)
  3420. server = server_ctx.wrap_socket(server, server_side=True)
  3421. self.assertTrue(server.server_side)
  3422. evt = threading.Event()
  3423. remote = None
  3424. peer = None
  3425. def serve():
  3426. nonlocal remote, peer
  3427. server.listen()
  3428. # Block on the accept and wait on the connection to close.
  3429. evt.set()
  3430. remote, peer = server.accept()
  3431. remote.send(remote.recv(4))
  3432. t = threading.Thread(target=serve)
  3433. t.start()
  3434. # Client wait until server setup and perform a connect.
  3435. evt.wait()
  3436. client = client_ctx.wrap_socket(
  3437. socket.socket(), server_hostname=hostname
  3438. )
  3439. client.connect((hostname, port))
  3440. client.send(b'data')
  3441. client.recv()
  3442. client_addr = client.getsockname()
  3443. client.close()
  3444. t.join()
  3445. remote.close()
  3446. server.close()
  3447. # Sanity checks.
  3448. self.assertIsInstance(remote, ssl.SSLSocket)
  3449. self.assertEqual(peer, client_addr)
  3450. def test_getpeercert_enotconn(self):
  3451. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  3452. context.check_hostname = False
  3453. with context.wrap_socket(socket.socket()) as sock:
  3454. with self.assertRaises(OSError) as cm:
  3455. sock.getpeercert()
  3456. self.assertEqual(cm.exception.errno, errno.ENOTCONN)
  3457. def test_do_handshake_enotconn(self):
  3458. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  3459. context.check_hostname = False
  3460. with context.wrap_socket(socket.socket()) as sock:
  3461. with self.assertRaises(OSError) as cm:
  3462. sock.do_handshake()
  3463. self.assertEqual(cm.exception.errno, errno.ENOTCONN)
  3464. def test_no_shared_ciphers(self):
  3465. client_context, server_context, hostname = testing_context()
  3466. # OpenSSL enables all TLS 1.3 ciphers, enforce TLS 1.2 for test
  3467. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3468. # Force different suites on client and server
  3469. client_context.set_ciphers("AES128")
  3470. server_context.set_ciphers("AES256")
  3471. with ThreadedEchoServer(context=server_context) as server:
  3472. with client_context.wrap_socket(socket.socket(),
  3473. server_hostname=hostname) as s:
  3474. with self.assertRaises(OSError):
  3475. s.connect((HOST, server.port))
  3476. self.assertIn("no shared cipher", server.conn_errors[0])
  3477. def test_version_basic(self):
  3478. """
  3479. Basic tests for SSLSocket.version().
  3480. More tests are done in the test_protocol_*() methods.
  3481. """
  3482. context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  3483. context.check_hostname = False
  3484. context.verify_mode = ssl.CERT_NONE
  3485. with ThreadedEchoServer(CERTFILE,
  3486. ssl_version=ssl.PROTOCOL_TLS_SERVER,
  3487. chatty=False) as server:
  3488. with context.wrap_socket(socket.socket()) as s:
  3489. self.assertIs(s.version(), None)
  3490. self.assertIs(s._sslobj, None)
  3491. s.connect((HOST, server.port))
  3492. self.assertEqual(s.version(), 'TLSv1.3')
  3493. self.assertIs(s._sslobj, None)
  3494. self.assertIs(s.version(), None)
  3495. @requires_tls_version('TLSv1_3')
  3496. def test_tls1_3(self):
  3497. client_context, server_context, hostname = testing_context()
  3498. client_context.minimum_version = ssl.TLSVersion.TLSv1_3
  3499. with ThreadedEchoServer(context=server_context) as server:
  3500. with client_context.wrap_socket(socket.socket(),
  3501. server_hostname=hostname) as s:
  3502. s.connect((HOST, server.port))
  3503. self.assertIn(s.cipher()[0], {
  3504. 'TLS_AES_256_GCM_SHA384',
  3505. 'TLS_CHACHA20_POLY1305_SHA256',
  3506. 'TLS_AES_128_GCM_SHA256',
  3507. })
  3508. self.assertEqual(s.version(), 'TLSv1.3')
  3509. @requires_tls_version('TLSv1_2')
  3510. @requires_tls_version('TLSv1')
  3511. @ignore_deprecation
  3512. def test_min_max_version_tlsv1_2(self):
  3513. client_context, server_context, hostname = testing_context()
  3514. # client TLSv1.0 to 1.2
  3515. client_context.minimum_version = ssl.TLSVersion.TLSv1
  3516. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3517. # server only TLSv1.2
  3518. server_context.minimum_version = ssl.TLSVersion.TLSv1_2
  3519. server_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3520. with ThreadedEchoServer(context=server_context) as server:
  3521. with client_context.wrap_socket(socket.socket(),
  3522. server_hostname=hostname) as s:
  3523. s.connect((HOST, server.port))
  3524. self.assertEqual(s.version(), 'TLSv1.2')
  3525. @requires_tls_version('TLSv1_1')
  3526. @ignore_deprecation
  3527. def test_min_max_version_tlsv1_1(self):
  3528. client_context, server_context, hostname = testing_context()
  3529. # client 1.0 to 1.2, server 1.0 to 1.1
  3530. client_context.minimum_version = ssl.TLSVersion.TLSv1
  3531. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3532. server_context.minimum_version = ssl.TLSVersion.TLSv1
  3533. server_context.maximum_version = ssl.TLSVersion.TLSv1_1
  3534. seclevel_workaround(client_context, server_context)
  3535. with ThreadedEchoServer(context=server_context) as server:
  3536. with client_context.wrap_socket(socket.socket(),
  3537. server_hostname=hostname) as s:
  3538. s.connect((HOST, server.port))
  3539. self.assertEqual(s.version(), 'TLSv1.1')
  3540. @requires_tls_version('TLSv1_2')
  3541. @requires_tls_version('TLSv1')
  3542. @ignore_deprecation
  3543. def test_min_max_version_mismatch(self):
  3544. client_context, server_context, hostname = testing_context()
  3545. # client 1.0, server 1.2 (mismatch)
  3546. server_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3547. server_context.minimum_version = ssl.TLSVersion.TLSv1_2
  3548. client_context.maximum_version = ssl.TLSVersion.TLSv1
  3549. client_context.minimum_version = ssl.TLSVersion.TLSv1
  3550. seclevel_workaround(client_context, server_context)
  3551. with ThreadedEchoServer(context=server_context) as server:
  3552. with client_context.wrap_socket(socket.socket(),
  3553. server_hostname=hostname) as s:
  3554. with self.assertRaises(ssl.SSLError) as e:
  3555. s.connect((HOST, server.port))
  3556. self.assertIn("alert", str(e.exception))
  3557. @requires_tls_version('SSLv3')
  3558. def test_min_max_version_sslv3(self):
  3559. client_context, server_context, hostname = testing_context()
  3560. server_context.minimum_version = ssl.TLSVersion.SSLv3
  3561. client_context.minimum_version = ssl.TLSVersion.SSLv3
  3562. client_context.maximum_version = ssl.TLSVersion.SSLv3
  3563. seclevel_workaround(client_context, server_context)
  3564. with ThreadedEchoServer(context=server_context) as server:
  3565. with client_context.wrap_socket(socket.socket(),
  3566. server_hostname=hostname) as s:
  3567. s.connect((HOST, server.port))
  3568. self.assertEqual(s.version(), 'SSLv3')
  3569. def test_default_ecdh_curve(self):
  3570. # Issue #21015: elliptic curve-based Diffie Hellman key exchange
  3571. # should be enabled by default on SSL contexts.
  3572. client_context, server_context, hostname = testing_context()
  3573. # TLSv1.3 defaults to PFS key agreement and no longer has KEA in
  3574. # cipher name.
  3575. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3576. # Prior to OpenSSL 1.0.0, ECDH ciphers have to be enabled
  3577. # explicitly using the 'ECCdraft' cipher alias. Otherwise,
  3578. # our default cipher list should prefer ECDH-based ciphers
  3579. # automatically.
  3580. with ThreadedEchoServer(context=server_context) as server:
  3581. with client_context.wrap_socket(socket.socket(),
  3582. server_hostname=hostname) as s:
  3583. s.connect((HOST, server.port))
  3584. self.assertIn("ECDH", s.cipher()[0])
  3585. @unittest.skipUnless("tls-unique" in ssl.CHANNEL_BINDING_TYPES,
  3586. "'tls-unique' channel binding not available")
  3587. def test_tls_unique_channel_binding(self):
  3588. """Test tls-unique channel binding."""
  3589. if support.verbose:
  3590. sys.stdout.write("\n")
  3591. client_context, server_context, hostname = testing_context()
  3592. server = ThreadedEchoServer(context=server_context,
  3593. chatty=True,
  3594. connectionchatty=False)
  3595. with server:
  3596. with client_context.wrap_socket(
  3597. socket.socket(),
  3598. server_hostname=hostname) as s:
  3599. s.connect((HOST, server.port))
  3600. # get the data
  3601. cb_data = s.get_channel_binding("tls-unique")
  3602. if support.verbose:
  3603. sys.stdout.write(
  3604. " got channel binding data: {0!r}\n".format(cb_data))
  3605. # check if it is sane
  3606. self.assertIsNotNone(cb_data)
  3607. if s.version() == 'TLSv1.3':
  3608. self.assertEqual(len(cb_data), 48)
  3609. else:
  3610. self.assertEqual(len(cb_data), 12) # True for TLSv1
  3611. # and compare with the peers version
  3612. s.write(b"CB tls-unique\n")
  3613. peer_data_repr = s.read().strip()
  3614. self.assertEqual(peer_data_repr,
  3615. repr(cb_data).encode("us-ascii"))
  3616. # now, again
  3617. with client_context.wrap_socket(
  3618. socket.socket(),
  3619. server_hostname=hostname) as s:
  3620. s.connect((HOST, server.port))
  3621. new_cb_data = s.get_channel_binding("tls-unique")
  3622. if support.verbose:
  3623. sys.stdout.write(
  3624. "got another channel binding data: {0!r}\n".format(
  3625. new_cb_data)
  3626. )
  3627. # is it really unique
  3628. self.assertNotEqual(cb_data, new_cb_data)
  3629. self.assertIsNotNone(cb_data)
  3630. if s.version() == 'TLSv1.3':
  3631. self.assertEqual(len(cb_data), 48)
  3632. else:
  3633. self.assertEqual(len(cb_data), 12) # True for TLSv1
  3634. s.write(b"CB tls-unique\n")
  3635. peer_data_repr = s.read().strip()
  3636. self.assertEqual(peer_data_repr,
  3637. repr(new_cb_data).encode("us-ascii"))
  3638. def test_compression(self):
  3639. client_context, server_context, hostname = testing_context()
  3640. stats = server_params_test(client_context, server_context,
  3641. chatty=True, connectionchatty=True,
  3642. sni_name=hostname)
  3643. if support.verbose:
  3644. sys.stdout.write(" got compression: {!r}\n".format(stats['compression']))
  3645. self.assertIn(stats['compression'], { None, 'ZLIB', 'RLE' })
  3646. @unittest.skipUnless(hasattr(ssl, 'OP_NO_COMPRESSION'),
  3647. "ssl.OP_NO_COMPRESSION needed for this test")
  3648. def test_compression_disabled(self):
  3649. client_context, server_context, hostname = testing_context()
  3650. client_context.options |= ssl.OP_NO_COMPRESSION
  3651. server_context.options |= ssl.OP_NO_COMPRESSION
  3652. stats = server_params_test(client_context, server_context,
  3653. chatty=True, connectionchatty=True,
  3654. sni_name=hostname)
  3655. self.assertIs(stats['compression'], None)
  3656. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  3657. def test_dh_params(self):
  3658. # Check we can get a connection with ephemeral Diffie-Hellman
  3659. client_context, server_context, hostname = testing_context()
  3660. # test scenario needs TLS <= 1.2
  3661. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3662. server_context.load_dh_params(DHFILE)
  3663. server_context.set_ciphers("kEDH")
  3664. server_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3665. stats = server_params_test(client_context, server_context,
  3666. chatty=True, connectionchatty=True,
  3667. sni_name=hostname)
  3668. cipher = stats["cipher"][0]
  3669. parts = cipher.split("-")
  3670. if "ADH" not in parts and "EDH" not in parts and "DHE" not in parts:
  3671. self.fail("Non-DH cipher: " + cipher[0])
  3672. def test_ecdh_curve(self):
  3673. # server secp384r1, client auto
  3674. client_context, server_context, hostname = testing_context()
  3675. server_context.set_ecdh_curve("secp384r1")
  3676. server_context.set_ciphers("ECDHE:!eNULL:!aNULL")
  3677. server_context.minimum_version = ssl.TLSVersion.TLSv1_2
  3678. stats = server_params_test(client_context, server_context,
  3679. chatty=True, connectionchatty=True,
  3680. sni_name=hostname)
  3681. # server auto, client secp384r1
  3682. client_context, server_context, hostname = testing_context()
  3683. client_context.set_ecdh_curve("secp384r1")
  3684. server_context.set_ciphers("ECDHE:!eNULL:!aNULL")
  3685. server_context.minimum_version = ssl.TLSVersion.TLSv1_2
  3686. stats = server_params_test(client_context, server_context,
  3687. chatty=True, connectionchatty=True,
  3688. sni_name=hostname)
  3689. # server / client curve mismatch
  3690. client_context, server_context, hostname = testing_context()
  3691. client_context.set_ecdh_curve("prime256v1")
  3692. server_context.set_ecdh_curve("secp384r1")
  3693. server_context.set_ciphers("ECDHE:!eNULL:!aNULL")
  3694. server_context.minimum_version = ssl.TLSVersion.TLSv1_2
  3695. with self.assertRaises(ssl.SSLError):
  3696. server_params_test(client_context, server_context,
  3697. chatty=True, connectionchatty=True,
  3698. sni_name=hostname)
  3699. def test_selected_alpn_protocol(self):
  3700. # selected_alpn_protocol() is None unless ALPN is used.
  3701. client_context, server_context, hostname = testing_context()
  3702. stats = server_params_test(client_context, server_context,
  3703. chatty=True, connectionchatty=True,
  3704. sni_name=hostname)
  3705. self.assertIs(stats['client_alpn_protocol'], None)
  3706. def test_selected_alpn_protocol_if_server_uses_alpn(self):
  3707. # selected_alpn_protocol() is None unless ALPN is used by the client.
  3708. client_context, server_context, hostname = testing_context()
  3709. server_context.set_alpn_protocols(['foo', 'bar'])
  3710. stats = server_params_test(client_context, server_context,
  3711. chatty=True, connectionchatty=True,
  3712. sni_name=hostname)
  3713. self.assertIs(stats['client_alpn_protocol'], None)
  3714. def test_alpn_protocols(self):
  3715. server_protocols = ['foo', 'bar', 'milkshake']
  3716. protocol_tests = [
  3717. (['foo', 'bar'], 'foo'),
  3718. (['bar', 'foo'], 'foo'),
  3719. (['milkshake'], 'milkshake'),
  3720. (['http/3.0', 'http/4.0'], None)
  3721. ]
  3722. for client_protocols, expected in protocol_tests:
  3723. client_context, server_context, hostname = testing_context()
  3724. server_context.set_alpn_protocols(server_protocols)
  3725. client_context.set_alpn_protocols(client_protocols)
  3726. try:
  3727. stats = server_params_test(client_context,
  3728. server_context,
  3729. chatty=True,
  3730. connectionchatty=True,
  3731. sni_name=hostname)
  3732. except ssl.SSLError as e:
  3733. stats = e
  3734. msg = "failed trying %s (s) and %s (c).\n" \
  3735. "was expecting %s, but got %%s from the %%s" \
  3736. % (str(server_protocols), str(client_protocols),
  3737. str(expected))
  3738. client_result = stats['client_alpn_protocol']
  3739. self.assertEqual(client_result, expected,
  3740. msg % (client_result, "client"))
  3741. server_result = stats['server_alpn_protocols'][-1] \
  3742. if len(stats['server_alpn_protocols']) else 'nothing'
  3743. self.assertEqual(server_result, expected,
  3744. msg % (server_result, "server"))
  3745. def test_npn_protocols(self):
  3746. assert not ssl.HAS_NPN
  3747. def sni_contexts(self):
  3748. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  3749. server_context.load_cert_chain(SIGNED_CERTFILE)
  3750. other_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  3751. other_context.load_cert_chain(SIGNED_CERTFILE2)
  3752. client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  3753. client_context.load_verify_locations(SIGNING_CA)
  3754. return server_context, other_context, client_context
  3755. def check_common_name(self, stats, name):
  3756. cert = stats['peercert']
  3757. self.assertIn((('commonName', name),), cert['subject'])
  3758. def test_sni_callback(self):
  3759. calls = []
  3760. server_context, other_context, client_context = self.sni_contexts()
  3761. client_context.check_hostname = False
  3762. def servername_cb(ssl_sock, server_name, initial_context):
  3763. calls.append((server_name, initial_context))
  3764. if server_name is not None:
  3765. ssl_sock.context = other_context
  3766. server_context.set_servername_callback(servername_cb)
  3767. stats = server_params_test(client_context, server_context,
  3768. chatty=True,
  3769. sni_name='supermessage')
  3770. # The hostname was fetched properly, and the certificate was
  3771. # changed for the connection.
  3772. self.assertEqual(calls, [("supermessage", server_context)])
  3773. # CERTFILE4 was selected
  3774. self.check_common_name(stats, 'fakehostname')
  3775. calls = []
  3776. # The callback is called with server_name=None
  3777. stats = server_params_test(client_context, server_context,
  3778. chatty=True,
  3779. sni_name=None)
  3780. self.assertEqual(calls, [(None, server_context)])
  3781. self.check_common_name(stats, SIGNED_CERTFILE_HOSTNAME)
  3782. # Check disabling the callback
  3783. calls = []
  3784. server_context.set_servername_callback(None)
  3785. stats = server_params_test(client_context, server_context,
  3786. chatty=True,
  3787. sni_name='notfunny')
  3788. # Certificate didn't change
  3789. self.check_common_name(stats, SIGNED_CERTFILE_HOSTNAME)
  3790. self.assertEqual(calls, [])
  3791. def test_sni_callback_alert(self):
  3792. # Returning a TLS alert is reflected to the connecting client
  3793. server_context, other_context, client_context = self.sni_contexts()
  3794. def cb_returning_alert(ssl_sock, server_name, initial_context):
  3795. return ssl.ALERT_DESCRIPTION_ACCESS_DENIED
  3796. server_context.set_servername_callback(cb_returning_alert)
  3797. with self.assertRaises(ssl.SSLError) as cm:
  3798. stats = server_params_test(client_context, server_context,
  3799. chatty=False,
  3800. sni_name='supermessage')
  3801. self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_ACCESS_DENIED')
  3802. def test_sni_callback_raising(self):
  3803. # Raising fails the connection with a TLS handshake failure alert.
  3804. server_context, other_context, client_context = self.sni_contexts()
  3805. def cb_raising(ssl_sock, server_name, initial_context):
  3806. 1/0
  3807. server_context.set_servername_callback(cb_raising)
  3808. with support.catch_unraisable_exception() as catch:
  3809. with self.assertRaises(ssl.SSLError) as cm:
  3810. stats = server_params_test(client_context, server_context,
  3811. chatty=False,
  3812. sni_name='supermessage')
  3813. self.assertEqual(cm.exception.reason,
  3814. 'SSLV3_ALERT_HANDSHAKE_FAILURE')
  3815. self.assertEqual(catch.unraisable.exc_type, ZeroDivisionError)
  3816. def test_sni_callback_wrong_return_type(self):
  3817. # Returning the wrong return type terminates the TLS connection
  3818. # with an internal error alert.
  3819. server_context, other_context, client_context = self.sni_contexts()
  3820. def cb_wrong_return_type(ssl_sock, server_name, initial_context):
  3821. return "foo"
  3822. server_context.set_servername_callback(cb_wrong_return_type)
  3823. with support.catch_unraisable_exception() as catch:
  3824. with self.assertRaises(ssl.SSLError) as cm:
  3825. stats = server_params_test(client_context, server_context,
  3826. chatty=False,
  3827. sni_name='supermessage')
  3828. self.assertEqual(cm.exception.reason, 'TLSV1_ALERT_INTERNAL_ERROR')
  3829. self.assertEqual(catch.unraisable.exc_type, TypeError)
  3830. def test_shared_ciphers(self):
  3831. client_context, server_context, hostname = testing_context()
  3832. client_context.set_ciphers("AES128:AES256")
  3833. server_context.set_ciphers("AES256")
  3834. expected_algs = [
  3835. "AES256", "AES-256",
  3836. # TLS 1.3 ciphers are always enabled
  3837. "TLS_CHACHA20", "TLS_AES",
  3838. ]
  3839. stats = server_params_test(client_context, server_context,
  3840. sni_name=hostname)
  3841. ciphers = stats['server_shared_ciphers'][0]
  3842. self.assertGreater(len(ciphers), 0)
  3843. for name, tls_version, bits in ciphers:
  3844. if not any(alg in name for alg in expected_algs):
  3845. self.fail(name)
  3846. def test_read_write_after_close_raises_valuerror(self):
  3847. client_context, server_context, hostname = testing_context()
  3848. server = ThreadedEchoServer(context=server_context, chatty=False)
  3849. with server:
  3850. s = client_context.wrap_socket(socket.socket(),
  3851. server_hostname=hostname)
  3852. s.connect((HOST, server.port))
  3853. s.close()
  3854. self.assertRaises(ValueError, s.read, 1024)
  3855. self.assertRaises(ValueError, s.write, b'hello')
  3856. def test_sendfile(self):
  3857. TEST_DATA = b"x" * 512
  3858. with open(os_helper.TESTFN, 'wb') as f:
  3859. f.write(TEST_DATA)
  3860. self.addCleanup(os_helper.unlink, os_helper.TESTFN)
  3861. client_context, server_context, hostname = testing_context()
  3862. server = ThreadedEchoServer(context=server_context, chatty=False)
  3863. with server:
  3864. with client_context.wrap_socket(socket.socket(),
  3865. server_hostname=hostname) as s:
  3866. s.connect((HOST, server.port))
  3867. with open(os_helper.TESTFN, 'rb') as file:
  3868. s.sendfile(file)
  3869. self.assertEqual(s.recv(1024), TEST_DATA)
  3870. def test_session(self):
  3871. client_context, server_context, hostname = testing_context()
  3872. # TODO: sessions aren't compatible with TLSv1.3 yet
  3873. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3874. # first connection without session
  3875. stats = server_params_test(client_context, server_context,
  3876. sni_name=hostname)
  3877. session = stats['session']
  3878. self.assertTrue(session.id)
  3879. self.assertGreater(session.time, 0)
  3880. self.assertGreater(session.timeout, 0)
  3881. self.assertTrue(session.has_ticket)
  3882. self.assertGreater(session.ticket_lifetime_hint, 0)
  3883. self.assertFalse(stats['session_reused'])
  3884. sess_stat = server_context.session_stats()
  3885. self.assertEqual(sess_stat['accept'], 1)
  3886. self.assertEqual(sess_stat['hits'], 0)
  3887. # reuse session
  3888. stats = server_params_test(client_context, server_context,
  3889. session=session, sni_name=hostname)
  3890. sess_stat = server_context.session_stats()
  3891. self.assertEqual(sess_stat['accept'], 2)
  3892. self.assertEqual(sess_stat['hits'], 1)
  3893. self.assertTrue(stats['session_reused'])
  3894. session2 = stats['session']
  3895. self.assertEqual(session2.id, session.id)
  3896. self.assertEqual(session2, session)
  3897. self.assertIsNot(session2, session)
  3898. self.assertGreaterEqual(session2.time, session.time)
  3899. self.assertGreaterEqual(session2.timeout, session.timeout)
  3900. # another one without session
  3901. stats = server_params_test(client_context, server_context,
  3902. sni_name=hostname)
  3903. self.assertFalse(stats['session_reused'])
  3904. session3 = stats['session']
  3905. self.assertNotEqual(session3.id, session.id)
  3906. self.assertNotEqual(session3, session)
  3907. sess_stat = server_context.session_stats()
  3908. self.assertEqual(sess_stat['accept'], 3)
  3909. self.assertEqual(sess_stat['hits'], 1)
  3910. # reuse session again
  3911. stats = server_params_test(client_context, server_context,
  3912. session=session, sni_name=hostname)
  3913. self.assertTrue(stats['session_reused'])
  3914. session4 = stats['session']
  3915. self.assertEqual(session4.id, session.id)
  3916. self.assertEqual(session4, session)
  3917. self.assertGreaterEqual(session4.time, session.time)
  3918. self.assertGreaterEqual(session4.timeout, session.timeout)
  3919. sess_stat = server_context.session_stats()
  3920. self.assertEqual(sess_stat['accept'], 4)
  3921. self.assertEqual(sess_stat['hits'], 2)
  3922. def test_session_handling(self):
  3923. client_context, server_context, hostname = testing_context()
  3924. client_context2, _, _ = testing_context()
  3925. # TODO: session reuse does not work with TLSv1.3
  3926. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  3927. client_context2.maximum_version = ssl.TLSVersion.TLSv1_2
  3928. server = ThreadedEchoServer(context=server_context, chatty=False)
  3929. with server:
  3930. with client_context.wrap_socket(socket.socket(),
  3931. server_hostname=hostname) as s:
  3932. # session is None before handshake
  3933. self.assertEqual(s.session, None)
  3934. self.assertEqual(s.session_reused, None)
  3935. s.connect((HOST, server.port))
  3936. session = s.session
  3937. self.assertTrue(session)
  3938. with self.assertRaises(TypeError) as e:
  3939. s.session = object
  3940. self.assertEqual(str(e.exception), 'Value is not a SSLSession.')
  3941. with client_context.wrap_socket(socket.socket(),
  3942. server_hostname=hostname) as s:
  3943. s.connect((HOST, server.port))
  3944. # cannot set session after handshake
  3945. with self.assertRaises(ValueError) as e:
  3946. s.session = session
  3947. self.assertEqual(str(e.exception),
  3948. 'Cannot set session after handshake.')
  3949. with client_context.wrap_socket(socket.socket(),
  3950. server_hostname=hostname) as s:
  3951. # can set session before handshake and before the
  3952. # connection was established
  3953. s.session = session
  3954. s.connect((HOST, server.port))
  3955. self.assertEqual(s.session.id, session.id)
  3956. self.assertEqual(s.session, session)
  3957. self.assertEqual(s.session_reused, True)
  3958. with client_context2.wrap_socket(socket.socket(),
  3959. server_hostname=hostname) as s:
  3960. # cannot re-use session with a different SSLContext
  3961. with self.assertRaises(ValueError) as e:
  3962. s.session = session
  3963. s.connect((HOST, server.port))
  3964. self.assertEqual(str(e.exception),
  3965. 'Session refers to a different SSLContext.')
  3966. @unittest.skipUnless(has_tls_version('TLSv1_3'), "Test needs TLS 1.3")
  3967. class TestPostHandshakeAuth(unittest.TestCase):
  3968. def test_pha_setter(self):
  3969. protocols = [
  3970. ssl.PROTOCOL_TLS_SERVER, ssl.PROTOCOL_TLS_CLIENT
  3971. ]
  3972. for protocol in protocols:
  3973. ctx = ssl.SSLContext(protocol)
  3974. self.assertEqual(ctx.post_handshake_auth, False)
  3975. ctx.post_handshake_auth = True
  3976. self.assertEqual(ctx.post_handshake_auth, True)
  3977. ctx.verify_mode = ssl.CERT_REQUIRED
  3978. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  3979. self.assertEqual(ctx.post_handshake_auth, True)
  3980. ctx.post_handshake_auth = False
  3981. self.assertEqual(ctx.verify_mode, ssl.CERT_REQUIRED)
  3982. self.assertEqual(ctx.post_handshake_auth, False)
  3983. ctx.verify_mode = ssl.CERT_OPTIONAL
  3984. ctx.post_handshake_auth = True
  3985. self.assertEqual(ctx.verify_mode, ssl.CERT_OPTIONAL)
  3986. self.assertEqual(ctx.post_handshake_auth, True)
  3987. def test_pha_required(self):
  3988. client_context, server_context, hostname = testing_context()
  3989. server_context.post_handshake_auth = True
  3990. server_context.verify_mode = ssl.CERT_REQUIRED
  3991. client_context.post_handshake_auth = True
  3992. client_context.load_cert_chain(SIGNED_CERTFILE)
  3993. server = ThreadedEchoServer(context=server_context, chatty=False)
  3994. with server:
  3995. with client_context.wrap_socket(socket.socket(),
  3996. server_hostname=hostname) as s:
  3997. s.connect((HOST, server.port))
  3998. s.write(b'HASCERT')
  3999. self.assertEqual(s.recv(1024), b'FALSE\n')
  4000. s.write(b'PHA')
  4001. self.assertEqual(s.recv(1024), b'OK\n')
  4002. s.write(b'HASCERT')
  4003. self.assertEqual(s.recv(1024), b'TRUE\n')
  4004. # PHA method just returns true when cert is already available
  4005. s.write(b'PHA')
  4006. self.assertEqual(s.recv(1024), b'OK\n')
  4007. s.write(b'GETCERT')
  4008. cert_text = s.recv(4096).decode('us-ascii')
  4009. self.assertIn('Python Software Foundation CA', cert_text)
  4010. def test_pha_required_nocert(self):
  4011. client_context, server_context, hostname = testing_context()
  4012. server_context.post_handshake_auth = True
  4013. server_context.verify_mode = ssl.CERT_REQUIRED
  4014. client_context.post_handshake_auth = True
  4015. def msg_cb(conn, direction, version, content_type, msg_type, data):
  4016. if support.verbose and content_type == _TLSContentType.ALERT:
  4017. info = (conn, direction, version, content_type, msg_type, data)
  4018. sys.stdout.write(f"TLS: {info!r}\n")
  4019. server_context._msg_callback = msg_cb
  4020. client_context._msg_callback = msg_cb
  4021. server = ThreadedEchoServer(context=server_context, chatty=True)
  4022. with server:
  4023. with client_context.wrap_socket(socket.socket(),
  4024. server_hostname=hostname,
  4025. suppress_ragged_eofs=False) as s:
  4026. s.connect((HOST, server.port))
  4027. s.write(b'PHA')
  4028. # test sometimes fails with EOF error. Test passes as long as
  4029. # server aborts connection with an error.
  4030. with self.assertRaisesRegex(
  4031. ssl.SSLError,
  4032. '(certificate required|EOF occurred)'
  4033. ):
  4034. # receive CertificateRequest
  4035. data = s.recv(1024)
  4036. self.assertEqual(data, b'OK\n')
  4037. # send empty Certificate + Finish
  4038. s.write(b'HASCERT')
  4039. # receive alert
  4040. s.recv(1024)
  4041. def test_pha_optional(self):
  4042. if support.verbose:
  4043. sys.stdout.write("\n")
  4044. client_context, server_context, hostname = testing_context()
  4045. server_context.post_handshake_auth = True
  4046. server_context.verify_mode = ssl.CERT_REQUIRED
  4047. client_context.post_handshake_auth = True
  4048. client_context.load_cert_chain(SIGNED_CERTFILE)
  4049. # check CERT_OPTIONAL
  4050. server_context.verify_mode = ssl.CERT_OPTIONAL
  4051. server = ThreadedEchoServer(context=server_context, chatty=False)
  4052. with server:
  4053. with client_context.wrap_socket(socket.socket(),
  4054. server_hostname=hostname) as s:
  4055. s.connect((HOST, server.port))
  4056. s.write(b'HASCERT')
  4057. self.assertEqual(s.recv(1024), b'FALSE\n')
  4058. s.write(b'PHA')
  4059. self.assertEqual(s.recv(1024), b'OK\n')
  4060. s.write(b'HASCERT')
  4061. self.assertEqual(s.recv(1024), b'TRUE\n')
  4062. def test_pha_optional_nocert(self):
  4063. if support.verbose:
  4064. sys.stdout.write("\n")
  4065. client_context, server_context, hostname = testing_context()
  4066. server_context.post_handshake_auth = True
  4067. server_context.verify_mode = ssl.CERT_OPTIONAL
  4068. client_context.post_handshake_auth = True
  4069. server = ThreadedEchoServer(context=server_context, chatty=False)
  4070. with server:
  4071. with client_context.wrap_socket(socket.socket(),
  4072. server_hostname=hostname) as s:
  4073. s.connect((HOST, server.port))
  4074. s.write(b'HASCERT')
  4075. self.assertEqual(s.recv(1024), b'FALSE\n')
  4076. s.write(b'PHA')
  4077. self.assertEqual(s.recv(1024), b'OK\n')
  4078. # optional doesn't fail when client does not have a cert
  4079. s.write(b'HASCERT')
  4080. self.assertEqual(s.recv(1024), b'FALSE\n')
  4081. def test_pha_no_pha_client(self):
  4082. client_context, server_context, hostname = testing_context()
  4083. server_context.post_handshake_auth = True
  4084. server_context.verify_mode = ssl.CERT_REQUIRED
  4085. client_context.load_cert_chain(SIGNED_CERTFILE)
  4086. server = ThreadedEchoServer(context=server_context, chatty=False)
  4087. with server:
  4088. with client_context.wrap_socket(socket.socket(),
  4089. server_hostname=hostname) as s:
  4090. s.connect((HOST, server.port))
  4091. with self.assertRaisesRegex(ssl.SSLError, 'not server'):
  4092. s.verify_client_post_handshake()
  4093. s.write(b'PHA')
  4094. self.assertIn(b'extension not received', s.recv(1024))
  4095. def test_pha_no_pha_server(self):
  4096. # server doesn't have PHA enabled, cert is requested in handshake
  4097. client_context, server_context, hostname = testing_context()
  4098. server_context.verify_mode = ssl.CERT_REQUIRED
  4099. client_context.post_handshake_auth = True
  4100. client_context.load_cert_chain(SIGNED_CERTFILE)
  4101. server = ThreadedEchoServer(context=server_context, chatty=False)
  4102. with server:
  4103. with client_context.wrap_socket(socket.socket(),
  4104. server_hostname=hostname) as s:
  4105. s.connect((HOST, server.port))
  4106. s.write(b'HASCERT')
  4107. self.assertEqual(s.recv(1024), b'TRUE\n')
  4108. # PHA doesn't fail if there is already a cert
  4109. s.write(b'PHA')
  4110. self.assertEqual(s.recv(1024), b'OK\n')
  4111. s.write(b'HASCERT')
  4112. self.assertEqual(s.recv(1024), b'TRUE\n')
  4113. def test_pha_not_tls13(self):
  4114. # TLS 1.2
  4115. client_context, server_context, hostname = testing_context()
  4116. server_context.verify_mode = ssl.CERT_REQUIRED
  4117. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  4118. client_context.post_handshake_auth = True
  4119. client_context.load_cert_chain(SIGNED_CERTFILE)
  4120. server = ThreadedEchoServer(context=server_context, chatty=False)
  4121. with server:
  4122. with client_context.wrap_socket(socket.socket(),
  4123. server_hostname=hostname) as s:
  4124. s.connect((HOST, server.port))
  4125. # PHA fails for TLS != 1.3
  4126. s.write(b'PHA')
  4127. self.assertIn(b'WRONG_SSL_VERSION', s.recv(1024))
  4128. def test_bpo37428_pha_cert_none(self):
  4129. # verify that post_handshake_auth does not implicitly enable cert
  4130. # validation.
  4131. hostname = SIGNED_CERTFILE_HOSTNAME
  4132. client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  4133. client_context.post_handshake_auth = True
  4134. client_context.load_cert_chain(SIGNED_CERTFILE)
  4135. # no cert validation and CA on client side
  4136. client_context.check_hostname = False
  4137. client_context.verify_mode = ssl.CERT_NONE
  4138. server_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  4139. server_context.load_cert_chain(SIGNED_CERTFILE)
  4140. server_context.load_verify_locations(SIGNING_CA)
  4141. server_context.post_handshake_auth = True
  4142. server_context.verify_mode = ssl.CERT_REQUIRED
  4143. server = ThreadedEchoServer(context=server_context, chatty=False)
  4144. with server:
  4145. with client_context.wrap_socket(socket.socket(),
  4146. server_hostname=hostname) as s:
  4147. s.connect((HOST, server.port))
  4148. s.write(b'HASCERT')
  4149. self.assertEqual(s.recv(1024), b'FALSE\n')
  4150. s.write(b'PHA')
  4151. self.assertEqual(s.recv(1024), b'OK\n')
  4152. s.write(b'HASCERT')
  4153. self.assertEqual(s.recv(1024), b'TRUE\n')
  4154. # server cert has not been validated
  4155. self.assertEqual(s.getpeercert(), {})
  4156. def test_internal_chain_client(self):
  4157. client_context, server_context, hostname = testing_context(
  4158. server_chain=False
  4159. )
  4160. server = ThreadedEchoServer(context=server_context, chatty=False)
  4161. with server:
  4162. with client_context.wrap_socket(
  4163. socket.socket(),
  4164. server_hostname=hostname
  4165. ) as s:
  4166. s.connect((HOST, server.port))
  4167. vc = s._sslobj.get_verified_chain()
  4168. self.assertEqual(len(vc), 2)
  4169. ee, ca = vc
  4170. uvc = s._sslobj.get_unverified_chain()
  4171. self.assertEqual(len(uvc), 1)
  4172. self.assertEqual(ee, uvc[0])
  4173. self.assertEqual(hash(ee), hash(uvc[0]))
  4174. self.assertEqual(repr(ee), repr(uvc[0]))
  4175. self.assertNotEqual(ee, ca)
  4176. self.assertNotEqual(hash(ee), hash(ca))
  4177. self.assertNotEqual(repr(ee), repr(ca))
  4178. self.assertNotEqual(ee.get_info(), ca.get_info())
  4179. self.assertIn("CN=localhost", repr(ee))
  4180. self.assertIn("CN=our-ca-server", repr(ca))
  4181. pem = ee.public_bytes(_ssl.ENCODING_PEM)
  4182. der = ee.public_bytes(_ssl.ENCODING_DER)
  4183. self.assertIsInstance(pem, str)
  4184. self.assertIn("-----BEGIN CERTIFICATE-----", pem)
  4185. self.assertIsInstance(der, bytes)
  4186. self.assertEqual(
  4187. ssl.PEM_cert_to_DER_cert(pem), der
  4188. )
  4189. def test_internal_chain_server(self):
  4190. client_context, server_context, hostname = testing_context()
  4191. client_context.load_cert_chain(SIGNED_CERTFILE)
  4192. server_context.verify_mode = ssl.CERT_REQUIRED
  4193. server_context.maximum_version = ssl.TLSVersion.TLSv1_2
  4194. server = ThreadedEchoServer(context=server_context, chatty=False)
  4195. with server:
  4196. with client_context.wrap_socket(
  4197. socket.socket(),
  4198. server_hostname=hostname
  4199. ) as s:
  4200. s.connect((HOST, server.port))
  4201. s.write(b'VERIFIEDCHAIN\n')
  4202. res = s.recv(1024)
  4203. self.assertEqual(res, b'\x02\n')
  4204. s.write(b'UNVERIFIEDCHAIN\n')
  4205. res = s.recv(1024)
  4206. self.assertEqual(res, b'\x02\n')
  4207. HAS_KEYLOG = hasattr(ssl.SSLContext, 'keylog_filename')
  4208. requires_keylog = unittest.skipUnless(
  4209. HAS_KEYLOG, 'test requires OpenSSL 1.1.1 with keylog callback')
  4210. class TestSSLDebug(unittest.TestCase):
  4211. def keylog_lines(self, fname=os_helper.TESTFN):
  4212. with open(fname) as f:
  4213. return len(list(f))
  4214. @requires_keylog
  4215. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  4216. def test_keylog_defaults(self):
  4217. self.addCleanup(os_helper.unlink, os_helper.TESTFN)
  4218. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  4219. self.assertEqual(ctx.keylog_filename, None)
  4220. self.assertFalse(os.path.isfile(os_helper.TESTFN))
  4221. ctx.keylog_filename = os_helper.TESTFN
  4222. self.assertEqual(ctx.keylog_filename, os_helper.TESTFN)
  4223. self.assertTrue(os.path.isfile(os_helper.TESTFN))
  4224. self.assertEqual(self.keylog_lines(), 1)
  4225. ctx.keylog_filename = None
  4226. self.assertEqual(ctx.keylog_filename, None)
  4227. with self.assertRaises((IsADirectoryError, PermissionError)):
  4228. # Windows raises PermissionError
  4229. ctx.keylog_filename = os.path.dirname(
  4230. os.path.abspath(os_helper.TESTFN))
  4231. with self.assertRaises(TypeError):
  4232. ctx.keylog_filename = 1
  4233. @requires_keylog
  4234. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  4235. def test_keylog_filename(self):
  4236. self.addCleanup(os_helper.unlink, os_helper.TESTFN)
  4237. client_context, server_context, hostname = testing_context()
  4238. client_context.keylog_filename = os_helper.TESTFN
  4239. server = ThreadedEchoServer(context=server_context, chatty=False)
  4240. with server:
  4241. with client_context.wrap_socket(socket.socket(),
  4242. server_hostname=hostname) as s:
  4243. s.connect((HOST, server.port))
  4244. # header, 5 lines for TLS 1.3
  4245. self.assertEqual(self.keylog_lines(), 6)
  4246. client_context.keylog_filename = None
  4247. server_context.keylog_filename = os_helper.TESTFN
  4248. server = ThreadedEchoServer(context=server_context, chatty=False)
  4249. with server:
  4250. with client_context.wrap_socket(socket.socket(),
  4251. server_hostname=hostname) as s:
  4252. s.connect((HOST, server.port))
  4253. self.assertGreaterEqual(self.keylog_lines(), 11)
  4254. client_context.keylog_filename = os_helper.TESTFN
  4255. server_context.keylog_filename = os_helper.TESTFN
  4256. server = ThreadedEchoServer(context=server_context, chatty=False)
  4257. with server:
  4258. with client_context.wrap_socket(socket.socket(),
  4259. server_hostname=hostname) as s:
  4260. s.connect((HOST, server.port))
  4261. self.assertGreaterEqual(self.keylog_lines(), 21)
  4262. client_context.keylog_filename = None
  4263. server_context.keylog_filename = None
  4264. @requires_keylog
  4265. @unittest.skipIf(sys.flags.ignore_environment,
  4266. "test is not compatible with ignore_environment")
  4267. @unittest.skipIf(Py_DEBUG_WIN32, "Avoid mixing debug/release CRT on Windows")
  4268. def test_keylog_env(self):
  4269. self.addCleanup(os_helper.unlink, os_helper.TESTFN)
  4270. with unittest.mock.patch.dict(os.environ):
  4271. os.environ['SSLKEYLOGFILE'] = os_helper.TESTFN
  4272. self.assertEqual(os.environ['SSLKEYLOGFILE'], os_helper.TESTFN)
  4273. ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
  4274. self.assertEqual(ctx.keylog_filename, None)
  4275. ctx = ssl.create_default_context()
  4276. self.assertEqual(ctx.keylog_filename, os_helper.TESTFN)
  4277. ctx = ssl._create_stdlib_context()
  4278. self.assertEqual(ctx.keylog_filename, os_helper.TESTFN)
  4279. def test_msg_callback(self):
  4280. client_context, server_context, hostname = testing_context()
  4281. def msg_cb(conn, direction, version, content_type, msg_type, data):
  4282. pass
  4283. self.assertIs(client_context._msg_callback, None)
  4284. client_context._msg_callback = msg_cb
  4285. self.assertIs(client_context._msg_callback, msg_cb)
  4286. with self.assertRaises(TypeError):
  4287. client_context._msg_callback = object()
  4288. def test_msg_callback_tls12(self):
  4289. client_context, server_context, hostname = testing_context()
  4290. client_context.maximum_version = ssl.TLSVersion.TLSv1_2
  4291. msg = []
  4292. def msg_cb(conn, direction, version, content_type, msg_type, data):
  4293. self.assertIsInstance(conn, ssl.SSLSocket)
  4294. self.assertIsInstance(data, bytes)
  4295. self.assertIn(direction, {'read', 'write'})
  4296. msg.append((direction, version, content_type, msg_type))
  4297. client_context._msg_callback = msg_cb
  4298. server = ThreadedEchoServer(context=server_context, chatty=False)
  4299. with server:
  4300. with client_context.wrap_socket(socket.socket(),
  4301. server_hostname=hostname) as s:
  4302. s.connect((HOST, server.port))
  4303. self.assertIn(
  4304. ("read", TLSVersion.TLSv1_2, _TLSContentType.HANDSHAKE,
  4305. _TLSMessageType.SERVER_KEY_EXCHANGE),
  4306. msg
  4307. )
  4308. self.assertIn(
  4309. ("write", TLSVersion.TLSv1_2, _TLSContentType.CHANGE_CIPHER_SPEC,
  4310. _TLSMessageType.CHANGE_CIPHER_SPEC),
  4311. msg
  4312. )
  4313. def test_msg_callback_deadlock_bpo43577(self):
  4314. client_context, server_context, hostname = testing_context()
  4315. server_context2 = testing_context()[1]
  4316. def msg_cb(conn, direction, version, content_type, msg_type, data):
  4317. pass
  4318. def sni_cb(sock, servername, ctx):
  4319. sock.context = server_context2
  4320. server_context._msg_callback = msg_cb
  4321. server_context.sni_callback = sni_cb
  4322. server = ThreadedEchoServer(context=server_context, chatty=False)
  4323. with server:
  4324. with client_context.wrap_socket(socket.socket(),
  4325. server_hostname=hostname) as s:
  4326. s.connect((HOST, server.port))
  4327. with client_context.wrap_socket(socket.socket(),
  4328. server_hostname=hostname) as s:
  4329. s.connect((HOST, server.port))
  4330. class TestEnumerations(unittest.TestCase):
  4331. def test_tlsversion(self):
  4332. class CheckedTLSVersion(enum.IntEnum):
  4333. MINIMUM_SUPPORTED = _ssl.PROTO_MINIMUM_SUPPORTED
  4334. SSLv3 = _ssl.PROTO_SSLv3
  4335. TLSv1 = _ssl.PROTO_TLSv1
  4336. TLSv1_1 = _ssl.PROTO_TLSv1_1
  4337. TLSv1_2 = _ssl.PROTO_TLSv1_2
  4338. TLSv1_3 = _ssl.PROTO_TLSv1_3
  4339. MAXIMUM_SUPPORTED = _ssl.PROTO_MAXIMUM_SUPPORTED
  4340. enum._test_simple_enum(CheckedTLSVersion, TLSVersion)
  4341. def test_tlscontenttype(self):
  4342. class Checked_TLSContentType(enum.IntEnum):
  4343. """Content types (record layer)
  4344. See RFC 8446, section B.1
  4345. """
  4346. CHANGE_CIPHER_SPEC = 20
  4347. ALERT = 21
  4348. HANDSHAKE = 22
  4349. APPLICATION_DATA = 23
  4350. # pseudo content types
  4351. HEADER = 0x100
  4352. INNER_CONTENT_TYPE = 0x101
  4353. enum._test_simple_enum(Checked_TLSContentType, _TLSContentType)
  4354. def test_tlsalerttype(self):
  4355. class Checked_TLSAlertType(enum.IntEnum):
  4356. """Alert types for TLSContentType.ALERT messages
  4357. See RFC 8466, section B.2
  4358. """
  4359. CLOSE_NOTIFY = 0
  4360. UNEXPECTED_MESSAGE = 10
  4361. BAD_RECORD_MAC = 20
  4362. DECRYPTION_FAILED = 21
  4363. RECORD_OVERFLOW = 22
  4364. DECOMPRESSION_FAILURE = 30
  4365. HANDSHAKE_FAILURE = 40
  4366. NO_CERTIFICATE = 41
  4367. BAD_CERTIFICATE = 42
  4368. UNSUPPORTED_CERTIFICATE = 43
  4369. CERTIFICATE_REVOKED = 44
  4370. CERTIFICATE_EXPIRED = 45
  4371. CERTIFICATE_UNKNOWN = 46
  4372. ILLEGAL_PARAMETER = 47
  4373. UNKNOWN_CA = 48
  4374. ACCESS_DENIED = 49
  4375. DECODE_ERROR = 50
  4376. DECRYPT_ERROR = 51
  4377. EXPORT_RESTRICTION = 60
  4378. PROTOCOL_VERSION = 70
  4379. INSUFFICIENT_SECURITY = 71
  4380. INTERNAL_ERROR = 80
  4381. INAPPROPRIATE_FALLBACK = 86
  4382. USER_CANCELED = 90
  4383. NO_RENEGOTIATION = 100
  4384. MISSING_EXTENSION = 109
  4385. UNSUPPORTED_EXTENSION = 110
  4386. CERTIFICATE_UNOBTAINABLE = 111
  4387. UNRECOGNIZED_NAME = 112
  4388. BAD_CERTIFICATE_STATUS_RESPONSE = 113
  4389. BAD_CERTIFICATE_HASH_VALUE = 114
  4390. UNKNOWN_PSK_IDENTITY = 115
  4391. CERTIFICATE_REQUIRED = 116
  4392. NO_APPLICATION_PROTOCOL = 120
  4393. enum._test_simple_enum(Checked_TLSAlertType, _TLSAlertType)
  4394. def test_tlsmessagetype(self):
  4395. class Checked_TLSMessageType(enum.IntEnum):
  4396. """Message types (handshake protocol)
  4397. See RFC 8446, section B.3
  4398. """
  4399. HELLO_REQUEST = 0
  4400. CLIENT_HELLO = 1
  4401. SERVER_HELLO = 2
  4402. HELLO_VERIFY_REQUEST = 3
  4403. NEWSESSION_TICKET = 4
  4404. END_OF_EARLY_DATA = 5
  4405. HELLO_RETRY_REQUEST = 6
  4406. ENCRYPTED_EXTENSIONS = 8
  4407. CERTIFICATE = 11
  4408. SERVER_KEY_EXCHANGE = 12
  4409. CERTIFICATE_REQUEST = 13
  4410. SERVER_DONE = 14
  4411. CERTIFICATE_VERIFY = 15
  4412. CLIENT_KEY_EXCHANGE = 16
  4413. FINISHED = 20
  4414. CERTIFICATE_URL = 21
  4415. CERTIFICATE_STATUS = 22
  4416. SUPPLEMENTAL_DATA = 23
  4417. KEY_UPDATE = 24
  4418. NEXT_PROTO = 67
  4419. MESSAGE_HASH = 254
  4420. CHANGE_CIPHER_SPEC = 0x0101
  4421. enum._test_simple_enum(Checked_TLSMessageType, _TLSMessageType)
  4422. def test_sslmethod(self):
  4423. Checked_SSLMethod = enum._old_convert_(
  4424. enum.IntEnum, '_SSLMethod', 'ssl',
  4425. lambda name: name.startswith('PROTOCOL_') and name != 'PROTOCOL_SSLv23',
  4426. source=ssl._ssl,
  4427. )
  4428. # This member is assigned dynamically in `ssl.py`:
  4429. Checked_SSLMethod.PROTOCOL_SSLv23 = Checked_SSLMethod.PROTOCOL_TLS
  4430. enum._test_simple_enum(Checked_SSLMethod, ssl._SSLMethod)
  4431. def test_options(self):
  4432. CheckedOptions = enum._old_convert_(
  4433. enum.IntFlag, 'Options', 'ssl',
  4434. lambda name: name.startswith('OP_'),
  4435. source=ssl._ssl,
  4436. )
  4437. enum._test_simple_enum(CheckedOptions, ssl.Options)
  4438. def test_alertdescription(self):
  4439. CheckedAlertDescription = enum._old_convert_(
  4440. enum.IntEnum, 'AlertDescription', 'ssl',
  4441. lambda name: name.startswith('ALERT_DESCRIPTION_'),
  4442. source=ssl._ssl,
  4443. )
  4444. enum._test_simple_enum(CheckedAlertDescription, ssl.AlertDescription)
  4445. def test_sslerrornumber(self):
  4446. Checked_SSLErrorNumber = enum._old_convert_(
  4447. enum.IntEnum, 'SSLErrorNumber', 'ssl',
  4448. lambda name: name.startswith('SSL_ERROR_'),
  4449. source=ssl._ssl,
  4450. )
  4451. enum._test_simple_enum(Checked_SSLErrorNumber, ssl.SSLErrorNumber)
  4452. def test_verifyflags(self):
  4453. CheckedVerifyFlags = enum._old_convert_(
  4454. enum.IntFlag, 'VerifyFlags', 'ssl',
  4455. lambda name: name.startswith('VERIFY_'),
  4456. source=ssl._ssl,
  4457. )
  4458. enum._test_simple_enum(CheckedVerifyFlags, ssl.VerifyFlags)
  4459. def test_verifymode(self):
  4460. CheckedVerifyMode = enum._old_convert_(
  4461. enum.IntEnum, 'VerifyMode', 'ssl',
  4462. lambda name: name.startswith('CERT_'),
  4463. source=ssl._ssl,
  4464. )
  4465. enum._test_simple_enum(CheckedVerifyMode, ssl.VerifyMode)
  4466. def setUpModule():
  4467. if support.verbose:
  4468. plats = {
  4469. 'Mac': platform.mac_ver,
  4470. 'Windows': platform.win32_ver,
  4471. }
  4472. for name, func in plats.items():
  4473. plat = func()
  4474. if plat and plat[0]:
  4475. plat = '%s %r' % (name, plat)
  4476. break
  4477. else:
  4478. plat = repr(platform.platform())
  4479. print("test_ssl: testing with %r %r" %
  4480. (ssl.OPENSSL_VERSION, ssl.OPENSSL_VERSION_INFO))
  4481. print(" under %s" % plat)
  4482. print(" HAS_SNI = %r" % ssl.HAS_SNI)
  4483. print(" OP_ALL = 0x%8x" % ssl.OP_ALL)
  4484. try:
  4485. print(" OP_NO_TLSv1_1 = 0x%8x" % ssl.OP_NO_TLSv1_1)
  4486. except AttributeError:
  4487. pass
  4488. for filename in [
  4489. CERTFILE, BYTES_CERTFILE,
  4490. ONLYCERT, ONLYKEY, BYTES_ONLYCERT, BYTES_ONLYKEY,
  4491. SIGNED_CERTFILE, SIGNED_CERTFILE2, SIGNING_CA,
  4492. BADCERT, BADKEY, EMPTYCERT]:
  4493. if not os.path.exists(filename):
  4494. raise support.TestFailed("Can't read certificate file %r" % filename)
  4495. thread_info = threading_helper.threading_setup()
  4496. unittest.addModuleCleanup(threading_helper.threading_cleanup, *thread_info)
  4497. if __name__ == "__main__":
  4498. unittest.main()