tls13.c 472 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530
  1. /* tls13.c
  2. *
  3. * Copyright (C) 2006-2023 wolfSSL Inc.
  4. *
  5. * This file is part of wolfSSL.
  6. *
  7. * wolfSSL is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * wolfSSL is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
  20. */
  21. /*
  22. * BUILD_GCM
  23. * Enables AES-GCM ciphersuites.
  24. * HAVE_AESCCM
  25. * Enables AES-CCM ciphersuites.
  26. * HAVE_SESSION_TICKET
  27. * Enables session tickets - required for TLS 1.3 resumption.
  28. * NO_PSK
  29. * Do not enable Pre-Shared Keys.
  30. * HAVE_KEYING_MATERIAL
  31. * Enables exporting keying material based on section 7.5 of RFC 8446.
  32. * WOLFSSL_ASYNC_CRYPT
  33. * Enables the use of asynchronous cryptographic operations.
  34. * This is available for ciphers and certificates.
  35. * HAVE_CHACHA && HAVE_POLY1305
  36. * Enables use of CHACHA20-POLY1305 ciphersuites.
  37. * WOLFSSL_DEBUG_TLS
  38. * Writes out details of TLS 1.3 protocol including handshake message buffers
  39. * and key generation input and output.
  40. * WOLFSSL_EARLY_DATA
  41. * Allow 0-RTT Handshake using Early Data extensions and handshake message
  42. * WOLFSSL_EARLY_DATA_GROUP
  43. * Group EarlyData message with ClientHello when sending
  44. * WOLFSSL_NO_SERVER_GROUPS_EXT
  45. * Do not send the server's groups in an extension when the server's top
  46. * preference is not in client's list.
  47. * WOLFSSL_POST_HANDSHAKE_AUTH
  48. * Allow TLS v1.3 code to perform post-handshake authentication of the
  49. * client.
  50. * WOLFSSL_SEND_HRR_COOKIE
  51. * Send a cookie in hello_retry_request message to enable stateless tracking
  52. * of ClientHello replies.
  53. * WOLFSSL_TLS13
  54. * Enable TLS 1.3 protocol implementation.
  55. * WOLFSSL_TLS13_MIDDLEBOX_COMPAT
  56. * Enable middlebox compatibility in the TLS 1.3 handshake.
  57. * This includes sending ChangeCipherSpec before encrypted messages and
  58. * including a session id.
  59. * WOLFSSL_TLS13_SHA512
  60. * Allow generation of SHA-512 digests in handshake - no ciphersuite
  61. * requires SHA-512 at this time.
  62. * WOLFSSL_TLS13_TICKET_BEFORE_FINISHED
  63. * Allow a NewSessionTicket message to be sent by server before Client's
  64. * Finished message.
  65. * See TLS v1.3 specification, Section 4.6.1, Paragraph 4 (Note).
  66. * WOLFSSL_PSK_ONE_ID
  67. * When only one PSK ID is used and only one call to the PSK callback can
  68. * be made per connect.
  69. * You cannot use wc_psk_client_cs_callback type callback on client.
  70. * WOLFSSL_PRIORITIZE_PSK
  71. * During a handshake, prioritize PSK order instead of ciphersuite order.
  72. * WOLFSSL_CHECK_ALERT_ON_ERR
  73. * Check for alerts during the handshake in the event of an error.
  74. * WOLFSSL_NO_CLIENT_CERT_ERROR
  75. * Requires client to set a client certificate
  76. * WOLFSSL_PSK_MULTI_ID_PER_CS
  77. * When multiple PSK identities are available for the same cipher suite.
  78. * Sets the first byte of the client identity to the count of identities
  79. * that have been seen so far for the cipher suite.
  80. * WOLFSSL_CHECK_SIG_FAULTS
  81. * Verifies the ECC signature after signing in case of faults in the
  82. * calculation of the signature. Useful when signature fault injection is a
  83. * possible attack.
  84. * WOLFSSL_32BIT_MILLI_TIME
  85. * Function TimeNowInMilliseconds() returns an unsigned 32-bit value.
  86. * Default behavior is to return a signed 64-bit value.
  87. */
  88. #ifdef HAVE_CONFIG_H
  89. #include <config.h>
  90. #endif
  91. #include <wolfssl/wolfcrypt/settings.h>
  92. #ifdef WOLFSSL_TLS13
  93. #ifdef HAVE_SESSION_TICKET
  94. #include <wolfssl/wolfcrypt/wc_port.h>
  95. #endif
  96. #ifndef WOLFCRYPT_ONLY
  97. #ifdef HAVE_ERRNO_H
  98. #include <errno.h>
  99. #endif
  100. #if defined(__MACH__) || defined(__FreeBSD__) || \
  101. defined(__INCLUDE_NUTTX_CONFIG_H) || defined(WOLFSSL_RIOT_OS)
  102. #include <sys/time.h>
  103. #endif /* __MACH__ || __FreeBSD__ ||
  104. __INCLUDE_NUTTX_CONFIG_H || WOLFSSL_RIOT_OS */
  105. #include <wolfssl/internal.h>
  106. #include <wolfssl/error-ssl.h>
  107. #include <wolfssl/wolfcrypt/asn.h>
  108. #include <wolfssl/wolfcrypt/dh.h>
  109. #include <wolfssl/wolfcrypt/kdf.h>
  110. #include <wolfssl/wolfcrypt/signature.h>
  111. #ifdef NO_INLINE
  112. #include <wolfssl/wolfcrypt/misc.h>
  113. #else
  114. #define WOLFSSL_MISC_INCLUDED
  115. #include <wolfcrypt/src/misc.c>
  116. #endif
  117. #ifdef __sun
  118. #include <sys/filio.h>
  119. #endif
  120. #ifndef TRUE
  121. #define TRUE 1
  122. #endif
  123. #ifndef FALSE
  124. #define FALSE 0
  125. #endif
  126. #ifndef HAVE_AEAD
  127. #ifndef _MSC_VER
  128. #error "The build option HAVE_AEAD is required for TLS 1.3"
  129. #else
  130. #pragma \
  131. message("error: The build option HAVE_AEAD is required for TLS 1.3")
  132. #endif
  133. #endif
  134. #ifndef HAVE_HKDF
  135. #ifndef _MSC_VER
  136. #error "The build option HAVE_HKDF is required for TLS 1.3"
  137. #else
  138. #pragma message("error: The build option HAVE_HKDF is required for TLS 1.3")
  139. #endif
  140. #endif
  141. #ifndef HAVE_TLS_EXTENSIONS
  142. #ifndef _MSC_VER
  143. #error "The build option HAVE_TLS_EXTENSIONS is required for TLS 1.3"
  144. #else
  145. #pragma message("error: The build option HAVE_TLS_EXTENSIONS is required for TLS 1.3")
  146. #endif
  147. #endif
  148. /* Set ret to error value and jump to label.
  149. *
  150. * err The error value to set.
  151. * eLabel The label to jump to.
  152. */
  153. #define ERROR_OUT(err, eLabel) { ret = (err); goto eLabel; }
  154. /* Size of the TLS v1.3 label use when deriving keys. */
  155. #define TLS13_PROTOCOL_LABEL_SZ 6
  156. /* The protocol label for TLS v1.3. */
  157. static const byte tls13ProtocolLabel[TLS13_PROTOCOL_LABEL_SZ + 1] = "tls13 ";
  158. #ifdef WOLFSSL_DTLS13
  159. #define DTLS13_PROTOCOL_LABEL_SZ 6
  160. static const byte dtls13ProtocolLabel[DTLS13_PROTOCOL_LABEL_SZ + 1] = "dtls13";
  161. #endif /* WOLFSSL_DTLS13 */
  162. #if defined(HAVE_ECH)
  163. #define ECH_ACCEPT_CONFIRMATION_SZ 8
  164. #define ECH_ACCEPT_CONFIRMATION_LABEL_SZ 23
  165. static const byte
  166. echAcceptConfirmationLabel[ECH_ACCEPT_CONFIRMATION_LABEL_SZ + 1] =
  167. "ech accept confirmation";
  168. #endif
  169. #ifndef NO_CERTS
  170. #if !defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_ED25519) || \
  171. defined(HAVE_ED448) || defined(HAVE_PQC)
  172. static WC_INLINE int GetMsgHash(WOLFSSL* ssl, byte* hash);
  173. #endif
  174. #endif
  175. /* Expand data using HMAC, salt and label and info.
  176. * TLS v1.3 defines this function. Use callback if available. */
  177. static int Tls13HKDFExpandLabel(WOLFSSL* ssl, byte* okm, word32 okmLen,
  178. const byte* prk, word32 prkLen,
  179. const byte* protocol, word32 protocolLen,
  180. const byte* label, word32 labelLen,
  181. const byte* info, word32 infoLen,
  182. int digest)
  183. {
  184. int ret = NOT_COMPILED_IN;
  185. #if defined(HAVE_PK_CALLBACKS)
  186. if (ssl->ctx && ssl->ctx->HKDFExpandLabelCb) {
  187. ret = ssl->ctx->HKDFExpandLabelCb(okm, okmLen, prk, prkLen,
  188. protocol, protocolLen,
  189. label, labelLen,
  190. info, infoLen, digest,
  191. WOLFSSL_CLIENT_END /* ignored */);
  192. }
  193. if (ret != NOT_COMPILED_IN)
  194. return ret;
  195. #endif
  196. (void)ssl;
  197. PRIVATE_KEY_UNLOCK();
  198. #if !defined(HAVE_FIPS) || (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3))
  199. ret = wc_Tls13_HKDF_Expand_Label_ex(okm, okmLen, prk, prkLen,
  200. protocol, protocolLen,
  201. label, labelLen,
  202. info, infoLen, digest,
  203. ssl->heap, ssl->devId);
  204. #else
  205. ret = wc_Tls13_HKDF_Expand_Label(okm, okmLen, prk, prkLen,
  206. protocol, protocolLen,
  207. label, labelLen,
  208. info, infoLen, digest);
  209. #endif
  210. PRIVATE_KEY_LOCK();
  211. return ret;
  212. }
  213. /* Same as above, but pass in the side we are expanding for:
  214. * side: either WOLFSSL_CLIENT_END or WOLFSSL_SERVER_END.
  215. */
  216. static int Tls13HKDFExpandKeyLabel(WOLFSSL* ssl, byte* okm, word32 okmLen,
  217. const byte* prk, word32 prkLen,
  218. const byte* protocol, word32 protocolLen,
  219. const byte* label, word32 labelLen,
  220. const byte* info, word32 infoLen,
  221. int digest, int side)
  222. {
  223. int ret;
  224. #if defined(HAVE_PK_CALLBACKS)
  225. ret = NOT_COMPILED_IN;
  226. if (ssl->ctx && ssl->ctx->HKDFExpandLabelCb) {
  227. ret = ssl->ctx->HKDFExpandLabelCb(okm, okmLen, prk, prkLen,
  228. protocol, protocolLen,
  229. label, labelLen,
  230. info, infoLen,
  231. digest, side);
  232. }
  233. if (ret != NOT_COMPILED_IN)
  234. return ret;
  235. #endif
  236. #if !defined(HAVE_FIPS) || (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3))
  237. ret = wc_Tls13_HKDF_Expand_Label_ex(okm, okmLen, prk, prkLen,
  238. protocol, protocolLen,
  239. label, labelLen,
  240. info, infoLen, digest,
  241. ssl->heap, ssl->devId);
  242. #elif defined(HAVE_FIPS) && defined(wc_Tls13_HKDF_Expand_Label)
  243. ret = wc_Tls13_HKDF_Expand_Label_fips(okm, okmLen, prk, prkLen,
  244. protocol, protocolLen,
  245. label, labelLen,
  246. info, infoLen, digest);
  247. #else
  248. ret = wc_Tls13_HKDF_Expand_Label(okm, okmLen, prk, prkLen,
  249. protocol, protocolLen,
  250. label, labelLen,
  251. info, infoLen, digest);
  252. #endif
  253. (void)ssl;
  254. (void)side;
  255. return ret;
  256. }
  257. /* Derive a key from a message.
  258. *
  259. * ssl The SSL/TLS object.
  260. * output The buffer to hold the derived key.
  261. * outputLen The length of the derived key.
  262. * secret The secret used to derive the key (HMAC secret).
  263. * label The label used to distinguish the context.
  264. * labelLen The length of the label.
  265. * msg The message data to derive key from.
  266. * msgLen The length of the message data to derive key from.
  267. * hashAlgo The hash algorithm to use in the HMAC.
  268. * returns 0 on success, otherwise failure.
  269. */
  270. static int DeriveKeyMsg(WOLFSSL* ssl, byte* output, int outputLen,
  271. const byte* secret, const byte* label, word32 labelLen,
  272. byte* msg, int msgLen, int hashAlgo)
  273. {
  274. byte hash[WC_MAX_DIGEST_SIZE];
  275. Digest digest;
  276. word32 hashSz = 0;
  277. const byte* protocol;
  278. word32 protocolLen;
  279. int digestAlg = -1;
  280. int ret = BAD_FUNC_ARG;
  281. switch (hashAlgo) {
  282. #ifndef NO_WOLFSSL_SHA256
  283. case sha256_mac:
  284. ret = wc_InitSha256_ex(&digest.sha256, ssl->heap, ssl->devId);
  285. if (ret == 0) {
  286. ret = wc_Sha256Update(&digest.sha256, msg, msgLen);
  287. if (ret == 0)
  288. ret = wc_Sha256Final(&digest.sha256, hash);
  289. wc_Sha256Free(&digest.sha256);
  290. }
  291. hashSz = WC_SHA256_DIGEST_SIZE;
  292. digestAlg = WC_SHA256;
  293. break;
  294. #endif
  295. #ifdef WOLFSSL_SHA384
  296. case sha384_mac:
  297. ret = wc_InitSha384_ex(&digest.sha384, ssl->heap, ssl->devId);
  298. if (ret == 0) {
  299. ret = wc_Sha384Update(&digest.sha384, msg, msgLen);
  300. if (ret == 0)
  301. ret = wc_Sha384Final(&digest.sha384, hash);
  302. wc_Sha384Free(&digest.sha384);
  303. }
  304. hashSz = WC_SHA384_DIGEST_SIZE;
  305. digestAlg = WC_SHA384;
  306. break;
  307. #endif
  308. #ifdef WOLFSSL_TLS13_SHA512
  309. case sha512_mac:
  310. ret = wc_InitSha512_ex(&digest.sha512, ssl->heap, ssl->devId);
  311. if (ret == 0) {
  312. ret = wc_Sha512Update(&digest.sha512, msg, msgLen);
  313. if (ret == 0)
  314. ret = wc_Sha512Final(&digest.sha512, hash);
  315. wc_Sha512Free(&digest.sha512);
  316. }
  317. hashSz = WC_SHA512_DIGEST_SIZE;
  318. digestAlg = WC_SHA512;
  319. break;
  320. #endif
  321. #ifdef WOLFSSL_SM3
  322. case sm3_mac:
  323. ret = wc_InitSm3(&digest.sm3, ssl->heap, ssl->devId);
  324. if (ret == 0) {
  325. ret = wc_Sm3Update(&digest.sm3, msg, msgLen);
  326. if (ret == 0)
  327. ret = wc_Sm3Final(&digest.sm3, hash);
  328. wc_Sm3Free(&digest.sm3);
  329. }
  330. hashSz = WC_SM3_DIGEST_SIZE;
  331. digestAlg = WC_SM3;
  332. break;
  333. #endif
  334. default:
  335. digestAlg = -1;
  336. break;
  337. }
  338. if (digestAlg < 0)
  339. return HASH_TYPE_E;
  340. if (ret != 0)
  341. return ret;
  342. switch (ssl->version.minor) {
  343. case TLSv1_3_MINOR:
  344. protocol = tls13ProtocolLabel;
  345. protocolLen = TLS13_PROTOCOL_LABEL_SZ;
  346. break;
  347. #ifdef WOLFSSL_DTLS13
  348. case DTLSv1_3_MINOR:
  349. if (!ssl->options.dtls)
  350. return VERSION_ERROR;
  351. protocol = dtls13ProtocolLabel;
  352. protocolLen = DTLS13_PROTOCOL_LABEL_SZ;
  353. break;
  354. #endif /* WOLFSSL_DTLS13 */
  355. default:
  356. return VERSION_ERROR;
  357. }
  358. if (outputLen == -1)
  359. outputLen = hashSz;
  360. ret = Tls13HKDFExpandLabel(ssl, output, outputLen, secret, hashSz,
  361. protocol, protocolLen, label, labelLen,
  362. hash, hashSz, digestAlg);
  363. return ret;
  364. }
  365. /* Derive a key.
  366. *
  367. * ssl The SSL/TLS object.
  368. * output The buffer to hold the derived key.
  369. * outputLen The length of the derived key.
  370. * secret The secret used to derive the key (HMAC secret).
  371. * label The label used to distinguish the context.
  372. * labelLen The length of the label.
  373. * hashAlgo The hash algorithm to use in the HMAC.
  374. * includeMsgs Whether to include a hash of the handshake messages so far.
  375. * side The side that we are deriving the secret for.
  376. * returns 0 on success, otherwise failure.
  377. */
  378. int Tls13DeriveKey(WOLFSSL* ssl, byte* output, int outputLen,
  379. const byte* secret, const byte* label, word32 labelLen,
  380. int hashAlgo, int includeMsgs, int side)
  381. {
  382. int ret = 0;
  383. byte hash[WC_MAX_DIGEST_SIZE];
  384. word32 hashSz = 0;
  385. word32 hashOutSz = 0;
  386. const byte* protocol;
  387. word32 protocolLen;
  388. int digestAlg = 0;
  389. switch (hashAlgo) {
  390. #ifndef NO_SHA256
  391. case sha256_mac:
  392. hashSz = WC_SHA256_DIGEST_SIZE;
  393. digestAlg = WC_SHA256;
  394. if (includeMsgs)
  395. ret = wc_Sha256GetHash(&ssl->hsHashes->hashSha256, hash);
  396. break;
  397. #endif
  398. #ifdef WOLFSSL_SHA384
  399. case sha384_mac:
  400. hashSz = WC_SHA384_DIGEST_SIZE;
  401. digestAlg = WC_SHA384;
  402. if (includeMsgs)
  403. ret = wc_Sha384GetHash(&ssl->hsHashes->hashSha384, hash);
  404. break;
  405. #endif
  406. #ifdef WOLFSSL_TLS13_SHA512
  407. case sha512_mac:
  408. hashSz = WC_SHA512_DIGEST_SIZE;
  409. digestAlg = WC_SHA512;
  410. if (includeMsgs)
  411. ret = wc_Sha512GetHash(&ssl->hsHashes->hashSha512, hash);
  412. break;
  413. #endif
  414. #ifdef WOLFSSL_SM3
  415. case sm3_mac:
  416. hashSz = WC_SM3_DIGEST_SIZE;
  417. digestAlg = WC_SM3;
  418. if (includeMsgs)
  419. ret = wc_Sm3GetHash(&ssl->hsHashes->hashSm3, hash);
  420. break;
  421. #endif
  422. default:
  423. ret = HASH_TYPE_E;
  424. break;
  425. }
  426. if (ret != 0)
  427. return ret;
  428. protocol = tls13ProtocolLabel;
  429. protocolLen = TLS13_PROTOCOL_LABEL_SZ;
  430. #ifdef WOLFSSL_DTLS13
  431. if (ssl->options.dtls) {
  432. protocol = dtls13ProtocolLabel;
  433. protocolLen = DTLS13_PROTOCOL_LABEL_SZ;
  434. }
  435. #endif /* WOLFSSL_DTLS13 */
  436. if (outputLen == -1) {
  437. outputLen = hashSz;
  438. }
  439. if (includeMsgs) {
  440. hashOutSz = hashSz;
  441. }
  442. else {
  443. /* Appease static analyzers by making sure hash is cleared, since it is
  444. * passed into expand key label where older wc_Tls13_HKDF_Expand_Label
  445. * will unconditionally try to call a memcpy on it, however length will
  446. * always be 0. */
  447. XMEMSET(hash, 0, sizeof(hash));
  448. hashOutSz = 0;
  449. }
  450. PRIVATE_KEY_UNLOCK();
  451. ret = Tls13HKDFExpandKeyLabel(ssl, output, outputLen, secret, hashSz,
  452. protocol, protocolLen, label, labelLen,
  453. hash, hashOutSz, digestAlg, side);
  454. PRIVATE_KEY_LOCK();
  455. #ifdef WOLFSSL_CHECK_MEM_ZERO
  456. wc_MemZero_Add("TLS 1.3 derived key", output, outputLen);
  457. #endif
  458. return ret;
  459. }
  460. /* Convert TLS mac ID to a hash algorithm ID
  461. *
  462. * mac Mac ID to convert
  463. * returns hash ID on success, or the NONE type.
  464. */
  465. static WC_INLINE int mac2hash(int mac)
  466. {
  467. int hash;
  468. switch (mac) {
  469. #ifndef NO_SHA256
  470. case sha256_mac:
  471. hash = WC_SHA256;
  472. break;
  473. #endif
  474. #ifdef WOLFSSL_SHA384
  475. case sha384_mac:
  476. hash = WC_SHA384;
  477. break;
  478. #endif
  479. #ifdef WOLFSSL_TLS13_SHA512
  480. case sha512_mac:
  481. hash = WC_SHA512;
  482. break;
  483. #endif
  484. #ifdef WOLFSSL_SM3
  485. case sm3_mac:
  486. hash = WC_SM3;
  487. break;
  488. #endif
  489. default:
  490. hash = WC_HASH_TYPE_NONE;
  491. }
  492. return hash;
  493. }
  494. #ifndef NO_PSK
  495. /* The length of the binder key label. */
  496. #define BINDER_KEY_LABEL_SZ 10
  497. /* The binder key label. */
  498. static const byte binderKeyLabel[BINDER_KEY_LABEL_SZ + 1] =
  499. "ext binder";
  500. /* Derive the binder key.
  501. *
  502. * ssl The SSL/TLS object.
  503. * key The derived key.
  504. * returns 0 on success, otherwise failure.
  505. */
  506. static int DeriveBinderKey(WOLFSSL* ssl, byte* key)
  507. {
  508. WOLFSSL_MSG("Derive Binder Key");
  509. if (ssl == NULL || ssl->arrays == NULL) {
  510. return BAD_FUNC_ARG;
  511. }
  512. return DeriveKeyMsg(ssl, key, -1, ssl->arrays->secret,
  513. binderKeyLabel, BINDER_KEY_LABEL_SZ,
  514. NULL, 0, ssl->specs.mac_algorithm);
  515. }
  516. #endif /* !NO_PSK */
  517. #if defined(HAVE_SESSION_TICKET) && \
  518. (!defined(NO_WOLFSSL_CLIENT) || !defined(NO_WOLFSSL_SERVER))
  519. /* The length of the binder key resume label. */
  520. #define BINDER_KEY_RESUME_LABEL_SZ 10
  521. /* The binder key resume label. */
  522. static const byte binderKeyResumeLabel[BINDER_KEY_RESUME_LABEL_SZ + 1] =
  523. "res binder";
  524. /* Derive the binder resumption key.
  525. *
  526. * ssl The SSL/TLS object.
  527. * key The derived key.
  528. * returns 0 on success, otherwise failure.
  529. */
  530. static int DeriveBinderKeyResume(WOLFSSL* ssl, byte* key)
  531. {
  532. WOLFSSL_MSG("Derive Binder Key - Resumption");
  533. if (ssl == NULL || ssl->arrays == NULL) {
  534. return BAD_FUNC_ARG;
  535. }
  536. return DeriveKeyMsg(ssl, key, -1, ssl->arrays->secret,
  537. binderKeyResumeLabel, BINDER_KEY_RESUME_LABEL_SZ,
  538. NULL, 0, ssl->specs.mac_algorithm);
  539. }
  540. #endif /* HAVE_SESSION_TICKET && (!NO_WOLFSSL_CLIENT || !NO_WOLFSSL_SERVER) */
  541. #ifdef WOLFSSL_EARLY_DATA
  542. /* The length of the early traffic label. */
  543. #define EARLY_TRAFFIC_LABEL_SZ 11
  544. /* The early traffic label. */
  545. static const byte earlyTrafficLabel[EARLY_TRAFFIC_LABEL_SZ + 1] =
  546. "c e traffic";
  547. /* Derive the early traffic key.
  548. *
  549. * ssl The SSL/TLS object.
  550. * key The derived key.
  551. * side The side that we are deriving the secret for.
  552. * returns 0 on success, otherwise failure.
  553. */
  554. static int DeriveEarlyTrafficSecret(WOLFSSL* ssl, byte* key, int side)
  555. {
  556. int ret;
  557. WOLFSSL_MSG("Derive Early Traffic Secret");
  558. if (ssl == NULL || ssl->arrays == NULL) {
  559. return BAD_FUNC_ARG;
  560. }
  561. #if defined(WOLFSSL_SNIFFER) && defined(WOLFSSL_SNIFFER_KEYLOGFILE)
  562. /* If this is called from a sniffer session with keylog file support,
  563. * obtain the appropriate secret from the callback */
  564. if (ssl->snifferSecretCb != NULL) {
  565. return ssl->snifferSecretCb(ssl->arrays->clientRandom,
  566. SNIFFER_SECRET_CLIENT_EARLY_TRAFFIC_SECRET,
  567. key);
  568. }
  569. #endif /* WOLFSSL_SNIFFER && WOLFSSL_SNIFFER_KEYLOGFILE */
  570. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->secret,
  571. earlyTrafficLabel, EARLY_TRAFFIC_LABEL_SZ,
  572. ssl->specs.mac_algorithm, 1, side);
  573. #ifdef HAVE_SECRET_CALLBACK
  574. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  575. ret = ssl->tls13SecretCb(ssl, CLIENT_EARLY_TRAFFIC_SECRET, key,
  576. ssl->specs.hash_size, ssl->tls13SecretCtx);
  577. if (ret != 0) {
  578. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  579. return TLS13_SECRET_CB_E;
  580. }
  581. }
  582. #ifdef OPENSSL_EXTRA
  583. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  584. ret = ssl->tls13KeyLogCb(ssl, CLIENT_EARLY_TRAFFIC_SECRET, key,
  585. ssl->specs.hash_size, NULL);
  586. if (ret != 0) {
  587. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  588. return TLS13_SECRET_CB_E;
  589. }
  590. }
  591. #endif /* OPENSSL_EXTRA */
  592. #endif /* HAVE_SECRET_CALLBACK */
  593. return ret;
  594. }
  595. #endif
  596. /* The length of the client handshake label. */
  597. #define CLIENT_HANDSHAKE_LABEL_SZ 12
  598. /* The client handshake label. */
  599. static const byte clientHandshakeLabel[CLIENT_HANDSHAKE_LABEL_SZ + 1] =
  600. "c hs traffic";
  601. /* Derive the client handshake key.
  602. *
  603. * ssl The SSL/TLS object.
  604. * key The derived key.
  605. * returns 0 on success, otherwise failure.
  606. */
  607. static int DeriveClientHandshakeSecret(WOLFSSL* ssl, byte* key)
  608. {
  609. int ret;
  610. WOLFSSL_MSG("Derive Client Handshake Secret");
  611. if (ssl == NULL || ssl->arrays == NULL) {
  612. return BAD_FUNC_ARG;
  613. }
  614. #if defined(WOLFSSL_SNIFFER) && defined(WOLFSSL_SNIFFER_KEYLOGFILE)
  615. /* If this is called from a sniffer session with keylog file support,
  616. * obtain the appropriate secret from the callback */
  617. if (ssl->snifferSecretCb != NULL) {
  618. return ssl->snifferSecretCb(ssl->arrays->clientRandom,
  619. SNIFFER_SECRET_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
  620. key);
  621. }
  622. #endif /* WOLFSSL_SNIFFER && WOLFSSL_SNIFFER_KEYLOGFILE */
  623. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->preMasterSecret,
  624. clientHandshakeLabel, CLIENT_HANDSHAKE_LABEL_SZ,
  625. ssl->specs.mac_algorithm, 1, WOLFSSL_CLIENT_END);
  626. #ifdef HAVE_SECRET_CALLBACK
  627. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  628. ret = ssl->tls13SecretCb(ssl, CLIENT_HANDSHAKE_TRAFFIC_SECRET, key,
  629. ssl->specs.hash_size, ssl->tls13SecretCtx);
  630. if (ret != 0) {
  631. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  632. return TLS13_SECRET_CB_E;
  633. }
  634. }
  635. #ifdef OPENSSL_EXTRA
  636. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  637. ret = ssl->tls13KeyLogCb(ssl, CLIENT_HANDSHAKE_TRAFFIC_SECRET, key,
  638. ssl->specs.hash_size, NULL);
  639. if (ret != 0) {
  640. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  641. return TLS13_SECRET_CB_E;
  642. }
  643. }
  644. #endif /* OPENSSL_EXTRA */
  645. #endif /* HAVE_SECRET_CALLBACK */
  646. return ret;
  647. }
  648. /* The length of the server handshake label. */
  649. #define SERVER_HANDSHAKE_LABEL_SZ 12
  650. /* The server handshake label. */
  651. static const byte serverHandshakeLabel[SERVER_HANDSHAKE_LABEL_SZ + 1] =
  652. "s hs traffic";
  653. /* Derive the server handshake key.
  654. *
  655. * ssl The SSL/TLS object.
  656. * key The derived key.
  657. * returns 0 on success, otherwise failure.
  658. */
  659. static int DeriveServerHandshakeSecret(WOLFSSL* ssl, byte* key)
  660. {
  661. int ret;
  662. WOLFSSL_MSG("Derive Server Handshake Secret");
  663. if (ssl == NULL || ssl->arrays == NULL) {
  664. return BAD_FUNC_ARG;
  665. }
  666. #if defined(WOLFSSL_SNIFFER) && defined(WOLFSSL_SNIFFER_KEYLOGFILE)
  667. /* If this is called from a sniffer session with keylog file support,
  668. * obtain the appropriate secret from the callback */
  669. if (ssl->snifferSecretCb != NULL) {
  670. return ssl->snifferSecretCb(ssl->arrays->clientRandom,
  671. SNIFFER_SECRET_SERVER_HANDSHAKE_TRAFFIC_SECRET,
  672. key);
  673. }
  674. #endif /* WOLFSSL_SNIFFER && WOLFSSL_SNIFFER_KEYLOGFILE */
  675. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->preMasterSecret,
  676. serverHandshakeLabel, SERVER_HANDSHAKE_LABEL_SZ,
  677. ssl->specs.mac_algorithm, 1, WOLFSSL_SERVER_END);
  678. #ifdef HAVE_SECRET_CALLBACK
  679. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  680. ret = ssl->tls13SecretCb(ssl, SERVER_HANDSHAKE_TRAFFIC_SECRET, key,
  681. ssl->specs.hash_size, ssl->tls13SecretCtx);
  682. if (ret != 0) {
  683. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  684. return TLS13_SECRET_CB_E;
  685. }
  686. }
  687. #ifdef OPENSSL_EXTRA
  688. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  689. ret = ssl->tls13KeyLogCb(ssl, SERVER_HANDSHAKE_TRAFFIC_SECRET, key,
  690. ssl->specs.hash_size, NULL);
  691. if (ret != 0) {
  692. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  693. return TLS13_SECRET_CB_E;
  694. }
  695. }
  696. #endif /* OPENSSL_EXTRA */
  697. #endif /* HAVE_SECRET_CALLBACK */
  698. return ret;
  699. }
  700. /* The length of the client application traffic label. */
  701. #define CLIENT_APP_LABEL_SZ 12
  702. /* The client application traffic label. */
  703. static const byte clientAppLabel[CLIENT_APP_LABEL_SZ + 1] =
  704. "c ap traffic";
  705. /* Derive the client application traffic key.
  706. *
  707. * ssl The SSL/TLS object.
  708. * key The derived key.
  709. * returns 0 on success, otherwise failure.
  710. */
  711. static int DeriveClientTrafficSecret(WOLFSSL* ssl, byte* key)
  712. {
  713. int ret;
  714. WOLFSSL_MSG("Derive Client Traffic Secret");
  715. if (ssl == NULL || ssl->arrays == NULL) {
  716. return BAD_FUNC_ARG;
  717. }
  718. #if defined(WOLFSSL_SNIFFER) && defined(WOLFSSL_SNIFFER_KEYLOGFILE)
  719. /* If this is called from a sniffer session with keylog file support,
  720. * obtain the appropriate secret from the callback */
  721. if (ssl->snifferSecretCb != NULL) {
  722. return ssl->snifferSecretCb(ssl->arrays->clientRandom,
  723. SNIFFER_SECRET_CLIENT_TRAFFIC_SECRET,
  724. key);
  725. }
  726. #endif /* WOLFSSL_SNIFFER && WOLFSSL_SNIFFER_KEYLOGFILE */
  727. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->masterSecret,
  728. clientAppLabel, CLIENT_APP_LABEL_SZ,
  729. ssl->specs.mac_algorithm, 1, WOLFSSL_CLIENT_END);
  730. #ifdef HAVE_SECRET_CALLBACK
  731. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  732. ret = ssl->tls13SecretCb(ssl, CLIENT_TRAFFIC_SECRET, key,
  733. ssl->specs.hash_size, ssl->tls13SecretCtx);
  734. if (ret != 0) {
  735. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  736. return TLS13_SECRET_CB_E;
  737. }
  738. }
  739. #ifdef OPENSSL_EXTRA
  740. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  741. ret = ssl->tls13KeyLogCb(ssl, CLIENT_TRAFFIC_SECRET, key,
  742. ssl->specs.hash_size, NULL);
  743. if (ret != 0) {
  744. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  745. return TLS13_SECRET_CB_E;
  746. }
  747. }
  748. #endif /* OPENSSL_EXTRA */
  749. #endif /* HAVE_SECRET_CALLBACK */
  750. return ret;
  751. }
  752. /* The length of the server application traffic label. */
  753. #define SERVER_APP_LABEL_SZ 12
  754. /* The server application traffic label. */
  755. static const byte serverAppLabel[SERVER_APP_LABEL_SZ + 1] =
  756. "s ap traffic";
  757. /* Derive the server application traffic key.
  758. *
  759. * ssl The SSL/TLS object.
  760. * key The derived key.
  761. * returns 0 on success, otherwise failure.
  762. */
  763. static int DeriveServerTrafficSecret(WOLFSSL* ssl, byte* key)
  764. {
  765. int ret;
  766. WOLFSSL_MSG("Derive Server Traffic Secret");
  767. if (ssl == NULL || ssl->arrays == NULL) {
  768. return BAD_FUNC_ARG;
  769. }
  770. #if defined(WOLFSSL_SNIFFER) && defined(WOLFSSL_SNIFFER_KEYLOGFILE)
  771. /* If this is called from a sniffer session with keylog file support,
  772. * obtain the appropriate secret from the callback */
  773. if (ssl->snifferSecretCb != NULL) {
  774. return ssl->snifferSecretCb(ssl->arrays->clientRandom,
  775. SNIFFER_SECRET_SERVER_TRAFFIC_SECRET,
  776. key);
  777. }
  778. #endif /* WOLFSSL_SNIFFER && WOLFSSL_SNIFFER_KEYLOGFILE */
  779. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->masterSecret,
  780. serverAppLabel, SERVER_APP_LABEL_SZ,
  781. ssl->specs.mac_algorithm, 1, WOLFSSL_SERVER_END);
  782. #ifdef HAVE_SECRET_CALLBACK
  783. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  784. ret = ssl->tls13SecretCb(ssl, SERVER_TRAFFIC_SECRET, key,
  785. ssl->specs.hash_size, ssl->tls13SecretCtx);
  786. if (ret != 0) {
  787. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  788. return TLS13_SECRET_CB_E;
  789. }
  790. }
  791. #ifdef OPENSSL_EXTRA
  792. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  793. ret = ssl->tls13KeyLogCb(ssl, SERVER_TRAFFIC_SECRET, key,
  794. ssl->specs.hash_size, NULL);
  795. if (ret != 0) {
  796. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  797. return TLS13_SECRET_CB_E;
  798. }
  799. }
  800. #endif /* OPENSSL_EXTRA */
  801. #endif /* HAVE_SECRET_CALLBACK */
  802. return ret;
  803. }
  804. #ifdef HAVE_KEYING_MATERIAL
  805. /* The length of the exporter master secret label. */
  806. #define EXPORTER_MASTER_LABEL_SZ 10
  807. /* The exporter master secret label. */
  808. static const byte exporterMasterLabel[EXPORTER_MASTER_LABEL_SZ + 1] =
  809. "exp master";
  810. /* Derive the exporter secret.
  811. *
  812. * ssl The SSL/TLS object.
  813. * key The derived key.
  814. * returns 0 on success, otherwise failure.
  815. */
  816. static int DeriveExporterSecret(WOLFSSL* ssl, byte* key)
  817. {
  818. int ret;
  819. WOLFSSL_ENTER("Derive Exporter Secret");
  820. if (ssl == NULL || ssl->arrays == NULL) {
  821. return BAD_FUNC_ARG;
  822. }
  823. ret = Tls13DeriveKey(ssl, key, -1, ssl->arrays->masterSecret,
  824. exporterMasterLabel, EXPORTER_MASTER_LABEL_SZ,
  825. ssl->specs.mac_algorithm, 1, 0 /* Unused */);
  826. #ifdef HAVE_SECRET_CALLBACK
  827. if (ret == 0 && ssl->tls13SecretCb != NULL) {
  828. ret = ssl->tls13SecretCb(ssl, EXPORTER_SECRET, key,
  829. ssl->specs.hash_size, ssl->tls13SecretCtx);
  830. if (ret != 0) {
  831. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  832. return TLS13_SECRET_CB_E;
  833. }
  834. }
  835. #ifdef OPENSSL_EXTRA
  836. if (ret == 0 && ssl->tls13KeyLogCb != NULL) {
  837. ret = ssl->tls13KeyLogCb(ssl, EXPORTER_SECRET, key,
  838. ssl->specs.hash_size, NULL);
  839. if (ret != 0) {
  840. WOLFSSL_ERROR_VERBOSE(TLS13_SECRET_CB_E);
  841. return TLS13_SECRET_CB_E;
  842. }
  843. }
  844. #endif /* OPENSSL_EXTRA */
  845. #endif /* HAVE_SECRET_CALLBACK */
  846. return ret;
  847. }
  848. /* The length of the exporter label. */
  849. #define EXPORTER_LABEL_SZ 8
  850. /* The exporter label. */
  851. static const byte exporterLabel[EXPORTER_LABEL_SZ + 1] =
  852. "exporter";
  853. /* Hash("") */
  854. #ifndef NO_SHA256
  855. static const byte emptySHA256Hash[] = {
  856. 0xE3, 0xB0, 0xC4, 0x42, 0x98, 0xFC, 0x1C, 0x14, 0x9A, 0xFB, 0xF4, 0xC8,
  857. 0x99, 0x6F, 0xB9, 0x24, 0x27, 0xAE, 0x41, 0xE4, 0x64, 0x9B, 0x93, 0x4C,
  858. 0xA4, 0x95, 0x99, 0x1B, 0x78, 0x52, 0xB8, 0x55
  859. };
  860. #endif
  861. #ifdef WOLFSSL_SHA384
  862. static const byte emptySHA384Hash[] = {
  863. 0x38, 0xB0, 0x60, 0xA7, 0x51, 0xAC, 0x96, 0x38, 0x4C, 0xD9, 0x32, 0x7E,
  864. 0xB1, 0xB1, 0xE3, 0x6A, 0x21, 0xFD, 0xB7, 0x11, 0x14, 0xBE, 0x07, 0x43,
  865. 0x4C, 0x0C, 0xC7, 0xBF, 0x63, 0xF6, 0xE1, 0xDA, 0x27, 0x4E, 0xDE, 0xBF,
  866. 0xE7, 0x6F, 0x65, 0xFB, 0xD5, 0x1A, 0xD2, 0xF1, 0x48, 0x98, 0xB9, 0x5B
  867. };
  868. #endif
  869. #ifdef WOLFSSL_TLS13_SHA512
  870. static const byte emptySHA512Hash[] = {
  871. 0xCF, 0x83, 0xE1, 0x35, 0x7E, 0xEF, 0xB8, 0xBD, 0xF1, 0x54, 0x28, 0x50,
  872. 0xD6, 0x6D, 0x80, 0x07, 0xD6, 0x20, 0xE4, 0x05, 0x0B, 0x57, 0x15, 0xDC,
  873. 0x83, 0xF4, 0xA9, 0x21, 0xD3, 0x6C, 0xE9, 0xCE, 0x47, 0xD0, 0xD1, 0x3C,
  874. 0x5D, 0x85, 0xF2, 0xB0, 0xFF, 0x83, 0x18, 0xD2, 0x87, 0x7E, 0xEC, 0x2F,
  875. 0x63, 0xB9, 0x31, 0xBD, 0x47, 0x41, 0x7A, 0x81, 0xA5, 0x38, 0x32, 0x7A,
  876. 0xF9, 0x27, 0xDA, 0x3E
  877. };
  878. #endif
  879. /**
  880. * Implement section 7.5 of RFC 8446
  881. * @return 0 on success
  882. * <0 on failure
  883. */
  884. int Tls13_Exporter(WOLFSSL* ssl, unsigned char *out, size_t outLen,
  885. const char *label, size_t labelLen,
  886. const unsigned char *context, size_t contextLen)
  887. {
  888. int ret;
  889. enum wc_HashType hashType = WC_HASH_TYPE_NONE;
  890. int hashLen = 0;
  891. byte hashOut[WC_MAX_DIGEST_SIZE];
  892. const byte* emptyHash = NULL;
  893. byte firstExpand[WC_MAX_DIGEST_SIZE];
  894. const byte* protocol = tls13ProtocolLabel;
  895. word32 protocolLen = TLS13_PROTOCOL_LABEL_SZ;
  896. if (ssl->options.dtls && ssl->version.minor != DTLSv1_3_MINOR)
  897. return VERSION_ERROR;
  898. if (!ssl->options.dtls && ssl->version.minor != TLSv1_3_MINOR)
  899. return VERSION_ERROR;
  900. #ifdef WOLFSSL_DTLS13
  901. if (ssl->options.dtls) {
  902. protocol = dtls13ProtocolLabel;
  903. protocolLen = DTLS13_PROTOCOL_LABEL_SZ;
  904. }
  905. #endif /* WOLFSSL_DTLS13 */
  906. switch (ssl->specs.mac_algorithm) {
  907. #ifndef NO_SHA256
  908. case sha256_mac:
  909. hashType = WC_HASH_TYPE_SHA256;
  910. hashLen = WC_SHA256_DIGEST_SIZE;
  911. emptyHash = emptySHA256Hash;
  912. break;
  913. #endif
  914. #ifdef WOLFSSL_SHA384
  915. case sha384_mac:
  916. hashType = WC_HASH_TYPE_SHA384;
  917. hashLen = WC_SHA384_DIGEST_SIZE;
  918. emptyHash = emptySHA384Hash;
  919. break;
  920. #endif
  921. #ifdef WOLFSSL_TLS13_SHA512
  922. case sha512_mac:
  923. hashType = WC_HASH_TYPE_SHA512;
  924. hashLen = WC_SHA512_DIGEST_SIZE;
  925. emptyHash = emptySHA512Hash;
  926. break;
  927. #endif
  928. }
  929. /* Derive-Secret(Secret, label, "") */
  930. ret = Tls13HKDFExpandLabel(ssl, firstExpand, hashLen,
  931. ssl->arrays->exporterSecret, hashLen,
  932. protocol, protocolLen, (byte*)label, (word32)labelLen,
  933. emptyHash, hashLen, hashType);
  934. if (ret != 0)
  935. return ret;
  936. /* Hash(context_value) */
  937. ret = wc_Hash(hashType, context, (word32)contextLen, hashOut, WC_MAX_DIGEST_SIZE);
  938. if (ret != 0)
  939. return ret;
  940. ret = Tls13HKDFExpandLabel(ssl, out, (word32)outLen, firstExpand, hashLen,
  941. protocol, protocolLen, exporterLabel, EXPORTER_LABEL_SZ,
  942. hashOut, hashLen, hashType);
  943. return ret;
  944. }
  945. #endif
  946. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  947. /* The length of the resumption master secret label. */
  948. #define RESUME_MASTER_LABEL_SZ 10
  949. /* The resumption master secret label. */
  950. static const byte resumeMasterLabel[RESUME_MASTER_LABEL_SZ + 1] =
  951. "res master";
  952. /* Derive the resumption secret.
  953. *
  954. * ssl The SSL/TLS object.
  955. * key The derived key.
  956. * returns 0 on success, otherwise failure.
  957. */
  958. int DeriveResumptionSecret(WOLFSSL* ssl, byte* key)
  959. {
  960. byte* masterSecret;
  961. WOLFSSL_MSG("Derive Resumption Secret");
  962. if (ssl == NULL) {
  963. return BAD_FUNC_ARG;
  964. }
  965. if (ssl->arrays != NULL) {
  966. masterSecret = ssl->arrays->masterSecret;
  967. }
  968. else {
  969. masterSecret = ssl->session->masterSecret;
  970. }
  971. return Tls13DeriveKey(ssl, key, -1, masterSecret, resumeMasterLabel,
  972. RESUME_MASTER_LABEL_SZ, ssl->specs.mac_algorithm, 1,
  973. 0 /* Unused */);
  974. }
  975. #endif
  976. /* Length of the finished label. */
  977. #define FINISHED_LABEL_SZ 8
  978. /* Finished label for generating finished key. */
  979. static const byte finishedLabel[FINISHED_LABEL_SZ+1] = "finished";
  980. /* Derive the finished secret.
  981. *
  982. * ssl The SSL/TLS object.
  983. * key The key to use with the HMAC.
  984. * secret The derived secret.
  985. * side The side that we are deriving the secret for.
  986. * returns 0 on success, otherwise failure.
  987. */
  988. static int DeriveFinishedSecret(WOLFSSL* ssl, byte* key, byte* secret,
  989. int side)
  990. {
  991. WOLFSSL_MSG("Derive Finished Secret");
  992. return Tls13DeriveKey(ssl, secret, -1, key, finishedLabel,
  993. FINISHED_LABEL_SZ, ssl->specs.mac_algorithm, 0,
  994. side);
  995. }
  996. /* The length of the application traffic label. */
  997. #define APP_TRAFFIC_LABEL_SZ 11
  998. /* The application traffic label. */
  999. static const byte appTrafficLabel[APP_TRAFFIC_LABEL_SZ + 1] =
  1000. "traffic upd";
  1001. /* Update the traffic secret.
  1002. *
  1003. * ssl The SSL/TLS object.
  1004. * secret The previous secret and derived secret.
  1005. * side The side that we are deriving the secret for.
  1006. * returns 0 on success, otherwise failure.
  1007. */
  1008. static int DeriveTrafficSecret(WOLFSSL* ssl, byte* secret, int side)
  1009. {
  1010. WOLFSSL_MSG("Derive New Application Traffic Secret");
  1011. return Tls13DeriveKey(ssl, secret, -1, secret,
  1012. appTrafficLabel, APP_TRAFFIC_LABEL_SZ,
  1013. ssl->specs.mac_algorithm, 0, side);
  1014. }
  1015. static int Tls13_HKDF_Extract(WOLFSSL *ssl, byte* prk, const byte* salt,
  1016. int saltLen, byte* ikm, int ikmLen, int digest)
  1017. {
  1018. int ret;
  1019. #ifdef HAVE_PK_CALLBACKS
  1020. void *cb_ctx = ssl->HkdfExtractCtx;
  1021. CallbackHKDFExtract cb = ssl->ctx->HkdfExtractCb;
  1022. if (cb != NULL) {
  1023. ret = cb(prk, salt, saltLen, ikm, ikmLen, digest, cb_ctx);
  1024. }
  1025. else
  1026. #endif
  1027. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  1028. if ((int)ssl->arrays->psk_keySz < 0) {
  1029. ret = PSK_KEY_ERROR;
  1030. }
  1031. else
  1032. #endif
  1033. {
  1034. #if !defined(HAVE_FIPS) || \
  1035. (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3))
  1036. ret = wc_Tls13_HKDF_Extract_ex(prk, salt, saltLen, ikm, ikmLen, digest,
  1037. ssl->heap, ssl->devId);
  1038. #else
  1039. ret = wc_Tls13_HKDF_Extract(prk, salt, saltLen, ikm, ikmLen, digest);
  1040. (void)ssl;
  1041. #endif
  1042. }
  1043. return ret;
  1044. }
  1045. /* Derive the early secret using HKDF Extract.
  1046. *
  1047. * ssl The SSL/TLS object.
  1048. */
  1049. int DeriveEarlySecret(WOLFSSL* ssl)
  1050. {
  1051. int ret;
  1052. WOLFSSL_MSG("Derive Early Secret");
  1053. if (ssl == NULL || ssl->arrays == NULL) {
  1054. return BAD_FUNC_ARG;
  1055. }
  1056. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  1057. ret = tsip_Tls13DeriveEarlySecret(ssl);
  1058. if (ret != CRYPTOCB_UNAVAILABLE)
  1059. return ret;
  1060. #endif
  1061. PRIVATE_KEY_UNLOCK();
  1062. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  1063. ret = Tls13_HKDF_Extract(ssl, ssl->arrays->secret, NULL, 0,
  1064. ssl->arrays->psk_key, ssl->arrays->psk_keySz,
  1065. mac2hash(ssl->specs.mac_algorithm));
  1066. #else
  1067. ret = Tls13_HKDF_Extract(ssl, ssl->arrays->secret, NULL, 0,
  1068. ssl->arrays->masterSecret, 0, mac2hash(ssl->specs.mac_algorithm));
  1069. #endif
  1070. PRIVATE_KEY_LOCK();
  1071. return ret;
  1072. }
  1073. /* The length of the derived label. */
  1074. #define DERIVED_LABEL_SZ 7
  1075. /* The derived label. */
  1076. static const byte derivedLabel[DERIVED_LABEL_SZ + 1] =
  1077. "derived";
  1078. /* Derive the handshake secret using HKDF Extract.
  1079. *
  1080. * ssl The SSL/TLS object.
  1081. */
  1082. int DeriveHandshakeSecret(WOLFSSL* ssl)
  1083. {
  1084. byte key[WC_MAX_DIGEST_SIZE];
  1085. int ret;
  1086. WOLFSSL_MSG("Derive Handshake Secret");
  1087. if (ssl == NULL || ssl->arrays == NULL) {
  1088. return BAD_FUNC_ARG;
  1089. }
  1090. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  1091. ret = tsip_Tls13DeriveHandshakeSecret(ssl);
  1092. if (ret != CRYPTOCB_UNAVAILABLE)
  1093. return ret;
  1094. #endif
  1095. ret = DeriveKeyMsg(ssl, key, -1, ssl->arrays->secret,
  1096. derivedLabel, DERIVED_LABEL_SZ,
  1097. NULL, 0, ssl->specs.mac_algorithm);
  1098. if (ret != 0)
  1099. return ret;
  1100. PRIVATE_KEY_UNLOCK();
  1101. ret = Tls13_HKDF_Extract(ssl, ssl->arrays->preMasterSecret,
  1102. key, ssl->specs.hash_size,
  1103. ssl->arrays->preMasterSecret, ssl->arrays->preMasterSz,
  1104. mac2hash(ssl->specs.mac_algorithm));
  1105. PRIVATE_KEY_LOCK();
  1106. return ret;
  1107. }
  1108. /* Derive the master secret using HKDF Extract.
  1109. *
  1110. * ssl The SSL/TLS object.
  1111. */
  1112. int DeriveMasterSecret(WOLFSSL* ssl)
  1113. {
  1114. byte key[WC_MAX_DIGEST_SIZE];
  1115. int ret;
  1116. WOLFSSL_MSG("Derive Master Secret");
  1117. if (ssl == NULL || ssl->arrays == NULL) {
  1118. return BAD_FUNC_ARG;
  1119. }
  1120. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  1121. ret = tsip_Tls13DeriveMasterSecret(ssl);
  1122. if (ret != CRYPTOCB_UNAVAILABLE)
  1123. return ret;
  1124. #endif
  1125. ret = DeriveKeyMsg(ssl, key, -1, ssl->arrays->preMasterSecret,
  1126. derivedLabel, DERIVED_LABEL_SZ,
  1127. NULL, 0, ssl->specs.mac_algorithm);
  1128. if (ret != 0)
  1129. return ret;
  1130. PRIVATE_KEY_UNLOCK();
  1131. ret = Tls13_HKDF_Extract(ssl, ssl->arrays->masterSecret,
  1132. key, ssl->specs.hash_size,
  1133. ssl->arrays->masterSecret, 0, mac2hash(ssl->specs.mac_algorithm));
  1134. PRIVATE_KEY_LOCK();
  1135. #ifdef HAVE_KEYING_MATERIAL
  1136. if (ret != 0)
  1137. return ret;
  1138. /* Calculate exporter secret only when saving arrays */
  1139. if (ssl->options.saveArrays)
  1140. ret = DeriveExporterSecret(ssl, ssl->arrays->exporterSecret);
  1141. #endif
  1142. return ret;
  1143. }
  1144. #if defined(HAVE_SESSION_TICKET)
  1145. /* Length of the resumption label. */
  1146. #define RESUMPTION_LABEL_SZ 10
  1147. /* Resumption label for generating PSK associated with the ticket. */
  1148. static const byte resumptionLabel[RESUMPTION_LABEL_SZ+1] = "resumption";
  1149. /* Derive the PSK associated with the ticket.
  1150. *
  1151. * ssl The SSL/TLS object.
  1152. * nonce The nonce to derive with.
  1153. * nonceLen The length of the nonce to derive with.
  1154. * secret The derived secret.
  1155. * returns 0 on success, otherwise failure.
  1156. */
  1157. int DeriveResumptionPSK(WOLFSSL* ssl, byte* nonce, byte nonceLen, byte* secret)
  1158. {
  1159. int digestAlg;
  1160. /* Only one protocol version defined at this time. */
  1161. const byte* protocol = tls13ProtocolLabel;
  1162. word32 protocolLen = TLS13_PROTOCOL_LABEL_SZ;
  1163. int ret;
  1164. WOLFSSL_MSG("Derive Resumption PSK");
  1165. #ifdef WOLFSSL_DTLS13
  1166. if (ssl->options.dtls) {
  1167. protocol = dtls13ProtocolLabel;
  1168. protocolLen = DTLS13_PROTOCOL_LABEL_SZ;
  1169. }
  1170. #endif /* WOLFSSL_DTLS13 */
  1171. switch (ssl->specs.mac_algorithm) {
  1172. #ifndef NO_SHA256
  1173. case sha256_mac:
  1174. digestAlg = WC_SHA256;
  1175. break;
  1176. #endif
  1177. #ifdef WOLFSSL_SHA384
  1178. case sha384_mac:
  1179. digestAlg = WC_SHA384;
  1180. break;
  1181. #endif
  1182. #ifdef WOLFSSL_TLS13_SHA512
  1183. case sha512_mac:
  1184. digestAlg = WC_SHA512;
  1185. break;
  1186. #endif
  1187. #ifdef WOLFSSL_SM3
  1188. case sm3_mac:
  1189. digestAlg = WC_SM3;
  1190. break;
  1191. #endif
  1192. default:
  1193. return BAD_FUNC_ARG;
  1194. }
  1195. #if defined(WOLFSSL_TICKET_NONCE_MALLOC) && \
  1196. (!defined(HAVE_FIPS) || (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3)))
  1197. PRIVATE_KEY_UNLOCK();
  1198. ret = wc_Tls13_HKDF_Expand_Label_Alloc(secret, ssl->specs.hash_size,
  1199. ssl->session->masterSecret, ssl->specs.hash_size, protocol, protocolLen,
  1200. resumptionLabel, RESUMPTION_LABEL_SZ, nonce, nonceLen, digestAlg,
  1201. ssl->heap);
  1202. PRIVATE_KEY_LOCK();
  1203. #else
  1204. ret = Tls13HKDFExpandLabel(ssl, secret, ssl->specs.hash_size,
  1205. ssl->session->masterSecret, ssl->specs.hash_size,
  1206. protocol, protocolLen, resumptionLabel,
  1207. RESUMPTION_LABEL_SZ, nonce, nonceLen, digestAlg);
  1208. #endif /* !defined(HAVE_FIPS) || FIPS_VERSION_GE(5,3) */
  1209. return ret;
  1210. }
  1211. #endif /* HAVE_SESSION_TICKET */
  1212. /* Calculate the HMAC of message data to this point.
  1213. *
  1214. * ssl The SSL/TLS object.
  1215. * key The HMAC key.
  1216. * hash The hash result - verify data.
  1217. * returns length of verify data generated.
  1218. */
  1219. static int BuildTls13HandshakeHmac(WOLFSSL* ssl, byte* key, byte* hash,
  1220. word32* pHashSz)
  1221. {
  1222. #ifdef WOLFSSL_SMALL_STACK
  1223. Hmac* verifyHmac;
  1224. #else
  1225. Hmac verifyHmac[1];
  1226. #endif
  1227. int hashType = WC_SHA256;
  1228. int hashSz = WC_SHA256_DIGEST_SIZE;
  1229. int ret = BAD_FUNC_ARG;
  1230. if (ssl == NULL || key == NULL || hash == NULL) {
  1231. return BAD_FUNC_ARG;
  1232. }
  1233. /* Get the hash of the previous handshake messages. */
  1234. switch (ssl->specs.mac_algorithm) {
  1235. #ifndef NO_SHA256
  1236. case sha256_mac:
  1237. hashType = WC_SHA256;
  1238. hashSz = WC_SHA256_DIGEST_SIZE;
  1239. ret = wc_Sha256GetHash(&ssl->hsHashes->hashSha256, hash);
  1240. break;
  1241. #endif /* !NO_SHA256 */
  1242. #ifdef WOLFSSL_SHA384
  1243. case sha384_mac:
  1244. hashType = WC_SHA384;
  1245. hashSz = WC_SHA384_DIGEST_SIZE;
  1246. ret = wc_Sha384GetHash(&ssl->hsHashes->hashSha384, hash);
  1247. break;
  1248. #endif /* WOLFSSL_SHA384 */
  1249. #ifdef WOLFSSL_TLS13_SHA512
  1250. case sha512_mac:
  1251. hashType = WC_SHA512;
  1252. hashSz = WC_SHA512_DIGEST_SIZE;
  1253. ret = wc_Sha512GetHash(&ssl->hsHashes->hashSha512, hash);
  1254. break;
  1255. #endif /* WOLFSSL_TLS13_SHA512 */
  1256. #ifdef WOLFSSL_SM3
  1257. case sm3_mac:
  1258. hashType = WC_SM3;
  1259. hashSz = WC_SM3_DIGEST_SIZE;
  1260. ret = wc_Sm3GetHash(&ssl->hsHashes->hashSm3, hash);
  1261. break;
  1262. #endif /* WOLFSSL_SM3 */
  1263. default:
  1264. break;
  1265. }
  1266. if (ret != 0)
  1267. return ret;
  1268. #ifdef WOLFSSL_DEBUG_TLS
  1269. WOLFSSL_MSG(" Key");
  1270. WOLFSSL_BUFFER(key, ssl->specs.hash_size);
  1271. WOLFSSL_MSG(" Msg Hash");
  1272. WOLFSSL_BUFFER(hash, hashSz);
  1273. #endif
  1274. #ifdef WOLFSSL_SMALL_STACK
  1275. verifyHmac = (Hmac*)XMALLOC(sizeof(Hmac), NULL, DYNAMIC_TYPE_HMAC);
  1276. if (verifyHmac == NULL) {
  1277. return MEMORY_E;
  1278. }
  1279. #endif
  1280. /* Calculate the verify data. */
  1281. ret = wc_HmacInit(verifyHmac, ssl->heap, ssl->devId);
  1282. if (ret == 0) {
  1283. ret = wc_HmacSetKey(verifyHmac, hashType, key, ssl->specs.hash_size);
  1284. if (ret == 0)
  1285. ret = wc_HmacUpdate(verifyHmac, hash, hashSz);
  1286. if (ret == 0)
  1287. ret = wc_HmacFinal(verifyHmac, hash);
  1288. wc_HmacFree(verifyHmac);
  1289. }
  1290. #ifdef WOLFSSL_SMALL_STACK
  1291. XFREE(verifyHmac, NULL, DYNAMIC_TYPE_HMAC);
  1292. #endif
  1293. #ifdef WOLFSSL_DEBUG_TLS
  1294. WOLFSSL_MSG(" Hash");
  1295. WOLFSSL_BUFFER(hash, hashSz);
  1296. #endif
  1297. if (pHashSz)
  1298. *pHashSz = hashSz;
  1299. return ret;
  1300. }
  1301. /* The length of the label to use when deriving keys. */
  1302. #define WRITE_KEY_LABEL_SZ 3
  1303. /* The length of the label to use when deriving IVs. */
  1304. #define WRITE_IV_LABEL_SZ 2
  1305. /* The label to use when deriving keys. */
  1306. static const byte writeKeyLabel[WRITE_KEY_LABEL_SZ+1] = "key";
  1307. /* The label to use when deriving IVs. */
  1308. static const byte writeIVLabel[WRITE_IV_LABEL_SZ+1] = "iv";
  1309. /* Derive the keys and IVs for TLS v1.3.
  1310. *
  1311. * ssl The SSL/TLS object.
  1312. * secret early_data_key when deriving the key and IV for encrypting early
  1313. * data application data and end_of_early_data messages.
  1314. * handshake_key when deriving keys and IVs for encrypting handshake
  1315. * messages.
  1316. * traffic_key when deriving first keys and IVs for encrypting
  1317. * traffic messages.
  1318. * update_traffic_key when deriving next keys and IVs for encrypting
  1319. * traffic messages.
  1320. * side ENCRYPT_SIDE_ONLY when only encryption secret needs to be derived.
  1321. * DECRYPT_SIDE_ONLY when only decryption secret needs to be derived.
  1322. * ENCRYPT_AND_DECRYPT_SIDE when both secret needs to be derived.
  1323. * store 1 indicates to derive the keys and IVs from derived secret and
  1324. * store ready for provisioning.
  1325. * returns 0 on success, otherwise failure.
  1326. */
  1327. int DeriveTls13Keys(WOLFSSL* ssl, int secret, int side, int store)
  1328. {
  1329. int ret = BAD_FUNC_ARG; /* Assume failure */
  1330. int i = 0;
  1331. #ifdef WOLFSSL_SMALL_STACK
  1332. byte* key_dig;
  1333. #else
  1334. byte key_dig[MAX_PRF_DIG];
  1335. #endif
  1336. int provision;
  1337. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  1338. ret = tsip_Tls13DeriveKeys(ssl, secret, side);
  1339. if (ret != CRYPTOCB_UNAVAILABLE) {
  1340. return ret;
  1341. }
  1342. ret = BAD_FUNC_ARG; /* Assume failure */
  1343. #endif
  1344. #ifdef WOLFSSL_SMALL_STACK
  1345. key_dig = (byte*)XMALLOC(MAX_PRF_DIG, ssl->heap, DYNAMIC_TYPE_DIGEST);
  1346. if (key_dig == NULL)
  1347. return MEMORY_E;
  1348. #endif
  1349. if (side == ENCRYPT_AND_DECRYPT_SIDE) {
  1350. provision = PROVISION_CLIENT_SERVER;
  1351. }
  1352. else {
  1353. provision = ((ssl->options.side != WOLFSSL_CLIENT_END) ^
  1354. (side == ENCRYPT_SIDE_ONLY)) ? PROVISION_CLIENT :
  1355. PROVISION_SERVER;
  1356. }
  1357. /* Derive the appropriate secret to use in the HKDF. */
  1358. switch (secret) {
  1359. #ifdef WOLFSSL_EARLY_DATA
  1360. case early_data_key:
  1361. ret = DeriveEarlyTrafficSecret(ssl, ssl->clientSecret,
  1362. WOLFSSL_CLIENT_END);
  1363. if (ret != 0)
  1364. goto end;
  1365. break;
  1366. #endif
  1367. case handshake_key:
  1368. if (provision & PROVISION_CLIENT) {
  1369. ret = DeriveClientHandshakeSecret(ssl,
  1370. ssl->clientSecret);
  1371. if (ret != 0)
  1372. goto end;
  1373. }
  1374. if (provision & PROVISION_SERVER) {
  1375. ret = DeriveServerHandshakeSecret(ssl,
  1376. ssl->serverSecret);
  1377. if (ret != 0)
  1378. goto end;
  1379. }
  1380. break;
  1381. case traffic_key:
  1382. if (provision & PROVISION_CLIENT) {
  1383. ret = DeriveClientTrafficSecret(ssl, ssl->clientSecret);
  1384. if (ret != 0)
  1385. goto end;
  1386. }
  1387. if (provision & PROVISION_SERVER) {
  1388. ret = DeriveServerTrafficSecret(ssl, ssl->serverSecret);
  1389. if (ret != 0)
  1390. goto end;
  1391. }
  1392. break;
  1393. case update_traffic_key:
  1394. if (provision & PROVISION_CLIENT) {
  1395. ret = DeriveTrafficSecret(ssl, ssl->clientSecret,
  1396. WOLFSSL_CLIENT_END);
  1397. if (ret != 0)
  1398. goto end;
  1399. }
  1400. if (provision & PROVISION_SERVER) {
  1401. ret = DeriveTrafficSecret(ssl, ssl->serverSecret,
  1402. WOLFSSL_SERVER_END);
  1403. if (ret != 0)
  1404. goto end;
  1405. }
  1406. break;
  1407. default:
  1408. break;
  1409. }
  1410. #ifdef WOLFSSL_QUIC
  1411. if (WOLFSSL_IS_QUIC(ssl)) {
  1412. ret = wolfSSL_quic_forward_secrets(ssl, secret, side);
  1413. if (ret != 0)
  1414. goto end;
  1415. }
  1416. #endif /* WOLFSSL_QUIC */
  1417. if (!store)
  1418. goto end;
  1419. /* Key data = client key | server key | client IV | server IV */
  1420. if (provision & PROVISION_CLIENT) {
  1421. /* Derive the client key. */
  1422. WOLFSSL_MSG("Derive Client Key");
  1423. ret = Tls13DeriveKey(ssl, &key_dig[i], ssl->specs.key_size,
  1424. ssl->clientSecret, writeKeyLabel,
  1425. WRITE_KEY_LABEL_SZ, ssl->specs.mac_algorithm, 0,
  1426. WOLFSSL_CLIENT_END);
  1427. if (ret != 0)
  1428. goto end;
  1429. i += ssl->specs.key_size;
  1430. }
  1431. if (provision & PROVISION_SERVER) {
  1432. /* Derive the server key. */
  1433. WOLFSSL_MSG("Derive Server Key");
  1434. ret = Tls13DeriveKey(ssl, &key_dig[i], ssl->specs.key_size,
  1435. ssl->serverSecret, writeKeyLabel,
  1436. WRITE_KEY_LABEL_SZ, ssl->specs.mac_algorithm, 0,
  1437. WOLFSSL_SERVER_END);
  1438. if (ret != 0)
  1439. goto end;
  1440. i += ssl->specs.key_size;
  1441. }
  1442. if (provision & PROVISION_CLIENT) {
  1443. /* Derive the client IV. */
  1444. WOLFSSL_MSG("Derive Client IV");
  1445. ret = Tls13DeriveKey(ssl, &key_dig[i], ssl->specs.iv_size,
  1446. ssl->clientSecret, writeIVLabel,
  1447. WRITE_IV_LABEL_SZ, ssl->specs.mac_algorithm, 0,
  1448. WOLFSSL_CLIENT_END);
  1449. if (ret != 0)
  1450. goto end;
  1451. i += ssl->specs.iv_size;
  1452. }
  1453. if (provision & PROVISION_SERVER) {
  1454. /* Derive the server IV. */
  1455. WOLFSSL_MSG("Derive Server IV");
  1456. ret = Tls13DeriveKey(ssl, &key_dig[i], ssl->specs.iv_size,
  1457. ssl->serverSecret, writeIVLabel,
  1458. WRITE_IV_LABEL_SZ, ssl->specs.mac_algorithm, 0,
  1459. WOLFSSL_SERVER_END);
  1460. if (ret != 0)
  1461. goto end;
  1462. i += ssl->specs.iv_size;
  1463. }
  1464. /* Store keys and IVs but don't activate them. */
  1465. ret = StoreKeys(ssl, key_dig, provision);
  1466. #ifdef WOLFSSL_DTLS13
  1467. if (ret != 0)
  1468. goto end;
  1469. if (ssl->options.dtls) {
  1470. ret = Dtls13DeriveSnKeys(ssl, provision);
  1471. if (ret != 0)
  1472. return ret;
  1473. }
  1474. #endif /* WOLFSSL_DTLS13 */
  1475. end:
  1476. ForceZero(key_dig, i);
  1477. #ifdef WOLFSSL_SMALL_STACK
  1478. XFREE(key_dig, ssl->heap, DYNAMIC_TYPE_DIGEST);
  1479. #elif defined(WOLFSSL_CHECK_MEM_ZERO)
  1480. wc_MemZero_Check(key_dig, MAX_PRF_DIG);
  1481. #endif
  1482. if (ret != 0) {
  1483. WOLFSSL_ERROR_VERBOSE(ret);
  1484. }
  1485. return ret;
  1486. }
  1487. #if (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK))
  1488. #ifdef WOLFSSL_32BIT_MILLI_TIME
  1489. #ifndef NO_ASN_TIME
  1490. #if defined(USER_TICKS)
  1491. #if 0
  1492. word32 TimeNowInMilliseconds(void)
  1493. {
  1494. /*
  1495. write your own clock tick function if don't want gettimeofday()
  1496. needs millisecond accuracy but doesn't have to correlated to EPOCH
  1497. */
  1498. }
  1499. #endif
  1500. #elif defined(TIME_OVERRIDES)
  1501. #if !defined(NO_ASN) && !defined(NO_ASN_TIME)
  1502. word32 TimeNowInMilliseconds(void)
  1503. {
  1504. return (word32) wc_Time(0) * 1000;
  1505. }
  1506. #else
  1507. #ifndef HAVE_TIME_T_TYPE
  1508. typedef long time_t;
  1509. #endif
  1510. extern time_t XTIME(time_t * timer);
  1511. /* The time in milliseconds.
  1512. * Used for tickets to represent difference between when first seen and when
  1513. * sending.
  1514. *
  1515. * returns the time in milliseconds as a 32-bit value.
  1516. */
  1517. word32 TimeNowInMilliseconds(void)
  1518. {
  1519. return (word32) XTIME(0) * 1000;
  1520. }
  1521. #endif
  1522. #elif defined(XTIME_MS)
  1523. word32 TimeNowInMilliseconds(void)
  1524. {
  1525. return (word32)XTIME_MS(0);
  1526. }
  1527. #elif defined(USE_WINDOWS_API)
  1528. /* The time in milliseconds.
  1529. * Used for tickets to represent difference between when first seen and when
  1530. * sending.
  1531. *
  1532. * returns the time in milliseconds as a 32-bit value.
  1533. */
  1534. word32 TimeNowInMilliseconds(void)
  1535. {
  1536. static int init = 0;
  1537. static LARGE_INTEGER freq;
  1538. LARGE_INTEGER count;
  1539. if (!init) {
  1540. QueryPerformanceFrequency(&freq);
  1541. init = 1;
  1542. }
  1543. QueryPerformanceCounter(&count);
  1544. return (word32)(count.QuadPart / (freq.QuadPart / 1000));
  1545. }
  1546. #elif defined(HAVE_RTP_SYS)
  1547. #include "rtptime.h"
  1548. /* The time in milliseconds.
  1549. * Used for tickets to represent difference between when first seen and when
  1550. * sending.
  1551. *
  1552. * returns the time in milliseconds as a 32-bit value.
  1553. */
  1554. word32 TimeNowInMilliseconds(void)
  1555. {
  1556. return (word32)rtp_get_system_sec() * 1000;
  1557. }
  1558. #elif defined(WOLFSSL_DEOS)
  1559. word32 TimeNowInMilliseconds(void)
  1560. {
  1561. const word32 systemTickTimeInHz = 1000000 / systemTickInMicroseconds();
  1562. word32 *systemTickPtr = systemTickPointer();
  1563. return (word32) (*systemTickPtr/systemTickTimeInHz) * 1000;
  1564. }
  1565. #elif defined(MICRIUM)
  1566. /* The time in milliseconds.
  1567. * Used for tickets to represent difference between when first seen and when
  1568. * sending.
  1569. *
  1570. * returns the time in milliseconds as a 32-bit value.
  1571. */
  1572. word32 TimeNowInMilliseconds(void)
  1573. {
  1574. OS_TICK ticks = 0;
  1575. OS_ERR err;
  1576. ticks = OSTimeGet(&err);
  1577. return (word32) (ticks / OSCfg_TickRate_Hz) * 1000;
  1578. }
  1579. #elif defined(MICROCHIP_TCPIP_V5)
  1580. /* The time in milliseconds.
  1581. * Used for tickets to represent difference between when first seen and when
  1582. * sending.
  1583. *
  1584. * returns the time in milliseconds as a 32-bit value.
  1585. */
  1586. word32 TimeNowInMilliseconds(void)
  1587. {
  1588. return (word32) (TickGet() / (TICKS_PER_SECOND / 1000));
  1589. }
  1590. #elif defined(MICROCHIP_TCPIP)
  1591. #if defined(MICROCHIP_MPLAB_HARMONY)
  1592. #include <system/tmr/sys_tmr.h>
  1593. /* The time in milliseconds.
  1594. * Used for tickets to represent difference between when first seen and when
  1595. * sending.
  1596. *
  1597. * returns the time in milliseconds as a 32-bit value.
  1598. */
  1599. word32 TimeNowInMilliseconds(void)
  1600. {
  1601. return (word32)(SYS_TMR_TickCountGet() /
  1602. (SYS_TMR_TickCounterFrequencyGet() / 1000));
  1603. }
  1604. #else
  1605. /* The time in milliseconds.
  1606. * Used for tickets to represent difference between when first seen and when
  1607. * sending.
  1608. *
  1609. * returns the time in milliseconds as a 32-bit value.
  1610. */
  1611. word32 TimeNowInMilliseconds(void)
  1612. {
  1613. return (word32)(SYS_TICK_Get() / (SYS_TICK_TicksPerSecondGet() / 1000));
  1614. }
  1615. #endif
  1616. #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX)
  1617. /* The time in milliseconds.
  1618. * Used for tickets to represent difference between when first seen and when
  1619. * sending.
  1620. *
  1621. * returns the time in milliseconds as a 32-bit value.
  1622. */
  1623. word32 TimeNowInMilliseconds(void)
  1624. {
  1625. TIME_STRUCT mqxTime;
  1626. _time_get_elapsed(&mqxTime);
  1627. return (word32) mqxTime.SECONDS * 1000;
  1628. }
  1629. #elif defined(FREESCALE_FREE_RTOS) || defined(FREESCALE_KSDK_FREERTOS)
  1630. #include "include/task.h"
  1631. /* The time in milliseconds.
  1632. * Used for tickets to represent difference between when first seen and when
  1633. * sending.
  1634. *
  1635. * returns the time in milliseconds as a 32-bit value.
  1636. */
  1637. word32 TimeNowInMilliseconds(void)
  1638. {
  1639. return (unsigned int)(((float)xTaskGetTickCount()) /
  1640. (configTICK_RATE_HZ / 1000));
  1641. }
  1642. #elif defined(FREESCALE_KSDK_BM)
  1643. #include "lwip/sys.h" /* lwIP */
  1644. /* The time in milliseconds.
  1645. * Used for tickets to represent difference between when first seen and when
  1646. * sending.
  1647. *
  1648. * returns the time in milliseconds as a 32-bit value.
  1649. */
  1650. word32 TimeNowInMilliseconds(void)
  1651. {
  1652. return sys_now();
  1653. }
  1654. #elif defined(WOLFSSL_CMSIS_RTOS) || defined(WOLFSSL_CMSIS_RTOSv2)
  1655. word32 TimeNowInMilliseconds(void)
  1656. {
  1657. return (word32)osKernelGetTickCount();
  1658. }
  1659. #elif defined(WOLFSSL_TIRTOS)
  1660. /* The time in milliseconds.
  1661. * Used for tickets to represent difference between when first seen and when
  1662. * sending.
  1663. *
  1664. * returns the time in milliseconds as a 32-bit value.
  1665. */
  1666. word32 TimeNowInMilliseconds(void)
  1667. {
  1668. return (word32) Seconds_get() * 1000;
  1669. }
  1670. #elif defined(WOLFSSL_UTASKER)
  1671. /* The time in milliseconds.
  1672. * Used for tickets to represent difference between when first seen and when
  1673. * sending.
  1674. *
  1675. * returns the time in milliseconds as a 32-bit value.
  1676. */
  1677. word32 TimeNowInMilliseconds(void)
  1678. {
  1679. return (word32)(uTaskerSystemTick / (TICK_RESOLUTION / 1000));
  1680. }
  1681. #elif defined(WOLFSSL_LINUXKM)
  1682. word32 TimeNowInMilliseconds(void)
  1683. {
  1684. s64 t;
  1685. #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 0, 0)
  1686. struct timespec ts;
  1687. getnstimeofday(&ts);
  1688. t = ts.tv_sec * (s64)1000;
  1689. t += ts.tv_nsec / (s64)1000000;
  1690. #else
  1691. struct timespec64 ts;
  1692. #if LINUX_VERSION_CODE < KERNEL_VERSION(5, 0, 0)
  1693. ts = current_kernel_time64();
  1694. #else
  1695. ktime_get_coarse_real_ts64(&ts);
  1696. #endif
  1697. t = ts.tv_sec * 1000L;
  1698. t += ts.tv_nsec / 1000000L;
  1699. #endif
  1700. return (word32)t;
  1701. }
  1702. #elif defined(WOLFSSL_QNX_CAAM)
  1703. word32 TimeNowInMilliseconds(void)
  1704. {
  1705. struct timespec now;
  1706. clock_gettime(CLOCK_REALTIME, &now);
  1707. return (word32)(now.tv_sec * 1000 + now.tv_nsec / 1000000);
  1708. }
  1709. #elif defined(FUSION_RTOS)
  1710. /* The time in milliseconds.
  1711. * Used for tickets to represent difference between when first seen and when
  1712. * sending.
  1713. *
  1714. * returns the time in milliseconds as a 32-bit value.
  1715. */
  1716. word32 TimeNowInMilliseconds(void)
  1717. {
  1718. struct timeval now;
  1719. if (FCL_GETTIMEOFDAY(&now, 0) < 0)
  1720. return 0;
  1721. /* Convert to milliseconds number. */
  1722. return (word32)(now.tv_sec * 1000 + now.tv_usec / 1000);
  1723. }
  1724. #elif defined(WOLFSSL_ZEPHYR)
  1725. word32 TimeNowInMilliseconds(void)
  1726. {
  1727. #if defined(CONFIG_ARCH_POSIX)
  1728. k_cpu_idle();
  1729. #endif
  1730. return (word32)k_uptime_get() / 1000;
  1731. }
  1732. #else
  1733. /* The time in milliseconds.
  1734. * Used for tickets to represent difference between when first seen and when
  1735. * sending.
  1736. *
  1737. * returns the time in milliseconds as a 32-bit value.
  1738. */
  1739. word32 TimeNowInMilliseconds(void)
  1740. {
  1741. struct timeval now;
  1742. if (gettimeofday(&now, 0) < 0)
  1743. return 0;
  1744. /* Convert to milliseconds number. */
  1745. return (word32)(now.tv_sec * 1000 + now.tv_usec / 1000);
  1746. }
  1747. #endif
  1748. #else
  1749. /* user must supply time in milliseconds function:
  1750. * word32 TimeNowInMilliseconds(void);
  1751. * The response is milliseconds elapsed
  1752. */
  1753. #endif /* !NO_ASN_TIME */
  1754. #else
  1755. #ifndef NO_ASN_TIME
  1756. #if defined(USER_TICKS)
  1757. #if 0
  1758. sword64 TimeNowInMilliseconds(void)
  1759. {
  1760. /*
  1761. write your own clock tick function if don't want gettimeofday()
  1762. needs millisecond accuracy but doesn't have to correlated to EPOCH
  1763. */
  1764. }
  1765. #endif
  1766. #elif defined(TIME_OVERRIDES)
  1767. #if !defined(NO_ASN) && !defined(NO_ASN_TIME)
  1768. sword64 TimeNowInMilliseconds(void)
  1769. {
  1770. return (sword64) wc_Time(0) * 1000;
  1771. }
  1772. #else
  1773. #ifndef HAVE_TIME_T_TYPE
  1774. typedef long time_t;
  1775. #endif
  1776. extern time_t XTIME(time_t * timer);
  1777. /* The time in milliseconds.
  1778. * Used for tickets to represent difference between when first seen and when
  1779. * sending.
  1780. *
  1781. * returns the time in milliseconds as a 32-bit value.
  1782. */
  1783. sword64 TimeNowInMilliseconds(void)
  1784. {
  1785. return (sword64) XTIME(0) * 1000;
  1786. }
  1787. #endif
  1788. #elif defined(XTIME_MS)
  1789. sword64 TimeNowInMilliseconds(void)
  1790. {
  1791. return (sword64)XTIME_MS(0);
  1792. }
  1793. #elif defined(USE_WINDOWS_API)
  1794. /* The time in milliseconds.
  1795. * Used for tickets to represent difference between when first seen and when
  1796. * sending.
  1797. *
  1798. * returns the time in milliseconds as a 64-bit value.
  1799. */
  1800. sword64 TimeNowInMilliseconds(void)
  1801. {
  1802. static int init = 0;
  1803. static LARGE_INTEGER freq;
  1804. LARGE_INTEGER count;
  1805. if (!init) {
  1806. QueryPerformanceFrequency(&freq);
  1807. init = 1;
  1808. }
  1809. QueryPerformanceCounter(&count);
  1810. return (sword64)(count.QuadPart / (freq.QuadPart / 1000));
  1811. }
  1812. #elif defined(HAVE_RTP_SYS)
  1813. #include "rtptime.h"
  1814. /* The time in milliseconds.
  1815. * Used for tickets to represent difference between when first seen and when
  1816. * sending.
  1817. *
  1818. * returns the time in milliseconds as a 64-bit value.
  1819. */
  1820. sword64 TimeNowInMilliseconds(void)
  1821. {
  1822. return (sword64)rtp_get_system_sec() * 1000;
  1823. }
  1824. #elif defined(WOLFSSL_DEOS)
  1825. sword64 TimeNowInMilliseconds(void)
  1826. {
  1827. const word32 systemTickTimeInHz = 1000000 / systemTickInMicroseconds();
  1828. word32 *systemTickPtr = systemTickPointer();
  1829. return (sword64) (*systemTickPtr/systemTickTimeInHz) * 1000;
  1830. }
  1831. #elif defined(MICRIUM)
  1832. /* The time in milliseconds.
  1833. * Used for tickets to represent difference between when first seen and when
  1834. * sending.
  1835. *
  1836. * returns the time in milliseconds as a 64-bit value.
  1837. */
  1838. sword64 TimeNowInMilliseconds(void)
  1839. {
  1840. OS_TICK ticks = 0;
  1841. OS_ERR err;
  1842. ticks = OSTimeGet(&err);
  1843. return (sword64) (ticks / OSCfg_TickRate_Hz) * 1000;
  1844. }
  1845. #elif defined(MICROCHIP_TCPIP_V5)
  1846. /* The time in milliseconds.
  1847. * Used for tickets to represent difference between when first seen and when
  1848. * sending.
  1849. *
  1850. * returns the time in milliseconds as a 64-bit value.
  1851. */
  1852. sword64 TimeNowInMilliseconds(void)
  1853. {
  1854. return (sword64) (TickGet() / (TICKS_PER_SECOND / 1000));
  1855. }
  1856. #elif defined(MICROCHIP_TCPIP)
  1857. #if defined(MICROCHIP_MPLAB_HARMONY)
  1858. #include <system/tmr/sys_tmr.h>
  1859. /* The time in milliseconds.
  1860. * Used for tickets to represent difference between when first seen and when
  1861. * sending.
  1862. *
  1863. * returns the time in milliseconds as a 64-bit value.
  1864. */
  1865. sword64 TimeNowInMilliseconds(void)
  1866. {
  1867. return (sword64)SYS_TMR_TickCountGet() /
  1868. (SYS_TMR_TickCounterFrequencyGet() / 1000);
  1869. }
  1870. #else
  1871. /* The time in milliseconds.
  1872. * Used for tickets to represent difference between when first seen and when
  1873. * sending.
  1874. *
  1875. * returns the time in milliseconds as a 64-bit value.
  1876. */
  1877. sword64 TimeNowInMilliseconds(void)
  1878. {
  1879. return (sword64)SYS_TICK_Get() / (SYS_TICK_TicksPerSecondGet() / 1000);
  1880. }
  1881. #endif
  1882. #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX)
  1883. /* The time in milliseconds.
  1884. * Used for tickets to represent difference between when first seen and when
  1885. * sending.
  1886. *
  1887. * returns the time in milliseconds as a 64-bit value.
  1888. */
  1889. sword64 TimeNowInMilliseconds(void)
  1890. {
  1891. TIME_STRUCT mqxTime;
  1892. _time_get_elapsed(&mqxTime);
  1893. return (sword64) mqxTime.SECONDS * 1000;
  1894. }
  1895. #elif defined(FREESCALE_FREE_RTOS) || defined(FREESCALE_KSDK_FREERTOS)
  1896. #include "include/task.h"
  1897. /* The time in milliseconds.
  1898. * Used for tickets to represent difference between when first seen and when
  1899. * sending.
  1900. *
  1901. * returns the time in milliseconds as a 64-bit value.
  1902. */
  1903. sword64 TimeNowInMilliseconds(void)
  1904. {
  1905. return (sword64)xTaskGetTickCount() / (configTICK_RATE_HZ / 1000);
  1906. }
  1907. #elif defined(FREESCALE_KSDK_BM)
  1908. #include "lwip/sys.h" /* lwIP */
  1909. /* The time in milliseconds.
  1910. * Used for tickets to represent difference between when first seen and when
  1911. * sending.
  1912. *
  1913. * returns the time in milliseconds as a 64-bit value.
  1914. */
  1915. sword64 TimeNowInMilliseconds(void)
  1916. {
  1917. return sys_now();
  1918. }
  1919. #elif defined(WOLFSSL_CMSIS_RTOS) || defined(WOLFSSL_CMSIS_RTOSv2)
  1920. sword64 TimeNowInMilliseconds(void)
  1921. {
  1922. return (sword64)osKernelGetTickCount();
  1923. }
  1924. #elif defined(WOLFSSL_TIRTOS)
  1925. /* The time in milliseconds.
  1926. * Used for tickets to represent difference between when first seen and when
  1927. * sending.
  1928. *
  1929. * returns the time in milliseconds as a 64-bit value.
  1930. */
  1931. sword64 TimeNowInMilliseconds(void)
  1932. {
  1933. return (sword64) Seconds_get() * 1000;
  1934. }
  1935. #elif defined(WOLFSSL_UTASKER)
  1936. /* The time in milliseconds.
  1937. * Used for tickets to represent difference between when first seen and when
  1938. * sending.
  1939. *
  1940. * returns the time in milliseconds as a 64-bit value.
  1941. */
  1942. sword64 TimeNowInMilliseconds(void)
  1943. {
  1944. return (sword64)(uTaskerSystemTick / (TICK_RESOLUTION / 1000));
  1945. }
  1946. #elif defined(WOLFSSL_LINUXKM)
  1947. sword64 TimeNowInMilliseconds(void)
  1948. {
  1949. s64 t;
  1950. #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 0, 0)
  1951. struct timespec ts;
  1952. getnstimeofday(&ts);
  1953. t = ts.tv_sec * (s64)1000;
  1954. t += ts.tv_nsec / (s64)1000000;
  1955. #else
  1956. struct timespec64 ts;
  1957. #if LINUX_VERSION_CODE < KERNEL_VERSION(5, 0, 0)
  1958. ts = current_kernel_time64();
  1959. #else
  1960. ktime_get_coarse_real_ts64(&ts);
  1961. #endif
  1962. t = ts.tv_sec * 1000L;
  1963. t += ts.tv_nsec / 1000000L;
  1964. #endif
  1965. return (sword64)t;
  1966. }
  1967. #elif defined(WOLFSSL_QNX_CAAM)
  1968. sword64 TimeNowInMilliseconds(void)
  1969. {
  1970. struct timespec now;
  1971. clock_gettime(CLOCK_REALTIME, &now);
  1972. return (sword64)(now.tv_sec * 1000 + now.tv_nsec / 1000000);
  1973. }
  1974. #elif defined(FUSION_RTOS)
  1975. /* The time in milliseconds.
  1976. * Used for tickets to represent difference between when first seen and when
  1977. * sending.
  1978. *
  1979. * returns the time in milliseconds as a 64-bit value.
  1980. */
  1981. sword64 TimeNowInMilliseconds(void)
  1982. {
  1983. struct timeval now;
  1984. if (FCL_GETTIMEOFDAY(&now, 0) < 0)
  1985. return 0;
  1986. /* Convert to milliseconds number. */
  1987. return (sword64)now.tv_sec * 1000 + now.tv_usec / 1000;
  1988. }
  1989. #elif defined(WOLFSSL_ZEPHYR)
  1990. sword64 TimeNowInMilliseconds(void)
  1991. {
  1992. #if defined(CONFIG_ARCH_POSIX)
  1993. k_cpu_idle();
  1994. #endif
  1995. return (sword64)k_uptime_get() / 1000;
  1996. }
  1997. #else
  1998. /* The time in milliseconds.
  1999. * Used for tickets to represent difference between when first seen and when
  2000. * sending.
  2001. *
  2002. * returns the time in milliseconds as a 64-bit value.
  2003. */
  2004. sword64 TimeNowInMilliseconds(void)
  2005. {
  2006. struct timeval now;
  2007. if (gettimeofday(&now, 0) < 0)
  2008. return 0;
  2009. /* Convert to milliseconds number. */
  2010. return (sword64)now.tv_sec * 1000 + now.tv_usec / 1000;
  2011. }
  2012. #endif
  2013. #else
  2014. /* user must supply time in milliseconds function:
  2015. * sword64 TimeNowInMilliseconds(void);
  2016. * The response is milliseconds elapsed
  2017. */
  2018. #endif /* !NO_ASN_TIME */
  2019. #endif /* WOLFSSL_32BIT_MILLI_TIME */
  2020. #endif /* HAVE_SESSION_TICKET || !NO_PSK */
  2021. /* Extract the handshake header information.
  2022. *
  2023. * ssl The SSL/TLS object.
  2024. * input The buffer holding the message data.
  2025. * inOutIdx On entry, the index into the buffer of the handshake data.
  2026. * On exit, the start of the handshake data.
  2027. * type Type of handshake message.
  2028. * size The length of the handshake message data.
  2029. * totalSz The total size of data in the buffer.
  2030. * returns BUFFER_E if there is not enough input data and 0 on success.
  2031. */
  2032. static int GetHandshakeHeader(WOLFSSL* ssl, const byte* input, word32* inOutIdx,
  2033. byte* type, word32* size, word32 totalSz)
  2034. {
  2035. const byte* ptr = input + *inOutIdx;
  2036. (void)ssl;
  2037. *inOutIdx += HANDSHAKE_HEADER_SZ;
  2038. if (*inOutIdx > totalSz)
  2039. return BUFFER_E;
  2040. *type = ptr[0];
  2041. c24to32(&ptr[1], size);
  2042. return 0;
  2043. }
  2044. /* Add record layer header to message.
  2045. *
  2046. * output The buffer to write the record layer header into.
  2047. * length The length of the record data.
  2048. * type The type of record message.
  2049. * ssl The SSL/TLS object.
  2050. */
  2051. static void AddTls13RecordHeader(byte* output, word32 length, byte type,
  2052. WOLFSSL* ssl)
  2053. {
  2054. RecordLayerHeader* rl;
  2055. rl = (RecordLayerHeader*)output;
  2056. rl->type = type;
  2057. rl->pvMajor = ssl->version.major;
  2058. /* NOTE: May be TLSv1_MINOR when sending first ClientHello. */
  2059. rl->pvMinor = TLSv1_2_MINOR;
  2060. c16toa((word16)length, rl->length);
  2061. }
  2062. /* Add handshake header to message.
  2063. *
  2064. * output The buffer to write the handshake header into.
  2065. * length The length of the handshake data.
  2066. * fragOffset The offset of the fragment data. (DTLS)
  2067. * fragLength The length of the fragment data. (DTLS)
  2068. * type The type of handshake message.
  2069. * ssl The SSL/TLS object. (DTLS)
  2070. */
  2071. static void AddTls13HandShakeHeader(byte* output, word32 length,
  2072. word32 fragOffset, word32 fragLength,
  2073. byte type, WOLFSSL* ssl)
  2074. {
  2075. HandShakeHeader* hs;
  2076. (void)fragOffset;
  2077. (void)fragLength;
  2078. (void)ssl;
  2079. #ifdef WOLFSSL_DTLS13
  2080. /* message_hash type is used for a synthetic message that replaces the first
  2081. ClientHello in the hash transcript when using HelloRetryRequest. It will
  2082. never be transmitted and, as the DTLS-only fields must not be considered
  2083. when computing the hash transcript, we can avoid to use the DTLS
  2084. handshake header. */
  2085. if (ssl->options.dtls && type != message_hash) {
  2086. Dtls13HandshakeAddHeader(ssl, output, (enum HandShakeType)type, length);
  2087. return;
  2088. }
  2089. #endif /* WOLFSSL_DTLS13 */
  2090. /* handshake header */
  2091. hs = (HandShakeHeader*)output;
  2092. hs->type = type;
  2093. c32to24(length, hs->length);
  2094. }
  2095. /* Add both record layer and handshake header to message.
  2096. *
  2097. * output The buffer to write the headers into.
  2098. * length The length of the handshake data.
  2099. * type The type of record layer message.
  2100. * ssl The SSL/TLS object. (DTLS)
  2101. */
  2102. static void AddTls13Headers(byte* output, word32 length, byte type,
  2103. WOLFSSL* ssl)
  2104. {
  2105. word32 lengthAdj = HANDSHAKE_HEADER_SZ;
  2106. word32 outputAdj = RECORD_HEADER_SZ;
  2107. #ifdef WOLFSSL_DTLS13
  2108. if (ssl->options.dtls) {
  2109. Dtls13AddHeaders(output, length, (enum HandShakeType)type, ssl);
  2110. return;
  2111. }
  2112. #endif /* WOLFSSL_DTLS13 */
  2113. AddTls13RecordHeader(output, length + lengthAdj, handshake, ssl);
  2114. AddTls13HandShakeHeader(output + outputAdj, length, 0, length, type, ssl);
  2115. }
  2116. #if (!defined(NO_WOLFSSL_CLIENT) || !defined(NO_WOLFSSL_SERVER)) \
  2117. && !defined(NO_CERTS)
  2118. /* Add both record layer and fragment handshake header to message.
  2119. *
  2120. * output The buffer to write the headers into.
  2121. * fragOffset The offset of the fragment data. (DTLS)
  2122. * fragLength The length of the fragment data. (DTLS)
  2123. * length The length of the handshake data.
  2124. * type The type of record layer message.
  2125. * ssl The SSL/TLS object. (DTLS)
  2126. */
  2127. static void AddTls13FragHeaders(byte* output, word32 fragSz, word32 fragOffset,
  2128. word32 length, byte type, WOLFSSL* ssl)
  2129. {
  2130. word32 lengthAdj = HANDSHAKE_HEADER_SZ;
  2131. word32 outputAdj = RECORD_HEADER_SZ;
  2132. (void)fragSz;
  2133. #ifdef WOLFSSL_DTLS13
  2134. /* we ignore fragmentation fields here because fragmentation logic for
  2135. DTLS1.3 is inside dtls13_handshake_send(). */
  2136. if (ssl->options.dtls) {
  2137. Dtls13AddHeaders(output, length, (enum HandShakeType)type, ssl);
  2138. return;
  2139. }
  2140. #endif /* WOLFSSL_DTLS13 */
  2141. AddTls13RecordHeader(output, fragSz + lengthAdj, handshake, ssl);
  2142. AddTls13HandShakeHeader(output + outputAdj, length, fragOffset, fragSz,
  2143. type, ssl);
  2144. }
  2145. #endif /* (!NO_WOLFSSL_CLIENT || !NO_WOLFSSL_SERVER) && !NO_CERTS */
  2146. /* Write the sequence number into the buffer.
  2147. * No DTLS v1.3 support.
  2148. *
  2149. * ssl The SSL/TLS object.
  2150. * verifyOrder Which set of sequence numbers to use.
  2151. * out The buffer to write into.
  2152. */
  2153. static WC_INLINE void WriteSEQTls13(WOLFSSL* ssl, int verifyOrder, byte* out)
  2154. {
  2155. word32 seq[2] = {0, 0};
  2156. if (ssl->options.dtls) {
  2157. #ifdef WOLFSSL_DTLS13
  2158. Dtls13GetSeq(ssl, verifyOrder, seq, 1);
  2159. #endif /* WOLFSSL_DTLS13 */
  2160. }
  2161. else if (verifyOrder == PEER_ORDER) {
  2162. seq[0] = ssl->keys.peer_sequence_number_hi;
  2163. seq[1] = ssl->keys.peer_sequence_number_lo++;
  2164. /* handle rollover */
  2165. if (seq[1] > ssl->keys.peer_sequence_number_lo)
  2166. ssl->keys.peer_sequence_number_hi++;
  2167. }
  2168. else {
  2169. seq[0] = ssl->keys.sequence_number_hi;
  2170. seq[1] = ssl->keys.sequence_number_lo++;
  2171. /* handle rollover */
  2172. if (seq[1] > ssl->keys.sequence_number_lo)
  2173. ssl->keys.sequence_number_hi++;
  2174. }
  2175. c32toa(seq[0], out);
  2176. c32toa(seq[1], out + OPAQUE32_LEN);
  2177. }
  2178. /* Build the nonce for TLS v1.3 encryption and decryption.
  2179. *
  2180. * ssl The SSL/TLS object.
  2181. * nonce The nonce data to use when encrypting or decrypting.
  2182. * iv The derived IV.
  2183. * order The side on which the message is to be or was sent.
  2184. */
  2185. static WC_INLINE void BuildTls13Nonce(WOLFSSL* ssl, byte* nonce, const byte* iv,
  2186. int order)
  2187. {
  2188. int i;
  2189. /* The nonce is the IV with the sequence XORed into the last bytes. */
  2190. WriteSEQTls13(ssl, order, nonce + AEAD_NONCE_SZ - SEQ_SZ);
  2191. for (i = 0; i < AEAD_NONCE_SZ - SEQ_SZ; i++)
  2192. nonce[i] = iv[i];
  2193. for (; i < AEAD_NONCE_SZ; i++)
  2194. nonce[i] ^= iv[i];
  2195. }
  2196. #if defined(HAVE_CHACHA) && defined(HAVE_POLY1305)
  2197. /* Encrypt with ChaCha20 and create authentication tag with Poly1305.
  2198. *
  2199. * ssl The SSL/TLS object.
  2200. * output The buffer to write encrypted data and authentication tag into.
  2201. * May be the same pointer as input.
  2202. * input The data to encrypt.
  2203. * sz The number of bytes to encrypt.
  2204. * nonce The nonce to use with ChaCha20.
  2205. * aad The additional authentication data.
  2206. * aadSz The size of the addition authentication data.
  2207. * tag The authentication tag buffer.
  2208. * returns 0 on success, otherwise failure.
  2209. */
  2210. static int ChaCha20Poly1305_Encrypt(WOLFSSL* ssl, byte* output,
  2211. const byte* input, word16 sz, byte* nonce,
  2212. const byte* aad, word16 aadSz, byte* tag)
  2213. {
  2214. int ret = 0;
  2215. byte poly[CHACHA20_256_KEY_SIZE];
  2216. /* Poly1305 key is 256 bits of zero encrypted with ChaCha20. */
  2217. XMEMSET(poly, 0, sizeof(poly));
  2218. /* Set the nonce for ChaCha and get Poly1305 key. */
  2219. ret = wc_Chacha_SetIV(ssl->encrypt.chacha, nonce, 0);
  2220. if (ret != 0)
  2221. return ret;
  2222. /* Create Poly1305 key using ChaCha20 keystream. */
  2223. ret = wc_Chacha_Process(ssl->encrypt.chacha, poly, poly, sizeof(poly));
  2224. if (ret != 0)
  2225. return ret;
  2226. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2227. wc_MemZero_Add("ChaCha20Poly1305_Encrypt poly", poly, sizeof(poly));
  2228. #endif
  2229. ret = wc_Chacha_SetIV(ssl->encrypt.chacha, nonce, 1);
  2230. if (ret != 0)
  2231. return ret;
  2232. /* Encrypt the plain text. */
  2233. ret = wc_Chacha_Process(ssl->encrypt.chacha, output, input, sz);
  2234. if (ret != 0) {
  2235. ForceZero(poly, sizeof(poly));
  2236. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2237. wc_MemZero_Check(poly, sizeof(poly));
  2238. #endif
  2239. return ret;
  2240. }
  2241. /* Set key for Poly1305. */
  2242. ret = wc_Poly1305SetKey(ssl->auth.poly1305, poly, sizeof(poly));
  2243. ForceZero(poly, sizeof(poly)); /* done with poly1305 key, clear it */
  2244. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2245. wc_MemZero_Check(poly, sizeof(poly));
  2246. #endif
  2247. if (ret != 0)
  2248. return ret;
  2249. /* Add authentication code of encrypted data to end. */
  2250. ret = wc_Poly1305_MAC(ssl->auth.poly1305, aad, aadSz, output, sz, tag,
  2251. POLY1305_AUTH_SZ);
  2252. return ret;
  2253. }
  2254. #endif
  2255. #ifdef HAVE_NULL_CIPHER
  2256. /* Create authentication tag and copy data over input.
  2257. *
  2258. * ssl The SSL/TLS object.
  2259. * output The buffer to copy data into.
  2260. * May be the same pointer as input.
  2261. * input The data.
  2262. * sz The number of bytes of data.
  2263. * nonce The nonce to use with authentication.
  2264. * aad The additional authentication data.
  2265. * aadSz The size of the addition authentication data.
  2266. * tag The authentication tag buffer.
  2267. * returns 0 on success, otherwise failure.
  2268. */
  2269. static int Tls13IntegrityOnly_Encrypt(WOLFSSL* ssl, byte* output,
  2270. const byte* input, word16 sz,
  2271. const byte* nonce,
  2272. const byte* aad, word16 aadSz, byte* tag)
  2273. {
  2274. int ret;
  2275. /* HMAC: nonce | aad | input */
  2276. ret = wc_HmacUpdate(ssl->encrypt.hmac, nonce, HMAC_NONCE_SZ);
  2277. if (ret == 0)
  2278. ret = wc_HmacUpdate(ssl->encrypt.hmac, aad, aadSz);
  2279. if (ret == 0)
  2280. ret = wc_HmacUpdate(ssl->encrypt.hmac, input, sz);
  2281. if (ret == 0)
  2282. ret = wc_HmacFinal(ssl->encrypt.hmac, tag);
  2283. /* Copy the input to output if not the same buffer */
  2284. if (ret == 0 && output != input)
  2285. XMEMCPY(output, input, sz);
  2286. return ret;
  2287. }
  2288. #endif
  2289. /* Encrypt data for TLS v1.3.
  2290. *
  2291. * ssl The SSL/TLS object.
  2292. * output The buffer to write encrypted data and authentication tag into.
  2293. * May be the same pointer as input.
  2294. * input The record header and data to encrypt.
  2295. * sz The number of bytes to encrypt.
  2296. * aad The additional authentication data.
  2297. * aadSz The size of the addition authentication data.
  2298. * asyncOkay If non-zero can return WC_PENDING_E, otherwise blocks on crypto
  2299. * returns 0 on success, otherwise failure.
  2300. */
  2301. static int EncryptTls13(WOLFSSL* ssl, byte* output, const byte* input,
  2302. word16 sz, const byte* aad, word16 aadSz, int asyncOkay)
  2303. {
  2304. int ret = 0;
  2305. word16 dataSz = sz - ssl->specs.aead_mac_size;
  2306. word16 macSz = ssl->specs.aead_mac_size;
  2307. word32 nonceSz = 0;
  2308. #ifdef WOLFSSL_ASYNC_CRYPT
  2309. WC_ASYNC_DEV* asyncDev = NULL;
  2310. word32 event_flags = WC_ASYNC_FLAG_CALL_AGAIN;
  2311. #endif
  2312. WOLFSSL_ENTER("EncryptTls13");
  2313. (void)output;
  2314. (void)input;
  2315. (void)sz;
  2316. (void)dataSz;
  2317. (void)macSz;
  2318. (void)asyncOkay;
  2319. (void)nonceSz;
  2320. #ifdef WOLFSSL_ASYNC_CRYPT
  2321. if (ssl->error == WC_PENDING_E) {
  2322. ssl->error = 0; /* clear async */
  2323. }
  2324. #endif
  2325. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  2326. ret = tsip_Tls13AesEncrypt(ssl, output, input, dataSz);
  2327. if (ret != CRYPTOCB_UNAVAILABLE) {
  2328. if (ret > 0) {
  2329. ret = 0; /* tsip_Tls13AesEncrypt returns output size */
  2330. }
  2331. return ret;
  2332. }
  2333. ret = 0;
  2334. #endif /* WOLFSSL_RENESAS_TSIP_TLS */
  2335. switch (ssl->encrypt.state) {
  2336. case CIPHER_STATE_BEGIN:
  2337. {
  2338. #ifdef WOLFSSL_DEBUG_TLS
  2339. WOLFSSL_MSG("Data to encrypt");
  2340. WOLFSSL_BUFFER(input, dataSz);
  2341. WOLFSSL_MSG("Additional Authentication Data");
  2342. WOLFSSL_BUFFER(aad, aadSz);
  2343. #endif
  2344. #ifdef WOLFSSL_CIPHER_TEXT_CHECK
  2345. if (ssl->specs.bulk_cipher_algorithm != wolfssl_cipher_null) {
  2346. XMEMCPY(ssl->encrypt.sanityCheck, input,
  2347. min(dataSz, sizeof(ssl->encrypt.sanityCheck)));
  2348. }
  2349. #endif
  2350. #ifdef CIPHER_NONCE
  2351. if (ssl->encrypt.nonce == NULL) {
  2352. ssl->encrypt.nonce = (byte*)XMALLOC(AEAD_NONCE_SZ,
  2353. ssl->heap, DYNAMIC_TYPE_CIPHER);
  2354. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2355. if (ssl->encrypt.nonce != NULL) {
  2356. wc_MemZero_Add("EncryptTls13 nonce", ssl->encrypt.nonce,
  2357. AEAD_NONCE_SZ);
  2358. }
  2359. #endif
  2360. }
  2361. if (ssl->encrypt.nonce == NULL)
  2362. return MEMORY_E;
  2363. BuildTls13Nonce(ssl, ssl->encrypt.nonce, ssl->keys.aead_enc_imp_IV,
  2364. CUR_ORDER);
  2365. #endif
  2366. /* Advance state and proceed */
  2367. ssl->encrypt.state = CIPHER_STATE_DO;
  2368. }
  2369. FALL_THROUGH;
  2370. case CIPHER_STATE_DO:
  2371. {
  2372. switch (ssl->specs.bulk_cipher_algorithm) {
  2373. #ifdef BUILD_AESGCM
  2374. case wolfssl_aes_gcm:
  2375. #ifdef WOLFSSL_ASYNC_CRYPT
  2376. /* initialize event */
  2377. asyncDev = &ssl->encrypt.aes->asyncDev;
  2378. ret = wolfSSL_AsyncInit(ssl, asyncDev, event_flags);
  2379. if (ret != 0)
  2380. break;
  2381. #endif
  2382. nonceSz = AESGCM_NONCE_SZ;
  2383. #if defined(HAVE_PK_CALLBACKS)
  2384. ret = NOT_COMPILED_IN;
  2385. if (ssl->ctx && ssl->ctx->PerformTlsRecordProcessingCb) {
  2386. ret = ssl->ctx->PerformTlsRecordProcessingCb(ssl, 1,
  2387. output, input, dataSz,
  2388. ssl->encrypt.nonce, nonceSz,
  2389. output + dataSz, macSz,
  2390. aad, aadSz);
  2391. }
  2392. if (ret == NOT_COMPILED_IN)
  2393. #endif
  2394. {
  2395. #if ((defined(HAVE_FIPS) || defined(HAVE_SELFTEST)) && \
  2396. (!defined(HAVE_FIPS_VERSION) || (HAVE_FIPS_VERSION < 2)))
  2397. ret = wc_AesGcmEncrypt(ssl->encrypt.aes, output, input,
  2398. dataSz, ssl->encrypt.nonce, nonceSz,
  2399. output + dataSz, macSz, aad, aadSz);
  2400. #else
  2401. ret = wc_AesGcmSetExtIV(ssl->encrypt.aes,
  2402. ssl->encrypt.nonce, nonceSz);
  2403. if (ret == 0) {
  2404. ret = wc_AesGcmEncrypt_ex(ssl->encrypt.aes, output,
  2405. input, dataSz, ssl->encrypt.nonce, nonceSz,
  2406. output + dataSz, macSz, aad, aadSz);
  2407. }
  2408. #endif
  2409. }
  2410. break;
  2411. #endif
  2412. #ifdef HAVE_AESCCM
  2413. case wolfssl_aes_ccm:
  2414. #ifdef WOLFSSL_ASYNC_CRYPT
  2415. /* initialize event */
  2416. asyncDev = &ssl->encrypt.aes->asyncDev;
  2417. ret = wolfSSL_AsyncInit(ssl, asyncDev, event_flags);
  2418. if (ret != 0)
  2419. break;
  2420. #endif
  2421. nonceSz = AESCCM_NONCE_SZ;
  2422. #if defined(HAVE_PK_CALLBACKS)
  2423. ret = NOT_COMPILED_IN;
  2424. if (ssl->ctx && ssl->ctx->PerformTlsRecordProcessingCb) {
  2425. ret = ssl->ctx->PerformTlsRecordProcessingCb(ssl, 1,
  2426. output, input, dataSz,
  2427. ssl->encrypt.nonce, nonceSz,
  2428. output + dataSz, macSz,
  2429. aad, aadSz);
  2430. }
  2431. if (ret == NOT_COMPILED_IN)
  2432. #endif
  2433. {
  2434. #if ((defined(HAVE_FIPS) || defined(HAVE_SELFTEST)) && \
  2435. (!defined(HAVE_FIPS_VERSION) || (HAVE_FIPS_VERSION < 2)))
  2436. ret = wc_AesCcmEncrypt(ssl->encrypt.aes, output, input,
  2437. dataSz, ssl->encrypt.nonce, nonceSz,
  2438. output + dataSz, macSz, aad, aadSz);
  2439. #else
  2440. ret = wc_AesCcmSetNonce(ssl->encrypt.aes,
  2441. ssl->encrypt.nonce, nonceSz);
  2442. if (ret == 0) {
  2443. ret = wc_AesCcmEncrypt_ex(ssl->encrypt.aes, output,
  2444. input, dataSz, ssl->encrypt.nonce, nonceSz,
  2445. output + dataSz, macSz, aad, aadSz);
  2446. }
  2447. #endif
  2448. }
  2449. break;
  2450. #endif
  2451. #if defined(HAVE_CHACHA) && defined(HAVE_POLY1305)
  2452. case wolfssl_chacha:
  2453. ret = ChaCha20Poly1305_Encrypt(ssl, output, input, dataSz,
  2454. ssl->encrypt.nonce, aad, aadSz, output + dataSz);
  2455. break;
  2456. #endif
  2457. #ifdef WOLFSSL_SM4_GCM
  2458. case wolfssl_sm4_gcm:
  2459. nonceSz = SM4_GCM_NONCE_SZ;
  2460. ret = wc_Sm4GcmEncrypt(ssl->encrypt.sm4, output, input,
  2461. dataSz, ssl->encrypt.nonce, nonceSz, output + dataSz,
  2462. macSz, aad, aadSz);
  2463. break;
  2464. #endif
  2465. #ifdef WOLFSSL_SM4_CCM
  2466. case wolfssl_sm4_ccm:
  2467. nonceSz = SM4_CCM_NONCE_SZ;
  2468. ret = wc_Sm4CcmEncrypt(ssl->encrypt.sm4, output, input,
  2469. dataSz, ssl->encrypt.nonce, nonceSz, output + dataSz,
  2470. macSz, aad, aadSz);
  2471. break;
  2472. #endif
  2473. #ifdef HAVE_NULL_CIPHER
  2474. case wolfssl_cipher_null:
  2475. ret = Tls13IntegrityOnly_Encrypt(ssl, output, input, dataSz,
  2476. ssl->encrypt.nonce, aad, aadSz, output + dataSz);
  2477. break;
  2478. #endif
  2479. default:
  2480. WOLFSSL_MSG("wolfSSL Encrypt programming error");
  2481. return ENCRYPT_ERROR;
  2482. }
  2483. /* Advance state */
  2484. ssl->encrypt.state = CIPHER_STATE_END;
  2485. #ifdef WOLFSSL_ASYNC_CRYPT
  2486. if (ret == WC_PENDING_E) {
  2487. /* if async is not okay, then block */
  2488. if (!asyncOkay) {
  2489. ret = wc_AsyncWait(ret, asyncDev, event_flags);
  2490. }
  2491. else {
  2492. /* If pending, then leave and return will resume below */
  2493. return wolfSSL_AsyncPush(ssl, asyncDev);
  2494. }
  2495. }
  2496. #endif
  2497. }
  2498. FALL_THROUGH;
  2499. case CIPHER_STATE_END:
  2500. {
  2501. #ifdef WOLFSSL_DEBUG_TLS
  2502. #ifdef CIPHER_NONCE
  2503. WOLFSSL_MSG("Nonce");
  2504. WOLFSSL_BUFFER(ssl->encrypt.nonce, ssl->specs.iv_size);
  2505. #endif
  2506. WOLFSSL_MSG("Encrypted data");
  2507. WOLFSSL_BUFFER(output, dataSz);
  2508. WOLFSSL_MSG("Authentication Tag");
  2509. WOLFSSL_BUFFER(output + dataSz, macSz);
  2510. #endif
  2511. #ifdef WOLFSSL_CIPHER_TEXT_CHECK
  2512. if (ssl->specs.bulk_cipher_algorithm != wolfssl_cipher_null &&
  2513. XMEMCMP(output, ssl->encrypt.sanityCheck,
  2514. min(dataSz, sizeof(ssl->encrypt.sanityCheck))) == 0) {
  2515. WOLFSSL_MSG("EncryptTls13 sanity check failed! Glitch?");
  2516. return ENCRYPT_ERROR;
  2517. }
  2518. ForceZero(ssl->encrypt.sanityCheck,
  2519. sizeof(ssl->encrypt.sanityCheck));
  2520. #endif
  2521. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2522. if ((ssl->specs.bulk_cipher_algorithm != wolfssl_cipher_null) &&
  2523. (output != input) && (ret == 0)) {
  2524. wc_MemZero_Add("TLS 1.3 Encrypt plaintext", input, sz);
  2525. }
  2526. #endif
  2527. #ifdef CIPHER_NONCE
  2528. ForceZero(ssl->encrypt.nonce, AEAD_NONCE_SZ);
  2529. #endif
  2530. break;
  2531. }
  2532. default:
  2533. break;
  2534. }
  2535. /* Reset state */
  2536. ssl->encrypt.state = CIPHER_STATE_BEGIN;
  2537. return ret;
  2538. }
  2539. #if defined(HAVE_CHACHA) && defined(HAVE_POLY1305)
  2540. /* Decrypt with ChaCha20 and check authentication tag with Poly1305.
  2541. *
  2542. * ssl The SSL/TLS object.
  2543. * output The buffer to write decrypted data into.
  2544. * May be the same pointer as input.
  2545. * input The data to decrypt.
  2546. * sz The number of bytes to decrypt.
  2547. * nonce The nonce to use with ChaCha20.
  2548. * aad The additional authentication data.
  2549. * aadSz The size of the addition authentication data.
  2550. * tagIn The authentication tag data from packet.
  2551. * returns 0 on success, otherwise failure.
  2552. */
  2553. static int ChaCha20Poly1305_Decrypt(WOLFSSL* ssl, byte* output,
  2554. const byte* input, word16 sz, byte* nonce,
  2555. const byte* aad, word16 aadSz,
  2556. const byte* tagIn)
  2557. {
  2558. int ret;
  2559. byte tag[POLY1305_AUTH_SZ];
  2560. byte poly[CHACHA20_256_KEY_SIZE]; /* generated key for mac */
  2561. /* Poly1305 key is 256 bits of zero encrypted with ChaCha20. */
  2562. XMEMSET(poly, 0, sizeof(poly));
  2563. /* Set nonce and get Poly1305 key. */
  2564. ret = wc_Chacha_SetIV(ssl->decrypt.chacha, nonce, 0);
  2565. if (ret != 0)
  2566. return ret;
  2567. /* Use ChaCha20 keystream to get Poly1305 key for tag. */
  2568. ret = wc_Chacha_Process(ssl->decrypt.chacha, poly, poly, sizeof(poly));
  2569. if (ret != 0)
  2570. return ret;
  2571. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2572. wc_MemZero_Add("ChaCha20Poly1305_Decrypt poly", poly, sizeof(poly));
  2573. #endif
  2574. ret = wc_Chacha_SetIV(ssl->decrypt.chacha, nonce, 1);
  2575. if (ret != 0) {
  2576. ForceZero(poly, sizeof(poly)); /* done with poly1305 key, clear it */
  2577. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2578. wc_MemZero_Check(poly, sizeof(poly));
  2579. #endif
  2580. return ret;
  2581. }
  2582. /* Set key for Poly1305. */
  2583. ret = wc_Poly1305SetKey(ssl->auth.poly1305, poly, sizeof(poly));
  2584. ForceZero(poly, sizeof(poly)); /* done with poly1305 key, clear it */
  2585. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2586. wc_MemZero_Check(poly, sizeof(poly));
  2587. #endif
  2588. if (ret != 0)
  2589. return ret;
  2590. /* Generate authentication tag for encrypted data. */
  2591. if ((ret = wc_Poly1305_MAC(ssl->auth.poly1305, aad, aadSz, input, sz, tag,
  2592. sizeof(tag))) != 0) {
  2593. return ret;
  2594. }
  2595. /* Check tag sent along with packet. */
  2596. if (ConstantCompare(tagIn, tag, POLY1305_AUTH_SZ) != 0) {
  2597. WOLFSSL_MSG("MAC did not match");
  2598. return VERIFY_MAC_ERROR;
  2599. }
  2600. /* If the tag was good decrypt message. */
  2601. ret = wc_Chacha_Process(ssl->decrypt.chacha, output, input, sz);
  2602. return ret;
  2603. }
  2604. #endif
  2605. #ifdef HAVE_NULL_CIPHER
  2606. /* Check HMAC tag and copy over input.
  2607. *
  2608. * ssl The SSL/TLS object.
  2609. * output The buffer to copy data into.
  2610. * May be the same pointer as input.
  2611. * input The data.
  2612. * sz The number of bytes of data.
  2613. * nonce The nonce to use with authentication.
  2614. * aad The additional authentication data.
  2615. * aadSz The size of the addition authentication data.
  2616. * tagIn The authentication tag data from packet.
  2617. * returns 0 on success, otherwise failure.
  2618. */
  2619. static int Tls13IntegrityOnly_Decrypt(WOLFSSL* ssl, byte* output,
  2620. const byte* input, word16 sz,
  2621. const byte* nonce,
  2622. const byte* aad, word16 aadSz,
  2623. const byte* tagIn)
  2624. {
  2625. int ret;
  2626. byte hmac[WC_MAX_DIGEST_SIZE];
  2627. /* HMAC: nonce | aad | input */
  2628. ret = wc_HmacUpdate(ssl->decrypt.hmac, nonce, HMAC_NONCE_SZ);
  2629. if (ret == 0)
  2630. ret = wc_HmacUpdate(ssl->decrypt.hmac, aad, aadSz);
  2631. if (ret == 0)
  2632. ret = wc_HmacUpdate(ssl->decrypt.hmac, input, sz);
  2633. if (ret == 0)
  2634. ret = wc_HmacFinal(ssl->decrypt.hmac, hmac);
  2635. /* Check authentication tag matches */
  2636. if (ret == 0 && ConstantCompare(tagIn, hmac, ssl->specs.hash_size) != 0)
  2637. ret = DECRYPT_ERROR;
  2638. /* Copy the input to output if not the same buffer */
  2639. if (ret == 0 && output != input)
  2640. XMEMCPY(output, input, sz);
  2641. return ret;
  2642. }
  2643. #endif
  2644. /* Decrypt data for TLS v1.3.
  2645. *
  2646. * ssl The SSL/TLS object.
  2647. * output The buffer to write decrypted data into.
  2648. * May be the same pointer as input.
  2649. * input The data to decrypt and authentication tag.
  2650. * sz The length of the encrypted data plus authentication tag.
  2651. * aad The additional authentication data.
  2652. * aadSz The size of the addition authentication data.
  2653. * returns 0 on success, otherwise failure.
  2654. */
  2655. int DecryptTls13(WOLFSSL* ssl, byte* output, const byte* input, word16 sz,
  2656. const byte* aad, word16 aadSz)
  2657. {
  2658. int ret = 0;
  2659. word16 dataSz = sz - ssl->specs.aead_mac_size;
  2660. word16 macSz = ssl->specs.aead_mac_size;
  2661. word32 nonceSz = 0;
  2662. WOLFSSL_ENTER("DecryptTls13");
  2663. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  2664. ret = tsip_Tls13AesDecrypt(ssl, output, input, sz);
  2665. if (ret != CRYPTOCB_UNAVAILABLE) {
  2666. #ifndef WOLFSSL_EARLY_DATA
  2667. if (ret < 0) {
  2668. ret = VERIFY_MAC_ERROR;
  2669. WOLFSSL_ERROR_VERBOSE(ret);
  2670. }
  2671. #endif
  2672. return ret;
  2673. }
  2674. #endif
  2675. #ifdef WOLFSSL_ASYNC_CRYPT
  2676. ret = wolfSSL_AsyncPop(ssl, &ssl->decrypt.state);
  2677. if (ret != WC_NO_PENDING_E) {
  2678. /* check for still pending */
  2679. if (ret == WC_PENDING_E)
  2680. return ret;
  2681. ssl->error = 0; /* clear async */
  2682. /* let failures through so CIPHER_STATE_END logic is run */
  2683. }
  2684. else
  2685. #endif
  2686. {
  2687. /* Reset state */
  2688. ret = 0;
  2689. ssl->decrypt.state = CIPHER_STATE_BEGIN;
  2690. }
  2691. (void)output;
  2692. (void)input;
  2693. (void)sz;
  2694. (void)dataSz;
  2695. (void)macSz;
  2696. (void)nonceSz;
  2697. switch (ssl->decrypt.state) {
  2698. case CIPHER_STATE_BEGIN:
  2699. {
  2700. #ifdef WOLFSSL_DEBUG_TLS
  2701. WOLFSSL_MSG("Data to decrypt");
  2702. WOLFSSL_BUFFER(input, dataSz);
  2703. WOLFSSL_MSG("Additional Authentication Data");
  2704. WOLFSSL_BUFFER(aad, aadSz);
  2705. WOLFSSL_MSG("Authentication tag");
  2706. WOLFSSL_BUFFER(input + dataSz, macSz);
  2707. #endif
  2708. #ifdef CIPHER_NONCE
  2709. if (ssl->decrypt.nonce == NULL) {
  2710. ssl->decrypt.nonce = (byte*)XMALLOC(AEAD_NONCE_SZ,
  2711. ssl->heap, DYNAMIC_TYPE_CIPHER);
  2712. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2713. if (ssl->decrypt.nonce != NULL) {
  2714. wc_MemZero_Add("DecryptTls13 nonce", ssl->decrypt.nonce,
  2715. AEAD_NONCE_SZ);
  2716. }
  2717. #endif
  2718. }
  2719. if (ssl->decrypt.nonce == NULL)
  2720. return MEMORY_E;
  2721. BuildTls13Nonce(ssl, ssl->decrypt.nonce, ssl->keys.aead_dec_imp_IV,
  2722. PEER_ORDER);
  2723. #endif
  2724. /* Advance state and proceed */
  2725. ssl->decrypt.state = CIPHER_STATE_DO;
  2726. }
  2727. FALL_THROUGH;
  2728. case CIPHER_STATE_DO:
  2729. {
  2730. switch (ssl->specs.bulk_cipher_algorithm) {
  2731. #ifdef BUILD_AESGCM
  2732. case wolfssl_aes_gcm:
  2733. #ifdef WOLFSSL_ASYNC_CRYPT
  2734. /* initialize event */
  2735. ret = wolfSSL_AsyncInit(ssl, &ssl->decrypt.aes->asyncDev,
  2736. WC_ASYNC_FLAG_NONE);
  2737. if (ret != 0)
  2738. break;
  2739. #endif
  2740. nonceSz = AESGCM_NONCE_SZ;
  2741. #if defined(HAVE_PK_CALLBACKS)
  2742. ret = NOT_COMPILED_IN;
  2743. if (ssl->ctx && ssl->ctx->PerformTlsRecordProcessingCb) {
  2744. ret = ssl->ctx->PerformTlsRecordProcessingCb(ssl, 0,
  2745. output, input, dataSz,
  2746. ssl->decrypt.nonce, nonceSz,
  2747. (byte *)(input + dataSz), macSz,
  2748. aad, aadSz);
  2749. }
  2750. if (ret == NOT_COMPILED_IN)
  2751. #endif
  2752. {
  2753. ret = wc_AesGcmDecrypt(ssl->decrypt.aes, output, input,
  2754. dataSz, ssl->decrypt.nonce, nonceSz,
  2755. input + dataSz, macSz, aad, aadSz);
  2756. #ifdef WOLFSSL_ASYNC_CRYPT
  2757. if (ret == WC_PENDING_E) {
  2758. ret = wolfSSL_AsyncPush(ssl,
  2759. &ssl->decrypt.aes->asyncDev);
  2760. }
  2761. #endif
  2762. }
  2763. break;
  2764. #endif
  2765. #ifdef HAVE_AESCCM
  2766. case wolfssl_aes_ccm:
  2767. #ifdef WOLFSSL_ASYNC_CRYPT
  2768. /* initialize event */
  2769. ret = wolfSSL_AsyncInit(ssl, &ssl->decrypt.aes->asyncDev,
  2770. WC_ASYNC_FLAG_NONE);
  2771. if (ret != 0)
  2772. break;
  2773. #endif
  2774. nonceSz = AESCCM_NONCE_SZ;
  2775. #if defined(HAVE_PK_CALLBACKS)
  2776. ret = NOT_COMPILED_IN;
  2777. if (ssl->ctx && ssl->ctx->PerformTlsRecordProcessingCb) {
  2778. ret = ssl->ctx->PerformTlsRecordProcessingCb(ssl, 0,
  2779. output, input, dataSz,
  2780. ssl->decrypt.nonce, nonceSz,
  2781. (byte *)(input + dataSz), macSz,
  2782. aad, aadSz);
  2783. }
  2784. if (ret == NOT_COMPILED_IN)
  2785. #endif
  2786. {
  2787. ret = wc_AesCcmDecrypt(ssl->decrypt.aes, output, input,
  2788. dataSz, ssl->decrypt.nonce, nonceSz,
  2789. input + dataSz, macSz, aad, aadSz);
  2790. #ifdef WOLFSSL_ASYNC_CRYPT
  2791. if (ret == WC_PENDING_E) {
  2792. ret = wolfSSL_AsyncPush(ssl,
  2793. &ssl->decrypt.aes->asyncDev);
  2794. }
  2795. #endif
  2796. }
  2797. break;
  2798. #endif
  2799. #if defined(HAVE_CHACHA) && defined(HAVE_POLY1305)
  2800. case wolfssl_chacha:
  2801. ret = ChaCha20Poly1305_Decrypt(ssl, output, input, dataSz,
  2802. ssl->decrypt.nonce, aad, aadSz, input + dataSz);
  2803. break;
  2804. #endif
  2805. #ifdef WOLFSSL_SM4_GCM
  2806. case wolfssl_sm4_gcm:
  2807. nonceSz = SM4_GCM_NONCE_SZ;
  2808. ret = wc_Sm4GcmDecrypt(ssl->decrypt.sm4, output, input,
  2809. dataSz, ssl->decrypt.nonce, nonceSz, output + dataSz,
  2810. macSz, aad, aadSz);
  2811. break;
  2812. #endif
  2813. #ifdef WOLFSSL_SM4_CCM
  2814. case wolfssl_sm4_ccm:
  2815. nonceSz = SM4_CCM_NONCE_SZ;
  2816. ret = wc_Sm4CcmDecrypt(ssl->decrypt.sm4, output, input,
  2817. dataSz, ssl->decrypt.nonce, nonceSz, output + dataSz,
  2818. macSz, aad, aadSz);
  2819. break;
  2820. #endif
  2821. #ifdef HAVE_NULL_CIPHER
  2822. case wolfssl_cipher_null:
  2823. ret = Tls13IntegrityOnly_Decrypt(ssl, output, input, dataSz,
  2824. ssl->decrypt.nonce, aad, aadSz, input + dataSz);
  2825. break;
  2826. #endif
  2827. default:
  2828. WOLFSSL_MSG("wolfSSL Decrypt programming error");
  2829. return DECRYPT_ERROR;
  2830. }
  2831. /* Advance state */
  2832. ssl->decrypt.state = CIPHER_STATE_END;
  2833. #ifdef WOLFSSL_ASYNC_CRYPT
  2834. /* If pending, leave now */
  2835. if (ret == WC_PENDING_E) {
  2836. return ret;
  2837. }
  2838. #endif
  2839. }
  2840. FALL_THROUGH;
  2841. case CIPHER_STATE_END:
  2842. {
  2843. #ifdef WOLFSSL_DEBUG_TLS
  2844. #ifdef CIPHER_NONCE
  2845. WOLFSSL_MSG("Nonce");
  2846. WOLFSSL_BUFFER(ssl->decrypt.nonce, ssl->specs.iv_size);
  2847. #endif
  2848. WOLFSSL_MSG("Decrypted data");
  2849. WOLFSSL_BUFFER(output, dataSz);
  2850. #endif
  2851. #ifdef WOLFSSL_CHECK_MEM_ZERO
  2852. if ((ssl->specs.bulk_cipher_algorithm != wolfssl_cipher_null) &&
  2853. (ret == 0)) {
  2854. wc_MemZero_Add("TLS 1.3 Decrypted data", output, sz);
  2855. }
  2856. #endif
  2857. #ifdef CIPHER_NONCE
  2858. ForceZero(ssl->decrypt.nonce, AEAD_NONCE_SZ);
  2859. #endif
  2860. break;
  2861. }
  2862. default:
  2863. break;
  2864. }
  2865. if (ret < 0) {
  2866. WOLFSSL_ERROR_VERBOSE(ret);
  2867. }
  2868. return ret;
  2869. }
  2870. /* Persistable BuildTls13Message arguments */
  2871. typedef struct BuildMsg13Args {
  2872. word32 sz;
  2873. word32 idx;
  2874. word32 headerSz;
  2875. word16 size;
  2876. } BuildMsg13Args;
  2877. static void FreeBuildMsg13Args(WOLFSSL* ssl, void* pArgs)
  2878. {
  2879. BuildMsg13Args* args = (BuildMsg13Args*)pArgs;
  2880. (void)ssl;
  2881. (void)args;
  2882. /* no allocations in BuildTls13Message */
  2883. }
  2884. /* Build SSL Message, encrypted.
  2885. * TLS v1.3 encryption is AEAD only.
  2886. *
  2887. * ssl The SSL/TLS object.
  2888. * output The buffer to write record message to.
  2889. * outSz Size of the buffer being written into.
  2890. * input The record data to encrypt (excluding record header).
  2891. * inSz The size of the record data.
  2892. * type The recorder header content type.
  2893. * hashOutput Whether to hash the unencrypted record data.
  2894. * sizeOnly Only want the size of the record message.
  2895. * asyncOkay If non-zero can return WC_PENDING_E, otherwise blocks on crypto
  2896. * returns the size of the encrypted record message or negative value on error.
  2897. */
  2898. int BuildTls13Message(WOLFSSL* ssl, byte* output, int outSz, const byte* input,
  2899. int inSz, int type, int hashOutput, int sizeOnly, int asyncOkay)
  2900. {
  2901. int ret;
  2902. BuildMsg13Args* args;
  2903. BuildMsg13Args lcl_args;
  2904. WOLFSSL_ENTER("BuildTls13Message");
  2905. #ifdef WOLFSSL_ASYNC_CRYPT
  2906. ret = WC_NO_PENDING_E;
  2907. if (asyncOkay) {
  2908. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  2909. if (ssl->async == NULL) {
  2910. ssl->async = (struct WOLFSSL_ASYNC*)
  2911. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  2912. DYNAMIC_TYPE_ASYNC);
  2913. if (ssl->async == NULL)
  2914. return MEMORY_E;
  2915. }
  2916. args = (BuildMsg13Args*)ssl->async->args;
  2917. ret = wolfSSL_AsyncPop(ssl, &ssl->options.buildMsgState);
  2918. if (ret != WC_NO_PENDING_E) {
  2919. /* Check for error */
  2920. if (ret < 0)
  2921. goto exit_buildmsg;
  2922. }
  2923. }
  2924. else
  2925. #endif
  2926. {
  2927. args = &lcl_args;
  2928. }
  2929. /* Reset state */
  2930. #ifdef WOLFSSL_ASYNC_CRYPT
  2931. if (ret == WC_NO_PENDING_E)
  2932. #endif
  2933. {
  2934. ret = 0;
  2935. ssl->options.buildMsgState = BUILD_MSG_BEGIN;
  2936. XMEMSET(args, 0, sizeof(BuildMsg13Args));
  2937. args->headerSz = RECORD_HEADER_SZ;
  2938. #ifdef WOLFSSL_DTLS13
  2939. if (ssl->options.dtls)
  2940. args->headerSz = Dtls13GetRlHeaderLength(ssl, 1);
  2941. #endif /* WOLFSSL_DTLS13 */
  2942. args->sz = args->headerSz + inSz;
  2943. args->idx = args->headerSz;
  2944. #ifdef WOLFSSL_ASYNC_CRYPT
  2945. if (asyncOkay)
  2946. ssl->async->freeArgs = FreeBuildMsg13Args;
  2947. #endif
  2948. }
  2949. switch (ssl->options.buildMsgState) {
  2950. case BUILD_MSG_BEGIN:
  2951. {
  2952. /* catch mistaken sizeOnly parameter */
  2953. if (sizeOnly) {
  2954. if (output || input) {
  2955. WOLFSSL_MSG("BuildTls13Message with sizeOnly "
  2956. "doesn't need input or output");
  2957. return BAD_FUNC_ARG;
  2958. }
  2959. }
  2960. else if (output == NULL || input == NULL) {
  2961. return BAD_FUNC_ARG;
  2962. }
  2963. /* Record layer content type at the end of record data. */
  2964. args->sz++;
  2965. /* Authentication data at the end. */
  2966. args->sz += ssl->specs.aead_mac_size;
  2967. if (sizeOnly)
  2968. return args->sz;
  2969. if (args->sz > (word32)outSz) {
  2970. WOLFSSL_MSG("Oops, want to write past output buffer size");
  2971. return BUFFER_E;
  2972. }
  2973. /* Record data length. */
  2974. args->size = (word16)(args->sz - args->headerSz);
  2975. /* Write/update the record header with the new size.
  2976. * Always have the content type as application data for encrypted
  2977. * messages in TLS v1.3.
  2978. */
  2979. if (ssl->options.dtls) {
  2980. #ifdef WOLFSSL_DTLS13
  2981. Dtls13RlAddCiphertextHeader(ssl, output, args->size);
  2982. #endif /* WOLFSSL_DTLS13 */
  2983. }
  2984. else {
  2985. AddTls13RecordHeader(output, args->size, application_data, ssl);
  2986. }
  2987. /* TLS v1.3 can do in place encryption. */
  2988. if (input != output + args->idx)
  2989. XMEMCPY(output + args->idx, input, inSz);
  2990. args->idx += inSz;
  2991. ssl->options.buildMsgState = BUILD_MSG_HASH;
  2992. }
  2993. FALL_THROUGH;
  2994. case BUILD_MSG_HASH:
  2995. {
  2996. if (hashOutput) {
  2997. ret = HashOutput(ssl, output, args->headerSz + inSz, 0);
  2998. if (ret != 0)
  2999. goto exit_buildmsg;
  3000. }
  3001. /* The real record content type goes at the end of the data. */
  3002. output[args->idx++] = (byte)type;
  3003. ssl->options.buildMsgState = BUILD_MSG_ENCRYPT;
  3004. }
  3005. FALL_THROUGH;
  3006. case BUILD_MSG_ENCRYPT:
  3007. {
  3008. #ifdef WOLFSSL_QUIC
  3009. if (WOLFSSL_IS_QUIC(ssl)) {
  3010. /* QUIC does not use encryption of the TLS Record Layer.
  3011. * Return the original length + added headers
  3012. * and restore it in the record header. */
  3013. AddTls13RecordHeader(output, inSz, type, ssl);
  3014. ret = args->headerSz + inSz;
  3015. goto exit_buildmsg;
  3016. }
  3017. #endif
  3018. #ifdef ATOMIC_USER
  3019. if (ssl->ctx->MacEncryptCb) {
  3020. /* User Record Layer Callback handling */
  3021. byte* mac = output + args->idx;
  3022. output += args->headerSz;
  3023. ret = ssl->ctx->MacEncryptCb(ssl, mac, output, inSz, type, 0,
  3024. output, output, args->size, ssl->MacEncryptCtx);
  3025. }
  3026. else
  3027. #endif
  3028. {
  3029. const byte* aad = output;
  3030. output += args->headerSz;
  3031. ret = EncryptTls13(ssl, output, output, args->size, aad,
  3032. (word16)args->headerSz, asyncOkay);
  3033. if (ret != 0) {
  3034. #ifdef WOLFSSL_ASYNC_CRYPT
  3035. if (ret != WC_PENDING_E)
  3036. #endif
  3037. {
  3038. /* Zeroize plaintext. */
  3039. ForceZero(output, args->size);
  3040. }
  3041. }
  3042. #ifdef WOLFSSL_DTLS13
  3043. if (ret == 0 && ssl->options.dtls) {
  3044. /* AAD points to the header. Reuse the variable */
  3045. ret = Dtls13EncryptRecordNumber(ssl, (byte*)aad, (word16)args->sz);
  3046. }
  3047. #endif /* WOLFSSL_DTLS13 */
  3048. }
  3049. break;
  3050. }
  3051. default:
  3052. break;
  3053. }
  3054. exit_buildmsg:
  3055. WOLFSSL_LEAVE("BuildTls13Message", ret);
  3056. #ifdef WOLFSSL_ASYNC_CRYPT
  3057. if (ret == WC_PENDING_E) {
  3058. return ret;
  3059. }
  3060. #endif
  3061. /* make sure build message state is reset */
  3062. ssl->options.buildMsgState = BUILD_MSG_BEGIN;
  3063. /* return sz on success */
  3064. if (ret == 0) {
  3065. ret = args->sz;
  3066. }
  3067. else {
  3068. WOLFSSL_ERROR_VERBOSE(ret);
  3069. }
  3070. /* Final cleanup */
  3071. #ifdef WOLFSSL_ASYNC_CRYPT
  3072. if (asyncOkay)
  3073. FreeAsyncCtx(ssl, 0);
  3074. else
  3075. #endif
  3076. FreeBuildMsg13Args(ssl, args);
  3077. return ret;
  3078. }
  3079. #if !defined(NO_WOLFSSL_CLIENT) || (!defined(NO_WOLFSSL_SERVER) && \
  3080. (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)) && \
  3081. (defined(WOLFSSL_PSK_ONE_ID) || defined(WOLFSSL_PRIORITIZE_PSK)))
  3082. /* Find the cipher suite in the suites set in the SSL.
  3083. *
  3084. * ssl SSL/TLS object.
  3085. * suite Cipher suite to look for.
  3086. * returns 1 when suite is found in SSL/TLS object's list and 0 otherwise.
  3087. */
  3088. int FindSuiteSSL(const WOLFSSL* ssl, byte* suite)
  3089. {
  3090. word16 i;
  3091. const Suites* suites = WOLFSSL_SUITES(ssl);
  3092. for (i = 0; i < suites->suiteSz; i += 2) {
  3093. if (suites->suites[i+0] == suite[0] &&
  3094. suites->suites[i+1] == suite[1]) {
  3095. return 1;
  3096. }
  3097. }
  3098. return 0;
  3099. }
  3100. #endif
  3101. #ifndef NO_PSK
  3102. /* Get the MAC algorithm for the TLS 1.3 cipher suite.
  3103. *
  3104. * @param [in] suite.
  3105. * @return A value from wc_MACAlgorithm enumeration.
  3106. */
  3107. byte SuiteMac(const byte* suite)
  3108. {
  3109. byte mac = no_mac;
  3110. if (suite[0] == TLS13_BYTE) {
  3111. switch (suite[1]) {
  3112. #ifdef BUILD_TLS_AES_128_GCM_SHA256
  3113. case TLS_AES_128_GCM_SHA256:
  3114. mac = sha256_mac;
  3115. break;
  3116. #endif
  3117. #ifdef BUILD_TLS_CHACHA20_POLY1305_SHA256
  3118. case TLS_CHACHA20_POLY1305_SHA256:
  3119. mac = sha256_mac;
  3120. break;
  3121. #endif
  3122. #ifdef BUILD_TLS_AES_128_CCM_SHA256
  3123. case TLS_AES_128_CCM_SHA256:
  3124. mac = sha256_mac;
  3125. break;
  3126. #endif
  3127. #ifdef BUILD_TLS_AES_128_CCM_8_SHA256
  3128. case TLS_AES_128_CCM_8_SHA256:
  3129. mac = sha256_mac;
  3130. break;
  3131. #endif
  3132. #ifdef BUILD_TLS_AES_256_GCM_SHA384
  3133. case TLS_AES_256_GCM_SHA384:
  3134. mac = sha384_mac;
  3135. break;
  3136. #endif
  3137. default:
  3138. break;
  3139. }
  3140. }
  3141. #if (defined(WOLFSSL_SM4_GCM) || defined(WOLFSSL_SM4_CCM)) && \
  3142. defined(WOLFSSL_SM3)
  3143. else if (suite[0] == CIPHER_BYTE) {
  3144. switch (suite[1]) {
  3145. #ifdef BUILD_TLS_SM4_GCM_SM3
  3146. case TLS_SM4_GCM_SM3:
  3147. mac = sm3_mac;
  3148. break;
  3149. #endif
  3150. #ifdef BUILD_TLS_SM4_CCM_SM3
  3151. case TLS_SM4_CCM_SM3:
  3152. mac = sm3_mac;
  3153. break;
  3154. #endif
  3155. default:
  3156. break;
  3157. }
  3158. }
  3159. #endif
  3160. #ifdef HAVE_NULL_CIPHER
  3161. else if (suite[0] == ECC_BYTE) {
  3162. switch (suite[1]) {
  3163. #ifdef BUILD_TLS_SHA256_SHA256
  3164. case TLS_SHA256_SHA256:
  3165. mac = sha256_mac;
  3166. break;
  3167. #endif
  3168. #ifdef BUILD_TLS_SHA384_SHA384
  3169. case TLS_SHA384_SHA384:
  3170. mac = sha384_mac;
  3171. break;
  3172. #endif
  3173. default:
  3174. break;
  3175. }
  3176. }
  3177. #endif
  3178. return mac;
  3179. }
  3180. #endif
  3181. #if defined(WOLFSSL_SEND_HRR_COOKIE) && !defined(NO_WOLFSSL_SERVER)
  3182. /* Create Cookie extension using the hash of the first ClientHello.
  3183. *
  3184. * ssl SSL/TLS object.
  3185. * hash The hash data.
  3186. * hashSz The size of the hash data in bytes.
  3187. * returns 0 on success, otherwise failure.
  3188. */
  3189. int CreateCookieExt(const WOLFSSL* ssl, byte* hash, word16 hashSz,
  3190. TLSX** exts, byte cipherSuite0, byte cipherSuite)
  3191. {
  3192. int ret;
  3193. byte mac[WC_MAX_DIGEST_SIZE] = {0};
  3194. Hmac cookieHmac;
  3195. byte cookieType = 0;
  3196. byte macSz = 0;
  3197. byte cookie[OPAQUE8_LEN + WC_MAX_DIGEST_SIZE + OPAQUE16_LEN * 2];
  3198. TLSX* ext;
  3199. word16 cookieSz = 0;
  3200. if (hash == NULL || hashSz == 0) {
  3201. return BAD_FUNC_ARG;
  3202. }
  3203. if (ssl->buffers.tls13CookieSecret.buffer == NULL ||
  3204. ssl->buffers.tls13CookieSecret.length == 0) {
  3205. WOLFSSL_MSG("Missing DTLS 1.3 cookie secret");
  3206. return COOKIE_ERROR;
  3207. }
  3208. /* Cookie Data = Hash Len | Hash | CS | KeyShare Group */
  3209. cookie[cookieSz++] = (byte)hashSz;
  3210. XMEMCPY(cookie + cookieSz, hash, hashSz);
  3211. cookieSz += hashSz;
  3212. cookie[cookieSz++] = cipherSuite0;
  3213. cookie[cookieSz++] = cipherSuite;
  3214. if ((ext = TLSX_Find(*exts, TLSX_KEY_SHARE)) != NULL) {
  3215. KeyShareEntry* kse = (KeyShareEntry*)ext->data;
  3216. if (kse == NULL) {
  3217. WOLFSSL_MSG("KeyShareEntry can't be empty when negotiating "
  3218. "parameters");
  3219. return BAD_STATE_E;
  3220. }
  3221. c16toa(kse->group, cookie + cookieSz);
  3222. cookieSz += OPAQUE16_LEN;
  3223. }
  3224. #if !defined(NO_SHA) && defined(NO_SHA256)
  3225. cookieType = SHA;
  3226. macSz = WC_SHA_DIGEST_SIZE;
  3227. #endif /* NO_SHA */
  3228. #ifndef NO_SHA256
  3229. cookieType = WC_SHA256;
  3230. macSz = WC_SHA256_DIGEST_SIZE;
  3231. #endif /* NO_SHA256 */
  3232. ret = wc_HmacInit(&cookieHmac, ssl->heap, INVALID_DEVID);
  3233. if (ret == 0) {
  3234. ret = wc_HmacSetKey(&cookieHmac, cookieType,
  3235. ssl->buffers.tls13CookieSecret.buffer,
  3236. ssl->buffers.tls13CookieSecret.length);
  3237. }
  3238. if (ret == 0)
  3239. ret = wc_HmacUpdate(&cookieHmac, cookie, cookieSz);
  3240. #ifdef WOLFSSL_DTLS13
  3241. /* Tie cookie to peer address */
  3242. if (ret == 0) {
  3243. if (ssl->options.dtls && ssl->buffers.dtlsCtx.peer.sz > 0) {
  3244. ret = wc_HmacUpdate(&cookieHmac,
  3245. (byte*)ssl->buffers.dtlsCtx.peer.sa,
  3246. ssl->buffers.dtlsCtx.peer.sz);
  3247. }
  3248. }
  3249. #endif
  3250. if (ret == 0)
  3251. ret = wc_HmacFinal(&cookieHmac, mac);
  3252. wc_HmacFree(&cookieHmac);
  3253. if (ret != 0)
  3254. return ret;
  3255. /* The cookie data is the hash and the integrity check. */
  3256. return TLSX_Cookie_Use(ssl, cookie, cookieSz, mac, macSz, 1, exts);
  3257. }
  3258. #endif
  3259. #ifdef WOLFSSL_DTLS13
  3260. #define HRR_MAX_HS_HEADER_SZ DTLS_HANDSHAKE_HEADER_SZ
  3261. #else
  3262. #define HRR_MAX_HS_HEADER_SZ HANDSHAKE_HEADER_SZ
  3263. #endif /* WOLFSSL_DTLS13 */
  3264. static int CreateCookie(const WOLFSSL* ssl, byte** hash, byte* hashSz,
  3265. Hashes* hashes, TLSX** exts)
  3266. {
  3267. int ret = 0;
  3268. (void)exts;
  3269. *hash = NULL;
  3270. switch (ssl->specs.mac_algorithm) {
  3271. #ifndef NO_SHA256
  3272. case sha256_mac:
  3273. *hash = hashes->sha256;
  3274. break;
  3275. #endif
  3276. #ifdef WOLFSSL_SHA384
  3277. case sha384_mac:
  3278. *hash = hashes->sha384;
  3279. break;
  3280. #endif
  3281. #ifdef WOLFSSL_TLS13_SHA512
  3282. case sha512_mac:
  3283. *hash = hashes->sha512;
  3284. break;
  3285. #endif
  3286. #ifdef WOLFSSL_SM3
  3287. case sm3_mac:
  3288. *hash = hashes->sm3;
  3289. break;
  3290. #endif
  3291. }
  3292. *hashSz = ssl->specs.hash_size;
  3293. /* check hash */
  3294. if (*hash == NULL && *hashSz > 0)
  3295. return BAD_FUNC_ARG;
  3296. #if defined(WOLFSSL_SEND_HRR_COOKIE) && !defined(NO_WOLFSSL_SERVER)
  3297. if (ssl->options.sendCookie && ssl->options.side == WOLFSSL_SERVER_END)
  3298. ret = CreateCookieExt(ssl, *hash, *hashSz, exts,
  3299. ssl->options.cipherSuite0, ssl->options.cipherSuite);
  3300. #endif
  3301. return ret;
  3302. }
  3303. /* Restart the handshake hash with a hash of the previous messages.
  3304. *
  3305. * ssl The SSL/TLS object.
  3306. * returns 0 on success, otherwise failure.
  3307. */
  3308. int RestartHandshakeHash(WOLFSSL* ssl)
  3309. {
  3310. int ret;
  3311. byte header[HANDSHAKE_HEADER_SZ] = {0};
  3312. Hashes hashes;
  3313. byte* hash = NULL;
  3314. byte hashSz = 0;
  3315. ret = BuildCertHashes(ssl, &hashes);
  3316. if (ret != 0)
  3317. return ret;
  3318. ret = CreateCookie(ssl, &hash, &hashSz, &hashes, &ssl->extensions);
  3319. if (ret != 0)
  3320. return ret;
  3321. #if defined(WOLFSSL_SEND_HRR_COOKIE) && !defined(NO_WOLFSSL_SERVER)
  3322. if (ssl->options.sendCookie && ssl->options.side == WOLFSSL_SERVER_END)
  3323. return 0;
  3324. #endif
  3325. AddTls13HandShakeHeader(header, hashSz, 0, 0, message_hash, ssl);
  3326. #ifdef WOLFSSL_DEBUG_TLS
  3327. WOLFSSL_MSG("Restart Hash");
  3328. WOLFSSL_BUFFER(hash, hashSz);
  3329. #endif
  3330. ret = InitHandshakeHashes(ssl);
  3331. if (ret != 0)
  3332. return ret;
  3333. ret = HashRaw(ssl, header, sizeof(header));
  3334. if (ret != 0)
  3335. return ret;
  3336. return HashRaw(ssl, hash, hashSz);
  3337. }
  3338. #if !defined(NO_WOLFSSL_CLIENT) || !defined(NO_WOLFSSL_SERVER)
  3339. /* The value in the random field of a ServerHello to indicate
  3340. * HelloRetryRequest.
  3341. */
  3342. static byte helloRetryRequestRandom[] = {
  3343. 0xCF, 0x21, 0xAD, 0x74, 0xE5, 0x9A, 0x61, 0x11,
  3344. 0xBE, 0x1D, 0x8C, 0x02, 0x1E, 0x65, 0xB8, 0x91,
  3345. 0xC2, 0xA2, 0x11, 0x16, 0x7A, 0xBB, 0x8C, 0x5E,
  3346. 0x07, 0x9E, 0x09, 0xE2, 0xC8, 0xA8, 0x33, 0x9C
  3347. };
  3348. #endif
  3349. #ifndef NO_WOLFSSL_CLIENT
  3350. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  3351. #if defined(OPENSSL_EXTRA) && !defined(WOLFSSL_PSK_ONE_ID) && \
  3352. !defined(NO_PSK)
  3353. /**
  3354. * convert mac algorithm to WOLFSSL_EVP_MD
  3355. * @param mac_alg mac algorithm
  3356. * @return const WOLFSSL_EVP_MD on successful, otherwise NULL
  3357. */
  3358. static const WOLFSSL_EVP_MD* ssl_handshake_md(const byte mac_alg)
  3359. {
  3360. switch(mac_alg) {
  3361. case no_mac:
  3362. #ifndef NO_MD5
  3363. case md5_mac:
  3364. return wolfSSL_EVP_md5();
  3365. #endif
  3366. #ifndef NO_SHA
  3367. case sha_mac:
  3368. return wolfSSL_EVP_sha1();
  3369. #endif
  3370. #ifdef WOLFSSL_SHA224
  3371. case sha224_mac:
  3372. return wolfSSL_EVP_sha224();
  3373. #endif
  3374. case sha256_mac:
  3375. return wolfSSL_EVP_sha256();
  3376. #ifdef WOLFSSL_SHA384
  3377. case sha384_mac:
  3378. return wolfSSL_EVP_sha384();
  3379. #endif
  3380. #ifdef WOLFSSL_SHA512
  3381. case sha512_mac:
  3382. return wolfSSL_EVP_sha512();
  3383. #endif
  3384. case rmd_mac:
  3385. case blake2b_mac:
  3386. WOLFSSL_MSG("no suitable EVP_MD");
  3387. return NULL;
  3388. default:
  3389. WOLFSSL_MSG("Unknown mac algorithm");
  3390. return NULL;
  3391. }
  3392. }
  3393. #endif
  3394. /* Setup pre-shared key based on the details in the extension data.
  3395. *
  3396. * ssl SSL/TLS object.
  3397. * psk Pre-shared key extension data.
  3398. * clientHello Whether called from client_hello construction.
  3399. * returns 0 on success, PSK_KEY_ERROR when the client PSK callback fails and
  3400. * other negative value on failure.
  3401. */
  3402. static int SetupPskKey(WOLFSSL* ssl, PreSharedKey* psk, int clientHello)
  3403. {
  3404. #if defined(HAVE_SESSION_TICKET) || !defined(WOLFSSL_PSK_ONE_ID)
  3405. int ret;
  3406. #endif
  3407. byte suite[2];
  3408. if (psk == NULL)
  3409. return BAD_FUNC_ARG;
  3410. if (!HaveUniqueSessionObj(ssl)) {
  3411. WOLFSSL_MSG("Unable to have unique session object");
  3412. WOLFSSL_ERROR_VERBOSE(MEMORY_ERROR);
  3413. return MEMORY_ERROR;
  3414. }
  3415. suite[0] = ssl->options.cipherSuite0;
  3416. suite[1] = ssl->options.cipherSuite;
  3417. #ifdef HAVE_SESSION_TICKET
  3418. if (psk->resumption) {
  3419. if (clientHello) {
  3420. suite[0] = psk->cipherSuite0;
  3421. suite[1] = psk->cipherSuite;
  3422. /* Ensure cipher suite is supported or changed suite to one with
  3423. * the same MAC algorithm. */
  3424. if (!FindSuiteSSL(ssl, suite)) {
  3425. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3426. return PSK_KEY_ERROR;
  3427. }
  3428. ssl->options.cipherSuite0 = suite[0];
  3429. ssl->options.cipherSuite = suite[1];
  3430. /* Setting mac for binder and keys for deriving EarlyData. */
  3431. ret = SetCipherSpecs(ssl);
  3432. if (ret != 0)
  3433. return ret;
  3434. }
  3435. #ifdef WOLFSSL_EARLY_DATA
  3436. if (ssl->session->maxEarlyDataSz == 0)
  3437. ssl->earlyData = no_early_data;
  3438. #endif
  3439. /* Resumption PSK is master secret. */
  3440. ssl->arrays->psk_keySz = ssl->specs.hash_size;
  3441. if ((ret = DeriveResumptionPSK(ssl, ssl->session->ticketNonce.data,
  3442. ssl->session->ticketNonce.len, ssl->arrays->psk_key)) != 0) {
  3443. return ret;
  3444. }
  3445. if (!clientHello) {
  3446. /* CLIENT: using secret in ticket for peer authentication. */
  3447. ssl->options.peerAuthGood = 1;
  3448. }
  3449. }
  3450. #endif
  3451. #ifndef NO_PSK
  3452. if (!psk->resumption) {
  3453. /* Get the pre-shared key. */
  3454. #ifndef WOLFSSL_PSK_ONE_ID
  3455. const char* cipherName = NULL;
  3456. #ifdef OPENSSL_EXTRA
  3457. WOLFSSL_SESSION* psksession = NULL;
  3458. #endif
  3459. /* Set the client identity to use. */
  3460. XMEMSET(ssl->arrays->client_identity, 0,
  3461. sizeof(ssl->arrays->client_identity));
  3462. XMEMCPY(ssl->arrays->client_identity, psk->identity, psk->identityLen);
  3463. #ifdef WOLFSSL_DEBUG_TLS
  3464. WOLFSSL_MSG("PSK cipher suite:");
  3465. WOLFSSL_MSG(GetCipherNameInternal(psk->cipherSuite0, psk->cipherSuite));
  3466. #endif
  3467. /* Get the pre-shared key. */
  3468. #ifdef OPENSSL_EXTRA
  3469. if (ssl->options.session_psk_cb != NULL) {
  3470. const unsigned char* id = NULL;
  3471. size_t idlen = 0;
  3472. const WOLFSSL_EVP_MD* handshake_md = NULL;
  3473. if (ssl->msgsReceived.got_hello_retry_request >= 1) {
  3474. handshake_md = ssl_handshake_md(ssl->specs.mac_algorithm);
  3475. }
  3476. /* OpenSSL compatible callback that gets cached session. */
  3477. if (ssl->options.session_psk_cb(ssl, handshake_md, &id, &idlen,
  3478. &psksession) == 0) {
  3479. wolfSSL_FreeSession(ssl->ctx, psksession);
  3480. WOLFSSL_MSG("psk session callback failed");
  3481. return PSK_KEY_ERROR;
  3482. }
  3483. if (psksession != NULL) {
  3484. if (idlen > MAX_PSK_KEY_LEN) {
  3485. wolfSSL_FreeSession(ssl->ctx, psksession);
  3486. WOLFSSL_MSG("psk key length is too long");
  3487. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3488. return PSK_KEY_ERROR;
  3489. }
  3490. ssl->arrays->psk_keySz = (word32)idlen;
  3491. XMEMCPY(ssl->arrays->psk_key, id, idlen);
  3492. suite[0] = psksession->cipherSuite0;
  3493. suite[1] = psksession->cipherSuite;
  3494. /* Not needed anymore. */
  3495. wolfSSL_FreeSession(ssl->ctx, psksession);
  3496. /* Leave pointer not NULL to indicate success with callback. */
  3497. }
  3498. }
  3499. if (psksession != NULL) {
  3500. /* Don't try other callbacks - we have an answer. */
  3501. }
  3502. else
  3503. #endif /* OPENSSL_EXTRA */
  3504. if (ssl->options.client_psk_cs_cb != NULL) {
  3505. #ifdef WOLFSSL_PSK_MULTI_ID_PER_CS
  3506. ssl->arrays->client_identity[0] = 0;
  3507. #endif
  3508. /* Lookup key again for next identity. */
  3509. ssl->arrays->psk_keySz = ssl->options.client_psk_cs_cb(
  3510. ssl, ssl->arrays->server_hint,
  3511. ssl->arrays->client_identity, MAX_PSK_ID_LEN,
  3512. ssl->arrays->psk_key, MAX_PSK_KEY_LEN,
  3513. GetCipherNameInternal(psk->cipherSuite0, psk->cipherSuite));
  3514. if (clientHello) {
  3515. /* Use PSK cipher suite. */
  3516. ssl->options.cipherSuite0 = psk->cipherSuite0;
  3517. ssl->options.cipherSuite = psk->cipherSuite;
  3518. }
  3519. else {
  3520. byte pskCS[2];
  3521. pskCS[0] = psk->cipherSuite0;
  3522. pskCS[1] = psk->cipherSuite;
  3523. /* Ensure PSK and negotiated cipher suites have same hash. */
  3524. if (SuiteMac(pskCS) != SuiteMac(suite)) {
  3525. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3526. return PSK_KEY_ERROR;
  3527. }
  3528. /* Negotiated cipher suite is to be used - update PSK. */
  3529. psk->cipherSuite0 = suite[0];
  3530. psk->cipherSuite = suite[1];
  3531. }
  3532. }
  3533. else if (ssl->options.client_psk_tls13_cb != NULL) {
  3534. byte cipherSuite0;
  3535. byte cipherSuite;
  3536. int cipherSuiteFlags = WOLFSSL_CIPHER_SUITE_FLAG_NONE;
  3537. ssl->arrays->psk_keySz = ssl->options.client_psk_tls13_cb(ssl,
  3538. ssl->arrays->server_hint, ssl->arrays->client_identity,
  3539. MAX_PSK_ID_LEN, ssl->arrays->psk_key, MAX_PSK_KEY_LEN,
  3540. &cipherName);
  3541. if (GetCipherSuiteFromName(cipherName, &cipherSuite0,
  3542. &cipherSuite, &cipherSuiteFlags) != 0) {
  3543. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3544. return PSK_KEY_ERROR;
  3545. }
  3546. ssl->options.cipherSuite0 = cipherSuite0;
  3547. ssl->options.cipherSuite = cipherSuite;
  3548. (void)cipherSuiteFlags;
  3549. }
  3550. else {
  3551. ssl->arrays->psk_keySz = ssl->options.client_psk_cb(ssl,
  3552. ssl->arrays->server_hint, ssl->arrays->client_identity,
  3553. MAX_PSK_ID_LEN, ssl->arrays->psk_key, MAX_PSK_KEY_LEN);
  3554. ssl->options.cipherSuite0 = TLS13_BYTE;
  3555. ssl->options.cipherSuite = WOLFSSL_DEF_PSK_CIPHER;
  3556. }
  3557. if (ssl->arrays->psk_keySz == 0 ||
  3558. (ssl->arrays->psk_keySz > MAX_PSK_KEY_LEN &&
  3559. (int)ssl->arrays->psk_keySz != USE_HW_PSK)) {
  3560. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3561. return PSK_KEY_ERROR;
  3562. }
  3563. ret = SetCipherSpecs(ssl);
  3564. if (ret != 0)
  3565. return ret;
  3566. #else
  3567. /* PSK information loaded during setting of default TLS extensions. */
  3568. #endif /* !WOLFSSL_PSK_ONE_ID */
  3569. if (!clientHello && (psk->cipherSuite0 != suite[0] ||
  3570. psk->cipherSuite != suite[1])) {
  3571. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  3572. return PSK_KEY_ERROR;
  3573. }
  3574. if (!clientHello) {
  3575. /* CLIENT: using PSK for peer authentication. */
  3576. ssl->options.peerAuthGood = 1;
  3577. }
  3578. }
  3579. #endif
  3580. if (ssl->options.noPskDheKe) {
  3581. ssl->arrays->preMasterSz = 0;
  3582. }
  3583. /* Derive the early secret using the PSK. */
  3584. return DeriveEarlySecret(ssl);
  3585. }
  3586. /* Derive and write the binders into the ClientHello in space left when
  3587. * writing the Pre-Shared Key extension.
  3588. *
  3589. * ssl The SSL/TLS object.
  3590. * output The buffer containing the ClientHello.
  3591. * idx The index at the end of the completed ClientHello.
  3592. * returns 0 on success and otherwise failure.
  3593. */
  3594. static int WritePSKBinders(WOLFSSL* ssl, byte* output, word32 idx)
  3595. {
  3596. int ret;
  3597. TLSX* ext;
  3598. PreSharedKey* current;
  3599. byte binderKey[WC_MAX_DIGEST_SIZE];
  3600. word16 len;
  3601. WOLFSSL_ENTER("WritePSKBinders");
  3602. ext = TLSX_Find(ssl->extensions, TLSX_PRE_SHARED_KEY);
  3603. if (ext == NULL)
  3604. return SANITY_MSG_E;
  3605. /* Get the size of the binders to determine where to write binders. */
  3606. ret = TLSX_PreSharedKey_GetSizeBinders((PreSharedKey*)ext->data,
  3607. client_hello, &len);
  3608. if (ret < 0)
  3609. return ret;
  3610. idx -= len;
  3611. /* Hash truncated ClientHello - up to binders. */
  3612. #ifdef WOLFSSL_DTLS13
  3613. if (ssl->options.dtls)
  3614. ret = Dtls13HashHandshake(ssl, output + Dtls13GetRlHeaderLength(ssl, 0),
  3615. idx - Dtls13GetRlHeaderLength(ssl, 0));
  3616. else
  3617. #endif /* WOLFSSL_DTLS13 */
  3618. ret = HashOutput(ssl, output, idx, 0);
  3619. if (ret != 0)
  3620. return ret;
  3621. current = (PreSharedKey*)ext->data;
  3622. #ifdef WOLFSSL_CHECK_MEM_ZERO
  3623. if (current != NULL) {
  3624. wc_MemZero_Add("WritePSKBinders binderKey", binderKey,
  3625. sizeof(binderKey));
  3626. }
  3627. #endif
  3628. /* Calculate the binder for each identity based on previous handshake data.
  3629. */
  3630. while (current != NULL) {
  3631. if ((ret = SetupPskKey(ssl, current, 1)) != 0)
  3632. break;
  3633. #ifdef HAVE_SESSION_TICKET
  3634. if (current->resumption)
  3635. ret = DeriveBinderKeyResume(ssl, binderKey);
  3636. #endif
  3637. #ifndef NO_PSK
  3638. if (!current->resumption)
  3639. ret = DeriveBinderKey(ssl, binderKey);
  3640. #endif
  3641. if (ret != 0)
  3642. break;
  3643. /* Derive the Finished message secret. */
  3644. ret = DeriveFinishedSecret(ssl, binderKey,
  3645. ssl->keys.client_write_MAC_secret,
  3646. 0 /* neither end */);
  3647. if (ret != 0)
  3648. break;
  3649. /* Build the HMAC of the handshake message data = binder. */
  3650. ret = BuildTls13HandshakeHmac(ssl, ssl->keys.client_write_MAC_secret,
  3651. current->binder, &current->binderLen);
  3652. if (ret != 0)
  3653. break;
  3654. current = current->next;
  3655. }
  3656. ForceZero(binderKey, sizeof(binderKey));
  3657. #ifdef WOLFSSL_CHECK_MEM_ZERO
  3658. wc_MemZero_Check(binderKey, sizeof(binderKey));
  3659. #endif
  3660. if (ret != 0)
  3661. return ret;
  3662. /* Data entered into extension, now write to message. */
  3663. ret = TLSX_PreSharedKey_WriteBinders((PreSharedKey*)ext->data, output + idx,
  3664. client_hello, &len);
  3665. if (ret < 0)
  3666. return ret;
  3667. /* Hash binders to complete the hash of the ClientHello. */
  3668. ret = HashRaw(ssl, output + idx, len);
  3669. if (ret < 0)
  3670. return ret;
  3671. #ifdef WOLFSSL_EARLY_DATA
  3672. if (ssl->earlyData != no_early_data) {
  3673. if ((ret = SetupPskKey(ssl, (PreSharedKey*)ext->data, 1)) != 0)
  3674. return ret;
  3675. /* Derive early data encryption key. */
  3676. ret = DeriveTls13Keys(ssl, early_data_key, ENCRYPT_SIDE_ONLY, 1);
  3677. if (ret != 0)
  3678. return ret;
  3679. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  3680. return ret;
  3681. #ifdef WOLFSSL_DTLS13
  3682. if (ssl->options.dtls) {
  3683. ret = Dtls13NewEpoch(
  3684. ssl, w64From32(0x0, DTLS13_EPOCH_EARLYDATA), ENCRYPT_SIDE_ONLY);
  3685. if (ret != 0)
  3686. return ret;
  3687. }
  3688. #endif /* WOLFSSL_DTLS13 */
  3689. }
  3690. #endif
  3691. WOLFSSL_LEAVE("WritePSKBinders", ret);
  3692. return ret;
  3693. }
  3694. #endif
  3695. #if defined(HAVE_ECH)
  3696. /* returns the index of the first supported cipher suite, -1 if none */
  3697. int EchConfigGetSupportedCipherSuite(WOLFSSL_EchConfig* config)
  3698. {
  3699. int i, j, supported = 0;
  3700. for (i = 0; i < config->numCipherSuites; i++) {
  3701. supported = 0;
  3702. for (j = 0; j < HPKE_SUPPORTED_KDF_LEN; j++) {
  3703. if (config->cipherSuites[i].kdfId == hpkeSupportedKdf[j])
  3704. break;
  3705. }
  3706. if (j < HPKE_SUPPORTED_KDF_LEN)
  3707. for (j = 0; j < HPKE_SUPPORTED_AEAD_LEN; j++) {
  3708. if (config->cipherSuites[i].aeadId == hpkeSupportedAead[j]) {
  3709. supported = 1;
  3710. break;
  3711. }
  3712. }
  3713. if (supported)
  3714. return i;
  3715. }
  3716. return -1;
  3717. }
  3718. /* returns status after we hash the ech inner */
  3719. static int EchHashHelloInner(WOLFSSL* ssl, WOLFSSL_ECH* ech)
  3720. {
  3721. int ret;
  3722. HS_Hashes* tmpHashes;
  3723. byte falseHeader[HANDSHAKE_HEADER_SZ];
  3724. if (ssl == NULL || ech == NULL)
  3725. return BAD_FUNC_ARG;
  3726. /* switch hsHashes to the ech version */
  3727. InitHandshakeHashesAndCopy(ssl, ssl->hsHashes, &ssl->hsHashesEch);
  3728. /* swap hsHashes so the regular hash functions work */
  3729. tmpHashes = ssl->hsHashes;
  3730. ssl->hsHashes = ssl->hsHashesEch;
  3731. /* do the handshake header then the body */
  3732. AddTls13HandShakeHeader(falseHeader,
  3733. ech->innerClientHelloLen - ech->paddingLen - ech->hpke->Nt, 0, 0,
  3734. client_hello, ssl);
  3735. ret = HashRaw(ssl, falseHeader, HANDSHAKE_HEADER_SZ);
  3736. /* hash the body */
  3737. if (ret == 0) {
  3738. ret = HashRaw(ssl, ech->innerClientHello,
  3739. ech->innerClientHelloLen - ech->paddingLen - ech->hpke->Nt);
  3740. }
  3741. /* swap hsHashes back */
  3742. ssl->hsHashes = tmpHashes;
  3743. return ret;
  3744. }
  3745. #endif
  3746. static void GetTls13SessionId(WOLFSSL* ssl, byte* output, word32* idx)
  3747. {
  3748. if (ssl->session->sessionIDSz > 0) {
  3749. /* Session resumption for old versions of protocol. */
  3750. if (ssl->session->sessionIDSz <= ID_LEN) {
  3751. if (output != NULL)
  3752. output[*idx] = ssl->session->sessionIDSz;
  3753. (*idx)++;
  3754. if (output != NULL) {
  3755. XMEMCPY(output + *idx, ssl->session->sessionID,
  3756. ssl->session->sessionIDSz);
  3757. }
  3758. *idx += ssl->session->sessionIDSz;
  3759. }
  3760. else {
  3761. /* Invalid session ID length. Reset it. */
  3762. ssl->session->sessionIDSz = 0;
  3763. if (output != NULL)
  3764. output[*idx] = 0;
  3765. (*idx)++;
  3766. }
  3767. }
  3768. else {
  3769. #ifdef WOLFSSL_TLS13_MIDDLEBOX_COMPAT
  3770. if (ssl->options.tls13MiddleBoxCompat) {
  3771. if (output != NULL)
  3772. output[*idx] = ID_LEN;
  3773. (*idx)++;
  3774. if (output != NULL)
  3775. XMEMCPY(output + *idx, ssl->arrays->clientRandom, ID_LEN);
  3776. *idx += ID_LEN;
  3777. }
  3778. else
  3779. #endif /* WOLFSSL_TLS13_MIDDLEBOX_COMPAT */
  3780. {
  3781. /* TLS v1.3 does not use session id - 0 length. */
  3782. if (output != NULL)
  3783. output[*idx] = 0;
  3784. (*idx)++;
  3785. }
  3786. }
  3787. }
  3788. /* handle generation of TLS 1.3 client_hello (1) */
  3789. /* Send a ClientHello message to the server.
  3790. * Include the information required to start a handshake with servers using
  3791. * protocol versions less than TLS v1.3.
  3792. * Only a client will send this message.
  3793. *
  3794. * ssl The SSL/TLS object.
  3795. * returns 0 on success and otherwise failure.
  3796. */
  3797. typedef struct Sch13Args {
  3798. byte* output;
  3799. word32 idx;
  3800. int sendSz;
  3801. word16 length;
  3802. #if defined(HAVE_ECH)
  3803. int clientRandomOffset;
  3804. int preXLength;
  3805. WOLFSSL_ECH* ech;
  3806. #endif
  3807. } Sch13Args;
  3808. int SendTls13ClientHello(WOLFSSL* ssl)
  3809. {
  3810. int ret;
  3811. #ifdef WOLFSSL_ASYNC_CRYPT
  3812. Sch13Args* args = NULL;
  3813. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  3814. #else
  3815. Sch13Args args[1];
  3816. #endif
  3817. byte major, tls12minor;
  3818. const Suites* suites;
  3819. WOLFSSL_START(WC_FUNC_CLIENT_HELLO_SEND);
  3820. WOLFSSL_ENTER("SendTls13ClientHello");
  3821. if (ssl == NULL) {
  3822. return BAD_FUNC_ARG;
  3823. }
  3824. ssl->options.buildingMsg = 1;
  3825. major = SSLv3_MAJOR;
  3826. tls12minor = TLSv1_2_MINOR;
  3827. #ifdef WOLFSSL_DTLS13
  3828. if (ssl->options.dtls) {
  3829. major = DTLS_MAJOR;
  3830. tls12minor = DTLSv1_2_MINOR;
  3831. }
  3832. #endif /* WOLFSSL_DTLS */
  3833. #ifdef HAVE_SESSION_TICKET
  3834. if (ssl->options.resuming &&
  3835. (ssl->session->version.major != ssl->version.major ||
  3836. ssl->session->version.minor != ssl->version.minor)) {
  3837. #ifndef WOLFSSL_NO_TLS12
  3838. if (ssl->session->version.major == ssl->version.major &&
  3839. ssl->session->version.minor < ssl->version.minor) {
  3840. /* Cannot resume with a different protocol version. */
  3841. ssl->options.resuming = 0;
  3842. ssl->version.major = ssl->session->version.major;
  3843. ssl->version.minor = ssl->session->version.minor;
  3844. return SendClientHello(ssl);
  3845. }
  3846. else
  3847. #endif
  3848. {
  3849. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  3850. return VERSION_ERROR;
  3851. }
  3852. }
  3853. #endif
  3854. suites = WOLFSSL_SUITES(ssl);
  3855. if (suites == NULL) {
  3856. WOLFSSL_MSG("Bad suites pointer in SendTls13ClientHello");
  3857. return SUITES_ERROR;
  3858. }
  3859. #ifdef WOLFSSL_ASYNC_CRYPT
  3860. if (ssl->async == NULL) {
  3861. ssl->async = (struct WOLFSSL_ASYNC*)
  3862. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  3863. DYNAMIC_TYPE_ASYNC);
  3864. if (ssl->async == NULL)
  3865. return MEMORY_E;
  3866. ssl->async->freeArgs = NULL;
  3867. }
  3868. args = (Sch13Args*)ssl->async->args;
  3869. ret = wolfSSL_AsyncPop(ssl, &ssl->options.asyncState);
  3870. if (ret != WC_NO_PENDING_E) {
  3871. /* Check for error */
  3872. if (ret < 0)
  3873. return ret;
  3874. }
  3875. else
  3876. #endif
  3877. {
  3878. /* Reset state */
  3879. ssl->options.asyncState = TLS_ASYNC_BEGIN;
  3880. XMEMSET(args, 0, sizeof(Sch13Args));
  3881. }
  3882. switch (ssl->options.asyncState) {
  3883. case TLS_ASYNC_BEGIN:
  3884. {
  3885. word32 sessIdSz = 0;
  3886. args->idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  3887. #ifdef WOLFSSL_DTLS13
  3888. if (ssl->options.dtls)
  3889. args->idx += DTLS_RECORD_EXTRA + DTLS_HANDSHAKE_EXTRA;
  3890. #endif /* WOLFSSL_DTLS13 */
  3891. /* Version | Random | Cipher Suites | Compression */
  3892. args->length = VERSION_SZ + RAN_LEN + suites->suiteSz +
  3893. SUITE_LEN + COMP_LEN + ENUM_LEN;
  3894. #ifdef WOLFSSL_QUIC
  3895. if (WOLFSSL_IS_QUIC(ssl)) {
  3896. /* RFC 9001 ch. 8.4 sessionID in ClientHello MUST be 0 length */
  3897. ssl->session->sessionIDSz = 0;
  3898. ssl->options.tls13MiddleBoxCompat = 0;
  3899. }
  3900. #endif
  3901. GetTls13SessionId(ssl, NULL, &sessIdSz);
  3902. args->length += (word16)sessIdSz;
  3903. #ifdef WOLFSSL_DTLS13
  3904. if (ssl->options.dtls) {
  3905. /* legacy_cookie_id len */
  3906. args->length += ENUM_LEN;
  3907. /* server sent us an HelloVerifyRequest and we allow downgrade */
  3908. if (ssl->arrays->cookieSz > 0 && ssl->options.downgrade)
  3909. args->length += ssl->arrays->cookieSz;
  3910. }
  3911. #endif /* WOLFSSL_DTLS13 */
  3912. /* Advance state and proceed */
  3913. ssl->options.asyncState = TLS_ASYNC_BUILD;
  3914. } /* case TLS_ASYNC_BEGIN */
  3915. FALL_THROUGH;
  3916. case TLS_ASYNC_BUILD:
  3917. case TLS_ASYNC_DO:
  3918. {
  3919. /* Auto populate extensions supported unless user defined. */
  3920. if ((ret = TLSX_PopulateExtensions(ssl, 0)) != 0)
  3921. return ret;
  3922. /* Advance state and proceed */
  3923. ssl->options.asyncState = TLS_ASYNC_FINALIZE;
  3924. } /* case TLS_ASYNC_BUILD */
  3925. FALL_THROUGH;
  3926. case TLS_ASYNC_FINALIZE:
  3927. {
  3928. #ifdef WOLFSSL_EARLY_DATA
  3929. #ifndef NO_PSK
  3930. if (!ssl->options.resuming &&
  3931. ssl->options.client_psk_tls13_cb == NULL &&
  3932. ssl->options.client_psk_cb == NULL)
  3933. #else
  3934. if (!ssl->options.resuming)
  3935. #endif
  3936. ssl->earlyData = no_early_data;
  3937. if (ssl->options.serverState == SERVER_HELLO_RETRY_REQUEST_COMPLETE)
  3938. ssl->earlyData = no_early_data;
  3939. if (ssl->earlyData == no_early_data)
  3940. TLSX_Remove(&ssl->extensions, TLSX_EARLY_DATA, ssl->heap);
  3941. if (ssl->earlyData != no_early_data &&
  3942. (ret = TLSX_EarlyData_Use(ssl, 0, 0)) < 0) {
  3943. return ret;
  3944. }
  3945. #endif
  3946. #ifdef WOLFSSL_QUIC
  3947. if (WOLFSSL_IS_QUIC(ssl) && IsAtLeastTLSv1_3(ssl->version)) {
  3948. ret = wolfSSL_quic_add_transport_extensions(ssl, client_hello);
  3949. if (ret != 0)
  3950. return ret;
  3951. }
  3952. #endif
  3953. /* find length of outer and inner */
  3954. #if defined(HAVE_ECH)
  3955. if (ssl->options.useEch == 1) {
  3956. TLSX* echX = TLSX_Find(ssl->extensions, TLSX_ECH);
  3957. if (echX == NULL)
  3958. return -1;
  3959. args->ech = (WOLFSSL_ECH*)echX->data;
  3960. if (args->ech == NULL)
  3961. return -1;
  3962. /* set the type to inner */
  3963. args->ech->type = ECH_TYPE_INNER;
  3964. args->preXLength = args->length;
  3965. /* get size for inner */
  3966. ret = TLSX_GetRequestSize(ssl, client_hello, &args->length);
  3967. if (ret != 0)
  3968. return ret;
  3969. /* set the type to outer */
  3970. args->ech->type = 0;
  3971. /* set innerClientHelloLen to ClientHelloInner + padding + tag */
  3972. args->ech->paddingLen = 31 - ((args->length - 1) % 32);
  3973. args->ech->innerClientHelloLen = args->length +
  3974. args->ech->paddingLen + args->ech->hpke->Nt;
  3975. /* set the length back to before we computed ClientHelloInner size */
  3976. args->length = args->preXLength;
  3977. }
  3978. #endif
  3979. {
  3980. #ifdef WOLFSSL_DTLS_CH_FRAG
  3981. int maxFrag = wolfSSL_GetMaxFragSize(ssl, MAX_RECORD_SIZE);
  3982. word16 lenWithoutExts = args->length;
  3983. #endif
  3984. /* Include length of TLS extensions. */
  3985. ret = TLSX_GetRequestSize(ssl, client_hello, &args->length);
  3986. if (ret != 0)
  3987. return ret;
  3988. #ifdef WOLFSSL_DTLS_CH_FRAG
  3989. if (ssl->options.dtls && args->length > maxFrag &&
  3990. TLSX_Find(ssl->extensions, TLSX_COOKIE) == NULL) {
  3991. /* Try again with an empty key share if we would be fragmenting
  3992. * without a cookie */
  3993. ret = TLSX_KeyShare_Empty(ssl);
  3994. if (ret != 0)
  3995. return ret;
  3996. args->length = lenWithoutExts;
  3997. ret = TLSX_GetRequestSize(ssl, client_hello, &args->length);
  3998. if (ret != 0)
  3999. return ret;
  4000. if (args->length > maxFrag) {
  4001. WOLFSSL_MSG("Can't fit first CH in one fragment.");
  4002. return BUFFER_ERROR;
  4003. }
  4004. WOLFSSL_MSG("Sending empty key share so we don't fragment CH1");
  4005. }
  4006. #endif
  4007. }
  4008. /* Total message size. */
  4009. args->sendSz = args->length + HANDSHAKE_HEADER_SZ + RECORD_HEADER_SZ;
  4010. #ifdef WOLFSSL_DTLS13
  4011. if (ssl->options.dtls)
  4012. args->sendSz += DTLS_RECORD_EXTRA + DTLS_HANDSHAKE_EXTRA;
  4013. #endif /* WOLFSSL_DTLS13 */
  4014. /* Check buffers are big enough and grow if needed. */
  4015. if ((ret = CheckAvailableSize(ssl, args->sendSz)) != 0)
  4016. return ret;
  4017. /* Get position in output buffer to write new message to. */
  4018. args->output = GetOutputBuffer(ssl);
  4019. /* Put the record and handshake headers on. */
  4020. AddTls13Headers(args->output, args->length, client_hello, ssl);
  4021. /* Protocol version - negotiation now in extension: supported_versions. */
  4022. args->output[args->idx++] = major;
  4023. args->output[args->idx++] = tls12minor;
  4024. /* Keep for downgrade. */
  4025. ssl->chVersion = ssl->version;
  4026. if (ssl->arrays == NULL) {
  4027. return BAD_FUNC_ARG;
  4028. }
  4029. /* Client Random */
  4030. if (ssl->options.connectState == CONNECT_BEGIN) {
  4031. ret = wc_RNG_GenerateBlock(ssl->rng, args->output + args->idx, RAN_LEN);
  4032. if (ret != 0)
  4033. return ret;
  4034. /* Store random for possible second ClientHello. */
  4035. XMEMCPY(ssl->arrays->clientRandom, args->output + args->idx, RAN_LEN);
  4036. }
  4037. else
  4038. XMEMCPY(args->output + args->idx, ssl->arrays->clientRandom, RAN_LEN);
  4039. #if defined(HAVE_ECH)
  4040. args->clientRandomOffset = args->idx;
  4041. #endif
  4042. args->idx += RAN_LEN;
  4043. GetTls13SessionId(ssl, args->output, &args->idx);
  4044. #ifdef WOLFSSL_DTLS13
  4045. if (ssl->options.dtls) {
  4046. args->output[args->idx++] = ssl->arrays->cookieSz;
  4047. if (ssl->arrays->cookieSz > 0) {
  4048. /* We have a cookie saved, so the server sent us an
  4049. * HelloVerifyRequest, it means it is a v1.2 server */
  4050. if (!ssl->options.downgrade)
  4051. return VERSION_ERROR;
  4052. XMEMCPY(args->output + args->idx, ssl->arrays->cookie,
  4053. ssl->arrays->cookieSz);
  4054. args->idx += ssl->arrays->cookieSz;
  4055. }
  4056. }
  4057. #endif /* WOLFSSL_DTLS13 */
  4058. /* Cipher suites */
  4059. c16toa(suites->suiteSz, args->output + args->idx);
  4060. args->idx += OPAQUE16_LEN;
  4061. XMEMCPY(args->output + args->idx, &suites->suites,
  4062. suites->suiteSz);
  4063. args->idx += suites->suiteSz;
  4064. #ifdef WOLFSSL_DEBUG_TLS
  4065. {
  4066. int ii;
  4067. WOLFSSL_MSG("Ciphers:");
  4068. for (ii = 0 ; ii < suites->suiteSz; ii += 2) {
  4069. WOLFSSL_MSG(GetCipherNameInternal(suites->suites[ii+0],
  4070. suites->suites[ii+1]));
  4071. }
  4072. }
  4073. #endif
  4074. /* Compression not supported in TLS v1.3. */
  4075. args->output[args->idx++] = COMP_LEN;
  4076. args->output[args->idx++] = NO_COMPRESSION;
  4077. #if defined(HAVE_ECH)
  4078. /* write inner then outer */
  4079. if (ssl->options.useEch == 1) {
  4080. /* set the type to inner */
  4081. args->ech->type = ECH_TYPE_INNER;
  4082. /* allocate the inner */
  4083. args->ech->innerClientHello =
  4084. (byte*)XMALLOC(args->ech->innerClientHelloLen - args->ech->hpke->Nt,
  4085. ssl->heap, DYNAMIC_TYPE_TMP_BUFFER);
  4086. if (args->ech->innerClientHello == NULL)
  4087. return MEMORY_E;
  4088. /* set the padding bytes to 0 */
  4089. XMEMSET(args->ech->innerClientHello + args->ech->innerClientHelloLen -
  4090. args->ech->hpke->Nt - args->ech->paddingLen, 0,
  4091. args->ech->paddingLen);
  4092. /* copy the client hello to the ech innerClientHello, exclude record */
  4093. /* and handshake headers */
  4094. XMEMCPY(args->ech->innerClientHello,
  4095. args->output + RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ,
  4096. args->idx - (RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ));
  4097. /* copy the client random to inner */
  4098. XMEMCPY(ssl->arrays->clientRandomInner, ssl->arrays->clientRandom,
  4099. RAN_LEN);
  4100. /* change the outer client random */
  4101. ret = wc_RNG_GenerateBlock(ssl->rng, args->output +
  4102. args->clientRandomOffset, RAN_LEN);
  4103. if (ret != 0)
  4104. return ret;
  4105. /* copy the new client random */
  4106. XMEMCPY(ssl->arrays->clientRandom, args->output +
  4107. args->clientRandomOffset, RAN_LEN);
  4108. /* write the extensions for inner */
  4109. args->length = 0;
  4110. ret = TLSX_WriteRequest(ssl, args->ech->innerClientHello + args->idx -
  4111. (RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ), client_hello,
  4112. &args->length);
  4113. if (ret != 0)
  4114. return ret;
  4115. /* set the type to outer */
  4116. args->ech->type = 0;
  4117. }
  4118. #endif
  4119. /* Write out extensions for a request. */
  4120. args->length = 0;
  4121. ret = TLSX_WriteRequest(ssl, args->output + args->idx, client_hello,
  4122. &args->length);
  4123. if (ret != 0)
  4124. return ret;
  4125. args->idx += args->length;
  4126. #if defined(HAVE_ECH)
  4127. /* encrypt and pack the ech innerClientHello */
  4128. if (ssl->options.useEch == 1) {
  4129. ret = TLSX_FinalizeEch(args->ech,
  4130. args->output + RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ,
  4131. args->sendSz - (RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ));
  4132. if (ret != 0)
  4133. return ret;
  4134. }
  4135. #endif
  4136. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  4137. /* Resumption has a specific set of extensions and binder is calculated
  4138. * for each identity.
  4139. */
  4140. if (TLSX_Find(ssl->extensions, TLSX_PRE_SHARED_KEY)) {
  4141. ret = WritePSKBinders(ssl, args->output, args->idx);
  4142. }
  4143. else
  4144. #endif
  4145. {
  4146. #ifdef WOLFSSL_DTLS13
  4147. if (ssl->options.dtls)
  4148. ret = Dtls13HashHandshake(ssl,
  4149. args->output + Dtls13GetRlHeaderLength(ssl, 0),
  4150. (word16)args->idx - Dtls13GetRlHeaderLength(ssl, 0));
  4151. else
  4152. #endif /* WOLFSSL_DTLS13 */
  4153. {
  4154. #if defined(HAVE_ECH)
  4155. /* compute the inner hash */
  4156. if (ssl->options.useEch == 1) {
  4157. ret = EchHashHelloInner(ssl, args->ech);
  4158. }
  4159. #endif
  4160. /* compute the outer hash */
  4161. if (ret == 0)
  4162. ret = HashOutput(ssl, args->output, args->idx, 0);
  4163. }
  4164. }
  4165. if (ret != 0)
  4166. return ret;
  4167. ssl->options.clientState = CLIENT_HELLO_COMPLETE;
  4168. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  4169. if (ssl->hsInfoOn) AddPacketName(ssl, "ClientHello");
  4170. if (ssl->toInfoOn) {
  4171. ret = AddPacketInfo(ssl, "ClientHello", handshake, args->output,
  4172. args->sendSz, WRITE_PROTO, 0, ssl->heap);
  4173. if (ret != 0)
  4174. return ret;
  4175. }
  4176. #endif
  4177. ssl->options.buildingMsg = 0;
  4178. #ifdef WOLFSSL_DTLS13
  4179. if (ssl->options.dtls) {
  4180. ret = Dtls13HandshakeSend(ssl, args->output, (word16)args->sendSz,
  4181. (word16)args->idx, client_hello, 0);
  4182. break;
  4183. }
  4184. #endif /* WOLFSSL_DTLS13 */
  4185. ssl->buffers.outputBuffer.length += args->sendSz;
  4186. /* Advance state and proceed */
  4187. ssl->options.asyncState = TLS_ASYNC_END;
  4188. }
  4189. /* case TLS_ASYNC_BUILD */
  4190. FALL_THROUGH;
  4191. case TLS_ASYNC_END:
  4192. {
  4193. #ifdef WOLFSSL_EARLY_DATA_GROUP
  4194. /* QUIC needs to forward records at their encryption level
  4195. * and is therefore unable to group here */
  4196. if (ssl->earlyData == no_early_data || WOLFSSL_IS_QUIC(ssl))
  4197. #endif
  4198. ret = SendBuffered(ssl);
  4199. break;
  4200. }
  4201. default:
  4202. ret = INPUT_CASE_ERROR;
  4203. } /* switch (ssl->options.asyncState) */
  4204. #ifdef WOLFSSL_ASYNC_CRYPT
  4205. if (ret == 0)
  4206. FreeAsyncCtx(ssl, 0);
  4207. #endif
  4208. WOLFSSL_LEAVE("SendTls13ClientHello", ret);
  4209. WOLFSSL_END(WC_FUNC_CLIENT_HELLO_SEND);
  4210. return ret;
  4211. }
  4212. #if defined(WOLFSSL_DTLS13) && !defined(WOLFSSL_NO_CLIENT)
  4213. static int Dtls13ClientDoDowngrade(WOLFSSL* ssl)
  4214. {
  4215. int ret;
  4216. if (ssl->dtls13ClientHello == NULL)
  4217. return BAD_STATE_E;
  4218. /* v1.3 and v1.2 hash messages to compute the transcript hash. When we are
  4219. * using DTLSv1.3 we hash the first clientHello following v1.3 but the
  4220. * server can negotiate a lower version. So we need to re-hash the
  4221. * clientHello to adhere to DTLS <= v1.2 rules. */
  4222. ret = InitHandshakeHashes(ssl);
  4223. if (ret != 0)
  4224. return ret;
  4225. ret = HashRaw(ssl, ssl->dtls13ClientHello, ssl->dtls13ClientHelloSz);
  4226. XFREE(ssl->dtls13ClientHello, ssl->heap, DYNAMIC_TYPE_DTLS_MSG);
  4227. ssl->dtls13ClientHello = NULL;
  4228. ssl->dtls13ClientHelloSz = 0;
  4229. ssl->keys.dtls_sequence_number_hi =
  4230. (word16)w64GetHigh32(ssl->dtls13EncryptEpoch->nextSeqNumber);
  4231. ssl->keys.dtls_sequence_number_lo =
  4232. w64GetLow32(ssl->dtls13EncryptEpoch->nextSeqNumber);
  4233. return ret;
  4234. }
  4235. #endif /* WOLFSSL_DTLS13 && !WOLFSSL_NO_CLIENT*/
  4236. #if defined(HAVE_ECH)
  4237. /* check if the server accepted ech or not */
  4238. static int EchCheckAcceptance(WOLFSSL* ssl, const byte* input,
  4239. int serverRandomOffset, int helloSz)
  4240. {
  4241. int ret = 0;
  4242. int digestType = 0;
  4243. int digestSize = 0;
  4244. HS_Hashes* tmpHashes;
  4245. HS_Hashes* acceptHashes;
  4246. byte zeros[WC_MAX_DIGEST_SIZE];
  4247. byte transcriptEchConf[WC_MAX_DIGEST_SIZE];
  4248. byte expandLabelPrk[WC_MAX_DIGEST_SIZE];
  4249. byte acceptConfirmation[ECH_ACCEPT_CONFIRMATION_SZ];
  4250. XMEMSET(zeros, 0, sizeof(zeros));
  4251. XMEMSET(transcriptEchConf, 0, sizeof(transcriptEchConf));
  4252. XMEMSET(expandLabelPrk, 0, sizeof(expandLabelPrk));
  4253. XMEMSET(acceptConfirmation, 0, sizeof(acceptConfirmation));
  4254. /* copy ech hashes to accept */
  4255. ret = InitHandshakeHashesAndCopy(ssl, ssl->hsHashesEch, &acceptHashes);
  4256. /* swap hsHashes to acceptHashes */
  4257. tmpHashes = ssl->hsHashes;
  4258. ssl->hsHashes = acceptHashes;
  4259. /* hash up to the last 8 bytes */
  4260. if (ret == 0)
  4261. ret = HashRaw(ssl, input, serverRandomOffset + RAN_LEN -
  4262. ECH_ACCEPT_CONFIRMATION_SZ);
  4263. /* hash 8 zeros */
  4264. if (ret == 0)
  4265. ret = HashRaw(ssl, zeros, ECH_ACCEPT_CONFIRMATION_SZ);
  4266. /* hash the rest of the hello */
  4267. if (ret == 0) {
  4268. ret = HashRaw(ssl, input + serverRandomOffset + RAN_LEN,
  4269. helloSz + HANDSHAKE_HEADER_SZ - (serverRandomOffset + RAN_LEN));
  4270. }
  4271. /* get the modified transcript hash */
  4272. if (ret == 0)
  4273. ret = GetMsgHash(ssl, transcriptEchConf);
  4274. if (ret > 0)
  4275. ret = 0;
  4276. /* pick the right type and size based on mac_algorithm */
  4277. if (ret == 0) {
  4278. switch (ssl->specs.mac_algorithm) {
  4279. #ifndef NO_SHA256
  4280. case sha256_mac:
  4281. digestType = WC_SHA256;
  4282. digestSize = WC_SHA256_DIGEST_SIZE;
  4283. break;
  4284. #endif /* !NO_SHA256 */
  4285. #ifdef WOLFSSL_SHA384
  4286. case sha384_mac:
  4287. digestType = WC_SHA384;
  4288. digestSize = WC_SHA384_DIGEST_SIZE;
  4289. break;
  4290. #endif /* WOLFSSL_SHA384 */
  4291. #ifdef WOLFSSL_TLS13_SHA512
  4292. case sha512_mac:
  4293. digestType = WC_SHA512;
  4294. digestSize = WC_SHA512_DIGEST_SIZE;
  4295. break;
  4296. #endif /* WOLFSSL_TLS13_SHA512 */
  4297. #ifdef WOLFSSL_SM3
  4298. case sm3_mac:
  4299. digestType = WC_SM3;
  4300. digestSize = WC_SM3_DIGEST_SIZE;
  4301. break;
  4302. #endif /* WOLFSSL_SM3 */
  4303. default:
  4304. ret = -1;
  4305. break;
  4306. }
  4307. }
  4308. /* extract clientRandomInner with a key of all zeros */
  4309. if (ret == 0) {
  4310. PRIVATE_KEY_UNLOCK();
  4311. #if !defined(HAVE_FIPS) || \
  4312. (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3))
  4313. ret = wc_HKDF_Extract_ex(digestType, zeros, digestSize,
  4314. ssl->arrays->clientRandomInner, RAN_LEN, expandLabelPrk,
  4315. ssl->heap, ssl->devId);
  4316. #else
  4317. ret = wc_HKDF_Extract(digestType, zeros, digestSize,
  4318. ssl->arrays->clientRandomInner, RAN_LEN, expandLabelPrk);
  4319. #endif
  4320. PRIVATE_KEY_LOCK();
  4321. }
  4322. /* tls expand with the confirmation label */
  4323. if (ret == 0) {
  4324. PRIVATE_KEY_UNLOCK();
  4325. ret = Tls13HKDFExpandKeyLabel(ssl,
  4326. acceptConfirmation, ECH_ACCEPT_CONFIRMATION_SZ,
  4327. expandLabelPrk, digestSize,
  4328. tls13ProtocolLabel, TLS13_PROTOCOL_LABEL_SZ,
  4329. echAcceptConfirmationLabel, ECH_ACCEPT_CONFIRMATION_LABEL_SZ,
  4330. transcriptEchConf, digestSize, digestType, WOLFSSL_SERVER_END);
  4331. PRIVATE_KEY_LOCK();
  4332. }
  4333. if (ret == 0) {
  4334. /* last 8 bytes should match our expand output */
  4335. ret = XMEMCMP(acceptConfirmation,
  4336. ssl->arrays->serverRandom + RAN_LEN - ECH_ACCEPT_CONFIRMATION_SZ,
  4337. ECH_ACCEPT_CONFIRMATION_SZ);
  4338. /* ech accepted */
  4339. if (ret == 0) {
  4340. /* use the inner random for client random */
  4341. XMEMCPY(ssl->arrays->clientRandom, ssl->arrays->clientRandomInner,
  4342. RAN_LEN);
  4343. /* switch back to original hsHashes to free */
  4344. ssl->hsHashes = tmpHashes;
  4345. /* set the final hsHashes to the ech hashes */
  4346. tmpHashes = ssl->hsHashesEch;
  4347. }
  4348. /* ech rejected */
  4349. else {
  4350. /* switch to hsHashesEch to free */
  4351. ssl->hsHashes = ssl->hsHashesEch;
  4352. }
  4353. /* free hsHashes */
  4354. FreeHandshakeHashes(ssl);
  4355. /* set hsHashesEch to NULL to avoid double free */
  4356. ssl->hsHashesEch = NULL;
  4357. /* continue with outer if we failed to verify ech was accepted */
  4358. ret = 0;
  4359. }
  4360. /* switch to acceptHashes */
  4361. ssl->hsHashes = acceptHashes;
  4362. /* free acceptHashes */
  4363. FreeHandshakeHashes(ssl);
  4364. /* swap to tmp, will ech if accepted, hsHashes if rejected */
  4365. ssl->hsHashes = tmpHashes;
  4366. return ret;
  4367. }
  4368. /* replace the last 8 bytes of the server random with the ech acceptance
  4369. * parameter, return status */
  4370. static int EchWriteAcceptance(WOLFSSL* ssl, byte* output,
  4371. int serverRandomOffset, int helloSz)
  4372. {
  4373. int ret = 0;
  4374. int digestType = 0;
  4375. int digestSize = 0;
  4376. HS_Hashes* tmpHashes = NULL;
  4377. HS_Hashes* acceptHashes = NULL;
  4378. byte zeros[WC_MAX_DIGEST_SIZE];
  4379. byte transcriptEchConf[WC_MAX_DIGEST_SIZE];
  4380. byte expandLabelPrk[WC_MAX_DIGEST_SIZE];
  4381. XMEMSET(zeros, 0, sizeof(zeros));
  4382. XMEMSET(transcriptEchConf, 0, sizeof(transcriptEchConf));
  4383. XMEMSET(expandLabelPrk, 0, sizeof(expandLabelPrk));
  4384. /* copy ech hashes to accept */
  4385. ret = InitHandshakeHashesAndCopy(ssl, ssl->hsHashes, &acceptHashes);
  4386. /* swap hsHashes to acceptHashes */
  4387. tmpHashes = ssl->hsHashes;
  4388. ssl->hsHashes = acceptHashes;
  4389. /* hash up to the last 8 bytes */
  4390. if (ret == 0)
  4391. ret = HashRaw(ssl, output, serverRandomOffset + RAN_LEN -
  4392. ECH_ACCEPT_CONFIRMATION_SZ);
  4393. /* hash 8 zeros */
  4394. if (ret == 0)
  4395. ret = HashRaw(ssl, zeros, ECH_ACCEPT_CONFIRMATION_SZ);
  4396. /* hash the rest of the hello */
  4397. if (ret == 0)
  4398. ret = HashRaw(ssl, output + serverRandomOffset + RAN_LEN,
  4399. helloSz - (serverRandomOffset + RAN_LEN));
  4400. /* get the modified transcript hash */
  4401. if (ret == 0)
  4402. ret = GetMsgHash(ssl, transcriptEchConf);
  4403. if (ret > 0)
  4404. ret = 0;
  4405. /* pick the right type and size based on mac_algorithm */
  4406. if (ret == 0)
  4407. switch (ssl->specs.mac_algorithm) {
  4408. #ifndef NO_SHA256
  4409. case sha256_mac:
  4410. digestType = WC_SHA256;
  4411. digestSize = WC_SHA256_DIGEST_SIZE;
  4412. break;
  4413. #endif /* !NO_SHA256 */
  4414. #ifdef WOLFSSL_SHA384
  4415. case sha384_mac:
  4416. digestType = WC_SHA384;
  4417. digestSize = WC_SHA384_DIGEST_SIZE;
  4418. break;
  4419. #endif /* WOLFSSL_SHA384 */
  4420. #ifdef WOLFSSL_TLS13_SHA512
  4421. case sha512_mac:
  4422. digestType = WC_SHA512;
  4423. digestSize = WC_SHA512_DIGEST_SIZE;
  4424. break;
  4425. #endif /* WOLFSSL_TLS13_SHA512 */
  4426. #ifdef WOLFSSL_SM3
  4427. case sm3_mac:
  4428. digestType = WC_SM3;
  4429. digestSize = WC_SM3_DIGEST_SIZE;
  4430. break;
  4431. #endif /* WOLFSSL_SM3 */
  4432. default:
  4433. ret = -1;
  4434. break;
  4435. }
  4436. /* extract clientRandom with a key of all zeros */
  4437. if (ret == 0) {
  4438. PRIVATE_KEY_UNLOCK();
  4439. #if !defined(HAVE_FIPS) || \
  4440. (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3))
  4441. ret = wc_HKDF_Extract_ex(digestType, zeros, digestSize,
  4442. ssl->arrays->clientRandom, RAN_LEN, expandLabelPrk,
  4443. ssl->heap, ssl->devId);
  4444. #else
  4445. ret = wc_HKDF_Extract(digestType, zeros, digestSize,
  4446. ssl->arrays->clientRandom, RAN_LEN, expandLabelPrk);
  4447. #endif
  4448. PRIVATE_KEY_LOCK();
  4449. }
  4450. /* tls expand with the confirmation label */
  4451. if (ret == 0) {
  4452. PRIVATE_KEY_UNLOCK();
  4453. ret = Tls13HKDFExpandKeyLabel(ssl,
  4454. output + serverRandomOffset + RAN_LEN - ECH_ACCEPT_CONFIRMATION_SZ,
  4455. ECH_ACCEPT_CONFIRMATION_SZ,
  4456. expandLabelPrk, digestSize,
  4457. tls13ProtocolLabel, TLS13_PROTOCOL_LABEL_SZ,
  4458. echAcceptConfirmationLabel, ECH_ACCEPT_CONFIRMATION_LABEL_SZ,
  4459. transcriptEchConf, digestSize, digestType, WOLFSSL_SERVER_END);
  4460. PRIVATE_KEY_LOCK();
  4461. }
  4462. if (ret == 0)
  4463. XMEMCPY(ssl->arrays->serverRandom, output + serverRandomOffset,
  4464. RAN_LEN);
  4465. /* free acceptHashes */
  4466. FreeHandshakeHashes(ssl);
  4467. ssl->hsHashes = tmpHashes;
  4468. return ret;
  4469. }
  4470. #endif
  4471. /* handle processing of TLS 1.3 server_hello (2) and hello_retry_request (6) */
  4472. /* Handle the ServerHello message from the server.
  4473. * Only a client will receive this message.
  4474. *
  4475. * ssl The SSL/TLS object.
  4476. * input The message buffer.
  4477. * inOutIdx On entry, the index into the message buffer of ServerHello.
  4478. * On exit, the index of byte after the ServerHello message.
  4479. * helloSz The length of the current handshake message.
  4480. * returns 0 on success and otherwise failure.
  4481. */
  4482. typedef struct Dsh13Args {
  4483. ProtocolVersion pv;
  4484. word32 idx;
  4485. word32 begin;
  4486. const byte* sessId;
  4487. word16 totalExtSz;
  4488. byte sessIdSz;
  4489. byte extMsgType;
  4490. #if defined(HAVE_ECH)
  4491. int serverRandomOffset;
  4492. #endif
  4493. } Dsh13Args;
  4494. int DoTls13ServerHello(WOLFSSL* ssl, const byte* input, word32* inOutIdx,
  4495. word32 helloSz, byte* extMsgType)
  4496. {
  4497. int ret;
  4498. byte suite[2];
  4499. byte tls12minor;
  4500. #ifdef WOLFSSL_ASYNC_CRYPT
  4501. Dsh13Args* args = NULL;
  4502. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  4503. #else
  4504. Dsh13Args args[1];
  4505. #endif
  4506. WOLFSSL_START(WC_FUNC_SERVER_HELLO_DO);
  4507. WOLFSSL_ENTER("DoTls13ServerHello");
  4508. tls12minor = TLSv1_2_MINOR;
  4509. #ifdef WOLFSSL_DTLS13
  4510. if (ssl->options.dtls)
  4511. tls12minor = DTLSv1_2_MINOR;
  4512. #endif /* WOLFSSL_DTLS13 */
  4513. if (ssl == NULL || ssl->arrays == NULL)
  4514. return BAD_FUNC_ARG;
  4515. #ifdef WOLFSSL_ASYNC_CRYPT
  4516. if (ssl->async == NULL) {
  4517. ssl->async = (struct WOLFSSL_ASYNC*)
  4518. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  4519. DYNAMIC_TYPE_ASYNC);
  4520. if (ssl->async == NULL)
  4521. return MEMORY_E;
  4522. ssl->async->freeArgs = NULL;
  4523. }
  4524. args = (Dsh13Args*)ssl->async->args;
  4525. ret = wolfSSL_AsyncPop(ssl, &ssl->options.asyncState);
  4526. if (ret != WC_NO_PENDING_E) {
  4527. /* Check for error */
  4528. if (ret < 0) {
  4529. if (ret == WC_PENDING_E) {
  4530. /* Mark message as not received so it can process again */
  4531. ssl->msgsReceived.got_server_hello = 0;
  4532. }
  4533. return ret;
  4534. }
  4535. }
  4536. else
  4537. #endif
  4538. {
  4539. /* Reset state */
  4540. ssl->options.asyncState = TLS_ASYNC_BEGIN;
  4541. XMEMSET(args, 0, sizeof(Dsh13Args));
  4542. }
  4543. switch (ssl->options.asyncState) {
  4544. case TLS_ASYNC_BEGIN:
  4545. {
  4546. byte b;
  4547. #ifdef WOLFSSL_CALLBACKS
  4548. if (ssl->hsInfoOn) AddPacketName(ssl, "ServerHello");
  4549. if (ssl->toInfoOn) AddLateName("ServerHello", &ssl->timeoutInfo);
  4550. #endif
  4551. /* Protocol version length check. */
  4552. if (helloSz < OPAQUE16_LEN)
  4553. return BUFFER_ERROR;
  4554. args->idx = *inOutIdx;
  4555. args->begin = args->idx;
  4556. /* Protocol version */
  4557. XMEMCPY(&args->pv, input + args->idx, OPAQUE16_LEN);
  4558. args->idx += OPAQUE16_LEN;
  4559. #ifdef WOLFSSL_DTLS
  4560. if (ssl->options.dtls &&
  4561. (args->pv.major != DTLS_MAJOR || args->pv.minor == DTLS_BOGUS_MINOR))
  4562. return VERSION_ERROR;
  4563. #endif /* WOLFSSL_DTLS */
  4564. #ifndef WOLFSSL_NO_TLS12
  4565. {
  4566. byte wantDowngrade;
  4567. wantDowngrade = args->pv.major == ssl->version.major &&
  4568. args->pv.minor < TLSv1_2_MINOR;
  4569. #ifdef WOLFSSL_DTLS13
  4570. if (ssl->options.dtls)
  4571. wantDowngrade = args->pv.major == ssl->version.major &&
  4572. args->pv.minor > DTLSv1_2_MINOR;
  4573. #endif /* WOLFSSL_DTLS13 */
  4574. if (wantDowngrade && ssl->options.downgrade) {
  4575. /* Force client hello version 1.2 to work for static RSA. */
  4576. ssl->chVersion.minor = TLSv1_2_MINOR;
  4577. ssl->version.minor = TLSv1_2_MINOR;
  4578. #ifdef WOLFSSL_DTLS13
  4579. if (ssl->options.dtls) {
  4580. ssl->chVersion.minor = DTLSv1_2_MINOR;
  4581. ssl->version.minor = DTLSv1_2_MINOR;
  4582. ret = Dtls13ClientDoDowngrade(ssl);
  4583. if (ret != 0)
  4584. return ret;
  4585. }
  4586. #endif /* WOLFSSL_DTLS13 */
  4587. return DoServerHello(ssl, input, inOutIdx, helloSz);
  4588. }
  4589. }
  4590. #endif
  4591. if (args->pv.major != ssl->version.major ||
  4592. args->pv.minor != tls12minor) {
  4593. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4594. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4595. return VERSION_ERROR;
  4596. }
  4597. /* Random and session id length check */
  4598. if ((args->idx - args->begin) + RAN_LEN + ENUM_LEN > helloSz)
  4599. return BUFFER_ERROR;
  4600. /* Check if hello retry request */
  4601. if (XMEMCMP(input + args->idx, helloRetryRequestRandom, RAN_LEN) == 0) {
  4602. WOLFSSL_MSG("HelloRetryRequest format");
  4603. *extMsgType = hello_retry_request;
  4604. if (ssl->msgsReceived.got_hello_verify_request) {
  4605. WOLFSSL_MSG("Received HelloRetryRequest after a "
  4606. "HelloVerifyRequest");
  4607. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4608. return VERSION_ERROR;
  4609. }
  4610. /* A HelloRetryRequest comes in as an ServerHello for MiddleBox compat.
  4611. * Found message to be a HelloRetryRequest.
  4612. * Don't allow more than one HelloRetryRequest or ServerHello.
  4613. */
  4614. if (ssl->msgsReceived.got_hello_retry_request) {
  4615. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  4616. return DUPLICATE_MSG_E;
  4617. }
  4618. }
  4619. args->extMsgType = *extMsgType;
  4620. /* Server random - keep for debugging. */
  4621. XMEMCPY(ssl->arrays->serverRandom, input + args->idx, RAN_LEN);
  4622. #if defined(HAVE_ECH)
  4623. args->serverRandomOffset = args->idx;
  4624. #endif
  4625. args->idx += RAN_LEN;
  4626. /* Session id */
  4627. args->sessIdSz = input[args->idx++];
  4628. if ((args->idx - args->begin) + args->sessIdSz > helloSz)
  4629. return BUFFER_ERROR;
  4630. args->sessId = input + args->idx;
  4631. args->idx += args->sessIdSz;
  4632. ssl->options.haveSessionId = 1;
  4633. /* Ciphersuite and compression check */
  4634. if ((args->idx - args->begin) + OPAQUE16_LEN + OPAQUE8_LEN > helloSz)
  4635. return BUFFER_ERROR;
  4636. /* Set the cipher suite from the message. */
  4637. ssl->options.cipherSuite0 = input[args->idx++];
  4638. ssl->options.cipherSuite = input[args->idx++];
  4639. #ifdef WOLFSSL_DEBUG_TLS
  4640. WOLFSSL_MSG("Chosen cipher suite:");
  4641. WOLFSSL_MSG(GetCipherNameInternal(ssl->options.cipherSuite0,
  4642. ssl->options.cipherSuite));
  4643. #endif
  4644. /* Compression */
  4645. b = input[args->idx++];
  4646. if (b != 0) {
  4647. WOLFSSL_MSG("Must be no compression types in list");
  4648. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4649. return INVALID_PARAMETER;
  4650. }
  4651. if ((args->idx - args->begin) + OPAQUE16_LEN > helloSz) {
  4652. if (!ssl->options.downgrade)
  4653. return BUFFER_ERROR;
  4654. #ifndef WOLFSSL_NO_TLS12
  4655. /* Force client hello version 1.2 to work for static RSA. */
  4656. ssl->chVersion.minor = TLSv1_2_MINOR;
  4657. ssl->version.minor = TLSv1_2_MINOR;
  4658. #ifdef WOLFSSL_DTLS13
  4659. if (ssl->options.dtls) {
  4660. ssl->chVersion.minor = DTLSv1_2_MINOR;
  4661. ssl->version.minor = DTLSv1_2_MINOR;
  4662. ret = Dtls13ClientDoDowngrade(ssl);
  4663. if (ret != 0)
  4664. return ret;
  4665. }
  4666. #endif /* WOLFSSL_DTLS13 */
  4667. #endif
  4668. ssl->options.haveEMS = 0;
  4669. if (args->pv.minor < ssl->options.minDowngrade) {
  4670. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4671. return VERSION_ERROR;
  4672. }
  4673. #ifndef WOLFSSL_NO_TLS12
  4674. return DoServerHello(ssl, input, inOutIdx, helloSz);
  4675. #else
  4676. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4677. return VERSION_ERROR;
  4678. #endif
  4679. }
  4680. if ((args->idx - args->begin) < helloSz) {
  4681. int foundVersion;
  4682. /* Get extension length and length check. */
  4683. if ((args->idx - args->begin) + OPAQUE16_LEN > helloSz)
  4684. return BUFFER_ERROR;
  4685. ato16(&input[args->idx], &args->totalExtSz);
  4686. args->idx += OPAQUE16_LEN;
  4687. if ((args->idx - args->begin) + args->totalExtSz > helloSz)
  4688. return BUFFER_ERROR;
  4689. /* Need to negotiate version first. */
  4690. if ((ret = TLSX_ParseVersion(ssl, input + args->idx,
  4691. args->totalExtSz, *extMsgType, &foundVersion))) {
  4692. return ret;
  4693. }
  4694. if (!foundVersion) {
  4695. if (!ssl->options.downgrade) {
  4696. WOLFSSL_MSG("Server trying to downgrade to version less than "
  4697. "TLS v1.3");
  4698. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4699. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4700. return VERSION_ERROR;
  4701. }
  4702. #if defined(OPENSSL_EXTRA) || defined(HAVE_WEBSERVER) || \
  4703. defined(WOLFSSL_WPAS_SMALL)
  4704. /* Check if client has disabled TLS 1.2 */
  4705. if (args->pv.minor == TLSv1_2_MINOR &&
  4706. (ssl->options.mask & SSL_OP_NO_TLSv1_2) == SSL_OP_NO_TLSv1_2) {
  4707. WOLFSSL_MSG("\tOption set to not allow TLSv1.2");
  4708. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4709. return VERSION_ERROR;
  4710. }
  4711. #endif
  4712. if (!ssl->options.dtls &&
  4713. args->pv.minor < ssl->options.minDowngrade) {
  4714. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4715. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4716. return VERSION_ERROR;
  4717. }
  4718. if (ssl->options.dtls &&
  4719. args->pv.minor > ssl->options.minDowngrade) {
  4720. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  4721. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4722. return VERSION_ERROR;
  4723. }
  4724. ssl->version.minor = args->pv.minor;
  4725. #ifdef WOLFSSL_DTLS13
  4726. if (ssl->options.dtls) {
  4727. ret = Dtls13ClientDoDowngrade(ssl);
  4728. if (ret != 0)
  4729. return ret;
  4730. }
  4731. #endif /* WOLFSSL_DTLS13 */
  4732. }
  4733. }
  4734. #ifdef WOLFSSL_DTLS13
  4735. /* we are sure that version is >= v1.3 now, we can get rid of buffered
  4736. * ClientHello that was buffered to re-compute the hash in case of
  4737. * downgrade */
  4738. if (ssl->options.dtls && ssl->dtls13ClientHello != NULL) {
  4739. XFREE(ssl->dtls13ClientHello, ssl->heap, DYNAMIC_TYPE_DTLS_MSG);
  4740. ssl->dtls13ClientHello = NULL;
  4741. ssl->dtls13ClientHelloSz = 0;
  4742. }
  4743. #endif /* WOLFSSL_DTLS13 */
  4744. /* Advance state and proceed */
  4745. ssl->options.asyncState = TLS_ASYNC_BUILD;
  4746. } /* case TLS_ASYNC_BEGIN */
  4747. FALL_THROUGH;
  4748. case TLS_ASYNC_BUILD:
  4749. case TLS_ASYNC_DO:
  4750. {
  4751. /* restore message type */
  4752. *extMsgType = args->extMsgType;
  4753. if (args->totalExtSz > 0) {
  4754. /* Parse and handle extensions. */
  4755. ret = TLSX_Parse(ssl, input + args->idx, args->totalExtSz,
  4756. *extMsgType, NULL);
  4757. if (ret != 0) {
  4758. #ifdef WOLFSSL_ASYNC_CRYPT
  4759. /* Handle async operation */
  4760. if (ret == WC_PENDING_E) {
  4761. /* Mark message as not received so it can process again */
  4762. ssl->msgsReceived.got_server_hello = 0;
  4763. }
  4764. #endif
  4765. return ret;
  4766. }
  4767. if (*extMsgType == hello_retry_request) {
  4768. /* Update counts to reflect change of message type. */
  4769. ssl->msgsReceived.got_hello_retry_request = 1;
  4770. ssl->msgsReceived.got_server_hello = 0;
  4771. }
  4772. args->idx += args->totalExtSz;
  4773. }
  4774. #ifdef WOLFSSL_DTLS_CID
  4775. if (ssl->options.useDtlsCID && *extMsgType == server_hello)
  4776. DtlsCIDOnExtensionsParsed(ssl);
  4777. #endif /* WOLFSSL_DTLS_CID */
  4778. *inOutIdx = args->idx;
  4779. ssl->options.serverState = SERVER_HELLO_COMPLETE;
  4780. #ifdef HAVE_SECRET_CALLBACK
  4781. if (ssl->sessionSecretCb != NULL
  4782. #ifdef HAVE_SESSION_TICKET
  4783. && ssl->session->ticketLen > 0
  4784. #endif
  4785. ) {
  4786. int secretSz = SECRET_LEN;
  4787. ret = ssl->sessionSecretCb(ssl, ssl->session->masterSecret,
  4788. &secretSz, ssl->sessionSecretCtx);
  4789. if (ret != 0 || secretSz != SECRET_LEN) {
  4790. WOLFSSL_ERROR_VERBOSE(SESSION_SECRET_CB_E);
  4791. return SESSION_SECRET_CB_E;
  4792. }
  4793. }
  4794. #endif /* HAVE_SECRET_CALLBACK */
  4795. /* Version only negotiated in extensions for TLS v1.3.
  4796. * Only now do we know how to deal with session id.
  4797. */
  4798. if (!IsAtLeastTLSv1_3(ssl->version)) {
  4799. #ifndef WOLFSSL_NO_TLS12
  4800. ssl->arrays->sessionIDSz = args->sessIdSz;
  4801. if (ssl->arrays->sessionIDSz > ID_LEN) {
  4802. WOLFSSL_MSG("Invalid session ID size");
  4803. ssl->arrays->sessionIDSz = 0;
  4804. return BUFFER_ERROR;
  4805. }
  4806. else if (ssl->arrays->sessionIDSz) {
  4807. XMEMCPY(ssl->arrays->sessionID, args->sessId,
  4808. ssl->arrays->sessionIDSz);
  4809. ssl->options.haveSessionId = 1;
  4810. }
  4811. /* Force client hello version 1.2 to work for static RSA. */
  4812. ssl->chVersion.minor = TLSv1_2_MINOR;
  4813. /* Complete TLS v1.2 processing of ServerHello. */
  4814. ret = CompleteServerHello(ssl);
  4815. #else
  4816. WOLFSSL_MSG("Client using higher version, fatal error");
  4817. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  4818. ret = VERSION_ERROR;
  4819. #endif
  4820. WOLFSSL_LEAVE("DoTls13ServerHello", ret);
  4821. return ret;
  4822. }
  4823. /* Advance state and proceed */
  4824. ssl->options.asyncState = TLS_ASYNC_FINALIZE;
  4825. } /* case TLS_ASYNC_BUILD || TLS_ASYNC_DO */
  4826. FALL_THROUGH;
  4827. case TLS_ASYNC_FINALIZE:
  4828. {
  4829. #ifdef WOLFSSL_TLS13_MIDDLEBOX_COMPAT
  4830. if (ssl->options.tls13MiddleBoxCompat) {
  4831. if (args->sessIdSz == 0) {
  4832. WOLFSSL_MSG("args->sessIdSz == 0");
  4833. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4834. return INVALID_PARAMETER;
  4835. }
  4836. if (ssl->session->sessionIDSz != 0) {
  4837. if (ssl->session->sessionIDSz != args->sessIdSz ||
  4838. XMEMCMP(ssl->session->sessionID, args->sessId,
  4839. args->sessIdSz) != 0) {
  4840. WOLFSSL_MSG("session id doesn't match");
  4841. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4842. return INVALID_PARAMETER;
  4843. }
  4844. }
  4845. else if (XMEMCMP(ssl->arrays->clientRandom, args->sessId,
  4846. args->sessIdSz) != 0) {
  4847. WOLFSSL_MSG("session id doesn't match client random");
  4848. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4849. return INVALID_PARAMETER;
  4850. }
  4851. }
  4852. else
  4853. #endif /* WOLFSSL_TLS13_MIDDLEBOX_COMPAT */
  4854. #ifdef WOLFSSL_QUIC
  4855. if (WOLFSSL_IS_QUIC(ssl)) {
  4856. if (args->sessIdSz != 0) {
  4857. WOLFSSL_MSG("args->sessIdSz != 0");
  4858. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4859. return INVALID_PARAMETER;
  4860. }
  4861. }
  4862. else
  4863. #endif /* WOLFSSL_QUIC */
  4864. if (args->sessIdSz != ssl->session->sessionIDSz || (args->sessIdSz > 0 &&
  4865. XMEMCMP(ssl->session->sessionID, args->sessId, args->sessIdSz) != 0))
  4866. {
  4867. WOLFSSL_MSG("Server sent different session id");
  4868. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4869. return INVALID_PARAMETER;
  4870. }
  4871. ret = SetCipherSpecs(ssl);
  4872. if (ret != 0)
  4873. return ret;
  4874. #if defined(HAVE_ECH)
  4875. /* check for acceptConfirmation and HashInput with 8 0 bytes */
  4876. if (ssl->options.useEch == 1) {
  4877. ret = EchCheckAcceptance(ssl, input, args->serverRandomOffset, helloSz);
  4878. if (ret != 0)
  4879. return ret;
  4880. }
  4881. #endif
  4882. #ifdef HAVE_NULL_CIPHER
  4883. if (ssl->options.cipherSuite0 == ECC_BYTE &&
  4884. (ssl->options.cipherSuite == TLS_SHA256_SHA256 ||
  4885. ssl->options.cipherSuite == TLS_SHA384_SHA384)) {
  4886. ;
  4887. }
  4888. else
  4889. #endif
  4890. #if defined(WOLFSSL_SM4_GCM) && defined(WOLFSSL_SM3)
  4891. if (ssl->options.cipherSuite0 == CIPHER_BYTE &&
  4892. ssl->options.cipherSuite == TLS_SM4_GCM_SM3) {
  4893. ; /* Do nothing. */
  4894. }
  4895. else
  4896. #endif
  4897. #if defined(WOLFSSL_SM4_CCM) && defined(WOLFSSL_SM3)
  4898. if (ssl->options.cipherSuite0 == CIPHER_BYTE &&
  4899. ssl->options.cipherSuite == TLS_SM4_CCM_SM3) {
  4900. ; /* Do nothing. */
  4901. }
  4902. else
  4903. #endif
  4904. /* Check that the negotiated ciphersuite matches protocol version. */
  4905. if (ssl->options.cipherSuite0 != TLS13_BYTE) {
  4906. WOLFSSL_MSG("Server sent non-TLS13 cipher suite in TLS 1.3 packet");
  4907. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  4908. return INVALID_PARAMETER;
  4909. }
  4910. suite[0] = ssl->options.cipherSuite0;
  4911. suite[1] = ssl->options.cipherSuite;
  4912. if (!FindSuiteSSL(ssl, suite)) {
  4913. WOLFSSL_MSG("Cipher suite not supported on client");
  4914. WOLFSSL_ERROR_VERBOSE(MATCH_SUITE_ERROR);
  4915. return MATCH_SUITE_ERROR;
  4916. }
  4917. if (*extMsgType == server_hello) {
  4918. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  4919. PreSharedKey* psk = NULL;
  4920. TLSX* ext = TLSX_Find(ssl->extensions, TLSX_PRE_SHARED_KEY);
  4921. if (ext != NULL)
  4922. psk = (PreSharedKey*)ext->data;
  4923. while (psk != NULL && !psk->chosen)
  4924. psk = psk->next;
  4925. if (psk == NULL) {
  4926. ssl->options.resuming = 0;
  4927. ssl->arrays->psk_keySz = 0;
  4928. XMEMSET(ssl->arrays->psk_key, 0, MAX_PSK_KEY_LEN);
  4929. }
  4930. else {
  4931. if ((ret = SetupPskKey(ssl, psk, 0)) != 0)
  4932. return ret;
  4933. ssl->options.pskNegotiated = 1;
  4934. }
  4935. #endif
  4936. /* sanity check on PSK / KSE */
  4937. if (
  4938. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  4939. ssl->options.pskNegotiated == 0 &&
  4940. #endif
  4941. ssl->session->namedGroup == 0) {
  4942. return EXT_MISSING;
  4943. }
  4944. ssl->keys.encryptionOn = 1;
  4945. ssl->options.serverState = SERVER_HELLO_COMPLETE;
  4946. }
  4947. else {
  4948. ssl->options.tls1_3 = 1;
  4949. ssl->options.serverState = SERVER_HELLO_RETRY_REQUEST_COMPLETE;
  4950. ret = RestartHandshakeHash(ssl);
  4951. }
  4952. break;
  4953. } /* case TLS_ASYNC_FINALIZE */
  4954. default:
  4955. ret = INPUT_CASE_ERROR;
  4956. } /* switch (ssl->options.asyncState) */
  4957. #ifdef WOLFSSL_ASYNC_CRYPT
  4958. if (ret == 0)
  4959. FreeAsyncCtx(ssl, 0);
  4960. #endif
  4961. WOLFSSL_LEAVE("DoTls13ServerHello", ret);
  4962. WOLFSSL_END(WC_FUNC_SERVER_HELLO_DO);
  4963. return ret;
  4964. }
  4965. /* handle processing TLS 1.3 encrypted_extensions (8) */
  4966. /* Parse and handle an EncryptedExtensions message.
  4967. * Only a client will receive this message.
  4968. *
  4969. * ssl The SSL/TLS object.
  4970. * input The message buffer.
  4971. * inOutIdx On entry, the index into the message buffer of
  4972. * EncryptedExtensions.
  4973. * On exit, the index of byte after the EncryptedExtensions
  4974. * message.
  4975. * totalSz The length of the current handshake message.
  4976. * returns 0 on success and otherwise failure.
  4977. */
  4978. static int DoTls13EncryptedExtensions(WOLFSSL* ssl, const byte* input,
  4979. word32* inOutIdx, word32 totalSz)
  4980. {
  4981. int ret;
  4982. word32 begin = *inOutIdx;
  4983. word32 i = begin;
  4984. word16 totalExtSz;
  4985. WOLFSSL_START(WC_FUNC_ENCRYPTED_EXTENSIONS_DO);
  4986. WOLFSSL_ENTER("DoTls13EncryptedExtensions");
  4987. #ifdef WOLFSSL_CALLBACKS
  4988. if (ssl->hsInfoOn) AddPacketName(ssl, "EncryptedExtensions");
  4989. if (ssl->toInfoOn) AddLateName("EncryptedExtensions", &ssl->timeoutInfo);
  4990. #endif
  4991. /* Length field of extension data. */
  4992. if (totalSz < OPAQUE16_LEN)
  4993. return BUFFER_ERROR;
  4994. ato16(&input[i], &totalExtSz);
  4995. i += OPAQUE16_LEN;
  4996. /* Extension data. */
  4997. if (i - begin + totalExtSz > totalSz)
  4998. return BUFFER_ERROR;
  4999. if ((ret = TLSX_Parse(ssl, input + i, totalExtSz, encrypted_extensions,
  5000. NULL))) {
  5001. return ret;
  5002. }
  5003. /* Move index to byte after message. */
  5004. *inOutIdx = i + totalExtSz;
  5005. /* Always encrypted. */
  5006. *inOutIdx += ssl->keys.padSz;
  5007. #ifdef WOLFSSL_EARLY_DATA
  5008. if (ssl->earlyData != no_early_data) {
  5009. TLSX* ext = TLSX_Find(ssl->extensions, TLSX_EARLY_DATA);
  5010. if (ext == NULL || !ext->val)
  5011. ssl->earlyData = no_early_data;
  5012. }
  5013. #endif
  5014. #ifdef WOLFSSL_EARLY_DATA
  5015. if (ssl->earlyData == no_early_data) {
  5016. ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY);
  5017. if (ret != 0)
  5018. return ret;
  5019. }
  5020. #endif
  5021. ssl->options.serverState = SERVER_ENCRYPTED_EXTENSIONS_COMPLETE;
  5022. WOLFSSL_LEAVE("DoTls13EncryptedExtensions", ret);
  5023. WOLFSSL_END(WC_FUNC_ENCRYPTED_EXTENSIONS_DO);
  5024. return ret;
  5025. }
  5026. #ifndef NO_CERTS
  5027. /* handle processing TLS v1.3 certificate_request (13) */
  5028. /* Handle a TLS v1.3 CertificateRequest message.
  5029. * This message is always encrypted.
  5030. * Only a client will receive this message.
  5031. *
  5032. * ssl The SSL/TLS object.
  5033. * input The message buffer.
  5034. * inOutIdx On entry, the index into the message buffer of CertificateRequest.
  5035. * On exit, the index of byte after the CertificateRequest message.
  5036. * size The length of the current handshake message.
  5037. * returns 0 on success and otherwise failure.
  5038. */
  5039. static int DoTls13CertificateRequest(WOLFSSL* ssl, const byte* input,
  5040. word32* inOutIdx, word32 size)
  5041. {
  5042. word16 len;
  5043. word32 begin = *inOutIdx;
  5044. int ret = 0;
  5045. Suites peerSuites;
  5046. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  5047. CertReqCtx* certReqCtx;
  5048. #endif
  5049. WOLFSSL_START(WC_FUNC_CERTIFICATE_REQUEST_DO);
  5050. WOLFSSL_ENTER("DoTls13CertificateRequest");
  5051. XMEMSET(&peerSuites, 0, sizeof(Suites));
  5052. #ifdef WOLFSSL_CALLBACKS
  5053. if (ssl->hsInfoOn) AddPacketName(ssl, "CertificateRequest");
  5054. if (ssl->toInfoOn) AddLateName("CertificateRequest", &ssl->timeoutInfo);
  5055. #endif
  5056. #ifdef OPENSSL_EXTRA
  5057. if ((ret = CertSetupCbWrapper(ssl)) != 0)
  5058. return ret;
  5059. #endif
  5060. if (OPAQUE8_LEN > size)
  5061. return BUFFER_ERROR;
  5062. /* Length of the request context. */
  5063. len = input[(*inOutIdx)++];
  5064. if ((*inOutIdx - begin) + len > size)
  5065. return BUFFER_ERROR;
  5066. if (ssl->options.connectState < FINISHED_DONE && len > 0)
  5067. return BUFFER_ERROR;
  5068. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  5069. /* CertReqCtx has one byte at end for context value.
  5070. * Increase size to handle other implementations sending more than one byte.
  5071. * That is, allocate extra space, over one byte, to hold the context value.
  5072. */
  5073. certReqCtx = (CertReqCtx*)XMALLOC(sizeof(CertReqCtx) + len - 1, ssl->heap,
  5074. DYNAMIC_TYPE_TMP_BUFFER);
  5075. if (certReqCtx == NULL)
  5076. return MEMORY_E;
  5077. certReqCtx->next = ssl->certReqCtx;
  5078. certReqCtx->len = len;
  5079. XMEMCPY(&certReqCtx->ctx, input + *inOutIdx, len);
  5080. ssl->certReqCtx = certReqCtx;
  5081. #endif
  5082. *inOutIdx += len;
  5083. /* TODO: Add support for more extensions:
  5084. * signed_certificate_timestamp, certificate_authorities, oid_filters.
  5085. */
  5086. /* Certificate extensions */
  5087. if ((*inOutIdx - begin) + OPAQUE16_LEN > size)
  5088. return BUFFER_ERROR;
  5089. ato16(input + *inOutIdx, &len);
  5090. *inOutIdx += OPAQUE16_LEN;
  5091. if ((*inOutIdx - begin) + len > size)
  5092. return BUFFER_ERROR;
  5093. if (len == 0)
  5094. return INVALID_PARAMETER;
  5095. if ((ret = TLSX_Parse(ssl, input + *inOutIdx, len, certificate_request,
  5096. &peerSuites))) {
  5097. return ret;
  5098. }
  5099. *inOutIdx += len;
  5100. if ((ssl->buffers.certificate && ssl->buffers.certificate->buffer &&
  5101. ((ssl->buffers.key && ssl->buffers.key->buffer)
  5102. #ifdef HAVE_PK_CALLBACKS
  5103. || wolfSSL_CTX_IsPrivatePkSet(ssl->ctx)
  5104. #endif
  5105. ))
  5106. #ifdef OPENSSL_EXTRA
  5107. || ssl->ctx->certSetupCb != NULL
  5108. #endif
  5109. ) {
  5110. if (PickHashSigAlgo(ssl, peerSuites.hashSigAlgo,
  5111. peerSuites.hashSigAlgoSz) != 0) {
  5112. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  5113. return INVALID_PARAMETER;
  5114. }
  5115. ssl->options.sendVerify = SEND_CERT;
  5116. }
  5117. else {
  5118. #ifndef WOLFSSL_NO_CLIENT_CERT_ERROR
  5119. ssl->options.sendVerify = SEND_BLANK_CERT;
  5120. #else
  5121. WOLFSSL_MSG("Certificate required but none set on client");
  5122. SendAlert(ssl, alert_fatal, illegal_parameter);
  5123. WOLFSSL_ERROR_VERBOSE(NO_CERT_ERROR);
  5124. return NO_CERT_ERROR;
  5125. #endif
  5126. }
  5127. /* This message is always encrypted so add encryption padding. */
  5128. *inOutIdx += ssl->keys.padSz;
  5129. WOLFSSL_LEAVE("DoTls13CertificateRequest", ret);
  5130. WOLFSSL_END(WC_FUNC_CERTIFICATE_REQUEST_DO);
  5131. return ret;
  5132. }
  5133. #endif /* !NO_CERTS */
  5134. #endif /* !NO_WOLFSSL_CLIENT */
  5135. #ifndef NO_WOLFSSL_SERVER
  5136. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  5137. /* Refine list of supported cipher suites to those common to server and client.
  5138. *
  5139. * ssl SSL/TLS object.
  5140. * peerSuites The peer's advertised list of supported cipher suites.
  5141. */
  5142. static void RefineSuites(WOLFSSL* ssl, Suites* peerSuites)
  5143. {
  5144. byte suites[WOLFSSL_MAX_SUITE_SZ];
  5145. word16 suiteSz = 0;
  5146. word16 i;
  5147. word16 j;
  5148. if (AllocateSuites(ssl) != 0)
  5149. return;
  5150. XMEMSET(suites, 0, sizeof(suites));
  5151. if (!ssl->options.useClientOrder) {
  5152. /* Server order refining. */
  5153. for (i = 0; i < ssl->suites->suiteSz; i += 2) {
  5154. for (j = 0; j < peerSuites->suiteSz; j += 2) {
  5155. if ((ssl->suites->suites[i+0] == peerSuites->suites[j+0]) &&
  5156. (ssl->suites->suites[i+1] == peerSuites->suites[j+1])) {
  5157. suites[suiteSz++] = peerSuites->suites[j+0];
  5158. suites[suiteSz++] = peerSuites->suites[j+1];
  5159. break;
  5160. }
  5161. }
  5162. if (suiteSz == WOLFSSL_MAX_SUITE_SZ)
  5163. break;
  5164. }
  5165. }
  5166. else {
  5167. /* Client order refining. */
  5168. for (j = 0; j < peerSuites->suiteSz; j += 2) {
  5169. for (i = 0; i < ssl->suites->suiteSz; i += 2) {
  5170. if ((ssl->suites->suites[i+0] == peerSuites->suites[j+0]) &&
  5171. (ssl->suites->suites[i+1] == peerSuites->suites[j+1])) {
  5172. suites[suiteSz++] = peerSuites->suites[j+0];
  5173. suites[suiteSz++] = peerSuites->suites[j+1];
  5174. break;
  5175. }
  5176. }
  5177. if (suiteSz == WOLFSSL_MAX_SUITE_SZ)
  5178. break;
  5179. }
  5180. }
  5181. ssl->suites->suiteSz = suiteSz;
  5182. XMEMCPY(ssl->suites->suites, &suites, sizeof(suites));
  5183. #ifdef WOLFSSL_DEBUG_TLS
  5184. {
  5185. int ii;
  5186. WOLFSSL_MSG("Refined Ciphers:");
  5187. for (ii = 0 ; ii < ssl->suites->suiteSz; ii += 2) {
  5188. WOLFSSL_MSG(GetCipherNameInternal(ssl->suites->suites[ii+0],
  5189. ssl->suites->suites[ii+1]));
  5190. }
  5191. }
  5192. #endif
  5193. }
  5194. #ifndef NO_PSK
  5195. int FindPskSuite(const WOLFSSL* ssl, PreSharedKey* psk, byte* psk_key,
  5196. word32* psk_keySz, const byte* suite, int* found, byte* foundSuite)
  5197. {
  5198. const char* cipherName = NULL;
  5199. byte cipherSuite0 = TLS13_BYTE;
  5200. byte cipherSuite = WOLFSSL_DEF_PSK_CIPHER;
  5201. int ret = 0;
  5202. *found = 0;
  5203. (void)suite;
  5204. if (ssl->options.server_psk_tls13_cb != NULL) {
  5205. *psk_keySz = ssl->options.server_psk_tls13_cb((WOLFSSL*)ssl,
  5206. (char*)psk->identity, psk_key, MAX_PSK_KEY_LEN, &cipherName);
  5207. if (*psk_keySz != 0) {
  5208. int cipherSuiteFlags = WOLFSSL_CIPHER_SUITE_FLAG_NONE;
  5209. *found = (GetCipherSuiteFromName(cipherName, &cipherSuite0,
  5210. &cipherSuite, &cipherSuiteFlags) == 0);
  5211. (void)cipherSuiteFlags;
  5212. }
  5213. }
  5214. if (*found == 0 && (ssl->options.server_psk_cb != NULL)) {
  5215. *psk_keySz = ssl->options.server_psk_cb((WOLFSSL*)ssl,
  5216. (char*)psk->identity, psk_key,
  5217. MAX_PSK_KEY_LEN);
  5218. *found = (*psk_keySz != 0);
  5219. }
  5220. if (*found) {
  5221. if (*psk_keySz > MAX_PSK_KEY_LEN &&
  5222. *((int*)psk_keySz) != USE_HW_PSK) {
  5223. WOLFSSL_MSG("Key len too long in FindPsk()");
  5224. ret = PSK_KEY_ERROR;
  5225. WOLFSSL_ERROR_VERBOSE(ret);
  5226. *found = 0;
  5227. }
  5228. if (ret == 0) {
  5229. #if !defined(WOLFSSL_PSK_ONE_ID) && !defined(WOLFSSL_PRIORITIZE_PSK)
  5230. /* Check whether PSK ciphersuite is in SSL. */
  5231. *found = (suite[0] == cipherSuite0) && (suite[1] == cipherSuite);
  5232. #else
  5233. (void)suite;
  5234. /* Check whether PSK ciphersuite is in SSL. */
  5235. {
  5236. byte s[2] = {
  5237. cipherSuite0,
  5238. cipherSuite,
  5239. };
  5240. *found = FindSuiteSSL(ssl, s);
  5241. }
  5242. #endif
  5243. }
  5244. }
  5245. if (*found && foundSuite != NULL) {
  5246. foundSuite[0] = cipherSuite0;
  5247. foundSuite[1] = cipherSuite;
  5248. }
  5249. return ret;
  5250. }
  5251. /* Attempt to find the PSK (not session ticket) that matches.
  5252. *
  5253. * @param [in, out] ssl The SSL/TLS object.
  5254. * @param [in] psk A pre-shared key from the extension.
  5255. * @param [out] suite Cipher suite to use with PSK.
  5256. * @param [out] err Error code.
  5257. * PSK_KEY_ERROR when key is too big or ticket age is
  5258. * invalid,
  5259. * UNSUPPORTED_SUITE on invalid suite.
  5260. * Other error when attempting to derive early secret.
  5261. * @return 1 when a match found - but check error code.
  5262. * @return 0 when no match found.
  5263. */
  5264. static int FindPsk(WOLFSSL* ssl, PreSharedKey* psk, const byte* suite, int* err)
  5265. {
  5266. int ret = 0;
  5267. int found = 0;
  5268. byte foundSuite[SUITE_LEN];
  5269. WOLFSSL_ENTER("FindPsk");
  5270. ret = FindPskSuite(ssl, psk, ssl->arrays->psk_key, &ssl->arrays->psk_keySz,
  5271. suite, &found, foundSuite);
  5272. if (ret == 0 && found) {
  5273. /* Default to ciphersuite if cb doesn't specify. */
  5274. ssl->options.resuming = 0;
  5275. /* Don't send certificate request when using PSK. */
  5276. ssl->options.verifyPeer = 0;
  5277. /* PSK age is always zero. */
  5278. if (psk->ticketAge != 0) {
  5279. ret = PSK_KEY_ERROR;
  5280. WOLFSSL_ERROR_VERBOSE(ret);
  5281. }
  5282. if (ret == 0) {
  5283. /* Set PSK ciphersuite into SSL. */
  5284. ssl->options.cipherSuite0 = foundSuite[0];
  5285. ssl->options.cipherSuite = foundSuite[1];
  5286. ret = SetCipherSpecs(ssl);
  5287. }
  5288. if (ret == 0) {
  5289. /* Derive the early secret using the PSK. */
  5290. ret = DeriveEarlySecret(ssl);
  5291. }
  5292. if (ret == 0) {
  5293. /* PSK negotiation has succeeded */
  5294. ssl->options.isPSK = 1;
  5295. /* SERVER: using PSK for peer authentication. */
  5296. ssl->options.peerAuthGood = 1;
  5297. }
  5298. }
  5299. *err = ret;
  5300. WOLFSSL_LEAVE("FindPsk", found);
  5301. WOLFSSL_LEAVE("FindPsk", ret);
  5302. return found;
  5303. }
  5304. #endif /* !NO_PSK */
  5305. /* Handle any Pre-Shared Key (PSK) extension.
  5306. * Find a PSK that supports the cipher suite passed in.
  5307. *
  5308. * ssl SSL/TLS object.
  5309. * suite Cipher suite to find PSK for.
  5310. * usingPSK 1=Indicates handshake is using Pre-Shared Keys (2=Ephemeral)
  5311. * first Set to 1 if first in extension
  5312. * returns 0 on success and otherwise failure.
  5313. */
  5314. static int DoPreSharedKeys(WOLFSSL* ssl, const byte* input, word32 inputSz,
  5315. const byte* suite, int* usingPSK, int* first)
  5316. {
  5317. int ret = 0;
  5318. TLSX* ext;
  5319. PreSharedKey* current;
  5320. byte binderKey[WC_MAX_DIGEST_SIZE];
  5321. byte binder[WC_MAX_DIGEST_SIZE];
  5322. word32 binderLen;
  5323. #ifdef NO_PSK
  5324. (void) suite; /* to avoid unused var warning when not used */
  5325. #endif
  5326. WOLFSSL_ENTER("DoPreSharedKeys");
  5327. (void)suite;
  5328. ext = TLSX_Find(ssl->extensions, TLSX_PRE_SHARED_KEY);
  5329. if (ext == NULL) {
  5330. WOLFSSL_MSG("No pre shared extension keys found");
  5331. return BAD_FUNC_ARG;
  5332. }
  5333. /* Look through all client's pre-shared keys for a match. */
  5334. for (current = (PreSharedKey*)ext->data; current != NULL;
  5335. current = current->next) {
  5336. #ifndef NO_PSK
  5337. if (current->identityLen > MAX_PSK_ID_LEN) {
  5338. return BUFFER_ERROR;
  5339. }
  5340. XMEMCPY(ssl->arrays->client_identity, current->identity,
  5341. current->identityLen);
  5342. ssl->arrays->client_identity[current->identityLen] = '\0';
  5343. #endif
  5344. #ifdef HAVE_SESSION_TICKET
  5345. /* Decode the identity. */
  5346. switch (current->decryptRet) {
  5347. case PSK_DECRYPT_NONE:
  5348. ret = DoClientTicket_ex(ssl, current, 1);
  5349. /* psk->sess may be set. Need to clean up later. */
  5350. break;
  5351. case PSK_DECRYPT_OK:
  5352. ret = WOLFSSL_TICKET_RET_OK;
  5353. break;
  5354. case PSK_DECRYPT_CREATE:
  5355. ret = WOLFSSL_TICKET_RET_CREATE;
  5356. break;
  5357. case PSK_DECRYPT_FAIL:
  5358. ret = WOLFSSL_TICKET_RET_REJECT;
  5359. break;
  5360. }
  5361. #ifdef WOLFSSL_ASYNC_CRYPT
  5362. if (ret == WC_PENDING_E)
  5363. return ret;
  5364. #endif
  5365. if (ret != WOLFSSL_TICKET_RET_OK && current->sess_free_cb != NULL) {
  5366. current->sess_free_cb(ssl, current->sess,
  5367. &current->sess_free_cb_ctx);
  5368. current->sess = NULL;
  5369. XMEMSET(&current->sess_free_cb_ctx, 0,
  5370. sizeof(psk_sess_free_cb_ctx));
  5371. }
  5372. if (ret == WOLFSSL_TICKET_RET_OK) {
  5373. ret = DoClientTicketCheck(ssl, current, ssl->timeout, suite);
  5374. if (ret == 0)
  5375. DoClientTicketFinalize(ssl, current->it, current->sess);
  5376. if (current->sess_free_cb != NULL) {
  5377. current->sess_free_cb(ssl, current->sess,
  5378. &current->sess_free_cb_ctx);
  5379. current->sess = NULL;
  5380. XMEMSET(&current->sess_free_cb_ctx, 0,
  5381. sizeof(psk_sess_free_cb_ctx));
  5382. }
  5383. if (ret != 0)
  5384. continue;
  5385. /* SERVER: using secret in session ticket for peer auth. */
  5386. ssl->options.peerAuthGood = 1;
  5387. #ifdef WOLFSSL_EARLY_DATA
  5388. ssl->options.maxEarlyDataSz = ssl->session->maxEarlyDataSz;
  5389. #endif
  5390. /* Use the same cipher suite as before and set up for use. */
  5391. ssl->options.cipherSuite0 = ssl->session->cipherSuite0;
  5392. ssl->options.cipherSuite = ssl->session->cipherSuite;
  5393. ret = SetCipherSpecs(ssl);
  5394. if (ret != 0)
  5395. return ret;
  5396. /* Resumption PSK is resumption master secret. */
  5397. ssl->arrays->psk_keySz = ssl->specs.hash_size;
  5398. if ((ret = DeriveResumptionPSK(ssl, ssl->session->ticketNonce.data,
  5399. ssl->session->ticketNonce.len, ssl->arrays->psk_key)) != 0) {
  5400. return ret;
  5401. }
  5402. /* Derive the early secret using the PSK. */
  5403. ret = DeriveEarlySecret(ssl);
  5404. if (ret != 0)
  5405. return ret;
  5406. /* Hash data up to binders for deriving binders in PSK extension. */
  5407. ret = HashInput(ssl, input, inputSz);
  5408. if (ret < 0)
  5409. return ret;
  5410. /* Derive the binder key to use with HMAC. */
  5411. ret = DeriveBinderKeyResume(ssl, binderKey);
  5412. if (ret != 0)
  5413. return ret;
  5414. }
  5415. else
  5416. #endif /* HAVE_SESSION_TICKET */
  5417. #ifndef NO_PSK
  5418. if (FindPsk(ssl, current, suite, &ret)) {
  5419. if (ret != 0)
  5420. return ret;
  5421. ret = HashInput(ssl, input, inputSz);
  5422. if (ret < 0)
  5423. return ret;
  5424. /* Derive the binder key to use with HMAC. */
  5425. ret = DeriveBinderKey(ssl, binderKey);
  5426. if (ret != 0)
  5427. return ret;
  5428. }
  5429. else
  5430. #endif
  5431. {
  5432. continue;
  5433. }
  5434. ssl->options.sendVerify = 0;
  5435. /* Derive the Finished message secret. */
  5436. ret = DeriveFinishedSecret(ssl, binderKey,
  5437. ssl->keys.client_write_MAC_secret,
  5438. 0 /* neither end */);
  5439. if (ret != 0)
  5440. return ret;
  5441. /* Derive the binder and compare with the one in the extension. */
  5442. ret = BuildTls13HandshakeHmac(ssl,
  5443. ssl->keys.client_write_MAC_secret, binder, &binderLen);
  5444. if (ret != 0)
  5445. return ret;
  5446. if (binderLen != current->binderLen ||
  5447. XMEMCMP(binder, current->binder, binderLen) != 0) {
  5448. WOLFSSL_ERROR_VERBOSE(BAD_BINDER);
  5449. return BAD_BINDER;
  5450. }
  5451. /* This PSK works, no need to try any more. */
  5452. current->chosen = 1;
  5453. ext->resp = 1;
  5454. break;
  5455. }
  5456. if (current == NULL) {
  5457. #ifdef WOLFSSL_PSK_ID_PROTECTION
  5458. #ifndef NO_CERTS
  5459. if (ssl->buffers.certChainCnt != 0)
  5460. return 0;
  5461. #endif
  5462. WOLFSSL_ERROR_VERBOSE(BAD_BINDER);
  5463. return BAD_BINDER;
  5464. #else
  5465. return 0;
  5466. #endif
  5467. }
  5468. *first = (current == ext->data);
  5469. *usingPSK = 1;
  5470. WOLFSSL_LEAVE("DoPreSharedKeys", ret);
  5471. return ret;
  5472. }
  5473. /* Handle any Pre-Shared Key (PSK) extension.
  5474. * Must do this in ClientHello as it requires a hash of the truncated message.
  5475. * Don't know size of binders until Pre-Shared Key extension has been parsed.
  5476. *
  5477. * ssl SSL/TLS object.
  5478. * input ClientHello message.
  5479. * helloSz Size of the ClientHello message (including binders if present).
  5480. * clSuites Client's cipher suite list.
  5481. * usingPSK Indicates handshake is using Pre-Shared Keys.
  5482. */
  5483. static int CheckPreSharedKeys(WOLFSSL* ssl, const byte* input, word32 helloSz,
  5484. Suites* clSuites, int* usingPSK)
  5485. {
  5486. int ret;
  5487. TLSX* ext;
  5488. word16 bindersLen;
  5489. int first = 0;
  5490. #ifndef WOLFSSL_PSK_ONE_ID
  5491. int i;
  5492. const Suites* suites;
  5493. #else
  5494. byte suite[2];
  5495. #endif
  5496. WOLFSSL_ENTER("CheckPreSharedKeys");
  5497. ext = TLSX_Find(ssl->extensions, TLSX_PRE_SHARED_KEY);
  5498. if (ext == NULL) {
  5499. #ifdef WOLFSSL_EARLY_DATA
  5500. ssl->earlyData = no_early_data;
  5501. #endif
  5502. if (usingPSK)
  5503. *usingPSK = 0;
  5504. /* Hash data up to binders for deriving binders in PSK extension. */
  5505. ret = HashInput(ssl, input, helloSz);
  5506. return ret;
  5507. }
  5508. /* Extensions pushed on stack/list and PSK must be last. */
  5509. if (ssl->extensions != ext) {
  5510. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  5511. return PSK_KEY_ERROR;
  5512. }
  5513. /* Assume we are going to resume with a pre-shared key. */
  5514. ssl->options.resuming = 1;
  5515. /* Find the pre-shared key extension and calculate hash of truncated
  5516. * ClientHello for binders.
  5517. */
  5518. ret = TLSX_PreSharedKey_GetSizeBinders((PreSharedKey*)ext->data,
  5519. client_hello, &bindersLen);
  5520. if (ret < 0)
  5521. return ret;
  5522. /* Refine list for PSK processing. */
  5523. RefineSuites(ssl, clSuites);
  5524. #ifndef WOLFSSL_PSK_ONE_ID
  5525. if (usingPSK == NULL)
  5526. return BAD_FUNC_ARG;
  5527. /* set after refineSuites, to avoid taking a stale ptr to ctx->Suites */
  5528. suites = WOLFSSL_SUITES(ssl);
  5529. /* Server list has only common suites from refining in server or client
  5530. * order. */
  5531. for (i = 0; !(*usingPSK) && i < suites->suiteSz; i += 2) {
  5532. ret = DoPreSharedKeys(ssl, input, helloSz - bindersLen,
  5533. suites->suites + i, usingPSK, &first);
  5534. if (ret != 0) {
  5535. #ifdef HAVE_SESSION_TICKET
  5536. #ifdef WOLFSSL_ASYNC_CRYPT
  5537. if (ret != WC_PENDING_E)
  5538. #endif
  5539. CleanupClientTickets((PreSharedKey*)ext->data);
  5540. #endif
  5541. WOLFSSL_MSG_EX("DoPreSharedKeys: %d", ret);
  5542. return ret;
  5543. }
  5544. }
  5545. #ifdef HAVE_SESSION_TICKET
  5546. CleanupClientTickets((PreSharedKey*)ext->data);
  5547. #endif
  5548. #else
  5549. ret = DoPreSharedKeys(ssl, input, helloSz - bindersLen, suite, usingPSK,
  5550. &first);
  5551. if (ret != 0) {
  5552. WOLFSSL_MSG_EX("DoPreSharedKeys: %d", ret);
  5553. return ret;
  5554. }
  5555. #endif
  5556. if (*usingPSK) {
  5557. /* While verifying the selected PSK, we updated the
  5558. * handshake hash up to the binder bytes in the PSK extensions.
  5559. * Continuing, we need the rest of the ClientHello hashed as well.
  5560. */
  5561. ret = HashRaw(ssl, input + helloSz - bindersLen, bindersLen);
  5562. }
  5563. else {
  5564. /* No suitable PSK found, Hash the complete ClientHello,
  5565. * as caller expect it after we return */
  5566. ret = HashInput(ssl, input, helloSz);
  5567. }
  5568. if (ret != 0)
  5569. return ret;
  5570. if (*usingPSK != 0) {
  5571. word16 modes;
  5572. #ifdef WOLFSSL_EARLY_DATA
  5573. TLSX* extEarlyData;
  5574. extEarlyData = TLSX_Find(ssl->extensions, TLSX_EARLY_DATA);
  5575. if (extEarlyData != NULL) {
  5576. /* Check if accepting early data and first PSK. */
  5577. if (ssl->earlyData != no_early_data && first) {
  5578. extEarlyData->resp = 1;
  5579. /* Derive early data decryption key. */
  5580. ret = DeriveTls13Keys(ssl, early_data_key, DECRYPT_SIDE_ONLY,
  5581. 1);
  5582. if (ret != 0)
  5583. return ret;
  5584. if ((ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY)) != 0)
  5585. return ret;
  5586. ssl->keys.encryptionOn = 1;
  5587. #ifdef WOLFSSL_DTLS13
  5588. if (ssl->options.dtls) {
  5589. ret = Dtls13NewEpoch(ssl,
  5590. w64From32(0x0, DTLS13_EPOCH_EARLYDATA),
  5591. DECRYPT_SIDE_ONLY);
  5592. if (ret != 0)
  5593. return ret;
  5594. }
  5595. #endif /* WOLFSSL_DTLS13 */
  5596. ssl->earlyData = process_early_data;
  5597. }
  5598. else
  5599. extEarlyData->resp = 0;
  5600. }
  5601. #endif
  5602. /* Get the PSK key exchange modes the client wants to negotiate. */
  5603. ext = TLSX_Find(ssl->extensions, TLSX_PSK_KEY_EXCHANGE_MODES);
  5604. if (ext == NULL) {
  5605. WOLFSSL_ERROR_VERBOSE(MISSING_HANDSHAKE_DATA);
  5606. return MISSING_HANDSHAKE_DATA;
  5607. }
  5608. modes = ext->val;
  5609. #ifdef HAVE_SUPPORTED_CURVES
  5610. ext = TLSX_Find(ssl->extensions, TLSX_KEY_SHARE);
  5611. /* Use (EC)DHE for forward-security if possible. */
  5612. if ((modes & (1 << PSK_DHE_KE)) != 0 && !ssl->options.noPskDheKe &&
  5613. ext != NULL) {
  5614. /* Only use named group used in last session. */
  5615. ssl->namedGroup = ssl->session->namedGroup;
  5616. *usingPSK = 2; /* generate new ephemeral key */
  5617. }
  5618. else if (ssl->options.onlyPskDheKe) {
  5619. return PSK_KEY_ERROR;
  5620. }
  5621. else
  5622. #endif
  5623. {
  5624. if ((modes & (1 << PSK_KE)) == 0) {
  5625. WOLFSSL_MSG("psk_ke mode does not allow key share");
  5626. WOLFSSL_ERROR_VERBOSE(PSK_KEY_ERROR);
  5627. return PSK_KEY_ERROR;
  5628. }
  5629. ssl->options.noPskDheKe = 1;
  5630. ssl->arrays->preMasterSz = 0;
  5631. *usingPSK = 1;
  5632. }
  5633. }
  5634. #ifdef WOLFSSL_PSK_ID_PROTECTION
  5635. else {
  5636. #ifndef NO_CERTS
  5637. if (ssl->buffers.certChainCnt != 0)
  5638. return 0;
  5639. #endif
  5640. WOLFSSL_ERROR_VERBOSE(BAD_BINDER);
  5641. return BAD_BINDER;
  5642. }
  5643. #endif
  5644. WOLFSSL_LEAVE("CheckPreSharedKeys", ret);
  5645. return 0;
  5646. }
  5647. #endif /* HAVE_SESSION_TICKET || !NO_PSK */
  5648. #if defined(WOLFSSL_SEND_HRR_COOKIE)
  5649. /* Check that the Cookie data's integrity.
  5650. *
  5651. * ssl SSL/TLS object.
  5652. * cookie The cookie data - hash and MAC.
  5653. * cookieSz The length of the cookie data in bytes.
  5654. * returns Length of the hash on success, otherwise failure.
  5655. */
  5656. int TlsCheckCookie(const WOLFSSL* ssl, const byte* cookie, word16 cookieSz)
  5657. {
  5658. int ret;
  5659. byte mac[WC_MAX_DIGEST_SIZE] = {0};
  5660. Hmac cookieHmac;
  5661. byte cookieType = 0;
  5662. byte macSz = 0;
  5663. if (ssl->buffers.tls13CookieSecret.buffer == NULL ||
  5664. ssl->buffers.tls13CookieSecret.length == 0) {
  5665. WOLFSSL_MSG("Missing DTLS 1.3 cookie secret");
  5666. return COOKIE_ERROR;
  5667. }
  5668. #if !defined(NO_SHA) && defined(NO_SHA256)
  5669. cookieType = SHA;
  5670. macSz = WC_SHA_DIGEST_SIZE;
  5671. #endif /* NO_SHA */
  5672. #ifndef NO_SHA256
  5673. cookieType = WC_SHA256;
  5674. macSz = WC_SHA256_DIGEST_SIZE;
  5675. #endif /* NO_SHA256 */
  5676. if (cookieSz < ssl->specs.hash_size + macSz)
  5677. return HRR_COOKIE_ERROR;
  5678. cookieSz -= macSz;
  5679. ret = wc_HmacInit(&cookieHmac, ssl->heap, INVALID_DEVID);
  5680. if (ret == 0) {
  5681. ret = wc_HmacSetKey(&cookieHmac, cookieType,
  5682. ssl->buffers.tls13CookieSecret.buffer,
  5683. ssl->buffers.tls13CookieSecret.length);
  5684. }
  5685. if (ret == 0)
  5686. ret = wc_HmacUpdate(&cookieHmac, cookie, cookieSz);
  5687. #ifdef WOLFSSL_DTLS13
  5688. /* Tie cookie to peer address */
  5689. if (ret == 0) {
  5690. if (ssl->options.dtls && ssl->buffers.dtlsCtx.peer.sz > 0) {
  5691. ret = wc_HmacUpdate(&cookieHmac,
  5692. (byte*)ssl->buffers.dtlsCtx.peer.sa,
  5693. ssl->buffers.dtlsCtx.peer.sz);
  5694. }
  5695. }
  5696. #endif
  5697. if (ret == 0)
  5698. ret = wc_HmacFinal(&cookieHmac, mac);
  5699. wc_HmacFree(&cookieHmac);
  5700. if (ret != 0)
  5701. return ret;
  5702. if (ConstantCompare(cookie + cookieSz, mac, macSz) != 0) {
  5703. WOLFSSL_ERROR_VERBOSE(HRR_COOKIE_ERROR);
  5704. return HRR_COOKIE_ERROR;
  5705. }
  5706. return cookieSz;
  5707. }
  5708. /* Length of the KeyShare Extension */
  5709. #define HRR_KEY_SHARE_SZ (OPAQUE16_LEN + OPAQUE16_LEN + OPAQUE16_LEN)
  5710. /* Length of the Supported Versions Extension */
  5711. #define HRR_VERSIONS_SZ (OPAQUE16_LEN + OPAQUE16_LEN + OPAQUE16_LEN)
  5712. /* Length of the Cookie Extension excluding cookie data */
  5713. #define HRR_COOKIE_HDR_SZ (OPAQUE16_LEN + OPAQUE16_LEN + OPAQUE16_LEN)
  5714. /* PV | Random | Session Id | CipherSuite | Compression | Ext Len */
  5715. #define HRR_BODY_SZ (VERSION_SZ + RAN_LEN + ENUM_LEN + ID_LEN + \
  5716. SUITE_LEN + COMP_LEN + OPAQUE16_LEN)
  5717. /* HH | PV | CipherSuite | Ext Len | Key Share | Supported Version | Cookie */
  5718. #define MAX_HRR_SZ (HRR_MAX_HS_HEADER_SZ + \
  5719. HRR_BODY_SZ + \
  5720. HRR_KEY_SHARE_SZ + \
  5721. HRR_VERSIONS_SZ + \
  5722. HRR_COOKIE_HDR_SZ)
  5723. /* Restart the handshake hash from the cookie value.
  5724. *
  5725. * ssl SSL/TLS object.
  5726. * cookie Cookie data from client.
  5727. * returns 0 on success, otherwise failure.
  5728. */
  5729. static int RestartHandshakeHashWithCookie(WOLFSSL* ssl, Cookie* cookie)
  5730. {
  5731. byte header[HANDSHAKE_HEADER_SZ] = {0};
  5732. byte hrr[MAX_HRR_SZ] = {0};
  5733. int hrrIdx;
  5734. word32 idx;
  5735. byte hashSz;
  5736. byte* cookieData;
  5737. word16 cookieDataSz;
  5738. word16 length;
  5739. int keyShareExt = 0;
  5740. int ret;
  5741. ret = TlsCheckCookie(ssl, cookie->data, (byte)cookie->len);
  5742. if (ret < 0)
  5743. return ret;
  5744. cookieDataSz = (word16)ret;
  5745. hashSz = cookie->data[0];
  5746. cookieData = cookie->data;
  5747. idx = OPAQUE8_LEN;
  5748. /* Restart handshake hash with synthetic message hash. */
  5749. AddTls13HandShakeHeader(header, hashSz, 0, 0, message_hash, ssl);
  5750. if ((ret = InitHandshakeHashes(ssl)) != 0)
  5751. return ret;
  5752. if ((ret = HashRaw(ssl, header, sizeof(header))) != 0)
  5753. return ret;
  5754. #ifdef WOLFSSL_DEBUG_TLS
  5755. WOLFSSL_MSG("Restart Hash from Cookie");
  5756. WOLFSSL_BUFFER(cookieData + idx, hashSz);
  5757. #endif
  5758. if ((ret = HashRaw(ssl, cookieData + idx, hashSz)) != 0)
  5759. return ret;
  5760. /* Reconstruct the HelloRetryMessage for handshake hash. */
  5761. length = HRR_BODY_SZ - ID_LEN + ssl->session->sessionIDSz +
  5762. HRR_COOKIE_HDR_SZ + cookie->len;
  5763. length += HRR_VERSIONS_SZ;
  5764. /* HashSz (1 byte) + Hash (HashSz bytes) + CipherSuite (2 bytes) */
  5765. if (cookieDataSz > OPAQUE8_LEN + hashSz + OPAQUE16_LEN) {
  5766. keyShareExt = 1;
  5767. length += HRR_KEY_SHARE_SZ;
  5768. }
  5769. AddTls13HandShakeHeader(hrr, length, 0, 0, server_hello, ssl);
  5770. idx += hashSz;
  5771. hrrIdx = HANDSHAKE_HEADER_SZ;
  5772. #ifdef WOLFSSL_DTLS13
  5773. if (ssl->options.dtls)
  5774. hrrIdx += DTLS_HANDSHAKE_EXTRA;
  5775. #endif /* WOLFSSL_DTLS13 */
  5776. /* The negotiated protocol version. */
  5777. hrr[hrrIdx++] = ssl->version.major;
  5778. hrr[hrrIdx++] = ssl->options.dtls ? DTLSv1_2_MINOR : TLSv1_2_MINOR;
  5779. /* HelloRetryRequest message has fixed value for random. */
  5780. XMEMCPY(hrr + hrrIdx, helloRetryRequestRandom, RAN_LEN);
  5781. hrrIdx += RAN_LEN;
  5782. hrr[hrrIdx++] = ssl->session->sessionIDSz;
  5783. if (ssl->session->sessionIDSz > 0) {
  5784. XMEMCPY(hrr + hrrIdx, ssl->session->sessionID, ssl->session->sessionIDSz);
  5785. hrrIdx += ssl->session->sessionIDSz;
  5786. }
  5787. /* Cipher Suite */
  5788. hrr[hrrIdx++] = cookieData[idx++];
  5789. hrr[hrrIdx++] = cookieData[idx++];
  5790. /* Compression not supported in TLS v1.3. */
  5791. hrr[hrrIdx++] = 0;
  5792. /* Extensions' length */
  5793. length -= HRR_BODY_SZ - ID_LEN + ssl->session->sessionIDSz;
  5794. c16toa(length, hrr + hrrIdx);
  5795. hrrIdx += 2;
  5796. /* Optional KeyShare Extension */
  5797. if (keyShareExt) {
  5798. c16toa(TLSX_KEY_SHARE, hrr + hrrIdx);
  5799. hrrIdx += 2;
  5800. c16toa(OPAQUE16_LEN, hrr + hrrIdx);
  5801. hrrIdx += 2;
  5802. hrr[hrrIdx++] = cookieData[idx++];
  5803. hrr[hrrIdx++] = cookieData[idx++];
  5804. }
  5805. c16toa(TLSX_SUPPORTED_VERSIONS, hrr + hrrIdx);
  5806. hrrIdx += 2;
  5807. c16toa(OPAQUE16_LEN, hrr + hrrIdx);
  5808. hrrIdx += 2;
  5809. #ifdef WOLFSSL_TLS13_DRAFT
  5810. hrr[hrrIdx++] = TLS_DRAFT_MAJOR;
  5811. hrr[hrrIdx++] = TLS_DRAFT_MINOR;
  5812. #else
  5813. hrr[hrrIdx++] = ssl->version.major;
  5814. hrr[hrrIdx++] = ssl->version.minor;
  5815. #endif
  5816. /* Mandatory Cookie Extension */
  5817. c16toa(TLSX_COOKIE, hrr + hrrIdx);
  5818. hrrIdx += 2;
  5819. c16toa(cookie->len + OPAQUE16_LEN, hrr + hrrIdx);
  5820. hrrIdx += 2;
  5821. c16toa(cookie->len, hrr + hrrIdx);
  5822. hrrIdx += 2;
  5823. #ifdef WOLFSSL_DEBUG_TLS
  5824. WOLFSSL_MSG("Reconstructed HelloRetryRequest");
  5825. WOLFSSL_BUFFER(hrr, hrrIdx);
  5826. WOLFSSL_MSG("Cookie");
  5827. WOLFSSL_BUFFER(cookieData, cookie->len);
  5828. #endif
  5829. #ifdef WOLFSSL_DTLS13
  5830. if (ssl->options.dtls) {
  5831. ret = Dtls13HashHandshake(ssl, hrr, (word16)hrrIdx);
  5832. }
  5833. else
  5834. #endif /* WOLFSSL_DTLS13 */
  5835. {
  5836. ret = HashRaw(ssl, hrr, hrrIdx);
  5837. }
  5838. if (ret != 0)
  5839. return ret;
  5840. return HashRaw(ssl, cookieData, cookie->len);
  5841. }
  5842. #endif
  5843. /* Do SupportedVersion extension for TLS v1.3+ otherwise it is not.
  5844. *
  5845. * ssl The SSL/TLS object.
  5846. * input The message buffer.
  5847. * i The index into the message buffer of ClientHello.
  5848. * helloSz The length of the current handshake message.
  5849. * returns 0 on success and otherwise failure.
  5850. */
  5851. static int DoTls13SupportedVersions(WOLFSSL* ssl, const byte* input, word32 i,
  5852. word32 helloSz, int* wantDowngrade)
  5853. {
  5854. int ret;
  5855. byte b;
  5856. word16 suiteSz;
  5857. word16 totalExtSz;
  5858. int foundVersion = 0;
  5859. /* Client random */
  5860. i += RAN_LEN;
  5861. /* Session id - not used in TLS v1.3 */
  5862. b = input[i++];
  5863. if (i + b > helloSz) {
  5864. return BUFFER_ERROR;
  5865. }
  5866. i += b;
  5867. #ifdef WOLFSSL_DTLS13
  5868. if (ssl->options.dtls) {
  5869. /* legacy_cookie - not used in DTLS v1.3 */
  5870. b = input[i++];
  5871. if (i + b > helloSz) {
  5872. return BUFFER_ERROR;
  5873. }
  5874. i += b;
  5875. }
  5876. #endif /* WOLFSSL_DTLS13 */
  5877. /* Cipher suites */
  5878. if (i + OPAQUE16_LEN > helloSz)
  5879. return BUFFER_ERROR;
  5880. ato16(input + i, &suiteSz);
  5881. i += OPAQUE16_LEN;
  5882. if (i + suiteSz + 1 > helloSz)
  5883. return BUFFER_ERROR;
  5884. i += suiteSz;
  5885. /* Compression */
  5886. b = input[i++];
  5887. if (i + b > helloSz)
  5888. return BUFFER_ERROR;
  5889. i += b;
  5890. /* TLS 1.3 must have extensions */
  5891. if (i < helloSz) {
  5892. if (i + OPAQUE16_LEN > helloSz)
  5893. return BUFFER_ERROR;
  5894. ato16(&input[i], &totalExtSz);
  5895. i += OPAQUE16_LEN;
  5896. if (totalExtSz != helloSz - i)
  5897. return BUFFER_ERROR;
  5898. /* Need to negotiate version first. */
  5899. if ((ret = TLSX_ParseVersion(ssl, input + i, totalExtSz, client_hello,
  5900. &foundVersion))) {
  5901. return ret;
  5902. }
  5903. }
  5904. *wantDowngrade = !foundVersion || !IsAtLeastTLSv1_3(ssl->version);
  5905. return 0;
  5906. }
  5907. /* Handle a ClientHello handshake message.
  5908. * If the protocol version in the message is not TLS v1.3 or higher, use
  5909. * DoClientHello()
  5910. * Only a server will receive this message.
  5911. *
  5912. * ssl The SSL/TLS object.
  5913. * input The message buffer.
  5914. * inOutIdx On entry, the index into the message buffer of ClientHello.
  5915. * On exit, the index of byte after the ClientHello message and
  5916. * padding.
  5917. * helloSz The length of the current handshake message.
  5918. * returns 0 on success and otherwise failure.
  5919. */
  5920. typedef struct Dch13Args {
  5921. ProtocolVersion pv;
  5922. Suites* clSuites;
  5923. word32 idx;
  5924. word32 begin;
  5925. int usingPSK;
  5926. } Dch13Args;
  5927. static void FreeDch13Args(WOLFSSL* ssl, void* pArgs)
  5928. {
  5929. Dch13Args* args = (Dch13Args*)pArgs;
  5930. (void)ssl;
  5931. if (args && args->clSuites) {
  5932. XFREE(args->clSuites, ssl->heap, DYNAMIC_TYPE_SUITES);
  5933. args->clSuites = NULL;
  5934. }
  5935. #ifdef OPENSSL_EXTRA
  5936. ssl->clSuites = NULL;
  5937. #endif
  5938. }
  5939. int DoTls13ClientHello(WOLFSSL* ssl, const byte* input, word32* inOutIdx,
  5940. word32 helloSz)
  5941. {
  5942. int ret;
  5943. #ifdef WOLFSSL_ASYNC_CRYPT
  5944. Dch13Args* args = NULL;
  5945. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  5946. #else
  5947. Dch13Args args[1];
  5948. #endif
  5949. #if defined(HAVE_ECH)
  5950. TLSX* echX = NULL;
  5951. #endif
  5952. WOLFSSL_START(WC_FUNC_CLIENT_HELLO_DO);
  5953. WOLFSSL_ENTER("DoTls13ClientHello");
  5954. #ifdef WOLFSSL_ASYNC_CRYPT
  5955. if (ssl->async == NULL) {
  5956. ssl->async = (struct WOLFSSL_ASYNC*)
  5957. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  5958. DYNAMIC_TYPE_ASYNC);
  5959. if (ssl->async == NULL)
  5960. ERROR_OUT(MEMORY_E, exit_dch);
  5961. }
  5962. args = (Dch13Args*)ssl->async->args;
  5963. ret = wolfSSL_AsyncPop(ssl, &ssl->options.asyncState);
  5964. if (ret != WC_NO_PENDING_E) {
  5965. /* Check for error */
  5966. if (ret < 0) {
  5967. goto exit_dch;
  5968. }
  5969. }
  5970. else
  5971. #endif
  5972. {
  5973. /* Reset state */
  5974. ret = VERSION_ERROR;
  5975. ssl->options.asyncState = TLS_ASYNC_BEGIN;
  5976. XMEMSET(args, 0, sizeof(Dch13Args));
  5977. #ifdef WOLFSSL_ASYNC_CRYPT
  5978. ssl->async->freeArgs = FreeDch13Args;
  5979. #endif
  5980. }
  5981. switch (ssl->options.asyncState) {
  5982. case TLS_ASYNC_BEGIN:
  5983. {
  5984. byte b;
  5985. byte sessIdSz;
  5986. int wantDowngrade = 0;
  5987. word16 totalExtSz = 0;
  5988. #ifdef WOLFSSL_CALLBACKS
  5989. if (ssl->hsInfoOn) AddPacketName(ssl, "ClientHello");
  5990. if (ssl->toInfoOn) AddLateName("ClientHello", &ssl->timeoutInfo);
  5991. #endif
  5992. /* do not change state in the SSL object before the next region of code
  5993. * to be able to statelessly compute a DTLS cookie */
  5994. #if defined(WOLFSSL_DTLS13) && defined(WOLFSSL_SEND_HRR_COOKIE)
  5995. /* Update the ssl->options.dtlsStateful setting `if` statement in
  5996. * wolfSSL_accept_TLSv13 when changing this one. */
  5997. if (IsDtlsNotSctpMode(ssl) && ssl->options.sendCookie &&
  5998. !ssl->options.dtlsStateful) {
  5999. DtlsSetSeqNumForReply(ssl);
  6000. ret = DoClientHelloStateless(ssl, input + *inOutIdx, helloSz, 0, NULL);
  6001. if (ret != 0 || !ssl->options.dtlsStateful) {
  6002. *inOutIdx += helloSz;
  6003. goto exit_dch;
  6004. }
  6005. if (ssl->chGoodCb != NULL) {
  6006. int cbret = ssl->chGoodCb(ssl, ssl->chGoodCtx);
  6007. if (cbret < 0) {
  6008. ssl->error = cbret;
  6009. WOLFSSL_MSG("ClientHello Good Cb don't continue error");
  6010. return WOLFSSL_FATAL_ERROR;
  6011. }
  6012. }
  6013. }
  6014. ssl->options.dtlsStateful = 1;
  6015. #endif /* WOLFSSL_DTLS */
  6016. args->idx = *inOutIdx;
  6017. args->begin = args->idx;
  6018. /* protocol version, random and session id length check */
  6019. if (OPAQUE16_LEN + RAN_LEN + OPAQUE8_LEN > helloSz) {
  6020. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6021. }
  6022. /* Protocol version */
  6023. XMEMCPY(&args->pv, input + args->idx, OPAQUE16_LEN);
  6024. ssl->chVersion = args->pv; /* store */
  6025. args->idx += OPAQUE16_LEN;
  6026. /* this check pass for DTLS Major (0xff) */
  6027. if (args->pv.major < SSLv3_MAJOR) {
  6028. WOLFSSL_MSG("Legacy version field contains unsupported value");
  6029. ERROR_OUT(VERSION_ERROR, exit_dch);
  6030. }
  6031. #ifdef WOLFSSL_DTLS13
  6032. if (ssl->options.dtls &&
  6033. args->pv.major == DTLS_MAJOR && args->pv.minor > DTLSv1_2_MINOR) {
  6034. wantDowngrade = 1;
  6035. ssl->version.minor = args->pv.minor;
  6036. }
  6037. #endif /* WOLFSSL_DTLS13 */
  6038. if (!ssl->options.dtls) {
  6039. /* Legacy protocol version cannot negotiate TLS 1.3 or higher. */
  6040. if (args->pv.major > SSLv3_MAJOR || (args->pv.major == SSLv3_MAJOR &&
  6041. args->pv.minor >= TLSv1_3_MINOR)) {
  6042. args->pv.major = SSLv3_MAJOR;
  6043. args->pv.minor = TLSv1_2_MINOR;
  6044. wantDowngrade = 1;
  6045. ssl->version.minor = args->pv.minor;
  6046. }
  6047. /* Legacy version must be [ SSLv3_MAJOR, TLSv1_2_MINOR ] for TLS v1.3 */
  6048. else if (args->pv.major == SSLv3_MAJOR &&
  6049. args->pv.minor < TLSv1_2_MINOR) {
  6050. wantDowngrade = 1;
  6051. ssl->version.minor = args->pv.minor;
  6052. }
  6053. }
  6054. if (!wantDowngrade) {
  6055. ret = DoTls13SupportedVersions(ssl, input + args->begin,
  6056. args->idx - args->begin, helloSz, &wantDowngrade);
  6057. if (ret < 0)
  6058. goto exit_dch;
  6059. }
  6060. if (wantDowngrade) {
  6061. #ifndef WOLFSSL_NO_TLS12
  6062. byte realMinor;
  6063. if (!ssl->options.downgrade) {
  6064. WOLFSSL_MSG("Client trying to connect with lesser version than "
  6065. "TLS v1.3");
  6066. ERROR_OUT(VERSION_ERROR, exit_dch);
  6067. }
  6068. if ((!ssl->options.dtls
  6069. && args->pv.minor < ssl->options.minDowngrade) ||
  6070. (ssl->options.dtls && args->pv.minor > ssl->options.minDowngrade)) {
  6071. WOLFSSL_MSG("\tversion below minimum allowed, fatal error");
  6072. ERROR_OUT(VERSION_ERROR, exit_dch);
  6073. }
  6074. realMinor = ssl->version.minor;
  6075. ssl->version.minor = args->pv.minor;
  6076. ret = HashInput(ssl, input + args->begin, helloSz);
  6077. ssl->version.minor = realMinor;
  6078. if (ret == 0) {
  6079. ret = DoClientHello(ssl, input, inOutIdx, helloSz);
  6080. }
  6081. goto exit_dch;
  6082. #else
  6083. WOLFSSL_MSG("Client trying to connect with lesser version than "
  6084. "TLS v1.3");
  6085. ERROR_OUT(VERSION_ERROR, exit_dch);
  6086. #endif
  6087. }
  6088. /* From here on we are a TLS 1.3 ClientHello. */
  6089. /* Client random */
  6090. XMEMCPY(ssl->arrays->clientRandom, input + args->idx, RAN_LEN);
  6091. args->idx += RAN_LEN;
  6092. #ifdef WOLFSSL_DEBUG_TLS
  6093. WOLFSSL_MSG("client random");
  6094. WOLFSSL_BUFFER(ssl->arrays->clientRandom, RAN_LEN);
  6095. #endif
  6096. sessIdSz = input[args->idx++];
  6097. #ifndef WOLFSSL_TLS13_MIDDLEBOX_COMPAT
  6098. if (sessIdSz > ID_LEN)
  6099. #else
  6100. if (sessIdSz != ID_LEN && sessIdSz != 0)
  6101. #endif
  6102. {
  6103. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6104. }
  6105. if (sessIdSz + args->idx > helloSz)
  6106. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6107. ssl->session->sessionIDSz = sessIdSz;
  6108. if (sessIdSz > 0)
  6109. XMEMCPY(ssl->session->sessionID, input + args->idx, sessIdSz);
  6110. args->idx += sessIdSz;
  6111. #ifdef WOLFSSL_DTLS13
  6112. /* legacy_cookie */
  6113. if (ssl->options.dtls) {
  6114. /* https://www.rfc-editor.org/rfc/rfc9147.html#section-5.3 */
  6115. byte cookieLen = input[args->idx++];
  6116. if (cookieLen != 0) {
  6117. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6118. }
  6119. }
  6120. #endif /* WOLFSSL_DTLS13 */
  6121. args->clSuites = (Suites*)XMALLOC(sizeof(Suites), ssl->heap,
  6122. DYNAMIC_TYPE_SUITES);
  6123. if (args->clSuites == NULL) {
  6124. ERROR_OUT(MEMORY_E, exit_dch);
  6125. }
  6126. /* Cipher suites */
  6127. if ((args->idx - args->begin) + OPAQUE16_LEN > helloSz)
  6128. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6129. ato16(&input[args->idx], &args->clSuites->suiteSz);
  6130. args->idx += OPAQUE16_LEN;
  6131. if ((args->clSuites->suiteSz % 2) != 0) {
  6132. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6133. }
  6134. /* suites and compression length check */
  6135. if ((args->idx - args->begin) + args->clSuites->suiteSz + OPAQUE8_LEN > helloSz)
  6136. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6137. if (args->clSuites->suiteSz > WOLFSSL_MAX_SUITE_SZ)
  6138. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6139. XMEMCPY(args->clSuites->suites, input + args->idx, args->clSuites->suiteSz);
  6140. args->idx += args->clSuites->suiteSz;
  6141. args->clSuites->hashSigAlgoSz = 0;
  6142. /* Compression */
  6143. b = input[args->idx++];
  6144. if ((args->idx - args->begin) + b > helloSz)
  6145. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6146. if (b != COMP_LEN) {
  6147. WOLFSSL_MSG("Must be one compression type in list");
  6148. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6149. }
  6150. b = input[args->idx++];
  6151. if (b != NO_COMPRESSION) {
  6152. WOLFSSL_MSG("Must be no compression type in list");
  6153. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6154. }
  6155. /* Extensions */
  6156. if ((args->idx - args->begin) == helloSz)
  6157. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6158. if ((args->idx - args->begin) + OPAQUE16_LEN > helloSz)
  6159. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6160. ato16(&input[args->idx], &totalExtSz);
  6161. args->idx += OPAQUE16_LEN;
  6162. if ((args->idx - args->begin) + totalExtSz > helloSz)
  6163. ERROR_OUT(BUFFER_ERROR, exit_dch);
  6164. /* Auto populate extensions supported unless user defined. */
  6165. if ((ret = TLSX_PopulateExtensions(ssl, 1)) != 0)
  6166. goto exit_dch;
  6167. #if defined(HAVE_ECH)
  6168. if (ssl->ctx->echConfigs != NULL) {
  6169. /* save the start of the buffer so we can use it when parsing ech */
  6170. echX = TLSX_Find(ssl->extensions, TLSX_ECH);
  6171. if (echX == NULL)
  6172. return -1;
  6173. ((WOLFSSL_ECH*)echX->data)->aad = input + HANDSHAKE_HEADER_SZ;
  6174. ((WOLFSSL_ECH*)echX->data)->aadLen = helloSz;
  6175. }
  6176. #endif
  6177. /* Parse extensions */
  6178. if ((ret = TLSX_Parse(ssl, input + args->idx, totalExtSz, client_hello,
  6179. args->clSuites))) {
  6180. goto exit_dch;
  6181. }
  6182. #if defined(HAVE_ECH)
  6183. /* jump to the end to clean things up */
  6184. if (echX != NULL && ((WOLFSSL_ECH*)echX->data)->state == ECH_WRITE_NONE)
  6185. goto exit_dch;
  6186. #endif
  6187. #ifdef HAVE_SNI
  6188. if ((ret = SNI_Callback(ssl)) != 0)
  6189. goto exit_dch;
  6190. ssl->options.side = WOLFSSL_SERVER_END;
  6191. #endif
  6192. args->idx += totalExtSz;
  6193. ssl->options.haveSessionId = 1;
  6194. ssl->options.sendVerify = SEND_CERT;
  6195. #if defined(WOLFSSL_SEND_HRR_COOKIE)
  6196. ssl->options.cookieGood = 0;
  6197. if (ssl->options.sendCookie &&
  6198. (ssl->options.serverState == SERVER_HELLO_RETRY_REQUEST_COMPLETE
  6199. #ifdef WOLFSSL_DTLS13
  6200. /* Always check for a valid cookie since we may have already
  6201. * sent a HRR but we reset the state. */
  6202. || ssl->options.dtls
  6203. #endif
  6204. )) {
  6205. TLSX* ext = TLSX_Find(ssl->extensions, TLSX_COOKIE);
  6206. if (ext != NULL) {
  6207. /* Ensure the cookie came from client and isn't the one in the
  6208. * response - HelloRetryRequest.
  6209. */
  6210. if (ext->resp == 0) {
  6211. ret = RestartHandshakeHashWithCookie(ssl, (Cookie*)ext->data);
  6212. if (ret != 0)
  6213. goto exit_dch;
  6214. /* Don't change state here as we may want to enter
  6215. * DoTls13ClientHello again. */
  6216. ssl->options.cookieGood = 1;
  6217. }
  6218. else {
  6219. ERROR_OUT(HRR_COOKIE_ERROR, exit_dch);
  6220. }
  6221. }
  6222. else {
  6223. #if defined(WOLFSSL_DTLS13) && defined(WOLFSSL_DTLS13_NO_HRR_ON_RESUME)
  6224. /* Don't error out as we may be resuming. We confirm this later. */
  6225. if (!ssl->options.dtls)
  6226. #endif
  6227. ERROR_OUT(HRR_COOKIE_ERROR, exit_dch);
  6228. }
  6229. }
  6230. #endif
  6231. #if (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)) && \
  6232. defined(HAVE_TLS_EXTENSIONS)
  6233. ret = CheckPreSharedKeys(ssl, input + args->begin, helloSz, args->clSuites,
  6234. &args->usingPSK);
  6235. if (ret != 0)
  6236. goto exit_dch;
  6237. #else
  6238. if ((ret = HashInput(ssl, input + args->begin, helloSz)) != 0)
  6239. goto exit_dch;
  6240. #endif
  6241. #if (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)) && \
  6242. defined(HAVE_TLS_EXTENSIONS)
  6243. if (!args->usingPSK)
  6244. #endif
  6245. {
  6246. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  6247. /* Not using PSK so don't require no KE. */
  6248. ssl->options.noPskDheKe = 0;
  6249. #endif
  6250. #ifndef NO_CERTS
  6251. if (TLSX_Find(ssl->extensions, TLSX_KEY_SHARE) == NULL) {
  6252. WOLFSSL_MSG("Client did not send a KeyShare extension");
  6253. ERROR_OUT(INCOMPLETE_DATA, exit_dch);
  6254. }
  6255. if (TLSX_Find(ssl->extensions, TLSX_SIGNATURE_ALGORITHMS) == NULL) {
  6256. WOLFSSL_MSG("Client did not send a SignatureAlgorithms extension");
  6257. ERROR_OUT(INCOMPLETE_DATA, exit_dch);
  6258. }
  6259. #else
  6260. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6261. #endif
  6262. }
  6263. #ifdef HAVE_ALPN
  6264. /* With PSK and all other things validated, it's time to
  6265. * select the ALPN protocol, if so requested */
  6266. if ((ret = ALPN_Select(ssl)) != 0)
  6267. goto exit_dch;
  6268. #endif
  6269. } /* case TLS_ASYNC_BEGIN */
  6270. FALL_THROUGH;
  6271. case TLS_ASYNC_BUILD:
  6272. /* Advance state and proceed */
  6273. ssl->options.asyncState = TLS_ASYNC_DO;
  6274. FALL_THROUGH;
  6275. case TLS_ASYNC_DO:
  6276. {
  6277. #ifdef OPENSSL_EXTRA
  6278. ssl->clSuites = args->clSuites;
  6279. if ((ret = CertSetupCbWrapper(ssl)) != 0)
  6280. goto exit_dch;
  6281. #endif
  6282. #ifndef NO_CERTS
  6283. if (!args->usingPSK) {
  6284. if ((ret = MatchSuite(ssl, args->clSuites)) < 0) {
  6285. #ifdef WOLFSSL_ASYNC_CRYPT
  6286. if (ret != WC_PENDING_E)
  6287. #endif
  6288. WOLFSSL_MSG("Unsupported cipher suite, ClientHello 1.3");
  6289. goto exit_dch;
  6290. }
  6291. }
  6292. #endif
  6293. #ifdef HAVE_SUPPORTED_CURVES
  6294. if (args->usingPSK == 2) {
  6295. /* Pick key share and Generate a new key if not present. */
  6296. int doHelloRetry = 0;
  6297. ret = TLSX_KeyShare_Establish(ssl, &doHelloRetry);
  6298. if (doHelloRetry) {
  6299. /* Make sure we don't send HRR twice */
  6300. if (ssl->options.serverState == SERVER_HELLO_RETRY_REQUEST_COMPLETE)
  6301. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6302. ssl->options.serverState = SERVER_HELLO_RETRY_REQUEST_COMPLETE;
  6303. if (ret != WC_PENDING_E)
  6304. ret = 0; /* for hello_retry return 0 */
  6305. }
  6306. if (ret != 0)
  6307. goto exit_dch;
  6308. }
  6309. #endif
  6310. /* Advance state and proceed */
  6311. ssl->options.asyncState = TLS_ASYNC_VERIFY;
  6312. } /* case TLS_ASYNC_BUILD || TLS_ASYNC_DO */
  6313. FALL_THROUGH;
  6314. case TLS_ASYNC_VERIFY:
  6315. {
  6316. #if defined(WOLFSSL_ASYNC_CRYPT) && defined(HAVE_SUPPORTED_CURVES)
  6317. /* Check if the KeyShare calculations from the previous state are complete.
  6318. * wolfSSL_AsyncPop advances ssl->options.asyncState so we may end up here
  6319. * with a pending calculation. */
  6320. TLSX* extension = TLSX_Find(ssl->extensions, TLSX_KEY_SHARE);
  6321. if (extension != NULL && extension->resp == 1) {
  6322. KeyShareEntry* serverKSE = (KeyShareEntry*)extension->data;
  6323. if (serverKSE != NULL && serverKSE->lastRet == WC_PENDING_E) {
  6324. ret = TLSX_KeyShare_GenKey(ssl, serverKSE);
  6325. if (ret != 0)
  6326. goto exit_dch;
  6327. }
  6328. }
  6329. #endif
  6330. /* Advance state and proceed */
  6331. ssl->options.asyncState = TLS_ASYNC_FINALIZE;
  6332. }
  6333. FALL_THROUGH;
  6334. case TLS_ASYNC_FINALIZE:
  6335. {
  6336. *inOutIdx = args->idx;
  6337. ssl->options.clientState = CLIENT_HELLO_COMPLETE;
  6338. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  6339. ssl->options.pskNegotiated = (args->usingPSK != 0);
  6340. #endif
  6341. if (!args->usingPSK) {
  6342. #ifndef NO_CERTS
  6343. /* Check that the negotiated ciphersuite matches protocol version. */
  6344. #ifdef HAVE_NULL_CIPHER
  6345. if (ssl->options.cipherSuite0 == ECC_BYTE &&
  6346. (ssl->options.cipherSuite == TLS_SHA256_SHA256 ||
  6347. ssl->options.cipherSuite == TLS_SHA384_SHA384)) {
  6348. ;
  6349. }
  6350. else
  6351. #endif
  6352. #if defined(WOLFSSL_SM4_GCM) && defined(WOLFSSL_SM3)
  6353. if (ssl->options.cipherSuite0 == CIPHER_BYTE &&
  6354. ssl->options.cipherSuite == TLS_SM4_GCM_SM3) {
  6355. ; /* Do nothing. */
  6356. }
  6357. else
  6358. #endif
  6359. #if defined(WOLFSSL_SM4_CCM) && defined(WOLFSSL_SM3)
  6360. if (ssl->options.cipherSuite0 == CIPHER_BYTE &&
  6361. ssl->options.cipherSuite == TLS_SM4_CCM_SM3) {
  6362. ; /* Do nothing. */
  6363. }
  6364. else
  6365. #endif
  6366. if (ssl->options.cipherSuite0 != TLS13_BYTE) {
  6367. WOLFSSL_MSG("Negotiated ciphersuite from lesser version than "
  6368. "TLS v1.3");
  6369. ERROR_OUT(MATCH_SUITE_ERROR, exit_dch);
  6370. }
  6371. #ifdef HAVE_SESSION_TICKET
  6372. if (ssl->options.resuming) {
  6373. ssl->options.resuming = 0;
  6374. ssl->arrays->psk_keySz = 0;
  6375. XMEMSET(ssl->arrays->psk_key, 0, ssl->specs.hash_size);
  6376. }
  6377. #endif
  6378. /* Derive early secret for handshake secret. */
  6379. if ((ret = DeriveEarlySecret(ssl)) != 0)
  6380. goto exit_dch;
  6381. #endif /* !NO_CERTS */
  6382. }
  6383. break;
  6384. } /* case TLS_ASYNC_FINALIZE */
  6385. default:
  6386. ret = INPUT_CASE_ERROR;
  6387. } /* switch (ssl->options.asyncState) */
  6388. #ifdef WOLFSSL_SEND_HRR_COOKIE
  6389. if (ret == 0 && ssl->options.sendCookie) {
  6390. if (ssl->options.cookieGood &&
  6391. ssl->options.acceptState == TLS13_ACCEPT_FIRST_REPLY_DONE) {
  6392. /* Processing second ClientHello. Clear HRR state. */
  6393. ssl->options.serverState = NULL_STATE;
  6394. }
  6395. if (ssl->options.cookieGood &&
  6396. ssl->options.serverState == SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  6397. /* If we already verified the peer with a cookie then we can't
  6398. * do another HRR for cipher negotiation. Send alert and restart
  6399. * the entire handshake. */
  6400. ERROR_OUT(INVALID_PARAMETER, exit_dch);
  6401. }
  6402. #ifdef WOLFSSL_DTLS13
  6403. if (ssl->options.dtls &&
  6404. ssl->options.serverState == SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  6405. /* Cookie and key share negotiation should be handled in
  6406. * DoClientHelloStateless. If we enter here then something went
  6407. * wrong in our logic. */
  6408. ERROR_OUT(BAD_HELLO, exit_dch);
  6409. }
  6410. #endif
  6411. /* Send a cookie */
  6412. if (!ssl->options.cookieGood &&
  6413. ssl->options.serverState != SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  6414. #ifdef WOLFSSL_DTLS13
  6415. if (ssl->options.dtls) {
  6416. #ifdef WOLFSSL_DTLS13_NO_HRR_ON_RESUME
  6417. /* We can skip cookie on resumption */
  6418. if (!ssl->options.dtls || !ssl->options.dtls13NoHrrOnResume ||
  6419. !args->usingPSK)
  6420. #endif
  6421. ERROR_OUT(BAD_HELLO, exit_dch);
  6422. }
  6423. else
  6424. #endif
  6425. {
  6426. /* Need to remove the keyshare ext if we found a common group
  6427. * and are not doing curve negotiation. */
  6428. TLSX_Remove(&ssl->extensions, TLSX_KEY_SHARE, ssl->heap);
  6429. ssl->options.serverState = SERVER_HELLO_RETRY_REQUEST_COMPLETE;
  6430. }
  6431. }
  6432. }
  6433. #endif /* WOLFSSL_DTLS13 */
  6434. #ifdef WOLFSSL_DTLS_CID
  6435. /* do not modify CID state if we are sending an HRR */
  6436. if (ret == 0 && ssl->options.dtls && ssl->options.useDtlsCID &&
  6437. ssl->options.serverState != SERVER_HELLO_RETRY_REQUEST_COMPLETE)
  6438. DtlsCIDOnExtensionsParsed(ssl);
  6439. #endif /* WOLFSSL_DTLS_CID */
  6440. exit_dch:
  6441. WOLFSSL_LEAVE("DoTls13ClientHello", ret);
  6442. #ifdef WOLFSSL_ASYNC_CRYPT
  6443. if (ret == WC_PENDING_E) {
  6444. ssl->msgsReceived.got_client_hello = 0;
  6445. return ret;
  6446. }
  6447. #endif
  6448. FreeDch13Args(ssl, args);
  6449. #ifdef WOLFSSL_ASYNC_CRYPT
  6450. FreeAsyncCtx(ssl, 0);
  6451. #endif
  6452. WOLFSSL_END(WC_FUNC_CLIENT_HELLO_DO);
  6453. if (ret != 0) {
  6454. WOLFSSL_ERROR_VERBOSE(ret);
  6455. }
  6456. #if defined(HAVE_ECH)
  6457. if (ret == 0 && echX != NULL &&
  6458. ((WOLFSSL_ECH*)echX->data)->state == ECH_WRITE_NONE) {
  6459. /* add the header to the inner hello */
  6460. AddTls13HandShakeHeader(((WOLFSSL_ECH*)echX->data)->innerClientHello,
  6461. ((WOLFSSL_ECH*)echX->data)->innerClientHelloLen, 0, 0,
  6462. client_hello, ssl);
  6463. }
  6464. #endif
  6465. return ret;
  6466. }
  6467. /* Send TLS v1.3 ServerHello message to client.
  6468. * Only a server will send this message.
  6469. *
  6470. * ssl The SSL/TLS object.
  6471. * returns 0 on success, otherwise failure.
  6472. */
  6473. /* handle generation of TLS 1.3 server_hello (2) */
  6474. int SendTls13ServerHello(WOLFSSL* ssl, byte extMsgType)
  6475. {
  6476. int ret;
  6477. byte* output;
  6478. word16 length;
  6479. word32 idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  6480. int sendSz;
  6481. #if defined(HAVE_ECH)
  6482. TLSX* echX = NULL;
  6483. word32 serverRandomOffset;
  6484. #endif
  6485. WOLFSSL_START(WC_FUNC_SERVER_HELLO_SEND);
  6486. WOLFSSL_ENTER("SendTls13ServerHello");
  6487. /* When ssl->options.dtlsStateful is not set then cookie is calculated in
  6488. * dtls.c */
  6489. if (extMsgType == hello_retry_request
  6490. #ifdef WOLFSSL_DTLS13
  6491. && (!ssl->options.dtls || ssl->options.dtlsStateful)
  6492. #endif
  6493. ) {
  6494. WOLFSSL_MSG("wolfSSL Sending HelloRetryRequest");
  6495. if ((ret = RestartHandshakeHash(ssl)) < 0)
  6496. return ret;
  6497. }
  6498. ssl->options.buildingMsg = 1;
  6499. #ifdef WOLFSSL_DTLS13
  6500. if (ssl->options.dtls)
  6501. idx = DTLS_RECORD_HEADER_SZ + DTLS_HANDSHAKE_HEADER_SZ;
  6502. #endif /* WOLFSSL_DTLS13 */
  6503. /* Protocol version, server random, session id, cipher suite, compression
  6504. * and extensions.
  6505. */
  6506. length = VERSION_SZ + RAN_LEN + ENUM_LEN + ssl->session->sessionIDSz +
  6507. SUITE_LEN + COMP_LEN;
  6508. ret = TLSX_GetResponseSize(ssl, extMsgType, &length);
  6509. if (ret != 0)
  6510. return ret;
  6511. sendSz = idx + length;
  6512. /* Check buffers are big enough and grow if needed. */
  6513. if ((ret = CheckAvailableSize(ssl, sendSz)) != 0)
  6514. return ret;
  6515. /* Get position in output buffer to write new message to. */
  6516. output = GetOutputBuffer(ssl);
  6517. /* Put the record and handshake headers on. */
  6518. AddTls13Headers(output, length, server_hello, ssl);
  6519. /* The protocol version must be TLS v1.2 for middleboxes. */
  6520. output[idx++] = ssl->version.major;
  6521. output[idx++] = ssl->options.dtls ? DTLSv1_2_MINOR : TLSv1_2_MINOR;
  6522. if (extMsgType == server_hello) {
  6523. /* Generate server random. */
  6524. if ((ret = wc_RNG_GenerateBlock(ssl->rng, output + idx, RAN_LEN)) != 0)
  6525. return ret;
  6526. }
  6527. else {
  6528. /* HelloRetryRequest message has fixed value for random. */
  6529. XMEMCPY(output + idx, helloRetryRequestRandom, RAN_LEN);
  6530. }
  6531. #if defined(HAVE_ECH)
  6532. serverRandomOffset = idx;
  6533. #endif
  6534. /* Store in SSL for debugging. */
  6535. XMEMCPY(ssl->arrays->serverRandom, output + idx, RAN_LEN);
  6536. idx += RAN_LEN;
  6537. #ifdef WOLFSSL_DEBUG_TLS
  6538. WOLFSSL_MSG("Server random");
  6539. WOLFSSL_BUFFER(ssl->arrays->serverRandom, RAN_LEN);
  6540. #endif
  6541. output[idx++] = ssl->session->sessionIDSz;
  6542. if (ssl->session->sessionIDSz > 0) {
  6543. XMEMCPY(output + idx, ssl->session->sessionID, ssl->session->sessionIDSz);
  6544. idx += ssl->session->sessionIDSz;
  6545. }
  6546. /* Chosen cipher suite */
  6547. output[idx++] = ssl->options.cipherSuite0;
  6548. output[idx++] = ssl->options.cipherSuite;
  6549. #ifdef WOLFSSL_DEBUG_TLS
  6550. WOLFSSL_MSG("Chosen cipher suite:");
  6551. WOLFSSL_MSG(GetCipherNameInternal(ssl->options.cipherSuite0,
  6552. ssl->options.cipherSuite));
  6553. #endif
  6554. /* Compression not supported in TLS v1.3. */
  6555. output[idx++] = 0;
  6556. /* Extensions */
  6557. ret = TLSX_WriteResponse(ssl, output + idx, extMsgType, NULL);
  6558. if (ret != 0)
  6559. return ret;
  6560. #ifdef WOLFSSL_SEND_HRR_COOKIE
  6561. if (ssl->options.sendCookie && extMsgType == hello_retry_request) {
  6562. /* Reset the hashes from here. We will be able to restart the hashes
  6563. * from the cookie in RestartHandshakeHashWithCookie */
  6564. #ifdef WOLFSSL_DTLS13
  6565. /* When ssl->options.dtlsStateful is not set then cookie is calculated
  6566. * in dtls.c */
  6567. if (ssl->options.dtls && !ssl->options.dtlsStateful)
  6568. ret = 0;
  6569. else
  6570. #endif
  6571. ret = InitHandshakeHashes(ssl);
  6572. }
  6573. else
  6574. #endif
  6575. {
  6576. #ifdef WOLFSSL_DTLS13
  6577. if (ssl->options.dtls) {
  6578. ret = Dtls13HashHandshake(
  6579. ssl,
  6580. output + Dtls13GetRlHeaderLength(ssl, 0) ,
  6581. (word16)sendSz - Dtls13GetRlHeaderLength(ssl, 0));
  6582. }
  6583. else
  6584. #endif /* WOLFSSL_DTLS13 */
  6585. {
  6586. #if defined(HAVE_ECH)
  6587. if (ssl->ctx->echConfigs != NULL) {
  6588. echX = TLSX_Find(ssl->extensions, TLSX_ECH);
  6589. if (echX == NULL)
  6590. return -1;
  6591. /* replace the last 8 bytes of server random with the accept */
  6592. if (((WOLFSSL_ECH*)echX->data)->state == ECH_PARSED_INTERNAL) {
  6593. ret = EchWriteAcceptance(ssl, output + RECORD_HEADER_SZ,
  6594. serverRandomOffset - RECORD_HEADER_SZ,
  6595. sendSz - RECORD_HEADER_SZ);
  6596. /* remove ech so we don't keep sending it in write */
  6597. TLSX_Remove(&ssl->extensions, TLSX_ECH, ssl->heap);
  6598. }
  6599. }
  6600. #endif
  6601. if (ret == 0)
  6602. ret = HashOutput(ssl, output, sendSz, 0);
  6603. }
  6604. }
  6605. if (ret != 0)
  6606. return ret;
  6607. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  6608. if (ssl->hsInfoOn)
  6609. AddPacketName(ssl, "ServerHello");
  6610. if (ssl->toInfoOn) {
  6611. ret = AddPacketInfo(ssl, "ServerHello", handshake, output, sendSz,
  6612. WRITE_PROTO, 0, ssl->heap);
  6613. if (ret != 0)
  6614. return ret;
  6615. }
  6616. #endif
  6617. if (extMsgType == server_hello)
  6618. ssl->options.serverState = SERVER_HELLO_COMPLETE;
  6619. ssl->options.buildingMsg = 0;
  6620. #ifdef WOLFSSL_DTLS13
  6621. if (ssl->options.dtls) {
  6622. ret = Dtls13HandshakeSend(ssl, output, (word16)sendSz, (word16)sendSz,
  6623. (enum HandShakeType)extMsgType, 0);
  6624. WOLFSSL_LEAVE("SendTls13ServerHello", ret);
  6625. WOLFSSL_END(WC_FUNC_SERVER_HELLO_SEND);
  6626. return ret;
  6627. }
  6628. #endif /* WOLFSSL_DTLS13 */
  6629. ssl->buffers.outputBuffer.length += sendSz;
  6630. if (!ssl->options.groupMessages || extMsgType != server_hello)
  6631. ret = SendBuffered(ssl);
  6632. WOLFSSL_LEAVE("SendTls13ServerHello", ret);
  6633. WOLFSSL_END(WC_FUNC_SERVER_HELLO_SEND);
  6634. return ret;
  6635. }
  6636. /* handle generation of TLS 1.3 encrypted_extensions (8) */
  6637. /* Send the rest of the extensions encrypted under the handshake key.
  6638. * This message is always encrypted in TLS v1.3.
  6639. * Only a server will send this message.
  6640. *
  6641. * ssl The SSL/TLS object.
  6642. * returns 0 on success, otherwise failure.
  6643. */
  6644. static int SendTls13EncryptedExtensions(WOLFSSL* ssl)
  6645. {
  6646. int ret;
  6647. byte* output;
  6648. word16 length = 0;
  6649. word32 idx;
  6650. int sendSz;
  6651. WOLFSSL_START(WC_FUNC_ENCRYPTED_EXTENSIONS_SEND);
  6652. WOLFSSL_ENTER("SendTls13EncryptedExtensions");
  6653. ssl->options.buildingMsg = 1;
  6654. ssl->keys.encryptionOn = 1;
  6655. #ifdef WOLFSSL_DTLS13
  6656. if (ssl->options.dtls) {
  6657. idx = Dtls13GetHeadersLength(ssl, encrypted_extensions);
  6658. }
  6659. else
  6660. #endif /* WOLFSSL_DTLS13 */
  6661. {
  6662. idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  6663. }
  6664. #if defined(HAVE_SUPPORTED_CURVES) && !defined(WOLFSSL_NO_SERVER_GROUPS_EXT)
  6665. if ((ret = TLSX_SupportedCurve_CheckPriority(ssl)) != 0)
  6666. return ret;
  6667. #endif
  6668. /* Derive the handshake secret now that we are at first message to be
  6669. * encrypted under the keys.
  6670. */
  6671. if ((ret = DeriveHandshakeSecret(ssl)) != 0)
  6672. return ret;
  6673. if ((ret = DeriveTls13Keys(ssl, handshake_key,
  6674. ENCRYPT_AND_DECRYPT_SIDE, 1)) != 0)
  6675. return ret;
  6676. /* Setup encrypt/decrypt keys for following messages. */
  6677. #ifdef WOLFSSL_EARLY_DATA
  6678. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  6679. return ret;
  6680. if (ssl->earlyData != process_early_data) {
  6681. if ((ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY)) != 0)
  6682. return ret;
  6683. }
  6684. #else
  6685. if ((ret = SetKeysSide(ssl, ENCRYPT_AND_DECRYPT_SIDE)) != 0)
  6686. return ret;
  6687. #endif
  6688. #ifdef WOLFSSL_QUIC
  6689. if (IsAtLeastTLSv1_3(ssl->version) && WOLFSSL_IS_QUIC(ssl)) {
  6690. ret = wolfSSL_quic_add_transport_extensions(ssl, encrypted_extensions);
  6691. if (ret != 0)
  6692. return ret;
  6693. }
  6694. #endif
  6695. #ifdef WOLFSSL_DTLS13
  6696. if (ssl->options.dtls) {
  6697. w64wrapper epochHandshake = w64From32(0, DTLS13_EPOCH_HANDSHAKE);
  6698. ssl->dtls13Epoch = epochHandshake;
  6699. ret = Dtls13NewEpoch(
  6700. ssl, epochHandshake, ENCRYPT_AND_DECRYPT_SIDE);
  6701. if (ret != 0)
  6702. return ret;
  6703. ret = Dtls13SetEpochKeys(
  6704. ssl, epochHandshake, ENCRYPT_AND_DECRYPT_SIDE);
  6705. if (ret != 0)
  6706. return ret;
  6707. }
  6708. #endif /* WOLFSSL_DTLS13 */
  6709. ret = TLSX_GetResponseSize(ssl, encrypted_extensions, &length);
  6710. if (ret != 0)
  6711. return ret;
  6712. sendSz = idx + length;
  6713. /* Encryption always on. */
  6714. sendSz += MAX_MSG_EXTRA;
  6715. /* Check buffers are big enough and grow if needed. */
  6716. ret = CheckAvailableSize(ssl, sendSz);
  6717. if (ret != 0)
  6718. return ret;
  6719. /* Get position in output buffer to write new message to. */
  6720. output = GetOutputBuffer(ssl);
  6721. /* Put the record and handshake headers on. */
  6722. AddTls13Headers(output, length, encrypted_extensions, ssl);
  6723. ret = TLSX_WriteResponse(ssl, output + idx, encrypted_extensions, NULL);
  6724. if (ret != 0)
  6725. return ret;
  6726. idx += length;
  6727. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  6728. if (ssl->hsInfoOn)
  6729. AddPacketName(ssl, "EncryptedExtensions");
  6730. if (ssl->toInfoOn) {
  6731. ret = AddPacketInfo(ssl, "EncryptedExtensions", handshake, output,
  6732. sendSz, WRITE_PROTO, 0, ssl->heap);
  6733. if (ret != 0)
  6734. return ret;
  6735. }
  6736. #endif
  6737. #ifdef WOLFSSL_DTLS13
  6738. if (ssl->options.dtls) {
  6739. ssl->options.buildingMsg = 0;
  6740. ret = Dtls13HandshakeSend(ssl, output, (word16)sendSz, (word16)idx,
  6741. encrypted_extensions, 1);
  6742. if (ret == 0)
  6743. ssl->options.serverState = SERVER_ENCRYPTED_EXTENSIONS_COMPLETE;
  6744. WOLFSSL_LEAVE("SendTls13EncryptedExtensions", ret);
  6745. WOLFSSL_END(WC_FUNC_ENCRYPTED_EXTENSIONS_SEND);
  6746. return ret;
  6747. }
  6748. #endif /* WOLFSSL_DTLS13 */
  6749. /* This handshake message is always encrypted. */
  6750. sendSz = BuildTls13Message(ssl, output, sendSz, output + RECORD_HEADER_SZ,
  6751. idx - RECORD_HEADER_SZ, handshake, 1, 0, 0);
  6752. if (sendSz < 0)
  6753. return sendSz;
  6754. ssl->buffers.outputBuffer.length += sendSz;
  6755. ssl->options.buildingMsg = 0;
  6756. ssl->options.serverState = SERVER_ENCRYPTED_EXTENSIONS_COMPLETE;
  6757. if (!ssl->options.groupMessages)
  6758. ret = SendBuffered(ssl);
  6759. WOLFSSL_LEAVE("SendTls13EncryptedExtensions", ret);
  6760. WOLFSSL_END(WC_FUNC_ENCRYPTED_EXTENSIONS_SEND);
  6761. return ret;
  6762. }
  6763. #ifndef NO_CERTS
  6764. /* handle generation TLS v1.3 certificate_request (13) */
  6765. /* Send the TLS v1.3 CertificateRequest message.
  6766. * This message is always encrypted in TLS v1.3.
  6767. * Only a server will send this message.
  6768. *
  6769. * ssl SSL/TLS object.
  6770. * reqCtx Request context.
  6771. * reqCtxLen Length of context. 0 when sending as part of handshake.
  6772. * returns 0 on success, otherwise failure.
  6773. */
  6774. static int SendTls13CertificateRequest(WOLFSSL* ssl, byte* reqCtx,
  6775. int reqCtxLen)
  6776. {
  6777. byte* output;
  6778. int ret;
  6779. int sendSz;
  6780. word32 i;
  6781. word16 reqSz;
  6782. word16 hashSigAlgoSz = 0;
  6783. SignatureAlgorithms* sa;
  6784. int haveSig = SIG_RSA | SIG_ECDSA | SIG_FALCON | SIG_DILITHIUM;
  6785. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  6786. haveSig |= SIG_SM2;
  6787. #endif
  6788. WOLFSSL_START(WC_FUNC_CERTIFICATE_REQUEST_SEND);
  6789. WOLFSSL_ENTER("SendTls13CertificateRequest");
  6790. ssl->options.buildingMsg = 1;
  6791. if (ssl->options.side != WOLFSSL_SERVER_END)
  6792. return SIDE_ERROR;
  6793. /* Get the length of the hashSigAlgo buffer */
  6794. InitSuitesHashSigAlgo_ex2(NULL, haveSig, 1, ssl->buffers.keySz,
  6795. &hashSigAlgoSz);
  6796. sa = TLSX_SignatureAlgorithms_New(ssl, hashSigAlgoSz, ssl->heap);
  6797. if (sa == NULL)
  6798. return MEMORY_ERROR;
  6799. InitSuitesHashSigAlgo_ex2(sa->hashSigAlgo, haveSig, 1, ssl->buffers.keySz,
  6800. &hashSigAlgoSz);
  6801. ret = TLSX_Push(&ssl->extensions, TLSX_SIGNATURE_ALGORITHMS, sa, ssl->heap);
  6802. if (ret != 0) {
  6803. TLSX_SignatureAlgorithms_FreeAll(sa, ssl->heap);
  6804. return ret;
  6805. }
  6806. i = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  6807. #ifdef WOLFSSL_DTLS13
  6808. if (ssl->options.dtls)
  6809. i = Dtls13GetRlHeaderLength(ssl, 1) + DTLS_HANDSHAKE_HEADER_SZ;
  6810. #endif /* WOLFSSL_DTLS13 */
  6811. reqSz = (word16)(OPAQUE8_LEN + reqCtxLen);
  6812. ret = TLSX_GetRequestSize(ssl, certificate_request, &reqSz);
  6813. if (ret != 0)
  6814. return ret;
  6815. sendSz = i + reqSz;
  6816. /* Always encrypted and make room for padding. */
  6817. sendSz += MAX_MSG_EXTRA;
  6818. /* Check buffers are big enough and grow if needed. */
  6819. if ((ret = CheckAvailableSize(ssl, sendSz)) != 0)
  6820. return ret;
  6821. /* Get position in output buffer to write new message to. */
  6822. output = GetOutputBuffer(ssl);
  6823. /* Put the record and handshake headers on. */
  6824. AddTls13Headers(output, reqSz, certificate_request, ssl);
  6825. /* Certificate request context. */
  6826. output[i++] = (byte)reqCtxLen;
  6827. if (reqCtxLen != 0) {
  6828. XMEMCPY(output + i, reqCtx, reqCtxLen);
  6829. i += reqCtxLen;
  6830. }
  6831. /* Certificate extensions. */
  6832. reqSz = 0;
  6833. ret = TLSX_WriteRequest(ssl, output + i, certificate_request, &reqSz);
  6834. if (ret != 0)
  6835. return ret;
  6836. i += reqSz;
  6837. #ifdef WOLFSSL_DTLS13
  6838. if (ssl->options.dtls) {
  6839. ssl->options.buildingMsg = 0;
  6840. ret =
  6841. Dtls13HandshakeSend(ssl, output, (word16)sendSz, (word16)i,
  6842. certificate_request, 1);
  6843. WOLFSSL_LEAVE("SendTls13CertificateRequest", ret);
  6844. WOLFSSL_END(WC_FUNC_CERTIFICATE_REQUEST_SEND);
  6845. return ret;
  6846. }
  6847. #endif /* WOLFSSL_DTLS13 */
  6848. /* Always encrypted. */
  6849. sendSz = BuildTls13Message(ssl, output, sendSz, output + RECORD_HEADER_SZ,
  6850. i - RECORD_HEADER_SZ, handshake, 1, 0, 0);
  6851. if (sendSz < 0)
  6852. return sendSz;
  6853. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  6854. if (ssl->hsInfoOn)
  6855. AddPacketName(ssl, "CertificateRequest");
  6856. if (ssl->toInfoOn) {
  6857. ret = AddPacketInfo(ssl, "CertificateRequest", handshake, output,
  6858. sendSz, WRITE_PROTO, 0, ssl->heap);
  6859. if (ret != 0)
  6860. return ret;
  6861. }
  6862. #endif
  6863. ssl->buffers.outputBuffer.length += sendSz;
  6864. ssl->options.buildingMsg = 0;
  6865. if (!ssl->options.groupMessages)
  6866. ret = SendBuffered(ssl);
  6867. WOLFSSL_LEAVE("SendTls13CertificateRequest", ret);
  6868. WOLFSSL_END(WC_FUNC_CERTIFICATE_REQUEST_SEND);
  6869. return ret;
  6870. }
  6871. #endif /* NO_CERTS */
  6872. #endif /* NO_WOLFSSL_SERVER */
  6873. #ifndef NO_CERTS
  6874. #if !defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_ED25519) || \
  6875. defined(HAVE_ED448) || defined(HAVE_PQC)
  6876. /* Encode the signature algorithm into buffer.
  6877. *
  6878. * hashalgo The hash algorithm.
  6879. * hsType The signature type.
  6880. * output The buffer to encode into.
  6881. */
  6882. static WC_INLINE void EncodeSigAlg(byte hashAlgo, byte hsType, byte* output)
  6883. {
  6884. switch (hsType) {
  6885. #ifdef HAVE_ECC
  6886. case ecc_dsa_sa_algo:
  6887. output[0] = hashAlgo;
  6888. output[1] = ecc_dsa_sa_algo;
  6889. break;
  6890. #endif
  6891. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  6892. case sm2_sa_algo:
  6893. output[0] = SM2_SA_MAJOR;
  6894. output[1] = SM2_SA_MINOR;
  6895. break;
  6896. #endif
  6897. #ifdef HAVE_ED25519
  6898. /* ED25519: 0x0807 */
  6899. case ed25519_sa_algo:
  6900. output[0] = ED25519_SA_MAJOR;
  6901. output[1] = ED25519_SA_MINOR;
  6902. (void)hashAlgo;
  6903. break;
  6904. #endif
  6905. #ifdef HAVE_ED448
  6906. /* ED448: 0x0808 */
  6907. case ed448_sa_algo:
  6908. output[0] = ED448_SA_MAJOR;
  6909. output[1] = ED448_SA_MINOR;
  6910. (void)hashAlgo;
  6911. break;
  6912. #endif
  6913. #ifndef NO_RSA
  6914. /* PSS signatures: 0x080[4-6] */
  6915. case rsa_pss_sa_algo:
  6916. output[0] = rsa_pss_sa_algo;
  6917. output[1] = hashAlgo;
  6918. break;
  6919. #endif
  6920. #ifdef HAVE_PQC
  6921. #ifdef HAVE_FALCON
  6922. case falcon_level1_sa_algo:
  6923. output[0] = FALCON_LEVEL1_SA_MAJOR;
  6924. output[1] = FALCON_LEVEL1_SA_MINOR;
  6925. break;
  6926. case falcon_level5_sa_algo:
  6927. output[0] = FALCON_LEVEL5_SA_MAJOR;
  6928. output[1] = FALCON_LEVEL5_SA_MINOR;
  6929. break;
  6930. #endif
  6931. #ifdef HAVE_DILITHIUM
  6932. case dilithium_level2_sa_algo:
  6933. output[0] = DILITHIUM_LEVEL2_SA_MAJOR;
  6934. output[1] = DILITHIUM_LEVEL2_SA_MINOR;
  6935. break;
  6936. case dilithium_level3_sa_algo:
  6937. output[0] = DILITHIUM_LEVEL3_SA_MAJOR;
  6938. output[1] = DILITHIUM_LEVEL3_SA_MINOR;
  6939. break;
  6940. case dilithium_level5_sa_algo:
  6941. output[0] = DILITHIUM_LEVEL5_SA_MAJOR;
  6942. output[1] = DILITHIUM_LEVEL5_SA_MINOR;
  6943. break;
  6944. #endif
  6945. #endif
  6946. default:
  6947. break;
  6948. }
  6949. }
  6950. #ifdef WOLFSSL_DUAL_ALG_CERTS
  6951. /* These match up with what the OQS team has defined. */
  6952. #define HYBRID_SA_MAJOR 0xFE
  6953. #define HYBRID_P256_DILITHIUM_LEVEL2_SA_MINOR 0xA1
  6954. #define HYBRID_RSA3072_DILITHIUM_LEVEL2_SA_MINOR 0xA2
  6955. #define HYBRID_P384_DILITHIUM_LEVEL3_SA_MINOR 0xA4
  6956. #define HYBRID_P521_DILITHIUM_LEVEL5_SA_MINOR 0xA6
  6957. #define HYBRID_P256_FALCON_LEVEL1_SA_MINOR 0x0C
  6958. #define HYBRID_RSA3072_FALCON_LEVEL1_SA_MINOR 0x0D
  6959. #define HYBRID_P521_FALCON_LEVEL5_SA_MINOR 0x0F
  6960. static void EncodeDualSigAlg(byte sigAlg, byte altSigAlg, byte* output)
  6961. {
  6962. /* Initialize output to error indicator. */
  6963. output[0] = 0x0;
  6964. output[1] = 0x0;
  6965. if (sigAlg == ecc_dsa_sa_algo && altSigAlg == dilithium_level2_sa_algo) {
  6966. output[1] = HYBRID_P256_DILITHIUM_LEVEL2_SA_MINOR;
  6967. }
  6968. else if (sigAlg == rsa_pss_sa_algo &&
  6969. altSigAlg == dilithium_level2_sa_algo) {
  6970. output[1] = HYBRID_RSA3072_DILITHIUM_LEVEL2_SA_MINOR;
  6971. }
  6972. else if (sigAlg == ecc_dsa_sa_algo &&
  6973. altSigAlg == dilithium_level3_sa_algo) {
  6974. output[1] = HYBRID_P384_DILITHIUM_LEVEL3_SA_MINOR;
  6975. }
  6976. else if (sigAlg == ecc_dsa_sa_algo &&
  6977. altSigAlg == dilithium_level5_sa_algo) {
  6978. output[1] = HYBRID_P521_DILITHIUM_LEVEL5_SA_MINOR;
  6979. }
  6980. else if (sigAlg == ecc_dsa_sa_algo && altSigAlg == falcon_level1_sa_algo) {
  6981. output[1] = HYBRID_P256_FALCON_LEVEL1_SA_MINOR;
  6982. }
  6983. else if (sigAlg == rsa_pss_sa_algo && altSigAlg == falcon_level1_sa_algo) {
  6984. output[1] = HYBRID_RSA3072_FALCON_LEVEL1_SA_MINOR;
  6985. }
  6986. else if (sigAlg == ecc_dsa_sa_algo && altSigAlg == falcon_level5_sa_algo) {
  6987. output[1] = HYBRID_P521_FALCON_LEVEL5_SA_MINOR;
  6988. }
  6989. if (output[1] != 0x0) {
  6990. output[0] = HYBRID_SA_MAJOR;
  6991. }
  6992. }
  6993. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  6994. /* Decode the signature algorithm.
  6995. *
  6996. * input The encoded signature algorithm.
  6997. * hashalgo The hash algorithm.
  6998. * hsType The signature type.
  6999. * returns INVALID_PARAMETER if not recognized and 0 otherwise.
  7000. */
  7001. static WC_INLINE int DecodeTls13SigAlg(byte* input, byte* hashAlgo,
  7002. byte* hsType)
  7003. {
  7004. int ret = 0;
  7005. switch (input[0]) {
  7006. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  7007. case SM2_SA_MAJOR:
  7008. if (input[1] == SM2_SA_MINOR) {
  7009. *hsType = sm2_sa_algo;
  7010. *hashAlgo = sm3_mac;
  7011. }
  7012. else
  7013. ret = INVALID_PARAMETER;
  7014. break;
  7015. #endif
  7016. case NEW_SA_MAJOR:
  7017. /* PSS signatures: 0x080[4-6] */
  7018. if (input[1] >= sha256_mac && input[1] <= sha512_mac) {
  7019. *hsType = input[0];
  7020. *hashAlgo = input[1];
  7021. }
  7022. #ifdef HAVE_ED25519
  7023. /* ED25519: 0x0807 */
  7024. else if (input[1] == ED25519_SA_MINOR) {
  7025. *hsType = ed25519_sa_algo;
  7026. /* Hash performed as part of sign/verify operation. */
  7027. *hashAlgo = sha512_mac;
  7028. }
  7029. #endif
  7030. #ifdef HAVE_ED448
  7031. /* ED448: 0x0808 */
  7032. else if (input[1] == ED448_SA_MINOR) {
  7033. *hsType = ed448_sa_algo;
  7034. /* Hash performed as part of sign/verify operation. */
  7035. *hashAlgo = sha512_mac;
  7036. }
  7037. #endif
  7038. else
  7039. ret = INVALID_PARAMETER;
  7040. break;
  7041. #ifdef HAVE_PQC
  7042. case PQC_SA_MAJOR:
  7043. #if defined(HAVE_FALCON)
  7044. if (input[1] == FALCON_LEVEL1_SA_MINOR) {
  7045. *hsType = falcon_level1_sa_algo;
  7046. /* Hash performed as part of sign/verify operation. */
  7047. *hashAlgo = sha512_mac;
  7048. } else if (input[1] == FALCON_LEVEL5_SA_MINOR) {
  7049. *hsType = falcon_level5_sa_algo;
  7050. /* Hash performed as part of sign/verify operation. */
  7051. *hashAlgo = sha512_mac;
  7052. }
  7053. else
  7054. #endif /* HAVE_FALCON */
  7055. #if defined(HAVE_DILITHIUM)
  7056. if (input[1] == DILITHIUM_LEVEL2_SA_MINOR) {
  7057. *hsType = dilithium_level2_sa_algo;
  7058. /* Hash performed as part of sign/verify operation. */
  7059. *hashAlgo = sha512_mac;
  7060. } else if (input[1] == DILITHIUM_LEVEL3_SA_MINOR) {
  7061. *hsType = dilithium_level3_sa_algo;
  7062. /* Hash performed as part of sign/verify operation. */
  7063. *hashAlgo = sha512_mac;
  7064. } else if (input[1] == DILITHIUM_LEVEL5_SA_MINOR) {
  7065. *hsType = dilithium_level5_sa_algo;
  7066. /* Hash performed as part of sign/verify operation. */
  7067. *hashAlgo = sha512_mac;
  7068. }
  7069. else
  7070. #endif /* HAVE_DILITHIUM */
  7071. {
  7072. ret = INVALID_PARAMETER;
  7073. }
  7074. break;
  7075. #endif
  7076. default:
  7077. *hashAlgo = input[0];
  7078. *hsType = input[1];
  7079. break;
  7080. }
  7081. return ret;
  7082. }
  7083. #ifdef WOLFSSL_DUAL_ALG_CERTS
  7084. /* Decode the hybrid signature algorithm.
  7085. *
  7086. * input The encoded signature algorithm.
  7087. * hashalgo The hash algorithm.
  7088. * hsType The signature type.
  7089. * returns INVALID_PARAMETER if not recognized and 0 otherwise.
  7090. */
  7091. static WC_INLINE int DecodeTls13HybridSigAlg(byte* input, byte* hashAlg,
  7092. byte *sigAlg, byte *altSigAlg)
  7093. {
  7094. if (input[0] != HYBRID_SA_MAJOR) {
  7095. return INVALID_PARAMETER;
  7096. }
  7097. if (input[1] == HYBRID_P256_DILITHIUM_LEVEL2_SA_MINOR) {
  7098. *sigAlg = ecc_dsa_sa_algo;
  7099. *hashAlg = 4; /* WC_HASH_TYPE_SHA? Reviewer? */
  7100. *altSigAlg = dilithium_level2_sa_algo;
  7101. }
  7102. else if (input[1] == HYBRID_RSA3072_DILITHIUM_LEVEL2_SA_MINOR) {
  7103. *sigAlg = rsa_pss_sa_algo;
  7104. *hashAlg = 4;
  7105. *altSigAlg = dilithium_level2_sa_algo;
  7106. }
  7107. else if (input[1] == HYBRID_P384_DILITHIUM_LEVEL3_SA_MINOR) {
  7108. *sigAlg = ecc_dsa_sa_algo;
  7109. *hashAlg = 5;
  7110. *altSigAlg = dilithium_level3_sa_algo;
  7111. }
  7112. else if (input[1] == HYBRID_P521_DILITHIUM_LEVEL5_SA_MINOR) {
  7113. *sigAlg = ecc_dsa_sa_algo;
  7114. *hashAlg = 6;
  7115. *altSigAlg = dilithium_level5_sa_algo;
  7116. }
  7117. else if (input[1] == HYBRID_P256_FALCON_LEVEL1_SA_MINOR) {
  7118. *sigAlg = ecc_dsa_sa_algo;
  7119. *hashAlg = 4;
  7120. *altSigAlg = falcon_level1_sa_algo;
  7121. }
  7122. else if (input[1] == HYBRID_RSA3072_FALCON_LEVEL1_SA_MINOR) {
  7123. *sigAlg = rsa_pss_sa_algo;
  7124. *hashAlg = 4;
  7125. *altSigAlg = falcon_level1_sa_algo;
  7126. }
  7127. else if (input[1] == HYBRID_P521_FALCON_LEVEL5_SA_MINOR) {
  7128. *sigAlg = ecc_dsa_sa_algo;
  7129. *hashAlg = 6;
  7130. *altSigAlg = falcon_level5_sa_algo;
  7131. }
  7132. else {
  7133. return INVALID_PARAMETER;
  7134. }
  7135. return 0;
  7136. }
  7137. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  7138. /* Get the hash of the messages so far.
  7139. *
  7140. * ssl The SSL/TLS object.
  7141. * hash The buffer to write the hash to.
  7142. * returns the length of the hash.
  7143. */
  7144. static WC_INLINE int GetMsgHash(WOLFSSL* ssl, byte* hash)
  7145. {
  7146. int ret = 0;
  7147. switch (ssl->specs.mac_algorithm) {
  7148. #ifndef NO_SHA256
  7149. case sha256_mac:
  7150. ret = wc_Sha256GetHash(&ssl->hsHashes->hashSha256, hash);
  7151. if (ret == 0)
  7152. ret = WC_SHA256_DIGEST_SIZE;
  7153. break;
  7154. #endif /* !NO_SHA256 */
  7155. #ifdef WOLFSSL_SHA384
  7156. case sha384_mac:
  7157. ret = wc_Sha384GetHash(&ssl->hsHashes->hashSha384, hash);
  7158. if (ret == 0)
  7159. ret = WC_SHA384_DIGEST_SIZE;
  7160. break;
  7161. #endif /* WOLFSSL_SHA384 */
  7162. #ifdef WOLFSSL_TLS13_SHA512
  7163. case sha512_mac:
  7164. ret = wc_Sha512GetHash(&ssl->hsHashes->hashSha512, hash);
  7165. if (ret == 0)
  7166. ret = WC_SHA512_DIGEST_SIZE;
  7167. break;
  7168. #endif /* WOLFSSL_TLS13_SHA512 */
  7169. #ifdef WOLFSSL_SM3
  7170. case sm3_mac:
  7171. ret = wc_Sm3GetHash(&ssl->hsHashes->hashSm3, hash);
  7172. if (ret == 0)
  7173. ret = WC_SM3_DIGEST_SIZE;
  7174. break;
  7175. #endif /* WOLFSSL_SM3 */
  7176. default:
  7177. break;
  7178. }
  7179. return ret;
  7180. }
  7181. /* The server certificate verification label. */
  7182. static const byte serverCertVfyLabel[CERT_VFY_LABEL_SZ] =
  7183. "TLS 1.3, server CertificateVerify";
  7184. /* The client certificate verification label. */
  7185. static const byte clientCertVfyLabel[CERT_VFY_LABEL_SZ] =
  7186. "TLS 1.3, client CertificateVerify";
  7187. /* The prefix byte in the signature data. */
  7188. #define SIGNING_DATA_PREFIX_BYTE 0x20
  7189. /* Create the signature data for TLS v1.3 certificate verification.
  7190. *
  7191. * ssl The SSL/TLS object.
  7192. * sigData The signature data.
  7193. * sigDataSz The length of the signature data.
  7194. * check Indicates this is a check not create.
  7195. */
  7196. int CreateSigData(WOLFSSL* ssl, byte* sigData, word16* sigDataSz,
  7197. int check)
  7198. {
  7199. word16 idx;
  7200. int side = ssl->options.side;
  7201. int ret;
  7202. /* Signature Data = Prefix | Label | Handshake Hash */
  7203. XMEMSET(sigData, SIGNING_DATA_PREFIX_BYTE, SIGNING_DATA_PREFIX_SZ);
  7204. idx = SIGNING_DATA_PREFIX_SZ;
  7205. if ((side == WOLFSSL_SERVER_END && check) ||
  7206. (side == WOLFSSL_CLIENT_END && !check)) {
  7207. XMEMCPY(&sigData[idx], clientCertVfyLabel, CERT_VFY_LABEL_SZ);
  7208. }
  7209. if ((side == WOLFSSL_CLIENT_END && check) ||
  7210. (side == WOLFSSL_SERVER_END && !check)) {
  7211. XMEMCPY(&sigData[idx], serverCertVfyLabel, CERT_VFY_LABEL_SZ);
  7212. }
  7213. idx += CERT_VFY_LABEL_SZ;
  7214. ret = GetMsgHash(ssl, &sigData[idx]);
  7215. if (ret < 0)
  7216. return ret;
  7217. *sigDataSz = (word16)(idx + ret);
  7218. ret = 0;
  7219. return ret;
  7220. }
  7221. #ifndef NO_RSA
  7222. /* Encode the PKCS #1.5 RSA signature.
  7223. *
  7224. * sig The buffer to place the encoded signature into.
  7225. * sigData The data to be signed.
  7226. * sigDataSz The size of the data to be signed.
  7227. * hashAlgo The hash algorithm to use when signing.
  7228. * returns the length of the encoded signature or negative on error.
  7229. */
  7230. int CreateRSAEncodedSig(byte* sig, byte* sigData, int sigDataSz,
  7231. int sigAlgo, int hashAlgo)
  7232. {
  7233. Digest digest;
  7234. int hashSz = 0;
  7235. int ret = BAD_FUNC_ARG;
  7236. byte* hash;
  7237. (void)sigAlgo;
  7238. hash = sig;
  7239. /* Digest the signature data. */
  7240. switch (hashAlgo) {
  7241. #ifndef NO_WOLFSSL_SHA256
  7242. case sha256_mac:
  7243. ret = wc_InitSha256(&digest.sha256);
  7244. if (ret == 0) {
  7245. ret = wc_Sha256Update(&digest.sha256, sigData, sigDataSz);
  7246. if (ret == 0)
  7247. ret = wc_Sha256Final(&digest.sha256, hash);
  7248. wc_Sha256Free(&digest.sha256);
  7249. }
  7250. hashSz = WC_SHA256_DIGEST_SIZE;
  7251. break;
  7252. #endif
  7253. #ifdef WOLFSSL_SHA384
  7254. case sha384_mac:
  7255. ret = wc_InitSha384(&digest.sha384);
  7256. if (ret == 0) {
  7257. ret = wc_Sha384Update(&digest.sha384, sigData, sigDataSz);
  7258. if (ret == 0)
  7259. ret = wc_Sha384Final(&digest.sha384, hash);
  7260. wc_Sha384Free(&digest.sha384);
  7261. }
  7262. hashSz = WC_SHA384_DIGEST_SIZE;
  7263. break;
  7264. #endif
  7265. #ifdef WOLFSSL_SHA512
  7266. case sha512_mac:
  7267. ret = wc_InitSha512(&digest.sha512);
  7268. if (ret == 0) {
  7269. ret = wc_Sha512Update(&digest.sha512, sigData, sigDataSz);
  7270. if (ret == 0)
  7271. ret = wc_Sha512Final(&digest.sha512, hash);
  7272. wc_Sha512Free(&digest.sha512);
  7273. }
  7274. hashSz = WC_SHA512_DIGEST_SIZE;
  7275. break;
  7276. #endif
  7277. }
  7278. if (ret != 0)
  7279. return ret;
  7280. return hashSz;
  7281. }
  7282. #endif /* !NO_RSA */
  7283. #ifdef HAVE_ECC
  7284. /* Encode the ECC signature.
  7285. *
  7286. * sigData The data to be signed.
  7287. * sigDataSz The size of the data to be signed.
  7288. * hashAlgo The hash algorithm to use when signing.
  7289. * returns the length of the encoded signature or negative on error.
  7290. */
  7291. static int CreateECCEncodedSig(byte* sigData, int sigDataSz, int hashAlgo)
  7292. {
  7293. Digest digest;
  7294. int hashSz = 0;
  7295. int ret = BAD_FUNC_ARG;
  7296. /* Digest the signature data. */
  7297. switch (hashAlgo) {
  7298. #ifndef NO_WOLFSSL_SHA256
  7299. case sha256_mac:
  7300. ret = wc_InitSha256(&digest.sha256);
  7301. if (ret == 0) {
  7302. ret = wc_Sha256Update(&digest.sha256, sigData, sigDataSz);
  7303. if (ret == 0)
  7304. ret = wc_Sha256Final(&digest.sha256, sigData);
  7305. wc_Sha256Free(&digest.sha256);
  7306. }
  7307. hashSz = WC_SHA256_DIGEST_SIZE;
  7308. break;
  7309. #endif
  7310. #ifdef WOLFSSL_SHA384
  7311. case sha384_mac:
  7312. ret = wc_InitSha384(&digest.sha384);
  7313. if (ret == 0) {
  7314. ret = wc_Sha384Update(&digest.sha384, sigData, sigDataSz);
  7315. if (ret == 0)
  7316. ret = wc_Sha384Final(&digest.sha384, sigData);
  7317. wc_Sha384Free(&digest.sha384);
  7318. }
  7319. hashSz = WC_SHA384_DIGEST_SIZE;
  7320. break;
  7321. #endif
  7322. #ifdef WOLFSSL_SHA512
  7323. case sha512_mac:
  7324. ret = wc_InitSha512(&digest.sha512);
  7325. if (ret == 0) {
  7326. ret = wc_Sha512Update(&digest.sha512, sigData, sigDataSz);
  7327. if (ret == 0)
  7328. ret = wc_Sha512Final(&digest.sha512, sigData);
  7329. wc_Sha512Free(&digest.sha512);
  7330. }
  7331. hashSz = WC_SHA512_DIGEST_SIZE;
  7332. break;
  7333. #endif
  7334. default:
  7335. break;
  7336. }
  7337. if (ret != 0)
  7338. return ret;
  7339. return hashSz;
  7340. }
  7341. #endif /* HAVE_ECC */
  7342. #if !defined(NO_RSA) && defined(WC_RSA_PSS)
  7343. /* Check that the decrypted signature matches the encoded signature
  7344. * based on the digest of the signature data.
  7345. *
  7346. * ssl The SSL/TLS object.
  7347. * sigAlgo The signature algorithm used to generate signature.
  7348. * hashAlgo The hash algorithm used to generate signature.
  7349. * decSig The decrypted signature.
  7350. * decSigSz The size of the decrypted signature.
  7351. * returns 0 on success, otherwise failure.
  7352. */
  7353. static int CheckRSASignature(WOLFSSL* ssl, int sigAlgo, int hashAlgo,
  7354. byte* decSig, word32 decSigSz)
  7355. {
  7356. int ret = 0;
  7357. byte sigData[MAX_SIG_DATA_SZ];
  7358. word16 sigDataSz;
  7359. ret = CreateSigData(ssl, sigData, &sigDataSz, 1);
  7360. if (ret != 0)
  7361. return ret;
  7362. if (sigAlgo == rsa_pss_sa_algo) {
  7363. enum wc_HashType hashType = WC_HASH_TYPE_NONE;
  7364. word32 sigSz;
  7365. ret = ConvertHashPss(hashAlgo, &hashType, NULL);
  7366. if (ret < 0)
  7367. return ret;
  7368. /* PSS signature can be done in-place */
  7369. ret = CreateRSAEncodedSig(sigData, sigData, sigDataSz,
  7370. sigAlgo, hashAlgo);
  7371. if (ret < 0)
  7372. return ret;
  7373. sigSz = ret;
  7374. ret = wc_RsaPSS_CheckPadding(sigData, sigSz, decSig, decSigSz,
  7375. hashType);
  7376. }
  7377. return ret;
  7378. }
  7379. #endif /* !NO_RSA && WC_RSA_PSS */
  7380. #endif /* !NO_RSA || HAVE_ECC */
  7381. #if !defined(NO_WOLFSSL_CLIENT) || !defined(NO_WOLFSSL_SERVER)
  7382. /* Get the next certificate from the list for writing into the TLS v1.3
  7383. * Certificate message.
  7384. *
  7385. * data The certificate list.
  7386. * length The length of the certificate data in the list.
  7387. * idx The index of the next certificate.
  7388. * returns the length of the certificate data. 0 indicates no more certificates
  7389. * in the list.
  7390. */
  7391. static word32 NextCert(byte* data, word32 length, word32* idx)
  7392. {
  7393. word32 len;
  7394. /* Is index at end of list. */
  7395. if (*idx == length)
  7396. return 0;
  7397. /* Length of the current ASN.1 encoded certificate. */
  7398. c24to32(data + *idx, &len);
  7399. /* Include the length field. */
  7400. len += 3;
  7401. /* Move index to next certificate and return the current certificate's
  7402. * length.
  7403. */
  7404. *idx += len;
  7405. return len;
  7406. }
  7407. /* Add certificate data and empty extension to output up to the fragment size.
  7408. *
  7409. * ssl SSL/TLS object.
  7410. * cert The certificate data to write out.
  7411. * len The length of the certificate data.
  7412. * extSz Length of the extension data with the certificate.
  7413. * idx The start of the certificate data to write out.
  7414. * fragSz The maximum size of this fragment.
  7415. * output The buffer to write to.
  7416. * returns the number of bytes written.
  7417. */
  7418. static word32 AddCertExt(WOLFSSL* ssl, byte* cert, word32 len, word16 extSz,
  7419. word32 idx, word32 fragSz, byte* output)
  7420. {
  7421. word32 i = 0;
  7422. word32 copySz = min(len - idx, fragSz);
  7423. if (idx < len) {
  7424. XMEMCPY(output, cert + idx, copySz);
  7425. i = copySz;
  7426. if (copySz == fragSz)
  7427. return i;
  7428. }
  7429. copySz = len + extSz - idx - i;
  7430. if (extSz == OPAQUE16_LEN) {
  7431. if (copySz <= fragSz) {
  7432. /* Empty extension */
  7433. output[i++] = 0;
  7434. output[i++] = 0;
  7435. }
  7436. }
  7437. else {
  7438. byte* certExts = ssl->buffers.certExts->buffer + idx + i - len;
  7439. /* Put out as much of the extensions' data as will fit in fragment. */
  7440. if (copySz > fragSz - i)
  7441. copySz = fragSz - i;
  7442. XMEMCPY(output + i, certExts, copySz);
  7443. i += copySz;
  7444. }
  7445. return i;
  7446. }
  7447. /* handle generation TLS v1.3 certificate (11) */
  7448. /* Send the certificate for this end and any CAs that help with validation.
  7449. * This message is always encrypted in TLS v1.3.
  7450. *
  7451. * ssl The SSL/TLS object.
  7452. * returns 0 on success, otherwise failure.
  7453. */
  7454. static int SendTls13Certificate(WOLFSSL* ssl)
  7455. {
  7456. int ret = 0;
  7457. word32 certSz, certChainSz, headerSz, listSz, payloadSz;
  7458. word16 extSz = 0;
  7459. word32 length, maxFragment;
  7460. word32 len = 0;
  7461. word32 idx = 0;
  7462. word32 offset = OPAQUE16_LEN;
  7463. byte* p = NULL;
  7464. byte certReqCtxLen = 0;
  7465. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  7466. byte* certReqCtx = NULL;
  7467. #endif
  7468. #ifdef OPENSSL_EXTRA
  7469. WOLFSSL_X509* x509 = NULL;
  7470. WOLFSSL_EVP_PKEY* pkey = NULL;
  7471. #endif
  7472. WOLFSSL_START(WC_FUNC_CERTIFICATE_SEND);
  7473. WOLFSSL_ENTER("SendTls13Certificate");
  7474. ssl->options.buildingMsg = 1;
  7475. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  7476. if (ssl->options.side == WOLFSSL_CLIENT_END && ssl->certReqCtx != NULL) {
  7477. certReqCtxLen = ssl->certReqCtx->len;
  7478. certReqCtx = &ssl->certReqCtx->ctx;
  7479. }
  7480. #endif
  7481. #ifdef OPENSSL_EXTRA
  7482. /* call client cert callback if no cert has been loaded */
  7483. if ((ssl->ctx->CBClientCert != NULL) &&
  7484. (!ssl->buffers.certificate || !ssl->buffers.certificate->buffer)) {
  7485. ret = ssl->ctx->CBClientCert(ssl, &x509, &pkey);
  7486. if (ret == 1) {
  7487. if ((wolfSSL_CTX_use_certificate(ssl->ctx, x509) == WOLFSSL_SUCCESS) &&
  7488. (wolfSSL_CTX_use_PrivateKey(ssl->ctx, pkey) == WOLFSSL_SUCCESS)) {
  7489. ssl->options.sendVerify = SEND_CERT;
  7490. }
  7491. wolfSSL_X509_free(x509);
  7492. wolfSSL_EVP_PKEY_free(pkey);
  7493. }
  7494. }
  7495. #endif
  7496. if (ssl->options.sendVerify == SEND_BLANK_CERT) {
  7497. certSz = 0;
  7498. certChainSz = 0;
  7499. headerSz = OPAQUE8_LEN + certReqCtxLen + CERT_HEADER_SZ;
  7500. length = headerSz;
  7501. listSz = 0;
  7502. }
  7503. else {
  7504. if (!ssl->buffers.certificate) {
  7505. WOLFSSL_MSG("Send Cert missing certificate buffer");
  7506. return BUFFER_ERROR;
  7507. }
  7508. /* Certificate Data */
  7509. certSz = ssl->buffers.certificate->length;
  7510. /* Cert Req Ctx Len | Cert Req Ctx | Cert List Len | Cert Data Len */
  7511. headerSz = OPAQUE8_LEN + certReqCtxLen + CERT_HEADER_SZ +
  7512. CERT_HEADER_SZ;
  7513. ret = TLSX_GetResponseSize(ssl, certificate, &extSz);
  7514. if (ret < 0)
  7515. return ret;
  7516. /* Create extensions' data if none already present. */
  7517. if (extSz > OPAQUE16_LEN && ssl->buffers.certExts == NULL) {
  7518. ret = AllocDer(&ssl->buffers.certExts, extSz, CERT_TYPE, ssl->heap);
  7519. if (ret < 0)
  7520. return ret;
  7521. extSz = 0;
  7522. ret = TLSX_WriteResponse(ssl, ssl->buffers.certExts->buffer,
  7523. certificate, &extSz);
  7524. if (ret < 0)
  7525. return ret;
  7526. }
  7527. /* Length of message data with one certificate and extensions. */
  7528. length = headerSz + certSz + extSz;
  7529. /* Length of list data with one certificate and extensions. */
  7530. listSz = CERT_HEADER_SZ + certSz + extSz;
  7531. /* Send rest of chain if sending cert (chain has leading size/s). */
  7532. if (certSz > 0 && ssl->buffers.certChainCnt > 0) {
  7533. p = ssl->buffers.certChain->buffer;
  7534. /* Chain length including extensions. */
  7535. certChainSz = ssl->buffers.certChain->length +
  7536. OPAQUE16_LEN * ssl->buffers.certChainCnt;
  7537. length += certChainSz;
  7538. listSz += certChainSz;
  7539. }
  7540. else
  7541. certChainSz = 0;
  7542. }
  7543. payloadSz = length;
  7544. if (ssl->fragOffset != 0)
  7545. length -= (ssl->fragOffset + headerSz);
  7546. maxFragment = wolfSSL_GetMaxFragSize(ssl, MAX_RECORD_SIZE);
  7547. while (length > 0 && ret == 0) {
  7548. byte* output = NULL;
  7549. word32 fragSz = 0;
  7550. word32 i = RECORD_HEADER_SZ;
  7551. int sendSz = RECORD_HEADER_SZ;
  7552. #ifdef WOLFSSL_DTLS13
  7553. if (ssl->options.dtls) {
  7554. i = Dtls13GetRlHeaderLength(ssl, 1);
  7555. sendSz = (int)i;
  7556. }
  7557. #endif /* WOLFSSL_DTLS13 */
  7558. if (ssl->fragOffset == 0) {
  7559. if (headerSz + certSz + extSz + certChainSz <=
  7560. maxFragment - HANDSHAKE_HEADER_SZ) {
  7561. fragSz = headerSz + certSz + extSz + certChainSz;
  7562. }
  7563. #ifdef WOLFSSL_DTLS13
  7564. else if (ssl->options.dtls){
  7565. /* short-circuit the fragmentation logic here. DTLS
  7566. fragmentation will be done in dtls13HandshakeSend() */
  7567. fragSz = headerSz + certSz + extSz + certChainSz;
  7568. }
  7569. #endif /* WOLFSSL_DTLS13 */
  7570. else {
  7571. fragSz = maxFragment - HANDSHAKE_HEADER_SZ;
  7572. }
  7573. sendSz += fragSz + HANDSHAKE_HEADER_SZ;
  7574. i += HANDSHAKE_HEADER_SZ;
  7575. #ifdef WOLFSSL_DTLS13
  7576. if (ssl->options.dtls) {
  7577. sendSz += DTLS_HANDSHAKE_EXTRA;
  7578. i += DTLS_HANDSHAKE_EXTRA;
  7579. }
  7580. #endif /* WOLFSSL_DTLS13 */
  7581. }
  7582. else {
  7583. fragSz = min(length, maxFragment);
  7584. sendSz += fragSz;
  7585. }
  7586. sendSz += MAX_MSG_EXTRA;
  7587. /* Check buffers are big enough and grow if needed. */
  7588. if ((ret = CheckAvailableSize(ssl, sendSz)) != 0)
  7589. return ret;
  7590. /* Get position in output buffer to write new message to. */
  7591. output = GetOutputBuffer(ssl);
  7592. if (ssl->fragOffset == 0) {
  7593. AddTls13FragHeaders(output, fragSz, 0, payloadSz, certificate, ssl);
  7594. /* Request context. */
  7595. output[i++] = certReqCtxLen;
  7596. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  7597. if (certReqCtxLen > 0) {
  7598. XMEMCPY(output + i, certReqCtx, certReqCtxLen);
  7599. i += certReqCtxLen;
  7600. }
  7601. #endif
  7602. length -= OPAQUE8_LEN + certReqCtxLen;
  7603. fragSz -= OPAQUE8_LEN + certReqCtxLen;
  7604. /* Certificate list length. */
  7605. c32to24(listSz, output + i);
  7606. i += CERT_HEADER_SZ;
  7607. length -= CERT_HEADER_SZ;
  7608. fragSz -= CERT_HEADER_SZ;
  7609. /* Leaf certificate data length. */
  7610. if (certSz > 0) {
  7611. c32to24(certSz, output + i);
  7612. i += CERT_HEADER_SZ;
  7613. length -= CERT_HEADER_SZ;
  7614. fragSz -= CERT_HEADER_SZ;
  7615. }
  7616. }
  7617. else
  7618. AddTls13RecordHeader(output, fragSz, handshake, ssl);
  7619. if (certSz > 0 && ssl->fragOffset < certSz + extSz) {
  7620. /* Put in the leaf certificate with extensions. */
  7621. word32 copySz = AddCertExt(ssl, ssl->buffers.certificate->buffer,
  7622. certSz, extSz, ssl->fragOffset, fragSz, output + i);
  7623. i += copySz;
  7624. ssl->fragOffset += copySz;
  7625. length -= copySz;
  7626. fragSz -= copySz;
  7627. if (ssl->fragOffset == certSz + extSz)
  7628. FreeDer(&ssl->buffers.certExts);
  7629. }
  7630. if (certChainSz > 0 && fragSz > 0) {
  7631. /* Put in the CA certificates with empty extensions. */
  7632. while (fragSz > 0) {
  7633. word32 l;
  7634. if (offset == len + OPAQUE16_LEN) {
  7635. /* Find next CA certificate to write out. */
  7636. offset = 0;
  7637. /* Point to the start of current cert in chain buffer. */
  7638. p = ssl->buffers.certChain->buffer + idx;
  7639. len = NextCert(ssl->buffers.certChain->buffer,
  7640. ssl->buffers.certChain->length, &idx);
  7641. if (len == 0)
  7642. break;
  7643. }
  7644. /* Write out certificate and empty extension. */
  7645. l = AddCertExt(ssl, p, len, OPAQUE16_LEN, offset, fragSz,
  7646. output + i);
  7647. i += l;
  7648. ssl->fragOffset += l;
  7649. length -= l;
  7650. fragSz -= l;
  7651. offset += l;
  7652. }
  7653. }
  7654. if ((int)i - RECORD_HEADER_SZ < 0) {
  7655. WOLFSSL_MSG("Send Cert bad inputSz");
  7656. return BUFFER_E;
  7657. }
  7658. #ifdef WOLFSSL_DTLS13
  7659. if (ssl->options.dtls) {
  7660. /* DTLS1.3 uses a separate variable and logic for fragments */
  7661. ssl->options.buildingMsg = 0;
  7662. ssl->fragOffset = 0;
  7663. ret = Dtls13HandshakeSend(ssl, output, (word16)sendSz, (word16)i,
  7664. certificate, 1);
  7665. }
  7666. else
  7667. #endif /* WOLFSSL_DTLS13 */
  7668. {
  7669. /* This message is always encrypted. */
  7670. sendSz = BuildTls13Message(ssl, output, sendSz,
  7671. output + RECORD_HEADER_SZ, i - RECORD_HEADER_SZ, handshake, 1,
  7672. 0, 0);
  7673. if (sendSz < 0)
  7674. return sendSz;
  7675. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  7676. if (ssl->hsInfoOn)
  7677. AddPacketName(ssl, "Certificate");
  7678. if (ssl->toInfoOn) {
  7679. ret = AddPacketInfo(ssl, "Certificate", handshake, output,
  7680. sendSz, WRITE_PROTO, 0, ssl->heap);
  7681. if (ret != 0)
  7682. return ret;
  7683. }
  7684. #endif
  7685. ssl->buffers.outputBuffer.length += sendSz;
  7686. ssl->options.buildingMsg = 0;
  7687. if (!ssl->options.groupMessages)
  7688. ret = SendBuffered(ssl);
  7689. }
  7690. }
  7691. if (ret != WANT_WRITE) {
  7692. /* Clean up the fragment offset. */
  7693. ssl->options.buildingMsg = 0;
  7694. ssl->fragOffset = 0;
  7695. if (ssl->options.side == WOLFSSL_SERVER_END)
  7696. ssl->options.serverState = SERVER_CERT_COMPLETE;
  7697. }
  7698. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  7699. if (ssl->options.side == WOLFSSL_CLIENT_END && ssl->certReqCtx != NULL) {
  7700. CertReqCtx* ctx = ssl->certReqCtx;
  7701. ssl->certReqCtx = ssl->certReqCtx->next;
  7702. XFREE(ctx, ssl->heap, DYNAMIC_TYPE_TMP_BUFFER);
  7703. }
  7704. #endif
  7705. WOLFSSL_LEAVE("SendTls13Certificate", ret);
  7706. WOLFSSL_END(WC_FUNC_CERTIFICATE_SEND);
  7707. return ret;
  7708. }
  7709. #if (!defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_ED25519) || \
  7710. defined(HAVE_ED448) || defined(HAVE_PQC)) && \
  7711. (!defined(NO_WOLFSSL_SERVER) || !defined(WOLFSSL_NO_CLIENT_AUTH))
  7712. typedef struct Scv13Args {
  7713. byte* output; /* not allocated */
  7714. byte* verify; /* not allocated */
  7715. word32 idx;
  7716. word32 sigLen;
  7717. int sendSz;
  7718. word16 length;
  7719. byte sigAlgo;
  7720. byte* sigData;
  7721. word16 sigDataSz;
  7722. #ifdef WOLFSSL_DUAL_ALG_CERTS
  7723. byte altSigAlgo;
  7724. word16 altSigLen; /* Only used in the case of both native and alt. */
  7725. #endif
  7726. } Scv13Args;
  7727. static void FreeScv13Args(WOLFSSL* ssl, void* pArgs)
  7728. {
  7729. Scv13Args* args = (Scv13Args*)pArgs;
  7730. (void)ssl;
  7731. if (args && args->sigData) {
  7732. XFREE(args->sigData, ssl->heap, DYNAMIC_TYPE_SIGNATURE);
  7733. args->sigData = NULL;
  7734. }
  7735. }
  7736. /* handle generation TLS v1.3 certificate_verify (15) */
  7737. /* Send the TLS v1.3 CertificateVerify message.
  7738. * A hash of all the message so far is used.
  7739. * The signed data is:
  7740. * 0x20 * 64 | context string | 0x00 | hash of messages
  7741. * This message is always encrypted in TLS v1.3.
  7742. *
  7743. * ssl The SSL/TLS object.
  7744. * returns 0 on success, otherwise failure.
  7745. */
  7746. static int SendTls13CertificateVerify(WOLFSSL* ssl)
  7747. {
  7748. int ret = 0;
  7749. buffer* sig = &ssl->buffers.sig;
  7750. #ifdef WOLFSSL_ASYNC_CRYPT
  7751. Scv13Args* args = NULL;
  7752. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  7753. #else
  7754. Scv13Args args[1];
  7755. #endif
  7756. #ifdef WOLFSSL_DTLS13
  7757. int recordLayerHdrExtra;
  7758. #endif /* WOLFSSL_DTLS13 */
  7759. WOLFSSL_START(WC_FUNC_CERTIFICATE_VERIFY_SEND);
  7760. WOLFSSL_ENTER("SendTls13CertificateVerify");
  7761. ssl->options.buildingMsg = 1;
  7762. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  7763. ret = tsip_Tls13SendCertVerify(ssl);
  7764. if (ret != CRYPTOCB_UNAVAILABLE) {
  7765. goto exit_scv;
  7766. }
  7767. ret = 0;
  7768. #endif /* WOLFSSL_RENESAS_TSIP_TLS */
  7769. #ifdef WOLFSSL_DTLS13
  7770. /* can be negative */
  7771. if (ssl->options.dtls)
  7772. recordLayerHdrExtra = Dtls13GetRlHeaderLength(ssl, 1) - RECORD_HEADER_SZ;
  7773. else
  7774. recordLayerHdrExtra = 0;
  7775. #endif /* WOLFSSL_DTLS13 */
  7776. #ifdef WOLFSSL_ASYNC_CRYPT
  7777. if (ssl->async == NULL) {
  7778. ssl->async = (struct WOLFSSL_ASYNC*)
  7779. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  7780. DYNAMIC_TYPE_ASYNC);
  7781. if (ssl->async == NULL)
  7782. ERROR_OUT(MEMORY_E, exit_scv);
  7783. }
  7784. args = (Scv13Args*)ssl->async->args;
  7785. ret = wolfSSL_AsyncPop(ssl, &ssl->options.asyncState);
  7786. if (ret != WC_NO_PENDING_E) {
  7787. /* Check for error */
  7788. if (ret < 0)
  7789. goto exit_scv;
  7790. }
  7791. else
  7792. #endif
  7793. {
  7794. /* Reset state */
  7795. ret = 0;
  7796. ssl->options.asyncState = TLS_ASYNC_BEGIN;
  7797. XMEMSET(args, 0, sizeof(Scv13Args));
  7798. #ifdef WOLFSSL_ASYNC_CRYPT
  7799. ssl->async->freeArgs = FreeScv13Args;
  7800. #endif
  7801. }
  7802. switch(ssl->options.asyncState)
  7803. {
  7804. case TLS_ASYNC_BEGIN:
  7805. {
  7806. if (ssl->options.sendVerify == SEND_BLANK_CERT) {
  7807. return 0; /* sent blank cert, can't verify */
  7808. }
  7809. args->sendSz = MAX_CERT_VERIFY_SZ + MAX_MSG_EXTRA;
  7810. /* Always encrypted. */
  7811. args->sendSz += MAX_MSG_EXTRA;
  7812. /* check for available size */
  7813. if ((ret = CheckAvailableSize(ssl, args->sendSz)) != 0) {
  7814. goto exit_scv;
  7815. }
  7816. /* get output buffer */
  7817. args->output = GetOutputBuffer(ssl);
  7818. /* Advance state and proceed */
  7819. ssl->options.asyncState = TLS_ASYNC_BUILD;
  7820. } /* case TLS_ASYNC_BEGIN */
  7821. FALL_THROUGH;
  7822. case TLS_ASYNC_BUILD:
  7823. {
  7824. int rem = ssl->buffers.outputBuffer.bufferSize
  7825. - ssl->buffers.outputBuffer.length
  7826. - RECORD_HEADER_SZ - HANDSHAKE_HEADER_SZ;
  7827. /* idx is used to track verify pointer offset to output */
  7828. args->idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  7829. args->verify =
  7830. &args->output[RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ];
  7831. #ifdef WOLFSSL_DTLS13
  7832. if (ssl->options.dtls) {
  7833. rem -= recordLayerHdrExtra + DTLS_HANDSHAKE_EXTRA;
  7834. args->idx += recordLayerHdrExtra + DTLS_HANDSHAKE_EXTRA;
  7835. args->verify += recordLayerHdrExtra + DTLS_HANDSHAKE_EXTRA;
  7836. }
  7837. #endif /* WOLFSSL_DTLS13 */
  7838. if (ssl->buffers.key == NULL) {
  7839. #ifdef HAVE_PK_CALLBACKS
  7840. if (wolfSSL_CTX_IsPrivatePkSet(ssl->ctx))
  7841. args->length = (word16)GetPrivateKeySigSize(ssl);
  7842. else
  7843. #endif
  7844. ERROR_OUT(NO_PRIVATE_KEY, exit_scv);
  7845. }
  7846. else {
  7847. #ifdef WOLFSSL_DUAL_ALG_CERTS
  7848. if (wolfSSL_is_server(ssl) &&
  7849. ssl->sigSpec != NULL &&
  7850. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_ALTERNATIVE) {
  7851. /* In the case of alternative, we swap in the alt. */
  7852. if (ssl->ctx->altPrivateKey == NULL) {
  7853. ERROR_OUT(NO_PRIVATE_KEY, exit_scv);
  7854. }
  7855. ssl->buffers.keyType = ssl->buffers.altKeyType;
  7856. ssl->buffers.keySz = ssl->buffers.altKeySz;
  7857. /* If we own it, free key before overriding it. */
  7858. if (ssl->buffers.weOwnKey) {
  7859. FreeDer(&ssl->buffers.key);
  7860. }
  7861. /* Transfer ownership. ssl->ctx always owns the alt private
  7862. * key. */
  7863. ssl->buffers.key = ssl->ctx->altPrivateKey;
  7864. ssl->ctx->altPrivateKey = NULL;
  7865. ssl->buffers.weOwnKey = 1;
  7866. ssl->buffers.weOwnAltKey = 0;
  7867. }
  7868. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  7869. ret = DecodePrivateKey(ssl, &args->length);
  7870. if (ret != 0)
  7871. goto exit_scv;
  7872. }
  7873. if (rem < 0 || args->length > rem) {
  7874. ERROR_OUT(BUFFER_E, exit_scv);
  7875. }
  7876. if (args->length == 0) {
  7877. ERROR_OUT(NO_PRIVATE_KEY, exit_scv);
  7878. }
  7879. /* Add signature algorithm. */
  7880. if (ssl->hsType == DYNAMIC_TYPE_RSA)
  7881. args->sigAlgo = rsa_pss_sa_algo;
  7882. #ifdef HAVE_ECC
  7883. else if (ssl->hsType == DYNAMIC_TYPE_ECC) {
  7884. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  7885. if (ssl->buffers.keyType == sm2_sa_algo) {
  7886. args->sigAlgo = sm2_sa_algo;
  7887. }
  7888. else
  7889. #endif
  7890. {
  7891. args->sigAlgo = ecc_dsa_sa_algo;
  7892. }
  7893. }
  7894. #endif
  7895. #ifdef HAVE_ED25519
  7896. else if (ssl->hsType == DYNAMIC_TYPE_ED25519)
  7897. args->sigAlgo = ed25519_sa_algo;
  7898. #endif
  7899. #ifdef HAVE_ED448
  7900. else if (ssl->hsType == DYNAMIC_TYPE_ED448)
  7901. args->sigAlgo = ed448_sa_algo;
  7902. #endif
  7903. #if defined(HAVE_PQC)
  7904. #if defined(HAVE_FALCON)
  7905. else if (ssl->hsType == DYNAMIC_TYPE_FALCON) {
  7906. falcon_key* fkey = (falcon_key*)ssl->hsKey;
  7907. byte level = 0;
  7908. if (wc_falcon_get_level(fkey, &level) != 0) {
  7909. ERROR_OUT(ALGO_ID_E, exit_scv);
  7910. }
  7911. if (level == 1) {
  7912. args->sigAlgo = falcon_level1_sa_algo;
  7913. }
  7914. else if (level == 5) {
  7915. args->sigAlgo = falcon_level5_sa_algo;
  7916. }
  7917. else {
  7918. ERROR_OUT(ALGO_ID_E, exit_scv);
  7919. }
  7920. }
  7921. #endif /* HAVE_FALCON */
  7922. #if defined(HAVE_DILITHIUM)
  7923. else if (ssl->hsType == DYNAMIC_TYPE_DILITHIUM) {
  7924. dilithium_key* fkey = (dilithium_key*)ssl->hsKey;
  7925. byte level = 0;
  7926. if (wc_dilithium_get_level(fkey, &level) != 0) {
  7927. ERROR_OUT(ALGO_ID_E, exit_scv);
  7928. }
  7929. if (level == 2) {
  7930. args->sigAlgo = dilithium_level2_sa_algo;
  7931. }
  7932. else if (level == 3) {
  7933. args->sigAlgo = dilithium_level3_sa_algo;
  7934. }
  7935. else if (level == 5) {
  7936. args->sigAlgo = dilithium_level5_sa_algo;
  7937. }
  7938. else {
  7939. ERROR_OUT(ALGO_ID_E, exit_scv);
  7940. }
  7941. }
  7942. #endif /* HAVE_DILITHIUM */
  7943. #endif /* HAVE_PQC */
  7944. else {
  7945. ERROR_OUT(ALGO_ID_E, exit_scv);
  7946. }
  7947. #ifdef WOLFSSL_DUAL_ALG_CERTS
  7948. if (ssl->peerSigSpec == NULL) {
  7949. /* The peer did not respond. We didn't send CKS or they don't
  7950. * support it. Either way, we do not need to handle dual
  7951. * key/sig case. */
  7952. ssl->sigSpec = NULL;
  7953. ssl->sigSpecSz = 0;
  7954. }
  7955. if (wolfSSL_is_server(ssl) &&
  7956. ssl->sigSpec != NULL &&
  7957. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  7958. /* The native was already decoded. Now we need to do the
  7959. * alternative. Note that no swap was done because this case is
  7960. * both native and alternative, not just alternative. */
  7961. if (ssl->ctx->altPrivateKey == NULL) {
  7962. ERROR_OUT(NO_PRIVATE_KEY, exit_scv);
  7963. }
  7964. if (ssl->buffers.altKeyType == falcon_level1_sa_algo ||
  7965. ssl->buffers.altKeyType == falcon_level5_sa_algo ||
  7966. ssl->buffers.altKeyType == dilithium_level2_sa_algo ||
  7967. ssl->buffers.altKeyType == dilithium_level3_sa_algo ||
  7968. ssl->buffers.altKeyType == dilithium_level5_sa_algo) {
  7969. args->altSigAlgo = ssl->buffers.altKeyType;
  7970. }
  7971. else {
  7972. ERROR_OUT(ALGO_ID_E, exit_scv);
  7973. }
  7974. /* After this call, args->altSigLen has the length we need for
  7975. * the alternative signature. */
  7976. ret = DecodeAltPrivateKey(ssl, &args->altSigLen);
  7977. if (ret != 0)
  7978. goto exit_scv;
  7979. EncodeDualSigAlg(args->sigAlgo, args->altSigAlgo, args->verify);
  7980. if (args->verify[0] == 0) {
  7981. ERROR_OUT(ALGO_ID_E, exit_scv);
  7982. }
  7983. }
  7984. else
  7985. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  7986. EncodeSigAlg(ssl->options.hashAlgo, args->sigAlgo,
  7987. args->verify);
  7988. if (args->sigData == NULL) {
  7989. if (ssl->hsType == DYNAMIC_TYPE_RSA) {
  7990. int sigLen = MAX_SIG_DATA_SZ;
  7991. if (args->length > MAX_SIG_DATA_SZ)
  7992. sigLen = args->length;
  7993. args->sigData = (byte*)XMALLOC(sigLen, ssl->heap,
  7994. DYNAMIC_TYPE_SIGNATURE);
  7995. }
  7996. else {
  7997. args->sigData = (byte*)XMALLOC(MAX_SIG_DATA_SZ, ssl->heap,
  7998. DYNAMIC_TYPE_SIGNATURE);
  7999. }
  8000. if (args->sigData == NULL) {
  8001. ERROR_OUT(MEMORY_E, exit_scv);
  8002. }
  8003. }
  8004. /* Create the data to be signed. */
  8005. ret = CreateSigData(ssl, args->sigData, &args->sigDataSz, 0);
  8006. if (ret != 0)
  8007. goto exit_scv;
  8008. #ifndef NO_RSA
  8009. if (ssl->hsType == DYNAMIC_TYPE_RSA) {
  8010. /* build encoded signature buffer */
  8011. sig->length = WC_MAX_DIGEST_SIZE;
  8012. sig->buffer = (byte*)XMALLOC(sig->length, ssl->heap,
  8013. DYNAMIC_TYPE_SIGNATURE);
  8014. if (sig->buffer == NULL) {
  8015. ERROR_OUT(MEMORY_E, exit_scv);
  8016. }
  8017. ret = CreateRSAEncodedSig(sig->buffer, args->sigData,
  8018. args->sigDataSz, args->sigAlgo, ssl->options.hashAlgo);
  8019. if (ret < 0)
  8020. goto exit_scv;
  8021. sig->length = ret;
  8022. ret = 0;
  8023. /* Maximum size of RSA Signature. */
  8024. args->sigLen = args->length;
  8025. }
  8026. #endif /* !NO_RSA */
  8027. #ifdef HAVE_ECC
  8028. if (ssl->hsType == DYNAMIC_TYPE_ECC) {
  8029. sig->length = args->sendSz - args->idx - HASH_SIG_SIZE -
  8030. VERIFY_HEADER;
  8031. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8032. if (ssl->buffers.keyType != sm2_sa_algo)
  8033. #endif
  8034. {
  8035. ret = CreateECCEncodedSig(args->sigData,
  8036. args->sigDataSz, ssl->options.hashAlgo);
  8037. if (ret < 0)
  8038. goto exit_scv;
  8039. args->sigDataSz = (word16)ret;
  8040. ret = 0;
  8041. }
  8042. }
  8043. #endif /* HAVE_ECC */
  8044. #ifdef HAVE_ED25519
  8045. if (ssl->hsType == DYNAMIC_TYPE_ED25519) {
  8046. ret = Ed25519CheckPubKey(ssl);
  8047. if (ret < 0) {
  8048. ERROR_OUT(ret, exit_scv);
  8049. }
  8050. sig->length = ED25519_SIG_SIZE;
  8051. }
  8052. #endif /* HAVE_ED25519 */
  8053. #ifdef HAVE_ED448
  8054. if (ssl->hsType == DYNAMIC_TYPE_ED448) {
  8055. ret = Ed448CheckPubKey(ssl);
  8056. if (ret < 0) {
  8057. ERROR_OUT(ret, exit_scv);
  8058. }
  8059. sig->length = ED448_SIG_SIZE;
  8060. }
  8061. #endif /* HAVE_ED448 */
  8062. #if defined(HAVE_PQC)
  8063. #if defined(HAVE_FALCON)
  8064. if (ssl->hsType == DYNAMIC_TYPE_FALCON) {
  8065. sig->length = FALCON_MAX_SIG_SIZE;
  8066. }
  8067. #endif
  8068. #if defined(HAVE_DILITHIUM)
  8069. if (ssl->hsType == DYNAMIC_TYPE_DILITHIUM) {
  8070. sig->length = DILITHIUM_MAX_SIG_SIZE;
  8071. }
  8072. #endif
  8073. #endif /* HAVE_PQC */
  8074. /* Advance state and proceed */
  8075. ssl->options.asyncState = TLS_ASYNC_DO;
  8076. } /* case TLS_ASYNC_BUILD */
  8077. FALL_THROUGH;
  8078. case TLS_ASYNC_DO:
  8079. {
  8080. #ifdef HAVE_ECC
  8081. if (ssl->hsType == DYNAMIC_TYPE_ECC) {
  8082. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8083. if (ssl->buffers.keyType == sm2_sa_algo) {
  8084. ret = Sm2wSm3Sign(ssl, TLS13_SM2_SIG_ID,
  8085. TLS13_SM2_SIG_ID_SZ, args->sigData, args->sigDataSz,
  8086. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8087. (word32*)&sig->length, (ecc_key*)ssl->hsKey, NULL);
  8088. }
  8089. else
  8090. #endif
  8091. {
  8092. ret = EccSign(ssl, args->sigData, args->sigDataSz,
  8093. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8094. (word32*)&sig->length, (ecc_key*)ssl->hsKey,
  8095. #ifdef HAVE_PK_CALLBACKS
  8096. ssl->buffers.key
  8097. #else
  8098. NULL
  8099. #endif
  8100. );
  8101. }
  8102. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8103. if (wolfSSL_is_server(ssl) &&
  8104. ssl->sigSpec != NULL &&
  8105. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  8106. if (ssl->hsAltType == DYNAMIC_TYPE_DILITHIUM) {
  8107. /* note the + sig->length; we are appending. */
  8108. ret = wc_dilithium_sign_msg(
  8109. args->sigData, args->sigDataSz,
  8110. args->verify + HASH_SIG_SIZE +
  8111. VERIFY_HEADER + sig->length,
  8112. (word32*)&args->altSigLen,
  8113. (dilithium_key*)ssl->hsAltKey, ssl->rng);
  8114. }
  8115. else if (ssl->hsAltType == DYNAMIC_TYPE_FALCON) {
  8116. /* note the sig->length; we are appending. */
  8117. ret = wc_falcon_sign_msg(args->sigData, args->sigDataSz,
  8118. args->verify + HASH_SIG_SIZE +
  8119. VERIFY_HEADER + sig->length,
  8120. (word32*)&args->altSigLen,
  8121. (falcon_key*)ssl->hsAltKey,
  8122. ssl->rng);
  8123. }
  8124. }
  8125. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8126. args->length = (word16)sig->length;
  8127. }
  8128. #endif /* HAVE_ECC */
  8129. #ifdef HAVE_ED25519
  8130. if (ssl->hsType == DYNAMIC_TYPE_ED25519) {
  8131. ret = Ed25519Sign(ssl, args->sigData, args->sigDataSz,
  8132. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8133. (word32*)&sig->length, (ed25519_key*)ssl->hsKey,
  8134. #ifdef HAVE_PK_CALLBACKS
  8135. ssl->buffers.key
  8136. #else
  8137. NULL
  8138. #endif
  8139. );
  8140. args->length = (word16)sig->length;
  8141. }
  8142. #endif
  8143. #ifdef HAVE_ED448
  8144. if (ssl->hsType == DYNAMIC_TYPE_ED448) {
  8145. ret = Ed448Sign(ssl, args->sigData, args->sigDataSz,
  8146. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8147. (word32*)&sig->length, (ed448_key*)ssl->hsKey,
  8148. #ifdef HAVE_PK_CALLBACKS
  8149. ssl->buffers.key
  8150. #else
  8151. NULL
  8152. #endif
  8153. );
  8154. args->length = (word16)sig->length;
  8155. }
  8156. #endif
  8157. #if defined(HAVE_PQC)
  8158. #if defined(HAVE_FALCON)
  8159. if (ssl->hsType == DYNAMIC_TYPE_FALCON) {
  8160. ret = wc_falcon_sign_msg(args->sigData, args->sigDataSz,
  8161. args->verify + HASH_SIG_SIZE +
  8162. VERIFY_HEADER, (word32*)&sig->length,
  8163. (falcon_key*)ssl->hsKey, ssl->rng);
  8164. args->length = (word16)sig->length;
  8165. }
  8166. #endif
  8167. #if defined(HAVE_DILITHIUM)
  8168. if (ssl->hsType == DYNAMIC_TYPE_DILITHIUM) {
  8169. ret = wc_dilithium_sign_msg(args->sigData, args->sigDataSz,
  8170. args->verify + HASH_SIG_SIZE +
  8171. VERIFY_HEADER, (word32*)&sig->length,
  8172. (dilithium_key*)ssl->hsKey, ssl->rng);
  8173. args->length = (word16)sig->length;
  8174. }
  8175. #endif
  8176. #endif /* HAVE_PQC */
  8177. #ifndef NO_RSA
  8178. if (ssl->hsType == DYNAMIC_TYPE_RSA) {
  8179. ret = RsaSign(ssl, sig->buffer, (word32)sig->length,
  8180. args->verify + HASH_SIG_SIZE + VERIFY_HEADER, &args->sigLen,
  8181. args->sigAlgo, ssl->options.hashAlgo,
  8182. (RsaKey*)ssl->hsKey,
  8183. ssl->buffers.key
  8184. );
  8185. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8186. /* In the case of RSA, we need to do the CKS both case here
  8187. * BEFORE args->sigData is overwritten!! We keep the sig
  8188. * separate and then append later so we don't interfere with the
  8189. * checks below. */
  8190. if (wolfSSL_is_server(ssl) &&
  8191. ssl->sigSpec != NULL &&
  8192. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  8193. if (ssl->hsAltType == DYNAMIC_TYPE_DILITHIUM) {
  8194. /* note the + args->sigLen; we are appending. */
  8195. ret = wc_dilithium_sign_msg(args->sigData,
  8196. args->sigDataSz,
  8197. args->verify + HASH_SIG_SIZE + VERIFY_HEADER +
  8198. args->sigLen,
  8199. (word32*)&args->altSigLen,
  8200. (dilithium_key*)ssl->hsAltKey, ssl->rng);
  8201. }
  8202. else if (ssl->hsAltType == DYNAMIC_TYPE_FALCON) {
  8203. /* note the + args->sigLen; we are appending. */
  8204. ret = wc_falcon_sign_msg(args->sigData, args->sigDataSz,
  8205. args->verify + HASH_SIG_SIZE +
  8206. VERIFY_HEADER + args->sigLen,
  8207. (word32*)&args->altSigLen,
  8208. (falcon_key*)ssl->hsAltKey,
  8209. ssl->rng);
  8210. }
  8211. }
  8212. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8213. if (ret == 0) {
  8214. args->length = (word16)args->sigLen;
  8215. XMEMCPY(args->sigData,
  8216. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8217. args->sigLen);
  8218. }
  8219. }
  8220. #endif /* !NO_RSA */
  8221. /* Check for error */
  8222. if (ret != 0) {
  8223. goto exit_scv;
  8224. }
  8225. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8226. /* Add in length of the alt sig which will be appended to the sig */
  8227. args->length += args->altSigLen;
  8228. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8229. /* Add signature length. */
  8230. c16toa(args->length, args->verify + HASH_SIG_SIZE);
  8231. /* Advance state and proceed */
  8232. ssl->options.asyncState = TLS_ASYNC_VERIFY;
  8233. } /* case TLS_ASYNC_DO */
  8234. FALL_THROUGH;
  8235. case TLS_ASYNC_VERIFY:
  8236. {
  8237. #ifndef NO_RSA
  8238. if (ssl->hsType == DYNAMIC_TYPE_RSA) {
  8239. /* check for signature faults */
  8240. ret = VerifyRsaSign(ssl, args->sigData, args->sigLen,
  8241. sig->buffer, (word32)sig->length, args->sigAlgo,
  8242. ssl->options.hashAlgo, (RsaKey*)ssl->hsKey,
  8243. ssl->buffers.key
  8244. );
  8245. }
  8246. #endif /* !NO_RSA */
  8247. #if defined(HAVE_ECC) && defined(WOLFSSL_CHECK_SIG_FAULTS)
  8248. if (ssl->hsType == DYNAMIC_TYPE_ECC) {
  8249. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8250. if (ssl->buffers.keyType == sm2_sa_algo) {
  8251. ret = Sm2wSm3Verify(ssl, TLS13_SM2_SIG_ID,
  8252. TLS13_SM2_SIG_ID_SZ,
  8253. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8254. sig->length, args->sigData, args->sigDataSz,
  8255. (ecc_key*)ssl->hsKey, NULL);
  8256. }
  8257. else
  8258. #endif
  8259. {
  8260. ret = EccVerify(ssl,
  8261. args->verify + HASH_SIG_SIZE + VERIFY_HEADER,
  8262. sig->length, args->sigData, args->sigDataSz,
  8263. (ecc_key*)ssl->hsKey,
  8264. #ifdef HAVE_PK_CALLBACKS
  8265. ssl->buffers.key
  8266. #else
  8267. NULL
  8268. #endif
  8269. );
  8270. }
  8271. }
  8272. #endif
  8273. /* Check for error */
  8274. if (ret != 0) {
  8275. goto exit_scv;
  8276. }
  8277. /* Advance state and proceed */
  8278. ssl->options.asyncState = TLS_ASYNC_FINALIZE;
  8279. } /* case TLS_ASYNC_VERIFY */
  8280. FALL_THROUGH;
  8281. case TLS_ASYNC_FINALIZE:
  8282. {
  8283. /* Put the record and handshake headers on. */
  8284. AddTls13Headers(args->output, args->length + HASH_SIG_SIZE +
  8285. VERIFY_HEADER, certificate_verify, ssl);
  8286. args->sendSz = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ +
  8287. args->length + HASH_SIG_SIZE + VERIFY_HEADER;
  8288. #ifdef WOLFSSL_DTLS13
  8289. if (ssl->options.dtls)
  8290. args->sendSz += recordLayerHdrExtra + DTLS_HANDSHAKE_EXTRA;
  8291. #endif /* WOLFSSL_DTLS13 */
  8292. /* Advance state and proceed */
  8293. ssl->options.asyncState = TLS_ASYNC_END;
  8294. } /* case TLS_ASYNC_FINALIZE */
  8295. FALL_THROUGH;
  8296. case TLS_ASYNC_END:
  8297. {
  8298. #ifdef WOLFSSL_DTLS13
  8299. if (ssl->options.dtls) {
  8300. ssl->options.buildingMsg = 0;
  8301. ret = Dtls13HandshakeSend(ssl, args->output,
  8302. MAX_CERT_VERIFY_SZ + MAX_MSG_EXTRA + MAX_MSG_EXTRA,
  8303. (word16)args->sendSz, certificate_verify, 1);
  8304. if (ret != 0)
  8305. goto exit_scv;
  8306. break;
  8307. }
  8308. #endif /* WOLFSSL_DTLS13 */
  8309. /* This message is always encrypted. */
  8310. ret = BuildTls13Message(ssl, args->output,
  8311. MAX_CERT_VERIFY_SZ + MAX_MSG_EXTRA,
  8312. args->output + RECORD_HEADER_SZ,
  8313. args->sendSz - RECORD_HEADER_SZ, handshake,
  8314. 1, 0, 0);
  8315. if (ret < 0) {
  8316. goto exit_scv;
  8317. }
  8318. else {
  8319. args->sendSz = ret;
  8320. ret = 0;
  8321. }
  8322. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  8323. if (ssl->hsInfoOn)
  8324. AddPacketName(ssl, "CertificateVerify");
  8325. if (ssl->toInfoOn) {
  8326. ret = AddPacketInfo(ssl, "CertificateVerify", handshake,
  8327. args->output, args->sendSz, WRITE_PROTO, 0,
  8328. ssl->heap);
  8329. if (ret != 0)
  8330. goto exit_scv;
  8331. }
  8332. #endif
  8333. ssl->buffers.outputBuffer.length += args->sendSz;
  8334. ssl->options.buildingMsg = 0;
  8335. if (!ssl->options.groupMessages)
  8336. ret = SendBuffered(ssl);
  8337. break;
  8338. }
  8339. default:
  8340. ret = INPUT_CASE_ERROR;
  8341. } /* switch(ssl->options.asyncState) */
  8342. exit_scv:
  8343. WOLFSSL_LEAVE("SendTls13CertificateVerify", ret);
  8344. WOLFSSL_END(WC_FUNC_CERTIFICATE_VERIFY_SEND);
  8345. #ifdef WOLFSSL_ASYNC_CRYPT
  8346. /* Handle async operation */
  8347. if (ret == WC_PENDING_E) {
  8348. return ret;
  8349. }
  8350. #endif /* WOLFSSL_ASYNC_CRYPT */
  8351. /* Final cleanup */
  8352. FreeScv13Args(ssl, args);
  8353. FreeKeyExchange(ssl);
  8354. #ifdef WOLFSSL_ASYNC_IO
  8355. /* Cleanup async */
  8356. FreeAsyncCtx(ssl, 0);
  8357. #endif
  8358. if (ret != 0) {
  8359. WOLFSSL_ERROR_VERBOSE(ret);
  8360. }
  8361. return ret;
  8362. }
  8363. #endif
  8364. #endif /* !NO_WOLFSSL_CLIENT || !NO_WOLFSSL_SERVER */
  8365. #if !defined(NO_WOLFSSL_CLIENT) || !defined(WOLFSSL_NO_CLIENT_AUTH)
  8366. /* handle processing TLS v1.3 certificate (11) */
  8367. /* Parse and handle a TLS v1.3 Certificate message.
  8368. *
  8369. * ssl The SSL/TLS object.
  8370. * input The message buffer.
  8371. * inOutIdx On entry, the index into the message buffer of Certificate.
  8372. * On exit, the index of byte after the Certificate message.
  8373. * totalSz The length of the current handshake message.
  8374. * returns 0 on success and otherwise failure.
  8375. */
  8376. static int DoTls13Certificate(WOLFSSL* ssl, byte* input, word32* inOutIdx,
  8377. word32 totalSz)
  8378. {
  8379. int ret = 0;
  8380. WOLFSSL_START(WC_FUNC_CERTIFICATE_DO);
  8381. WOLFSSL_ENTER("DoTls13Certificate");
  8382. #ifdef WOLFSSL_DTLS13
  8383. if (ssl->options.dtls && ssl->options.handShakeDone) {
  8384. /* certificate needs some special care after the handshake */
  8385. ret = Dtls13RtxProcessingCertificate(
  8386. ssl, input + *inOutIdx, totalSz);
  8387. }
  8388. #endif /* WOLFSSL_DTLS13 */
  8389. if (ret == 0)
  8390. ret = ProcessPeerCerts(ssl, input, inOutIdx, totalSz);
  8391. if (ret == 0) {
  8392. #if !defined(NO_WOLFSSL_CLIENT)
  8393. if (ssl->options.side == WOLFSSL_CLIENT_END)
  8394. ssl->options.serverState = SERVER_CERT_COMPLETE;
  8395. #endif
  8396. #if !defined(NO_WOLFSSL_SERVER) && defined(WOLFSSL_POST_HANDSHAKE_AUTH)
  8397. if (ssl->options.side == WOLFSSL_SERVER_END &&
  8398. ssl->options.handShakeState == HANDSHAKE_DONE) {
  8399. /* reset handshake states */
  8400. ssl->options.serverState = SERVER_FINISHED_COMPLETE;
  8401. ssl->options.acceptState = TICKET_SENT;
  8402. ssl->options.handShakeState = SERVER_FINISHED_COMPLETE;
  8403. }
  8404. #endif
  8405. }
  8406. WOLFSSL_LEAVE("DoTls13Certificate", ret);
  8407. WOLFSSL_END(WC_FUNC_CERTIFICATE_DO);
  8408. return ret;
  8409. }
  8410. #endif
  8411. #if !defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_ED25519) || \
  8412. defined(HAVE_ED448)
  8413. typedef struct Dcv13Args {
  8414. byte* output; /* not allocated */
  8415. word32 sendSz;
  8416. word16 sz;
  8417. word32 sigSz;
  8418. word32 idx;
  8419. word32 begin;
  8420. byte* sigData;
  8421. word16 sigDataSz;
  8422. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8423. byte altSigAlgo;
  8424. byte* altSigData;
  8425. word16 altSigDataSz;
  8426. word16 altSignatureSz;
  8427. byte altPeerAuthGood;
  8428. #endif
  8429. } Dcv13Args;
  8430. static void FreeDcv13Args(WOLFSSL* ssl, void* pArgs)
  8431. {
  8432. Dcv13Args* args = (Dcv13Args*)pArgs;
  8433. if (args && args->sigData != NULL) {
  8434. XFREE(args->sigData, ssl->heap, DYNAMIC_TYPE_SIGNATURE);
  8435. args->sigData = NULL;
  8436. }
  8437. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8438. if (args && args->altSigData != NULL) {
  8439. XFREE(args->altSigData, ssl->heap, DYNAMIC_TYPE_SIGNATURE);
  8440. args->altSigData = NULL;
  8441. }
  8442. #endif
  8443. (void)ssl;
  8444. }
  8445. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8446. /* ssl->peerCert->sapkiDer is the alternative public key. Hopefully it is a
  8447. * dilithium public key. Convert it into a usable public key. */
  8448. static int decodeDilithiumKey(WOLFSSL* ssl, int level)
  8449. {
  8450. int keyRet;
  8451. word32 tmpIdx = 0;
  8452. if (ssl->peerDilithiumKeyPresent)
  8453. return INVALID_PARAMETER;
  8454. keyRet = AllocKey(ssl, DYNAMIC_TYPE_DILITHIUM,
  8455. (void**)&ssl->peerDilithiumKey);
  8456. if (keyRet != 0)
  8457. return PEER_KEY_ERROR;
  8458. ssl->peerDilithiumKeyPresent = 1;
  8459. keyRet = wc_dilithium_init(ssl->peerDilithiumKey);
  8460. if (keyRet != 0)
  8461. return PEER_KEY_ERROR;
  8462. keyRet = wc_dilithium_set_level(ssl->peerDilithiumKey, level);
  8463. if (keyRet != 0)
  8464. return PEER_KEY_ERROR;
  8465. keyRet = wc_Dilithium_PublicKeyDecode(ssl->peerCert.sapkiDer, &tmpIdx,
  8466. ssl->peerDilithiumKey,
  8467. ssl->peerCert.sapkiLen);
  8468. if (keyRet != 0)
  8469. return PEER_KEY_ERROR;
  8470. return 0;
  8471. }
  8472. /* ssl->peerCert->sapkiDer is the alternative public key. Hopefully it is a
  8473. * falcon public key. Convert it into a usable public key. */
  8474. static int decodeFalconKey(WOLFSSL* ssl, int level)
  8475. {
  8476. int keyRet;
  8477. word32 tmpIdx = 0;
  8478. if (ssl->peerFalconKeyPresent)
  8479. return INVALID_PARAMETER;
  8480. keyRet = AllocKey(ssl, DYNAMIC_TYPE_FALCON, (void**)&ssl->peerFalconKey);
  8481. if (keyRet != 0)
  8482. return PEER_KEY_ERROR;
  8483. ssl->peerFalconKeyPresent = 1;
  8484. keyRet = wc_falcon_init(ssl->peerFalconKey);
  8485. if (keyRet != 0)
  8486. return PEER_KEY_ERROR;
  8487. keyRet = wc_falcon_set_level(ssl->peerFalconKey, level);
  8488. if (keyRet != 0)
  8489. return PEER_KEY_ERROR;
  8490. keyRet = wc_Falcon_PublicKeyDecode(ssl->peerCert.sapkiDer, &tmpIdx,
  8491. ssl->peerFalconKey,
  8492. ssl->peerCert.sapkiLen);
  8493. if (keyRet != 0)
  8494. return PEER_KEY_ERROR;
  8495. return 0;
  8496. }
  8497. #endif
  8498. /* handle processing TLS v1.3 certificate_verify (15) */
  8499. /* Parse and handle a TLS v1.3 CertificateVerify message.
  8500. *
  8501. * ssl The SSL/TLS object.
  8502. * input The message buffer.
  8503. * inOutIdx On entry, the index into the message buffer of
  8504. * CertificateVerify.
  8505. * On exit, the index of byte after the CertificateVerify message.
  8506. * totalSz The length of the current handshake message.
  8507. * returns 0 on success and otherwise failure.
  8508. */
  8509. static int DoTls13CertificateVerify(WOLFSSL* ssl, byte* input,
  8510. word32* inOutIdx, word32 totalSz)
  8511. {
  8512. int ret = 0;
  8513. buffer* sig = &ssl->buffers.sig;
  8514. #ifdef WOLFSSL_ASYNC_CRYPT
  8515. Dcv13Args* args = NULL;
  8516. WOLFSSL_ASSERT_SIZEOF_GE(ssl->async->args, *args);
  8517. #else
  8518. Dcv13Args args[1];
  8519. #endif
  8520. WOLFSSL_START(WC_FUNC_CERTIFICATE_VERIFY_DO);
  8521. WOLFSSL_ENTER("DoTls13CertificateVerify");
  8522. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  8523. ret = tsip_Tls13CertificateVerify(ssl, input, inOutIdx, totalSz);
  8524. if (ret != CRYPTOCB_UNAVAILABLE) {
  8525. goto exit_dcv;
  8526. }
  8527. ret = 0;
  8528. #endif
  8529. #ifdef WOLFSSL_ASYNC_CRYPT
  8530. if (ssl->async == NULL) {
  8531. ssl->async = (struct WOLFSSL_ASYNC*)
  8532. XMALLOC(sizeof(struct WOLFSSL_ASYNC), ssl->heap,
  8533. DYNAMIC_TYPE_ASYNC);
  8534. if (ssl->async == NULL)
  8535. ERROR_OUT(MEMORY_E, exit_dcv);
  8536. }
  8537. args = (Dcv13Args*)ssl->async->args;
  8538. ret = wolfSSL_AsyncPop(ssl, &ssl->options.asyncState);
  8539. if (ret != WC_NO_PENDING_E) {
  8540. /* Check for error */
  8541. if (ret < 0)
  8542. goto exit_dcv;
  8543. }
  8544. else
  8545. #endif
  8546. {
  8547. /* Reset state */
  8548. ret = 0;
  8549. ssl->options.asyncState = TLS_ASYNC_BEGIN;
  8550. XMEMSET(args, 0, sizeof(Dcv13Args));
  8551. ssl->options.peerHashAlgo = sha_mac;
  8552. ssl->options.peerSigAlgo = anonymous_sa_algo;
  8553. args->idx = *inOutIdx;
  8554. args->begin = *inOutIdx;
  8555. #ifdef WOLFSSL_ASYNC_CRYPT
  8556. ssl->async->freeArgs = FreeDcv13Args;
  8557. #endif
  8558. }
  8559. switch(ssl->options.asyncState)
  8560. {
  8561. case TLS_ASYNC_BEGIN:
  8562. {
  8563. #ifdef WOLFSSL_CALLBACKS
  8564. if (ssl->hsInfoOn) AddPacketName(ssl, "CertificateVerify");
  8565. if (ssl->toInfoOn) AddLateName("CertificateVerify",
  8566. &ssl->timeoutInfo);
  8567. #endif
  8568. /* Advance state and proceed */
  8569. ssl->options.asyncState = TLS_ASYNC_BUILD;
  8570. } /* case TLS_ASYNC_BEGIN */
  8571. FALL_THROUGH;
  8572. case TLS_ASYNC_BUILD:
  8573. {
  8574. int validSigAlgo;
  8575. /* Signature algorithm. */
  8576. if ((args->idx - args->begin) + ENUM_LEN + ENUM_LEN > totalSz) {
  8577. ERROR_OUT(BUFFER_ERROR, exit_dcv);
  8578. }
  8579. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8580. if (ssl->peerSigSpec == NULL) {
  8581. /* The peer did not respond. We didn't send CKS or they don't
  8582. * support it. Either way, we do not need to handle dual
  8583. * key/sig case. */
  8584. ssl->sigSpec = NULL;
  8585. ssl->sigSpecSz = 0;
  8586. }
  8587. /* If no CKS extension or either native or alternative, then just
  8588. * get a normal sigalgo. But if BOTH, then get the native and alt
  8589. * sig algos. */
  8590. if (wolfSSL_is_server(ssl) ||
  8591. ssl->sigSpec == NULL ||
  8592. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_NATIVE ||
  8593. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_ALTERNATIVE) {
  8594. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8595. ret = DecodeTls13SigAlg(input + args->idx,
  8596. &ssl->options.peerHashAlgo, &ssl->options.peerSigAlgo);
  8597. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8598. }
  8599. else {
  8600. ret = DecodeTls13HybridSigAlg(input + args->idx,
  8601. &ssl->options.peerHashAlgo,
  8602. &ssl->options.peerSigAlgo,
  8603. &args->altSigAlgo);
  8604. }
  8605. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8606. if (ret < 0)
  8607. goto exit_dcv;
  8608. args->idx += OPAQUE16_LEN;
  8609. /* Signature length. */
  8610. if ((args->idx - args->begin) + OPAQUE16_LEN > totalSz) {
  8611. ERROR_OUT(BUFFER_ERROR, exit_dcv);
  8612. }
  8613. ato16(input + args->idx, &args->sz);
  8614. args->idx += OPAQUE16_LEN;
  8615. /* Signature data. */
  8616. if ((args->idx - args->begin) + args->sz > totalSz ||
  8617. args->sz > ENCRYPT_LEN) {
  8618. ERROR_OUT(BUFFER_ERROR, exit_dcv);
  8619. }
  8620. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8621. if (!wolfSSL_is_server(ssl) &&
  8622. (ssl->sigSpec != NULL) &&
  8623. (*ssl->sigSpec != WOLFSSL_CKS_SIGSPEC_NATIVE)) {
  8624. word16 sa;
  8625. if (args->altSigAlgo == 0)
  8626. sa = ssl->options.peerSigAlgo;
  8627. else
  8628. sa = args->altSigAlgo;
  8629. switch(sa) {
  8630. case dilithium_level2_sa_algo:
  8631. ret = decodeDilithiumKey(ssl, 2);
  8632. break;
  8633. case dilithium_level3_sa_algo:
  8634. ret = decodeDilithiumKey(ssl, 3);
  8635. break;
  8636. case dilithium_level5_sa_algo:
  8637. ret = decodeDilithiumKey(ssl, 5);
  8638. break;
  8639. case falcon_level1_sa_algo:
  8640. ret = decodeFalconKey(ssl, 1);
  8641. break;
  8642. case falcon_level5_sa_algo:
  8643. ret = decodeFalconKey(ssl, 5);
  8644. break;
  8645. default:
  8646. ERROR_OUT(PEER_KEY_ERROR, exit_dcv);
  8647. break;
  8648. }
  8649. if (ret != 0)
  8650. ERROR_OUT(ret, exit_dcv);
  8651. if (*ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_ALTERNATIVE) {
  8652. /* Now swap in the alternative. We only support hybrid certs
  8653. * where native is RSA or ECC so check that either of those
  8654. * are present and then remove it. */
  8655. if (ssl->peerRsaKeyPresent &&
  8656. ssl->peerEccDsaKeyPresent) {
  8657. /* They shouldn't both be present. */
  8658. ERROR_OUT(PEER_KEY_ERROR, exit_dcv);
  8659. }
  8660. else if (ssl->peerRsaKeyPresent) {
  8661. FreeKey(ssl, DYNAMIC_TYPE_RSA,
  8662. (void**)&ssl->peerRsaKey);
  8663. ssl->peerRsaKeyPresent = 0;
  8664. }
  8665. else if (ssl->peerEccDsaKeyPresent) {
  8666. FreeKey(ssl, DYNAMIC_TYPE_ECC,
  8667. (void**)&ssl->peerEccDsaKey);
  8668. ssl->peerEccDsaKeyPresent = 0;
  8669. }
  8670. else {
  8671. ERROR_OUT(WOLFSSL_NOT_IMPLEMENTED, exit_dcv);
  8672. }
  8673. }
  8674. else if (*ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  8675. /* Use alternative public key to figure out the expected
  8676. * alt sig size. We only support Post-quantum key as SAPKI.
  8677. */
  8678. switch(sa) {
  8679. case dilithium_level2_sa_algo:
  8680. case dilithium_level3_sa_algo:
  8681. case dilithium_level5_sa_algo:
  8682. ret = wc_dilithium_sig_size(ssl->peerDilithiumKey);
  8683. break;
  8684. case falcon_level1_sa_algo:
  8685. case falcon_level5_sa_algo:
  8686. ret = wc_falcon_sig_size(ssl->peerFalconKey);
  8687. break;
  8688. default:
  8689. ERROR_OUT(PEER_KEY_ERROR, exit_dcv);
  8690. break;
  8691. }
  8692. if (ret <= 0) {
  8693. ERROR_OUT(PEER_KEY_ERROR, exit_dcv);
  8694. }
  8695. args->altSignatureSz = ret;
  8696. ret = 0;
  8697. }
  8698. else {
  8699. ERROR_OUT(WOLFSSL_NOT_IMPLEMENTED, exit_dcv);
  8700. }
  8701. }
  8702. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8703. /* Check for public key of required type. */
  8704. /* Assume invalid unless signature algo matches the key provided */
  8705. validSigAlgo = 0;
  8706. #ifdef HAVE_ED25519
  8707. if (ssl->options.peerSigAlgo == ed25519_sa_algo) {
  8708. WOLFSSL_MSG("Peer sent ED25519 sig");
  8709. validSigAlgo = (ssl->peerEd25519Key != NULL) &&
  8710. ssl->peerEd25519KeyPresent;
  8711. }
  8712. #endif
  8713. #ifdef HAVE_ED448
  8714. if (ssl->options.peerSigAlgo == ed448_sa_algo) {
  8715. WOLFSSL_MSG("Peer sent ED448 sig");
  8716. validSigAlgo = (ssl->peerEd448Key != NULL) &&
  8717. ssl->peerEd448KeyPresent;
  8718. }
  8719. #endif
  8720. #ifdef HAVE_ECC
  8721. if (ssl->options.peerSigAlgo == ecc_dsa_sa_algo) {
  8722. WOLFSSL_MSG("Peer sent ECC sig");
  8723. validSigAlgo = (ssl->peerEccDsaKey != NULL) &&
  8724. ssl->peerEccDsaKeyPresent;
  8725. }
  8726. #endif
  8727. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8728. if (ssl->options.peerSigAlgo == sm2_sa_algo) {
  8729. WOLFSSL_MSG("Peer sent SM2 sig");
  8730. validSigAlgo = (ssl->peerEccDsaKey != NULL) &&
  8731. ssl->peerEccDsaKeyPresent;
  8732. }
  8733. #endif
  8734. #ifdef HAVE_PQC
  8735. if (ssl->options.peerSigAlgo == falcon_level1_sa_algo) {
  8736. WOLFSSL_MSG("Peer sent Falcon Level 1 sig");
  8737. validSigAlgo = (ssl->peerFalconKey != NULL) &&
  8738. ssl->peerFalconKeyPresent;
  8739. }
  8740. if (ssl->options.peerSigAlgo == falcon_level5_sa_algo) {
  8741. WOLFSSL_MSG("Peer sent Falcon Level 5 sig");
  8742. validSigAlgo = (ssl->peerFalconKey != NULL) &&
  8743. ssl->peerFalconKeyPresent;
  8744. }
  8745. if (ssl->options.peerSigAlgo == dilithium_level2_sa_algo) {
  8746. WOLFSSL_MSG("Peer sent Dilithium Level 2 sig");
  8747. validSigAlgo = (ssl->peerDilithiumKey != NULL) &&
  8748. ssl->peerDilithiumKeyPresent;
  8749. }
  8750. if (ssl->options.peerSigAlgo == dilithium_level3_sa_algo) {
  8751. WOLFSSL_MSG("Peer sent Dilithium Level 3 sig");
  8752. validSigAlgo = (ssl->peerDilithiumKey != NULL) &&
  8753. ssl->peerDilithiumKeyPresent;
  8754. }
  8755. if (ssl->options.peerSigAlgo == dilithium_level5_sa_algo) {
  8756. WOLFSSL_MSG("Peer sent Dilithium Level 5 sig");
  8757. validSigAlgo = (ssl->peerDilithiumKey != NULL) &&
  8758. ssl->peerDilithiumKeyPresent;
  8759. }
  8760. #endif
  8761. #ifndef NO_RSA
  8762. if (ssl->options.peerSigAlgo == rsa_sa_algo) {
  8763. WOLFSSL_MSG("Peer sent PKCS#1.5 algo - not valid TLS 1.3");
  8764. ERROR_OUT(INVALID_PARAMETER, exit_dcv);
  8765. }
  8766. if (ssl->options.peerSigAlgo == rsa_pss_sa_algo) {
  8767. WOLFSSL_MSG("Peer sent RSA sig");
  8768. validSigAlgo = (ssl->peerRsaKey != NULL) &&
  8769. ssl->peerRsaKeyPresent;
  8770. }
  8771. #endif
  8772. if (!validSigAlgo) {
  8773. WOLFSSL_MSG("Sig algo doesn't correspond to certificate");
  8774. ERROR_OUT(SIG_VERIFY_E, exit_dcv);
  8775. }
  8776. sig->length = args->sz;
  8777. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8778. if (!wolfSSL_is_server(ssl) &&
  8779. ssl->sigSpec != NULL &&
  8780. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  8781. /* If its RSA, we only hybridize with RSA3072 which has a sig
  8782. * size of 384. For ECC, this is actually encoded as an RFC5912
  8783. * formatted signature which means we can use the ASN APIs to
  8784. * figure out the length. Note that some post-quantum sig algs
  8785. * have variable length signatures (Falcon). That is why we
  8786. * don't do:
  8787. * sig->length -= args->altSignatureSz; */
  8788. #define RSA3072_SIG_LEN 384
  8789. if (ssl->options.peerSigAlgo == rsa_pss_sa_algo) {
  8790. sig->length = RSA3072_SIG_LEN;
  8791. }
  8792. else if (ssl->options.peerSigAlgo == ecc_dsa_sa_algo) {
  8793. word32 tmpIdx = args->idx;
  8794. sig->length = wc_SignatureGetSize(WC_SIGNATURE_TYPE_ECC,
  8795. ssl->peerEccDsaKey,
  8796. sizeof(*ssl->peerEccDsaKey));
  8797. if (GetSequence(input, &tmpIdx, (int*)&sig->length,
  8798. args->sz) < 0) {
  8799. ERROR_OUT(SIG_VERIFY_E, exit_dcv);
  8800. }
  8801. /* We have to increment by the size of the header. */
  8802. sig->length += tmpIdx - args->idx;
  8803. }
  8804. else {
  8805. ERROR_OUT(WOLFSSL_NOT_IMPLEMENTED, exit_dcv);
  8806. }
  8807. }
  8808. #endif
  8809. sig->buffer = (byte*)XMALLOC(sig->length, ssl->heap,
  8810. DYNAMIC_TYPE_SIGNATURE);
  8811. if (sig->buffer == NULL) {
  8812. ERROR_OUT(MEMORY_E, exit_dcv);
  8813. }
  8814. XMEMCPY(sig->buffer, input + args->idx, sig->length);
  8815. #ifdef HAVE_ECC
  8816. if (ssl->peerEccDsaKeyPresent) {
  8817. WOLFSSL_MSG("Doing ECC peer cert verify");
  8818. args->sigData = (byte*)XMALLOC(MAX_SIG_DATA_SZ, ssl->heap,
  8819. DYNAMIC_TYPE_SIGNATURE);
  8820. if (args->sigData == NULL) {
  8821. ERROR_OUT(MEMORY_E, exit_dcv);
  8822. }
  8823. ret = CreateSigData(ssl, args->sigData, &args->sigDataSz, 1);
  8824. if (ret != 0)
  8825. goto exit_dcv;
  8826. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8827. if (ssl->options.peerSigAlgo != sm2_sa_algo)
  8828. #endif
  8829. {
  8830. ret = CreateECCEncodedSig(args->sigData,
  8831. args->sigDataSz, ssl->options.peerHashAlgo);
  8832. if (ret < 0)
  8833. goto exit_dcv;
  8834. args->sigDataSz = (word16)ret;
  8835. ret = 0;
  8836. }
  8837. }
  8838. #endif
  8839. #ifdef HAVE_ED25519
  8840. if (ssl->peerEd25519KeyPresent) {
  8841. WOLFSSL_MSG("Doing ED25519 peer cert verify");
  8842. args->sigData = (byte*)XMALLOC(MAX_SIG_DATA_SZ, ssl->heap,
  8843. DYNAMIC_TYPE_SIGNATURE);
  8844. if (args->sigData == NULL) {
  8845. ERROR_OUT(MEMORY_E, exit_dcv);
  8846. }
  8847. ret = CreateSigData(ssl, args->sigData, &args->sigDataSz, 1);
  8848. if (ret < 0)
  8849. goto exit_dcv;
  8850. }
  8851. #endif
  8852. #ifdef HAVE_ED448
  8853. if (ssl->peerEd448KeyPresent) {
  8854. WOLFSSL_MSG("Doing ED448 peer cert verify");
  8855. args->sigData = (byte*)XMALLOC(MAX_SIG_DATA_SZ, ssl->heap,
  8856. DYNAMIC_TYPE_SIGNATURE);
  8857. if (args->sigData == NULL) {
  8858. ERROR_OUT(MEMORY_E, exit_dcv);
  8859. }
  8860. ret = CreateSigData(ssl, args->sigData, &args->sigDataSz, 1);
  8861. if (ret < 0)
  8862. goto exit_dcv;
  8863. }
  8864. #endif
  8865. #ifdef HAVE_PQC
  8866. if (ssl->peerFalconKeyPresent || ssl->peerDilithiumKeyPresent) {
  8867. word16 sigDataSz;
  8868. byte *sigData = (byte*)XMALLOC(MAX_SIG_DATA_SZ, ssl->heap,
  8869. DYNAMIC_TYPE_SIGNATURE);
  8870. if (sigData == NULL) {
  8871. ERROR_OUT(MEMORY_E, exit_dcv);
  8872. }
  8873. ret = CreateSigData(ssl, sigData, &sigDataSz, 1);
  8874. if (ret < 0) {
  8875. goto exit_dcv;
  8876. }
  8877. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8878. if (!wolfSSL_is_server(ssl) &&
  8879. ssl->sigSpec != NULL &&
  8880. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  8881. /* In this case (BOTH), the pq sig is the alternative. */
  8882. args->altSigData = sigData;
  8883. args->altSigDataSz = sigDataSz;
  8884. }
  8885. else
  8886. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  8887. {
  8888. args->sigData = sigData;
  8889. args->sigDataSz = sigDataSz;
  8890. }
  8891. ret = 0;
  8892. }
  8893. #endif
  8894. /* Advance state and proceed */
  8895. ssl->options.asyncState = TLS_ASYNC_DO;
  8896. } /* case TLS_ASYNC_BUILD */
  8897. FALL_THROUGH;
  8898. case TLS_ASYNC_DO:
  8899. {
  8900. #ifndef NO_RSA
  8901. if (ssl->peerRsaKey != NULL && ssl->peerRsaKeyPresent != 0) {
  8902. ret = RsaVerify(ssl, sig->buffer, (word32)sig->length, &args->output,
  8903. ssl->options.peerSigAlgo, ssl->options.peerHashAlgo, ssl->peerRsaKey,
  8904. #ifdef HAVE_PK_CALLBACKS
  8905. &ssl->buffers.peerRsaKey
  8906. #else
  8907. NULL
  8908. #endif
  8909. );
  8910. if (ret >= 0) {
  8911. args->sendSz = ret;
  8912. ret = 0;
  8913. }
  8914. }
  8915. #endif /* !NO_RSA */
  8916. #ifdef HAVE_ECC
  8917. if (ssl->peerEccDsaKeyPresent) {
  8918. #if defined(WOLFSSL_SM2) && defined(WOLFSSL_SM3)
  8919. if (ssl->options.peerSigAlgo == sm2_sa_algo) {
  8920. ret = Sm2wSm3Verify(ssl, TLS13_SM2_SIG_ID,
  8921. TLS13_SM2_SIG_ID_SZ, input + args->idx, args->sz,
  8922. args->sigData, args->sigDataSz,
  8923. ssl->peerEccDsaKey, NULL);
  8924. }
  8925. else
  8926. #endif
  8927. {
  8928. ret = EccVerify(ssl, input + args->idx, sig->length,
  8929. args->sigData, args->sigDataSz,
  8930. ssl->peerEccDsaKey,
  8931. #ifdef HAVE_PK_CALLBACKS
  8932. &ssl->buffers.peerEccDsaKey
  8933. #else
  8934. NULL
  8935. #endif
  8936. );
  8937. }
  8938. if (ret >= 0) {
  8939. /* CLIENT/SERVER: data verified with public key from
  8940. * certificate. */
  8941. ssl->options.peerAuthGood = 1;
  8942. FreeKey(ssl, DYNAMIC_TYPE_ECC, (void**)&ssl->peerEccDsaKey);
  8943. ssl->peerEccDsaKeyPresent = 0;
  8944. }
  8945. }
  8946. #endif /* HAVE_ECC */
  8947. #ifdef HAVE_ED25519
  8948. if (ssl->peerEd25519KeyPresent) {
  8949. ret = Ed25519Verify(ssl, input + args->idx, args->sz,
  8950. args->sigData, args->sigDataSz,
  8951. ssl->peerEd25519Key,
  8952. #ifdef HAVE_PK_CALLBACKS
  8953. &ssl->buffers.peerEd25519Key
  8954. #else
  8955. NULL
  8956. #endif
  8957. );
  8958. if (ret >= 0) {
  8959. /* CLIENT/SERVER: data verified with public key from
  8960. * certificate. */
  8961. ssl->options.peerAuthGood = 1;
  8962. FreeKey(ssl, DYNAMIC_TYPE_ED25519,
  8963. (void**)&ssl->peerEd25519Key);
  8964. ssl->peerEd25519KeyPresent = 0;
  8965. }
  8966. }
  8967. #endif
  8968. #ifdef HAVE_ED448
  8969. if (ssl->peerEd448KeyPresent) {
  8970. ret = Ed448Verify(ssl, input + args->idx, args->sz,
  8971. args->sigData, args->sigDataSz,
  8972. ssl->peerEd448Key,
  8973. #ifdef HAVE_PK_CALLBACKS
  8974. &ssl->buffers.peerEd448Key
  8975. #else
  8976. NULL
  8977. #endif
  8978. );
  8979. if (ret >= 0) {
  8980. /* CLIENT/SERVER: data verified with public key from
  8981. * certificate. */
  8982. ssl->options.peerAuthGood = 1;
  8983. FreeKey(ssl, DYNAMIC_TYPE_ED448,
  8984. (void**)&ssl->peerEd448Key);
  8985. ssl->peerEd448KeyPresent = 0;
  8986. }
  8987. }
  8988. #endif
  8989. #if defined(HAVE_PQC) && defined(HAVE_FALCON)
  8990. if (ssl->peerFalconKeyPresent) {
  8991. int res = 0;
  8992. byte *sigIn = input + args->idx;
  8993. word32 sigInLen = args->sz;
  8994. byte *sigData = args->sigData;
  8995. word32 sigDataSz = args->sigDataSz;
  8996. WOLFSSL_MSG("Doing Falcon peer cert verify");
  8997. #ifdef WOLFSSL_DUAL_ALG_CERTS
  8998. if (!wolfSSL_is_server(ssl) &&
  8999. ssl->sigSpec != NULL &&
  9000. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  9001. /* Note: + sig->length; we are skipping the native sig. */
  9002. sigIn = input + args->idx + sig->length;
  9003. sigInLen = args->sz - sig->length;
  9004. /* For RSA, something different was verified. */
  9005. if (ssl->peerRsaKeyPresent) {
  9006. sigData = args->altSigData;
  9007. sigDataSz = args->altSigDataSz;
  9008. }
  9009. }
  9010. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  9011. ret = wc_falcon_verify_msg(sigIn, sigInLen,
  9012. sigData, sigDataSz,
  9013. &res, ssl->peerFalconKey);
  9014. if ((ret >= 0) && (res == 1)) {
  9015. /* CLIENT/SERVER: data verified with public key from
  9016. * certificate. */
  9017. #ifdef WOLFSSL_DUAL_ALG_CERTS
  9018. if (!wolfSSL_is_server(ssl) &&
  9019. ssl->sigSpec != NULL &&
  9020. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  9021. args->altPeerAuthGood = 1;
  9022. }
  9023. else
  9024. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  9025. ssl->options.peerAuthGood = 1;
  9026. FreeKey(ssl, DYNAMIC_TYPE_FALCON,
  9027. (void**)&ssl->peerFalconKey);
  9028. ssl->peerFalconKeyPresent = 0;
  9029. }
  9030. }
  9031. #endif /* HAVE_PQC && HAVE_FALCON */
  9032. #if defined(HAVE_PQC) && defined(HAVE_DILITHIUM)
  9033. if (ssl->peerDilithiumKeyPresent) {
  9034. int res = 0;
  9035. byte *sigIn = input + args->idx;
  9036. word32 sigInLen = args->sz;
  9037. byte *sigData = args->sigData;
  9038. word32 sigDataSz = args->sigDataSz;
  9039. WOLFSSL_MSG("Doing Dilithium peer cert verify");
  9040. #ifdef WOLFSSL_DUAL_ALG_CERTS
  9041. if (!wolfSSL_is_server(ssl) &&
  9042. ssl->sigSpec != NULL &&
  9043. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  9044. /* Go backwards from the end of the signature the size of
  9045. * the alt sig to find the beginning of the alt sig. */
  9046. sigIn = input + args->idx + args->sz - args->altSignatureSz;
  9047. sigInLen = args->altSignatureSz;
  9048. /* For RSA, something different was verified. */
  9049. if (ssl->peerRsaKeyPresent) {
  9050. sigData = args->altSigData;
  9051. sigDataSz = args->altSigDataSz;
  9052. }
  9053. }
  9054. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  9055. ret = wc_dilithium_verify_msg(sigIn, sigInLen,
  9056. sigData, sigDataSz,
  9057. &res, ssl->peerDilithiumKey);
  9058. if ((ret >= 0) && (res == 1)) {
  9059. /* CLIENT/SERVER: data verified with public key from
  9060. * certificate. */
  9061. #ifdef WOLFSSL_DUAL_ALG_CERTS
  9062. if (!wolfSSL_is_server(ssl) &&
  9063. ssl->sigSpec != NULL &&
  9064. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  9065. args->altPeerAuthGood = 1;
  9066. }
  9067. else
  9068. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  9069. ssl->options.peerAuthGood = 1;
  9070. FreeKey(ssl, DYNAMIC_TYPE_DILITHIUM,
  9071. (void**)&ssl->peerDilithiumKey);
  9072. ssl->peerDilithiumKeyPresent = 0;
  9073. }
  9074. }
  9075. #endif /* HAVE_PQC && HAVE_DILITHIUM */
  9076. /* Check for error */
  9077. if (ret != 0) {
  9078. goto exit_dcv;
  9079. }
  9080. /* Advance state and proceed */
  9081. ssl->options.asyncState = TLS_ASYNC_VERIFY;
  9082. } /* case TLS_ASYNC_DO */
  9083. FALL_THROUGH;
  9084. case TLS_ASYNC_VERIFY:
  9085. {
  9086. #if !defined(NO_RSA) && defined(WC_RSA_PSS)
  9087. if (ssl->peerRsaKey != NULL && ssl->peerRsaKeyPresent != 0) {
  9088. ret = CheckRSASignature(ssl, ssl->options.peerSigAlgo,
  9089. ssl->options.peerHashAlgo, args->output, args->sendSz);
  9090. if (ret != 0)
  9091. goto exit_dcv;
  9092. /* CLIENT/SERVER: data verified with public key from
  9093. * certificate. */
  9094. ssl->peerRsaKeyPresent = 0;
  9095. FreeKey(ssl, DYNAMIC_TYPE_RSA, (void**)&ssl->peerRsaKey);
  9096. ssl->options.peerAuthGood = 1;
  9097. }
  9098. #endif /* !NO_RSA && WC_RSA_PSS */
  9099. /* Advance state and proceed */
  9100. ssl->options.asyncState = TLS_ASYNC_FINALIZE;
  9101. } /* case TLS_ASYNC_VERIFY */
  9102. FALL_THROUGH;
  9103. case TLS_ASYNC_FINALIZE:
  9104. {
  9105. #ifdef WOLFSSL_DUAL_ALG_CERTS
  9106. if (!wolfSSL_is_server(ssl) &&
  9107. ssl->options.peerAuthGood &&
  9108. ssl->sigSpec != NULL &&
  9109. *ssl->sigSpec == WOLFSSL_CKS_SIGSPEC_BOTH) {
  9110. ssl->options.peerAuthGood = args->altPeerAuthGood;
  9111. }
  9112. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  9113. ssl->options.havePeerVerify = 1;
  9114. /* Set final index */
  9115. args->idx += args->sz;
  9116. *inOutIdx = args->idx;
  9117. /* Encryption is always on: add padding */
  9118. *inOutIdx += ssl->keys.padSz;
  9119. /* Advance state and proceed */
  9120. ssl->options.asyncState = TLS_ASYNC_END;
  9121. #if !defined(NO_WOLFSSL_CLIENT)
  9122. if (ssl->options.side == WOLFSSL_CLIENT_END)
  9123. ssl->options.serverState = SERVER_CERT_VERIFY_COMPLETE;
  9124. #endif
  9125. } /* case TLS_ASYNC_FINALIZE */
  9126. FALL_THROUGH;
  9127. case TLS_ASYNC_END:
  9128. {
  9129. break;
  9130. }
  9131. default:
  9132. ret = INPUT_CASE_ERROR;
  9133. } /* switch(ssl->options.asyncState) */
  9134. exit_dcv:
  9135. WOLFSSL_LEAVE("DoTls13CertificateVerify", ret);
  9136. WOLFSSL_END(WC_FUNC_CERTIFICATE_VERIFY_DO);
  9137. #ifdef WOLFSSL_ASYNC_CRYPT
  9138. /* Handle async operation */
  9139. if (ret == WC_PENDING_E) {
  9140. /* Mark message as not received so it can process again */
  9141. ssl->msgsReceived.got_certificate_verify = 0;
  9142. return ret;
  9143. }
  9144. else
  9145. #endif /* WOLFSSL_ASYNC_CRYPT */
  9146. if (ret != 0) {
  9147. WOLFSSL_ERROR_VERBOSE(ret);
  9148. if (ret != INVALID_PARAMETER) {
  9149. SendAlert(ssl, alert_fatal, decrypt_error);
  9150. }
  9151. }
  9152. /* Final cleanup */
  9153. FreeDcv13Args(ssl, args);
  9154. FreeKeyExchange(ssl);
  9155. #ifdef WOLFSSL_ASYNC_IO
  9156. /* Cleanup async */
  9157. FreeAsyncCtx(ssl, 0);
  9158. #endif
  9159. return ret;
  9160. }
  9161. #endif /* !NO_RSA || HAVE_ECC */
  9162. #endif /* !NO_CERTS */
  9163. /* Parse and handle a TLS v1.3 Finished message.
  9164. *
  9165. * ssl The SSL/TLS object.
  9166. * input The message buffer.
  9167. * inOutIdx On entry, the index into the message buffer of Finished.
  9168. * On exit, the index of byte after the Finished message and padding.
  9169. * size Length of message data.
  9170. * totalSz Length of remaining data in the message buffer.
  9171. * sniff Indicates whether we are sniffing packets.
  9172. * returns 0 on success and otherwise failure.
  9173. */
  9174. int DoTls13Finished(WOLFSSL* ssl, const byte* input, word32* inOutIdx,
  9175. word32 size, word32 totalSz, int sniff)
  9176. {
  9177. int ret;
  9178. word32 finishedSz = 0;
  9179. byte* secret;
  9180. byte mac[WC_MAX_DIGEST_SIZE];
  9181. WOLFSSL_START(WC_FUNC_FINISHED_DO);
  9182. WOLFSSL_ENTER("DoTls13Finished");
  9183. #if !defined(NO_CERTS) && !defined(WOLFSSL_NO_CLIENT_AUTH)
  9184. /* verify the client sent certificate if required */
  9185. if (ssl->options.side == WOLFSSL_SERVER_END && !ssl->options.resuming &&
  9186. (ssl->options.mutualAuth || ssl->options.failNoCert)) {
  9187. #ifdef OPENSSL_COMPATIBLE_DEFAULTS
  9188. if (ssl->options.isPSK) {
  9189. WOLFSSL_MSG("TLS v1.3 client used PSK but cert required. Allowing "
  9190. "for OpenSSL compatibility");
  9191. }
  9192. else
  9193. #endif
  9194. if (
  9195. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  9196. !ssl->options.verifyPostHandshake &&
  9197. #endif
  9198. (!ssl->options.havePeerCert || !ssl->options.havePeerVerify)) {
  9199. ret = NO_PEER_CERT; /* NO_PEER_VERIFY */
  9200. WOLFSSL_MSG("TLS v1.3 client did not present peer cert");
  9201. DoCertFatalAlert(ssl, ret);
  9202. return ret;
  9203. }
  9204. }
  9205. #endif
  9206. /* check against totalSz */
  9207. if (*inOutIdx + size > totalSz)
  9208. return BUFFER_E;
  9209. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  9210. ret = tsip_Tls13HandleFinished(ssl, input, inOutIdx, size, totalSz);
  9211. if (ret == 0) {
  9212. ssl->options.serverState = SERVER_FINISHED_COMPLETE;
  9213. return ret;
  9214. }
  9215. if (ret == VERIFY_FINISHED_ERROR) {
  9216. SendAlert(ssl, alert_fatal, decrypt_error);
  9217. return ret;
  9218. }
  9219. if (ret != CRYPTOCB_UNAVAILABLE) {
  9220. /* other errors */
  9221. return ret;
  9222. }
  9223. ret = 0;
  9224. #endif /* WOLFSSL_RENESAS_TSIP_TLS */
  9225. if (ssl->options.handShakeDone) {
  9226. ret = DeriveFinishedSecret(ssl, ssl->clientSecret,
  9227. ssl->keys.client_write_MAC_secret,
  9228. WOLFSSL_CLIENT_END);
  9229. if (ret != 0)
  9230. return ret;
  9231. secret = ssl->keys.client_write_MAC_secret;
  9232. }
  9233. else if (ssl->options.side == WOLFSSL_CLIENT_END) {
  9234. /* All the handshake messages have been received to calculate
  9235. * client and server finished keys.
  9236. */
  9237. ret = DeriveFinishedSecret(ssl, ssl->clientSecret,
  9238. ssl->keys.client_write_MAC_secret,
  9239. WOLFSSL_CLIENT_END);
  9240. if (ret != 0)
  9241. return ret;
  9242. ret = DeriveFinishedSecret(ssl, ssl->serverSecret,
  9243. ssl->keys.server_write_MAC_secret,
  9244. WOLFSSL_SERVER_END);
  9245. if (ret != 0)
  9246. return ret;
  9247. secret = ssl->keys.server_write_MAC_secret;
  9248. }
  9249. else {
  9250. secret = ssl->keys.client_write_MAC_secret;
  9251. }
  9252. if (sniff == NO_SNIFF) {
  9253. ret = BuildTls13HandshakeHmac(ssl, secret, mac, &finishedSz);
  9254. #ifdef WOLFSSL_HAVE_TLS_UNIQUE
  9255. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  9256. XMEMCPY(ssl->serverFinished, mac, finishedSz);
  9257. ssl->serverFinished_len = finishedSz;
  9258. }
  9259. else {
  9260. XMEMCPY(ssl->clientFinished, mac, finishedSz);
  9261. ssl->clientFinished_len = finishedSz;
  9262. }
  9263. #endif /* WOLFSSL_HAVE_TLS_UNIQUE */
  9264. if (ret != 0)
  9265. return ret;
  9266. if (size != finishedSz)
  9267. return BUFFER_ERROR;
  9268. }
  9269. #ifdef WOLFSSL_CALLBACKS
  9270. if (ssl->hsInfoOn) AddPacketName(ssl, "Finished");
  9271. if (ssl->toInfoOn) AddLateName("Finished", &ssl->timeoutInfo);
  9272. #endif
  9273. if (sniff == NO_SNIFF) {
  9274. /* Actually check verify data. */
  9275. if (size > WC_MAX_DIGEST_SIZE ||
  9276. XMEMCMP(input + *inOutIdx, mac, size) != 0){
  9277. WOLFSSL_MSG("Verify finished error on hashes");
  9278. SendAlert(ssl, alert_fatal, decrypt_error);
  9279. WOLFSSL_ERROR_VERBOSE(VERIFY_FINISHED_ERROR);
  9280. return VERIFY_FINISHED_ERROR;
  9281. }
  9282. }
  9283. /* Force input exhaustion at ProcessReply by consuming padSz. */
  9284. *inOutIdx += size + ssl->keys.padSz;
  9285. if (ssl->options.side == WOLFSSL_SERVER_END &&
  9286. !ssl->options.handShakeDone) {
  9287. #ifdef WOLFSSL_EARLY_DATA
  9288. if (ssl->earlyData != no_early_data) {
  9289. if ((ret = DeriveTls13Keys(ssl, no_key, DECRYPT_SIDE_ONLY, 1)) != 0)
  9290. return ret;
  9291. }
  9292. #endif
  9293. /* Setup keys for application data messages from client. */
  9294. if ((ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY)) != 0)
  9295. return ret;
  9296. }
  9297. #ifndef NO_WOLFSSL_CLIENT
  9298. if (ssl->options.side == WOLFSSL_CLIENT_END)
  9299. ssl->options.serverState = SERVER_FINISHED_COMPLETE;
  9300. #endif
  9301. #ifndef NO_WOLFSSL_SERVER
  9302. if (ssl->options.side == WOLFSSL_SERVER_END) {
  9303. ssl->options.clientState = CLIENT_FINISHED_COMPLETE;
  9304. ssl->options.handShakeState = HANDSHAKE_DONE;
  9305. ssl->options.handShakeDone = 1;
  9306. }
  9307. #endif
  9308. #if defined(WOLFSSL_DTLS13) && defined(WOLFSSL_EARLY_DATA)
  9309. if (ssl->options.dtls && ssl->earlyData > early_data_ext) {
  9310. /* DTLSv1.3 has no EndOfearlydata messages. We stop processing EarlyData
  9311. as soon we receive the client's finished message */
  9312. ssl->earlyData = done_early_data;
  9313. }
  9314. #endif /* WOLFSSL_DTLS13 && WOLFSSL_EARLY_DATA */
  9315. #if defined(WOLFSSL_QUIC) && defined(WOLFSSL_EARLY_DATA)
  9316. if (WOLFSSL_IS_QUIC(ssl) && ssl->earlyData > early_data_ext) {
  9317. /* QUIC has no EndOfEarlyData messages. We stop processing EarlyData
  9318. as soon we receive the client's finished message */
  9319. ssl->earlyData = done_early_data;
  9320. }
  9321. #endif /* WOLFSSL_QUIC && WOLFSSL_EARLY_DATA */
  9322. WOLFSSL_LEAVE("DoTls13Finished", 0);
  9323. WOLFSSL_END(WC_FUNC_FINISHED_DO);
  9324. return 0;
  9325. }
  9326. #if !defined(NO_WOLFSSL_CLIENT) || !defined(NO_WOLFSSL_SERVER)
  9327. /* Send the TLS v1.3 Finished message.
  9328. *
  9329. * ssl The SSL/TLS object.
  9330. * returns 0 on success, otherwise failure.
  9331. */
  9332. static int SendTls13Finished(WOLFSSL* ssl)
  9333. {
  9334. int finishedSz = ssl->specs.hash_size;
  9335. byte* input;
  9336. byte* output;
  9337. int ret;
  9338. int headerSz = HANDSHAKE_HEADER_SZ;
  9339. int outputSz;
  9340. byte* secret;
  9341. #ifdef WOLFSSL_DTLS13
  9342. int dtlsRet = 0, isDtls = 0;
  9343. #endif /* WOLFSSL_DTLS13 */
  9344. WOLFSSL_START(WC_FUNC_FINISHED_SEND);
  9345. WOLFSSL_ENTER("SendTls13Finished");
  9346. ssl->options.buildingMsg = 1;
  9347. #ifdef WOLFSSL_DTLS13
  9348. if (ssl->options.dtls) {
  9349. headerSz = DTLS_HANDSHAKE_HEADER_SZ;
  9350. /* using isDtls instead of ssl->options.dtls will abide clang static
  9351. analyzer on using an uninitialized value */
  9352. isDtls = 1;
  9353. }
  9354. #endif /* WOLFSSL_DTLS13 */
  9355. outputSz = WC_MAX_DIGEST_SIZE + DTLS_HANDSHAKE_HEADER_SZ + MAX_MSG_EXTRA;
  9356. /* Check buffers are big enough and grow if needed. */
  9357. if ((ret = CheckAvailableSize(ssl, outputSz)) != 0)
  9358. return ret;
  9359. /* get output buffer */
  9360. output = GetOutputBuffer(ssl);
  9361. input = output + RECORD_HEADER_SZ;
  9362. #ifdef WOLFSSL_DTLS13
  9363. if (isDtls)
  9364. input = output + Dtls13GetRlHeaderLength(ssl, 1);
  9365. #endif /* WOLFSSL_DTLS13 */
  9366. AddTls13HandShakeHeader(input, finishedSz, 0, finishedSz, finished, ssl);
  9367. #if defined(WOLFSSL_RENESAS_TSIP_TLS)
  9368. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  9369. ret = tsip_Tls13SendFinished(ssl, output, outputSz, input, 1);
  9370. if (ret != CRYPTOCB_UNAVAILABLE) {
  9371. return ret;
  9372. }
  9373. ret = 0;
  9374. }
  9375. #endif /* WOLFSSL_RENESAS_TSIP_TLS */
  9376. /* make finished hashes */
  9377. if (ssl->options.handShakeDone) {
  9378. ret = DeriveFinishedSecret(ssl, ssl->clientSecret,
  9379. ssl->keys.client_write_MAC_secret,
  9380. WOLFSSL_CLIENT_END);
  9381. if (ret != 0)
  9382. return ret;
  9383. secret = ssl->keys.client_write_MAC_secret;
  9384. }
  9385. else if (ssl->options.side == WOLFSSL_CLIENT_END)
  9386. secret = ssl->keys.client_write_MAC_secret;
  9387. else {
  9388. /* All the handshake messages have been done to calculate client and
  9389. * server finished keys.
  9390. */
  9391. ret = DeriveFinishedSecret(ssl, ssl->clientSecret,
  9392. ssl->keys.client_write_MAC_secret,
  9393. WOLFSSL_SERVER_END);
  9394. if (ret != 0)
  9395. return ret;
  9396. ret = DeriveFinishedSecret(ssl, ssl->serverSecret,
  9397. ssl->keys.server_write_MAC_secret,
  9398. WOLFSSL_CLIENT_END);
  9399. if (ret != 0)
  9400. return ret;
  9401. secret = ssl->keys.server_write_MAC_secret;
  9402. }
  9403. ret = BuildTls13HandshakeHmac(ssl, secret, &input[headerSz], NULL);
  9404. if (ret != 0)
  9405. return ret;
  9406. #ifdef WOLFSSL_HAVE_TLS_UNIQUE
  9407. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  9408. XMEMCPY(ssl->clientFinished, &input[headerSz], finishedSz);
  9409. ssl->clientFinished_len = finishedSz;
  9410. }
  9411. else {
  9412. XMEMCPY(ssl->serverFinished, &input[headerSz], finishedSz);
  9413. ssl->serverFinished_len = finishedSz;
  9414. }
  9415. #endif /* WOLFSSL_HAVE_TLS_UNIQUE */
  9416. #ifdef WOLFSSL_DTLS13
  9417. if (isDtls) {
  9418. dtlsRet = Dtls13HandshakeSend(ssl, output, (word16)outputSz,
  9419. (word16)(Dtls13GetRlHeaderLength(ssl, 1) + headerSz + finishedSz), finished,
  9420. 1);
  9421. if (dtlsRet != 0 && dtlsRet != WANT_WRITE)
  9422. return ret;
  9423. } else
  9424. #endif /* WOLFSSL_DTLS13 */
  9425. {
  9426. /* This message is always encrypted. */
  9427. int sendSz = BuildTls13Message(ssl, output, outputSz, input,
  9428. headerSz + finishedSz, handshake, 1, 0, 0);
  9429. if (sendSz < 0) {
  9430. WOLFSSL_ERROR_VERBOSE(BUILD_MSG_ERROR);
  9431. return BUILD_MSG_ERROR;
  9432. }
  9433. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  9434. if (ssl->hsInfoOn) AddPacketName(ssl, "Finished");
  9435. if (ssl->toInfoOn) {
  9436. ret = AddPacketInfo(ssl, "Finished", handshake, output, sendSz,
  9437. WRITE_PROTO, 0, ssl->heap);
  9438. if (ret != 0)
  9439. return ret;
  9440. }
  9441. #endif
  9442. ssl->buffers.outputBuffer.length += sendSz;
  9443. ssl->options.buildingMsg = 0;
  9444. }
  9445. if (ssl->options.side == WOLFSSL_SERVER_END) {
  9446. #ifdef WOLFSSL_EARLY_DATA
  9447. byte storeTrafficDecKeys = ssl->earlyData == no_early_data;
  9448. #endif
  9449. /* Can send application data now. */
  9450. if ((ret = DeriveMasterSecret(ssl)) != 0)
  9451. return ret;
  9452. /* Last use of preMasterSecret - zeroize as soon as possible. */
  9453. ForceZero(ssl->arrays->preMasterSecret, ssl->arrays->preMasterSz);
  9454. #ifdef WOLFSSL_EARLY_DATA
  9455. #ifdef WOLFSSL_DTLS13
  9456. /* DTLS13 dynamically change keys and it needs all
  9457. the keys in ssl->keys to save the keying material */
  9458. if (isDtls)
  9459. storeTrafficDecKeys = 1;
  9460. #endif /* WOLFSSL_DTLS13 */
  9461. if ((ret = DeriveTls13Keys(ssl, traffic_key, ENCRYPT_SIDE_ONLY, 1))
  9462. != 0) {
  9463. return ret;
  9464. }
  9465. if ((ret = DeriveTls13Keys(ssl, traffic_key, DECRYPT_SIDE_ONLY,
  9466. storeTrafficDecKeys)) != 0) {
  9467. return ret;
  9468. }
  9469. #else
  9470. if ((ret = DeriveTls13Keys(ssl, traffic_key, ENCRYPT_AND_DECRYPT_SIDE,
  9471. 1)) != 0) {
  9472. return ret;
  9473. }
  9474. #endif
  9475. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  9476. return ret;
  9477. #ifdef WOLFSSL_DTLS13
  9478. if (isDtls) {
  9479. w64wrapper epochTraffic0;
  9480. epochTraffic0 = w64From32(0, DTLS13_EPOCH_TRAFFIC0);
  9481. ssl->dtls13Epoch = epochTraffic0;
  9482. ssl->dtls13PeerEpoch = epochTraffic0;
  9483. ret = Dtls13NewEpoch(
  9484. ssl, epochTraffic0, ENCRYPT_AND_DECRYPT_SIDE);
  9485. if (ret != 0)
  9486. return ret;
  9487. ret = Dtls13SetEpochKeys(
  9488. ssl, epochTraffic0, ENCRYPT_AND_DECRYPT_SIDE);
  9489. if (ret != 0)
  9490. return ret;
  9491. }
  9492. #endif /* WOLFSSL_DTLS13 */
  9493. }
  9494. if (ssl->options.side == WOLFSSL_CLIENT_END &&
  9495. !ssl->options.handShakeDone) {
  9496. #ifdef WOLFSSL_EARLY_DATA
  9497. if (ssl->earlyData != no_early_data) {
  9498. if ((ret = DeriveTls13Keys(ssl, no_key, ENCRYPT_AND_DECRYPT_SIDE,
  9499. 1)) != 0) {
  9500. return ret;
  9501. }
  9502. }
  9503. #endif
  9504. /* Setup keys for application data messages. */
  9505. if ((ret = SetKeysSide(ssl, ENCRYPT_AND_DECRYPT_SIDE)) != 0)
  9506. return ret;
  9507. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  9508. ret = DeriveResumptionSecret(ssl, ssl->session->masterSecret);
  9509. if (ret != 0)
  9510. return ret;
  9511. #endif
  9512. #ifdef WOLFSSL_DTLS13
  9513. if (isDtls) {
  9514. w64wrapper epochTraffic0;
  9515. epochTraffic0 = w64From32(0, DTLS13_EPOCH_TRAFFIC0);
  9516. ssl->dtls13Epoch = epochTraffic0;
  9517. ssl->dtls13PeerEpoch = epochTraffic0;
  9518. ret = Dtls13NewEpoch(
  9519. ssl, epochTraffic0, ENCRYPT_AND_DECRYPT_SIDE);
  9520. if (ret != 0)
  9521. return ret;
  9522. ret = Dtls13SetEpochKeys(
  9523. ssl, epochTraffic0, ENCRYPT_AND_DECRYPT_SIDE);
  9524. if (ret != 0)
  9525. return ret;
  9526. }
  9527. #endif /* WOLFSSL_DTLS13 */
  9528. }
  9529. #ifndef NO_WOLFSSL_CLIENT
  9530. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  9531. ssl->options.clientState = CLIENT_FINISHED_COMPLETE;
  9532. ssl->options.handShakeState = HANDSHAKE_DONE;
  9533. ssl->options.handShakeDone = 1;
  9534. }
  9535. #endif
  9536. #ifndef NO_WOLFSSL_SERVER
  9537. if (ssl->options.side == WOLFSSL_SERVER_END) {
  9538. ssl->options.serverState = SERVER_FINISHED_COMPLETE;
  9539. }
  9540. #endif
  9541. #ifdef WOLFSSL_DTLS13
  9542. if (isDtls) {
  9543. WOLFSSL_LEAVE("SendTls13Finished", ret);
  9544. WOLFSSL_END(WC_FUNC_FINISHED_SEND);
  9545. return dtlsRet;
  9546. }
  9547. #endif /* WOLFSSL_DTLS13 */
  9548. if ((ret = SendBuffered(ssl)) != 0)
  9549. return ret;
  9550. WOLFSSL_LEAVE("SendTls13Finished", ret);
  9551. WOLFSSL_END(WC_FUNC_FINISHED_SEND);
  9552. return ret;
  9553. }
  9554. #endif /* !NO_WOLFSSL_CLIENT || !NO_WOLFSSL_SERVER */
  9555. /* handle generation TLS v1.3 key_update (24) */
  9556. /* Send the TLS v1.3 KeyUpdate message.
  9557. *
  9558. * ssl The SSL/TLS object.
  9559. * returns 0 on success, otherwise failure.
  9560. */
  9561. static int SendTls13KeyUpdate(WOLFSSL* ssl)
  9562. {
  9563. byte* input;
  9564. byte* output;
  9565. int ret;
  9566. int headerSz = HANDSHAKE_HEADER_SZ;
  9567. int outputSz;
  9568. word32 i = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  9569. WOLFSSL_START(WC_FUNC_KEY_UPDATE_SEND);
  9570. WOLFSSL_ENTER("SendTls13KeyUpdate");
  9571. #ifdef WOLFSSL_DTLS13
  9572. if (ssl->options.dtls)
  9573. i = Dtls13GetRlHeaderLength(ssl, 1) + DTLS_HANDSHAKE_HEADER_SZ;
  9574. #endif /* WOLFSSL_DTLS13 */
  9575. outputSz = OPAQUE8_LEN + MAX_MSG_EXTRA;
  9576. /* Check buffers are big enough and grow if needed. */
  9577. if ((ret = CheckAvailableSize(ssl, outputSz)) != 0)
  9578. return ret;
  9579. /* get output buffer */
  9580. output = GetOutputBuffer(ssl);
  9581. input = output + RECORD_HEADER_SZ;
  9582. #ifdef WOLFSSL_DTLS13
  9583. if (ssl->options.dtls)
  9584. input = output + Dtls13GetRlHeaderLength(ssl, 1);
  9585. #endif /* WOLFSSL_DTLS13 */
  9586. AddTls13Headers(output, OPAQUE8_LEN, key_update, ssl);
  9587. /* If:
  9588. * 1. I haven't sent a KeyUpdate requesting a response and
  9589. * 2. This isn't responding to peer KeyUpdate requiring a response then,
  9590. * I want a response.
  9591. */
  9592. ssl->keys.updateResponseReq = output[i++] =
  9593. !ssl->keys.updateResponseReq && !ssl->keys.keyUpdateRespond;
  9594. /* Sent response, no longer need to respond. */
  9595. ssl->keys.keyUpdateRespond = 0;
  9596. #ifdef WOLFSSL_DTLS13
  9597. if (ssl->options.dtls) {
  9598. ret = Dtls13HandshakeSend(ssl, output, (word16)outputSz,
  9599. OPAQUE8_LEN + Dtls13GetRlHeaderLength(ssl, 1) +
  9600. DTLS_HANDSHAKE_HEADER_SZ,
  9601. key_update, 0);
  9602. }
  9603. else
  9604. #endif /* WOLFSSL_DTLS13 */
  9605. {
  9606. /* This message is always encrypted. */
  9607. int sendSz = BuildTls13Message(ssl, output, outputSz, input,
  9608. headerSz + OPAQUE8_LEN, handshake, 0, 0, 0);
  9609. if (sendSz < 0)
  9610. return BUILD_MSG_ERROR;
  9611. #if defined(WOLFSSL_CALLBACKS) || defined(OPENSSL_EXTRA)
  9612. if (ssl->hsInfoOn) AddPacketName(ssl, "KeyUpdate");
  9613. if (ssl->toInfoOn) {
  9614. ret = AddPacketInfo(ssl, "KeyUpdate", handshake, output, sendSz,
  9615. WRITE_PROTO, 0, ssl->heap);
  9616. if (ret != 0)
  9617. return ret;
  9618. }
  9619. #endif
  9620. ssl->buffers.outputBuffer.length += sendSz;
  9621. ret = SendBuffered(ssl);
  9622. if (ret != 0 && ret != WANT_WRITE)
  9623. return ret;
  9624. }
  9625. /* In DTLS we must wait for the ack before setting up the new keys */
  9626. if (!ssl->options.dtls) {
  9627. /* Future traffic uses new encryption keys. */
  9628. if ((ret = DeriveTls13Keys(
  9629. ssl, update_traffic_key, ENCRYPT_SIDE_ONLY, 1))
  9630. != 0)
  9631. return ret;
  9632. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  9633. return ret;
  9634. }
  9635. WOLFSSL_LEAVE("SendTls13KeyUpdate", ret);
  9636. WOLFSSL_END(WC_FUNC_KEY_UPDATE_SEND);
  9637. return ret;
  9638. }
  9639. /* handle processing TLS v1.3 key_update (24) */
  9640. /* Parse and handle a TLS v1.3 KeyUpdate message.
  9641. *
  9642. * ssl The SSL/TLS object.
  9643. * input The message buffer.
  9644. * inOutIdx On entry, the index into the message buffer of Finished.
  9645. * On exit, the index of byte after the Finished message and padding.
  9646. * totalSz The length of the current handshake message.
  9647. * returns 0 on success and otherwise failure.
  9648. */
  9649. static int DoTls13KeyUpdate(WOLFSSL* ssl, const byte* input, word32* inOutIdx,
  9650. word32 totalSz)
  9651. {
  9652. int ret;
  9653. word32 i = *inOutIdx;
  9654. WOLFSSL_START(WC_FUNC_KEY_UPDATE_DO);
  9655. WOLFSSL_ENTER("DoTls13KeyUpdate");
  9656. /* check against totalSz */
  9657. if (OPAQUE8_LEN != totalSz)
  9658. return BUFFER_E;
  9659. switch (input[i]) {
  9660. case update_not_requested:
  9661. /* This message in response to any outstanding request. */
  9662. ssl->keys.keyUpdateRespond = 0;
  9663. ssl->keys.updateResponseReq = 0;
  9664. break;
  9665. case update_requested:
  9666. /* New key update requiring a response. */
  9667. ssl->keys.keyUpdateRespond = 1;
  9668. break;
  9669. default:
  9670. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  9671. return INVALID_PARAMETER;
  9672. }
  9673. /* Move index to byte after message. */
  9674. *inOutIdx += totalSz;
  9675. /* Always encrypted. */
  9676. *inOutIdx += ssl->keys.padSz;
  9677. /* Future traffic uses new decryption keys. */
  9678. if ((ret = DeriveTls13Keys(ssl, update_traffic_key, DECRYPT_SIDE_ONLY, 1))
  9679. != 0) {
  9680. return ret;
  9681. }
  9682. if ((ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY)) != 0)
  9683. return ret;
  9684. #ifdef WOLFSSL_DTLS13
  9685. if (ssl->options.dtls) {
  9686. w64Increment(&ssl->dtls13PeerEpoch);
  9687. ret = Dtls13NewEpoch(ssl, ssl->dtls13PeerEpoch, DECRYPT_SIDE_ONLY);
  9688. if (ret != 0)
  9689. return ret;
  9690. ret = Dtls13SetEpochKeys(ssl, ssl->dtls13PeerEpoch, DECRYPT_SIDE_ONLY);
  9691. if (ret != 0)
  9692. return ret;
  9693. }
  9694. #endif /* WOLFSSL_DTLS13 */
  9695. if (ssl->keys.keyUpdateRespond) {
  9696. #ifdef WOLFSSL_DTLS13
  9697. /* we already sent a keyUpdate (either in response to a previous
  9698. KeyUpdate or initiated by the application) and we are waiting for the
  9699. ack. We can't send a new KeyUpdate right away but to honor the RFC we
  9700. should send another KeyUpdate after the one in-flight is acked. We
  9701. don't do that as it looks redundant, it will make the code more
  9702. complex and I don't see a good use case for that. */
  9703. if (ssl->options.dtls && ssl->dtls13WaitKeyUpdateAck) {
  9704. ssl->keys.keyUpdateRespond = 0;
  9705. return 0;
  9706. }
  9707. #endif /* WOLFSSL_DTLS13 */
  9708. return SendTls13KeyUpdate(ssl);
  9709. }
  9710. WOLFSSL_LEAVE("DoTls13KeyUpdate", ret);
  9711. WOLFSSL_END(WC_FUNC_KEY_UPDATE_DO);
  9712. return 0;
  9713. }
  9714. #ifdef WOLFSSL_EARLY_DATA
  9715. #ifndef NO_WOLFSSL_CLIENT
  9716. /* Send the TLS v1.3 EndOfEarlyData message to indicate that there will be no
  9717. * more early application data.
  9718. * The encryption key now changes to the pre-calculated handshake key.
  9719. *
  9720. * ssl The SSL/TLS object.
  9721. * returns 0 on success and otherwise failure.
  9722. */
  9723. static int SendTls13EndOfEarlyData(WOLFSSL* ssl)
  9724. {
  9725. byte* output;
  9726. int ret;
  9727. int sendSz;
  9728. word32 length;
  9729. word32 idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  9730. WOLFSSL_START(WC_FUNC_END_OF_EARLY_DATA_SEND);
  9731. WOLFSSL_ENTER("SendTls13EndOfEarlyData");
  9732. length = 0;
  9733. sendSz = idx + length + MAX_MSG_EXTRA;
  9734. ssl->options.buildingMsg = 1;
  9735. /* Check buffers are big enough and grow if needed. */
  9736. if ((ret = CheckAvailableSize(ssl, sendSz)) != 0)
  9737. return ret;
  9738. /* Get position in output buffer to write new message to. */
  9739. output = GetOutputBuffer(ssl);
  9740. /* Put the record and handshake headers on. */
  9741. AddTls13Headers(output, length, end_of_early_data, ssl);
  9742. /* This message is always encrypted. */
  9743. sendSz = BuildTls13Message(ssl, output, sendSz, output + RECORD_HEADER_SZ,
  9744. idx - RECORD_HEADER_SZ, handshake, 1, 0, 0);
  9745. if (sendSz < 0)
  9746. return sendSz;
  9747. ssl->buffers.outputBuffer.length += sendSz;
  9748. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  9749. return ret;
  9750. ssl->options.buildingMsg = 0;
  9751. if (!ssl->options.groupMessages)
  9752. ret = SendBuffered(ssl);
  9753. ssl->earlyData = done_early_data;
  9754. WOLFSSL_LEAVE("SendTls13EndOfEarlyData", ret);
  9755. WOLFSSL_END(WC_FUNC_END_OF_EARLY_DATA_SEND);
  9756. return ret;
  9757. }
  9758. #endif /* !NO_WOLFSSL_CLIENT */
  9759. #ifndef NO_WOLFSSL_SERVER
  9760. /* handle processing of TLS 1.3 end_of_early_data (5) */
  9761. /* Parse the TLS v1.3 EndOfEarlyData message that indicates that there will be
  9762. * no more early application data.
  9763. * The decryption key now changes to the pre-calculated handshake key.
  9764. *
  9765. * ssl The SSL/TLS object.
  9766. * returns 0 on success and otherwise failure.
  9767. */
  9768. static int DoTls13EndOfEarlyData(WOLFSSL* ssl, const byte* input,
  9769. word32* inOutIdx, word32 size)
  9770. {
  9771. int ret;
  9772. word32 begin = *inOutIdx;
  9773. (void)input;
  9774. WOLFSSL_START(WC_FUNC_END_OF_EARLY_DATA_DO);
  9775. WOLFSSL_ENTER("DoTls13EndOfEarlyData");
  9776. if ((*inOutIdx - begin) != size)
  9777. return BUFFER_ERROR;
  9778. if (ssl->earlyData == no_early_data) {
  9779. WOLFSSL_MSG("EndOfEarlyData received unexpectedly");
  9780. SendAlert(ssl, alert_fatal, unexpected_message);
  9781. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  9782. return OUT_OF_ORDER_E;
  9783. }
  9784. ssl->earlyData = done_early_data;
  9785. /* Always encrypted. */
  9786. *inOutIdx += ssl->keys.padSz;
  9787. ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY);
  9788. WOLFSSL_LEAVE("DoTls13EndOfEarlyData", ret);
  9789. WOLFSSL_END(WC_FUNC_END_OF_EARLY_DATA_DO);
  9790. return ret;
  9791. }
  9792. #endif /* !NO_WOLFSSL_SERVER */
  9793. #endif /* WOLFSSL_EARLY_DATA */
  9794. #if defined(HAVE_SESSION_TICKET) && defined(WOLFSSL_TICKET_NONCE_MALLOC) && \
  9795. (!defined(HAVE_FIPS) || (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3)))
  9796. int SessionTicketNoncePopulate(WOLFSSL_SESSION *session, const byte *nonce,
  9797. byte len)
  9798. {
  9799. if (session->ticketNonce.data
  9800. != session->ticketNonce.dataStatic) {
  9801. XFREE(session->ticketNonce.data, session->heap,
  9802. DYNAMIC_TYPE_SESSION_TICK);
  9803. session->ticketNonce.data = session->ticketNonce.dataStatic;
  9804. session->ticketNonce.len = 0;
  9805. }
  9806. if (len > MAX_TICKET_NONCE_STATIC_SZ) {
  9807. WOLFSSL_MSG("Using dynamic nonce buffer");
  9808. session->ticketNonce.data = (byte*)XMALLOC(len,
  9809. session->heap, DYNAMIC_TYPE_SESSION_TICK);
  9810. if (session->ticketNonce.data == NULL)
  9811. return MEMORY_ERROR;
  9812. }
  9813. XMEMCPY(session->ticketNonce.data, nonce, len);
  9814. session->ticketNonce.len = len;
  9815. return 0;
  9816. }
  9817. #endif
  9818. #ifndef NO_WOLFSSL_CLIENT
  9819. /* Handle a New Session Ticket handshake message.
  9820. * Message contains the information required to perform resumption.
  9821. *
  9822. * ssl The SSL/TLS object.
  9823. * input The message buffer.
  9824. * inOutIdx On entry, the index into the message buffer of Finished.
  9825. * On exit, the index of byte after the Finished message and padding.
  9826. * size The length of the current handshake message.
  9827. * returns 0 on success, otherwise failure.
  9828. */
  9829. static int DoTls13NewSessionTicket(WOLFSSL* ssl, const byte* input,
  9830. word32* inOutIdx, word32 size)
  9831. {
  9832. #ifdef HAVE_SESSION_TICKET
  9833. int ret;
  9834. word32 begin = *inOutIdx;
  9835. word32 lifetime;
  9836. word32 ageAdd;
  9837. word16 length;
  9838. #ifdef WOLFSSL_32BIT_MILLI_TIME
  9839. word32 now;
  9840. #else
  9841. sword64 now;
  9842. #endif
  9843. const byte* nonce;
  9844. byte nonceLength;
  9845. WOLFSSL_START(WC_FUNC_NEW_SESSION_TICKET_DO);
  9846. WOLFSSL_ENTER("DoTls13NewSessionTicket");
  9847. /* Lifetime hint. */
  9848. if ((*inOutIdx - begin) + SESSION_HINT_SZ > size)
  9849. return BUFFER_ERROR;
  9850. ato32(input + *inOutIdx, &lifetime);
  9851. *inOutIdx += SESSION_HINT_SZ;
  9852. if (lifetime > MAX_LIFETIME) {
  9853. WOLFSSL_ERROR_VERBOSE(SERVER_HINT_ERROR);
  9854. return SERVER_HINT_ERROR;
  9855. }
  9856. /* Age add. */
  9857. if ((*inOutIdx - begin) + SESSION_ADD_SZ > size)
  9858. return BUFFER_ERROR;
  9859. ato32(input + *inOutIdx, &ageAdd);
  9860. *inOutIdx += SESSION_ADD_SZ;
  9861. /* Ticket nonce. */
  9862. if ((*inOutIdx - begin) + 1 > size)
  9863. return BUFFER_ERROR;
  9864. nonceLength = input[*inOutIdx];
  9865. #if !defined(WOLFSSL_TICKET_NONCE_MALLOC) && \
  9866. (!defined(HAVE_FIPS) || FIPS_VERSION_GE(5,3))
  9867. if (nonceLength > MAX_TICKET_NONCE_STATIC_SZ) {
  9868. WOLFSSL_MSG("Nonce length not supported");
  9869. WOLFSSL_ERROR_VERBOSE(INVALID_PARAMETER);
  9870. return INVALID_PARAMETER;
  9871. }
  9872. #endif /* WOLFSSL_TICKET_NONCE_MALLOC && FIPS_VERSION_GE(5,3) */
  9873. *inOutIdx += 1;
  9874. if ((*inOutIdx - begin) + nonceLength > size)
  9875. return BUFFER_ERROR;
  9876. nonce = input + *inOutIdx;
  9877. *inOutIdx += nonceLength;
  9878. /* Ticket length. */
  9879. if ((*inOutIdx - begin) + LENGTH_SZ > size)
  9880. return BUFFER_ERROR;
  9881. ato16(input + *inOutIdx, &length);
  9882. *inOutIdx += LENGTH_SZ;
  9883. if ((*inOutIdx - begin) + length > size)
  9884. return BUFFER_ERROR;
  9885. if ((ret = SetTicket(ssl, input + *inOutIdx, length)) != 0)
  9886. return ret;
  9887. *inOutIdx += length;
  9888. now = TimeNowInMilliseconds();
  9889. if (now == 0)
  9890. return GETTIME_ERROR;
  9891. /* Copy in ticket data (server identity). */
  9892. ssl->timeout = lifetime;
  9893. ssl->session->timeout = lifetime;
  9894. ssl->session->cipherSuite0 = ssl->options.cipherSuite0;
  9895. ssl->session->cipherSuite = ssl->options.cipherSuite;
  9896. ssl->session->ticketSeen = now;
  9897. ssl->session->ticketAdd = ageAdd;
  9898. #ifdef WOLFSSL_EARLY_DATA
  9899. ssl->session->maxEarlyDataSz = ssl->options.maxEarlyDataSz;
  9900. #endif
  9901. #if defined(WOLFSSL_TICKET_NONCE_MALLOC) && \
  9902. (!defined(HAVE_FIPS) || (defined(FIPS_VERSION_GE) && FIPS_VERSION_GE(5,3)))
  9903. ret = SessionTicketNoncePopulate(ssl->session, nonce, nonceLength);
  9904. if (ret != 0)
  9905. return ret;
  9906. #else
  9907. ssl->session->ticketNonce.len = nonceLength;
  9908. if (nonceLength > MAX_TICKET_NONCE_STATIC_SZ) {
  9909. ret = BUFFER_ERROR;
  9910. return ret;
  9911. }
  9912. if (nonceLength > 0)
  9913. XMEMCPY(ssl->session->ticketNonce.data, nonce, nonceLength);
  9914. #endif /* defined(WOLFSSL_TICKET_NONCE_MALLOC) && FIPS_VERSION_GE(5,3) */
  9915. ssl->session->namedGroup = ssl->namedGroup;
  9916. if ((*inOutIdx - begin) + EXTS_SZ > size)
  9917. return BUFFER_ERROR;
  9918. ato16(input + *inOutIdx, &length);
  9919. *inOutIdx += EXTS_SZ;
  9920. if ((*inOutIdx - begin) + length != size)
  9921. return BUFFER_ERROR;
  9922. #ifdef WOLFSSL_EARLY_DATA
  9923. ret = TLSX_Parse(ssl, (byte *)input + (*inOutIdx), length, session_ticket,
  9924. NULL);
  9925. if (ret != 0)
  9926. return ret;
  9927. #endif
  9928. *inOutIdx += length;
  9929. SetupSession(ssl);
  9930. #ifndef NO_SESSION_CACHE
  9931. AddSession(ssl);
  9932. #endif
  9933. /* Always encrypted. */
  9934. *inOutIdx += ssl->keys.padSz;
  9935. ssl->expect_session_ticket = 0;
  9936. #else
  9937. (void)ssl;
  9938. (void)input;
  9939. WOLFSSL_ENTER("DoTls13NewSessionTicket");
  9940. *inOutIdx += size + ssl->keys.padSz;
  9941. #endif /* HAVE_SESSION_TICKET */
  9942. WOLFSSL_LEAVE("DoTls13NewSessionTicket", 0);
  9943. WOLFSSL_END(WC_FUNC_NEW_SESSION_TICKET_DO);
  9944. return 0;
  9945. }
  9946. #endif /* NO_WOLFSSL_CLIENT */
  9947. #ifndef NO_WOLFSSL_SERVER
  9948. #ifdef HAVE_SESSION_TICKET
  9949. #ifdef WOLFSSL_TLS13_TICKET_BEFORE_FINISHED
  9950. /* Offset of the MAC size in the finished message. */
  9951. #define FINISHED_MSG_SIZE_OFFSET 3
  9952. /* Calculate the resumption secret which includes the unseen client finished
  9953. * message.
  9954. *
  9955. * ssl The SSL/TLS object.
  9956. * returns 0 on success, otherwise failure.
  9957. */
  9958. static int ExpectedResumptionSecret(WOLFSSL* ssl)
  9959. {
  9960. int ret;
  9961. word32 finishedSz = 0;
  9962. byte mac[WC_MAX_DIGEST_SIZE];
  9963. Digest digest;
  9964. static byte header[] = { 0x14, 0x00, 0x00, 0x00 };
  9965. /* Copy the running hash so we can restore it after. */
  9966. switch (ssl->specs.mac_algorithm) {
  9967. #ifndef NO_SHA256
  9968. case sha256_mac:
  9969. ret = wc_Sha256Copy(&ssl->hsHashes->hashSha256, &digest.sha256);
  9970. if (ret != 0)
  9971. return ret;
  9972. break;
  9973. #endif
  9974. #ifdef WOLFSSL_SHA384
  9975. case sha384_mac:
  9976. ret = wc_Sha384Copy(&ssl->hsHashes->hashSha384, &digest.sha384);
  9977. if (ret != 0)
  9978. return ret;
  9979. break;
  9980. #endif
  9981. #ifdef WOLFSSL_TLS13_SHA512
  9982. case sha512_mac:
  9983. ret = wc_Sha512Copy(&ssl->hsHashes->hashSha512, &digest.sha512);
  9984. if (ret != 0)
  9985. return ret;
  9986. break;
  9987. #endif
  9988. #ifdef WOLFSSL_SM3
  9989. case sm3_mac:
  9990. ret = wc_Sm3Copy(&ssl->hsHashes->hashSm3, &digest.sm3);
  9991. if (ret != 0)
  9992. return ret;
  9993. break;
  9994. #endif
  9995. }
  9996. /* Generate the Client's Finished message and hash it. */
  9997. ret = BuildTls13HandshakeHmac(ssl, ssl->keys.client_write_MAC_secret, mac,
  9998. &finishedSz);
  9999. if (ret != 0)
  10000. return ret;
  10001. header[FINISHED_MSG_SIZE_OFFSET] = finishedSz;
  10002. #ifdef WOLFSSL_EARLY_DATA
  10003. if (ssl->earlyData != no_early_data) {
  10004. static byte endOfEarlyData[] = { 0x05, 0x00, 0x00, 0x00 };
  10005. ret = HashRaw(ssl, endOfEarlyData, sizeof(endOfEarlyData));
  10006. if (ret != 0)
  10007. return ret;
  10008. }
  10009. #endif
  10010. if ((ret = HashRaw(ssl, header, sizeof(header))) != 0)
  10011. return ret;
  10012. if ((ret = HashRaw(ssl, mac, finishedSz)) != 0)
  10013. return ret;
  10014. if ((ret = DeriveResumptionSecret(ssl, ssl->session->masterSecret)) != 0)
  10015. return ret;
  10016. /* Restore the hash inline with currently seen messages. */
  10017. switch (ssl->specs.mac_algorithm) {
  10018. #ifndef NO_SHA256
  10019. case sha256_mac:
  10020. wc_Sha256Free(&ssl->hsHashes->hashSha256);
  10021. ret = wc_Sha256Copy(&digest.sha256, &ssl->hsHashes->hashSha256);
  10022. wc_Sha256Free(&digest.sha256);
  10023. if (ret != 0)
  10024. return ret;
  10025. break;
  10026. #endif
  10027. #ifdef WOLFSSL_SHA384
  10028. case sha384_mac:
  10029. wc_Sha384Free(&ssl->hsHashes->hashSha384);
  10030. ret = wc_Sha384Copy(&digest.sha384, &ssl->hsHashes->hashSha384);
  10031. wc_Sha384Free(&digest.sha384);
  10032. if (ret != 0)
  10033. return ret;
  10034. break;
  10035. #endif
  10036. #ifdef WOLFSSL_TLS13_SHA512
  10037. case sha512_mac:
  10038. wc_Sha512Free(&ssl->hsHashes->hashSha512);
  10039. ret = wc_Sha512Copy(&digest.sha512, &ssl->hsHashes->hashSha512);
  10040. wc_Sha512Free(&digest.sha512);
  10041. if (ret != 0)
  10042. return ret;
  10043. break;
  10044. #endif
  10045. #ifdef WOLFSSL_SM3
  10046. case sm3_mac:
  10047. wc_Sm3Free(&ssl->hsHashes->hashSm3);
  10048. ret = wc_Sm3Copy(&digest.sm3, &ssl->hsHashes->hashSm3);
  10049. wc_Sm3Free(&digest.sm3);
  10050. if (ret != 0)
  10051. return ret;
  10052. break;
  10053. #endif
  10054. }
  10055. return ret;
  10056. }
  10057. #endif
  10058. /* Send New Session Ticket handshake message.
  10059. * Message contains the information required to perform resumption.
  10060. *
  10061. * ssl The SSL/TLS object.
  10062. * returns 0 on success, otherwise failure.
  10063. */
  10064. static int SendTls13NewSessionTicket(WOLFSSL* ssl)
  10065. {
  10066. byte* output;
  10067. int ret;
  10068. int sendSz;
  10069. word16 extSz;
  10070. word32 length;
  10071. word32 idx = RECORD_HEADER_SZ + HANDSHAKE_HEADER_SZ;
  10072. WOLFSSL_START(WC_FUNC_NEW_SESSION_TICKET_SEND);
  10073. WOLFSSL_ENTER("SendTls13NewSessionTicket");
  10074. #ifdef WOLFSSL_DTLS13
  10075. if (ssl->options.dtls)
  10076. idx = Dtls13GetRlHeaderLength(ssl, 1) + DTLS_HANDSHAKE_HEADER_SZ;
  10077. #endif /* WOLFSSL_DTLS13 */
  10078. #ifdef WOLFSSL_TLS13_TICKET_BEFORE_FINISHED
  10079. if (!ssl->msgsReceived.got_finished) {
  10080. if ((ret = ExpectedResumptionSecret(ssl)) != 0)
  10081. return ret;
  10082. }
  10083. #endif
  10084. /* Start ticket nonce at 0 and go up to 255. */
  10085. if (ssl->session->ticketNonce.len == 0) {
  10086. ssl->session->ticketNonce.len = DEF_TICKET_NONCE_SZ;
  10087. ssl->session->ticketNonce.data[0] = 0;
  10088. }
  10089. else
  10090. #ifdef WOLFSSL_ASYNC_CRYPT
  10091. if (ssl->error != WC_PENDING_E)
  10092. #endif
  10093. {
  10094. ssl->session->ticketNonce.data[0]++;
  10095. }
  10096. if ((ssl->options.mask & WOLFSSL_OP_NO_TICKET) != 0) {
  10097. /* In this case we only send the ID as the ticket. Let's generate a new
  10098. * ID for the new ticket so that we don't overwrite any old ones */
  10099. ret = wc_RNG_GenerateBlock(ssl->rng, ssl->session->altSessionID,
  10100. ID_LEN);
  10101. if (ret != 0)
  10102. return ret;
  10103. ssl->session->haveAltSessionID = 1;
  10104. }
  10105. if (!ssl->options.noTicketTls13) {
  10106. if ((ret = SetupTicket(ssl)) != 0)
  10107. return ret;
  10108. /* No need to create the ticket if we only send the ID */
  10109. if ((ssl->options.mask & WOLFSSL_OP_NO_TICKET) == 0) {
  10110. if ((ret = CreateTicket(ssl)) != 0)
  10111. return ret;
  10112. }
  10113. }
  10114. #ifdef WOLFSSL_EARLY_DATA
  10115. ssl->session->maxEarlyDataSz = ssl->options.maxEarlyDataSz;
  10116. if (ssl->session->maxEarlyDataSz > 0)
  10117. TLSX_EarlyData_Use(ssl, ssl->session->maxEarlyDataSz, 1);
  10118. extSz = 0;
  10119. ret = TLSX_GetResponseSize(ssl, session_ticket, &extSz);
  10120. if (ret != 0)
  10121. return ret;
  10122. #else
  10123. extSz = EXTS_SZ;
  10124. #endif
  10125. /* Lifetime | Age Add | Ticket session ID | Extensions */
  10126. length = SESSION_HINT_SZ + SESSION_ADD_SZ + LENGTH_SZ;
  10127. if ((ssl->options.mask & WOLFSSL_OP_NO_TICKET) != 0)
  10128. length += ID_LEN + extSz;
  10129. else
  10130. length += ssl->session->ticketLen + extSz;
  10131. /* Nonce */
  10132. length += TICKET_NONCE_LEN_SZ + DEF_TICKET_NONCE_SZ;
  10133. sendSz = idx + length + MAX_MSG_EXTRA;
  10134. /* Check buffers are big enough and grow if needed. */
  10135. if ((ret = CheckAvailableSize(ssl, sendSz)) != 0)
  10136. return ret;
  10137. /* Get position in output buffer to write new message to. */
  10138. output = GetOutputBuffer(ssl);
  10139. /* Put the record and handshake headers on. */
  10140. AddTls13Headers(output, length, session_ticket, ssl);
  10141. /* Lifetime hint */
  10142. c32toa(ssl->ctx->ticketHint, output + idx);
  10143. idx += SESSION_HINT_SZ;
  10144. /* Age add - obfuscator */
  10145. c32toa(ssl->session->ticketAdd, output + idx);
  10146. idx += SESSION_ADD_SZ;
  10147. output[idx++] = ssl->session->ticketNonce.len;
  10148. output[idx++] = ssl->session->ticketNonce.data[0];
  10149. /* length */
  10150. if ((ssl->options.mask & WOLFSSL_OP_NO_TICKET) != 0) {
  10151. c16toa(ID_LEN, output + idx);
  10152. }
  10153. else {
  10154. c16toa(ssl->session->ticketLen, output + idx);
  10155. }
  10156. idx += LENGTH_SZ;
  10157. /* ticket */
  10158. if ((ssl->options.mask & WOLFSSL_OP_NO_TICKET) != 0) {
  10159. if (ssl->session->haveAltSessionID)
  10160. XMEMCPY(output + idx, ssl->session->altSessionID, ID_LEN);
  10161. else
  10162. return BAD_FUNC_ARG; /* Should not happen */
  10163. idx += ID_LEN;
  10164. }
  10165. else {
  10166. XMEMCPY(output + idx, ssl->session->ticket, ssl->session->ticketLen);
  10167. idx += ssl->session->ticketLen;
  10168. }
  10169. #ifdef WOLFSSL_EARLY_DATA
  10170. extSz = 0;
  10171. ret = TLSX_WriteResponse(ssl, output + idx, session_ticket, &extSz);
  10172. if (ret != 0)
  10173. return ret;
  10174. idx += extSz;
  10175. #else
  10176. /* No extension support - empty extensions. */
  10177. c16toa(0, output + idx);
  10178. idx += EXTS_SZ;
  10179. #endif
  10180. ssl->options.haveSessionId = 1;
  10181. SetupSession(ssl);
  10182. /* Only add to cache when support built in and when the ticket contains
  10183. * an ID. Otherwise we have no way to actually retrieve the ticket from the
  10184. * cache. */
  10185. #if !defined(NO_SESSION_CACHE) && defined(WOLFSSL_TICKET_HAVE_ID)
  10186. AddSession(ssl);
  10187. #endif
  10188. #ifdef WOLFSSL_DTLS13
  10189. if (ssl->options.dtls)
  10190. return Dtls13HandshakeSend(ssl, output, sendSz, idx, session_ticket, 0);
  10191. #endif /* WOLFSSL_DTLS13 */
  10192. /* This message is always encrypted. */
  10193. sendSz = BuildTls13Message(ssl, output, sendSz, output + RECORD_HEADER_SZ,
  10194. idx - RECORD_HEADER_SZ, handshake, 0, 0, 0);
  10195. if (sendSz < 0)
  10196. return sendSz;
  10197. ssl->buffers.outputBuffer.length += sendSz;
  10198. /* Always send as this is either directly after server's Finished or only
  10199. * message after client's Finished.
  10200. */
  10201. ret = SendBuffered(ssl);
  10202. WOLFSSL_LEAVE("SendTls13NewSessionTicket", 0);
  10203. WOLFSSL_END(WC_FUNC_NEW_SESSION_TICKET_SEND);
  10204. return ret;
  10205. }
  10206. #endif /* HAVE_SESSION_TICKET */
  10207. #endif /* NO_WOLFSSL_SERVER */
  10208. /* Make sure no duplicates, no fast forward, or other problems
  10209. *
  10210. * ssl The SSL/TLS object.
  10211. * type Type of handshake message received.
  10212. * returns 0 on success, otherwise failure.
  10213. */
  10214. static int SanityCheckTls13MsgReceived(WOLFSSL* ssl, byte type)
  10215. {
  10216. /* verify not a duplicate, mark received, check state */
  10217. switch (type) {
  10218. #ifndef NO_WOLFSSL_SERVER
  10219. case client_hello:
  10220. #ifndef NO_WOLFSSL_CLIENT
  10221. /* Only valid when received on SERVER side. */
  10222. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  10223. WOLFSSL_MSG("ClientHello received by client");
  10224. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10225. return SIDE_ERROR;
  10226. }
  10227. #endif
  10228. /* Check state. */
  10229. if (ssl->options.clientState >= CLIENT_HELLO_COMPLETE) {
  10230. WOLFSSL_MSG("ClientHello received out of order");
  10231. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10232. return OUT_OF_ORDER_E;
  10233. }
  10234. /* Check previously seen. */
  10235. /* Initial and after HelloRetryRequest - no more than 2. */
  10236. if (ssl->msgsReceived.got_client_hello == 2) {
  10237. WOLFSSL_MSG("Too many ClientHello received");
  10238. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10239. return DUPLICATE_MSG_E;
  10240. }
  10241. /* Second only after HelloRetryRequest seen. */
  10242. if (ssl->msgsReceived.got_client_hello == 1 &&
  10243. ssl->options.serverState !=
  10244. SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  10245. WOLFSSL_MSG("Duplicate ClientHello received");
  10246. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10247. return DUPLICATE_MSG_E;
  10248. }
  10249. ssl->msgsReceived.got_client_hello++;
  10250. break;
  10251. #endif
  10252. #ifndef NO_WOLFSSL_CLIENT
  10253. case server_hello:
  10254. #ifndef NO_WOLFSSL_SERVER
  10255. /* Only valid when received on CLIENT side. */
  10256. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10257. WOLFSSL_MSG("ServerHello received by server");
  10258. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10259. return SIDE_ERROR;
  10260. }
  10261. #endif
  10262. /* Check state. */
  10263. if (ssl->options.serverState >= SERVER_HELLO_COMPLETE) {
  10264. WOLFSSL_MSG("ServerHello received out of order");
  10265. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10266. return OUT_OF_ORDER_E;
  10267. }
  10268. /* Check previously seen. */
  10269. /* Only once after ClientHello.
  10270. * HelloRetryRequest has ServerHello type but count fixed up later
  10271. * - see DoTls13ServerHello().
  10272. */
  10273. if (ssl->msgsReceived.got_server_hello) {
  10274. WOLFSSL_MSG("Duplicate ServerHello received");
  10275. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10276. return DUPLICATE_MSG_E;
  10277. }
  10278. ssl->msgsReceived.got_server_hello = 1;
  10279. break;
  10280. #endif
  10281. #ifndef NO_WOLFSSL_CLIENT
  10282. case session_ticket:
  10283. #ifndef NO_WOLFSSL_SERVER
  10284. /* Only valid when received on CLIENT side. */
  10285. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10286. WOLFSSL_MSG("NewSessionTicket received by server");
  10287. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10288. return SIDE_ERROR;
  10289. }
  10290. #endif
  10291. /* Check state. */
  10292. #ifdef WOLFSSL_TLS13_TICKET_BEFORE_FINISHED
  10293. /* Only allowed after server's Finished message. */
  10294. if (ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  10295. WOLFSSL_MSG("NewSessionTicket received out of order");
  10296. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10297. return OUT_OF_ORDER_E;
  10298. }
  10299. #else
  10300. /* Only allowed after client's Finished message. */
  10301. if (ssl->options.clientState < CLIENT_FINISHED_COMPLETE) {
  10302. WOLFSSL_MSG("NewSessionTicket received out of order");
  10303. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10304. return OUT_OF_ORDER_E;
  10305. }
  10306. #endif
  10307. /* Many SessionTickets can be sent. */
  10308. ssl->msgsReceived.got_session_ticket = 1;
  10309. break;
  10310. #endif
  10311. #ifndef NO_WOLFSSL_SERVER
  10312. #ifdef WOLFSSL_EARLY_DATA
  10313. case end_of_early_data:
  10314. #ifndef NO_WOLFSSL_CLIENT
  10315. /* Only valid when received on SERVER side. */
  10316. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  10317. WOLFSSL_MSG("EndOfEarlyData received by client");
  10318. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10319. return SIDE_ERROR;
  10320. }
  10321. #endif
  10322. /* Check state. */
  10323. /* Only after server's Finished and before client's Finished. */
  10324. if (ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  10325. WOLFSSL_MSG("EndOfEarlyData received out of order");
  10326. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10327. return OUT_OF_ORDER_E;
  10328. }
  10329. if (ssl->options.clientState >= CLIENT_FINISHED_COMPLETE) {
  10330. WOLFSSL_MSG("EndOfEarlyData received out of order");
  10331. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10332. return OUT_OF_ORDER_E;
  10333. }
  10334. /* Check previously seen. */
  10335. if (ssl->msgsReceived.got_end_of_early_data) {
  10336. WOLFSSL_MSG("Too many EndOfEarlyData received");
  10337. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10338. return DUPLICATE_MSG_E;
  10339. }
  10340. ssl->msgsReceived.got_end_of_early_data = 1;
  10341. break;
  10342. #endif
  10343. #endif
  10344. #ifndef NO_WOLFSSL_CLIENT
  10345. case encrypted_extensions:
  10346. #ifndef NO_WOLFSSL_SERVER
  10347. /* Only valid when received on CLIENT side. */
  10348. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10349. WOLFSSL_MSG("EncryptedExtensions received by server");
  10350. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10351. return SIDE_ERROR;
  10352. }
  10353. #endif
  10354. /* Check state. */
  10355. /* Must be received directly after ServerHello.
  10356. * DoTls13EncryptedExtensions() changes state to:
  10357. * SERVER_ENCRYPTED_EXTENSIONS_COMPLETE.
  10358. */
  10359. if (ssl->options.serverState != SERVER_HELLO_COMPLETE) {
  10360. WOLFSSL_MSG("EncryptedExtensions received out of order");
  10361. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10362. return OUT_OF_ORDER_E;
  10363. }
  10364. /* Check previously seen. */
  10365. if (ssl->msgsReceived.got_encrypted_extensions) {
  10366. WOLFSSL_MSG("Duplicate EncryptedExtensions received");
  10367. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10368. return DUPLICATE_MSG_E;
  10369. }
  10370. ssl->msgsReceived.got_encrypted_extensions = 1;
  10371. break;
  10372. #endif
  10373. case certificate:
  10374. /* Valid on both sides. */
  10375. #ifndef NO_WOLFSSL_CLIENT
  10376. /* Check state. */
  10377. /* On client, seen after EncryptedExtension and CertificateRequest
  10378. * (if sent) and before CertificateVerify and Finished.
  10379. * DoTls13Certificate() sets serverState to SERVER_CERT_COMPLETE.
  10380. */
  10381. if (ssl->options.side == WOLFSSL_CLIENT_END &&
  10382. ssl->options.serverState !=
  10383. SERVER_ENCRYPTED_EXTENSIONS_COMPLETE) {
  10384. WOLFSSL_MSG("Certificate received out of order - Client");
  10385. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10386. return OUT_OF_ORDER_E;
  10387. }
  10388. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  10389. /* Server's authenticating with PSK must not send this. */
  10390. if (ssl->options.side == WOLFSSL_CLIENT_END &&
  10391. ssl->options.serverState == SERVER_CERT_COMPLETE &&
  10392. ssl->options.pskNegotiated) {
  10393. WOLFSSL_MSG("Certificate received while using PSK");
  10394. WOLFSSL_ERROR_VERBOSE(SANITY_MSG_E);
  10395. return SANITY_MSG_E;
  10396. }
  10397. #endif
  10398. #endif
  10399. #ifndef NO_WOLFSSL_SERVER
  10400. /* Check state. */
  10401. /* On Server, valid after ClientHello received and ServerFinished
  10402. * sent. */
  10403. if (ssl->options.side == WOLFSSL_SERVER_END &&
  10404. ssl->options.clientState != CLIENT_HELLO_COMPLETE &&
  10405. ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  10406. WOLFSSL_MSG("Certificate received out of order - Server");
  10407. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10408. return OUT_OF_ORDER_E;
  10409. }
  10410. #endif
  10411. /* Check previously seen. */
  10412. if (ssl->msgsReceived.got_certificate) {
  10413. WOLFSSL_MSG("Duplicate Certificate received");
  10414. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10415. return DUPLICATE_MSG_E;
  10416. }
  10417. ssl->msgsReceived.got_certificate = 1;
  10418. break;
  10419. #ifndef NO_WOLFSSL_CLIENT
  10420. case certificate_request:
  10421. #ifndef NO_WOLFSSL_SERVER
  10422. /* Only valid when received on CLIENT side. */
  10423. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10424. WOLFSSL_MSG("CertificateRequest received by server");
  10425. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10426. return SIDE_ERROR;
  10427. }
  10428. #endif
  10429. /* Check state. */
  10430. #ifndef WOLFSSL_POST_HANDSHAKE_AUTH
  10431. /* Only valid when sent after EncryptedExtensions and before
  10432. * Certificate. */
  10433. if (ssl->options.serverState !=
  10434. SERVER_ENCRYPTED_EXTENSIONS_COMPLETE) {
  10435. WOLFSSL_MSG("CertificateRequest received out of order");
  10436. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10437. return OUT_OF_ORDER_E;
  10438. }
  10439. #else
  10440. /* Valid when sent after EncryptedExtensions and before Certificate
  10441. * and after both client and server have sent Finished (Post
  10442. * Handshake Authentication). */
  10443. if (ssl->options.serverState !=
  10444. SERVER_ENCRYPTED_EXTENSIONS_COMPLETE &&
  10445. (ssl->options.serverState < SERVER_FINISHED_COMPLETE ||
  10446. ssl->options.clientState != CLIENT_FINISHED_COMPLETE)) {
  10447. WOLFSSL_MSG("CertificateRequest received out of order");
  10448. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10449. return OUT_OF_ORDER_E;
  10450. }
  10451. #endif
  10452. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  10453. /* Server's authenticating with PSK must not send this. */
  10454. if (ssl->options.pskNegotiated) {
  10455. WOLFSSL_MSG("CertificateRequest received while using PSK");
  10456. WOLFSSL_ERROR_VERBOSE(SANITY_MSG_E);
  10457. return SANITY_MSG_E;
  10458. }
  10459. #endif
  10460. /* Check previously seen. */
  10461. #ifndef WOLFSSL_POST_HANDSHAKE_AUTH
  10462. /* Only once during handshake. */
  10463. if (ssl->msgsReceived.got_certificate_request) {
  10464. WOLFSSL_MSG("Duplicate CertificateRequest received");
  10465. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10466. return DUPLICATE_MSG_E;
  10467. }
  10468. #else
  10469. /* Only once during handshake. */
  10470. if (ssl->msgsReceived.got_certificate_request &&
  10471. ssl->options.clientState != CLIENT_FINISHED_COMPLETE) {
  10472. WOLFSSL_MSG("Duplicate CertificateRequest received");
  10473. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10474. return DUPLICATE_MSG_E;
  10475. }
  10476. #endif
  10477. ssl->msgsReceived.got_certificate_request = 1;
  10478. break;
  10479. #endif
  10480. case certificate_verify:
  10481. /* Valid on both sides. */
  10482. #ifndef NO_WOLFSSL_CLIENT
  10483. /* Check state on client.
  10484. * Valid only directly after a Certificate message. */
  10485. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  10486. if (ssl->options.serverState != SERVER_CERT_COMPLETE) {
  10487. WOLFSSL_MSG("No Cert before CertVerify");
  10488. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10489. return OUT_OF_ORDER_E;
  10490. }
  10491. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  10492. /* Server's authenticating with PSK must not send this. */
  10493. if (ssl->options.pskNegotiated) {
  10494. WOLFSSL_MSG("CertificateVerify received while using PSK");
  10495. WOLFSSL_ERROR_VERBOSE(SANITY_MSG_E);
  10496. return SANITY_MSG_E;
  10497. }
  10498. #endif
  10499. }
  10500. #endif
  10501. #ifndef NO_WOLFSSL_SERVER
  10502. /* Check state on server. */
  10503. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10504. /* Server must have sent Finished message. */
  10505. if (ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  10506. WOLFSSL_MSG("CertificateVerify received out of order");
  10507. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10508. return OUT_OF_ORDER_E;
  10509. }
  10510. /* Valid only directly after a Certificate message. */
  10511. if (ssl->options.clientState < CLIENT_HELLO_COMPLETE) {
  10512. WOLFSSL_MSG("CertificateVerify before ClientHello done");
  10513. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10514. return OUT_OF_ORDER_E;
  10515. }
  10516. if (!ssl->msgsReceived.got_certificate) {
  10517. WOLFSSL_MSG("No Cert before CertificateVerify");
  10518. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10519. return OUT_OF_ORDER_E;
  10520. }
  10521. }
  10522. #endif
  10523. /* Check previously seen. */
  10524. if (ssl->msgsReceived.got_certificate_verify) {
  10525. WOLFSSL_MSG("Duplicate CertificateVerify received");
  10526. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10527. return DUPLICATE_MSG_E;
  10528. }
  10529. ssl->msgsReceived.got_certificate_verify = 1;
  10530. break;
  10531. case finished:
  10532. /* Valid on both sides. */
  10533. #ifndef NO_WOLFSSL_CLIENT
  10534. /* Check state on client. */
  10535. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  10536. /* After sending ClientHello */
  10537. if (ssl->options.clientState < CLIENT_HELLO_COMPLETE) {
  10538. WOLFSSL_MSG("Finished received out of order - clientState");
  10539. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10540. return OUT_OF_ORDER_E;
  10541. }
  10542. /* Must have seen certificate and verify from server except when
  10543. * using PSK. */
  10544. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  10545. if (ssl->options.pskNegotiated) {
  10546. if (ssl->options.serverState !=
  10547. SERVER_ENCRYPTED_EXTENSIONS_COMPLETE) {
  10548. WOLFSSL_MSG("Finished received out of order - PSK");
  10549. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10550. return OUT_OF_ORDER_E;
  10551. }
  10552. }
  10553. else
  10554. #endif
  10555. if (ssl->options.serverState != SERVER_CERT_VERIFY_COMPLETE) {
  10556. WOLFSSL_MSG("Finished received out of order - serverState");
  10557. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10558. return OUT_OF_ORDER_E;
  10559. }
  10560. }
  10561. #endif
  10562. #ifndef NO_WOLFSSL_SERVER
  10563. /* Check state on server. */
  10564. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10565. if (ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  10566. WOLFSSL_MSG("Finished received out of order - serverState");
  10567. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10568. return OUT_OF_ORDER_E;
  10569. }
  10570. if (ssl->options.clientState < CLIENT_HELLO_COMPLETE) {
  10571. WOLFSSL_MSG("Finished received out of order - clientState");
  10572. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10573. return OUT_OF_ORDER_E;
  10574. }
  10575. #ifdef WOLFSSL_EARLY_DATA
  10576. if (ssl->earlyData == process_early_data &&
  10577. /* early data may be lost when using DTLS */
  10578. !ssl->options.dtls
  10579. /* QUIC does not use EndOfEarlyData records */
  10580. && !WOLFSSL_IS_QUIC(ssl)) {
  10581. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10582. return OUT_OF_ORDER_E;
  10583. }
  10584. #endif
  10585. }
  10586. #endif
  10587. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  10588. if (!ssl->options.pskNegotiated)
  10589. #endif
  10590. {
  10591. /* Must have received a Certificate message from client if
  10592. * verifying the peer. Empty certificate message indicates
  10593. * no certificate available.
  10594. */
  10595. if (ssl->options.verifyPeer &&
  10596. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  10597. !ssl->options.verifyPostHandshake &&
  10598. #endif
  10599. !ssl->msgsReceived.got_certificate) {
  10600. WOLFSSL_MSG("Finished received out of order - "
  10601. "missing Certificate message");
  10602. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10603. return OUT_OF_ORDER_E;
  10604. }
  10605. /* Mutual authentication on server requires a certificate from
  10606. * peer. Verify peer set on client side requires a certificate
  10607. * from peer as not doing PSK.
  10608. */
  10609. if ((ssl->options.mutualAuth ||
  10610. (ssl->options.side == WOLFSSL_CLIENT_END &&
  10611. ssl->options.verifyPeer)) && !ssl->options.havePeerCert) {
  10612. WOLFSSL_MSG("Finished received out of order - "
  10613. "no valid certificate");
  10614. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10615. return OUT_OF_ORDER_E;
  10616. }
  10617. /* Must have received a valid CertificateVerify if verifying
  10618. * peer and got a peer certificate.
  10619. */
  10620. if ((ssl->options.mutualAuth || ssl->options.verifyPeer) &&
  10621. ssl->options.havePeerCert && !ssl->options.havePeerVerify) {
  10622. WOLFSSL_MSG("Finished received out of order - "
  10623. "Certificate message but no CertificateVerify");
  10624. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10625. return OUT_OF_ORDER_E;
  10626. }
  10627. }
  10628. /* Check previously seen. */
  10629. if (ssl->msgsReceived.got_finished) {
  10630. WOLFSSL_MSG("Duplicate Finished received");
  10631. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10632. return DUPLICATE_MSG_E;
  10633. }
  10634. ssl->msgsReceived.got_finished = 1;
  10635. break;
  10636. case key_update:
  10637. /* Valid on both sides. */
  10638. /* Check state.
  10639. * Client and server must have received finished message from other
  10640. * side.
  10641. */
  10642. if (!ssl->msgsReceived.got_finished) {
  10643. WOLFSSL_MSG("No KeyUpdate before Finished");
  10644. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10645. return OUT_OF_ORDER_E;
  10646. }
  10647. /* Multiple KeyUpdates can be sent. */
  10648. break;
  10649. #if defined(WOLFSSL_DTLS13) && !defined(WOLFSSL_NO_TLS12)
  10650. case hello_verify_request:
  10651. if (!ssl->options.dtls) {
  10652. WOLFSSL_MSG("HelloVerifyRequest when not in DTLS");
  10653. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10654. return OUT_OF_ORDER_E;
  10655. }
  10656. if (ssl->msgsReceived.got_hello_verify_request) {
  10657. WOLFSSL_MSG("Duplicate HelloVerifyRequest received");
  10658. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10659. return DUPLICATE_MSG_E;
  10660. }
  10661. ssl->msgsReceived.got_hello_verify_request = 1;
  10662. if (ssl->msgsReceived.got_hello_retry_request) {
  10663. WOLFSSL_MSG(
  10664. "Both HelloVerifyRequest and HelloRetryRequest received");
  10665. WOLFSSL_ERROR_VERBOSE(DUPLICATE_MSG_E);
  10666. return DUPLICATE_MSG_E;
  10667. }
  10668. if (ssl->options.serverState >=
  10669. SERVER_HELLO_RETRY_REQUEST_COMPLETE ||
  10670. ssl->options.connectState != CLIENT_HELLO_SENT) {
  10671. WOLFSSL_MSG("HelloVerifyRequest received out of order");
  10672. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10673. return OUT_OF_ORDER_E;
  10674. }
  10675. if (ssl->options.side == WOLFSSL_SERVER_END) {
  10676. WOLFSSL_MSG("HelloVerifyRequest received on the server");
  10677. WOLFSSL_ERROR_VERBOSE(SIDE_ERROR);
  10678. return SIDE_ERROR;
  10679. }
  10680. if (!ssl->options.downgrade ||
  10681. ssl->options.minDowngrade < DTLSv1_2_MINOR) {
  10682. WOLFSSL_MSG(
  10683. "HelloVerifyRequest received but not DTLSv1.2 allowed");
  10684. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  10685. return VERSION_ERROR;
  10686. }
  10687. break;
  10688. #endif /* WOLFSSL_DTLS13 && !WOLFSSL_NO_TLS12*/
  10689. default:
  10690. WOLFSSL_MSG("Unknown message type");
  10691. WOLFSSL_ERROR_VERBOSE(SANITY_MSG_E);
  10692. return SANITY_MSG_E;
  10693. }
  10694. return 0;
  10695. }
  10696. /* Handle a type of handshake message that has been received.
  10697. *
  10698. * ssl The SSL/TLS object.
  10699. * input The message buffer.
  10700. * inOutIdx On entry, the index into the buffer of the current message.
  10701. * On exit, the index into the buffer of the next message.
  10702. * size The length of the current handshake message.
  10703. * totalSz Length of remaining data in the message buffer.
  10704. * returns 0 on success and otherwise failure.
  10705. */
  10706. int DoTls13HandShakeMsgType(WOLFSSL* ssl, byte* input, word32* inOutIdx,
  10707. byte type, word32 size, word32 totalSz)
  10708. {
  10709. int ret = 0, tmp;
  10710. word32 inIdx = *inOutIdx;
  10711. int alertType = invalid_alert;
  10712. #if defined(HAVE_ECH)
  10713. TLSX* echX = NULL;
  10714. word32 echInOutIdx;
  10715. #endif
  10716. (void)totalSz;
  10717. WOLFSSL_ENTER("DoTls13HandShakeMsgType");
  10718. /* make sure we can read the message */
  10719. if (*inOutIdx + size > totalSz)
  10720. return INCOMPLETE_DATA;
  10721. /* sanity check msg received */
  10722. if ((ret = SanityCheckTls13MsgReceived(ssl, type)) != 0) {
  10723. WOLFSSL_MSG("Sanity Check on handshake message type received failed");
  10724. if (ret == VERSION_ERROR)
  10725. SendAlert(ssl, alert_fatal, wolfssl_alert_protocol_version);
  10726. else
  10727. SendAlert(ssl, alert_fatal, unexpected_message);
  10728. return ret;
  10729. }
  10730. #if defined(WOLFSSL_CALLBACKS)
  10731. /* add name later, add on record and handshake header part back on */
  10732. if (ssl->toInfoOn) {
  10733. ret = AddPacketInfo(ssl, 0, handshake, input + *inOutIdx -
  10734. HANDSHAKE_HEADER_SZ, size + HANDSHAKE_HEADER_SZ, READ_PROTO,
  10735. RECORD_HEADER_SZ, ssl->heap);
  10736. if (ret != 0)
  10737. return ret;
  10738. AddLateRecordHeader(&ssl->curRL, &ssl->timeoutInfo);
  10739. }
  10740. #endif
  10741. if (ssl->options.handShakeState == HANDSHAKE_DONE &&
  10742. type != session_ticket && type != certificate_request &&
  10743. type != certificate && type != key_update && type != finished) {
  10744. WOLFSSL_MSG("HandShake message after handshake complete");
  10745. SendAlert(ssl, alert_fatal, unexpected_message);
  10746. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10747. return OUT_OF_ORDER_E;
  10748. }
  10749. if (ssl->options.side == WOLFSSL_CLIENT_END &&
  10750. ssl->options.serverState == NULL_STATE &&
  10751. type != server_hello && type != hello_retry_request
  10752. #if defined(WOLFSSL_DTLS13) && !defined(WOLFSSL_NO_TLS12)
  10753. && (!ssl->options.dtls || type != hello_verify_request)
  10754. #endif /* defined(WOLFSSL_DTLS13) && !defined(WOLFSSL_NO_TLS12) */
  10755. ) {
  10756. WOLFSSL_MSG("First server message not server hello");
  10757. SendAlert(ssl, alert_fatal, unexpected_message);
  10758. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10759. return OUT_OF_ORDER_E;
  10760. }
  10761. if (ssl->options.side == WOLFSSL_SERVER_END &&
  10762. ssl->options.clientState == NULL_STATE && type != client_hello) {
  10763. WOLFSSL_MSG("First client message not client hello");
  10764. SendAlert(ssl, alert_fatal, unexpected_message);
  10765. WOLFSSL_ERROR_VERBOSE(OUT_OF_ORDER_E);
  10766. return OUT_OF_ORDER_E;
  10767. }
  10768. /* above checks handshake state */
  10769. switch (type) {
  10770. #ifndef NO_WOLFSSL_CLIENT
  10771. /* Messages only received by client. */
  10772. case server_hello:
  10773. WOLFSSL_MSG("processing server hello");
  10774. ret = DoTls13ServerHello(ssl, input, inOutIdx, size, &type);
  10775. #if !defined(WOLFSSL_NO_CLIENT_AUTH) && \
  10776. ((defined(HAVE_ED25519) && !defined(NO_ED25519_CLIENT_AUTH)) || \
  10777. (defined(HAVE_ED448) && !defined(NO_ED448_CLIENT_AUTH)))
  10778. if (ssl->options.resuming || !IsAtLeastTLSv1_2(ssl) ||
  10779. IsAtLeastTLSv1_3(ssl->version)) {
  10780. ssl->options.cacheMessages = 0;
  10781. if ((ssl->hsHashes != NULL) && (ssl->hsHashes->messages != NULL)) {
  10782. ForceZero(ssl->hsHashes->messages, ssl->hsHashes->length);
  10783. XFREE(ssl->hsHashes->messages, ssl->heap, DYNAMIC_TYPE_HASHES);
  10784. ssl->hsHashes->messages = NULL;
  10785. }
  10786. }
  10787. #endif
  10788. break;
  10789. case encrypted_extensions:
  10790. WOLFSSL_MSG("processing encrypted extensions");
  10791. ret = DoTls13EncryptedExtensions(ssl, input, inOutIdx, size);
  10792. break;
  10793. #ifndef NO_CERTS
  10794. case certificate_request:
  10795. WOLFSSL_MSG("processing certificate request");
  10796. ret = DoTls13CertificateRequest(ssl, input, inOutIdx, size);
  10797. break;
  10798. #endif
  10799. case session_ticket:
  10800. WOLFSSL_MSG("processing new session ticket");
  10801. ret = DoTls13NewSessionTicket(ssl, input, inOutIdx, size);
  10802. break;
  10803. #endif /* !NO_WOLFSSL_CLIENT */
  10804. #ifndef NO_WOLFSSL_SERVER
  10805. /* Messages only received by server. */
  10806. case client_hello:
  10807. WOLFSSL_MSG("processing client hello");
  10808. #if defined(HAVE_ECH)
  10809. /* keep the start idx so we can restore it for the inner call */
  10810. echInOutIdx = *inOutIdx;
  10811. #endif
  10812. ret = DoTls13ClientHello(ssl, input, inOutIdx, size);
  10813. #if !defined(WOLFSSL_NO_CLIENT_AUTH) && \
  10814. ((defined(HAVE_ED25519) && !defined(NO_ED25519_CLIENT_AUTH)) || \
  10815. (defined(HAVE_ED448) && !defined(NO_ED448_CLIENT_AUTH)))
  10816. if ((ssl->options.resuming || !ssl->options.verifyPeer ||
  10817. !IsAtLeastTLSv1_2(ssl) || IsAtLeastTLSv1_3(ssl->version))
  10818. #ifdef WOLFSSL_DTLS13
  10819. && (!ssl->options.dtls)
  10820. #endif
  10821. ) {
  10822. #if defined(WOLFSSL_ASYNC_CRYPT) || defined(WOLFSSL_NONBLOCK_OCSP)
  10823. if (ret != WC_PENDING_E && ret != OCSP_WANT_READ)
  10824. #endif
  10825. {
  10826. ssl->options.cacheMessages = 0;
  10827. if ((ssl->hsHashes != NULL) &&
  10828. (ssl->hsHashes->messages != NULL)) {
  10829. ForceZero(ssl->hsHashes->messages, ssl->hsHashes->length);
  10830. XFREE(ssl->hsHashes->messages, ssl->heap,
  10831. DYNAMIC_TYPE_HASHES);
  10832. ssl->hsHashes->messages = NULL;
  10833. }
  10834. }
  10835. }
  10836. #endif
  10837. #if defined(HAVE_ECH)
  10838. if (ret == 0) {
  10839. echX = TLSX_Find(ssl->extensions, TLSX_ECH);
  10840. if (echX != NULL &&
  10841. ((WOLFSSL_ECH*)echX->data)->state == ECH_WRITE_NONE) {
  10842. /* reset the inOutIdx to the outer start */
  10843. *inOutIdx = echInOutIdx;
  10844. /* call again with the inner hello */
  10845. ret = DoTls13ClientHello(ssl,
  10846. ((WOLFSSL_ECH*)echX->data)->innerClientHello,
  10847. &echInOutIdx,
  10848. ((WOLFSSL_ECH*)echX->data)->innerClientHelloLen);
  10849. /* if the inner ech parsed successfully we have successfully
  10850. * handled the hello and can skip the whole message */
  10851. if (ret == 0)
  10852. *inOutIdx += size;
  10853. }
  10854. }
  10855. #endif /* HAVE_ECH */
  10856. break;
  10857. #ifdef WOLFSSL_EARLY_DATA
  10858. case end_of_early_data:
  10859. WOLFSSL_MSG("processing end of early data");
  10860. ret = DoTls13EndOfEarlyData(ssl, input, inOutIdx, size);
  10861. break;
  10862. #endif
  10863. #endif /* !NO_WOLFSSL_SERVER */
  10864. /* Messages received by both client and server. */
  10865. #if !defined(NO_CERTS) && (!defined(NO_WOLFSSL_CLIENT) || \
  10866. !defined(WOLFSSL_NO_CLIENT_AUTH))
  10867. case certificate:
  10868. WOLFSSL_MSG("processing certificate");
  10869. ret = DoTls13Certificate(ssl, input, inOutIdx, size);
  10870. break;
  10871. #endif
  10872. #if !defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_ED25519) || \
  10873. defined(HAVE_ED448) || defined(HAVE_PQC)
  10874. case certificate_verify:
  10875. WOLFSSL_MSG("processing certificate verify");
  10876. ret = DoTls13CertificateVerify(ssl, input, inOutIdx, size);
  10877. break;
  10878. #endif
  10879. case finished:
  10880. WOLFSSL_MSG("processing finished");
  10881. ret = DoTls13Finished(ssl, input, inOutIdx, size, totalSz, NO_SNIFF);
  10882. break;
  10883. case key_update:
  10884. WOLFSSL_MSG("processing key update");
  10885. ret = DoTls13KeyUpdate(ssl, input, inOutIdx, size);
  10886. break;
  10887. #if defined(WOLFSSL_DTLS13) && !defined(WOLFSSL_NO_TLS12) && \
  10888. !defined(NO_WOLFSSL_CLIENT)
  10889. case hello_verify_request:
  10890. WOLFSSL_MSG("processing hello verify request");
  10891. ret = DoHelloVerifyRequest(ssl, input, inOutIdx, size);
  10892. break;
  10893. #endif
  10894. default:
  10895. WOLFSSL_MSG("Unknown handshake message type");
  10896. ret = UNKNOWN_HANDSHAKE_TYPE;
  10897. break;
  10898. }
  10899. #if defined(WOLFSSL_ASYNC_CRYPT) || defined(WOLFSSL_ASYNC_IO)
  10900. /* if async, offset index so this msg will be processed again */
  10901. /* NOTE: check this now before other calls can overwrite ret */
  10902. if ((ret == WC_PENDING_E || ret == OCSP_WANT_READ) && *inOutIdx > 0) {
  10903. /* DTLS always stores a message in a buffer when async is enable, so we
  10904. * don't need to adjust for the extra bytes here (*inOutIdx is always
  10905. * == 0) */
  10906. *inOutIdx -= HANDSHAKE_HEADER_SZ;
  10907. }
  10908. /* make sure async error is cleared */
  10909. if (ret == 0 && (ssl->error == WC_PENDING_E || ssl->error == OCSP_WANT_READ)) {
  10910. ssl->error = 0;
  10911. }
  10912. #endif
  10913. if (ret == 0 && type != client_hello && type != session_ticket &&
  10914. type != key_update) {
  10915. ret = HashInput(ssl, input + inIdx, size);
  10916. }
  10917. alertType = TranslateErrorToAlert(ret);
  10918. if (alertType != invalid_alert) {
  10919. #ifdef WOLFSSL_DTLS13
  10920. if (type == client_hello && ssl->options.dtls)
  10921. DtlsSetSeqNumForReply(ssl);
  10922. #endif
  10923. tmp = SendAlert(ssl, alert_fatal, alertType);
  10924. /* propagate socket error instead of tls error to be sure the error is
  10925. * not ignored by DTLS code */
  10926. if (tmp == SOCKET_ERROR_E)
  10927. ret = SOCKET_ERROR_E;
  10928. }
  10929. if (ret == 0 && ssl->options.tls1_3) {
  10930. /* Need to hash input message before deriving secrets. */
  10931. #ifndef NO_WOLFSSL_CLIENT
  10932. if (ssl->options.side == WOLFSSL_CLIENT_END) {
  10933. if (type == server_hello) {
  10934. if ((ret = DeriveEarlySecret(ssl)) != 0)
  10935. return ret;
  10936. if ((ret = DeriveHandshakeSecret(ssl)) != 0)
  10937. return ret;
  10938. if ((ret = DeriveTls13Keys(ssl, handshake_key,
  10939. ENCRYPT_AND_DECRYPT_SIDE, 1)) != 0) {
  10940. return ret;
  10941. }
  10942. #ifdef WOLFSSL_EARLY_DATA
  10943. if (ssl->earlyData != no_early_data) {
  10944. if ((ret = SetKeysSide(ssl, DECRYPT_SIDE_ONLY)) != 0)
  10945. return ret;
  10946. }
  10947. else
  10948. #endif
  10949. if ((ret = SetKeysSide(ssl, ENCRYPT_AND_DECRYPT_SIDE)) != 0)
  10950. return ret;
  10951. #ifdef WOLFSSL_DTLS13
  10952. if (ssl->options.dtls) {
  10953. w64wrapper epochHandshake;
  10954. epochHandshake = w64From32(0, DTLS13_EPOCH_HANDSHAKE);
  10955. ssl->dtls13Epoch = epochHandshake;
  10956. ssl->dtls13PeerEpoch = epochHandshake;
  10957. ret = Dtls13NewEpoch(
  10958. ssl, epochHandshake, ENCRYPT_AND_DECRYPT_SIDE);
  10959. if (ret != 0)
  10960. return ret;
  10961. ret = Dtls13SetEpochKeys(
  10962. ssl, epochHandshake, ENCRYPT_AND_DECRYPT_SIDE);
  10963. if (ret != 0)
  10964. return ret;
  10965. }
  10966. #endif /* WOLFSSL_DTLS13 */
  10967. }
  10968. if (type == finished) {
  10969. if ((ret = DeriveMasterSecret(ssl)) != 0)
  10970. return ret;
  10971. /* Last use of preMasterSecret - zeroize as soon as possible. */
  10972. ForceZero(ssl->arrays->preMasterSecret,
  10973. ssl->arrays->preMasterSz);
  10974. #ifdef WOLFSSL_EARLY_DATA
  10975. #ifdef WOLFSSL_QUIC
  10976. if (WOLFSSL_IS_QUIC(ssl) && ssl->earlyData != no_early_data) {
  10977. /* QUIC never sends/receives EndOfEarlyData, but having
  10978. * early data means the last encrpytion keys had not been
  10979. * set yet. */
  10980. if ((ret = SetKeysSide(ssl, ENCRYPT_SIDE_ONLY)) != 0)
  10981. return ret;
  10982. }
  10983. #endif
  10984. if ((ret = DeriveTls13Keys(ssl, traffic_key,
  10985. ENCRYPT_AND_DECRYPT_SIDE,
  10986. ssl->earlyData == no_early_data)) != 0) {
  10987. return ret;
  10988. }
  10989. #else
  10990. if ((ret = DeriveTls13Keys(ssl, traffic_key,
  10991. ENCRYPT_AND_DECRYPT_SIDE, 1)) != 0) {
  10992. return ret;
  10993. }
  10994. #endif
  10995. }
  10996. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  10997. if (type == certificate_request &&
  10998. ssl->options.handShakeState == HANDSHAKE_DONE) {
  10999. /* reset handshake states */
  11000. ssl->options.clientState = CLIENT_HELLO_COMPLETE;
  11001. ssl->options.connectState = FIRST_REPLY_DONE;
  11002. ssl->options.handShakeState = CLIENT_HELLO_COMPLETE;
  11003. ssl->options.processReply = 0; /* doProcessInit */
  11004. /*
  11005. DTLSv1.3 note: We can't reset serverState to
  11006. SERVER_FINISHED_COMPLETE with the goal that this connect
  11007. blocks until the cert/cert_verify/finished flight gets ACKed
  11008. by the server. The problem is that we will invoke
  11009. ProcessReplyEx() in that case, but we came here from
  11010. ProcessReplyEx() and it is not re-entrant safe (the input
  11011. buffer would still have the certificate_request message). */
  11012. if (wolfSSL_connect_TLSv13(ssl) != WOLFSSL_SUCCESS) {
  11013. ret = ssl->error;
  11014. if (ret != WC_PENDING_E)
  11015. ret = POST_HAND_AUTH_ERROR;
  11016. }
  11017. }
  11018. #endif
  11019. }
  11020. #endif /* NO_WOLFSSL_CLIENT */
  11021. #ifndef NO_WOLFSSL_SERVER
  11022. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  11023. if (ssl->options.side == WOLFSSL_SERVER_END && type == finished) {
  11024. ret = DeriveResumptionSecret(ssl, ssl->session->masterSecret);
  11025. if (ret != 0)
  11026. return ret;
  11027. }
  11028. #endif
  11029. #endif /* NO_WOLFSSL_SERVER */
  11030. }
  11031. #ifdef WOLFSSL_DTLS13
  11032. if (ssl->options.dtls && !ssl->options.dtlsStateful) {
  11033. DtlsResetState(ssl);
  11034. if (DtlsIgnoreError(ret))
  11035. ret = 0;
  11036. }
  11037. #endif
  11038. WOLFSSL_LEAVE("DoTls13HandShakeMsgType()", ret);
  11039. return ret;
  11040. }
  11041. /* Handle a handshake message that has been received.
  11042. *
  11043. * ssl The SSL/TLS object.
  11044. * input The message buffer.
  11045. * inOutIdx On entry, the index into the buffer of the current message.
  11046. * On exit, the index into the buffer of the next message.
  11047. * totalSz Length of remaining data in the message buffer.
  11048. * returns 0 on success and otherwise failure.
  11049. */
  11050. int DoTls13HandShakeMsg(WOLFSSL* ssl, byte* input, word32* inOutIdx,
  11051. word32 totalSz)
  11052. {
  11053. int ret = 0;
  11054. word32 inputLength;
  11055. byte type;
  11056. word32 size = 0;
  11057. WOLFSSL_ENTER("DoTls13HandShakeMsg");
  11058. if (ssl->arrays == NULL) {
  11059. if (GetHandshakeHeader(ssl, input, inOutIdx, &type, &size,
  11060. totalSz) != 0) {
  11061. SendAlert(ssl, alert_fatal, unexpected_message);
  11062. WOLFSSL_ERROR_VERBOSE(PARSE_ERROR);
  11063. return PARSE_ERROR;
  11064. }
  11065. ret = EarlySanityCheckMsgReceived(ssl, type, size);
  11066. if (ret != 0) {
  11067. WOLFSSL_ERROR(ret);
  11068. return ret;
  11069. }
  11070. return DoTls13HandShakeMsgType(ssl, input, inOutIdx, type, size,
  11071. totalSz);
  11072. }
  11073. inputLength = ssl->buffers.inputBuffer.length - *inOutIdx - ssl->keys.padSz;
  11074. /* If there is a pending fragmented handshake message,
  11075. * pending message size will be non-zero. */
  11076. if (ssl->arrays->pendingMsgSz == 0) {
  11077. if (GetHandshakeHeader(ssl, input, inOutIdx, &type, &size,
  11078. totalSz) != 0) {
  11079. WOLFSSL_ERROR_VERBOSE(PARSE_ERROR);
  11080. return PARSE_ERROR;
  11081. }
  11082. ret = EarlySanityCheckMsgReceived(ssl, type,
  11083. min(inputLength - HANDSHAKE_HEADER_SZ, size));
  11084. if (ret != 0) {
  11085. WOLFSSL_ERROR(ret);
  11086. return ret;
  11087. }
  11088. /* Cap the maximum size of a handshake message to something reasonable.
  11089. * By default is the maximum size of a certificate message assuming
  11090. * nine 2048-bit RSA certificates in the chain. */
  11091. if (size > MAX_HANDSHAKE_SZ) {
  11092. WOLFSSL_MSG("Handshake message too large");
  11093. WOLFSSL_ERROR_VERBOSE(HANDSHAKE_SIZE_ERROR);
  11094. return HANDSHAKE_SIZE_ERROR;
  11095. }
  11096. /* size is the size of the certificate message payload */
  11097. if (inputLength - HANDSHAKE_HEADER_SZ < size) {
  11098. ssl->arrays->pendingMsgType = type;
  11099. ssl->arrays->pendingMsgSz = size + HANDSHAKE_HEADER_SZ;
  11100. ssl->arrays->pendingMsg = (byte*)XMALLOC(size + HANDSHAKE_HEADER_SZ,
  11101. ssl->heap,
  11102. DYNAMIC_TYPE_ARRAYS);
  11103. if (ssl->arrays->pendingMsg == NULL)
  11104. return MEMORY_E;
  11105. XMEMCPY(ssl->arrays->pendingMsg,
  11106. input + *inOutIdx - HANDSHAKE_HEADER_SZ,
  11107. inputLength);
  11108. ssl->arrays->pendingMsgOffset = inputLength;
  11109. *inOutIdx += inputLength + ssl->keys.padSz - HANDSHAKE_HEADER_SZ;
  11110. return 0;
  11111. }
  11112. ret = DoTls13HandShakeMsgType(ssl, input, inOutIdx, type, size,
  11113. totalSz);
  11114. }
  11115. else {
  11116. if (inputLength + ssl->arrays->pendingMsgOffset >
  11117. ssl->arrays->pendingMsgSz) {
  11118. inputLength = ssl->arrays->pendingMsgSz -
  11119. ssl->arrays->pendingMsgOffset;
  11120. }
  11121. ret = EarlySanityCheckMsgReceived(ssl, ssl->arrays->pendingMsgType,
  11122. inputLength);
  11123. if (ret != 0) {
  11124. WOLFSSL_ERROR(ret);
  11125. return ret;
  11126. }
  11127. XMEMCPY(ssl->arrays->pendingMsg + ssl->arrays->pendingMsgOffset,
  11128. input + *inOutIdx, inputLength);
  11129. ssl->arrays->pendingMsgOffset += inputLength;
  11130. *inOutIdx += inputLength + ssl->keys.padSz;
  11131. if (ssl->arrays->pendingMsgOffset == ssl->arrays->pendingMsgSz)
  11132. {
  11133. word32 idx = 0;
  11134. ret = DoTls13HandShakeMsgType(ssl,
  11135. ssl->arrays->pendingMsg + HANDSHAKE_HEADER_SZ,
  11136. &idx, ssl->arrays->pendingMsgType,
  11137. ssl->arrays->pendingMsgSz - HANDSHAKE_HEADER_SZ,
  11138. ssl->arrays->pendingMsgSz);
  11139. #ifdef WOLFSSL_ASYNC_CRYPT
  11140. if (ret == WC_PENDING_E) {
  11141. /* setup to process fragment again */
  11142. ssl->arrays->pendingMsgOffset -= inputLength;
  11143. *inOutIdx -= inputLength + ssl->keys.padSz;
  11144. }
  11145. else
  11146. #endif
  11147. {
  11148. XFREE(ssl->arrays->pendingMsg, ssl->heap, DYNAMIC_TYPE_ARRAYS);
  11149. ssl->arrays->pendingMsg = NULL;
  11150. ssl->arrays->pendingMsgSz = 0;
  11151. }
  11152. }
  11153. }
  11154. WOLFSSL_LEAVE("DoTls13HandShakeMsg", ret);
  11155. return ret;
  11156. }
  11157. #ifndef NO_WOLFSSL_CLIENT
  11158. /* The client connecting to the server.
  11159. * The protocol version is expecting to be TLS v1.3.
  11160. * If the server downgrades, and older versions of the protocol are compiled
  11161. * in, the client will fallback to wolfSSL_connect().
  11162. * Please see note at top of README if you get an error from connect.
  11163. *
  11164. * ssl The SSL/TLS object.
  11165. * returns WOLFSSL_SUCCESS on successful handshake, WOLFSSL_FATAL_ERROR when
  11166. * unrecoverable error occurs and 0 otherwise.
  11167. * For more error information use wolfSSL_get_error().
  11168. */
  11169. int wolfSSL_connect_TLSv13(WOLFSSL* ssl)
  11170. {
  11171. int advanceState;
  11172. int ret = 0;
  11173. WOLFSSL_ENTER("wolfSSL_connect_TLSv13");
  11174. #ifdef HAVE_ERRNO_H
  11175. errno = 0;
  11176. #endif
  11177. if (ssl == NULL)
  11178. return BAD_FUNC_ARG;
  11179. if (ssl->options.side != WOLFSSL_CLIENT_END) {
  11180. ssl->error = SIDE_ERROR;
  11181. WOLFSSL_ERROR(ssl->error);
  11182. return WOLFSSL_FATAL_ERROR;
  11183. }
  11184. /* make sure this wolfSSL object has arrays and rng setup. Protects
  11185. * case where the WOLFSSL object is re-used via wolfSSL_clear() */
  11186. if ((ret = ReinitSSL(ssl, ssl->ctx, 0)) != 0) {
  11187. return ret;
  11188. }
  11189. #ifdef WOLFSSL_DTLS
  11190. if (ssl->version.major == DTLS_MAJOR) {
  11191. ssl->options.dtls = 1;
  11192. ssl->options.dtlsStateful = 1;
  11193. }
  11194. #endif
  11195. #ifdef WOLFSSL_WOLFSENTRY_HOOKS
  11196. if ((ssl->ConnectFilter != NULL) &&
  11197. (ssl->options.connectState == CONNECT_BEGIN))
  11198. {
  11199. wolfSSL_netfilter_decision_t res;
  11200. if ((ssl->ConnectFilter(ssl, ssl->ConnectFilter_arg, &res) ==
  11201. WOLFSSL_SUCCESS) &&
  11202. (res == WOLFSSL_NETFILTER_REJECT)) {
  11203. ssl->error = SOCKET_FILTERED_E;
  11204. WOLFSSL_ERROR(ssl->error);
  11205. return WOLFSSL_FATAL_ERROR;
  11206. }
  11207. }
  11208. #endif /* WOLFSSL_WOLFSENTRY_HOOKS */
  11209. /* fragOffset is non-zero when sending fragments. On the last
  11210. * fragment, fragOffset is zero again, and the state can be
  11211. * advanced. Also, only advance from states in which we send data */
  11212. advanceState = (ssl->options.connectState == CONNECT_BEGIN ||
  11213. ssl->options.connectState == HELLO_AGAIN ||
  11214. (ssl->options.connectState >= FIRST_REPLY_DONE &&
  11215. ssl->options.connectState <= FIRST_REPLY_FOURTH));
  11216. #ifdef WOLFSSL_DTLS13
  11217. if (ssl->options.dtls)
  11218. advanceState = advanceState && !ssl->dtls13SendingFragments
  11219. && !ssl->dtls13SendingAckOrRtx;
  11220. #endif /* WOLFSSL_DTLS13 */
  11221. if (ssl->buffers.outputBuffer.length > 0
  11222. #ifdef WOLFSSL_ASYNC_CRYPT
  11223. /* do not send buffered or advance state if last error was an
  11224. async pending operation */
  11225. && ssl->error != WC_PENDING_E
  11226. #endif
  11227. ) {
  11228. if ((ret = SendBuffered(ssl)) == 0) {
  11229. if (ssl->fragOffset == 0 && !ssl->options.buildingMsg) {
  11230. if (advanceState) {
  11231. #ifdef WOLFSSL_DTLS13
  11232. if (ssl->options.dtls && IsAtLeastTLSv1_3(ssl->version) &&
  11233. ssl->options.connectState == FIRST_REPLY_FOURTH) {
  11234. /* WAIT_FINISHED_ACK is a state added afterwards, but it
  11235. can't follow FIRST_REPLY_FOURTH in the enum order. Indeed
  11236. the value of the enum ConnectState is stored in
  11237. serialized session. This would make importing serialized
  11238. session from other wolfSSL version incompatible */
  11239. ssl->options.connectState = WAIT_FINISHED_ACK;
  11240. }
  11241. else
  11242. #endif /* WOLFSSL_DTLS13 */
  11243. {
  11244. ssl->options.connectState++;
  11245. }
  11246. WOLFSSL_MSG("connect state: "
  11247. "Advanced from last buffered fragment send");
  11248. #ifdef WOLFSSL_ASYNC_IO
  11249. FreeAsyncCtx(ssl, 0);
  11250. #endif
  11251. }
  11252. }
  11253. else {
  11254. WOLFSSL_MSG("connect state: "
  11255. "Not advanced, more fragments to send");
  11256. }
  11257. #ifdef WOLFSSL_DTLS13
  11258. if (ssl->options.dtls)
  11259. ssl->dtls13SendingAckOrRtx = 0;
  11260. #endif /* WOLFSSL_DTLS13 */
  11261. }
  11262. else {
  11263. ssl->error = ret;
  11264. WOLFSSL_ERROR(ssl->error);
  11265. return WOLFSSL_FATAL_ERROR;
  11266. }
  11267. }
  11268. ret = RetrySendAlert(ssl);
  11269. if (ret != 0) {
  11270. ssl->error = ret;
  11271. WOLFSSL_ERROR(ssl->error);
  11272. return WOLFSSL_FATAL_ERROR;
  11273. }
  11274. #ifdef WOLFSSL_DTLS13
  11275. if (ssl->options.dtls && ssl->dtls13SendingFragments) {
  11276. if ((ssl->error = Dtls13FragmentsContinue(ssl)) != 0) {
  11277. WOLFSSL_ERROR(ssl->error);
  11278. return WOLFSSL_FATAL_ERROR;
  11279. }
  11280. /* we sent all the fragments. Advance state. */
  11281. ssl->options.connectState++;
  11282. }
  11283. #endif /* WOLFSSL_DTLS13 */
  11284. switch (ssl->options.connectState) {
  11285. case CONNECT_BEGIN:
  11286. /* Always send client hello first. */
  11287. if ((ssl->error = SendTls13ClientHello(ssl)) != 0) {
  11288. WOLFSSL_ERROR(ssl->error);
  11289. return WOLFSSL_FATAL_ERROR;
  11290. }
  11291. ssl->options.connectState = CLIENT_HELLO_SENT;
  11292. WOLFSSL_MSG("TLSv13 connect state: CLIENT_HELLO_SENT");
  11293. #ifdef WOLFSSL_EARLY_DATA
  11294. if (ssl->earlyData != no_early_data) {
  11295. #if defined(WOLFSSL_TLS13_MIDDLEBOX_COMPAT)
  11296. if (!ssl->options.dtls && ssl->options.tls13MiddleBoxCompat) {
  11297. if ((ssl->error = SendChangeCipher(ssl)) != 0) {
  11298. WOLFSSL_ERROR(ssl->error);
  11299. return WOLFSSL_FATAL_ERROR;
  11300. }
  11301. ssl->options.sentChangeCipher = 1;
  11302. }
  11303. #endif
  11304. ssl->options.handShakeState = CLIENT_HELLO_COMPLETE;
  11305. return WOLFSSL_SUCCESS;
  11306. }
  11307. #endif
  11308. FALL_THROUGH;
  11309. case CLIENT_HELLO_SENT:
  11310. /* Get the response/s from the server. */
  11311. while (ssl->options.serverState <
  11312. SERVER_HELLOVERIFYREQUEST_COMPLETE) {
  11313. if ((ssl->error = ProcessReply(ssl)) < 0) {
  11314. WOLFSSL_ERROR(ssl->error);
  11315. return WOLFSSL_FATAL_ERROR;
  11316. }
  11317. #ifdef WOLFSSL_DTLS13
  11318. if (ssl->options.dtls) {
  11319. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  11320. WOLFSSL_ERROR(ssl->error);
  11321. return WOLFSSL_FATAL_ERROR;
  11322. }
  11323. }
  11324. #endif /* WOLFSSL_DTLS13 */
  11325. }
  11326. if (!ssl->options.tls1_3) {
  11327. #ifndef WOLFSSL_NO_TLS12
  11328. if (ssl->options.downgrade)
  11329. return wolfSSL_connect(ssl);
  11330. #endif
  11331. WOLFSSL_MSG("Client using higher version, fatal error");
  11332. WOLFSSL_ERROR_VERBOSE(VERSION_ERROR);
  11333. return VERSION_ERROR;
  11334. }
  11335. ssl->options.connectState = HELLO_AGAIN;
  11336. WOLFSSL_MSG("connect state: HELLO_AGAIN");
  11337. FALL_THROUGH;
  11338. case HELLO_AGAIN:
  11339. if (ssl->options.serverState ==
  11340. SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  11341. #if defined(WOLFSSL_TLS13_MIDDLEBOX_COMPAT)
  11342. if (!ssl->options.dtls && !ssl->options.sentChangeCipher
  11343. && ssl->options.tls13MiddleBoxCompat) {
  11344. if ((ssl->error = SendChangeCipher(ssl)) != 0) {
  11345. WOLFSSL_ERROR(ssl->error);
  11346. return WOLFSSL_FATAL_ERROR;
  11347. }
  11348. ssl->options.sentChangeCipher = 1;
  11349. }
  11350. #endif
  11351. /* Try again with different security parameters. */
  11352. if ((ssl->error = SendTls13ClientHello(ssl)) != 0) {
  11353. WOLFSSL_ERROR(ssl->error);
  11354. return WOLFSSL_FATAL_ERROR;
  11355. }
  11356. }
  11357. ssl->options.connectState = HELLO_AGAIN_REPLY;
  11358. WOLFSSL_MSG("connect state: HELLO_AGAIN_REPLY");
  11359. FALL_THROUGH;
  11360. case HELLO_AGAIN_REPLY:
  11361. /* Get the response/s from the server. */
  11362. while (ssl->options.serverState < SERVER_FINISHED_COMPLETE) {
  11363. if ((ssl->error = ProcessReply(ssl)) < 0) {
  11364. WOLFSSL_ERROR(ssl->error);
  11365. return WOLFSSL_FATAL_ERROR;
  11366. }
  11367. #ifdef WOLFSSL_DTLS13
  11368. if (ssl->options.dtls) {
  11369. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  11370. WOLFSSL_ERROR(ssl->error);
  11371. return WOLFSSL_FATAL_ERROR;
  11372. }
  11373. }
  11374. #endif /* WOLFSSL_DTLS13 */
  11375. }
  11376. ssl->options.connectState = FIRST_REPLY_DONE;
  11377. WOLFSSL_MSG("connect state: FIRST_REPLY_DONE");
  11378. FALL_THROUGH;
  11379. case FIRST_REPLY_DONE:
  11380. if (ssl->options.certOnly)
  11381. return WOLFSSL_SUCCESS;
  11382. #ifdef WOLFSSL_EARLY_DATA
  11383. if (!ssl->options.dtls && ssl->earlyData != no_early_data
  11384. && !WOLFSSL_IS_QUIC(ssl)) {
  11385. if ((ssl->error = SendTls13EndOfEarlyData(ssl)) != 0) {
  11386. WOLFSSL_ERROR(ssl->error);
  11387. return WOLFSSL_FATAL_ERROR;
  11388. }
  11389. WOLFSSL_MSG("sent: end_of_early_data");
  11390. }
  11391. #endif
  11392. ssl->options.connectState = FIRST_REPLY_FIRST;
  11393. WOLFSSL_MSG("connect state: FIRST_REPLY_FIRST");
  11394. FALL_THROUGH;
  11395. case FIRST_REPLY_FIRST:
  11396. #if defined(WOLFSSL_TLS13_MIDDLEBOX_COMPAT)
  11397. if (!ssl->options.sentChangeCipher && !ssl->options.dtls
  11398. && ssl->options.tls13MiddleBoxCompat) {
  11399. if ((ssl->error = SendChangeCipher(ssl)) != 0) {
  11400. WOLFSSL_ERROR(ssl->error);
  11401. return WOLFSSL_FATAL_ERROR;
  11402. }
  11403. ssl->options.sentChangeCipher = 1;
  11404. }
  11405. #endif
  11406. ssl->options.connectState = FIRST_REPLY_SECOND;
  11407. WOLFSSL_MSG("connect state: FIRST_REPLY_SECOND");
  11408. FALL_THROUGH;
  11409. case FIRST_REPLY_SECOND:
  11410. /* CLIENT: check peer authentication. */
  11411. if (!ssl->options.peerAuthGood) {
  11412. WOLFSSL_MSG("Server authentication did not happen");
  11413. WOLFSSL_ERROR_VERBOSE(WOLFSSL_FATAL_ERROR);
  11414. return WOLFSSL_FATAL_ERROR;
  11415. }
  11416. #ifndef NO_CERTS
  11417. if (!ssl->options.resuming && ssl->options.sendVerify) {
  11418. ssl->error = SendTls13Certificate(ssl);
  11419. if (ssl->error != 0) {
  11420. #ifdef WOLFSSL_CHECK_ALERT_ON_ERR
  11421. ProcessReplyEx(ssl, 1); /* See if an alert was sent. */
  11422. #endif
  11423. WOLFSSL_ERROR(ssl->error);
  11424. return WOLFSSL_FATAL_ERROR;
  11425. }
  11426. WOLFSSL_MSG("sent: certificate");
  11427. }
  11428. #endif
  11429. ssl->options.connectState = FIRST_REPLY_THIRD;
  11430. WOLFSSL_MSG("connect state: FIRST_REPLY_THIRD");
  11431. FALL_THROUGH;
  11432. case FIRST_REPLY_THIRD:
  11433. #if (!defined(NO_CERTS) && (!defined(NO_RSA) || defined(HAVE_ECC) || \
  11434. defined(HAVE_ED25519) || defined(HAVE_ED448) || \
  11435. defined(HAVE_PQC))) && (!defined(NO_WOLFSSL_SERVER) || \
  11436. !defined(WOLFSSL_NO_CLIENT_AUTH))
  11437. if (!ssl->options.resuming && ssl->options.sendVerify) {
  11438. ssl->error = SendTls13CertificateVerify(ssl);
  11439. if (ssl->error != 0) {
  11440. #ifdef WOLFSSL_CHECK_ALERT_ON_ERR
  11441. ProcessReplyEx(ssl, 1); /* See if an alert was sent. */
  11442. #endif
  11443. WOLFSSL_ERROR(ssl->error);
  11444. return WOLFSSL_FATAL_ERROR;
  11445. }
  11446. WOLFSSL_MSG("sent: certificate verify");
  11447. }
  11448. #endif
  11449. ssl->options.connectState = FIRST_REPLY_FOURTH;
  11450. WOLFSSL_MSG("connect state: FIRST_REPLY_FOURTH");
  11451. FALL_THROUGH;
  11452. case FIRST_REPLY_FOURTH:
  11453. if ((ssl->error = SendTls13Finished(ssl)) != 0) {
  11454. #ifdef WOLFSSL_CHECK_ALERT_ON_ERR
  11455. ProcessReplyEx(ssl, 1); /* See if an alert was sent. */
  11456. #endif
  11457. WOLFSSL_ERROR(ssl->error);
  11458. return WOLFSSL_FATAL_ERROR;
  11459. }
  11460. WOLFSSL_MSG("sent: finished");
  11461. #ifdef WOLFSSL_DTLS13
  11462. ssl->options.connectState = WAIT_FINISHED_ACK;
  11463. WOLFSSL_MSG("connect state: WAIT_FINISHED_ACK");
  11464. FALL_THROUGH;
  11465. case WAIT_FINISHED_ACK:
  11466. if (ssl->options.dtls) {
  11467. while (ssl->options.serverState != SERVER_FINISHED_ACKED) {
  11468. if ((ssl->error = ProcessReply(ssl)) < 0) {
  11469. WOLFSSL_ERROR(ssl->error);
  11470. return WOLFSSL_FATAL_ERROR;
  11471. }
  11472. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  11473. WOLFSSL_ERROR(ssl->error);
  11474. return WOLFSSL_FATAL_ERROR;
  11475. }
  11476. }
  11477. }
  11478. #endif /* WOLFSSL_DTLS13 */
  11479. ssl->options.connectState = FINISHED_DONE;
  11480. WOLFSSL_MSG("connect state: FINISHED_DONE");
  11481. FALL_THROUGH;
  11482. case FINISHED_DONE:
  11483. #ifndef NO_HANDSHAKE_DONE_CB
  11484. if (ssl->hsDoneCb != NULL) {
  11485. int cbret = ssl->hsDoneCb(ssl, ssl->hsDoneCtx);
  11486. if (cbret < 0) {
  11487. ssl->error = cbret;
  11488. WOLFSSL_ERROR_VERBOSE(ssl->error);
  11489. WOLFSSL_MSG("HandShake Done Cb don't continue error");
  11490. return WOLFSSL_FATAL_ERROR;
  11491. }
  11492. }
  11493. #endif /* NO_HANDSHAKE_DONE_CB */
  11494. if (!ssl->options.keepResources) {
  11495. FreeHandshakeResources(ssl);
  11496. }
  11497. #if defined(WOLFSSL_ASYNC_IO) && !defined(WOLFSSL_ASYNC_CRYPT)
  11498. /* Free the remaining async context if not using it for crypto */
  11499. FreeAsyncCtx(ssl, 1);
  11500. #endif
  11501. ssl->error = 0; /* clear the error */
  11502. WOLFSSL_LEAVE("wolfSSL_connect_TLSv13", WOLFSSL_SUCCESS);
  11503. return WOLFSSL_SUCCESS;
  11504. default:
  11505. WOLFSSL_MSG("Unknown connect state ERROR");
  11506. return WOLFSSL_FATAL_ERROR; /* unknown connect state */
  11507. }
  11508. }
  11509. #endif
  11510. #if defined(WOLFSSL_SEND_HRR_COOKIE)
  11511. /* Send a cookie with the HelloRetryRequest to avoid storing state.
  11512. *
  11513. * ssl SSL/TLS object.
  11514. * secret Secret to use when generating integrity check for cookie.
  11515. * A value of NULL indicates to generate a new random secret.
  11516. * secretSz Size of secret data in bytes.
  11517. * Use a value of 0 to indicate use of default size.
  11518. * returns BAD_FUNC_ARG when ssl is NULL or not using TLS v1.3, SIDE_ERROR when
  11519. * called on a client; WOLFSSL_SUCCESS on success and otherwise failure.
  11520. */
  11521. int wolfSSL_send_hrr_cookie(WOLFSSL* ssl, const unsigned char* secret,
  11522. unsigned int secretSz)
  11523. {
  11524. int ret;
  11525. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11526. return BAD_FUNC_ARG;
  11527. #ifndef NO_WOLFSSL_SERVER
  11528. if (ssl->options.side == WOLFSSL_CLIENT_END)
  11529. return SIDE_ERROR;
  11530. if (secretSz == 0) {
  11531. #if !defined(NO_SHA) && defined(NO_SHA256)
  11532. secretSz = WC_SHA_DIGEST_SIZE;
  11533. #endif /* NO_SHA */
  11534. #ifndef NO_SHA256
  11535. secretSz = WC_SHA256_DIGEST_SIZE;
  11536. #endif /* NO_SHA256 */
  11537. }
  11538. if (secretSz != ssl->buffers.tls13CookieSecret.length) {
  11539. byte* newSecret;
  11540. if (ssl->buffers.tls13CookieSecret.buffer != NULL) {
  11541. ForceZero(ssl->buffers.tls13CookieSecret.buffer,
  11542. ssl->buffers.tls13CookieSecret.length);
  11543. XFREE(ssl->buffers.tls13CookieSecret.buffer,
  11544. ssl->heap, DYNAMIC_TYPE_COOKIE_PWD);
  11545. }
  11546. newSecret = (byte*)XMALLOC(secretSz, ssl->heap,
  11547. DYNAMIC_TYPE_COOKIE_PWD);
  11548. if (newSecret == NULL) {
  11549. ssl->buffers.tls13CookieSecret.buffer = NULL;
  11550. ssl->buffers.tls13CookieSecret.length = 0;
  11551. WOLFSSL_MSG("couldn't allocate new cookie secret");
  11552. return MEMORY_ERROR;
  11553. }
  11554. ssl->buffers.tls13CookieSecret.buffer = newSecret;
  11555. ssl->buffers.tls13CookieSecret.length = secretSz;
  11556. #ifdef WOLFSSL_CHECK_MEM_ZERO
  11557. wc_MemZero_Add("wolfSSL_send_hrr_cookie secret",
  11558. ssl->buffers.tls13CookieSecret.buffer,
  11559. ssl->buffers.tls13CookieSecret.length);
  11560. #endif
  11561. }
  11562. /* If the supplied secret is NULL, randomly generate a new secret. */
  11563. if (secret == NULL) {
  11564. ret = wc_RNG_GenerateBlock(ssl->rng,
  11565. ssl->buffers.tls13CookieSecret.buffer, secretSz);
  11566. if (ret < 0)
  11567. return ret;
  11568. }
  11569. else
  11570. XMEMCPY(ssl->buffers.tls13CookieSecret.buffer, secret, secretSz);
  11571. ssl->options.sendCookie = 1;
  11572. ret = WOLFSSL_SUCCESS;
  11573. #else
  11574. (void)secret;
  11575. (void)secretSz;
  11576. ret = SIDE_ERROR;
  11577. #endif
  11578. return ret;
  11579. }
  11580. int wolfSSL_disable_hrr_cookie(WOLFSSL* ssl)
  11581. {
  11582. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11583. return BAD_FUNC_ARG;
  11584. #ifdef NO_WOLFSSL_SERVER
  11585. return SIDE_ERROR;
  11586. #else
  11587. if (ssl->options.side == WOLFSSL_CLIENT_END)
  11588. return SIDE_ERROR;
  11589. if (ssl->buffers.tls13CookieSecret.buffer != NULL) {
  11590. ForceZero(ssl->buffers.tls13CookieSecret.buffer,
  11591. ssl->buffers.tls13CookieSecret.length);
  11592. XFREE(ssl->buffers.tls13CookieSecret.buffer, ssl->heap,
  11593. DYNAMIC_TYPE_COOKIE_PWD);
  11594. ssl->buffers.tls13CookieSecret.buffer = NULL;
  11595. ssl->buffers.tls13CookieSecret.length = 0;
  11596. }
  11597. ssl->options.sendCookie = 0;
  11598. return WOLFSSL_SUCCESS;
  11599. #endif /* NO_WOLFSSL_SERVER */
  11600. }
  11601. #endif /* defined(WOLFSSL_SEND_HRR_COOKIE) */
  11602. #ifdef HAVE_SUPPORTED_CURVES
  11603. /* Create a key share entry from group.
  11604. * Generates a key pair.
  11605. *
  11606. * ssl The SSL/TLS object.
  11607. * group The named group.
  11608. * returns 0 on success, otherwise failure.
  11609. * for async can return WC_PENDING_E and should be called again
  11610. */
  11611. int wolfSSL_UseKeyShare(WOLFSSL* ssl, word16 group)
  11612. {
  11613. int ret;
  11614. if (ssl == NULL)
  11615. return BAD_FUNC_ARG;
  11616. #ifdef WOLFSSL_ASYNC_CRYPT
  11617. ret = wolfSSL_AsyncPop(ssl, NULL);
  11618. if (ret != WC_NO_PENDING_E) {
  11619. /* Check for error */
  11620. if (ret < 0)
  11621. return ret;
  11622. }
  11623. #endif
  11624. #ifdef HAVE_PQC
  11625. if (WOLFSSL_NAMED_GROUP_IS_PQC(group)) {
  11626. if (ssl->ctx != NULL && ssl->ctx->method != NULL &&
  11627. !IsAtLeastTLSv1_3(ssl->version)) {
  11628. return BAD_FUNC_ARG;
  11629. }
  11630. if (ssl->options.side == WOLFSSL_SERVER_END) {
  11631. /* If I am the server of a KEM connection, do not do keygen because I'm
  11632. * going to encapsulate with the client's public key. Note that I might
  11633. * be the client and ssl->option.side has not been properly set yet. In
  11634. * that case the KeyGen operation will be deferred to connection time. */
  11635. return WOLFSSL_SUCCESS;
  11636. }
  11637. }
  11638. #endif
  11639. #if defined(NO_TLS)
  11640. (void)ret;
  11641. (void)group;
  11642. #else
  11643. ret = TLSX_KeyShare_Use(ssl, group, 0, NULL, NULL, &ssl->extensions);
  11644. if (ret != 0)
  11645. return ret;
  11646. #endif /* NO_TLS */
  11647. return WOLFSSL_SUCCESS;
  11648. }
  11649. /* Send no key share entries - use HelloRetryRequest to negotiate shared group.
  11650. *
  11651. * ssl The SSL/TLS object.
  11652. * returns 0 on success, otherwise failure.
  11653. */
  11654. int wolfSSL_NoKeyShares(WOLFSSL* ssl)
  11655. {
  11656. int ret;
  11657. if (ssl == NULL)
  11658. return BAD_FUNC_ARG;
  11659. if (ssl->options.side == WOLFSSL_SERVER_END)
  11660. return SIDE_ERROR;
  11661. #if defined(NO_TLS)
  11662. (void)ret;
  11663. #else
  11664. ret = TLSX_KeyShare_Empty(ssl);
  11665. if (ret != 0)
  11666. return ret;
  11667. #endif /* NO_TLS */
  11668. return WOLFSSL_SUCCESS;
  11669. }
  11670. #endif
  11671. #ifdef WOLFSSL_DUAL_ALG_CERTS
  11672. int wolfSSL_UseCKS(WOLFSSL* ssl, byte *sigSpec, word16 sigSpecSz)
  11673. {
  11674. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->ctx->method->version) ||
  11675. sigSpec == NULL || sigSpecSz == 0)
  11676. return BAD_FUNC_ARG;
  11677. ssl->sigSpec = sigSpec;
  11678. ssl->sigSpecSz = sigSpecSz;
  11679. return WOLFSSL_SUCCESS;
  11680. }
  11681. int wolfSSL_CTX_UseCKS(WOLFSSL_CTX* ctx, byte *sigSpec, word16 sigSpecSz)
  11682. {
  11683. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version) ||
  11684. sigSpec == NULL || sigSpecSz == 0)
  11685. return BAD_FUNC_ARG;
  11686. ctx->sigSpec = sigSpec;
  11687. ctx->sigSpecSz = sigSpecSz;
  11688. return WOLFSSL_SUCCESS;
  11689. }
  11690. #endif /* WOLFSSL_DUAL_ALG_CERTS */
  11691. /* Do not send a ticket after TLS v1.3 handshake for resumption.
  11692. *
  11693. * ctx The SSL/TLS CTX object.
  11694. * returns BAD_FUNC_ARG when ctx is NULL and 0 on success.
  11695. */
  11696. int wolfSSL_CTX_no_ticket_TLSv13(WOLFSSL_CTX* ctx)
  11697. {
  11698. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  11699. return BAD_FUNC_ARG;
  11700. if (ctx->method->side == WOLFSSL_CLIENT_END)
  11701. return SIDE_ERROR;
  11702. #ifdef HAVE_SESSION_TICKET
  11703. ctx->noTicketTls13 = 1;
  11704. #endif
  11705. return 0;
  11706. }
  11707. /* Do not send a ticket after TLS v1.3 handshake for resumption.
  11708. *
  11709. * ssl The SSL/TLS object.
  11710. * returns BAD_FUNC_ARG when ssl is NULL, not using TLS v1.3, or called on
  11711. * a client and 0 on success.
  11712. */
  11713. int wolfSSL_no_ticket_TLSv13(WOLFSSL* ssl)
  11714. {
  11715. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11716. return BAD_FUNC_ARG;
  11717. if (ssl->options.side == WOLFSSL_CLIENT_END)
  11718. return SIDE_ERROR;
  11719. #ifdef HAVE_SESSION_TICKET
  11720. ssl->options.noTicketTls13 = 1;
  11721. #endif
  11722. return 0;
  11723. }
  11724. /* Disallow (EC)DHE key exchange when using pre-shared keys.
  11725. *
  11726. * ctx The SSL/TLS CTX object.
  11727. * returns BAD_FUNC_ARG when ctx is NULL and 0 on success.
  11728. */
  11729. int wolfSSL_CTX_no_dhe_psk(WOLFSSL_CTX* ctx)
  11730. {
  11731. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  11732. return BAD_FUNC_ARG;
  11733. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  11734. ctx->noPskDheKe = 1;
  11735. #endif
  11736. return 0;
  11737. }
  11738. /* Disallow (EC)DHE key exchange when using pre-shared keys.
  11739. *
  11740. * ssl The SSL/TLS object.
  11741. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3 and 0 on
  11742. * success.
  11743. */
  11744. int wolfSSL_no_dhe_psk(WOLFSSL* ssl)
  11745. {
  11746. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11747. return BAD_FUNC_ARG;
  11748. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  11749. ssl->options.noPskDheKe = 1;
  11750. #endif
  11751. return 0;
  11752. }
  11753. #ifdef HAVE_SUPPORTED_CURVES
  11754. /* Only allow (EC)DHE key exchange when using pre-shared keys.
  11755. *
  11756. * ctx The SSL/TLS CTX object.
  11757. * returns BAD_FUNC_ARG when ctx is NULL and 0 on success.
  11758. */
  11759. int wolfSSL_CTX_only_dhe_psk(WOLFSSL_CTX* ctx)
  11760. {
  11761. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  11762. return BAD_FUNC_ARG;
  11763. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  11764. ctx->onlyPskDheKe = 1;
  11765. #endif
  11766. return 0;
  11767. }
  11768. /* Only allow (EC)DHE key exchange when using pre-shared keys.
  11769. *
  11770. * ssl The SSL/TLS object.
  11771. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3 and 0 on
  11772. * success.
  11773. */
  11774. int wolfSSL_only_dhe_psk(WOLFSSL* ssl)
  11775. {
  11776. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11777. return BAD_FUNC_ARG;
  11778. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  11779. ssl->options.onlyPskDheKe = 1;
  11780. #endif
  11781. return 0;
  11782. }
  11783. #endif /* HAVE_SUPPORTED_CURVES */
  11784. int Tls13UpdateKeys(WOLFSSL* ssl)
  11785. {
  11786. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11787. return BAD_FUNC_ARG;
  11788. #ifdef WOLFSSL_DTLS13
  11789. /* we are already waiting for the ack of a sent key update message. We can't
  11790. send another one before receiving its ack. Either wolfSSL_update_keys()
  11791. was invoked multiple times over a short period of time or we replied to a
  11792. KeyUpdate with update request. We'll just ignore sending this
  11793. KeyUpdate. */
  11794. /* TODO: add WOLFSSL_ERROR_ALREADY_IN_PROGRESS type of error here */
  11795. if (ssl->options.dtls && ssl->dtls13WaitKeyUpdateAck)
  11796. return 0;
  11797. #endif /* WOLFSSL_DTLS13 */
  11798. return SendTls13KeyUpdate(ssl);
  11799. }
  11800. /* Update the keys for encryption and decryption.
  11801. * If using non-blocking I/O and WOLFSSL_ERROR_WANT_WRITE is returned then
  11802. * calling wolfSSL_write() will have the message sent when ready.
  11803. *
  11804. * ssl The SSL/TLS object.
  11805. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3,
  11806. * WOLFSSL_ERROR_WANT_WRITE when non-blocking I/O is not ready to write,
  11807. * WOLFSSL_SUCCESS on success and otherwise failure.
  11808. */
  11809. int wolfSSL_update_keys(WOLFSSL* ssl)
  11810. {
  11811. int ret;
  11812. ret = Tls13UpdateKeys(ssl);
  11813. if (ret == WANT_WRITE)
  11814. ret = WOLFSSL_ERROR_WANT_WRITE;
  11815. else if (ret == 0)
  11816. ret = WOLFSSL_SUCCESS;
  11817. return ret;
  11818. }
  11819. /* Whether a response is waiting for key update request.
  11820. *
  11821. * ssl The SSL/TLS object.
  11822. * required 0 when no key update response required.
  11823. * 1 when no key update response required.
  11824. * return 0 on success.
  11825. * return BAD_FUNC_ARG when ssl is NULL or not using TLS v1.3
  11826. */
  11827. int wolfSSL_key_update_response(WOLFSSL* ssl, int* required)
  11828. {
  11829. if (required == NULL || ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11830. return BAD_FUNC_ARG;
  11831. *required = ssl->keys.updateResponseReq;
  11832. return 0;
  11833. }
  11834. #if !defined(NO_CERTS) && defined(WOLFSSL_POST_HANDSHAKE_AUTH)
  11835. /* Allow post-handshake authentication in TLS v1.3 connections.
  11836. *
  11837. * ctx The SSL/TLS CTX object.
  11838. * returns BAD_FUNC_ARG when ctx is NULL, SIDE_ERROR when not a client and
  11839. * 0 on success.
  11840. */
  11841. int wolfSSL_CTX_allow_post_handshake_auth(WOLFSSL_CTX* ctx)
  11842. {
  11843. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  11844. return BAD_FUNC_ARG;
  11845. if (ctx->method->side == WOLFSSL_SERVER_END)
  11846. return SIDE_ERROR;
  11847. ctx->postHandshakeAuth = 1;
  11848. return 0;
  11849. }
  11850. /* Allow post-handshake authentication in TLS v1.3 connection.
  11851. *
  11852. * ssl The SSL/TLS object.
  11853. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3,
  11854. * SIDE_ERROR when not a client and 0 on success.
  11855. */
  11856. int wolfSSL_allow_post_handshake_auth(WOLFSSL* ssl)
  11857. {
  11858. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11859. return BAD_FUNC_ARG;
  11860. if (ssl->options.side == WOLFSSL_SERVER_END)
  11861. return SIDE_ERROR;
  11862. ssl->options.postHandshakeAuth = 1;
  11863. return 0;
  11864. }
  11865. /* Request a certificate of the client.
  11866. * Can be called any time after handshake completion.
  11867. * A maximum of 256 requests can be sent on a connection.
  11868. *
  11869. * ssl SSL/TLS object.
  11870. */
  11871. int wolfSSL_request_certificate(WOLFSSL* ssl)
  11872. {
  11873. int ret;
  11874. #ifndef NO_WOLFSSL_SERVER
  11875. CertReqCtx* certReqCtx;
  11876. #endif
  11877. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11878. return BAD_FUNC_ARG;
  11879. #ifndef NO_WOLFSSL_SERVER
  11880. if (ssl->options.side == WOLFSSL_CLIENT_END)
  11881. return SIDE_ERROR;
  11882. if (ssl->options.handShakeState != HANDSHAKE_DONE)
  11883. return NOT_READY_ERROR;
  11884. if (!ssl->options.postHandshakeAuth)
  11885. return POST_HAND_AUTH_ERROR;
  11886. certReqCtx = (CertReqCtx*)XMALLOC(sizeof(CertReqCtx), ssl->heap,
  11887. DYNAMIC_TYPE_TMP_BUFFER);
  11888. if (certReqCtx == NULL)
  11889. return MEMORY_E;
  11890. XMEMSET(certReqCtx, 0, sizeof(CertReqCtx));
  11891. certReqCtx->next = ssl->certReqCtx;
  11892. certReqCtx->len = 1;
  11893. if (certReqCtx->next != NULL)
  11894. certReqCtx->ctx = certReqCtx->next->ctx + 1;
  11895. ssl->certReqCtx = certReqCtx;
  11896. ssl->msgsReceived.got_certificate = 0;
  11897. ssl->msgsReceived.got_certificate_verify = 0;
  11898. ssl->msgsReceived.got_finished = 0;
  11899. ret = SendTls13CertificateRequest(ssl, &certReqCtx->ctx, certReqCtx->len);
  11900. if (ret == WANT_WRITE)
  11901. ret = WOLFSSL_ERROR_WANT_WRITE;
  11902. else if (ret == 0)
  11903. ret = WOLFSSL_SUCCESS;
  11904. #else
  11905. ret = SIDE_ERROR;
  11906. #endif
  11907. return ret;
  11908. }
  11909. #endif /* !NO_CERTS && WOLFSSL_POST_HANDSHAKE_AUTH */
  11910. #if !defined(WOLFSSL_NO_SERVER_GROUPS_EXT)
  11911. /* Get the preferred key exchange group.
  11912. *
  11913. * ssl The SSL/TLS object.
  11914. * returns BAD_FUNC_ARG when ssl is NULL or not using TLS v1.3,
  11915. * SIDE_ERROR when not a client, NOT_READY_ERROR when handshake not complete
  11916. * and group number on success.
  11917. */
  11918. int wolfSSL_preferred_group(WOLFSSL* ssl)
  11919. {
  11920. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  11921. return BAD_FUNC_ARG;
  11922. #ifndef NO_WOLFSSL_CLIENT
  11923. if (ssl->options.side == WOLFSSL_SERVER_END)
  11924. return SIDE_ERROR;
  11925. if (ssl->options.handShakeState != HANDSHAKE_DONE)
  11926. return NOT_READY_ERROR;
  11927. #ifdef HAVE_SUPPORTED_CURVES
  11928. /* Return supported groups only. */
  11929. return TLSX_SupportedCurve_Preferred(ssl, 1);
  11930. #else
  11931. return 0;
  11932. #endif
  11933. #else
  11934. return SIDE_ERROR;
  11935. #endif
  11936. }
  11937. #endif
  11938. #if defined(HAVE_SUPPORTED_CURVES)
  11939. /* Sets the key exchange groups in rank order on a context.
  11940. *
  11941. * ctx SSL/TLS context object.
  11942. * groups Array of groups.
  11943. * count Number of groups in array.
  11944. * returns BAD_FUNC_ARG when ctx or groups is NULL, not using TLS v1.3 or
  11945. * count is greater than WOLFSSL_MAX_GROUP_COUNT and WOLFSSL_SUCCESS on success.
  11946. */
  11947. int wolfSSL_CTX_set_groups(WOLFSSL_CTX* ctx, int* groups, int count)
  11948. {
  11949. int ret, i;
  11950. WOLFSSL_ENTER("wolfSSL_CTX_set_groups");
  11951. if (ctx == NULL || groups == NULL || count > WOLFSSL_MAX_GROUP_COUNT)
  11952. return BAD_FUNC_ARG;
  11953. if (!IsAtLeastTLSv1_3(ctx->method->version))
  11954. return BAD_FUNC_ARG;
  11955. ctx->numGroups = 0;
  11956. #if !defined(NO_TLS)
  11957. TLSX_Remove(&ctx->extensions, TLSX_SUPPORTED_GROUPS, ctx->heap);
  11958. #endif /* !NO_TLS */
  11959. for (i = 0; i < count; i++) {
  11960. /* Call to wolfSSL_CTX_UseSupportedCurve also checks if input groups
  11961. * are valid */
  11962. if ((ret = wolfSSL_CTX_UseSupportedCurve(ctx, (word16)groups[i]))
  11963. != WOLFSSL_SUCCESS) {
  11964. #if !defined(NO_TLS)
  11965. TLSX_Remove(&ctx->extensions, TLSX_SUPPORTED_GROUPS, ctx->heap);
  11966. #endif /* !NO_TLS */
  11967. return ret;
  11968. }
  11969. ctx->group[i] = (word16)groups[i];
  11970. }
  11971. ctx->numGroups = (byte)count;
  11972. return WOLFSSL_SUCCESS;
  11973. }
  11974. /* Sets the key exchange groups in rank order.
  11975. *
  11976. * ssl SSL/TLS object.
  11977. * groups Array of groups.
  11978. * count Number of groups in array.
  11979. * returns BAD_FUNC_ARG when ssl or groups is NULL, not using TLS v1.3 or
  11980. * count is greater than WOLFSSL_MAX_GROUP_COUNT and WOLFSSL_SUCCESS on success.
  11981. */
  11982. int wolfSSL_set_groups(WOLFSSL* ssl, int* groups, int count)
  11983. {
  11984. int ret, i;
  11985. WOLFSSL_ENTER("wolfSSL_set_groups");
  11986. if (ssl == NULL || groups == NULL || count > WOLFSSL_MAX_GROUP_COUNT)
  11987. return BAD_FUNC_ARG;
  11988. if (!IsAtLeastTLSv1_3(ssl->version))
  11989. return BAD_FUNC_ARG;
  11990. ssl->numGroups = 0;
  11991. #if !defined(NO_TLS)
  11992. TLSX_Remove(&ssl->extensions, TLSX_SUPPORTED_GROUPS, ssl->heap);
  11993. #endif /* !NO_TLS */
  11994. for (i = 0; i < count; i++) {
  11995. /* Call to wolfSSL_UseSupportedCurve also checks if input groups
  11996. * are valid */
  11997. if ((ret = wolfSSL_UseSupportedCurve(ssl, (word16)groups[i]))
  11998. != WOLFSSL_SUCCESS) {
  11999. #if !defined(NO_TLS)
  12000. TLSX_Remove(&ssl->extensions, TLSX_SUPPORTED_GROUPS, ssl->heap);
  12001. #endif /* !NO_TLS */
  12002. return ret;
  12003. }
  12004. ssl->group[i] = (word16)groups[i];
  12005. }
  12006. ssl->numGroups = (byte)count;
  12007. return WOLFSSL_SUCCESS;
  12008. }
  12009. #endif /* HAVE_SUPPORTED_CURVES */
  12010. #ifndef NO_PSK
  12011. /* Set the PSK callback, that is passed the cipher suite, for a client to use
  12012. * against context object.
  12013. *
  12014. * @param [in, out] ctx SSL/TLS context object.
  12015. * @param [in] cb Client PSK callback passed a cipher suite.
  12016. */
  12017. void wolfSSL_CTX_set_psk_client_cs_callback(WOLFSSL_CTX* ctx,
  12018. wc_psk_client_cs_callback cb)
  12019. {
  12020. WOLFSSL_ENTER("wolfSSL_CTX_set_psk_client_cs_callback");
  12021. if (ctx == NULL)
  12022. return;
  12023. ctx->havePSK = 1;
  12024. ctx->client_psk_cs_cb = cb;
  12025. }
  12026. /* Set the PSK callback, that is passed the cipher suite, for a client to use
  12027. * against SSL object.
  12028. *
  12029. * @param [in, out] ssl SSL/TLS object.
  12030. * @param [in] cb Client PSK callback passed a cipher suite.
  12031. */
  12032. void wolfSSL_set_psk_client_cs_callback(WOLFSSL* ssl,
  12033. wc_psk_client_cs_callback cb)
  12034. {
  12035. byte haveRSA = 1;
  12036. int keySz = 0;
  12037. WOLFSSL_ENTER("wolfSSL_set_psk_client_cs_callback");
  12038. if (ssl == NULL)
  12039. return;
  12040. ssl->options.havePSK = 1;
  12041. ssl->options.client_psk_cs_cb = cb;
  12042. #ifdef NO_RSA
  12043. haveRSA = 0;
  12044. #endif
  12045. #ifndef NO_CERTS
  12046. keySz = ssl->buffers.keySz;
  12047. #endif
  12048. if (AllocateSuites(ssl) != 0)
  12049. return;
  12050. InitSuites(ssl->suites, ssl->version, keySz, haveRSA, TRUE,
  12051. ssl->options.haveDH, ssl->options.haveECDSAsig,
  12052. ssl->options.haveECC, TRUE, ssl->options.haveStaticECC,
  12053. ssl->options.haveFalconSig, ssl->options.haveDilithiumSig,
  12054. ssl->options.useAnon, TRUE, ssl->options.side);
  12055. }
  12056. /* Set the PSK callback that returns the cipher suite for a client to use
  12057. * against context object.
  12058. *
  12059. * @param [in, out] ctx SSL/TLS context object.
  12060. * @param [in] cb Client PSK callback returning cipher suite.
  12061. */
  12062. void wolfSSL_CTX_set_psk_client_tls13_callback(WOLFSSL_CTX* ctx,
  12063. wc_psk_client_tls13_callback cb)
  12064. {
  12065. WOLFSSL_ENTER("wolfSSL_CTX_set_psk_client_tls13_callback");
  12066. if (ctx == NULL)
  12067. return;
  12068. ctx->havePSK = 1;
  12069. ctx->client_psk_tls13_cb = cb;
  12070. }
  12071. /* Set the PSK callback that returns the cipher suite for a client to use
  12072. * against SSL object.
  12073. *
  12074. * @param [in, out] ssl SSL/TLS object.
  12075. * @param [in] cb Client PSK callback returning cipher suite.
  12076. */
  12077. void wolfSSL_set_psk_client_tls13_callback(WOLFSSL* ssl,
  12078. wc_psk_client_tls13_callback cb)
  12079. {
  12080. byte haveRSA = 1;
  12081. int keySz = 0;
  12082. WOLFSSL_ENTER("wolfSSL_set_psk_client_tls13_callback");
  12083. if (ssl == NULL)
  12084. return;
  12085. ssl->options.havePSK = 1;
  12086. ssl->options.client_psk_tls13_cb = cb;
  12087. #ifdef NO_RSA
  12088. haveRSA = 0;
  12089. #endif
  12090. #ifndef NO_CERTS
  12091. keySz = ssl->buffers.keySz;
  12092. #endif
  12093. if (AllocateSuites(ssl) != 0)
  12094. return;
  12095. InitSuites(ssl->suites, ssl->version, keySz, haveRSA, TRUE,
  12096. ssl->options.haveDH, ssl->options.haveECDSAsig,
  12097. ssl->options.haveECC, TRUE, ssl->options.haveStaticECC,
  12098. ssl->options.haveFalconSig, ssl->options.haveDilithiumSig,
  12099. ssl->options.useAnon, TRUE, ssl->options.side);
  12100. }
  12101. /* Set the PSK callback that returns the cipher suite for a server to use
  12102. * against context object.
  12103. *
  12104. * @param [in, out] ctx SSL/TLS context object.
  12105. * @param [in] cb Server PSK callback returning cipher suite.
  12106. */
  12107. void wolfSSL_CTX_set_psk_server_tls13_callback(WOLFSSL_CTX* ctx,
  12108. wc_psk_server_tls13_callback cb)
  12109. {
  12110. WOLFSSL_ENTER("wolfSSL_CTX_set_psk_server_tls13_callback");
  12111. if (ctx == NULL)
  12112. return;
  12113. ctx->havePSK = 1;
  12114. ctx->server_psk_tls13_cb = cb;
  12115. }
  12116. /* Set the PSK callback that returns the cipher suite for a server to use
  12117. * against SSL object.
  12118. *
  12119. * @param [in, out] ssl SSL/TLS object.
  12120. * @param [in] cb Server PSK callback returning cipher suite.
  12121. */
  12122. void wolfSSL_set_psk_server_tls13_callback(WOLFSSL* ssl,
  12123. wc_psk_server_tls13_callback cb)
  12124. {
  12125. byte haveRSA = 1;
  12126. int keySz = 0;
  12127. WOLFSSL_ENTER("wolfSSL_set_psk_server_tls13_callback");
  12128. if (ssl == NULL)
  12129. return;
  12130. ssl->options.havePSK = 1;
  12131. ssl->options.server_psk_tls13_cb = cb;
  12132. #ifdef NO_RSA
  12133. haveRSA = 0;
  12134. #endif
  12135. #ifndef NO_CERTS
  12136. keySz = ssl->buffers.keySz;
  12137. #endif
  12138. if (AllocateSuites(ssl) != 0)
  12139. return;
  12140. InitSuites(ssl->suites, ssl->version, keySz, haveRSA, TRUE,
  12141. ssl->options.haveDH, ssl->options.haveECDSAsig,
  12142. ssl->options.haveECC, TRUE, ssl->options.haveStaticECC,
  12143. ssl->options.haveFalconSig, ssl->options.haveDilithiumSig,
  12144. ssl->options.useAnon, TRUE, ssl->options.side);
  12145. }
  12146. /* Get name of first supported cipher suite that uses the hash indicated.
  12147. *
  12148. * @param [in] ssl SSL/TLS object.
  12149. * @param [in] hash Name of hash algorithm. e.g. "SHA256", "SHA384"
  12150. * @return Name of cipher suite.
  12151. * @return NULL on failure.
  12152. */
  12153. const char* wolfSSL_get_cipher_name_by_hash(WOLFSSL* ssl, const char* hash)
  12154. {
  12155. const char* name = NULL;
  12156. byte mac = no_mac;
  12157. int i;
  12158. const Suites* suites = WOLFSSL_SUITES(ssl);
  12159. if (XSTRCMP(hash, "SHA256") == 0) {
  12160. mac = sha256_mac;
  12161. }
  12162. else if (XSTRCMP(hash, "SHA384") == 0) {
  12163. mac = sha384_mac;
  12164. }
  12165. if (mac != no_mac) {
  12166. for (i = 0; i < suites->suiteSz; i += 2) {
  12167. if (SuiteMac(suites->suites + i) == mac) {
  12168. name = GetCipherNameInternal(suites->suites[i + 0],
  12169. suites->suites[i + 1]);
  12170. break;
  12171. }
  12172. }
  12173. }
  12174. return name;
  12175. }
  12176. #endif /* !NO_PSK */
  12177. #ifndef NO_WOLFSSL_SERVER
  12178. /* The server accepting a connection from a client.
  12179. * The protocol version is expecting to be TLS v1.3.
  12180. * If the client downgrades, and older versions of the protocol are compiled
  12181. * in, the server will fallback to wolfSSL_accept().
  12182. * Please see note at top of README if you get an error from accept.
  12183. *
  12184. * ssl The SSL/TLS object.
  12185. * returns WOLFSSL_SUCCESS on successful handshake, WOLFSSL_FATAL_ERROR when
  12186. * unrecoverable error occurs and 0 otherwise.
  12187. * For more error information use wolfSSL_get_error().
  12188. */
  12189. int wolfSSL_accept_TLSv13(WOLFSSL* ssl)
  12190. {
  12191. #if !defined(NO_CERTS) && (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK))
  12192. word16 havePSK = 0;
  12193. #endif
  12194. int ret = 0;
  12195. WOLFSSL_ENTER("wolfSSL_accept_TLSv13");
  12196. #ifdef HAVE_ERRNO_H
  12197. errno = 0;
  12198. #endif
  12199. if (ssl == NULL)
  12200. return WOLFSSL_FATAL_ERROR;
  12201. #if !defined(NO_CERTS) && (defined(HAVE_SESSION_TICKET) || !defined(NO_PSK))
  12202. havePSK = ssl->options.havePSK;
  12203. #endif
  12204. if (ssl->options.side != WOLFSSL_SERVER_END) {
  12205. ssl->error = SIDE_ERROR;
  12206. WOLFSSL_ERROR(ssl->error);
  12207. return WOLFSSL_FATAL_ERROR;
  12208. }
  12209. /* make sure this wolfSSL object has arrays and rng setup. Protects
  12210. * case where the WOLFSSL object is re-used via wolfSSL_clear() */
  12211. if ((ret = ReinitSSL(ssl, ssl->ctx, 0)) != 0) {
  12212. return ret;
  12213. }
  12214. #ifdef WOLFSSL_DTLS
  12215. if (ssl->version.major == DTLS_MAJOR) {
  12216. ssl->options.dtls = 1;
  12217. if (!IsDtlsNotSctpMode(ssl) || !ssl->options.sendCookie)
  12218. ssl->options.dtlsStateful = 1;
  12219. }
  12220. #endif
  12221. #ifdef WOLFSSL_WOLFSENTRY_HOOKS
  12222. if ((ssl->AcceptFilter != NULL) &&
  12223. ((ssl->options.acceptState == TLS13_ACCEPT_BEGIN)
  12224. #ifdef HAVE_SECURE_RENEGOTIATION
  12225. || (ssl->options.acceptState == TLS13_ACCEPT_BEGIN_RENEG)
  12226. #endif
  12227. ))
  12228. {
  12229. wolfSSL_netfilter_decision_t res;
  12230. if ((ssl->AcceptFilter(ssl, ssl->AcceptFilter_arg, &res) ==
  12231. WOLFSSL_SUCCESS) &&
  12232. (res == WOLFSSL_NETFILTER_REJECT)) {
  12233. ssl->error = SOCKET_FILTERED_E;
  12234. WOLFSSL_ERROR(ssl->error);
  12235. return WOLFSSL_FATAL_ERROR;
  12236. }
  12237. }
  12238. #endif /* WOLFSSL_WOLFSENTRY_HOOKS */
  12239. #ifndef NO_CERTS
  12240. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  12241. if (!havePSK)
  12242. #endif
  12243. {
  12244. #if defined(OPENSSL_ALL) || defined(OPENSSL_EXTRA) || \
  12245. defined(WOLFSSL_NGINX) || defined (WOLFSSL_HAPROXY)
  12246. if (ssl->ctx->certSetupCb != NULL) {
  12247. WOLFSSL_MSG("CertSetupCb set. server cert and "
  12248. "key not checked");
  12249. }
  12250. else
  12251. #endif
  12252. {
  12253. if (!ssl->buffers.certificate ||
  12254. !ssl->buffers.certificate->buffer) {
  12255. WOLFSSL_MSG("accept error: server cert required");
  12256. ssl->error = NO_PRIVATE_KEY;
  12257. WOLFSSL_ERROR(ssl->error);
  12258. return WOLFSSL_FATAL_ERROR;
  12259. }
  12260. if (!ssl->buffers.key || !ssl->buffers.key->buffer) {
  12261. /* allow no private key if using existing key */
  12262. #ifdef WOLF_PRIVATE_KEY_ID
  12263. if (ssl->devId != INVALID_DEVID
  12264. #ifdef HAVE_PK_CALLBACKS
  12265. || wolfSSL_CTX_IsPrivatePkSet(ssl->ctx)
  12266. #endif
  12267. ) {
  12268. WOLFSSL_MSG("Allowing no server private key (external)");
  12269. }
  12270. else
  12271. #endif
  12272. {
  12273. WOLFSSL_MSG("accept error: server key required");
  12274. ssl->error = NO_PRIVATE_KEY;
  12275. WOLFSSL_ERROR(ssl->error);
  12276. return WOLFSSL_FATAL_ERROR;
  12277. }
  12278. }
  12279. }
  12280. }
  12281. #endif /* NO_CERTS */
  12282. if (ssl->buffers.outputBuffer.length > 0
  12283. #ifdef WOLFSSL_ASYNC_CRYPT
  12284. /* do not send buffered or advance state if last error was an
  12285. async pending operation */
  12286. && ssl->error != WC_PENDING_E
  12287. #endif
  12288. ) {
  12289. /* fragOffset is non-zero when sending fragments. On the last
  12290. * fragment, fragOffset is zero again, and the state can be
  12291. * advanced. */
  12292. int advanceState =
  12293. (ssl->options.acceptState == TLS13_ACCEPT_CLIENT_HELLO_DONE ||
  12294. ssl->options.acceptState ==
  12295. TLS13_ACCEPT_HELLO_RETRY_REQUEST_DONE ||
  12296. ssl->options.acceptState == TLS13_ACCEPT_SECOND_REPLY_DONE ||
  12297. ssl->options.acceptState == TLS13_SERVER_HELLO_SENT ||
  12298. ssl->options.acceptState == TLS13_ACCEPT_THIRD_REPLY_DONE ||
  12299. ssl->options.acceptState == TLS13_SERVER_EXTENSIONS_SENT ||
  12300. ssl->options.acceptState == TLS13_CERT_REQ_SENT ||
  12301. ssl->options.acceptState == TLS13_CERT_SENT ||
  12302. ssl->options.acceptState == TLS13_CERT_VERIFY_SENT ||
  12303. ssl->options.acceptState == TLS13_ACCEPT_FINISHED_SENT ||
  12304. ssl->options.acceptState == TLS13_ACCEPT_FINISHED_DONE);
  12305. #ifdef WOLFSSL_DTLS13
  12306. if (ssl->options.dtls)
  12307. advanceState = advanceState && !ssl->dtls13SendingFragments
  12308. && !ssl->dtls13SendingAckOrRtx;
  12309. #endif /* WOLFSSL_DTLS13 */
  12310. ret = SendBuffered(ssl);
  12311. if (ret == 0) {
  12312. if (ssl->fragOffset == 0 && !ssl->options.buildingMsg) {
  12313. if (advanceState) {
  12314. ssl->options.acceptState++;
  12315. WOLFSSL_MSG("accept state: "
  12316. "Advanced from last buffered fragment send");
  12317. #ifdef WOLFSSL_ASYNC_IO
  12318. FreeAsyncCtx(ssl, 0);
  12319. #endif
  12320. }
  12321. }
  12322. else {
  12323. WOLFSSL_MSG("accept state: "
  12324. "Not advanced, more fragments to send");
  12325. }
  12326. #ifdef WOLFSSL_DTLS13
  12327. if (ssl->options.dtls)
  12328. ssl->dtls13SendingAckOrRtx = 0;
  12329. #endif /* WOLFSSL_DTLS13 */
  12330. }
  12331. else {
  12332. ssl->error = ret;
  12333. WOLFSSL_ERROR(ssl->error);
  12334. return WOLFSSL_FATAL_ERROR;
  12335. }
  12336. }
  12337. ret = RetrySendAlert(ssl);
  12338. if (ret != 0) {
  12339. ssl->error = ret;
  12340. WOLFSSL_ERROR(ssl->error);
  12341. return WOLFSSL_FATAL_ERROR;
  12342. }
  12343. #ifdef WOLFSSL_DTLS13
  12344. if (ssl->options.dtls && ssl->dtls13SendingFragments) {
  12345. if ((ssl->error = Dtls13FragmentsContinue(ssl)) != 0) {
  12346. WOLFSSL_ERROR(ssl->error);
  12347. return WOLFSSL_FATAL_ERROR;
  12348. }
  12349. /* we sent all the fragments. Advance state. */
  12350. ssl->options.acceptState++;
  12351. }
  12352. #endif /* WOLFSSL_DTLS13 */
  12353. switch (ssl->options.acceptState) {
  12354. #ifdef HAVE_SECURE_RENEGOTIATION
  12355. case TLS13_ACCEPT_BEGIN_RENEG:
  12356. #endif
  12357. case TLS13_ACCEPT_BEGIN :
  12358. /* get client_hello */
  12359. while (ssl->options.clientState < CLIENT_HELLO_COMPLETE) {
  12360. if ((ssl->error = ProcessReply(ssl)) < 0) {
  12361. WOLFSSL_ERROR(ssl->error);
  12362. return WOLFSSL_FATAL_ERROR;
  12363. }
  12364. #ifdef WOLFSSL_DTLS13
  12365. if (ssl->options.dtls) {
  12366. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  12367. WOLFSSL_ERROR(ssl->error);
  12368. return WOLFSSL_FATAL_ERROR;
  12369. }
  12370. }
  12371. #endif /* WOLFSSL_DTLS13 */
  12372. }
  12373. ssl->options.acceptState = TLS13_ACCEPT_CLIENT_HELLO_DONE;
  12374. WOLFSSL_MSG("accept state ACCEPT_CLIENT_HELLO_DONE");
  12375. if (!IsAtLeastTLSv1_3(ssl->version))
  12376. return wolfSSL_accept(ssl);
  12377. FALL_THROUGH;
  12378. case TLS13_ACCEPT_CLIENT_HELLO_DONE :
  12379. if (ssl->options.serverState ==
  12380. SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  12381. if ((ssl->error = SendTls13ServerHello(ssl,
  12382. hello_retry_request)) != 0) {
  12383. WOLFSSL_ERROR(ssl->error);
  12384. return WOLFSSL_FATAL_ERROR;
  12385. }
  12386. }
  12387. ssl->options.acceptState = TLS13_ACCEPT_HELLO_RETRY_REQUEST_DONE;
  12388. WOLFSSL_MSG("accept state ACCEPT_HELLO_RETRY_REQUEST_DONE");
  12389. FALL_THROUGH;
  12390. case TLS13_ACCEPT_HELLO_RETRY_REQUEST_DONE :
  12391. #ifdef WOLFSSL_TLS13_MIDDLEBOX_COMPAT
  12392. if (!ssl->options.dtls && ssl->options.tls13MiddleBoxCompat
  12393. && ssl->options.serverState ==
  12394. SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  12395. if ((ssl->error = SendChangeCipher(ssl)) != 0) {
  12396. WOLFSSL_ERROR(ssl->error);
  12397. return WOLFSSL_FATAL_ERROR;
  12398. }
  12399. ssl->options.sentChangeCipher = 1;
  12400. ssl->options.serverState = SERVER_HELLO_RETRY_REQUEST_COMPLETE;
  12401. }
  12402. #endif
  12403. ssl->options.acceptState = TLS13_ACCEPT_FIRST_REPLY_DONE;
  12404. WOLFSSL_MSG("accept state ACCEPT_FIRST_REPLY_DONE");
  12405. FALL_THROUGH;
  12406. case TLS13_ACCEPT_FIRST_REPLY_DONE :
  12407. if (ssl->options.serverState ==
  12408. SERVER_HELLO_RETRY_REQUEST_COMPLETE) {
  12409. ssl->options.clientState = CLIENT_HELLO_RETRY;
  12410. while (ssl->options.clientState < CLIENT_HELLO_COMPLETE) {
  12411. if ((ssl->error = ProcessReply(ssl)) < 0) {
  12412. WOLFSSL_ERROR(ssl->error);
  12413. return WOLFSSL_FATAL_ERROR;
  12414. }
  12415. #ifdef WOLFSSL_DTLS13
  12416. if (ssl->options.dtls) {
  12417. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  12418. WOLFSSL_ERROR(ssl->error);
  12419. return WOLFSSL_FATAL_ERROR;
  12420. }
  12421. }
  12422. #endif /* WOLFSSL_DTLS13 */
  12423. }
  12424. }
  12425. ssl->options.acceptState = TLS13_ACCEPT_SECOND_REPLY_DONE;
  12426. WOLFSSL_MSG("accept state ACCEPT_SECOND_REPLY_DONE");
  12427. FALL_THROUGH;
  12428. case TLS13_ACCEPT_SECOND_REPLY_DONE :
  12429. if ((ssl->error = SendTls13ServerHello(ssl, server_hello)) != 0) {
  12430. WOLFSSL_ERROR(ssl->error);
  12431. return WOLFSSL_FATAL_ERROR;
  12432. }
  12433. ssl->options.acceptState = TLS13_SERVER_HELLO_SENT;
  12434. WOLFSSL_MSG("accept state SERVER_HELLO_SENT");
  12435. FALL_THROUGH;
  12436. case TLS13_SERVER_HELLO_SENT :
  12437. #if defined(WOLFSSL_TLS13_MIDDLEBOX_COMPAT)
  12438. if (!ssl->options.dtls && ssl->options.tls13MiddleBoxCompat
  12439. && !ssl->options.sentChangeCipher && !ssl->options.dtls) {
  12440. if ((ssl->error = SendChangeCipher(ssl)) != 0) {
  12441. WOLFSSL_ERROR(ssl->error);
  12442. return WOLFSSL_FATAL_ERROR;
  12443. }
  12444. ssl->options.sentChangeCipher = 1;
  12445. }
  12446. #endif
  12447. ssl->options.acceptState = TLS13_ACCEPT_THIRD_REPLY_DONE;
  12448. WOLFSSL_MSG("accept state ACCEPT_THIRD_REPLY_DONE");
  12449. FALL_THROUGH;
  12450. case TLS13_ACCEPT_THIRD_REPLY_DONE :
  12451. #ifdef HAVE_SUPPORTED_CURVES
  12452. #if defined(HAVE_SESSION_TICKET) || !defined(NO_PSK)
  12453. if (!ssl->options.noPskDheKe)
  12454. #endif
  12455. {
  12456. ssl->error = TLSX_KeyShare_DeriveSecret(ssl);
  12457. if (ssl->error != 0)
  12458. return WOLFSSL_FATAL_ERROR;
  12459. }
  12460. #endif
  12461. if ((ssl->error = SendTls13EncryptedExtensions(ssl)) != 0) {
  12462. WOLFSSL_ERROR(ssl->error);
  12463. return WOLFSSL_FATAL_ERROR;
  12464. }
  12465. ssl->options.acceptState = TLS13_SERVER_EXTENSIONS_SENT;
  12466. WOLFSSL_MSG("accept state SERVER_EXTENSIONS_SENT");
  12467. FALL_THROUGH;
  12468. case TLS13_SERVER_EXTENSIONS_SENT :
  12469. #ifndef NO_CERTS
  12470. if (!ssl->options.resuming) {
  12471. if (ssl->options.verifyPeer
  12472. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  12473. && !ssl->options.verifyPostHandshake
  12474. #endif
  12475. ) {
  12476. ssl->error = SendTls13CertificateRequest(ssl, NULL, 0);
  12477. if (ssl->error != 0) {
  12478. WOLFSSL_ERROR(ssl->error);
  12479. return WOLFSSL_FATAL_ERROR;
  12480. }
  12481. }
  12482. else {
  12483. /* SERVER: Peer auth good if not verifying client. */
  12484. ssl->options.peerAuthGood = 1;
  12485. }
  12486. }
  12487. #endif
  12488. ssl->options.acceptState = TLS13_CERT_REQ_SENT;
  12489. WOLFSSL_MSG("accept state CERT_REQ_SENT");
  12490. FALL_THROUGH;
  12491. case TLS13_CERT_REQ_SENT :
  12492. #ifndef NO_CERTS
  12493. if (!ssl->options.resuming && ssl->options.sendVerify) {
  12494. if ((ssl->error = SendTls13Certificate(ssl)) != 0) {
  12495. WOLFSSL_ERROR(ssl->error);
  12496. return WOLFSSL_FATAL_ERROR;
  12497. }
  12498. }
  12499. #endif
  12500. ssl->options.acceptState = TLS13_CERT_SENT;
  12501. WOLFSSL_MSG("accept state CERT_SENT");
  12502. FALL_THROUGH;
  12503. case TLS13_CERT_SENT :
  12504. #if !defined(NO_CERTS) && (!defined(NO_RSA) || defined(HAVE_ECC) || \
  12505. defined(HAVE_ED25519) || defined(HAVE_ED448) || defined(HAVE_PQC))
  12506. if (!ssl->options.resuming && ssl->options.sendVerify) {
  12507. if ((ssl->error = SendTls13CertificateVerify(ssl)) != 0) {
  12508. WOLFSSL_ERROR(ssl->error);
  12509. return WOLFSSL_FATAL_ERROR;
  12510. }
  12511. }
  12512. #endif
  12513. ssl->options.acceptState = TLS13_CERT_VERIFY_SENT;
  12514. WOLFSSL_MSG("accept state CERT_VERIFY_SENT");
  12515. FALL_THROUGH;
  12516. case TLS13_CERT_VERIFY_SENT :
  12517. if ((ssl->error = SendTls13Finished(ssl)) != 0) {
  12518. WOLFSSL_ERROR(ssl->error);
  12519. return WOLFSSL_FATAL_ERROR;
  12520. }
  12521. ssl->options.acceptState = TLS13_ACCEPT_FINISHED_SENT;
  12522. WOLFSSL_MSG("accept state ACCEPT_FINISHED_SENT");
  12523. #ifdef WOLFSSL_EARLY_DATA
  12524. if (ssl->earlyData != no_early_data) {
  12525. ssl->options.handShakeState = SERVER_FINISHED_COMPLETE;
  12526. return WOLFSSL_SUCCESS;
  12527. }
  12528. #endif
  12529. FALL_THROUGH;
  12530. case TLS13_ACCEPT_FINISHED_SENT :
  12531. #ifdef HAVE_SESSION_TICKET
  12532. #ifdef WOLFSSL_TLS13_TICKET_BEFORE_FINISHED
  12533. if (!ssl->options.verifyPeer && !ssl->options.noTicketTls13 &&
  12534. ssl->ctx->ticketEncCb != NULL) {
  12535. if ((ssl->error = SendTls13NewSessionTicket(ssl)) != 0) {
  12536. WOLFSSL_ERROR(ssl->error);
  12537. return WOLFSSL_FATAL_ERROR;
  12538. }
  12539. ssl->options.ticketsSent = 1;
  12540. }
  12541. #endif
  12542. #endif /* HAVE_SESSION_TICKET */
  12543. ssl->options.acceptState = TLS13_PRE_TICKET_SENT;
  12544. WOLFSSL_MSG("accept state TICKET_SENT");
  12545. FALL_THROUGH;
  12546. case TLS13_PRE_TICKET_SENT :
  12547. while (ssl->options.clientState < CLIENT_FINISHED_COMPLETE) {
  12548. if ( (ssl->error = ProcessReply(ssl)) < 0) {
  12549. WOLFSSL_ERROR(ssl->error);
  12550. return WOLFSSL_FATAL_ERROR;
  12551. }
  12552. #ifdef WOLFSSL_DTLS13
  12553. if (ssl->options.dtls) {
  12554. if ((ssl->error = Dtls13DoScheduledWork(ssl)) < 0) {
  12555. WOLFSSL_ERROR(ssl->error);
  12556. return WOLFSSL_FATAL_ERROR;
  12557. }
  12558. }
  12559. #endif /* WOLFSSL_DTLS13 */
  12560. }
  12561. ssl->options.acceptState = TLS13_ACCEPT_FINISHED_DONE;
  12562. WOLFSSL_MSG("accept state ACCEPT_FINISHED_DONE");
  12563. FALL_THROUGH;
  12564. case TLS13_ACCEPT_FINISHED_DONE :
  12565. /* SERVER: When not resuming and verifying peer but no certificate
  12566. * received and not failing when not received then peer auth good.
  12567. */
  12568. if (!ssl->options.resuming && ssl->options.verifyPeer &&
  12569. #ifdef WOLFSSL_POST_HANDSHAKE_AUTH
  12570. !ssl->options.verifyPostHandshake &&
  12571. #endif
  12572. !ssl->options.havePeerCert && !ssl->options.failNoCert) {
  12573. ssl->options.peerAuthGood = 1;
  12574. }
  12575. /* SERVER: check peer authentication. */
  12576. if (!ssl->options.peerAuthGood) {
  12577. WOLFSSL_MSG("Client authentication did not happen");
  12578. return WOLFSSL_FATAL_ERROR;
  12579. }
  12580. #ifdef HAVE_SESSION_TICKET
  12581. while (ssl->options.ticketsSent < ssl->options.maxTicketTls13) {
  12582. if (!ssl->options.noTicketTls13 && ssl->ctx->ticketEncCb
  12583. != NULL) {
  12584. if ((ssl->error = SendTls13NewSessionTicket(ssl)) != 0) {
  12585. WOLFSSL_ERROR(ssl->error);
  12586. return WOLFSSL_FATAL_ERROR;
  12587. }
  12588. }
  12589. ssl->options.ticketsSent++;
  12590. /* only one session ticket is sent on session resumption */
  12591. if (ssl->options.resuming) {
  12592. break;
  12593. }
  12594. }
  12595. #endif /* HAVE_SESSION_TICKET */
  12596. ssl->options.acceptState = TLS13_TICKET_SENT;
  12597. WOLFSSL_MSG("accept state TICKET_SENT");
  12598. FALL_THROUGH;
  12599. case TLS13_TICKET_SENT :
  12600. #ifndef NO_HANDSHAKE_DONE_CB
  12601. if (ssl->hsDoneCb) {
  12602. int cbret = ssl->hsDoneCb(ssl, ssl->hsDoneCtx);
  12603. if (cbret < 0) {
  12604. ssl->error = cbret;
  12605. WOLFSSL_MSG("HandShake Done Cb don't continue error");
  12606. return WOLFSSL_FATAL_ERROR;
  12607. }
  12608. }
  12609. #endif /* NO_HANDSHAKE_DONE_CB */
  12610. if (!ssl->options.keepResources) {
  12611. FreeHandshakeResources(ssl);
  12612. }
  12613. #if defined(WOLFSSL_ASYNC_IO) && !defined(WOLFSSL_ASYNC_CRYPT)
  12614. /* Free the remaining async context if not using it for crypto */
  12615. FreeAsyncCtx(ssl, 1);
  12616. #endif
  12617. ssl->error = 0; /* clear the error */
  12618. WOLFSSL_LEAVE("wolfSSL_accept", WOLFSSL_SUCCESS);
  12619. return WOLFSSL_SUCCESS;
  12620. default :
  12621. WOLFSSL_MSG("Unknown accept state ERROR");
  12622. return WOLFSSL_FATAL_ERROR;
  12623. }
  12624. }
  12625. #endif
  12626. #if !defined(NO_WOLFSSL_SERVER) && defined(HAVE_SESSION_TICKET)
  12627. /* Server sends a session ticket to the peer.
  12628. *
  12629. * RFC 8446, section 4.6.1, para 1.
  12630. *
  12631. * ssl The SSL/TLS object.
  12632. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3,
  12633. * SIDE_ERROR when not a server,
  12634. * NOT_READY_ERROR when handshake not complete,
  12635. * WOLFSSL_FATAL_ERROR when creating or sending message fails, and
  12636. * WOLFSSL_SUCCESS on success.
  12637. */
  12638. int wolfSSL_send_SessionTicket(WOLFSSL* ssl)
  12639. {
  12640. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  12641. return BAD_FUNC_ARG;
  12642. if (ssl->options.side == WOLFSSL_CLIENT_END)
  12643. return SIDE_ERROR;
  12644. if (ssl->options.handShakeState != HANDSHAKE_DONE)
  12645. return NOT_READY_ERROR;
  12646. if ((ssl->error = SendTls13NewSessionTicket(ssl)) != 0) {
  12647. WOLFSSL_ERROR(ssl->error);
  12648. return WOLFSSL_FATAL_ERROR;
  12649. }
  12650. ssl->options.ticketsSent++;
  12651. return WOLFSSL_SUCCESS;
  12652. }
  12653. #endif
  12654. #ifdef WOLFSSL_EARLY_DATA
  12655. /* Sets the maximum amount of early data that can be seen by server when using
  12656. * session tickets for resumption.
  12657. * A value of zero indicates no early data is to be sent by client using session
  12658. * tickets.
  12659. *
  12660. * ctx The SSL/TLS CTX object.
  12661. * sz Maximum size of the early data.
  12662. * returns BAD_FUNC_ARG when ctx is NULL, SIDE_ERROR when not a server and
  12663. * 0 on success.
  12664. */
  12665. int wolfSSL_CTX_set_max_early_data(WOLFSSL_CTX* ctx, unsigned int sz)
  12666. {
  12667. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  12668. return BAD_FUNC_ARG;
  12669. if (ctx->method->side == WOLFSSL_CLIENT_END)
  12670. return SIDE_ERROR;
  12671. ctx->maxEarlyDataSz = sz;
  12672. #if defined(OPENSSL_EXTRA) || defined(WOLFSSL_ERROR_CODE_OPENSSL)
  12673. /* 1 on success in OpenSSL*/
  12674. return WOLFSSL_SUCCESS;
  12675. #else
  12676. return 0;
  12677. #endif
  12678. }
  12679. /* Sets the maximum amount of early data that a client or server would like
  12680. * to exchange. Servers will advertise this value in session tickets sent
  12681. * to a client.
  12682. * A value of zero indicates no early data will be sent by a client, or
  12683. * no early data is accepted by a server (and announced as such in send out
  12684. * session tickets).
  12685. *
  12686. * ssl The SSL/TLS object.
  12687. * sz Maximum size of the early data.
  12688. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3,
  12689. * and 0 on success.
  12690. */
  12691. int wolfSSL_set_max_early_data(WOLFSSL* ssl, unsigned int sz)
  12692. {
  12693. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  12694. return BAD_FUNC_ARG;
  12695. ssl->options.maxEarlyDataSz = sz;
  12696. #if defined(OPENSSL_EXTRA) || defined(WOLFSSL_ERROR_CODE_OPENSSL)
  12697. /* 1 on success in OpenSSL*/
  12698. return WOLFSSL_SUCCESS;
  12699. #else
  12700. return 0;
  12701. #endif
  12702. }
  12703. /* Gets the maximum amount of early data that can be seen by server when using
  12704. * session tickets for resumption.
  12705. * A value of zero indicates no early data is to be sent by client using session
  12706. * tickets.
  12707. *
  12708. * ctx The SSL/TLS CTX object.
  12709. * returns BAD_FUNC_ARG when ctx is NULL, SIDE_ERROR when not a server and
  12710. * returns the maximum amount of early data to be set
  12711. */
  12712. int wolfSSL_CTX_get_max_early_data(WOLFSSL_CTX* ctx)
  12713. {
  12714. if (ctx == NULL || !IsAtLeastTLSv1_3(ctx->method->version))
  12715. return BAD_FUNC_ARG;
  12716. if (ctx->method->side == WOLFSSL_CLIENT_END)
  12717. return SIDE_ERROR;
  12718. return ctx->maxEarlyDataSz;
  12719. }
  12720. /* Gets the maximum amount of early data that can be seen by server when using
  12721. * session tickets for resumption.
  12722. * A value of zero indicates no early data is to be sent by client using session
  12723. * tickets.
  12724. *
  12725. * ssl The SSL/TLS object.
  12726. * returns BAD_FUNC_ARG when ssl is NULL, or not using TLS v1.3,
  12727. * SIDE_ERROR when not a server and
  12728. * returns the maximum amount of early data to be set
  12729. */
  12730. int wolfSSL_get_max_early_data(WOLFSSL* ssl)
  12731. {
  12732. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  12733. return BAD_FUNC_ARG;
  12734. return ssl->options.maxEarlyDataSz;
  12735. }
  12736. /* Write early data to the server.
  12737. *
  12738. * ssl The SSL/TLS object.
  12739. * data Early data to write
  12740. * sz The size of the early data in bytes.
  12741. * outSz The number of early data bytes written.
  12742. * returns BAD_FUNC_ARG when: ssl, data or outSz is NULL; sz is negative;
  12743. * or not using TLS v1.3. SIDE ERROR when not a server. Otherwise the number of
  12744. * early data bytes written.
  12745. */
  12746. int wolfSSL_write_early_data(WOLFSSL* ssl, const void* data, int sz, int* outSz)
  12747. {
  12748. int ret = 0;
  12749. WOLFSSL_ENTER("wolfSSL_write_early_data");
  12750. if (ssl == NULL || data == NULL || sz < 0 || outSz == NULL)
  12751. return BAD_FUNC_ARG;
  12752. if (!IsAtLeastTLSv1_3(ssl->version))
  12753. return BAD_FUNC_ARG;
  12754. #ifndef NO_WOLFSSL_CLIENT
  12755. if (ssl->options.side == WOLFSSL_SERVER_END)
  12756. return SIDE_ERROR;
  12757. if (ssl->options.handShakeState == NULL_STATE) {
  12758. if (ssl->error != WC_PENDING_E)
  12759. ssl->earlyData = expecting_early_data;
  12760. ret = wolfSSL_connect_TLSv13(ssl);
  12761. if (ret != WOLFSSL_SUCCESS)
  12762. return WOLFSSL_FATAL_ERROR;
  12763. /* on client side, status is set to rejected */
  12764. /* until sever accepts the early data extension. */
  12765. ssl->earlyDataStatus = WOLFSSL_EARLY_DATA_REJECTED;
  12766. }
  12767. if (ssl->options.handShakeState == CLIENT_HELLO_COMPLETE) {
  12768. #ifdef OPENSSL_EXTRA
  12769. /* when processed early data exceeds max size */
  12770. if (ssl->session->maxEarlyDataSz > 0 &&
  12771. (ssl->earlyDataSz + sz > ssl->session->maxEarlyDataSz)) {
  12772. ssl->error = TOO_MUCH_EARLY_DATA;
  12773. return WOLFSSL_FATAL_ERROR;
  12774. }
  12775. #endif
  12776. ret = SendData(ssl, data, sz);
  12777. if (ret > 0) {
  12778. *outSz = ret;
  12779. /* store amount of processed early data from client */
  12780. ssl->earlyDataSz += ret;
  12781. }
  12782. }
  12783. #else
  12784. return SIDE_ERROR;
  12785. #endif
  12786. WOLFSSL_LEAVE("wolfSSL_write_early_data", ret);
  12787. if (ret < 0)
  12788. ret = WOLFSSL_FATAL_ERROR;
  12789. return ret;
  12790. }
  12791. /* Read the any early data from the client.
  12792. *
  12793. * ssl The SSL/TLS object.
  12794. * data Buffer to put the early data into.
  12795. * sz The size of the buffer in bytes.
  12796. * outSz The number of early data bytes read.
  12797. * returns BAD_FUNC_ARG when: ssl, data or outSz is NULL; sz is negative;
  12798. * or not using TLS v1.3. SIDE ERROR when not a server. Otherwise the number of
  12799. * early data bytes read.
  12800. */
  12801. int wolfSSL_read_early_data(WOLFSSL* ssl, void* data, int sz, int* outSz)
  12802. {
  12803. int ret = 0;
  12804. WOLFSSL_ENTER("wolfSSL_read_early_data");
  12805. if (ssl == NULL || data == NULL || sz < 0 || outSz == NULL)
  12806. return BAD_FUNC_ARG;
  12807. if (!IsAtLeastTLSv1_3(ssl->version))
  12808. return BAD_FUNC_ARG;
  12809. *outSz = 0;
  12810. #ifndef NO_WOLFSSL_SERVER
  12811. if (ssl->options.side == WOLFSSL_CLIENT_END)
  12812. return SIDE_ERROR;
  12813. if (ssl->options.handShakeState == NULL_STATE) {
  12814. if (ssl->error != WC_PENDING_E)
  12815. ssl->earlyData = expecting_early_data;
  12816. /* this used to be: ret = wolfSSL_accept_TLSv13(ssl);
  12817. * However, wolfSSL_accept_TLSv13() expects a certificate to
  12818. * be installed already, which is not the case in servers
  12819. * such as HAProxy. They do it after inspecting the ClientHello.
  12820. * The common wolfssl_accept() allows that. */
  12821. ret = wolfSSL_accept(ssl);
  12822. if (ret <= 0)
  12823. return WOLFSSL_FATAL_ERROR;
  12824. }
  12825. if (ssl->options.handShakeState == SERVER_FINISHED_COMPLETE) {
  12826. ret = ReceiveData(ssl, (byte*)data, sz, FALSE);
  12827. if (ret > 0)
  12828. *outSz = ret;
  12829. if (ssl->error == ZERO_RETURN) {
  12830. ssl->error = WOLFSSL_ERROR_NONE;
  12831. #ifdef WOLFSSL_DTLS13
  12832. if (ssl->options.dtls) {
  12833. ret = Dtls13DoScheduledWork(ssl);
  12834. if (ret < 0) {
  12835. ssl->error = ret;
  12836. WOLFSSL_ERROR(ssl->error);
  12837. return WOLFSSL_FATAL_ERROR;
  12838. }
  12839. }
  12840. #endif /* WOLFSSL_DTLS13 */
  12841. }
  12842. }
  12843. else
  12844. ret = 0;
  12845. #else
  12846. return SIDE_ERROR;
  12847. #endif
  12848. WOLFSSL_LEAVE("wolfSSL_read_early_data", ret);
  12849. if (ret < 0)
  12850. ret = WOLFSSL_FATAL_ERROR;
  12851. return ret;
  12852. }
  12853. /* Returns early data status
  12854. *
  12855. * ssl The SSL/TLS object.
  12856. * returns WOLFSSL_EARLY_DATA_ACCEPTED if the data was accepted
  12857. * WOLFSSL_EARLY_DATA_REJECTED if the data was rejected
  12858. * WOLFSSL_EARLY_DATA_NOT_SENT if no early data was sent
  12859. */
  12860. int wolfSSL_get_early_data_status(const WOLFSSL* ssl)
  12861. {
  12862. if (ssl == NULL || !IsAtLeastTLSv1_3(ssl->version))
  12863. return BAD_FUNC_ARG;
  12864. return ssl->earlyDataStatus;
  12865. }
  12866. #endif
  12867. #ifdef HAVE_SECRET_CALLBACK
  12868. int wolfSSL_set_tls13_secret_cb(WOLFSSL* ssl, Tls13SecretCb cb, void* ctx)
  12869. {
  12870. WOLFSSL_ENTER("wolfSSL_set_tls13_secret_cb");
  12871. if (ssl == NULL)
  12872. return WOLFSSL_FATAL_ERROR;
  12873. ssl->tls13SecretCb = cb;
  12874. ssl->tls13SecretCtx = ctx;
  12875. return WOLFSSL_SUCCESS;
  12876. }
  12877. #if defined(SHOW_SECRETS) && defined(WOLFSSL_SSLKEYLOGFILE)
  12878. int tls13ShowSecrets(WOLFSSL* ssl, int id, const unsigned char* secret,
  12879. int secretSz, void* ctx)
  12880. {
  12881. int i;
  12882. const char* str = NULL;
  12883. byte clientRandom[RAN_LEN];
  12884. int clientRandomSz;
  12885. XFILE fp;
  12886. (void) ctx;
  12887. #ifdef WOLFSSL_SSLKEYLOGFILE_OUTPUT
  12888. fp = XFOPEN(WOLFSSL_SSLKEYLOGFILE_OUTPUT, "ab");
  12889. if (fp == XBADFILE) {
  12890. return BAD_FUNC_ARG;
  12891. }
  12892. #else
  12893. fp = stderr;
  12894. #endif
  12895. clientRandomSz = (int)wolfSSL_get_client_random(ssl, clientRandom,
  12896. sizeof(clientRandom));
  12897. if (clientRandomSz <= 0) {
  12898. printf("Error getting server random %d\n", clientRandomSz);
  12899. }
  12900. #if 0
  12901. printf("TLS Server Secret CB: Rand %d, Secret %d\n",
  12902. serverRandomSz, secretSz);
  12903. #endif
  12904. switch (id) {
  12905. case CLIENT_EARLY_TRAFFIC_SECRET:
  12906. str = "CLIENT_EARLY_TRAFFIC_SECRET"; break;
  12907. case EARLY_EXPORTER_SECRET:
  12908. str = "EARLY_EXPORTER_SECRET"; break;
  12909. case CLIENT_HANDSHAKE_TRAFFIC_SECRET:
  12910. str = "CLIENT_HANDSHAKE_TRAFFIC_SECRET"; break;
  12911. case SERVER_HANDSHAKE_TRAFFIC_SECRET:
  12912. str = "SERVER_HANDSHAKE_TRAFFIC_SECRET"; break;
  12913. case CLIENT_TRAFFIC_SECRET:
  12914. str = "CLIENT_TRAFFIC_SECRET_0"; break;
  12915. case SERVER_TRAFFIC_SECRET:
  12916. str = "SERVER_TRAFFIC_SECRET_0"; break;
  12917. case EXPORTER_SECRET:
  12918. str = "EXPORTER_SECRET"; break;
  12919. default:
  12920. #ifdef WOLFSSL_SSLKEYLOGFILE_OUTPUT
  12921. XFCLOSE(fp);
  12922. #endif
  12923. return BAD_FUNC_ARG;
  12924. break;
  12925. }
  12926. fprintf(fp, "%s ", str);
  12927. for (i = 0; i < (int)clientRandomSz; i++) {
  12928. fprintf(fp, "%02x", clientRandom[i]);
  12929. }
  12930. fprintf(fp, " ");
  12931. for (i = 0; i < secretSz; i++) {
  12932. fprintf(fp, "%02x", secret[i]);
  12933. }
  12934. fprintf(fp, "\n");
  12935. #ifdef WOLFSSL_SSLKEYLOGFILE_OUTPUT
  12936. XFCLOSE(fp);
  12937. #endif
  12938. return 0;
  12939. }
  12940. #endif
  12941. #endif
  12942. #undef ERROR_OUT
  12943. #endif /* !WOLFCRYPT_ONLY */
  12944. #endif /* WOLFSSL_TLS13 */