ssl.h 201 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540
  1. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  2. * All rights reserved.
  3. *
  4. * This package is an SSL implementation written
  5. * by Eric Young (eay@cryptsoft.com).
  6. * The implementation was written so as to conform with Netscapes SSL.
  7. *
  8. * This library is free for commercial and non-commercial use as long as
  9. * the following conditions are aheared to. The following conditions
  10. * apply to all code found in this distribution, be it the RC4, RSA,
  11. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  12. * included with this distribution is covered by the same copyright terms
  13. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14. *
  15. * Copyright remains Eric Young's, and as such any Copyright notices in
  16. * the code are not to be removed.
  17. * If this package is used in a product, Eric Young should be given attribution
  18. * as the author of the parts of the library used.
  19. * This can be in the form of a textual message at program startup or
  20. * in documentation (online or textual) provided with the package.
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. * 1. Redistributions of source code must retain the copyright
  26. * notice, this list of conditions and the following disclaimer.
  27. * 2. Redistributions in binary form must reproduce the above copyright
  28. * notice, this list of conditions and the following disclaimer in the
  29. * documentation and/or other materials provided with the distribution.
  30. * 3. All advertising materials mentioning features or use of this software
  31. * must display the following acknowledgement:
  32. * "This product includes cryptographic software written by
  33. * Eric Young (eay@cryptsoft.com)"
  34. * The word 'cryptographic' can be left out if the rouines from the library
  35. * being used are not cryptographic related :-).
  36. * 4. If you include any Windows specific code (or a derivative thereof) from
  37. * the apps directory (application code) you must include an acknowledgement:
  38. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50. * SUCH DAMAGE.
  51. *
  52. * The licence and distribution terms for any publically available version or
  53. * derivative of this code cannot be changed. i.e. this code cannot simply be
  54. * copied and put under another distribution licence
  55. * [including the GNU Public Licence.]
  56. */
  57. /* ====================================================================
  58. * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
  59. *
  60. * Redistribution and use in source and binary forms, with or without
  61. * modification, are permitted provided that the following conditions
  62. * are met:
  63. *
  64. * 1. Redistributions of source code must retain the above copyright
  65. * notice, this list of conditions and the following disclaimer.
  66. *
  67. * 2. Redistributions in binary form must reproduce the above copyright
  68. * notice, this list of conditions and the following disclaimer in
  69. * the documentation and/or other materials provided with the
  70. * distribution.
  71. *
  72. * 3. All advertising materials mentioning features or use of this
  73. * software must display the following acknowledgment:
  74. * "This product includes software developed by the OpenSSL Project
  75. * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76. *
  77. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78. * endorse or promote products derived from this software without
  79. * prior written permission. For written permission, please contact
  80. * openssl-core@openssl.org.
  81. *
  82. * 5. Products derived from this software may not be called "OpenSSL"
  83. * nor may "OpenSSL" appear in their names without prior written
  84. * permission of the OpenSSL Project.
  85. *
  86. * 6. Redistributions of any form whatsoever must retain the following
  87. * acknowledgment:
  88. * "This product includes software developed by the OpenSSL Project
  89. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90. *
  91. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  100. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  101. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  102. * OF THE POSSIBILITY OF SUCH DAMAGE.
  103. * ====================================================================
  104. *
  105. * This product includes cryptographic software written by Eric Young
  106. * (eay@cryptsoft.com). This product includes software written by Tim
  107. * Hudson (tjh@cryptsoft.com).
  108. *
  109. */
  110. /* ====================================================================
  111. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  112. * ECC cipher suite support in OpenSSL originally developed by
  113. * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  114. */
  115. /* ====================================================================
  116. * Copyright 2005 Nokia. All rights reserved.
  117. *
  118. * The portions of the attached software ("Contribution") is developed by
  119. * Nokia Corporation and is licensed pursuant to the OpenSSL open source
  120. * license.
  121. *
  122. * The Contribution, originally written by Mika Kousa and Pasi Eronen of
  123. * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
  124. * support (see RFC 4279) to OpenSSL.
  125. *
  126. * No patent licenses or other rights except those expressly stated in
  127. * the OpenSSL open source license shall be deemed granted or received
  128. * expressly, by implication, estoppel, or otherwise.
  129. *
  130. * No assurances are provided by Nokia that the Contribution does not
  131. * infringe the patent or other intellectual property rights of any third
  132. * party or that the license provides you with all the necessary rights
  133. * to make use of the Contribution.
  134. *
  135. * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
  136. * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
  137. * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
  138. * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
  139. * OTHERWISE.
  140. */
  141. #ifndef OPENSSL_HEADER_SSL_H
  142. #define OPENSSL_HEADER_SSL_H
  143. #include <openssl/base.h>
  144. #include <openssl/bio.h>
  145. #include <openssl/buf.h>
  146. #include <openssl/hmac.h>
  147. #include <openssl/lhash.h>
  148. #include <openssl/pem.h>
  149. #include <openssl/ssl3.h>
  150. #include <openssl/thread.h>
  151. #include <openssl/tls1.h>
  152. #include <openssl/x509.h>
  153. #if !defined(OPENSSL_WINDOWS)
  154. #include <sys/time.h>
  155. #endif
  156. /* wpa_supplicant expects to get the version functions from ssl.h */
  157. #include <openssl/crypto.h>
  158. /* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
  159. * Windows headers define too many macros to be included in public headers.
  160. * However, only a forward declaration is needed. */
  161. struct timeval;
  162. #if defined(__cplusplus)
  163. extern "C" {
  164. #endif
  165. /* SSL implementation. */
  166. /* SSL contexts.
  167. *
  168. * |SSL_CTX| objects manage shared state and configuration between multiple TLS
  169. * or DTLS connections. Whether the connections are TLS or DTLS is selected by
  170. * an |SSL_METHOD| on creation.
  171. *
  172. * |SSL_CTX| are reference-counted and may be shared by connections across
  173. * multiple threads. Once shared, functions which change the |SSL_CTX|'s
  174. * configuration may not be used. */
  175. /* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
  176. OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
  177. /* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
  178. OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
  179. /* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
  180. * on error. */
  181. OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
  182. /* SSL_CTX_free releases memory associated with |ctx|. */
  183. OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
  184. /* SSL connections.
  185. *
  186. * An |SSL| object represents a single TLS or DTLS connection. Although the
  187. * shared |SSL_CTX| is thread-safe, an |SSL| is not thread-safe and may only be
  188. * used on one thread at a time. */
  189. /* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. The new
  190. * connection inherits settings from |ctx| at the time of creation. Settings may
  191. * also be individually configured on the connection.
  192. *
  193. * On creation, an |SSL| is not configured to be either a client or server. Call
  194. * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
  195. OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
  196. /* SSL_free releases memory associated with |ssl|. */
  197. OPENSSL_EXPORT void SSL_free(SSL *ssl);
  198. /* SSL_get_SSL_CTX returns the |SSL_CTX| associated with |ssl|. If
  199. * |SSL_set_SSL_CTX| is called, it returns the new |SSL_CTX|, not the initial
  200. * one. */
  201. OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
  202. /* SSL_set_connect_state configures |ssl| to be a client. */
  203. OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
  204. /* SSL_set_accept_state configures |ssl| to be a server. */
  205. OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
  206. /* SSL_is_server returns one if |ssl| is configured as a server and zero
  207. * otherwise. */
  208. OPENSSL_EXPORT int SSL_is_server(SSL *ssl);
  209. /* SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl|
  210. * takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl|
  211. * only takes ownership of one reference.
  212. *
  213. * In DTLS, if |rbio| is blocking, it must handle
  214. * |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| control requests to set read timeouts.
  215. *
  216. * Calling this function on an already-configured |ssl| is deprecated. */
  217. OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
  218. /* SSL_get_rbio returns the |BIO| that |ssl| reads from. */
  219. OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl);
  220. /* SSL_get_wbio returns the |BIO| that |ssl| writes to. */
  221. OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl);
  222. /* SSL_get_fd calls |SSL_get_rfd|. */
  223. OPENSSL_EXPORT int SSL_get_fd(const SSL *ssl);
  224. /* SSL_get_rfd returns the file descriptor that |ssl| is configured to read
  225. * from. If |ssl|'s read |BIO| is not configured or doesn't wrap a file
  226. * descriptor then it returns -1. */
  227. OPENSSL_EXPORT int SSL_get_rfd(const SSL *ssl);
  228. /* SSL_get_wfd returns the file descriptor that |ssl| is configured to write
  229. * to. If |ssl|'s write |BIO| is not configured or doesn't wrap a file
  230. * descriptor then it returns -1. */
  231. OPENSSL_EXPORT int SSL_get_wfd(const SSL *ssl);
  232. /* SSL_set_fd configures |ssl| to read from and write to |fd|. It returns one
  233. * on success and zero on allocation error. The caller retains ownership of
  234. * |fd|. */
  235. OPENSSL_EXPORT int SSL_set_fd(SSL *ssl, int fd);
  236. /* SSL_set_rfd configures |ssl| to read from |fd|. It returns one on success and
  237. * zero on allocation error. The caller retains ownership of |fd|. */
  238. OPENSSL_EXPORT int SSL_set_rfd(SSL *ssl, int fd);
  239. /* SSL_set_wfd configures |ssl| to write to |fd|. It returns one on success and
  240. * zero on allocation error. The caller retains ownership of |fd|. */
  241. OPENSSL_EXPORT int SSL_set_wfd(SSL *ssl, int fd);
  242. /* SSL_do_handshake continues the current handshake. If there is none or the
  243. * handshake has completed or False Started, it returns one. Otherwise, it
  244. * returns <= 0. The caller should pass the value into |SSL_get_error| to
  245. * determine how to proceed.
  246. *
  247. * In DTLS, if the read |BIO| is non-blocking, the caller must drive
  248. * retransmissions. Whenever |SSL_get_error| signals |SSL_ERROR_WANT_READ|, use
  249. * |DTLSv1_get_timeout| to determine the current timeout. If it expires before
  250. * the next retry, call |DTLSv1_handle_timeout|. Note that DTLS handshake
  251. * retransmissions use fresh sequence numbers, so it is not sufficient to replay
  252. * packets at the transport.
  253. *
  254. * TODO(davidben): Ensure 0 is only returned on transport EOF.
  255. * https://crbug.com/466303. */
  256. OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl);
  257. /* SSL_connect configures |ssl| as a client, if unconfigured, and calls
  258. * |SSL_do_handshake|. */
  259. OPENSSL_EXPORT int SSL_connect(SSL *ssl);
  260. /* SSL_accept configures |ssl| as a server, if unconfigured, and calls
  261. * |SSL_do_handshake|. */
  262. OPENSSL_EXPORT int SSL_accept(SSL *ssl);
  263. /* SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs
  264. * any pending handshakes, including renegotiations when enabled. On success, it
  265. * returns the number of bytes read. Otherwise, it returns <= 0. The caller
  266. * should pass the value into |SSL_get_error| to determine how to proceed.
  267. *
  268. * TODO(davidben): Ensure 0 is only returned on transport EOF.
  269. * https://crbug.com/466303. */
  270. OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
  271. /* SSL_peek behaves like |SSL_read| but does not consume any bytes returned. */
  272. OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
  273. /* SSL_pending returns the number of bytes available in |ssl|. It does not read
  274. * from the transport. */
  275. OPENSSL_EXPORT int SSL_pending(const SSL *ssl);
  276. /* SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs
  277. * any pending handshakes, including renegotiations when enabled. On success, it
  278. * returns the number of bytes read. Otherwise, it returns <= 0. The caller
  279. * should pass the value into |SSL_get_error| to determine how to proceed.
  280. *
  281. * In TLS, a non-blocking |SSL_write| differs from non-blocking |write| in that
  282. * a failed |SSL_write| still commits to the data passed in. When retrying, the
  283. * caller must supply the original write buffer (or a larger one containing the
  284. * original as a prefix). By default, retries will fail if they also do not
  285. * reuse the same |buf| pointer. This may be relaxed with
  286. * |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be
  287. * unchanged.
  288. *
  289. * By default, in TLS, |SSL_write| will not return success until all |num| bytes
  290. * are written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It
  291. * allows |SSL_write| to complete with a partial result when only part of the
  292. * input was written in a single record.
  293. *
  294. * In DTLS, neither |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER| and
  295. * |SSL_MODE_ENABLE_PARTIAL_WRITE| do anything. The caller may retry with a
  296. * different buffer freely. A single call to |SSL_write| only ever writes a
  297. * single record in a single packet, so |num| must be at most
  298. * |SSL3_RT_MAX_PLAIN_LENGTH|.
  299. *
  300. * TODO(davidben): Ensure 0 is only returned on transport EOF.
  301. * https://crbug.com/466303. */
  302. OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
  303. /* SSL_shutdown shuts down |ssl|. On success, it completes in two stages. First,
  304. * it returns 0 if |ssl| completed uni-directional shutdown; close_notify has
  305. * been sent, but the peer's close_notify has not been received. Most callers
  306. * may stop at this point. For bi-directional shutdown, call |SSL_shutdown|
  307. * again. It returns 1 if close_notify has been both sent and received.
  308. *
  309. * If the peer's close_notify arrived first, the first stage is skipped.
  310. * |SSL_shutdown| will return 1 once close_notify is sent and skip 0. Callers
  311. * only interested in uni-directional shutdown must therefore allow for the
  312. * first stage returning either 0 or 1.
  313. *
  314. * |SSL_shutdown| returns -1 on failure. The caller should pass the return value
  315. * into |SSL_get_error| to determine how to proceed. If the underlying |BIO| is
  316. * non-blocking, both stages may require retry.
  317. *
  318. * |SSL_shutdown| must be called to retain |ssl|'s session in the session
  319. * cache. Use |SSL_CTX_set_quiet_shutdown| to configure |SSL_shutdown| to
  320. * neither send nor wait for close_notify but still retain the session.
  321. *
  322. * TODO(davidben): Is there any point in the session cache interaction? Remove
  323. * it? */
  324. OPENSSL_EXPORT int SSL_shutdown(SSL *ssl);
  325. /* SSL_CTX_set_quiet_shutdown sets quiet shutdown on |ctx| to |mode|. If
  326. * enabled, |SSL_shutdown| will not send a close_notify alert or wait for one
  327. * from the peer. It will instead synchronously return one. */
  328. OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
  329. /* SSL_CTX_get_quiet_shutdown returns whether quiet shutdown is enabled for
  330. * |ctx|. */
  331. OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
  332. /* SSL_set_quiet_shutdown sets quiet shutdown on |ssl| to |mode|. If enabled,
  333. * |SSL_shutdown| will not send a close_notify alert or wait for one from the
  334. * peer. It will instead synchronously return one. */
  335. OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
  336. /* SSL_get_quiet_shutdown returns whether quiet shutdown is enabled for
  337. * |ssl|. */
  338. OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
  339. /* SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on
  340. * |ssl|. It should be called after an operation failed to determine whether the
  341. * error was fatal and, if not, when to retry. */
  342. OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code);
  343. /* SSL_ERROR_NONE indicates the operation succeeded. */
  344. #define SSL_ERROR_NONE 0
  345. /* SSL_ERROR_SSL indicates the operation failed within the library. The caller
  346. * may inspect the error queue for more information. */
  347. #define SSL_ERROR_SSL 1
  348. /* SSL_ERROR_WANT_READ indicates the operation failed attempting to read from
  349. * the transport. The caller may retry the operation when the transport is ready
  350. * for reading.
  351. *
  352. * If signaled by a DTLS handshake, the caller must also call
  353. * |DTLSv1_get_timeout| and |DTLSv1_handle_timeout| as appropriate. See
  354. * |SSL_do_handshake|. */
  355. #define SSL_ERROR_WANT_READ 2
  356. /* SSL_ERROR_WANT_WRITE indicates the operation failed attempting to write to
  357. * the transport. The caller may retry the operation when the transport is ready
  358. * for writing. */
  359. #define SSL_ERROR_WANT_WRITE 3
  360. /* SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the
  361. * |cert_cb| or |client_cert_cb|. The caller may retry the operation when the
  362. * callback is ready to return a certificate or one has been configured
  363. * externally.
  364. *
  365. * See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. */
  366. #define SSL_ERROR_WANT_X509_LOOKUP 4
  367. /* SSL_ERROR_WANT_SYSCALL indicates the operation failed externally to the
  368. * library. The caller should consult the system-specific error mechanism. This
  369. * is typically |errno| but may be something custom if using a custom |BIO|. It
  370. * may also be signaled if the transport returned EOF, in which case the
  371. * operation's return value will be zero. */
  372. #define SSL_ERROR_SYSCALL 5
  373. /* SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection
  374. * was cleanly shut down with a close_notify alert. */
  375. #define SSL_ERROR_ZERO_RETURN 6
  376. /* SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect
  377. * the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the
  378. * operation when the transport is ready. */
  379. #define SSL_ERROR_WANT_CONNECT 7
  380. /* SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a
  381. * connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The
  382. * caller may retry the operation when the transport is ready.
  383. *
  384. * TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. */
  385. #define SSL_ERROR_WANT_ACCEPT 8
  386. /* SSL_ERROR_WANT_CHANNEL_ID_LOOKUP indicates the operation failed looking up
  387. * the Channel ID key. The caller may retry the operation when |channel_id_cb|
  388. * is ready to return a key or one has been configured with
  389. * |SSL_set1_tls_channel_id|.
  390. *
  391. * See also |SSL_CTX_set_channel_id_cb|. */
  392. #define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
  393. /* SSL_ERROR_PENDING_SESSION indicates the operation failed because the session
  394. * lookup callback indicated the session was unavailable. The caller may retry
  395. * the operation when lookup has completed.
  396. *
  397. * See also |SSL_CTX_sess_set_get_cb| and |SSL_magic_pending_session_ptr|. */
  398. #define SSL_ERROR_PENDING_SESSION 11
  399. /* SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the
  400. * early callback indicated certificate lookup was incomplete. The caller may
  401. * retry the operation when lookup has completed. Note: when the operation is
  402. * retried, the early callback will not be called a second time.
  403. *
  404. * See also |SSL_CTX_set_select_certificate_cb|. */
  405. #define SSL_ERROR_PENDING_CERTIFICATE 12
  406. /* SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because
  407. * a private key operation was unfinished. The caller may retry the operation
  408. * when the private key operation is complete.
  409. *
  410. * See also |SSL_set_private_key_method|. */
  411. #define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
  412. /* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
  413. * and zero on failure. */
  414. OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
  415. /* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
  416. * timeout in progress, it sets |*out| to the time remaining and returns one.
  417. * Otherwise, it returns zero.
  418. *
  419. * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
  420. * retransmit behavior.
  421. *
  422. * NOTE: This function must be queried again whenever the handshake state
  423. * machine changes, including when |DTLSv1_handle_timeout| is called. */
  424. OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
  425. /* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
  426. * timeout had expired, it returns 0. Otherwise, it retransmits the previous
  427. * flight of handshake messages and returns 1. If too many timeouts had expired
  428. * without progress or an error occurs, it returns -1.
  429. *
  430. * The caller's external timer should be compatible with the one |ssl| queries
  431. * within some fudge factor. Otherwise, the call will be a no-op, but
  432. * |DTLSv1_get_timeout| will return an updated timeout.
  433. *
  434. * If the function returns -1, checking if |SSL_get_error| returns
  435. * |SSL_ERROR_WANT_WRITE| may be used to determine if the retransmit failed due
  436. * to a non-fatal error at the write |BIO|. However, the operation may not be
  437. * retried until the next timeout fires.
  438. *
  439. * WARNING: This function breaks the usual return value convention.
  440. *
  441. * TODO(davidben): This |SSL_ERROR_WANT_WRITE| behavior is kind of bizarre. */
  442. OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
  443. /* Protocol versions. */
  444. #define DTLS1_VERSION_MAJOR 0xfe
  445. #define SSL3_VERSION_MAJOR 0x03
  446. #define SSL3_VERSION 0x0300
  447. #define TLS1_VERSION 0x0301
  448. #define TLS1_1_VERSION 0x0302
  449. #define TLS1_2_VERSION 0x0303
  450. #define DTLS1_VERSION 0xfeff
  451. #define DTLS1_2_VERSION 0xfefd
  452. /* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
  453. * |version|. */
  454. OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
  455. /* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
  456. * |version|. */
  457. OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
  458. /* SSL_set_min_version sets the minimum protocol version for |ssl| to
  459. * |version|. */
  460. OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
  461. /* SSL_set_max_version sets the maximum protocol version for |ssl| to
  462. * |version|. */
  463. OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
  464. /* SSL_version returns the TLS or DTLS protocol version used by |ssl|, which is
  465. * one of the |*_VERSION| values. (E.g. |TLS1_2_VERSION|.) Before the version
  466. * is negotiated, the result is undefined. */
  467. OPENSSL_EXPORT int SSL_version(const SSL *ssl);
  468. /* Options.
  469. *
  470. * Options configure protocol behavior. */
  471. /* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
  472. * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
  473. #define SSL_OP_NO_QUERY_MTU 0x00001000L
  474. /* SSL_OP_NO_TICKET disables session ticket support (RFC 5077). */
  475. #define SSL_OP_NO_TICKET 0x00004000L
  476. /* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
  477. * ECDHE curves according to the server's preferences instead of the
  478. * client's. */
  479. #define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
  480. /* SSL_OP_DISABLE_NPN configures an individual |SSL| to not advertise NPN,
  481. * despite |SSL_CTX_set_next_proto_select_cb| being configured on the
  482. * |SSL_CTX|. */
  483. #define SSL_OP_DISABLE_NPN 0x00800000L
  484. /* SSL_CTX_set_options enables all options set in |options| (which should be one
  485. * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  486. * bitmask representing the resulting enabled options. */
  487. OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
  488. /* SSL_CTX_clear_options disables all options set in |options| (which should be
  489. * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  490. * bitmask representing the resulting enabled options. */
  491. OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
  492. /* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
  493. * the options enabled for |ctx|. */
  494. OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
  495. /* SSL_set_options enables all options set in |options| (which should be one or
  496. * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
  497. * representing the resulting enabled options. */
  498. OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
  499. /* SSL_clear_options disables all options set in |options| (which should be one
  500. * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
  501. * bitmask representing the resulting enabled options. */
  502. OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
  503. /* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
  504. * options enabled for |ssl|. */
  505. OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
  506. /* Modes.
  507. *
  508. * Modes configure API behavior. */
  509. /* SSL_MODE_ENABLE_PARTIAL_WRITE, in TLS, allows |SSL_write| to complete with a
  510. * partial result when the only part of the input was written in a single
  511. * record. In DTLS, it does nothing. */
  512. #define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
  513. /* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER, in TLS, allows retrying an incomplete
  514. * |SSL_write| with a different buffer. However, |SSL_write| still assumes the
  515. * buffer contents are unchanged. This is not the default to avoid the
  516. * misconception that non-blocking |SSL_write| behaves like non-blocking
  517. * |write|. In DTLS, it does nothing. */
  518. #define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
  519. /* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
  520. * before sending certificates to the peer.
  521. * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
  522. #define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
  523. /* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
  524. * receipt of ChangeCipherSpec and Finished. This mode enables full-handshakes
  525. * to 'complete' in one RTT. See draft-bmoeller-tls-falsestart-01.
  526. *
  527. * When False Start is enabled, |SSL_do_handshake| may succeed before the
  528. * handshake has completely finished. |SSL_write| will function at this point,
  529. * and |SSL_read| will transparently wait for the final handshake leg before
  530. * returning application data. To determine if False Start occurred or when the
  531. * handshake is completely finished, see |SSL_in_false_start|, |SSL_in_init|,
  532. * and |SSL_CB_HANDSHAKE_DONE| from |SSL_CTX_set_info_callback|. */
  533. #define SSL_MODE_ENABLE_FALSE_START 0x00000080L
  534. /* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
  535. * TLS 1.0 to be split in two: the first record will contain a single byte and
  536. * the second will contain the remainder. This effectively randomises the IV and
  537. * prevents BEAST attacks. */
  538. #define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
  539. /* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
  540. * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
  541. * session resumption is used for a given SSL*. */
  542. #define SSL_MODE_NO_SESSION_CREATION 0x00000200L
  543. /* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
  544. * To be set only by applications that reconnect with a downgraded protocol
  545. * version; see RFC 7507 for details.
  546. *
  547. * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
  548. * this in explicit fallback retries, following the guidance in RFC 7507. */
  549. #define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
  550. /* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
  551. * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
  552. * representing the resulting enabled modes. */
  553. OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
  554. /* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
  555. * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
  556. * bitmask representing the resulting enabled modes. */
  557. OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
  558. /* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
  559. * the modes enabled for |ssl|. */
  560. OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
  561. /* SSL_set_mode enables all modes set in |mode| (which should be one or more of
  562. * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  563. * representing the resulting enabled modes. */
  564. OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
  565. /* SSL_clear_mode disables all modes set in |mode| (which should be one or more
  566. * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  567. * representing the resulting enabled modes. */
  568. OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
  569. /* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
  570. * modes enabled for |ssl|. */
  571. OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
  572. /* Configuring certificates and private keys.
  573. *
  574. * These functions configure the connection's leaf certificate, private key, and
  575. * certificate chain. The certificate chain is ordered leaf to root (as sent on
  576. * the wire) but does not include the leaf. Both client and server certificates
  577. * use these functions.
  578. *
  579. * Certificates and keys may be configured before the handshake or dynamically
  580. * in the early callback and certificate callback. */
  581. /* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
  582. * one on success and zero on failure. */
  583. OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
  584. /* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
  585. * on success and zero on failure. */
  586. OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
  587. /* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
  588. * success and zero on failure. */
  589. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
  590. /* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
  591. * success and zero on failure. */
  592. OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
  593. /* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
  594. * |chain|. On success, it returns one and takes ownership of |chain|.
  595. * Otherwise, it returns zero. */
  596. OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  597. /* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
  598. * |chain|. It returns one on success and zero on failure. The caller retains
  599. * ownership of |chain| and may release it freely. */
  600. OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  601. /* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
  602. * |chain|. On success, it returns one and takes ownership of |chain|.
  603. * Otherwise, it returns zero. */
  604. OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
  605. /* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
  606. * |chain|. It returns one on success and zero on failure. The caller retains
  607. * ownership of |chain| and may release it freely. */
  608. OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
  609. /* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
  610. * success, it returns one and takes ownership of |x509|. Otherwise, it returns
  611. * zero. */
  612. OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
  613. /* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
  614. * returns one on success and zero on failure. The caller retains ownership of
  615. * |x509| and may release it freely. */
  616. OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
  617. /* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
  618. * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
  619. OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
  620. /* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
  621. OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
  622. /* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
  623. * one on success and zero on failure. The caller retains ownership of |x509|
  624. * and may release it freely. */
  625. OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
  626. /* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
  627. * one. */
  628. OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
  629. /* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
  630. OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
  631. /* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
  632. OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
  633. /* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
  634. * The callback returns one on success, zero on internal error, and a negative
  635. * number on failure or to pause the handshake. If the handshake is paused,
  636. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
  637. *
  638. * On the client, the callback may call |SSL_get0_certificate_types| and
  639. * |SSL_get_client_CA_list| for information on the server's certificate
  640. * request. */
  641. OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
  642. int (*cb)(SSL *ssl, void *arg),
  643. void *arg);
  644. /* SSL_set_cert_cb sets a callback that is called to select a certificate. The
  645. * callback returns one on success, zero on internal error, and a negative
  646. * number on failure or to pause the handshake. If the handshake is paused,
  647. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
  648. *
  649. * On the client, the callback may call |SSL_get0_certificate_types| and
  650. * |SSL_get_client_CA_list| for information on the server's certificate
  651. * request. */
  652. OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
  653. void *arg);
  654. /* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
  655. * containing the client certificate types requested by a server. It returns the
  656. * length of the array.
  657. *
  658. * The behavior of this function is undefined except during the callbacks set by
  659. * by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the
  660. * handshake is paused because of them. */
  661. OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
  662. const uint8_t **out_types);
  663. /* SSL_certs_clear resets the private key, leaf certificate, and certificate
  664. * chain of |ssl|. */
  665. OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
  666. /* SSL_CTX_check_private_key returns one if the certificate and private key
  667. * configured in |ctx| are consistent and zero otherwise. */
  668. OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
  669. /* SSL_check_private_key returns one if the certificate and private key
  670. * configured in |ssl| are consistent and zero otherwise. */
  671. OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
  672. /* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
  673. OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
  674. /* SSL_get_certificate returns |ssl|'s leaf certificate. */
  675. OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
  676. /* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
  677. OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
  678. /* SSL_get_privatekey returns |ssl|'s private key. */
  679. OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
  680. /* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
  681. * returns one. */
  682. OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
  683. STACK_OF(X509) **out_chain);
  684. /* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
  685. OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
  686. STACK_OF(X509) **out_chain);
  687. /* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
  688. * returns one. */
  689. OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
  690. STACK_OF(X509) **out_chain);
  691. /* SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate
  692. * timestamps that is sent to clients that request it. The |list| argument must
  693. * contain one or more SCT structures serialised as a SignedCertificateTimestamp
  694. * List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT
  695. * is prefixed by a big-endian, uint16 length and the concatenation of one or
  696. * more such prefixed SCTs are themselves also prefixed by a uint16 length. It
  697. * returns one on success and zero on error. The caller retains ownership of
  698. * |list|. */
  699. OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx,
  700. const uint8_t *list,
  701. size_t list_len);
  702. /* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
  703. * which request it. It returns one on success and zero on error. The caller
  704. * retains ownership of |response|. */
  705. OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
  706. const uint8_t *response,
  707. size_t response_len);
  708. /* SSL_set_private_key_digest_prefs copies |num_digests| NIDs from |digest_nids|
  709. * into |ssl|. These digests will be used, in decreasing order of preference,
  710. * when signing with |ssl|'s private key. It returns one on success and zero on
  711. * error. */
  712. OPENSSL_EXPORT int SSL_set_private_key_digest_prefs(SSL *ssl,
  713. const int *digest_nids,
  714. size_t num_digests);
  715. /* Certificate and private key convenience functions. */
  716. /* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
  717. * on success and zero on failure. */
  718. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
  719. /* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
  720. * success and zero on failure. */
  721. OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
  722. /* The following functions configure certificates or private keys but take as
  723. * input DER-encoded structures. They return one on success and zero on
  724. * failure. */
  725. OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, size_t der_len,
  726. const uint8_t *der);
  727. OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
  728. size_t der_len);
  729. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
  730. const uint8_t *der,
  731. size_t der_len);
  732. OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
  733. const uint8_t *der, size_t der_len);
  734. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
  735. const uint8_t *der,
  736. size_t der_len);
  737. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
  738. size_t der_len);
  739. /* The following functions configure certificates or private keys but take as
  740. * input files to read from. They return one on success and zero on failure. The
  741. * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
  742. * the file's contents are read as PEM or DER. */
  743. #define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
  744. #define SSL_FILETYPE_PEM X509_FILETYPE_PEM
  745. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
  746. const char *file,
  747. int type);
  748. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
  749. int type);
  750. OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
  751. int type);
  752. OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
  753. int type);
  754. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
  755. int type);
  756. OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
  757. int type);
  758. /* SSL_CTX_use_certificate_chain_file configures certificates for |ctx|. It
  759. * reads the contents of |file| as a PEM-encoded leaf certificate followed
  760. * optionally by the certificate chain to send to the peer. It returns one on
  761. * success and zero on failure. */
  762. OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
  763. const char *file);
  764. /* SSL_CTX_set_default_passwd_cb sets the password callback for PEM-based
  765. * convenience functions called on |ctx|. */
  766. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
  767. pem_password_cb *cb);
  768. /* SSL_CTX_set_default_passwd_cb_userdata sets the userdata parameter for
  769. * |ctx|'s password callback. */
  770. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
  771. void *data);
  772. /* Custom private keys. */
  773. enum ssl_private_key_result_t {
  774. ssl_private_key_success,
  775. ssl_private_key_retry,
  776. ssl_private_key_failure,
  777. };
  778. /* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
  779. * signing operations to a custom, potentially asynchronous, backend. */
  780. typedef struct ssl_private_key_method_st {
  781. /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
  782. * key used by |ssl|. */
  783. int (*type)(SSL *ssl);
  784. /* max_signature_len returns the maximum length of a signature signed by the
  785. * key used by |ssl|. This must be a constant value for a given |ssl|. */
  786. size_t (*max_signature_len)(SSL *ssl);
  787. /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
  788. * used to calculate |in|. On success, it returns |ssl_private_key_success|
  789. * and writes at most |max_out| bytes of signature data to |out|. On failure,
  790. * it returns |ssl_private_key_failure|. If the operation has not completed,
  791. * it returns |ssl_private_key_retry|. |sign| should arrange for the
  792. * high-level operation on |ssl| to be retried when the operation is
  793. * completed. This will result in a call to |sign_complete|.
  794. *
  795. * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
  796. * the digest itself, so the DigestInfo prefix, if any, must be prepended by
  797. * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
  798. *
  799. * It is an error to call |sign| while another private key operation is in
  800. * progress on |ssl|. */
  801. enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
  802. size_t max_out, const EVP_MD *md,
  803. const uint8_t *in, size_t in_len);
  804. /* sign_complete completes a pending |sign| operation. If the operation has
  805. * completed, it returns |ssl_private_key_success| and writes the result to
  806. * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
  807. * failure and |ssl_private_key_retry| if the operation is still in progress.
  808. *
  809. * |sign_complete| may be called arbitrarily many times before completion, but
  810. * it is an error to call |sign_complete| if there is no pending |sign|
  811. * operation in progress on |ssl|. */
  812. enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
  813. size_t *out_len,
  814. size_t max_out);
  815. /* decrypt decrypts |in_len| bytes of encrypted data from |in|. On success it
  816. * returns |ssl_private_key_success|, writes at most |max_out| bytes of
  817. * decrypted data to |out| and sets |*out_len| to the actual number of bytes
  818. * written. On failure it returns |ssl_private_key_failure|. If the operation
  819. * has not completed, it returns |ssl_private_key_retry|. The caller should
  820. * arrange for the high-level operation on |ssl| to be retried when the
  821. * operation is completed, which will result in a call to |decrypt_complete|.
  822. * This function only works with RSA keys and should perform a raw RSA
  823. * decryption operation with no padding.
  824. *
  825. * It is an error to call |decrypt| while another private key operation is in
  826. * progress on |ssl|. */
  827. enum ssl_private_key_result_t (*decrypt)(SSL *ssl, uint8_t *out,
  828. size_t *out_len, size_t max_out,
  829. const uint8_t *in, size_t in_len);
  830. /* decrypt_complete completes a pending |decrypt| operation. If the operation
  831. * has completed, it returns |ssl_private_key_success| and writes the result
  832. * to |out| as in |decrypt|. Otherwise, it returns |ssl_private_key_failure|
  833. * on failure and |ssl_private_key_retry| if the operation is still in
  834. * progress.
  835. *
  836. * |decrypt_complete| may be called arbitrarily many times before completion,
  837. * but it is an error to call |decrypt_complete| if there is no pending
  838. * |decrypt| operation in progress on |ssl|. */
  839. enum ssl_private_key_result_t (*decrypt_complete)(SSL *ssl, uint8_t *out,
  840. size_t *out_len,
  841. size_t max_out);
  842. } SSL_PRIVATE_KEY_METHOD;
  843. /* SSL_set_private_key_method configures a custom private key on |ssl|.
  844. * |key_method| must remain valid for the lifetime of |ssl|. */
  845. OPENSSL_EXPORT void SSL_set_private_key_method(
  846. SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
  847. /* Cipher suites.
  848. *
  849. * |SSL_CIPHER| objects represent cipher suites. */
  850. DECLARE_STACK_OF(SSL_CIPHER)
  851. /* SSL_get_cipher_by_value returns the structure representing a TLS cipher
  852. * suite based on its assigned number, or NULL if unknown. See
  853. * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
  854. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
  855. /* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
  856. * get the cipher suite value. */
  857. OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
  858. /* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
  859. * mode). */
  860. OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
  861. /* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
  862. OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
  863. /* SSL_CIPHER_has_SHA1_HMAC returns one if |cipher| uses HMAC-SHA1. */
  864. OPENSSL_EXPORT int SSL_CIPHER_has_SHA1_HMAC(const SSL_CIPHER *cipher);
  865. /* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
  866. OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
  867. /* SSL_CIPHER_is_AES128GCM returns one if |cipher| uses 128-bit AES-GCM. */
  868. OPENSSL_EXPORT int SSL_CIPHER_is_AES128GCM(const SSL_CIPHER *cipher);
  869. /* SSL_CIPHER_is_AES128CBC returns one if |cipher| uses 128-bit AES in CBC
  870. * mode. */
  871. OPENSSL_EXPORT int SSL_CIPHER_is_AES128CBC(const SSL_CIPHER *cipher);
  872. /* SSL_CIPHER_is_AES256CBC returns one if |cipher| uses 256-bit AES in CBC
  873. * mode. */
  874. OPENSSL_EXPORT int SSL_CIPHER_is_AES256CBC(const SSL_CIPHER *cipher);
  875. /* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
  876. * CHACHA20_POLY1305. Note this includes both the
  877. * draft-ietf-tls-chacha20-poly1305-04 and draft-agl-tls-chacha20poly1305-04
  878. * versions. */
  879. OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
  880. /* SSL_CIPHER_is_NULL returns one if |cipher| does not encrypt. */
  881. OPENSSL_EXPORT int SSL_CIPHER_is_NULL(const SSL_CIPHER *cipher);
  882. /* SSL_CIPHER_is_RC4 returns one if |cipher| uses RC4. */
  883. OPENSSL_EXPORT int SSL_CIPHER_is_RC4(const SSL_CIPHER *cipher);
  884. /* SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. */
  885. OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher);
  886. /* SSL_CIPHER_is_ECDSA returns one if |cipher| uses ECDSA. */
  887. OPENSSL_EXPORT int SSL_CIPHER_is_ECDSA(const SSL_CIPHER *cipher);
  888. /* SSL_CIPHER_is_ECDHE returns one if |cipher| uses ECDHE. */
  889. OPENSSL_EXPORT int SSL_CIPHER_is_ECDHE(const SSL_CIPHER *cipher);
  890. /* SSL_CIPHER_get_min_version returns the minimum protocol version required
  891. * for |cipher|. */
  892. OPENSSL_EXPORT uint16_t SSL_CIPHER_get_min_version(const SSL_CIPHER *cipher);
  893. /* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
  894. OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
  895. /* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
  896. * method used by |cipher|. For example, "ECDHE_ECDSA". */
  897. OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
  898. /* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
  899. * name for |cipher| or NULL on error. For example,
  900. * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
  901. * calling |OPENSSL_free| on the result. */
  902. OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
  903. /* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
  904. * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
  905. * symmetric algorithm to |*out_alg_bits|. */
  906. OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
  907. int *out_alg_bits);
  908. /* Cipher suite configuration.
  909. *
  910. * OpenSSL uses a mini-language to configure cipher suites. The language
  911. * maintains an ordered list of enabled ciphers, along with an ordered list of
  912. * disabled but available ciphers. Initially, all ciphers are disabled with a
  913. * default ordering. The cipher string is then interpreted as a sequence of
  914. * directives, separated by colons, each of which modifies this state.
  915. *
  916. * Most directives consist of a one character or empty opcode followed by a
  917. * selector which matches a subset of available ciphers.
  918. *
  919. * Available opcodes are:
  920. *
  921. * The empty opcode enables and appends all matching disabled ciphers to the
  922. * end of the enabled list. The newly appended ciphers are ordered relative to
  923. * each other matching their order in the disabled list.
  924. *
  925. * |-| disables all matching enabled ciphers and prepends them to the disabled
  926. * list, with relative order from the enabled list preserved. This means the
  927. * most recently disabled ciphers get highest preference relative to other
  928. * disabled ciphers if re-enabled.
  929. *
  930. * |+| moves all matching enabled ciphers to the end of the enabled list, with
  931. * relative order preserved.
  932. *
  933. * |!| deletes all matching ciphers, enabled or not, from either list. Deleted
  934. * ciphers will not matched by future operations.
  935. *
  936. * A selector may be a specific cipher (using the OpenSSL name for the cipher)
  937. * or one or more rules separated by |+|. The final selector matches the
  938. * intersection of each rule. For instance, |AESGCM+aECDSA| matches
  939. * ECDSA-authenticated AES-GCM ciphers.
  940. *
  941. * Available cipher rules are:
  942. *
  943. * |ALL| matches all ciphers.
  944. *
  945. * |kRSA|, |kDHE|, |kECDHE|, and |kPSK| match ciphers using plain RSA, DHE,
  946. * ECDHE, and plain PSK key exchanges, respectively. Note that ECDHE_PSK is
  947. * matched by |kECDHE| and not |kPSK|.
  948. *
  949. * |aRSA|, |aECDSA|, and |aPSK| match ciphers authenticated by RSA, ECDSA, and
  950. * a pre-shared key, respectively.
  951. *
  952. * |RSA|, |DHE|, |ECDHE|, |PSK|, |ECDSA|, and |PSK| are aliases for the
  953. * corresponding |k*| or |a*| cipher rule. |RSA| is an alias for |kRSA|, not
  954. * |aRSA|.
  955. *
  956. * |3DES|, |RC4|, |AES128|, |AES256|, |AES|, |AESGCM|, |CHACHA20| match
  957. * ciphers whose bulk cipher use the corresponding encryption scheme. Note
  958. * that |AES|, |AES128|, and |AES256| match both CBC and GCM ciphers.
  959. *
  960. * |MD5|, |SHA1|, |SHA256|, and |SHA384| match legacy cipher suites using the
  961. * corresponding hash function in their MAC. AEADs are matched by none of
  962. * these.
  963. *
  964. * |SHA| is an alias for |SHA1|.
  965. *
  966. * Although implemented, authentication-only ciphers match no rules and must be
  967. * explicitly selected by name.
  968. *
  969. * Deprecated cipher rules:
  970. *
  971. * |kEDH|, |EDH|, |kEECDH|, and |EECDH| are legacy aliases for |kDHE|, |DHE|,
  972. * |kECDHE|, and |ECDHE|, respectively.
  973. *
  974. * |MEDIUM| and |HIGH| match RC4-based ciphers and all others, respectively.
  975. *
  976. * |FIPS| is an alias for |HIGH|.
  977. *
  978. * |SSLv3| and |TLSv1| match ciphers available in TLS 1.1 or earlier.
  979. * |TLSv1_2| matches ciphers new in TLS 1.2. This is confusing and should not
  980. * be used.
  981. *
  982. * Unknown rules silently match nothing.
  983. *
  984. * The special |@STRENGTH| directive will sort all enabled ciphers by strength.
  985. *
  986. * The |DEFAULT| directive, when appearing at the front of the string, expands
  987. * to the default ordering of available ciphers.
  988. *
  989. * If configuring a server, one may also configure equal-preference groups to
  990. * partially respect the client's preferences when
  991. * |SSL_OP_CIPHER_SERVER_PREFERENCE| is enabled. Ciphers in an equal-preference
  992. * group have equal priority and use the client order. This may be used to
  993. * enforce that AEADs are preferred but select AES-GCM vs. ChaCha20-Poly1305
  994. * based on client preferences. An equal-preference is specified with square
  995. * brackets, combining multiple selectors separated by |. For example:
  996. *
  997. * [ECDHE-ECDSA-CHACHA20-POLY1305|ECDHE-ECDSA-AES128-GCM-SHA256]
  998. *
  999. * Once an equal-preference group is used, future directives must be
  1000. * opcode-less. */
  1001. /* SSL_DEFAULT_CIPHER_LIST is the default cipher suite configuration. It is
  1002. * substituted when a cipher string starts with 'DEFAULT'. */
  1003. #define SSL_DEFAULT_CIPHER_LIST "ALL"
  1004. /* SSL_CTX_set_cipher_list configures the cipher list for |ctx|, evaluating
  1005. * |str| as a cipher string. It returns one on success and zero on failure. */
  1006. OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
  1007. /* SSL_CTX_set_cipher_list_tls10 configures the TLS 1.0+ cipher list for |ctx|,
  1008. * evaluating |str| as a cipher string. It returns one on success and zero on
  1009. * failure. If set, servers will use this cipher suite list for TLS 1.0 or
  1010. * higher. */
  1011. OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls10(SSL_CTX *ctx, const char *str);
  1012. /* SSL_CTX_set_cipher_list_tls11 configures the TLS 1.1+ cipher list for |ctx|,
  1013. * evaluating |str| as a cipher string. It returns one on success and zero on
  1014. * failure. If set, servers will use this cipher suite list for TLS 1.1 or
  1015. * higher. */
  1016. OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *ctx, const char *str);
  1017. /* SSL_set_cipher_list configures the cipher list for |ssl|, evaluating |str| as
  1018. * a cipher string. It returns one on success and zero on failure. */
  1019. OPENSSL_EXPORT int SSL_set_cipher_list(SSL *ssl, const char *str);
  1020. /* SSL_get_ciphers returns the cipher list for |ssl|, in order of preference. If
  1021. * |SSL_CTX_set_cipher_list_tls10| or |SSL_CTX_set_cipher_list_tls11| has been
  1022. * used, the corresponding list for the current version is returned. */
  1023. OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
  1024. /* Connection information. */
  1025. /* SSL_is_init_finished returns one if |ssl| has completed its initial handshake
  1026. * and has no pending handshake. It returns zero otherwise. */
  1027. OPENSSL_EXPORT int SSL_is_init_finished(const SSL *ssl);
  1028. /* SSL_in_init returns one if |ssl| has a pending handshake and zero
  1029. * otherwise. */
  1030. OPENSSL_EXPORT int SSL_in_init(const SSL *ssl);
  1031. /* SSL_in_false_start returns one if |ssl| has a pending handshake that is in
  1032. * False Start. |SSL_write| may be called at this point without waiting for the
  1033. * peer, but |SSL_read| will complete the handshake before accepting application
  1034. * data.
  1035. *
  1036. * See also |SSL_MODE_ENABLE_FALSE_START|. */
  1037. OPENSSL_EXPORT int SSL_in_false_start(const SSL *ssl);
  1038. /* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
  1039. * peer did not use certificates. The caller must call |X509_free| on the
  1040. * result to release it. */
  1041. OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
  1042. /* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
  1043. * unavailable or the peer did not use certificates. This is the unverified
  1044. * list of certificates as sent by the peer, not the final chain built during
  1045. * verification. For historical reasons, this value may not be available if
  1046. * resuming a serialized |SSL_SESSION|. The caller does not take ownership of
  1047. * the result.
  1048. *
  1049. * WARNING: This function behaves differently between client and server. If
  1050. * |ssl| is a server, the returned chain does not include the leaf certificate.
  1051. * If a client, it does. */
  1052. OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
  1053. /* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
  1054. * |*out_len| bytes of SCT information from the server. This is only valid if
  1055. * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
  1056. * (including the two leading length bytes).
  1057. * See https://tools.ietf.org/html/rfc6962#section-3.3
  1058. * If no SCT was received then |*out_len| will be zero on return.
  1059. *
  1060. * WARNING: the returned data is not guaranteed to be well formed. */
  1061. OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
  1062. const uint8_t **out,
  1063. size_t *out_len);
  1064. /* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
  1065. * bytes of an OCSP response from the server. This is the DER encoding of an
  1066. * OCSPResponse type as defined in RFC 2560.
  1067. *
  1068. * WARNING: the returned data is not guaranteed to be well formed. */
  1069. OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
  1070. size_t *out_len);
  1071. /* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
  1072. * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
  1073. * returns one on success or zero on error. In general |max_out| should be at
  1074. * least 12.
  1075. *
  1076. * This function will always fail if the initial handshake has not completed.
  1077. * The tls-unique value will change after a renegotiation but, since
  1078. * renegotiations can be initiated by the server at any point, the higher-level
  1079. * protocol must either leave them disabled or define states in which the
  1080. * tls-unique value can be read.
  1081. *
  1082. * The tls-unique value is defined by
  1083. * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
  1084. * TLS protocol, tls-unique is broken for resumed connections unless the
  1085. * Extended Master Secret extension is negotiated. Thus this function will
  1086. * return zero if |ssl| performed session resumption unless EMS was used when
  1087. * negotiating the original session. */
  1088. OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
  1089. size_t *out_len, size_t max_out);
  1090. /* SSL_get_extms_support returns one if the Extended Master Secret
  1091. * extension was negotiated. Otherwise, it returns zero. */
  1092. OPENSSL_EXPORT int SSL_get_extms_support(const SSL *ssl);
  1093. /* SSL_get_current_cipher returns the cipher used in the current outgoing
  1094. * connection state, or NULL if the null cipher is active. */
  1095. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
  1096. /* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
  1097. * and zero otherwise.
  1098. *
  1099. * TODO(davidben): Hammer down the semantics of this API while a handshake,
  1100. * initial or renego, is in progress. */
  1101. OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
  1102. /* SSL_get_secure_renegotiation_support returns one if the peer supports secure
  1103. * renegotiation (RFC 5746) and zero otherwise. */
  1104. OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
  1105. /* SSL_export_keying_material exports a value derived from the master secret, as
  1106. * specified in RFC 5705. It writes |out_len| bytes to |out| given a label and
  1107. * optional context. (Since a zero length context is allowed, the |use_context|
  1108. * flag controls whether a context is included.)
  1109. *
  1110. * It returns one on success and zero otherwise. */
  1111. OPENSSL_EXPORT int SSL_export_keying_material(
  1112. SSL *ssl, uint8_t *out, size_t out_len, const char *label, size_t label_len,
  1113. const uint8_t *context, size_t context_len, int use_context);
  1114. /* Custom extensions.
  1115. *
  1116. * The custom extension functions allow TLS extensions to be added to
  1117. * ClientHello and ServerHello messages. */
  1118. /* SSL_custom_ext_add_cb is a callback function that is called when the
  1119. * ClientHello (for clients) or ServerHello (for servers) is constructed. In
  1120. * the case of a server, this callback will only be called for a given
  1121. * extension if the ClientHello contained that extension – it's not possible to
  1122. * inject extensions into a ServerHello that the client didn't request.
  1123. *
  1124. * When called, |extension_value| will contain the extension number that is
  1125. * being considered for addition (so that a single callback can handle multiple
  1126. * extensions). If the callback wishes to include the extension, it must set
  1127. * |*out| to point to |*out_len| bytes of extension contents and return one. In
  1128. * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
  1129. * called with the value of |*out| once that data has been copied.
  1130. *
  1131. * If the callback does not wish to add an extension it must return zero.
  1132. *
  1133. * Alternatively, the callback can abort the connection by setting
  1134. * |*out_alert_value| to a TLS alert number and returning -1. */
  1135. typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
  1136. const uint8_t **out, size_t *out_len,
  1137. int *out_alert_value, void *add_arg);
  1138. /* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
  1139. * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
  1140. * this callback is called and passed the |out| pointer that was returned by
  1141. * the add callback. This is to free any dynamically allocated data created by
  1142. * the add callback. */
  1143. typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
  1144. const uint8_t *out, void *add_arg);
  1145. /* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
  1146. * parse an extension from the peer: that is from the ServerHello for a client
  1147. * and from the ClientHello for a server.
  1148. *
  1149. * When called, |extension_value| will contain the extension number and the
  1150. * contents of the extension are |contents_len| bytes at |contents|.
  1151. *
  1152. * The callback must return one to continue the handshake. Otherwise, if it
  1153. * returns zero, a fatal alert with value |*out_alert_value| is sent and the
  1154. * handshake is aborted. */
  1155. typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
  1156. const uint8_t *contents,
  1157. size_t contents_len,
  1158. int *out_alert_value, void *parse_arg);
  1159. /* SSL_extension_supported returns one iff OpenSSL internally handles
  1160. * extensions of type |extension_value|. This can be used to avoid registering
  1161. * custom extension handlers for extensions that a future version of OpenSSL
  1162. * may handle internally. */
  1163. OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
  1164. /* SSL_CTX_add_client_custom_ext registers callback functions for handling
  1165. * custom TLS extensions for client connections.
  1166. *
  1167. * If |add_cb| is NULL then an empty extension will be added in each
  1168. * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
  1169. * this callback.
  1170. *
  1171. * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
  1172. * needs to be freed.
  1173. *
  1174. * It returns one on success or zero on error. It's always an error to register
  1175. * callbacks for the same extension twice, or to register callbacks for an
  1176. * extension that OpenSSL handles internally. See |SSL_extension_supported| to
  1177. * discover, at runtime, which extensions OpenSSL handles internally. */
  1178. OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
  1179. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  1180. SSL_custom_ext_free_cb free_cb, void *add_arg,
  1181. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  1182. /* SSL_CTX_add_server_custom_ext is the same as
  1183. * |SSL_CTX_add_client_custom_ext|, but for server connections.
  1184. *
  1185. * Unlike on the client side, if |add_cb| is NULL no extension will be added.
  1186. * The |add_cb|, if any, will only be called if the ClientHello contained a
  1187. * matching extension. */
  1188. OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
  1189. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  1190. SSL_custom_ext_free_cb free_cb, void *add_arg,
  1191. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  1192. /* Sessions.
  1193. *
  1194. * An |SSL_SESSION| represents an SSL session that may be resumed in an
  1195. * abbreviated handshake. It is reference-counted and immutable. Once
  1196. * established, an |SSL_SESSION| may be shared by multiple |SSL| objects on
  1197. * different threads and must not be modified. */
  1198. DECLARE_LHASH_OF(SSL_SESSION)
  1199. DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
  1200. /* SSL_SESSION_new returns a newly-allocated blank |SSL_SESSION| or NULL on
  1201. * error. This may be useful in writing tests but otherwise should not be
  1202. * used outside the library. */
  1203. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
  1204. /* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
  1205. * of |session|. It then returns |session|. */
  1206. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
  1207. /* SSL_SESSION_free decrements the reference count of |session|. If it reaches
  1208. * zero, all data referenced by |session| and |session| itself are released. */
  1209. OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
  1210. /* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
  1211. * |*out_data| to that buffer and |*out_len| to its length. The caller takes
  1212. * ownership of the buffer and must call |OPENSSL_free| when done. It returns
  1213. * one on success and zero on error. */
  1214. OPENSSL_EXPORT int SSL_SESSION_to_bytes(const SSL_SESSION *in,
  1215. uint8_t **out_data, size_t *out_len);
  1216. /* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
  1217. * identification information, namely the session ID and ticket. */
  1218. OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(const SSL_SESSION *in,
  1219. uint8_t **out_data,
  1220. size_t *out_len);
  1221. /* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
  1222. * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
  1223. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
  1224. size_t in_len);
  1225. /* SSL_SESSION_get_version returns a string describing the TLS version |session|
  1226. * was established at. For example, "TLSv1.2" or "SSLv3". */
  1227. OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *session);
  1228. /* SSL_SESSION_get_id returns a pointer to a buffer containg |session|'s session
  1229. * ID and sets |*out_len| to its length. */
  1230. OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session,
  1231. unsigned *out_len);
  1232. /* SSL_SESSION_get_time returns the time at which |session| was established in
  1233. * seconds since the UNIX epoch. */
  1234. OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *session);
  1235. /* SSL_SESSION_get_timeout returns the lifetime of |session| in seconds. */
  1236. OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *session);
  1237. /* SSL_SESSION_get_key_exchange_info returns a value that describes the
  1238. * strength of the asymmetric operation that provides confidentiality to
  1239. * |session|. Its interpretation depends on the operation used. See the
  1240. * documentation for this value in the |SSL_SESSION| structure. */
  1241. OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(
  1242. const SSL_SESSION *session);
  1243. /* SSL_SESSION_get0_peer return's the peer leaf certificate stored in
  1244. * |session|.
  1245. *
  1246. * TODO(davidben): This should return a const X509 *. */
  1247. OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(const SSL_SESSION *session);
  1248. /* SSL_SESSION_set_time sets |session|'s creation time to |time| and returns
  1249. * |time|. This function may be useful in writing tests but otherwise should not
  1250. * be used. */
  1251. OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *session, long time);
  1252. /* SSL_SESSION_set_timeout sets |session|'s timeout to |timeout| and returns
  1253. * one. This function may be useful in writing tests but otherwise should not
  1254. * be used. */
  1255. OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *session, long timeout);
  1256. /* SSL_SESSION_set1_id_context sets |session|'s session ID context (see
  1257. * |SSL_CTX_set_session_id_context|) to |sid_ctx|. It returns one on success and
  1258. * zero on error. This function may be useful in writing tests but otherwise
  1259. * should not be used. */
  1260. OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *session,
  1261. const uint8_t *sid_ctx,
  1262. unsigned sid_ctx_len);
  1263. /* Session caching.
  1264. *
  1265. * Session caching allows clients to reconnect to a server based on saved
  1266. * parameters from a previous connection.
  1267. *
  1268. * For a server, the library implements a built-in internal session cache as an
  1269. * in-memory hash table. One may also register callbacks to implement a custom
  1270. * external session cache. An external cache may be used in addition to or
  1271. * instead of the internal one. Use |SSL_CTX_set_session_cache_mode| to toggle
  1272. * the internal cache.
  1273. *
  1274. * For a client, the only option is an external session cache. Prior to
  1275. * handshaking, the consumer should look up a session externally (keyed, for
  1276. * instance, by hostname) and use |SSL_set_session| to configure which session
  1277. * to offer. The callbacks may be used to determine when new sessions are
  1278. * available.
  1279. *
  1280. * Note that offering or accepting a session short-circuits most parameter
  1281. * negotiation. Resuming sessions across different configurations may result in
  1282. * surprising behavor. So, for instance, a client implementing a version
  1283. * fallback should shard its session cache by maximum protocol version. */
  1284. /* SSL_SESS_CACHE_OFF disables all session caching. */
  1285. #define SSL_SESS_CACHE_OFF 0x0000
  1286. /* SSL_SESS_CACHE_CLIENT enables session caching for a client. The internal
  1287. * cache is never used on a client, so this only enables the callbacks. */
  1288. #define SSL_SESS_CACHE_CLIENT 0x0001
  1289. /* SSL_SESS_CACHE_SERVER enables session caching for a server. */
  1290. #define SSL_SESS_CACHE_SERVER 0x0002
  1291. /* SSL_SESS_CACHE_SERVER enables session caching for both client and server. */
  1292. #define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
  1293. /* SSL_SESS_CACHE_NO_AUTO_CLEAR disables automatically calling
  1294. * |SSL_CTX_flush_sessions| every 255 connections. */
  1295. #define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
  1296. /* SSL_SESS_CACHE_NO_INTERNAL_LOOKUP, on a server, disables looking up a session
  1297. * from the internal session cache. */
  1298. #define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
  1299. /* SSL_SESS_CACHE_NO_INTERNAL_STORE, on a server, disables storing sessions in
  1300. * the internal session cache. */
  1301. #define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
  1302. /* SSL_SESS_CACHE_NO_INTERNAL, on a server, disables the internal session
  1303. * cache. */
  1304. #define SSL_SESS_CACHE_NO_INTERNAL \
  1305. (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
  1306. /* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
  1307. * |mode|. It returns the previous value. */
  1308. OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
  1309. /* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
  1310. * |ctx| */
  1311. OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
  1312. /* SSL_set_session, for a client, configures |ssl| to offer to resume |session|
  1313. * in the initial handshake and returns one. The caller retains ownership of
  1314. * |session|. */
  1315. OPENSSL_EXPORT int SSL_set_session(SSL *ssl, SSL_SESSION *session);
  1316. /* SSL_get_session returns a non-owning pointer to |ssl|'s session. Prior to the
  1317. * initial handshake beginning, this is the session to be offered, set by
  1318. * |SSL_set_session|. After a handshake has finished, this is the currently
  1319. * active session. Its behavior is undefined while a handshake is progress. */
  1320. OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
  1321. /* SSL_get0_session is an alias for |SSL_get_session|. */
  1322. #define SSL_get0_session SSL_get_session
  1323. /* SSL_get1_session acts like |SSL_get_session| but returns a new reference to
  1324. * the session. */
  1325. OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(SSL *ssl);
  1326. /* SSL_DEFAULT_SESSION_TIMEOUT is the default lifetime, in seconds, of a
  1327. * session. */
  1328. #define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
  1329. /* SSL_CTX_set_timeout sets the lifetime, in seconds, of sessions created in
  1330. * |ctx| to |timeout|. */
  1331. OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long timeout);
  1332. /* SSL_CTX_get_timeout returns the lifetime, in seconds, of sessions created in
  1333. * |ctx|. */
  1334. OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
  1335. /* SSL_CTX_set_session_id_context sets |ctx|'s session ID context to |sid_ctx|.
  1336. * It returns one on success and zero on error. The session ID context is an
  1337. * application-defined opaque byte string. A session will not be used in a
  1338. * connection without a matching session ID context.
  1339. *
  1340. * For a server, if |SSL_VERIFY_PEER| is enabled, it is an error to not set a
  1341. * session ID context.
  1342. *
  1343. * TODO(davidben): Is that check needed? That seems a special case of taking
  1344. * care not to cross-resume across configuration changes, and this is only
  1345. * relevant if a server requires client auth. */
  1346. OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
  1347. const uint8_t *sid_ctx,
  1348. unsigned sid_ctx_len);
  1349. /* SSL_set_session_id_context sets |ssl|'s session ID context to |sid_ctx|. It
  1350. * returns one on success and zero on error. See also
  1351. * |SSL_CTX_set_session_id_context|. */
  1352. OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
  1353. unsigned sid_ctx_len);
  1354. /* SSL_SESSION_CACHE_MAX_SIZE_DEFAULT is the default maximum size of a session
  1355. * cache. */
  1356. #define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
  1357. /* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s internal session
  1358. * cache to |size|. It returns the previous value. */
  1359. OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
  1360. unsigned long size);
  1361. /* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s internal
  1362. * session cache. */
  1363. OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
  1364. /* SSL_CTX_sessions returns |ctx|'s internal session cache. */
  1365. OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
  1366. /* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
  1367. * session cache. */
  1368. OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
  1369. /* SSL_CTX_add_session inserts |session| into |ctx|'s internal session cache. It
  1370. * returns one on success and zero on error or if |session| is already in the
  1371. * cache. The caller retains its reference to |session|. */
  1372. OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session);
  1373. /* SSL_CTX_remove_session removes |session| from |ctx|'s internal session cache.
  1374. * It returns one on success and zero if |session| was not in the cache. */
  1375. OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session);
  1376. /* SSL_CTX_flush_sessions removes all sessions from |ctx| which have expired as
  1377. * of time |time|. If |time| is zero, all sessions are removed. */
  1378. OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long time);
  1379. /* SSL_CTX_sess_set_new_cb sets the callback to be called when a new session is
  1380. * established and ready to be cached. If the session cache is disabled (the
  1381. * appropriate one of |SSL_SESS_CACHE_CLIENT| or |SSL_SESS_CACHE_SERVER| is
  1382. * unset), the callback is not called.
  1383. *
  1384. * The callback is passed a reference to |session|. It returns one if it takes
  1385. * ownership and zero otherwise.
  1386. *
  1387. * Note: For a client, the callback may be called on abbreviated handshakes if a
  1388. * ticket is renewed. Further, it may not be called until some time after
  1389. * |SSL_do_handshake| or |SSL_connect| completes if False Start is enabled. Thus
  1390. * it's recommended to use this callback over checking |SSL_session_reused| on
  1391. * handshake completion.
  1392. *
  1393. * TODO(davidben): Conditioning callbacks on |SSL_SESS_CACHE_CLIENT| or
  1394. * |SSL_SESS_CACHE_SERVER| doesn't make any sense when one could just as easily
  1395. * not supply the callbacks. Removing that condition and the client internal
  1396. * cache would simplify things. */
  1397. OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
  1398. SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *session));
  1399. /* SSL_CTX_sess_get_new_cb returns the callback set by
  1400. * |SSL_CTX_sess_set_new_cb|. */
  1401. OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(
  1402. SSL *ssl, SSL_SESSION *session);
  1403. /* SSL_CTX_sess_set_remove_cb sets a callback which is called when a session is
  1404. * removed from the internal session cache.
  1405. *
  1406. * TODO(davidben): What is the point of this callback? It seems useless since it
  1407. * only fires on sessions in the internal cache. */
  1408. OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
  1409. SSL_CTX *ctx,
  1410. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *session));
  1411. /* SSL_CTX_sess_get_remove_cb returns the callback set by
  1412. * |SSL_CTX_sess_set_remove_cb|. */
  1413. OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
  1414. SSL_CTX *ctx, SSL_SESSION *session);
  1415. /* SSL_CTX_sess_set_get_cb sets a callback to look up a session by ID for a
  1416. * server. The callback is passed the session ID and should return a matching
  1417. * |SSL_SESSION| or NULL if not found. It should set |*out_copy| to zero and
  1418. * return a new reference to the session. This callback is not used for a
  1419. * client.
  1420. *
  1421. * For historical reasons, if |*out_copy| is set to one (default), the SSL
  1422. * library will take a new reference to the returned |SSL_SESSION|, expecting
  1423. * the callback to return a non-owning pointer. This is not recommended. If
  1424. * |ctx| and thus the callback is used on multiple threads, the session may be
  1425. * removed and invalidated before the SSL library calls |SSL_SESSION_up_ref|,
  1426. * whereas the callback may synchronize internally.
  1427. *
  1428. * To look up a session asynchronously, the callback may return
  1429. * |SSL_magic_pending_session_ptr|. See the documentation for that function and
  1430. * |SSL_ERROR_PENDING_SESSION|.
  1431. *
  1432. * If the internal session cache is enabled, the callback is only consulted if
  1433. * the internal cache does not return a match.
  1434. *
  1435. * The callback's |id| parameter is not const for historical reasons, but the
  1436. * contents may not be modified. */
  1437. OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
  1438. SSL_CTX *ctx,
  1439. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *id, int id_len,
  1440. int *out_copy));
  1441. /* SSL_CTX_sess_get_get_cb returns the callback set by
  1442. * |SSL_CTX_sess_set_get_cb|. */
  1443. OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
  1444. SSL *ssl, uint8_t *id, int id_len, int *out_copy);
  1445. /* SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates
  1446. * that the session isn't currently unavailable. |SSL_get_error| will then
  1447. * return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later
  1448. * when the lookup has completed. */
  1449. OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
  1450. /* Session tickets.
  1451. *
  1452. * Session tickets, from RFC 5077, allow session resumption without server-side
  1453. * state. Session tickets are supported in by default but may be disabled with
  1454. * |SSL_OP_NO_TICKET|.
  1455. *
  1456. * On the client, ticket-based sessions use the same APIs as ID-based tickets.
  1457. * Callers do not need to handle them differently.
  1458. *
  1459. * On the server, tickets are encrypted and authenticated with a secret key. By
  1460. * default, an |SSL_CTX| generates a key on creation. Tickets are minted and
  1461. * processed transparently. The following functions may be used to configure a
  1462. * persistent key or implement more custom behavior. */
  1463. /* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
  1464. * |len| bytes of |out|. It returns one on success and zero if |len| is not
  1465. * 48. If |out| is NULL, it returns 48 instead. */
  1466. OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
  1467. size_t len);
  1468. /* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
  1469. * |len| bytes of |in|. It returns one on success and zero if |len| is not
  1470. * 48. If |in| is NULL, it returns 48 instead. */
  1471. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
  1472. size_t len);
  1473. /* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
  1474. * ticket. */
  1475. #define SSL_TICKET_KEY_NAME_LEN 16
  1476. /* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
  1477. * returns one. |callback| will be called when encrypting a new ticket and when
  1478. * decrypting a ticket from the client.
  1479. *
  1480. * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
  1481. * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
  1482. * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
  1483. * for encryption or decryption, based on the mode.
  1484. *
  1485. * When encrypting a new ticket, |encrypt| will be one. It writes a public
  1486. * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
  1487. * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  1488. * |callback| returns 1 on success and -1 on error.
  1489. *
  1490. * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
  1491. * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
  1492. * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  1493. * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
  1494. * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
  1495. * This may be used to re-key the ticket.
  1496. *
  1497. * WARNING: |callback| wildly breaks the usual return value convention and is
  1498. * called in two different modes. */
  1499. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
  1500. SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
  1501. EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
  1502. int encrypt));
  1503. /* Elliptic curve Diffie-Hellman.
  1504. *
  1505. * Cipher suites using an ECDHE key exchange perform Diffie-Hellman over an
  1506. * elliptic curve negotiated by both endpoints. See RFC 4492. Only named curves
  1507. * are supported. ECDHE is always enabled, but the curve preferences may be
  1508. * configured with these functions.
  1509. *
  1510. * A client may use |SSL_SESSION_get_key_exchange_info| to determine the curve
  1511. * selected. */
  1512. /* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
  1513. * element of |curves| should be a curve nid. It returns one on success and
  1514. * zero on failure. */
  1515. OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
  1516. size_t curves_len);
  1517. /* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
  1518. * element of |curves| should be a curve nid. It returns one on success and
  1519. * zero on failure. */
  1520. OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
  1521. size_t curves_len);
  1522. /* SSL_get_curve_name returns a human-readable name for the elliptic curve
  1523. * specified by the given TLS curve id, or NULL if the curve if unknown. */
  1524. OPENSSL_EXPORT const char *SSL_get_curve_name(uint16_t curve_id);
  1525. /* Multiplicative Diffie-Hellman.
  1526. *
  1527. * Cipher suites using a DHE key exchange perform Diffie-Hellman over a
  1528. * multiplicative group selected by the server. These ciphers are disabled for a
  1529. * server unless a group is chosen with one of these functions.
  1530. *
  1531. * A client may use |SSL_SESSION_get_key_exchange_info| to determine the size of
  1532. * the selected group's prime, but note that servers may select degenerate
  1533. * groups. */
  1534. /* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
  1535. * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
  1536. * one on success and zero on error. */
  1537. OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
  1538. /* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
  1539. * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
  1540. * on success and zero on error. */
  1541. OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
  1542. /* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
  1543. * the group for DHE ciphers. |callback| should ignore |is_export| and
  1544. * |keylength| and return a |DH| of the selected group or NULL on error. Only
  1545. * the parameters are used, so the |DH| needn't have a generated keypair.
  1546. *
  1547. * WARNING: The caller does not take ownership of the resulting |DH|, so
  1548. * |callback| must save and release the object elsewhere. */
  1549. OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
  1550. SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
  1551. /* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
  1552. * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
  1553. * and return a |DH| of the selected group or NULL on error. Only the
  1554. * parameters are used, so the |DH| needn't have a generated keypair.
  1555. *
  1556. * WARNING: The caller does not take ownership of the resulting |DH|, so
  1557. * |callback| must save and release the object elsewhere. */
  1558. OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
  1559. DH *(*dh)(SSL *ssl, int is_export,
  1560. int keylength));
  1561. /* Certificate verification.
  1562. *
  1563. * SSL may authenticate either endpoint with an X.509 certificate. Typically
  1564. * this is used to authenticate the server to the client. These functions
  1565. * configure certificate verification.
  1566. *
  1567. * WARNING: By default, certificate verification errors on a client are not
  1568. * fatal. See |SSL_VERIFY_NONE| This may be configured with
  1569. * |SSL_CTX_set_verify|.
  1570. *
  1571. * By default clients are anonymous but a server may request a certificate from
  1572. * the client by setting |SSL_VERIFY_PEER|.
  1573. *
  1574. * Many of these functions use OpenSSL's legacy X.509 stack which is
  1575. * underdocumented and deprecated, but the replacement isn't ready yet. For
  1576. * now, consumers may use the existing stack or bypass it by performing
  1577. * certificate verification externally. This may be done with
  1578. * |SSL_CTX_set_cert_verify_callback| or by extracting the chain with
  1579. * |SSL_get_peer_cert_chain| after the handshake. In the future, functions will
  1580. * be added to use the SSL stack without dependency on any part of the legacy
  1581. * X.509 and ASN.1 stack.
  1582. *
  1583. * To augment certificate verification, a client may also enable OCSP stapling
  1584. * (RFC 6066) and Certificate Transparency (RFC 6962) extensions. */
  1585. /* SSL_VERIFY_NONE, on a client, verifies the server certificate but does not
  1586. * make errors fatal. The result may be checked with |SSL_get_verify_result|. On
  1587. * a server it does not request a client certificate. This is the default. */
  1588. #define SSL_VERIFY_NONE 0x00
  1589. /* SSL_VERIFY_PEER, on a client, makes server certificate errors fatal. On a
  1590. * server it requests a client certificate and makes errors fatal. However,
  1591. * anonymous clients are still allowed. See
  1592. * |SSL_VERIFY_FAIL_IF_NO_PEER_CERT|. */
  1593. #define SSL_VERIFY_PEER 0x01
  1594. /* SSL_VERIFY_FAIL_IF_NO_PEER_CERT configures a server to reject connections if
  1595. * the client declines to send a certificate. Otherwise |SSL_VERIFY_PEER| still
  1596. * allows anonymous clients. */
  1597. #define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
  1598. /* SSL_VERIFY_PEER_IF_NO_OBC configures a server to request a client certificate
  1599. * if and only if Channel ID is not negotiated. */
  1600. #define SSL_VERIFY_PEER_IF_NO_OBC 0x04
  1601. /* SSL_CTX_set_verify configures certificate verification behavior. |mode| is
  1602. * one of the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is
  1603. * used to customize certificate verification. See the behavior of
  1604. * |X509_STORE_CTX_set_verify_cb|.
  1605. *
  1606. * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
  1607. * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
  1608. OPENSSL_EXPORT void SSL_CTX_set_verify(
  1609. SSL_CTX *ctx, int mode, int (*callback)(int ok, X509_STORE_CTX *store_ctx));
  1610. /* SSL_set_verify configures certificate verification behavior. |mode| is one of
  1611. * the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is used to
  1612. * customize certificate verification. See the behavior of
  1613. * |X509_STORE_CTX_set_verify_cb|.
  1614. *
  1615. * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
  1616. * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
  1617. OPENSSL_EXPORT void SSL_set_verify(SSL *ssl, int mode,
  1618. int (*callback)(int ok,
  1619. X509_STORE_CTX *store_ctx));
  1620. /* SSL_CTX_get_verify_mode returns |ctx|'s verify mode, set by
  1621. * |SSL_CTX_set_verify|. */
  1622. OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
  1623. /* SSL_get_verify_mode returns |ssl|'s verify mode, set by |SSL_CTX_set_verify|
  1624. * or |SSL_set_verify|. */
  1625. OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *ssl);
  1626. /* SSL_CTX_get_verify_callback returns the callback set by
  1627. * |SSL_CTX_set_verify|. */
  1628. OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
  1629. int ok, X509_STORE_CTX *store_ctx);
  1630. /* SSL_get_verify_callback returns the callback set by |SSL_CTX_set_verify| or
  1631. * |SSL_set_verify|. */
  1632. OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *ssl))(
  1633. int ok, X509_STORE_CTX *store_ctx);
  1634. /* SSL_CTX_set_verify_depth sets the maximum depth of a certificate chain
  1635. * accepted in verification. This number does not include the leaf, so a depth
  1636. * of 1 allows the leaf and one CA certificate. */
  1637. OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
  1638. /* SSL_set_verify_depth sets the maximum depth of a certificate chain accepted
  1639. * in verification. This number does not include the leaf, so a depth of 1
  1640. * allows the leaf and one CA certificate. */
  1641. OPENSSL_EXPORT void SSL_set_verify_depth(SSL *ssl, int depth);
  1642. /* SSL_CTX_get_verify_depth returns the maximum depth of a certificate accepted
  1643. * in verification. */
  1644. OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
  1645. /* SSL_get_verify_depth returns the maximum depth of a certificate accepted in
  1646. * verification. */
  1647. OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *ssl);
  1648. /* SSL_CTX_set1_param sets verification parameters from |param|. It returns one
  1649. * on success and zero on failure. The caller retains ownership of |param|. */
  1650. OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx,
  1651. const X509_VERIFY_PARAM *param);
  1652. /* SSL_set1_param sets verification parameters from |param|. It returns one on
  1653. * success and zero on failure. The caller retains ownership of |param|. */
  1654. OPENSSL_EXPORT int SSL_set1_param(SSL *ssl,
  1655. const X509_VERIFY_PARAM *param);
  1656. /* SSL_CTX_get0_param returns |ctx|'s |X509_VERIFY_PARAM| for certificate
  1657. * verification. The caller must not release the returned pointer but may call
  1658. * functions on it to configure it. */
  1659. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
  1660. /* SSL_get0_param returns |ssl|'s |X509_VERIFY_PARAM| for certificate
  1661. * verification. The caller must not release the returned pointer but may call
  1662. * functions on it to configure it. */
  1663. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
  1664. /* SSL_CTX_set_purpose sets |ctx|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
  1665. * |purpose|. It returns one on success and zero on error. */
  1666. OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose);
  1667. /* SSL_set_purpose sets |ssl|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
  1668. * |purpose|. It returns one on success and zero on error. */
  1669. OPENSSL_EXPORT int SSL_set_purpose(SSL *ssl, int purpose);
  1670. /* SSL_CTX_set_trust sets |ctx|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
  1671. * |trust|. It returns one on success and zero on error. */
  1672. OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *ctx, int trust);
  1673. /* SSL_set_trust sets |ssl|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
  1674. * |trust|. It returns one on success and zero on error. */
  1675. OPENSSL_EXPORT int SSL_set_trust(SSL *ssl, int trust);
  1676. /* SSL_CTX_set_cert_store sets |ctx|'s certificate store to |store|. It takes
  1677. * ownership of |store|. The store is used for certificate verification.
  1678. *
  1679. * The store is also used for the auto-chaining feature, but this is deprecated.
  1680. * See also |SSL_MODE_NO_AUTO_CHAIN|. */
  1681. OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store);
  1682. /* SSL_CTX_get_cert_store returns |ctx|'s certificate store. */
  1683. OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx);
  1684. /* SSL_CTX_set_default_verify_paths loads the OpenSSL system-default trust
  1685. * anchors into |ctx|'s store. It returns one on success and zero on failure. */
  1686. OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
  1687. /* SSL_CTX_load_verify_locations loads trust anchors into |ctx|'s store from
  1688. * |ca_file| and |ca_dir|, either of which may be NULL. If |ca_file| is passed,
  1689. * it is opened and PEM-encoded CA certificates are read. If |ca_dir| is passed,
  1690. * it is treated as a directory in OpenSSL's hashed directory format. It returns
  1691. * one on success and zero on failure.
  1692. *
  1693. * See
  1694. * https://www.openssl.org/docs/manmaster/ssl/SSL_CTX_load_verify_locations.html
  1695. * for documentation on the directory format. */
  1696. OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
  1697. const char *ca_file,
  1698. const char *ca_dir);
  1699. /* SSL_get_verify_result returns the result of certificate verification. It is
  1700. * either |X509_V_OK| or a |X509_V_ERR_*| value. */
  1701. OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
  1702. /* SSL_set_verify_result overrides the result of certificate verification. */
  1703. OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long result);
  1704. /* SSL_get_ex_data_X509_STORE_CTX_idx returns the ex_data index used to look up
  1705. * the |SSL| associated with an |X509_STORE_CTX| in the verify callback. */
  1706. OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
  1707. /* SSL_CTX_set_cert_verify_callback sets a custom callback to be called on
  1708. * certificate verification rather than |X509_verify_cert|. |store_ctx| contains
  1709. * the verification parameters. The callback should return one on success and
  1710. * zero on fatal error. It may use |X509_STORE_CTX_set_error| to set a
  1711. * verification result.
  1712. *
  1713. * The callback may use either the |arg| parameter or
  1714. * |SSL_get_ex_data_X509_STORE_CTX_idx| to recover the associated |SSL|
  1715. * object. */
  1716. OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
  1717. SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *store_ctx, void *arg),
  1718. void *arg);
  1719. /* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
  1720. * of a connection) to request SCTs from the server. See
  1721. * https://tools.ietf.org/html/rfc6962. It returns one.
  1722. *
  1723. * Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the
  1724. * handshake. */
  1725. OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
  1726. /* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
  1727. * objects created from |ctx|.
  1728. *
  1729. * Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the
  1730. * handshake. */
  1731. OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
  1732. /* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
  1733. * connection) to request a stapled OCSP response from the server. It returns
  1734. * one.
  1735. *
  1736. * Call |SSL_get0_ocsp_response| to recover the OCSP response after the
  1737. * handshake. */
  1738. OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
  1739. /* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
  1740. * created from |ctx|.
  1741. *
  1742. * Call |SSL_get0_ocsp_response| to recover the OCSP response after the
  1743. * handshake. */
  1744. OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
  1745. /* Client certificate CA list.
  1746. *
  1747. * When requesting a client certificate, a server may advertise a list of
  1748. * certificate authorities which are accepted. These functions may be used to
  1749. * configure this list. */
  1750. /* SSL_set_client_CA_list sets |ssl|'s client certificate CA list to
  1751. * |name_list|. It takes ownership of |name_list|. */
  1752. OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *ssl,
  1753. STACK_OF(X509_NAME) *name_list);
  1754. /* SSL_CTX_set_client_CA_list sets |ctx|'s client certificate CA list to
  1755. * |name_list|. It takes ownership of |name_list|. */
  1756. OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
  1757. STACK_OF(X509_NAME) *name_list);
  1758. /* SSL_get_client_CA_list returns |ssl|'s client certificate CA list. If |ssl|
  1759. * has not been configured as a client, this is the list configured by
  1760. * |SSL_CTX_set_client_CA_list|.
  1761. *
  1762. * If configured as a client, it returns the client certificate CA list sent by
  1763. * the server. In this mode, the behavior is undefined except during the
  1764. * callbacks set by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or
  1765. * when the handshake is paused because of them. */
  1766. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *ssl);
  1767. /* SSL_CTX_get_client_CA_list returns |ctx|'s client certificate CA list. */
  1768. OPENSSL_EXPORT STACK_OF(X509_NAME) *
  1769. SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);
  1770. /* SSL_add_client_CA appends |x509|'s subject to the client certificate CA list.
  1771. * It returns one on success or zero on error. The caller retains ownership of
  1772. * |x509|. */
  1773. OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x509);
  1774. /* SSL_CTX_add_client_CA appends |x509|'s subject to the client certificate CA
  1775. * list. It returns one on success or zero on error. The caller retains
  1776. * ownership of |x509|. */
  1777. OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x509);
  1778. /* SSL_load_client_CA_file opens |file| and reads PEM-encoded certificates from
  1779. * it. It returns a newly-allocated stack of the certificate subjects or NULL
  1780. * on error. */
  1781. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
  1782. /* SSL_dup_CA_list makes a deep copy of |list|. It returns the new list on
  1783. * success or NULL on allocation error. */
  1784. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *list);
  1785. /* SSL_add_file_cert_subjects_to_stack behaves like |SSL_load_client_CA_file|
  1786. * but appends the result to |out|. It returns one on success or zero on
  1787. * error. */
  1788. OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
  1789. const char *file);
  1790. /* SSL_add_dir_cert_subjects_to_stack lists files in directory |dir|. It calls
  1791. * |SSL_add_file_cert_subjects_to_stack| on each file and returns one on success
  1792. * or zero on error. */
  1793. OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
  1794. const char *dir);
  1795. /* Server name indication.
  1796. *
  1797. * The server_name extension (RFC 3546) allows the client to advertise the name
  1798. * of the server it is connecting to. This is used in virtual hosting
  1799. * deployments to select one of a several certificates on a single IP. Only the
  1800. * host_name name type is supported. */
  1801. #define TLSEXT_NAMETYPE_host_name 0
  1802. /* SSL_set_tlsext_host_name, for a client, configures |ssl| to advertise |name|
  1803. * in the server_name extension. It returns one on success and zero on error. */
  1804. OPENSSL_EXPORT int SSL_set_tlsext_host_name(SSL *ssl, const char *name);
  1805. /* SSL_get_servername, for a server, returns the hostname supplied by the
  1806. * client or NULL if there was none. The |type| argument must be
  1807. * |TLSEXT_NAMETYPE_host_name|. */
  1808. OPENSSL_EXPORT const char *SSL_get_servername(const SSL *ssl, const int type);
  1809. /* SSL_get_servername_type, for a server, returns |TLSEXT_NAMETYPE_host_name|
  1810. * if the client sent a hostname and -1 otherwise. */
  1811. OPENSSL_EXPORT int SSL_get_servername_type(const SSL *ssl);
  1812. /* SSL_CTX_set_tlsext_servername_callback configures |callback| to be called on
  1813. * the server after ClientHello extensions have been parsed and returns one.
  1814. * The callback may use |SSL_get_servername| to examine the server_name extension
  1815. * and returns a |SSL_TLSEXT_ERR_*| value. The value of |arg| may be set by
  1816. * calling |SSL_CTX_set_tlsext_servername_arg|.
  1817. *
  1818. * If the callback returns |SSL_TLSEXT_ERR_NOACK|, the server_name extension is
  1819. * not acknowledged in the ServerHello. If the return value is
  1820. * |SSL_TLSEXT_ERR_ALERT_FATAL| or |SSL_TLSEXT_ERR_ALERT_WARNING| then
  1821. * |*out_alert| must be set to the alert value to send. */
  1822. OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_callback(
  1823. SSL_CTX *ctx, int (*callback)(SSL *ssl, int *out_alert, void *arg));
  1824. /* SSL_CTX_set_tlsext_servername_arg sets the argument to the servername
  1825. * callback and returns one. See |SSL_CTX_set_tlsext_servername_callback|. */
  1826. OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_arg(SSL_CTX *ctx, void *arg);
  1827. /* SSL_TLSEXT_ERR_* are values returned by some extension-related callbacks. */
  1828. #define SSL_TLSEXT_ERR_OK 0
  1829. #define SSL_TLSEXT_ERR_ALERT_WARNING 1
  1830. #define SSL_TLSEXT_ERR_ALERT_FATAL 2
  1831. #define SSL_TLSEXT_ERR_NOACK 3
  1832. /* Application-layer protocol negotation.
  1833. *
  1834. * The ALPN extension (RFC 7301) allows negotiating different application-layer
  1835. * protocols over a single port. This is used, for example, to negotiate
  1836. * HTTP/2. */
  1837. /* SSL_CTX_set_alpn_protos sets the client ALPN protocol list on |ctx| to
  1838. * |protos|. |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1839. * length-prefixed strings). It returns zero on success and one on failure.
  1840. * Configuring this list enables ALPN on a client.
  1841. *
  1842. * WARNING: this function is dangerous because it breaks the usual return value
  1843. * convention. */
  1844. OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
  1845. unsigned protos_len);
  1846. /* SSL_set_alpn_protos sets the client ALPN protocol list on |ssl| to |protos|.
  1847. * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1848. * length-prefixed strings). It returns zero on success and one on failure.
  1849. * Configuring this list enables ALPN on a client.
  1850. *
  1851. * WARNING: this function is dangerous because it breaks the usual return value
  1852. * convention. */
  1853. OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
  1854. unsigned protos_len);
  1855. /* SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is called
  1856. * during ClientHello processing in order to select an ALPN protocol from the
  1857. * client's list of offered protocols. Configuring this callback enables ALPN on
  1858. * a server.
  1859. *
  1860. * The callback is passed a wire-format (i.e. a series of non-empty, 8-bit
  1861. * length-prefixed strings) ALPN protocol list in |in|. It should set |*out| and
  1862. * |*out_len| to the selected protocol and return |SSL_TLSEXT_ERR_OK| on
  1863. * success. It does not pass ownership of the buffer. Otherwise, it should
  1864. * return |SSL_TLSEXT_ERR_NOACK|. Other |SSL_TLSEXT_ERR_*| values are
  1865. * unimplemented and will be treated as |SSL_TLSEXT_ERR_NOACK|. */
  1866. OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
  1867. SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *out_len,
  1868. const uint8_t *in, unsigned in_len, void *arg),
  1869. void *arg);
  1870. /* SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
  1871. * On return it sets |*out_data| to point to |*out_len| bytes of protocol name
  1872. * (not including the leading length-prefix byte). If the server didn't respond
  1873. * with a negotiated protocol then |*out_len| will be zero. */
  1874. OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl,
  1875. const uint8_t **out_data,
  1876. unsigned *out_len);
  1877. /* Next protocol negotiation.
  1878. *
  1879. * The NPN extension (draft-agl-tls-nextprotoneg-03) is the predecessor to ALPN
  1880. * and deprecated in favor of it. */
  1881. /* SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when a
  1882. * TLS server needs a list of supported protocols for Next Protocol
  1883. * Negotiation. The returned list must be in wire format. The list is returned
  1884. * by setting |*out| to point to it and |*out_len| to its length. This memory
  1885. * will not be modified, but one should assume that |ssl| keeps a reference to
  1886. * it.
  1887. *
  1888. * The callback should return |SSL_TLSEXT_ERR_OK| if it wishes to advertise.
  1889. * Otherwise, no such extension will be included in the ServerHello. */
  1890. OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
  1891. SSL_CTX *ctx,
  1892. int (*cb)(SSL *ssl, const uint8_t **out, unsigned *out_len, void *arg),
  1893. void *arg);
  1894. /* SSL_CTX_set_next_proto_select_cb sets a callback that is called when a client
  1895. * needs to select a protocol from the server's provided list. |*out| must be
  1896. * set to point to the selected protocol (which may be within |in|). The length
  1897. * of the protocol name must be written into |*out_len|. The server's advertised
  1898. * protocols are provided in |in| and |in_len|. The callback can assume that
  1899. * |in| is syntactically valid.
  1900. *
  1901. * The client must select a protocol. It is fatal to the connection if this
  1902. * callback returns a value other than |SSL_TLSEXT_ERR_OK|.
  1903. *
  1904. * Configuring this callback enables NPN on a client. */
  1905. OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
  1906. SSL_CTX *ctx, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
  1907. const uint8_t *in, unsigned in_len, void *arg),
  1908. void *arg);
  1909. /* SSL_get0_next_proto_negotiated sets |*out_data| and |*out_len| to point to
  1910. * the client's requested protocol for this connection. If the client didn't
  1911. * request any protocol, then |*out_data| is set to NULL.
  1912. *
  1913. * Note that the client can request any protocol it chooses. The value returned
  1914. * from this function need not be a member of the list of supported protocols
  1915. * provided by the server. */
  1916. OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *ssl,
  1917. const uint8_t **out_data,
  1918. unsigned *out_len);
  1919. /* SSL_select_next_proto implements the standard protocol selection. It is
  1920. * expected that this function is called from the callback set by
  1921. * |SSL_CTX_set_next_proto_select_cb|.
  1922. *
  1923. * The protocol data is assumed to be a vector of 8-bit, length prefixed byte
  1924. * strings. The length byte itself is not included in the length. A byte
  1925. * string of length 0 is invalid. No byte string may be truncated.
  1926. *
  1927. * The current, but experimental algorithm for selecting the protocol is:
  1928. *
  1929. * 1) If the server doesn't support NPN then this is indicated to the
  1930. * callback. In this case, the client application has to abort the connection
  1931. * or have a default application level protocol.
  1932. *
  1933. * 2) If the server supports NPN, but advertises an empty list then the
  1934. * client selects the first protcol in its list, but indicates via the
  1935. * API that this fallback case was enacted.
  1936. *
  1937. * 3) Otherwise, the client finds the first protocol in the server's list
  1938. * that it supports and selects this protocol. This is because it's
  1939. * assumed that the server has better information about which protocol
  1940. * a client should use.
  1941. *
  1942. * 4) If the client doesn't support any of the server's advertised
  1943. * protocols, then this is treated the same as case 2.
  1944. *
  1945. * It returns either |OPENSSL_NPN_NEGOTIATED| if a common protocol was found, or
  1946. * |OPENSSL_NPN_NO_OVERLAP| if the fallback case was reached. */
  1947. OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *out_len,
  1948. const uint8_t *server,
  1949. unsigned server_len,
  1950. const uint8_t *client,
  1951. unsigned client_len);
  1952. #define OPENSSL_NPN_UNSUPPORTED 0
  1953. #define OPENSSL_NPN_NEGOTIATED 1
  1954. #define OPENSSL_NPN_NO_OVERLAP 2
  1955. /* Channel ID.
  1956. *
  1957. * See draft-balfanz-tls-channelid-01. */
  1958. /* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
  1959. * Channel IDs from clients, or configures a client to send TLS Channel IDs to
  1960. * a server. It returns one. */
  1961. OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
  1962. /* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
  1963. * Channel IDs from clients, or configures a client to send TLS Channel IDs to
  1964. * server. It returns one. */
  1965. OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
  1966. /* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
  1967. * to compatible servers. |private_key| must be a P-256 EC key. It returns one
  1968. * on success and zero on error. */
  1969. OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
  1970. EVP_PKEY *private_key);
  1971. /* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
  1972. * compatible servers. |private_key| must be a P-256 EC key. It returns one on
  1973. * success and zero on error. */
  1974. OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
  1975. /* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server |SSL*|
  1976. * and copies up to the first |max_out| bytes into |out|. The Channel ID
  1977. * consists of the client's P-256 public key as an (x,y) pair where each is a
  1978. * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
  1979. * Channel ID and the length of the complete Channel ID otherwise. */
  1980. OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
  1981. size_t max_out);
  1982. /* SSL_CTX_set_channel_id_cb sets a callback to be called when a TLS Channel ID
  1983. * is requested. The callback may set |*out_pkey| to a key, passing a reference
  1984. * to the caller. If none is returned, the handshake will pause and
  1985. * |SSL_get_error| will return |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|.
  1986. *
  1987. * See also |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|. */
  1988. OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
  1989. SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey));
  1990. /* SSL_CTX_get_channel_id_cb returns the callback set by
  1991. * |SSL_CTX_set_channel_id_cb|. */
  1992. OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(
  1993. SSL *ssl, EVP_PKEY **out_pkey);
  1994. /* DTLS-SRTP.
  1995. *
  1996. * See RFC 5764. */
  1997. /* srtp_protection_profile_st (aka |SRTP_PROTECTION_PROFILE|) is an SRTP
  1998. * profile for use with the use_srtp extension. */
  1999. struct srtp_protection_profile_st {
  2000. const char *name;
  2001. unsigned long id;
  2002. } /* SRTP_PROTECTION_PROFILE */;
  2003. DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
  2004. /* SRTP_* define constants for SRTP profiles. */
  2005. #define SRTP_AES128_CM_SHA1_80 0x0001
  2006. #define SRTP_AES128_CM_SHA1_32 0x0002
  2007. #define SRTP_AES128_F8_SHA1_80 0x0003
  2008. #define SRTP_AES128_F8_SHA1_32 0x0004
  2009. #define SRTP_NULL_SHA1_80 0x0005
  2010. #define SRTP_NULL_SHA1_32 0x0006
  2011. #define SRTP_AEAD_AES_128_GCM 0x0007
  2012. #define SRTP_AEAD_AES_256_GCM 0x0008
  2013. /* SSL_CTX_set_srtp_profiles enables SRTP for all SSL objects created from
  2014. * |ctx|. |profile| contains a colon-separated list of profile names. It returns
  2015. * one on success and zero on failure. */
  2016. OPENSSL_EXPORT int SSL_CTX_set_srtp_profiles(SSL_CTX *ctx,
  2017. const char *profiles);
  2018. /* SSL_set_srtp_profiles enables SRTP for |ssl|. |profile| contains a
  2019. * colon-separated list of profile names. It returns one on success and zero on
  2020. * failure. */
  2021. OPENSSL_EXPORT int SSL_set_srtp_profiles(SSL *ssl, const char *profiles);
  2022. /* SSL_get_srtp_profiles returns the SRTP profiles supported by |ssl|. */
  2023. OPENSSL_EXPORT STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles(
  2024. SSL *ssl);
  2025. /* SSL_get_selected_srtp_profile returns the selected SRTP profile, or NULL if
  2026. * SRTP was not negotiated. */
  2027. OPENSSL_EXPORT const SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(
  2028. SSL *ssl);
  2029. /* Pre-shared keys.
  2030. *
  2031. * Connections may be configured with PSK (Pre-Shared Key) cipher suites. These
  2032. * authenticate using out-of-band pre-shared keys rather than certificates. See
  2033. * RFC 4279.
  2034. *
  2035. * This implementation uses NUL-terminated C strings for identities and identity
  2036. * hints, so values with a NUL character are not supported. (RFC 4279 does not
  2037. * specify the format of an identity.) */
  2038. /* PSK_MAX_IDENTITY_LEN is the maximum supported length of a PSK identity,
  2039. * excluding the NUL terminator. */
  2040. #define PSK_MAX_IDENTITY_LEN 128
  2041. /* PSK_MAX_PSK_LEN is the maximum supported length of a pre-shared key. */
  2042. #define PSK_MAX_PSK_LEN 256
  2043. /* SSL_CTX_set_psk_client_callback sets the callback to be called when PSK is
  2044. * negotiated on the client. This callback must be set to enable PSK cipher
  2045. * suites on the client.
  2046. *
  2047. * The callback is passed the identity hint in |hint| or NULL if none was
  2048. * provided. It should select a PSK identity and write the identity and the
  2049. * corresponding PSK to |identity| and |psk|, respectively. The identity is
  2050. * written as a NUL-terminated C string of length (excluding the NUL terminator)
  2051. * at most |max_identity_len|. The PSK's length must be at most |max_psk_len|.
  2052. * The callback returns the length of the PSK or 0 if no suitable identity was
  2053. * found. */
  2054. OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
  2055. SSL_CTX *ctx,
  2056. unsigned (*psk_client_callback)(
  2057. SSL *ssl, const char *hint, char *identity,
  2058. unsigned max_identity_len, uint8_t *psk, unsigned max_psk_len));
  2059. /* SSL_set_psk_client_callback sets the callback to be called when PSK is
  2060. * negotiated on the client. This callback must be set to enable PSK cipher
  2061. * suites on the client. See also |SSL_CTX_set_psk_client_callback|. */
  2062. OPENSSL_EXPORT void SSL_set_psk_client_callback(
  2063. SSL *ssl, unsigned (*psk_client_callback)(SSL *ssl, const char *hint,
  2064. char *identity,
  2065. unsigned max_identity_len,
  2066. uint8_t *psk,
  2067. unsigned max_psk_len));
  2068. /* SSL_CTX_set_psk_server_callback sets the callback to be called when PSK is
  2069. * negotiated on the server. This callback must be set to enable PSK cipher
  2070. * suites on the server.
  2071. *
  2072. * The callback is passed the identity in |identity|. It should write a PSK of
  2073. * length at most |max_psk_len| to |psk| and return the number of bytes written
  2074. * or zero if the PSK identity is unknown. */
  2075. OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
  2076. SSL_CTX *ctx,
  2077. unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
  2078. uint8_t *psk,
  2079. unsigned max_psk_len));
  2080. /* SSL_set_psk_server_callback sets the callback to be called when PSK is
  2081. * negotiated on the server. This callback must be set to enable PSK cipher
  2082. * suites on the server. See also |SSL_CTX_set_psk_server_callback|. */
  2083. OPENSSL_EXPORT void SSL_set_psk_server_callback(
  2084. SSL *ssl,
  2085. unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
  2086. uint8_t *psk,
  2087. unsigned max_psk_len));
  2088. /* SSL_CTX_use_psk_identity_hint configures server connections to advertise an
  2089. * identity hint of |identity_hint|. It returns one on success and zero on
  2090. * error. */
  2091. OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
  2092. const char *identity_hint);
  2093. /* SSL_use_psk_identity_hint configures server connections to advertise an
  2094. * identity hint of |identity_hint|. It returns one on success and zero on
  2095. * error. */
  2096. OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *ssl,
  2097. const char *identity_hint);
  2098. /* SSL_get_psk_identity_hint returns the PSK identity hint advertised for |ssl|
  2099. * or NULL if there is none. */
  2100. OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *ssl);
  2101. /* SSL_get_psk_identity, after the handshake completes, returns the PSK identity
  2102. * that was negotiated by |ssl| or NULL if PSK was not used. */
  2103. OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *ssl);
  2104. /* Alerts.
  2105. *
  2106. * TLS and SSL 3.0 use alerts to signal error conditions. Alerts have a type
  2107. * (warning or fatal) and description. OpenSSL internally handles fatal alerts
  2108. * with dedicated error codes (see |SSL_AD_REASON_OFFSET|). Except for
  2109. * close_notify, warning alerts are silently ignored and may only be surfaced
  2110. * with |SSL_CTX_set_info_callback|. */
  2111. /* SSL_AD_REASON_OFFSET is the offset between error reasons and |SSL_AD_*|
  2112. * values. Any error code under |ERR_LIB_SSL| with an error reason above this
  2113. * value corresponds to an alert description. Consumers may add or subtract
  2114. * |SSL_AD_REASON_OFFSET| to convert between them.
  2115. *
  2116. * make_errors.go reserves error codes above 1000 for manually-assigned errors.
  2117. * This value must be kept in sync with reservedReasonCode in make_errors.h */
  2118. #define SSL_AD_REASON_OFFSET 1000
  2119. /* SSL_AD_* are alert descriptions for SSL 3.0 and TLS. */
  2120. #define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
  2121. #define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE
  2122. #define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC
  2123. #define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
  2124. #define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
  2125. #define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE
  2126. #define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE
  2127. #define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not used in TLS */
  2128. #define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
  2129. #define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
  2130. #define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
  2131. #define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
  2132. #define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
  2133. #define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER
  2134. #define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA
  2135. #define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED
  2136. #define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR
  2137. #define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
  2138. #define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION
  2139. #define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION
  2140. #define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY
  2141. #define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR
  2142. #define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
  2143. #define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
  2144. #define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
  2145. #define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
  2146. #define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
  2147. #define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
  2148. TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
  2149. #define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
  2150. #define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY
  2151. #define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK
  2152. /* SSL_alert_type_string_long returns a string description of |value| as an
  2153. * alert type (warning or fatal). */
  2154. OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
  2155. /* SSL_alert_desc_string_long returns a string description of |value| as an
  2156. * alert description or "unknown" if unknown. */
  2157. OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
  2158. /* ex_data functions.
  2159. *
  2160. * See |ex_data.h| for details. */
  2161. OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
  2162. OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
  2163. OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
  2164. CRYPTO_EX_unused *unused,
  2165. CRYPTO_EX_dup *dup_func,
  2166. CRYPTO_EX_free *free_func);
  2167. OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx,
  2168. void *data);
  2169. OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *session,
  2170. int idx);
  2171. OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
  2172. CRYPTO_EX_unused *unused,
  2173. CRYPTO_EX_dup *dup_func,
  2174. CRYPTO_EX_free *free_func);
  2175. OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ctx, int idx, void *data);
  2176. OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ctx, int idx);
  2177. OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
  2178. CRYPTO_EX_unused *unused,
  2179. CRYPTO_EX_dup *dup_func,
  2180. CRYPTO_EX_free *free_func);
  2181. /* Low-level record-layer state. */
  2182. /* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
  2183. * the read and write directions. It returns one on success or zero if |ssl|
  2184. * isn't using an RC4-based cipher suite. */
  2185. OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
  2186. const RC4_KEY **write_key);
  2187. /* SSL_get_ivs sets |*out_iv_len| to the length of the IVs for the ciphers
  2188. * underlying |ssl| and sets |*out_read_iv| and |*out_write_iv| to point to the
  2189. * current IVs for the read and write directions. This is only meaningful for
  2190. * connections with implicit IVs (i.e. CBC mode with SSLv3 or TLS 1.0).
  2191. *
  2192. * It returns one on success or zero on error. */
  2193. OPENSSL_EXPORT int SSL_get_ivs(const SSL *ssl, const uint8_t **out_read_iv,
  2194. const uint8_t **out_write_iv,
  2195. size_t *out_iv_len);
  2196. /* SSL_get_key_block_len returns the length of |ssl|'s key block. */
  2197. OPENSSL_EXPORT size_t SSL_get_key_block_len(const SSL *ssl);
  2198. /* SSL_generate_key_block generates |out_len| bytes of key material for |ssl|'s
  2199. * current connection state. */
  2200. OPENSSL_EXPORT int SSL_generate_key_block(const SSL *ssl, uint8_t *out,
  2201. size_t out_len);
  2202. /* SSL_get_read_sequence returns, in TLS, the expected sequence number of the
  2203. * next incoming record in the current epoch. In DTLS, it returns the maximum
  2204. * sequence number received in the current epoch and includes the epoch number
  2205. * in the two most significant bytes. */
  2206. OPENSSL_EXPORT uint64_t SSL_get_read_sequence(const SSL *ssl);
  2207. /* SSL_get_write_sequence returns the sequence number of the next outgoing
  2208. * record in the current epoch. In DTLS, it includes the epoch number in the
  2209. * two most significant bytes. */
  2210. OPENSSL_EXPORT uint64_t SSL_get_write_sequence(const SSL *ssl);
  2211. /* Obscure functions. */
  2212. /* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
  2213. * SSL_SESSION structures so that a test can ensure that outside code agrees on
  2214. * these values. */
  2215. OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
  2216. size_t *ssl_ctx_size,
  2217. size_t *ssl_session_size);
  2218. /* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
  2219. * This callback will be called when sending or receiving low-level record
  2220. * headers, complete handshake messages, ChangeCipherSpec, and alerts.
  2221. * |write_p| is one for outgoing messages and zero for incoming messages.
  2222. *
  2223. * For each record header, |cb| is called with |version| = 0 and |content_type|
  2224. * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
  2225. * this does not include the record body. If the record is sealed, the length
  2226. * in the header is the length of the ciphertext.
  2227. *
  2228. * For each handshake message, ChangeCipherSpec, and alert, |version| is the
  2229. * protocol version and |content_type| is the corresponding record type. The
  2230. * |len| bytes from |buf| contain the handshake message, one-byte
  2231. * ChangeCipherSpec body, and two-byte alert, respectively. */
  2232. OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
  2233. SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
  2234. const void *buf, size_t len, SSL *ssl, void *arg));
  2235. /* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
  2236. * callback. */
  2237. OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
  2238. /* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
  2239. * |SSL_CTX_set_msg_callback| for when this callback is called. */
  2240. OPENSSL_EXPORT void SSL_set_msg_callback(
  2241. SSL *ssl, void (*cb)(int write_p, int version, int content_type,
  2242. const void *buf, size_t len, SSL *ssl, void *arg));
  2243. /* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
  2244. OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
  2245. /* SSL_CTX_set_keylog_callback configures a callback to log key material. This
  2246. * is intended for debugging use with tools like Wireshark. The |cb| function
  2247. * should log |line| followed by a newline, synchronizing with any concurrent
  2248. * access to the log.
  2249. *
  2250. * The format is described in
  2251. * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
  2252. OPENSSL_EXPORT void SSL_CTX_set_keylog_callback(
  2253. SSL_CTX *ctx, void (*cb)(const SSL *ssl, const char *line));
  2254. enum ssl_renegotiate_mode_t {
  2255. ssl_renegotiate_never = 0,
  2256. ssl_renegotiate_once,
  2257. ssl_renegotiate_freely,
  2258. ssl_renegotiate_ignore,
  2259. };
  2260. /* SSL_set_renegotiate_mode configures how |ssl|, a client, reacts to
  2261. * renegotiation attempts by a server. If |ssl| is a server, peer-initiated
  2262. * renegotiations are *always* rejected and this function does nothing.
  2263. *
  2264. * The renegotiation mode defaults to |ssl_renegotiate_never|, but may be set
  2265. * at any point in a connection's lifetime. Set it to |ssl_renegotiate_once| to
  2266. * allow one renegotiation, |ssl_renegotiate_freely| to allow all
  2267. * renegotiations or |ssl_renegotiate_ignore| to ignore HelloRequest messages.
  2268. * Note that ignoring HelloRequest messages may cause the connection to stall
  2269. * if the server waits for the renegotiation to complete.
  2270. *
  2271. * There is no support in BoringSSL for initiating renegotiations as a client
  2272. * or server. */
  2273. OPENSSL_EXPORT void SSL_set_renegotiate_mode(SSL *ssl,
  2274. enum ssl_renegotiate_mode_t mode);
  2275. /* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
  2276. * renegotiation. */
  2277. OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
  2278. /* SSL_total_renegotiations returns the total number of renegotiation handshakes
  2279. * peformed by |ssl|. This includes the pending renegotiation, if any. */
  2280. OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
  2281. /* SSL_MAX_CERT_LIST_DEFAULT is the default maximum length, in bytes, of a peer
  2282. * certificate chain. */
  2283. #define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100
  2284. /* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
  2285. * certificate chain accepted by |ctx|. */
  2286. OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
  2287. /* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
  2288. * certificate chain to |max_cert_list|. This affects how much memory may be
  2289. * consumed during the handshake. */
  2290. OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
  2291. size_t max_cert_list);
  2292. /* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
  2293. * certificate chain accepted by |ssl|. */
  2294. OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
  2295. /* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
  2296. * certificate chain to |max_cert_list|. This affects how much memory may be
  2297. * consumed during the handshake. */
  2298. OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
  2299. /* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
  2300. * sent by |ctx|. Beyond this length, handshake messages and application data
  2301. * will be split into multiple records. It returns one on success or zero on
  2302. * error. */
  2303. OPENSSL_EXPORT int SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
  2304. size_t max_send_fragment);
  2305. /* SSL_set_max_send_fragment sets the maximum length, in bytes, of records sent
  2306. * by |ssl|. Beyond this length, handshake messages and application data will
  2307. * be split into multiple records. It returns one on success or zero on
  2308. * error. */
  2309. OPENSSL_EXPORT int SSL_set_max_send_fragment(SSL *ssl,
  2310. size_t max_send_fragment);
  2311. /* ssl_early_callback_ctx is passed to certain callbacks that are called very
  2312. * early on during the server handshake. At this point, much of the SSL* hasn't
  2313. * been filled out and only the ClientHello can be depended on. */
  2314. struct ssl_early_callback_ctx {
  2315. SSL *ssl;
  2316. const uint8_t *client_hello;
  2317. size_t client_hello_len;
  2318. const uint8_t *session_id;
  2319. size_t session_id_len;
  2320. const uint8_t *cipher_suites;
  2321. size_t cipher_suites_len;
  2322. const uint8_t *compression_methods;
  2323. size_t compression_methods_len;
  2324. const uint8_t *extensions;
  2325. size_t extensions_len;
  2326. };
  2327. /* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
  2328. * extension of the given type. If not found, it returns zero. Otherwise it
  2329. * sets |out_data| to point to the extension contents (not including the type
  2330. * and length bytes), sets |out_len| to the length of the extension contents
  2331. * and returns one. */
  2332. OPENSSL_EXPORT int SSL_early_callback_ctx_extension_get(
  2333. const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
  2334. const uint8_t **out_data, size_t *out_len);
  2335. /* SSL_CTX_set_select_certificate_cb sets a callback that is called before most
  2336. * ClientHello processing and before the decision whether to resume a session
  2337. * is made. The callback may inspect the ClientHello and configure the
  2338. * connection. It may then return one to continue the handshake or zero to
  2339. * pause the handshake to perform an asynchronous operation. If paused,
  2340. * |SSL_get_error| will return |SSL_ERROR_PENDING_CERTIFICATE|.
  2341. *
  2342. * Note: The |ssl_early_callback_ctx| is only valid for the duration of the
  2343. * callback and is not valid while the handshake is paused. Further, unlike with
  2344. * most callbacks, when the handshake loop is resumed, it will not call the
  2345. * callback a second time. The caller must finish reconfiguring the connection
  2346. * before resuming the handshake. */
  2347. OPENSSL_EXPORT void SSL_CTX_set_select_certificate_cb(
  2348. SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
  2349. /* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
  2350. * resumption decision for a ClientHello has been made. It can return one to
  2351. * allow the handshake to continue or zero to cause the handshake to abort. */
  2352. OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
  2353. SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
  2354. /* SSL_ST_* are possible values for |SSL_state| and the bitmasks that make them
  2355. * up. */
  2356. #define SSL_ST_CONNECT 0x1000
  2357. #define SSL_ST_ACCEPT 0x2000
  2358. #define SSL_ST_MASK 0x0FFF
  2359. #define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
  2360. #define SSL_ST_OK 0x03
  2361. #define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
  2362. /* SSL_CB_* are possible values for the |type| parameter in the info
  2363. * callback and the bitmasks that make them up. */
  2364. #define SSL_CB_LOOP 0x01
  2365. #define SSL_CB_EXIT 0x02
  2366. #define SSL_CB_READ 0x04
  2367. #define SSL_CB_WRITE 0x08
  2368. #define SSL_CB_ALERT 0x4000
  2369. #define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
  2370. #define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
  2371. #define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
  2372. #define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
  2373. #define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
  2374. #define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
  2375. #define SSL_CB_HANDSHAKE_START 0x10
  2376. #define SSL_CB_HANDSHAKE_DONE 0x20
  2377. /* SSL_CTX_set_info_callback configures a callback to be run when various
  2378. * events occur during a connection's lifetime. The |type| argumentj determines
  2379. * the type of event and the meaning of the |value| argument. Callbacks must
  2380. * ignore unexpected |type| values.
  2381. *
  2382. * |SSL_CB_READ_ALERT| is signaled for each alert received, warning or fatal.
  2383. * The |value| argument is a 16-bit value where the alert level (either
  2384. * |SSL3_AL_WARNING| or |SSL3_AL_FATAL|) is in the most-significant eight bits and
  2385. * the alert type (one of |SSL_AD_*|) is in the least-significant eight.
  2386. *
  2387. * |SSL_CB_WRITE_ALERT| is signaled for each alert sent. The |value| argument
  2388. * is constructed as with |SSL_CB_READ_ALERT|.
  2389. *
  2390. * |SSL_CB_HANDSHAKE_START| is signaled when a handshake begins. The |value|
  2391. * argument is always one.
  2392. *
  2393. * |SSL_CB_HANDSHAKE_DONE| is signaled when a handshake completes successfully.
  2394. * The |value| argument is always one. If a handshake False Starts, this event
  2395. * may be used to determine when the Finished message is received.
  2396. *
  2397. * The following event types expose implementation details of the handshake
  2398. * state machine. Consuming them is deprecated.
  2399. *
  2400. * |SSL_CB_ACCEPT_LOOP| (respectively, |SSL_CB_CONNECT_LOOP|) is signaled when
  2401. * a server (respectively, client) handshake progresses. The |value| argument
  2402. * is always one. For the duration of the callback, |SSL_state| will return the
  2403. * previous state.
  2404. *
  2405. * |SSL_CB_ACCEPT_EXIT| (respectively, |SSL_CB_CONNECT_EXIT|) is signaled when
  2406. * a server (respectively, client) handshake completes, fails, or is paused.
  2407. * The |value| argument is one if the handshake succeeded and <= 0
  2408. * otherwise. */
  2409. OPENSSL_EXPORT void SSL_CTX_set_info_callback(
  2410. SSL_CTX *ctx, void (*cb)(const SSL *ssl, int type, int value));
  2411. /* SSL_CTX_get_info_callback returns the callback set by
  2412. * |SSL_CTX_set_info_callback|. */
  2413. OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
  2414. int type,
  2415. int value);
  2416. /* SSL_set_info_callback configures a callback to be run at various events
  2417. * during a connection's lifetime. See |SSL_CTX_set_info_callback|. */
  2418. OPENSSL_EXPORT void SSL_set_info_callback(
  2419. SSL *ssl, void (*cb)(const SSL *ssl, int type, int value));
  2420. /* SSL_get_info_callback returns the callback set by |SSL_set_info_callback|. */
  2421. OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
  2422. int type,
  2423. int value);
  2424. /* SSL_state_string_long returns the current state of the handshake state
  2425. * machine as a string. This may be useful for debugging and logging. */
  2426. OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *ssl);
  2427. /* SSL_set_SSL_CTX partially changes |ssl|'s |SSL_CTX|. |ssl| will use the
  2428. * certificate and session_id_context from |ctx|, and |SSL_get_SSL_CTX| will
  2429. * report |ctx|. However most settings and the session cache itself will
  2430. * continue to use the initial |SSL_CTX|. It is often used as part of SNI.
  2431. *
  2432. * TODO(davidben): Make a better story here and get rid of this API. Also
  2433. * determine if there's anything else affected by |SSL_set_SSL_CTX| that
  2434. * matters. Not as many values are affected as one might initially think. The
  2435. * session cache explicitly selects the initial |SSL_CTX|. Most settings are
  2436. * copied at |SSL_new| so |ctx|'s versions don't apply. This, notably, has some
  2437. * consequences for any plans to make |SSL| copy-on-write most of its
  2438. * configuration. */
  2439. OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
  2440. #define SSL_SENT_SHUTDOWN 1
  2441. #define SSL_RECEIVED_SHUTDOWN 2
  2442. /* SSL_get_shutdown returns a bitmask with a subset of |SSL_SENT_SHUTDOWN| and
  2443. * |SSL_RECEIVED_SHUTDOWN| to query whether close_notify was sent or received,
  2444. * respectively. */
  2445. OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
  2446. /* SSL_get_server_key_exchange_hash, on a client, returns the hash the server
  2447. * used to sign the ServerKeyExchange in TLS 1.2. If not applicable, it returns
  2448. * |TLSEXT_hash_none|. */
  2449. OPENSSL_EXPORT uint8_t SSL_get_server_key_exchange_hash(const SSL *ssl);
  2450. /* SSL_get_client_random writes up to |max_out| bytes of the most recent
  2451. * handshake's client_random to |out| and returns the number of bytes written.
  2452. * If |max_out| is zero, it returns the size of the client_random. */
  2453. OPENSSL_EXPORT size_t SSL_get_client_random(const SSL *ssl, uint8_t *out,
  2454. size_t max_out);
  2455. /* SSL_get_server_random writes up to |max_out| bytes of the most recent
  2456. * handshake's server_random to |out| and returns the number of bytes written.
  2457. * If |max_out| is zero, it returns the size of the server_random. */
  2458. OPENSSL_EXPORT size_t SSL_get_server_random(const SSL *ssl, uint8_t *out,
  2459. size_t max_out);
  2460. /* SSL_get_pending_cipher returns the cipher suite for the current handshake or
  2461. * NULL if one has not been negotiated yet or there is no pending handshake. */
  2462. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_pending_cipher(const SSL *ssl);
  2463. /* SSL_CTX_set_retain_only_sha256_of_client_certs, on a server, sets whether
  2464. * only the SHA-256 hash of peer's certificate should be saved in memory and in
  2465. * the session. This can save memory, ticket size and session cache space. If
  2466. * enabled, |SSL_get_peer_certificate| will return NULL after the handshake
  2467. * completes. See the |peer_sha256| field of |SSL_SESSION| for the hash. */
  2468. OPENSSL_EXPORT void SSL_CTX_set_retain_only_sha256_of_client_certs(SSL_CTX *ctx,
  2469. int enable);
  2470. /* Deprecated functions. */
  2471. /* SSL_library_init calls |CRYPTO_library_init| and returns one. */
  2472. OPENSSL_EXPORT int SSL_library_init(void);
  2473. /* SSL_set_reject_peer_renegotiations calls |SSL_set_renegotiate_mode| with
  2474. * |ssl_never_renegotiate| if |reject| is one and |ssl_renegotiate_freely| if
  2475. * zero. */
  2476. OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
  2477. /* SSL_CIPHER_description writes a description of |cipher| into |buf| and
  2478. * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
  2479. * freed with |OPENSSL_free|, or NULL on error.
  2480. *
  2481. * The description includes a trailing newline and has the form:
  2482. * AES128-SHA Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
  2483. *
  2484. * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
  2485. OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
  2486. char *buf, int len);
  2487. /* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
  2488. OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
  2489. typedef void COMP_METHOD;
  2490. /* SSL_COMP_get_compression_methods returns NULL. */
  2491. OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
  2492. /* SSL_COMP_add_compression_method returns one. */
  2493. OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
  2494. /* SSL_COMP_get_name returns NULL. */
  2495. OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
  2496. /* SSLv23_method calls |TLS_method|. */
  2497. OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
  2498. /* These version-specific methods behave exactly like |TLS_method| and
  2499. * |DTLS_method| except they also call |SSL_CTX_set_min_version| and
  2500. * |SSL_CTX_set_max_version| to lock connections to that protocol version. */
  2501. OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
  2502. OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
  2503. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
  2504. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
  2505. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
  2506. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
  2507. /* These client- and server-specific methods call their corresponding generic
  2508. * methods. */
  2509. OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
  2510. OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
  2511. OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
  2512. OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
  2513. OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
  2514. OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
  2515. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
  2516. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
  2517. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
  2518. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
  2519. OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
  2520. OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
  2521. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
  2522. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
  2523. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
  2524. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
  2525. /* SSL_clear resets |ssl| to allow another connection and returns one on success
  2526. * or zero on failure. It returns most configuration state but releases memory
  2527. * associated with the current connection.
  2528. *
  2529. * Free |ssl| and create a new one instead. */
  2530. OPENSSL_EXPORT int SSL_clear(SSL *ssl);
  2531. /* SSL_CTX_set_tmp_rsa_callback does nothing. */
  2532. OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
  2533. SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
  2534. /* SSL_set_tmp_rsa_callback does nothing. */
  2535. OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
  2536. RSA *(*cb)(SSL *ssl, int is_export,
  2537. int keylength));
  2538. /* SSL_CTX_sess_connect returns zero. */
  2539. OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
  2540. /* SSL_CTX_sess_connect_good returns zero. */
  2541. OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
  2542. /* SSL_CTX_sess_connect_renegotiate returns zero. */
  2543. OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
  2544. /* SSL_CTX_sess_accept returns zero. */
  2545. OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
  2546. /* SSL_CTX_sess_accept_renegotiate returns zero. */
  2547. OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
  2548. /* SSL_CTX_sess_accept_good returns zero. */
  2549. OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
  2550. /* SSL_CTX_sess_hits returns zero. */
  2551. OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
  2552. /* SSL_CTX_sess_cb_hits returns zero. */
  2553. OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
  2554. /* SSL_CTX_sess_misses returns zero. */
  2555. OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
  2556. /* SSL_CTX_sess_timeouts returns zero. */
  2557. OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
  2558. /* SSL_CTX_sess_cache_full returns zero. */
  2559. OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
  2560. /* SSL_cutthrough_complete calls |SSL_in_false_start|. */
  2561. OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
  2562. /* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
  2563. OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
  2564. /* SSL_CTX_need_tmp_RSA returns zero. */
  2565. OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
  2566. /* SSL_need_tmp_RSA returns zero. */
  2567. OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
  2568. /* SSL_CTX_set_tmp_rsa returns one. */
  2569. OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
  2570. /* SSL_set_tmp_rsa returns one. */
  2571. OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
  2572. /* SSL_CTX_get_read_ahead returns zero. */
  2573. OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
  2574. /* SSL_CTX_set_read_ahead does nothing. */
  2575. OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
  2576. /* SSL_get_read_ahead returns zero. */
  2577. OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
  2578. /* SSL_set_read_ahead does nothing. */
  2579. OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
  2580. /* SSL_renegotiate put an error on the error queue and returns zero. */
  2581. OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
  2582. /* SSL_set_state does nothing. */
  2583. OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
  2584. /* SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. */
  2585. #define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
  2586. /* i2d_SSL_SESSION serializes |in| to the bytes pointed to by |*pp|. On success,
  2587. * it returns the number of bytes written and advances |*pp| by that many bytes.
  2588. * On failure, it returns -1. If |pp| is NULL, no bytes are written and only the
  2589. * length is returned.
  2590. *
  2591. * Use |SSL_SESSION_to_bytes| instead. */
  2592. OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
  2593. /* d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed
  2594. * to by |*pp|. It returns the new |SSL_SESSION| and advances |*pp| by the
  2595. * number of bytes consumed on success and NULL on failure. The caller takes
  2596. * ownership of the new session and must call |SSL_SESSION_free| when done.
  2597. *
  2598. * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
  2599. *
  2600. * Use |SSL_SESSION_from_bytes| instead. */
  2601. OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
  2602. long length);
  2603. /* i2d_SSL_SESSION_bio serializes |session| and writes the result to |bio|. It
  2604. * returns the number of bytes written on success and <= 0 on error. */
  2605. OPENSSL_EXPORT int i2d_SSL_SESSION_bio(BIO *bio, const SSL_SESSION *session);
  2606. /* d2i_SSL_SESSION_bio reads a serialized |SSL_SESSION| from |bio| and returns a
  2607. * newly-allocated |SSL_SESSION| or NULL on error. If |out| is not NULL, it also
  2608. * frees |*out| and sets |*out| to the new |SSL_SESSION|. */
  2609. OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION_bio(BIO *bio, SSL_SESSION **out);
  2610. /* ERR_load_SSL_strings does nothing. */
  2611. OPENSSL_EXPORT void ERR_load_SSL_strings(void);
  2612. /* SSL_load_error_strings does nothing. */
  2613. OPENSSL_EXPORT void SSL_load_error_strings(void);
  2614. /* SSL_CTX_set_tlsext_use_srtp calls |SSL_CTX_set_srtp_profiles|. It returns
  2615. * zero on success and one on failure.
  2616. *
  2617. * WARNING: this function is dangerous because it breaks the usual return value
  2618. * convention. Use |SSL_CTX_set_srtp_profiles| instead. */
  2619. OPENSSL_EXPORT int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx,
  2620. const char *profiles);
  2621. /* SSL_set_tlsext_use_srtp calls |SSL_set_srtp_profiles|. It returns zero on
  2622. * success and one on failure.
  2623. *
  2624. * WARNING: this function is dangerous because it breaks the usual return value
  2625. * convention. Use |SSL_set_srtp_profiles| instead. */
  2626. OPENSSL_EXPORT int SSL_set_tlsext_use_srtp(SSL *ssl, const char *profiles);
  2627. /* SSL_get_current_compression returns NULL. */
  2628. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
  2629. /* SSL_get_current_expansion returns NULL. */
  2630. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
  2631. #define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
  2632. #define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
  2633. #define SSL_SESSION_set_app_data(s, a) \
  2634. (SSL_SESSION_set_ex_data(s, 0, (char *)a))
  2635. #define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
  2636. #define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
  2637. #define SSL_CTX_set_app_data(ctx, arg) \
  2638. (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
  2639. #define OpenSSL_add_ssl_algorithms() SSL_library_init()
  2640. #define SSLeay_add_ssl_algorithms() SSL_library_init()
  2641. #define SSL_get_cipher(ssl) SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
  2642. #define SSL_get_cipher_bits(ssl, out_alg_bits) \
  2643. SSL_CIPHER_get_bits(SSL_get_current_cipher(ssl), out_alg_bits)
  2644. #define SSL_get_cipher_version(ssl) \
  2645. SSL_CIPHER_get_version(SSL_get_current_cipher(ssl))
  2646. #define SSL_get_cipher_name(ssl) \
  2647. SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
  2648. #define SSL_get_time(session) SSL_SESSION_get_time(session)
  2649. #define SSL_set_time(session, time) SSL_SESSION_set_time((session), (time))
  2650. #define SSL_get_timeout(session) SSL_SESSION_get_timeout(session)
  2651. #define SSL_set_timeout(session, timeout) \
  2652. SSL_SESSION_set_timeout((session), (timeout))
  2653. typedef struct ssl_comp_st SSL_COMP;
  2654. struct ssl_comp_st {
  2655. int id;
  2656. const char *name;
  2657. char *method;
  2658. };
  2659. DECLARE_STACK_OF(SSL_COMP)
  2660. /* The following flags toggle individual protocol versions. This is deprecated.
  2661. * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
  2662. #define SSL_OP_NO_SSLv3 0x02000000L
  2663. #define SSL_OP_NO_TLSv1 0x04000000L
  2664. #define SSL_OP_NO_TLSv1_2 0x08000000L
  2665. #define SSL_OP_NO_TLSv1_1 0x10000000L
  2666. #define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
  2667. #define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
  2668. /* The following flags do nothing and are included only to make it easier to
  2669. * compile code with BoringSSL. */
  2670. #define SSL_MODE_AUTO_RETRY 0
  2671. #define SSL_MODE_RELEASE_BUFFERS 0
  2672. #define SSL_MODE_SEND_CLIENTHELLO_TIME 0
  2673. #define SSL_MODE_SEND_SERVERHELLO_TIME 0
  2674. #define SSL_OP_ALL 0
  2675. #define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
  2676. #define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
  2677. #define SSL_OP_EPHEMERAL_RSA 0
  2678. #define SSL_OP_LEGACY_SERVER_CONNECT 0
  2679. #define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0
  2680. #define SSL_OP_MICROSOFT_SESS_ID_BUG 0
  2681. #define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
  2682. #define SSL_OP_NETSCAPE_CA_DN_BUG 0
  2683. #define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
  2684. #define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
  2685. #define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
  2686. #define SSL_OP_NO_COMPRESSION 0
  2687. #define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
  2688. #define SSL_OP_NO_SSLv2 0
  2689. #define SSL_OP_PKCS1_CHECK_1 0
  2690. #define SSL_OP_PKCS1_CHECK_2 0
  2691. #define SSL_OP_SINGLE_DH_USE 0
  2692. #define SSL_OP_SINGLE_ECDH_USE 0
  2693. #define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
  2694. #define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
  2695. #define SSL_OP_TLS_BLOCK_PADDING_BUG 0
  2696. #define SSL_OP_TLS_D5_BUG 0
  2697. #define SSL_OP_TLS_ROLLBACK_BUG 0
  2698. #define SSL_VERIFY_CLIENT_ONCE 0
  2699. /* SSL_cache_hit calls |SSL_session_resumed|. */
  2700. OPENSSL_EXPORT int SSL_cache_hit(SSL *ssl);
  2701. /* SSL_get_default_timeout returns |SSL_DEFAULT_SESSION_TIMEOUT|. */
  2702. OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *ssl);
  2703. /* SSL_get_version returns a string describing the TLS version used by |ssl|.
  2704. * For example, "TLSv1.2" or "SSLv3". */
  2705. OPENSSL_EXPORT const char *SSL_get_version(const SSL *ssl);
  2706. /* SSL_get_cipher_list returns the name of the |n|th cipher in the output of
  2707. * |SSL_get_ciphers| or NULL if out of range. Use |SSL_get_ciphers| insteads. */
  2708. OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *ssl, int n);
  2709. /* SSL_CTX_set_client_cert_cb sets a callback which is called on the client if
  2710. * the server requests a client certificate and none is configured. On success,
  2711. * the callback should return one and set |*out_x509| to |*out_pkey| to a leaf
  2712. * certificate and private key, respectively, passing ownership. It should
  2713. * return zero to send no certificate and -1 to fail or pause the handshake. If
  2714. * the handshake is paused, |SSL_get_error| will return
  2715. * |SSL_ERROR_WANT_X509_LOOKUP|.
  2716. *
  2717. * The callback may call |SSL_get0_certificate_types| and
  2718. * |SSL_get_client_CA_list| for information on the server's certificate request.
  2719. *
  2720. * Use |SSL_CTX_set_cert_cb| instead. Configuring intermediate certificates with
  2721. * this function is confusing. */
  2722. OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
  2723. SSL_CTX *ctx,
  2724. int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey));
  2725. /* SSL_CTX_get_client_cert_cb returns the callback set by
  2726. * |SSL_CTX_set_client_cert_cb|. */
  2727. OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(
  2728. SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
  2729. #define SSL_NOTHING 1
  2730. #define SSL_WRITING 2
  2731. #define SSL_READING 3
  2732. #define SSL_X509_LOOKUP 4
  2733. #define SSL_CHANNEL_ID_LOOKUP 5
  2734. #define SSL_PENDING_SESSION 7
  2735. #define SSL_CERTIFICATE_SELECTION_PENDING 8
  2736. #define SSL_PRIVATE_KEY_OPERATION 9
  2737. /* SSL_want returns one of the above values to determine what the most recent
  2738. * operation on |ssl| was blocked on. Use |SSL_get_error| instead. */
  2739. OPENSSL_EXPORT int SSL_want(const SSL *ssl);
  2740. #define SSL_want_nothing(ssl) (SSL_want(ssl) == SSL_NOTHING)
  2741. #define SSL_want_read(ssl) (SSL_want(ssl) == SSL_READING)
  2742. #define SSL_want_write(ssl) (SSL_want(ssl) == SSL_WRITING)
  2743. #define SSL_want_x509_lookup(ssl) (SSL_want(ssl) == SSL_X509_LOOKUP)
  2744. #define SSL_want_channel_id_lookup(ssl) (SSL_want(ssl) == SSL_CHANNEL_ID_LOOKUP)
  2745. #define SSL_want_session(ssl) (SSL_want(ssl) == SSL_PENDING_SESSION)
  2746. #define SSL_want_certificate(ssl) \
  2747. (SSL_want(ssl) == SSL_CERTIFICATE_SELECTION_PENDING)
  2748. #define SSL_want_private_key_operation(ssl) \
  2749. (SSL_want(ssl) == SSL_PRIVATE_KEY_OPERATION)
  2750. /* SSL_get_finished writes up to |count| bytes of the Finished message sent by
  2751. * |ssl| to |buf|. It returns the total untruncated length or zero if none has
  2752. * been sent yet.
  2753. *
  2754. * Use |SSL_get_tls_unique| instead. */
  2755. OPENSSL_EXPORT size_t SSL_get_finished(const SSL *ssl, void *buf, size_t count);
  2756. /* SSL_get_peer_finished writes up to |count| bytes of the Finished message
  2757. * received from |ssl|'s peer to |buf|. It returns the total untruncated length
  2758. * or zero if none has been received yet.
  2759. *
  2760. * Use |SSL_get_tls_unique| instead. */
  2761. OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *ssl, void *buf,
  2762. size_t count);
  2763. /* SSL_alert_type_string returns "!". Use |SSL_alert_type_string_long|
  2764. * instead. */
  2765. OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
  2766. /* SSL_alert_desc_string returns "!!". Use |SSL_alert_desc_string_long|
  2767. * instead. */
  2768. OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
  2769. /* SSL_TXT_* expand to strings. */
  2770. #define SSL_TXT_MEDIUM "MEDIUM"
  2771. #define SSL_TXT_HIGH "HIGH"
  2772. #define SSL_TXT_FIPS "FIPS"
  2773. #define SSL_TXT_kRSA "kRSA"
  2774. #define SSL_TXT_kDHE "kDHE"
  2775. #define SSL_TXT_kEDH "kEDH"
  2776. #define SSL_TXT_kECDHE "kECDHE"
  2777. #define SSL_TXT_kEECDH "kEECDH"
  2778. #define SSL_TXT_kPSK "kPSK"
  2779. #define SSL_TXT_aRSA "aRSA"
  2780. #define SSL_TXT_aECDSA "aECDSA"
  2781. #define SSL_TXT_aPSK "aPSK"
  2782. #define SSL_TXT_DH "DH"
  2783. #define SSL_TXT_DHE "DHE"
  2784. #define SSL_TXT_EDH "EDH"
  2785. #define SSL_TXT_RSA "RSA"
  2786. #define SSL_TXT_ECDH "ECDH"
  2787. #define SSL_TXT_ECDHE "ECDHE"
  2788. #define SSL_TXT_EECDH "EECDH"
  2789. #define SSL_TXT_ECDSA "ECDSA"
  2790. #define SSL_TXT_PSK "PSK"
  2791. #define SSL_TXT_3DES "3DES"
  2792. #define SSL_TXT_RC4 "RC4"
  2793. #define SSL_TXT_AES128 "AES128"
  2794. #define SSL_TXT_AES256 "AES256"
  2795. #define SSL_TXT_AES "AES"
  2796. #define SSL_TXT_AES_GCM "AESGCM"
  2797. #define SSL_TXT_CHACHA20 "CHACHA20"
  2798. #define SSL_TXT_MD5 "MD5"
  2799. #define SSL_TXT_SHA1 "SHA1"
  2800. #define SSL_TXT_SHA "SHA"
  2801. #define SSL_TXT_SHA256 "SHA256"
  2802. #define SSL_TXT_SHA384 "SHA384"
  2803. #define SSL_TXT_SSLV3 "SSLv3"
  2804. #define SSL_TXT_TLSV1 "TLSv1"
  2805. #define SSL_TXT_TLSV1_1 "TLSv1.1"
  2806. #define SSL_TXT_TLSV1_2 "TLSv1.2"
  2807. #define SSL_TXT_ALL "ALL"
  2808. #define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
  2809. typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
  2810. /* SSL_state returns the current state of the handshake state machine. */
  2811. OPENSSL_EXPORT int SSL_state(const SSL *ssl);
  2812. #define SSL_get_state(ssl) SSL_state(ssl)
  2813. /* SSL_state_string returns the current state of the handshake state machine as
  2814. * a six-letter string. Use |SSL_state_string_long| for a more intelligible
  2815. * string. */
  2816. OPENSSL_EXPORT const char *SSL_state_string(const SSL *ssl);
  2817. /* SSL_set_shutdown causes |ssl| to behave as if the shutdown bitmask (see
  2818. * |SSL_get_shutdown|) were |mode|. This may be used to skip sending or
  2819. * receiving close_notify in |SSL_shutdown| by causing the implementation to
  2820. * believe the events already happened.
  2821. *
  2822. * It is an error to use |SSL_set_shutdown| to unset a bit that has already been
  2823. * set. Doing so will trigger an |assert| in debug builds and otherwise be
  2824. * ignored.
  2825. *
  2826. * Use |SSL_CTX_set_quiet_shutdown| instead. */
  2827. OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
  2828. /* SSL_CTX_set_tmp_ecdh calls |SSL_CTX_set1_curves| with a one-element list
  2829. * containing |ec_key|'s curve. */
  2830. OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
  2831. /* SSL_set_tmp_ecdh calls |SSL_set1_curves| with a one-element list containing
  2832. * |ec_key|'s curve. */
  2833. OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
  2834. /* Private structures.
  2835. *
  2836. * This structures are exposed for historical reasons, but access to them is
  2837. * deprecated. */
  2838. typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
  2839. typedef struct ssl3_enc_method SSL3_ENC_METHOD;
  2840. typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
  2841. struct ssl_cipher_st {
  2842. /* name is the OpenSSL name for the cipher. */
  2843. const char *name;
  2844. /* id is the cipher suite value bitwise OR-d with 0x03000000. */
  2845. uint32_t id;
  2846. /* algorithm_* are internal fields. See ssl/internal.h for their values. */
  2847. uint32_t algorithm_mkey;
  2848. uint32_t algorithm_auth;
  2849. uint32_t algorithm_enc;
  2850. uint32_t algorithm_mac;
  2851. uint32_t algorithm_prf;
  2852. };
  2853. typedef struct ssl_ecdh_method_st SSL_ECDH_METHOD;
  2854. typedef struct ssl_ecdh_ctx_st {
  2855. const SSL_ECDH_METHOD *method;
  2856. void *data;
  2857. } SSL_ECDH_CTX;
  2858. #define SSL_MAX_SSL_SESSION_ID_LENGTH 32
  2859. #define SSL_MAX_SID_CTX_LENGTH 32
  2860. #define SSL_MAX_MASTER_KEY_LENGTH 48
  2861. struct ssl_session_st {
  2862. CRYPTO_refcount_t references;
  2863. int ssl_version; /* what ssl version session info is being kept in here? */
  2864. /* key_exchange_info contains an indication of the size of the asymmetric
  2865. * primitive used in the handshake that created this session. In the event
  2866. * that two asymmetric operations are used, this value applies to the one
  2867. * that controls the confidentiality of the connection. Its interpretation
  2868. * depends on the primitive that was used; as specified by the cipher suite:
  2869. * DHE: the size, in bits, of the multiplicative group.
  2870. * RSA: the size, in bits, of the modulus.
  2871. * ECDHE: the TLS id for the curve.
  2872. *
  2873. * A zero indicates that the value is unknown. */
  2874. uint32_t key_exchange_info;
  2875. int master_key_length;
  2876. uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
  2877. /* session_id - valid? */
  2878. unsigned int session_id_length;
  2879. uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
  2880. /* this is used to determine whether the session is being reused in
  2881. * the appropriate context. It is up to the application to set this,
  2882. * via SSL_new */
  2883. unsigned int sid_ctx_length;
  2884. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  2885. char *psk_identity;
  2886. /* peer is the peer's certificate. */
  2887. X509 *peer;
  2888. /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
  2889. * reasons, when a client (so the peer is a server), the chain includes
  2890. * |peer|, but when a server it does not. */
  2891. STACK_OF(X509) *cert_chain;
  2892. /* when app_verify_callback accepts a session where the peer's certificate is
  2893. * not ok, we must remember the error for session reuse: */
  2894. long verify_result; /* only for servers */
  2895. long timeout;
  2896. long time;
  2897. const SSL_CIPHER *cipher;
  2898. CRYPTO_EX_DATA ex_data; /* application specific data */
  2899. /* These are used to make removal of session-ids more efficient and to
  2900. * implement a maximum cache size. */
  2901. SSL_SESSION *prev, *next;
  2902. char *tlsext_hostname;
  2903. /* RFC4507 info */
  2904. uint8_t *tlsext_tick; /* Session ticket */
  2905. size_t tlsext_ticklen; /* Session ticket length */
  2906. size_t tlsext_signed_cert_timestamp_list_length;
  2907. uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
  2908. /* The OCSP response that came with the session. */
  2909. size_t ocsp_response_length;
  2910. uint8_t *ocsp_response;
  2911. /* peer_sha256 contains the SHA-256 hash of the peer's certificate if
  2912. * |peer_sha256_valid| is true. */
  2913. uint8_t peer_sha256[SHA256_DIGEST_LENGTH];
  2914. /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
  2915. * SHA-2, depending on TLS version) for the original, full handshake that
  2916. * created a session. This is used by Channel IDs during resumption. */
  2917. uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
  2918. unsigned original_handshake_hash_len;
  2919. uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
  2920. /* extended_master_secret is true if the master secret in this session was
  2921. * generated using EMS and thus isn't vulnerable to the Triple Handshake
  2922. * attack. */
  2923. unsigned extended_master_secret:1;
  2924. /* peer_sha256_valid is non-zero if |peer_sha256| is valid. */
  2925. unsigned peer_sha256_valid:1; /* Non-zero if peer_sha256 is valid */
  2926. /* not_resumable is used to indicate that session resumption is not allowed.
  2927. * Applications can also set this bit for a new session via
  2928. * not_resumable_session_cb to disable session caching and tickets. */
  2929. unsigned not_resumable:1;
  2930. };
  2931. /* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
  2932. * equal-preference groups. For TLS clients, the groups are moot because the
  2933. * server picks the cipher and groups cannot be expressed on the wire. However,
  2934. * for servers, the equal-preference groups allow the client's preferences to
  2935. * be partially respected. (This only has an effect with
  2936. * SSL_OP_CIPHER_SERVER_PREFERENCE).
  2937. *
  2938. * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
  2939. * All elements of a group have the same priority: no ordering is expressed
  2940. * within a group.
  2941. *
  2942. * The values in |ciphers| are in one-to-one correspondence with
  2943. * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
  2944. * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
  2945. * indicate that the corresponding SSL_CIPHER is not the last element of a
  2946. * group, or 0 to indicate that it is.
  2947. *
  2948. * For example, if |in_group_flags| contains all zeros then that indicates a
  2949. * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
  2950. * of the group (i.e. they are all in a one-element group).
  2951. *
  2952. * For a more complex example, consider:
  2953. * ciphers: A B C D E F
  2954. * in_group_flags: 1 1 0 0 1 0
  2955. *
  2956. * That would express the following, order:
  2957. *
  2958. * A E
  2959. * B -> D -> F
  2960. * C
  2961. */
  2962. struct ssl_cipher_preference_list_st {
  2963. STACK_OF(SSL_CIPHER) *ciphers;
  2964. uint8_t *in_group_flags;
  2965. };
  2966. /* ssl_ctx_st (aka |SSL_CTX|) contains configuration common to several SSL
  2967. * connections. */
  2968. struct ssl_ctx_st {
  2969. const SSL_PROTOCOL_METHOD *method;
  2970. /* lock is used to protect various operations on this object. */
  2971. CRYPTO_MUTEX lock;
  2972. /* max_version is the maximum acceptable protocol version. If zero, the
  2973. * maximum supported version, currently (D)TLS 1.2, is used. */
  2974. uint16_t max_version;
  2975. /* min_version is the minimum acceptable protocl version. If zero, the
  2976. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  2977. uint16_t min_version;
  2978. struct ssl_cipher_preference_list_st *cipher_list;
  2979. /* same as above but sorted for lookup */
  2980. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  2981. /* cipher_list_tls10 is the list of ciphers when TLS 1.0 or greater is in
  2982. * use. This only applies to server connections as, for clients, the version
  2983. * number is known at connect time and so the cipher list can be set then. If
  2984. * |cipher_list_tls11| is non-NULL then this applies only to TLS 1.0
  2985. * connections.
  2986. *
  2987. * TODO(agl): this exists to assist in the death of SSLv3. It can hopefully
  2988. * be removed after that. */
  2989. struct ssl_cipher_preference_list_st *cipher_list_tls10;
  2990. /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
  2991. * use. This only applies to server connections as, for clients, the version
  2992. * number is known at connect time and so the cipher list can be set then. */
  2993. struct ssl_cipher_preference_list_st *cipher_list_tls11;
  2994. X509_STORE *cert_store;
  2995. LHASH_OF(SSL_SESSION) *sessions;
  2996. /* Most session-ids that will be cached, default is
  2997. * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
  2998. unsigned long session_cache_size;
  2999. SSL_SESSION *session_cache_head;
  3000. SSL_SESSION *session_cache_tail;
  3001. /* handshakes_since_cache_flush is the number of successful handshakes since
  3002. * the last cache flush. */
  3003. int handshakes_since_cache_flush;
  3004. /* This can have one of 2 values, ored together,
  3005. * SSL_SESS_CACHE_CLIENT,
  3006. * SSL_SESS_CACHE_SERVER,
  3007. * Default is SSL_SESSION_CACHE_SERVER, which means only
  3008. * SSL_accept which cache SSL_SESSIONS. */
  3009. int session_cache_mode;
  3010. /* If timeout is not 0, it is the default timeout value set when SSL_new() is
  3011. * called. This has been put in to make life easier to set things up */
  3012. long session_timeout;
  3013. /* If this callback is not null, it will be called each time a session id is
  3014. * added to the cache. If this function returns 1, it means that the
  3015. * callback will do a SSL_SESSION_free() when it has finished using it.
  3016. * Otherwise, on 0, it means the callback has finished with it. If
  3017. * remove_session_cb is not null, it will be called when a session-id is
  3018. * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
  3019. * it. */
  3020. int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
  3021. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
  3022. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
  3023. int *copy);
  3024. CRYPTO_refcount_t references;
  3025. /* if defined, these override the X509_verify_cert() calls */
  3026. int (*app_verify_callback)(X509_STORE_CTX *store_ctx, void *arg);
  3027. void *app_verify_arg;
  3028. /* Default password callback. */
  3029. pem_password_cb *default_passwd_callback;
  3030. /* Default password callback user data. */
  3031. void *default_passwd_callback_userdata;
  3032. /* get client cert callback */
  3033. int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
  3034. /* get channel id callback */
  3035. void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey);
  3036. CRYPTO_EX_DATA ex_data;
  3037. /* custom_*_extensions stores any callback sets for custom extensions. Note
  3038. * that these pointers will be NULL if the stack would otherwise be empty. */
  3039. STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
  3040. STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
  3041. /* Default values used when no per-SSL value is defined follow */
  3042. void (*info_callback)(const SSL *ssl, int type, int value);
  3043. /* what we put in client cert requests */
  3044. STACK_OF(X509_NAME) *client_CA;
  3045. /* Default values to use in SSL structures follow (these are copied by
  3046. * SSL_new) */
  3047. uint32_t options;
  3048. uint32_t mode;
  3049. uint32_t max_cert_list;
  3050. struct cert_st /* CERT */ *cert;
  3051. /* callback that allows applications to peek at protocol messages */
  3052. void (*msg_callback)(int write_p, int version, int content_type,
  3053. const void *buf, size_t len, SSL *ssl, void *arg);
  3054. void *msg_callback_arg;
  3055. int verify_mode;
  3056. unsigned int sid_ctx_length;
  3057. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  3058. int (*default_verify_callback)(
  3059. int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
  3060. X509_VERIFY_PARAM *param;
  3061. /* select_certificate_cb is called before most ClientHello processing and
  3062. * before the decision whether to resume a session is made. It may return one
  3063. * to continue the handshake or zero to cause the handshake loop to return
  3064. * with an error and cause SSL_get_error to return
  3065. * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
  3066. * will not call the callback a second time. */
  3067. int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
  3068. /* dos_protection_cb is called once the resumption decision for a ClientHello
  3069. * has been made. It returns one to continue the handshake or zero to
  3070. * abort. */
  3071. int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
  3072. /* Maximum amount of data to send in one fragment. actual record size can be
  3073. * more than this due to padding and MAC overheads. */
  3074. uint16_t max_send_fragment;
  3075. /* TLS extensions servername callback */
  3076. int (*tlsext_servername_callback)(SSL *, int *, void *);
  3077. void *tlsext_servername_arg;
  3078. /* RFC 4507 session ticket keys */
  3079. uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
  3080. uint8_t tlsext_tick_hmac_key[16];
  3081. uint8_t tlsext_tick_aes_key[16];
  3082. /* Callback to support customisation of ticket key setting */
  3083. int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
  3084. EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
  3085. /* Server-only: psk_identity_hint is the default identity hint to send in
  3086. * PSK-based key exchanges. */
  3087. char *psk_identity_hint;
  3088. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  3089. char *identity,
  3090. unsigned int max_identity_len,
  3091. uint8_t *psk, unsigned int max_psk_len);
  3092. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  3093. uint8_t *psk, unsigned int max_psk_len);
  3094. /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
  3095. * hash of the peer's certificate and then discard it to save memory and
  3096. * session space. Only effective on the server side. */
  3097. char retain_only_sha256_of_client_certs;
  3098. /* Next protocol negotiation information */
  3099. /* (for experimental NPN extension). */
  3100. /* For a server, this contains a callback function by which the set of
  3101. * advertised protocols can be provided. */
  3102. int (*next_protos_advertised_cb)(SSL *ssl, const uint8_t **out,
  3103. unsigned *out_len, void *arg);
  3104. void *next_protos_advertised_cb_arg;
  3105. /* For a client, this contains a callback function that selects the
  3106. * next protocol from the list provided by the server. */
  3107. int (*next_proto_select_cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
  3108. const uint8_t *in, unsigned in_len, void *arg);
  3109. void *next_proto_select_cb_arg;
  3110. /* ALPN information
  3111. * (we are in the process of transitioning from NPN to ALPN.) */
  3112. /* For a server, this contains a callback function that allows the
  3113. * server to select the protocol for the connection.
  3114. * out: on successful return, this must point to the raw protocol
  3115. * name (without the length prefix).
  3116. * outlen: on successful return, this contains the length of |*out|.
  3117. * in: points to the client's list of supported protocols in
  3118. * wire-format.
  3119. * inlen: the length of |in|. */
  3120. int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *out_len,
  3121. const uint8_t *in, unsigned in_len, void *arg);
  3122. void *alpn_select_cb_arg;
  3123. /* For a client, this contains the list of supported protocols in wire
  3124. * format. */
  3125. uint8_t *alpn_client_proto_list;
  3126. unsigned alpn_client_proto_list_len;
  3127. /* SRTP profiles we are willing to do from RFC 5764 */
  3128. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  3129. /* EC extension values inherited by SSL structure */
  3130. size_t tlsext_ellipticcurvelist_length;
  3131. uint16_t *tlsext_ellipticcurvelist;
  3132. /* The client's Channel ID private key. */
  3133. EVP_PKEY *tlsext_channel_id_private;
  3134. /* Signed certificate timestamp list to be sent to the client, if requested */
  3135. uint8_t *signed_cert_timestamp_list;
  3136. size_t signed_cert_timestamp_list_length;
  3137. /* OCSP response to be sent to the client, if requested. */
  3138. uint8_t *ocsp_response;
  3139. size_t ocsp_response_length;
  3140. /* keylog_callback, if not NULL, is the key logging callback. See
  3141. * |SSL_CTX_set_keylog_callback|. */
  3142. void (*keylog_callback)(const SSL *ssl, const char *line);
  3143. /* current_time_cb, if not NULL, is the function to use to get the current
  3144. * time. It sets |*out_clock| to the current time. */
  3145. void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
  3146. /* quiet_shutdown is true if the connection should not send a close_notify on
  3147. * shutdown. */
  3148. unsigned quiet_shutdown:1;
  3149. /* ocsp_stapling_enabled is only used by client connections and indicates
  3150. * whether OCSP stapling will be requested. */
  3151. unsigned ocsp_stapling_enabled:1;
  3152. /* If true, a client will request certificate timestamps. */
  3153. unsigned signed_cert_timestamps_enabled:1;
  3154. /* tlsext_channel_id_enabled is copied from the |SSL_CTX|. For a server,
  3155. * means that we'll accept Channel IDs from clients. For a client, means that
  3156. * we'll advertise support. */
  3157. unsigned tlsext_channel_id_enabled:1;
  3158. /* extra_certs is a dummy value included for compatibility.
  3159. * TODO(agl): remove once node.js no longer references this. */
  3160. STACK_OF(X509)* extra_certs;
  3161. int freelist_max_len;
  3162. };
  3163. struct ssl_st {
  3164. /* version is the protocol version. */
  3165. int version;
  3166. /* max_version is the maximum acceptable protocol version. If zero, the
  3167. * maximum supported version, currently (D)TLS 1.2, is used. */
  3168. uint16_t max_version;
  3169. /* min_version is the minimum acceptable protocl version. If zero, the
  3170. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  3171. uint16_t min_version;
  3172. /* method is the method table corresponding to the current protocol (DTLS or
  3173. * TLS). */
  3174. const SSL_PROTOCOL_METHOD *method;
  3175. /* There are 2 BIO's even though they are normally both the same. This is so
  3176. * data can be read and written to different handlers */
  3177. BIO *rbio; /* used by SSL_read */
  3178. BIO *wbio; /* used by SSL_write */
  3179. /* bbio, if non-NULL, is a buffer placed in front of |wbio| to pack handshake
  3180. * messages within one flight into a single |BIO_write|.
  3181. *
  3182. * TODO(davidben): This does not work right for DTLS. It assumes the MTU is
  3183. * smaller than the buffer size so that the buffer's internal flushing never
  3184. * kicks in. It also doesn't kick in for DTLS retransmission. Replace this
  3185. * with a better mechanism. */
  3186. BIO *bbio;
  3187. int (*handshake_func)(SSL *);
  3188. /* Imagine that here's a boolean member "init" that is switched as soon as
  3189. * SSL_set_{accept/connect}_state is called for the first time, so that
  3190. * "state" and "handshake_func" are properly initialized. But as
  3191. * handshake_func is == 0 until then, we use this test instead of an "init"
  3192. * member. */
  3193. int shutdown; /* we have shut things down, 0x01 sent, 0x02
  3194. * for received */
  3195. int state; /* where we are */
  3196. BUF_MEM *init_buf; /* buffer used during init */
  3197. uint8_t *init_msg; /* pointer to handshake message body, set by
  3198. ssl3_get_message() */
  3199. int init_num; /* amount read/written */
  3200. int init_off; /* amount read/written */
  3201. struct ssl3_state_st *s3; /* SSLv3 variables */
  3202. struct dtls1_state_st *d1; /* DTLSv1 variables */
  3203. /* callback that allows applications to peek at protocol messages */
  3204. void (*msg_callback)(int write_p, int version, int content_type,
  3205. const void *buf, size_t len, SSL *ssl, void *arg);
  3206. void *msg_callback_arg;
  3207. X509_VERIFY_PARAM *param;
  3208. /* crypto */
  3209. struct ssl_cipher_preference_list_st *cipher_list;
  3210. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  3211. /* session info */
  3212. /* client cert? */
  3213. /* This is used to hold the server certificate used */
  3214. struct cert_st /* CERT */ *cert;
  3215. /* This holds a variable that indicates what we were doing when a 0 or -1 is
  3216. * returned. This is needed for non-blocking IO so we know what request
  3217. * needs re-doing when in SSL_accept or SSL_connect */
  3218. int rwstate;
  3219. /* the session_id_context is used to ensure sessions are only reused
  3220. * in the appropriate context */
  3221. unsigned int sid_ctx_length;
  3222. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  3223. /* This can also be in the session once a session is established */
  3224. SSL_SESSION *session;
  3225. int (*verify_callback)(int ok,
  3226. X509_STORE_CTX *ctx); /* fail if callback returns 0 */
  3227. void (*info_callback)(const SSL *ssl, int type, int value);
  3228. /* Server-only: psk_identity_hint is the identity hint to send in
  3229. * PSK-based key exchanges. */
  3230. char *psk_identity_hint;
  3231. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  3232. char *identity,
  3233. unsigned int max_identity_len,
  3234. uint8_t *psk, unsigned int max_psk_len);
  3235. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  3236. uint8_t *psk, unsigned int max_psk_len);
  3237. SSL_CTX *ctx;
  3238. /* extra application data */
  3239. long verify_result;
  3240. CRYPTO_EX_DATA ex_data;
  3241. /* for server side, keep the list of CA_dn we can use */
  3242. STACK_OF(X509_NAME) *client_CA;
  3243. uint32_t options; /* protocol behaviour */
  3244. uint32_t mode; /* API behaviour */
  3245. uint32_t max_cert_list;
  3246. int client_version; /* what was passed, used for
  3247. * SSLv3/TLS rollback check */
  3248. uint16_t max_send_fragment;
  3249. char *tlsext_hostname;
  3250. /* RFC4507 session ticket expected to be received or sent */
  3251. int tlsext_ticket_expected;
  3252. size_t tlsext_ellipticcurvelist_length;
  3253. uint16_t *tlsext_ellipticcurvelist; /* our list */
  3254. SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
  3255. /* srtp_profiles is the list of configured SRTP protection profiles for
  3256. * DTLS-SRTP. */
  3257. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  3258. /* srtp_profile is the selected SRTP protection profile for
  3259. * DTLS-SRTP. */
  3260. const SRTP_PROTECTION_PROFILE *srtp_profile;
  3261. /* The client's Channel ID private key. */
  3262. EVP_PKEY *tlsext_channel_id_private;
  3263. /* For a client, this contains the list of supported protocols in wire
  3264. * format. */
  3265. uint8_t *alpn_client_proto_list;
  3266. unsigned alpn_client_proto_list_len;
  3267. /* renegotiate_mode controls how peer renegotiation attempts are handled. */
  3268. enum ssl_renegotiate_mode_t renegotiate_mode;
  3269. /* These fields are always NULL and exist only to keep wpa_supplicant happy
  3270. * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
  3271. * don't support. */
  3272. EVP_CIPHER_CTX *enc_read_ctx;
  3273. EVP_MD_CTX *read_hash;
  3274. /* in_handshake is non-zero when we are actually in SSL_accept() or
  3275. * SSL_connect() */
  3276. int in_handshake;
  3277. /* verify_mode is a bitmask of |SSL_VERIFY_*| values. */
  3278. uint8_t verify_mode;
  3279. /* hit is true if this connection is resuming a previous session. */
  3280. unsigned hit:1;
  3281. /* server is true iff the this SSL* is the server half. Note: before the SSL*
  3282. * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
  3283. * the side is not determined. In this state, server is always false. */
  3284. unsigned server:1;
  3285. /* quiet_shutdown is true if the connection should not send a close_notify on
  3286. * shutdown. */
  3287. unsigned quiet_shutdown:1;
  3288. /* Enable signed certificate time stamps. Currently client only. */
  3289. unsigned signed_cert_timestamps_enabled:1;
  3290. /* ocsp_stapling_enabled is only used by client connections and indicates
  3291. * whether OCSP stapling will be requested. */
  3292. unsigned ocsp_stapling_enabled:1;
  3293. /* tlsext_channel_id_enabled is copied from the |SSL_CTX|. For a server,
  3294. * means that we'll accept Channel IDs from clients. For a client, means that
  3295. * we'll advertise support. */
  3296. unsigned tlsext_channel_id_enabled:1;
  3297. /* TODO(agl): remove once node.js not longer references this. */
  3298. int tlsext_status_type;
  3299. };
  3300. typedef struct ssl3_record_st {
  3301. /* type is the record type. */
  3302. uint8_t type;
  3303. /* length is the number of unconsumed bytes in the record. */
  3304. uint16_t length;
  3305. /* data is a non-owning pointer to the first unconsumed byte of the record. */
  3306. uint8_t *data;
  3307. } SSL3_RECORD;
  3308. typedef struct ssl3_buffer_st {
  3309. /* buf is the memory allocated for this buffer. */
  3310. uint8_t *buf;
  3311. /* offset is the offset into |buf| which the buffer contents start at. */
  3312. uint16_t offset;
  3313. /* len is the length of the buffer contents from |buf| + |offset|. */
  3314. uint16_t len;
  3315. /* cap is how much memory beyond |buf| + |offset| is available. */
  3316. uint16_t cap;
  3317. } SSL3_BUFFER;
  3318. typedef struct ssl3_state_st {
  3319. uint8_t read_sequence[8];
  3320. uint8_t write_sequence[8];
  3321. uint8_t server_random[SSL3_RANDOM_SIZE];
  3322. uint8_t client_random[SSL3_RANDOM_SIZE];
  3323. /* have_version is true if the connection's final version is known. Otherwise
  3324. * the version has not been negotiated yet. */
  3325. char have_version;
  3326. /* initial_handshake_complete is true if the initial handshake has
  3327. * completed. */
  3328. char initial_handshake_complete;
  3329. /* read_buffer holds data from the transport to be processed. */
  3330. SSL3_BUFFER read_buffer;
  3331. /* write_buffer holds data to be written to the transport. */
  3332. SSL3_BUFFER write_buffer;
  3333. SSL3_RECORD rrec; /* each decoded record goes in here */
  3334. /* hello_request_len is the number of bytes of HelloRequest received, possibly
  3335. * split over multiple records. */
  3336. uint8_t hello_request_len;
  3337. /* partial write - check the numbers match */
  3338. unsigned int wnum; /* number of bytes sent so far */
  3339. int wpend_tot; /* number bytes written */
  3340. int wpend_type;
  3341. int wpend_ret; /* number of bytes submitted */
  3342. const uint8_t *wpend_buf;
  3343. /* handshake_buffer, if non-NULL, contains the handshake transcript. */
  3344. BUF_MEM *handshake_buffer;
  3345. /* handshake_hash, if initialized with an |EVP_MD|, maintains the handshake
  3346. * hash. For TLS 1.1 and below, it is the SHA-1 half. */
  3347. EVP_MD_CTX handshake_hash;
  3348. /* handshake_md5, if initialized with an |EVP_MD|, maintains the MD5 half of
  3349. * the handshake hash for TLS 1.1 and below. */
  3350. EVP_MD_CTX handshake_md5;
  3351. int warn_alert;
  3352. int fatal_alert;
  3353. /* we allow one fatal and one warning alert to be outstanding, send close
  3354. * alert via the warning alert */
  3355. int alert_dispatch;
  3356. uint8_t send_alert[2];
  3357. int total_renegotiations;
  3358. /* empty_record_count is the number of consecutive empty records received. */
  3359. uint8_t empty_record_count;
  3360. /* warning_alert_count is the number of consecutive warning alerts
  3361. * received. */
  3362. uint8_t warning_alert_count;
  3363. /* aead_read_ctx is the current read cipher state. */
  3364. SSL_AEAD_CTX *aead_read_ctx;
  3365. /* aead_write_ctx is the current write cipher state. */
  3366. SSL_AEAD_CTX *aead_write_ctx;
  3367. /* enc_method is the method table corresponding to the current protocol
  3368. * version. */
  3369. const SSL3_ENC_METHOD *enc_method;
  3370. /* State pertaining to the pending handshake.
  3371. *
  3372. * TODO(davidben): State is current spread all over the place. Move
  3373. * pending handshake state here so it can be managed separately from
  3374. * established connection state in case of renegotiations. */
  3375. struct {
  3376. uint8_t finish_md[EVP_MAX_MD_SIZE];
  3377. int finish_md_len;
  3378. uint8_t peer_finish_md[EVP_MAX_MD_SIZE];
  3379. int peer_finish_md_len;
  3380. unsigned long message_size;
  3381. int message_type;
  3382. /* used to hold the new cipher we are going to use */
  3383. const SSL_CIPHER *new_cipher;
  3384. /* used when SSL_ST_FLUSH_DATA is entered */
  3385. int next_state;
  3386. int reuse_message;
  3387. union {
  3388. /* sent is a bitset where the bits correspond to elements of kExtensions
  3389. * in t1_lib.c. Each bit is set if that extension was sent in a
  3390. * ClientHello. It's not used by servers. */
  3391. uint32_t sent;
  3392. /* received is a bitset, like |sent|, but is used by servers to record
  3393. * which extensions were received from a client. */
  3394. uint32_t received;
  3395. } extensions;
  3396. union {
  3397. /* sent is a bitset where the bits correspond to elements of
  3398. * |client_custom_extensions| in the |SSL_CTX|. Each bit is set if that
  3399. * extension was sent in a ClientHello. It's not used by servers. */
  3400. uint16_t sent;
  3401. /* received is a bitset, like |sent|, but is used by servers to record
  3402. * which custom extensions were received from a client. The bits here
  3403. * correspond to |server_custom_extensions|. */
  3404. uint16_t received;
  3405. } custom_extensions;
  3406. /* SNI extension */
  3407. /* should_ack_sni is used by a server and indicates that the SNI extension
  3408. * should be echoed in the ServerHello. */
  3409. unsigned should_ack_sni:1;
  3410. /* Client-only: cert_req determines if a client certificate is to be sent.
  3411. * This is 0 if no client Certificate message is to be sent, 1 if there is
  3412. * a client certificate, and 2 to send an empty client Certificate
  3413. * message. */
  3414. int cert_req;
  3415. /* Client-only: ca_names contains the list of CAs received in a
  3416. * CertificateRequest message. */
  3417. STACK_OF(X509_NAME) *ca_names;
  3418. /* Client-only: certificate_types contains the set of certificate types
  3419. * received in a CertificateRequest message. */
  3420. uint8_t *certificate_types;
  3421. size_t num_certificate_types;
  3422. uint8_t *key_block;
  3423. uint8_t key_block_length;
  3424. uint8_t new_mac_secret_len;
  3425. uint8_t new_key_len;
  3426. uint8_t new_fixed_iv_len;
  3427. /* Server-only: cert_request is true if a client certificate was
  3428. * requested. */
  3429. int cert_request;
  3430. /* certificate_status_expected is true if OCSP stapling was negotiated and
  3431. * the server is expected to send a CertificateStatus message. (This is
  3432. * used on both the client and server sides.) */
  3433. unsigned certificate_status_expected:1;
  3434. /* ocsp_stapling_requested is true if a client requested OCSP stapling. */
  3435. unsigned ocsp_stapling_requested:1;
  3436. /* Server-only: peer_ellipticcurvelist contains the EC curve IDs advertised
  3437. * by the peer. This is only set on the server's end. The server does not
  3438. * advertise this extension to the client. */
  3439. uint16_t *peer_ellipticcurvelist;
  3440. size_t peer_ellipticcurvelist_length;
  3441. /* extended_master_secret indicates whether the extended master secret
  3442. * computation is used in this handshake. Note that this is different from
  3443. * whether it was used for the current session. If this is a resumption
  3444. * handshake then EMS might be negotiated in the client and server hello
  3445. * messages, but it doesn't matter if the session that's being resumed
  3446. * didn't use it to create the master secret initially. */
  3447. char extended_master_secret;
  3448. /* Client-only: peer_psk_identity_hint is the psk_identity_hint sent by the
  3449. * server when using a PSK key exchange. */
  3450. char *peer_psk_identity_hint;
  3451. /* new_mac_secret_size is unused and exists only until wpa_supplicant can
  3452. * be updated. It is only needed for EAP-FAST, which we don't support. */
  3453. uint8_t new_mac_secret_size;
  3454. /* Client-only: in_false_start is one if there is a pending handshake in
  3455. * False Start. The client may write data at this point. */
  3456. char in_false_start;
  3457. /* server_key_exchange_hash, on a client, is the hash the server used to
  3458. * sign the ServerKeyExchange in TLS 1.2. If not applicable, it is
  3459. * |TLSEXT_hash_none|. */
  3460. uint8_t server_key_exchange_hash;
  3461. /* ecdh_ctx is the current ECDH instance. */
  3462. SSL_ECDH_CTX ecdh_ctx;
  3463. /* peer_key is the peer's ECDH key. */
  3464. uint8_t *peer_key;
  3465. uint16_t peer_key_len;
  3466. } tmp;
  3467. /* Connection binding to prevent renegotiation attacks */
  3468. uint8_t previous_client_finished[EVP_MAX_MD_SIZE];
  3469. uint8_t previous_client_finished_len;
  3470. uint8_t previous_server_finished[EVP_MAX_MD_SIZE];
  3471. uint8_t previous_server_finished_len;
  3472. int send_connection_binding; /* TODOEKR */
  3473. /* Set if we saw the Next Protocol Negotiation extension from our peer. */
  3474. int next_proto_neg_seen;
  3475. /* Next protocol negotiation. For the client, this is the protocol that we
  3476. * sent in NextProtocol and is set when handling ServerHello extensions.
  3477. *
  3478. * For a server, this is the client's selected_protocol from NextProtocol and
  3479. * is set when handling the NextProtocol message, before the Finished
  3480. * message. */
  3481. uint8_t *next_proto_negotiated;
  3482. size_t next_proto_negotiated_len;
  3483. /* ALPN information
  3484. * (we are in the process of transitioning from NPN to ALPN.) */
  3485. /* In a server these point to the selected ALPN protocol after the
  3486. * ClientHello has been processed. In a client these contain the protocol
  3487. * that the server selected once the ServerHello has been processed. */
  3488. uint8_t *alpn_selected;
  3489. size_t alpn_selected_len;
  3490. /* In a client, this means that the server supported Channel ID and that a
  3491. * Channel ID was sent. In a server it means that we echoed support for
  3492. * Channel IDs and that tlsext_channel_id will be valid after the
  3493. * handshake. */
  3494. char tlsext_channel_id_valid;
  3495. /* For a server:
  3496. * If |tlsext_channel_id_valid| is true, then this contains the
  3497. * verified Channel ID from the client: a P256 point, (x,y), where
  3498. * each are big-endian values. */
  3499. uint8_t tlsext_channel_id[64];
  3500. } SSL3_STATE;
  3501. /* Android compatibility section (hidden).
  3502. *
  3503. * These functions are declared, temporarily, for Android because
  3504. * wpa_supplicant will take a little time to sync with upstream. Outside of
  3505. * Android they'll have no definition. */
  3506. #define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
  3507. OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
  3508. int ext_len);
  3509. OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
  3510. OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
  3511. OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
  3512. /* Nodejs compatibility section (hidden).
  3513. *
  3514. * These defines exist for node.js, with the hope that we can eliminate the
  3515. * need for them over time. */
  3516. #define SSLerr(function, reason) \
  3517. ERR_put_error(ERR_LIB_SSL, 0, reason, __FILE__, __LINE__)
  3518. /* Preprocessor compatibility section (hidden).
  3519. *
  3520. * Historically, a number of APIs were implemented in OpenSSL as macros and
  3521. * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
  3522. * section defines a number of legacy macros.
  3523. *
  3524. * Although using either the CTRL values or their wrapper macros in #ifdefs is
  3525. * still supported, the CTRL values may not be passed to |SSL_ctrl| and
  3526. * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
  3527. #define DTLS_CTRL_GET_TIMEOUT doesnt_exist
  3528. #define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
  3529. #define SSL_CTRL_CHAIN doesnt_exist
  3530. #define SSL_CTRL_CHAIN_CERT doesnt_exist
  3531. #define SSL_CTRL_CHANNEL_ID doesnt_exist
  3532. #define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
  3533. #define SSL_CTRL_CLEAR_MODE doesnt_exist
  3534. #define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
  3535. #define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
  3536. #define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
  3537. #define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
  3538. #define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
  3539. #define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
  3540. #define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
  3541. #define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
  3542. #define SSL_CTRL_GET_READ_AHEAD doesnt_exist
  3543. #define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
  3544. #define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
  3545. #define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
  3546. #define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
  3547. #define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
  3548. #define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
  3549. #define SSL_CTRL_MODE doesnt_exist
  3550. #define SSL_CTRL_NEED_TMP_RSA doesnt_exist
  3551. #define SSL_CTRL_OPTIONS doesnt_exist
  3552. #define SSL_CTRL_SESS_NUMBER doesnt_exist
  3553. #define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
  3554. #define SSL_CTRL_SET_CURVES doesnt_exist
  3555. #define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
  3556. #define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
  3557. #define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
  3558. #define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
  3559. #define SSL_CTRL_SET_MTU doesnt_exist
  3560. #define SSL_CTRL_SET_READ_AHEAD doesnt_exist
  3561. #define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
  3562. #define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
  3563. #define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
  3564. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
  3565. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
  3566. #define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
  3567. #define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
  3568. #define SSL_CTRL_SET_TMP_DH doesnt_exist
  3569. #define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
  3570. #define SSL_CTRL_SET_TMP_ECDH doesnt_exist
  3571. #define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
  3572. #define SSL_CTRL_SET_TMP_RSA doesnt_exist
  3573. #define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
  3574. #define DTLSv1_get_timeout DTLSv1_get_timeout
  3575. #define DTLSv1_handle_timeout DTLSv1_handle_timeout
  3576. #define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
  3577. #define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
  3578. #define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
  3579. #define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
  3580. #define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
  3581. #define SSL_CTX_clear_mode SSL_CTX_clear_mode
  3582. #define SSL_CTX_clear_options SSL_CTX_clear_options
  3583. #define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
  3584. #define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
  3585. #define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
  3586. #define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
  3587. #define SSL_CTX_get_mode SSL_CTX_get_mode
  3588. #define SSL_CTX_get_options SSL_CTX_get_options
  3589. #define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
  3590. #define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
  3591. #define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
  3592. #define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
  3593. #define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
  3594. #define SSL_CTX_sess_number SSL_CTX_sess_number
  3595. #define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
  3596. #define SSL_CTX_set0_chain SSL_CTX_set0_chain
  3597. #define SSL_CTX_set1_chain SSL_CTX_set1_chain
  3598. #define SSL_CTX_set1_curves SSL_CTX_set1_curves
  3599. #define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
  3600. #define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
  3601. #define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
  3602. #define SSL_CTX_set_mode SSL_CTX_set_mode
  3603. #define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
  3604. #define SSL_CTX_set_options SSL_CTX_set_options
  3605. #define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
  3606. #define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
  3607. #define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
  3608. #define SSL_CTX_set_tlsext_servername_callback \
  3609. SSL_CTX_set_tlsext_servername_callback
  3610. #define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
  3611. #define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
  3612. #define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
  3613. #define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
  3614. #define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
  3615. #define SSL_add0_chain_cert SSL_add0_chain_cert
  3616. #define SSL_add1_chain_cert SSL_add1_chain_cert
  3617. #define SSL_clear_chain_certs SSL_clear_chain_certs
  3618. #define SSL_clear_mode SSL_clear_mode
  3619. #define SSL_clear_options SSL_clear_options
  3620. #define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
  3621. #define SSL_get0_certificate_types SSL_get0_certificate_types
  3622. #define SSL_get0_chain_certs SSL_get0_chain_certs
  3623. #define SSL_get_max_cert_list SSL_get_max_cert_list
  3624. #define SSL_get_mode SSL_get_mode
  3625. #define SSL_get_options SSL_get_options
  3626. #define SSL_get_secure_renegotiation_support \
  3627. SSL_get_secure_renegotiation_support
  3628. #define SSL_get_tls_channel_id SSL_get_tls_channel_id
  3629. #define SSL_need_tmp_RSA SSL_need_tmp_RSA
  3630. #define SSL_num_renegotiations SSL_num_renegotiations
  3631. #define SSL_session_reused SSL_session_reused
  3632. #define SSL_set0_chain SSL_set0_chain
  3633. #define SSL_set1_chain SSL_set1_chain
  3634. #define SSL_set1_curves SSL_set1_curves
  3635. #define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
  3636. #define SSL_set_max_cert_list SSL_set_max_cert_list
  3637. #define SSL_set_max_send_fragment SSL_set_max_send_fragment
  3638. #define SSL_set_mode SSL_set_mode
  3639. #define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
  3640. #define SSL_set_mtu SSL_set_mtu
  3641. #define SSL_set_options SSL_set_options
  3642. #define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
  3643. #define SSL_set_tmp_dh SSL_set_tmp_dh
  3644. #define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
  3645. #define SSL_set_tmp_rsa SSL_set_tmp_rsa
  3646. #define SSL_total_renegotiations SSL_total_renegotiations
  3647. #if defined(__cplusplus)
  3648. } /* extern C */
  3649. #endif
  3650. #define SSL_R_APP_DATA_IN_HANDSHAKE 100
  3651. #define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
  3652. #define SSL_R_BAD_ALERT 102
  3653. #define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
  3654. #define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
  3655. #define SSL_R_BAD_DH_P_LENGTH 105
  3656. #define SSL_R_BAD_DIGEST_LENGTH 106
  3657. #define SSL_R_BAD_ECC_CERT 107
  3658. #define SSL_R_BAD_ECPOINT 108
  3659. #define SSL_R_BAD_HANDSHAKE_RECORD 109
  3660. #define SSL_R_BAD_HELLO_REQUEST 110
  3661. #define SSL_R_BAD_LENGTH 111
  3662. #define SSL_R_BAD_PACKET_LENGTH 112
  3663. #define SSL_R_BAD_RSA_ENCRYPT 113
  3664. #define SSL_R_BAD_SIGNATURE 114
  3665. #define SSL_R_BAD_SRTP_MKI_VALUE 115
  3666. #define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 116
  3667. #define SSL_R_BAD_SSL_FILETYPE 117
  3668. #define SSL_R_BAD_WRITE_RETRY 118
  3669. #define SSL_R_BIO_NOT_SET 119
  3670. #define SSL_R_BN_LIB 120
  3671. #define SSL_R_BUFFER_TOO_SMALL 121
  3672. #define SSL_R_CA_DN_LENGTH_MISMATCH 122
  3673. #define SSL_R_CA_DN_TOO_LONG 123
  3674. #define SSL_R_CCS_RECEIVED_EARLY 124
  3675. #define SSL_R_CERTIFICATE_VERIFY_FAILED 125
  3676. #define SSL_R_CERT_CB_ERROR 126
  3677. #define SSL_R_CERT_LENGTH_MISMATCH 127
  3678. #define SSL_R_CHANNEL_ID_NOT_P256 128
  3679. #define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 129
  3680. #define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 130
  3681. #define SSL_R_CLIENTHELLO_PARSE_FAILED 131
  3682. #define SSL_R_CLIENTHELLO_TLSEXT 132
  3683. #define SSL_R_CONNECTION_REJECTED 133
  3684. #define SSL_R_CONNECTION_TYPE_NOT_SET 134
  3685. #define SSL_R_CUSTOM_EXTENSION_ERROR 135
  3686. #define SSL_R_DATA_LENGTH_TOO_LONG 136
  3687. #define SSL_R_DECODE_ERROR 137
  3688. #define SSL_R_DECRYPTION_FAILED 138
  3689. #define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 139
  3690. #define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 140
  3691. #define SSL_R_DH_P_TOO_LONG 141
  3692. #define SSL_R_DIGEST_CHECK_FAILED 142
  3693. #define SSL_R_DTLS_MESSAGE_TOO_BIG 143
  3694. #define SSL_R_ECC_CERT_NOT_FOR_SIGNING 144
  3695. #define SSL_R_EMS_STATE_INCONSISTENT 145
  3696. #define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 146
  3697. #define SSL_R_ERROR_ADDING_EXTENSION 147
  3698. #define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 148
  3699. #define SSL_R_ERROR_PARSING_EXTENSION 149
  3700. #define SSL_R_EXCESSIVE_MESSAGE_SIZE 150
  3701. #define SSL_R_EXTRA_DATA_IN_MESSAGE 151
  3702. #define SSL_R_FRAGMENT_MISMATCH 152
  3703. #define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 153
  3704. #define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 154
  3705. #define SSL_R_HTTPS_PROXY_REQUEST 155
  3706. #define SSL_R_HTTP_REQUEST 156
  3707. #define SSL_R_INAPPROPRIATE_FALLBACK 157
  3708. #define SSL_R_INVALID_COMMAND 158
  3709. #define SSL_R_INVALID_MESSAGE 159
  3710. #define SSL_R_INVALID_SSL_SESSION 160
  3711. #define SSL_R_INVALID_TICKET_KEYS_LENGTH 161
  3712. #define SSL_R_LENGTH_MISMATCH 162
  3713. #define SSL_R_LIBRARY_HAS_NO_CIPHERS 163
  3714. #define SSL_R_MISSING_EXTENSION 164
  3715. #define SSL_R_MISSING_RSA_CERTIFICATE 165
  3716. #define SSL_R_MISSING_TMP_DH_KEY 166
  3717. #define SSL_R_MISSING_TMP_ECDH_KEY 167
  3718. #define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 168
  3719. #define SSL_R_MTU_TOO_SMALL 169
  3720. #define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 170
  3721. #define SSL_R_NESTED_GROUP 171
  3722. #define SSL_R_NO_CERTIFICATES_RETURNED 172
  3723. #define SSL_R_NO_CERTIFICATE_ASSIGNED 173
  3724. #define SSL_R_NO_CERTIFICATE_SET 174
  3725. #define SSL_R_NO_CIPHERS_AVAILABLE 175
  3726. #define SSL_R_NO_CIPHERS_PASSED 176
  3727. #define SSL_R_NO_CIPHER_MATCH 177
  3728. #define SSL_R_NO_COMPRESSION_SPECIFIED 178
  3729. #define SSL_R_NO_METHOD_SPECIFIED 179
  3730. #define SSL_R_NO_P256_SUPPORT 180
  3731. #define SSL_R_NO_PRIVATE_KEY_ASSIGNED 181
  3732. #define SSL_R_NO_RENEGOTIATION 182
  3733. #define SSL_R_NO_REQUIRED_DIGEST 183
  3734. #define SSL_R_NO_SHARED_CIPHER 184
  3735. #define SSL_R_NULL_SSL_CTX 185
  3736. #define SSL_R_NULL_SSL_METHOD_PASSED 186
  3737. #define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 187
  3738. #define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 188
  3739. #define SSL_R_OUTPUT_ALIASES_INPUT 189
  3740. #define SSL_R_PARSE_TLSEXT 190
  3741. #define SSL_R_PATH_TOO_LONG 191
  3742. #define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 192
  3743. #define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 193
  3744. #define SSL_R_PROTOCOL_IS_SHUTDOWN 194
  3745. #define SSL_R_PSK_IDENTITY_NOT_FOUND 195
  3746. #define SSL_R_PSK_NO_CLIENT_CB 196
  3747. #define SSL_R_PSK_NO_SERVER_CB 197
  3748. #define SSL_R_READ_TIMEOUT_EXPIRED 198
  3749. #define SSL_R_RECORD_LENGTH_MISMATCH 199
  3750. #define SSL_R_RECORD_TOO_LARGE 200
  3751. #define SSL_R_RENEGOTIATION_ENCODING_ERR 201
  3752. #define SSL_R_RENEGOTIATION_MISMATCH 202
  3753. #define SSL_R_REQUIRED_CIPHER_MISSING 203
  3754. #define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 204
  3755. #define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 205
  3756. #define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 206
  3757. #define SSL_R_SERVERHELLO_TLSEXT 207
  3758. #define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 208
  3759. #define SSL_R_SESSION_MAY_NOT_BE_CREATED 209
  3760. #define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 210
  3761. #define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 211
  3762. #define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 212
  3763. #define SSL_R_SSL3_EXT_INVALID_SERVERNAME 213
  3764. #define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 214
  3765. #define SSL_R_SSL_HANDSHAKE_FAILURE 215
  3766. #define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 216
  3767. #define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 217
  3768. #define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 218
  3769. #define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 219
  3770. #define SSL_R_TOO_MANY_WARNING_ALERTS 220
  3771. #define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 221
  3772. #define SSL_R_UNEXPECTED_EXTENSION 222
  3773. #define SSL_R_UNEXPECTED_MESSAGE 223
  3774. #define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 224
  3775. #define SSL_R_UNEXPECTED_RECORD 225
  3776. #define SSL_R_UNINITIALIZED 226
  3777. #define SSL_R_UNKNOWN_ALERT_TYPE 227
  3778. #define SSL_R_UNKNOWN_CERTIFICATE_TYPE 228
  3779. #define SSL_R_UNKNOWN_CIPHER_RETURNED 229
  3780. #define SSL_R_UNKNOWN_CIPHER_TYPE 230
  3781. #define SSL_R_UNKNOWN_DIGEST 231
  3782. #define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 232
  3783. #define SSL_R_UNKNOWN_PROTOCOL 233
  3784. #define SSL_R_UNKNOWN_SSL_VERSION 234
  3785. #define SSL_R_UNKNOWN_STATE 235
  3786. #define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 236
  3787. #define SSL_R_UNSUPPORTED_CIPHER 237
  3788. #define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 238
  3789. #define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 239
  3790. #define SSL_R_UNSUPPORTED_PROTOCOL 240
  3791. #define SSL_R_WRONG_CERTIFICATE_TYPE 241
  3792. #define SSL_R_WRONG_CIPHER_RETURNED 242
  3793. #define SSL_R_WRONG_CURVE 243
  3794. #define SSL_R_WRONG_MESSAGE_TYPE 244
  3795. #define SSL_R_WRONG_SIGNATURE_TYPE 245
  3796. #define SSL_R_WRONG_SSL_VERSION 246
  3797. #define SSL_R_WRONG_VERSION_NUMBER 247
  3798. #define SSL_R_X509_LIB 248
  3799. #define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 249
  3800. #define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
  3801. #define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
  3802. #define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
  3803. #define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
  3804. #define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
  3805. #define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
  3806. #define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
  3807. #define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
  3808. #define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
  3809. #define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
  3810. #define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
  3811. #define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
  3812. #define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
  3813. #define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
  3814. #define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
  3815. #define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
  3816. #define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
  3817. #define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
  3818. #define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
  3819. #define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
  3820. #define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
  3821. #define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
  3822. #define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
  3823. #define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
  3824. #define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
  3825. #define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
  3826. #define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
  3827. #define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
  3828. #define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
  3829. #define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
  3830. #endif /* OPENSSL_HEADER_SSL_H */